@cognigy/rest-api-client 0.19.0 → 4.93.0

package/dist/esm/shared/interfaces/messageAPI/handover.js

@@ -0,0 +1,301 @@
+import { foreignSessionDataSchema, handoverSettingsSchema, queueUpdateOptionsSchema } from "../handover";
+export const createHandoverRequestDataSchema = {
+    title: "createHandoverRequestDataSchema",
+    "type": "object",
+    "required": [
+        "projectId",
+        "organisation",
+        "userId",
+        "sessionId",
+        "flowReferenceId",
+        "URLToken"
+    ],
+    "additionalProperties": false,
+    "properties": {
+        "projectId": {
+            "type": "string",
+            "format": "mongo-id",
+        },
+        "organisation": {
+            "type": "string",
+            "format": "mongo-id",
+        },
+        "userId": {
+            "type": "string"
+        },
+        "sessionId": {
+            "type": "string"
+        },
+        "flowReferenceId": {
+            "type": "string",
+            "format": "uuid"
+        },
+        "flowName": {
+            "type": ["string", "null"]
+        },
+        "profile": {
+            "type": "object"
+        },
+        // We cannot set format: endpoint-channel, since the channel can be
+        // overriden by the customer (e.g. for their website)
+        "channel": {
+            "type": "string",
+        },
+        "requestedAt": {
+            "type": "number"
+        },
+        "requestInputId": {
+            "type": "string"
+        },
+        "previousInputId": {
+            "type": ["string", "null"]
+        },
+        "previousInputMessageAmount": {
+            "type": "number"
+        },
+        "handoverRequestId": {
+            "type": "string",
+        },
+        "URLToken": {
+            "type": "string"
+        },
+        "foreignSessionData": {
+            "type": "object"
+        },
+        "settings": {
+            "type": "object"
+        },
+        "foreignSessionId": {
+            "type": "string"
+        },
+        "chatwootInboxId": {
+            "type": "string",
+        },
+        "liveAgentInboxId": {
+            "type": "string"
+        },
+        "liveAgentAllowAgentInject": {
+            "type": "boolean"
+        },
+        "sendTranscriptAsFirstMessage": {
+            "type": "boolean"
+        },
+        "buttonId": {
+            "type": "string"
+        },
+        salesforcePrechatDetails: {
+            type: ["object", "array", "number", "string"],
+        },
+        salesforcePrechatEntities: {
+            type: ["object", "array", "number", "string"],
+        },
+        "notifySessionId": {
+            "type": "string",
+        },
+        "disableSensitiveLogging": {
+            "type": "boolean"
+        },
+        "traceId": {
+            "type": "string"
+        }
+    }
+};
+const getHandoverRequestFlowQuerySchema = {
+    title: "getHandoverRequestFlowQuerySchema",
+    additionalProperties: false,
+    type: "object",
+    required: ["userId", "organisation"],
+    properties: {
+        userId: { type: "string" },
+        organisation: { type: "string", format: "mongo-id" },
+        flowId: { type: "string", format: "mongo-id" }
+    }
+};
+const getHandoverRequestSessionQuerySchema = {
+    title: "getHandoverRequestSessionQuerySchema",
+    additionalProperties: false,
+    type: "object",
+    required: ["sessionId"],
+    properties: {
+        sessionId: { type: "string" },
+    }
+};
+const getHandoverRequestForeignSessionQuerySchema = {
+    title: "getHandoverRequestForeignSessionQuerySchema",
+    additionalProperties: false,
+    type: "object",
+    required: ["foreignSessionId"],
+    properties: {
+        foreignSessionId: { type: "string" },
+    }
+};
+export const getHandoverRequestDataSchema = {
+    title: "getHandoverRequestDataSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        disableSensitiveLogging: { type: "boolean" },
+        traceId: { type: "string" },
+        query: {
+            // @ts-ignore
+            oneOf: [getHandoverRequestFlowQuerySchema, getHandoverRequestSessionQuerySchema, getHandoverRequestForeignSessionQuerySchema]
+        }
+    }
+};
+export const sendMessageToProviderSchema = {
+    title: "sendMessageToProviderSchema",
+    "type": "object",
+    "required": [
+        "organisation",
+        "sessionId",
+        "messages",
+        "URLToken"
+    ],
+    "additionalProperties": false,
+    "properties": {
+        "organisation": {
+            "type": "string",
+            "format": "mongo-id",
+        },
+        "userId": {
+            "type": "string"
+        },
+        "sessionId": {
+            "type": "string"
+        },
+        "projectId": {
+            "type": "string"
+        },
+        "messages": {
+            "type": "array",
+            "items": {
+                "required": [
+                    "source",
+                    "userId",
+                    "message"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                    "source": {
+                        "type": "string",
+                        "enum": ["bot", "user"]
+                    },
+                    "userId": {
+                        "type": "string"
+                    },
+                    "message": {
+                        "type": ["null", "string"],
+                    },
+                    "data": {
+                        "type": ["object", "null"],
+                    },
+                    "settings": {
+                        "type": ["object", "null"]
+                    },
+                    "timestamp": {
+                        "type": ["object", "null"]
+                    },
+                    "attachments": {
+                        "type": ["array", "null"]
+                    }
+                }
+            }
+        },
+        "URLToken": {
+            "type": "string"
+        },
+        "disableSensitiveLogging": {
+            "type": "boolean"
+        },
+        "traceId": {
+            "type": "string"
+        },
+        "message_type": {
+            "type": ["null", "string"]
+        }
+    }
+};
+export const activateHandoverConversationSchema = {
+    title: "activateHandoverConversationSchema",
+    "type": "object",
+    "required": [
+        "userId",
+        "sessionId",
+    ],
+    "additionalProperties": false,
+    "properties": {
+        "userId": {
+            "type": "string"
+        },
+        "sessionId": {
+            "type": "string"
+        },
+        "disableSensitiveLogging": {
+            "type": "boolean"
+        },
+        "traceId": {
+            "type": "string"
+        }
+    }
+};
+export const pollAgentRepliesEventSchema = {
+    title: "pollAgentRepliesEventSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["handoverSettings", "traceId", "disableSensitiveLogging"],
+    properties: {
+        handoverSettings: handoverSettingsSchema,
+        foreignSessionData: foreignSessionDataSchema,
+        foreignSessionId: { type: "string" },
+        organisation: { type: "string" },
+        sessionId: { type: "string" },
+        traceId: { type: "string" },
+        disableSensitiveLogging: { type: "boolean" },
+        pollingTimeoutAt: { type: "number" },
+        sequence: { type: "number" }
+    },
+};
+export const handleHandoverRpcEventSchema = {
+    title: "handleHandoverRpcEventSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "providerId",
+        "eventType",
+        "message",
+        "traceId",
+        "disableSensitiveLogging"
+    ],
+    properties: {
+        providerId: { type: "string" },
+        eventType: { type: "string", enum: ["agentReply", "agentTypingOn", "agentTypingOff", "conversationClosed", "conversationFailed", "unknown"] },
+        foreignSessionData: foreignSessionDataSchema,
+        foreignSessionId: { type: "string" },
+        message: { type: ["string", "null"] },
+        data: { type: "object" },
+        traceId: { type: "string" },
+        disableSensitiveLogging: { type: "boolean" }
+    },
+};
+export const getQueueUpdateEventsSchema = {
+    title: "getQueueUpdateEventsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "handoverSettings",
+        "foreignSessionData",
+        "traceId",
+        "disableSensitiveLogging"
+    ],
+    properties: {
+        organisationId: { type: "string" },
+        projectId: { type: "string" },
+        handoverSettings: handoverSettingsSchema,
+        foreignSessionData: foreignSessionDataSchema,
+        queueUpdateOptions: queueUpdateOptionsSchema,
+        sessionId: { type: "string" },
+        traceId: { type: "string" },
+        disableSensitiveLogging: { type: "boolean" }
+    },
+};
+//# sourceMappingURL=handover.js.map

