@cognigy/rest-api-client 0.13.2 → 0.15.0

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

@@ -5,14 +5,13 @@ exports.transferNode = void 0;
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /** Helper Modules */
 const transfer_mapper_1 = require("../../voice/mappers/transfer.mapper");
-const constants_1 = require("../utils/constants");
 const design_1 = require("../utils/design");
 const helper_1 = require("../utils/helper");
 exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "transfer",
     defaultLabel: "Transfer",
     preview: {
-        key: "referTo",
+        key: "transferTarget",
         type: "text",
     },
     appearance: {
@@ -20,27 +19,56 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
     },
     fields: [
         {
-            key: "referTo",
-            label: "Target",
+            key: "transferType",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TYPE__LABEL",
+            type: "select",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TYPE__OPTIONS__REFER__LABEL",
+                        value: "refer"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TYPE__OPTIONS__DIAL__LABEL",
+                        value: "dial"
+                    }
+                ]
+            },
+            defaultValue: "refer",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TYPE__DESCRIPTION",
+        },
+        {
+            key: "transferTarget",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TARGET__LABEL",
             type: "cognigyText",
             params: {
                 required: true,
             },
-            description: "E.164 syntax or a SIP URI are supported",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_TARGET__DESCRIPTION",
             defaultValue: "+49123456789",
         },
+        {
+            key: "transferReason",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_REASON__LABEL",
+            type: "cognigyText",
+            params: {
+                required: true,
+            },
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_REASON__DESCRIPTION",
+            defaultValue: "Bot initiated a transfer.",
+        },
         {
             key: "useTransferSipHeaders",
-            label: "Custom Transfer SIP Headers",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__USE_TRANSFER_SIP_HEADERS__LABEL",
             type: "toggle",
-            description: "Add data to be sent as SIP headers in the generated SIP message",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__USE_TRANSFER_SIP_HEADERS__DESCRIPTION",
             defaultValue: false,
         },
         {
             key: "transferSipHeaders",
-            label: "Transfer SIP Headers",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_SIP_HEADERS__LABEL",
             type: "json",
-            description: "The data to be sent as SIP headers in the generated SIP message",
+            description: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSFER_SIP_HEADERS__DESCRIPTION",
             defaultValue: {
                 "X-Custom-Header": "YourValue",
             },
@@ -49,38 +77,206 @@ exports.transferNode = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 value: true,
             },
         },
