@cognigy/rest-api-client 4.95.0 → 4.97.0

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

@@ -2,6 +2,7 @@ export const externalHandoverProviders = [
     "rce",
     "chatwoot",
     "salesforce",
+    "salesforceMIAW",
     "liveAgent",
     "genesysCloud",
     "genesysCloudOM",
@@ -38,6 +39,7 @@ export const handoverSettingsSchema = {
                 "cognigy",
                 "rce",
                 "salesforce",
+                "salesforceMIAW",
                 "liveAgent",
                 "genesysCloud",
                 "genesysCloudOM",
@@ -80,7 +82,15 @@ export const handoverSettingsSchema = {
                         queue: { type: "string" },
                         queueId: { type: "string" },
                         sendProfile: { type: "boolean" },
-                        sessionDuration: { type: "number" }
+                        sessionDuration: { type: "number" },
+                        esDeveloperName: { type: "string" },
+                        capabilitiesVersion: { type: "string" },
+                        rceConnection: { type: "string" },
+                        eightByEightConnection: { type: "string" },
+                        chatwootConnection: { type: "string" },
+                        liveAgentConnection: { type: "string" },
+                        genesysCloudConnection: { type: "string" },
+                        genesysCloudOMConnection: { type: "string" }
                     }
                 }
             ]
@@ -130,6 +140,8 @@ export const foreignSessionDataSchema = {
         integrationId: { type: "string" },
         conversationId: { type: "string" },
         clientPollTimeout: { type: "number" },
+        accessToken: { type: "string" },
+        lastEventId: { type: "string" },
     }
 };
 export const rceSettingsSchema = {
@@ -137,12 +149,9 @@ export const rceSettingsSchema = {
     "type": "object",
     "additionalProperties": false,
     "required": [
-        "apiAccessToken",
         "baseApiUrl",
         "forwardOnlyHandoverConversations",
-        "realtimeAccessToken",
         "realtimeEndpointUrl",
-        "webhookSecret",
         "agentCategoryId",
         "botCategoryId"
     ],
@@ -175,6 +184,10 @@ export const rceSettingsSchema = {
         },
         "botCategoryId": {
             "type": "string"
+        },
+        // TODO: add as required once we have migrated all providers to the new connection ids
+        "rceConnection": {
+            "type": "string"
         }
     }
 };
