@cognigy/rest-api-client 2025.24.0 → 2025.25.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2025.25.0
+Released: December 09th, 2025 
+
+Released state of package up to date with Cognigy.AI v2025.25.0 
+
 # 2025.24.0
 Released: November 25th, 2025 
 

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cognigyDocumentParserProviderModule = exports.cognigyTranslationProviderModule = exports.cognigySpeechProviderModule = exports.cognigyGenerativeAIProviderModule = exports.cognigyInternalStorageProviderModule = exports.cognigyVoiceGateway2Module = exports.cognigyMicrosoftModule = exports.cognigyVoiceGatewayModule = exports.cognigySMTPModule = exports.cognigySQLModule = exports.cognigyMongoDBModule = exports.cognigyBasicModule = void 0;
+exports.niceCXoneKnowledgehubProviderModule = exports.cognigyDocumentParserProviderModule = exports.cognigyTranslationProviderModule = exports.cognigySpeechProviderModule = exports.cognigyGenerativeAIProviderModule = exports.cognigyInternalStorageProviderModule = exports.cognigyVoiceGateway2Module = exports.cognigyMicrosoftModule = exports.cognigyVoiceGatewayModule = exports.cognigySMTPModule = exports.cognigySQLModule = exports.cognigyMongoDBModule = exports.cognigyBasicModule = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../createNodeDescriptor");
 /* Nodes */
@@ -150,6 +150,8 @@ if (process.env.DISABLE_FEATURE_TRANSCRIPT_MANAGER !== "true") {
     nodes.push(service_1.AI_AGENT_JOB_CALL_MCP_TOOL);
     nodes.push(service_1.AI_AGENT_TOOL_ANSWER);
     nodes.push(service_1.KNOWLEDGE_TOOL);
+    nodes.push(service_1.HANDOVER_TO_AI_AGENT_TOOL);
+    nodes.push(service_1.SEND_EMAIL_TOOL);
     nodes.push(service_1.AI_AGENT_HANDOVER);
     nodes.push(service_1.LOAD_AI_AGENT);
 }
@@ -200,4 +202,6 @@ var translationProviders_1 = require("./connectionNodes/translationProviders");
 Object.defineProperty(exports, "cognigyTranslationProviderModule", { enumerable: true, get: function () { return translationProviders_1.cognigyTranslationProviderModule; } });
 var documentParserProviders_1 = require("./connectionNodes/documentParserProviders");
 Object.defineProperty(exports, "cognigyDocumentParserProviderModule", { enumerable: true, get: function () { return documentParserProviders_1.cognigyDocumentParserProviderModule; } });
+var CXoneKnowledgehubProviderModule_1 = require("./service/cxone/knowledgehub/CXoneKnowledgehubProviderModule");
+Object.defineProperty(exports, "niceCXoneKnowledgehubProviderModule", { enumerable: true, get: function () { return CXoneKnowledgehubProviderModule_1.niceCXoneKnowledgehubProviderModule; } });
 //# sourceMappingURL=index.js.map

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

@@ -19,6 +19,9 @@ exports.PLACEHOLDER = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "text",
             label: "UI__NODE_EDITOR__PLACEHOLDER__FIELDS__TEXT__LABEL",
             type: "text",
