@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/interfaces/IProfile.js

@@ -1,5 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.profileQuerySchema = exports.profileSchema = exports.profileDataSchema = void 0;
+/* Custom Modules */
+const createQuerySchema_1 = require("../helper/createQuerySchema");
 const IEntityMeta_1 = require("./resources/IEntityMeta");
 exports.profileDataSchema = {
     title: "profileDataSchema",
@@ -7,7 +10,7 @@ exports.profileDataSchema = {
     additionalProperties: false,
     properties: {
         active: { type: "boolean" },
-        contactIds: { type: "array", items: { type: "string" }, additionalItems: false },
+        contactIds: { type: "array", items: { type: "string" }, additionalItems: false, minItems: 1 },
         expiresAt: { type: "object" },
         profile: {},
     },
@@ -18,4 +21,5 @@ exports.profileSchema = {
     additionalProperties: false,
     properties: Object.assign(Object.assign(Object.assign({}, exports.profileDataSchema.properties), IEntityMeta_1.entityMetaSchema.properties), { projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
 };
+exports.profileQuerySchema = createQuerySchema_1.createQuerySchema("profileQuerySchema", exports.profileSchema);
 //# sourceMappingURL=IProfile.js.map

package/build/shared/interfaces/IProfileSchema.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateProfileSchemaRedisKeys = exports.defaultProfile = exports.profileSchemaSchema = exports.profileSchemaEntry = exports.profileEntrySchemaTypes = void 0;
 const IEntityMeta_1 = require("./resources/IEntityMeta");
+exports.profileEntrySchemaTypes = ["string", "object", "number", "boolean"];
 exports.profileSchemaEntry = {
     title: "profileSchemaEntry",
     type: "object",
     required: ["field", "internal", "type"],
     properties: {
         field: { type: "string" },
-        internal: { type: "string", pattern: "^[a-zA-Z_]+$" },
-        type: { type: "string", enum: ["string", "object", "number", "boolean"] }
+        internal: { type: "string", format: "profile-schema-entry-internal" },
+        type: { type: "string", format: "profile-schema-entry-type" }
     },
 };
 exports.profileSchemaSchema = {
@@ -35,4 +37,10 @@ exports.defaultProfile = {
     accepted_gdpr: false,
     goals: [],
 };
+const generateProfileSchemaRedisKeys = (data) => {
+    return [
+        `organisationId:${data.organisationId}:projectId:${data.projectId}:profileSchema`,
+    ];
+};
+exports.generateProfileSchemaRedisKeys = generateProfileSchemaRedisKeys;
 //# sourceMappingURL=IProfileSchema.js.map

package/build/shared/interfaces/ISessionScope.js

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

package/build/shared/interfaces/TEntrypointType.js

@@ -0,0 +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/TFunctionInstanceStatus.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.functionInstanceStatus = void 0;
+exports.functionInstanceStatus = [
+    "queued",
+    "active",
+    "done",
+    "error",
+];
+//# sourceMappingURL=TFunctionInstanceStatus.js.map

package/build/shared/interfaces/TFunctionInstanceTrigger.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.functionInstanceTrigger = void 0;
+exports.functionInstanceTrigger = [
+    "flow",
+    "manual",
+];
+//# sourceMappingURL=TFunctionInstanceTrigger.js.map

package/build/shared/interfaces/alexa/ISkill.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.skillSchema = void 0;
 exports.skillSchema = {
     title: "skillSchema",
     type: "object",

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.skillSchema = void 0;
 var ISkill_1 = require("./ISkill");
-exports.skillSchema = ISkill_1.skillSchema;
+Object.defineProperty(exports, "skillSchema", { enumerable: true, get: function () { return ISkill_1.skillSchema; } });
 //# sourceMappingURL=index.js.map

package/build/shared/interfaces/amqpInterface.js

@@ -1,25 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeRpcInternalParamsSchema = exports.referenceKeys = void 0;
+;
 exports.referenceKeys = [
+    "analyticsStepReference",
     "chartReference",
     "dataReference",
     "extensionReference",
+    "fallbackLocaleReference",
     "flowReference",
+    "functionReference",
+    "handoverRequestReference",
     "intentReference",
     "intentTrainGroupReference",
-    "lexiconReference",
     "lexiconEntryReference",
-    "nodeReference",
+    "lexiconReference",
+    "localeReference",
     "nodeDescriptorReference",
     "nodeDescriptorSetReference",
+    "nodeReference",
     "organisationReference",
+    "primaryLocaleReference",
     "projectReference",
     "resourceReference",
-    "subResourceReference",
-    "primaryLocaleReference",
     "snapshotReference",
-    "localeReference",
-    "fallbackLocaleReference"
+    "subResourceReference",
 ];
 exports.executeRpcInternalParamsSchema = {
     title: "executeRpcInternalParamsSchema",
@@ -58,8 +63,25 @@ exports.executeRpcInternalParamsSchema = {
                 }
             ]
         },
+        consumerTag: {
+            type: "string",
+        },
+        delay: {
+            type: "number",
+            minimum: 1,
+        },
+        session: {},
+        bulk: {
+            type: "boolean",
+        },
         reThrow: {
             type: "boolean"
+        },
+        exchange: {
+            type: "string"
+        },
+        expiration: {
+            type: "string"
         }
     }
 };

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

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

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/IAnalyticsFlowMeta.js

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

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

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

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

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

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

@@ -1,64 +1,216 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+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/IAnalyticsStepData.js

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

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stepEventSchema = void 0;
+exports.stepEventSchema = {
+    title: "stepEventSchema",
+    type: "object",
+    required: [
+        "sessionId",
+        "userId",
+        "inputId",
+        "stepLabel",
+        "timestamp",
+        "entityReferenceId",
+        "type",
+        "flowName",
+        "flowReferenceId",
+        "projectName",
+        "projectId",
+        "organisationId",
+    ],
+    additionalProperties: false,
+    properties: {
+        _id: { format: "mongo-id" },
+        sessionId: { type: "string", },
+        userId: { type: "string", },
+        inputId: { type: "string" },
+        parentStep: { type: ["string", "null"], format: "uuid" },
+        stepLabel: { type: "string", format: "analytics-label" },
+        timestamp: { type: "object" },
+        entityReferenceId: { type: "string", format: "uuid" },
+        type: { type: "string", enum: ["intent", "node"] },
+        flowName: { type: "string", format: "resource-name" },
+        flowReferenceId: { type: "string", format: "uuid" },
+        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" },
+        projectId: { format: "mongo-id" },
+        snapshotName: { type: "string", format: "resource-name" },
+        snapshotId: { format: "mongo-id" },
+        organisationId: { format: "mongo-id" },
+    },
+};
+//# sourceMappingURL=IStepEvent.js.map

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/TAnalyticsSource.js

@@ -1,3 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyticsSourceTypes = void 0;
+exports.analyticsSourceTypes = [
+    "user",
+    "bot",
+    "agent",
+    "suggestion"
+];
 //# sourceMappingURL=TAnalyticsSource.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/analytics/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.customerEditableAnalyticsSchema = void 0;
 var IAnalyticsSourceData_1 = require("./IAnalyticsSourceData");
-exports.customerEditableAnalyticsSchema = IAnalyticsSourceData_1.customerEditableAnalyticsSchema;
+Object.defineProperty(exports, "customerEditableAnalyticsSchema", { enumerable: true, get: function () { return IAnalyticsSourceData_1.customerEditableAnalyticsSchema; } });
 //# sourceMappingURL=index.js.map

package/build/shared/interfaces/cognigySlots.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cognigySystemSlots = void 0;
 exports.cognigySystemSlots = [
     "DATE",
     "NUMBER",

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/INluWarningEventPayload.js

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

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDebugEndpointEventType = exports.debugEventTypes = void 0;
+exports.debugEventTypes = [
+    "activeEntrypointsChanged",
+    "contextChanged",
+    "finalPing",
+    "inputChanged",
+    "nodeError",
+    "nodeExecuted",
+    "input",
+    "output",
+    "profileChanged",
+    "switchedFlow",
+];
+function isValidDebugEndpointEventType(value) {
+    return (typeof value === "string" &&
+        exports.debugEventTypes.indexOf(value) !== -1);
+}
+exports.isValidDebugEndpointEventType = isValidDebugEndpointEventType;
+//# sourceMappingURL=TDebugEndpointEvent.js.map

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayTDebugEventTypes = void 0;
 exports.arrayTDebugEventTypes = [
     "inputChanged",
     "contextChanged",
@@ -8,9 +9,9 @@ exports.arrayTDebugEventTypes = [
     "nodeExecuted",
     "nodeError",
     "finalPing",
-    "intentFound",
-    "slotFound",
+    "input",
     "output",
-    "switchedFlow"
+    "switchedFlow",
+    "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