@cognigy/rest-api-client 0.16.0 → 0.18.0

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

@@ -36,6 +36,7 @@ exports.endpointTypes = [
     "genesysBotConnector",
     "niceCXOne",
     "agentAssistVoice",
+    "webchat3"
 ];
 const transferTypes = ["dial", "sip:refer"];
 exports.webchatPersistentMenuSchema = {
@@ -74,6 +75,18 @@ exports.businessHoursMenuSchema = {
                 }
             }
         },
+        times: {
+            type: "array",
+            items: {
+                type: "object",
+                additionalProperties: false,
+                properties: {
+                    startTime: { type: "string" },
+                    endTime: { type: "string" },
+                    weekDay: { type: "string" },
+                }
+            }
+        },
         enabled: { type: "boolean" },
         mode: { type: "string" },
         text: { type: "string" },
@@ -129,11 +142,12 @@ const callFailoverSettingsSchema = {
         dialTranscribeRecognitionChannel: { type: "number" },
         dialTranscribeRecognitionGoogleModel: { type: 'string' },
         dialTranscribeLabel: { type: "string" },
-        dialTranscribeDeepgramTier: { type: 'string' },
         dialTranscribeDeepgramModel: { type: 'string' },
+        referredBy: { type: "string" },
         deepgramSmartFormatting: { type: "boolean" },
         deepgramEndpointing: { type: "boolean" },
-        deepgramEndpointingValue: { type: "number" }
+        deepgramEndpointingValue: { type: "number" },
+        dialTranscribeDeepgramTier: { type: "string" }
     }
 };
 exports.callEventSettingsSchema = {
@@ -580,6 +594,7 @@ exports.AMAZON_POLLY_LANGUAGE_MAPPING = {
         { voice: "Polly.Astrid", gender: "female" }
     ]
 };
