@cognigy/rest-api-client 0.11.0 → 0.13.0

package/build/shared/charts/descriptors/{profile → analytics}/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OVERWRITE_ANALYTICS = exports.BLIND_MODE = exports.UPDATE_PROFILE = exports.MERGE_PROFILE = exports.DELETE_PROFILE = exports.DEACTIVATE_PROFILE = exports.COMPLETE_GOAL = exports.ACTIVATE_PROFILE = void 0;
+exports.REQUEST_RATING = exports.SET_RATING = exports.OVERWRITE_ANALYTICS = exports.BLIND_MODE = exports.UPDATE_PROFILE = exports.MERGE_PROFILE = exports.DELETE_PROFILE = exports.DEACTIVATE_PROFILE = exports.COMPLETE_GOAL = exports.ACTIVATE_PROFILE = void 0;
 var activateProfile_1 = require("./activateProfile");
 Object.defineProperty(exports, "ACTIVATE_PROFILE", { enumerable: true, get: function () { return activateProfile_1.ACTIVATE_PROFILE; } });
 var completeGoal_1 = require("./completeGoal");
@@ -17,4 +17,8 @@ var blindMode_1 = require("./blindMode");
 Object.defineProperty(exports, "BLIND_MODE", { enumerable: true, get: function () { return blindMode_1.BLIND_MODE; } });
 var overwriteAnalytics_1 = require("./overwriteAnalytics");
 Object.defineProperty(exports, "OVERWRITE_ANALYTICS", { enumerable: true, get: function () { return overwriteAnalytics_1.OVERWRITE_ANALYTICS; } });
+var setRating_1 = require("./setRating");
+Object.defineProperty(exports, "SET_RATING", { enumerable: true, get: function () { return setRating_1.SET_RATING; } });
+var requestRating_1 = require("./requestRating");
+Object.defineProperty(exports, "REQUEST_RATING", { enumerable: true, get: function () { return requestRating_1.REQUEST_RATING; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/{profile → analytics}/mergeProfile.js

@@ -9,7 +9,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  * Purpose:
  * Attempts to merge a profile with another
  */
-exports.MERGE_PROFILE = createNodeDescriptor_1.createNodeDescriptor({
+exports.MERGE_PROFILE = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "mergeProfile",
     defaultLabel: "Merge Profile",
     summary: "Attempts to merge the Contact Profile with another",
@@ -26,7 +26,7 @@ exports.MERGE_PROFILE = createNodeDescriptor_1.createNodeDescriptor({
             }
         }
     ],
-    tags: ["profile"],
+    tags: ["analytics", "profile"],
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         const { contactId } = config;

package/build/shared/charts/descriptors/{profile → analytics}/overwriteAnalytics.js

@@ -9,7 +9,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  * Purpose:
  * Overwrites the analytics record
  */
-exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
+exports.OVERWRITE_ANALYTICS = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "overwriteAnalytics",
     defaultLabel: "Overwrite Analytics",
     summary: "Overwrites the analytics record",
@@ -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",
             ]
         },
     ],
@@ -141,10 +189,17 @@ exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
         { type: "section", key: "customFields" },
         { type: "section", key: "defaultFields" }
     ],
-    tags: ["profile", "analytics", "customize"],
+    tags: ["analytics", "customize"],
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         for (let key of Object.keys(config)) {
+            if (key === "handoverEscalations") {
+                const parsedHandoverEscalations = parseInt(config[key]);
+                if (!isNaN(parsedHandoverEscalations)) {
+                    api.setAnalyticsData(key, parsedHandoverEscalations);
+                }
+                continue;
+            }
             switch (typeof config[key]) {
                 case "string":
                     if (config[key] && config[key].length > 0 && config[key] !== "cUndefined") {

package/build/shared/charts/descriptors/analytics/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 = (0, 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: ["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/analytics/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 = (0, 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: ["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/{profile → analytics}/updateProfile.js

@@ -9,7 +9,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  * Purpose:
  * Adds a value to the contact profile
  */
-exports.UPDATE_PROFILE = createNodeDescriptor_1.createNodeDescriptor({
+exports.UPDATE_PROFILE = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "updateProfile",
     defaultLabel: "Update Profile",
     summary: "Updates a Field in the Contact Profile",
@@ -35,7 +35,7 @@ exports.UPDATE_PROFILE = createNodeDescriptor_1.createNodeDescriptor({
         key: "key",
         type: "text"
     },
-    tags: ["profile"],
+    tags: ["analytics", "profile"],
     function: async ({ cognigy, config }) => {
         const { key, value } = config;
         const { api } = cognigy;

package/build/shared/charts/descriptors/apps/getAppSessionPin.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET_APP_SESSION_PIN = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'getAppSessionPin'
+ *
+ * Purpose:
+ * Retrieve a short-lived Cognigy App Session PIN.
+ */
+exports.GET_APP_SESSION_PIN = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "getAppSessionPin",
+    defaultLabel: "Get App Session PIN",
+    summary: "Get a new App Session PIN.",
+    appearance: {
+        showIcon: false,
+    },
+    fields: [],
+    tags: ["basic", "apps"],
+    tokens: [
+        {
+            type: "input",
+            label: "App Session PIN",
+            script: "input.appSessionPin || ''",
+        },
+        {
+            type: "input",
+            label: "App PIN Page URL",
+            script: `
+(() => {
+	if (!input.shellPageBaseURL) return '';
+	const overrides = input.shellPageOverrides ? \`?overrides=\${encodeURIComponent(JSON.stringify(input.shellPageOverrides))}\` : '';
+	return [input.shellPageBaseURL, overrides].join('');
+})()`
+                .split("\n")
+                .join(" "),
+        },
+    ],
+    function: async ({ cognigy }) => {
+        const { api } = cognigy;
+        const appSessionPin = await api.getAppSessionPin();
+        api.addToInput("appSessionPin", appSessionPin);
+    },
+});
+//# sourceMappingURL=getAppSessionPin.js.map

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_ADAPTIVE_CARD_APP_STATE = exports.SET_HTML_APP_STATE = exports.GET_APP_SESSION_PIN = exports.SET_APP_STATE = exports.INIT_APP_SESSION = void 0;
+var initAppSession_1 = require("./initAppSession");
+Object.defineProperty(exports, "INIT_APP_SESSION", { enumerable: true, get: function () { return initAppSession_1.INIT_APP_SESSION; } });
+var setAppState_1 = require("./setAppState");
+Object.defineProperty(exports, "SET_APP_STATE", { enumerable: true, get: function () { return setAppState_1.SET_APP_STATE; } });
+var getAppSessionPin_1 = require("./getAppSessionPin");
+Object.defineProperty(exports, "GET_APP_SESSION_PIN", { enumerable: true, get: function () { return getAppSessionPin_1.GET_APP_SESSION_PIN; } });
+var setHtmlAppState_1 = require("./setHtmlAppState");
+Object.defineProperty(exports, "SET_HTML_APP_STATE", { enumerable: true, get: function () { return setHtmlAppState_1.SET_HTML_APP_STATE; } });
+var setAdaptiveCardAppState_1 = require("./setAdaptiveCardAppState");
+Object.defineProperty(exports, "SET_ADAPTIVE_CARD_APP_STATE", { enumerable: true, get: function () { return setAdaptiveCardAppState_1.SET_ADAPTIVE_CARD_APP_STATE; } });
+//# sourceMappingURL=index.js.map