{ "openapi": "3.0.1", "info": { "title": "Helvia.ai Core API", "description": "Central backend API for the Helvia.ai Platform. Manages organizations (workspaces), AI agents (tenants), users, conversation sessions, flow definitions, knowledge bases, NLP pipelines, and third-party integrations. All other platform services read from and write to hbf-core \u2014 it is the single source of truth for all platform configuration and data.", "version": "2.0.0" }, "servers": [ { "url": "https://core-v5.helvia.io", "description": "Generated server url" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Activity Resource" }, { "name": "Analytics Resource" }, { "name": "Api Tokens Moderator Resource" }, { "name": "AuditLog Resource" }, { "name": "Authentication Resource" }, { "name": "Automated Tests", "description": "API endpoints for managing automated tests" }, { "name": "Bot Content Resource" }, { "name": "Bot Deployments Resource", "description": "Moderator Interface" }, { "name": "Bot Template Resource", "description": "Moderator Interface" }, { "name": "BotContentCompiled Resource" }, { "name": "Broadcast Resource", "description": "Moderator Interface" }, { "name": "Chat Session Resource" }, { "name": "CSAT Sections Resource" }, { "name": "Deployment Public Data Resource", "description": "Contains endpoints for retrieving public Bot Deployment data" }, { "name": "DirectLine tokens Resource" }, { "name": "Facebook Handover Resource" }, { "name": "Groups Resource" }, { "name": "Handover Resource" }, { "name": "Integration Resource" }, { "name": "Integrations Resource" }, { "name": "Job Resource" }, { "name": "Knowledge Base Article Resource" }, { "name": "Knowledge Base Group Resource" }, { "name": "Knowledge Base Resource" }, { "name": "Messaging Apps Resource" }, { "name": "Missed Questions Resource" }, { "name": "NLP Pipeline Tree Resource" }, { "name": "NLP Pipelines Resource" }, { "name": "Organization Analytics Resource" }, { "name": "Organization Api Tokens Resource" }, { "name": "Organization Bot Content Resource" }, { "name": "Organization Public Resource" }, { "name": "Organization Resource" }, { "name": "Response Resource" }, { "name": "Semantic Document Segmenter Resource" }, { "name": "Static Variable Resource" }, { "name": "Subscribers Resource" }, { "name": "Survey Resource" }, { "name": "Tenant monitor Resource" }, { "name": "Tenant Public Data Resource", "description": "Contains endpoints for retrieving public Tenant data" }, { "name": "Tenant Recompilation Resource" }, { "name": "Tenant Resource" }, { "name": "Test Set Resource" }, { "name": "Thread Resource" }, { "name": "Ticketing Resource" }, { "name": "Translation Resource" }, { "name": "User account recovery Resource", "description": "Contains endpoints to allow user to reset password" }, { "name": "User email verification Public Resource", "description": "Contains endpoints for user email verification" }, { "name": "User Group Resource" }, { "name": "User Group Resource (Organization)" }, { "name": "User invitation Resource" }, { "name": "User registration Public Resource", "description": "Contains endpoints for user registration" }, { "name": "User Resource" } ], "paths": { "/users/{id}": { "get": { "tags": [ "User Resource" ], "summary": "Get a User by ID; requires moderator access.", "operationId": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "User Resource" ], "summary": "Updates or Creates a new User; requires moderator access.", "operationId": "replace", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "User Resource" ], "summary": "Deletes an existing Subscriber; requires moderator access.", "operationId": "delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "User Resource" ], "summary": "Updates an existing User; requires moderator access.", "operationId": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/{id}": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a Tenant by ID.", "operationId": "get_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeEntryNodes", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Tenant Resource" ], "summary": "Creates or Updates an existing Tenant.", "operationId": "replace_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Tenant Resource" ], "summary": "Deletes an existing Tenant.", "operationId": "delete_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Tenant Resource" ], "summary": "Updates an existing Tenant.", "operationId": "update_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/{id}/stats": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get the stats of a Tenant.", "operationId": "getStats", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Tenant Resource" ], "summary": "Create or update the stats of a Tenant.", "operationId": "createOrReplaceStats", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantStatsDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/subscribers/{id}": { "get": { "tags": [ "Subscribers Resource" ], "summary": "Get a Subscriber by ID; requires moderator access", "operationId": "get_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Subscribers Resource" ], "summary": "Creates or Replace an existing Subscriber; requires moderator access", "operationId": "replace_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Subscribers Resource" ], "summary": "Deletes an existing Subscriber; requires moderator access.", "operationId": "delete_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Subscribers Resource" ], "summary": "Updates an existing Subscriber; requires moderator access.", "operationId": "update_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/responses": { "get": { "tags": [ "Response Resource" ], "summary": "Get a list of Responses; requires moderator access.", "operationId": "list_3", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "includeBroadcast", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "broadcastId", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ObjectId" } }, { "name": "broadcastLabel", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "subscriberHandle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sent", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponsesResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Response Resource" ], "summary": "Creates or Updates a Response; requires moderator access.", "operationId": "upsert", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Response Resource" ], "summary": "Creates a new Response; requires moderator access.", "operationId": "create_4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/responses/{id}": { "get": { "tags": [ "Response Resource" ], "summary": "Get a Response by ID; requires moderator access.", "operationId": "get_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeBroadcast", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Response Resource" ], "summary": "Creates or Updates a Response; requires moderator access.", "operationId": "replace_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Response Resource" ], "summary": "Delete a Response by ID; requires moderator access.", "operationId": "delete_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Response Resource" ], "summary": "Updates an existing Response; requires moderator access.", "operationId": "update_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/public/user-invitations": { "put": { "tags": [ "User invitation Resource" ], "summary": "Retrieve User details using a user invitation token.", "operationId": "getUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [] }, "post": { "tags": [ "User invitation Resource" ], "summary": "Accept user invitation.", "operationId": "accept", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvitationAcceptanceDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [] } }, "/organizations/{orgId}/tenants/{tenantId}/broadcasts/{id}": { "get": { "tags": [ "Broadcast Resource" ], "summary": "Get a Broadcast by ID", "operationId": "get_14", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeGroups", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeResults", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Broadcast Resource" ], "summary": "Create or Update a Broadcast by ID", "operationId": "replace_5", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Broadcast Resource" ], "summary": "Delete a Broadcast by ID", "operationId": "delete_12", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Broadcast Resource" ], "summary": "Update a Broadcast by ID", "operationId": "update_14", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-deployments/{id}/webchat-settings/configuration": { "put": { "tags": [ "Bot Deployments Resource" ], "summary": "Creates or Updates the webchat settings configuration of the given Deployment", "operationId": "replaceWebChatSettings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/backups/{id}": { "put": { "tags": [ "Tenant Resource" ], "summary": "Restore a Tenant's backup.", "operationId": "restore", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Tenant Resource" ], "summary": "Deletes an existing Tenant Backup", "operationId": "deleteBackup", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/activities/batch": { "put": { "tags": [ "Activity Resource" ], "summary": "Creates or Replaces the list of Activities for the Tenant in batches.", "operationId": "batchReplace", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Activity Resource" ], "summary": "Deletes a set of Activities", "operationId": "batchDelete_3", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{id}": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a Tenant by ID", "operationId": "get_16", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeEntryNodes", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Tenant Resource" ], "summary": "Creates or Updates an existing Tenant", "operationId": "replace_6", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Tenant Resource" ], "summary": "Deletes an existing Tenant", "operationId": "delete_15", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Tenant Resource" ], "summary": "Updates an existing Tenant", "operationId": "update_17", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{id}/webchat-settings/configuration": { "put": { "tags": [ "Tenant Resource" ], "summary": "Creates or Updates the webchat settings configuration of the given Tenant", "operationId": "replaceWebChatSettings_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/surveys": { "get": { "tags": [ "Survey Resource" ], "summary": "Get a list of Surveys", "operationId": "list_19", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceActivityName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "INTERVIEW", "LIVECHAT", "USER_FEEDBACK" ] } }, { "name": "sessionId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedChapterResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Survey Resource" ], "summary": "Create or Replace an existing Survey", "operationId": "replace_7", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Survey Resource" ], "summary": "Creates a new Survey", "operationId": "create_19", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/messaging-apps/{id}": { "get": { "tags": [ "Messaging Apps Resource" ], "summary": "Get a Messaging App by ID; requires moderator access.", "operationId": "get_25", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingApp" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Messaging Apps Resource" ], "summary": "Creates or Replaces an existing Messaging App; requires moderator access.", "operationId": "replace_8", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingApp" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Replaced", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MessagingApp" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MessagingApp" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Messaging Apps Resource" ], "summary": "Deletes a Messaging App; requires moderator access.", "operationId": "delete_23", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Messaging Apps Resource" ], "summary": "Updates an existing Messaging App (updates from partial state); requires moderator access.", "operationId": "update_27", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingApp" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/groups/{id}": { "get": { "tags": [ "Groups Resource" ], "summary": "Get a Group by ID; requires moderator access.", "operationId": "get_28", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Groups Resource" ], "summary": "Creates or Update an existing Group; requires moderator access.", "operationId": "replace_9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Groups Resource" ], "summary": "Delete an existing Group; requires moderator access.", "operationId": "delete_25", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" }, "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Groups Resource" ], "summary": "Update an existing Group; requires moderator access.", "operationId": "update_29", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/chat-sessions/{id}": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Get a Chat session by ID; requires moderator access.", "operationId": "get_30", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeMessages", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeLiveChats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Chat Session Resource" ], "summary": "Upserts a Chat Session; requires moderator access.", "operationId": "upsert_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Chat Session Resource" ], "summary": "Delete a Chat Session by uuid; requires moderator access.", "operationId": "delete_27", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Chat Session Resource" ], "summary": "Update a Chat Session by id; requires moderator access.", "operationId": "update_31", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/broadcasts/{id}": { "get": { "tags": [ "Broadcast Resource" ], "summary": "Get a Broadcast by ID; requires moderator access.", "operationId": "get_31", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeGroups", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeResults", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Broadcast Resource" ], "summary": "Create or Update a Broadcast by ID; requires moderator access.", "operationId": "replace_10", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Broadcast Resource" ], "summary": "Delete a Broadcast by ID; requires moderator access.", "operationId": "delete_28", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Broadcast Resource" ], "summary": "Update a Broadcast by ID; requires moderator access.", "operationId": "update_32", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-content-compiled": { "get": { "tags": [ "BotContentCompiled Resource" ], "summary": "Get a list of BotContentCompiled; requires moderator access.", "operationId": "list_37", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "tenantId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedContentCompiledResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "BotContentCompiled Resource" ], "summary": "Replaces an existing Content Compiled given the Tenant's ID; requires moderator access.", "operationId": "updateByTenant", "parameters": [ { "name": "tenantId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotContentCompiledDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "BotContentCompiled Resource" ], "summary": "Creates a new BotContentCompiled; requires moderator access.", "operationId": "create_34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotContentCompiledDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-content-compiled/{id}": { "get": { "tags": [ "BotContentCompiled Resource" ], "summary": "Get a BotContentCompiled by ID; requires moderator access.", "operationId": "get_34", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotContentCompiled" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "BotContentCompiled Resource" ], "summary": "Creates or Updates an existing Bot Content Compiled; requires moderator access.", "operationId": "replace_11", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotContentCompiledDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "BotContentCompiled Resource" ], "summary": "Deletes an existing Content Compiled its ID; requires moderator access.", "operationId": "delete_32", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-content-compiled/{id}/activities-compiled/custom/{activityId}": { "get": { "tags": [ "BotContentCompiled Resource" ], "summary": "Get a custom activity of a Content Compiled; requires moderator access.", "operationId": "getCustomActivity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ActivityCompiled" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "BotContentCompiled Resource" ], "summary": "Update a custom activity of a Content Compiled; requires moderator access.", "operationId": "replaceCustomActivity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityCompiled" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "BotContentCompiled Resource" ], "summary": "Deletes a custom activity of a Content Compiled; requires moderator access.", "operationId": "deleteCustomActivity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/surveys": { "get": { "tags": [ "Survey Resource" ], "summary": "Get a list of Survey", "description": "Get a list of Survey", "operationId": "list_39", "parameters": [ { "name": "tenantId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedChapterResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Survey Resource" ], "summary": "Create or Replace an existing Survey; requires moderator access.", "operationId": "replace_12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Survey Resource" ], "summary": "Creates a new Survey; requires moderator access.", "operationId": "create_36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/users": { "get": { "tags": [ "User Resource" ], "summary": "Get a list of Users; requires moderator access.", "operationId": "list", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "email", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "externalId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeExternalUsers", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedUsersResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "User Resource" ], "summary": "Creates a new User; requires moderator access.", "operationId": "create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/users/{id}/unlock": { "post": { "tags": [ "User Resource" ], "summary": "Unlock a locked user account; requires moderator access.", "operationId": "unlock", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/users/email-verification-request": { "post": { "tags": [ "User Resource" ], "summary": "Request an email verification link.", "operationId": "emailVerification", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/user-groups": { "get": { "tags": [ "User Group Resource" ], "summary": "Get a list of User Groups (paginated); requires moderator access.", "operationId": "getAll", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationRole", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "externalId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchUser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeUsers", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedUserGroupResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "User Group Resource" ], "summary": "Creates a new User Group; requires moderator access.", "operationId": "create_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/user-groups/{id}/users": { "post": { "tags": [ "User Group Resource" ], "summary": "Adds an existing User in a User Group; requires moderator access.", "operationId": "addUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "No content" } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a list of Tenants; requires moderator access.", "operationId": "list_1", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statsUpdateLessThan", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "includeStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeEntryNodes", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTenantsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Tenant Resource" ], "summary": "Creates a new Tenant; requires moderator access.", "operationId": "create_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/{tenantId}/train": { "post": { "tags": [ "Tenant Resource" ], "summary": "Train the NLU linked to a tenant.", "operationId": "train", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "forceFullRetrain", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "202": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/clone": { "post": { "tags": [ "Tenant Resource" ], "summary": "Clone a Tenant; requires moderator access.", "operationId": "clone", "parameters": [ { "name": "source", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "targetOrganizationId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneTenantDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants-recompilation": { "post": { "tags": [ "Tenant Recompilation Resource" ], "summary": "Recompile a list of Tenants; requires moderator access.", "operationId": "recompileTenants", "parameters": [ { "name": "dryRun", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "syncNLU", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/subscribers": { "get": { "tags": [ "Subscribers Resource" ], "summary": "Get a list of Subscribers; requires moderator access.", "operationId": "list_2", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "tenantId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSubscribersResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Subscribers Resource" ], "summary": "Creates a new Subscriber; requires moderator access.", "operationId": "create_3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/registration": { "post": { "tags": [ "User registration Public Resource" ], "summary": "Register a new User & Organization.", "operationId": "register", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/public/sds/webhook": { "post": { "tags": [ "Semantic Document Segmenter Resource" ], "summary": "Send the results of a file to process into articles", "operationId": "handleResults", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SdsUploadedFileArticlesResultsDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [] } }, "/public/ms-directline/token/refresh": { "post": { "tags": [ "DirectLine tokens Resource" ], "summary": "Refresh a DirectLine token", "operationId": "refreshToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [] } }, "/public/monitor/webhook": { "post": { "tags": [ "Tenant monitor Resource" ], "summary": "Handle a new monitoring webhook event", "operationId": "retrieveWebhook", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [] } }, "/public/forgot-password": { "post": { "tags": [ "User account recovery Resource" ], "summary": "Check a forgot password token.", "operationId": "useToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordSubmitDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [] } }, "/public/forgot-password-request": { "post": { "tags": [ "User account recovery Resource" ], "summary": "Send email with token to reset password", "operationId": "sendToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [] } }, "/public/email-verification": { "post": { "tags": [ "User email verification Public Resource" ], "summary": "Check an email verification link.", "operationId": "verifyToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [] } }, "/organizations": { "get": { "tags": [ "Organization Resource" ], "summary": "Get a list of Organizations", "description": "Returns a list of Organizations.", "operationId": "list_4", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "externalId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedOrganizationResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Organization Resource" ], "summary": "Creates a new Organization", "description": "Creates a new Organization.", "operationId": "create_5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/users": { "get": { "tags": [ "User Resource" ], "summary": "Get a list of Users of the specified organization", "operationId": "list_5", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "maximum": 500, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tenantId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "isActive", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "organizationRole", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedUsersResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "User Resource" ], "summary": "Creates a new User for Organization", "operationId": "create_6", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/user-invitations": { "get": { "tags": [ "User invitation Resource" ], "summary": "Get a list of user invitations", "description": "Returns a list of user invitations.", "operationId": "list_6", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedUserInvitationsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "User invitation Resource" ], "summary": "Send a new user invitation link.", "operationId": "create_7", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvitationDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/user-invitations/{id}/revoke": { "post": { "tags": [ "User invitation Resource" ], "summary": "Revoke a user invitation.", "operationId": "revoke", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserInvitationDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/user-groups": { "get": { "tags": [ "User Group Resource (Organization)" ], "summary": "Get a list of User Groups of an Organization (paginated)", "operationId": "list_7", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "organizationRole", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, { "name": "externalId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchUser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeUsers", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedUserGroupResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "User Group Resource (Organization)" ], "summary": "Creates a new User Group under Organization", "operationId": "create_8", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/translations/translate": { "post": { "tags": [ "Translation Resource" ], "summary": "Translate messages", "description": "Translate a list of messages to the specified language", "operationId": "translate", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Translation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/translations/detect": { "post": { "tags": [ "Translation Resource" ], "summary": "Detect messages language", "description": "Return the language of given messages", "operationId": "detectLanguage", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationQuery" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Translation" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a list of Tenants", "operationId": "list_8", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "includeStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeEntryNodes", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeBotDeployments", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTenantsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Tenant Resource" ], "summary": "Creates a new Tenant based on a Template", "operationId": "createTenantInOrganization_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateTenantDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/train": { "post": { "tags": [ "Tenant Resource" ], "summary": "Train the NLU linked to a tenant.", "operationId": "train_1", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "forceFullRetrain", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "202": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/test-sets": { "get": { "tags": [ "Test Set Resource" ], "summary": "Get a list of Test Sets", "operationId": "list_9", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTestSetResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Test Set Resource" ], "summary": "Create a new Test Set", "operationId": "create_9", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TestSetDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/test-sets/{testSetId}/runs": { "get": { "tags": [ "Test Set Resource" ], "summary": "List the test set runs of a Test Set.", "operationId": "listTestSetRunResults", "parameters": [ { "name": "testSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetRunDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Test Set Resource" ], "summary": "Create a Test Set Run.", "operationId": "create_10", "parameters": [ { "name": "testSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetRunExtendedDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TestSetRunExtendedDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/test-sets/{id}": { "get": { "tags": [ "Test Set Resource" ], "summary": "Get a Test Set App by ID.", "operationId": "get_9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Test Set Resource" ], "summary": "Run a Test Set", "operationId": "run", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetRunExtendedDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TestSetRunExtendedDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Test Set Resource" ], "summary": "Delete a Test Set by ID", "operationId": "delete_7", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Test Set Resource" ], "summary": "Updates an existing Test Set", "operationId": "update_8", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TestSetDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/static-variables": { "get": { "tags": [ "Static Variable Resource" ], "summary": "Get a list of Static Variables for the Tenant", "operationId": "list_11", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedStaticVariableResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Static Variable Resource" ], "summary": "Creates a new Static Variable for the Tenant", "operationId": "create_12", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticVariableDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Static Variable Resource" ], "summary": "Deletes an existing Static Variable", "operationId": "deleteStaticVariable", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticVariableDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Static Variable Resource" ], "summary": "Updates an existing Static Variable", "operationId": "updateStaticVariable", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticVariableDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/StaticVariableDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/nlp-pipelines": { "get": { "tags": [ "NLP Pipelines Resource" ], "summary": "Get a list of NLP Pipelines", "description": "Returns a list of NLP Pipelines for this tenant.", "operationId": "list_13", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "CREATED", "OUTDATED", "TRAINING", "FAILED", "READY", "INITIALIZED" ] } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedNLPPipelineResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "NLP Pipelines Resource" ], "summary": "Creates an NLP Pipeline", "description": "Creates an NLP Pipeline in a tenant", "operationId": "create_13", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DialogflowNLP" }, { "$ref": "#/components/schemas/HelviaGPT" }, { "$ref": "#/components/schemas/HelviaNLPSpecification" }, { "$ref": "#/components/schemas/HelviaRAGPipeline" }, { "$ref": "#/components/schemas/LuisNLP" }, { "$ref": "#/components/schemas/OpenAINLP" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DialogflowNLP" }, { "$ref": "#/components/schemas/HelviaGPT" }, { "$ref": "#/components/schemas/HelviaNLPSpecification" }, { "$ref": "#/components/schemas/HelviaRAGPipeline" }, { "$ref": "#/components/schemas/LuisNLP" }, { "$ref": "#/components/schemas/OpenAINLP" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/nlp-pipelines/{id}/train": { "post": { "tags": [ "NLP Pipelines Resource" ], "summary": "Trains an NLP Pipeline", "description": "Trains an NLP Pipeline of a tenant", "operationId": "train_2", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "forceFullRetrain", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/nlp-pipelines/trees": { "get": { "tags": [ "NLP Pipeline Tree Resource" ], "summary": "Get the NLP Pipeline Tree of the Tenant", "description": "Returns the NLP Pipeline for the Tenant.", "operationId": "get_12", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NLPPipelineTreeDataDtoPage" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "NLP Pipeline Tree Resource" ], "summary": "Create a new NLP Pipeline Tree of the Tenant", "description": "Create a new NLP Pipeline for the Tenant.", "operationId": "set", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NLPPipelineTreeDataDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NLPPipelineTreeDataDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/monitor": { "get": { "tags": [ "Tenant Resource" ], "summary": "Retrieve the monitoring service details for a Tenant", "operationId": "retrieveMonitoring", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantMonitorDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Tenant Resource" ], "summary": "Enable the monitoring service for a Tenant", "operationId": "createMonitoring", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Tenant Resource" ], "summary": "Disable the monitoring service for a Tenant", "operationId": "deleteMonitoring", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" }, "201": { "description": "Created" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/groups": { "get": { "tags": [ "Groups Resource" ], "summary": "Get a list of Groups", "operationId": "list_14", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedGroupsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Groups Resource" ], "summary": "Creates a new Group", "operationId": "create_14", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/content-replacement": { "post": { "tags": [ "Tenant Resource" ], "summary": "Replace Tenant content with another.", "operationId": "replaceContent", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "replacementTenantId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceContentResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/broadcasts": { "get": { "tags": [ "Broadcast Resource" ], "summary": "Get a list of Broadcasts", "operationId": "list_16", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeGroups", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeResults", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sendBefore", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "sendAfter", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedBroadcastsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Broadcast Resource" ], "summary": "Create a Broadcast", "description": "Creates a new Broadcast.", "operationId": "create_15", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-deployments": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a list of Bot Deployments", "operationId": "list_17", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedBotDeploymentResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Bot Deployments Resource" ], "summary": "Create a new Bot Deployment", "operationId": "create_16", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-deployments/{id}/clone": { "post": { "tags": [ "Bot Deployments Resource" ], "summary": "Clone a Bot Deployment.", "operationId": "clone_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentCloneDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/backups": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a list of Tenant Backups", "operationId": "listBackups", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTenantBackupsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Tenant Resource" ], "summary": "Create a Tenant's Backup", "operationId": "create_17", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantBackupDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/activities": { "get": { "tags": [ "Activity Resource" ], "summary": "Get a list of Activities for the Tenant", "operationId": "list_18", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedActivityResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Activity Resource" ], "summary": "Creates a new Activity for the Tenant", "operationId": "create_18", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Activity Resource" ], "summary": "Deletes Activities that match the provided prefix", "operationId": "deleteByCriteria", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/clone": { "post": { "tags": [ "Tenant Resource" ], "summary": "Clone a Tenant.", "operationId": "clone_2", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceTenantId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "targetOrganizationId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneTenantDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tags": { "post": { "tags": [ "Organization Resource" ], "summary": "Create a new tag under the requested Organization", "description": "Create a new tag under the requested Organization", "operationId": "createTag", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TagDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/missed-questions": { "get": { "tags": [ "Missed Questions Resource" ], "summary": "Get the missed questions of a tenant", "operationId": "listMissedQuestions_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } }, { "name": "question", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedMissedQuestionResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Missed Questions Resource" ], "summary": "Create a missed question", "operationId": "createMissedQuestion_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MissedQuestionCreateDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MissedQuestion" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases": { "get": { "tags": [ "Knowledge Base Resource" ], "summary": "Get a list of Knowledge Bases", "description": "Returns a list of Knowledge Bases for this organization.", "operationId": "list_20", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "space", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "bot-lab", "cx", "ex" ] } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "INTERNAL", "INTEGRATION", "SHARED" ] } } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "includeOrganization", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenants", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedKnowledgeBaseResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Knowledge Base Resource" ], "summary": "Creates a Knowledge Base", "description": "Creates a knowledge base in an organization", "operationId": "create_20", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Knowledge Base Resource" ], "summary": "Deletes a list of Knowledge Bases", "description": "Deletes a list of knowledge bases in an organization", "operationId": "bulkDelete_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/kb-groups": { "get": { "tags": [ "Knowledge Base Group Resource" ], "summary": "Get a list of Knowledge Base Groups", "description": "Returns a list of Knowledge Bases Articles for this Knowledge Base.", "operationId": "list_21", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedKnowledgeBaseGroupResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Knowledge Base Group Resource" ], "summary": "Creates a Knowledge Base Group", "description": "Creates a knowledge base group in a knowledge base", "operationId": "create_21", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "404": { "description": "Not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/kb-groups/bulk-update": { "post": { "tags": [ "Knowledge Base Group Resource" ], "summary": "Updates Knowledge Base Groups in bulk", "description": "Updates a knowledge base groups in an organization", "operationId": "bulkUpdate", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/file-to-articles": { "post": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Creates multiple Knowledge Base Articles after processing the uploaded file", "description": "Creates multiple Knowledge Base Articles after processing the uploaded file", "operationId": "upload", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFileToArticlesDto" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/articles": { "get": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Get a list of Knowledge Base Articles", "description": "Returns a list of Knowledge Bases Articles for this Knowledge Base.", "operationId": "list_22", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parentArticleId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "body", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "includeKnowledgeBase", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedKnowledgeBaseArticleResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Creates a Knowledge Base Article", "description": "Creates a knowledge base article in a knowledge base", "operationId": "create_22", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticleDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticleDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/articles/bulk-update": { "post": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Updates Knowledge Base Articles in bulk", "description": "Updates a knowledge base articles in an organization", "operationId": "bulkUpdate_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseArticleDto" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/articles/bulk-delete": { "post": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Deletes a list of Knowledge Bases Articles", "description": "Deletes a list of knowledge bases articles in an organization", "operationId": "bulkDelete", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/articles/bulk-create": { "post": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Creates a list of Knowledge Base Articles", "description": "Creates a list of knowledge base articles in a knowledge base", "operationId": "bulkCreate", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseArticleDto" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseArticleDto" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{id}/sync": { "post": { "tags": [ "Knowledge Base Resource" ], "summary": "Syncs a Knowledge Base", "description": "Syncs a knowledge base of an organization", "operationId": "sync", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{id}/sync-article-updates": { "post": { "tags": [ "Knowledge Base Resource" ], "summary": "Syncs a Knowledge Base", "description": "Syncs a knowledge base of an organization given am update body", "operationId": "syncWebhook", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{id}/content": { "post": { "tags": [ "Knowledge Base Resource" ], "summary": "Updates the content of a knowledge base", "description": "Updates the content of a knowledge base", "operationId": "updateContent", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseContentDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Created" }, "201": { "description": "Created" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/shared": { "post": { "tags": [ "Knowledge Base Resource" ], "summary": "Creates a shared Knowledge Base", "description": "Creates a shared Knowledge base in an organization", "operationId": "createShared", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSharedDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/bulk-update": { "post": { "tags": [ "Knowledge Base Resource" ], "summary": "Updates a set of Knowledge Bases", "description": "Updates a set of Knowledge Bases", "operationId": "bulkUpdate_2", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseDto" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/bulk-sync": { "post": { "tags": [ "Knowledge Base Resource" ], "summary": "Syncs a list of Knowledge Bases", "description": "Syncs a list of knowledge bases of an organization", "operationId": "bulkSync", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/jobs": { "get": { "tags": [ "Job Resource" ], "summary": "Get a list of Jobs", "description": "Get a list of Jobs", "operationId": "getJobs", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "STARTING", "RUNNING", "STOPPED", "COMPLETED", "FAILED" ] } } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SDS", "KB_GROUP", "AUTO_BOT_TEST" ] } }, { "name": "objectId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "jobIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedJobResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Job Resource" ], "summary": "Creates a job", "description": "Creates a job", "operationId": "createJob", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutoBotTestJob" }, { "$ref": "#/components/schemas/KbGroupJob" }, { "$ref": "#/components/schemas/SdsJob" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/jobs/{id}/cancel": { "post": { "tags": [ "Job Resource" ], "summary": "Cancels a job", "description": "Cancels a Jobs", "operationId": "cancelJob", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/jobs/bulk-create": { "post": { "tags": [ "Job Resource" ], "summary": "Creates jobs", "description": "Creates jobs", "operationId": "bulkCreateJobs", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AutoBotTestJob" }, { "$ref": "#/components/schemas/KbGroupJob" }, { "$ref": "#/components/schemas/SdsJob" } ] } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/integrations": { "get": { "tags": [ "Integration Resource" ], "summary": "Get a list of Integrations", "operationId": "list_23", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "OIDC_AUTHENTICATION", "MICROSOFT_DYNAMICS_CRM", "MICROSOFT_DYNAMICS_KB", "CISCO_LIVECHAT", "HELVIA_LIVECHAT", "ZENDESK_LIVECHAT", "GENESYS_LIVECHAT", "AZURE_AI_LLM", "OPEN_AI_LLM", "GEMINI_AI_LLM", "ZENDESK_TICKETING", "GOOGLE_TRANSLATION" ] } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AUTHENTICATION", "CRM", "KB", "LIVECHAT", "LLM", "TICKETING", "TRANSLATION" ] } }, { "name": "enabled", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Integration Resource" ], "summary": "Creates a new Integration", "operationId": "create_23", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AzureAIIntegration" }, { "$ref": "#/components/schemas/CiscoLivechatIntegration" }, { "$ref": "#/components/schemas/GeminiAIIntegration" }, { "$ref": "#/components/schemas/GenesysLivechatIntegration" }, { "$ref": "#/components/schemas/GoogleTranslationIntegration" }, { "$ref": "#/components/schemas/HelviaLivechatIntegration" }, { "$ref": "#/components/schemas/MicrosoftDynamicsCrmIntegration" }, { "$ref": "#/components/schemas/MicrosoftDynamicsKbIntegration" }, { "$ref": "#/components/schemas/OIDCIntegration" }, { "$ref": "#/components/schemas/OpenAIIntegration" }, { "$ref": "#/components/schemas/ZendeskLivechatIntegration" }, { "$ref": "#/components/schemas/ZendeskTicketingIntegration" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/csat-sections": { "get": { "tags": [ "CSAT Sections Resource" ], "summary": "Get a list of Organization CSAT Sections", "description": "Returns a list of Organization CSAT Sections.", "operationId": "list_24", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "DELETED" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCSATSectionResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "CSAT Sections Resource" ], "summary": "Create a new CSAT Section under the requested Organization", "description": "Create a new CSAT Section under the requested Organization", "operationId": "create_24", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSATSectionDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CSATSectionDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/automated-tests": { "get": { "tags": [ "Automated Tests" ], "summary": "Get all automated tests of a specific organization based on criteria", "operationId": "list_27", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "QA_TEST", "DIALOG_TEST" ] } } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] } }, { "name": "examinedTenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "percentGte", "in": "query", "required": false, "schema": { "type": "number", "format": "double" } }, { "name": "percentLte", "in": "query", "required": false, "schema": { "type": "number", "format": "double" } }, { "name": "searchText", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successfully retrieved all automated tests", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageDtoAutomatedTest" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Automated Tests" ], "summary": "Create a new automated test", "operationId": "create_25", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successfully created the automated test", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/automated-tests/{id}/clone": { "post": { "tags": [ "Automated Tests" ], "summary": "Clone an automated test", "operationId": "clone_3", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoBotTestCloneDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successfully cloned the automated test", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } } }, "404": { "description": "Automated test not found", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/api-tokens": { "get": { "tags": [ "Organization Api Tokens Resource" ], "summary": "Get a list of Organization Api Tokens", "operationId": "list_28", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedApiTokenResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Organization Api Tokens Resource" ], "summary": "Creates a new Organization Api Token", "operationId": "create_26", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTokenDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTokenDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{id}/spell-check": { "post": { "tags": [ "Organization Resource" ], "summary": "Spell check a text using the language tool", "description": "Spell check a text using the language tool", "operationId": "spellCheck", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpellCheckDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LanguageToolSpellCheckResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{id}/audit-logs": { "get": { "tags": [ "Organization Resource" ], "summary": "Get the audit-logs of the requested Organization", "description": "Get the audit-logs of the requested Organization.", "operationId": "getAuditLogs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ACCESS_CONTROL", "CONTENT", "BOT_SETTINGS", "BOT_DEPLOYMENTS", "ORG_SETTINGS", "ORG_MANAGEMENT" ] } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedAuditLogResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Organization Resource" ], "summary": "Post a new audit-log under the requested Organization", "description": "Post a new audit-log under the requested Organization", "operationId": "createAuditLog", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Organization Resource" ], "summary": "Delete the audit-logs of the requested organization", "description": "Delete the audit-logs of the requested organization", "operationId": "deleteAuditLogs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/nlp-pipelines/{id}/train": { "post": { "tags": [ "NLP Pipelines Resource" ], "summary": "Trains an NLP Pipeline", "description": "Trains an NLP Pipeline of a tenant", "operationId": "train_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "forceFullRetrain", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/nlp-pipelines/trees/recompile-all": { "post": { "tags": [ "NLP Pipelines Resource" ], "summary": "Recompile all NLP Pipeline Trees", "description": "Recompile all NLP Pipeline Trees", "operationId": "recompileAll", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/messaging-apps": { "get": { "tags": [ "Messaging Apps Resource" ], "summary": "Get a list of Messaging Apps; requires moderator access.", "operationId": "list_29", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Messaging Apps Resource" ], "summary": "Creates a new Messaging App; requires moderator access.", "operationId": "create_27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagingApp" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created" }, "409": { "description": "App Id exists" } }, "security": [ { "bearerAuth": [] } ] } }, "/logout": { "post": { "tags": [ "Authentication Resource" ], "operationId": "logout", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ] } }, "/login": { "post": { "tags": [ "Authentication Resource" ], "operationId": "login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialsAuthenticationRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/login/teams": { "post": { "tags": [ "Authentication Resource" ], "operationId": "loginByMicrosoftTeams", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsAuthenticationRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/login/refresh": { "post": { "tags": [ "Authentication Resource" ], "operationId": "loginRefresh", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthenticationResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/login/microsoft": { "post": { "tags": [ "Authentication Resource" ], "operationId": "loginByMicrosoft", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MicrosoftAuthenticationRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/login/integration": { "post": { "tags": [ "Authentication Resource" ], "operationId": "loginByIntegration", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OIDCAuthenticationRequestDto" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/login/google": { "post": { "tags": [ "Authentication Resource" ], "operationId": "loginByGoogle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAuthenticationRequestDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers": { "get": { "tags": [ "Handover Resource" ], "summary": "Get a list of Handover Links", "description": "Get a list of Handover Links", "operationId": "list_30", "parameters": [ { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "createdBefore", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "updatedBefore", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "sourceHandle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceSubscriberHandle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetHandle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetSubscriberHandle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetChannelId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetThreadId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Handover Resource" ], "summary": "Create a new Handover Link entry", "description": "Create a new Handover Link entry", "operationId": "create_28", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/groups": { "get": { "tags": [ "Groups Resource" ], "summary": "Get a list of Groups", "description": "Returns a list of Groups satisfying the query parameter.", "operationId": "list_31", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "tenantId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "handle", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedGroupsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Groups Resource" ], "summary": "Creates a new Group", "operationId": "create_29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/fb-handovers": { "get": { "tags": [ "Facebook Handover Resource" ], "summary": "Get a list of FbHandovers; requires moderator access.", "operationId": "list_32", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "tenantId", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ObjectId" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "subscriberHandle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updatedBefore", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FbHandoverDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Facebook Handover Resource" ], "summary": "Create a new Fbhandover entry; requires moderator access.", "operationId": "create_30", "parameters": [ { "name": "tenantId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FbHandoverDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FbHandoverDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/chat-sessions": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Get list of chat sessions; requires moderator access.", "operationId": "list_33", "parameters": [ { "name": "includeMessages", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeLiveChats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "tenantId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "COMPLETED" ] } }, { "name": "lastInteractionLessThan", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Chat Session Resource" ], "summary": "Creates a new Chat Session; requires moderator access.", "operationId": "create_31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/chat-sessions/{id}/variables": { "post": { "tags": [ "Chat Session Resource" ], "summary": "Adds variable mappings to a session; requires moderator access.", "operationId": "addVariables", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ChatSessionVariableMapping" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/chat-sessions/{id}/messages": { "post": { "tags": [ "Chat Session Resource" ], "summary": "Adds a new Chat Session message; requires moderator access.", "operationId": "addMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionMessageDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/chat-sessions/{id}/messages/batch": { "post": { "tags": [ "Chat Session Resource" ], "summary": "Adds a list of Chat Session message; requires moderator access.", "operationId": "addMessages", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatSessionMessageDto" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/broadcasts": { "get": { "tags": [ "Broadcast Resource" ], "summary": "Get a list of Broadcasts; requires moderator access", "operationId": "list_34", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeGroups", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeResults", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sendBefore", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "sendAfter", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tenantId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedBroadcastsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Broadcast Resource" ], "summary": "Create a new Broadcast; requires moderator access.", "operationId": "create_32", "parameters": [ { "name": "tenantId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "userEmail", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BroadcastDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-templates": { "get": { "tags": [ "Bot Template Resource" ], "summary": "Get a list of Bot Templates; requires moderator access.", "operationId": "list_35", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedBotTemplatesResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Bot Template Resource" ], "summary": "Create a new Bot Template; requires moderator access.", "operationId": "create_33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotTemplateDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-content-compiled/{id}/activities-compiled/custom": { "post": { "tags": [ "BotContentCompiled Resource" ], "summary": "Created a custom activity of a Content Compiled; requires moderator access.", "operationId": "createCustomActivity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityCompiled" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ActivityCompiled" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/audit-logs": { "post": { "tags": [ "AuditLog Resource" ], "summary": "Post a new audit-log under the requested Organization", "description": "Post a new audit-log under the requested Organization", "operationId": "createAuditLog_1", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/api-tokens": { "get": { "tags": [ "Api Tokens Moderator Resource" ], "summary": "Get a list of Moderator Api Tokens", "operationId": "list_38", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedApiTokenResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Api Tokens Moderator Resource" ], "summary": "Creates a new Moderator Api Token", "operationId": "create_35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTokenDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTokenDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/analytics/messages/{id}/tags": { "post": { "tags": [ "Analytics Resource" ], "summary": "Add tags to a Chat Session Message by id; requires moderator access.", "operationId": "addMessageTags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChatSessionMessage" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/user-groups/{id}": { "get": { "tags": [ "User Group Resource" ], "summary": "Get a User Group by ID; requires moderator access.", "operationId": "get_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "User Group Resource" ], "summary": "Deletes an existing User Group; requires moderator access.", "operationId": "delete_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "No content" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "User Group Resource" ], "summary": "Updates an existing User Group; requires moderator access.", "operationId": "update_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/users/{id}": { "get": { "tags": [ "User Resource" ], "summary": "Get a User by ID", "operationId": "get_7", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "User Resource" ], "summary": "Removes a User from an organization", "operationId": "delete_5", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "User Resource" ], "summary": "Updates an existing User", "operationId": "update_5", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/user-groups/{id}": { "get": { "tags": [ "User Group Resource (Organization)" ], "summary": "Get a User Group by ID in Organization", "operationId": "get_8", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "User Group Resource (Organization)" ], "summary": "Deletes an existing User Group in an Organization", "operationId": "delete_6", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "User Group Resource (Organization)" ], "summary": "Updates an existing User Group of an Organization", "operationId": "update_6", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/test-sets/{testSetId}/runs/{testSetRunId}": { "patch": { "tags": [ "Test Set Resource" ], "summary": "Update a Test Set Run.", "operationId": "update_7", "parameters": [ { "name": "testSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "testSetRunId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetRunExtendedDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TestSetRunExtendedDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/nlp-pipelines/{id}": { "get": { "tags": [ "NLP Pipelines Resource" ], "summary": "Get an NLP Pipeline", "description": "Returns an NLP Pipeline from an organization.", "operationId": "get_11", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedNLPPipelineResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "NLP Pipelines Resource" ], "summary": "Deletes an NLP Pipeline", "description": "Deletes an NLP Pipeline in a tenant", "operationId": "delete_9", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "NLP Pipelines Resource" ], "summary": "Updates an NLP Pipeline", "description": "Updates an NLP Pipeline in a tenant", "operationId": "update_10", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DialogflowNLP" }, { "$ref": "#/components/schemas/HelviaGPT" }, { "$ref": "#/components/schemas/HelviaNLPSpecification" }, { "$ref": "#/components/schemas/HelviaRAGPipeline" }, { "$ref": "#/components/schemas/LuisNLP" }, { "$ref": "#/components/schemas/OpenAINLP" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/nlp-pipelines/trees/{treeId}": { "get": { "tags": [ "NLP Pipeline Tree Resource" ], "summary": "Get a specific NLP Pipeline Tree of the Tenant", "description": "Geta a specific NLP Pipeline for the Tenant.", "operationId": "getOne", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "treeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeDecisionTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NLPPipelineTreeDataDtoPage" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "NLP Pipeline Tree Resource" ], "summary": "Delete a NLP Pipeline Tree of the Tenant", "description": "Delete a NLP Pipeline for the Tenant.", "operationId": "delete_10", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "treeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NLPPipelineTreeDataDtoPage" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "NLP Pipeline Tree Resource" ], "summary": "Update a NLP Pipeline Tree of the Tenant", "description": "Update a NLP Pipeline for the Tenant.", "operationId": "update_11", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "treeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NLPPipelineTreeDataDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NLPPipelineTreeDataDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/groups/{id}": { "delete": { "tags": [ "Groups Resource" ], "summary": "Deletes a Group", "operationId": "delete_11", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Groups Resource" ], "summary": "Updates a Group", "operationId": "update_12", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-deployments/{id}": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a Bot Deployment App by ID.", "operationId": "get_15", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Bot Deployments Resource" ], "summary": "Delete a Bot Deployment by ID", "operationId": "delete_13", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Bot Deployments Resource" ], "summary": "Updates an existing Bot Deployment", "operationId": "update_15", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/activities/{id}": { "get": { "tags": [ "Activity Resource" ], "summary": "Get a specific Activity for the Tenant", "operationId": "getById_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Activity Resource" ], "summary": "Deletes an existing Activity", "operationId": "delete_14", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Activity Resource" ], "summary": "Creates or Updates an existing Activity.", "operationId": "update_16", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/activities/main": { "get": { "tags": [ "Activity Resource" ], "summary": "Get the main Activity id for the Tenant", "operationId": "getMainActivityId", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Activity Resource" ], "summary": "Update the main Activity id for the Tenant", "operationId": "updatetMainActivityId", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MainActivityIdDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/surveys/{id}": { "get": { "tags": [ "Survey Resource" ], "summary": "Get a specific Survey.", "operationId": "getById_2", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedChapterResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Survey Resource" ], "summary": "Deletes an existing Survey.", "operationId": "delete_16", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Survey Resource" ], "summary": "Updates an existing Survey", "operationId": "update_18", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/missed-questions/{id}": { "get": { "tags": [ "Missed Questions Resource" ], "summary": "Get a missed question by id", "operationId": "findMissedQuestion_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MissedQuestion" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Missed Questions Resource" ], "summary": "Update a missed question", "operationId": "updateMissedQuestion_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MissedQuestionDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MissedQuestion" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/kb-groups/{id}": { "get": { "tags": [ "Knowledge Base Group Resource" ], "summary": "Get a Knowledge Base Group", "description": "Returns a knowledge base group from a knowledge base.", "operationId": "get_17", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Knowledge Base Group Resource" ], "summary": "Deletes a Knowledge Base Group", "description": "Deletes a knowledge base group in a knowledge base", "operationId": "delete_17", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deleteArticles", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "async", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "202": { "description": "Accepted (Async) - Returns Job", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "No Content", "content": { "*/*": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Knowledge Base Group Resource" ], "summary": "Updates a Knowledge Base Group", "description": "Updates a knowledge base group in an organization", "operationId": "update_19", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/articles/{id}": { "get": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Get a Knowledge Base Article", "description": "Returns a knowledge base article from a knowledge base.", "operationId": "get_18", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeKnowledgeBase", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedKnowledgeBaseArticleResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Deletes a Knowledge Base Article", "description": "Deletes a knowledge base article in a knowledge base", "operationId": "delete_18", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Updates a Knowledge Base Article", "description": "Updates a knowledge base article in an organization", "operationId": "update_20", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticleDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{id}": { "get": { "tags": [ "Knowledge Base Resource" ], "summary": "Get a Knowledge Base", "description": "Returns a knowledge base from an organization.", "operationId": "get_19", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeOrganization", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenants", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedKnowledgeBaseResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Knowledge Base Resource" ], "summary": "Deletes a Knowledge Base", "description": "Deletes a knowledge base in an organization", "operationId": "delete_19", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Knowledge Base Resource" ], "summary": "Updates a Knowledge Base", "description": "Updates a knowledge base in an organization", "operationId": "update_21", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/integrations/{id}": { "get": { "tags": [ "Integration Resource" ], "summary": "Gets an Integration", "description": "Returns an integration from an organization.", "operationId": "get_20", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Integration Resource" ], "summary": "Deletes an existing Integration", "operationId": "delete_20", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Integration Resource" ], "summary": "Updates an existing Integration", "operationId": "update_22", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AzureAIIntegration" }, { "$ref": "#/components/schemas/CiscoLivechatIntegration" }, { "$ref": "#/components/schemas/GeminiAIIntegration" }, { "$ref": "#/components/schemas/GenesysLivechatIntegration" }, { "$ref": "#/components/schemas/GoogleTranslationIntegration" }, { "$ref": "#/components/schemas/HelviaLivechatIntegration" }, { "$ref": "#/components/schemas/MicrosoftDynamicsCrmIntegration" }, { "$ref": "#/components/schemas/MicrosoftDynamicsKbIntegration" }, { "$ref": "#/components/schemas/OIDCIntegration" }, { "$ref": "#/components/schemas/OpenAIIntegration" }, { "$ref": "#/components/schemas/ZendeskLivechatIntegration" }, { "$ref": "#/components/schemas/ZendeskTicketingIntegration" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/csat-sections/{id}": { "delete": { "tags": [ "CSAT Sections Resource" ], "summary": "Soft delete of a CSAT Section by ID", "operationId": "softDelete", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "CSAT Sections Resource" ], "summary": "Updates an existing CSAT Section of an Organization", "operationId": "update_23", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSATSectionDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSATSectionDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions/{id}": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Get a Chat Session by ID", "operationId": "get_21", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeMessages", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeLiveChats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSummary", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Chat Session Resource" ], "summary": "Update a Chat Session by id.", "operationId": "update_24", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions/{id}/tags": { "patch": { "tags": [ "Chat Session Resource" ], "summary": "Updates the tags of a chat session", "operationId": "updateTags_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/automated-tests/{id}": { "get": { "tags": [ "Automated Tests" ], "summary": "Get an automated test by ID in organization", "operationId": "get_23", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successfully retrieved the automated test", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } } }, "404": { "description": "Automated test not found", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Automated Tests" ], "summary": "Delete an automated test", "operationId": "delete_21", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successfully deleted the automated test" }, "404": { "description": "Automated test not found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Automated Tests" ], "summary": "Update an automated test", "operationId": "update_25", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successfully updated the automated test", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } } }, "404": { "description": "Automated test not found", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{id}": { "get": { "tags": [ "Organization Resource" ], "summary": "Get the Organization info", "description": "Get the Organization info.", "operationId": "get_24", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeLoginSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Organization Resource" ], "summary": "Delete an Organization", "description": "Delete an Organization", "operationId": "deleteOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Organization Resource" ], "summary": "Update the Organization", "description": "Update the User's Organization", "operationId": "update_26", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers/{id}": { "get": { "tags": [ "Handover Resource" ], "summary": "Get a Handover Entry", "description": "Returns an Handover Link by ID", "operationId": "get_27", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Handover Resource" ], "summary": "Delete a Handover Entry", "description": "Delete an Handover Link by ID", "operationId": "delete_24", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation" }, "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Handover Resource" ], "summary": "Update a Handover by ID", "description": "Update a Handover by ID.", "operationId": "update_28", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/fb-handovers/{id}": { "get": { "tags": [ "Facebook Handover Resource" ], "summary": "Get a FbHandover by ID; requires moderator access.", "operationId": "get_29", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FbHandoverDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Facebook Handover Resource" ], "summary": "Delete a FbHandover Entry; requires moderator access.", "operationId": "delete_26", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation" }, "204": { "description": "No Content" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Facebook Handover Resource" ], "summary": "Update a FbHandover by ID; requires moderator access.", "operationId": "update_30", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FbHandoverDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/chat-sessions/batch/complete": { "patch": { "tags": [ "Chat Session Resource" ], "summary": "Set chat session status to 'COMPLETED' for multiple chat sessions", "operationId": "batchSetStatusCompleted", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionBatchSetStatusCompletedDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-templates/{id}": { "get": { "tags": [ "Bot Template Resource" ], "summary": "Get a Bot Template by ID; requires moderator access.", "operationId": "get_32", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotTemplateDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Bot Template Resource" ], "summary": "Delete a Bot Template by ID; requires moderator access.", "operationId": "delete_29", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Bot Template Resource" ], "summary": "Updates an existing Bot Template; requires moderator access.", "operationId": "update_33", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotTemplateDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-deployments/{id}": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a Bot Deployment App by ID; requires moderator access.", "operationId": "get_33", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Bot Deployments Resource" ], "summary": "Delete a Bot Deployment by ID; requires moderator access.", "operationId": "delete_30", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Bot Deployments Resource" ], "summary": "Updates an existing Bot Deployment; requires moderator access.", "operationId": "update_34", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/surveys/{id}": { "get": { "tags": [ "Survey Resource" ], "summary": "Get a specific Survey; requires moderator access.", "operationId": "getById_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedChapterResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Survey Resource" ], "summary": "Deletes an existing Survey; requires moderator access.", "operationId": "delete_34", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Survey Resource" ], "summary": "Updates an existing Survey; requires moderator access.", "operationId": "update_35", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/users/me": { "get": { "tags": [ "User Resource" ], "summary": "Get details of current user", "operationId": "getCurrentUser", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/users/email": { "get": { "tags": [ "User Resource" ], "summary": "Get User by Email; requires moderator access.", "operationId": "getByEmail", "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/thread/sleep": { "get": { "tags": [ "Thread Resource" ], "operationId": "sleep", "parameters": [ { "name": "millis", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/{tenantId}/process": { "get": { "tags": [ "Tenant Resource" ], "summary": "Processes a message in a tenant", "description": "Processes a message in a tenant", "operationId": "process", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "subscriberId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "detectLanguage", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "cacheResult", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "sessionId", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "saveMissedQuestion", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "messageId", "in": "query", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NLPProcessDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/{id}/timestamp": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a Tenant's Timestamp.", "operationId": "getTimestamp", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/usage": { "get": { "tags": [ "Tenant Resource" ], "summary": "List tenants usage", "operationId": "listUsage", "parameters": [ { "name": "includeOnlyWithUsageLimits", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/plugins/{pluginCategory}/integrations": { "get": { "tags": [ "Tenant Resource" ], "summary": "List all distinct integrations connected by tenant plugins", "operationId": "listDistinctIntegrations", "parameters": [ { "name": "pluginCategory", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "AUTHENTICATION", "CRM", "KB", "LIVECHAT", "LLM_NODE", "LLM_TOPIC_MODELLING", "LLM_SUMMARIZATION", "LLM_SEMANTIC_SEARCH_NODE", "LLM_AUTOMATED_AGENT_TESTING", "LLM_LANGUAGE_DETECTION", "TICKETING" ] } }, { "name": "integrationType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "OIDC_AUTHENTICATION", "MICROSOFT_DYNAMICS_CRM", "MICROSOFT_DYNAMICS_KB", "CISCO_LIVECHAT", "HELVIA_LIVECHAT", "ZENDESK_LIVECHAT", "GENESYS_LIVECHAT", "AZURE_AI_LLM", "OPEN_AI_LLM", "GEMINI_AI_LLM", "ZENDESK_TICKETING", "GOOGLE_TRANSLATION" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/handle/{handle}": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a Tenant by Handle.", "operationId": "getByHandle", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeEntryNodes", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includePipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/tenants/handle/{handle}/timestamp": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a Tenant's Timestamp by Handle.", "operationId": "getTimestampByHandle", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/subscribers/handle/{handle}": { "get": { "tags": [ "Subscribers Resource" ], "summary": "Get a Subscriber by Handle; requires moderator access.", "operationId": "getByHandle_1", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/public/user-invitations/{id}": { "get": { "tags": [ "User invitation Resource" ], "summary": "Get a user invitation by id", "description": "Returns a user invitation by id.", "operationId": "get_5", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedUserInvitationsResponse" } } } } }, "security": [] } }, "/public/tenants/{tenantId}": { "get": { "tags": [ "Tenant Public Data Resource" ], "summary": "Get the Tenant's Info", "description": "Fetches the Tenant's image, webchat settings and timezone.", "operationId": "getInfo", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [] } }, "/public/tenants/{tenantId}/webchat-settings": { "get": { "tags": [ "Tenant Public Data Resource" ], "summary": "Get the Tenant's webchat settings", "description": "Fetches the webchat settings of the Tenant.", "operationId": "getWebChatSettings", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebChatSettings" } } } } }, "deprecated": true, "security": [] } }, "/public/tenants/{tenantId}/image": { "get": { "tags": [ "Tenant Public Data Resource" ], "summary": "Get the Tenant's Avatar", "description": "Redirects the client to the location of the given tenant's avatar.", "operationId": "getImage", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation" }, "302": { "description": "Found" } }, "security": [] } }, "/public/tenants/{tenantId}/health-check": { "get": { "tags": [ "Tenant Public Data Resource" ], "summary": "Get the health check status of Tenant", "description": "Runs various checks against the Tenant to ensure it works.", "operationId": "getHealthCheck", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation" } }, "security": [] } }, "/public/tenants/{tenantId}/entry-points": { "get": { "tags": [ "Tenant Public Data Resource" ], "summary": "Get a list of entry points for the tenant.", "description": "Returns a list of entry points for the tenant.", "operationId": "getEntryPoints", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntryPoint" } } } } } }, "security": [] } }, "/public/organizations/{id}": { "get": { "tags": [ "Organization Public Resource" ], "summary": "Get the Organization public info", "description": "Get the Organization info with public information", "operationId": "get_6", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeLoginSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } } }, "security": [] } }, "/public/ms-directline/token/new": { "get": { "tags": [ "DirectLine tokens Resource" ], "summary": "Retrieve a new DirectLine token", "operationId": "retrieveToken", "parameters": [ { "name": "botDeploymentId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [] } }, "/public/ms-directline/token/mock": { "get": { "tags": [ "DirectLine tokens Resource" ], "summary": "Mock retrieve a new DirectLine token. This is useful when load testing.", "operationId": "mockRetrieveToken", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [] } }, "/public/bot-deployments": { "get": { "tags": [ "Deployment Public Data Resource" ], "summary": "Get the Bot Deployment's Info by Tenant", "description": "Fetches the Tenant's image and timezone and Bot Deployment's Webchat settings. The Bot Deployment is the first found that is not is not used for Preview. ", "operationId": "getInfoByTenantId", "parameters": [ { "name": "tenantId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true, "security": [] } }, "/public/bot-deployments/{id}": { "get": { "tags": [ "Deployment Public Data Resource" ], "summary": "Get the Bot Deployment's Info", "description": "Fetches the Tenant's image and timezone and Bot Deployment's Webchat settings.", "operationId": "getInfo_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [] } }, "/public/bot-deployments/{id}/webchat-settings": { "get": { "tags": [ "Deployment Public Data Resource" ], "summary": "Get the Bot Deployment's webchat settings", "description": "Fetches the webchat settings of the Bot Deployment.", "operationId": "getWebChatSettings_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebChatSettings" } } } } }, "security": [] } }, "/public/bot-deployments/webchat-settings": { "get": { "tags": [ "Deployment Public Data Resource" ], "summary": "Get the Bot Deployment's webchat settings by Tenant", "description": "Fetches the webchat settings of the Tenant's first deployment.", "operationId": "getWebChatSettingsByTenant", "parameters": [ { "name": "tenantId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebChatSettings" } } } } }, "deprecated": true, "security": [] } }, "/organizations/{orgId}/users/list": { "get": { "tags": [ "User Resource" ], "summary": "Get a thin list of Users of the specified organization", "operationId": "thinList", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationRole", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedUsersResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/user-groups/name/{name}": { "get": { "tags": [ "User Group Resource (Organization)" ], "summary": "Get a User Group by name; requires moderator access.", "operationId": "getByName", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/tickets": { "get": { "tags": [ "Ticketing Resource" ], "summary": "Get a list of tickets", "description": "Get a list of tickets from a tenant integration", "operationId": "getTickets", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "associatedId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTicketsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/tickets/{ticketId}": { "get": { "tags": [ "Ticketing Resource" ], "summary": "Get a specific ticket by id", "description": "Get a specific ticket from a tenant integration", "operationId": "getTicket", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedTicketsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/test-sets/{testSetId}/runs/{id}": { "get": { "tags": [ "Test Set Resource" ], "summary": "Get the run result of a Test Set by id.", "operationId": "getRunResults", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "testSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetRunExtendedDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/test-sets/{testSetId}/export/{id}": { "get": { "tags": [ "Test Set Resource" ], "summary": "Export data of a specific test set run in excel format.", "description": "Export the data of a test set run given its id.", "operationId": "exportById", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "testSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/responses": { "get": { "tags": [ "Response Resource" ], "summary": "Get a list of Responses", "description": "Returns a list of Responses satisfying the query parameter.", "operationId": "list_12", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "includeBroadcast", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "broadcastId", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ObjectId" } }, { "name": "broadcastLabel", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "subscriberHandle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sent", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponsesResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/responses/{id}": { "get": { "tags": [ "Response Resource" ], "summary": "Get a Response by ID", "description": "Returns a specific Response by ID.", "operationId": "get_10", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeBroadcast", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/process": { "get": { "tags": [ "Tenant Resource" ], "summary": "Processes a message in a tenant", "description": "Processes a message in a tenant", "operationId": "process_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "subscriberId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "detectLanguage", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "cacheResult", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "sessionId", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "saveMissedQuestion", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "messageId", "in": "query", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NLPProcessDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/nlp-pipelines/{id}/process": { "get": { "tags": [ "NLP Pipelines Resource" ], "summary": "Processes a message using a specific NLPPipeline", "description": "Processes a message using a specific NLPPipeline", "operationId": "process_2", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "cacheResult", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "sessionId", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "saveMissedQuestion", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "messageId", "in": "query", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NLPProcessDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/contacts/{contactId}": { "get": { "tags": [ "Integrations Resource" ], "summary": "Get a contact", "description": "Get a contact", "operationId": "getByContactId", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/contact-by-subscriber-handle/{subscriberHandle}": { "get": { "tags": [ "Integrations Resource" ], "summary": "Get a contact from the specified CRM implementation using the subscriber handle", "description": "Get a contact from the specified CRM implementation", "operationId": "getBySubscriberHandle", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriberHandle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/broadcasts/{broadcastId}/export": { "get": { "tags": [ "Broadcast Resource" ], "summary": "Export analytics of a broadcast in CSV.", "operationId": "exportById_2", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "broadcastId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "separator", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-deployments/preview": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a Bot Deployment with isPreview=True", "operationId": "getByPreview", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-deployments/handle/{handle}": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a Bot Deployment by Handle.", "operationId": "getByHandle_2", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-content/variables": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get the Content variables of a Tenant.", "operationId": "getVariables", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSpec" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/activities/{id}/referencing-activities": { "get": { "tags": [ "Activity Resource" ], "summary": "Get a list of Activities' ID that refers/jump to the specified Activity", "description": "Get a list of Activities' ID that refers/jump to the specified Activity.", "operationId": "getReferencingActivities", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/activities/training-content": { "get": { "tags": [ "Activity Resource" ], "summary": "Get the training content that will be used by a tenant.", "description": "Get the training content that will be used by a tenant.", "operationId": "getTrainingContent", "parameters": [ { "name": "includeTrainingTags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "excludeTrainingTags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivitiesWithArticleDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{id}/webchat-settings": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get the Tenant's webchat settings", "operationId": "getWebchatSettings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebChatSettings" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{id}/timestamp": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get a Tenant's Timestamp", "operationId": "getTimestamp_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{id}/stats": { "get": { "tags": [ "Tenant Resource" ], "summary": "Get the stats of a Tenant", "operationId": "getStats_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/surveys/export": { "get": { "tags": [ "Survey Resource" ], "summary": "Export all the surveys in CSV.", "operationId": "export_3", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "separator", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceActivityName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "INTERVIEW", "LIVECHAT", "USER_FEEDBACK" ] } }, { "name": "sessionId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/subscribers": { "get": { "tags": [ "Organization Resource" ], "summary": "List organization subscribers", "description": "List organization subscribers", "operationId": "listOrganizationSubscribers", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "tenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedOrganizationResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/missed-questions/{id}/occurrences": { "get": { "tags": [ "Missed Questions Resource" ], "summary": "Get occurrences of a missed question by id", "operationId": "findMissedQuestionOccurrences_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MissedQuestionOccurrence" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/missed-questions/export": { "get": { "tags": [ "Missed Questions Resource" ], "summary": "Export missed questions data in CSV.", "operationId": "export_4", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fileType", "in": "query", "required": false, "schema": { "type": "string", "default": "csv" } }, { "name": "separator", "in": "query", "required": false, "schema": { "type": "string", "default": ";" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/knowledge-bases/{knowledgeBaseId}/kb-groups/source-id/{sourceId}": { "get": { "tags": [ "Knowledge Base Group Resource" ], "summary": "Get a Knowledge Base Group", "description": "Returns a knowledge base group from a knowledge base.", "operationId": "getBySourceId", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Get list of chat sessions with query parameters.", "operationId": "list_25", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "uuid", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchVariable", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "matchFullWord", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "searchByVariable", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "isRegex", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsFallback", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsFeedback", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsCSATSurvey", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsLiveChat", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "csatSurveysStatuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contact", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "includeMessages", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeLiveChats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions/{id}/messages": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Get the messages of a Chat Session by ID", "operationId": "getMessages_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions/transcript/{requestId}": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Get a Chat Session transcript by variable", "operationId": "getTranscriptByRequestIdVariable_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionTranscriptDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions/subscribers/handle/{handle}": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Get a list of chat sessions based on a subscriber handle.", "operationId": "listBySubscriberHandle_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions/export": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Export chat session data in text transcript or CSV.", "operationId": "export_5", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "deploymentIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "csatSurveysStatuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contact", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "matchFullWord", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "isRegex", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsFallback", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsCSATSurvey", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsFeedback", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "containsLiveChat", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "separator", "in": "query", "required": false, "schema": { "type": "string", "default": ";" } }, { "name": "fileType", "in": "query", "required": false, "schema": { "type": "string", "default": "txt" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "*/*": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/chat-sessions/export/{id}": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Export data of a specific chat session in text transcript.", "operationId": "exportById_3", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileType", "in": "query", "required": false, "schema": { "type": "string", "default": "txt" } }, { "name": "separator", "in": "query", "required": false, "schema": { "type": "string", "default": ";" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/bot-templates": { "get": { "tags": [ "Bot Template Resource" ], "summary": "Get a list of Bot Templates", "operationId": "list_26", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 1000 } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedBotTemplatesResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/bot-templates/{id}": { "get": { "tags": [ "Bot Template Resource" ], "summary": "Get a Bot Template by ID", "operationId": "get_22", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotTemplateDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/bot-content/variables": { "get": { "tags": [ "Organization Bot Content Resource" ], "summary": "Get a list of variables of the Organization", "operationId": "listVariables", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityWithTenantIdDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/bot-content/activities": { "get": { "tags": [ "Organization Bot Content Resource" ], "summary": "Get a list of Activities of the Organization", "operationId": "listActivities", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "DECISION_TREE", "LIVECHAT_FLOW", "AUTOMATED_ANSWERS", "INTERVIEW", "LIVECHAT_SYSTEM_MESSAGE", "USER_FEEDBACK", "KNOWLEDGE_BASE_ARTICLE", "CUSTOM", "DEFAULT_FALLBACK", "FLOW", "FAQLITE", "FAQ", "GRAPH", "FORM" ] } } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityWithTenantIdDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/articles": { "get": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Get a list of Knowledge Base Articles based on advanced criteria", "description": "Returns a list of Knowledge Bases Articles for the specified criteria", "operationId": "listAdvanced", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "noTags", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "includeKnowledgeBase", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedKnowledgeBaseArticleResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/articles/tags": { "get": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Get a list of distinct tags from all the articles that are found based on the criteria", "description": "Returns a string list of tags", "operationId": "listTags", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "knowledgeBaseIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "searchTerm", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/user-feedback": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics user feedback section", "operationId": "userFeedback", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsUserFeedbackDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/summary": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics summary section", "operationId": "summary", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSummaryDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/missed-questions": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics missed questions section", "operationId": "missedQuestions", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsMissedQuestionsDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/live-chat": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics live chats section", "operationId": "liveChats", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsLiveChatDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/interviews": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics surveys section", "operationId": "surveys", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsInterviewsDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/decision-trees": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics decision trees section", "operationId": "decisionTrees", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsDecisionTreesDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/csat": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics CSAT section", "operationId": "csatMetrics", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsCSATDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/analytics/automated-answers": { "get": { "tags": [ "Organization Analytics Resource" ], "summary": "Returns the metrics of the analytics automated answers section", "operationId": "automatedAnswers", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "timeZone", "in": "query", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "rules": { "type": "object", "properties": { "fixedOffset": { "type": "boolean" }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "zero": { "type": "boolean" }, "nano": { "type": "integer", "format": "int32" }, "negative": { "type": "boolean" }, "positive": { "type": "boolean" }, "units": { "type": "array", "items": { "type": "object", "properties": { "durationEstimated": { "type": "boolean" }, "timeBased": { "type": "boolean" }, "dateBased": { "type": "boolean" } } } } } }, "gap": { "type": "boolean" }, "dateTimeAfter": { "type": "string", "format": "date-time" }, "dateTimeBefore": { "type": "string", "format": "date-time" }, "instant": { "type": "string", "format": "date-time" }, "overlap": { "type": "boolean" } } } }, "transitionRules": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "timeDefinition": { "type": "string", "enum": [ "UTC", "WALL", "STANDARD" ] }, "standardOffset": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetBefore": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "offsetAfter": { "type": "object", "properties": { "totalSeconds": { "type": "integer", "format": "int32" }, "id": { "type": "string" } } }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "dayOfMonthIndicator": { "type": "integer", "format": "int32" }, "localTime": { "$ref": "#/components/schemas/LocalTime" }, "midnightEndOfDay": { "type": "boolean" } } } } } } } } }, { "name": "tenants", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsAutomatedAnswersDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{id}/tenants-stats": { "get": { "tags": [ "Organization Resource" ], "summary": "Get the stats for the accessible tenants of Organization", "description": "Get the stats for the accessible tenants of Organization.", "operationId": "getStats_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationTenantStatsDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{id}/tags": { "get": { "tags": [ "Organization Resource" ], "summary": "Get a list of Organization Tags", "description": "Returns a list of Organization Tags.", "operationId": "listTags_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTagResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{id}/monitors": { "get": { "tags": [ "Organization Resource" ], "summary": "Get the monitoring stats of organization's bots that has monitoring powerup enabled.", "description": "Get the monitoring stats of organization's bots that has monitoring powerup enabled.", "operationId": "getMonitors", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "tenantIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tenantsFilter", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "displayName" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PagedMonitoringResponse" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/nlp-pipelines": { "get": { "tags": [ "NLP Pipelines Resource" ], "summary": "Find NLPPipelines by status", "description": "Find NLPPipelines by status", "operationId": "findByCriteria", "parameters": [ { "name": "status", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CREATED", "OUTDATED", "TRAINING", "FAILED", "READY", "INITIALIZED" ] } }, { "name": "tenantHasAutoTrain", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DialogflowNLP" }, { "$ref": "#/components/schemas/HelviaGPT" }, { "$ref": "#/components/schemas/HelviaNLPSpecification" }, { "$ref": "#/components/schemas/HelviaRAGPipeline" }, { "$ref": "#/components/schemas/LuisNLP" }, { "$ref": "#/components/schemas/OpenAINLP" } ] } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/nlp-pipelines/{id}": { "get": { "tags": [ "NLP Pipelines Resource" ], "summary": "Find NLPPipeline by id", "description": "Find NLPPipeline by id", "operationId": "findById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DialogflowNLP" }, { "$ref": "#/components/schemas/HelviaGPT" }, { "$ref": "#/components/schemas/HelviaNLPSpecification" }, { "$ref": "#/components/schemas/HelviaRAGPipeline" }, { "$ref": "#/components/schemas/LuisNLP" }, { "$ref": "#/components/schemas/OpenAINLP" } ] } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DialogflowNLP" }, { "$ref": "#/components/schemas/HelviaGPT" }, { "$ref": "#/components/schemas/HelviaNLPSpecification" }, { "$ref": "#/components/schemas/HelviaRAGPipeline" }, { "$ref": "#/components/schemas/LuisNLP" }, { "$ref": "#/components/schemas/OpenAINLP" } ] } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/integrations/webhookKey/{webhookKey}": { "get": { "tags": [ "Integration Resource" ], "summary": "Gets an Integration by webhookKey", "description": "Returns an integration from an organization; Requires moderator access", "operationId": "get_26", "parameters": [ { "name": "webhookKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers/target/{handle}": { "get": { "tags": [ "Handover Resource" ], "summary": "Get a list of Handover Link by Target", "description": "Get a list of Handover Link by Source", "operationId": "getTarget", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers/target/tenant/{handle}": { "get": { "tags": [ "Handover Resource" ], "summary": "Get a list of Handover Link by Target", "description": "Get a list of Handover Link by Source", "operationId": "getTarget_1", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers/target/subscriber/{handle}": { "get": { "tags": [ "Handover Resource" ], "summary": "Get the Handover Link by Target Subscriber", "description": "Get the Handover Link by Target Subscriber", "operationId": "getTargetBySubscriber", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "404": { "description": "The Handover Link is missing.", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers/source/{handle}": { "get": { "tags": [ "Handover Resource" ], "summary": "Get a list of Handover Link by Source", "description": "Get a list of Handover Link by Source", "operationId": "getSource", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers/source/tenant/{handle}": { "get": { "tags": [ "Handover Resource" ], "summary": "Get a list of Handover Link by Source", "description": "Get a list of Handover Link by Source", "operationId": "getSource_1", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/handovers/source/subscriber/{handle}": { "get": { "tags": [ "Handover Resource" ], "summary": "Get the Handover Link by Source Subscriber", "description": "Get the Handover Link by Source Subscriber", "operationId": "getSourceBySubscriber", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "DESC" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "404": { "description": "The Handover Link is missing.", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HandoverLinkDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/fb-handovers/subscriber/{handle}": { "get": { "tags": [ "Facebook Handover Resource" ], "summary": "Get the FbHandover by Subscriber; requires moderator access.", "operationId": "getBySubscriberHandle_1", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FbHandoverDto" } } } }, "404": { "description": "The FbHandover document is missing.", "content": { "*/*": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/chat-sessions/export/{id}": { "get": { "tags": [ "Chat Session Resource" ], "summary": "Export data of a specific chat session in text transcript.", "description": "Export the data of a chat session given its id.", "operationId": "exportById_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileType", "in": "query", "required": false, "schema": { "type": "string", "default": "txt" } }, { "name": "separator", "in": "query", "required": false, "schema": { "type": "string", "default": ";" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": {} } } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-deployments": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a list of Bot Deployments; requires moderator access.", "operationId": "list_36", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MICROSOFT_TEAMS", "MICROSOFT_WEB_CHAT", "VIBER", "FACEBOOK", "LIVECHAT", "SLACK", "INSTAGRAM", "UNITY", "WHATSAPP", "API" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedBotDeploymentsResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-deployments/handle/{handle}": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a Bot Deployment by Handle; requires moderator access.", "operationId": "getByHandle_3", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeTenant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantSystemSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantStats", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPipelines", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeComponentTree", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeContentCompiled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeTenantPlugins", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-deployments/handle/{handle}/timestamp": { "get": { "tags": [ "Bot Deployments Resource" ], "summary": "Get a Tenant's Timestamp by Bot Deployment Handle; requires moderator access.", "operationId": "getTenantTimestampByHandle", "parameters": [ { "name": "handle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/articles/{id}": { "get": { "tags": [ "Knowledge Base Article Resource" ], "summary": "Get a Knowledge Base Article", "description": "Returns a knowledge base article by id.", "operationId": "getById_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedKnowledgeBaseArticleResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/user-groups/{id}/users/{userId}": { "delete": { "tags": [ "User Group Resource" ], "summary": "Removes a User from a User Group; requires moderator access.", "operationId": "removeUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "No content" }, "200": { "description": "OK" } }, "security": [ { "bearerAuth": [] } ] } }, "/tenants/{tenantId}/data": { "delete": { "tags": [ "Tenant Resource" ], "summary": "Delete data of Tenant.", "description": "Deletes all the ChatSessions, Forms, Subscribers Documents, of Tenant that are tenant.dataRetentionPeriod old, based on currentDate.", "operationId": "deleteData", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/users/batch": { "delete": { "tags": [ "User Resource" ], "summary": "Removes a list of Users from an organization", "operationId": "batchDelete", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserOrganizationBatchDeleteDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserOrganizationBatchDeleteDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/static-variables/batch": { "delete": { "tags": [ "Static Variable Resource" ], "summary": "Deletes multiple Static Variables", "operationId": "batchDelete_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/cache": { "delete": { "tags": [ "Tenant Resource" ], "summary": "Clear the nlu cache of a tenant.", "operationId": "clearCache", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/tenants/{tenantId}/bot-deployments/batch": { "delete": { "tags": [ "Bot Deployments Resource" ], "summary": "Removes a list of Deployments from a Tenant", "operationId": "batchDelete_2", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotDeploymentBatchDeleteDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BotDeploymentBatchDeleteDto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/data": { "delete": { "tags": [ "Organization Resource" ], "summary": "Delete data of Org", "description": "Deletes all the ChatSessions, Forms, Subscribers Documents, of org that are org.dataRetentionPeriod old, based on currentDate.", "operationId": "deleteData_1", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/organizations/{orgId}/api-tokens/{id}": { "delete": { "tags": [ "Organization Api Tokens Resource" ], "summary": "Deletes an existing Organization Api Token", "operationId": "delete_22", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/bot-content/{id}": { "delete": { "tags": [ "Bot Content Resource" ], "summary": "Deletes an existing Content Compiled its ID; requires moderator access.", "operationId": "delete_31", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } }, "/api-tokens/{id}": { "delete": { "tags": [ "Api Tokens Moderator Resource" ], "summary": "Deletes an existing Moderator Api Token", "operationId": "delete_33", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "object" } } } }, "204": { "description": "Successful Operation" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "schemas": { "ExternalEntity": { "required": [ "createdAt", "type" ], "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "type": { "type": "string" } }, "description": "External associated user accounts (like MsTeams user)", "discriminator": { "propertyName": "type" } }, "MsTeamsChannel": { "required": [ "aadGroupId", "createdAt" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalEntity" }, { "type": "object", "properties": { "channelId": { "type": "string" }, "azureTenantId": { "type": "string" }, "aadGroupId": { "type": "string" } } } ] }, "MsTeamsOrganization": { "required": [ "azureTenantId", "createdAt" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalEntity" }, { "type": "object", "properties": { "azureTenantId": { "type": "string" } } } ] }, "MsTeamsUser": { "required": [ "aadObjectId", "createdAt" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalEntity" }, { "type": "object", "properties": { "aadObjectId": { "type": "string" } } } ] }, "NoneType": { "required": [ "createdAt" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExternalEntity" } ] }, "UserProfileDto": { "required": [ "email", "fullName", "isModerator", "organizationId", "organizationRoles", "password", "tenantRoles" ], "type": "object", "properties": { "email": { "type": "string", "description": "User's Email", "example": "someguy@somemail.com" }, "currentPassword": { "maxLength": 2147483647, "minLength": 8, "type": "string", "description": "User's current password", "example": "cvjd984" }, "password": { "maxLength": 2147483647, "minLength": 8, "type": "string", "description": "User's password", "example": "cvjd984" }, "confirmPassword": { "maxLength": 2147483647, "minLength": 8, "type": "string", "description": "User's new password confirmation", "example": "cvjd984" }, "fullName": { "maxLength": 120, "minLength": 1, "type": "string", "description": "User's Full Name", "example": "Some Guy" }, "image": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "User's avatar image", "example": "https://public-storage-development.s3.eu-central-1.amazonaws.com/" }, "telephoneNumber": { "maxLength": 60, "minLength": 1, "type": "string", "description": "User's Telephone Number", "example": "+32123445657889" }, "country": { "maxLength": 2, "minLength": 2, "type": "string", "description": "User's Country", "example": "Italy" }, "language": { "maxLength": 5, "minLength": 5, "type": "string", "description": "User's Language", "example": "Italian" }, "organizationId": { "type": "string", "description": "User's organization", "example": "Helvia" }, "isModerator": { "type": "boolean", "description": "User is moderator", "example": true }, "tenantRoles": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "User roles table for the organization's tenants.", "items": { "type": "string", "description": "User roles table for the organization's tenants.", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } }, "description": "User roles table for the organization's tenants." }, "description": "User roles table for the organization's tenants." }, "organizationRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "User roles table for the organization.", "items": { "type": "string", "description": "User roles table for the organization.", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, "description": "User roles table for the organization." }, "externalUsers": { "uniqueItems": true, "type": "array", "description": "External associated user accounts (like MsTeams user)", "items": { "oneOf": [ { "$ref": "#/components/schemas/MsTeamsChannel" }, { "$ref": "#/components/schemas/MsTeamsOrganization" }, { "$ref": "#/components/schemas/MsTeamsUser" }, { "$ref": "#/components/schemas/NoneType" } ] } } } }, "AzureAIIntegration": { "required": [ "apiKey", "category", "endpoint", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "endpoint": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "apiKey": { "type": "string" } } } ] }, "CiscoLivechatIntegration": { "required": [ "category", "ccxQueueTag", "chatId", "endpoint", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "endpoint": { "type": "string" }, "chatId": { "type": "integer", "format": "int64" }, "ccxQueueTag": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" } } } ] }, "EffectiveRoles": { "required": [ "organizationRoles", "tenantRoles" ], "type": "object", "properties": { "tenantRoles": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } } } }, "organizationRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } } } }, "description": "Effective user roles table for the organization and organization's tenants.", "readOnly": true }, "ExternalAnalytics": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" }, "displayName": { "type": "string" }, "type": { "type": "string", "enum": [ "KIBANA", "MONGO" ] } } }, "FilterProperty": { "type": "object", "properties": { "dataPropertyName": { "type": "string" }, "subscriberPropertyName": { "type": "string" } } }, "GeminiAIIntegration": { "required": [ "apiKey", "category", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "apiKey": { "type": "string" } } } ] }, "GenesysLivechatIntegration": { "required": [ "category", "clientId", "clientSecret", "name", "openIntegrationId", "region", "webhookKey" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "webhookKey": { "type": "string", "description": "Webhook key to validate events." }, "clientId": { "type": "string", "description": "Genesys OAuth app client ID" }, "clientSecret": { "type": "string", "description": "Genesys OAuth app client secret" }, "region": { "type": "string", "description": "Genesys organization region. Domain only.", "example": "mypurecloud.ie" }, "openIntegrationId": { "type": "string", "description": "Genesys Open Messaging integration ID" }, "queueIds": { "uniqueItems": true, "type": "array", "description": "Genesys Queue IDs that are going to be subscribed.", "items": { "type": "string", "description": "Genesys Queue IDs that are going to be subscribed." } } } } ] }, "GoogleTranslationIntegration": { "required": [ "apiKey", "category", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "apiKey": { "type": "string" } } } ] }, "HelviaLivechatIntegration": { "required": [ "category", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" } ] }, "Integration": { "required": [ "category", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "OIDC_AUTHENTICATION", "MICROSOFT_DYNAMICS_CRM", "MICROSOFT_DYNAMICS_KB", "CISCO_LIVECHAT", "HELVIA_LIVECHAT", "ZENDESK_LIVECHAT", "GENESYS_LIVECHAT", "AZURE_AI_LLM", "OPEN_AI_LLM", "GEMINI_AI_LLM", "ZENDESK_TICKETING", "GOOGLE_TRANSLATION" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "organizationRef": { "type": "string", "writeOnly": true }, "category": { "type": "string", "enum": [ "AUTHENTICATION", "CRM", "KB", "LIVECHAT", "LLM", "TICKETING", "TRANSLATION" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "discriminator": { "propertyName": "type" } }, "IntegrationPlugin": { "required": [ "category", "integrationId" ], "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/Integration" }, "settings": { "$ref": "#/components/schemas/PluginSettings" }, "category": { "type": "string", "enum": [ "AUTHENTICATION", "CRM", "KB", "LIVECHAT", "LLM_NODE", "LLM_TOPIC_MODELLING", "LLM_SUMMARIZATION", "LLM_SEMANTIC_SEARCH_NODE", "LLM_AUTOMATED_AGENT_TESTING", "LLM_LANGUAGE_DETECTION", "TICKETING" ] }, "integrationId": { "type": "string", "writeOnly": true } }, "description": "Tenant Plugins" }, "LoginSettings": { "required": [ "plugins", "supportedPluginCategories" ], "type": "object", "properties": { "isOrganizationNameVisible": { "type": "boolean" }, "isOrganizationLogoVisible": { "type": "boolean" }, "isCustomMessageVisible": { "type": "boolean" }, "customMessage": { "type": "string" }, "isCredentialLoginVisible": { "type": "boolean" }, "isGoogleLoginVisible": { "type": "boolean" }, "isMicrosoftLoginVisible": { "type": "boolean" }, "isSkipNativeLoginEnabled": { "type": "boolean" }, "failedAuthenticationRedirectUrl": { "type": "string" }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } }, "plugins": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationPlugin" } }, "isAutoUserCreationEnabled": { "type": "boolean" }, "defaultAutoCreationRole": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] }, "suppressWelcomeEmail": { "type": "boolean" }, "isPostAuthenticationEnabled": { "type": "boolean" }, "postAuthenticationRequestUrl": { "type": "string" }, "postAuthenticationRequestHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "roleMap": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, "pluginRefs": { "type": "array", "writeOnly": true, "items": { "type": "string" } }, "supportedPluginCategories": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "AUTHENTICATION", "CRM", "KB", "LIVECHAT", "LLM_NODE", "LLM_TOPIC_MODELLING", "LLM_SUMMARIZATION", "LLM_SEMANTIC_SEARCH_NODE", "LLM_AUTOMATED_AGENT_TESTING", "LLM_LANGUAGE_DETECTION", "TICKETING" ] } } }, "description": "Organization's login screen customization" }, "MicrosoftDynamicsCrmIntegration": { "required": [ "category", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "baseUrl": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "azureTenantId": { "type": "string" }, "scope": { "type": "string" }, "version": { "type": "string" }, "entityProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MicrosoftDynamicsEntityProperty" } }, "filterExpression": { "type": "string" }, "filterProperty": { "$ref": "#/components/schemas/FilterProperty" }, "contactLinkTemplate": { "type": "string" } } } ] }, "MicrosoftDynamicsEntityProperty": { "type": "object", "properties": { "dataPropertyPath": { "type": "string" }, "domainPropertyName": { "type": "string" }, "displayName": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "CHOICE", "LOOKUP", "DATETIME" ] }, "value": { "type": "object" } } }, "MicrosoftDynamicsKbIntegration": { "required": [ "category", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "baseUrl": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "azureTenantId": { "type": "string" }, "scope": { "type": "string" }, "version": { "type": "string" }, "entityProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/MicrosoftDynamicsEntityProperty" } }, "filterExpression": { "type": "string" } } } ] }, "OIDCIntegration": { "required": [ "authorizationEndpoint", "category", "clientId", "grantType", "issuer", "jwksUri", "name", "tokenEndpoint" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "configurationUrl": { "type": "string" }, "issuer": { "type": "string" }, "authorizationEndpoint": { "type": "string" }, "tokenEndpoint": { "type": "string" }, "jwksUri": { "type": "string" }, "grantType": { "type": "string", "enum": [ "AUTHORIZATION_CODE", "AUTHORIZATION_CODE_PKCE" ] }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "writeOnly": true }, "challengeMethod": { "type": "string", "enum": [ "SHA_256", "PLAIN" ] }, "additionalScopes": { "type": "string" }, "emailKey": { "type": "string" }, "fullNameKey": { "type": "string" } } } ] }, "OpenAIIntegration": { "required": [ "apiKey", "category", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "apiKey": { "type": "string" }, "project": { "type": "string" }, "openAIOrganization": { "type": "string" }, "customUrl": { "type": "string" } } } ] }, "OrganizationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Organization's ID", "example": "fk4tk2323j35n23k5n" }, "externalOrganizations": { "type": "array", "description": "External associated organizations", "items": { "$ref": "#/components/schemas/ExternalEntity" } }, "externalAnalytics": { "type": "array", "description": "Organization's external analytics", "items": { "$ref": "#/components/schemas/ExternalAnalytics" } }, "displayName": { "type": "string", "description": "Organization's Name", "example": "A.C.M.E" }, "timezone": { "type": "string", "description": "Organization's timezone", "example": "america/new_york" }, "image": { "type": "string", "description": "Organization's Avatar/Icon/Image", "example": "s3://something-something" }, "users": { "type": "array", "description": "List of Organization's Users", "items": { "$ref": "#/components/schemas/UserDto" } }, "auditLogsNotificationEmail": { "maxLength": 400, "minLength": 0, "type": "string", "description": "The email address to receive audit logs notifications" }, "auditLogsNotificationsEnabled": { "type": "boolean", "description": "Whether to receive audit log notifications or not" }, "dataRetentionPeriod": { "type": "integer", "description": "Organization's Data Retention Period in months", "format": "int32", "example": 1 }, "auditLogsRetentionPeriod": { "type": "integer", "description": "Organization's Audit Logs Retention Period in months", "format": "int32", "example": 1 }, "loginSettings": { "$ref": "#/components/schemas/LoginSettings" } } }, "PluginSettings": { "type": "object", "properties": { "compatiblePluginCategory": { "type": "string" } } }, "UserDto": { "required": [ "email", "fullName", "id", "organizationRoles", "tenantRoles" ], "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string", "description": "User's Email", "example": "someguy@somemail.com" }, "fullName": { "maxLength": 120, "minLength": 1, "type": "string", "description": "User's Full Name", "example": "Some Guy" }, "telephoneNumber": { "type": "string" }, "image": { "type": "string" }, "country": { "type": "string" }, "language": { "type": "string" }, "isModerator": { "type": "boolean" }, "tenantRoles": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "User roles table for the organization's tenants.", "items": { "type": "string", "description": "User roles table for the organization's tenants.", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } }, "description": "User roles table for the organization's tenants." }, "description": "User roles table for the organization's tenants." }, "organizationRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "User roles table for the organization.", "items": { "type": "string", "description": "User roles table for the organization.", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, "description": "User roles table for the organization." }, "effectiveRoles": { "$ref": "#/components/schemas/EffectiveRoles" }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationDto" } }, "isActive": { "type": "boolean", "description": "Whether the user is considered active or not", "readOnly": true, "example": false }, "externalUsers": { "uniqueItems": true, "type": "array", "description": "External associated user accounts (like MsTeams user)", "items": { "$ref": "#/components/schemas/ExternalEntity" } }, "groupIds": { "uniqueItems": true, "type": "array", "description": "Groups that user will be part of.", "writeOnly": true, "items": { "type": "string", "description": "Groups that user will be part of." } }, "sendWelcomeEmail": { "type": "boolean", "description": "Send joined new Organization email to user", "writeOnly": true, "default": true } }, "description": "List of Organization's Users" }, "ZendeskLivechatIntegration": { "required": [ "appId", "baseUrl", "category", "keyId", "name", "secret", "webhookKey" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "webhookKey": { "type": "string", "description": "Webhook key to validate events." }, "baseUrl": { "type": "string", "description": "Zendesk base url. Don't append /sc here" }, "appId": { "type": "string", "description": "Zendesk-Sunshine conversations app id" }, "keyId": { "type": "string", "description": "Zendesk-Sunshine conversations key id" }, "secret": { "type": "string", "description": "Zendesk-Sunshine conversations secret key" } } } ] }, "ZendeskTicketingIntegration": { "required": [ "baseUrl", "category", "name", "token", "userName" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Integration" }, { "type": "object", "properties": { "baseUrl": { "type": "string" }, "userName": { "type": "string" }, "token": { "type": "string", "writeOnly": true } } } ] }, "Activity": { "required": [ "content", "diffName", "diffType", "id", "schema", "tags", "type" ], "type": "object", "properties": { "lastModifiedBy": { "type": "object", "additionalProperties": { "type": "string" } }, "version": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "name": { "type": "object", "additionalProperties": { "type": "string", "description": "Name of the activity in different languages." }, "description": "Name of the activity in different languages." }, "schema": { "type": "string", "description": "Schema of the activity.", "enum": [ "FLOWGRAPH", "FAQLITE" ] }, "group": { "type": "object", "additionalProperties": { "type": "string", "description": "Group name of the activity in different languages." }, "description": "Group name of the activity in different languages." }, "type": { "type": "string", "description": "Type of the activity.", "enum": [ "DECISION_TREE", "LIVECHAT_FLOW", "AUTOMATED_ANSWERS", "INTERVIEW", "LIVECHAT_SYSTEM_MESSAGE", "USER_FEEDBACK", "KNOWLEDGE_BASE_ARTICLE", "CUSTOM", "DEFAULT_FALLBACK", "FLOW", "FAQLITE", "FAQ", "GRAPH", "FORM" ] }, "nlpTrainingData": { "$ref": "#/components/schemas/NLPTrainingData" }, "content": { "$ref": "#/components/schemas/ActivityContent" }, "tags": { "type": "array", "items": { "type": "string" } }, "settings": { "$ref": "#/components/schemas/ActivitySettings" }, "createdAt": { "type": "string", "format": "date-time" }, "diffType": { "type": "string" }, "diffName": { "type": "string" }, "forceOverwrite": { "type": "boolean" } }, "description": "The List of Activities" }, "ActivityCompilationMetadata": { "required": [ "entryNodes", "formQuestions", "formQuestionsIds", "jumpsTo", "templateData" ], "type": "object", "properties": { "formQuestionsIds": { "type": "array", "items": { "type": "string" } }, "formQuestions": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "templateData": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "jumpsTo": { "type": "array", "items": { "type": "string" } }, "entryNodes": { "type": "array", "items": { "type": "string" } } } }, "ActivityCompiled": { "required": [ "conversationNodes", "entryPoints", "metadata", "responses", "variables" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "DECISION_TREE", "LIVECHAT_FLOW", "AUTOMATED_ANSWERS", "INTERVIEW", "LIVECHAT_SYSTEM_MESSAGE", "USER_FEEDBACK", "KNOWLEDGE_BASE_ARTICLE", "CUSTOM", "DEFAULT_FALLBACK", "FLOW", "FAQLITE", "FAQ", "GRAPH", "FORM" ] }, "conversationNodes": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationNode" } }, "responses": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Response" } } } }, "metadata": { "$ref": "#/components/schemas/ActivityCompilationMetadata" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/VariableSpec" } }, "entryPoints": { "type": "array", "items": { "$ref": "#/components/schemas/EntryPoint" } } }, "description": "The List of custom Compiled Activities" }, "ActivityContent": { "required": [ "schema" ], "type": "object", "properties": { "schema": { "type": "string", "enum": [ "FLOWGRAPH", "FAQLITE" ] } }, "description": "The content of the activity.", "discriminator": { "propertyName": "schema" } }, "ActivitySettings": { "type": "object", "properties": { "storeAnswersByDefault": { "type": "boolean" }, "automaticBackButtonForLeafMessages": { "type": "boolean" }, "defaultInlineUserFeedbackData": { "$ref": "#/components/schemas/InlineFeedbackData" }, "useGeneratedResponse": { "type": "boolean" }, "defaultLanguage": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] } }, "description": "The activity settings." }, "AdvancedChatPromptBubble": { "required": [ "enable", "stepOneButtonLabel", "stepOneMessage", "stepTwoMessage" ], "type": "object", "properties": { "enable": { "type": "boolean" }, "stepOneMessage": { "type": "string" }, "stepOneButtonLabel": { "type": "string" }, "stepTwoMessage": { "type": "string" }, "deployments": { "type": "array", "description": "The advanced chat prompt deployment settings", "items": { "$ref": "#/components/schemas/AdvancedChatPromptDeploymentSettings" } } }, "description": "The advanced user prompt bubble functionality. User can add pre chat steps prompt." }, "AdvancedChatPromptDeploymentSettings": { "required": [ "icon", "url" ], "type": "object", "properties": { "icon": { "type": "string" }, "url": { "type": "string" } }, "description": "The advanced chat prompt deployment settings" }, "AnalyticNodeData": { "type": "object", "properties": { "reportedIntent": { "type": "string" }, "reportedConvnode": { "type": "string" }, "responseType": { "type": "string" }, "otherData": { "type": "object", "additionalProperties": { "type": "string" } }, "analyticTags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "analyticTagsRemoved": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "AnonymizationNamedEntity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "PERSON", "GPE", "NORP", "FAC", "ORG", "LOC", "PRODUCT", "EVENT", "WORK_OF_ART", "LAW", "LANGUAGE", "DATE", "TIME", "PERCENT", "MONEY", "QUANTITY", "ORDINAL", "CARDINAL" ] }, "replacement": { "type": "string" } } }, "AnonymizationRegexEntity": { "type": "object", "properties": { "name": { "type": "string" }, "pattern": { "type": "string" }, "replacement": { "type": "string" } } }, "AnonymizationServiceConfiguration": { "type": "object", "properties": { "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AnonymizationSettings": { "type": "object", "properties": { "namedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/AnonymizationNamedEntity" } }, "regexEntities": { "type": "array", "items": { "$ref": "#/components/schemas/AnonymizationRegexEntity" } }, "defaultReplacement": { "type": "string" }, "serviceConfiguration": { "$ref": "#/components/schemas/AnonymizationServiceConfiguration" } }, "description": "Settings for external Data Anonymization Services" }, "ApiIntegrationSettings": { "type": "object", "properties": { "jwtToken": { "type": "string" } } }, "AutoPopOut": { "required": [ "delayInSeconds", "enable", "extendTimeAfterView", "once" ], "type": "object", "properties": { "enable": { "type": "boolean" }, "delayInSeconds": { "minimum": 0, "type": "integer", "format": "int32" }, "extendTimeAfterView": { "type": "boolean" }, "once": { "type": "boolean" } }, "description": "The automatic pop-out functionality for the bubble-style." }, "BotContentCompilationMetadata": { "required": [ "entryPoints", "jumpsTo", "variables" ], "type": "object", "properties": { "entryPoints": { "type": "array", "items": { "$ref": "#/components/schemas/EntryPoint" } }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/VariableSpec" } }, "jumpsTo": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "description": "The Metadata that come from compiled activities" }, "BotContentCompiledDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The BotContentCompiled Id", "example": "13513594520" }, "activities": { "type": "array", "description": "The List of Compiled Activities", "items": { "$ref": "#/components/schemas/ActivityCompiled" } }, "customActivities": { "type": "array", "description": "The List of custom Compiled Activities", "items": { "$ref": "#/components/schemas/ActivityCompiled" } }, "metadata": { "$ref": "#/components/schemas/BotContentCompilationMetadata" } }, "description": "The bot content dto" }, "BotContentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The BotContent Id", "example": "13513594520" }, "activities": { "type": "array", "description": "The List of Activities", "items": { "$ref": "#/components/schemas/Activity" } }, "mainActivity": { "type": "string", "description": "The Id of the Main Activity", "example": "13513594520" } }, "description": "The bot content dto" }, "BotDeploymentDto": { "required": [ "displayName", "platform", "scope" ], "type": "object", "properties": { "id": { "type": "string", "description": "Bot Deployment's ID", "example": "1213991249013" }, "handle": { "maxLength": 300, "minLength": 1, "type": "string", "description": "Unique human-readable handle of the Bot Deployment.", "example": "dfvd4fv6d4vcds56" }, "displayName": { "maxLength": 240, "minLength": 1, "type": "string", "description": "A human-readable name for the Bot Deployment", "example": "HRwiz Demo" }, "description": { "maxLength": 400, "minLength": 0, "type": "string", "description": "Bot Deployment's description", "example": "Lorem ipsum dolor.." }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "messagingAppId": { "type": "string", "description": "The id of the messaging app", "writeOnly": true, "example": "60faf0f8df4f1876c07b8271" }, "platform": { "type": "string", "description": "The platform type of the bot deployment", "example": "MICROSOFT_TEAMS", "enum": [ "MICROSOFT_TEAMS", "MICROSOFT_WEB_CHAT", "VIBER", "FACEBOOK", "LIVECHAT", "SLACK", "INSTAGRAM", "UNITY", "WHATSAPP", "API" ] }, "scope": { "type": "string", "description": "Bot Deployment's scope", "example": "system", "enum": [ "USER", "SYSTEM" ] }, "settings": { "$ref": "#/components/schemas/BotDeploymentSettingsDto" }, "isPreview": { "type": "boolean", "description": "Defines if bot deployment is in preview mode" }, "created": { "type": "string", "description": "The time the Bot Deployment was created.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "lastChanged": { "type": "string", "description": "The last time the Bot Deployment has been modified.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "lastChangedBy": { "$ref": "#/components/schemas/EditorDto" } }, "description": "Bot Deployments of tenant." }, "BotDeploymentIntegrationSettings": { "type": "object", "properties": { "microsoftTeams": { "$ref": "#/components/schemas/MicrosoftTeamsIntegrationSettings" }, "microsoftWebChat": { "$ref": "#/components/schemas/MicrosoftWebChatIntegrationSettings" }, "viber": { "$ref": "#/components/schemas/ViberIntegrationSettings" }, "facebook": { "$ref": "#/components/schemas/FacebookIntegrationSettings" }, "instagram": { "$ref": "#/components/schemas/InstagramIntegrationSettings" }, "slack": { "$ref": "#/components/schemas/SlackIntegrationSettings" }, "unity": { "$ref": "#/components/schemas/UnityIntegrationSettings" }, "whatsapp": { "$ref": "#/components/schemas/WhatsAppIntegrationSettings" }, "api": { "$ref": "#/components/schemas/ApiIntegrationSettings" } } }, "BotDeploymentLayoutSettings": { "type": "object", "properties": { "microsoftTeams": { "$ref": "#/components/schemas/MicrosoftTeamsLayoutSettings" }, "microsoftWebChat": { "$ref": "#/components/schemas/WebChatSettings" }, "viber": { "$ref": "#/components/schemas/ViberLayoutSettings" }, "facebook": { "$ref": "#/components/schemas/FacebookLayoutSettings" }, "instagram": { "$ref": "#/components/schemas/InstagramLayoutSettings" }, "slack": { "$ref": "#/components/schemas/SlackLayoutSettings" }, "whatsApp": { "$ref": "#/components/schemas/WhatsAppLayoutSettings" } } }, "BotDeploymentSettingsDto": { "required": [ "language" ], "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/BotDeploymentLayoutSettings" }, "integration": { "$ref": "#/components/schemas/BotDeploymentIntegrationSettings" }, "language": { "type": "string", "description": "Bot Deployment's language", "example": "en", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "automaticLanguageDetectionEnabled": { "type": "boolean", "description": "If this bot deployment supports automatic language detection of subsribcer." } }, "description": "The Bot Deployment specific settings" }, "Configuration": { "type": "object", "properties": { "headerText": { "type": "string", "description": "The text of the header." }, "fontFamily": { "type": "string", "description": "The font family." }, "botAvatarImage": { "type": "string", "description": "The bot avatar image url." }, "userAvatarImage": { "type": "string", "description": "The user avatar image family." }, "mainColor": { "type": "string", "description": "The main color." }, "mainFontColor": { "type": "string", "description": "The main color of the font." }, "botBubbleColor": { "type": "string", "description": "The bot bubble color." }, "botBubbleTextColor": { "type": "string", "description": "The bot bubble color of text." }, "userBubbleColor": { "type": "string", "description": "The user bubble color." }, "userBubbleTextColor": { "type": "string", "description": "The user bubble color of text." }, "suggestedActionLayout": { "type": "string", "description": "The suggested action layout." }, "hideUploadButton": { "type": "boolean", "description": "To hide upload button." }, "showTypingIndicator": { "type": "boolean", "description": "To show the typing indicator" }, "hideEmojiPickerButton": { "type": "boolean", "description": "To hide the emoji picker button" }, "entryPoint": { "type": "string", "description": "To greeting Activity" }, "mode": { "type": "string", "description": "To mode of the WebChat deployment", "enum": [ "BUBBLE", "EMBEDDED" ] }, "menuButtons": { "type": "array", "description": "The menu buttons.", "items": { "$ref": "#/components/schemas/MenuButton" } }, "customSettings": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object", "description": "The user custom settings." }, "description": "The user custom settings." }, "autoPopOut": { "$ref": "#/components/schemas/AutoPopOut" }, "userPromptBubble": { "$ref": "#/components/schemas/UserPromptBubble" }, "advancedChatPromptBubble": { "$ref": "#/components/schemas/AdvancedChatPromptBubble" }, "linkTarget": { "type": "string", "description": "The behavior after clicking the link in webchat" }, "hyperlinkColor": { "type": "string", "description": "The color of hyperlinks in webchat" }, "widgetRadius": { "maximum": 32, "minimum": 0, "type": "integer", "description": "The widget border radius", "format": "int32" }, "headerStyle": { "type": "string", "description": "The widget's header style" }, "width": { "maximum": 500, "minimum": 350, "type": "integer", "description": "The widget width", "format": "int32" }, "height": { "maximum": 850, "minimum": 450, "type": "integer", "description": "The widget height", "format": "int32" }, "startUpNotifications": { "type": "array", "description": "The startup notifications", "items": { "$ref": "#/components/schemas/StartUpNotification" } }, "idleNotifications": { "type": "array", "description": "The idle notifications", "items": { "$ref": "#/components/schemas/IdleNotification" } } } }, "ContextEntry": { "required": [ "duration", "lifespan" ], "type": "object", "properties": { "lifespan": { "type": "integer", "format": "int64" }, "duration": { "type": "integer", "format": "int64" }, "commands": { "type": "string" } } }, "ContextFull": { "type": "object", "properties": { "lifespan": { "type": "integer", "format": "int32" }, "duration": { "type": "integer", "format": "int32" }, "commands": { "type": "string" } } }, "ConvNodeCondition": { "required": [ "_class" ], "type": "object", "properties": { "_class": { "type": "string" } }, "discriminator": { "propertyName": "_class" } }, "ConversationAction": { "type": "object", "properties": { "name": { "type": "string" }, "params": { "type": "object" } } }, "ConversationManagerSettings": { "type": "object", "properties": { "url": { "type": "string" }, "defaultFallbackOutputContexts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ContextFull" } } } }, "ConversationNode": { "required": [ "description", "id", "inputContexts", "intentName", "messages", "outputContexts" ], "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "intentName": { "type": "array", "items": { "type": "string" } }, "inputContexts": { "type": "array", "items": { "type": "string" } }, "outputContexts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ContextEntry" } }, "messages": { "type": "array", "items": { "type": "string" } }, "action": { "$ref": "#/components/schemas/ConversationAction" }, "next": { "type": "array", "items": { "$ref": "#/components/schemas/NextEntry" } }, "isBotPrompt": { "type": "boolean" }, "isUserInput": { "type": "boolean" }, "isBackMilestone": { "type": "boolean" }, "isFileUpload": { "type": "boolean" }, "reportedIntent": { "type": "string" }, "reportedConvnode": { "type": "string" }, "autogen": { "type": "boolean" }, "analyticsData": { "$ref": "#/components/schemas/AnalyticNodeData" } } }, "DialogFlowDirectSettings": { "required": [ "clientEmail", "language", "privateKey", "projectId" ], "type": "object", "properties": { "projectId": { "type": "string" }, "privateKey": { "type": "string" }, "clientEmail": { "type": "string" }, "language": { "type": "string" } } }, "DialogflowNLP": { "required": [ "excludeTrainingTags", "includeTrainingTags", "language", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/NLPPipeline" }, { "type": "object", "properties": { "projectId": { "type": "string" }, "privateKey": { "type": "string" }, "privateKeyId": { "type": "string" }, "clientId": { "type": "string" }, "clientEmail": { "type": "string" }, "tokenServerUri": { "type": "string" }, "region": { "type": "string", "enum": [ "EU_W1", "EU_W2", "AU_SE1", "AS_NE1", "GLOBAL", "US" ] }, "trainingOperationName": { "type": "string" } } } ] }, "EditorDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The User or ApiToken ID.", "example": "abc123" }, "email": { "type": "string", "description": "The email of the User.", "example": "foo@bar.baz" }, "name": { "type": "string", "description": "The name of the User or ApiToken description.", "example": "Foo Bar" }, "type": { "type": "string", "description": "The request authentication type.", "example": "login" } }, "description": "The latest user that modified the Bot Deployment." }, "EntryPoint": { "required": [ "fromActivity", "nodeId" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "fromActivity": { "type": "string" } } }, "FacebookIntegrationSettings": { "required": [ "pageAccessToken", "pageId" ], "type": "object", "properties": { "pageAccessToken": { "type": "string" }, "pageId": { "type": "string" } } }, "FacebookLayoutSettings": { "type": "object", "properties": { "showTypingIndicator": { "type": "boolean" } } }, "FeedbackSettings": { "type": "object", "properties": { "enableThumbsFeedback": { "type": "boolean" }, "thumbsUpNodeId": { "type": "string" }, "thumbsDownNodeId": { "type": "string" } } }, "FlowGraphPosition": { "required": [ "x", "y" ], "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" } } }, "HelviaGPT": { "required": [ "bearerToken", "excludeTrainingTags", "includeTrainingTags", "language", "name", "pipelineId", "serviceUrl" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/NLPPipeline" }, { "type": "object", "properties": { "serviceUrl": { "type": "string" }, "bearerToken": { "type": "string" }, "pipelineId": { "type": "string" } } } ] }, "HelviaNLPSpecification": { "required": [ "bearerToken", "excludeTrainingTags", "includeTrainingTags", "language", "name", "serviceUrl" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/NLPPipeline" }, { "type": "object", "properties": { "serviceUrl": { "type": "string" }, "bearerToken": { "type": "string" } } } ] }, "HelviaRAGPipeline": { "required": [ "bearerToken", "excludeTrainingTags", "includeTrainingTags", "language", "name", "pipelineId", "serviceUrl", "settings" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/NLPPipeline" }, { "type": "object", "properties": { "serviceUrl": { "type": "string" }, "bearerToken": { "type": "string" }, "pipelineId": { "type": "string" }, "settings": { "$ref": "#/components/schemas/RAGPipelineSettings" } } } ] }, "IdleNotification": { "required": [ "buttons", "hasSound", "level", "text", "triggerConversationNodeId", "triggerWhenInactiveFor" ], "type": "object", "properties": { "text": { "type": "string" }, "triggerWhenInactiveFor": { "minimum": 0, "type": "number" }, "triggerConversationNodeId": { "type": "string" }, "hasSound": { "type": "boolean" }, "level": { "type": "string", "enum": [ "ERROR", "INFO", "SUCCESS", "WARN" ] }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationButton" } } }, "description": "The idle notifications" }, "InlineFeedbackData": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "positive": { "$ref": "#/components/schemas/InlineFeedbackElement" }, "negative": { "$ref": "#/components/schemas/InlineFeedbackElement" } } }, "InlineFeedbackElement": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "feedbackNodeId": { "type": "string" } } }, "InstagramIntegrationSettings": { "required": [ "fbConnectedPageId", "pageAccessToken" ], "type": "object", "properties": { "pageAccessToken": { "type": "string" }, "fbConnectedPageId": { "type": "string" } } }, "InstagramLayoutSettings": { "type": "object" }, "LanguageDetectionSettings": { "required": [ "confidenceThreshold", "defaultLanguage", "enabled", "googleTranslateKey", "googleTranslateProjectId" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "defaultLanguage": { "type": "string" }, "googleTranslateProjectId": { "type": "string" }, "googleTranslateKey": { "type": "string" }, "confidenceThreshold": { "type": "number", "format": "double" } } }, "LanguageSettings": { "required": [ "primary" ], "type": "object", "properties": { "primary": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "additional": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] } } } }, "LiveChatSourceManager": { "required": [ "targetTenantHandle" ], "type": "object", "properties": { "targetTenantHandle": { "type": "string" }, "specialCommandConvNodeIds": { "type": "array", "items": { "type": "string" } } } }, "LiveChatSystemSettings": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "SOURCE", "TARGET" ] }, "sourceSettings": { "$ref": "#/components/schemas/LivechatSourceSettings" }, "targetSettings": { "$ref": "#/components/schemas/LivechatTargetSettings" } } }, "LiveChatTargetManager": { "type": "object", "properties": { "specialCommandConvNodeIds": { "type": "array", "items": { "type": "string" } }, "itcPrefixType": { "type": "string", "enum": [ "FIRST_NAME", "FULL_NAME" ] }, "transcriptTextures": { "$ref": "#/components/schemas/LivechatTranscriptTextures" }, "transferTextures": { "$ref": "#/components/schemas/LivechatTransferRequestTextures" } } }, "LivechatRequestBuilderSettings": { "type": "object", "properties": { "requestTextures": { "$ref": "#/components/schemas/LivechatRequestTextures" } } }, "LivechatRequestTextures": { "type": "object", "properties": { "cardSubjectOnPending": { "type": "string" }, "cardSubjectOnMissed": { "type": "string" }, "cardSubjectOnProcessed": { "type": "string" }, "cardHyperlinkTextOnProcessed": { "type": "string" }, "cardButtonTitle": { "type": "string" } } }, "LivechatSourceSettings": { "required": [ "manager" ], "type": "object", "properties": { "manager": { "$ref": "#/components/schemas/LiveChatSourceManager" } } }, "LivechatTargetSettings": { "required": [ "manager" ], "type": "object", "properties": { "manager": { "$ref": "#/components/schemas/LiveChatTargetManager" }, "requestBuilder": { "$ref": "#/components/schemas/LivechatRequestBuilderSettings" } } }, "LivechatTranscriptTextures": { "type": "object", "properties": { "transcriptCardTitle": { "type": "string" }, "transcriptCardAltText": { "type": "string" }, "transcriptUserAvatarImageUrl": { "type": "string" }, "transcriptBotAvatarImageUrl": { "type": "string" }, "transcriptAgentAvatarImageUrl": { "type": "string" }, "requestTranscriptText": { "type": "string" }, "requestTranscriptViewButtonTitle": { "type": "string" }, "requestTranscriptDownloadButtonTitle": { "type": "string" } } }, "LivechatTransferRequestTextures": { "type": "object", "properties": { "requestCard": { "$ref": "#/components/schemas/LivechatTransferRequestTexturesRequestCard" }, "requestToAgentCard": { "$ref": "#/components/schemas/LivechatTransferRequestTexturesRequestToAgentCard" }, "requestToTeamCard": { "$ref": "#/components/schemas/LivechatTransferRequestTexturesRequestToTeamCard" } } }, "LivechatTransferRequestTexturesRequestCard": { "type": "object", "properties": { "text": { "type": "string" }, "transferToAgentButton": { "type": "string" }, "transferToTeamButton": { "type": "string" } } }, "LivechatTransferRequestTexturesRequestToAgentCard": { "type": "object", "properties": { "text": { "type": "string" }, "title": { "type": "string" }, "button": { "type": "string" } } }, "LivechatTransferRequestTexturesRequestToTeamCard": { "type": "object", "properties": { "text": { "type": "string" }, "fallbackText": { "type": "string" }, "title": { "type": "string" }, "button": { "type": "string" } } }, "LocalNluSettings": { "type": "object", "properties": { "intents": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "similarityAlgorithm": { "type": "string", "enum": [ "LEVENSHTEIN", "JARO_WINKLER" ] }, "similarityThreshold": { "type": "number", "format": "double" } } }, "LuisNLP": { "required": [ "appId", "appName", "excludeTrainingTags", "includeTrainingTags", "language", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/NLPPipeline" }, { "type": "object", "properties": { "appId": { "type": "string" }, "appName": { "type": "string" }, "authoringKey": { "type": "string" }, "appVersion": { "type": "string" }, "host": { "type": "string" }, "predictionHost": { "type": "string" }, "predictionKey": { "type": "string" } } } ] }, "MaskExpression": { "required": [ "name", "regex" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name for the mask expression", "example": "E-Mail mask" }, "regex": { "type": "string", "description": "The regex pattern to search for", "example": "[a-zA-Z0-9_@]+" }, "substitute": { "maxLength": 15, "minLength": 1, "pattern": "^[^$]+$", "type": "string", "description": "Useful if third party services (such as LLMs) get confused by the default asterisk replacement", "example": " or john@doe.com" } }, "description": "Regular expressions matched against user input to mask sensitive data" }, "MenuButton": { "required": [ "node", "title" ], "type": "object", "properties": { "node": { "type": "string" }, "title": { "type": "string" } }, "description": "The menu buttons." }, "MicrosoftTeamsIntegrationSettings": { "required": [ "azureTenantId", "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "azureTenantId": { "type": "string" }, "serviceUrl": { "type": "string" } } }, "MicrosoftTeamsLayoutSettings": { "type": "object", "properties": { "showTypingIndicator": { "type": "boolean" } } }, "MicrosoftWebChatIntegrationSettings": { "required": [ "azureBotHandle", "clientId", "clientSecret", "webSecretKey" ], "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "webSecretKey": { "type": "string" }, "azureBotHandle": { "type": "string" }, "azureTenantId": { "type": "string" } } }, "MonitoringSettings": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether monitoring is enabled for the tenant or not", "readOnly": true }, "alertEmail": { "type": "string", "description": "The email address to use for monitoring alerts" } } }, "NLPPipeline": { "required": [ "excludeTrainingTags", "includeTrainingTags", "language", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "LUIS_NLP", "OPENAI_NLP", "HELVIA_NLP_SPECIFICATION", "HELVIA_RAG_PIPELINE", "DIALOGFLOW_NLP", "HELVIA_GPT" ] }, "includeTrainingTags": { "type": "array", "items": { "type": "string" } }, "excludeTrainingTags": { "type": "array", "items": { "type": "string" } }, "language": { "type": "string" }, "secondaryLanguages": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] } }, "organizationRef": { "type": "string" }, "tenantRef": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "OUTDATED", "TRAINING", "FAILED", "READY", "INITIALIZED" ] }, "failedReason": { "type": "string" }, "lastTrainedAt": { "type": "string", "format": "date-time" }, "predictionConfidenceThreshold": { "maximum": 1, "minimum": 0, "exclusiveMinimum": true, "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "trainCount": { "type": "integer", "format": "int32" }, "trainingGroup": { "type": "string" }, "nlpService": { "type": "string", "enum": [ "HBF_NLP", "HBF_CORE" ] } }, "description": "Language - Pipeline association with the tenant (literal)", "discriminator": { "propertyName": "type" } }, "NLPPipelineTreeHeaderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Pipeline Decision Tree ID", "example": "1234567890" }, "name": { "type": "string", "description": "Pipeline Decision Tree Name", "example": "Decision Tree 1" }, "language": { "type": "string", "description": "Pipeline Decision Tree Language", "example": "en" }, "createdAt": { "type": "string", "description": "Pipeline Decision Tree Created At", "format": "date-time", "example": "2021-01-01T00:00:00Z" }, "updatedAt": { "type": "string", "description": "Pipeline Decision Tree Updated At", "format": "date-time", "example": "2021-01-01T00:00:00Z" }, "variables": { "type": "array", "description": "The variables used in the Pipeline Decision Tree", "example": "UserInfo.email, UserInfo.fullName", "items": { "type": "string", "description": "The variables used in the Pipeline Decision Tree", "example": "UserInfo.email, UserInfo.fullName" } } }, "description": "Language - Pipeline Tree metadata association with the tenant (literal)" }, "NLPSettings": { "type": "object", "properties": { "fallbackNlpFlowId": { "type": "string" } } }, "NLPTrainingData": { "type": "object", "properties": { "articleId": { "type": "string", "description": "The id of the related article that its content is used in training." }, "supportedLanguages": { "type": "array", "description": "The supported languages that can be trained.", "items": { "type": "string", "description": "The supported languages that can be trained." } }, "examples": { "type": "object", "additionalProperties": { "type": "array", "description": "Examples by language used in training.", "items": { "type": "string", "description": "Examples by language used in training." } }, "description": "Examples by language used in training." } }, "description": "Training data associated with the activity." }, "NextEntry": { "required": [ "convNodeId", "weight" ], "type": "object", "properties": { "convNodeId": { "type": "string" }, "weight": { "type": "number", "format": "double" }, "condition": { "$ref": "#/components/schemas/ConvNodeCondition" } } }, "NlgSettings": { "type": "object", "properties": { "language": { "type": "string" } } }, "NotificationButton": { "required": [ "conversationNodeId", "title", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "HCN" ] }, "title": { "type": "string" }, "conversationNodeId": { "type": "string" } } }, "OpenAINLP": { "required": [ "apiKey", "excludeTrainingTags", "includeTrainingTags", "language", "model", "modelCategory", "name", "trainingType" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/NLPPipeline" }, { "type": "object", "properties": { "model": { "type": "string" }, "apiKey": { "type": "string" }, "temperature": { "type": "number", "format": "double" }, "maxTokens": { "type": "integer", "format": "int32" }, "logprobs": { "maximum": 5, "type": "integer", "format": "int32" }, "numberOfExamples": { "minimum": 2, "type": "integer", "format": "int32" }, "presencePenalty": { "type": "number", "format": "double" }, "frequencyPenalty": { "type": "number", "format": "double" }, "stop": { "maxItems": 4, "minItems": 0, "type": "array", "items": { "type": "string" } }, "trainingType": { "type": "string", "enum": [ "ZERO_SHOT", "ONE_SHOT", "FEW_SHOT", "CUSTOM_PROMPT", "FINE_TUNED" ] }, "modelCategory": { "type": "string", "enum": [ "COMPLETION", "CHAT" ] } } } ] }, "PrivacySettings": { "type": "object", "properties": { "censorUserInput": { "type": "boolean", "description": "Flag for force hide of input text from any storage" }, "maskExpressions": { "type": "array", "description": "Regular expressions matched against user input to mask sensitive data", "items": { "$ref": "#/components/schemas/MaskExpression" } }, "anonymizationSettings": { "$ref": "#/components/schemas/AnonymizationSettings" } } }, "RAGPipelineSettings": { "required": [ "includeHistory", "maxHistoryTurns" ], "type": "object", "properties": { "includeHistory": { "type": "boolean" }, "maxHistoryTurns": { "type": "integer", "format": "int32" } } }, "Response": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "SessionSettings": { "type": "object", "properties": { "expireInactiveSessionAfter": { "minimum": 0, "type": "integer", "format": "int32" } } }, "SlackIntegrationSettings": { "required": [ "appId", "botUserOAuthToken", "clientId", "clientSecret", "teamId" ], "type": "object", "properties": { "botUserOAuthToken": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "appId": { "type": "string" }, "teamId": { "type": "string" } } }, "SlackLayoutSettings": { "type": "object" }, "StartUpNotification": { "required": [ "buttons", "level", "text" ], "type": "object", "properties": { "text": { "type": "string" }, "level": { "type": "string", "enum": [ "ERROR", "INFO", "SUCCESS", "WARN" ] }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationButton" } } }, "description": "The startup notifications" }, "TenantDto": { "required": [ "displayName", "powerups", "settings", "systemSettings", "tags" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the Tenant.", "example": "1" }, "displayName": { "maxLength": 240, "minLength": 1, "type": "string", "description": "A human-readable name for the Tenant", "example": "HRWiz" }, "organizationId": { "type": "string", "description": "The Organization's ID of the Tenant", "example": "fff43491959195" }, "contentId": { "type": "string", "description": "The bot content id", "example": "1" }, "contentCompiledId": { "type": "string", "description": "The bot content compiled id", "example": "1" }, "content": { "$ref": "#/components/schemas/BotContentDto" }, "contentCompiled": { "$ref": "#/components/schemas/BotContentCompiledDto" }, "description": { "maxLength": 400, "minLength": 0, "type": "string", "description": "Tenant's description", "example": "Lorem ipsum dolor.." }, "componentTree": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object", "description": "The componentTree configuration" }, "description": "The componentTree configuration" }, "settings": { "$ref": "#/components/schemas/TenantSettingsDto" }, "botDeployments": { "uniqueItems": true, "type": "array", "description": "Bot Deployments of tenant.", "items": { "$ref": "#/components/schemas/BotDeploymentDto" } }, "nluCachingEnabled": { "type": "boolean", "description": "If nlu caching is enabled for this tenant" }, "nluSync": { "type": "boolean", "description": "If tenant is allowed to sync- update the nlu agent he is linked to." }, "nlpMapRef": { "type": "object", "additionalProperties": { "type": "string", "description": "Language - Pipeline association with the tenant (language - pipelineId)" }, "description": "Language - Pipeline association with the tenant (language - pipelineId)" }, "nlpMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NLPPipeline" }, "description": "Language - Pipeline association with the tenant (literal)" }, "nlpTreeMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NLPPipelineTreeHeaderDto" }, "description": "Language - Pipeline Tree metadata association with the tenant (literal)" }, "systemSettings": { "$ref": "#/components/schemas/TenantSystemSettingsDto" }, "image": { "maxLength": 400, "minLength": 0, "type": "string", "description": "Tenant's Image URL" }, "tenantStats": { "$ref": "#/components/schemas/TenantStatsDto" }, "timezone": { "maxLength": 400, "minLength": 1, "type": "string", "description": "The Tenant's Main Timezone" }, "powerups": { "type": "array", "description": "The Powerups enabled for the Tenant", "items": { "type": "string", "description": "The Powerups enabled for the Tenant", "enum": [ "HRWIZ", "FAQS", "BROADCASTS", "FLOWS", "LIVECHAT", "SURVEYS", "INTERVIEWS", "CHAT_SESSIONS", "SENTIMENT_ANALYSIS", "ANALYTICS", "SETTINGS", "BACKUPS", "INTEGRATIONS", "BILLING", "MONITORING", "NLU_CACHING", "CONNECTORS" ] } }, "created": { "type": "string", "description": "The time the Tenant was created.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "lastChanged": { "type": "string", "description": "The last time the Tenant has been modified.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "lastChangedBy": { "$ref": "#/components/schemas/EditorDto" }, "entryNodes": { "type": "array", "description": "The tenant's entry nodes.", "items": { "type": "string", "description": "The tenant's entry nodes." } }, "tags": { "type": "array", "description": "List of Tenant's tags", "items": { "type": "string", "description": "List of Tenant's tags" } }, "dataRetentionPeriod": { "type": "integer", "description": "Tenant's Data Retention Period in months", "format": "int32", "example": 1 }, "disabled": { "type": "boolean" }, "plugins": { "uniqueItems": true, "type": "array", "description": "Tenant Plugins", "items": { "$ref": "#/components/schemas/IntegrationPlugin" } }, "space": { "type": "string", "description": "The scope for the Tenant", "enum": [ "bot-lab", "cx", "ex" ] }, "sourceTemplateId": { "type": "string", "description": "The source Bot Template ID of this Tenant; used for analytics", "example": "fff43491959195" } }, "description": "The Tenant to which the Chat session belong." }, "TenantSettingsDto": { "type": "object", "properties": { "autoTrain": { "type": "boolean" }, "session": { "$ref": "#/components/schemas/SessionSettings" }, "monitoring": { "$ref": "#/components/schemas/MonitoringSettings" }, "externalAnalytics": { "$ref": "#/components/schemas/ExternalAnalytics" }, "privacy": { "$ref": "#/components/schemas/PrivacySettings" }, "languages": { "$ref": "#/components/schemas/LanguageSettings" }, "feedback": { "$ref": "#/components/schemas/FeedbackSettings" }, "nluLocal": { "$ref": "#/components/schemas/LocalNluSettings" }, "nlp": { "$ref": "#/components/schemas/NLPSettings" } } }, "TenantStatsDto": { "required": [ "data", "lastStatsUpdate" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the TenantStats.", "example": "1" }, "tenantId": { "type": "string", "description": "The Tenant ID the stats are about." }, "lastStatsUpdate": { "type": "string", "description": "Date of last update of the stats.", "format": "date-time" }, "data": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object", "description": "The data of the stats." }, "description": "The data of the stats." } }, "description": "Tenant's stats" }, "TenantSystemSettingsDto": { "type": "object", "properties": { "convManager": { "$ref": "#/components/schemas/ConversationManagerSettings" }, "languageDetection": { "$ref": "#/components/schemas/LanguageDetectionSettings" }, "nlg": { "$ref": "#/components/schemas/NlgSettings" }, "liveChat": { "$ref": "#/components/schemas/LiveChatSystemSettings" }, "microsoftDataverse": { "type": "object", "additionalProperties": { "type": "object" } }, "microsoftSharepoint": { "type": "object", "additionalProperties": { "type": "object" } }, "dialogFlowDirect": { "$ref": "#/components/schemas/DialogFlowDirectSettings" }, "readOnly": { "type": "boolean" }, "maxNumOfUserMessages": { "type": "integer", "format": "int32" }, "maxNumOfSessions": { "type": "integer", "format": "int32" }, "nlpService": { "type": "string", "enum": [ "HBF_NLP", "HBF_CORE" ] }, "useAutomatedAnswerTags": { "type": "boolean" }, "isAgent": { "type": "boolean" }, "nlpServiceUrl": { "type": "string" }, "nlpPipelineId": { "type": "string" }, "nlpAccessToken": { "type": "string" } } }, "UnityIntegrationSettings": { "type": "object", "properties": { "jwtToken": { "type": "string" } } }, "UserPromptBubble": { "required": [ "delayInSeconds", "enable", "message" ], "type": "object", "properties": { "enable": { "type": "boolean" }, "delayInSeconds": { "minimum": 0, "type": "integer", "format": "int32" }, "message": { "type": "string" } }, "description": "The user prompt bubble functionality" }, "VariableSpec": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "AUTO", "INTERVIEW", "QUESTION", "CALLBACK", "SESSION", "CONTACT", "SYSTEM", "CSAT", "LIVECHAT", "STATIC" ] }, "description": { "type": "string" }, "fromActivity": { "type": "string" }, "value": { "type": "string" }, "isConstant": { "type": "boolean" } } }, "ViberIntegrationSettings": { "required": [ "authToken" ], "type": "object", "properties": { "authToken": { "type": "string" }, "registerToEvents": { "type": "array", "items": { "type": "string", "enum": [ "MESSAGE", "FAILED", "DELIVERED", "SEEN", "CONVERSATION_STARTED", "UNSUBSCRIBED", "SUBSCRIBED", "WEBHOOK" ] } } } }, "ViberLayoutSettings": { "required": [ "avatar", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "avatar": { "type": "string" }, "entryPoint": { "type": "string" } } }, "WebChatSettings": { "required": [ "configuration" ], "type": "object", "properties": { "tokenUrl": { "type": "string", "readOnly": true }, "botId": { "type": "string", "readOnly": true }, "botName": { "type": "string", "readOnly": true }, "configuration": { "$ref": "#/components/schemas/Configuration" } } }, "WhatsAppIntegrationSettings": { "required": [ "accessToken", "phoneNumberId" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "phoneNumberId": { "type": "string" } } }, "WhatsAppLayoutSettings": { "type": "object", "properties": { "showTypingIndicator": { "type": "boolean" } } }, "SubscriberDto": { "required": [ "fullName", "handle", "tenantId" ], "type": "object", "properties": { "id": { "type": "string" }, "handle": { "maxLength": 256, "minLength": 1, "type": "string", "description": "The Human-readable identifier of the Subscriber.", "example": "SomeGuy090" }, "email": { "maxLength": 150, "minLength": 1, "type": "string", "description": "Subscriber's Email", "example": "someguy@somemail.com" }, "fullName": { "maxLength": 150, "minLength": 1, "type": "string", "description": "Subscriber's Full Name", "example": "Some Guy" }, "telephoneNumber": { "maxLength": 150, "minLength": 1, "type": "string", "description": "Subscriber's Telephone Number", "example": "+32123445657889" }, "country": { "maxLength": 60, "minLength": 0, "type": "string", "description": "Subscriber's Country", "example": "Italy" }, "language": { "maxLength": 60, "minLength": 0, "type": "string", "description": "Subscriber's Language", "example": "Italian" }, "discriminator": { "maxLength": 150, "minLength": 0, "type": "string", "description": "This value discriminates Bot Deployments created using the same Messaging App; it allows specific platforms (e.g. Teams, Slack) to have multiple Bot Deployments using the same Messaging App on the same Tenant" }, "customData": { "type": "object", "additionalProperties": { "type": "object", "description": "Subscriber's Custom Data" }, "description": "Subscriber's Custom Data" }, "blackboard": { "type": "object", "additionalProperties": { "type": "object", "description": "A copy of the permanent BlackBoard" }, "description": "A copy of the permanent BlackBoard" }, "tenantId": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "The Tenant ID where the Subscriber belong.", "writeOnly": true, "example": "some_tenant_id_xyz" }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "activeAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "description": "Date of document last update", "format": "date-time" } } }, "BroadcastDto": { "required": [ "groups", "label", "method", "sendAt", "status", "text", "title", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Broadcast's ID", "example": "1213991249013" }, "label": { "maxLength": 60, "minLength": 1, "type": "string", "description": "Broadcast's Label", "example": "1213991249013" }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "groups": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Broadcast's connected Groups", "items": { "$ref": "#/components/schemas/GroupDto" } }, "results": { "$ref": "#/components/schemas/BroadcastResultsDto" }, "method": { "type": "string", "description": "Broadcasting Method", "enum": [ "BATCHES", "ONE_SHOT" ] }, "text": { "maxLength": 2000, "minLength": 1, "type": "string", "description": "Broadcasted Text" }, "type": { "type": "string", "description": "Broadcast's Type", "enum": [ "MESSAGE", "QUIZ", "POLL", "ANALYTICS_REPORT", "POSTBACK" ] }, "image": { "maxLength": 400, "minLength": 1, "type": "string", "description": "Broadcast's Image URL" }, "status": { "type": "string", "description": "The current Broadcast's Status", "enum": [ "INACTIVE", "PENDING", "SENDING", "WAITING", "COMPLETE", "ERROR" ] }, "error": { "type": "string", "description": "Broadcast's last Error (if any)" }, "choices": { "type": "array", "description": "Broadcast's Multiple Choices", "items": { "$ref": "#/components/schemas/ChoiceDto" } }, "sendAt": { "type": "string", "description": "Broadcast's Scheduled Date", "format": "date-time" }, "postbackData": { "type": "object", "additionalProperties": { "type": "object", "description": "Broadcast's Postback Data" }, "description": "Broadcast's Postback Data" }, "platform": { "type": "string", "description": "Broadcast's Platform", "enum": [ "MICROSOFT_TEAMS", "MICROSOFT_WEB_CHAT", "VIBER", "FACEBOOK", "LIVECHAT", "SLACK", "INSTAGRAM", "UNITY", "WHATSAPP", "API" ] }, "title": { "maxLength": 200, "minLength": 1, "type": "string", "description": "Broadcast's Title" }, "userEmail": { "type": "string", "description": "Broadcast's User Email" }, "userFullName": { "type": "string", "description": "Broadcast's Full Name" }, "currentBatch": { "type": "integer", "description": "The current batch while sending the Broadcast", "format": "int32" }, "totalBatches": { "type": "integer", "description": "The total batches of the Broadcast", "format": "int32" } } }, "BroadcastResultsDto": { "type": "object", "properties": { "totalRecipients": { "type": "integer", "description": "Total recipients", "format": "int64", "example": 10 }, "totalDelivered": { "type": "integer", "description": "Total delivered", "format": "int64", "example": 5 }, "totalResponded": { "type": "integer", "description": "Total responded", "format": "int64", "example": 3 } }, "description": "Broadcast's Results" }, "ChoiceDto": { "required": [ "isCorrect", "text" ], "type": "object", "properties": { "text": { "maxLength": 300, "minLength": 1, "type": "string", "description": "Text for a possible answer.", "example": "The Moon" }, "isCorrect": { "type": "boolean", "description": "Is the answer correct?", "example": true } }, "description": "Broadcast's Multiple Choices" }, "GroupDto": { "required": [ "active", "label", "platform", "tenantId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Group ID", "example": "4923052358329" }, "tenantId": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "The ID of the Tenant to which the Group belong.", "writeOnly": true }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "label": { "maxLength": 150, "minLength": 1, "type": "string", "description": "Group label", "example": "something" }, "handle": { "maxLength": 150, "minLength": 1, "type": "string", "description": "Group Handle", "example": "BestGroup034" }, "subscribers": { "maxItems": 2147483647, "minItems": 0, "uniqueItems": true, "type": "array", "description": "Subscribers in this Group", "items": { "type": "string", "description": "Subscribers in this Group" } }, "usersIds": { "maxItems": 2147483647, "minItems": 0, "uniqueItems": true, "type": "array", "description": "Console users' ids in this Group", "items": { "type": "string", "description": "Console users' ids in this Group" } }, "syncedAt": { "type": "string", "description": "Last Time Synched", "format": "date-time", "example": "2020-07-09T12:16:36.44093+02:00" }, "active": { "type": "boolean", "description": "Is the Group active?", "example": true }, "platform": { "type": "string", "description": "The type of the group", "example": "MS_TEAMS", "enum": [ "MICROSOFT_TEAMS", "MICROSOFT_WEB_CHAT", "VIBER", "FACEBOOK", "LIVECHAT", "SLACK", "INSTAGRAM", "UNITY", "WHATSAPP", "API" ] } }, "description": "Broadcast's connected Groups" }, "ResponseDto": { "required": [ "broadcastId", "sent", "subscriberFullName", "subscriberHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "Response ID", "example": "312419294139" }, "subscriberHandle": { "maxLength": 120, "minLength": 1, "type": "string", "description": "The Subscriber handle of the respondent.", "example": "sub2940" }, "subscriberFullName": { "maxLength": 120, "minLength": 1, "type": "string", "description": "The Subscriber full name of the respondent.", "example": "John Doe" }, "subscriberEmail": { "maxLength": 150, "minLength": 1, "type": "string", "description": "The Subscriber email of the respondent.", "example": "someguy@somemail.com" }, "broadcastLabel": { "maxLength": 120, "minLength": 1, "type": "string", "description": "The Broadcast label to which this Response is answering." }, "broadcastId": { "maxLength": 2147483647, "minLength": 1, "type": "string", "description": "The ID of the Broadcast to which this Response is answering.", "writeOnly": true }, "broadcast": { "$ref": "#/components/schemas/BroadcastDto" }, "sent": { "type": "boolean", "description": "Is this response already sent?", "example": false }, "error": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "The last error obtained processing this Response. If any." }, "selectedChoice": { "type": "integer", "description": "Which choice this response refers to?", "format": "int32", "example": 2 }, "sentAt": { "type": "string", "description": "Sent Date of the original Broadcast", "format": "date-time", "example": "2020-07-09T12:51:00.685499+02:00" }, "respondedAt": { "type": "string", "description": "Sent Date for the Response", "format": "date-time", "example": "2020-07-09T12:51:38.47857+02:00" } } }, "TokenDto": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string", "description": "The token generated by the API" } } }, "ChatSessionCSATSurvey": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID from the CSAT Node Response" }, "name": { "type": "string", "description": "Name of CSAT Node Variable" }, "status": { "type": "string", "description": "The status of the CSAT Survey. Can be 'PRESENTED' or 'ANSWERED'." }, "sectionsScore": { "type": "object", "additionalProperties": { "type": "integer", "description": "The scores of the sections given by the End User.", "format": "int32" }, "description": "The scores of the sections given by the End User." } }, "description": "The customer satisfaction scores for the chat session" }, "ChatSessionConversationNode": { "type": "object", "properties": { "nodeId": { "type": "string", "description": "The node id" }, "appearances": { "type": "integer", "description": "The number of appearances", "format": "int32" } }, "description": "A list of conversation nodes and the number of their appearance in this session" }, "ChatSessionDto": { "required": [ "containsUserInteraction", "subscriberHandle", "tenantId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Chat session uuid", "example": "af38d502-7961-4dcf-a038-21d8ebb4f435" }, "duration": { "type": "integer", "description": "Duration of the chat session in mill", "format": "int64", "example": 60000 }, "messageCount": { "type": "integer", "description": "Messages count for the chat session", "format": "int32", "example": 10 }, "messages": { "type": "array", "description": "List of messages in the chat session", "items": { "$ref": "#/components/schemas/ChatSessionMessage" } }, "status": { "type": "string", "description": "Status of chat session", "example": "active", "enum": [ "ACTIVE", "COMPLETED" ] }, "tags": { "uniqueItems": true, "type": "array", "description": "List of tags for a chat session", "items": { "type": "string", "description": "List of tags for a chat session" } }, "subscriberHandle": { "type": "string", "description": "The subscriber handle where the chat session belongs", "example": "12345678" }, "language": { "type": "string", "description": "The language of the session", "example": "en", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "summary": { "type": "string", "description": "The AI summary of the chat session messages" }, "sentiment": { "type": "string", "description": "The sentiment label given by AI" }, "resolution": { "type": "string", "description": "The resolution label given by AI" }, "urgency": { "type": "string", "description": "The urgency label given by AI" }, "features": { "type": "object", "additionalProperties": { "type": "object", "description": "The features extracted by AI" }, "description": "The features extracted by AI" }, "csatSurveys": { "uniqueItems": true, "type": "array", "description": "The customer satisfaction scores for the chat session", "items": { "$ref": "#/components/schemas/ChatSessionCSATSurvey" } }, "tenantId": { "type": "string", "description": "The id of the tenant", "writeOnly": true, "example": "60faf0f8df4f1876c07b8271" }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "lastInteraction": { "type": "string", "format": "date-time" }, "conversationNodes": { "type": "array", "description": "A list of conversation nodes and the number of their appearance in this session", "items": { "$ref": "#/components/schemas/ChatSessionConversationNode" } }, "intents": { "type": "object", "additionalProperties": { "type": "integer", "description": "A map of Intents and the number of their appearance in this session", "format": "int32" }, "description": "A map of Intents and the number of their appearance in this session" }, "createdAt": { "type": "string", "description": "Date of document creation", "format": "date-time" }, "updatedAt": { "type": "string", "description": "Date of document last update", "format": "date-time" }, "containsUserInteraction": { "type": "boolean", "description": "If the chat session contains at least one user interaction", "readOnly": true }, "userInteractionCount": { "type": "integer", "description": "User interactions count for the chat session", "format": "int32", "readOnly": true, "example": 10 }, "liveChats": { "type": "array", "description": "List of live chat sessions in the chat session", "items": { "$ref": "#/components/schemas/LiveChatSession" } }, "metadata": { "$ref": "#/components/schemas/ChatSessionMetadata" }, "variables": { "uniqueItems": true, "type": "array", "description": "Chat session variables mappings", "items": { "$ref": "#/components/schemas/ChatSessionVariableMapping" } } }, "description": "The Surveys Session" }, "ChatSessionMessage": { "type": "object", "properties": { "subscriberHandle": { "type": "string", "description": "The handle of the subscriber that sent this message" }, "subscriberName": { "type": "string", "description": "The subscriber's name" }, "subscriberEmail": { "type": "string", "description": "The subscriber's email" }, "message": { "type": "string", "description": "The message that was sent" }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags of the message", "items": { "type": "string", "description": "The list of tags of the message" } }, "intentName": { "type": "string", "description": "The intent name that was triggered when receiving this message (optional)" }, "conversationNode": { "type": "string", "description": "The name of the conversation node that got triggered" }, "type": { "type": "string", "description": "The type of this ChatSessionMessage", "enum": [ "TEXT", "POSTBACK", "ATTACHMENT", "TRIGGER" ] }, "category": { "type": "string", "description": "The category of this ChatSessionMessage", "enum": [ "FALLBACK", "FEEDBACK", "LIVE_CHAT", "BACK", "COMMON" ] }, "date": { "type": "string", "description": "The date this message was sent as a unix timestamp", "format": "date-time" }, "isUserInteraction": { "type": "boolean", "description": "Indicates if the message was send by a user" }, "liveChatEventType": { "type": "string", "description": "Type of incoming LiveChat event", "enum": [ "LIVECHAT_INITIALIZED", "LIVECHAT_REQUESTED", "LIVECHAT_REQUEST_CLOSED", "LIVECHAT_REQUEST_ACCEPTED", "LIVECHAT_REQUEST_MISSED", "LIVECHAT_TERMINATION_REQUESTED", "LIVECHAT_TERMINATED", "LIVECHAT_ABANDONED", "LIVECHAT_TRANSFERRED", "LIVECHAT_MESSAGE_EXCHANGED", "LIVECHAT_MESSAGE_TYPING", "LIVECHAT_IS_DISABLED", "LIVECHAT_REQUEST_EXISTS", "LIVECHAT_OUT_OF_BUSINESS_HOURS", "LIVECHAT_IS_IN_PROGRESS", "LIVECHAT_GENERIC_ERROR", "SOURCE_REQUEST_NEW_HANDOVER", "SOURCE_PRE_REQUEST_NEW_HANDOVER" ] }, "liveChatSender": { "type": "string", "description": "The sender of the live chat message", "enum": [ "END_USER", "AGENT" ] }, "liveChatConversationId": { "type": "string", "description": "The live chat conversation id" }, "id": { "type": "string", "description": "A unique identifier of the message, set by hbf-bot" }, "responseToId": { "type": "string", "description": "Identifier of the HBFEvent this bot response corresponds to" }, "language": { "type": "string", "description": "The language used in this message" } }, "description": "List of messages in the chat session" }, "ChatSessionMetadata": { "type": "object", "properties": { "subscriberName": { "type": "string" }, "subscriberEmail": { "type": "string" }, "subscriberCustomData": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object" } }, "deploymentId": { "type": "string" }, "deploymentName": { "type": "string" }, "platformOrigin": { "type": "string" }, "deploymentPlatform": { "type": "string" }, "isSubscriberNew": { "type": "boolean" } }, "description": "Chat session metadata" }, "ChatSessionVariableMapping": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The variable name" }, "value": { "type": "string", "description": "The variable value" } }, "description": "Chat session variables mappings" }, "LiveChatSession": { "required": [ "agents", "duration", "lastEndUserMessageAt", "lastSender", "liveChatEventType", "responseTime", "updatedAt" ], "type": "object", "properties": { "waitingTime": { "type": "integer", "format": "int64" }, "liveChatEventType": { "type": "string", "enum": [ "LIVECHAT_INITIALIZED", "LIVECHAT_REQUESTED", "LIVECHAT_REQUEST_CLOSED", "LIVECHAT_REQUEST_ACCEPTED", "LIVECHAT_REQUEST_MISSED", "LIVECHAT_TERMINATION_REQUESTED", "LIVECHAT_TERMINATED", "LIVECHAT_ABANDONED", "LIVECHAT_TRANSFERRED", "LIVECHAT_MESSAGE_EXCHANGED", "LIVECHAT_MESSAGE_TYPING", "LIVECHAT_IS_DISABLED", "LIVECHAT_REQUEST_EXISTS", "LIVECHAT_OUT_OF_BUSINESS_HOURS", "LIVECHAT_IS_IN_PROGRESS", "LIVECHAT_GENERIC_ERROR", "SOURCE_REQUEST_NEW_HANDOVER", "SOURCE_PRE_REQUEST_NEW_HANDOVER" ] }, "duration": { "type": "integer", "format": "int64" }, "responseTime": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "updatedAt": { "type": "string", "format": "date-time" }, "lastEndUserMessageAt": { "type": "string", "format": "date-time" }, "lastSender": { "type": "string", "enum": [ "END_USER", "AGENT" ] }, "conversationId": { "type": "string" }, "agents": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } } }, "description": "List of live chat sessions in the chat session" }, "SurveyDto": { "required": [ "questions", "session", "subscriber", "tenantId", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Survey ID", "example": "4923052358329" }, "tenantId": { "type": "string", "description": "Tenant of the Survey", "example": "some tenant" }, "session": { "type": "string", "description": "SessionID for the Survey", "example": "4923052358329" }, "chatSession": { "$ref": "#/components/schemas/ChatSessionDto" }, "subscriber": { "type": "string", "description": "Subscriber ID for the Survey", "example": "4923052358329" }, "questions": { "type": "array", "description": "List of questions and answers.", "items": { "$ref": "#/components/schemas/SurveyQuestion" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "description": "The survey type.", "enum": [ "INTERVIEW", "LIVECHAT", "USER_FEEDBACK" ] } } }, "SurveyQuestion": { "required": [ "answer", "question", "questionId" ], "type": "object", "properties": { "questionId": { "type": "string" }, "question": { "type": "string" }, "answer": { "type": "string" }, "sourceActivityName": { "type": "string" } }, "description": "List of questions and answers." }, "ApiAppConfigurations": { "type": "object" }, "EventCallback": { "type": "object", "properties": { "actionUrl": { "type": "string" } } }, "FacebookAppConfigurations": { "required": [ "pageAccessToken" ], "type": "object", "properties": { "pageAccessToken": { "type": "string" } } }, "InstagramAppConfigurations": { "required": [ "pageAccessToken" ], "type": "object", "properties": { "pageAccessToken": { "type": "string" } } }, "MessagingApp": { "required": [ "appId", "appName", "config", "platform" ], "type": "object", "properties": { "id": { "type": "string" }, "appId": { "type": "string" }, "appName": { "type": "string" }, "platform": { "type": "string", "enum": [ "MICROSOFT_TEAMS", "MICROSOFT_WEB_CHAT", "VIBER", "FACEBOOK", "LIVECHAT", "SLACK", "INSTAGRAM", "UNITY", "WHATSAPP", "API" ] }, "config": { "$ref": "#/components/schemas/MessagingAppConfigurations" }, "eventCallback": { "$ref": "#/components/schemas/EventCallback" }, "fallbackNotFoundDeploymentId": { "type": "string" }, "fallbackDisabledDeploymentId": { "type": "string" } } }, "MessagingAppConfigurations": { "type": "object", "properties": { "microsoftTeams": { "$ref": "#/components/schemas/MicrosoftTeamsAppConfigurations" }, "microsoftWebChat": { "$ref": "#/components/schemas/MicrosoftWebChatAppConfigurations" }, "viber": { "$ref": "#/components/schemas/ViberAppConfigurations" }, "facebook": { "$ref": "#/components/schemas/FacebookAppConfigurations" }, "instagram": { "$ref": "#/components/schemas/InstagramAppConfigurations" }, "slack": { "$ref": "#/components/schemas/SlackAppConfigurations" }, "unity": { "$ref": "#/components/schemas/UnityAppConfigurations" }, "whatsapp": { "$ref": "#/components/schemas/WhatsAppAppConfigurations" }, "api": { "$ref": "#/components/schemas/ApiAppConfigurations" } } }, "MicrosoftTeamsAppConfigurations": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" } } }, "MicrosoftWebChatAppConfigurations": { "required": [ "azureBotHandle", "clientId", "clientSecret", "webSecretKey" ], "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "webSecretKey": { "type": "string" }, "azureBotHandle": { "type": "string" }, "azureTenantId": { "type": "string" } } }, "SlackAppConfigurations": { "required": [ "appId", "botUserOAuthToken", "clientId", "clientSecret" ], "type": "object", "properties": { "botUserOAuthToken": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "appId": { "type": "string" } } }, "UnityAppConfigurations": { "type": "object" }, "ViberAppConfigurations": { "required": [ "authToken" ], "type": "object", "properties": { "authToken": { "type": "string" }, "registerToEvents": { "type": "array", "items": { "type": "string", "enum": [ "MESSAGE", "FAILED", "DELIVERED", "SEEN", "CONVERSATION_STARTED", "UNSUBSCRIBED", "SUBSCRIBED", "WEBHOOK" ] } } } }, "WhatsAppAppConfigurations": { "required": [ "accessToken", "phoneNumberId" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "phoneNumberId": { "type": "string" } } }, "UserGroupDto": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Internal id (read only)", "readOnly": true }, "name": { "type": "string", "description": "User Group name. Must be unique per organization", "example": "Some Group" }, "description": { "type": "string", "description": "Brief description", "example": "Very nice group. Let's play" }, "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "organizationId": { "type": "string", "description": "The organization to associate to by id (write only)", "writeOnly": true, "example": "6051da0573c0fe08d75193d4" }, "users": { "type": "array", "description": "List of users of this group (read only)", "readOnly": true, "items": { "$ref": "#/components/schemas/UserDto" } }, "userIds": { "uniqueItems": true, "type": "array", "description": "List of users to associate to by id (write only)", "writeOnly": true, "example": "6168287fe267be3d67b1a74b", "items": { "type": "string", "description": "List of users to associate to by id (write only)", "writeOnly": true, "example": "6168287fe267be3d67b1a74b" } }, "userCount": { "type": "integer", "description": "The number of users. Useful when listing (read only)", "format": "int32", "readOnly": true }, "tenantRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "UserGroup roles for the organization's tenants.", "items": { "type": "string", "description": "UserGroup roles for the organization's tenants.", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } }, "description": "UserGroup roles for the organization's tenants." }, "organizationRoles": { "uniqueItems": true, "type": "array", "description": "UserGroup roles for the organization.", "items": { "type": "string", "description": "UserGroup roles for the organization.", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, "externalChannel": { "$ref": "#/components/schemas/ExternalEntity" }, "createdAt": { "type": "string", "description": "Date created (read only)", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "description": "Date updated (read only)", "format": "date-time", "readOnly": true } } }, "Organization": { "required": [ "loginSettings" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "image": { "type": "string" }, "timezone": { "type": "string" }, "auditLogsNotificationEmail": { "type": "string" }, "auditLogsNotificationsEnabled": { "type": "boolean" }, "externalOrganizations": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalEntity" } }, "externalAnalytics": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalAnalytics" } }, "dataRetentionPeriod": { "type": "integer", "format": "int32" }, "auditLogsRetentionPeriod": { "type": "integer", "format": "int32" }, "loginSettings": { "$ref": "#/components/schemas/LoginSettings" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "User": { "required": [ "accountLocked", "effectiveRoles", "emailVerified", "failedLoginAttempts", "organizationRoles", "organizations", "tenantRoles" ], "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "fullName": { "type": "string" }, "image": { "type": "string" }, "telephoneNumber": { "type": "string" }, "country": { "type": "string" }, "language": { "type": "string" }, "isModerator": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "lastLogin": { "type": "string", "format": "date-time" }, "accountLocked": { "type": "boolean" }, "failedLoginAttempts": { "type": "integer", "format": "int32" }, "lockedAt": { "type": "string", "format": "date-time" }, "externalUsers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalEntity" } }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } }, "tenantRoles": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } } } }, "organizationRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } } }, "effectiveRoles": { "$ref": "#/components/schemas/EffectiveRoles" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "UserGroup": { "required": [ "name", "organizationRoles", "tenantRoles", "users" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization" }, "users": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "userCount": { "type": "integer", "format": "int32" }, "tenantRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } } }, "organizationRoles": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, "externalChannel": { "$ref": "#/components/schemas/ExternalEntity" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "CloneTenantDto": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the cloned Tenant.", "example": "NewTenantFromTemplate" } } }, "RegistrationDto": { "type": "object", "properties": { "fullName": { "maxLength": 120, "minLength": 1, "type": "string", "description": "User's Full Name", "example": "Some Guy" }, "email": { "type": "string", "description": "User's Email", "example": "someguy@somemail.com" }, "password": { "maxLength": 2147483647, "minLength": 8, "type": "string", "description": "User's password", "example": "cvjd984" }, "organizationName": { "type": "string", "description": "Human readable name of the organization", "example": "Helvia" }, "loginToken": { "type": "string", "description": "Service login token", "example": "GoogleIdToken" }, "loginType": { "type": "string", "description": "Login type used", "example": "CONSOLE", "enum": [ "CONSOLE", "GOOGLE", "MICROSOFT", "MSTEAMS" ] } } }, "UserInvitationAcceptanceDto": { "required": [ "userInvitationToken" ], "type": "object", "properties": { "userInvitationToken": { "type": "string", "description": "The token generated by the API" }, "password": { "maxLength": 2147483647, "minLength": 8, "type": "string", "description": "User's password", "example": "cvjd984" }, "fullName": { "maxLength": 120, "minLength": 1, "type": "string", "description": "User's Full Name", "example": "Some Guy" }, "loginToken": { "type": "string", "description": "Service login token", "example": "GoogleIdToken" }, "loginType": { "type": "string", "description": "Login type used", "example": "CONSOLE", "enum": [ "CONSOLE", "GOOGLE", "MICROSOFT", "MSTEAMS" ] } } }, "SdsUploadedFileArticlesResultsDto": { "required": [ "progress", "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "Status of the remote job. This does not reflect the domain job status.", "example": "NEW, PENDING, PROCESSING, COMPLETED, CANCELLED, FAILED" }, "progress": { "type": "integer", "description": "Progress indicator. This will also define the domain job progress", "format": "int32" }, "segments": { "type": "array", "description": "The segments (articles) of the uploaded file", "items": { "$ref": "#/components/schemas/UploadedFileArticleSegmentDto" } } } }, "UploadedFileArticleSegmentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The external article ID", "example": "2" }, "pagenr": { "type": "integer", "description": "The file page number that the article was extracted from", "format": "int32", "example": 1 }, "topic": { "type": "string", "description": "The topic of Article", "example": "Foo" }, "title": { "type": "string", "description": "The title of Article", "example": "This is a title" }, "body": { "type": "string", "description": "The content of Article", "example": "Foo bar baz" }, "group": { "type": "string", "description": "The group of Article", "example": "Group 1" }, "tags": { "type": "array", "description": "The tags of Article", "example": "['Foo', 'Bar']", "items": { "type": "string", "description": "The tags of Article", "example": "['Foo', 'Bar']" } }, "lang": { "type": "string", "description": "The language of Article", "example": "en" }, "ordinal": { "type": "integer", "description": "The ordinal number of the article", "format": "int32", "example": 1 }, "created": { "type": "string", "description": "The time the Article was created.", "example": "2020-07-08T17:13:03" }, "updated": { "type": "string", "description": "The last time the Article has been modified.", "example": "2020-07-08T17:13:03" } }, "description": "The segments (articles) of the uploaded file" }, "ForgotPasswordSubmitDto": { "required": [ "password", "token" ], "type": "object", "properties": { "password": { "maxLength": 2147483647, "minLength": 8, "type": "string", "description": "User's password", "writeOnly": true, "example": "cvjd984" }, "token": { "type": "string", "description": "The token generated by the API", "writeOnly": true } } }, "ForgotPasswordRequestDto": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "User's Email", "writeOnly": true, "example": "someguy@somemail.com" } } }, "UserInvitationDto": { "required": [ "email" ], "type": "object", "properties": { "id": { "type": "string", "description": "The invitation ID", "example": "13513594520" }, "email": { "type": "string", "description": "User's Email", "example": "someguy@somemail.com" }, "organizationId": { "type": "string", "description": "The Organization Id of the invitation", "example": "fff43491959195" }, "tenantRoles": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "User roles table for the organization's tenants.", "items": { "type": "string", "description": "User roles table for the organization's tenants.", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } }, "description": "User roles table for the organization's tenants." }, "description": "User roles table for the organization's tenants." }, "organizationRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "User roles table for the organization.", "items": { "type": "string", "description": "User roles table for the organization.", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] } }, "description": "User roles table for the organization." }, "groupId": { "type": "string", "description": "Groups to join upon invitation" }, "groupIds": { "uniqueItems": true, "type": "array", "description": "Groups to join upon invitation", "items": { "type": "string", "description": "Groups to join upon invitation" } }, "status": { "type": "string", "description": "Status of the invitation", "enum": [ "ACCEPTED", "PENDING", "EXPIRED", "REVOKED" ] }, "expirationDate": { "type": "string", "description": "Expiration Date of user invitation", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/EditorDto" }, "createdAt": { "type": "string", "description": "Date of invitation creation", "format": "date-time" }, "updatedAt": { "type": "string", "description": "Date of invitation last update", "format": "date-time" } } }, "TranslationQuery": { "required": [ "messages" ], "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string" } }, "targetLanguage": { "type": "string" }, "sourceLanguage": { "type": "string" } } }, "Translation": { "required": [ "result" ], "type": "object", "properties": { "result": { "type": "array", "items": { "type": "string" } }, "targetLanguage": { "type": "string" } } }, "TemplateTenantDto": { "required": [ "displayName" ], "type": "object", "properties": { "displayName": { "maxLength": 240, "minLength": 1, "type": "string", "description": "Name of the new Tenant", "example": "NewTenantFromTemplate" }, "primaryLanguage": { "type": "string", "description": "Primary language of the new Tenant", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "description": { "maxLength": 400, "minLength": 1, "type": "string", "description": "Tenant's description", "example": "Lorem ipsum dolor.." }, "image": { "maxLength": 400, "minLength": 1, "type": "string", "description": "Tenant's Image URL" } } }, "TestSetCaseDto": { "required": [ "input", "intent" ], "type": "object", "properties": { "input": { "type": "string", "description": "The user input to test.", "example": "hi" }, "intent": { "type": "string", "description": "The expected intent to hit.", "example": "Greetings" } }, "description": "Test set's cases to test" }, "TestSetDto": { "required": [ "cases", "language", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Test set's ID", "example": "1213991249013" }, "name": { "type": "string", "description": "Test set's name", "example": "Test 1" }, "description": { "type": "string", "description": "Test set's description", "example": "Test a language" }, "language": { "type": "string", "description": "Test set's language", "example": "en", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "cases": { "type": "array", "description": "Test set's cases to test", "items": { "$ref": "#/components/schemas/TestSetCaseDto" } }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "createdAt": { "type": "string", "description": "The time the Test set was created.", "format": "date-time", "readOnly": true, "example": "2020-07-08T17:13:03.157828+02:00" }, "updatedAt": { "type": "string", "description": "The last time the Test set was modified.", "format": "date-time", "readOnly": true, "example": "2020-07-08T17:13:03.157828+02:00" }, "createdBy": { "$ref": "#/components/schemas/EditorDto" }, "lastChangedBy": { "$ref": "#/components/schemas/EditorDto" } } }, "TestSetRunClassificationReportDto": { "type": "object", "properties": { "intentId": { "type": "string" }, "precision": { "type": "number", "format": "double" }, "recall": { "type": "number", "format": "double" }, "f1Score": { "type": "number", "format": "double" }, "support": { "type": "integer", "format": "int32" } } }, "TestSetRunConfusionMatrixRowDto": { "type": "object", "properties": { "rowKey": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } }, "TestSetRunExtendedDto": { "required": [ "nlpPipelines", "results" ], "type": "object", "properties": { "nlpPipelines": { "type": "array", "description": "The NLP Pipelines to run the Test set against", "items": { "type": "string", "description": "The NLP Pipelines to run the Test set against" } }, "results": { "type": "array", "description": "The results of the Test Set run", "items": { "$ref": "#/components/schemas/TestSetRunResultDto" } }, "id": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/EditorDto" } } }, "TestSetRunMessageResultDto": { "type": "object", "properties": { "input": { "type": "string" }, "expectedIntentId": { "type": "string" }, "detectedIntentId": { "type": "string" }, "detectedIntentScore": { "type": "number", "format": "double" } } }, "TestSetRunResultDto": { "required": [ "nlpPipelineId" ], "type": "object", "properties": { "nlpPipelineId": { "type": "string" }, "messageResults": { "type": "array", "items": { "$ref": "#/components/schemas/TestSetRunMessageResultDto" } }, "classificationReport": { "type": "array", "items": { "$ref": "#/components/schemas/TestSetRunClassificationReportDto" } }, "confusionMatrix": { "type": "array", "items": { "$ref": "#/components/schemas/TestSetRunConfusionMatrixRowDto" } }, "macroAvgPrecision": { "type": "number", "format": "double" }, "macroAvgRecall": { "type": "number", "format": "double" }, "macroAvgF1Score": { "type": "number", "format": "double" }, "accuracy": { "type": "number", "format": "double" } }, "description": "The results of the Test Set run" }, "StaticVariableDto": { "required": [ "isConstant", "name", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "isConstant": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "updatedAt": { "type": "integer", "format": "int64", "readOnly": true }, "tenantId": { "type": "string" } } }, "NLPPipelineTreeDataDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Pipeline Decision Tree ID", "example": "1234567890" }, "name": { "type": "string", "description": "Pipeline Decision Tree Name", "example": "Decision Tree 1" }, "language": { "type": "string", "description": "Pipeline Decision Tree Language", "example": "en" }, "nodes": { "type": "array", "description": "Pipeline Decision Tree Nodes", "items": { "$ref": "#/components/schemas/NLPTreeNode" } }, "edges": { "type": "array", "description": "Pipeline Decision Tree Edges", "items": { "$ref": "#/components/schemas/NLPTreeEdge" } }, "nlpDecisionTree": { "type": "object", "additionalProperties": { "type": "object", "description": "The decision tree executed at runtime" }, "description": "The decision tree executed at runtime" }, "createdAt": { "type": "string", "description": "Pipeline Decision Tree Created At", "format": "date-time", "example": "2021-01-01T00:00:00Z" }, "updatedAt": { "type": "string", "description": "Pipeline Decision Tree Updated At", "format": "date-time", "example": "2021-01-01T00:00:00Z" } } }, "NLPTreeEdge": { "required": [ "id", "label", "source", "target" ], "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string" }, "target": { "type": "string" }, "label": { "type": "string" }, "sourcePositionId": { "type": "string" } }, "description": "Pipeline Decision Tree Edges" }, "NLPTreeNode": { "required": [ "height", "id", "label", "position", "type", "width" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "intro", "pipeline", "sequence", "query" ] }, "label": { "type": "object", "additionalProperties": { "type": "string" } }, "pipelineId": { "type": "string" }, "query": { "type": "string" }, "position": { "$ref": "#/components/schemas/FlowGraphPosition" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" } }, "description": "Pipeline Decision Tree Nodes" }, "Corpus": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" }, "confidence": { "type": "number", "format": "double" } } }, "MissedQuestionCreateDto": { "required": [ "missedQuestion" ], "type": "object", "properties": { "missedQuestion": { "$ref": "#/components/schemas/MissedQuestionDto" }, "sessionId": { "type": "string", "description": "The id of the session." }, "messageId": { "type": "string", "description": "The id of the message." }, "nlpPipelineId": { "type": "string", "description": "The id of the NLP Pipeline." }, "examinedCorpus": { "type": "array", "description": "The corpus items examined during processing.", "items": { "$ref": "#/components/schemas/Corpus" } } } }, "MissedQuestionDto": { "required": [ "question", "tenantId" ], "type": "object", "properties": { "id": { "type": "string", "description": "The Missed Question id.", "readOnly": true }, "tenantId": { "type": "string", "description": "The tenant id this Missed Question originated from." }, "question": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The normalized text of the Missed question." }, "status": { "type": "string", "description": "The status of the Missed Question.", "enum": [ "RESOLVED", "UNRESOLVED", "IGNORED" ] }, "language": { "type": "string", "description": "The language of the Missed Question." }, "occurrences": { "type": "integer", "description": "The number of times this Missed Question has appeared in total.", "format": "int32", "readOnly": true }, "filteredOccurrences": { "type": "integer", "description": "The number of times this Missed Question has appeared during the selected period.", "format": "int32", "readOnly": true }, "createdAt": { "type": "string", "description": "The date the Missed Question was created.", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "description": "The date the Missed Question was updated.", "format": "date-time", "readOnly": true } } }, "BotContent": { "required": [ "activities", "allStaticVariables" ], "type": "object", "properties": { "id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } }, "mainActivity": { "type": "string" }, "staticVariables": { "type": "array", "items": { "$ref": "#/components/schemas/StaticVariable" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "activitiesList": { "type": "array", "writeOnly": true, "items": { "$ref": "#/components/schemas/Activity" } }, "allStaticVariables": { "type": "array", "items": { "$ref": "#/components/schemas/StaticVariable" } }, "staticVariablesList": { "type": "array", "writeOnly": true, "items": { "$ref": "#/components/schemas/StaticVariable" } } } }, "BotContentCompiled": { "required": [ "activities", "customActivities" ], "type": "object", "properties": { "id": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityCompiled" } }, "customActivities": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityCompiled" } }, "metadata": { "$ref": "#/components/schemas/BotContentCompilationMetadata" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "activitiesList": { "type": "array", "writeOnly": true, "items": { "$ref": "#/components/schemas/ActivityCompiled" } } } }, "DBRef": { "type": "object", "properties": { "id": { "type": "object" }, "collectionName": { "type": "string" }, "databaseName": { "type": "string" } } }, "MissedQuestion": { "required": [ "occurrences" ], "type": "object", "properties": { "id": { "type": "string" }, "question": { "type": "string" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "organizationId": { "type": "string" }, "status": { "type": "string", "enum": [ "RESOLVED", "UNRESOLVED", "IGNORED" ] }, "occurrences": { "type": "integer", "format": "int32" }, "language": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "NLPPipelineTreeData": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "nlpDecisionTree": { "type": "object", "additionalProperties": { "type": "object" } }, "nlpDecisionTreeSource": { "$ref": "#/components/schemas/PipelineDecisionTreeSource" }, "variables": { "type": "array", "items": { "type": "string" } }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "PipelineDecisionTreeSource": { "required": [ "edges", "nodes" ], "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/NLPTreeNode" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/NLPTreeEdge" } } } }, "StaticVariable": { "required": [ "createdAt", "isConstant", "name", "updatedAt", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "isConstant": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "Tenant": { "required": [ "powerups", "settings", "supportedPluginCategories", "systemSettings", "tags" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "settings": { "$ref": "#/components/schemas/TenantSettings" }, "systemSettings": { "$ref": "#/components/schemas/TenantSystemSettings" }, "image": { "type": "string" }, "timezone": { "type": "string" }, "story": { "$ref": "#/components/schemas/DBRef" }, "content": { "$ref": "#/components/schemas/BotContent" }, "contentCompiled": { "$ref": "#/components/schemas/BotContentCompiled" }, "organization": { "$ref": "#/components/schemas/Organization" }, "tenantStats": { "$ref": "#/components/schemas/TenantStats" }, "nluSync": { "type": "boolean" }, "nluCachingEnabled": { "type": "boolean" }, "nlpMap": { "type": "object", "additionalProperties": { "type": "string" } }, "nlpTrees": { "type": "array", "items": { "$ref": "#/components/schemas/NLPPipelineTreeData" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "type": "object", "additionalProperties": { "type": "string" } }, "dataRetentionPeriod": { "type": "integer", "format": "int32" }, "tags": { "type": "array", "items": { "type": "string" } }, "powerups": { "type": "array", "items": { "type": "string", "enum": [ "HRWIZ", "FAQS", "BROADCASTS", "FLOWS", "LIVECHAT", "SURVEYS", "INTERVIEWS", "CHAT_SESSIONS", "SENTIMENT_ANALYSIS", "ANALYTICS", "SETTINGS", "BACKUPS", "INTEGRATIONS", "BILLING", "MONITORING", "NLU_CACHING", "CONNECTORS" ] } }, "componentTree": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object" } }, "disabled": { "type": "boolean", "description": "When this is set to `true`, the bot (tenant) is considered disabled." }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } }, "pluginSettings": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PluginSettings" } }, "sourceTemplateId": { "type": "string" }, "space": { "type": "string", "enum": [ "bot-lab", "cx", "ex" ] }, "plugins": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationPlugin" } }, "supportedPluginCategories": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "AUTHENTICATION", "CRM", "KB", "LIVECHAT", "LLM_NODE", "LLM_TOPIC_MODELLING", "LLM_SUMMARIZATION", "LLM_SEMANTIC_SEARCH_NODE", "LLM_AUTOMATED_AGENT_TESTING", "LLM_LANGUAGE_DETECTION", "TICKETING" ] } } } }, "TenantSettings": { "required": [ "languages" ], "type": "object", "properties": { "autoTrain": { "type": "boolean" }, "session": { "$ref": "#/components/schemas/SessionSettings" }, "monitoring": { "$ref": "#/components/schemas/MonitoringSettings" }, "externalAnalytics": { "$ref": "#/components/schemas/ExternalAnalytics" }, "privacy": { "$ref": "#/components/schemas/PrivacySettings" }, "languages": { "$ref": "#/components/schemas/LanguageSettings" }, "feedback": { "$ref": "#/components/schemas/FeedbackSettings" }, "nluLocal": { "$ref": "#/components/schemas/LocalNluSettings" }, "nlp": { "$ref": "#/components/schemas/NLPSettings" } } }, "TenantStats": { "required": [ "tenant" ], "type": "object", "properties": { "id": { "type": "string" }, "tenant": { "$ref": "#/components/schemas/Tenant" }, "lastStatsUpdate": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object" } } } }, "TenantSystemSettings": { "type": "object", "properties": { "convManager": { "$ref": "#/components/schemas/ConversationManagerSettings" }, "languageDetection": { "$ref": "#/components/schemas/LanguageDetectionSettings" }, "nlg": { "$ref": "#/components/schemas/NlgSettings" }, "liveChat": { "$ref": "#/components/schemas/LiveChatSystemSettings" }, "microsoftDataverse": { "type": "object", "additionalProperties": { "type": "object" } }, "microsoftSharepoint": { "type": "object", "additionalProperties": { "type": "object" } }, "dialogFlowDirect": { "$ref": "#/components/schemas/DialogFlowDirectSettings" }, "maxNumOfUserMessages": { "type": "integer", "format": "int32" }, "maxNumOfSessions": { "type": "integer", "format": "int32" }, "nlpService": { "type": "string", "enum": [ "HBF_NLP", "HBF_CORE" ] }, "useAutomatedAnswerTags": { "type": "boolean" }, "readOnly": { "type": "boolean", "description": "Read Only tenant cannot compile or edit the story. The can only use it." }, "isAgent": { "type": "boolean" }, "nlpServiceUrl": { "type": "string" }, "nlpPipelineId": { "type": "string" }, "nlpAccessToken": { "type": "string" } } }, "ReplaceContentResponseDto": { "required": [ "missing_languages", "unsupported_languages" ], "type": "object", "properties": { "unsupported_languages": { "type": "array", "description": "Languages that exist in the source bot but are not supported by the target bot and therefore were omitted from the imported content", "example": [ "hu", "hr", "da", "no", "el" ], "items": { "type": "string", "description": "Languages that exist in the source bot but are not supported by the target bot and therefore were omitted from the imported content", "example": "[\"hu\",\"hr\",\"da\",\"no\",\"el\"]" } }, "missing_languages": { "type": "array", "description": "Languages that are supported by the target bot but were not found in the source content.", "example": [ "uk" ], "items": { "type": "string", "description": "Languages that are supported by the target bot but were not found in the source content.", "example": "[\"uk\"]" } } }, "description": "Response payload returned after replacing a Tenant's content with that of another Tenant" }, "BotDeploymentCloneDto": { "required": [ "tenantId" ], "type": "object", "properties": { "tenantId": { "type": "string", "description": "Bot Deployments connected Tenant" }, "displayName": { "type": "string", "description": "Bot Deployments display name" }, "settings": { "$ref": "#/components/schemas/BotDeploymentIntegrationSettings" } } }, "RestoreWarningDto": { "required": [ "botDeploymentId", "message", "orgId", "tenantId" ], "type": "object", "properties": { "message": { "type": "string" }, "orgId": { "type": "string" }, "tenantId": { "type": "string" }, "botDeploymentId": { "type": "string" } }, "description": "Restore warnings" }, "TenantBackupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the Tenant Backup.", "example": "1" }, "createdAt": { "type": "string", "description": "The Tenant Backup creation date.", "format": "date-time" }, "description": { "type": "string", "description": "Optional description" }, "warnings": { "type": "array", "description": "Restore warnings", "items": { "$ref": "#/components/schemas/RestoreWarningDto" } } } }, "TagDto": { "required": [ "label", "scope" ], "type": "object", "properties": { "label": { "type": "string", "description": "Tag's label", "example": "123abc" }, "scope": { "type": "string", "description": "Tag's scope", "example": "tenants", "enum": [ "TENANTS", "CHAT_SESSIONS" ] }, "createdAt": { "type": "string", "description": "The time the Audit Log was created.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "createdBy": { "$ref": "#/components/schemas/EditorDto" } } }, "KnowledgeBaseDto": { "required": [ "languages", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "tenantAssociations": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TenantAssociationDto" } }, "tenantAssociationRefs": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TenantAssociationDto" } }, "description": { "type": "string" }, "image": { "type": "string" }, "type": { "type": "string", "enum": [ "INTERNAL", "INTEGRATION", "SHARED" ] }, "source": { "type": "string" }, "languages": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseLanguage" } }, "spaces": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "bot-lab", "cx", "ex" ] } }, "createdBy": { "$ref": "#/components/schemas/EditorDto" }, "integration": { "$ref": "#/components/schemas/Integration" }, "integrationId": { "type": "string" }, "status": { "type": "string", "enum": [ "IDLE", "PROCESSING" ] }, "totalArticles": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "$ref": "#/components/schemas/EditorDto" }, "version": { "type": "integer", "format": "int64" }, "forceOverwrite": { "type": "boolean" } } }, "KnowledgeBaseLanguage": { "required": [ "isPrimary", "languageCode" ], "type": "object", "properties": { "languageCode": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "isPrimary": { "type": "boolean" } } }, "TenantAssociationDto": { "required": [ "tenantId", "useGenerative" ], "type": "object", "properties": { "tenantId": { "type": "string" }, "useGenerative": { "type": "boolean" } } }, "KnowledgeBaseGroupDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "object", "additionalProperties": { "type": "string" } }, "ordinal": { "type": "integer", "format": "int32" }, "source": { "type": "string" }, "sourceType": { "type": "string" }, "sourceId": { "type": "string" } } }, "BulkResponseDto": { "required": [ "failed", "metadata", "succeeded" ], "type": "object", "properties": { "succeeded": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KnowledgeBaseFileToArticlesDto": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "classificationTags": { "type": "string" }, "tags": { "type": "string" }, "maxClassificationTags": { "type": "string" }, "groupName": { "type": "string" }, "source": { "type": "string" }, "sourceId": { "type": "string" }, "publishArticles": { "type": "boolean" } } }, "ArticleContent": { "required": [ "languageCode" ], "type": "object", "properties": { "languageCode": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "title": { "maxLength": 1024, "minLength": 0, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "body": { "type": "string" } } }, "KnowledgeBaseArticleDto": { "required": [ "content", "id" ], "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "status": { "type": "string", "enum": [ "PUBLISHED", "UNPUBLISHED" ] }, "ordinal": { "type": "integer", "format": "int32" }, "content": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ArticleContent" } }, "knowledgeBase": { "$ref": "#/components/schemas/KnowledgeBaseDto" }, "externalId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "$ref": "#/components/schemas/EditorDto" }, "version": { "type": "integer", "format": "int64" }, "forceOverwrite": { "type": "boolean" } } }, "KnowledgeBaseArticleExportDto": { "required": [ "content", "groupName", "id", "tags" ], "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "status": { "type": "string", "enum": [ "PUBLISHED", "UNPUBLISHED" ] }, "ordinal": { "type": "integer", "format": "int32" }, "content": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ArticleContent" } }, "knowledgeBase": { "$ref": "#/components/schemas/KnowledgeBaseDto" }, "externalId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "$ref": "#/components/schemas/EditorDto" }, "version": { "type": "integer", "format": "int64" }, "forceOverwrite": { "type": "boolean" }, "groupName": { "type": "object", "additionalProperties": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } } } }, "KnowledgeBaseContentDto": { "required": [ "articles" ], "type": "object", "properties": { "articles": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseArticleExportDto" } } } }, "KnowledgeBaseSharedDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "tenantAssociations": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TenantAssociationDto" } }, "tenantAssociationRefs": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TenantAssociationDto" } }, "description": { "type": "string" }, "image": { "type": "string" }, "type": { "type": "string", "enum": [ "INTERNAL", "INTEGRATION", "SHARED" ] }, "source": { "type": "string" }, "languages": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseLanguage" } }, "spaces": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "bot-lab", "cx", "ex" ] } }, "createdBy": { "$ref": "#/components/schemas/EditorDto" }, "integration": { "oneOf": [ { "$ref": "#/components/schemas/AzureAIIntegration" }, { "$ref": "#/components/schemas/CiscoLivechatIntegration" }, { "$ref": "#/components/schemas/GeminiAIIntegration" }, { "$ref": "#/components/schemas/GenesysLivechatIntegration" }, { "$ref": "#/components/schemas/GoogleTranslationIntegration" }, { "$ref": "#/components/schemas/HelviaLivechatIntegration" }, { "$ref": "#/components/schemas/MicrosoftDynamicsCrmIntegration" }, { "$ref": "#/components/schemas/MicrosoftDynamicsKbIntegration" }, { "$ref": "#/components/schemas/OIDCIntegration" }, { "$ref": "#/components/schemas/OpenAIIntegration" }, { "$ref": "#/components/schemas/ZendeskLivechatIntegration" }, { "$ref": "#/components/schemas/ZendeskTicketingIntegration" } ] }, "integrationId": { "type": "string" }, "status": { "type": "string", "enum": [ "IDLE", "PROCESSING" ] }, "totalArticles": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "$ref": "#/components/schemas/EditorDto" }, "version": { "type": "integer", "format": "int64" }, "forceOverwrite": { "type": "boolean" } } }, "AutoBotTestJob": { "required": [ "log", "objectId", "progress", "status", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Job" } ] }, "Job": { "required": [ "log", "objectId", "progress", "status", "type" ], "type": "object", "properties": { "description": { "type": "string" }, "objectId": { "type": "string" }, "type": { "type": "string", "enum": [ "SDS", "KB_GROUP", "AUTO_BOT_TEST" ] }, "id": { "type": "string" }, "userId": { "type": "string" }, "status": { "type": "string", "readOnly": true, "enum": [ "STARTING", "RUNNING", "STOPPED", "COMPLETED", "FAILED" ] }, "progress": { "type": "integer", "format": "int32", "readOnly": true }, "organizationId": { "type": "string" }, "externalId": { "type": "string" }, "log": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "finishedOn": { "type": "string", "format": "date-time" }, "lastProcess": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "discriminator": { "propertyName": "type" } }, "KbGroupJob": { "required": [ "log", "objectId", "progress", "status", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Job" }, { "type": "object", "properties": { "knowledgeBaseId": { "type": "string" }, "deleteArticles": { "type": "boolean" } } } ] }, "SdsJob": { "required": [ "log", "objectId", "progress", "status", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Job" }, { "type": "object", "properties": { "contentType": { "type": "string" }, "filename": { "type": "string" }, "tags": { "type": "string" }, "groupName": { "type": "string" }, "source": { "type": "string" }, "sourceId": { "type": "string" }, "groupId": { "type": "string" }, "publishArticles": { "type": "boolean" } } } ] }, "CSATSectionDto": { "required": [ "title" ], "type": "object", "properties": { "id": { "type": "string", "description": "CSAT Section's ID", "example": "1213991249013" }, "title": { "maxLength": 240, "minLength": 1, "type": "string", "description": "CSAT Section's title", "example": "123abc" }, "status": { "type": "string", "description": "CSAT Section's status", "example": "ACTIVE", "enum": [ "ACTIVE", "DELETED" ] } } }, "AutomatedDialogTest": { "required": [ "evaluation", "examinedTenantId", "flowEntryPoint", "languageCode", "name", "numOfTrials", "profile", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutomatedTest" }, { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "QA_TEST", "DIALOG_TEST" ] }, "languageCode": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "examinedTenantId": { "type": "string" }, "flowEntryPoint": { "type": "string" }, "numOfTrials": { "type": "integer", "format": "int32" }, "environment": { "type": "string" }, "profile": { "$ref": "#/components/schemas/Profile" }, "evaluation": { "$ref": "#/components/schemas/Evaluation" } } } ] }, "AutomatedQaTest": { "required": [ "examinedTenantId", "flowEntryPoint", "languageCode", "name", "numOfTrials", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AutomatedTest" }, { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "QA_TEST", "DIALOG_TEST" ] }, "languageCode": { "type": "string", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "examinedTenantId": { "type": "string" }, "flowEntryPoint": { "type": "string" }, "numOfTrials": { "type": "integer", "format": "int32" }, "environment": { "type": "string" } } } ] }, "AutomatedTest": { "required": [ "examinedTenantId", "flowEntryPoint", "languageCode", "name", "numOfTrials", "type" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the test", "example": "Automated Test Run" }, "description": { "type": "string", "description": "Description of the test", "example": "Tests a conversation for Viva customer and assistant" }, "type": { "type": "string", "description": "Test Type", "example": "DIALOG_TEST or QA_TEST", "enum": [ "QA_TEST", "DIALOG_TEST" ] }, "languageCode": { "type": "string", "description": "Language Code", "example": "en", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "examinedTenantId": { "type": "string", "description": "The agent id to examine" }, "flowEntryPoint": { "type": "string", "description": "Flow staring node id" }, "numOfTrials": { "type": "integer", "description": "Times to run the test", "format": "int32", "example": 5 }, "environment": { "type": "string", "description": "[DEV] environment to run the test", "writeOnly": true, "example": "development, staging, production or direct link to bot" }, "resultSessions": { "type": "array", "items": { "$ref": "#/components/schemas/ResultSession" } }, "lastResultSuccessRate": { "type": "number", "format": "double" }, "tags": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "testRunDate": { "type": "string", "format": "date-time" }, "organizationId": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "Constraints": { "required": [ "maxNumMessages", "messageLookback" ], "type": "object", "properties": { "maxNumMessages": { "type": "integer", "format": "int32" }, "messageLookback": { "type": "integer", "format": "int32" } } }, "Evaluation": { "required": [ "model", "system" ], "type": "object", "properties": { "model": { "$ref": "#/components/schemas/Model" }, "system": { "type": "string" } } }, "Model": { "required": [ "name", "provider" ], "type": "object", "properties": { "name": { "type": "string" }, "provider": { "type": "string" } } }, "Profile": { "required": [ "model", "system" ], "type": "object", "properties": { "model": { "$ref": "#/components/schemas/Model" }, "system": { "type": "string" }, "constraints": { "$ref": "#/components/schemas/Constraints" } } }, "Result": { "type": "object", "properties": { "resultId": { "type": "string" }, "passed": { "type": "boolean" }, "reason": { "type": "string" } } }, "ResultDetails": { "type": "object", "properties": { "testName": { "type": "string" }, "testDescription": { "type": "string" }, "flowName": { "type": "string" }, "languageCode": { "type": "string" }, "examinedTenantName": { "type": "string" }, "examinedTenantId": { "type": "string" } } }, "ResultSession": { "required": [ "results" ], "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Result" } }, "successRate": { "type": "number", "format": "double" }, "date": { "type": "string", "format": "date-time" }, "resultDetails": { "$ref": "#/components/schemas/ResultDetails" } } }, "AutoBotTestCloneDto": { "required": [ "examinedTenantId", "flowEntryPoint", "languageCode", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the automated test" }, "description": { "type": "string", "description": "The description of the automated test" }, "examinedTenantId": { "type": "string", "description": "The id of the agent that will be used in the automated test" }, "languageCode": { "type": "string", "description": "The code of the language that will be used in the automated test", "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] }, "numOfTrials": { "type": "integer", "description": "The number of times the test will be performed", "format": "int32" }, "flowEntryPoint": { "type": "string", "description": "The flow starting node id of the flow that will be used in the automated test" } } }, "ApiTokenDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Api Token ID", "readOnly": true, "example": "4923058358329" }, "description": { "type": "string", "description": "A short description of the Api Token", "example": "Will be used on Foo service" }, "token": { "type": "string", "description": "The JWT of the Api Token", "readOnly": true, "example": "XXX.YYY.ZZZ" }, "role": { "type": "string", "description": "The role assigned to the Api Token", "enum": [ "HBF_ORG_ADMIN", "HBF_ORG_EDITOR", "HBF_ORG_VIEWER", "HBF_ORG_LIVE_AGENT", "HRWIZ_EMPLOYEE", "HBF_ORG_LIVECHAT_ADMIN" ] }, "isModerator": { "type": "boolean", "description": "Whether the Api Token has moderator privileges", "readOnly": true, "example": true }, "issuedBy": { "type": "string", "description": "The email address of the user that created the api token.", "readOnly": true }, "createdAt": { "type": "string", "description": "The time the Api Token was created.", "format": "date-time", "readOnly": true, "example": "2020-07-08T17:13:03.157828+02:00" }, "updatedAt": { "type": "string", "description": "The time the Api Token was last updated.", "format": "date-time", "readOnly": true, "example": "2020-07-08T17:13:03.157828+02:00" }, "lastUsed": { "type": "string", "description": "The time the Api Token was last used", "format": "date-time", "readOnly": true, "example": "2020-07-08T17:13:03.157828+02:00" }, "tenantRoles": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "Token tenant roles table", "items": { "type": "string", "description": "Token tenant roles table", "enum": [ "HBF_TENANT_ADMIN", "HBF_TENANT_EDITOR", "HBF_TENANT_VIEWER", "HBF_TENANT_LIVECHAT_ADMIN" ] } }, "description": "Token tenant roles table" } } }, "SpellCheckDto": { "required": [ "enabledCategories", "enabledOnly", "language", "text" ], "type": "object", "properties": { "text": { "type": "string" }, "language": { "type": "string" }, "enabledCategories": { "type": "array", "items": { "type": "string" } }, "enabledOnly": { "type": "boolean" } } }, "Category": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "Context": { "type": "object", "properties": { "text": { "type": "string" }, "offset": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32" } } }, "DetectedLanguage": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "confidence": { "type": "number", "format": "double" }, "source": { "type": "string" } } }, "DetectedLanguageRate": { "type": "object", "properties": { "language": { "type": "string" }, "rate": { "type": "number", "format": "double" } } }, "ExtendedSentenceRange": { "type": "object", "properties": { "from": { "type": "integer", "format": "int32" }, "to": { "type": "integer", "format": "int32" }, "detectedLanguages": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedLanguageRate" } } } }, "Language": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "detectedLanguage": { "$ref": "#/components/schemas/DetectedLanguage" } } }, "LanguageToolSpellCheckResponse": { "type": "object", "properties": { "software": { "$ref": "#/components/schemas/Software" }, "warnings": { "$ref": "#/components/schemas/Warnings" }, "language": { "$ref": "#/components/schemas/Language" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/Match" } }, "sentenceRanges": { "type": "array", "items": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "extendedSentenceRanges": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedSentenceRange" } } } }, "Match": { "type": "object", "properties": { "message": { "type": "string" }, "shortMessage": { "type": "string" }, "replacements": { "type": "array", "items": { "$ref": "#/components/schemas/Replacement" } }, "offset": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32" }, "context": { "$ref": "#/components/schemas/Context" }, "sentence": { "type": "string" }, "type": { "$ref": "#/components/schemas/MatchType" }, "rule": { "$ref": "#/components/schemas/Rule" }, "ignoreForIncompleteSentence": { "type": "boolean" }, "contextForSureMatch": { "type": "integer", "format": "int32" } } }, "MatchType": { "type": "object", "properties": { "typeName": { "type": "string" } } }, "Replacement": { "type": "object", "properties": { "value": { "type": "string" }, "shortDescription": { "type": "string" }, "confidence": { "type": "number", "format": "double" } } }, "Rule": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "issueType": { "type": "string" }, "category": { "$ref": "#/components/schemas/Category" } } }, "Software": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "buildDate": { "type": "string" }, "apiVersion": { "type": "integer", "format": "int32" }, "premium": { "type": "boolean" }, "premiumHint": { "type": "string" }, "status": { "type": "string" } } }, "Warnings": { "type": "object", "properties": { "incompleteResults": { "type": "boolean" } } }, "AuditLogDto": { "required": [ "description" ], "type": "object", "properties": { "createdAt": { "type": "string", "description": "The time the Audit Log was created.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "createdBy": { "$ref": "#/components/schemas/EditorDto" }, "objectId": { "type": "string", "description": "The id of the object that the audit log is for", "readOnly": true, "example": "123abc" }, "collection": { "type": "string", "description": "The collection table of the object that the audit log is for", "readOnly": true, "example": "tenants" }, "description": { "type": "string", "description": "A short description of the action happened", "example": "User foo@bar.baz updated bot FooBar" }, "details": { "type": "string", "description": "A detailed description of the changes happened, from the framework javers" }, "category": { "type": "string", "description": "The category of the audit log", "enum": [ "ACCESS_CONTROL", "CONTENT", "BOT_SETTINGS", "BOT_DEPLOYMENTS", "ORG_SETTINGS", "ORG_MANAGEMENT" ] } } }, "CredentialsAuthenticationRequestDto": { "required": [ "email", "password", "variables" ], "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" } } }, "TeamsAuthenticationRequestDto": { "required": [ "token", "variables" ], "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string" }, "token": { "type": "string" } } }, "AuthenticationResponseDto": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" }, "refreshToken": { "type": "string" }, "user": { "$ref": "#/components/schemas/UserDto" } } }, "MicrosoftAuthenticationRequestDto": { "required": [ "accessToken", "variables" ], "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string" }, "accessToken": { "type": "string" } } }, "IntegrationAuthenticationRequestDto": { "required": [ "integrationId", "organizationId", "variables" ], "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string" }, "integrationId": { "type": "string" } } }, "OIDCAuthenticationRequestDto": { "required": [ "code", "integrationId", "organizationId", "redirectUri", "variables" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IntegrationAuthenticationRequestDto" }, { "type": "object", "properties": { "code": { "type": "string" }, "redirectUri": { "type": "string" }, "codeVerifier": { "type": "string" }, "nonce": { "type": "string" } } } ] }, "GoogleAuthenticationRequestDto": { "required": [ "idToken", "variables" ], "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string" }, "idToken": { "type": "string" } } }, "HandoverLinkDto": { "required": [ "sourceHandle", "sourceMetadata", "sourceSubscriberHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "Handover Link ID", "example": "4923052358329" }, "sourceHandle": { "type": "string", "description": "The handle of the Tenant initiating the handover", "example": "some_tenant" }, "targetHandle": { "type": "string", "description": "The handle of the Tenant answering the handover", "example": "some_other_teant" }, "sourceSubscriberHandle": { "type": "string", "description": "The handle of the Subscriber initiating the handover", "example": "some_subscriber" }, "targetSubscriberHandle": { "type": "string", "description": "The handle of the Subscriber answering the handover", "example": "some_other_subscriber" }, "sourceMetadata": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object", "description": "Useful information used to send a message to source Tenant" }, "description": "Useful information used to send a message to source Tenant" }, "targetMetadata": { "type": "object", "properties": { "partialObject": { "type": "boolean" }, "empty": { "type": "boolean" } }, "additionalProperties": { "type": "object", "description": "Useful information used to send a message to target Tenant" }, "description": "Useful information used to send a message to target Tenant" }, "status": { "type": "string", "description": "The current Handover's Status", "enum": [ "PENDING", "ACTIVE", "COMPLETED", "DECLINED", "MISSED" ] }, "createdAt": { "type": "string", "description": "The Handover Request creation date.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "updatedAt": { "type": "string", "description": "The last time the Handover has been modified.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" } } }, "FbHandoverDto": { "required": [ "status", "subscriberHandle" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the FbHandover", "example": "4923052358329" }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "subscriberHandle": { "type": "string", "description": "The handle of the Subscriber associated with the FbHandover", "example": "some_subscriber" }, "status": { "type": "string", "description": "The current FbHandover's Status", "enum": [ "ACTIVE", "INACTIVE" ] }, "updatedAt": { "type": "string", "description": "The last time the FbHandover has been modified.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" } } }, "ChatSessionMessageDto": { "required": [ "date", "message" ], "type": "object", "properties": { "subscriberHandle": { "type": "string", "description": "The handle of the subscriber that sent this message" }, "subscriberName": { "type": "string", "description": "The subscriber's name" }, "subscriberEmail": { "type": "string", "description": "The subscriber's email" }, "message": { "type": "string", "description": "The message that was sent" }, "tags": { "uniqueItems": true, "type": "array", "description": "The list of tags of the message sent", "items": { "type": "string", "description": "The list of tags of the message sent" } }, "intentName": { "type": "string", "description": "The intent name that was triggered when receiving this message (optional)" }, "conversationNode": { "type": "string", "description": "The name of the conversation node that got triggered" }, "type": { "type": "string", "description": "The type of this ChatSessionMessage", "enum": [ "TEXT", "POSTBACK", "ATTACHMENT", "TRIGGER" ] }, "category": { "type": "string", "description": "The category of this ChatSessionMessage", "enum": [ "FALLBACK", "FEEDBACK", "LIVE_CHAT", "BACK", "COMMON" ] }, "date": { "type": "string", "description": "The date this message was sent as a unix timestamp", "format": "date-time" }, "isUserInteraction": { "type": "boolean", "description": "Indicates if the message was send by a user" }, "liveChatEventType": { "type": "string", "description": "Type of incoming LiveChat event", "enum": [ "LIVECHAT_INITIALIZED", "LIVECHAT_REQUESTED", "LIVECHAT_REQUEST_CLOSED", "LIVECHAT_REQUEST_ACCEPTED", "LIVECHAT_REQUEST_MISSED", "LIVECHAT_TERMINATION_REQUESTED", "LIVECHAT_TERMINATED", "LIVECHAT_ABANDONED", "LIVECHAT_TRANSFERRED", "LIVECHAT_MESSAGE_EXCHANGED", "LIVECHAT_MESSAGE_TYPING", "LIVECHAT_IS_DISABLED", "LIVECHAT_REQUEST_EXISTS", "LIVECHAT_OUT_OF_BUSINESS_HOURS", "LIVECHAT_IS_IN_PROGRESS", "LIVECHAT_GENERIC_ERROR", "SOURCE_REQUEST_NEW_HANDOVER", "SOURCE_PRE_REQUEST_NEW_HANDOVER" ] }, "liveChatSender": { "type": "string", "description": "The sender of the live chat message", "enum": [ "END_USER", "AGENT" ] }, "liveChatConversationId": { "type": "string", "description": "The live chat conversation id" }, "id": { "type": "string", "description": "A unique identifier of the message, set by hbf-bot" }, "responseToId": { "type": "string", "description": "Identifier of the HBFEvent this bot response corresponds to" }, "language": { "type": "string", "description": "The language used in this message" } } }, "BotTemplateDto": { "required": [ "displayName", "tenantId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Bot Template's ID", "example": "1213991249013" }, "displayName": { "maxLength": 240, "minLength": 1, "type": "string", "description": "A human-readable name for the Bot Template", "example": "Sales Advisor Template" }, "description": { "maxLength": 400, "minLength": 1, "type": "string", "description": "Bot Template's description", "example": "Lorem ipsum dolor.." }, "image": { "maxLength": 400, "minLength": 1, "type": "string", "description": "Bot Template's Image URL" }, "useCase": { "type": "string", "description": "The use case where the Template applies", "example": "EX", "enum": [ "LIVECHAT", "SUPPORT", "FAQS", "SALES", "BOOKING", "PROMOTION", "ENGAGEMENT", "FEEDBACK", "INTERVIEWS", "ONBOARDING", "HR_MANAGEMENT", "SURVEYS" ] }, "prerequisites": { "uniqueItems": true, "type": "array", "description": "The list of plans, power-ups, add-ons required to use the template", "items": { "type": "string", "description": "The list of plans, power-ups, add-ons required to use the template" } }, "platformCompatibility": { "uniqueItems": true, "type": "array", "description": "Platforms that fully support the behavior of the template", "items": { "type": "string", "description": "Platforms that fully support the behavior of the template", "enum": [ "MICROSOFT_TEAMS", "MICROSOFT_WEB_CHAT", "VIBER", "FACEBOOK", "LIVECHAT", "SLACK", "INSTAGRAM", "UNITY", "WHATSAPP", "API" ] } }, "tenant": { "$ref": "#/components/schemas/TenantDto" }, "tenantId": { "type": "string", "description": "Bot Template's connected Tenant ID", "writeOnly": true }, "availableLanguages": { "uniqueItems": true, "type": "array", "description": "The available ready-to-use languages that can be used with the template", "readOnly": true, "items": { "type": "string", "description": "The available ready-to-use languages that can be used with the template", "readOnly": true, "enum": [ "en", "el", "es", "pt", "pt-br", "it", "fr", "de", "fi", "bg", "cs", "nl", "et", "he", "pl", "ro", "ru", "sr", "sl", "sv", "tr", "uk", "zh", "fil", "no", "hr", "hu", "da" ] } }, "blank": { "type": "boolean", "description": "Defines if bot template is the default one; used as from scratch" }, "createdAt": { "type": "string", "description": "The time the Bot Deployment was created.", "format": "date-time", "readOnly": true, "example": "2020-07-08T17:13:03.157828+02:00" }, "updatedAt": { "type": "string", "description": "The last time the Bot Deployment has been updated.", "format": "date-time", "readOnly": true, "example": "2020-07-08T17:13:03.157828+02:00" } } }, "MainActivityIdDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of main activity", "example": "13513594520" } } }, "ChatSessionBatchSetStatusCompletedDto": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "description": "List of Chat Session ids", "example": [ "531582c6-675e-4cc4-b1de-c9b943e33782", "647ea48b-a3cf-422f-85bd-575edda5fc2b" ], "items": { "type": "string", "description": "List of Chat Session ids", "example": "[\"531582c6-675e-4cc4-b1de-c9b943e33782\",\"647ea48b-a3cf-422f-85bd-575edda5fc2b\"]" } } } }, "PagedUsersResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "ListUsersResponse": { "type": "array", "properties": { "size": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" }, "first": { "$ref": "#/components/schemas/UserDto" }, "last": { "$ref": "#/components/schemas/UserDto" } }, "items": { "$ref": "#/components/schemas/UserDto" } }, "PagedUserGroupResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedTenantsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TenantDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "KeyValuePair": { "required": [ "key" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "NLPProcessDto": { "type": "object", "properties": { "query": { "type": "string" }, "queryCategory": { "type": "string", "enum": [ "MATCHED", "SMALLTALK", "GENERIC", "MISSED" ] }, "languageCode": { "type": "string" }, "detectedLanguage": { "type": "string" }, "examinedCorpus": { "type": "array", "items": { "$ref": "#/components/schemas/Corpus" } }, "matchedCorpus": { "$ref": "#/components/schemas/Corpus" }, "generatedText": { "type": "string" }, "extractedParameters": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair" } } } }, "PagedSubscribersResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "ObjectId": { "type": "object", "properties": { "timestamp": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" } } }, "PagedResponsesResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedUserInvitationsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvitationDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedOrganizationResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedTicketsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketIntegrationDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "TicketIntegrationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The remote entity id if exists" }, "associatedId": { "type": "string", "description": "The external id which is used to associate an external entity with one of our ids" }, "name": { "type": "string", "description": "The remote entity name if exists" }, "description": { "type": "string", "description": "The remote entity description if exists" }, "url": { "type": "string", "description": "The remote entity url (used to go to that entity in the external platform) if exists" }, "createdAt": { "type": "string", "description": "The remote entity date if exists", "format": "date-time" } } }, "PagedTestSetResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TestSetDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "TestSetRunDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Test set run's ID", "example": "1213991249013" }, "status": { "type": "string", "description": "The status of the Test Set run" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/EditorDto" } } }, "PagedChapterResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedStaticVariableResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/StaticVariableDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedNLPPipelineResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NLPPipeline" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "NLPPipelineTreeDataDtoPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NLPPipelineTreeDataDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "DailyStatus": { "type": "object", "properties": { "date": { "type": "string", "description": "Timestamp at the start of the day (midnight) in timezone", "format": "date-time", "example": "2020-07-08T00:00:00+02:00" }, "ratio": { "type": "number", "description": "The uptime percentage of the monitor for the day (date+24h)", "format": "float", "example": 100.0 } }, "description": "The weekly status of the monitor" }, "TenantMonitorDto": { "type": "object", "properties": { "currentStatus": { "type": "integer", "description": "The current status of the monitor", "format": "int32" }, "weeklyStatus": { "type": "array", "description": "The weekly status of the monitor", "items": { "$ref": "#/components/schemas/DailyStatus" } }, "last1dRatio": { "type": "number", "description": "The uptime percentage of the monitor for the last 1 day", "format": "float", "example": 100.0 }, "last7dRatio": { "type": "number", "description": "The uptime percentage of the monitor for the last 7 days", "format": "float", "example": 96.348 }, "last30dRatio": { "type": "number", "description": "The uptime percentage of the monitor for the last 30 days", "format": "float", "example": 95.894 }, "last90dRatio": { "type": "number", "description": "The uptime percentage of the monitor for the last 90 days", "format": "float", "example": 95.894 }, "tenant": { "$ref": "#/components/schemas/TenantDto" } } }, "PagedMissedQuestionResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MissedQuestionDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "MissedQuestionNlpMetadata": { "type": "object", "properties": { "nlpPipeline": { "type": "string" }, "examinedCorpus": { "type": "array", "items": { "$ref": "#/components/schemas/Corpus" } } } }, "MissedQuestionOccurrence": { "type": "object", "properties": { "id": { "type": "string" }, "missedQuestion": { "$ref": "#/components/schemas/MissedQuestion" }, "question": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "nlpMetadata": { "$ref": "#/components/schemas/MissedQuestionNlpMetadata" }, "sessionId": { "type": "string" }, "messageId": { "type": "string" }, "normalizedQuestion": { "type": "string" }, "tenantId": { "type": "string" }, "organizationId": { "type": "string" } } }, "PagedGroupsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "ChatSessionTranscriptDto": { "required": [ "createdAt", "id", "messages" ], "type": "object", "properties": { "id": { "type": "string", "description": "Chat session uuid", "example": "af38d502-7961-4dcf-a038-21d8ebb4f435" }, "createdAt": { "type": "string", "description": "Date of session creation (ISO 8601)", "format": "date-time" }, "messages": { "type": "array", "description": "List of messages in the chat session", "items": { "$ref": "#/components/schemas/ChatSessionTranscriptMessageDto" } } } }, "ChatSessionTranscriptMessageDto": { "required": [ "date", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The sender's name" }, "email": { "type": "string", "description": "The sender's email" }, "message": { "type": "string", "description": "The message that was exchanged" }, "date": { "type": "string", "description": "The date this message was sent as a unix timestamp", "format": "date-time" } }, "description": "List of messages in the chat session" }, "PagedBroadcastsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BroadcastDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedBotDeploymentResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BotDeploymentDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedTenantBackupsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TenantBackupDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedActivityResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "ActivitiesWithArticleDto": { "type": "object", "properties": { "activities": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityWithArticle" } } } }, "ActivityWithArticle": { "required": [ "tags" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "object", "additionalProperties": { "type": "string" } }, "group": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "DECISION_TREE", "LIVECHAT_FLOW", "AUTOMATED_ANSWERS", "INTERVIEW", "LIVECHAT_SYSTEM_MESSAGE", "USER_FEEDBACK", "KNOWLEDGE_BASE_ARTICLE", "CUSTOM", "DEFAULT_FALLBACK", "FLOW", "FAQLITE", "FAQ", "GRAPH", "FORM" ] }, "nlpTrainingDataWithArticleContent": { "$ref": "#/components/schemas/NLPTrainingDataWithArticleContent" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "NLPTrainingDataWithArticleContent": { "type": "object", "properties": { "articleId": { "type": "string" }, "supportedLanguages": { "type": "array", "items": { "type": "string" } }, "examples": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "articleContent": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ArticleContent" } } } }, "PagedKnowledgeBaseResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedKnowledgeBaseGroupResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseGroupDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedKnowledgeBaseArticleResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseArticleDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedJobResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "ListCSATSectionResponse": { "type": "array", "properties": { "size": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" }, "first": { "$ref": "#/components/schemas/CSATSectionDto" }, "last": { "$ref": "#/components/schemas/CSATSectionDto" } }, "items": { "$ref": "#/components/schemas/CSATSectionDto" } }, "PagedBotTemplatesResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BotTemplateDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "ActivityWithTenantIdDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "object", "additionalProperties": { "type": "string" } }, "group": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "DECISION_TREE", "LIVECHAT_FLOW", "AUTOMATED_ANSWERS", "INTERVIEW", "LIVECHAT_SYSTEM_MESSAGE", "USER_FEEDBACK", "KNOWLEDGE_BASE_ARTICLE", "CUSTOM", "DEFAULT_FALLBACK", "FLOW", "FAQLITE", "FAQ", "GRAPH", "FORM" ] }, "organizationId": { "type": "string" }, "tenantId": { "type": "string" } } }, "PageDtoAutomatedTest": { "type": "object", "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AutomatedDialogTest" }, { "$ref": "#/components/schemas/AutomatedQaTest" } ] } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedApiTokenResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiTokenDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "LocalTime": { "type": "object", "properties": { "hour": { "type": "integer", "format": "int32" }, "minute": { "type": "integer", "format": "int32" }, "second": { "type": "integer", "format": "int32" }, "nano": { "type": "integer", "format": "int32" } } }, "AgentFeedback": { "required": [ "agent", "feedback" ], "type": "object", "properties": { "agent": { "type": "string" }, "feedback": { "$ref": "#/components/schemas/Feedback" } } }, "AnalyticsUserFeedbackDto": { "required": [ "feedback", "liveChatAgentsFeedback", "liveChatFeedback" ], "type": "object", "properties": { "feedback": { "$ref": "#/components/schemas/Feedback" }, "liveChatFeedback": { "$ref": "#/components/schemas/Feedback" }, "liveChatAgentsFeedback": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AgentFeedback" } } } }, "Feedback": { "required": [ "negative", "positive", "positivePercentage", "total" ], "type": "object", "properties": { "positive": { "type": "integer", "description": "Positive feedbacks", "format": "int64" }, "negative": { "type": "integer", "description": "Negative feedbacks", "format": "int64" }, "total": { "type": "integer", "format": "int64" }, "positivePercentage": { "type": "number", "format": "double" } } }, "AnalyticsSummaryDto": { "required": [ "engagement", "interactions", "sessions", "users" ], "type": "object", "properties": { "engagement": { "$ref": "#/components/schemas/Engagement" }, "sessions": { "$ref": "#/components/schemas/Sessions" }, "interactions": { "$ref": "#/components/schemas/Interactions" }, "users": { "$ref": "#/components/schemas/Users" } } }, "Bucket": { "required": [ "count", "string_date" ], "type": "object", "properties": { "string_date": { "type": "string" }, "count": { "type": "integer", "format": "int64" } }, "description": "Date histogram of average live chat session duration per day" }, "Engagement": { "required": [ "engagementPercentage", "interactiveSessions", "sessions" ], "type": "object", "properties": { "sessions": { "type": "integer", "description": "Sessions", "format": "int64" }, "interactiveSessions": { "type": "integer", "description": "Sessions with user interactions", "format": "int64" }, "engagementPercentage": { "type": "number", "description": "Percentage of sessions with user interaction", "format": "double" } } }, "Interactions": { "required": [ "histogram" ], "type": "object", "properties": { "total": { "type": "integer", "description": "User interactions", "format": "int64" }, "avgPerSession": { "type": "number", "description": "Average user interactions per session", "format": "double" }, "avgPerUser": { "type": "number", "description": "Date histogram of user interactions per day", "format": "double" }, "histogram": { "uniqueItems": true, "type": "array", "description": "Date histogram of user interactions per day", "items": { "$ref": "#/components/schemas/Bucket" } } } }, "Sessions": { "required": [ "histogram", "total" ], "type": "object", "properties": { "total": { "type": "integer", "description": "Sessions", "format": "int64" }, "histogram": { "uniqueItems": true, "type": "array", "description": "Date histogram of sessions per day", "items": { "$ref": "#/components/schemas/Bucket" } }, "avgDuration": { "type": "number", "description": "Average session duration in seconds", "format": "double" }, "longestDuration": { "type": "integer", "description": "Longest session duration in seconds", "format": "int64" }, "shortestDuration": { "type": "integer", "description": "Shortest session duration in seconds", "format": "int64" } } }, "Users": { "required": [ "active", "histogram", "new", "returnRate", "returning" ], "type": "object", "properties": { "active": { "type": "integer", "description": "Active users", "format": "int64" }, "new": { "type": "integer", "description": "New users", "format": "int64" }, "histogram": { "uniqueItems": true, "type": "array", "description": "Date histogram of users per day", "items": { "$ref": "#/components/schemas/Bucket" } }, "returnRate": { "type": "number", "description": "Users return rate", "format": "double", "example": 15.151515151515152 }, "returning": { "type": "integer", "description": "Returning users", "format": "int64" } } }, "ActivityUsage": { "required": [ "count", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Activity Name" }, "count": { "type": "integer", "description": "Activity Appearances", "format": "int64" } } }, "AnalyticsMissedQuestionsDto": { "required": [ "histogram", "missedQuestions", "missedQuestionsPercentage", "totalMissedQuestions", "totalQuestions" ], "type": "object", "properties": { "totalQuestions": { "type": "integer", "description": "Total questions", "format": "int64" }, "totalMissedQuestions": { "type": "integer", "description": "Total missed questions", "format": "int64" }, "missedQuestionsPercentage": { "type": "number", "description": "Percentage of missed questions out of total questions", "format": "double" }, "histogram": { "uniqueItems": true, "type": "array", "description": "Date histogram of missed questions per day", "items": { "$ref": "#/components/schemas/Bucket" } }, "missedQuestions": { "type": "array", "description": "Missed questions", "items": { "$ref": "#/components/schemas/ActivityUsage" } } } }, "AnalyticsLiveChatDto": { "required": [ "duration", "missedChats", "responseTimes", "usage" ], "type": "object", "properties": { "usage": { "$ref": "#/components/schemas/Usage" }, "missedChats": { "$ref": "#/components/schemas/MissedChats" }, "responseTimes": { "$ref": "#/components/schemas/ResponseTimes" }, "duration": { "$ref": "#/components/schemas/Duration" } } }, "Duration": { "required": [ "avgDurationPerDay" ], "type": "object", "properties": { "avgDuration": { "type": "number", "description": "Average live chat session duration in seconds", "format": "double" }, "longestDuration": { "type": "integer", "description": "Longest live chat session duration in seconds", "format": "int64" }, "shortestDuration": { "type": "integer", "description": "Shortest live chat session duration in seconds", "format": "int64" }, "avgDurationPerDay": { "uniqueItems": true, "type": "array", "description": "Date histogram of average live chat session duration per day", "items": { "$ref": "#/components/schemas/Bucket" } } } }, "MissedChats": { "required": [ "liveChatRequests", "liveChats", "missedChatsPercentage", "missedLiveChats" ], "type": "object", "properties": { "liveChatRequests": { "type": "integer", "description": "Total LiveChat requests", "format": "int64" }, "liveChats": { "type": "integer", "description": "Total LiveChats carried out", "format": "int64" }, "missedLiveChats": { "type": "integer", "description": "Missed LiveChats", "format": "int64" }, "missedChatsPercentage": { "type": "number", "description": "Percentage of missed LiveChats", "format": "double" } } }, "ResponseTimes": { "required": [ "avgFirstResponsePerDay", "avgResponsePerDay" ], "type": "object", "properties": { "avgFirstResponse": { "type": "number", "description": "Average first agent response in seconds", "format": "double" }, "longestFirstResponse": { "type": "integer", "description": "Longest first agent response in seconds", "format": "int64" }, "shortestFirstResponse": { "type": "integer", "description": "Shortest first agent response in seconds", "format": "int64" }, "avgResponse": { "type": "number", "description": "Average agent response in seconds", "format": "double" }, "longestResponse": { "type": "integer", "description": "Longest agent response in seconds", "format": "int64" }, "shortestResponse": { "type": "integer", "description": "Shortest agent response in seconds", "format": "int64" }, "avgFirstResponsePerDay": { "uniqueItems": true, "type": "array", "description": "Date histogram of average first agent response per day", "items": { "$ref": "#/components/schemas/Bucket" } }, "avgResponsePerDay": { "uniqueItems": true, "type": "array", "description": "Date histogram of average agent response per day", "items": { "$ref": "#/components/schemas/Bucket" } } } }, "Usage": { "required": [ "containmentRate", "liveChatPercentage", "liveChats", "liveChatsPerDay" ], "type": "object", "properties": { "liveChats": { "type": "integer", "description": "Total LiveChats", "format": "int64" }, "liveChatPercentage": { "type": "number", "description": "Percentage of sessions with LiveChat", "format": "double" }, "agentMessages": { "type": "integer", "description": "Number of messages send by a live chat agent", "format": "int64" }, "endUserMessages": { "type": "integer", "description": "Number of messages send by a end user", "format": "int64" }, "liveChatsPerDay": { "uniqueItems": true, "type": "array", "description": "Date histogram of live chats per day", "items": { "$ref": "#/components/schemas/Bucket" } }, "containmentRate": { "type": "number", "description": "The percentage of interactive sessions that are successfully handled without the need for live chat.", "format": "double" } } }, "AnalyticsInterviewsDto": { "required": [ "outcome", "usage" ], "type": "object", "properties": { "usage": { "$ref": "#/components/schemas/InterviewsUsage" }, "outcome": { "$ref": "#/components/schemas/InterviewsOutcome" } } }, "InterviewsOutcome": { "required": [ "abandoned", "failed", "successful" ], "type": "object", "properties": { "successful": { "type": "integer", "description": "Successful interviews", "format": "int64" }, "failed": { "type": "integer", "description": "Failed interviews", "format": "int64" }, "abandoned": { "type": "integer", "description": "Abandoned interviews", "format": "int64" } } }, "InterviewsUsage": { "required": [ "interviewSessions", "interviewSessionsPercentage", "sessions" ], "type": "object", "properties": { "sessions": { "type": "integer", "description": "Total Sessions", "format": "int64" }, "interviewSessions": { "type": "integer", "description": "Total Sessions with interviews", "format": "int64" }, "interviewSessionsPercentage": { "type": "number", "description": "Percentage of sessions with interviews", "format": "double" } } }, "AnalyticsDecisionTreesDto": { "required": [ "usage" ], "type": "object", "properties": { "usage": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityUsage" } } } }, "AnalyticsCSATDto": { "required": [ "csatOverTimeScore", "csatOverallScore", "csatOvertimeResponses", "csatSectionsScore" ], "type": "object", "properties": { "csatOverallScore": { "$ref": "#/components/schemas/CSATOverallScore" }, "csatSectionsScore": { "type": "array", "items": { "$ref": "#/components/schemas/CSATSectionScore" } }, "csatOverTimeScore": { "type": "array", "items": { "$ref": "#/components/schemas/DailyCSATSectionsScores" } }, "csatOvertimeResponses": { "$ref": "#/components/schemas/DailyCSATResponses" } } }, "CSATOverallScore": { "required": [ "averageScore", "averageScorePCT", "count" ], "type": "object", "properties": { "averageScore": { "type": "number", "description": "Total Average Score", "format": "double" }, "averageScorePCT": { "type": "number", "description": "Percentage of Total Average Score", "format": "double" }, "count": { "type": "integer", "description": "Total CSAT Answers", "format": "int64" } } }, "CSATSectionScore": { "required": [ "averageScore", "averageScorePCT", "count", "sectionId", "sectionTitle" ], "type": "object", "properties": { "sectionId": { "type": "string", "description": "ID of the Section" }, "sectionTitle": { "type": "string", "description": "Title of the Section" }, "averageScore": { "type": "number", "description": "Section's Average Score", "format": "double" }, "averageScorePCT": { "type": "number", "description": "Percentage of Section's Average Score", "format": "double" }, "count": { "type": "integer", "description": "Section Occurrences", "format": "int64" } }, "description": "Daily CSAT Sections Answered" }, "DailyCSATResponses": { "required": [ "histogram", "totalAnswered", "totalNotAnswered", "totalPresented" ], "type": "object", "properties": { "totalAnswered": { "type": "integer", "description": "How many times the CSAT was answered", "format": "int32" }, "totalNotAnswered": { "type": "integer", "description": "How many times the CSAT was not answered", "format": "int32" }, "totalPresented": { "type": "integer", "description": "How many times the CSAT was presented", "format": "int32" }, "histogram": { "uniqueItems": true, "type": "array", "description": "Daily CSAT Sections Answered", "items": { "$ref": "#/components/schemas/DailyCsatResponse" } } } }, "DailyCSATSectionsScores": { "required": [ "averageScore", "averageScorePCT", "count", "date", "sections" ], "type": "object", "properties": { "date": { "type": "string", "description": "The date of the day" }, "averageScore": { "type": "number", "description": "Daily Average Score", "format": "double" }, "averageScorePCT": { "type": "number", "description": "Percentage of Daily Average Score", "format": "double" }, "count": { "type": "integer", "description": "Daily CSAT Answers", "format": "int64" }, "sections": { "type": "array", "description": "Daily CSAT Sections Answered", "items": { "$ref": "#/components/schemas/CSATSectionScore" } } } }, "DailyCsatResponse": { "required": [ "answered", "date", "notAnswered", "presented" ], "type": "object", "properties": { "date": { "type": "string", "description": "The date of the day" }, "answered": { "type": "integer", "description": "How many times the CSAT was answered", "format": "int32" }, "notAnswered": { "type": "integer", "description": "How many times the CSAT was presented", "format": "int32" }, "presented": { "type": "integer", "description": "Total CSAT", "format": "int32" } }, "description": "Daily CSAT Sections Answered" }, "AnalyticsAutomatedAnswersDto": { "required": [ "usage" ], "type": "object", "properties": { "usage": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityUsage" } } } }, "DateNumberGraphDto": { "type": "object", "properties": { "value": { "type": "number", "description": "The value of the graph", "format": "float", "example": 10.0 }, "date": { "type": "string", "description": "Date of the value", "example": "2021-10-05" } }, "description": "The graph data for total chat sessions" }, "MostUsedTenantStatsDto": { "type": "object", "properties": { "tenantId": { "type": "string", "description": "The Tenant ID the stats are about." }, "displayName": { "type": "string", "description": "A human-readable name for the Tenant", "example": "HRWiz" }, "image": { "type": "string", "description": "Tenant's Image URL" }, "totalUsers": { "type": "integer", "description": "Total interacted users", "format": "int32", "example": 10 }, "totalUsersTrend": { "type": "number", "description": "Total interacted users trend", "format": "float", "example": 4.0 }, "totalMessages": { "type": "integer", "description": "Total messages", "format": "int32", "example": 40 }, "totalMessagesTrend": { "type": "number", "description": "Total messages trend", "format": "float", "example": 0.5 }, "totalSessions": { "type": "integer", "description": "Total sessions", "format": "int32", "example": 40 }, "totalSessionsTrend": { "type": "number", "description": "Total sessions trend", "format": "float", "example": 0.5 } }, "description": "The top tenants of organization" }, "OrganizationTenantStatsDto": { "type": "object", "properties": { "mostUsedTenants": { "type": "array", "description": "The top tenants of organization", "items": { "$ref": "#/components/schemas/MostUsedTenantStatsDto" } }, "totalUsers": { "$ref": "#/components/schemas/TotalUsersStatsDto" }, "totalMessages": { "$ref": "#/components/schemas/TotalMessagesStatsDto" }, "period": { "$ref": "#/components/schemas/PeriodDto" }, "totalSessions": { "$ref": "#/components/schemas/TotalSessionsStatsDto" } } }, "PeriodDto": { "type": "object", "properties": { "start": { "type": "string", "description": "The start of the period.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" }, "end": { "type": "string", "description": "The end of the period.", "format": "date-time", "example": "2020-07-08T17:13:03.157828+02:00" } }, "description": "The period of stats" }, "TotalMessagesStatsDto": { "type": "object", "properties": { "totalMessages": { "type": "integer", "description": "Total messages", "format": "int32", "example": 10 }, "totalInboundMessages": { "type": "integer", "description": "Total inbound messages", "format": "int32", "example": 10 }, "totalOutboundMessages": { "type": "integer", "description": "Total outbound messages", "format": "int32", "example": 10 }, "messagesGraph": { "type": "array", "description": "The graph data for total messages", "items": { "$ref": "#/components/schemas/DateNumberGraphDto" } }, "totalMessagesTrend": { "type": "number", "description": "Total messages trend", "format": "float", "example": 1.0 } }, "description": "The total messages stats" }, "TotalSessionsStatsDto": { "type": "object", "properties": { "totalSessions": { "type": "integer", "description": "Total chat sessions", "format": "int32", "example": 10 }, "sessionsGraph": { "type": "array", "description": "The graph data for total chat sessions", "items": { "$ref": "#/components/schemas/DateNumberGraphDto" } }, "totalSessionsTrend": { "type": "number", "description": "Total sessions trend", "format": "float", "example": 1.0 } }, "description": "The total sessions stats" }, "TotalUsersStatsDto": { "type": "object", "properties": { "totalUsers": { "type": "integer", "description": "Total interacted users", "format": "int32", "example": 10 }, "totalUsersTrend": { "type": "number", "description": "Total interacted users trend", "format": "float", "example": 10.0 }, "newUsers": { "type": "integer", "description": "Total new interacted users", "format": "int32", "example": 10 }, "newUsersTrend": { "type": "number", "description": "Total new interacted users trend", "format": "float", "example": 10.0 }, "returningUsers": { "type": "integer", "description": "Total returning users", "format": "int32", "example": 10 }, "returningUsersTrend": { "type": "number", "description": "Total new interacted users trend", "format": "float", "example": 10.0 }, "totalUsersGraph": { "type": "array", "description": "The graph data for total interacted users", "items": { "$ref": "#/components/schemas/DateNumberGraphDto" } } }, "description": "The total interacted users stats" }, "ListTagResponse": { "type": "array", "properties": { "size": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" }, "first": { "$ref": "#/components/schemas/TagDto" }, "last": { "$ref": "#/components/schemas/TagDto" } }, "items": { "$ref": "#/components/schemas/TagDto" } }, "PagedMonitoringResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TenantMonitorDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedAuditLogResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PageDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedBotDeploymentsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BotDeploymentDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "PagedContentCompiledResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BotContentCompiledDto" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" } } }, "Quote": { "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string", "description": "Quote's Message" } } }, "UserOrganizationBatchDeleteDto": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "description": "List of User ids", "example": [ "615eec9b24f9b85b4993e5e6", "615eec9b24f9b85b4993e5e6" ], "items": { "type": "string", "description": "List of User ids", "example": "[\"615eec9b24f9b85b4993e5e6\",\"615eec9b24f9b85b4993e5e6\"]" } } } }, "BotDeploymentBatchDeleteDto": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "description": "List of Bot Deployment ids", "example": [ "615eec9b24f9b85b4993e5e6", "615eec9b24f9b85b4993e5e6" ], "items": { "type": "string", "description": "List of Bot Deployment ids", "example": "[\"615eec9b24f9b85b4993e5e6\",\"615eec9b24f9b85b4993e5e6\"]" } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }