@cognigy/rest-api-client 0.13.2 → 0.14.0

package/build/shared/charts/descriptors/voice/nodes/play.js

@@ -7,13 +7,15 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const play_mapper_1 = require("../mappers/play.mapper");
 const design_1 = require("../utils/design");
 const setSessionConfig_1 = require("../../voicegateway2/nodes/setSessionConfig");
-const fields = setSessionConfig_1.voiceConfigFields.map(field => {
+const fields = (setSessionConfig_1.voiceConfigFields.map(field => {
     if (field.key !== "sttDisablePunctuation" &&
         field.key !== "sttVadEnabled" &&
         field.key !== "sttVadMode" &&
-        field.key !== "sttVadVoiceMs")
+        field.key !== "sttVadVoiceMs") {
         return field;
-});
+    }
+    return null;
+})).filter(f => !!f);
 exports.PLAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "play",
     defaultLabel: "Play URL",
@@ -49,7 +51,7 @@ exports.PLAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttVendor", "sttHints"],
+            fields: ["sttVendor", "sttHints", "enableAdvancedSTTConfig", "azureSttContextId", "azureEnableAudioLogging"],
             condition: {
                 key: "setActivityParams",
                 value: true
@@ -74,14 +76,14 @@ exports.PLAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 key: "setActivityParams",
                 value: true
             }
-        }
+        },
     ],
     form: [
         { type: "field", key: "url" },
         { type: "field", key: "setActivityParams" },
         { type: "section", key: "params_stt" },
         { type: "section", key: "params_bargein" },
-        { type: "section", key: "params_dtmf" }
+        { type: "section", key: "params_dtmf" },
     ],
     summary: "Streams a media file into the call",
     function: async ({ cognigy, config }) => {

package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js

@@ -37,6 +37,81 @@ exports.voiceConfigFields = [
         description: "Prevents the STT response from the bot to include punctuation marks",
         defaultValue: false
     },
+    {
+        key: "enableAdvancedSTTConfig",
+        type: "toggle",
+        label: "Enable Advanced STT Config",
+        description: "Advanced STT Configuration",
+        defaultValue: false
+    },
+    {
+        key: "azureSttContextId",
+        type: "cognigyText",
+        label: "Azure STT Context ID",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "azureEnableAudioLogging",
+        type: "toggle",
+        label: "Enable Audio Logging",
+        description: "Enables recording and logging of audio from the user on Azure.",
+        defaultValue: false,
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "enableAdvancedTTSConfig",
+        type: "toggle",
+        label: "Enable Advanced TTS Config",
+        description: "Enable Advanced TTS Configuration",
+        defaultValue: false,
+        condition: {
+            key: "ttsVendor",
+            value: "microsoft"
+        }
+    },
+    {
+        key: "azureTtsDeploymentId",
+        type: "cognigyText",
+        label: "Azure Custom Voice Endpoint",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedTTSConfig",
+                    value: true
+                },
+                {
+                    key: "ttsVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
     {
         key: "ttsVendor",
         defaultValue: "",
@@ -66,27 +141,34 @@ exports.SESSION_SPEECH_PARAMETERS = (0, createNodeDescriptor_1.createNodeDescrip
     defaultLabel: "Session Speech Parameters - Config",
     summary: "Change configuration settings for the call session",
     appearance: {
-        color: design_1.nodeColor
+        color: design_1.nodeColor,
     },
-    tags: ['voice'],
+    tags: ["voice"],
     fields: exports.voiceConfigFields,
     sections: [
         {
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttVendor", "sttHints", "sttDisablePunctuation"]
+            fields: [
+                "sttVendor",
+                "sttHints",
+                "sttDisablePunctuation",
+                "enableAdvancedSTTConfig",
+                "azureSttContextId",
+                "azureEnableAudioLogging",
+            ],
         },
         {
             key: "params_tts",
             label: "Synthesizer (TTS)",
             defaultCollapsed: true,
-            fields: ["ttsVendor"]
-        }
+            fields: ["ttsVendor", "enableAdvancedTTSConfig", "azureTtsDeploymentId"],
+        },
     ],
     form: [
         { type: "section", key: "params_tts" },
-        { type: "section", key: "params_stt" }
+        { type: "section", key: "params_stt" },
     ],
     function: async ({ cognigy, config }) => {
         const { api, input } = cognigy;
@@ -94,12 +176,12 @@ exports.SESSION_SPEECH_PARAMETERS = (0, createNodeDescriptor_1.createNodeDescrip
         try {
             const payload = setSessionConfig_mapper_1.setSessionConfig.handleInput(endpointType, (0, setSessionConfig_mapper_1.voiceConfigParamsToVoiceSettings)(config, api));
             api.say(null, {
-                _cognigy: payload
+                _cognigy: payload,
             });
         }
         catch (error) {
             throw new Error(`Error on Session Speech Parameters node. Error message: ${error.message}`);
         }
-    }
+    },
 });
 //# sourceMappingURL=sessionSpeechParameters.js.map

package/build/shared/charts/descriptors/voice/nodes/transfer.js

@@ -93,8 +93,8 @@ exports.TRANSFER_VOICE = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 return;
             }
             const transferParams = {
-                transferReason: transferReason,
-                transferTarget: (0, helper_1.cleanTarget)(referTo),
+                transferReason,
+                transferTarget: referTo,
                 useTransferSipHeaders: useTransferSipHeaders,
                 transferSipHeaders: transferSipHeaders,
             };

