@cognigy/rest-api-client 0.14.0 → 0.16.0

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

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HANDOVER_V2 = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const constants_1 = require("../../../constants");
 exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "handoverToAgent",
     defaultLabel: "Handover to Agent",
-    summary: "Sends a handover request to an agent",
+    summary: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SUMMARY",
     appearance: {
         showIcon: false
     },
@@ -17,41 +18,41 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             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"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__TEXT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__TEXT__DESCRIPTION"
         },
         {
             key: "repeatHandoverMessage",
             type: "toggle",
-            label: "Repeat Handover Accepted Message",
-            description: "Repeatedly respond with Handover Accepted Message for each user input until human agent responds",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__REPEAT_HANDOVER_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__REPEAT_HANDOVER_MESSAGE__DESCRIPTION",
             defaultValue: false,
         },
         {
             key: "cancelIntent",
             type: "cognigyText",
-            label: "Cancel Intent",
-            description: "Name of the intent which will cancel the handover"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__CANCEL_INTENT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__CANCEL_INTENT__DESCRIPTION"
         },
         {
             key: "quickReply",
             type: "cognigyText",
-            label: "Cancel Button Text",
-            description: "Text of the Quick Reply Button which sends the user back to the Virtual Agent"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__QUICK_REPLY__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__QUICK_REPLY__DESCRIPTION"
         },
         {
             key: "resolveBehavior",
             type: "select",
-            label: "On Resolve Behavior",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__RESOLVE_BEHAVIOUR__LABEL",
             defaultValue: "resetEntrypoint",
             params: {
                 options: [
                     {
-                        label: "Continue Flow below this Node",
+                        label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__RESOLVE_BEHAVIOUR__OPTIONS__RESET_ENTRY_POINT__LABEL",
                         value: "resetEntrypoint"
                     },
                     {
-                        label: "Continue Flow at current Entrypoint",
+                        label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__RESOLVE_BEHAVIOUR__OPTIONS__CONTINUE_ENTRY_POINT__LABEL",
                         value: "continueEntrypoint",
                     },
                 ],
@@ -60,86 +61,185 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "additionalCategoryIds",
             type: "cognigyTextArray",
-            label: "Additional Category Ids",
-            description: "Additional Category Ids to be passed to Ring Central Engage handover provider",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__ADDITIONAL_CATEGORY_IDS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__ADDITIONAL_CATEGORY_IDS__DESCRIPTION",
             defaultValue: []
         },
         {
             key: "sendResolveEvent",
             type: "toggle",
-            label: "Send resolve event to Virtual Agent",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SEND_RESOLVE_EVENT__LABEL",
             defaultValue: true,
         },
         {
-            key: "liveAgentInboxId",
+            key: constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_INBOX_ID,
             type: "cognigyText",
-            label: "Live Agent Inbox Id",
-            description: "Inbox Id in Live Agent"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_INBOXID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_INBOXID__DESCRIPTION"
         },
         {
-            key: "agentAssistInitMessage",
+            key: constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_SKILLS,
+            type: "cognigyTextArray",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_SKILLS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_SKILLS__DESCRIPTION",
+        },
+        {
+            key: constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_LANGUAGES,
+            type: "cognigyTextArray",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_LANGUAGES__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_LANGUAGES__DESCRIPTION",
+        },
+        {
+            key: constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_PRIORITY,
+            type: "select",
+            defaultValue: 'none',
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_PRIORITY__LABEL",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_PRIORITY__OPTIONS__NONE__LABEL",
+                        value: 'none'
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_PRIORITY__OPTIONS__URGENT__LABEL",
+                        value: "urgent"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_PRIORITY__OPTIONS__HIGH__LABEL",
+                        value: "high"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_PRIORITY__OPTIONS__MEDIUM__LABEL",
+                        value: "medium"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__LIVE_AGENT_PRIORITY__OPTIONS__LOW__LABEL",
+                        value: "low"
+                    },
+                ],
+            }
+        },
+        {
+            key: constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.AGENT_ASSIST_INIT_MESSAGE,
             type: "cognigyText",
-            label: "Initial Agent Assist Trigger",
-            description: "If an Assist Flow is configured, this trigger message is sent to it as an input upon Live Agent handover"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__AGENT_ASSIST_INIT_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__AGENT_ASSIST_INIT_MESSAGE__DESCRIPTION"
         },
         {
-            key: "allowAgentInject",
+            key: constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.ALLOW_AGENT_INJECT,
             type: "toggle",
-            label: "Allow to reply as user via UI",
-            description: "Display a button allowing human agents to reply as end user",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__ALLOW_AGENT_INJECT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__ALLOW_AGENT_INJECT__DESCRIPTION",
             defaultValue: false,
         },
         {
             key: "chatwootInboxId",
             type: "cognigyText",
-            label: "Chatwoot Inbox Id",
-            description: "Inbox Id in Chatwoot"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__CHATWOOT_INBOXID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__CHATWOOT_INBOXID__DESCRIPTION"
         },
         {
             key: "sendTranscriptAsFirstMessage",
             type: "toggle",
-            label: "Send Transcript as first message",
-            description: "The Salesforce receives conversation transcript as a first message.",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SEND_TRANSCRIPT_AS_FIRST_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SEND_TRANSCRIPT_AS_FIRST_MESSAGE__DESCRIPTION",
             defaultValue: false,
         },
+        {
+            key: "buttonId",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__BUTTON_ID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__BUTTON_ID__DESCRIPTION",
+        },
         {
             key: "salesforcePrechatEntities",
             type: "json",
-            label: "Salesforce Prechat Entites",
-            description: "The Salesforce entity that should be used.",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SALES_FORCE_PERCHAT_ENTITIES__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SALES_FORCE_PERCHAT_ENTITIES__DESCRIPTION",
             defaultValue: "[]",
         },
         {
             key: "salesforcePrechatDetails",
-            label: "Salesforce Prechat Details",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SALES_FORCE_PERCHAT_DETAILS__LABEL",
             type: "json",
-            description: "The details that should be displayed to the Live Chat Agent.",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SALES_FORCE_PERCHAT_DETAILS__DESCRIPTION",
             defaultValue: "[]",
         },
+        {
+            key: "genesysLanguage",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_LANGUAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_LANGUAGE__DESCRIPTION",
+        },
+        {
+            key: "genesysSkills",
+            type: "cognigyTextArray",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_SKILLS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_SKILLS__DESCRIPTION",
+            defaultValue: [],
+        },
+        {
+            key: "genesysPriority",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_PRIORITY__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_PRIORITY__DESCRIPTION",
+        },
+        {
+            key: "genesysCustomAttributes",
+            type: "json",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_CUSTOM_ATTRIBUTES__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__GENESYS_CUSTOM_ATTRIBUTES__DESCRIPTION",
+            defaultValue: {},
+        },
         {
             key: "eightByEightChannelId",
             type: "cognigyText",
-            label: "8x8 Channel Id",
-            description: "The 8x8 Channel Id that should be used.",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__EIGTH_BY_EIGHT_CHANNELID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__EIGTH_BY_EIGHT_CHANNELID__DESCRIPTION",
         },
         {
             key: "eightByEightQueueId",
             type: "cognigyText",
-            label: "8x8 Queue Id",
-            description: "The 8x8 Queue Id that should be used.",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__EIGTH_BY_EIGHT_QUEUEID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__EIGTH_BY_EIGHT_QUEUEID__DESCRIPTION",
         },
         {
             key: "eightByEightJSONProps",
             type: "json",
-            label: "8x8 JSON properties",
-            description: "Extend 8x8 properties with custom JSON.",
-            defaultValue: [],
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__EIGTH_BY_EIGHT_JSONPROPS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__EIGTH_BY_EIGHT_JSONPROPS__DESCRIPTION",
+            defaultValue: {
+                "name": null,
+                "userId": null,
+                "email": null,
+                "phone": null,
+                "company": null,
+                "caseId": null,
+                "language": null,
+                "additionalProperties": [
+                    { "key": "Key name", "value": "Value from Cognigy" }
+                ]
+            },
+        },
+        {
+            key: "sendOnQueueEvent",
+            type: "toggle",
+            defaultValue: false,
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SEND_ON_QUEUE_EVENT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SEND_ON_QUEUE_EVENT__DESCRIPTION",
+        },
+        {
+            key: "sendOnActiveEvent",
+            type: "toggle",
+            defaultValue: false,
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SEND_ON_ACTIVE_EVENT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__SEND_ON_ACTIVE_EVENT__DESCRIPTION",
         },
     ],
     sections: [
         {
             key: "cancelSettings",
-            label: "Cancel Handover Options",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__CANCEL_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "cancelIntent",
@@ -148,7 +248,7 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "resolveOptions",
-            label: "On Resolve Options",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__RESOLVE_OPTIONS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "resolveBehavior",
@@ -157,17 +257,20 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "liveAgentSettings",
-            label: "Live Agent Settings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__LIVE_AGENT_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
-                "liveAgentInboxId",
-                "agentAssistInitMessage",
-                "allowAgentInject"
+                constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_INBOX_ID,
+                constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_SKILLS,
+                constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_LANGUAGES,
+                constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_PRIORITY,
+                constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.AGENT_ASSIST_INIT_MESSAGE,
+                constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.ALLOW_AGENT_INJECT,
             ]
         },
         {
             key: "chatwootSettings",
-            label: "Chatwoot Settings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__CHATWOOT_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "chatwootInboxId",
@@ -175,17 +278,29 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "salesforceSettings",
-            label: "Salesforce Settings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__SALES_FORCE_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "sendTranscriptAsFirstMessage",
+                "buttonId",
                 "salesforcePrechatEntities",
                 "salesforcePrechatDetails"
             ]
         },
+        {
+            key: "genesysSettings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__GENESYS_SETTINGS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "genesysLanguage",
+                "genesysSkills",
+                "genesysPriority",
+                "genesysCustomAttributes"
+            ]
+        },
         {
             key: "eightByEightSettings",
-            label: "8x8 Settings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__EIGHT_BY_EIGHT_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "eightByEightChannelId",
@@ -195,11 +310,20 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "ringCentralEngageSettings",
-            label: "Ring Central Engage Settings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__RING_CENTRAL_ENGAGE_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "additionalCategoryIds",
             ]
+        },
+        {
+            key: "eventSettings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__SECTIONS__EVENT_SETTINGS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "sendOnQueueEvent",
+                "sendOnActiveEvent",
+            ]
         }
     ],
     form: [
@@ -214,8 +338,10 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         { type: "section", key: "chatwootSettings" },
         { type: "section", key: "salesforceSettings" },
+        { type: "section", key: "genesysSettings" },
         { type: "section", key: "eightByEightSettings" },
         { type: "section", key: "ringCentralEngageSettings" },
+        { type: "section", key: "eventSettings" },
     ]
         .filter(element => !!element),
     tags: ["service", "livechat", "chat", "hand over"],
@@ -228,11 +354,13 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
             childConfigs,
             nodeType: nodeType || "handoverToAgent",
         });
+        input.handover = result;
         if ((result === null || result === void 0 ? void 0 : result.status) === "error") {
-            input.handover = result;
             return;
         }
-        api.stopExecution();
+        if (!config.sendOnQueueEvent) {
+            api.stopExecution();
+        }
     }
 });
 //# sourceMappingURL=handoverV2.js.map