@cognigy/rest-api-client 2025.25.0 → 2026.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/CHANGELOG.md +5 -0
  2. package/build/apigroups/ResourcesAPIGroup_2_0.js +14 -0
  3. package/build/apigroups/SimulationAPIGroup_2_0.js +15 -1
  4. package/build/authentication/AuthenticationAPI.js +1 -0
  5. package/build/shared/charts/createNodeDescriptor.js +1 -0
  6. package/build/shared/charts/descriptors/analytics/overwriteAnalytics.js +14 -0
  7. package/build/shared/charts/descriptors/analytics/updateProfile.js +5 -0
  8. package/build/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +7 -0
  9. package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +9 -0
  10. package/build/shared/charts/descriptors/index.js +2 -0
  11. package/build/shared/charts/descriptors/message/question/question.js +5 -0
  12. package/build/shared/charts/descriptors/message/say.js +3 -0
  13. package/build/shared/charts/descriptors/service/agentTools/executeWorkflowTool.js +239 -0
  14. package/build/shared/charts/descriptors/service/agentTools/handoverToHumanAgentTool.js +783 -0
  15. package/build/shared/charts/descriptors/service/agentTools/sendEmailTool.js +33 -4
  16. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +23 -20
  17. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +4 -2
  18. package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +3 -1
  19. package/build/shared/charts/descriptors/service/aiAgent/helpers/parseMcpHeaders.js +26 -0
  20. package/build/shared/charts/descriptors/service/handoverV2.js +1 -1
  21. package/build/shared/charts/descriptors/service/httpRequest.js +3 -0
  22. package/build/shared/charts/descriptors/service/index.js +5 -1
  23. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +11 -4
  24. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +17 -11
  25. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +5 -5
  26. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +2 -2
  27. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +13 -4
  28. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +4 -4
  29. package/build/shared/interfaces/amqpInterface.js +1 -0
  30. package/build/shared/interfaces/messageAPI/endpoints.js +1 -1
  31. package/build/shared/interfaces/resources/IChart.js +10 -1
  32. package/build/shared/interfaces/resources/IChartNode.js +32 -4
  33. package/build/shared/interfaces/resources/IEndpoint.js +1 -0
  34. package/build/shared/interfaces/resources/INodeDescriptorSet.js +8 -0
  35. package/build/shared/interfaces/resources/TResourceType.js +1 -0
  36. package/build/shared/interfaces/resources/chart/IChartExecutableNode.js +10 -1
  37. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeConnector.js +49 -0
  38. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  39. package/build/shared/interfaces/restAPI/administration/user/v2.0/IExchangeCXoneTokenRest_2_0.js +3 -0
  40. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/ICreateKnowledgeConnectorRest_2_0.js +3 -0
  41. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IDeleteKnowledgeConnectorRest_2_0.js +3 -0
  42. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IIndexKnowledgeConnectorsRest_2_0.js +3 -0
  43. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IKnowledgeConnector_2_0.js +3 -0
  44. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IReadKnowledgeConnectorRest_2_0.js +3 -0
  45. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IUpdateKnowledgeConnectorRest_2_0.js +3 -0
  46. package/build/shared/interfaces/restAPI/simulation/scheduler/ICreateSchedulerRest_2_0.js +3 -0
  47. package/build/shared/interfaces/restAPI/simulation/scheduler/IGetSchedulerRest_2_0.js +3 -0
  48. package/build/shared/interfaces/restAPI/simulation/scheduler/ISchedulerRest_2_0.js +12 -0
  49. package/build/shared/interfaces/restAPI/simulation/scheduler/IUpdateSchedulerRest_2_0.js +3 -0
  50. package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +14 -0
  51. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +15 -1
  52. package/dist/esm/authentication/AuthenticationAPI.js +1 -0
  53. package/dist/esm/shared/charts/createNodeDescriptor.js +1 -0
  54. package/dist/esm/shared/charts/descriptors/analytics/overwriteAnalytics.js +14 -0
  55. package/dist/esm/shared/charts/descriptors/analytics/updateProfile.js +5 -0
  56. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +7 -0
  57. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +9 -0
  58. package/dist/esm/shared/charts/descriptors/index.js +3 -1
  59. package/dist/esm/shared/charts/descriptors/message/question/question.js +5 -0
  60. package/dist/esm/shared/charts/descriptors/message/say.js +3 -0
  61. package/dist/esm/shared/charts/descriptors/service/agentTools/executeWorkflowTool.js +237 -0
  62. package/dist/esm/shared/charts/descriptors/service/agentTools/handoverToHumanAgentTool.js +770 -0
  63. package/dist/esm/shared/charts/descriptors/service/agentTools/sendEmailTool.js +33 -4
  64. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +23 -20
  65. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +4 -2
  66. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +3 -1
  67. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/parseMcpHeaders.js +25 -0
  68. package/dist/esm/shared/charts/descriptors/service/handoverV2.js +1 -1
  69. package/dist/esm/shared/charts/descriptors/service/httpRequest.js +3 -0
  70. package/dist/esm/shared/charts/descriptors/service/index.js +2 -0
  71. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +11 -4
  72. package/dist/esm/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +17 -11
  73. package/dist/esm/shared/charts/descriptors/voice/mappers/transfer.mapper.js +5 -5
  74. package/dist/esm/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +2 -2
  75. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +13 -4
  76. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/transfer.js +4 -4
  77. package/dist/esm/shared/interfaces/amqpInterface.js +1 -0
  78. package/dist/esm/shared/interfaces/messageAPI/endpoints.js +1 -1
  79. package/dist/esm/shared/interfaces/resources/IChart.js +10 -1
  80. package/dist/esm/shared/interfaces/resources/IChartNode.js +32 -4
  81. package/dist/esm/shared/interfaces/resources/IEndpoint.js +1 -0
  82. package/dist/esm/shared/interfaces/resources/INodeDescriptorSet.js +8 -0
  83. package/dist/esm/shared/interfaces/resources/TResourceType.js +1 -0
  84. package/dist/esm/shared/interfaces/resources/chart/IChartExecutableNode.js +10 -1
  85. package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeConnector.js +46 -0
  86. package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  87. package/dist/esm/shared/interfaces/restAPI/administration/user/v2.0/IExchangeCXoneTokenRest_2_0.js +2 -0
  88. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/ICreateKnowledgeConnectorRest_2_0.js +2 -0
  89. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IDeleteKnowledgeConnectorRest_2_0.js +2 -0
  90. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IIndexKnowledgeConnectorsRest_2_0.js +2 -0
  91. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IKnowledgeConnector_2_0.js +2 -0
  92. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IReadKnowledgeConnectorRest_2_0.js +2 -0
  93. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IUpdateKnowledgeConnectorRest_2_0.js +2 -0
  94. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/ICreateSchedulerRest_2_0.js +2 -0
  95. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/IGetSchedulerRest_2_0.js +2 -0
  96. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/ISchedulerRest_2_0.js +9 -0
  97. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/IUpdateSchedulerRest_2_0.js +2 -0
  98. package/package.json +1 -1
  99. package/types/index.d.ts +528 -11