+        /* Dial specific */
+        {
+            key: "dialCallerId",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__DIAL_CALLER_ID__LABEL",
+            type: "text",
+            description: "UI__NODE_EDITOR__TRANSFER__DIAL_CALLER_ID__DESCRIPTION",
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "dialMusic",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__DIAL_MUSIC__LABEL",
+            type: "text",
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__DIAL_MUSIC__DESCRIPTION",
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "dialTranscriptionWebhook",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__DIAL_TRANSCRIPTION_WEBHOOK__LABEL",
+            type: "text",
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__DIAL_TRANSCRIPTION_WEBHOOK__DESCRIPTION",
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "amdEnabled",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__AMD_ENABLED__LABEL",
+            type: "toggle",
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__AMD_ENABLED__DESCRIPTION",
+            defaultValue: false,
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "amdRedirectOnMachineDetected",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__AMD_REDIRECT_ON_MACHINE_DETECTED__LABEL",
+            type: "toggle",
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__AMD_REDIRECT_ON_MACHINE_DETECTED__DESCRIPTION",
+            defaultValue: false,
+            condition: {
+                key: "amdEnabled",
+                value: true,
+            },
+        },
+        {
+            key: "amdRedirectText",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__AMD_REDIRECT_TEXT__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__AMD_REDIRECT_TEXT__DESCRIPTION",
+            defaultValue: "",
+            condition: {
+                and: [{
+                        key: "amdEnabled",
+                        value: true,
+                    },
+                    {
+                        key: "amdRedirectOnMachineDetected",
+                        value: true,
+                    }]
+            },
+        },
+        {
+            key: "recognitionChannel",
+            label: "UI__NODE_EDITOR__TRANSFER__FIELDS__RECOGNITION_CHANNEL__LABEL",
+            type: "select",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__TRANSFER__FIELDS__RECOGNITION_CHANNEL__OPTIONS__CALLER__LABEL",
+                        value: 1
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__TRANSFER__FIELDS__RECOGNITION_CHANNEL__OPTIONS__CALLED__LABEL",
+                        value: 2
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__TRANSFER__FIELDS__RECOGNITION_CHANNEL__OPTIONS__BOTH__LABEL",
+                        value: 0
+                    }
+                ]
+            },
+            defaultValue: 0,
+            description: "UI__NODE_EDITOR__TRANSFER__FIELDS__RECOGNITION_CHANNEL__DESCRIPTION",
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "sttVendor",
+            type: "sttSelect",
+            label: "_unused_",
+            description: "_unused_",
+            defaultValue: "",
+            params: {
+                languageKey: "config.sttLanguage"
+            },
+            condition: {
+                key: "transferType",
+                value: "dial",
+            },
+        },
+        {
+            key: "sttLanguage",
+            type: "sttSelect",
+            defaultValue: "",
+            label: "_unused_",
+        },
     ],
     sections: [
+        {
+            key: "transcribe",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__TRANSCRIBE__LABEL",
+            defaultCollapsed: true,
+            fields: ["sttVendor", "dialTranscriptionWebhook", "recognitionChannel"],
+            condition: {
+                key: "transferType",
+                value: "dial"
+            },
+        },
+        {
+            key: "amd",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__AMD__LABEL",
+            defaultCollapsed: true,
+            fields: ["amdEnabled", "amdRedirectOnMachineDetected", "amdRedirectText"],
+            condition: {
+                key: "transferType",
+                value: "dial"
+            },
+        },
         {
             key: "advanced",
-            label: "Advanced",
+            label: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__FIELDS__ADVANCED__LABEL",
             defaultCollapsed: true,
-            fields: ["useTransferSipHeaders", "transferSipHeaders"],
+            fields: ["useTransferSipHeaders", "transferSipHeaders", "enableAnsweringMachineDetection"],
         },
     ],
     form: [
         {
             type: "field",
-            key: "referTo",
+            key: "transferType",
+        },
+        {
+            type: "field",
+            key: "transferReason",
+        },
+        {
+            type: "field",
+            key: "transferTarget",
+        },
+        {
+            type: "field",
+            key: "dialCallerId",
+        },
+        {
+            type: "field",
+            key: "dialMusic",
+        },
+        {
+            type: "section",
+            key: "transcribe",
+        },
+        {
+            type: "section",
+            key: "amd",
         },
         {
             type: "section",
             key: "advanced",
         },
     ],
