@cognigy/rest-api-client 2025.10.0 → 2025.12.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 (73) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/build/RestAPIClient.js +7 -0
  3. package/build/apigroups/SimulationAPIGroup_2_0.js +58 -0
  4. package/build/apigroups/index.js +3 -1
  5. package/build/shared/charts/descriptors/index.js +2 -1
  6. package/build/shared/charts/descriptors/message/question/question.js +13 -29
  7. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +90 -64
  8. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +2 -2
  9. package/build/shared/charts/descriptors/service/aiAgent/helpers/createSystemMessage.js +22 -8
  10. package/build/shared/charts/descriptors/service/aiOpsCenterConnection.js +12 -0
  11. package/build/shared/charts/descriptors/service/handoverV2.js +0 -6
  12. package/build/shared/charts/descriptors/service/index.js +3 -1
  13. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +2 -2
  14. package/build/shared/constants.js +0 -1
  15. package/build/shared/interfaces/IOrganisation.js +32 -8
  16. package/build/shared/interfaces/messageAPI/endpoints.js +12 -2
  17. package/build/shared/interfaces/resources/IAuditEvent.js +3 -0
  18. package/build/shared/interfaces/resources/ILargeLanguageModel.js +1 -0
  19. package/build/shared/interfaces/resources/TResourceType.js +2 -0
  20. package/build/shared/interfaces/resources/TRestChannelType.js +5 -0
  21. package/build/shared/interfaces/resources/TWebhookChannelType.js +5 -0
  22. package/build/shared/interfaces/restAPI/opsCenter/observationConfig/IOpsCenterObservationConfig.js +1 -1
  23. package/build/shared/interfaces/restAPI/simulation/simulation/ICreateSimulationRest_2_0.js +3 -0
  24. package/build/shared/interfaces/restAPI/simulation/simulation/IDeleteSimulationRest_2_0.js +3 -0
  25. package/build/shared/interfaces/restAPI/simulation/simulation/IIndexSimulationRest_2_0.js +3 -0
  26. package/build/shared/interfaces/restAPI/simulation/simulation/IReadSimulationRest_2_0.js +3 -0
  27. package/build/shared/interfaces/restAPI/simulation/simulation/IScheduleSimulationRest_2_0.js +3 -0
  28. package/build/shared/interfaces/restAPI/simulation/simulation/ISimulationRest_2_0.js +9 -0
  29. package/build/shared/interfaces/restAPI/simulation/simulation/IUpdateSimulationRest_2_0.js +3 -0
  30. package/build/shared/interfaces/restAPI/simulation/simulationRun/IIndexSimulationRunRest_2_0.js +3 -0
  31. package/build/shared/interfaces/restAPI/simulation/simulationRun/IReadSimulationRunRest_2_0.js +3 -0
  32. package/build/shared/interfaces/restAPI/simulation/simulationRun/ISimulationRunRest_2_0.js +19 -0
  33. package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IGetAllSimulationRunBatchRest_2_0.js +3 -0
  34. package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IIndexSimulationRunBatchRest_2_0.js +3 -0
  35. package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IReadSimulationRunBatchRest_2_0.js +3 -0
  36. package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/ISimulationRunBatchRest_2_0.js +9 -0
  37. package/dist/esm/RestAPIClient.js +7 -0
  38. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +44 -0
  39. package/dist/esm/apigroups/index.js +1 -0
  40. package/dist/esm/shared/charts/descriptors/index.js +3 -2
  41. package/dist/esm/shared/charts/descriptors/message/question/question.js +13 -29
  42. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +91 -65
  43. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +2 -2
  44. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createSystemMessage.js +20 -7
  45. package/dist/esm/shared/charts/descriptors/service/aiOpsCenterConnection.js +9 -0
  46. package/dist/esm/shared/charts/descriptors/service/handoverV2.js +0 -6
  47. package/dist/esm/shared/charts/descriptors/service/index.js +1 -0
  48. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +2 -2
  49. package/dist/esm/shared/constants.js +0 -1
  50. package/dist/esm/shared/interfaces/IOrganisation.js +32 -8
  51. package/dist/esm/shared/interfaces/messageAPI/endpoints.js +11 -1
  52. package/dist/esm/shared/interfaces/resources/IAuditEvent.js +3 -0
  53. package/dist/esm/shared/interfaces/resources/ILargeLanguageModel.js +1 -0
  54. package/dist/esm/shared/interfaces/resources/TResourceType.js +2 -0
  55. package/dist/esm/shared/interfaces/resources/TRestChannelType.js +5 -0
  56. package/dist/esm/shared/interfaces/resources/TWebhookChannelType.js +5 -0
  57. package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IOpsCenterObservationConfig.js +1 -1
  58. package/dist/esm/shared/interfaces/restAPI/simulation/simulation/ICreateSimulationRest_2_0.js +2 -0
  59. package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IDeleteSimulationRest_2_0.js +2 -0
  60. package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IIndexSimulationRest_2_0.js +2 -0
  61. package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IReadSimulationRest_2_0.js +2 -0
  62. package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IScheduleSimulationRest_2_0.js +2 -0
  63. package/dist/esm/shared/interfaces/restAPI/simulation/simulation/ISimulationRest_2_0.js +6 -0
  64. package/dist/esm/shared/interfaces/restAPI/simulation/simulation/IUpdateSimulationRest_2_0.js +2 -0
  65. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/IIndexSimulationRunRest_2_0.js +2 -0
  66. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/IReadSimulationRunRest_2_0.js +2 -0
  67. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRun/ISimulationRunRest_2_0.js +16 -0
  68. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IGetAllSimulationRunBatchRest_2_0.js +2 -0
  69. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IIndexSimulationRunBatchRest_2_0.js +2 -0
  70. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/IReadSimulationRunBatchRest_2_0.js +2 -0
  71. package/dist/esm/shared/interfaces/restAPI/simulation/simulationRunBatch/ISimulationRunBatchRest_2_0.js +6 -0
  72. package/package.json +1 -1
  73. package/types/index.d.ts +325 -13