@@ -715,7 +715,7 @@ export const anyEndpointSettingsSchema = {
715
715
  title: "anyEndpointSettingsSchema",
716
716
  type: "object",
717
717
  additionalProperties: true,
718
- properties: Object.assign({ action: { type: "string" }, accessScope: { type: "string" }, accessToken: { type: "string" }, appId: { type: "string" }, appSecret: { type: "string" }, backgroundImageUrl: { type: "string" }, basicAuthPassword: { type: "string" }, basicAuthUser: { type: "string" }, botUserId: { type: "string" }, colorScheme: { type: "string" }, connectionName: { type: "string" }, cpaasToken: { type: "string" }, customJSON: { type: "string" }, designTemplate: { type: "integer" }, disableHtmlContentSanitization: { type: "boolean" }, disableInputAutocomplete: { type: "boolean" }, disableUrlButtonSanitization: { type: "boolean" }, disableInputSanitization: { type: "boolean" }, disableSkipUriTags: { type: "boolean" }, enableAsyncCommunication: { type: "boolean" }, enableCollectMetadata: { type: "boolean" }, enableGenericHTMLStyling: { type: "boolean" }, enableDemoWebchat: { type: "boolean" }, enableFileUpload: { type: "boolean" }, enablePersistentMenu: { type: "boolean" }, enableRating: { type: "string", enum: ["always", "once", "onRequest"] }, enableSTT: { type: "boolean" }, enableTTS: { type: "boolean" }, enableTypingIndicator: { type: "boolean" }, enableFileAttachment: { type: "boolean" }, fileAttachmentMaxSize: { type: "number" }, facebookPageToken: { type: "string" }, finishOnKey: {
718
+ properties: Object.assign({ action: { type: "string" }, accessScope: { type: "string" }, accessToken: { type: "string" }, appId: { type: "string" }, appSecret: { type: "string" }, backgroundImageUrl: { type: "string" }, basicAuthPassword: { type: "string" }, basicAuthUser: { type: "string" }, botUserId: { type: "string" }, colorScheme: { type: "string" }, connectionName: { type: "string" }, cpaasToken: { type: "string" }, customJSON: { type: "string" }, designTemplate: { type: "integer" }, disableHtmlContentSanitization: { type: "boolean" }, disableInputAutocomplete: { type: "boolean" }, disableUrlButtonSanitization: { type: "boolean" }, disableInputSanitization: { type: "boolean" }, disableSkipUriTags: { type: "boolean" }, enableAsyncCommunication: { type: "boolean" }, enableCollectMetadata: { type: "boolean" }, enableGenericHTMLStyling: { type: "boolean" }, enableDemoWebchat: { type: "boolean" }, enableFileUpload: { type: "boolean" }, enableMocking: { type: "boolean" }, enablePersistentMenu: { type: "boolean" }, enableRating: { type: "string", enum: ["always", "once", "onRequest"] }, enableSTT: { type: "boolean" }, enableTTS: { type: "boolean" }, enableTypingIndicator: { type: "boolean" }, enableFileAttachment: { type: "boolean" }, fileAttachmentMaxSize: { type: "number" }, facebookPageToken: { type: "string" }, finishOnKey: {
719
719
  type: "string",
720
720
  enum: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "*", "#"]
721
721
  }, workplaceToken: { type: "string" }, foreignId: { type: "string" }, gatherlanguage: {
@@ -13,7 +13,16 @@ export const chartNodeExcerptSchema = {
13
13
  analyticsLabel: { type: ["null", "string"], format: "analytics-label" },
14
14
  type: { type: "string", maxLength: 200 },
15
15
  extension: { type: "string", format: "package-name" },
16
- localeReference: { type: "string", format: "mongo-id" }
16
+ localeReference: { type: "string", format: "mongo-id" },
17
+ mock: {
18
+ type: "object",
19
+ properties: {
20
+ isEnabled: { type: "boolean" },
21
+ code: { type: "string" },
22
+ transpiled: { type: "string" },
23
+ hasError: { type: "boolean" }
24
+ }
25
+ }
17
26
  },
18
27
  };
19
28
  export const chartNodeRelationDataSchema = {
@@ -13,7 +13,8 @@ export const defaultNodeFields = [
13
13
  "isDisabled",
14
14
  "isEntryPoint",
15
15
  "preview",
16
- "analyticsLabel"
16
+ "analyticsLabel",
17
+ "mock"
17
18
  ];
18
19
  export const searchableNodeFields = [
19
20
  "comment",
@@ -60,7 +61,16 @@ export const nodeInDBSchema = {
60
61
  resourceReference: { format: "mongo-id" },
61
62
  projectReference: { format: "mongo-id" },
62
63
  organisationReference: { format: "mongo-id" },
63
- analyticsLabel: { format: "analytics-label" }
64
+ analyticsLabel: { format: "analytics-label" },
65
+ mock: {
66
+ type: "object",
67
+ properties: {
68
+ isEnabled: { type: "boolean" },
69
+ code: { type: "string" },
70
+ transpiled: { type: "string" },
71
+ hasError: { type: "boolean" }
72
+ }
73
+ },
64
74
  }
65
75
  };
66
76
  export const nodeDataSchema = {
@@ -97,7 +107,16 @@ export const nodeDataSchema = {
97
107
  }
98
108
  }
99
109
  }
100
- }
110
+ },
111
+ mock: {
112
+ type: "object",
113
+ properties: {
114
+ isEnabled: { type: "boolean" },
115
+ code: { type: "string" },
116
+ transpiled: { type: "string" },
117
+ hasError: { type: "boolean" }
118
+ }
119
+ },
101
120
  }
102
121
  };
103
122
  export const updateNodeDataSchema = {
@@ -120,7 +139,16 @@ export const updateNodeDataSchema = {
120
139
  config: {
121
140
  type: "object",
122
141
  additionalProperties: { propertyNames: { type: "string" } }
123
- }
142
+ },
143
+ mock: {
144
+ type: "object",
145
+ properties: {
146
+ isEnabled: { type: "boolean" },
147
+ code: { type: "string" },
148
+ transpiled: { type: "string" },
149
+ hasError: { type: "boolean" }
150
+ }
151
+ },
124
152
  }
125
153
  };
