@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/charts/descriptors/start.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.START = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../createNodeDescriptor");
 exports.START = createNodeDescriptor_1.createNodeDescriptor({
@@ -8,6 +9,7 @@ exports.START = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         color: '#61D188',
         textColor: 'white',
+        contrastTextColor: 'black',
         variant: 'mini'
     },
     behavior: {

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

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cognigyVoiceGatewayModule = void 0;
+/** Cognigy Modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/** Nodes */
+const sendMessage_1 = require("./nodes/sendMessage");
+const setSessionParams_1 = require("./nodes/setSessionParams");
+const agentAssist_1 = require("./nodes/agentAssist");
+const callRecording_1 = require("./nodes/callRecording");
+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({
+    nodes: [
+        sendMessage_1.sendMessageNode,
+        playURL_1.playURLNode,
+        handover_1.handoverNode,
+        hangup_1.hangupNode,
+        setSessionParams_1.setSessionParamsNode,
+        sendMetaData_1.sendMetaDataNode,
+        agentAssist_1.agentAssistNode,
+        callRecording_1.callRecordingNode
+    ],
+    connections: []
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.agentAssistNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+exports.agentAssistNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "agentAssist",
+    defaultLabel: "Agent Assist",
+    summary: "Configures Agent Assist capabilities",
+    preview: {
+        key: "activity",
+        type: "text"
+    },
+    fields: [
+        {
+            key: "activity",
+            label: "Activity",
+            type: "select",
+            description: "Whether to start or stop the recognition of inputs by VG",
+            defaultValue: "startRecognition",
+            params: {
+                options: [
+                    { value: "startRecognition", label: "Start Recognition" },
+                    { value: "stopRecognition", label: "Stop Recognition" },
+                ]
+            }
+        },
+        {
+            key: "targetParticipant",
+            label: "Target Participant",
+            type: "select",
+            description: "Who to apply the setting to",
+            defaultValue: "both",
+            params: {
+                options: [
+                    { value: "both", label: "Caller && Callee (Agent)" },
+                    { value: "caller", label: "Caller only" },
+                    { value: "callee", label: "Callee (Agent) only" },
+                ]
+            }
+        }
+    ],
+    appearance: {
+        color: design_1.nodeColor
+    },
+    form: [
+        { type: "field", key: "activity" },
+        { type: "field", key: "targetParticipant" }
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { activity, targetParticipant } = config;
+        if (activity && targetParticipant) {
+            let activities = [];
+            if (targetParticipant === "both" || targetParticipant === "caller") {
+                activities.push({
+                    "type": "event",
+                    "name": activity,
+                    "activityParams": {
+                        "targetParticipant": "caller"
+                    }
+                });
+            }
+            if (targetParticipant === "both" || targetParticipant === "callee") {
+                activities.push({
+                    "type": "event",
+                    "name": activity,
+                    "activityParams": {
+                        "targetParticipant": "callee"
+                    }
+                });
+            }
+            api.output(null, {
+                "_cognigy": {
+                    "_voiceGateway": {
+                        "json": {
+                            activities
+                        }
+                    }
+                }
+            });
+        }
+    }
+});
+//# sourceMappingURL=agentAssist.js.map

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

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callRecordingNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+exports.callRecordingNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "callRecording",
+    defaultLabel: "Call Recording",
+    summary: "Configures Call Recording capabilities",
+    fields: [
+        {
+            key: "activity",
+            label: "Activity",
+            type: "select",
+            description: "Whether to start or stop the recording of audio",
+            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" },
+                ]
+            }
+        },
+        {
+            key: "callRecordingServer",
+            label: "Call Recording Server",
+            type: "cognigyText",
+            description: "Defines the SRS as an IP Group name (as configured on the SBC) to record the call.",
+            defaultValue: "",
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "callRecordingId",
+            label: "Call Recording ID",
+            description: "Defines the recording ID session, which is forwarded by the SBC to the SRS",
+            type: "cognigyText",
+            defaultValue: "",
+            params: {
+                required: true
+            },
+            condition: {
+                key: "activity",
+                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",
+            type: "cognigyText",
+            defaultValue: "",
+            params: {
+                required: true
+            }
+        }
+    ],
+    appearance: {
+        color: design_1.nodeColor
+    },
+    preview: {
+        key: "activity",
+        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":
+                    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": {
+                    "_voiceGateway": {
+                        "json": {
+                            activities
+                        }
+                    }
+                }
+            });
+        }
+    }
+});
+//# sourceMappingURL=callRecording.js.map

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

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handoverNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+exports.handoverNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "handover",
+    defaultLabel: "Transfer",
+    summary: "Transfers a conversation to another target",
+    fields: [
+        {
+            key: "handoverReason",
+            label: "Reason",
+            type: "cognigyText",
+            defaultValue: "Bot initiated handover",
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "transferTarget",
+            label: "Target",
+            type: "cognigyText",
+            defaultValue: "tel:+49123456789",
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "transferReferredByURL",
+            label: "Referral URL",
+            type: "cognigyText",
+            description: "Adds a SIP Referred-By header to the outgoing INVITE/REFER message",
+            defaultValue: ""
+        },
+        {
+            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: `[{
+		"name": "X-My-Header",
+		"value": "my_value"
+	}]`,
+            condition: {
+                key: "useTransferSipHeaders",
+                value: true
+            }
+        },
+        {
+            key: "transferNotifications",
+            label: "Receive Transfer Notifications",
+            type: "toggle",
+            description: "Enables VG to notify the Flow on the outcome of call transfer attempts",
+            defaultValue: false
+        },
+        {
+            key: "transferNotificationsHangupMS",
+            label: "Disconnect on Success Timeout",
+            type: "number",
+            description: "Defines a grace period (in milliseconds) for disconnecting the call after a successful transfer",
+            defaultValue: 5000,
+            params: {
+                min: 0,
+                max: 60000,
+                step: 500
+            },
+            condition: {
+                key: "transferNotifications",
+                value: true
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: [
+                "transferNotifications",
+                "transferNotificationsHangupMS",
+                "transferReferredByURL",
+                "useTransferSipHeaders",
+                "transferSipHeaders",
+            ]
+        }
+    ],
+    preview: {
+        key: "transferTarget",
+        type: "text"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    form: [
+        {
+            type: "field",
+            key: "handoverReason"
+        },
+        {
+            type: "field",
+            key: "transferTarget"
+        },
+        {
+            type: "section",
+            key: "advanced"
+        }
+    ],
+    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;
+        }
+        if (transferNotifications) {
+            activities[0].activityParams["transferNotifications"] = transferNotifications;
+            activities[0].activityParams["transferNotificationsHangupMS"] = transferNotificationsHangupMS;
+        }
+        api.output(null, {
+            "_cognigy": {
+                "_voiceGateway": {
+                    "json": {
+                        activities
+                    }
+                }
+            }
+        });
+    }
+});
+//# sourceMappingURL=handover.js.map

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hangupNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+exports.hangupNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "hangup",
+    defaultLabel: "Hang Up",
+    summary: "Hangs up the call",
+    fields: [
+        {
+            key: "hangupReason",
+            label: "Reason",
+            type: "cognigyText",
+            defaultValue: "Bot ended the call",
+            params: {
+                required: true
+            }
+        },
+    ],
+    preview: {
+        key: "hangupReason",
+        type: "text"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    form: [
+        { type: "field", key: "hangupReason" }
+    ],
+    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
+                                }
+                            }
+                        ]
+                    }
+                }
+            }
+        });
+    }
+});
+//# sourceMappingURL=hangup.js.map

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

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.playURLNode = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const paramUtils_1 = require("../utils/paramUtils");
+exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "playURL",
+    defaultLabel: "Play URL",
+    summary: "Plays an audio prompt from a file url",
+    // @ts-ignore
+    fields: [
+        {
+            key: "playUrlUrl",
+            label: "Media URL",
+            type: "cognigyText",
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "playUrlMediaFormat",
+            label: "Media Format",
+            type: "select",
+            defaultValue: "wav/lpcm16",
+            description: "Either Mu-Law (8 bit, 8 kHz) or Linear PCM (16 bit, 16 kHz) encoded with or without a WAV header",
+            params: {
+                options: [
+                    {
+                        label: "wav/lpcm16",
+                        value: "wav/lpcm16"
+                    },
+                    {
+                        label: "raw/lpcm16",
+                        value: "raw/lpcm16"
+                    },
+                    {
+                        label: "wav/mulaw",
+                        value: "wav/mulaw"
+                    },
+                    {
+                        label: "raw/mulaw",
+                        value: "raw/mulaw"
+                    }
+                ]
+            }
+        },
+        {
+            key: "playUrlAltText",
+            label: "Alt Text",
+            type: "cognigyText",
+            description: "Defines the text to display in the transcript page of the user interface while the audio is played",
+            defaultValue: ""
+        },
+        {
+            key: "playUrlCaching",
+            label: "Cache Audio",
+            type: "toggle",
+            defaultValue: false
+        },
+        {
+            key: "setActivityParams",
+            label: "Set Activity Parameters",
+            type: "toggle",
+            defaultValue: false
+        },
+        {
+            key: "activityParams",
+            label: "Other Activity Params",
+            type: "json",
+            defaultValue: "{}"
+        }
+    ].concat(paramUtils_1.getParameterFields()),
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: [
+                "activityParams",
+            ],
+            condition: {
+                key: "setActivityParams",
+                value: true
+            }
+        }
+    ].concat(paramUtils_1.getParamSections({ key: "setActivityParams", value: true })),
+    form: [
+        { type: "field", key: "playUrlUrl" },
+        { type: "field", key: "playUrlMediaFormat" },
+        { type: "field", key: "playUrlCaching" },
+        { type: "field", key: "setActivityParams" },
+        { type: "section", key: "params_stt" },
+        { type: "section", key: "params_tts" },
+        { type: "section", key: "params_dtmf" },
+        { type: "section", key: "params_bargein" },
+        { type: "section", key: "params_continuousasr" },
+        { type: "section", key: "params_user_timeouts" },
+        { type: "section", key: "params_bot_timeouts" },
+        { type: "section", key: "params_azure" },
+        { type: "section", key: "params_google" },
+        { type: "section", key: "advanced" },
+    ],
+    preview: {
+        type: "text",
+        key: "playUrlUrl"
+    },
+    appearance: {
+        color: design_1.nodeColor
+    },
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { playUrlUrl, playUrlMediaFormat, playUrlAltText, setActivityParams, activityParams, playUrlCaching } = config;
+        if (playUrlUrl && playUrlMediaFormat) {
+            let compiledParams = Object.assign(activityParams || {}, {
+                playUrlUrl,
+                playUrlMediaFormat
+            });
+            if (playUrlAltText)
+                compiledParams["playUrlAltText"] = playUrlAltText;
+            if (playUrlCaching !== null)
+                compiledParams["playUrlCaching"] = !!playUrlCaching;
+            if (setActivityParams) {
+                paramUtils_1.compileParams(config, compiledParams);
+            }
+            api.output(null, {
+                "_cognigy": {
+                    "_voiceGateway": {
+                        "json": {
+                            "activities": [
+                                {
+                                    "type": "event",
+                                    "name": "playUrl",
+                                    "activityParams": compiledParams
+                                }
+                            ]
+                        }
+                    }
+                }
+            });
+        }
+    }
+});
+//# sourceMappingURL=playURL.js.map