@cognigy/rest-api-client 0.16.0 → 0.18.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 +12 -0
  2. package/build/GenericTusFn.js +6 -1
  3. package/build/GenericUploadFn.js +3 -5
  4. package/build/apigroups/ResourcesAPIGroup_2_0.js +12 -1
  5. package/build/connector/AxiosAdapter.js +35 -15
  6. package/build/shared/charts/createNodeDescriptor.js +5 -5
  7. package/build/shared/charts/descriptors/agentAssist/constants/constants.js +16 -1
  8. package/build/shared/charts/descriptors/agentAssist/helpers/agentAssistTranslator.helper.js +19 -0
  9. package/build/shared/charts/descriptors/agentAssist/helpers/getFontSizeFieldOptions.js +84 -0
  10. package/build/shared/charts/descriptors/agentAssist/helpers/getLanguageName.helper.js +33 -0
  11. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/answerExtraction.helper.js +59 -0
  12. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/configValidator.helper.js +20 -0
  13. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/errorHandler.helper.js +64 -0
  14. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/followUpDetection.helper.js +72 -0
  15. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/knowledgeSearch.helper.js +58 -0
  16. package/build/shared/charts/descriptors/agentAssist/helpers/sentiment.helper.js +7 -13
  17. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/identityAssistTemplate.js +17 -18
  18. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/knowledgeAssistTemplate.js +345 -152
  19. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/nextActionWidgetTemplate.js +212 -80
  20. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/sentimentAnalysisTemplate.js +11 -6
  21. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/transcriptAssistTemplate.js +15 -13
  22. package/build/shared/charts/descriptors/agentAssist/identityAssist.js +87 -14
  23. package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +192 -327
  24. package/build/shared/charts/descriptors/agentAssist/locales/cs.locale.js +11 -0
  25. package/build/shared/charts/descriptors/agentAssist/locales/de.locale.js +11 -0
  26. package/build/shared/charts/descriptors/agentAssist/locales/en.locale.js +11 -0
  27. package/build/shared/charts/descriptors/agentAssist/locales/es.locale.js +11 -0
  28. package/build/shared/charts/descriptors/agentAssist/locales/fr.locale.js +11 -0
  29. package/build/shared/charts/descriptors/agentAssist/locales/index.js +22 -0
  30. package/build/shared/charts/descriptors/agentAssist/locales/ja.locale.js +11 -0
  31. package/build/shared/charts/descriptors/agentAssist/locales/ko.locale.js +11 -0
  32. package/build/shared/charts/descriptors/agentAssist/locales/pt.locale.js +11 -0
  33. package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +485 -10
  34. package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +31 -8
  35. package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js +31 -16
  36. package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +40 -2
  37. package/build/shared/charts/descriptors/allFields.js +6 -0
  38. package/build/shared/charts/descriptors/analytics/requestRating.js +56 -2
  39. package/build/shared/charts/descriptors/index.js +1 -3
  40. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +1 -1
  41. package/build/shared/charts/descriptors/logic/goTo.js +3 -3
  42. package/build/shared/charts/descriptors/message/question/optionalQuestion.js +1 -1
  43. package/build/shared/charts/descriptors/message/question/question.js +123 -2
  44. package/build/shared/charts/descriptors/message/question/utils/evaluateQuestionAnswer.js +44 -3
  45. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +27 -7
  46. package/build/shared/charts/descriptors/nlu/index.js +1 -3
  47. package/build/shared/charts/descriptors/service/GPTPrompt.js +320 -22
  48. package/build/shared/charts/descriptors/service/LLMEntityExtract.js +274 -0
  49. package/build/shared/charts/descriptors/service/httpRequest.js +33 -1
  50. package/build/shared/charts/descriptors/service/index.js +3 -1
  51. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +35 -25
  52. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +15 -11
  53. package/build/shared/charts/descriptors/voice/nodes/play.js +8 -1
  54. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +51 -75
  55. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +0 -1
  56. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +38 -71
  57. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +17 -25
  58. package/build/shared/charts/helpers/generativeAI/generativeAIPrompts.js +55 -0
  59. package/build/shared/helper/BaseContext.js +31 -0
  60. package/build/shared/interfaces/appsession/IAppSession.js +3 -0
  61. package/build/shared/interfaces/appsession/ISetAppState.js +3 -0
  62. package/build/shared/interfaces/appsession/index.js +3 -0
  63. package/build/shared/interfaces/fileStorage.js +6 -0
  64. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +33 -2
  65. package/build/shared/interfaces/handover.js +2 -1
  66. package/build/shared/interfaces/messageAPI/endpoints.js +17 -2
  67. package/build/shared/interfaces/messageAPI/handover.js +9 -5
  68. package/build/shared/interfaces/nlu/nlu.js +3 -0
  69. package/build/shared/interfaces/resources/IAuditEvent.js +10 -9
  70. package/build/shared/interfaces/resources/ILargeLanguageModel.js +34 -20
  71. package/build/shared/interfaces/resources/IMilestone.js +50 -0
  72. package/build/shared/interfaces/resources/INodeDescriptorSet.js +85 -75
  73. package/build/shared/interfaces/resources/TResourceType.js +12 -5
  74. package/build/shared/interfaces/resources/TSocketChannelType.js +5 -1
  75. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -0
  76. package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/ICallCounterAggregatedValue_2_0.js +3 -0
  77. package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/IGetCallCounterOrganisationRest_2_0.js +3 -0
  78. package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/IGetCallCounterRest_2_0.js +3 -0
  79. package/build/shared/interfaces/restAPI/metrics/callCounter/v2.0/index.js +3 -0
  80. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/ICloneMilestoneRest_2_0.js +3 -0
  81. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/ICreateMilestoneRest_2_0.js +3 -0
  82. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IDeleteMilestoneRest_2_0.js +3 -0
  83. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IIndexMilestonesRest_2_0.js +3 -0
  84. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneIndexItem_2_0.js +3 -0
  85. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneStepMetric_2_0.js +3 -0
  86. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneStep_2_0.js +3 -0
  87. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestone_2_0.js +3 -0
  88. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IReadMilestoneRest_2_0.js +3 -0
  89. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IUpdateMilestoneRest_2_0.js +3 -0
  90. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/index.js +3 -0
  91. package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/IUploadResumableRest_2_0.js +3 -1
  92. package/build/shared/interfaces/security/ICallCounterAggregatedValue.js +3 -0
  93. package/build/shared/interfaces/security/IPermission.js +5 -2
  94. package/build/shared/interfaces/security/IRole.js +6 -0
  95. package/build/shared/interfaces/security/index.js +2 -1
  96. package/build/shared/interfaces/trainer/ITrainerRecord.js +2 -0
  97. package/package.json +2 -2
  98. package/types/index.d.ts +1053 -169
  99. package/build/shared/charts/descriptors/nlu/extractAnswer.js +0 -115