package/dist/esm/shared/interfaces/messageAPI/nlp.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=nlp.js.map

package/dist/esm/shared/interfaces/nlu/nlu.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=nlu.js.map

package/dist/esm/shared/interfaces/resources/IAgentAssistConfig.js

@@ -0,0 +1,59 @@
+/* Interfaces & Types */
+import { entityMetaSchema } from "./IEntityMeta";
+export const agentAssistGridConfigSchema = {
+    title: "agentAssistGridConfigSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        grid: {
+            type: "object",
+            additionalProperties: false,
+            required: ["columns", "rows", "gap"],
+            properties: {
+                columns: { type: "number" },
+                rows: { type: "number" },
+                gap: { type: "number" }
+            }
+        },
+        tiles: {
+            type: "object",
+            additionalProperties: false,
+            minProperties: 1,
+            patternProperties: {
+                "[a-zA-Z][0-9a-zA-Z_$]*": {
+                    type: "object",
+                    additionalProperties: false,
+                    required: ["x", "y", "columns", "rows"],
+                    properties: {
+                        x: { type: "number" },
+                        y: { type: "number" },
+                        columns: { type: "number" },
+                        rows: { type: "number" }
+                    }
+                }
+            }
+        }
+    },
+    required: ["grid", "tiles"]
+};
+export const agentAssistConfigDataSchema = {
+    title: "agentAssistConfigDataSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "name",
+        "config",
+    ],
+    properties: {
+        name: { type: "string", format: "resource-name" },
+        description: { type: "string", format: "snapshot-description" },
+        config: agentAssistGridConfigSchema
+    }
+};
+export const agentAssistConfigSchema = {
+    title: "agentAssistConfigSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), agentAssistConfigDataSchema.properties), { referenceId: { type: "string", format: "uuid" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
+};
+//# sourceMappingURL=IAgentAssistConfig.js.map

