@cognigy/rest-api-client 2025.25.0 → 2026.1.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2026.1.0
+Released: January 19th, 2026 
+
+Released state of package up to date with Cognigy.AI v2026.1.0 
+
 # 2025.25.0
 Released: December 09th, 2025 
 

package/build/apigroups/ResourcesAPIGroup_2_0.js

@@ -630,6 +630,20 @@ const ResourcesAPIGroup_2_0 = (instance) => {
             var { knowledgeStoreId, sourceId, chunkId } = _a, args = __rest(_a, ["knowledgeStoreId", "sourceId", "chunkId"]);
             return (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/knowledgestores/${knowledgeStoreId}/sources/${sourceId}/chunks/${chunkId}`, "PATCH", self)(args, options);
         },
+        indexKnowledgeConnectors: (_a, options) => {
+            var { knowledgeStoreId } = _a, args = __rest(_a, ["knowledgeStoreId"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/knowledgestores/${knowledgeStoreId}/connectors?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options);
+        },
+        createKnowledgeConnector: (_a, options) => {
+            var { knowledgeStoreId } = _a, args = __rest(_a, ["knowledgeStoreId"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/knowledgestores/${knowledgeStoreId}/connectors`, "POST", self)(args, options);
+        },
+        readKnowledgeConnector: ({ knowledgeStoreId, connectorId }, options) => (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/knowledgestores/${knowledgeStoreId}/connectors/${connectorId}`, "GET", self)(undefined, options),
+        updateKnowledgeConnector: (_a, options) => {
+            var { knowledgeStoreId, connectorId } = _a, args = __rest(_a, ["knowledgeStoreId", "connectorId"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/knowledgestores/${knowledgeStoreId}/connectors/${connectorId}`, "PATCH", self)(args, options);
+        },
+        deleteKnowledgeConnector: ({ knowledgeStoreId, connectorId }, options) => (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/knowledgestores/${knowledgeStoreId}/connectors/${connectorId}`, "DELETE", self)(undefined, options),
         uploadResumable: (args) => (0, GenericTusFn_1.GenericTusFn)("/new/v2.0/uploads", self)(args),
         generateNluScores: (_a) => {
             var { projectId } = _a, args = __rest(_a, ["projectId"]);

package/build/apigroups/SimulationAPIGroup_2_0.js

@@ -64,7 +64,21 @@ function SimulationAPIGroup_2_0(instance) {
         generatePersona: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/testing/beta/personas/generate", "POST", self)(args, options),
         regeneratePersonaField: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/testing/beta/personas/regenerate-field", "POST", self)(args, options),
         generateBulkPersona: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/testing/beta/personas/generate-bulk", "POST", self)(args, options),
-        generatePersonaFromTranscript: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/testing/beta/personas/from-transcript", "POST", self)(args, options)
+        generatePersonaFromTranscript: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/testing/beta/personas/from-transcript", "POST", self)(args, options),
+        getScheduler: (_a, options) => {
+            var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/schedules?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options);
+        },
+        createScheduler: (_a, options) => {
+            var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/schedules`, "POST", self)(args, options);
+        },
+        updateScheduler: (_a, options) => {
+            var { simulationReference, schedulerId, projectId } = _a, args = __rest(_a, ["simulationReference", "schedulerId", "projectId"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/schedules/${schedulerId}?${(0, query_1.stringifyQuery)({
+                projectId
+            })}`, "PATCH", self)(args, options);
+        }
     };
 }
 exports.SimulationAPIGroup_2_0 = SimulationAPIGroup_2_0;

package/build/authentication/AuthenticationAPI.js

@@ -68,6 +68,7 @@ function AuthenticationAPI(instance) {
             var { loginToken } = _a, args = __rest(_a, ["loginToken"]);
             return (0, GenericAPIFn_1.GenericAPIFn)(`/auth/exchangetoken?${(0, rest_1.stringifyQuery)({ loginToken })}`, "GET", self)(args, Object.assign({ withAuthentication: false, withCredentials: true }, options));
         },
+        exchangeCXoneToken: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/auth/exchangetoken/cxone", "POST", self)(args, Object.assign({ withAuthentication: false, withCredentials: true }, options)),
         generateManagementUIAuthToken: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/new/management/auth/token", "POST", self)(args, options)
     };
 }

package/build/shared/charts/createNodeDescriptor.js

@@ -25,6 +25,7 @@ const createNodeDescriptor = (params) => {
         tags: tags || [],
         tokens: tokens || [],
         function: params.function || null,
+        mocking: params.mocking || { defaultMockCode: "" }
     };
 };
 exports.createNodeDescriptor = createNodeDescriptor;

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

@@ -194,6 +194,20 @@ exports.OVERWRITE_ANALYTICS = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "section", key: "defaultFields" }
     ],
     tags: ["analytics", "customize"],
+    mocking: {
+        defaultMockCode: `
+				analyticsdata.intent = 'intent override';
+				analyticsdata.inputText = 'inputText override';
+				analyticsdata.inputData = {data: 'inputData override'};
+				analyticsdata.intentScore = 0.8;
+				analyticsdata.slots = {
+				NUMBER: [
+					1100
+				]
+				};
+				analyticsdata.understood = true;
+			`
+    },
     function: async ({ cognigy, config }) => {
         const { api } = cognigy;
         let stringUpdateValue = "";

package/build/shared/charts/descriptors/analytics/updateProfile.js

@@ -36,6 +36,11 @@ exports.UPDATE_PROFILE = (0, createNodeDescriptor_1.createNodeDescriptor)({
         type: "text"
     },
     tags: ["analytics", "profile"],
+    mocking: {
+        defaultMockCode: `
+				profile.name = "John Doe"
+			`
+    },
     function: async ({ cognigy, config }) => {
         const { key, value } = config;
         const { api } = cognigy;

package/build/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js

@@ -10,6 +10,12 @@ exports.EMAIL_NOTIFICATION = (0, createNodeDescriptor_1.createNodeDescriptor)({
     defaultLabel: "Email Notification",
     summary: "UI__NODE_EDITOR__SMTP__EMAIL_NOTIFICATION__SUMMARY",
     fields: [
+        {
+            key: "senderName",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SMTP__EMAIL_NOTIFICATION__SENDER_NAME__LABEL",
+            description: "UI__NODE_EDITOR__SMTP__EMAIL_NOTIFICATION__SENDER_NAME__DESCRIPTION"
+        },
         {
             key: "recipient",
             type: "cognigyText",
@@ -162,6 +168,7 @@ exports.EMAIL_NOTIFICATION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
     ],
     form: [
+        { key: "senderName", type: "field" },
         { key: "recipient", type: "field" },
         { key: "subject", type: "field" },
         { key: "message", type: "field" },

package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js

@@ -173,6 +173,15 @@ exports.SEND_EMAIL = (0, createNodeDescriptor_1.createNodeDescriptor)({
             label: "UI__NODE_EDITOR__SMTP__SEND_EMAIL__FROM__LABEL",
             description: "UI__NODE_EDITOR__SMTP__SEND_EMAIL__FROM__DESCRIPTION"
         },
+        {
+            key: "senderName",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SMTP__SEND_EMAIL__SENDER_NAME__LABEL",
+            description: "UI__NODE_EDITOR__SMTP__SEND_EMAIL__SENDER_NAME__DESCRIPTION",
+            params: {
+                required: true
+            }
+        },
         {
             key: "subject",
             type: "cognigyText",

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

@@ -151,7 +151,9 @@ if (process.env.DISABLE_FEATURE_TRANSCRIPT_MANAGER !== "true") {
     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.HANDOVER_TO_HUMAN_AGENT_TOOL);
     nodes.push(service_1.SEND_EMAIL_TOOL);
+    nodes.push(service_1.EXECUTE_WORKFLOW_TOOL);
     nodes.push(service_1.AI_AGENT_HANDOVER);
     nodes.push(service_1.LOAD_AI_AGENT);
 }

package/build/shared/charts/descriptors/message/question/question.js

@@ -1826,6 +1826,11 @@ DO NOT talk about other topics. Do not offer general assistance.`,
         type: "sayNode",
     },
     tags: ["basic", "message", "nlu"],
+    mocking: {
+        defaultMockCode: `
+			context.result = "Mocked result";
+		`
+    },
     //#endregion DescriptorFields
     function: async ({ cognigy, nodeId, organisationId, config, inputOptions }) => {
         var _a, _b, _c;

package/build/shared/charts/descriptors/message/say.js

@@ -88,6 +88,9 @@ exports.SAY = (0, createNodeDescriptor_1.createNodeDescriptor)({
         type: "sayNode",
     },
     tags: ["basic", "message"],
+    mocking: {
+        defaultMockCode: `api.say("Hello from Mock Code!");`
+    },
     function: async ({ cognigy, config, nodeId, organisationId, nodeType }) => {
         var _a, _b, _c, _d, _e, _f, _g;
         const { api } = cognigy;

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

@@ -0,0 +1,239 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXECUTE_WORKFLOW_TOOL = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+const transcripts_1 = require("../../../../interfaces/transcripts/transcripts");
+exports.EXECUTE_WORKFLOW_TOOL = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "executeWorkflowTool",
+    defaultLabel: "Execute Workflow 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: "execute_workflow",
+            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__EXECUTE_WORKFLOW_TOOL__FIELDS__DESCRIPTION__DESCRIPTION",
+            type: "cognigyLLMText",
+            params: {
+                required: true,
+                rows: 5,
+                multiline: true,
+                placeholder: `Describe the action or functionality that the target Flow handles.\nFor example: "Update a booking", "Check order status", or "Start onboarding workflow". Be specific so the AI Agent knows exactly when to execute this Flow.`
+            }
+        },
+        {
+            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": {
+		"execution_reason": {
+			"type": "string",
+			"description": "The reason for executing this workflow, including context from the conversation."
+		}
+	},
+	"required": ["execution_reason"],
+	"additionalProperties": false
+}`,
+            params: {
+                required: false,
+            },
+        },
+        {
+            key: "flowNode",
+            type: "flowNode",
+            label: "UI__NODE_EDITOR__SERVICE__EXECUTE_WORKFLOW_TOOL__FIELDS__FLOW_NODE__LABEL",
+            params: {
+                required: true,
+            }
+        },
+        {
+            key: "parseIntents",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_INTENTS__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_INTENTS__DESCRIPTION",
+            defaultValue: false
+        },
+        {
+            key: "parseKeyphrases",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_KEYPHRASES__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_KEYPHRASES__DESCRIPTION",
+            defaultValue: false
+        },
+        {
+            key: "absorbContext",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__ABSORB_CONTEXT__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__ABSORB_CONTEXT__DESCRIPTION",
+            defaultValue: 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",
+                "parseIntents",
+                "parseKeyphrases",
+                "absorbContext",
+            ],
+        },
+    ],
+    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, _g;
+        const { api } = cognigy;
+        const { debugMessage, flowNode: targetFlowNode, parseIntents, parseKeyphrases, absorbContext, } = 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 (!(targetFlowNode === null || targetFlowNode === void 0 ? void 0 : targetFlowNode.flow)) {
+            throw new Error("Flow is required for Execute Workflow Tool");
+        }
+        if (toolCall && aiAgentJobNode) {
+            if (!((_d = api.checkThink) === null || _d === void 0 ? void 0 : _d.call(api, thisNodeId))) {
+                const executionReason = ((_f = (_e = toolCall === null || toolCall === void 0 ? void 0 : toolCall.function) === null || _e === void 0 ? void 0 : _e.arguments) === null || _f === void 0 ? void 0 : _f.execution_reason) || "No reason provided";
+                // Optional Debug Message
+                if (debugMessage) {
+                    (_g = api.logDebugMessage) === null || _g === void 0 ? void 0 : _g.call(api, JSON.stringify({
+                        execution_reason: executionReason,
+                        target_flow: targetFlowNode.flow,
+                        target_node: targetFlowNode.node,
+                    }, null, 2));
+                }
+                api.resetNextNodes();
+                // We add the return to the AI Agent Job node before the executeFlow of the target flow,
+                // because we want to return to the AI Agent Job node after the target flow has been executed
+                const { flow: thisFlow, node: thisNode } = aiAgentJobNode;
+                if (thisFlow && thisNode) {
+                    await api.executeFlow({
+                        flowNode: {
+                            flow: thisFlow,
+                            node: thisNode,
+                        },
+                        absorbContext: true,
+                    });
+                }
+                else {
+                    throw new Error("AI Agent Job Node is required for Execute Workflow Tool");
+                }
+                // Execute the target flow (mirrors executeFlow functionality)
+                await api.executeFlow({
+                    flowNode: {
+                        flow: targetFlowNode.flow,
+                        node: targetFlowNode.node
+                    },
+                    absorbContext,
+                    parseIntents,
+                    parseKeyphrases
+                });
+                // 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: "Workflow executed",
+                    }
+                };
+                await api.addTranscriptStep(toolAnswer);
+                // Clear the last tool call from session state
+                api.updateSessionStateValues({
+                    lastToolCall: undefined
+                });
+            }
+            else {
+                throw new Error("Infinite Loop Detected");
+            }
+        }
+    }
+});
+//# sourceMappingURL=executeWorkflowTool.js.map