@cognigy/rest-api-client 0.11.0 → 0.12.0

package/build/shared/helper/rest/boolean.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseBoolean = void 0;
+exports.parseBooleanValues = exports.parseBoolean = void 0;
 const parseBoolean = (value) => {
     return value === "true" ? true : undefined;
 };
 exports.parseBoolean = parseBoolean;
+const parseBooleanValues = (value) => {
+    return value === "true" ? true : value === "false" ? false : undefined;
+};
+exports.parseBooleanValues = parseBooleanValues;
 //# sourceMappingURL=boolean.js.map

package/build/shared/helper/rest/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseBoolean = exports.NumberRange = exports.validateBatchOperations = exports.stringifyQuery = exports.parseQuery = exports.parseSkip = exports.parseLimit = exports.stringifySort = exports.parseSort = void 0;
+exports.parseArray = exports.parseBooleanValues = exports.parseBoolean = exports.NumberRange = exports.validateBatchOperations = exports.stringifyQuery = exports.parseQuery = exports.parseSkip = exports.parseLimit = exports.stringifySort = exports.parseSort = void 0;
 var sort_1 = require("./sort");
 Object.defineProperty(exports, "parseSort", { enumerable: true, get: function () { return sort_1.parseSort; } });
 Object.defineProperty(exports, "stringifySort", { enumerable: true, get: function () { return sort_1.stringifySort; } });
@@ -17,4 +17,7 @@ var NumberRange_1 = require("./NumberRange");
 Object.defineProperty(exports, "NumberRange", { enumerable: true, get: function () { return NumberRange_1.NumberRange; } });
 var boolean_1 = require("./boolean");
 Object.defineProperty(exports, "parseBoolean", { enumerable: true, get: function () { return boolean_1.parseBoolean; } });
+Object.defineProperty(exports, "parseBooleanValues", { enumerable: true, get: function () { return boolean_1.parseBooleanValues; } });
+var array_1 = require("./array");
+Object.defineProperty(exports, "parseArray", { enumerable: true, get: function () { return array_1.parseArray; } });
 //# sourceMappingURL=index.js.map

package/build/shared/interfaces/IEndpointTranslationSettings.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.translationSettingsEndpointSchema = void 0;
+exports.translationSettingsEndpointSchema = {
+    title: "translationSettingsEndpointSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        translationEnabled: {
+            type: "boolean"
+        },
+        flowLanguage: {
+            type: "string"
+        },
+        inputLanguage: {
+            type: "string"
+        },
+        noTranslateMarker: {
+            type: "string"
+        },
+        padPayloads: {
+            type: "boolean"
+        },
+        alwaysRemoveNoTranslateMarker: {
+            type: "boolean",
+        },
+        setInputLanguageOnExecutionCount: {
+            type: "number",
+        },
+    }
+};
+//# sourceMappingURL=IEndpointTranslationSettings.js.map

package/build/shared/interfaces/IHandoverRequestStatus.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IHandoverRequestStatus.js.map