@@ -13,23 +13,36 @@ export const organisationDataPrivacySettingsSchema = {
13
13
  maskIPAddress: { type: "boolean" },
14
14
  maskAnalytics: { type: "boolean" },
15
15
  maskLogging: { type: "boolean" },
16
- ignoreList: { type: "array", items: { type: "string" }, additionalItems: false, minItems: 0 }
17
- },
16
+ ignoreList: {
17
+ type: "array",
18
+ items: { type: "string" },
19
+ additionalItems: false,
20
+ minItems: 0
21
+ }
22
+ }
18
23
  };
19
24
  export const organisationPasswordPolicySchema = {
20
25
  title: "organisationPasswordPolicySchema",
21
26
  type: "object",
22
27
  additionalProperties: false,
23
28
  properties: {
24
- maxAmountIdenticalCharacters: { type: "integer", minimum: 0, maximum: 999 },
29
+ maxAmountIdenticalCharacters: {
30
+ type: "integer",
31
+ minimum: 0,
32
+ maximum: 999
33
+ },
25
34
  maxLength: { type: "integer", minimum: 0, maximum: 999 },
26
- minAmountFailedAttemptsAutoDisable: { type: "integer", minimum: 0, maximum: 999 },
35
+ minAmountFailedAttemptsAutoDisable: {
36
+ type: "integer",
37
+ minimum: 0,
38
+ maximum: 999
39
+ },
27
40
  minAmountLowerCase: { type: "integer", minimum: 0, maximum: 999 },
28
41
  minAmountNumbers: { type: "integer", minimum: 0, maximum: 999 },
29
42
  minAmountSpecialCharacters: { type: "integer", minimum: 0, maximum: 999 },
30
43
  minAmountUpperCase: { type: "integer", minimum: 0, maximum: 999 },
31
- minLength: { type: "integer", minimum: 0, maximum: 999 },
32
- },
44
+ minLength: { type: "integer", minimum: 0, maximum: 999 }
45
+ }
33
46
  };