+[];
 exports.avayaEndpointSettingsSchema = {
     type: "object",
     properties: {

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

@@ -86,11 +86,11 @@ exports.createHandoverRequestDataSchema = {
         "buttonId": {
             "type": "string"
         },
-        "salesforcePrechatDetails": {
-            "type": "array"
+        salesforcePrechatDetails: {
+            type: ["object", "array", "number", "string"],
         },
-        "salesforcePrechatEntities": {
-            "type": "array"
+        salesforcePrechatEntities: {
+            type: ["object", "array", "number", "string"],
         },
         "notifySessionId": {
             "type": "string",
@@ -250,8 +250,12 @@ exports.pollAgentRepliesEventSchema = {
         handoverSettings: handover_1.handoverSettingsSchema,
         foreignSessionData: handover_1.foreignSessionDataSchema,
         foreignSessionId: { type: "string" },
+        organisation: { type: "string" },
+        sessionId: { type: "string" },
         traceId: { type: "string" },
-        disableSensitiveLogging: { type: "boolean" }
+        disableSensitiveLogging: { type: "boolean" },
+        pollingTimeoutAt: { type: "number" },
+        sequence: { type: "number" }
     },
 };
 exports.handleHandoverRpcEventSchema = {

package/build/shared/interfaces/nlu/nlu.js

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

package/build/shared/interfaces/resources/IAuditEvent.js

@@ -7,7 +7,7 @@ exports.auditEventTypes = [
     "replace",
     "patch",
     "delete",
-    "unauthorized"
+    "unauthorized",
 ];
 exports.actionTypes = [
     "acceptTermsOfService",
@@ -35,6 +35,7 @@ exports.actionTypes = [
     "cancelTask",
     "changePlaybookStepOrder",
     "cloneFlow",
+    "cloneMilestone",
     "cloneLargeLanguageModel",
     "configureIdentityProvider",
     "createKnowledgeSearchIndex",
@@ -105,7 +106,7 @@ exports.actionTypes = [
     "updateFlowSettings",
     "optionsResolver",
     "processKnowledgeSourceUrl",
-    "processKnowledgeSourceFile"
+    "processKnowledgeSourceFile",
 ];
 exports.auditEventSchema = {
     title: "auditEventSchema",
@@ -117,14 +118,14 @@ exports.auditEventSchema = {
         "user",
         "userReference",
         "organisationReference",
-        "expiresAt"
+        "expiresAt",
     ],
     properties: {
         _id: { type: "string", format: "mongo-id" },
         timestamp: { type: "object", format: "date-time" },
         type: {
             type: "string",
-            enum: [...exports.auditEventTypes]
+            enum: [...exports.auditEventTypes],
         },
         actionType: { type: "string", enum: [...exports.actionTypes] },
         user: { type: "string", format: "email" },
@@ -139,13 +140,13 @@ exports.auditEventSchema = {
                 additionalProperties: false,
                 properties: {
                     elementId: { type: "string", format: "mongo-id" },
-                    elementType: { type: "string" }
-                }
-            }
+                    elementType: { type: "string" },
+                },
+            },
         },
         expiresAt: { type: "object", format: "date-time" },
         payload: { type: "string" },
-        projectReference: { type: "string", format: "mongo-id" }
-    }
+        projectReference: { type: "string", format: "mongo-id" },
+    },
 };
 //# sourceMappingURL=IAuditEvent.js.map

package/build/shared/interfaces/resources/ILargeLanguageModel.js

@@ -1,28 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.largeLanguageModelQuerySchema = exports.largeLanguageModelSchema = exports.largeLanguageModelDataSchema = exports.googleVertexAIMeataSchema = exports.azureOpenAIMeataSchema = exports.openAIMeataSchema = exports.alephAlphaMeataSchema = void 0;
+exports.largeLanguageModelQuerySchema = exports.largeLanguageModelSchema = exports.largeLanguageModelDataSchema = exports.googleVertexAIMetaSchema = exports.azureOpenAIMetaSchema = exports.openAIMetaSchema = exports.alephAlphaMetaSchema = exports.anthropicMetaSchema = void 0;
 /* Custom Modules */
 const createQuerySchema_1 = require("../../helper/createQuerySchema");
 const IEntityMeta_1 = require("./IEntityMeta");
 const IGenerativeAIModels_1 = require("../generativeAI/IGenerativeAIModels");
-exports.alephAlphaMeataSchema = {
-    title: "alephAlphaMeataSchema",
+exports.anthropicMetaSchema = {
+    title: "anthropicMetaSchema",
     type: "object",
     additionalProperties: false,
     properties: {
-        customModel: { type: "string" }
+        customModel: { type: ["string", "null"] }
     }
 };
-exports.openAIMeataSchema = {
-    title: "openAIMeataSchema",
+exports.alephAlphaMetaSchema = {
+    title: "alephAlphaMetaSchema",
     type: "object",
     additionalProperties: false,
     properties: {
-        customModel: { type: "string" }
+        customModel: { type: ["string", "null"] },
+        baseCustomUrl: { type: ["string", "null"] },
+    }
+};
+exports.openAIMetaSchema = {
+    title: "openAIMetaSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        customModel: { type: ["string", "null"] }
     }
 };
-exports.azureOpenAIMeataSchema = {
-    title: "azureOpenAIMeataSchema",
+exports.azureOpenAIMetaSchema = {
+    title: "azureOpenAIMetaSchema",
     type: "object",
     additionalProperties: false,
     properties: {
@@ -30,37 +39,42 @@ exports.azureOpenAIMeataSchema = {
         deploymentName: { type: ["string", "null"] },
         apiVersion: { type: ["string", "null"] },
         baseCustomUrl: { type: ["string", "null"] },
+        customModel: { type: ["string", "null"] }
     }
 };
-exports.googleVertexAIMeataSchema = {
-    title: "googleVertexAIMeataSchema",
+exports.googleVertexAIMetaSchema = {
+    title: "googleVertexAIMetaSchema",
     type: "object",
     additionalProperties: false,
     properties: {
         apiEndPoint: { type: "string", format: "resource-name" },
         location: { type: "string", format: "resource-name" },
-        publisher: { type: ["string", "null"] }
+        publisher: { type: ["string", "null"] },
+        customModel: { type: ["string", "null"] },
     }
 };
 exports.largeLanguageModelDataSchema = {
     title: "largeLanguageModelDataSchema",
     type: "object",
     additionalProperties: false,
-    required: [
-        "name",
-        "modelType",
+    oneOf: [
+        { required: ["name", "modelType",] },
+        { required: ["name", "modelType", "modelGroup", "isCustomModel"] }
     ],
     properties: {
         name: { type: "string", format: "resource-name" },
         description: { type: "string", format: "resource-description" },
-        modelType: { type: "string", enum: [...IGenerativeAIModels_1.generativeAIModels] },
+        modelType: { type: "string" } /* wildcard string for the Custom Models */,
+        isCustomModel: { type: "boolean" },
+        modelGroup: { type: "string", enum: [...IGenerativeAIModels_1.modelGroups] },
         provider: { type: "string", enum: [...IGenerativeAIModels_1.generativeAIProviders] },
         connectionId: { type: "string", format: "uuid" },
         isDefault: { type: "boolean" },
-        openAI: exports.openAIMeataSchema,
-        azureOpenAI: exports.azureOpenAIMeataSchema,
-        googleVertexAI: exports.googleVertexAIMeataSchema,
-        alephAlpha: exports.alephAlphaMeataSchema
+        openAI: exports.openAIMetaSchema,
+        azureOpenAI: exports.azureOpenAIMetaSchema,
+        googleVertexAI: exports.googleVertexAIMetaSchema,
+        alephAlpha: exports.alephAlphaMetaSchema,
+        anthropic: exports.anthropicMetaSchema
     }
 };
 exports.largeLanguageModelSchema = {

package/build/shared/interfaces/resources/IMilestone.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.milestoneSchema = exports.milestoneDataSchema = exports.milestoneStepSchema = exports.milestoneStepMetricSchema = void 0;
+const IEntityMeta_1 = require("./IEntityMeta");
+exports.milestoneStepMetricSchema = {
+    title: "milestoneStepMetricSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        _id: { type: "string", format: "mongo-id" },
+        name: { type: "string" },
+        description: { type: "string" },
+        type: { type: "string", enum: ["currency", "duration"] },
+        value: { type: "number" },
+    },
+};
+exports.milestoneStepSchema = {
+    title: "milestoneStepSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        _id: { type: "string", format: "mongo-id" },
+        name: { type: "string" },
+        description: { type: "string" },
+        order: { type: "number" },
+        type: { type: "string", enum: ["start", "completion"] },
+        metrics: {
+            type: "array",
+            items: exports.milestoneStepMetricSchema,
+        },
+    },
+};
+exports.milestoneDataSchema = {
+    title: "milestoneDataSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        version: { type: "number" },
+        description: { type: "string" },
+        name: { type: "string", format: "resource-name" },
+        steps: { type: "array", items: exports.milestoneStepSchema },
+    },
+};
+exports.milestoneSchema = {
+    title: "milestoneSchema",
+    type: "object",
+    additionalProperties: false,
+    properties: Object.assign(Object.assign(Object.assign({}, exports.milestoneDataSchema.properties), IEntityMeta_1.entityMetaSchema.properties), { referenceId: { type: "string", format: "uuid" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
+};
+//# sourceMappingURL=IMilestone.js.map

package/build/shared/interfaces/resources/INodeDescriptorSet.js

@@ -12,8 +12,8 @@ const nodeAppearanceSchema = {
         textColor: { type: "string", format: "color" },
         contrastTextColor: { type: "string", format: "color" },
         showIcon: { type: "boolean" },
-        variant: { type: "string", enum: ["regular", "mini", "hexagon"] }
-    }
+        variant: { type: "string", enum: ["regular", "mini", "hexagon"] },
+    },
 };
 const nodeBehaviorSchema = {
     title: "nodeBehaviorSchema",
@@ -21,18 +21,24 @@ const nodeBehaviorSchema = {
     additionalProperties: false,
     properties: {
         stopping: { type: "boolean" },
-        entrypoint: { type: "boolean" }
-    }
+        entrypoint: { type: "boolean" },
+    },
 };
-exports.nodePreviewTypes = ["text", "sayNode", "custom", "resource", "image"];
+exports.nodePreviewTypes = [
+    "text",
+    "sayNode",
+    "custom",
+    "resource",
+    "image",
+];
 const nodePreviewSchema = {
     title: "nodePreviewSchema",
     type: "object",
     additionalProperties: false,
     properties: {
         key: { type: "string", minLength: 1, maxLength: 200 },
-        type: { type: "string", enum: [...exports.nodePreviewTypes] }
-    }
+        type: { type: "string", enum: [...exports.nodePreviewTypes] },
+    },
 };
 const nodeConstraintSchema = {
     title: "nodeConstraintSchema",
@@ -41,13 +47,13 @@ const nodeConstraintSchema = {
     properties: {
         blacklist: {
             type: "array",
-            items: { type: "string", minLength: 1, maxLength: 200 }
+            items: { type: "string", minLength: 1, maxLength: 200 },
         },
         whitelist: {
             type: "array",
-            items: { type: "string", minLength: 1, maxLength: 200 }
-        }
-    }
+            items: { type: "string", minLength: 1, maxLength: 200 },
+        },
+    },
 };
 const nodeConstraintsSchema = {
     title: "nodeConstraintsSchema",
@@ -66,10 +72,10 @@ const nodeConstraintsSchema = {
             properties: {
                 children: nodeConstraintSchema,
                 predecessor: nodeConstraintSchema,
-                successor: nodeConstraintSchema
-            }
-        }
-    }
+                successor: nodeConstraintSchema,
+            },
+        },
+    },
 };
 const nodeDependenciesSchema = {
     title: "nodeDependenciesSchema",
@@ -78,14 +84,15 @@ const nodeDependenciesSchema = {
     properties: {
         children: {
             type: "array",
-            items: { type: "string", minLength: 1, maxLength: 200 }
-        }
-    }
+            items: { type: "string", minLength: 1, maxLength: 200 },
+        },
+    },
 };
 exports.nodeFieldTypes = [
     "adaptivecard",
     "agentAssistConfig",
     "appTemplate",
+    "backgroundSelector",
     "caseNode",
     "checkbox",
     "chipInput",
@@ -141,7 +148,7 @@ exports.searchableNodeFieldTypes = [
     "say",
     "code",
     "caseNode",
-    "select"
+    "select",
 ];
 exports.nodeFieldSingleConditionSchema = {
     title: "nodeFieldSingleConditionSchema",
@@ -158,11 +165,11 @@ exports.nodeFieldSingleConditionSchema = {
                 { type: "number" },
                 { type: "array", items: { type: "number" } },
                 { type: "boolean" },
-                { type: "array", items: { type: "boolean" } }
-            ]
+                { type: "array", items: { type: "boolean" } },
+            ],
         },
-        negate: { type: "boolean" }
-    }
+        negate: { type: "boolean" },
+    },
 };
 exports.nodeFieldANDConditionSchema = {
     title: "nodeFieldANDConditionSchema",
@@ -170,8 +177,8 @@ exports.nodeFieldANDConditionSchema = {
     additionalProperties: false,
     required: ["and"],
     properties: {
-        and: { type: "array", items: { $ref: "nodeFieldConditionSchema" } }
-    }
+        and: { type: "array", items: { $ref: "nodeFieldConditionSchema" } },
+    },
 };
 exports.nodeFieldORConditionSchema = {
     title: "nodeFieldORConditionSchema",
@@ -179,8 +186,8 @@ exports.nodeFieldORConditionSchema = {
     additionalProperties: false,
     required: ["or"],
     properties: {
-        or: { type: "array", items: { $ref: "nodeFieldConditionSchema" } }
-    }
+        or: { type: "array", items: { $ref: "nodeFieldConditionSchema" } },
+    },
 };
 // @ts-ignore
 exports.nodeFieldConditionSchema = {
@@ -193,17 +200,20 @@ exports.nodeFieldConditionSchema = {
         // @ts-ignore
         exports.nodeFieldANDConditionSchema,
         // @ts-ignore
-        exports.nodeFieldORConditionSchema
-    ]
+        exports.nodeFieldORConditionSchema,
+    ],
 };
 exports.nodeOptionsResolverSchema = {
     title: "nodeOptionsResolverSchema",
     type: "object",
     additionalProperties: false,
     properties: {
-        dependencies: { type: "array", items: { type: "string", minLength: 1, maxLength: 200 } },
-        resolverFunction: {}
-    }
+        dependencies: {
+            type: "array",
+            items: { type: "string", minLength: 1, maxLength: 200 },
+        },
+        resolverFunction: {},
+    },
 };
 exports.nodeFieldSchema = {
     title: "nodeFieldSchema",
@@ -224,10 +234,10 @@ exports.nodeFieldSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 }
-                    }
-                }
-            ]
+                        koKR: { type: "string", maxLength: 200 },
+                    },
+                },
+            ],
         },
         condition: exports.nodeFieldConditionSchema,
         defaultValue: {
@@ -237,8 +247,8 @@ exports.nodeFieldSchema = {
                 { type: "number" },
                 { type: "null" },
                 { type: "object" },
-                { type: "string" }
-            ]
+                { type: "string" },
+            ],
         },
         description: {
             oneOf: [
@@ -252,14 +262,14 @@ exports.nodeFieldSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 }
-                    }
-                }
-            ]
+                        koKR: { type: "string", maxLength: 200 },
+                    },
+                },
+            ],
         },
         params: { type: "object" },
