@cognigy/rest-api-client 0.12.0 → 0.13.0

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

@@ -6,7 +6,7 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
 const paramUtils_1 = require("../utils/paramUtils");
-exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.sendMessageNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "sendMessage",
     defaultLabel: "Send Message",
     summary: "Sends a prompt via VG",
@@ -208,7 +208,7 @@ exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
             type: "json",
             defaultValue: "{}"
         }
-    ].concat(paramUtils_1.getParameterFields()),
+    ].concat((0, paramUtils_1.getParameterFields)()),
     sections: [
         {
             key: "advanced",
@@ -222,7 +222,7 @@ exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
                 value: true
             }
         }
-    ].concat(paramUtils_1.getParamSections({ key: "setActivityParams", value: true })),
+    ].concat((0, paramUtils_1.getParamSections)({ key: "setActivityParams", value: true })),
     form: [
         { type: "field", key: "text" },
         { type: "field", key: "setActivityParams" },
@@ -249,7 +249,7 @@ exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
         const { text, activityParams, setActivityParams } = config;
         let compiledParams = activityParams || {};
         if (setActivityParams) {
-            paramUtils_1.compileParams(config, compiledParams);
+            (0, paramUtils_1.compileParams)(config, compiledParams);
         }
         if (text) {
             api.output(null, {

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

@@ -5,7 +5,7 @@ exports.sendMetaDataNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-exports.sendMetaDataNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.sendMetaDataNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "sendMetaData",
     defaultLabel: "Send Meta Data",
     summary: "Sends meta data via SIP INFO messages",

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

@@ -6,7 +6,7 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
 const paramUtils_1 = require("../utils/paramUtils");
-exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.setSessionParamsNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "setSessionParams",
     defaultLabel: "Set Session Parameters",
     summary: "Sets VG configuration settings for the session",
@@ -21,7 +21,7 @@ exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
                 required: true
             }
         }
-    ].concat(paramUtils_1.getParameterFields()),
+    ].concat((0, paramUtils_1.getParameterFields)()),
     sections: [
         {
             key: "advanced",
@@ -31,7 +31,7 @@ exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
                 "sessionParams",
             ]
         }
-    ].concat(paramUtils_1.getParamSections()),
+    ].concat((0, paramUtils_1.getParamSections)()),
     appearance: {
         color: design_1.nodeColor
     },
