@cognigy/rest-api-client 4.99.0 → 2025.10.0

package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js

@@ -8,6 +8,7 @@ export const embeddingModels = [
     "text-embedding-ada-002",
     "luminous-embedding-128",
     "amazon.titan-embed-text-v2:0",
+    "Pharia-1-Embedding-4608",
 ];
 export const generativeAIModels = [
     "gpt-3.5-turbo",

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

@@ -1,3 +1,10 @@
+/**
+ * IMPORTANT: This file exists in two places:
+ * - cognigy/services/service-handover/src/old_shared/interfaces/handover.ts
+ * - cognigy/shared/interfaces/handover.ts
+ *
+ * Please keep both files in sync.
+ */
 export const externalHandoverProviders = [
     "rce",
     "chatwoot",
@@ -7,6 +14,7 @@ export const externalHandoverProviders = [
     "genesysCloud",
     "genesysCloudOM",
     "eightByEight",
+    "salesforceMIAW"
 ];
 export const internalHandoverProviders = [
     "cognigy",
@@ -51,7 +59,8 @@ export const handoverSettingsSchema = {
             oneOf: [
                 {
                     type: "object",
-                    additionalProperties: false,
+                    // Temporary due to handover provider changes
+                    additionalProperties: true,
                     properties: {
                         accountId: { type: "string" },
                         baseUrl: { type: "string" },
@@ -142,6 +151,7 @@ export const foreignSessionDataSchema = {
         clientPollTimeout: { type: "number" },
         accessToken: { type: "string" },
         lastEventId: { type: "string" },
+        apiKey: { type: "string" }
     }
 };
 export const rceSettingsSchema = {
@@ -223,7 +233,7 @@ export const eightByEightSettingsSchema = {
 export const queueUpdateOptionsSchema = {
     "title": "queueUpdateOptionsSchema",
     "type": "object",
-    "additionalProperties": false,
+    "additionalProperties": true,
     "required": [],
     "properties": {
         "getQueuePosition": {
@@ -242,10 +252,16 @@ export const queueUpdateOptionsSchema = {
             "type": "boolean"
         },
         "maximumQueuePosition": {
-            "type": ["number", "null"]
+            "anyOf": [
+                { "type": "number" },
+                { "type": "string", "const": "" }
+            ]
         },
         "maximumEstimatedWaitTime": {
-            "type": ["number", "null"]
+            "anyOf": [
+                { "type": "number" },
+                { "type": "string", "const": "" }
+            ]
         },
         "alternativeText": {
             "type": ["string", "null"]
@@ -377,7 +393,7 @@ export const salesforceMIAWSettingsSchema = {
         },
         forwardUnknownEventsToFlow: {
             type: "boolean"
-        }
+        },
     }
 };
 export const liveAgentSettingsSchema = {

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

@@ -336,124 +336,6 @@ export const avayaGatherLanguages = [
     "cmn-Hans-HK",
     "cmn-Hans-CN",
 ];
-export const anyEndpointSettingsSchema = {
-    title: "anyEndpointSettingsSchema",
-    type: "object",
-    properties: {
-        action: { type: "string" },
-        accessScope: { type: "string" },
-        accessToken: { type: "string" },
-        appId: { type: "string" },
-        appSecret: { type: "string" },
-        backgroundImageUrl: { type: "string" },
-        basicAuthPassword: { type: "string" },
-        basicAuthUser: { type: "string" },
-        botUserId: { type: "string" },
-        colorScheme: { type: "string" },
-        connectionName: { type: "string" },
-        cpaasToken: { type: "string" },
-        customJSON: { type: "string" },
-        designTemplate: { type: "integer" },
-        disableHtmlContentSanitization: { type: "boolean" },
-        disableInputAutocomplete: { type: "boolean" },
-        disableUrlButtonSanitization: { type: "boolean" },
-        disableInputSanitization: { type: "boolean" },
-        disableSkipUriTags: { type: "boolean" },
-        enableAsyncCommunication: { type: "boolean" },
-        enableCollectMetadata: { type: "boolean" },
-        enableGenericHTMLStyling: { type: "boolean" },
-        enableDemoWebchat: { type: "boolean" },
-        enableFileUpload: { type: "boolean" },
-        enablePersistentMenu: { type: "boolean" },
-        enableRating: { type: "string", enum: ["always", "once", "onRequest"] },
-        enableSTT: { type: "boolean" },
-        enableTTS: { type: "boolean" },
-        enableTypingIndicator: { type: "boolean" },
-        enableFileAttachment: { type: "boolean" },
-        fileAttachmentMaxSize: { type: "number" },
-        facebookPageToken: { type: "string" },
-        finishOnKey: {
-            type: "string",
-            enum: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "*", "#"]
-        },
-        workplaceToken: { type: "string" },
-        foreignId: { type: "string" },
-        gatherlanguage: {
-            type: "string",
-            enum: [...avayaGatherLanguages]
-        },
-        getStartedButtonText: { type: "string" },
-        getStartedData: { type: "string" },
-        getStartedPayload: { type: "string" },
-        getStartedText: { type: "string" },
-        headerLogoUrl: { type: "string" },
-        hints: { type: "string" },
-        hubSecret: { type: "string" },
-        input: {
-            type: "string",
-            enum: ["speech dtmf", "speech", "dtmf"]
-        },
-        inputPlaceholder: { type: "string" },
-        language: {
-            type: "string",
-            enum: [...avayaSttTtsLanguages]
-        },
-        lineChannelAccessToken: { type: "string" },
-        lineChannelSecret: { type: "string" },
-        mergeContactProfiles: { type: "boolean" },
-        messageDelay: { type: "integer" },
-        messageLogoUrl: { type: "string" },
-        method: {
-            type: "string",
-            enum: ["GET", "POST"]
-        },
-        numDigits: { type: "integer" },
-        ratingTitleText: { type: "string" },
-        ratingCommentText: { type: "string" },
-        ratingMessageHistoryRatingText: { type: "string" },
-        ratingMessageHistoryCommentText: { type: "string" },
-        reparseAlexaSlots: { type: "boolean" },
-        requestFacebookProfileData: { type: "boolean" },
-        sessionExpiration: { type: "integer" },
-        slackOAuthAccessToken: { type: "string" },
-        slackVerifyToken: { type: "string" },
-        sunshineConversationsChannelKeyId: { type: "string" },
-        sunshineConversationsChannelSecret: { type: "string" },
-        sunshineConversationsChannelUri: { type: "string", format: "uri" },
-        sunshineConversationsApiVersion: { type: "string", enum: ["v1.1", "v2"] },
-        tenantId: { type: "string" },
-        timeout: { type: "integer" },
-        updateContactProfileWithFacebookProfile: { type: "boolean" },
-        voice: { type: "string" },
-        webhookUrl: {
-            oneOf: [
-                { type: "string", format: "uri" },
-                { type: "string", enum: [""] }
-            ]
-        },
-        enableConnectionStatusIndicator: { type: "boolean" },
-        enableUnreadMessageTitleIndicator: { type: "boolean" },
-        showEngagementMessagesInChat: { type: "boolean" },
-        engagementMessageText: { type: "string" },
-        enableUnreadMessageBadge: { type: "boolean" },
-        enableUnreadMessagePreview: { type: "boolean" },
-        enableUnreadMessageSound: { type: "boolean" },
-        dynamicImageAspectRatio: { type: "boolean" },
-        focusInputAfterPostback: { type: "boolean" },
-        disableInputAutogrow: { type: "boolean" },
-        inputAutogrowMaxRows: { type: "number" },
-        enableInputCollation: { type: "boolean" },
-        inputCollationTimeout: { type: "number" },
-        skill: skillSchema,
-        persistentMenu: webchatPersistentMenuSchema,
-        shouldOverwriteWebchatBundleUrl: { type: "boolean" },
-        overwriteWebchatBundleUrl: { type: "string" },
-        businessHours: businessHoursMenuSchema,
-        maintenance: maintenanceMenuSchema,
-        callEvents: callEventsSchema,
-        failover: callFailoverSettingsSchema,
-    }
-};
 export const dashbotPlatform = [
     "facebook",
     "whatsapp",
@@ -792,6 +674,24 @@ export const niceCXOneEndpointSettingsSchema = {
     },
     additionalProperties: false
 };
+export const niceCXOneAAHEndpointSettingsSchema = {
+    type: "object",
+    properties: {
+        niceCXOneAAHConnection: {
+            anyOf: [
+                {
+                    type: "string",
+                    format: "uuid"
+                },
+                {
+                    type: "string",
+                    maxLength: 0
+                }
+            ]
+        }
+    },
+    additionalProperties: false
+};
 export const agentAssistVoiceEndpointSettingsSchema = {
     type: "object",
     properties: {
@@ -799,6 +699,31 @@ export const agentAssistVoiceEndpointSettingsSchema = {
     },
     additionalProperties: false
 };
+export const anyEndpointSettingsSchema = {
+    title: "anyEndpointSettingsSchema",
+    type: "object",
+    properties: Object.assign({ action: { type: "string" }, accessScope: { type: "string" }, accessToken: { type: "string" }, appId: { type: "string" }, appSecret: { type: "string" }, backgroundImageUrl: { type: "string" }, basicAuthPassword: { type: "string" }, basicAuthUser: { type: "string" }, botUserId: { type: "string" }, colorScheme: { type: "string" }, connectionName: { type: "string" }, cpaasToken: { type: "string" }, customJSON: { type: "string" }, designTemplate: { type: "integer" }, disableHtmlContentSanitization: { type: "boolean" }, disableInputAutocomplete: { type: "boolean" }, disableUrlButtonSanitization: { type: "boolean" }, disableInputSanitization: { type: "boolean" }, disableSkipUriTags: { type: "boolean" }, enableAsyncCommunication: { type: "boolean" }, enableCollectMetadata: { type: "boolean" }, enableGenericHTMLStyling: { type: "boolean" }, enableDemoWebchat: { type: "boolean" }, enableFileUpload: { type: "boolean" }, enablePersistentMenu: { type: "boolean" }, enableRating: { type: "string", enum: ["always", "once", "onRequest"] }, enableSTT: { type: "boolean" }, enableTTS: { type: "boolean" }, enableTypingIndicator: { type: "boolean" }, enableFileAttachment: { type: "boolean" }, fileAttachmentMaxSize: { type: "number" }, facebookPageToken: { type: "string" }, finishOnKey: {
+            type: "string",
+            enum: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "*", "#"]
+        }, workplaceToken: { type: "string" }, foreignId: { type: "string" }, gatherlanguage: {
+            type: "string",
+            enum: [...avayaGatherLanguages]
+        }, getStartedButtonText: { type: "string" }, getStartedData: { type: "string" }, getStartedPayload: { type: "string" }, getStartedText: { type: "string" }, headerLogoUrl: { type: "string" }, hints: { type: "string" }, hubSecret: { type: "string" }, input: {
+            type: "string",
+            enum: ["speech dtmf", "speech", "dtmf"]
+        }, inputPlaceholder: { type: "string" }, language: {
+            type: "string",
+            enum: [...avayaSttTtsLanguages]
+        }, lineChannelAccessToken: { type: "string" }, lineChannelSecret: { type: "string" }, mergeContactProfiles: { type: "boolean" }, messageDelay: { type: "integer" }, messageLogoUrl: { type: "string" }, method: {
+            type: "string",
+            enum: ["GET", "POST"]
+        }, numDigits: { type: "integer" }, ratingTitleText: { type: "string" }, ratingCommentText: { type: "string" }, ratingMessageHistoryRatingText: { type: "string" }, ratingMessageHistoryCommentText: { type: "string" }, reparseAlexaSlots: { type: "boolean" }, requestFacebookProfileData: { type: "boolean" }, sessionExpiration: { type: "integer" }, slackOAuthAccessToken: { type: "string" }, slackVerifyToken: { type: "string" }, sunshineConversationsChannelKeyId: { type: "string" }, sunshineConversationsChannelSecret: { type: "string" }, sunshineConversationsChannelUri: { type: "string", format: "uri" }, sunshineConversationsApiVersion: { type: "string", enum: ["v1.1", "v2"] }, tenantId: { type: "string" }, timeout: { type: "integer" }, updateContactProfileWithFacebookProfile: { type: "boolean" }, voice: { type: "string" }, webhookUrl: {
+            oneOf: [
+                { type: "string", format: "uri" },
+                { type: "string", enum: [""] }
+            ]
+        }, enableConnectionStatusIndicator: { type: "boolean" }, enableUnreadMessageTitleIndicator: { type: "boolean" }, showEngagementMessagesInChat: { type: "boolean" }, engagementMessageText: { type: "string" }, enableUnreadMessageBadge: { type: "boolean" }, enableUnreadMessagePreview: { type: "boolean" }, enableUnreadMessageSound: { type: "boolean" }, dynamicImageAspectRatio: { type: "boolean" }, focusInputAfterPostback: { type: "boolean" }, disableInputAutogrow: { type: "boolean" }, inputAutogrowMaxRows: { type: "number" }, enableInputCollation: { type: "boolean" }, inputCollationTimeout: { type: "number" }, skill: skillSchema, persistentMenu: webchatPersistentMenuSchema, shouldOverwriteWebchatBundleUrl: { type: "boolean" }, overwriteWebchatBundleUrl: { type: "string" }, businessHours: businessHoursMenuSchema, maintenance: maintenanceMenuSchema, callEvents: callEventsSchema, failover: callFailoverSettingsSchema }, niceCXOneAAHEndpointSettingsSchema.properties)
+};
 /** Create the default endpoint for adminconsole i.e. for interaction panel */
 export const createAdminConsoleEndpointConfiguration = () => {
     /** Create the endpointConfiguration for this connection */

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

@@ -1,3 +1,10 @@
+/**
+ * IMPORTANT: This file exists in two places:
+ * - cognigy/services/service-handover/src/old_shared/interfaces/messageAPI/handover.ts
+ * - cognigy/shared/interfaces/messageAPI/handover.ts
+ *
+ * Please keep both files in sync.
+ */
 import { foreignSessionDataSchema, handoverSettingsSchema, queueUpdateOptionsSchema } from "../handover";
 export const createHandoverRequestDataSchema = {
     title: "createHandoverRequestDataSchema",
@@ -10,7 +17,7 @@ export const createHandoverRequestDataSchema = {
         "flowReferenceId",
         "URLToken"
     ],
-    "additionalProperties": false,
+    "additionalProperties": true,
     "properties": {
         "projectId": {
             "type": "string",
@@ -83,10 +90,6 @@ export const createHandoverRequestDataSchema = {
         "liveAgentAllowAgentInject": {
             "type": "boolean"
         },
-        // Temporary field for live agent
-        "allowAgentInject": {
-            "type": "boolean"
-        },
         "sendTranscriptAsFirstMessage": {
             "type": "boolean"
         },
@@ -99,6 +102,31 @@ export const createHandoverRequestDataSchema = {
         salesforcePrechatEntities: {
             type: ["object", "array", "number", "string"],
         },
+        salesforceMIAWRoutingAttributes: {
+            // @ts-ignore - not working properly with the type
+            type: ["object", "array", "number", "string"],
+        },
+        salesforceMIAWCustomerIdentityToken: {
+            type: "string"
+        },
+        enableHandoverDisconnectMessageLiveAgent: {
+            type: "boolean"
+        },
+        enableHandoverConnectMessageLiveAgent: {
+            type: "boolean"
+        },
+        enableHandoverDisconnectMessageGenesys: {
+            type: "boolean"
+        },
+        enableHandoverConnectMessageGenesys: {
+            type: "boolean"
+        },
+        enableHandoverDisconnectMessageRingCentralEngage: {
+            type: "boolean"
+        },
+        enableHandoverConnectMessageRingCentralEngage: {
+            type: "boolean"
+        },
         "notifySessionId": {
             "type": "string",
         },
@@ -296,7 +324,7 @@ export const handleHandoverRpcEventSchema = {
 export const getQueueUpdateEventsSchema = {
     title: "getQueueUpdateEventsSchema",
     type: "object",
-    additionalProperties: false,
+    additionalProperties: true,
     required: [
         "handoverSettings",
         "foreignSessionData",

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

@@ -1,9 +1,9 @@
 import { anyEndpointSettingsSchema } from "../messageAPI/endpoints";
-import { transformerFunctionSchema } from "../transformers/ITransformerFunction";
+import { transformerFunctionSchema, } from "../transformers/ITransformerFunction";
 import { handoverSettingsSchema } from "../handover";
 import { entityMetaSchema } from "./IEntityMeta";
-import { translationSettingsEndpointSchema } from "../IEndpointTranslationSettings";
-import { fileStorageSettingsSchema } from '../fileStorage';
+import { translationSettingsEndpointSchema, } from "../IEndpointTranslationSettings";
+import { fileStorageSettingsSchema } from "../fileStorage";
 export const endpointDataSchema = {
     title: "endpointDataSchema",
     type: "object",
@@ -14,16 +14,17 @@ export const endpointDataSchema = {
         channel: { type: "string", format: "endpoint-channel" },
         dashbotApikey: { type: "string" },
         dashbotPlatform: { type: "string" },
+        customIcon: { type: "string" },
         flowId: {
             oneOf: [
                 { type: "string", format: "uuid" },
-                { type: "string", enum: [""] }
+                { type: "string", enum: [""] },
             ],
         },
         localeId: {
             oneOf: [
                 { type: "string", format: "uuid" },
-                { type: "string", enum: [""] }
+                { type: "string", enum: [""] },
             ],
         },
         entrypoint: { type: ["string", "null"], format: "mongo-id" },
@@ -35,7 +36,7 @@ export const endpointDataSchema = {
             oneOf: [
                 { type: "string", format: "uuid" },
                 { type: "string", format: "nlu-connector-type" },
-            ]
+            ],
         },
         settings: anyEndpointSettingsSchema,
         transformer: transformerFunctionSchema,
@@ -50,7 +51,26 @@ export const endpointDataSchema = {
         overrideSnapshotConnections: { type: "boolean" },
         fileStorageSettings: fileStorageSettingsSchema,
         disableInputSanitization: { type: "boolean" },
-        disableSkipUriTags: { type: "boolean" }
+        disableSkipUriTags: { type: "boolean" },
+        webrtcClient: { type: "boolean" },
+        sipConnectivityInfo: {
+            type: "object",
+            properties: {
+                realm: { type: "string" },
+                username: { type: "string" },
+                password: { type: "string" },
+                applicationSid: { type: "string" },
+                clientSid: { type: "string" },
+                wsUri: { type: "string" },
+            },
+        },
+        webrtcWidgetConfig: {
+            type: "object",
+            properties: {
+                label: { type: "string" },
+                active: { type: "boolean" },
+            },
+        },
     },
 };
 export const endpointSchema = {

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

@@ -0,0 +1,13 @@
+export const sipConnectivityInfoSchema = {
+    title: "sipConnectivityInfoSchema",
+    type: "object",
+    properties: {
+        realm: { type: "string" },
+        username: { type: "string" },
+        password: { type: "string" },
+        applicationSid: { type: "string" },
+        wsUri: { type: "string" },
+        clientSid: { type: "string" },
+    },
+};
+//# sourceMappingURL=ISipConnectivityInfo.js.map

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

@@ -0,0 +1,9 @@
+export const webrtcWidgetConfigSchema = {
+    title: "webrtcWidgetConfigSchema",
+    type: "object",
+    properties: {
+        label: { type: "string" },
+        active: { type: "boolean" },
+    },
+};
+//# sourceMappingURL=IWebrtcWidgetConfig.js.map

package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IConversationCounterPreAggregatedValue_3_0.js

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

package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IGetConversationCounterOrganisationRest_3_0.js

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

package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IGetConversationCounterRest_3_0.js

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

package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/index.js

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

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

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

package/dist/esm/shared/json-schema.js

@@ -15,6 +15,7 @@ export const ajvFormats = [
     "uuid",
     "json-pointer",
     "json-pointer-uri-fragment",
-    "relative-json-pointer"
+    "relative-json-pointer",
+    "data-uri"
 ];
 //# sourceMappingURL=json-schema.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "4.99.0",
+	"version": "2025.10.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",