126
154
  export const nodeSchema = {
@@ -71,6 +71,7 @@ export const endpointDataSchema = {
71
71
  active: { type: "boolean" },
72
72
  },
73
73
  },
74
+ enableMocking: { type: "boolean" },
74
75
  },
75
76
  };
76
77
  export const endpointSchema = {
@@ -98,6 +98,7 @@ export const nodeFieldTypes = [
98
98
  "checkAgentAvailabilityConfig",
99
99
  "chipInput",
100
100
  "code",
101
+ "mockCode",
101
102
  "cognigyLLMText",
102
103
  "cognigyText",
103
104
  "cognigyTextArray",
@@ -442,6 +443,13 @@ export const nodeDescriptorSchema = {
442
443
  additionalItems: false,
443
444
  maxLength: 25,
444
445
  items: nodeFieldAndSectionFormElementSchema
446
+ },
447
+ mocking: {
448
+ type: "object",
449
+ additionalProperties: false,
450
+ properties: {
451
+ defaultMockCode: { type: "string" }
452
+ }
445
453
  }
446
454
  }
447
455
  };
@@ -69,6 +69,7 @@ export const arrayTResourceType = [
69
69
  "knowledgeStore",
70
70
  "knowledgeSource",
71
71
  "knowledgeChunk",
72
+ "knowledgeConnector",
72
73
  "lexicon",
73
74
  "lexiconEntry",
74
75
  "lexiconKeyphrase",
@@ -48,7 +48,16 @@ export const chartExecutableNodeSchema = {
48
48
  type: { type: "string", minLength: 1 },
49
49
  label: nodeDataSchema.properties.label,
50
50
  extension: { type: "string" },
51
- analyticsLabel: { type: ["string", "null"], format: "analytics-label" }
51
+ analyticsLabel: { type: ["string", "null"], format: "analytics-label" },
52
+ mock: {
53
+ type: "object",
54
+ properties: {
55
+ isEnabled: { type: "boolean" },
56
+ code: { type: "string" },
57
+ transpiled: { type: "string" },
58
+ hasError: { type: "boolean" },
59
+ }
60
+ }
52
61
  },
53
62
  };
