@cognigy/rest-api-client 0.11.0 → 0.12.0

package/build/shared/charts/descriptors/profile/overwriteAnalytics.js

@@ -48,6 +48,41 @@ exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
             type: "cognigyText",
             label: "Custom Value 3",
         },
+        {
+            key: "custom4",
+            type: "cognigyText",
+            label: "Custom Value 4",
+        },
+        {
+            key: "custom5",
+            type: "cognigyText",
+            label: "Custom Value 5",
+        },
+        {
+            key: "custom6",
+            type: "cognigyText",
+            label: "Custom Value 6",
+        },
+        {
+            key: "custom7",
+            type: "cognigyText",
+            label: "Custom Value 7",
+        },
+        {
+            key: "custom8",
+            type: "cognigyText",
+            label: "Custom Value 8",
+        },
+        {
+            key: "custom9",
+            type: "cognigyText",
+            label: "Custom Value 9",
+        },
+        {
+            key: "custom10",
+            type: "cognigyText",
+            label: "Custom Value 10",
+        },
         {
             key: "intent",
             type: "cognigyText",
@@ -74,6 +109,11 @@ exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
             type: "cognigyText",
             label: "State",
         },
+        {
+            key: "handoverEscalations",
+            type: "cognigyText",
+            label: "Handover Escalations",
+        },
         {
             key: "slots",
             type: "json",
@@ -117,7 +157,14 @@ exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
                 "customDesc",
                 "custom1",
                 "custom2",
-                "custom3"
+                "custom3",
+                "custom4",
+                "custom5",
+                "custom6",
+                "custom7",
+                "custom8",
+                "custom9",
+                "custom10",
             ]
         },
         {
@@ -133,7 +180,8 @@ exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
                 "state",
                 "slots",
                 "completedGoals",
-                "understood"
+                "understood",
+                "handoverEscalations",
             ]
         },
     ],
@@ -145,6 +193,10 @@ exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         for (let key of Object.keys(config)) {
+            if (key === "handoverEscalations") {
+                api.setAnalyticsData(key, parseInt(config[key]));
+                continue;
+            }
             switch (typeof config[key]) {
                 case "string":
                     if (config[key] && config[key].length > 0 && config[key] !== "cUndefined") {

package/build/shared/charts/descriptors/profile/requestRating.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_RATING = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'requestRating'
+ *
+ * Purpose:
+ * Send a rating request message to a webchat endpoint
+ */
+exports.REQUEST_RATING = createNodeDescriptor_1.createNodeDescriptor({
+    type: "requestRating",
+    defaultLabel: "Request Rating",
+    summary: "Request a rating from a Webchat User",
+    appearance: {
+        showIcon: false,
+    },
+    preview: {
+        key: "ratingTitleText",
+        type: "text",
+    },
+    fields: [
+        {
+            key: "ratingTitleText",
+            type: "cognigyText",
+            label: "Rating Title",
+            description: "Define a custom title for the rating request dialog",
+        },
+        {
+            key: "ratingCommentText",
+            type: "cognigyText",
+            label: "Rating Comment Text",
+            description: "Define a custom comment text for the rating request dialog",
+        },
+    ],
+    form: [
+        { type: "field", key: "ratingTitleText" },
+        { type: "field", key: "ratingCommentText" },
+    ],
+    tags: ["message", "profile", "analytics", "rating",],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const ratingTitleText = config.ratingTitleText;
+        const ratingCommentText = config.ratingCommentText;
+        api.say("", {
+            _plugin: {
+                type: "request-rating",
+                data: {
+                    ratingTitleText,
+                    ratingCommentText,
+                },
+            },
+        });
+    }
+});
+//# sourceMappingURL=requestRating.js.map

package/build/shared/charts/descriptors/profile/setRating.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_RATING = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+exports.SET_RATING = createNodeDescriptor_1.createNodeDescriptor({
+    type: "setRating",
+    defaultLabel: "Set Rating",
+    summary: "Sets the rating and rating comment for a conversation",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "rating",
+            type: "cognigyText",
+            label: "Rating Score",
+            description: "The rating for the conversation. -1 for a negative rating or 1 for a positive rating"
+        },
+        {
+            key: "ratingComment",
+            type: "cognigyText",
+            label: "Rating Comment",
+        },
+    ],
+    form: [
+        { type: "field", key: "rating" },
+        { type: "field", key: "ratingComment" }
+    ],
+    tags: ["profile", "analytics", "rating", "success"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        api.setRating({
+            rating: config.rating,
+            comment: config.ratingComment
+        });
+    }
+});
+//# sourceMappingURL=setRating.js.map