@@ -35,6 +35,7 @@ exports.primaryResourceTypes = exports.packageableResourceTypes = exports.search
35
35
  * - lexiconKeyphrase
36
36
  * - lexiconSlot
37
37
  * - locale
38
+ * - milestone
38
39
  * - nluconnector
39
40
  * - nodeData
40
41
  * - nodeDescriptorSet
@@ -72,6 +73,7 @@ exports.arrayTResourceType = [
72
73
  "lexiconKeyphrase",
73
74
  "lexiconSlot",
74
75
  "locale",
76
+ "milestone",
75
77
  "nluconnector",
76
78
  "nodeData",
77
79
  "nodeDescriptorSet",
@@ -80,7 +82,7 @@ exports.arrayTResourceType = [
80
82
  "playbookRun",
81
83
  "slotFiller",
82
84
  "snapshot",
83
- "snippet"
85
+ "snippet",
84
86
  ];
85
87
  exports.arrayTSnapshottableResourceType = [
86
88
  "agentSettings",
@@ -104,12 +106,13 @@ exports.arrayTSnapshottableResourceType = [
104
106
  "lexiconKeyphrase",
105
107
  "lexiconSlot",
106
108
  "locale",
109
+ "milestone",
107
110
  "nluconnector",
108
111
  "nodeData",
109
112
  "nodeDescriptorSet",
110
113
  "playbook",
111
114
  "slotFiller",
112
- "snippet"
115
+ "snippet",
113
116
  ];
114
117
  exports.arrayTChartableResourceType = ["flow"];
115
118
  exports.resourceTypes = [...exports.arrayTResourceType];
@@ -128,6 +131,7 @@ exports.chartableResourceTypes = [...exports.arrayTChartableResourceType];
128
131
  * - flow
129
132
  * - function
130
133
  * - lexicon
134
+ * - milestone
131
135
  * - nluconnector
132
136
  * - playbook
133
137
  * - project
@@ -140,10 +144,11 @@ exports.searchableResourceTypes = [
140
144
  "function",
141
145
  "largeLanguageModel",
142
146
  "lexicon",
147
+ "milestone",
143
148
  "nluconnector",
144
149
  "playbook",
145
150
  "project",
146
- "snapshot"
151
+ "snapshot",
147
152
  ];
148
153
  exports.packageableResourceTypes = [
149
154
  "agentAssistConfig",
@@ -157,9 +162,10 @@ exports.packageableResourceTypes = [
157
162
  "knowledgeStore",
158
163
  "lexicon",
159
164
  "locale",
165
+ "milestone",
160
166
  "nluconnector",
161
167
  "playbook",
162
- "snippet"
168
+ "snippet",
163
169
  ];
164
170
  exports.primaryResourceTypes = [
165
171
  "connection",
@@ -171,8 +177,9 @@ exports.primaryResourceTypes = [
171
177
  "largeLanguageModel",
172
178
  "lexicon",
173
179
  "locale",
180
+ "milestone",
174
181
  "nluconnector",
175
182
  "playbook",
176
- "snippet"
183
+ "snippet",
177
184
  ];
178
185
  //# sourceMappingURL=TResourceType.js.map
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.socketChannelDisplayNames = exports.socketChannelTypes = void 0;
4
- exports.socketChannelTypes = ["realtime", "webchat2", "admin-webchat", "socket", "voiceGateway2", "liveAgentAssist"];
4
+ exports.socketChannelTypes = ["realtime", "webchat2", "admin-webchat", "socket", "voiceGateway2", "liveAgentAssist", "webchat3"];
5
5
  exports.socketChannelDisplayNames = [
6
6
  {
7
7
  channel: "realtime",
@@ -26,6 +26,10 @@ exports.socketChannelDisplayNames = [
26
26
  {
27
27
  channel: "liveAgentAssist",
28
28
  displayName: "Live Agent Assist"
29
+ },
30
+ {
31
+ channel: "webchat3",
32
+ displayName: "Webchat 3"
29
33
  }
30
34
  ];
31
35
  //# sourceMappingURL=TSocketChannelType.js.map
@@ -65,6 +65,10 @@ exports.generativeAISettingsDataSchema = {
65
65
  sentimentAnalysis: {
66
66
  type: "object",
67
67
  properties: Object.assign({}, exports.generativeAIUseCaseDataSchema.properties)
68
+ },
69
+ nlu: {
70
+ type: "object",
71
+ properties: Object.assign({}, exports.generativeAIUseCaseDataSchema.properties)
68
72
  }
69
73
  }
70
74
  }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ICallCounterAggregatedValue_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IGetCallCounterOrganisationRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IGetCallCounterRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ICloneMilestoneRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ICreateMilestoneRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IDeleteMilestoneRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IIndexMilestonesRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IMilestoneIndexItem_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IMilestoneStepMetric_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IMilestoneStep_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IMilestone_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IReadMilestoneRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IUpdateMilestoneRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=index.js.map
@@ -10,8 +10,10 @@ exports.uploadResumableTypes = void 0;
10
10
  * type: string
11
11
  * enum:
12
12
  * - snapshots
13
+ * - packages
13
14
  */
14
15
  exports.uploadResumableTypes = [
15
- "snapshots"
16
+ "snapshots",
17
+ "packages"
16
18
  ];
17
19
  //# sourceMappingURL=IUploadResumableRest_2_0.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ICallCounterAggregatedValue.js.map
@@ -20,6 +20,7 @@ exports.availablePermissions = exports.projectWidePermissions = exports.organisa
20
20
  exports.organisationWidePermissions = [
21
21
  "analyticsOdata",
22
22
  "apiKeys",
23
+ "assignProject",
23
24
  "liveAgentAccount",
24
25
  "projects",
25
26
  "userDetails",
@@ -56,6 +57,7 @@ exports.organisationWidePermissions = [
56
57
  * - logs
57
58
  * - memberDetails
58
59
  * - members
60
+ * - milestones
59
61
  * - nluConnectors
60
62
  * - packages
61
63
  * - playbooks
@@ -93,6 +95,7 @@ exports.projectWidePermissions = [
93
95
  "logs",
94
96
  "memberDetails",
95
97
  "members",
98
+ "milestones",
96
99
  "nluConnectors",
97
100
  "packages",
98
101
  "playbooks",
@@ -103,10 +106,10 @@ exports.projectWidePermissions = [
103
106
  "tasks",
104
107
  "tokens",
105
108
  "yesNoIntents",
106
- "dataPrivacySettings"
109
+ "dataPrivacySettings",
107
110
  ];
108
111
  exports.availablePermissions = [
109
112
  ...exports.organisationWidePermissions,
110
- ...exports.projectWidePermissions
113
+ ...exports.projectWidePermissions,
111
114
  ];
112
115
  //# sourceMappingURL=IPermission.js.map
@@ -12,10 +12,13 @@ exports.projectRolesWithSpecialOrgRights = exports.availableRoles = exports.proj
12
12
  * - admin
13
13
  * - apiKeys
14
14
  * - base_role
15
+ * - basicSupportUser
16
+ * - fullSupportUser
15
17
  * - liveAgentAdmin
16
18
  * - liveAgentAgent
17
19
  * - liveAgentSupervisor
18
20
  * - odata
21
+ * - projectAssigner
19
22
  * - projectManager
20
23
  * - userManager
21
24
  * - userDetailsViewer
@@ -25,11 +28,14 @@ exports.organisationWideRoles = [
25
28
  "admin",
26
29
  "apiKeys",
27
30
  "base_role",
31
+ "basicSupportUser",
32
+ "fullSupportUser",
28
33
  "liveAgentAdmin",
29
34
  "liveAgentAgent",
30
35
  "liveAgentSupervisor",
31
36
  "livechat",
32
37
  "odata",
38
+ "projectAssigner",
33
39
  "projectManager",
34
40
  "userManager",
35
41
  "userDetailsViewer",
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.identityProviderSchema = exports.oidcIdentityProviderDataSchema = exports.samlIdentityProviderDataSchema = exports.CrudOperation = exports.operations = exports.availableRoles = exports.projectWideRoles = exports.organisationWideRoles = exports.availablePermissions = void 0;
3
+ 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;
4
+ exports.COMPUTED_ACL_HASH_VERSION = "v13";
4
5
  var IPermission_1 = require("./IPermission");
5
6
  Object.defineProperty(exports, "availablePermissions", { enumerable: true, get: function () { return IPermission_1.availablePermissions; } });
6
7
  var IRole_1 = require("./IRole");
@@ -35,6 +35,7 @@ exports.trainerRecordBulkCreateDataSchema = {
35
35
  properties: {
36
36
  finalIntentName: { type: ["null", "string"] },
37
37
  finalIntentScore: { type: ["null", "number"] },
38
+ highestFlow: { type: ["null", "string"] },
38
39
  },
39
40
  },
40
41
  tokens: { type: "array", items: { type: "string" } },
@@ -73,6 +74,7 @@ exports.trainerRecordDataSchema = {
73
74
  properties: {
74
75
  finalIntentName: { type: ["null", "string"] },
75
76
  finalIntentScore: { type: ["null", "number"] },
77
+ highestFlow: { type: ["null", "string"] },
76
78
  },
77
79
  },
78
80
  tokens: { type: "array", items: { type: "string" } },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cognigy/rest-api-client",
3
- "version": "0.16.0",
3
+ "version": "0.18.0",
4
4
  "description": "Cognigy REST-Client",
5
5
  "main": "build/index.js",
6
6
  "module": "dist/rollup-plugin-babel.esm.js",
@@ -31,7 +31,7 @@
31
31
  "license": "Cognigy Proprietary License",
32
32
  "dependencies": {
33
33
  "ajv": "6.12.6",
34
- "axios": "1.6.0",
34
+ "axios": "1.6.8",
35
35
  "form-data": "4.0.0",
36
36
  "tus-js-client": "^3.1.1",
37
37
  "uuidv4": "6.2.13"