package/build/shared/interfaces/{restAPI/administration/user/v2.0/IDeleteUserMeRest_2_0.js → IHttpRequest.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=IDeleteUserMeRest_2_0.js.map
+//# sourceMappingURL=IHttpRequest.js.map

package/build/shared/interfaces/IOrganisation.js

@@ -45,7 +45,7 @@ exports.organisationSchema = {
     title: "organisationSchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign({ _id: { format: "mongo-id" } }, exports.organisationDataSchema.properties),
+    properties: Object.assign(Object.assign({ _id: { format: "mongo-id" } }, exports.organisationDataSchema.properties), { liveAgentAccount: { type: "number" } }),
 };
 exports.organisationQuerySchema = createQuerySchema_1.createQuerySchema("organisationQuerySchema", exports.organisationSchema);
 //# sourceMappingURL=IOrganisation.js.map

package/build/shared/interfaces/TEntrypointType.js

@@ -1,3 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.entrypointType = void 0;
+exports.entrypointType = ["project", "snapshot"];
 //# sourceMappingURL=TEntrypointType.js.map

package/build/shared/interfaces/amqpInterface.js

@@ -71,6 +71,9 @@ exports.executeRpcInternalParamsSchema = {
             minimum: 1,
         },
         session: {},
+        bulk: {
+            type: "boolean",
+        },
         reThrow: {
             type: "boolean"
         },

package/build/shared/interfaces/analytics/IAnalyticsFlowHistoryData.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAnalyticsFlowHistoryData.js.map

package/build/shared/interfaces/analytics/IAnalyticsSourceData.js

@@ -1,65 +1,216 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customerEditableAnalyticsSchema = void 0;
+exports.customerEditableAnalyticsSchema = exports.customerUpdatableAnalyticsSchema = void 0;
+const TEntrypointType_1 = require("../TEntrypointType");
+const TAnalyticsMode_1 = require("./TAnalyticsMode");
+exports.customerUpdatableAnalyticsSchema = {
+    title: "customerUpdatableAnalyticsSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        state: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        mode: {
+            type: "string",
+            enum: [...TAnalyticsMode_1.analyticsModeTypes],
+        },
+        userType: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        channel: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        flowLanguage: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        intent: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        intentScore: {
+            type: ["number", "null"],
+        },
+        intentFlow: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        flowName: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        inHandoverRequest: {
+            type: ["boolean", "null"],
+        },
+        inHandoverConversation: {
+            type: ["boolean", "null"],
+        },
+        localeName: {
+            type: ["string", "null"],
+        },
+        rating: {
+            type: ["number", "null"],
+        },
+        ratingComment: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        entrypointType: {
+            type: "string",
+            enum: [...TEntrypointType_1.entrypointType],
+        },
+        endpointName: {
+            type: ["string", "null"],
+        },
+        endpointUrlToken: {
+            type: ["string", "null"],
+        },
+        handoverEscalations: {
+            type: ["number", "null"],
+        },
+        snapshotName: {
+            type: ["string", "null"],
+        },
+        slots: {
+            type: ["null", "object"],
+        },
+        custom1: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom2: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom3: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom4: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom5: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom6: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom7: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom8: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom9: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+        custom10: {
+            type: ["string", "null"],
+            maxLength: 512,
+        },
+    },
+};
 exports.customerEditableAnalyticsSchema = {
-    "type": "object",
-    "additionalProperties": false,
-    "properties": {
-        "intent": {
-            "type": ["string", "null"],
-            "maxLength": 256,
+    title: "customerEditableAnalyticsSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        intent: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        inputText: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        inputData: {
+            type: ["object", "null"],
+        },
+        state: {
+            type: ["string", "null"],
+            maxLength: 256,
+        },
+        slots: {
+            type: ["object", "null"],
+        },
+        completedGoals: {
+            type: ["array", "null"],
+        },
+        traceId: {
+            type: ["string", "null"],
+        },
+        disableSensitiveLogging: {
+            type: ["boolean", "null"],
+        },
+        intentScore: {
+            type: ["number", "null"],
+        },
+        intentFlow: {
+            type: ["string", "null"],
+            maxLength: 256,
         },
-        "inputText": {
-            "type": ["string", "null"],
-            "maxLength": 256,
+        understood: {
+            type: ["boolean", "null"],
         },
-        "inputData": {
-            "type": ["object", "null"]
+        inHandoverRequest: {
+            type: ["boolean", "null"],
         },
-        "state": {
-            "type": ["string", "null"],
-            "maxLength": 256
+        inHandoverConversation: {
+            type: ["boolean", "null"],
         },
-        "slots": {
-            "type": ["object", "null"]
+        handoverEscalations: {
+            type: ["number", "null"],
         },
-        "completedGoals": {
-            "type": ["array", "null"]
+        custom1: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "traceId": {
-            "type": ["string", "null"],
+        custom2: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "disableSensitiveLogging": {
-            "type": ["boolean", "null"]
+        custom3: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "intentScore": {
-            "type": ["number", "null"]
+        custom4: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "intentFlow": {
-            "type": ["string", "null"],
-            "maxLength": 256
+        custom5: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "understood": {
-            "type": ["boolean", "null"]
+        custom6: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "inHandoverRequest": {
-            "type": ["boolean", "null"]
+        custom7: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "inHandoverConversation": {
-            "type": ["boolean", "null"]
+        custom8: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "custom1": {
-            "type": ["string", "null"],
-            "maxLength": 512
+        custom9: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "custom2": {
-            "type": ["string", "null"],
-            "maxLength": 512
+        custom10: {
+            type: ["string", "null"],
+            maxLength: 512,
         },
-        "custom3": {
-            "type": ["string", "null"],
-            "maxLength": 512
-        }
-    }
+    },
 };
 //# sourceMappingURL=IAnalyticsSourceData.js.map

package/build/shared/interfaces/analytics/IStepEvent.js

@@ -31,8 +31,9 @@ exports.stepEventSchema = {
         type: { type: "string", enum: ["intent", "node"] },
         flowName: { type: "string", format: "resource-name" },
         flowReferenceId: { type: "string", format: "uuid" },
-        endpointName: { type: ["string", "null"], format: "resource-name" },
         endpointUrlToken: { type: ["string", "null"] },
+        endpointName: { type: ["string", "null"], format: "resource-name" },
+        channel: { type: "string" },
         localeName: { type: ["string", "null"], format: "resource-name" },
         localeReferenceId: { type: ["string", "null"], format: "uuid" },
         projectName: { type: "string", format: "resource-name" },

package/build/shared/interfaces/analytics/TAnalyticsMode.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyticsModeTypes = void 0;
+exports.analyticsModeTypes = [
+    "TextOnly",
+    "DataOnly",
+    "TextData",
+    "Empty",
+];
+//# sourceMappingURL=TAnalyticsMode.js.map

package/build/shared/interfaces/analytics/TAnalyticsType.js

@@ -1,3 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyticsType = void 0;
+exports.analyticsType = [
+    "input",
+    "output",
+];
 //# sourceMappingURL=TAnalyticsType.js.map

package/build/shared/interfaces/debugEvents/IErrorEventPayload.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IErrorEventPayload.js.map

package/build/shared/interfaces/debugEvents/TDebugEndpointEvent.js

@@ -8,6 +8,7 @@ exports.debugEventTypes = [
     "inputChanged",
     "nodeError",
     "nodeExecuted",
+    "input",
     "output",
     "profileChanged",
     "switchedFlow",

package/build/shared/interfaces/debugEvents/TDebugEventType.js

@@ -9,8 +9,9 @@ exports.arrayTDebugEventTypes = [
     "nodeExecuted",
     "nodeError",
     "finalPing",
+    "input",
     "output",
     "switchedFlow",
-    "nluWarning"
+    "nluWarning",
 ];
 //# sourceMappingURL=TDebugEventType.js.map

package/build/shared/interfaces/debugEvents/TSessionStateEmitParams.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TSessionStateEmitParams.js.map

package/build/shared/interfaces/handover.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chatwootSettingsSchema = exports.handoverAgentReplySchema = exports.rceSettingsSchema = exports.handoverSettingsSchema = exports.handoverProviders = exports.internalHandoverProviders = exports.externalHandoverProviders = void 0;
+exports.liveAgentSettingsSchema = exports.salesforceSettingsSchema = exports.chatwootSettingsSchema = exports.handoverAgentReplySchema = exports.rceSettingsSchema = exports.handoverSettingsSchema = exports.handoverProviders = exports.internalHandoverProviders = exports.externalHandoverProviders = void 0;
 exports.externalHandoverProviders = [
     "rce",
     "chatwoot",
+    "salesforce",
+    "liveAgent"
 ];
 exports.internalHandoverProviders = [
     "cognigy",
@@ -20,7 +22,7 @@ exports.handoverSettingsSchema = {
     properties: {
         provider: {
             type: "string",
-            enum: ["none", "chatwoot", "cognigy", "rce"]
+            enum: ["none", "chatwoot", "cognigy", "rce", "salesforce", "liveAgent"]
         },
         providerSettings: {
             type: "object",
@@ -32,6 +34,7 @@ exports.handoverSettingsSchema = {
                         accountId: { type: "string" },
                         baseUrl: { type: "string" },
                         apiKey: { type: "string" },
+                        usePlatformToken: { type: "boolean" },
                         forwardOnlyHandoverConversations: { type: "boolean" },
                         apiAccessToken: { type: "string" },
                         baseApiUrl: { type: "string", format: "url" },
@@ -39,10 +42,21 @@ exports.handoverSettingsSchema = {
                         realtimeEndpointUrl: { type: "string" },
                         webhookSecret: { type: "string" },
                         agentCategoryId: { type: "string" },
-                        botCategoryId: { type: "string" }
+                        botCategoryId: { type: "string" },
+                        apiVersion: { type: "string" },
+                        organizationId: { type: "string" },
+                        deploymentId: { type: "string" },
+                        buttonId: { type: "string" }
                     }
                 }
             ]
+        },
+        agentAssistSettings: {
+            type: "object",
+            additionalProperties: false,
+            properties: {
+                agentAssistFlowId: { type: "string" },
+            }
         }
     }
 };
@@ -145,4 +159,68 @@ exports.chatwootSettingsSchema = {
         },
     }
 };
+exports.salesforceSettingsSchema = {
+    title: "salesforceSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "apiVersion",
+        "baseUrl",
+        "organizationId",
+        "deploymentId",
+        "buttonId"
+    ],
+    properties: {
+        apiVersion: {
+            type: "string"
+        },
+        baseUrl: {
+            type: "string",
+            format: "url"
+        },
+        organizationId: {
+            type: "string",
+        },
+        deploymentId: {
+            type: "string",
+        },
+        buttonId: {
+            "type": "string",
+        },
+        forwardOnlyHandoverConversations: {
+            "type": "boolean",
+        },
+    }
+};
+exports.liveAgentSettingsSchema = {
+    title: "liveAgentSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "baseUrl",
+        "accountId",
+        "apiKey",
+    ],
+    properties: {
+        accountId: {
+            type: "string"
+        },
+        apiKey: {
+            type: "string"
+        },
+        baseUrl: {
+            type: "string",
+            format: "url"
+        },
+        liveAgentInboxId: {
+            type: "string",
+        },
+        forwardOnlyHandoverConversations: {
+            "type": "boolean",
+        },
+        usePlatformToken: {
+            "type": "boolean",
+        }
+    }
+};
 //# sourceMappingURL=handover.js.map

package/build/shared/interfaces/license.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.licenseCapabilitiesMapping = exports.licenseCapabilitiesFromKey = exports.licenseStates = void 0;
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     TLicenseState:
+ *       type: string
+ *       description: The state of the license
+ *       example: valid
+ *       enum:
+ *         - invalid
+ *         - valid
+ *         - valid3MonthsLeft
+ *         - willExpireSoon
+ *         - expiredRenewRequired
+ *         - expired
+ */
+exports.licenseStates = [
+    "invalid",
+    "valid",
+    "valid3MonthsLeft",
+    "willExpireSoon",
+    "expiredRenewRequired",
+    "expired" /* The license is expired. The system can no longer be used (ui, api) */
+];
+exports.licenseCapabilitiesFromKey = ["ui", "handover", "liveAgent"];
+exports.licenseCapabilitiesMapping = {
+    ui: "uiLicensed",
+    handover: "handoverLicensed",
+    liveAgent: 'liveAgentLicensed',
+};
+//# sourceMappingURL=license.js.map

package/build/shared/interfaces/license.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"license.js","sourceRoot":"","sources":["../../../src/shared/interfaces/license.ts"],"names":[],"mappings":";;;AAuBA;;;;;;;;;;;;;;;GAeG;AACU,QAAA,aAAa,GAAU;IACnC,SAAS;IACT,OAAO;IACP,kBAAkB;IAClB,gBAAgB;IAChB,sBAAsB;IACtB,SAAS,CAAC,wEAAwE;CAClF,CAAC;AAaW,QAAA,0BAA0B,GAAU,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;AAGpE,QAAA,0BAA0B,GAA8D;IACpG,EAAE,EAAE,YAAY;IAChB,QAAQ,EAAE,kBAAkB;IAC5B,SAAS,EAAE,mBAAmB;CAC9B,CAAC"}

package/build/shared/interfaces/messageAPI/ai.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.userSchema = void 0;
+exports.isSwitchedFlowData = exports.userSchema = void 0;
 exports.userSchema = {
     title: "userSchema",
     type: "object",
@@ -15,4 +15,18 @@ exports.userSchema = {
         userId: { type: "string", minLength: 1 },
     },
 };
+/**
+ * Type-Guard for "ISwitchedFlowData" in "AnyProcessOutputData"
+ *
+ * Can be used to easily exclude the type to get typed access to _cognigy
+ */
+const isSwitchedFlowData = (data) => {
+    if (!data)
+        return false;
+    const { type, fromFlowId, toFlowId } = data;
+    if (!type || !fromFlowId || !toFlowId)
+        return false;
+    return true;
+};
+exports.isSwitchedFlowData = isSwitchedFlowData;
 //# sourceMappingURL=ai.js.map