@cognigy/rest-api-client 0.13.2 → 0.15.0

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEND_METADATA = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const sendMetadata_mapper_1 = require("../mappers/sendMetadata.mapper");
+exports.SEND_METADATA = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "sendMetadata",
+    defaultLabel: "Send Metadata",
+    summary: "UI__NODE_EDITOR__SEND_METADATA__SUMMARY",
+    tags: ["voice"],
+    fields: [
+        {
+            key: "metadata",
+            label: "UI__NODE_EDITOR__SEND_METADATA__FIELDS__METADATA__LABEL",
+            type: "json",
+            defaultValue: { myParamName: "myParamValue" },
+            params: {
+                require: true,
+            },
+            description: "UI__NODE_EDITOR__SEND_METADATA__FIELDS__METADATA__DESCRIPTION"
+        }
+    ],
+    appearance: {
+        color: design_1.nodeColor,
+    },
+    form: [
+        {
+            type: "field",
+            key: "metadata"
+        }
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api, input } = cognigy;
+        const { endpointType } = input;
+        if (!config.metadata)
+            return;
+        try {
+            api.say(null, {
+                _cognigy: sendMetadata_mapper_1.sendMetadata.handleInput(endpointType, config.metadata)
+            });
+        }
+        catch (error) {
+            api.log("error", error.message);
+        }
+        ;
+    },
+});
+//# sourceMappingURL=sendMetadata.js.map

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

@@ -21,22 +21,160 @@ exports.voiceConfigFields = [
         key: "sttLanguage",
         type: "sttSelect",
         defaultValue: "",
-        label: "_unused_"
+        label: "_unused_",
     },
     {
         key: "sttHints",
         type: "textArray",
-        label: "STT Hints",
-        description: "Array of words or phrases to assist speech detection",
-        defaultValue: [""]
+        label: "UI__NODE_EDITOR__STT_HINTS__LABEL",
+        description: "UI__NODE_EDITOR__STT_HINTS__DESCRIPTION",
+        defaultValue: [""],
+        condition: {
+            or: [
+                {
+                    key: "sttVendor",
+                    value: "microsoft",
+                },
+                {
+                    key: "sttVendor",
+                    value: "google",
+                },
+                {
+                    key: "sttVendor",
+                    value: "aws",
+                },
+                {
+                    key: "sttVendor",
+                    value: "soniox"
+                }
+            ]
+        }
+    },
+    {
+        key: "sttHintsDynamicHints",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__STT_HINTS_DYNAMIC_HINTS__LABEL",
+        description: "UI__NODE_EDITOR__STT_HINTS_DYNAMIC_HINTS__DESCRIPTION",
+        defaultValue: "",
+        condition: {
+            or: [
+                {
+                    key: "sttVendor",
+                    value: "microsoft",
+                },
+                {
+                    key: "sttVendor",
+                    value: "google",
+                },
+                {
+                    key: "sttVendor",
+                    value: "aws",
+                },
+                {
+                    key: "sttVendor",
+                    value: "soniox"
+                }
+            ]
+        }
     },
     {
         key: "sttDisablePunctuation",
         type: "toggle",
-        label: "Disable STT Punctuation",
-        description: "Prevents the STT response from the bot to include punctuation marks",
+        label: "UI__NODE_EDITOR__STT_DISABLE_PUNCTUATION__LABEL",
+        description: "UI__NODE_EDITOR__STT_DISABLE_PUNCTUATION__DESCRIPTION",
+        defaultValue: false,
+        condition: {
+            or: [
+                {
+                    key: "sttVendor",
+                    value: "microsoft",
+                },
+                {
+                    key: "sttVendor",
+                    value: "google",
+                },
+                {
+                    key: "sttVendor",
+                    value: "aws",
+                },
+            ]
+        }
+    },
+    {
+        key: "enableAdvancedSTTConfig",
+        type: "toggle",
+        label: "UI__NODE_EDITOR__ENABLE_ADVANCED_STT_CONFIG__LABEL",
+        description: "UI__NODE_EDITOR__ENABLE_ADVANCED_STT_CONFIG__DESCRIPTION",
         defaultValue: false
     },