34
47
  export const organisationDataSchema = {
35
48
  title: "organisationDataSchema",
@@ -52,13 +65,24 @@ export const organisationDataSchema = {
52
65
  sessionStateTTLInMinutes: { type: "integer", minimum: 0 },
53
66
  billingTimezone: { type: "string", format: "timezone" },
54
67
  dataPrivacySettings: organisationDataPrivacySettingsSchema,
55
- },
68
+ maxTTLValues: {
69
+ type: "object",
70
+ properties: {
71
+ contactProfileTTLInMinutes: { type: "integer", minimum: 0 },
72
+ conversationTTLInMinutes: { type: "integer", minimum: 0 },
73
+ analyticsTTLInMinutes: { type: "integer", minimum: 0 },
74
+ sessionsTTLInMinutes: { type: "integer", minimum: 0 },
75
+ stepEventsTTLInMinutes: { type: "integer", minimum: 0 },
76
+ sessionStateTTLInMinutes: { type: "integer", minimum: 0 }
77
+ }
78
+ }
79
+ }
56
80
  };
57
81
  export const organisationSchema = {
58
82
  title: "organisationSchema",
59
83
  type: "object",
60
84
  additionalProperties: false,
61
- properties: Object.assign(Object.assign({ _id: { format: "mongo-id" } }, organisationDataSchema.properties), { liveAgentAccount: { type: "number" }, voiceGatewayAccount: { type: "string" } }),
85
+ properties: Object.assign(Object.assign({ _id: { format: "mongo-id" } }, organisationDataSchema.properties), { liveAgentAccount: { type: "number" }, voiceGatewayAccount: { type: "string" } })
62
86
  };
63
87
  export const organisationQuerySchema = createQuerySchema("organisationQuerySchema", organisationSchema);
64
88
  //# sourceMappingURL=IOrganisation.js.map
@@ -34,7 +34,8 @@ export const endpointTypes = [
34
34
  "niceCXOne",
35
35
  "niceCXOneAAH",
36
36
  "agentAssistVoice",
37
- "webchat3"
37
+ "webchat3",
38
+ "zoomContactCenter",
38
39
  ];
39
40
  const transferTypes = ["dial", "sip:refer"];
40
41
  export const webchatPersistentMenuSchema = {
@@ -699,6 +700,15 @@ export const agentAssistVoiceEndpointSettingsSchema = {
699
700
  },
700
701
  additionalProperties: false
701
702
  };