package/build/shared/charts/descriptors/service/handover.js

@@ -16,6 +16,10 @@ exports.HANDOVER = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         showIcon: false
     },
+    constraints: {
+        placement: {},
+        creatable: false,
+    },
     fields: [
         {
             key: "text",
@@ -52,6 +56,12 @@ exports.HANDOVER = createNodeDescriptor_1.createNodeDescriptor({
             type: "cognigyText",
             label: "Chatwoot Inbox Id",
             description: "Inbox Id in Chatwoot"
+        },
+        {
+            key: "liveAgentInboxId",
+            type: "cognigyText",
+            label: "Live Agent Inbox Id",
+            description: "Inbox Id in Live Agent"
         }
     ],
     sections: [
@@ -62,6 +72,14 @@ exports.HANDOVER = createNodeDescriptor_1.createNodeDescriptor({
             fields: [
                 "chatwootInboxId",
             ]
+        },
+        {
+            key: "liveAgentSettings",
+            label: "Live Agent Settings",
+            defaultCollapsed: true,
+            fields: [
+                "liveAgentInboxId",
+            ]
         }
     ],
     form: [
@@ -71,10 +89,19 @@ exports.HANDOVER = createNodeDescriptor_1.createNodeDescriptor({
         { type: "field", key: "unsupportedChannel" },
         { type: "field", key: "quickReply" },
         { type: "section", key: "chatwootSettings" },
-    ],
+        // only render this field if "live agent" is enabled
+        process.env.FEATURE_USE_COGNIGY_LIVE_AGENT === "true" && {
+            type: "section",
+            key: "liveAgentSettings"
+        },
+    ]
+        .filter(element => !!element),
     tags: ["service", "livechat", "chat", "hand over"],
     function: async ({ cognigy, config, childConfigs, nodeId }) => {
-        const { api } = cognigy;
+        const { api, input } = cognigy;
+        if (input.channel === "adminconsole") {
+            api.output("You are using the deprecated Handover Node. Please find the new Handover to Agent Node in the Node Selection Menu.", null);
+        }
         await api.handover({ cognigy, config, nodeId, childConfigs });
     }
 });

package/build/shared/charts/descriptors/service/handoverV2.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HANDOVER_V2 = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+exports.HANDOVER_V2 = createNodeDescriptor_1.createNodeDescriptor({
+    type: "handoverToAgent",
+    defaultLabel: "Handover to Agent",
+    summary: "Sends a handover request to an agent",
+    appearance: {
+        showIcon: false
+    },
+    dependencies: {
+        children: [],
+    },
+    fields: [
+        {
+            key: "text",
+            type: "cognigyText",
+            label: "Handover Accepted Message",
+            description: "The message to display to the user once the handover request was accepted by the live chat provider"
+        },
+        {
+            key: "repeatHandoverMessage",
+            type: "toggle",
+            label: "Repeat Handover Accepted Message",
+            description: "Repeatedly respond with Handover Accepted Message for each user input until human agent responds",
+            defaultValue: false,
+        },
+        {
+            key: "cancelIntent",
+            type: "cognigyText",
+            label: "Cancel Intent",
+            description: "Name of the intent which will cancel the handover"
+        },
+        {
+            key: "quickReply",
+            type: "cognigyText",
+            label: "Cancel Button Text",
+            description: "Text of the Quick Reply Button which sends the user back to the Virtual Agent"
+        },
+        {
+            key: "liveAgentInboxId",
+            type: "cognigyText",
+            label: "Live Agent Inbox Id",
+            description: "Inbox Id in Live Agent"
+        },
+        {
+            key: "chatwootInboxId",
+            type: "cognigyText",
+            label: "Chatwoot Inbox Id",
+            description: "Inbox Id in Chatwoot"
+        },
+        {
+            key: "salesforcePrechatEntities",
+            type: "json",
+            label: "Salesforce Prechat Entites",
+            description: "The Salesforce entity that should be used.",
+            defaultValue: "[]",
+        },
+        {
+            key: "salesforcePrechatDetails",
+            label: "Salesforce Prechat Details",
+            type: "json",
+            description: "The details that should be displayed to the Live Chat Agent.",
+            defaultValue: "[]",
+        },
+    ],
+    sections: [
+        {
+            key: "cancelSettings",
+            label: "Cancel Handover Options",
+            defaultCollapsed: true,
+            fields: [
+                "cancelIntent",
+                "quickReply",
+            ]
+        },
+        {
+            key: "liveAgentSettings",
+            label: "Live Agent Settings",
+            defaultCollapsed: true,
+            fields: [
+                "liveAgentInboxId",
+            ]
+        },
+        {
+            key: "chatwootSettings",
+            label: "Chatwoot Settings",
+            defaultCollapsed: true,
+            fields: [
+                "chatwootInboxId",
+            ]
+        },
+        {
+            key: "salesforceSettings",
+            label: "Salesforce Settings",
+            defaultCollapsed: true,
+            fields: [
+                "salesforcePrechatEntities",
+                "salesforcePrechatDetails"
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "text" },
+        { type: "field", key: "repeatHandoverMessage" },
+        { type: "section", key: "cancelSettings" },
+        // only render this field if "live agent" is enabled
+        process.env.FEATURE_USE_COGNIGY_LIVE_AGENT === "true" && {
+            type: "section",
+            key: "liveAgentSettings"
+        },
+        { type: "section", key: "chatwootSettings" },
+        { type: "section", key: "salesforceSettings" }
+    ]
+        .filter(element => !!element),
+    tags: ["service", "livechat", "chat", "hand over"],
+    function: async ({ cognigy, config, childConfigs, nodeId }) => {
+        const { api, input } = cognigy;
+        const result = await api.handoverV2({ cognigy, config, nodeId, childConfigs });
+        if ((result === null || result === void 0 ? void 0 : result.status) === "error") {
+            input.handover = result;
+            return;
+        }
+        api.stopExecution();
+    }
+});
+//# sourceMappingURL=handoverV2.js.map

package/build/shared/charts/descriptors/service/httpRequest.js

@@ -93,16 +93,16 @@ exports.HTTP_REQUEST = createNodeDescriptor_1.createNodeDescriptor({
         },
         {
             key: "headers",
-            type: "json",
+            type: "keyValuePairs",
             label: "Headers",
-            description: "Headers to send in the request",
-            defaultValue: {}
+            description: "Headers to send in the request (key/value pairs)",
+            defaultValue: {},
         },
         {
             key: "payloadType",
             type: "select",
             label: "Payload Type",
-            description: "Whether to send JSON or Text payload in the request",
+            description: "Whether to send JSON, Text or Form-Data payload in the request",
             defaultValue: "json",
             params: {
                 required: true,
@@ -114,6 +114,10 @@ exports.HTTP_REQUEST = createNodeDescriptor_1.createNodeDescriptor({
                     {
                         label: "Text",
                         value: "text"
+                    },
+                    {
+                        label: "Form-Data",
+                        value: "form-data"
                     }
                 ]
             }
@@ -138,6 +142,16 @@ exports.HTTP_REQUEST = createNodeDescriptor_1.createNodeDescriptor({
                 value: "json"
             }
         },
+        {
+            key: "payloadFormData",
+            type: "json",
+            label: "Payload",
+            defaultValue: {},
+            condition: {
+                key: "payloadType",
+                value: "form-data"
+            }
+        },
         {
             key: "storeLocation",
             type: "select",
@@ -350,6 +364,7 @@ exports.HTTP_REQUEST = createNodeDescriptor_1.createNodeDescriptor({
                 "payloadType",
                 "payloadText",
                 "payloadJSON",
+                "payloadFormData",
             ],
             condition: {
                 key: "type",
@@ -372,7 +387,7 @@ exports.HTTP_REQUEST = createNodeDescriptor_1.createNodeDescriptor({
             defaultCollapsed: true,
             fields: [
                 "headers",
-                "storeResponseHeaders"
+                "storeResponseHeaders",
             ]
         },
         {
@@ -436,7 +451,7 @@ exports.HTTP_REQUEST = createNodeDescriptor_1.createNodeDescriptor({
     function: async (httpRequestParams) => {
         const { cognigy, config } = httpRequestParams;
         const { api } = cognigy;
-        const { url, inputKey, contextKey, payloadType, payloadJSON, payloadText, async, storeLocation, authType, } = config;
+        const { url, inputKey, contextKey, payloadType, payloadJSON, payloadText, payloadFormData, async, storeLocation, authType, } = config;
         const { oAuth2Connection } = config;
         const { basicConnection } = config;
         const { apiKeyAuthKeyConnection } = config;
@@ -475,10 +490,14 @@ exports.HTTP_REQUEST = createNodeDescriptor_1.createNodeDescriptor({
                     break;
             }
         }
-        if (payloadType === "json" && typeof payloadJSON === 'object') {
+        if (payloadType === "json" && typeof payloadJSON === "object") {
             config.payloadIsJSON = true;
             config.payload = payloadJSON;
         }
+        else if (payloadType === "form-data" && typeof payloadFormData === "object") {
+            config.payloadIsFormData = true;
+            config.payload = payloadFormData;
+        }
         else {
             config.payloadIsJSON = false;
             config.payload = payloadText;

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

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.HANDOVER = void 0;
+exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.HANDOVER_V2 = exports.HANDOVER = void 0;
 var handover_1 = require("./handover");
 Object.defineProperty(exports, "HANDOVER", { enumerable: true, get: function () { return handover_1.HANDOVER; } });
+var handoverV2_1 = require("./handoverV2");
+Object.defineProperty(exports, "HANDOVER_V2", { enumerable: true, get: function () { return handoverV2_1.HANDOVER_V2; } });
 var httpRequest_1 = require("./httpRequest");
 /* Node */
 Object.defineProperty(exports, "HTTP_REQUEST", { enumerable: true, get: function () { return httpRequest_1.HTTP_REQUEST; } });

package/build/shared/charts/descriptors/service/triggerFunction/onScheduled.js

@@ -11,11 +11,13 @@ exports.ON_SCHEDULED = createNodeDescriptor_1.createNodeDescriptor({
         color: '#57c95b',
         variant: "mini",
         textColor: "white",
+        contrastTextColor: "black",
     },
     constraints: {
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         movable: false,
         placement: {}

package/build/shared/charts/descriptors/service/triggerFunction/onSchedulingError.js

@@ -11,11 +11,13 @@ exports.ON_SCHEDULING_ERROR = createNodeDescriptor_1.createNodeDescriptor({
         color: '#57c95b',
         variant: "mini",
         textColor: "white",
+        contrastTextColor: "black",
     },
     constraints: {
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         movable: false,
         placement: {}

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

@@ -9,6 +9,7 @@ exports.START = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         color: '#61D188',
         textColor: 'white',
+        contrastTextColor: 'black',
         variant: 'mini'
     },
     behavior: {

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

@@ -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

@@ -7,8 +7,8 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const design_1 = require("../utils/design");
 exports.handoverNode = 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",

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

@@ -25,6 +25,7 @@ exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
             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: [
                     {
@@ -34,6 +35,14 @@ exports.playURLNode = createNodeDescriptor_1.createNodeDescriptor({
                     {
                         label: "raw/lpcm16",
                         value: "raw/lpcm16"
+                    },
+                    {
+                        label: "wav/mulaw",
+                        value: "wav/mulaw"
+                    },
+                    {
+                        label: "raw/mulaw",
+                        value: "raw/mulaw"
                     }
                 ]
             }

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

@@ -252,7 +252,7 @@ exports.sendMessageNode = createNodeDescriptor_1.createNodeDescriptor({
             paramUtils_1.compileParams(config, compiledParams);
         }
         if (text) {
-            api.output(text, {
+            api.output(null, {
                 "_cognigy": {
                     "_voiceGateway": {
                         "json": {

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

@@ -84,6 +84,13 @@ const getParameterFields = () => [
         description: "Azure's Custom Speech model ID",
         defaultValue: ""
     },
+    {
+        key: "ttsDeploymentId",
+        type: "cognigyText",
+        label: "Azure TTS Deployment ID",
+        description: "Azure's Custom Speech model deployment ID",
+        defaultValue: ""
+    },
     {
         key: "azureEnableAudioLogging",
         type: "toggle",
@@ -120,7 +127,7 @@ const getParameterFields = () => [
         key: "bargeInMinWordCount",
         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",
+        description: "Defines the minimum number of words that the user must say for the Voice Gateway to consider it a barge in",
         defaultValue: 0,
         params: {
             min: 0,
@@ -391,6 +398,7 @@ const getParamSections = (condition) => [
             "azureUseContextPhrases",
             "sttContextPhrasesAzure",
             "sttContextBoostAzure",
+            "ttsDeploymentId",
             "azureEnableAudioLogging",
         ],
         condition