package/dist/esm/shared/interfaces/resources/IAiAgent.js

@@ -0,0 +1,49 @@
+/* Interfaces & Types */
+import { entityMetaSchema } from "./IEntityMeta";
+export const contactProfileOptions = ["none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly"];
+export const aiAgentDataSchema = {
+    title: "aiAgentDataSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["name"],
+    properties: {
+        name: { type: "string", format: "resource-name" },
+        image: { type: "string" },
+        imageOptimizedFormat: { type: "boolean" },
+        knowledgeReferenceId: { type: "string", format: "uuid" },
+        description: { type: "string", maxLength: 1000 },
+        speakingStyle: {
+            type: "object",
+            properties: {
+                completeness: { type: "string" },
+                formality: { type: "string" }
+            }
+        },
+        safetySettings: {
+            type: "object",
+            properties: {
+                avoidHarmfulContent: { type: "boolean" },
+                avoidUngroundedContent: { type: "boolean" },
+                avoidCopyrightInfringements: { type: "boolean" },
+                preventJailbreakAndManipulation: { type: "boolean" }
+            }
+        },
+        instructions: { type: "string", maxLength: 1000 },
+        contactProfilesOption: {
+            type: "string",
+            enum: [...contactProfileOptions]
+        },
+        contactProfilesSelected: {
+            type: "array", items: {
+                type: "string"
+            }
+        }
+    }
+};
+export const aiAgentSchema = {
+    title: "aiAgentSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), aiAgentDataSchema.properties), { referenceId: { type: "string", format: "uuid" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } })
+};
+//# sourceMappingURL=IAiAgent.js.map

package/dist/esm/shared/interfaces/resources/IAppTemplate.js

@@ -0,0 +1,21 @@
+import { entityMetaSchema } from "./IEntityMeta";
+export const appTemplateDataSchema = {
+    title: "appTemplateDataSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["type", "extension", "label", "path"],
+    properties: {
+        type: { type: "string", format: "resource-name" },
+        extension: { type: "string", format: "package-name" },
+        label: { type: "string", format: "resource-name" },
+        isCognigy: { type: "boolean" },
+        path: { type: "string" }
+    }
+};
+export const appTemplateSchema = {
+    title: "appTemplateSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), appTemplateDataSchema.properties), { projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } })
+};
+//# sourceMappingURL=IAppTemplate.js.map

package/dist/esm/shared/interfaces/resources/IAuditEvent.js

