@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/interfaces/handover.js

@@ -1,5 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+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",
+    "none"
+];
+exports.handoverProviders = [
+    ...exports.internalHandoverProviders,
+    ...exports.externalHandoverProviders
+];
 exports.handoverSettingsSchema = {
     title: "handoverSettingsSchema",
     type: "object",
@@ -7,7 +22,7 @@ exports.handoverSettingsSchema = {
     properties: {
         provider: {
             type: "string",
-            enum: ["none", "cognigy", "rce"]
+            enum: ["none", "chatwoot", "cognigy", "rce", "salesforce", "liveAgent"]
         },
         providerSettings: {
             type: "object",
@@ -16,21 +31,37 @@ exports.handoverSettingsSchema = {
                     type: "object",
                     additionalProperties: false,
                     properties: {
+                        accountId: { type: "string" },
+                        baseUrl: { type: "string" },
+                        apiKey: { type: "string" },
+                        usePlatformToken: { type: "boolean" },
                         forwardOnlyHandoverConversations: { type: "boolean" },
                         apiAccessToken: { type: "string" },
-                        baseApiUrl: { type: "string" },
+                        baseApiUrl: { type: "string", format: "url" },
                         realtimeAccessToken: { type: "string" },
                         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" },
+            }
         }
     }
 };
 exports.rceSettingsSchema = {
+    "title": "rceSettingsSchema",
     "type": "object",
     "additionalProperties": false,
     "required": [
@@ -100,4 +131,96 @@ exports.handoverAgentReplySchema = {
         }
     }
 };
+exports.chatwootSettingsSchema = {
+    title: "chatwootSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "baseUrl",
+        "accountId",
+        "apiKey",
+    ],
+    properties: {
+        accountId: {
+            type: "string"
+        },
+        apiKey: {
+            type: "string"
+        },
+        baseUrl: {
+            type: "string",
+            format: "url"
+        },
+        chatwootInboxId: {
+            type: "string",
+        },
+        forwardOnlyHandoverConversations: {
+            "type": "boolean",
+        },
+    }
+};
+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/journeys/IJourney.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.journeyQuerySchema = exports.journeySchema = exports.journeyDataSchema = exports.journeyStepGoals = void 0;
 /* Custom Modules */
 const createQuerySchema_1 = require("../../helper/createQuerySchema");
 /* Interfaces & Types */
@@ -16,7 +17,7 @@ exports.journeyStepGoals = [
     "createIfNode",
     "createQuestionNode",
     "createSayNode",
-    "createSwitchNode",
+    "createLookupNode",
     "updateCaseNode",
     "updateHttpRequestNode",
     "updateIfNode",
@@ -50,6 +51,7 @@ exports.journeyDataSchema = {
                 type: "object",
                 additionalProperties: false,
                 properties: {
+                    referenceId: { type: "string", format: "uuid" },
                     name: { type: "string", minLength: 1, maxLength: 200 },
                     link: { type: "string", maxLength: 1000 },
                     summary: { type: "string", maxLength: 200 },
@@ -58,7 +60,7 @@ exports.journeyDataSchema = {
                         type: "array",
                         additionalItems: false,
                         maxItems: 25,
-                        items: { type: "string", maxLength: 200, enum: [...exports.journeyStepGoals] }
+                        items: { type: "string", format: "journey-step-goal" }
                     }
                 }
             }
@@ -69,7 +71,7 @@ exports.journeySchema = {
     title: "journeySchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign(Object.assign({}, exports.journeyDataSchema.properties), IEntityMeta_1.entityMetaSchema.properties)
+    properties: Object.assign(Object.assign({ referenceId: { type: "string", format: "uuid" } }, exports.journeyDataSchema.properties), IEntityMeta_1.entityMetaSchema.properties)
 };
 exports.journeyQuerySchema = createQuerySchema_1.createQuerySchema("journeyQuerySchema", exports.journeySchema);
 //# sourceMappingURL=IJourney.js.map

package/build/shared/interfaces/journeys/IJourneyProgress.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const IJourney_1 = require("./IJourney");
+exports.journeyProgressSchema = exports.journeyProgressDataSchema = void 0;
 exports.journeyProgressDataSchema = {
     title: "journeyProgressDataSchema",
     type: "object",
@@ -10,7 +10,7 @@ exports.journeyProgressDataSchema = {
         organisationReference: { type: "string", format: "mongo-id" },
         isCurrent: { type: "boolean" },
         isComplete: { type: "boolean" },
-        journeyReference: { type: "string", format: "mongo-id" },
+        journeyReferenceId: { type: "string", format: "uuid" },
         journeySteps: {
             type: "array",
             additionalItems: false,
@@ -18,13 +18,13 @@ exports.journeyProgressDataSchema = {
                 type: "object",
                 additionalProperties: false,
                 properties: {
-                    journeyStepReference: { type: "string", format: "mongo-id" },
+                    journeyStepReferenceId: { type: "string", format: "uuid" },
                     isComplete: { type: "boolean" },
                     completedGoals: {
                         type: "array",
                         additionalItems: false,
                         maxItems: 25,
-                        items: { type: "string", maxLength: 200, enum: [...IJourney_1.journeyStepGoals] }
+                        items: { type: "string", format: "journey-step-goal" }
                     }
                 }
             }

package/build/shared/interfaces/journeys/IJourneyTrackEvent.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.trackableJourneyEvent = void 0;
 exports.trackableJourneyEvent = [
     /* resources */
     "createAgent",

package/build/shared/interfaces/journeys/index.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.journeyProgressSchema = exports.journeyProgressDataSchema = exports.journeyStepGoals = exports.journeySchema = exports.journeyQuerySchema = exports.journeyDataSchema = exports.trackableJourneyEvent = void 0;
 var IJourneyTrackEvent_1 = require("./IJourneyTrackEvent");
-exports.trackableJourneyEvent = IJourneyTrackEvent_1.trackableJourneyEvent;
+Object.defineProperty(exports, "trackableJourneyEvent", { enumerable: true, get: function () { return IJourneyTrackEvent_1.trackableJourneyEvent; } });
 var IJourney_1 = require("./IJourney");
-exports.journeyDataSchema = IJourney_1.journeyDataSchema;
-exports.journeyQuerySchema = IJourney_1.journeyQuerySchema;
-exports.journeySchema = IJourney_1.journeySchema;
-exports.journeyStepGoals = IJourney_1.journeyStepGoals;
+Object.defineProperty(exports, "journeyDataSchema", { enumerable: true, get: function () { return IJourney_1.journeyDataSchema; } });
+Object.defineProperty(exports, "journeyQuerySchema", { enumerable: true, get: function () { return IJourney_1.journeyQuerySchema; } });
+Object.defineProperty(exports, "journeySchema", { enumerable: true, get: function () { return IJourney_1.journeySchema; } });
+Object.defineProperty(exports, "journeyStepGoals", { enumerable: true, get: function () { return IJourney_1.journeyStepGoals; } });
 var IJourneyProgress_1 = require("./IJourneyProgress");
-exports.journeyProgressDataSchema = IJourneyProgress_1.journeyProgressDataSchema;
-exports.journeyProgressSchema = IJourneyProgress_1.journeyProgressSchema;
+Object.defineProperty(exports, "journeyProgressDataSchema", { enumerable: true, get: function () { return IJourneyProgress_1.journeyProgressDataSchema; } });
+Object.defineProperty(exports, "journeyProgressSchema", { enumerable: true, get: function () { return IJourneyProgress_1.journeyProgressSchema; } });
 //# sourceMappingURL=index.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/management/IVendor.js

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

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSwitchedFlowData = exports.userSchema = void 0;
 exports.userSchema = {
     title: "userSchema",
     type: "object",
@@ -14,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