@cognigy/rest-api-client 4.98.0 → 4.100.0

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/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,25 @@ 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" },
+            },
+        },
     },
 };
 export const endpointSchema = {

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

@@ -11,6 +11,14 @@ export const anthropicMetaSchema = {
         customModel: { type: ["string", "null"] }
     }
 };
+export const mistralMetaSchema = {
+    title: "mistralMetaSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        customModel: { type: ["string", "null"] }
+    }
+};
 export const awsBedrockMetaSchema = {
     title: "awsBedrockMetaSchema",
     type: "object",
@@ -129,6 +137,7 @@ export const largeLanguageModelDataSchema = {
         googleGemini: googleGeminiMetaSchema,
         alephAlpha: alephAlphaMetaSchema,
         anthropic: anthropicMetaSchema,
+        mistral: mistralMetaSchema,
         awsBedrock: awsBedrockMetaSchema,
         fallbacks: llmFallbackSchema,
         resourceLevel: { type: "string", enum: ["organisation", "project"] },

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,8 @@
+export const webrtcWidgetConfigSchema = {
+    title: "webrtcWidgetConfigSchema",
+    type: "object",
+    properties: {
+        label: { type: "string" },
+    },
+};
+//# 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/restAPI/opsCenter/alerts/IIndexOpsCenterAlertsRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/alerts/IOpsCenterAlert.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/component/IOpsCenterComponents.js

@@ -0,0 +1,31 @@
+// This is a copy of the Component in the service-sentinel/opsCenter
+export const arrayOfTMainComponent = ["VoiceGateway", "Endpoint", "Flow", "HandoverProvider"];
+/**
+ * Each main component has a set of subcomponents and Errors and Alerts
+ * are also tagged with a respective subcomponents.
+ */
+export const arrayOfTVoiceGatewaySubComponent = ["SpeechToText", "TextToSpeech"];
+export const arrayOfTEndpointSubComponent = [
+    "InputTransformer",
+    "OutputTransformer",
+    "ExecutionFinishedTransformer",
+    "InjectTransformer",
+    "NotifyTransformer",
+    "RealtimeTranslation",
+    "MessageRoundtrip",
+];
+export const arrayOfTFlowSubComponent = [
+    "FlowNodeExecution",
+    "NaturalLanguageUnderstanding",
+    "OutboundHTTPCalls",
+    "LargeLanguageModelCalls",
+    "KnowledgeAIQueries",
+];
+export const arrayOfTHandoverProviderSubComponent = ["OutboundHTTPCalls"];
+export const arrayOfTSubComponent = [
+    ...arrayOfTVoiceGatewaySubComponent,
+    ...arrayOfTEndpointSubComponent,
+    ...arrayOfTFlowSubComponent,
+    ...arrayOfTHandoverProviderSubComponent,
+];
+//# sourceMappingURL=IOpsCenterComponents.js.map

package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IDeleteOpsCenterErrorRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IGetOpsCenterErrorRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IIndexOpsCenterErrorsRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IOpsCenterError.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetrics.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsConfigRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsRangeRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IOpsCenterMetricsConfig.js

@@ -0,0 +1,5 @@
+const chartTypes = ["bar-chart", "heat-map", "line-chart", "alerts-errors", "health-status-monitor"];
+const segmentConfigArray = ["voice-gateway", "endpoints", "flows", "overview", "handover-provider"];
+const availableColorsArray = ["default", "blue", "yellow", "green", "purple", "red"];
+export {};
+//# sourceMappingURL=IOpsCenterMetricsConfig.js.map

package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IGetOpsCenterObservationConfigRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IOpsCenterObservationConfig.js

@@ -0,0 +1,3 @@
+const notificationChannels = ["email"];
+export {};
+//# sourceMappingURL=IOpsCenterObservationConfig.js.map

package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IPatchOpsCenterObservationConfigRest_2_0.js

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

package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/ISetupOpsCenterObservationConfigRest_2_0.js

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

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

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

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

@@ -22,6 +22,7 @@ export const samlIdentityProviderDataSchema = {
         idpLoginEndpoint: { type: "string", minLength: 1, maxLength: 5000 },
         idpLogoutEndpoint: { type: "string", minLength: 1, maxLength: 5000 },
         idpCertificate: { type: "string", minLength: 1, maxLength: 15000 },
+        wantAuthnResponseSigned: { type: "boolean" },
         decryptionPrivateKey: { type: "string", minLength: 1, maxLength: 15000 },
         idpDisableRequestedAuthnContext: { type: "boolean" },
     }

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.98.0",
+	"version": "4.100.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",