@@ -0,0 +1,150 @@
+export const auditEventTypes = [
+    "action",
+    "create",
+    "replace",
+    "patch",
+    "delete",
+    "unauthorized",
+];
+export const actionTypes = [
+    "acceptTermsOfService",
+    "addFlowLocalization",
+    "addIntentLocalization",
+    "addIntentToFlowState",
+    "addKeyphraseToLexiconEntry",
+    "addNodeLocalization",
+    "addProjectMember",
+    "addRoleToUser",
+    "addSlotToLexiconEntry",
+    "batchConnections",
+    "batchEndpoints",
+    "batchFlows",
+    "batchFlowStates",
+    "batchIntents",
+    "batchLexicons",
+    "batchLexiconEntries",
+    "batchLexiconSlots",
+    "batchNLUConnectors",
+    "batchPlaybooks",
+    "batchSentences",
+    "batchSlotFillers",
+    "batchTrainerRecords",
+    "cancelTask",
+    "changePlaybookStepOrder",
+    "cloneFlow",
+    "cloneGoal",
+    "cloneLargeLanguageModel",
+    "configureIdentityProvider",
+    "createKnowledgeSearchIndex",
+    "createPackage",
+    "createProjectByTemplate",
+    "createSnapshot",
+    "deleteKnowledgeSearchIndex",
+    "deprecatePassword",
+    "exportLexicons",
+    "followSession",
+    "hireAiAgent",
+    "importIntents",
+    "importIntoLexicon",
+    "ingestKnowledgeStore",
+    "logoutUser",
+    "mergePackage",
+    "moveChartNode",
+    "packageSnapshot",
+    "packageTrainerRecords",
+    "prepareCall",
+    "redoChart",
+    "removeContactIdFromProfile",
+    "removeFlowLocalization",
+    "removeIntentFromFlowState",
+    "removeIntentLocalization",
+    "removeKeyphraseFromLexiconEntry",
+    "removeNodeLocalization",
+    "removeProfileData",
+    "removeProjectMember",
+    "removeRoleFromUser",
+    "removeSlotFromLexiconEntry",
+    "requestOrganisationDeletion",
+    "resetFailedLoginAttempts",
+    "resetIdentityProvider",
+    "restoreSnapshot",
+    "stopFunctionInstance",
+    "setupCognigyLiveAgent",
+    "setupCognigyLiveAgentInbox",
+    "setupCognigyGenerativeAI",
+    "setupVoiceGatewayAccount",
+    "updateCognigyLiveAgentInbox",
+    "trainAllProjectFlows",
+    "trainIntents",
+    "trainYesNoIntents",
+    "triggerFunction",
+    "undoChart",
+    "updateExtensionPackage",
+    "updateProjectMember",
+    "uploadExtension",
+    "uploadFile",
+    "uploadPackage",
+    "uploadSnapshotPackage",
+    "uploadTrainerRecordsPackage",
+    "createAuthenticatedAmazonUser",
+    "deleteAmazonAccount",
+    "deployAlexaEndpoint",
+    "deleteOrganisation",
+    "enforcePasswordPolicy",
+    "createApiKey",
+    "updateOrganisation",
+    "createUser",
+    "deleteUser",
+    "updateUser",
+    "changePassword",
+    "resetPassword",
+    "exportProfileData",
+    "mergeProfiles",
+    "unmergeProfiles",
+    "updateFlowSettings",
+    "optionsResolver",
+    "processKnowledgeSourceUrl",
+    "processKnowledgeSourceFile",
+];
+export const auditEventSchema = {
+    title: "auditEventSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "timestamp",
+        "type",
+        "user",
+        "userReference",
+        "organisationReference",
+        "expiresAt",
+    ],
+    properties: {
+        _id: { type: "string", format: "mongo-id" },
+        timestamp: { type: "object", format: "date-time" },
+        type: {
+            type: "string",
+            enum: [...auditEventTypes],
+        },
+        actionType: { type: "string", enum: [...actionTypes] },
+        user: { type: "string", format: "email" },
+        userReference: { type: "string", format: "mongo-id" },
+        organisationReference: { type: "string", format: "mongo-id" },
+        chain: {
+            type: "array",
+            additionalItems: false,
+            items: {
+                type: "object",
+                required: ["elementType"],
+                additionalProperties: false,
+                properties: {
+                    elementId: { type: "string", format: "mongo-id" },
+                    elementType: { type: "string" },
+                },
+            },
+        },
+        expiresAt: { type: "object", format: "date-time" },
+        payload: { type: "string" },
+        projectReference: { type: "string", format: "mongo-id" },
+    },
+};
+//# sourceMappingURL=IAuditEvent.js.map

package/dist/esm/shared/interfaces/resources/IChart.js

@@ -0,0 +1,50 @@
+export const chartNodeExcerptSchema = {
+    title: "chartNodeExcerptSchema",
+    type: "object",
+    properties: {
+        _id: { format: "mongo-id" },
+        referenceId: { type: "string", format: "uuid" },
+        comment: { type: "string", maxLength: 512 },
+        commentColor: { type: "string", format: "color" },
+        preview: { type: "string" },
+        isDisabled: { type: "boolean" },
+        isEntryPoint: { type: "boolean" },
+        label: { type: "string", maxLength: 200 },
+        analyticsLabel: { type: ["null", "string"], format: "analytics-label" },
+        type: { type: "string", maxLength: 200 },
+        extension: { type: "string", format: "package-name" },
+        localeReference: { type: "string", format: "mongo-id" }
+    },
+};
+export const chartNodeRelationDataSchema = {
+    title: "chartNodeRelationDataSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        children: { type: "array", items: { format: "mongo-id" } },
+        next: { anyOf: [{ format: "mongo-id" }, { type: "null" }] },
+        node: { format: "mongo-id" },
+    },
+};
+export const chartNodeRelationSchema = {
+    title: "chartNodeRelationSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: Object.assign({ _id: { format: "mongo-id" } }, chartNodeRelationDataSchema.properties),
+};
+export const chartDataSchema = {
+    title: "chartDataSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        nodes: { type: "array", items: chartNodeExcerptSchema },
+        relations: { type: "array", items: chartNodeRelationSchema },
+    },
+};
+export const chartSchema = {
+    title: "chartDataSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: Object.assign(Object.assign({}, chartDataSchema.properties), { _id: { type: "string", format: "mongo-id" }, resourceReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
+};
+//# sourceMappingURL=IChart.js.map