@cognigy/rest-api-client 0.18.0 → 0.20.0

package/build/shared/interfaces/resources/settings/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translationProviders = exports.translationSettingsDataSchema = exports.audioPreviewProviders = exports.audioPreviewSettingsDataSchema = exports.generativeAISettingsDataSchema = exports.sharedSettingsSchema = exports.flowSettingsSchema = exports.flowSettingsDataSchema = exports.flowIntentMappingOrderType = exports.agentSettingsSchema = exports.agentSettingsDataSchema = void 0;
+exports.fileExtractorOptions = exports.knowledgeAISettingsDataSchema = exports.translationProviders = exports.translationSettingsDataSchema = exports.audioPreviewProviders = exports.audioPreviewSettingsDataSchema = exports.generativeAISettingsDataSchema = exports.sharedSettingsSchema = exports.flowSettingsSchema = exports.flowSettingsDataSchema = exports.flowIntentMappingOrderType = exports.agentSettingsSchema = exports.agentSettingsDataSchema = void 0;
 var IAgentSettings_1 = require("./IAgentSettings");
 Object.defineProperty(exports, "agentSettingsDataSchema", { enumerable: true, get: function () { return IAgentSettings_1.agentSettingsDataSchema; } });
 Object.defineProperty(exports, "agentSettingsSchema", { enumerable: true, get: function () { return IAgentSettings_1.agentSettingsSchema; } });
@@ -18,4 +18,7 @@ Object.defineProperty(exports, "audioPreviewProviders", { enumerable: true, get:
 var ITranslationSettings_1 = require("./ITranslationSettings");
 Object.defineProperty(exports, "translationSettingsDataSchema", { enumerable: true, get: function () { return ITranslationSettings_1.translationSettingsDataSchema; } });
 Object.defineProperty(exports, "translationProviders", { enumerable: true, get: function () { return ITranslationSettings_1.translationProviders; } });
+var IKnowledgeAISettings_1 = require("./IKnowledgeAISettings");
+Object.defineProperty(exports, "knowledgeAISettingsDataSchema", { enumerable: true, get: function () { return IKnowledgeAISettings_1.knowledgeAISettingsDataSchema; } });
+Object.defineProperty(exports, "fileExtractorOptions", { enumerable: true, get: function () { return IKnowledgeAISettings_1.fileExtractorOptions; } });
 //# sourceMappingURL=index.js.map

package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadCollectionsToBeDeletedRest_2_0.js

@@ -5,7 +5,6 @@ exports.servicesNames = void 0;
 exports.servicesNames = [
     "service-api",
     "service-resources",
-    "service-journeys",
     "service-logs",
     "service-profiles",
     "service-security",

package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadOrganisationKnowledgeChunksCountRest_2_0.js

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

package/build/shared/interfaces/restAPI/administration/user/v2.0/IGetPinnedResources_2_0.js

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

package/build/shared/interfaces/restAPI/{resources/journey/v2.0/IReadJourneyRest_2_0.js → administration/user/v2.0/IPinResourceRest_2_0.js}

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

package/build/shared/interfaces/restAPI/operations/nlu/v2.0/IGenerateNluScoresRest_2_0.js

@@ -0,0 +1,57 @@
+"use strict";
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     IGenerateNluScoreData_2_0:
+ *       type: object
+ *       required:
+ *         - flowReferenceId
+ *         - localeReferenceId
+ *         - sentence
+ *       properties:
+ *         flowReferenceId:
+ *           type: string
+ *           format: uuid
+ *           description: UUID of the flow reference.
+ *         localeReferenceId:
+ *           type: string
+ *           format: uuid
+ *           description: UUID of the locale reference.
+ *         sentence:
+ *           type: string
+ *           description: Sentence to analyze for NLU scoring.
+ *
+ *     IGeneratedNluScore_2_0:
+ *       type: object
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: Unique identifier of the score.
+ *         name:
+ *           type: string
+ *           description: Name of the score type.
+ *         score:
+ *           type: number
+ *           description: Numerical value of the score.
+ *         negated:
+ *           type: boolean
+ *           description: Indicates if the score is negated.
+ *         confirmationSentence:
+ *           type: string
+ *           description: Sentence used to confirm the score.
+ *         confirmationSentences:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Multiple sentences for confirmation if applicable.
+ *         disambiguationSentence:
+ *           type: string
+ *           description: Sentence used for disambiguation.
+ *         flow:
+ *           type: string
+ *           description: UUID of the flow associated with the score.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IGenerateNluScoresRest_2_0.js.map

package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgentHiringTemplate_2_0.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     IAiAgentHiringTemplate_2_0:
+ *       type: object
+ *       properties:
+ *         templateId:
+ *           type: string
+ *           description: The ID of the AI Agent template to hire.
+ *           example: RetailAssistant-Rita
+ *         aiAgentName:
+ *           type: string
+ *           description: The name of the AI Agent.
+ *           example: Rita
+ *         aiAgentFileName:
+ *           type: string
+ *           description: The file name of the AI Agent.
+ *           example: Rita.tar
+ *         aiAgentImage:
+ *           type: string
+ *           description: The image of the AI Agent.
+ *           example: https://cognigy.com/rita.png
+ *         aiAgentDescription:
+ *           type: string
+ *           description: A short description of the AI Agent, up to 1000 characters.
+ *           example: "I am a virtual assistant that can help you with your questions."
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAiAgentHiringTemplate_2_0.js.map

package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgent_2_0.js

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

package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IIndexJourneysRest_2_0.js → aiAgent/v2.0/ICreateAiAgentRest_2_0.js}

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

package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IDeleteAiAgentRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IGetAiAgentHiringTemplates_2_0.js

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

package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IJourneyStep_2_0.js → aiAgent/v2.0/IHireAiAgent_2_0.js}

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

package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IJourneyIndexItem_2_0.js → aiAgent/v2.0/IIndexAiAgentRest_2_0.js}

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