@@ -184,7 +197,6 @@ export const eightByEightSettingsSchema = {
     "additionalProperties": false,
     "required": [
         "baseUrl",
-        "apiKey",
         "apiTenant"
     ],
     "properties": {
@@ -202,6 +214,10 @@ export const eightByEightSettingsSchema = {
         "forwardOnlyHandoverConversations": {
             "type": "boolean"
         },
+        // TODO: add as required once we have migrated all providers to the new connection ids
+        "eightByEightConnection": {
+            "type": "string"
+        }
     }
 };
 export const queueUpdateOptionsSchema = {
@@ -271,12 +287,12 @@ export const chatwootSettingsSchema = {
     required: [
         "baseUrl",
         "accountId",
-        "apiKey",
     ],
     properties: {
         accountId: {
             type: "string"
         },
+        // TODO: remove once we have migrated all providers to the new connection ids
         apiKey: {
             type: "string"
         },
@@ -290,6 +306,10 @@ export const chatwootSettingsSchema = {
         forwardOnlyHandoverConversations: {
             "type": "boolean",
         },
+        // TODO: add as required once we have migrated all providers to the new connection ids
+        chatwootConnection: {
+            "type": "string"
+        }
     }
 };
 export const salesforceSettingsSchema = {
@@ -328,6 +348,38 @@ export const salesforceSettingsSchema = {
         },
     }
 };
+export const salesforceMIAWSettingsSchema = {
+    title: "salesforceMIAWSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "baseUrl",
+        "capabilitiesVersion",
+        "organizationId",
+        "esDeveloperName"
+    ],
+    properties: {
+        baseUrl: {
+            type: "string",
+            format: "url"
+        },
+        capabilitiesVersion: {
+            type: "string"
+        },
+        organizationId: {
+            type: "string",
+        },
+        esDeveloperName: {
+            type: "string",
+        },
+        forwardOnlyHandoverConversations: {
+            "type": "boolean",
+        },
+        forwardUnknownEventsToFlow: {
+            type: "boolean"
+        }
+    }
+};
 export const liveAgentSettingsSchema = {
     title: "liveAgentSettingsSchema",
     type: "object",
@@ -335,12 +387,12 @@ export const liveAgentSettingsSchema = {
     required: [
         "baseUrl",
         "accountId",
-        "apiKey",
     ],
     properties: {
         accountId: {
             type: "string"
         },
+        // TODO: remove once we have migrated all providers to the new connection ids
         apiKey: {
             type: "string"
         },
@@ -356,6 +408,10 @@ export const liveAgentSettingsSchema = {
         },
         usePlatformToken: {
             "type": "boolean",
+        },
+        // TODO: add as required once we have migrated all providers to the new connection ids
+        liveAgentConnection: {
+            "type": "string"
         }
     }
 };
@@ -395,8 +451,13 @@ export const genesysCloudSettingsSchema = {
         forwardOnlyHandoverConversations: {
             "type": "boolean",
         },
+        // TODO: remove once we have migrated all providers to the new connection ids
         oAuth2Connection: {
             type: "string"
+        },
+        // TODO: add as required once we have migrated all providers to the new connection ids
+        genesysCloudConnection: {
+            "type": "string"
         }
     }
 };
@@ -408,8 +469,6 @@ export const genesysCloudOMSettingsSchema = {
         "host",
         "deploymentName",
         "queue",
-        "clientId",
-        "clientSecret"
     ],
     properties: {
         host: {
@@ -421,6 +480,7 @@ export const genesysCloudOMSettingsSchema = {
         queue: {
             type: "string"
         },
+        // TODO: remove once we have migrated all providers to the new connection ids
         webhookSecret: {
             type: "string"
         },
@@ -433,6 +493,10 @@ export const genesysCloudOMSettingsSchema = {
         clientSecret: {
             type: "string"
         },
+        // TODO: add as required once we have migrated all providers to the new connection ids
+        genesysCloudOMConnection: {
+            "type": "string"
+        },
         forwardOnlyHandoverConversations: {
             "type": "boolean",
         }

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

@@ -0,0 +1,20 @@
+export const externalHandoverServices = [
+    "rce",
+    "chatwoot",
+    "salesforce",
+    "liveAgent",
+    "genesysCloud",
+    "genesysCloudOM",
+    "eightByEight",
+    "salesforceMIAW"
+];
+export const internalHandoverServices = [
+    "cognigy",
+    "none"
+];
+export const handoverServices = [
+    ...internalHandoverServices,
+    ...externalHandoverServices
+];
+;
+//# sourceMappingURL=handoverProviders.js.map

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

@@ -135,6 +135,8 @@ const callFailoverSettingsSchema = {
         dialCallerId: { type: "string" },
         dialMusic: { type: "string" },
         dialTimeout: { type: "number" },
+        timeLimit: { type: "number" },
+        enableTimeLimit: { type: "boolean" },
         dialTranscribeEnabled: { type: "boolean" },
         dialTranscribeVendor: { type: "string" },
         dialTranscribeLanguage: { type: "string" },

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

@@ -16,6 +16,12 @@ export const createHandoverRequestDataSchema = {
             "type": "string",
             "format": "mongo-id",
         },
+        "handoverProvider": {
+            "type": "string",
+        },
+        "handoverProviderConfig": {
+            "type": "object",
+        },
         "organisation": {
             "type": "string",
             "format": "mongo-id",
@@ -37,7 +43,7 @@ export const createHandoverRequestDataSchema = {
             "type": "object"
         },
         // We cannot set format: endpoint-channel, since the channel can be
-        // overriden by the customer (e.g. for their website)
+        // overridden by the customer (e.g. for their website)
         "channel": {
             "type": "string",
         },
@@ -77,6 +83,10 @@ export const createHandoverRequestDataSchema = {
         "liveAgentAllowAgentInject": {
             "type": "boolean"
         },
+        // Temporary field for live agent
+        "allowAgentInject": {
+            "type": "boolean"
+        },
         "sendTranscriptAsFirstMessage": {
             "type": "boolean"
         },
@@ -238,8 +248,8 @@ export const activateHandoverConversationSchema = {
         }
     }
 };
-export const pollAgentRepliesEventSchema = {
-    title: "pollAgentRepliesEventSchema",
+export const pollEventSchema = {
+    title: "pollEventSchema",
     type: "object",
     additionalProperties: false,
     required: ["handoverSettings", "traceId", "disableSensitiveLogging"],
@@ -252,7 +262,8 @@ export const pollAgentRepliesEventSchema = {
         traceId: { type: "string" },
         disableSensitiveLogging: { type: "boolean" },
         pollingTimeoutAt: { type: "number" },
-        sequence: { type: "number" }
+        sequence: { type: "number" },
+        lastEventId: { type: "string" }
     },
 };
 export const handleHandoverRpcEventSchema = {
@@ -298,4 +309,13 @@ export const getQueueUpdateEventsSchema = {
         disableSensitiveLogging: { type: "boolean" }
     },
 };
+;
+;
+;
+;
+;
+[];
+;
+;
+;
 //# sourceMappingURL=handover.js.map

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

@@ -19,6 +19,16 @@ export const aiAgentDataSchema = {
                 formality: { type: "string" }
             }
         },
+        voiceConfigs: {
+            type: "object",
+            properties: {
+                ttsVoice: { type: "string" },
+                ttsLanguage: { type: "string" },
+                ttsVendor: { type: "string" },
+                ttsModel: { type: "string" }
+            }
+        },
+        enableVoiceConfigs: { type: "boolean" },
         safetySettings: {
             type: "object",
             properties: {

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

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

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

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

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

@@ -34,7 +34,17 @@ export const openAIMetaSchema = {
     type: "object",
     additionalProperties: false,
     properties: {
-        customModel: { type: ["string", "null"] }
+        customModel: { type: ["string", "null"] },
+        baseCustomUrl: { type: ["string", "null"] }
+    }
+};
+export const openAICompatibleMetaSchema = {
+    title: "openAICompatibleMetaSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        customModel: { type: "string" },
+        baseCustomUrl: { type: "string" },
     }
 };
 export const azureOpenAIMetaSchema = {
@@ -113,6 +123,7 @@ export const largeLanguageModelDataSchema = {
         connectionId: { type: "string", format: "uuid" },
         isDefault: { type: "boolean" },
         openAI: openAIMetaSchema,
+        openAICompatible: openAICompatibleMetaSchema,
         azureOpenAI: azureOpenAIMetaSchema,
         googleVertexAI: googleVertexAIMetaSchema,
         googleGemini: googleGeminiMetaSchema,

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

@@ -89,10 +89,13 @@ const nodeDependenciesSchema = {
 export const nodeFieldTypes = [
     "adaptivecard",
     "agentAssistConfig",
+    "aiAgentSelect",
     "appTemplate",
     "backgroundSelector",
     "caseNode",
     "checkbox",
+    "checkAgentAvailabilityProvider",
+    "checkAgentAvailabilityConfig",
     "chipInput",
     "code",
     "cognigyLLMText",
@@ -107,16 +110,16 @@ export const nodeFieldTypes = [
     "flow",
     "flowNode",
     "function",
+    "goalAndStepsSelect",
+    "handoverProvider",
+    "handoverProviderConfig",
     "json",
     "keyValuePairs",
-    "toolParameters",
+    "knowledgeSourceTags",
     "knowledgeStore",
     "knowledgeStoreSelect",
-    "knowledgeSourceTags",
-    "llmSelect",
-    "aiAgentSelect",
-    "goalAndStepsSelect",
     "lexicon",
+    "llmSelect",
     "localeField",
     "node",
     "number",
@@ -136,6 +139,7 @@ export const nodeFieldTypes = [
     "textArray",
     "time",
     "toggle",
+    "toolParameters",
     "ttsSelect",
     "typescript",
     "xml"

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

@@ -20,6 +20,7 @@
  *         - flowSettings
  *         - flowState
  *         - function
+ *         - handoverProvider
  *         - intent
  *         - intentDefaultReply
  *         - intentLearningSentence
@@ -56,6 +57,7 @@ export const arrayTResourceType = [
     "flowSettings",
     "flowState",
     "function",
+    "handoverProvider",
     "intent",
     "intentDefaultReply",
     "intentLearningSentence",
@@ -95,6 +97,7 @@ export const arrayTSnapshottableResourceType = [
     "flowSettings",
     "flowState",
     "function",
+    "handoverProvider",
     "intent",
     "intentDefaultReply",
     "intentRelation",
@@ -132,6 +135,7 @@ export const chartableResourceTypes = [...arrayTChartableResourceType];
  *         - function
  *         - lexicon
  *         - goal
+ *         - handoverProvider
  *         - nluconnector
  *         - playbook
  *         - project
@@ -164,6 +168,7 @@ export const packageableResourceTypes = [
     "lexicon",
     "locale",
     "goal",
+    "handoverProvider",
     "nluconnector",
     "playbook",
     "snippet",
@@ -183,6 +188,7 @@ export const primaryResourceTypes = [
     "nluconnector",
     "playbook",
     "snippet",
+    "handoverProvider",
 ];
 export const pinnableResourceTypes = [
     "project"

package/dist/esm/shared/interfaces/resources/intent/IDefaultReply.js

@@ -15,7 +15,6 @@ export const defaultReplyInDBSchema = {
     additionalProperties: false,
     properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), defaultReplyDataSchema.properties), { localeReference: { type: "string", format: "mongo-id" }, intentReference: { type: "string", format: "mongo-id" }, flowReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } })
 };
-;
 export const defaultReplySchema = {
     title: "defaultReplySchema",
     type: "object",

package/dist/esm/shared/interfaces/resources/settings/IAudioPreviewSettings.js

@@ -1,4 +1,4 @@
-export const audioPreviewProviders = ["microsoft", "google", "aws"];
+export const audioPreviewProviders = ["microsoft", "google", "aws", "deepgram"];
 export const audioPreviewSettingsDataSchema = {
     title: "audioPreviewSettingsDataSchema",
     type: ["object", "null"],
@@ -25,7 +25,13 @@ export const audioPreviewSettingsDataSchema = {
                     properties: {
                         connectionId: { type: ["string", "null"], format: "uuid" }
                     }
-                }
+                },
+                deepgram: {
+                    type: "object",
+                    properties: {
+                        connectionId: { type: ["string", "null"], format: "uuid" }
+                    }
+                },
             }
         }
     }

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/ICreateHandoverProviderRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/IDeleteHandoverProviderRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/IHandoverProvider_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/IHandoverService_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/IIndexHandoverProvidersRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/IIndexHandoverServicesRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/IReadHandoverProviderRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/IUpdateHandoverProviderRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/resources/handoverProvider/v2.0/index.js

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

package/dist/esm/shared/interfaces/security/IPermission.js

@@ -58,6 +58,7 @@ export const organisationWidePermissions = [
  *         - memberDetails
  *         - members
  *         - goals
+ *         - handoverProviders
  *         - nluConnectors
  *         - packages
  *         - playbooks
@@ -97,6 +98,7 @@ export const projectWidePermissions = [
     "memberDetails",
     "members",
     "goals",
+    "handoverProviders",
     "nluConnectors",
     "packages",
     "playbooks",

package/dist/esm/shared/interfaces/security/IRole.js

@@ -63,6 +63,7 @@ export const organisationWideRoles = [
  *         - flowNodeComments
  *         - flowNodeDescriptions
  *         - followUser
+ *         - handoverProviderAdmin
  *         - intents
  *         - data_privacy_admin
  *         - data_privacy_editor
@@ -106,6 +107,7 @@ export const projectWideRoles = [
     "followUser",
     "function_admin",
     "function_editor",
+    "handoverProviderAdmin",
     "intents",
     "knowledgeAdmin",
     "large_language_model_admin",

package/dist/esm/shared/interfaces/security/index.js

@@ -1,4 +1,4 @@
-export const COMPUTED_ACL_HASH_VERSION = "v18";
+export const COMPUTED_ACL_HASH_VERSION = "v19";
 export { availablePermissions, } from "./IPermission";
 export { organisationWideRoles, projectWideRoles, availableRoles, } from "./IRole";
 export { operations, } from "./IOperation";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "4.95.0",
+	"version": "4.97.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",
@@ -31,7 +31,7 @@
 	"license": "Cognigy Proprietary License",
 	"dependencies": {
 		"ajv": "6.12.6",
-		"axios": "1.7.4",
+		"axios": "1.7.9",
 		"form-data": "4.0.0",
 		"tus-js-client": "^3.1.1",
 		"uuidv4": "6.2.13"