@cognigy/rest-api-client 0.11.0 → 0.13.0

package/build/shared/interfaces/messageAPI/endpoints.js

@@ -1,8 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chatwootEndpointSettingsSchema = exports.ringCentralEngageEndpointSettingsSchema = exports.avayaEndpointSettingsSchema = exports.AMAZON_POLLY_LANGUAGE_MAPPING = exports.workplaceEndpointSettingsSchema = exports.anyEndpointSettingsSchema = exports.webchatPersistentMenuSchema = void 0;
+exports.eightByEightEndpointSettingsSchema = exports.whatsAppEndpointSettingsSchema = exports.liveAgentEndpointSettingsSchema = exports.chatwootEndpointSettingsSchema = exports.ringCentralEngageEndpointSettingsSchema = exports.avayaEndpointSettingsSchema = exports.AMAZON_POLLY_LANGUAGE_MAPPING = exports.workplaceEndpointSettingsSchema = exports.dashbotPlatform = exports.anyEndpointSettingsSchema = exports.avayaGatherLanguages = exports.avayaSttTtsLanguages = exports.webchatPersistentMenuSchema = exports.endpointTypes = void 0;
 /* Interfaces & Types */
 const alexa_1 = require("../alexa");
+exports.endpointTypes = [
+    "facebook",
+    "workplace",
+    "alexa",
+    "slack",
+    "google",
+    "webhook",
+    "rest",
+    "abstractRest",
+    "socket",
+    "adminconsole",
+    "webchat2",
+    "dialogflow",
+    "twilio",
+    "twilioSms",
+    "twilioAutopilot",
+    "line",
+    "intercom",
+    "microsoftBotFramework",
+    "microsoftTeams",
+    "sunshineConversations",
+    "userlike",
+    "ringCentralEngage",
+    "audioCodes",
+    "avaya",
+    "nonConversational",
+    "voiceGateway2",
+    "whatsapp",
+    "amazonLex",
+    "eightByEight"
+];
 exports.webchatPersistentMenuSchema = {
     title: "webchatPersistentMenuSchema",
     type: "object",
@@ -22,10 +53,158 @@ exports.webchatPersistentMenuSchema = {
         }
     }
 };
