@cognigy/rest-api-client 2025.18.0 → 2025.19.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2025.19.0
+Released: September 16th, 2025 
+
+Released state of package up to date with Cognigy.AI v2025.19.0 
+
+# 2025.18.1
+Released: September 04th, 2025 
+
+Released state of package up to date with Cognigy.AI v2025.18.0
+
+- Changes for allowing cookies to be sent with authentication requests
+
 # 2025.18.0
 Released: September 02nd, 2025 
 

package/build/authentication/AuthenticationAPI.js

@@ -66,7 +66,7 @@ function AuthenticationAPI(instance) {
         },
         exchangeOneTimeTokenForRefreshToken: (_a, options) => {
             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 }, options));
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/auth/exchangetoken?${(0, rest_1.stringifyQuery)({ loginToken })}`, "GET", 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/authentication/OAuth2/OAuth2Authentication.js

@@ -4,7 +4,6 @@ exports.OAuth2Authentication = void 0;
 /* Custom Modules */
 const OAuth2Error_1 = require("./OAuth2Error");
 const HttpStatusCode_1 = require("../../shared/helper/HttpStatusCode");
-const errors_1 = require("../../shared/errors");
 const IOAuth2ErrorResponse_1 = require("./IOAuth2ErrorResponse");
 const expiryBuffer = 8;
 exports.OAuth2Authentication = function (credentials, self) {
@@ -29,7 +28,8 @@ exports.OAuth2Authentication = function (credentials, self) {
             };
             return await request(formFields, {
                 maxRetries: Infinity,
-                retryDelay: () => 3000
+                retryDelay: () => 3000,
+                withCredentials: true
             });
         };
         const request = async (formFields, options) => {
@@ -84,6 +84,8 @@ exports.OAuth2Authentication = function (credentials, self) {
         OAuth2Authentication.prototype.login = async (parameters) => {
             const { clientId, clientSecret } = self.credentials;
             switch (parameters.type) {
+                // Password Grant is deprecated in OAuth2, but still supported
+                // for api and e2e tests
                 case "password":
                     {
                         const { username, password, rememberMe, organisationId } = parameters;
@@ -103,6 +105,8 @@ exports.OAuth2Authentication = function (credentials, self) {
                     break;
                 case "refreshToken":
                     {
+                        // The refresh token from the parameters is to support older token granted via Password Grant flow
+                        // TODO - remove this in future once PKCE fully takes over
                         const { refreshToken } = parameters;
                         const credentials = self.credentials;
                         const result = await refreshTokenGrant({
@@ -115,17 +119,19 @@ exports.OAuth2Authentication = function (credentials, self) {
                     break;
                 case "authorizationCode":
                     {
-                        const { code, redirectUri, codeVerifier } = parameters;
+                        const { code, redirectUri, codeVerifier, rememberMe } = parameters;
                         const formFields = {
                             grant_type: "authorization_code",
                             client_id: clientId,
                             client_secret: clientSecret,
                             code,
                             redirect_uri: redirectUri,
+                            rememberMe,
                             code_verifier: codeVerifier
                         };
                         self.tokenData = await request(formFields, {
-                            maxRetries: 0
+                            maxRetries: 0,
+                            withCredentials: true
                         });
                     }
                     break;
@@ -177,9 +183,6 @@ exports.OAuth2Authentication = function (credentials, self) {
                  */
                 if (isAccessTokenExpired(self.tokenData)) {
                     const credentials = self.credentials;
-                    if (!self.tokenData.refresh_token) {
-                        throw new errors_1.UnauthorizedError("No RefreshToken provided.");
-                    }
                     if (self.refreshTokenSingleton === null) {
                         self.refreshTokenSingleton = new Promise((resolve, reject) => {
                             refreshTokenGrant({
@@ -219,8 +222,7 @@ exports.OAuth2Authentication = function (credentials, self) {
         };
         OAuth2Authentication.prototype.logout = async () => {
             if ((self === null || self === void 0 ? void 0 : self.credentials.type) ===
-                "OAuth2" &&
-                self.tokenData.refresh_token) {
+                "OAuth2") {
                 const httpAdapter = self.getHttpAdapter();
                 const requestData = {
                     method: "POST",
@@ -229,6 +231,7 @@ exports.OAuth2Authentication = function (credentials, self) {
                         token: self.tokenData.refresh_token
                     },
                     maxRetries: 3,
+                    withCredentials: true,
                     retryDelay: () => 0
                 };
                 // reset tokenData to avoid multiple revoke calls

package/build/connector/AxiosAdapter.js

@@ -76,13 +76,14 @@ class AxiosAdapter {
         return this.request(Object.assign(Object.assign({}, request), { method: "HEAD" }), client);
     }
     async convertRequest(request, client) {
-        var _a;
+        var _a, _b;
         const baseUrl = (_a = request.baseUrl) !== null && _a !== void 0 ? _a : this.config.baseUrl;
         const axiosRequest = {
             data: request.data,
             headers: request.headers,
             method: request.method || "GET",
             url: `${baseUrl}${request.url}`,
+            withCredentials: (_b = request.withCredentials) !== null && _b !== void 0 ? _b : false,
             validateStatus: (status) => !(0, isRetryableStatus_1.isRetryableStatus)(status)
         };
         if (typeof request.onProgress === "function") {
@@ -116,7 +117,7 @@ class AxiosAdapter {
             }
         }
         if (isAxiosResponse(axiosResponse)) {
-            const errorClass = errors_1.ErrorCollection[(_b = axiosResponse.data) === null || _b === void 0 ? void 0 : _b.code] ||
+            let errorClass = errors_1.ErrorCollection[(_b = axiosResponse.data) === null || _b === void 0 ? void 0 : _b.code] ||
                 errors_1.ErrorCollection[axiosResponse.status] ||
                 errors_1.ErrorCollection[errors_1.ErrorCode.INTERNAL_SERVER_ERROR];
             if ((axiosResponse.status === HttpStatusCode_1.HttpStatusCode.UNAUTHORIZED ||
@@ -125,6 +126,9 @@ class AxiosAdapter {
                 typeof this.config.onUnauthorized === "function") {
                 this.config.onUnauthorized();
             }
+            if (axiosResponse.status === HttpStatusCode_1.HttpStatusCode.CONFLICT) {
+                errorClass = errors_1.ErrorCollection[errors_1.ErrorCode.CONFLICT_ERROR];
+            }
             if (IOAuth2ErrorResponse_1.OAuth2Errors.includes((_d = axiosResponse.data) === null || _d === void 0 ? void 0 : _d.error)) {
                 throw new errorClass(axiosResponse.data.detail, { traceId: axiosResponse.data.traceId }, undefined, axiosResponse.data);
             }

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

@@ -4,7 +4,7 @@ exports.GPT_PROMPT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 const logic_1 = require("../logic");
-const crypto_1 = require("crypto");
+const uuid_1 = require("uuid");
 const prompt_1 = require("../nlu/generativeSlotFiller/prompt");
 const errors_1 = require("../../../errors");
 const transcripts_1 = require("../../../interfaces/transcripts/transcripts");
@@ -660,7 +660,7 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
         };
         try {
             const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
-            const _messageId = (0, crypto_1.randomUUID)();
+            const _messageId = (0, uuid_1.v4)();
             const data = {
                 prompt,
                 temperature,

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

@@ -14,7 +14,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AI_AGENT_JOB = exports.AI_AGENT_TOOLS_WHITELIST = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
-const crypto_1 = require("crypto");
 const setSessionConfig_mapper_1 = require("../../voice/mappers/setSessionConfig.mapper");
 const setSessionConfig_mapper_2 = require("../../voice/mappers/setSessionConfig.mapper");
 const logFullConfigToDebugMode_1 = require("../../../../helper/logFullConfigToDebugMode");
@@ -22,6 +21,7 @@ const createSystemMessage_1 = require("./helpers/createSystemMessage");
 const generateSearchPrompt_1 = require("./helpers/generateSearchPrompt");
 const getUserMemory_1 = require("./helpers/getUserMemory");
 const createToolDefinitions_1 = require("./helpers/createToolDefinitions");
+const uuid_1 = require("uuid");
 const transcripts_1 = require("../../../../interfaces/transcripts/transcripts");
 exports.AI_AGENT_TOOLS_WHITELIST = ["aiAgentJobDefault", "aiAgentJobTool", "aiAgentJobMCPTool"];
 exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
@@ -1163,7 +1163,7 @@ exports.AI_AGENT_JOB = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 transcript[transcript.length - 1].payload.text = enhancedInput;
             }
             const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
-            const _messageId = (0, crypto_1.randomUUID)();
+            const _messageId = (0, uuid_1.v4)();
             const llmPromptOptions = Object.assign(Object.assign({ prompt: "", chat: systemMessage, 
                 // Temp fix to override the transcript if needed
                 transcript: ((_0 = context === null || context === void 0 ? void 0 : context._cognigy) === null || _0 === void 0 ? void 0 : _0.transcript) ? [...context._cognigy.transcript] : transcript, detailedResults: true, timeoutInMs: timeoutInMs !== null && timeoutInMs !== void 0 ? timeoutInMs : 8000, maxTokens: maxTokens !== null && maxTokens !== void 0 ? maxTokens : 4000, temperature: temperature !== null && temperature !== void 0 ? temperature : 0.7, topP: 1, frequencyPenalty: 0, presencePenalty: 0, responseFormat: "text", stream: storeLocation === "stream", streamOnDataHandler: (text) => {

package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js

@@ -15,8 +15,8 @@ exports.LLM_PROMPT_V2 = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const logic_1 = require("../../logic");
-const crypto_1 = require("crypto");
 const createToolDefinitions_1 = require("../aiAgent/helpers/createToolDefinitions");
+const uuid_1 = require("uuid");
 const prompt_1 = require("../../nlu/generativeSlotFiller/prompt");
 const errors_1 = require("../../../../errors");
 const transcripts_1 = require("../../../../interfaces/transcripts/transcripts");
@@ -736,7 +736,7 @@ exports.LLM_PROMPT_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         };
         try {
             const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
-            const _messageId = (0, crypto_1.randomUUID)();
+            const _messageId = (0, uuid_1.v4)();
             // Start measuring LLM latency and time to first output if debug flag is enabled
             let firstOutputTime = null;
             /**

package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js

@@ -5,7 +5,7 @@ exports.prepareTransferParams = exports.transfer = void 0;
 const helper_1 = require("../../../descriptors/voicegateway2/utils/helper");
 const helper_2 = require("../utils/helper");
 exports.transfer = {
-    handleInput(endpointType, params, isGenericNode = false, recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, anchorMedia) {
+    handleInput(endpointType, params, isGenericNode = false, recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, mediaPath, anchorMedia) {
         try {
             switch (endpointType) {
                 case "bandwidth":
@@ -24,14 +24,14 @@ exports.transfer = {
                     return this.handleAudioCodesInput((0, exports.prepareTransferParams)(params), endpointType);
                 case "voiceGateway2":
                 default:
-                    return this.handleVGInput((0, exports.prepareTransferParams)(params), recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, anchorMedia);
+                    return this.handleVGInput((0, exports.prepareTransferParams)(params), recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, mediaPath, anchorMedia);
             }
         }
         catch (error) {
             throw Error(error.message);
         }
     },
-    handleVGInput(transferParam, recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, anchorMedia) {
+    handleVGInput(transferParam, recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, mediaPath, anchorMedia) {
         const { transferType, transferTarget, transferReason, referredBy, useTransferSipHeaders, transferSipHeaders, dialMusic, dialTranscriptionWebhook, dialCallerId, amdEnabled, amdRedirectOnMachineDetected, amdRedirectText, dialTimeout, timeLimit, sttLabel } = transferParam;
         const payload = {
             _voiceGateway2: {
@@ -55,6 +55,19 @@ exports.transfer = {
                 if (timeLimit && timeLimit > 0) {
                     dialVerb.timeLimit = timeLimit;
                 }
+                if (process.env.FEATURE_DISABLE_VG_MEDIA_PATH === "true") {
+                    if (typeof anchorMedia === "boolean") {
+                        dialVerb.anchorMedia = anchorMedia;
+                    }
+                }
+                else {
+                    if (mediaPath) {
+                        dialVerb.mediaPath = mediaPath;
+                    }
+                    else if (typeof anchorMedia === "boolean") {
+                        dialVerb.mediaPath = anchorMedia ? "fullMedia" : "partialMedia";
+                    }
+                }
                 if (amdEnabled) {
                     dialVerb.amd = {
                         actionHook: "amd"
@@ -75,6 +88,9 @@ exports.transfer = {
                 };
                 /* By default we set the target to phone */
                 dialVerb.target = [phoneTarget];
+                if (process.env.FEATURE_DISABLE_VG_MEDIA_PATH === "true") {
+                    delete dialVerb.mediaPath;
+                }
                 /* If targets includes an @ we set the target to sip */
                 if (transferTarget === null || transferTarget === void 0 ? void 0 : transferTarget.includes("@")) {
                     dialVerb.target = [sipTarget];
@@ -137,12 +153,10 @@ exports.transfer = {
                     }
                     dialVerb.callerId = dialCallerId;
                 }
-                if (anchorMedia) {
-                    dialVerb.anchorMedia = anchorMedia;
-                }
                 payload._voiceGateway2.json["dial"] = dialVerb;
                 break;
             case "refer":
+                mediaPath = undefined;
             default:
                 const referVerb = {
                     "referTo": (0, helper_1.cleanTarget)(transferTarget, false),

package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js

@@ -81,6 +81,33 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 value: "dial"
             }
         },
+        {
+            key: "mediaPath",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__MEDIA_PATH__LABEL",
+            type: "select",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__MEDIA_PATH__DESCRIPTION",
+            defaultValue: "partialMedia",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__MEDIA_PATH__OPTIONS__FULL_MEDIA__LABEL",
+                        value: "fullMedia"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__MEDIA_PATH__OPTIONS__PARTIAL_MEDIA__LABEL",
+                        value: "partialMedia"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__MEDIA_PATH__OPTIONS__NO_MEDIA__LABEL",
+                        value: "noMedia"
+                    }
+                ]
+            },
+            condition: {
+                key: "transferType",
+                value: "dial"
+            }
+        },
         {
             key: "useTransferSipHeaders",
             label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__USE_TRANSFER_SIP_HEADERS__LABEL",
@@ -462,7 +489,7 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
             defaultCollapsed: true,
             fields: [
                 "referredBy",
-                "anchorMedia",
+                process.env.FEATURE_DISABLE_VG_MEDIA_PATH === "true" ? "anchorMedia" : "mediaPath",
                 "useTransferSipHeaders",
                 "transferSipHeaders",
                 "enableAnsweringMachineDetection"
@@ -526,7 +553,7 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     summary: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__SUMMARY",
     function: async ({ cognigy, config, }) => {
         const { api, input } = cognigy;
-        const { transferType, transferTarget, referredBy, anchorMedia, useTransferSipHeaders, transferSipHeaders = {}, transferReason, dialMusic, dialTranscriptionWebhook, dialCallerId, recognitionChannel, sttVendor, sttLanguage, sttDisablePunctuation, dialTimeout, enableTimeLimit, timeLimit, amdEnabled, amdRedirectOnMachineDetected, amdRedirectText, sttLabel, googleModel, sttDeepgramModel, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, agentAssistEnabled, agentAssistHeadersKey = customHeaderDefaultValue } = config;
+        const { transferType, transferTarget, referredBy, mediaPath, useTransferSipHeaders, transferSipHeaders = {}, transferReason, dialMusic, dialTranscriptionWebhook, dialCallerId, recognitionChannel, sttVendor, sttLanguage, sttDisablePunctuation, dialTimeout, enableTimeLimit, timeLimit, amdEnabled, amdRedirectOnMachineDetected, amdRedirectText, sttLabel, googleModel, sttDeepgramModel, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, agentAssistEnabled, agentAssistHeadersKey = customHeaderDefaultValue, anchorMedia } = config;
         const transferParams = {
             transferType,
             transferReason,
@@ -544,6 +571,7 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
             timeLimit,
             sttLabel,
         };
+        let media = mediaPath;
         try {
             if (input.channel === "adminconsole") {
                 let textWarningAdminChannel = "Transferring a call is not supported in the Interaction Panel, please use the VoiceGateway endpoint.";
@@ -556,6 +584,14 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
             if (!enableTimeLimit) {
                 delete transferParams.timeLimit;
             }
+            if (transferType === "dial" && typeof anchorMedia === "boolean" && (mediaPath === null || mediaPath === undefined) && process.env.FEATURE_DISABLE_VG_MEDIA_PATH === "false") {
+                if (anchorMedia) {
+                    media = "fullMedia";
+                }
+                else {
+                    media = "partialMedia";
+                }
+            }
             if (agentAssistEnabled && dialTranscriptionWebhook) {
                 try {
                     const agentAssistConfigId = api.getAgentAssistConfigId();
@@ -591,7 +627,7 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 transferParams.useTransferSipHeaders = false;
                 api.log("error", "Invalid JSON in Transfer SIP Headers");
             }
-            const payload = transfer_mapper_1.transfer.handleInput("voiceGateway2", transferParams, false, recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, anchorMedia);
+            const payload = transfer_mapper_1.transfer.handleInput("voiceGateway2", transferParams, false, recognitionChannel, sttVendor, sttLanguage, googleModel, sttDeepgramModel, sttDisablePunctuation, deepgramEndpointing, deepgramEndpointingValue, deepgramSmartFormatting, media, anchorMedia);
             await api.say(null, {
                 _cognigy: payload,
             });