+            params: {
+                multiline: true
+            },
         },
         {
             key: "data",

package/build/shared/charts/descriptors/service/agentTools/handoverToAiAgentTool.js

@@ -0,0 +1,192 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HANDOVER_TO_AI_AGENT_TOOL = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+const transcripts_1 = require("../../../../interfaces/transcripts/transcripts");
+exports.HANDOVER_TO_AI_AGENT_TOOL = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "handoverToAiAgentTool",
+    defaultLabel: "Handover to AI Agent Tool",
+    parentType: ["aiAgentJob", "llmPromptV2"],
+    constraints: {
+        editable: true,
+        deletable: true,
+        collapsable: true,
+        creatable: true,
+        movable: true,
+        placement: {
+            predecessor: {
+                whitelist: []
+            }
+        },
+        childFlowCreatable: false
+    },
+    behavior: {
+        stopping: true
+    },
+    preview: {
+        type: "text",
+        key: "toolId"
+    },
+    fields: [
+        {
+            key: "toolId",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__DESCRIPTION",
+            type: "cognigyLLMText",
+            defaultValue: "handover_to_ai_agent",
+            params: {
+                required: true,
+                rows: 1,
+                multiline: false,
+                maxLength: 64,
+            }
+        },
+        {
+            key: "description",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__DESCRIPTION",
+            type: "cognigyLLMText",
+            params: {
+                required: true,
+                rows: 5,
+                multiline: true,
+                placeholder: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AI_AGENT_TOOL__FIELDS__DESCRIPTION__PLACEHOLDER"
+            }
+        },
+        {
+            key: "parameters",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__PARAMETERS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__PARAMETERS__DESCRIPTION",
+            type: "toolParameters",
+            defaultValue: `{
+	"type": "object",
+	"properties": {
+		"handover_reason": {
+			"type": "string",
+			"description": "The reason for handing over to the AI Agent, including context from the conversation."
+		}
+	},
+	"required": ["handover_reason"],
+	"additionalProperties": false
+}`,
+            params: {
+                required: false,
+            },
+        },
+        {
+            key: "flowNode",
+            type: "flowNode",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AI_AGENT_TOOL__FIELDS__FLOW_NODE__LABEL",
+            params: {
+                required: true,
+                nodeTypeFilter: ["aiAgentJob"]
+            }
+        },
+        {
+            key: "debugMessage",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__DESCRIPTION",
+            defaultValue: true,
+        },
+        {
+            key: "condition",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__DESCRIPTION",
+            type: "cognigyText",
+            defaultValue: "",
+        },
+    ],
+    sections: [
+        {
+            key: "debugging",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__DEBUG_SETTINGS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "debugMessage",
+            ],
+        },
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__ADVANCED__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "condition",
+            ],
+        },
+    ],
+    form: [
+        { type: "field", key: "toolId" },
+        { type: "field", key: "description" },
+        { type: "field", key: "flowNode" },
+        { type: "section", key: "debugging" },
+        { type: "section", key: "advanced" },
+    ],
+    appearance: {
+        color: "white",
+        textColor: "#252525",
+        variant: "mini",
+    },
+    function: async ({ cognigy, config, nodeId: thisNodeId }) => {
+        var _a, _b, _c, _d, _e, _f;
+        const { api } = cognigy;
+        const { debugMessage, flowNode } = config;
+        const sessionState = await api.loadSessionState();
+        const toolCall = (_a = sessionState.lastToolCall) === null || _a === void 0 ? void 0 : _a.toolCall;
+        if (!(toolCall === null || toolCall === void 0 ? void 0 : toolCall.id)) {
+            (_b = api.logDebugError) === null || _b === void 0 ? void 0 : _b.call(api, "UI__DEBUG_MODE__AI_AGENT_ANSWER__ERROR__MESSAGE");
+        }
+        if (!(flowNode === null || flowNode === void 0 ? void 0 : flowNode.flow) || !(flowNode === null || flowNode === void 0 ? void 0 : flowNode.node)) {
+            throw new Error("Flow Node is required for Handover to AI Agent Tool");
+        }
+        if (toolCall) {
+            if (!((_c = api.checkThink) === null || _c === void 0 ? void 0 : _c.call(api, thisNodeId))) {
+                const handoverReason = ((_e = (_d = toolCall === null || toolCall === void 0 ? void 0 : toolCall.function) === null || _d === void 0 ? void 0 : _d.arguments) === null || _e === void 0 ? void 0 : _e.handover_reason) || "Handover requested";
+                // Optional Debug Message
+                if (debugMessage) {
+                    (_f = api.logDebugMessage) === null || _f === void 0 ? void 0 : _f.call(api, JSON.stringify({ handover_reason: handoverReason, target_flow: flowNode.flow, target_node: flowNode.node }, null, 2));
+                }
+                // Add Tool Call Message to Transcript
+                const toolCallTranscriptStep = {
+                    role: transcripts_1.TranscriptRole.ASSISTANT,
+                    type: transcripts_1.TranscriptEntryType.TOOL_CALL,
+                    source: "system",
+                    payload: {
+                        name: toolCall.function.name,
+                        id: toolCall.id,
+                        input: toolCall.function.arguments,
+                    }
+                };
+                await api.addTranscriptStep(toolCallTranscriptStep);
+                // Add Tool Answer Message to Transcript
+                const toolAnswer = {
+                    role: transcripts_1.TranscriptRole.TOOL,
+                    type: transcripts_1.TranscriptEntryType.TOOL_ANSWER,
+                    source: "system",
+                    payload: {
+                        toolCallId: toolCall.id,
+                        name: toolCall.function.name,
+                        content: `Handover to AI Agent initiated. Reason: ${handoverReason}`,
+                    }
+                };
+                await api.addTranscriptStep(toolAnswer);
+                api.resetNextNodes();
+                api.updateSessionStateValues({
+                    lastToolCall: undefined
+                });
+                await api.executeFlow({
+                    flowNode: {
+                        flow: flowNode.flow,
+                        node: flowNode.node,
+                    },
+                    absorbContext: true,
+                });
+            }
+            else {
+                throw new Error("Infinite Loop Detected");
+            }
+        }
+    }
+});
+//# sourceMappingURL=handoverToAiAgentTool.js.map