+exports.avayaSttTtsLanguages = [
+    "cy-GB",
+    "da-DK",
+    "de-DE",
+    "en-AU",
+    "en-GB",
+    "en-GB-WLS",
+    "en-IN",
+    "en-US",
+    "es-ES",
+    "es-US",
+    "fr-CA",
+    "fr-FR",
+    "is-IS",
+    "it-IT",
+    "ja-JP",
+    "nb-NO",
+    "nl-NL",
+    "pl-PL",
+    "pt-BR",
+    "pt-PT",
+    "ro-RO",
+    "ru-RU",
+    "sv-SE",
+    "tr-TR"
+];
+exports.avayaGatherLanguages = [
+    "af-ZA",
+    "am-ET",
+    "hy-AM",
+    "az-AZ",
+    "id-ID",
+    "ms-MY",
+    "bn-BD",
+    "bn-IN",
+    "ca-ES",
+    "cs-CZ",
+    "da-DK",
+    "de-DE",
+    "en-AU",
+    "en-CA",
+    "en-GH",
+    "en-GB",
+    "en-IN",
+    "en-IE",
+    "en-KE",
+    "en-NZ",
+    "en-NG",
+    "en-PH",
+    "en-ZA",
+    "en-TZ",
+    "en-US",
+    "es-AR",
+    "es-BO",
+    "es-CL",
+    "es-CO",
+    "es-CR",
+    "es-EC",
+    "es-SV",
+    "es-ES",
+    "es-US",
+    "es-GT",
+    "es-HN",
+    "es-MX",
+    "es-NI",
+    "es-PA",
+    "es-PY",
+    "es-PE",
+    "es-PR",
+    "es-DO",
+    "es-UY",
+    "es-VE",
+    "eu-ES",
+    "il-PH",
+    "fr-CA",
+    "fr-FR",
+    "gl-ES",
+    "ka-GE",
+    "gu-IN",
+    "hr-HR",
+    "zu-ZA",
+    "is-IS",
+    "it-IT",
+    "jv-ID",
+    "kn-IN",
+    "km-KH",
+    "lo-LA",
+    "lv-LV",
+    "lt-LT",
+    "hu-HU",
+    "ml-IN",
+    "mr-IN",
+    "nl-NL",
+    "ne-NP",
+    "nb-NO",
+    "pl-PL",
+    "pt-BR",
+    "pt-PT",
+    "ro-RO",
+    "si-LK",
+    "sk-SK",
+    "sl-SI",
+    "su-ID",
+    "sw-TZ",
+    "sw-KE",
+    "fi-FI",
+    "sv-SE",
+    "ta-IN",
+    "ta-SG",
+    "ta-LK",
+    "ta-MY",
+    "te-IN",
+    "vi-VN",
+    "tr-TR",
+    "ur-PK",
+    "ur-IN",
+    "el-GR",
+    "bg-BG",
+    "ru-RU",
+    "sr-RS",
+    "uk-UA",
+    "he-IL",
+    "ar-IL",
+    "ar-JO",
+    "ar-AE",
+    "ar-BH",
+    "ar-DZ",
+    "ar-SA",
+    "ar-IQ",
+    "ar-KW",
+    "ar-MA",
+    "ar-TN",
+    "ar-OM",
+    "ar-PS",
+    "ar-QA",
+    "ar-LB",
+    "ar-EG",
+    "fa-IR",
+    "hi-IN",
+    "th-TH",
+    "ko-KR",
+    "cmn-Hant-TW",
+    "yue-Hant-HK",
+    "ja-JP",
+    "cmn-Hans-HK",
+    "cmn-Hans-CN",
+];
 exports.anyEndpointSettingsSchema = {
     title: "anyEndpointSettingsSchema",
     type: "object",
     properties: {
+        action: { type: "string" },
         accessToken: { type: "string" },
         appId: { type: "string" },
         appSecret: { type: "string" },
@@ -34,29 +213,63 @@ exports.anyEndpointSettingsSchema = {
         basicAuthUser: { type: "string" },
         botUserId: { type: "string" },
         colorScheme: { type: "string" },
+        connectionName: { type: "string" },
+        cpaasToken: { type: "string" },
+        customJSON: { type: "string" },
         designTemplate: { type: "integer" },
-        displayGetStartedButton: { type: "boolean" },
+        disableHtmlContentSanitization: { type: "boolean" },
+        disableInputAutocomplete: { type: "boolean" },
+        disableUrlButtonSanitization: { type: "boolean" },
+        enableAsyncCommunication: { 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" },
         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: [...exports.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" },
+        language: {
+            type: "string",
+            enum: [...exports.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" },
@@ -66,13 +279,40 @@ exports.anyEndpointSettingsSchema = {
         sunshineConversationsChannelSecret: { type: "string" },
         sunshineConversationsChannelUri: { type: "string", format: "uri" },
         sunshineConversationsApiVersion: { type: "string", enum: ["v1.1", "v2"] },
+        timeout: { type: "integer" },
         updateContactProfileWithFacebookProfile: { type: "boolean" },
         voice: { type: "string" },
         webhookUrl: { type: "string", format: "uri" },
+        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: alexa_1.skillSchema,
-        persistentMenu: exports.webchatPersistentMenuSchema
+        persistentMenu: exports.webchatPersistentMenuSchema,
+        shouldOverwriteWebchatBundleUrl: { type: "boolean" },
+        overwriteWebchatBundleUrl: { type: "string" }
     }
 };
+exports.dashbotPlatform = [
+    "facebook",
+    "whatsapp",
+    "alexa",
+    "google",
+    "slack",
+    "microsoftBotFramework",
+    "webchat",
+    "universal",
+    "eightByEight"
+];
 exports.workplaceEndpointSettingsSchema = {
     title: "workplaceEndpointSettingsSchema",
     additionalProperties: false,
@@ -101,7 +341,8 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
     "en-AU": [
         { voice: "Alice", gender: "female" },
         { voice: "Polly.Nicole", gender: "female" },
-        { voice: "Polly.Russell", gender: "male" }
+        { voice: "Polly.Russell", gender: "male" },
+        { voice: "Polly.Olivia-Neural", gender: "female" },
     ],
     "en-CA": [
         { voice: "Alice", gender: "female" }
@@ -114,6 +355,7 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
     ],
     "en-IN": [
         { voice: "Alice", gender: "female" },
+        { voice: "Aditi", gender: "female" },
         { voice: "Polly.Raveena", gender: "female" }
     ],
     "en-US": [
@@ -125,7 +367,15 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
         { voice: "Polly.Kendra", gender: "female" },
         { voice: "Polly.Kimberly", gender: "female" },
         { voice: "Polly.Matthew", gender: "male" },
-        { voice: "Polly.Salli", gender: "female" }
+        { voice: "Polly.Salli", gender: "female" },
+        { voice: "Polly.Ivy-Neural", gender: "female" },
+        { voice: "Polly.Joanna-Neural", gender: "female" },
+        { voice: "Polly.Joey-Neural", gender: "male" },
+        { voice: "Polly.Justin-Neural", gender: "male" },
+        { voice: "Polly.Kendra-Neural", gender: "female" },
+        { voice: "Polly.Kimberly-Neural", gender: "female" },
+        { voice: "Polly.Matthew-Neural", gender: "male" },
+        { voice: "Polly.Salli-Neural", gender: "female" }
     ],
     "ca-ES": [
         { voice: "Alice", gender: "female" }
@@ -133,10 +383,12 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
     "es-ES": [
         { voice: "Alice", gender: "female" },
         { voice: "Polly.Conchita", gender: "female" },
-        { voice: "Polly.Enrique", gender: "male" }
+        { voice: "Polly.Enrique", gender: "male" },
+        { voice: "Polly.Lucia", gender: "female" }
     ],
     "es-MX": [
-        { voice: "Alice", gender: "female" }
+        { voice: "Alice", gender: "female" },
+        { voice: "Polly.Mia", gender: "female" }
     ],
     "fi-FI": [
         { voice: "Alice", gender: "female" }
@@ -148,10 +400,12 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
     "fr-FR": [
         { voice: "Alice", gender: "female" },
         { voice: "Polly.Céline/Polly.Celine", gender: "female" },
+        { voice: "Polly.Léa/Polly.Lea", gender: "female" },
         { voice: "Polly.Mathieu", gender: "male" }
     ],
     "it-IT": [
         { voice: "Alice", gender: "female" },
+        { voice: "Polly.Bianca", gender: "female" },
         { voice: "Polly.Carla", gender: "female" },
         { voice: "Polly.Giorgio", gender: "male" }
     ],
@@ -161,7 +415,8 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
         { voice: "Polly.Takumi", gender: "male" }
     ],
     "ko-KR": [
-        { voice: "Alice", gender: "female" }
+        { voice: "Alice", gender: "female" },
+        { voice: "Polly.Seoyeon", gender: "female" }
     ],
     "nb-NO": [
         { voice: "Polly.Liv", gender: "female" }
@@ -181,7 +436,8 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
     "pt-BR": [
         { voice: "Alice", gender: "female" },
         { voice: "Polly.Ricardo", gender: "male" },
-        { voice: "Polly.Vitória/Polly.Vitoria", gender: "female" }
+        { voice: "Polly.Vitória/Polly.Vitoria", gender: "female" },
+        { voice: "Polly.Camila-Neural", gender: "female" }
     ],
     "pt-PT": [
         { voice: "Alice", gender: "female" },
@@ -207,8 +463,29 @@ exports.avayaEndpointSettingsSchema = {
         },
         language: {
             type: "string",
-            maxLength: 200
+            enum: [...exports.avayaSttTtsLanguages]
+        },
+        cpaasToken: { type: "string" },
+        input: {
+            type: "string",
+            enum: ["speech dtmf", "speech", "dtmf"]
+        },
+        hints: { type: "string" },
+        gatherLanguage: {
+            type: "string",
+            enum: [...exports.avayaGatherLanguages]
+        },
+        action: { type: "string" },
+        method: {
+            type: "string",
+            enum: ["", "GET", "POST"]
         },
+        timeout: { type: "integer", minimum: 0 },
+        finishOnKey: {
+            type: "string",
+            enum: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "*", "#"]
+        },
+        numDigits: { type: "integer", minimum: 0 },
     },
     additionalProperties: false
 };
@@ -264,4 +541,77 @@ exports.chatwootEndpointSettingsSchema = {
     },
     additionalProperties: false
 };
+exports.liveAgentEndpointSettingsSchema = {
+    type: "object",
+    properties: {
+        accountId: {
+            type: "string",
+            maxLength: 200
+        },
+        apiKey: {
+            type: "string",
+            maxLength: 1000
+        },
+        baseUrl: {
+            type: "string",
+            maxLength: 1000
+        },
+        usePlatformToken: {
+            type: "boolean"
+        }
+    },
+    additionalProperties: false
+};
+exports.whatsAppEndpointSettingsSchema = {
+    type: "object",
+    properties: {
+        phoneNumberId: {
+            type: "string",
+            maxLength: 200
+        },
+        appId: {
+            type: "string",
+            maxLength: 200
+        },
+        appSecret: {
+            type: "string",
+            maxLength: 200
+        },
+        bearerToken: {
+            type: "string",
+            maxLength: 1000
+        },
+        sessionExpiration: {
+            type: "number",
+            minimum: 0
+        },
+        messageDelay: {
+            type: "number",
+            minimum: 0
+        },
+        verifyToken: {
+            type: "string",
+            maxLength: 200
+        }
+    },
+    additionalProperties: false
+};
+exports.eightByEightEndpointSettingsSchema = {
+    type: "object",
+    properties: {
+        baseUrl: {
+            type: "string",
+            maxLength: 1000
+        },
+        apiKey: {
+            type: "string",
+            maxLength: 1000
+        },
+        sessionExpiration: {
+            type: "number",
+            minimum: 0
+        },
+    },
+    additionalProperties: false
+};
 //# sourceMappingURL=endpoints.js.map