purecloud-platform-client-v2 227.0.0 → 228.0.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.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1841 -237
- package/dist/web-amd/purecloud-platform-client-v2.js +1841 -237
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +583 -188
- package/dist/web-cjs/purecloud-platform-client-v2.js +583 -188
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1320 -290
- package/package.json +4 -4
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +32 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +391 -26
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +4 -46
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +7 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +61 -35
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +60 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +86 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +53 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -26
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +158 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +105 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +121 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +12 -12
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +494 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "purecloud-platform-client-v2",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "228.0.0",
|
|
4
4
|
"description": "A JavaScript library to interface with the PureCloud Platform API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/node/purecloud-platform-client-v2.js",
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
"url": "https://developer.genesys.cloud/"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"axios": "^1.
|
|
33
|
+
"axios": "^1.11.0",
|
|
34
34
|
"configparser": "^0.3.9",
|
|
35
|
-
"qs": "^6.
|
|
36
|
-
"winston": "^3.
|
|
35
|
+
"qs": "^6.14.0",
|
|
36
|
+
"winston": "^3.17.0"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"mocha": "~9.2.0",
|
|
@@ -5,7 +5,7 @@ class AIStudioApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AIStudio service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 228.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -227,6 +227,37 @@ class AIStudioApi {
|
|
|
227
227
|
);
|
|
228
228
|
}
|
|
229
229
|
|
|
230
|
+
/**
|
|
231
|
+
* Update a guide.
|
|
232
|
+
*
|
|
233
|
+
* @param {String} guideId Guide ID
|
|
234
|
+
* @param {Object} body
|
|
235
|
+
* patchGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
236
|
+
*/
|
|
237
|
+
patchGuide(guideId, body) {
|
|
238
|
+
// verify the required parameter 'guideId' is set
|
|
239
|
+
if (guideId === undefined || guideId === null || guideId === '') {
|
|
240
|
+
throw 'Missing the required parameter "guideId" when calling patchGuide';
|
|
241
|
+
}
|
|
242
|
+
// verify the required parameter 'body' is set
|
|
243
|
+
if (body === undefined || body === null) {
|
|
244
|
+
throw 'Missing the required parameter "body" when calling patchGuide';
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
return this.apiClient.callApi(
|
|
248
|
+
'/api/v2/guides/{guideId}',
|
|
249
|
+
'PATCH',
|
|
250
|
+
{ 'guideId': guideId },
|
|
251
|
+
{ },
|
|
252
|
+
{ },
|
|
253
|
+
{ },
|
|
254
|
+
body,
|
|
255
|
+
['PureCloud OAuth'],
|
|
256
|
+
['application/json'],
|
|
257
|
+
['application/json']
|
|
258
|
+
);
|
|
259
|
+
}
|
|
260
|
+
|
|
230
261
|
/**
|
|
231
262
|
* Update a guide version.
|
|
232
263
|
*
|
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 228.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,110 @@ class AnalyticsApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Delete/cancel an async request for action aggregates
|
|
25
|
+
*
|
|
26
|
+
* @param {String} jobId jobId
|
|
27
|
+
* deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
|
+
*/
|
|
29
|
+
deleteAnalyticsActionsAggregatesJob(jobId) {
|
|
30
|
+
// verify the required parameter 'jobId' is set
|
|
31
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
32
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsActionsAggregatesJob';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return this.apiClient.callApi(
|
|
36
|
+
'/api/v2/analytics/actions/aggregates/jobs/{jobId}',
|
|
37
|
+
'DELETE',
|
|
38
|
+
{ 'jobId': jobId },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
{ },
|
|
42
|
+
null,
|
|
43
|
+
['PureCloud OAuth'],
|
|
44
|
+
['application/json'],
|
|
45
|
+
['application/json']
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Delete/cancel an async request for agent copilot aggregates
|
|
51
|
+
*
|
|
52
|
+
* @param {String} jobId jobId
|
|
53
|
+
* deleteAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54
|
+
*/
|
|
55
|
+
deleteAnalyticsAgentcopilotsAggregatesJob(jobId) {
|
|
56
|
+
// verify the required parameter 'jobId' is set
|
|
57
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
58
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsAgentcopilotsAggregatesJob';
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
return this.apiClient.callApi(
|
|
62
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}',
|
|
63
|
+
'DELETE',
|
|
64
|
+
{ 'jobId': jobId },
|
|
65
|
+
{ },
|
|
66
|
+
{ },
|
|
67
|
+
{ },
|
|
68
|
+
null,
|
|
69
|
+
['PureCloud OAuth'],
|
|
70
|
+
['application/json'],
|
|
71
|
+
['application/json']
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Delete/cancel an async request for bot aggregates
|
|
77
|
+
*
|
|
78
|
+
* @param {String} jobId jobId
|
|
79
|
+
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80
|
+
*/
|
|
81
|
+
deleteAnalyticsBotsAggregatesJob(jobId) {
|
|
82
|
+
// verify the required parameter 'jobId' is set
|
|
83
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
84
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsBotsAggregatesJob';
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
return this.apiClient.callApi(
|
|
88
|
+
'/api/v2/analytics/bots/aggregates/jobs/{jobId}',
|
|
89
|
+
'DELETE',
|
|
90
|
+
{ 'jobId': jobId },
|
|
91
|
+
{ },
|
|
92
|
+
{ },
|
|
93
|
+
{ },
|
|
94
|
+
null,
|
|
95
|
+
['PureCloud OAuth'],
|
|
96
|
+
['application/json'],
|
|
97
|
+
['application/json']
|
|
98
|
+
);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* Delete/cancel an async request for conversation aggregates
|
|
103
|
+
*
|
|
104
|
+
* @param {String} jobId jobId
|
|
105
|
+
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
106
|
+
*/
|
|
107
|
+
deleteAnalyticsConversationsAggregatesJob(jobId) {
|
|
108
|
+
// verify the required parameter 'jobId' is set
|
|
109
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
110
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
return this.apiClient.callApi(
|
|
114
|
+
'/api/v2/analytics/conversations/aggregates/jobs/{jobId}',
|
|
115
|
+
'DELETE',
|
|
116
|
+
{ 'jobId': jobId },
|
|
117
|
+
{ },
|
|
118
|
+
{ },
|
|
119
|
+
{ },
|
|
120
|
+
null,
|
|
121
|
+
['PureCloud OAuth'],
|
|
122
|
+
['application/json'],
|
|
123
|
+
['application/json']
|
|
124
|
+
);
|
|
125
|
+
}
|
|
126
|
+
|
|
23
127
|
/**
|
|
24
128
|
* Delete/cancel an async details job
|
|
25
129
|
*
|
|
@@ -45,6 +149,292 @@ class AnalyticsApi {
|
|
|
45
149
|
);
|
|
46
150
|
}
|
|
47
151
|
|
|
152
|
+
/**
|
|
153
|
+
* Delete/cancel an async request for evaluation aggregates
|
|
154
|
+
*
|
|
155
|
+
* @param {String} jobId jobId
|
|
156
|
+
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
157
|
+
*/
|
|
158
|
+
deleteAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
159
|
+
// verify the required parameter 'jobId' is set
|
|
160
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
161
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
return this.apiClient.callApi(
|
|
165
|
+
'/api/v2/analytics/evaluations/aggregates/jobs/{jobId}',
|
|
166
|
+
'DELETE',
|
|
167
|
+
{ 'jobId': jobId },
|
|
168
|
+
{ },
|
|
169
|
+
{ },
|
|
170
|
+
{ },
|
|
171
|
+
null,
|
|
172
|
+
['PureCloud OAuth'],
|
|
173
|
+
['application/json'],
|
|
174
|
+
['application/json']
|
|
175
|
+
);
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Delete/cancel an async request for flow execution aggregates
|
|
180
|
+
*
|
|
181
|
+
* @param {String} jobId jobId
|
|
182
|
+
* deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
183
|
+
*/
|
|
184
|
+
deleteAnalyticsFlowexecutionsAggregatesJob(jobId) {
|
|
185
|
+
// verify the required parameter 'jobId' is set
|
|
186
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
187
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowexecutionsAggregatesJob';
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
return this.apiClient.callApi(
|
|
191
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}',
|
|
192
|
+
'DELETE',
|
|
193
|
+
{ 'jobId': jobId },
|
|
194
|
+
{ },
|
|
195
|
+
{ },
|
|
196
|
+
{ },
|
|
197
|
+
null,
|
|
198
|
+
['PureCloud OAuth'],
|
|
199
|
+
['application/json'],
|
|
200
|
+
['application/json']
|
|
201
|
+
);
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Delete/cancel an async request for flow aggregates
|
|
206
|
+
*
|
|
207
|
+
* @param {String} jobId jobId
|
|
208
|
+
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
209
|
+
*/
|
|
210
|
+
deleteAnalyticsFlowsAggregatesJob(jobId) {
|
|
211
|
+
// verify the required parameter 'jobId' is set
|
|
212
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
213
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
return this.apiClient.callApi(
|
|
217
|
+
'/api/v2/analytics/flows/aggregates/jobs/{jobId}',
|
|
218
|
+
'DELETE',
|
|
219
|
+
{ 'jobId': jobId },
|
|
220
|
+
{ },
|
|
221
|
+
{ },
|
|
222
|
+
{ },
|
|
223
|
+
null,
|
|
224
|
+
['PureCloud OAuth'],
|
|
225
|
+
['application/json'],
|
|
226
|
+
['application/json']
|
|
227
|
+
);
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Delete/cancel an async request for journey aggregates
|
|
232
|
+
*
|
|
233
|
+
* @param {String} jobId jobId
|
|
234
|
+
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
235
|
+
*/
|
|
236
|
+
deleteAnalyticsJourneysAggregatesJob(jobId) {
|
|
237
|
+
// verify the required parameter 'jobId' is set
|
|
238
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
239
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
return this.apiClient.callApi(
|
|
243
|
+
'/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
|
|
244
|
+
'DELETE',
|
|
245
|
+
{ 'jobId': jobId },
|
|
246
|
+
{ },
|
|
247
|
+
{ },
|
|
248
|
+
{ },
|
|
249
|
+
null,
|
|
250
|
+
['PureCloud OAuth'],
|
|
251
|
+
['application/json'],
|
|
252
|
+
['application/json']
|
|
253
|
+
);
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* Delete/cancel an async request for knowledge aggregates
|
|
258
|
+
*
|
|
259
|
+
* @param {String} jobId jobId
|
|
260
|
+
* deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
261
|
+
*/
|
|
262
|
+
deleteAnalyticsKnowledgeAggregatesJob(jobId) {
|
|
263
|
+
// verify the required parameter 'jobId' is set
|
|
264
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
265
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsKnowledgeAggregatesJob';
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
return this.apiClient.callApi(
|
|
269
|
+
'/api/v2/analytics/knowledge/aggregates/jobs/{jobId}',
|
|
270
|
+
'DELETE',
|
|
271
|
+
{ 'jobId': jobId },
|
|
272
|
+
{ },
|
|
273
|
+
{ },
|
|
274
|
+
{ },
|
|
275
|
+
null,
|
|
276
|
+
['PureCloud OAuth'],
|
|
277
|
+
['application/json'],
|
|
278
|
+
['application/json']
|
|
279
|
+
);
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* Delete/cancel an async request for resolution aggregates
|
|
284
|
+
*
|
|
285
|
+
* @param {String} jobId jobId
|
|
286
|
+
* deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
287
|
+
*/
|
|
288
|
+
deleteAnalyticsResolutionsAggregatesJob(jobId) {
|
|
289
|
+
// verify the required parameter 'jobId' is set
|
|
290
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
291
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsResolutionsAggregatesJob';
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
return this.apiClient.callApi(
|
|
295
|
+
'/api/v2/analytics/resolutions/aggregates/jobs/{jobId}',
|
|
296
|
+
'DELETE',
|
|
297
|
+
{ 'jobId': jobId },
|
|
298
|
+
{ },
|
|
299
|
+
{ },
|
|
300
|
+
{ },
|
|
301
|
+
null,
|
|
302
|
+
['PureCloud OAuth'],
|
|
303
|
+
['application/json'],
|
|
304
|
+
['application/json']
|
|
305
|
+
);
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* Delete/cancel an async request for summary aggregates
|
|
310
|
+
*
|
|
311
|
+
* @param {String} jobId jobId
|
|
312
|
+
* deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
313
|
+
*/
|
|
314
|
+
deleteAnalyticsSummariesAggregatesJob(jobId) {
|
|
315
|
+
// verify the required parameter 'jobId' is set
|
|
316
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
317
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSummariesAggregatesJob';
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
return this.apiClient.callApi(
|
|
321
|
+
'/api/v2/analytics/summaries/aggregates/jobs/{jobId}',
|
|
322
|
+
'DELETE',
|
|
323
|
+
{ 'jobId': jobId },
|
|
324
|
+
{ },
|
|
325
|
+
{ },
|
|
326
|
+
{ },
|
|
327
|
+
null,
|
|
328
|
+
['PureCloud OAuth'],
|
|
329
|
+
['application/json'],
|
|
330
|
+
['application/json']
|
|
331
|
+
);
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Delete/cancel an async request for survey aggregates
|
|
336
|
+
*
|
|
337
|
+
* @param {String} jobId jobId
|
|
338
|
+
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
339
|
+
*/
|
|
340
|
+
deleteAnalyticsSurveysAggregatesJob(jobId) {
|
|
341
|
+
// verify the required parameter 'jobId' is set
|
|
342
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
343
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
return this.apiClient.callApi(
|
|
347
|
+
'/api/v2/analytics/surveys/aggregates/jobs/{jobId}',
|
|
348
|
+
'DELETE',
|
|
349
|
+
{ 'jobId': jobId },
|
|
350
|
+
{ },
|
|
351
|
+
{ },
|
|
352
|
+
{ },
|
|
353
|
+
null,
|
|
354
|
+
['PureCloud OAuth'],
|
|
355
|
+
['application/json'],
|
|
356
|
+
['application/json']
|
|
357
|
+
);
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* Delete/cancel an async request for task management aggregates
|
|
362
|
+
*
|
|
363
|
+
* @param {String} jobId jobId
|
|
364
|
+
* deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
365
|
+
*/
|
|
366
|
+
deleteAnalyticsTaskmanagementAggregatesJob(jobId) {
|
|
367
|
+
// verify the required parameter 'jobId' is set
|
|
368
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
369
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTaskmanagementAggregatesJob';
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
return this.apiClient.callApi(
|
|
373
|
+
'/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}',
|
|
374
|
+
'DELETE',
|
|
375
|
+
{ 'jobId': jobId },
|
|
376
|
+
{ },
|
|
377
|
+
{ },
|
|
378
|
+
{ },
|
|
379
|
+
null,
|
|
380
|
+
['PureCloud OAuth'],
|
|
381
|
+
['application/json'],
|
|
382
|
+
['application/json']
|
|
383
|
+
);
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Delete/cancel an async request for transcript aggregates
|
|
388
|
+
*
|
|
389
|
+
* @param {String} jobId jobId
|
|
390
|
+
* deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
391
|
+
*/
|
|
392
|
+
deleteAnalyticsTranscriptsAggregatesJob(jobId) {
|
|
393
|
+
// verify the required parameter 'jobId' is set
|
|
394
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
395
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTranscriptsAggregatesJob';
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
return this.apiClient.callApi(
|
|
399
|
+
'/api/v2/analytics/transcripts/aggregates/jobs/{jobId}',
|
|
400
|
+
'DELETE',
|
|
401
|
+
{ 'jobId': jobId },
|
|
402
|
+
{ },
|
|
403
|
+
{ },
|
|
404
|
+
{ },
|
|
405
|
+
null,
|
|
406
|
+
['PureCloud OAuth'],
|
|
407
|
+
['application/json'],
|
|
408
|
+
['application/json']
|
|
409
|
+
);
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
/**
|
|
413
|
+
* Delete/cancel an async request for user aggregates
|
|
414
|
+
*
|
|
415
|
+
* @param {String} jobId jobId
|
|
416
|
+
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
417
|
+
*/
|
|
418
|
+
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
419
|
+
// verify the required parameter 'jobId' is set
|
|
420
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
421
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
return this.apiClient.callApi(
|
|
425
|
+
'/api/v2/analytics/users/aggregates/jobs/{jobId}',
|
|
426
|
+
'DELETE',
|
|
427
|
+
{ 'jobId': jobId },
|
|
428
|
+
{ },
|
|
429
|
+
{ },
|
|
430
|
+
{ },
|
|
431
|
+
null,
|
|
432
|
+
['PureCloud OAuth'],
|
|
433
|
+
['application/json'],
|
|
434
|
+
['application/json']
|
|
435
|
+
);
|
|
436
|
+
}
|
|
437
|
+
|
|
48
438
|
/**
|
|
49
439
|
* Delete/cancel an async request
|
|
50
440
|
*
|
|
@@ -1839,31 +2229,6 @@ class AnalyticsApi {
|
|
|
1839
2229
|
);
|
|
1840
2230
|
}
|
|
1841
2231
|
|
|
1842
|
-
/**
|
|
1843
|
-
* Search resources.
|
|
1844
|
-
*
|
|
1845
|
-
* @param {Object} body Search request options
|
|
1846
|
-
*/
|
|
1847
|
-
postAnalyticsConversationsTranscriptsQuery(body) {
|
|
1848
|
-
// verify the required parameter 'body' is set
|
|
1849
|
-
if (body === undefined || body === null) {
|
|
1850
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';
|
|
1851
|
-
}
|
|
1852
|
-
|
|
1853
|
-
return this.apiClient.callApi(
|
|
1854
|
-
'/api/v2/analytics/conversations/transcripts/query',
|
|
1855
|
-
'POST',
|
|
1856
|
-
{ },
|
|
1857
|
-
{ },
|
|
1858
|
-
{ },
|
|
1859
|
-
{ },
|
|
1860
|
-
body,
|
|
1861
|
-
['PureCloud OAuth'],
|
|
1862
|
-
['application/json'],
|
|
1863
|
-
['application/json']
|
|
1864
|
-
);
|
|
1865
|
-
}
|
|
1866
|
-
|
|
1867
2232
|
/**
|
|
1868
2233
|
* Query for evaluation aggregates asynchronously
|
|
1869
2234
|
*
|
|
@@ -5,7 +5,7 @@ class BusinessRulesApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* BusinessRules service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 228.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -279,7 +279,6 @@ class BusinessRulesApi {
|
|
|
279
279
|
* @param {Object} opts Optional parameters
|
|
280
280
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
281
281
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
282
|
-
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
283
282
|
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
284
283
|
*/
|
|
285
284
|
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
@@ -294,7 +293,7 @@ class BusinessRulesApi {
|
|
|
294
293
|
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
295
294
|
'GET',
|
|
296
295
|
{ 'tableId': tableId },
|
|
297
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize']
|
|
296
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
298
297
|
{ },
|
|
299
298
|
{ },
|
|
300
299
|
null,
|
|
@@ -311,6 +310,7 @@ class BusinessRulesApi {
|
|
|
311
310
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
312
311
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
313
312
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
313
|
+
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name.
|
|
314
314
|
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
315
315
|
*/
|
|
316
316
|
getBusinessrulesDecisiontables(opts) {
|
|
@@ -321,7 +321,7 @@ class BusinessRulesApi {
|
|
|
321
321
|
'/api/v2/businessrules/decisiontables',
|
|
322
322
|
'GET',
|
|
323
323
|
{ },
|
|
324
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
324
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'name': opts['name'] },
|
|
325
325
|
{ },
|
|
326
326
|
{ },
|
|
327
327
|
null,
|
|
@@ -523,48 +523,6 @@ class BusinessRulesApi {
|
|
|
523
523
|
);
|
|
524
524
|
}
|
|
525
525
|
|
|
526
|
-
/**
|
|
527
|
-
* Partially update a decision table row. Will be deprecated, we should use PUT request.
|
|
528
|
-
*
|
|
529
|
-
* @param {String} tableId Table ID
|
|
530
|
-
* @param {Number} tableVersion Table Version
|
|
531
|
-
* @param {String} rowId Row ID
|
|
532
|
-
* @param {Object} body Partially update decision table row request
|
|
533
|
-
* @deprecated
|
|
534
|
-
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
535
|
-
*/
|
|
536
|
-
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
537
|
-
// verify the required parameter 'tableId' is set
|
|
538
|
-
if (tableId === undefined || tableId === null || tableId === '') {
|
|
539
|
-
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
540
|
-
}
|
|
541
|
-
// verify the required parameter 'tableVersion' is set
|
|
542
|
-
if (tableVersion === undefined || tableVersion === null) {
|
|
543
|
-
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
544
|
-
}
|
|
545
|
-
// verify the required parameter 'rowId' is set
|
|
546
|
-
if (rowId === undefined || rowId === null || rowId === '') {
|
|
547
|
-
throw 'Missing the required parameter "rowId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
548
|
-
}
|
|
549
|
-
// verify the required parameter 'body' is set
|
|
550
|
-
if (body === undefined || body === null) {
|
|
551
|
-
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
552
|
-
}
|
|
553
|
-
|
|
554
|
-
return this.apiClient.callApi(
|
|
555
|
-
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
556
|
-
'PATCH',
|
|
557
|
-
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
558
|
-
{ },
|
|
559
|
-
{ },
|
|
560
|
-
{ },
|
|
561
|
-
body,
|
|
562
|
-
['PureCloud OAuth'],
|
|
563
|
-
['application/json'],
|
|
564
|
-
['application/json']
|
|
565
|
-
);
|
|
566
|
-
}
|
|
567
|
-
|
|
568
526
|
/**
|
|
569
527
|
* Execute a published decision table
|
|
570
528
|
*
|