Zoho Cliq Keyboardshortcuts Schemas

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Zoho Cliq Keyboardshortcuts Schemas",
  "definitions": {
    "no-response": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "example": "success"
        }
      }
    },
    "error-response": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "Detailed error message."
        }
      },
      "required": [
        "message"
      ]
    },
    "os-shortcut": {
      "type": "object",
      "properties": {
        "windows": {
          "type": "string",
          "description": "Shortcut mapping for Windows (e.g., <code>ctrl+k</code>, <code>ctrl+shift+m</code>).",
          "example": "ctrl+k"
        },
        "mac": {
          "type": "string",
          "description": "Shortcut mapping for Mac (e.g., <code>cmd+k</code>, <code>cmd+shift+m</code>).",
          "example": "cmd+k"
        }
      }
    },
    "custom-chat-or-widget-entry": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the chat or widget.",
          "example": "Support Team"
        },
        "id": {
          "type": "string",
          "description": "Chat or widget identifier.",
          "example": "support-team"
        },
        "mac": {
          "type": "string",
          "description": "Shortcut mapping for Mac (e.g., <code>cmd+option+c</code>).",
          "example": "cmd+option+c"
        },
        "windows": {
          "type": "string",
          "description": "Shortcut mapping for Windows (e.g., <code>ctrl+alt+c</code>).",
          "example": "ctrl+alt+c"
        }
      },
      "required": [
        "id"
      ]
    },
    "custom-snippet-entry": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of snippet shortcut.",
          "example": "OOO Snippet"
        },
        "message": {
          "type": "string",
          "description": "Snippet content to be sent when the shortcut is triggered.",
          "example": "I'm currently out of office. Will get back to you soon!"
        },
        "mac": {
          "type": "string",
          "description": "Shortcut mapping for Mac (e.g., <code>cmd+option+o</code>).",
          "example": "cmd+option+o"
        },
        "windows": {
          "type": "string",
          "description": "Shortcut mapping for Windows (e.g., <code>ctrl+alt+o</code>).",
          "example": "ctrl+alt+o"
        }
      },
      "required": [
        "name",
        "message"
      ]
    },
    "keyboard-shortcuts-object": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "basic": {
          "type": "object",
          "description": "Basic navigation shortcuts (e.g., interacting with elements, moving sections, moving focus).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "composer": {
          "type": "object",
          "description": "Message composer shortcuts (e.g., bold, italic, underline).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "message_action": {
          "type": "object",
          "description": "Message action shortcuts (e.g., star message, add reaction, go to writing assistant).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "annotate": {
          "type": "object",
          "description": "Annotation tool shortcuts (e.g., rectangle, add line, text).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "media": {
          "type": "object",
          "description": "Media call shortcuts (e.g., mute/unmute, video on/off, temporary unmute).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "networks": {
          "type": "object",
          "description": "Network navigation shortcuts (e.g., navigate between networks).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "custom": {
          "type": "object",
          "properties": {
            "chat": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/custom-chat-or-widget-entry"
              }
            },
            "widget": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/custom-chat-or-widget-entry"
              }
            },
            "snippet": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/custom-snippet-entry"
              }
            }
          }
        }
      }
    },
    "keyboard-shortcuts-response": {
      "type": "object",
      "properties": {
        "keyboard_shortcuts": {
          "$ref": "#/components/schemas/keyboard-shortcuts-object"
        }
      },
      "required": [
        "keyboard_shortcuts"
      ]
    },
    "update-keyboard-shortcuts-request": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "basic": {
          "type": "object",
          "description": "Basic navigation shortcuts to update (e.g., interacting with elements, moving sections, moving focus).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "composer": {
          "type": "object",
          "description": "Message composer shortcuts to update (e.g., bold, italic, underline).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "message_action": {
          "type": "object",
          "description": "Message action shortcuts to update (e.g., star message, add reaction, go to writing assistant).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "annotate": {
          "type": "object",
          "description": "Annotation tool shortcuts to update (e.g., rectangle, add line, text).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "media": {
          "type": "object",
          "description": "Media call shortcuts to update (e.g., mute/unmute, video on/off, temporary unmute).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "networks": {
          "type": "object",
          "description": "Network navigation shortcuts to update (e.g., navigate between networks).",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "custom": {
          "type": "object",
          "description": "Custom shortcuts to update. To update a custom shortcut, provide the complete details of the shortcut (including the new key mapping and associated chat/widget/snippet information). Partial updates are not supported for custom shortcuts.\n<b>Allowed custom shortcut types:</b>\n<ul>\n  <li><code>chat</code>: Requires an <code>id</code> (chat ID) along with the new shortcut key mapping.</li>\n  <li><code>widget</code>: Requires an <code>id</code> (widget ID) along with the new shortcut key mapping.</li>\n  <li><code>snippet</code>: Requires a <code>name</code>, <code>message</code>, and the new shortcut key mapping.</li>\n</ul>\n",
          "additionalProperties": true
        }
      }
    },
    "delete-keyboard-shortcuts-request": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "basic": {
          "type": "object",
          "description": "Basic navigation shortcuts to delete/reset.",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "composer": {
          "type": "object",
          "description": "Message composer shortcuts to delete/reset.",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "message_action": {
          "type": "object",
          "description": "Message action shortcuts to delete/reset.",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "annotate": {
          "type": "object",
          "description": "Annotation tool shortcuts to delete/reset.",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "media": {
          "type": "object",
          "description": "Media call shortcuts to delete/reset.",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "networks": {
          "type": "object",
          "description": "Network navigation shortcuts to delete/reset.",
          "additionalProperties": {
            "$ref": "#/components/schemas/os-shortcut"
          }
        },
        "custom": {
          "type": "object",
          "description": "Custom shortcuts to delete. Provide the <code>id</code> of each chat or widget shortcut to remove.\n",
          "additionalProperties": true
        },
        "type": {
          "type": "string",
          "enum": [
            "custom",
            "default"
          ],
          "description": "Specifies a bulk delete operation. Use <code>custom</code> to remove all custom shortcuts, or <code>default</code> to reset all default shortcuts to their system defaults. Omit this field to delete only the specific shortcuts provided in the payload.\n",
          "example": "custom"
        }
      }
    }
  }
}