+    {
+        key: "azureSttContextId",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__AZURE_STT_CONTEXT_ID__LABEL",
+        description: "UI__NODE_EDITOR__AZURE_STT_CONTEXT_ID__DESCRIPTION",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "azureEnableAudioLogging",
+        type: "toggle",
+        label: "UI__NODE_EDITOR__AZURE_ENABLE_AUDIO_LOGGING__LABEL",
+        description: "UI__NODE_EDITOR__AZURE_ENABLE_AUDIO_LOGGING__DESCRIPTION",
+        defaultValue: false,
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedSTTConfig",
+                    value: true
+                },
+                {
+                    key: "sttVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
+    {
+        key: "enableAdvancedTTSConfig",
+        type: "toggle",
+        label: "UI__NODE_EDITOR__ENABLE_ADVANCED_TTS_CONFIG__LABEL",
+        description: "UI__NODE_EDITOR__ENABLE_ADVANCED_TTS_CONFIG__DESCRIPTION",
+        defaultValue: false,
+        condition: {
+            key: "ttsVendor",
+            value: "microsoft"
+        }
+    },
+    {
+        key: "azureTtsDeploymentId",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__AZURE_TTS_DEPLOYMENT_ID__LABEL",
+        description: "UI__NODE_EDITOR__AZURE_TTS_DEPLOYMENT_ID__DESCRIPTION",
+        defaultValue: "",
+        condition: {
+            and: [
+                {
+                    key: "enableAdvancedTTSConfig",
+                    value: true
+                },
+                {
+                    key: "ttsVendor",
+                    value: "microsoft"
+                }
+            ]
+        }
+    },
     {
         key: "ttsVendor",
         defaultValue: "",
@@ -64,29 +202,37 @@ exports.voiceConfigFields = [
 exports.SESSION_SPEECH_PARAMETERS = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "sessionSpeechParameters",
     defaultLabel: "Session Speech Parameters - Config",
-    summary: "Change configuration settings for the call session",
+    summary: "UI__NODE_EDITOR__SESSION_SPEECH_PARAMETERS__SUMMARY",
     appearance: {
-        color: design_1.nodeColor
+        color: design_1.nodeColor,
     },
-    tags: ['voice'],
+    tags: ["voice"],
     fields: exports.voiceConfigFields,
     sections: [
         {
             key: "params_stt",
-            label: "Recognizer (STT)",
+            label: "UI__NODE_EDITOR__SESSION_SPEECH_PARAMETERS__SECTIONS__PARAMS_STT__LABEL",
             defaultCollapsed: true,
-            fields: ["sttVendor", "sttHints", "sttDisablePunctuation"]
+            fields: [
+                "sttVendor",
+                "sttHints",
+                "sttHintsDynamicHints",
+                "sttDisablePunctuation",
+                "enableAdvancedSTTConfig",
+                "azureSttContextId",
+                "azureEnableAudioLogging",
+            ],
         },
         {
             key: "params_tts",
-            label: "Synthesizer (TTS)",
+            label: "UI__NODE_EDITOR__SESSION_SPEECH_PARAMETERS__SECTIONS__PARAMS_TTS__LABEL",
             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 +240,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

@@ -21,36 +21,36 @@ exports.TRANSFER_VOICE = (0, createNodeDescriptor_1.createNodeDescriptor)({
     fields: [
         {
             key: "transferReason",
-            label: "Reason",
+            label: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__TRANSFER_REASON__LABEL",
             type: "cognigyText",
             params: {
                 required: true,
             },
-            description: "Reason for transfer.",
+            description: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__TRANSFER_REASON__DESCRIPTION",
             defaultValue: "Bot initiated transfer.",
         },
         {
             key: "referTo",
-            label: "Target",
+            label: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__REFER_TO__LABEL",
             type: "cognigyText",
             params: {
                 required: true,
             },
-            description: "E.164 syntax or a SIP URI are supported",
+            description: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__REFER_TO__DESCRIPTION",
             defaultValue: "+49123456789",
         },
         {
             key: "useTransferSipHeaders",
-            label: "Custom Transfer SIP Headers",
+            label: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__USE_TRANSFER_SIP_HEADERS__LABEL",
             type: "toggle",
-            description: "Add data to be sent as SIP headers in the generated SIP message",
+            description: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__USE_TRANSFER_SIP_HEADERS__DESCRIPTION",
             defaultValue: false,
         },
         {
             key: "transferSipHeaders",
-            label: "Transfer SIP Headers",
+            label: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__TRANSFER_SIP_HEADERS__LABEL",
             type: "json",
-            description: "The data to be sent as SIP headers in the generated SIP message",
+            description: "UI__NODE_EDITOR__TRANSFER_REASON__FIELDS__TRANSFER_SIP_HEADERS__DESCRIPTION",
             defaultValue: {
                 "X-Custom-Header": "YourValue",
             },
@@ -63,7 +63,7 @@ exports.TRANSFER_VOICE = (0, createNodeDescriptor_1.createNodeDescriptor)({
     sections: [
         {
             key: "advanced",
-            label: "Advanced",
+            label: "UI__NODE_EDITOR__TRANSFER_REASON__SECTIONS__ADVANCED__LABEL",
             defaultCollapsed: true,
             fields: ["useTransferSipHeaders", "transferSipHeaders"],
         },
@@ -82,7 +82,7 @@ exports.TRANSFER_VOICE = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "advanced",
         },
     ],
-    summary: "Transfers the call to another target",
+    summary: "UI__NODE_EDITOR__TRANSFER__SUMMARY",
     function: async ({ cognigy, config }) => {
         const { api, input } = cognigy;
         const { referTo, useTransferSipHeaders, transferSipHeaders, transferReason, } = config;
@@ -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

@@ -8,7 +8,7 @@ const design_1 = require("../utils/design");
 exports.agentAssistNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "agentAssist",
     defaultLabel: "Agent Assist",
-    summary: "Configures Agent Assist capabilities",
+    summary: "UI__NODE_EDITOR__AGENT_ASSIST__SUMMARY",
     preview: {
         key: "activity",
         type: "text"
@@ -16,38 +16,38 @@ exports.agentAssistNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     fields: [
         {
             key: "activity",
-            label: "Activity",
+            label: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__ACTIVITY__LABEL",
             type: "select",
-            description: "Whether to start or stop the recognition of inputs by VG",
+            description: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__ACTIVITY__DESCRIPTION",
             defaultValue: "startRecognition",
             params: {
                 options: [
-                    { value: "startRecognition", label: "Start Recognition" },
-                    { value: "stopRecognition", label: "Stop Recognition" },
+                    { value: "startRecognition", label: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__ACTIVITY__OPTIONS__START_RECOGNITION" },
+                    { value: "stopRecognition", label: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__ACTIVITY__OPTIONS__STOP_RECOGNITION" },
                 ]
             }
         },
         {
             key: "targetParticipant",
-            label: "Target Participant",
+            label: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__TARGET_PARTICIPANT__LABEL",
             type: "select",
-            description: "Who to apply the setting to",
+            description: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__TARGET_PARTICIPANT__DESCRIPTION",
             defaultValue: "both",
             params: {
                 options: [
-                    { value: "both", label: "Caller && Callee (Agent)" },
-                    { value: "caller", label: "Caller only" },
-                    { value: "callee", label: "Callee (Agent) only" },
+                    { value: "both", label: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__TARGET_PARTICIPANT__OPTIONS__BOTH" },
+                    { value: "caller", label: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__TARGET_PARTICIPANT__OPTIONS__CALLER" },
+                    { value: "callee", label: "UI__NODE_EDITOR__AGENT_ASSIST__FIELDS__TARGET_PARTICIPANT__OPTIONS__CALLEE" },
                 ]
             }
-        }
+        },
     ],
     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/voicegateway/nodes/callRecording.js

@@ -8,111 +8,113 @@ const design_1 = require("../utils/design");
 exports.callRecordingNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "callRecording",
     defaultLabel: "Call Recording",
-    summary: "Configures Call Recording capabilities",
+    summary: "UI__NODE_EDITOR__CALL_RECORDING__SUMMARY",
     fields: [
         {
             key: "activity",
-            label: "Activity",
+            label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__ACTIVITY__LABEL",
             type: "select",
-            description: "Whether to start or stop the recording of audio",
+            description: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__ACTIVITY__DESCRIPTION",
             defaultValue: "startRecording",
             params: {
                 options: [
-                    { value: "startCallRecording", label: "Start Call Recording" },
-                    { value: "stopCallRecording", label: "Stop Call Recording" },
-                    { value: "pauseCallRecording", label: "Pause Call Recording" },
-                    { value: "resumeCallRecording", label: "Resume Call Recording" },
-                ]
-            }
+                    { value: "startCallRecording", label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__ACTIVITY__OPTIONS__START_CALL_RECORDING" },
+                    { value: "stopCallRecording", label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__ACTIVITY__OPTIONS__STOP_CALL_RECORDING" },
+                    { value: "pauseCallRecording", label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__ACTIVITY__OPTIONS__PAUSE_CALL_RECORDING" },
+                    { value: "resumeCallRecording", label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__ACTIVITY__OPTIONS__RESUME_CALL_RECORDING" },
+                ],
+            },
         },
         {
             key: "callRecordingServer",
-            label: "Call Recording Server",
+            label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__CALL_RECORDING_SERVER__LABEL",
             type: "cognigyText",
-            description: "Defines the SRS as an IP Group name (as configured on the SBC) to record the call.",
+            description: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__CALL_RECORDING_SERVER__DESCRIPTION",
             defaultValue: "",
             params: {
-                required: true
-            }
+                required: true,
+            },
+            condition: {
+                key: "activity",
+                value: "startCallRecording",
+            },
         },
         {
             key: "callRecordingId",
-            label: "Call Recording ID",
-            description: "Defines the recording ID session, which is forwarded by the SBC to the SRS",
+            label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__CALL_RECORDING_ID__LABEL",
+            description: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__CALL_RECORDING_ID__DESCRIPTION",
             type: "cognigyText",
             defaultValue: "",
             params: {
-                required: true
+                required: true,
             },
             condition: {
                 key: "activity",
-                value: "startCallRecording"
-            }
+                value: "startCallRecording",
+            },
         },
         {
             key: "callRecordingDestUsername",
-            label: "Destination Username",
-            description: "Defines the username that is used in the SIP Request-URI and To headers of the INVITE",
+            label: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__CALL_RECORDING_DEST_USERNAME__LABEL",
+            description: "UI__NODE_EDITOR__CALL_RECORDING__FIELDS__CALL_RECORDING_DEST_USERNAME__DESCRIPTION",
             type: "cognigyText",
             defaultValue: "",
             params: {
-                required: true
-            }
-        }
+                required: true,
+            },
+            condition: {
+                key: "activity",
+                value: "startCallRecording",
+            },
+        },
     ],
     appearance: {
-        color: design_1.nodeColor
+        color: design_1.nodeColor,
     },
     preview: {
         key: "activity",
-        type: "text"
+        type: "text",
     },
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
-        const { activity, callRecordingDestUsername, callRecordingId, callRecordingServer } = config;
-        if (callRecordingServer && callRecordingId && callRecordingDestUsername) {
-            let activities = [];
-            switch (activity) {
-                case "startCallRecording":
+        const { activity, callRecordingDestUsername, callRecordingId, callRecordingServer, } = config;
+        let activities = [];
+        switch (activity) {
+            case "startCallRecording":
+                if (callRecordingId &&
+                    callRecordingServer &&
+                    callRecordingDestUsername) {
                     activities.push({
                         type: "event",
-                        name: "startCallRecording",
+                        name: activity,
                         activityParams: {
                             callRecordingId,
                             callRecordingDestUsername,
-                            callRecordingServer
-                        }
+                            callRecordingServer,
+                        },
                     });
-                    break;
-                case "stopCallRecording":
-                    activities.push({
-                        type: "event",
-                        name: "stopCallRecording",
-                    });
-                    break;
-                case "pauseCallRecording":
-                    activities.push({
-                        type: "event",
-                        name: "pauseCallRecording",
-                    });
-                    break;
-                case "resumeCallRecording":
-                    activities.push({
-                        type: "event",
-                        name: "resumeCallRecording",
-                    });
-                    break;
-            }
-            api.output(null, {
-                "_cognigy": {
-                    "_voiceGateway": {
-                        "json": {
-                            activities
-                        }
-                    }
                 }
-            });
+                break;
+            case "pauseCallRecording":
+            case "resumeCallRecording":
+            case "stopCallRecording":
+                activities.push({
+                    type: "event",
+                    name: activity,
+                });
+                break;
+            default:
+                api.log("error", "Invalid activity");
         }
-    }
+        api.output(null, {
+            _cognigy: {
+                _voiceGateway: {
+                    json: {
+                        activities,
+                    },
+                },
+            },
+        });
+    },
 });
 //# sourceMappingURL=callRecording.js.map