703
+ export const zoomContactCenterEndpointSettingsSchema = {
704
+ type: "object",
705
+ properties: {
706
+ verifyToken: {
707
+ type: "string"
708
+ },
709
+ },
710
+ additionalProperties: false
711
+ };
702
712
  export const anyEndpointSettingsSchema = {
703
713
  title: "anyEndpointSettingsSchema",
704
714
  type: "object",
@@ -105,6 +105,9 @@ export const actionTypes = [
105
105
  "optionsResolver",
106
106
  "processKnowledgeSourceUrl",
107
107
  "processKnowledgeSourceFile",
108
+ "setupObservationConfig",
109
+ "updateObservationConfig",
110
+ "resolveAiOpsCenterError"
108
111
  ];
109
112
  export const auditEventSchema = {
110
113
  title: "auditEventSchema",
@@ -53,6 +53,7 @@ export const openAICompatibleMetaSchema = {
53
53
  properties: {
54
54
  customModel: { type: "string" },
55
55
  baseCustomUrl: { type: "string" },
56
+ customAuthHeader: { type: "string" },
56
57
  }
57
58
  };
58
59
  export const azureOpenAIMetaSchema = {
@@ -43,6 +43,7 @@
43
43
  * - slotFiller
44
44
  * - snapshot
45
45
  * - snippet
46
+ * - simulation
46
47
  */
47
48
  export const arrayTResourceType = [
48
49
  "agentassistconfig",
@@ -84,6 +85,7 @@ export const arrayTResourceType = [
84
85
  "snapshot",
85
86
  "snippet",
86
87
  "aiAgent",
88
+ "simulation",
87
89
  ];
88
90
  export const arrayTSnapshottableResourceType = [
89
91
  "agentSettings",
@@ -15,6 +15,7 @@ export const restChannelTypes = [
15
15
  "genesysBotConnector",
16
16
  "niceCXOne",
17
17
  "niceCXOneAAH",
18
+ "zoomContactCenter",
18
19
  ];
19
20
  export const restChannelDisplayNames = [
20
21
  {
@@ -81,5 +82,9 @@ export const restChannelDisplayNames = [
81
82
  channel: "niceCXOneAAH",
82
83
  displayName: "NICE CXone AAH"
83
84
  },
85
+ {
86
+ channel: "zoomContactCenter",
87
+ displayName: "Zoom Contact Center"
88
+ }
84
89
  ];
85
90
  //# sourceMappingURL=TRestChannelType.js.map
@@ -11,6 +11,7 @@ export const webhookChannelTypes = [
11
11
  "whatsapp",
12
12
  "eightByEight",
13
13
  "agentAssistVoice",
14
+ "zoomContactCenter",
14
15
  ];
15
16
  export const webhookChannelDisplayNames = [
16
17
  {
@@ -61,5 +62,9 @@ export const webhookChannelDisplayNames = [
61
62
  channel: "eightByEight",
62
63
  displayName: "8x8"
63
64
  },
65
+ {
66
+ channel: "zoomContactCenter",
67
+ displayName: "Zoom Contact Center"
68
+ }
64
69
  ];
65
70
  //# sourceMappingURL=TWebhookChannelType.js.map
@@ -1,3 +1,3 @@
1
- const notificationChannels = ["email"];
1
+ const notificationChannels = ["email", "webhook"];
2
2
  export {};
3
3
  //# sourceMappingURL=IOpsCenterObservationConfig.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=ICreateSimulationRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IDeleteSimulationRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IIndexSimulationRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IReadSimulationRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IScheduleSimulationRest_2_0.js.map
@@ -0,0 +1,6 @@
1
+ export var ESuccessCriterionTypeRest_2_0;
2
+ (function (ESuccessCriterionTypeRest_2_0) {
3
+ ESuccessCriterionTypeRest_2_0["TEXT"] = "text";
4
+ ESuccessCriterionTypeRest_2_0["GOAL_COMPLETED"] = "goalCompleted";
5
+ })(ESuccessCriterionTypeRest_2_0 || (ESuccessCriterionTypeRest_2_0 = {}));
6
+ //# sourceMappingURL=ISimulationRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IUpdateSimulationRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IIndexSimulationRunRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IReadSimulationRunRest_2_0.js.map
@@ -0,0 +1,16 @@
1
+ export var ETurnTypeRest_2_0;
2
+ (function (ETurnTypeRest_2_0) {
3
+ ETurnTypeRest_2_0["INPUT"] = "input";
4
+ ETurnTypeRest_2_0["OUTPUT"] = "output";
5
+ })(ETurnTypeRest_2_0 || (ETurnTypeRest_2_0 = {}));
6
+ export var ESuccessCriteriaTypeRest_2_0;
7
+ (function (ESuccessCriteriaTypeRest_2_0) {
8
+ ESuccessCriteriaTypeRest_2_0["TEXT"] = "text";
9
+ })(ESuccessCriteriaTypeRest_2_0 || (ESuccessCriteriaTypeRest_2_0 = {}));
10
+ export var ESentimentTypeRest_2_0;
11
+ (function (ESentimentTypeRest_2_0) {
12
+ ESentimentTypeRest_2_0["POSITIVE"] = "POSITIVE";
13
+ ESentimentTypeRest_2_0["NEUTRAL"] = "NEUTRAL";
14
+ ESentimentTypeRest_2_0["NEGATIVE"] = "NEGATIVE";
15
+ })(ESentimentTypeRest_2_0 || (ESentimentTypeRest_2_0 = {}));
16
+ //# sourceMappingURL=ISimulationRunRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IGetAllSimulationRunBatchRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IIndexSimulationRunBatchRest_2_0.js.map
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=IReadSimulationRunBatchRest_2_0.js.map
@@ -0,0 +1,6 @@
1
+ export const SimulationRunBatchStatus = [
2
+ "IN_PROGRESS",
3
+ "COMPLETED",
4
+ "FAILED"
5
+ ];
6
+ //# sourceMappingURL=ISimulationRunBatchRest_2_0.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cognigy/rest-api-client",
3
- "version": "2025.10.0",
3
+ "version": "2025.12.0",
4
4
  "description": "Cognigy REST-Client",
5
5
  "main": "build/index.js",
6
6
  "module": "dist/esm/index.js",