@@ -51,7 +51,7 @@ exports.setSessionParamsNode = createNodeDescriptor_1.createNodeDescriptor({
         const { api } = cognigy;
         const { sessionParams } = config;
         let compiledParams = sessionParams || {};
-        paramUtils_1.compileParams(config, compiledParams);
+        (0, paramUtils_1.compileParams)(config, compiledParams);
         // output the activity to the voice gateway
         api.output(null, {
             "_cognigy": {

package/build/shared/charts/descriptors/voicegateway/utils/paramUtils.js

@@ -9,6 +9,7 @@ exports.getParamSections = exports.getParameterFields = exports.compileParams =
 const compileParams = (config, compiledParams) => {
     const EXCLUDEDKEYS = ["activityParams", "text", "setActivityParams", "sttContextBoostAzure", "sttContextBoost", "azureUseContextPhrases"];
     Object.keys(config).forEach((key) => {
+        var _a;
         if (EXCLUDEDKEYS.indexOf(key) === -1) {
             if (!key.startsWith("dtmfCollect") || (key.startsWith("dtmfCollect") && config["dtmfCollect"])) {
                 switch (typeof config[key]) {
@@ -38,7 +39,7 @@ const compileParams = (config, compiledParams) => {
                         break;
                     case "number":
                     case "string":
-                        if (config[key])
+                        if (config[key] || ((_a = config[key]) === null || _a === void 0 ? void 0 : _a.toString()) === '0')
                             compiledParams[key] = config[key];
                         break;
                     case "boolean":
@@ -128,9 +129,9 @@ const getParameterFields = () => [
         type: "slider",
         label: "Barge In Minimum Words",
         description: "Defines the minimum number of words that the user must say for the Voice Gateway to consider it a barge in",
-        defaultValue: 0,
+        defaultValue: 1,
         params: {
-            min: 0,
+            min: 1,
             max: 5,
             step: 1,
         },
@@ -188,7 +189,7 @@ const getParameterFields = () => [
         key: "userNoInputRetries",
         type: "number",
         label: "No User Input Retries",
-        description: "Defines the maximum number of allowed timeouts for no user input",
+        description: "Defines the maximum number of allowed timeouts for no user input.",
         defaultValue: 0,
     },
     {
@@ -198,6 +199,17 @@ const getParameterFields = () => [
         description: "Send an data input to the Flow if there is no user input",
         defaultValue: false,
     },
+    {
+        key: "userNoInputAutoHangup",
+        type: "toggle",
+        label: "Hangup after all retries",
+        description: "Automatically hangup if there is still no user input after all retries",
+        defaultValue: false,
+        condition: {
+            key: "userNoInputSendEvent",
+            value: true
+        }
+    },
     {
         key: "userNoInputSpeech",
         type: "cognigyText",
@@ -239,10 +251,14 @@ const getParameterFields = () => [
         type: "number",
         label: "Continuous ASR Timeout",
         description: "Defines the automatic speech recognition (ASR) timeout (in milliseconds)",
-        defaultValue: 0,
+        defaultValue: 3000,
         condition: {
             key: "continuousASR",
             value: true
+        },
+        params: {
+            min: 500,
+            max: 60000
         }
     },
     {
@@ -317,6 +333,9 @@ const getParameterFields = () => [
         condition: {
             key: "dtmfCollect",
             value: true
+        },
+        params: {
+            min: 1
         }
     },
     {
@@ -435,6 +454,7 @@ const getParamSections = (condition) => [
             "userNoInputTimeoutMS",
             "userNoInputRetries",
             "userNoInputSendEvent",
+            "userNoInputAutoHangup",
             "userNoInputSpeech",
             "userNoInputUrl",
         ],

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

@@ -7,14 +7,18 @@ const dtmf_1 = require("./nodes/dtmf");
 const hangup_1 = require("./nodes/hangup");
 const play_1 = require("./nodes/play");
 const refer_1 = require("./nodes/refer");
+const transfer_1 = require("./nodes/transfer");
 const setSessionConfig_1 = require("./nodes/setSessionConfig");
-exports.cognigyVoiceGateway2Module = createNodeDescriptor_1.createExtension({
+const sendMetadata_1 = require("./nodes/sendMetadata");
+exports.cognigyVoiceGateway2Module = (0, createNodeDescriptor_1.createExtension)({
     nodes: [
         setSessionConfig_1.setSessionConfigNode,
         dtmf_1.dtmfNode,
         hangup_1.hangupNode,
         play_1.playNode,
-        refer_1.referNode
+        refer_1.referNode,
+        transfer_1.transferNode,
+        sendMetadata_1.sendMetadataNode
     ],
     connections: []
 });

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

@@ -5,25 +5,30 @@ exports.dtmfNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const design_1 = require("../utils/design");
-exports.dtmfNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.dtmfNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "dtmf",
     defaultLabel: "DTMF",
+    summary: "Plays DTMF digits to the caller",
+    preview: {
+        key: "dtmf",
+        type: "text"
+    },
     appearance: {
         color: design_1.nodeColor
     },
     fields: [
         {
             key: "dtmf",
-            label: "Digit sequence",
+            label: "Digit Sequence",
             description: "Digit sequence to play to the caller",
-            type: "text",
+            type: "cognigyText",
             params: {
                 required: true
             }
         },
         {
             key: "duration",
-            label: "Pause time",
+            label: "Pause Time",
             description: "Pause time in ms between digits",
             type: "slider",
             defaultValue: 500,
@@ -34,7 +39,6 @@ exports.dtmfNode = createNodeDescriptor_1.createNodeDescriptor({
             }
         }
     ],
-    summary: "Plays DTMF digits to the caller",
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         const { dtmf, duration } = config;

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

@@ -4,45 +4,43 @@ exports.hangupNode = void 0;
 /** Custom Modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
+const constants_1 = require("../utils/constants");
 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",
+    preview: {
+        key: "hangupReason",
+        type: "text"
+    },
     appearance: {
         color: design_1.nodeColor
     },
+    summary: "Hangs up the call",
     fields: [
         {
             key: "hangupReason",
             label: "Reason for hang up",
-            type: "text",
+            type: "cognigyText",
             defaultValue: "Bot ended the call",
             params: {
                 required: true
             }
         }
     ],
-    summary: "Hangs up the call",
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         const { hangupReason } = config;
-        const voiceGateway2Payload = {
-            hangup: {}
-        };
-        if (hangupReason) {
-            voiceGateway2Payload.hangup = {
-                headers: {
-                    "X-Reason": hangupReason
-                }
-            };
+        try {
+            const payload = hangup_mapper_1.hangUp.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, hangupReason);
+            api.say(null, {
+                _cognigy: payload
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on hangup node. Error message: ${error.message}`);
         }
-        api.say(null, {
-            _cognigy: {
-                _voiceGateway2: {
-                    json: voiceGateway2Payload
-                }
-            }
-        });
     }
 });
 //# sourceMappingURL=hangup.js.map

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

@@ -4,12 +4,18 @@ exports.playNode = void 0;
 /** Custom Modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
+const play_mapper_1 = require("../../voice/mappers/play.mapper");
+const constants_1 = require("../utils/constants");
 const design_1 = require("../utils/design");
-const strip_nulls_1 = require("../utils/strip-nulls");
 const setSessionConfig_1 = require("./setSessionConfig");
-exports.playNode = createNodeDescriptor_1.createNodeDescriptor({
+exports.playNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "play",
     defaultLabel: "Play",
+    summary: "Streams a media file into the call with the ability to loop it",
+    preview: {
+        key: "url",
+        type: "text"
+    },
     appearance: {
         color: design_1.nodeColor
     },
@@ -17,7 +23,7 @@ exports.playNode = createNodeDescriptor_1.createNodeDescriptor({
         {
             key: "url",
             label: "Media URL",
-            type: "text",
+            type: "cognigyText",
             description: "You can use MP3 or WAV encoded files",
             params: {
                 required: true
@@ -51,16 +57,6 @@ exports.playNode = createNodeDescriptor_1.createNodeDescriptor({
         ...setSessionConfig_1.voiceConfigFields
     ],
     sections: [
-        {
-            key: "params_tts",
-            label: "Synthesizer (TTS)",
-            defaultCollapsed: true,
-            fields: ["ttsVoice", "ttsLanguage", "ttsVendor"],
-            condition: {
-                key: "setActivityParams",
-                value: true
-            }
-        },
         {
             key: "params_stt",
             label: "Recognizer (STT)",
@@ -81,16 +77,6 @@ exports.playNode = createNodeDescriptor_1.createNodeDescriptor({
                 value: true
             }
         },
-        {
-            key: "params_user_timeouts",
-            label: "User Input Timeout",
-            defaultCollapsed: true,
-            fields: ["userNoInputMode", "userNoInputSpeech", "userNoInputUrl", "userNoInputTimeout", "userNoInputRetries"],
-            condition: {
-                key: "setActivityParams",
-                value: true
-            }
-        },
         {
             key: "params_dtmf",
             label: "DTMF",
@@ -100,100 +86,28 @@ exports.playNode = createNodeDescriptor_1.createNodeDescriptor({
                 key: "setActivityParams",
                 value: true
             }
-        }
+        },
     ],
     form: [
         { type: "field", key: "url" },
         { type: "field", key: "loop" },
         { type: "field", key: "setActivityParams" },
-        { type: "section", key: "params_tts" },
         { type: "section", key: "params_stt" },
         { type: "section", key: "params_bargein" },
-        { type: "section", key: "params_user_timeouts" },
         { type: "section", key: "params_dtmf" },
     ],
-    summary: "Streams a media file into the call with the ability to loop it",
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
-        const { url, loop, setActivityParams } = config;
-        const voiceGateway2Payload = {
-            play: {
-                url,
-                loop,
-            }
-        };
-        if (setActivityParams) {
-            const activityConfig = {};
-            const synthesizer = {
-                language: config.ttsLanguage,
-                voice: config.ttsVoice,
-                vendor: config.ttsVendor
-            };
-            activityConfig.synthesizer = synthesizer;
-            const recognizer = {
-                language: config.sttLanguage,
-                vendor: config.sttVendor || "default",
-                hints: config.sttHints,
-                vad: {
-                    enable: config.sttVadEnabled,
-                    mode: config.sttVadMode,
-                    voiceMs: config.sttVadVoiceMs
-                }
-            };
-            activityConfig.recognizer = recognizer;
-            const bargein = {
-                enable: false,
-                minBargeinWordCount: config.bargeInMinWordCount,
-                input: [],
-                actionHook: "voice"
-            };
-            if (config.bargeInOnDtmf) {
-                bargein.dtmfBargein = true;
-                bargein.input.push("digits");
-            }
-            if (config.bargeInOnSpeech) {
-                bargein.input.push("speech");
-            }
-            if (bargein.input.length > 0) {
-                bargein.enable = true;
-                bargein.sticky = true;
-            }
-            activityConfig.bargeIn = bargein;
-            const user = {
-                noInputMode: config.userNoInputMode,
-                noInputTimeout: (config.userNoInputTimeout || 10000) / 1000,
-                noInputRetries: config.userNoInputRetries,
-                noInputSpeech: config.userNoInputSpeech,
-                noInputUrl: config.userNoInputUrl
-            };
-            activityConfig.user = user;
-            if (config.dtmfEnable) {
-                if (!activityConfig.bargeIn) {
-                    activityConfig.bargeIn = {
-                        enable: false
-                    };
-                }
-                activityConfig.bargeIn.interDigitTimeout = (config.dtmfInterDigitTimeout || 500) / 1000;
-                activityConfig.bargeIn.maxDigits = config.dtmfMaxDigits;
-                activityConfig.bargeIn.minDigits = config.dtmfMinDigits;
-                activityConfig.bargeIn.finishOnKey = config.dtmfSubmitDigit;
-                if (!voiceGateway2Payload.play.activityConfig) {
-                    voiceGateway2Payload.play.activityConfig = {};
-                }
-                voiceGateway2Payload.play.activityConfig.dtmf = true;
-            }
-            if (Object.keys(activityConfig).length > 0) {
-                voiceGateway2Payload.play.activityConfig = activityConfig;
-            }
+        try {
+            const payload = play_mapper_1.play.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, config);
+            api.say(null, {
+                _cognigy: payload
+            });
         }
-        strip_nulls_1.stripNulls(voiceGateway2Payload);
-        api.say(null, {
-            _cognigy: {
-                _voiceGateway2: {
-                    json: voiceGateway2Payload
-                }
-            }
-        });
+        catch (error) {
+            throw new Error(`Error on play node. Error message: ${error.message}`);
+        }
+        ;
     }
 });
 //# sourceMappingURL=play.js.map

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

@@ -4,13 +4,25 @@ exports.referNode = void 0;
 /** Custom Modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
+const transfer_mapper_1 = require("../../voice/mappers/transfer.mapper");
+const constants_1 = require("../utils/constants");
 const design_1 = require("../utils/design");
-exports.referNode = createNodeDescriptor_1.createNodeDescriptor({
+const helper_1 = require("../utils/helper");
+exports.referNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "refer",
     defaultLabel: "Refer",
+    summary: "Transfer the call to another target",
+    preview: {
+        key: "referTo",
+        type: "text"
+    },
     appearance: {
         color: design_1.nodeColor
     },
+    constraints: {
+        placement: {},
+        creatable: false,
+    },
     fields: [
         {
             key: "referTo",
@@ -21,24 +33,71 @@ exports.referNode = createNodeDescriptor_1.createNodeDescriptor({
             },
             description: "E.164 syntax or a SIP URI are supported",
             defaultValue: "+49176123456789"
+        },
+        {
+            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: "referTo"
+        },
+        {
+            type: "section",
+            key: "advanced"
         }
     ],
-    summary: "Transfer the call to another target",
     function: async ({ cognigy, config }) => {
-        const { api } = cognigy;
-        const { referTo } = config;
-        const voiceGateway2Payload = {
-            "sip:refer": {
-                referTo
-            }
+        const { api, input } = cognigy;
+        const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
+        const transferParams = {
+            transferReason: '',
+            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            useTransferSipHeaders,
+            transferSipHeaders
         };
-        api.say(null, {
-            _cognigy: {
-                _voiceGateway2: {
-                    json: voiceGateway2Payload
-                }
+        try {
+            const payload = transfer_mapper_1.transfer.handleInput(constants_1.ENDPOINTS.VOICE_GATEWAY, transferParams, false);
+            if (input.channel === "adminconsole") {
+                api.output('You are using the deprecated Refer Node. Please replace it with new Transfer Node in the Node Selection Menu.', null);
             }
-        });
+            api.log('error', 'You are using the deprecated Refer Node. Please replace it with new Transfer Node in the Node Selection Menu.');
+            api.say(null, {
+                _cognigy: payload
+            });
+        }
+        catch (error) {
+            throw new Error(`Error on Refer node. Error message: ${error.message}`);
+        }
     }
 });
 //# sourceMappingURL=refer.js.map

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

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendMetadataNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const helper_1 = require("../utils/helper");
+exports.sendMetadataNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "sendMetadata",
+    defaultLabel: "Send Metadata",
+    summary: "Sends metadata via SIP INFO messages",
+    fields: [
+        {
+            key: "metadata",
+            label: "Metadata",
+            type: "json",
+            defaultValue: { myParamName: "myParamValue" },
+            params: {
+                require: true,
+            },
+            description: "The metadata to send via SIP INFO messages",
+        },
+    ],
+    appearance: {
+        color: design_1.nodeColor,
+    },
+    form: [
+        {
+            type: "field",
+            key: "metadata",
+        },
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { metadata } = config;
+        const voiceGateway2Payload = {
+            "sip:request": {
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: "",
+                method: "INFO",
+                actionHook: "/info",
+            },
+        };
+        if (metadata) {
+            if ((0, helper_1.isValidJSON)(metadata)) {
+                voiceGateway2Payload["sip:request"].body = JSON.stringify(metadata);
+                api.say(null, {
+                    _cognigy: {
+                        _voiceGateway2: {
+                            json: voiceGateway2Payload,
+                        },
+                    },
+                });
+            }
+            else {
+                api.log("error", "Invalid JSON in Metadata Field");
+            }
+        }
+    },
+});
+//# sourceMappingURL=sendMetadata.js.map