-        optionsResolver: exports.nodeOptionsResolverSchema
-    }
+        optionsResolver: exports.nodeOptionsResolverSchema,
+    },
 };
 exports.nodeSectionSchema = {
     title: "nodeSectionSchema",
@@ -279,10 +289,10 @@ exports.nodeSectionSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 }
-                    }
-                }
-            ]
+                        koKR: { type: "string", maxLength: 200 },
+                    },
+                },
+            ],
         },
         description: {
             oneOf: [
@@ -296,10 +306,10 @@ exports.nodeSectionSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 }
-                    }
-                }
-            ]
+                        koKR: { type: "string", maxLength: 200 },
+                    },
+                },
+            ],
         },
         condition: exports.nodeFieldConditionSchema,
         defaultCollapsed: { type: "boolean" },
@@ -311,10 +321,10 @@ exports.nodeSectionSchema = {
             items: {
                 type: "string",
                 minLength: 1,
-                maxLength: 200
-            }
-        }
-    }
+                maxLength: 200,
+            },
+        },
+    },
 };
 exports.nodeFieldAndSectionFormElementSchema = {
     title: "nodeFieldAndSectionFormElementSchema",
@@ -322,8 +332,8 @@ exports.nodeFieldAndSectionFormElementSchema = {
     required: ["key", "type"],
     properties: {
         key: { type: "string", minLength: 1, maxLength: 200 },
-        type: { type: "string", enum: ["field", "section"] }
-    }
+        type: { type: "string", enum: ["field", "section"] },
+    },
 };
 exports.nodeDescriptorSchema = {
     title: "nodeDescriptorSchema",
@@ -345,10 +355,10 @@ exports.nodeDescriptorSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 }
-                    }
-                }
-            ]
+                        koKR: { type: "string", maxLength: 200 },
+                    },
+                },
+            ],
         },
         summary: {
             oneOf: [
@@ -362,10 +372,10 @@ exports.nodeDescriptorSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 }
-                    }
-                }
-            ]
+                        koKR: { type: "string", maxLength: 200 },
+                    },
+                },
+            ],
         },
         appearance: nodeAppearanceSchema,
         behavior: nodeBehaviorSchema,