package/build/shared/interfaces/restAPI/resources/{journey/v2.0/IJourneyProgress_2_0.js → aiAgent/v2.0/IReadAiAgentRest_2_0.js}

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

package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IUpdateAiAgentRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IValidateAiAgentNameRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/ICloneGoalRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/ICreateGoalRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IDeleteGoalRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalIndexItem_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalStepMetric_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalStep_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoal_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IIndexGoalsRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IReadGoalRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/IUpdateGoalRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/goal/v2.0/index.js

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

package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IAvailableModelsForLLMProvider_2_0 .js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     IAvailableModelItem_2_0:
+ *       type: object
+ *       properties:
+ *         modelName:
+ *           type: string
+ *         modelId:
+ *           type: string
+ *         providerName:
+ *           type: array
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAvailableModelsForLLMProvider_2_0%20.js.map

package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IGetAvailableModelsForLLMRest_2_0 .js

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

package/build/shared/interfaces/security/IPermission.js

@@ -11,6 +11,7 @@ exports.availablePermissions = exports.projectWidePermissions = exports.organisa
  *       enum:
  *         - analyticsOdata
  *         - apiKeys
+ *         - auditEvents
  *         - liveAgentAccount
  *         - projects
  *         - userDetails
@@ -20,6 +21,7 @@ exports.availablePermissions = exports.projectWidePermissions = exports.organisa
 exports.organisationWidePermissions = [
     "analyticsOdata",
     "apiKeys",
+    "auditEvents",
     "assignProject",
     "liveAgentAccount",
     "projects",
@@ -36,6 +38,7 @@ exports.organisationWidePermissions = [
  *       type: string
  *       enum:
  *         - agentAssistConfigs
+ *         - aiAgents
  *         - analytics
  *         - connections
  *         - contactProfiles
@@ -57,7 +60,7 @@ exports.organisationWidePermissions = [
  *         - logs
  *         - memberDetails
  *         - members
- *         - milestones
+ *         - goals
  *         - nluConnectors
  *         - packages
  *         - playbooks
@@ -73,6 +76,7 @@ exports.organisationWidePermissions = [
  */
 exports.projectWidePermissions = [
     "agentAssistConfigs",
+    "aiAgents",
     "analytics",
     "connections",
     "contactProfiles",
@@ -95,7 +99,7 @@ exports.projectWidePermissions = [
     "logs",
     "memberDetails",
     "members",
-    "milestones",
+    "goals",
     "nluConnectors",
     "packages",
     "playbooks",

package/build/shared/interfaces/security/IPinnedResource.js

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

package/build/shared/interfaces/security/IRole.js

@@ -70,6 +70,7 @@ exports.organisationWideRoles = [
  *         - data_privacy_admin
  *         - data_privacy_editor
  *         - data_privacy_viewer
+ *         - knowledgeAdmin
  *         - large_language_model_admin,
  *         - lexicon_admin
  *         - lexicon_editor
@@ -109,6 +110,7 @@ exports.projectWideRoles = [
     "function_admin",
     "function_editor",
     "intents",
+    "knowledgeAdmin",
     "large_language_model_admin",
     "lexicon_admin",
     "lexicon_editor",

package/build/shared/interfaces/security/ISystemCapabilities.js

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

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.identityProviderSchema = exports.oidcIdentityProviderDataSchema = exports.samlIdentityProviderDataSchema = exports.CrudOperation = exports.operations = exports.availableRoles = exports.projectWideRoles = exports.organisationWideRoles = exports.availablePermissions = exports.COMPUTED_ACL_HASH_VERSION = void 0;
-exports.COMPUTED_ACL_HASH_VERSION = "v13";
+exports.COMPUTED_ACL_HASH_VERSION = "v18";
 var IPermission_1 = require("./IPermission");
 Object.defineProperty(exports, "availablePermissions", { enumerable: true, get: function () { return IPermission_1.availablePermissions; } });
 var IRole_1 = require("./IRole");

package/build/shared/interfaces/trainer/ITrainerRecord.js

@@ -69,7 +69,7 @@ exports.trainerRecordDataSchema = {
                 intentFlow: { type: ["null", "string"] },
                 intentId: { type: ["null", "string"] },
                 intentMapperResults: {
-                    type: "object",
+                    type: ["object", "null"],
                     additionalProperties: true,
                     properties: {
                         finalIntentName: { type: ["null", "string"] },
@@ -96,7 +96,7 @@ exports.trainerRecordSchema = {
     properties: Object.assign(Object.assign(Object.assign({}, IEntityMeta_1.entityMetaSchema.properties), exports.trainerRecordDataSchema.properties), { expiresAt: { type: "object" }, projectReference: { format: "mongo-id" }, organisationReference: { format: "mongo-id" } }),
 };
 exports.trainerRecordInDbSchema = {
-    title: "trainerRecordSchema",
+    title: "trainerRecordInDbSchema",
     type: "object",
     additionalProperties: false,
     properties: Object.assign(Object.assign(Object.assign({}, IEntityMeta_1.entityMetaSchema.properties), exports.trainerRecordDataSchema.properties), { snapshotReference: {

package/build/shared/interfaces/transcripts/transcripts.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranscriptEntrySource = exports.TranscriptEntryType = exports.TranscriptRole = void 0;
+// enum for the roles that can be used in the transcript
+// Warning: this is used in the nodes node, changes might break existing nodes
+var TranscriptRole;
+(function (TranscriptRole) {
+    TranscriptRole["ASSISTANT"] = "assistant";
+    TranscriptRole["USER"] = "user";
+    TranscriptRole["AGENT"] = "agent";
+    TranscriptRole["SYSTEM"] = "system";
+    TranscriptRole["TOOL"] = "tool";
+})(TranscriptRole = exports.TranscriptRole || (exports.TranscriptRole = {}));
+// enum for the types of entries that can be used in the transcript
+// Warning: this is used in the nodes node, changes might break existing nodes
+var TranscriptEntryType;
+(function (TranscriptEntryType) {
+    TranscriptEntryType["INPUT"] = "input";
+    TranscriptEntryType["OUTPUT"] = "output";
+    TranscriptEntryType["TOOL_CALL"] = "toolCall";
+    TranscriptEntryType["TOOL_ANSWER"] = "toolAnswer";
+    TranscriptEntryType["DEBUG_LOG"] = "debugLog";
+})(TranscriptEntryType = exports.TranscriptEntryType || (exports.TranscriptEntryType = {}));
+// enum for the sources of the entries that can be used in the transcript
+// Warning: this is used in the nodes node, changes might break existing nodes
+var TranscriptEntrySource;
+(function (TranscriptEntrySource) {
+    TranscriptEntrySource["USER"] = "user";
+    TranscriptEntrySource["ASSISTANT"] = "assistant";
+    TranscriptEntrySource["AGENT"] = "agent";
+    TranscriptEntrySource["SYSTEM"] = "system";
+})(TranscriptEntrySource = exports.TranscriptEntrySource || (exports.TranscriptEntrySource = {}));
+//# sourceMappingURL=transcripts.js.map

package/build/shared/interfaces/user.js

@@ -10,7 +10,7 @@ exports.userDataSchema = {
     additionalProperties: false,
     properties: {
         id: { type: "string", format: "email" },
-        name: { type: "string", maxLength: 200 },
+        name: { type: "string", maxLength: 200, format: "resource-name" },
         acceptedTOS: { type: "boolean" },
         disabled: { type: "boolean" },
         roles: { type: "array", additionalItems: false, items: { type: "string", format: "organisation-wide-role" } },

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "0.18.0",
+	"version": "0.20.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/rollup-plugin-babel.esm.js",
@@ -31,7 +31,7 @@
 	"license": "Cognigy Proprietary License",
 	"dependencies": {
 		"ajv": "6.12.6",
-		"axios": "1.6.8",
+		"axios": "1.7.4",
 		"form-data": "4.0.0",
 		"tus-js-client": "^3.1.1",
 		"uuidv4": "6.2.13"