@cognigy/rest-api-client 0.19.0 → 0.20.0

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.primaryResourceTypes = exports.packageableResourceTypes = exports.searchableResourceTypes = exports.chartableResourceTypes = exports.resourceTypes = exports.arrayTChartableResourceType = exports.arrayTSnapshottableResourceType = exports.arrayTResourceType = void 0;
+exports.pinnableResourceTypes = exports.primaryResourceTypes = exports.packageableResourceTypes = exports.searchableResourceTypes = exports.chartableResourceTypes = exports.resourceTypes = exports.arrayTChartableResourceType = exports.arrayTSnapshottableResourceType = exports.arrayTResourceType = void 0;
 /**
  * @openapi
  * components:
@@ -10,6 +10,7 @@ exports.primaryResourceTypes = exports.packageableResourceTypes = exports.search
  *       description: The type of a resource
  *       example: flow
  *       enum:
+ *         - aiAgent
  *         - agentassistconfig
  *         - agentSettings
  *         - chart
@@ -35,7 +36,7 @@ exports.primaryResourceTypes = exports.packageableResourceTypes = exports.search
  *         - lexiconKeyphrase
  *         - lexiconSlot
  *         - locale
- *         - milestone
+ *         - goal
  *         - nluconnector
  *         - nodeData
  *         - nodeDescriptorSet
@@ -73,7 +74,7 @@ exports.arrayTResourceType = [
     "lexiconKeyphrase",
     "lexiconSlot",
     "locale",
-    "milestone",
+    "goal",
     "nluconnector",
     "nodeData",
     "nodeDescriptorSet",
@@ -83,9 +84,11 @@ exports.arrayTResourceType = [
     "slotFiller",
     "snapshot",
     "snippet",
+    "aiAgent",
 ];
 exports.arrayTSnapshottableResourceType = [
     "agentSettings",
+    "aiAgent",
     "chart",
     "connection",
     "connectionSchema",
@@ -106,7 +109,7 @@ exports.arrayTSnapshottableResourceType = [
     "lexiconKeyphrase",
     "lexiconSlot",
     "locale",
-    "milestone",
+    "goal",
     "nluconnector",
     "nodeData",
     "nodeDescriptorSet",
@@ -131,7 +134,7 @@ exports.chartableResourceTypes = [...exports.arrayTChartableResourceType];
  *         - flow
  *         - function
  *         - lexicon
- *         - milestone
+ *         - goal
  *         - nluconnector
  *         - playbook
  *         - project
@@ -144,13 +147,14 @@ exports.searchableResourceTypes = [
     "function",
     "largeLanguageModel",
     "lexicon",
-    "milestone",
+    "goal",
     "nluconnector",
     "playbook",
     "project",
     "snapshot",
 ];
 exports.packageableResourceTypes = [
+    "aiAgent",
     "agentAssistConfig",
     "connection",
     "endpoint",
@@ -162,12 +166,13 @@ exports.packageableResourceTypes = [
     "knowledgeStore",
     "lexicon",
     "locale",
-    "milestone",
+    "goal",
     "nluconnector",
     "playbook",
     "snippet",
 ];
 exports.primaryResourceTypes = [
+    "aiAgent",
     "connection",
     "endpoint",
     "extension",
@@ -177,9 +182,12 @@ exports.primaryResourceTypes = [
     "largeLanguageModel",
     "lexicon",
     "locale",
-    "milestone",
+    "goal",
     "nluconnector",
     "playbook",
     "snippet",
 ];
+exports.pinnableResourceTypes = [
+    "project"
+];
 //# sourceMappingURL=TResourceType.js.map

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

@@ -73,7 +73,11 @@ exports.generativeAISettingsDataSchema = {
                 answerExtraction: {
                     type: "object",
                     properties: Object.assign({}, exports.generativeAIUseCaseDataSchema.properties)
-                }
+                },
+                aiAgent: {
+                    type: "object",
+                    properties: Object.assign({}, exports.generativeAIUseCaseDataSchema.properties)
+                },
             }
         }
     }

package/build/shared/interfaces/restAPI/{resources/milestone/v2.0/ICloneMilestoneRest_2_0.js → administration/user/v2.0/IGetPinnedResources_2_0.js}

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

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IPinResourceRest_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/aiAgent/v2.0/ICreateAiAgentRest_2_0.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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/aiAgent/v2.0/IHireAiAgent_2_0.js

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

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

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

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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/{milestone/v2.0/ICreateMilestoneRest_2_0.js → aiAgent/v2.0/IValidateAiAgentNameRest_2_0.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ICreateMilestoneRest_2_0.js.map
+//# 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/{analytics/IMilestoneAnalytics.js → restAPI/resources/goal/v2.0/ICreateGoalRest_2_0.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=IMilestoneAnalytics.js.map
+//# 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/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/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 = "v14";
+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/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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "0.19.0",
+	"version": "0.20.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/rollup-plugin-babel.esm.js",