54
63
  //# sourceMappingURL=IChartExecutableNode.js.map
@@ -0,0 +1,46 @@
1
+ import { entityMetaSchema } from "../IEntityMeta";
2
+ export const knowledgeConnectorExecutionStatus = ["none", "queued", "active", "done", "error"];
3
+ export const knowledgeConnectorDataSchema = {
4
+ title: "knowledgeConnectorDataSchema",
5
+ type: "object",
6
+ additionalProperties: false,
7
+ required: ["extension", "type", "config", "name", "version"],
8
+ properties: {
9
+ extension: { type: "string" },
10
+ type: { type: "string" },
11
+ version: { type: "string" },
12
+ config: {
13
+ type: "object",
14
+ additionalProperties: true
15
+ },
16
+ name: { type: "string", format: "resource-name" },
17
+ schedule: {
18
+ type: "object",
19
+ additionalProperties: false,
20
+ properties: {
21
+ enabled: { type: "boolean" },
22
+ start: { type: "integer", format: "timestamp" },
23
+ hour: { type: "integer", minimum: 0, maximum: 23 },
24
+ minute: { type: "integer", minimum: 0, maximum: 59 },
25
+ weekDays: { type: "array", items: { type: "integer", minimum: 0, maximum: 6 } }
26
+ }
27
+ }
28
+ }
29
+ };
30
+ export const knowledgeConnectorSchema = {
31
+ title: "knowledgeConnectorDataSchema",
32
+ type: "object",
33
+ additionalProperties: false,
34
+ required: [
35
+ "extension",
36
+ "type",
37
+ "config",
38
+ "name",
39
+ "version"
40
+ ],
41
+ properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), knowledgeConnectorDataSchema.properties), { referenceId: { type: "string" }, storeReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" }, lastExecution: { type: "integer", format: "timestamp" }, lastExecutionStatus: {
42
+ type: "string",
43
+ enum: [...knowledgeConnectorExecutionStatus]
44
+ } })
45
+ };
46
+ //# sourceMappingURL=IKnowledgeConnector.js.map
@@ -34,6 +34,6 @@ export const knowledgeSourceSchema = {
34
34
  title: "knowledgeSourceSchema",
35
35
  type: "object",
36
36
  additionalProperties: false,
37
- properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), knowledgeSourceDataSchema.properties), { referenceId: { type: "string", format: "uuid" }, storeReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
37
+ properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), knowledgeSourceDataSchema.properties), { referenceId: { type: "string", format: "uuid" }, storeReference: { type: "string", format: "mongo-id" }, connectorReference: { type: "string", format: "mongo-id" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
38
38
  };
39
39
  //# sourceMappingURL=IKnowledgeSource.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IExchangeCXoneTokenRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=ICreateKnowledgeConnectorRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IDeleteKnowledgeConnectorRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IIndexKnowledgeConnectorsRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IKnowledgeConnector_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IReadKnowledgeConnectorRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IUpdateKnowledgeConnectorRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=ICreateSchedulerRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IGetSchedulerRest_2_0.js.map
@@ -0,0 +1,9 @@
1
+ export var ESchedulerFrequencyRest_2_0;
2
+ (function (ESchedulerFrequencyRest_2_0) {
3
+ ESchedulerFrequencyRest_2_0["DAILY"] = "daily";
4
+ ESchedulerFrequencyRest_2_0["EVERY_THREE_DAYS"] = "every three days";
5
+ ESchedulerFrequencyRest_2_0["WEEKLY"] = "weekly";
6
+ ESchedulerFrequencyRest_2_0["BIWEEKLY"] = "biweekly";
7
+ ESchedulerFrequencyRest_2_0["MONTHLY"] = "monthly";
8
+ })(ESchedulerFrequencyRest_2_0 || (ESchedulerFrequencyRest_2_0 = {}));
9
+ //# sourceMappingURL=ISchedulerRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IUpdateSchedulerRest_2_0.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cognigy/rest-api-client",
3
- "version": "2025.25.0",
3
+ "version": "2026.1.0",
4
4
  "description": "Cognigy REST-Client",
5
5
  "main": "build/index.js",
6
6
  "module": "dist/esm/index.js",