@cognigy/rest-api-client 0.11.0 → 0.13.0

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

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_INPUT_TIMEOUT = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const setSessionConfig_mapper_1 = require("../mappers/setSessionConfig.mapper");
+const design_1 = require("../utils/design");
+const setSessionConfig_mapper_2 = require("../mappers/setSessionConfig.mapper");
+exports.USER_INPUT_TIMEOUT = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "noUserInput",
+    defaultLabel: "User Input Timeout - Config",
+    tags: ["voice"],
+    appearance: {
+        color: design_1.nodeColor,
+    },
+    summary: "Defines what should happen if a user does not provide input to the bot in time",
+    fields: [
+        {
+            key: "userNoInputMode",
+            type: "select",
+            label: "User No Input Mode",
+            description: "Define what should happen if a user does not provide input to the bot in time",
+            defaultValue: "event",
+            params: {
+                options: [
+                    {
+                        label: "Speak",
+                        value: "speech",
+                    },
+                    {
+                        label: "Play File",
+                        value: "play",
+                    },
+                    {
+                        label: "Send Event",
+                        value: "event",
+                    },
+                ],
+            },
+        },
+        {
+            key: "userNoInputTimeout",
+            type: "number",
+            label: "User No Input Timeout",
+            description: "Defines the timeout for user input in milliseconds",
+            defaultValue: 10000,
+            params: {
+                min: 1000,
+            },
+        },
+        {
+            key: "userNoInputRetries",
+            type: "number",
+            label: "User No Input Retries",
+            description: "Defines how often the bot should retry to get an input from a user before completing the call",
+            defaultValue: 1,
+            params: {
+                min: 0,
+            },
+        },
+        {
+            key: "userNoInputSpeech",
+            type: "cognigyText",
+            label: "User No Input Speech",
+            description: "Define a prompt to speak in case a user does not answer the bot in time",
+            defaultValue: "",
+            condition: {
+                key: "userNoInputMode",
+                value: "speech",
+            },
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: "userNoInputUrl",
+            type: "cognigyText",
+            label: "User No Input URL",
+            description: "Define which URL will be played in case a user does not answer the bot in time. WAV encoded files are supported",
+            defaultValue: "",
+            condition: {
+                key: "userNoInputMode",
+                value: "play",
+            },
+            params: {
+                required: true,
+            },
+        },
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api, input } = cognigy;
+        const { endpointType } = input;
+        try {
+            const payload = setSessionConfig_mapper_1.setSessionConfig.handleInput(endpointType, (0, setSessionConfig_mapper_2.voiceConfigParamsToVoiceSettings)(config, api));
+            api.say(null, {
+                _cognigy: payload,
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on User Input Timeout node. Error message: ${error.message}`);
+        }
+    },
+});
+//# sourceMappingURL=noUserInput.js.map

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

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLAY = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const play_mapper_1 = require("../mappers/play.mapper");
+const design_1 = require("../utils/design");
+const setSessionConfig_1 = require("../../voicegateway2/nodes/setSessionConfig");
+exports.PLAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "play",
+    defaultLabel: "Play",
+    tags: ['voice'],
+    preview: {
+        key: "url",
+        type: "text"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: [
+        {
+            key: "url",
+            label: "Media URL",
+            type: "cognigyText",
+            description: "Description: WAV encoded files are supported",
+            params: {
+                required: true
+            },
+            defaultValue: "https://www2.cs.uic.edu/~i101/SoundFiles/PinkPanther30.wav"
+        },
+        {
+            key: "setActivityParams",
+            label: "Set Activity Parameters",
+            type: "toggle",
+            defaultValue: false
+        },
+        ...setSessionConfig_1.voiceConfigFields
+    ],
+    sections: [
+        {
+            key: "params_stt",
+            label: "Recognizer (STT)",
+            defaultCollapsed: true,
+            fields: ["sttLanguage", "sttVendor", "sttHints"],
+            condition: {
+                key: "setActivityParams",
+                value: true
+            }
+        },
+        {
+            key: "params_bargein",
+            label: "Barge In",
+            defaultCollapsed: true,
+            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"],
+            condition: {
+                key: "setActivityParams",
+                value: true
+            }
+        },
+        {
+            key: "params_dtmf",
+            label: "DTMF",
+            defaultCollapsed: true,
+            fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfSubmitDigit"],
+            condition: {
+                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" }
+    ],
+    summary: "Streams a media file into the call",
+    function: async ({ cognigy, config }) => {
+        const { api, input } = cognigy;
+        const { endpointType } = input;
+        try {
+            const payload = play_mapper_1.play.handleInput(endpointType, config, api);
+            api.say(null, {
+                _cognigy: payload
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on play node. Error message: ${error.message}`);
+        }
+        ;
+    }
+});
+//# sourceMappingURL=play.js.map

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

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SESSION_SPEECH_PARAMETERS = exports.voiceConfigFields = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const setSessionConfig_mapper_1 = require("../mappers/setSessionConfig.mapper");
+const design_1 = require("../utils/design");
+exports.voiceConfigFields = [
+    {
+        key: "sttVendor",
+        type: "sttSelect",
+        label: "_unused_",
+        description: "_unused_",
+        defaultValue: "",
+        params: {
+            languageKey: "config.sttLanguage"
+        }
+    },
+    {
+        key: "sttLanguage",
+        type: "sttSelect",
+        defaultValue: "",
+        label: "_unused_"
+    },
+    {
+        key: "sttHints",
+        type: "textArray",
+        label: "STT Hints",
+        description: "Array of words or phrases to assist speech detection",
+        defaultValue: [""]
+    },
+    {
+        key: "sttDisablePunctuation",
+        type: "toggle",
+        label: "Disable STT Punctuation",
+        description: "Prevents the STT response from the bot to include punctuation marks",
+        defaultValue: false
+    },
+    {
+        key: "ttsVendor",
+        defaultValue: "",
+        type: "ttsSelect",
+        label: "_unused_",
+        description: "_unused_",
+        params: {
+            languageKey: "config.ttsLanguage",
+            voiceKey: "config.ttsVoice"
+        }
+    },
+    {
+        key: "ttsVoice",
+        type: "ttsSelect",
+        defaultValue: "",
+        label: "_unused_"
+    },
+    {
+        key: "ttsLanguage",
+        type: "ttsSelect",
+        defaultValue: "",
+        label: "_unused_"
+    }
+];
+exports.SESSION_SPEECH_PARAMETERS = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "sessionSpeechParameters",
+    defaultLabel: "Session Speech Parameters - Config",
+    summary: "Change configuration settings for the call session",
+    appearance: {
+        color: design_1.nodeColor
+    },
+    tags: ['voice'],
+    fields: exports.voiceConfigFields,
+    sections: [
+        {
+            key: "params_stt",
+            label: "Recognizer (STT)",
+            defaultCollapsed: true,
+            fields: ["sttVendor", "sttHints", "sttDisablePunctuation"]
+        },
+        {
+            key: "params_tts",
+            label: "Synthesizer (TTS)",
+            defaultCollapsed: true,
+            fields: ["ttsVendor"]
+        }
+    ],
+    form: [
+        { type: "section", key: "params_tts" },
+        { type: "section", key: "params_stt" }
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api, input } = cognigy;
+        const { endpointType } = input;
+        try {
+            const payload = setSessionConfig_mapper_1.setSessionConfig.handleInput(endpointType, (0, setSessionConfig_mapper_1.voiceConfigParamsToVoiceSettings)(config, api));
+            api.say(null, {
+                _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

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TRANSFER_VOICE = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const transfer_mapper_1 = require("../mappers/transfer.mapper");
+const helper_1 = require("../../voicegateway2/utils/helper");
+exports.TRANSFER_VOICE = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "transfer",
+    defaultLabel: "Transfer",
+    tags: ["voice"],
+    preview: {
+        key: "referTo",
+        type: "text",
+    },
+    appearance: {
+        color: design_1.nodeColor,
+    },
+    fields: [
+        {
+            key: "transferReason",
+            label: "Reason",
+            type: "cognigyText",
+            params: {
+                required: true,
+            },
+            description: "Reason for transfer.",
+            defaultValue: "Bot initiated transfer.",
+        },
+        {
+            key: "referTo",
+            label: "Target",
+            type: "cognigyText",
+            params: {
+                required: true,
+            },
+            description: "E.164 syntax or a SIP URI are supported",
+            defaultValue: "+49123456789",
+        },
+        {
+            key: "useTransferSipHeaders",
+            label: "Custom Transfer SIP Headers",
+            type: "toggle",
+            description: "Add data to be sent as SIP headers in the generated SIP message",
+            defaultValue: false,
+        },
+        {
+            key: "transferSipHeaders",
+            label: "Transfer SIP Headers",
+            type: "json",
+            description: "The data to be sent as SIP headers in the generated SIP message",
+            defaultValue: {
+                "X-Custom-Header": "YourValue",
+            },
+            condition: {
+                key: "useTransferSipHeaders",
+                value: true,
+            },
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: ["useTransferSipHeaders", "transferSipHeaders"],
+        },
+    ],
+    form: [
+        {
+            type: "field",
+            key: "transferReason",
+        },
+        {
+            type: "field",
+            key: "referTo",
+        },
+        {
+            type: "section",
+            key: "advanced",
+        },
+    ],
+    summary: "Transfers the call to another target",
+    function: async ({ cognigy, config }) => {
+        const { api, input } = cognigy;
+        const { referTo, useTransferSipHeaders, transferSipHeaders, transferReason, } = config;
+        const { endpointType } = input;
+        try {
+            const transferParams = {
+                transferReason: transferReason,
+                transferTarget: (0, helper_1.cleanTarget)(referTo),
+                useTransferSipHeaders: useTransferSipHeaders,
+                transferSipHeaders: transferSipHeaders,
+            };
+            if (useTransferSipHeaders &&
+                transferSipHeaders &&
+                !(0, helper_1.isValidJSON)(transferSipHeaders)) {
+                delete transferParams.transferSipHeaders;
+                transferParams.useTransferSipHeaders = false;
+                api.log("error", "Invalid JSON in Transfer SIP Headers");
+            }
+            const payload = transfer_mapper_1.transfer.handleInput(endpointType, transferParams, true);
+            api.say(null, {
+                _cognigy: payload,
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on Transfer Node. Error message: ${error.message}`);
+        }
+    },
+});
+//# sourceMappingURL=transfer.js.map

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENDPOINTS = void 0;
+exports.ENDPOINTS = {
+    AUDIO_CODES: "audioCodes",
+    VOICE_GATEWAY: "voiceGateway2",
+};
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeColor = void 0;
+exports.nodeColor = '#0B3694';
+//# sourceMappingURL=design.js.map

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDTMF = void 0;
+function isValidDTMF(dtmf) {
+    if (dtmf.length !== 1)
+        return false;
+    const regex = new RegExp("^[0-9#*abcdABCD]+$");
+    return regex.test(dtmf);
+}
+exports.isValidDTMF = isValidDTMF;
+//# sourceMappingURL=helper.js.map

package/build/shared/charts/descriptors/voicegateway/index.js

@@ -12,7 +12,7 @@ const handover_1 = require("./nodes/handover");
 const hangup_1 = require("./nodes/hangup");
 const playURL_1 = require("./nodes/playURL");
 const sendMetaData_1 = require("./nodes/sendMetaData");
-exports.cognigyVoiceGatewayModule = createNodeDescriptor_1.createExtension({
+exports.cognigyVoiceGatewayModule = (0, createNodeDescriptor_1.createExtension)({
     nodes: [
         sendMessage_1.sendMessageNode,
         playURL_1.playURLNode,

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

@@ -5,7 +5,7 @@ exports.agentAssistNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-exports.agentAssistNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.agentAssistNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "agentAssist",
     defaultLabel: "Agent Assist",
     summary: "Configures Agent Assist capabilities",

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

@@ -5,7 +5,7 @@ exports.callRecordingNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-exports.callRecordingNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.callRecordingNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "callRecording",
     defaultLabel: "Call Recording",
     summary: "Configures Call Recording capabilities",
@@ -20,6 +20,8 @@ exports.callRecordingNode = createNodeDescriptor_1.createNodeDescriptor({
                 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" },
                 ]
             }
         },
@@ -41,6 +43,10 @@ exports.callRecordingNode = createNodeDescriptor_1.createNodeDescriptor({
             defaultValue: "",
             params: {
                 required: true
+            },
+            condition: {
+                key: "activity",
+                value: "startCallRecording"
             }
         },
         {
@@ -66,22 +72,36 @@ exports.callRecordingNode = createNodeDescriptor_1.createNodeDescriptor({
         const { activity, callRecordingDestUsername, callRecordingId, callRecordingServer } = config;
         if (callRecordingServer && callRecordingId && callRecordingDestUsername) {
             let activities = [];
-            if (activity === "startCallRecording") {
-                activities.push({
-                    type: "event",
-                    name: "startCallRecording",
-                    activityParams: {
-                        callRecordingId,
-                        callRecordingDestUsername,
-                        callRecordingServer
-                    }
-                });
-            }
-            if (activity === "stopCallRecording") {
-                activities.push({
-                    type: "event",
-                    name: "stopCallRecording",
-                });
+            switch (activity) {
+                case "startCallRecording":
+                    activities.push({
+                        type: "event",
+                        name: "startCallRecording",
+                        activityParams: {
+                            callRecordingId,
+                            callRecordingDestUsername,
+                            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": {

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

@@ -5,10 +5,11 @@ exports.handoverNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-exports.handoverNode = createNodeDescriptor_1.createNodeDescriptor({
+const transfer_mapper_1 = require("../../voice/mappers/transfer.mapper");
+exports.handoverNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "handover",
-    defaultLabel: "Handover",
-    summary: "Hands the conversations to another target",
+    defaultLabel: "Transfer",
+    summary: "Transfers a conversation to another target",
     fields: [
         {
             key: "handoverReason",
@@ -118,39 +119,24 @@ exports.handoverNode = createNodeDescriptor_1.createNodeDescriptor({
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         const { handoverReason, transferTarget, transferReferredByURL, useTransferSipHeaders, transferSipHeaders, transferNotifications, transferNotificationsHangupMS } = config;
-        if (!handoverReason)
-            throw new Error('The handover reason is missing.');
-        if (!transferTarget)
-            throw new Error('The handover target is missing.');
-        const activities = [
-            {
-                "type": "event",
-                "name": "transfer",
-                "activityParams": {
-                    transferTarget,
-                    handoverReason,
-                }
-            }
-        ];
-        if (transferReferredByURL) {
-            activities[0].activityParams["transferReferredByURL"] = transferReferredByURL;
-        }
-        if (useTransferSipHeaders) {
-            activities[0].activityParams["transferSipHeaders"] = transferSipHeaders;
+        const transferParams = {
+            transferReason: handoverReason,
+            transferTarget,
+            useTransferSipHeaders,
+            transferSipHeaders,
+            transferNotifications,
+            transferNotificationsHangupMS,
+            transferReferredByURL
+        };
+        try {
+            const payload = transfer_mapper_1.transfer.handleInput("audioCodes", transferParams, false);
+            api.say(null, {
+                _cognigy: payload
+            });
         }
-        if (transferNotifications) {
-            activities[0].activityParams["transferNotifications"] = transferNotifications;
-            activities[0].activityParams["transferNotificationsHangupMS"] = transferNotificationsHangupMS;
+        catch (error) {
+            throw new Error(`Error on hangup node. Error message: ${error.message}`);
         }
-        api.output(null, {
-            "_cognigy": {
-                "_voiceGateway": {
-                    "json": {
-                        activities
-                    }
-                }
-            }
-        });
     }
 });
 //# sourceMappingURL=handover.js.map

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

@@ -5,7 +5,8 @@ exports.hangupNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-exports.hangupNode = createNodeDescriptor_1.createNodeDescriptor({
+const hangup_mapper_1 = require("../../voice/mappers/hangup.mapper");
+exports.hangupNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "hangup",
     defaultLabel: "Hang Up",
     summary: "Hangs up the call",
@@ -33,25 +34,15 @@ exports.hangupNode = createNodeDescriptor_1.createNodeDescriptor({
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         const { hangupReason } = config;
-        if (!hangupReason)
-            throw new Error('The hangup reason is missing.');
-        api.output(null, {
-            "_cognigy": {
-                "_voiceGateway": {
-                    "json": {
-                        "activities": [
-                            {
-                                "type": "event",
-                                "name": "hangup",
-                                "activityParams": {
-                                    hangupReason
-                                }
-                            }
-                        ]
-                    }
-                }
-            }
-        });
+        try {
+            const payload = hangup_mapper_1.hangUp.handleInput("audioCodes", hangupReason);
+            api.say(null, {
+                _cognigy: payload
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on hangup node. Error message: ${error.message}`);
+        }
     }
 });
 //# sourceMappingURL=hangup.js.map