package/build/shared/charts/descriptors/service/agentTools/sendEmailTool.js

@@ -0,0 +1,243 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEND_EMAIL_TOOL = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+const transcripts_1 = require("../../../../interfaces/transcripts/transcripts");
+exports.SEND_EMAIL_TOOL = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "sendEmailTool",
+    defaultLabel: "Send Email Tool",
+    parentType: ["aiAgentJob", "llmPromptV2"],
+    constraints: {
+        editable: true,
+        deletable: true,
+        collapsable: true,
+        creatable: true,
+        movable: true,
+        placement: {
+            predecessor: {
+                whitelist: []
+            }
+        },
+        childFlowCreatable: false
+    },
+    behavior: {
+        stopping: true
+    },
+    preview: {
+        type: "text",
+        key: "toolId"
+    },
+    fields: [
+        {
+            key: "toolId",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__DESCRIPTION",
+            type: "cognigyLLMText",
+            defaultValue: "send_email",
+            params: {
+                required: true,
+                rows: 1,
+                multiline: false,
+                maxLength: 64,
+            }
+        },
+        {
+            key: "description",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__DESCRIPTION",
+            type: "cognigyLLMText",
+            defaultValue: "Create and send a new email message.",
+            params: {
+                required: true,
+                rows: 5,
+                multiline: true
+            }
+        },
+        {
+            key: "recipient",
+            label: "UI__NODE_EDITOR__SMTP__EMAIL_NOTIFICATION__RECIPIENT__LABEL",
+            description: "UI__NODE_EDITOR__SMTP__EMAIL_NOTIFICATION__RECIPIENT__DESCRIPTION",
+            type: "cognigyText",
+            params: {
+                required: true,
+                rows: 1,
+                multiline: false,
+                maxLength: 255,
+            },
+        },
+        {
+            key: "parameters",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__PARAMETERS__LABEL",
+            type: "toolParameters",
+            defaultValue: `{
+	"type": "object",
+	"properties": {
+		"subject": {
+			"type": "string",
+			"description": "The subject of the email."
+		},
+		"message": {
+			"type": "string",
+			"description": "The body of the email."
+		}
+	},
+	"required": ["subject", "message"],
+	"additionalProperties": false
+}`,
+        },
+        {
+            key: "debugMessage",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__DESCRIPTION",
+            defaultValue: true,
+        },
+        {
+            key: "condition",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__DESCRIPTION",
+            type: "cognigyText",
+            defaultValue: "",
+        },
+    ],
+    sections: [
+        {
+            key: "debugging",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__DEBUG_SETTINGS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "debugMessage",
+            ],
+        },
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__ADVANCED__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "condition"
+            ]
+        },
+    ],
+    form: [
+        { type: "field", key: "toolId" },
+        { type: "field", key: "description" },
+        { type: "field", key: "recipient" },
+        { type: "section", key: "debugging" },
+        { type: "section", key: "advanced" },
+    ],
+    appearance: {
+        color: "white",
+        textColor: "#252525",
+        variant: "mini",
+    },
+    function: async ({ cognigy, config, nodeId, nodeType, organisationId, projectId, childConfigs }) => {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const { api, context, input } = cognigy;
+        const { debugMessage, recipient, } = config;
+        const sessionState = await api.loadSessionState();
+        const toolCall = (_a = sessionState.lastToolCall) === null || _a === void 0 ? void 0 : _a.toolCall;
+        const aiAgentJobNode = (_b = sessionState.lastToolCall) === null || _b === void 0 ? void 0 : _b.aiAgentJobNode;
+        if (!(toolCall === null || toolCall === void 0 ? void 0 : toolCall.id)) {
+            (_c = api.logDebugError) === null || _c === void 0 ? void 0 : _c.call(api, "UI__DEBUG_MODE__AI_AGENT_ANSWER__ERROR__MESSAGE");
+        }
+        if (toolCall && aiAgentJobNode) {
+            if (!((_d = api.checkThink) === null || _d === void 0 ? void 0 : _d.call(api, nodeId))) {
+                const { subject, message } = toolCall.function.arguments;
+                let result;
+                try {
+                    result = await ((_e = api === null || api === void 0 ? void 0 : api.emailNotification) === null || _e === void 0 ? void 0 : _e.call(api, {
+                        cognigy,
+                        config: {
+                            recipient,
+                            subject,
+                            message,
+                            cc: "",
+                            bcc: "",
+                            priority: "normal",
+                            async: false,
+                            storeLocation: "none",
+                            inputKey: "",
+                            contextKey: "",
+                            stopOnError: false,
+                        },
+                        nodeId,
+                        nodeType,
+                        organisationId,
+                        projectId,
+                        childConfigs,
+                    }));
+                }
+                catch (error) {
+                    // Log error message to debug mode
+                    const errorMessage = error instanceof Error ? error.message : String(error);
+                    (_f = api.logDebugError) === null || _f === void 0 ? void 0 : _f.call(api, errorMessage, "UI__DEBUG_MODE__AI_AGENT__SEND_EMAIL_TOOL__ERROR");
+                    // Pass error message to LLM as result
+                    result = errorMessage;
+                }
+                // Optional Debug Message of Email sending and response
+                if (debugMessage) {
+                    const messageLines = [];
+                    if (recipient) {
+                        messageLines.push(`\n<b>UI__DEBUG_MODE__AI_AGENT__SEND_EMAIL_TOOL__RECIPIENT</b> ${recipient}`);
+                    }
+                    if (subject) {
+                        messageLines.push(`\n<b>UI__DEBUG_MODE__AI_AGENT__SEND_EMAIL_TOOL__SUBJECT</b> ${subject}`);
+                    }
+                    if (message) {
+                        messageLines.push(`\n<b>UI__DEBUG_MODE__AI_AGENT__SEND_EMAIL_TOOL__MESSAGE</b> ${message}`);
+                    }
+                    if (result) {
+                        const resultString = typeof result === 'string' ? result : JSON.stringify(result, null, 2);
+                        messageLines.push(`\n<b>UI__DEBUG_MODE__AI_AGENT__SEND_EMAIL_TOOL__RESULT</b>\n${resultString}`);
+                    }
+                    (_g = api.logDebugMessage) === null || _g === void 0 ? void 0 : _g.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT__SEND_EMAIL_TOOL__HEADER");
+                }
+                const { flow, node } = aiAgentJobNode;
+                if (flow && node) {
+                    // Add Tool Call Message to Transcript
+                    const toolCallTranscriptStep = {
+                        role: transcripts_1.TranscriptRole.ASSISTANT,
+                        type: transcripts_1.TranscriptEntryType.TOOL_CALL,
+                        source: "system",
+                        payload: {
+                            name: toolCall.function.name,
+                            id: toolCall.id,
+                            input: toolCall.function.arguments,
+                        }
+                    };
+                    await api.addTranscriptStep(toolCallTranscriptStep);
+                    // Add Tool Answer Message to Transcript
+                    const resultString = typeof result === 'string' ? result : JSON.stringify(result);
+                    const toolAnswer = {
+                        role: transcripts_1.TranscriptRole.TOOL,
+                        type: transcripts_1.TranscriptEntryType.TOOL_ANSWER,
+                        source: "system",
+                        payload: {
+                            toolCallId: toolCall.id,
+                            name: toolCall.function.name,
+                            content: `Send email result:\n${resultString}`,
+                        }
+                    };
+                    await api.addTranscriptStep(toolAnswer);
+                    api.resetNextNodes();
+                    // remove the call from the session state, because the call has been answered
+                    api.updateSessionStateValues({
+                        lastToolCall: undefined
+                    });
+                    await api.executeFlow({
+                        flowNode: {
+                            flow,
+                            node,
+                        },
+                        absorbContext: true,
+                    });
+                }
+            }
+            else {
+                throw new Error("Infinite Loop Detected");
+            }
+        }
+    }
+});
+//# sourceMappingURL=sendEmailTool.js.map

package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js

@@ -24,7 +24,7 @@ const generateSearchPrompt_1 = require("./helpers/generateSearchPrompt");
 const getUserMemory_1 = require("./helpers/getUserMemory");
 const createToolDefinitions_1 = require("./helpers/createToolDefinitions");
 const transcripts_1 = require("../../../../interfaces/transcripts/transcripts");
-exports.AI_AGENT_TOOLS_WHITELIST = ["aiAgentJobDefault", "aiAgentJobTool", "aiAgentJobMCPTool", "knowledgeTool"];
+exports.AI_AGENT_TOOLS_WHITELIST = ["aiAgentJobDefault", "aiAgentJobTool", "aiAgentJobMCPTool", "knowledgeTool", "handoverToAiAgentTool", "sendEmailTool"];
 exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "aiAgentJob",
     defaultLabel: "AI Agent",