package/build/shared/charts/descriptors/voice/utils/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidDTMF = void 0;
+exports.isValidPhoneNumber = exports.isValidUrl = exports.isValidDTMF = void 0;
 function isValidDTMF(dtmf) {
     if (dtmf.length !== 1)
         return false;
@@ -8,4 +8,14 @@ function isValidDTMF(dtmf) {
     return regex.test(dtmf);
 }
 exports.isValidDTMF = isValidDTMF;
+const isValidUrl = (url) => {
+    const regex = new RegExp("^(http|https)://");
+    return regex.test(url);
+};
+exports.isValidUrl = isValidUrl;
+const isValidPhoneNumber = (number) => {
+    const regex = /^\+{0,2}([\-\. ])?(\(?\d{0,3}\))?([\-\. ])?\(?\d{0,3}\)?([\-\. ])?\d{3}([\-\. ])?\d{4}/;
+    return regex.test(number);
+};
+exports.isValidPhoneNumber = isValidPhoneNumber;
 //# sourceMappingURL=helper.js.map

package/build/shared/charts/descriptors/voicegateway/nodes/agentAssist.js

@@ -40,14 +40,14 @@ exports.agentAssistNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     { value: "callee", label: "Callee (Agent) only" },
                 ]
             }
-        }
+        },
     ],
     appearance: {
         color: design_1.nodeColor
     },
     form: [
         { type: "field", key: "activity" },
-        { type: "field", key: "targetParticipant" }
+        { type: "field", key: "targetParticipant" },
     ],
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;

package/build/shared/charts/descriptors/voicegateway2/nodes/play.js

@@ -67,7 +67,10 @@ exports.playNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 "sttDisablePunctuation",
                 "sttVadEnabled",
                 "sttVadMode",