@@ -378,25 +388,25 @@ exports.nodeDescriptorSchema = {
             type: "array",
             items: { type: "string" },
             uniqueItems: true,
-            minItems: 0
+            minItems: 0,
         },
         tokens: {
             type: "array",
             items: ISnippet_1.snippetDataSchema,
-            uniqueItems: true
+            uniqueItems: true,
         },
         sections: {
             type: "array",
             additionalItems: false,
-            items: exports.nodeSectionSchema
+            items: exports.nodeSectionSchema,
         },
         form: {
             type: "array",
             additionalItems: false,
             maxLength: 25,
-            items: exports.nodeFieldAndSectionFormElementSchema
-        }
-    }
+            items: exports.nodeFieldAndSectionFormElementSchema,
+        },
+    },
 };
 exports.nodeDescriptorSetSchema = {
     title: "nodeDescriptorSetSchema",
@@ -412,10 +422,10 @@ exports.nodeDescriptorSetSchema = {
         descriptors: {
             type: "array",
             additionalItems: false,
-            items: exports.nodeDescriptorSchema
+            items: exports.nodeDescriptorSchema,
         },
         resourceType: { type: "string", enum: TResourceType_1.chartableResourceTypes },
-        trustedCode: { type: "boolean" }
-    }
+        trustedCode: { type: "boolean" },
+    },
 };
 //# sourceMappingURL=INodeDescriptorSet.js.map