-    summary: "Transfer the call to another target",
+    summary: "UI__NODE_EDITOR__VOICEGATEWAY2__TRANSFER__SUMMARY",
     function: async ({ cognigy, config }) => {
         const { api, input } = cognigy;
-        const { referTo, useTransferSipHeaders, transferSipHeaders } = config;
+        const { transferType, transferTarget, useTransferSipHeaders, transferSipHeaders, transferReason, dialMusic, dialTranscriptionWebhook, dialCallerId, recognitionChannel, sttVendor, sttLanguage, amdEnabled, amdRedirectOnMachineDetected, amdRedirectText } = config;
         const transferParams = {
-            transferReason: "",
-            transferTarget: (0, helper_1.cleanTarget)(referTo),
+            transferType,
+            transferReason,
+            transferTarget,
             useTransferSipHeaders,
             transferSipHeaders,
+            dialMusic,
+            dialCallerId,
+            dialTranscriptionWebhook,
+            amdEnabled,
+            amdRedirectOnMachineDetected,
+            amdRedirectText
         };
         try {
             if (input.channel === "adminconsole") {
-                api.say("Transferring a call is not supported in the Interaction Panel, please use the VG2 endpoint.", null);
+                api.say("Transferring a call is not supported in the Interaction Panel, please use the VoiceGateway endpoint.", null);
                 return;
             }
             if (useTransferSipHeaders &&
@@ -90,7 +286,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(constants_1.ENDPOINTS.VOICE_GATEWAY, transferParams, false);
+            const payload = transfer_mapper_1.transfer.handleInput("voiceGateway2", transferParams, false, recognitionChannel, sttVendor, sttLanguage);
             api.say(null, {
                 _cognigy: payload,
             });

package/build/shared/charts/descriptors/voicegateway2/utils/helper.js

@@ -1,20 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidJSON = exports.cleanTarget = void 0;
-function cleanTarget(target) {
-    if (target.includes("@")) {
-        const sip = target.replace(/\s/g, "");
-        if (target.substring(0, 4) === "sip:")
+function cleanTarget(rawTarget, isPrefixRequired) {
+    if (rawTarget.includes("@")) {
+        // handle sip refer
+        const sip = rawTarget.replace(/\s/g, "");
+        if (rawTarget.substring(0, 4) === "sip:")
             return sip;
         return `sip:${sip}`;
     }
-    const cleanedNumber = target.replace(/\s|\(|\)|\-/g, "");
-    let number = cleanedNumber;
-    if (number.substring(0, 4) === "tel:")
-        number = number.substring(4);
-    if (number.substring(0, 2) === "00")
-        return `+${number.slice(2)}`;
-    return number;
+    // handle telephone refer
+    let processedTarget = rawTarget;
+    if (processedTarget.toLowerCase().startsWith("tel:")) {
+        // remove "tel:" first
+        processedTarget = processedTarget.slice(4);
+    }
+    // clear up invalid chars
+    processedTarget = processedTarget.replace(/\s|\(|\)|\-/g, "");
+    if (processedTarget.substring(0, 2) === "00") {
+        // replace "00" with "+"
+        processedTarget = `+${processedTarget.slice(2)}`;
+    }
+    return isPrefixRequired ? "tel:" + processedTarget : processedTarget;
 }
 exports.cleanTarget = cleanTarget;
 function isValidJSON(json) {
@@ -24,12 +31,12 @@ function isValidJSON(json) {
             Object.entries(json).length &&
             !Array.isArray(json)) {
             for (const value of Object.values(json)) {
-                if (["string", "number", "boolean"].includes(typeof value)) {
-                    return true;
+                if (!["string", "number", "boolean"].includes(typeof value)) {
+                    return false;
                 }
             }
         }
-        return false;
+        return true;
     }
     catch (error) {
         return false;

package/build/shared/charts/descriptors/voicegateway2/utils/strip-nulls.js

@@ -3,7 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.stripNulls = void 0;
 function stripNulls(data) {
     Object.entries(data).forEach(([key, value]) => {
-        if (typeof value === "undefined" || typeof value === null || (typeof value === "string" && value.length == 0)) {
+        /* Boolean values are always value, true or false. We don't want to delete 'false' */
+        if (typeof value === 'boolean') {
+            return;
+        }
+        if (typeof value === "undefined" ||
+            typeof value === null ||
+            (typeof value === "string" &&
+                value.length == 0)) {
             delete data[key];
         }
         if (typeof value === "object" && (typeof value !== "number" || typeof value !== "string")) {

package/build/shared/charts/helpers/generativeAI/getRephraseWithAIFields.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRephraseWithAISection = exports.getRephraseWithAIFields = void 0;
+/**
+ * @returns The fields for rephraseWithAI
+ */
+const getRephraseWithAIFields = () => {
+    const fields = [
+        {
+            key: "generativeAI_rephraseOutputMode",
+            type: "select",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__LABEL",
+            params: {
+                required: true,
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__OPTIONS__NONE__LABEL",
+                        value: "none"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__OPTIONS__USER_INPUTS__LABEL",
+                        value: "userInputs"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__GENERATIVE_AI__REPHRASE_OUTPUT_MODE__OPTIONS__CUSTOM_INPUTS__LABEL",
+                        value: "customInputs"
+                    },
+                ],
+            },
+            defaultValue: "none",
+        },
+        {
+            key: "generativeAI_amountOfLastUserInputs",
+            type: "slider",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__AMOUNT_OF_LAST_USER_INPUTS__LABEL",
+            params: {
+                min: 1,
+                max: 10,
+                step: 1,
+            },
+            defaultValue: 5,
+            condition: {
+                key: "generativeAI_rephraseOutputMode",
+                value: "userInputs",
+            },
+        },
+        {
+            key: "generativeAI_customInputs",
+            type: "cognigyTextArray",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__CUSTOM_INPUTS__LABEL",
+            condition: {
+                key: "generativeAI_rephraseOutputMode",
+                value: "customInputs",
+            },
+        },
+        {
+            key: "generativeAI_temperature",
+            type: "slider",
+            label: "UI__NODE_EDITOR__GENERATIVE_AI__TEMPERATURE__LABEL",
+            params: {
+                min: 0,
+                max: 1,
+                step: 0.1,
+            },
+            defaultValue: 0.7,
+            condition: {
+                or: [
+                    {
+                        key: "generativeAI_rephraseOutputMode",
+                        value: "userInputs",
+                    },
+                    {
+                        key: "generativeAI_rephraseOutputMode",
+                        value: "customInputs",
+                    }
+                ],
+            },
+        },
+    ];
+    return fields;
+};
+exports.getRephraseWithAIFields = getRephraseWithAIFields;
+/**
+ * @returns The section for rephraseWithAI
+ */
+const getRephraseWithAISection = () => {
+    return {
+        key: "aiEnhancedOutput",
+        label: "UI__NODE_EDITOR__GENERATIVE_AI__LABEL",
+        defaultCollapsed: true,
+        fields: [
+            "generativeAI_rephraseOutputMode",
+            "generativeAI_amountOfLastUserInputs",
+            "generativeAI_customInputs",
+            "generativeAI_temperature",
+        ]
+    };
+};
+exports.getRephraseWithAISection = getRephraseWithAISection;
+//# sourceMappingURL=getRephraseWithAIFields.js.map

package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rephraseMultipleSentencesWithAI = exports.rephraseSentenceWithAI = void 0;
+const rephraseSentenceWithAI = async (sentence, config, api, organisationId) => {
+    const { generativeAI_rephraseOutputMode } = config;
+    if (generativeAI_rephraseOutputMode === "userInputs" || generativeAI_rephraseOutputMode === "customInputs") {
+        sentence = await api.rephraseSentenceWithAI(sentence, createRephraseSentenceWithAIOptions(config));
+    }
+    return sentence;
+};
+exports.rephraseSentenceWithAI = rephraseSentenceWithAI;
+const rephraseMultipleSentencesWithAI = async (sentences, config, api, organisationId) => {
+    const { generativeAI_rephraseOutputMode, generativeAI_amountOfLastUserInputs, generativeAI_customInputs, generativeAI_temperature } = config;
+    if (generativeAI_rephraseOutputMode === "userInputs" || generativeAI_rephraseOutputMode === "customInputs") {
+        sentences = await api.rephraseMultipleSentencesWithAI(sentences, createRephraseSentenceWithAIOptions(config));
+    }
+    return sentences;
+};
+exports.rephraseMultipleSentencesWithAI = rephraseMultipleSentencesWithAI;
+const createRephraseSentenceWithAIOptions = (params) => {
+    const options = {
+        promptType: params.promtType,
+        questionType: params.questionType,
+        temperature: params.generativeAI_temperature,
+        question: params.question,
+        answer: params.answer,
+    };
+    switch (params.generativeAI_rephraseOutputMode) {
+        case "none":
+            break;
+        case "userInputs":
+            options.useLastUserInputs = true;
+            options.amountOfUserInputs = params.generativeAI_amountOfLastUserInputs;
+            return options;
+        case "customInputs":
+            options.useLastUserInputs = false;
+            options.customInputs = params.generativeAI_customInputs;
+            return options;
+        default:
+            break;
+    }
+    return {};
+};
+//# sourceMappingURL=rephraseSentenceWithAi.js.map

package/build/shared/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM_EMAIL = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
+exports.IP_NOT_AVAILABLE = exports.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS = exports.AUDIO_PREVIEW_PROVIDER_EXTENSION = exports.GENERATIVE_AI_PROVIDER_EXTENSION = exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM_EMAIL = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
 exports.CREATED_BY_SSO = "000000000000000000000550";
 exports.SYSTEM = "000000000000000000000000";
 exports.SYSTEM_EMAIL = "system@mail.com";
@@ -20,4 +20,18 @@ exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = "@cognigy/internal-storage-provide
 exports.EMBEDDED_EXTENSION = "@embedded/";
 exports.X_COGNIGY_ORIGIN = "x-cognigy-origin";
 exports.ADMIN_CONSOLE_URL_TOKEN = "ffffffffffffffffffff55555555555555555eeeeeeeeeeeeeeeaaaaaaaaaaaa";
+exports.GENERATIVE_AI_PROVIDER_EXTENSION = "@cognigy/generative-ai-provider";
+exports.AUDIO_PREVIEW_PROVIDER_EXTENSION = "@cognigy/audio-preview-provider";
+exports.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS = {
+    ESCALATE_INTENTS_HANDOVER_LIVE_AGENT_INBOX_ID: "escalateIntentsHandoverLiveAgentInboxId",
+    ESCALATE_INTENTS_AGENT_ASSIST_INIT_MESSAGE: "escalateIntentsAgentAssistInitMessage",
+    ESCALATE_INTENTS_ALLOW_AGENT_INJECT: "escalateIntentsAllowAgentInject",
+    ESCALATE_ANSWERS_HANDOVER_LIVE_AGENT_INBOX_ID: "escalateAnswersHandoverLiveAgentInboxId",
+    ESCALATE_ANSWERS_ALLOW_AGENT_INJECT: "escalateAnswersAllowAgentInject",
+    ESCALATE_ANSWERS_AGENT_ASSIST_INIT_MESSAGE: "escalateAnswersAgentAssistInitMessage",
+    LIVE_AGENT_INBOX_ID: "liveAgentInboxId",
+    AGENT_ASSIST_INIT_MESSAGE: "agentAssistInitMessage",
+    ALLOW_AGENT_INJECT: "allowAgentInject",
+};
+exports.IP_NOT_AVAILABLE = "not available";
 //# sourceMappingURL=constants.js.map

package/build/shared/errors/ErrorCode.js

@@ -7,6 +7,7 @@ var ErrorCode;
     ErrorCode[ErrorCode["UNAUTHORIZED_ERROR"] = 401] = "UNAUTHORIZED_ERROR";
     ErrorCode[ErrorCode["PAYMENT_REQUIRED_ERROR"] = 402] = "PAYMENT_REQUIRED_ERROR";
     ErrorCode[ErrorCode["PAYLOAD_TOO_LARGE_ERROR"] = 413] = "PAYLOAD_TOO_LARGE_ERROR";
+    ErrorCode[ErrorCode["TOO_MANY_REQUESTS_ERROR"] = 429] = "TOO_MANY_REQUESTS_ERROR";
     ErrorCode[ErrorCode["FORBIDDEN_ERROR"] = 403] = "FORBIDDEN_ERROR";
     ErrorCode[ErrorCode["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
     ErrorCode[ErrorCode["SERVICE_UNAVAILABLE_ERROR"] = 503] = "SERVICE_UNAVAILABLE_ERROR";

package/build/shared/errors/TooManyRequestsError.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TooManyRequestsError = void 0;
+/* Custom modules */
+const baseError_1 = require("./baseError");
+const codes_1 = require("./codes");
+const HttpStatusCode_1 = require("../helper/HttpStatusCode");
+/**
+ * @openapi
+ * components:
+ *   responses:
+ *     TooManyRequestsError:
+ *       description: The server got too many requests than it is required to handle.
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               type:
+ *                 type: string
+ *                 example: TooManyRequestsError
+ *               title:
+ *                 type: string
+ *                 example: Too Many Requests Error
+ *               status:
+ *                 type: number
+ *                 example: 429
+ *               detail:
+ *                 type: string
+ *               instance:
+ *                 type: string
+ *                 example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432
+ *               code:
+ *                 type: string
+ *                 example: 1000
+ *               traceId:
+ *                 type: string
+ *                 example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f
+ *               details:
+ *                 type: object
+ *                 example: {}
+ */
+class TooManyRequestsError extends baseError_1.BaseError {
+    constructor(message, stack, meta, details, logLevel) {
+        super({
+            name: "Too Many Requests Error",
+            message,
+            code: codes_1.TOO_MANY_REQUESTS_ERROR,
+            httpStatusCode: HttpStatusCode_1.HttpStatusCode.TOO_MANY_REQUESTS,
+            httpStatusText: "Too Many Requests Error",
+            meta,
+            stack,
+            details,
+            logLevel,
+        });
+    }
+}
+exports.TooManyRequestsError = TooManyRequestsError;
+//# sourceMappingURL=TooManyRequestsError.js.map

package/build/shared/errors/baseError.js

@@ -41,10 +41,14 @@ class BaseError extends Error {
         }
         if (tracer) {
             if (this.logLevel === "error" || this.logLevel === "fatal") {
+                const { projectId, organisationId, organisation, groupingKey, organisationName, projectName, } = this.meta;
                 tracer.captureException(this, {
                     traceId: (_a = this.loggerstack) === null || _a === void 0 ? void 0 : _a.traceId,
-                    organisationId: (meta === null || meta === void 0 ? void 0 : meta.organisationId) || (meta === null || meta === void 0 ? void 0 : meta.organisation),
-                    projectId: meta === null || meta === void 0 ? void 0 : meta.projectId,
+                    organisationId: organisationId || organisation,
+                    projectId,
+                    groupingKey,
+                    organisationName,
+                    projectName,
                 });
             }
         }

package/build/shared/errors/codes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GATEWAY_TIMEOUT_ERROR = exports.BAD_GATEWAY_ERROR = exports.FORBIDDEN_ERROR = exports.PAYLOAD_TOO_LARGE_ERROR = exports.UNAUTHORIZED_ERROR = exports.TIMEOUT_ERROR = exports.INPUT_OUTPUT_ERROR = exports.DATABASE_QUERY_ERROR = exports.DATABASE_CONNECT_ERROR = exports.SMTP_CONNECT_ERROR = exports.METHOD_NOT_ALLOWED_ERROR = exports.FILE_WRITE_ERROR = exports.FILE_READ_ERROR = exports.PROCESS_ERROR = exports.NOT_IMPLEMENTED_ERROR = exports.INTERNAL_SERVER_ERROR = exports.EXPORT_ERROR = exports.IMPORT_ERROR = exports.INVALID_ARGUMENT_ERROR = exports.CONFLICT_ERROR = exports.DATABASE_READ_ERROR = exports.RESOURCE_NOT_FOUND_ERROR = exports.DATABASE_WRITE_ERROR = exports.MISSING_ARGUMENT_ERROR = void 0;
+exports.TOO_MANY_REQUESTS_ERROR = exports.GATEWAY_TIMEOUT_ERROR = exports.BAD_GATEWAY_ERROR = exports.FORBIDDEN_ERROR = exports.PAYLOAD_TOO_LARGE_ERROR = exports.UNAUTHORIZED_ERROR = exports.TIMEOUT_ERROR = exports.INPUT_OUTPUT_ERROR = exports.DATABASE_QUERY_ERROR = exports.DATABASE_CONNECT_ERROR = exports.SMTP_CONNECT_ERROR = exports.METHOD_NOT_ALLOWED_ERROR = exports.FILE_WRITE_ERROR = exports.FILE_READ_ERROR = exports.PROCESS_ERROR = exports.NOT_IMPLEMENTED_ERROR = exports.INTERNAL_SERVER_ERROR = exports.EXPORT_ERROR = exports.IMPORT_ERROR = exports.INVALID_ARGUMENT_ERROR = exports.CONFLICT_ERROR = exports.DATABASE_READ_ERROR = exports.RESOURCE_NOT_FOUND_ERROR = exports.DATABASE_WRITE_ERROR = exports.MISSING_ARGUMENT_ERROR = void 0;
 const ErrorCode_1 = require("./ErrorCode");
 exports.MISSING_ARGUMENT_ERROR = ErrorCode_1.ErrorCode.MISSING_ARGUMENT_ERROR;
 exports.DATABASE_WRITE_ERROR = ErrorCode_1.ErrorCode.DATABASE_WRITE_ERROR;
@@ -26,4 +26,5 @@ exports.PAYLOAD_TOO_LARGE_ERROR = ErrorCode_1.ErrorCode.PAYLOAD_TOO_LARGE_ERROR;
 exports.FORBIDDEN_ERROR = ErrorCode_1.ErrorCode.FORBIDDEN_ERROR;
 exports.BAD_GATEWAY_ERROR = ErrorCode_1.ErrorCode.BAD_GATEWAY;
 exports.GATEWAY_TIMEOUT_ERROR = ErrorCode_1.ErrorCode.GATEWAY_TIMEOUT_ERROR;
+exports.TOO_MANY_REQUESTS_ERROR = ErrorCode_1.ErrorCode.TOO_MANY_REQUESTS_ERROR;
 //# sourceMappingURL=codes.js.map