-                "sttVadVoiceMs"
+                "sttVadVoiceMs",
+                "enableAdvancedSTTConfig",
+                "azureSttContextId",
+                "azureEnableAudioLogging"
             ],
             condition: {
                 key: "setActivityParams",

package/build/shared/charts/descriptors/voicegateway2/nodes/refer.js

@@ -7,7 +7,6 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const transfer_mapper_1 = require("../../voice/mappers/transfer.mapper");
 const constants_1 = require("../utils/constants");
 const design_1 = require("../utils/design");
-const helper_1 = require("../utils/helper");
 exports.referNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "refer",
     defaultLabel: "Refer",
@@ -81,9 +80,10 @@ exports.referNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
         const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
         const transferParams = {
             transferReason: '',
-            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            transferTarget: referTo,
             useTransferSipHeaders,
-            transferSipHeaders
+            transferSipHeaders,
+            transferType: "refer",
         };
         try {
             const payload = transfer_mapper_1.transfer.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, transferParams, false);

package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js

@@ -126,13 +126,13 @@ exports.voiceConfigFields = [
         key: "ttsVoice",
         type: "ttsSelect",
         defaultValue: "",
-        label: "_unused_",
+        label: "_unused_"
     },
     {
         key: "ttsLanguage",
         type: "ttsSelect",
         defaultValue: "",
-        label: "_unused_",
+        label: "_unused_"
     },
     {
         key: "userNoInputMode",
@@ -143,13 +143,16 @@ exports.voiceConfigFields = [
         params: {
             options: [
                 {
-                    label: "Speak", value: "speech"
+                    label: "Speak",
+                    value: "speech"
                 },
                 {
-                    label: "Play File", value: "play"
+                    label: "Play File",
+                    value: "play"
                 },
                 {
-                    label: "Send Event", value: "event"
+                    label: "Send Event",
+                    value: "event"
                 }
             ]
         }
@@ -161,8 +164,8 @@ exports.voiceConfigFields = [
         description: "Define the timeout for user input in ms",
         defaultValue: 10000,
         params: {
-            min: 1000,
-        },
+            min: 1000
+        }
     },
     {
         key: "userNoInputRetries",
@@ -171,8 +174,8 @@ exports.voiceConfigFields = [
         description: "Define how often the bot should retry to get an input from a user before completing the call",
         defaultValue: 1,
         params: {
-            min: 0,
-        },
+            min: 0
+        }
     },
     {
         key: "userNoInputSpeech",
@@ -217,12 +220,12 @@ exports.voiceConfigFields = [
         defaultValue: 2000,
         params: {
             min: 1000,
-            max: 60000,
+            max: 60000
         },
         condition: {
             key: "dtmfEnable",
             value: true
-        },
+        }
     },
     {
         key: "dtmfMaxDigits",
@@ -231,7 +234,7 @@ exports.voiceConfigFields = [
         description: "Defines the maximum number of digits which can be entered by the user, the digits are being submitted automatically once this limit is reached",
         defaultValue: 1,
         params: {
-            min: 1,
+            min: 1
         },
         condition: {
             key: "dtmfEnable",
@@ -245,7 +248,7 @@ exports.voiceConfigFields = [
         description: "Defines the mininum number of digits before they are forwarded to the bot. This can be overridden by a submit digit",
         defaultValue: 1,
         params: {
-            min: 1,
+            min: 1
         },
         condition: {
             key: "dtmfEnable",
@@ -288,20 +291,99 @@ exports.voiceConfigFields = [
         description: "Defines the number of milliseconds of silence before the accumulated recognitions are send to the flow",
         defaultValue: 0,
         params: {
-            min: 0,
+            min: 0
         },
         condition: {
             key: "asrEnabled",
             value: true
         }
     },
+    {
+        key: "enableAdvancedSTTConfig",
+        type: "toggle",
+        label: "Enable Advanced STT Config",
+        description: "Advanced STT Configuration",
+        defaultValue: false,
+        condition: {
+            key: 'sttVendor',
+            value: 'microsoft'
+        }
+    },
+    {
+        key: "azureSttContextId",
+        type: "cognigyText",
+        label: "Azure STT Context ID",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "azureEnableAudioLogging",
+        type: "toggle",
+        label: "Enable Audio Logging",
+        description: "Enables recording and logging of audio from the user on Azure.",
+        defaultValue: false,
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "enableAdvancedTTSConfig",
+        type: "toggle",
+        label: "Enable Advanced TTS Config",
+        description: "Enable Advanced TTS Configuration",
+        defaultValue: false,
+        condition: {
+            key: "ttsVendor",
+            value: "microsoft",
+        }
+    },
+    {
+        key: "azureTtsDeploymentId",
+        type: "cognigyText",
+        label: "Azure Custom Voice Endpoint",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedTTSConfig",
+                    value: true
+                },
+                {
+                    key: "ttsVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    }
 ];
 exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "setSessionConfig",
     defaultLabel: "Set Session Config",
     summary: "Change configuration settings for the call session",
     appearance: {
-        color: design_1.nodeColor
+        color: design_1.nodeColor,
     },
     fields: exports.voiceConfigFields,
     sections: [
@@ -309,19 +391,29 @@ exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)(
             key: "params_stt",
             label: "Recognizer (STT)",
             defaultCollapsed: true,
-            fields: ["sttVendor", "sttHints", "sttDisablePunctuation", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"]
+            fields: [
+                "sttVendor",
+                "sttHints",
+                "sttDisablePunctuation",
+                "sttVadEnabled",
+                "sttVadMode",
+                "sttVadVoiceMs",
+                "enableAdvancedSTTConfig",
+                "azureSttContextId",
+                "azureEnableAudioLogging"
+            ],
         },
         {
             key: "params_tts",
             label: "Synthesizer (TTS)",
             defaultCollapsed: true,
-            fields: ["ttsVendor"]
+            fields: ["ttsVendor", "enableAdvancedTTSConfig", "azureTtsDeploymentId"],
         },
         {
             key: "params_bargein",
             label: "Barge In",
             defaultCollapsed: true,
-            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"]
+            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"],
         },
         {
             key: "params_user_timeouts",
@@ -332,21 +424,27 @@ exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)(
                 "userNoInputSpeech",
                 "userNoInputUrl",
                 "userNoInputTimeout",
-                "userNoInputRetries"
-            ]
+                "userNoInputRetries",
+            ],
         },
         {
             key: "params_dtmf",
             label: "DTMF",
             defaultCollapsed: true,
-            fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfMinDigits", "dtmfSubmitDigit"]
+            fields: [
+                "dtmfEnable",
+                "dtmfInterDigitTimeout",
+                "dtmfMaxDigits",
+                "dtmfMinDigits",
+                "dtmfSubmitDigit",
+            ],
         },
         {
             key: "params_continuous_asr",
             label: "Continuous ASR",
             defaultCollapsed: true,
             fields: ["asrEnabled", "asrDigit", "asrTimeout"],
-        }
+        },
     ],
     form: [
         { type: "section", key: "params_tts" },
@@ -355,18 +453,19 @@ exports.setSessionConfigNode = (0, createNodeDescriptor_1.createNodeDescriptor)(
         { type: "section", key: "params_user_timeouts" },
         { type: "section", key: "params_dtmf" },
         { type: "section", key: "params_continuous_asr" },
+        { type: "section", key: "params_azure_config" },
     ],
     function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
         try {
-            const payload = setSessionConfig_mapper_1.setSessionConfig.handleVGInput((0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, cognigy.api));
-            cognigy.api.say(null, {
+            const payload = setSessionConfig_mapper_1.setSessionConfig.handleVGInput((0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, api));
+            api.say(null, {
                 _cognigy: payload,
             });
         }
         catch (error) {
             throw new Error(`[VG2] Error on set session config node. Error message: ${error.message}`);
         }
-        ;
-    }
+    },
 });
 //# sourceMappingURL=setSessionConfig.js.map