purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class AgentAssistantsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AgentAssistants service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class AgentAssistantsApi {
|
|
|
24
24
|
* Delete an assistant.
|
|
25
25
|
*
|
|
26
26
|
* @param {String} assistantId Assistant ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
deleteAssistant(assistantId) {
|
|
30
|
+
deleteAssistant(assistantId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'assistantId' is set
|
|
30
34
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
31
35
|
throw 'Missing the required parameter "assistantId" when calling deleteAssistant';
|
|
@@ -41,7 +45,8 @@ class AgentAssistantsApi {
|
|
|
41
45
|
null,
|
|
42
46
|
['PureCloud OAuth'],
|
|
43
47
|
['application/json'],
|
|
44
|
-
['application/json']
|
|
48
|
+
['application/json'],
|
|
49
|
+
opts['customHeaders']
|
|
45
50
|
);
|
|
46
51
|
}
|
|
47
52
|
|
|
@@ -50,8 +55,12 @@ class AgentAssistantsApi {
|
|
|
50
55
|
*
|
|
51
56
|
* @param {String} assistantId Assistant ID
|
|
52
57
|
* @param {String} queueId Queue ID
|
|
58
|
+
* @param {Object} opts Optional parameters
|
|
59
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
60
|
*/
|
|
54
|
-
deleteAssistantQueue(assistantId, queueId) {
|
|
61
|
+
deleteAssistantQueue(assistantId, queueId, opts) {
|
|
62
|
+
opts = opts || {};
|
|
63
|
+
|
|
55
64
|
// verify the required parameter 'assistantId' is set
|
|
56
65
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
57
66
|
throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueue';
|
|
@@ -71,7 +80,8 @@ class AgentAssistantsApi {
|
|
|
71
80
|
null,
|
|
72
81
|
['PureCloud OAuth'],
|
|
73
82
|
['application/json'],
|
|
74
|
-
['application/json']
|
|
83
|
+
['application/json'],
|
|
84
|
+
opts['customHeaders']
|
|
75
85
|
);
|
|
76
86
|
}
|
|
77
87
|
|
|
@@ -81,6 +91,7 @@ class AgentAssistantsApi {
|
|
|
81
91
|
* @param {String} assistantId Assistant ID
|
|
82
92
|
* @param {Object} opts Optional parameters
|
|
83
93
|
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be deleted.
|
|
94
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
84
95
|
*/
|
|
85
96
|
deleteAssistantQueues(assistantId, opts) {
|
|
86
97
|
opts = opts || {};
|
|
@@ -100,7 +111,8 @@ class AgentAssistantsApi {
|
|
|
100
111
|
null,
|
|
101
112
|
['PureCloud OAuth'],
|
|
102
113
|
['application/json'],
|
|
103
|
-
['application/json']
|
|
114
|
+
['application/json'],
|
|
115
|
+
opts['customHeaders']
|
|
104
116
|
);
|
|
105
117
|
}
|
|
106
118
|
|
|
@@ -108,8 +120,12 @@ class AgentAssistantsApi {
|
|
|
108
120
|
* Delete an agent checklist
|
|
109
121
|
*
|
|
110
122
|
* @param {String} agentChecklistId Agent Checklist ID
|
|
123
|
+
* @param {Object} opts Optional parameters
|
|
124
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111
125
|
*/
|
|
112
|
-
deleteAssistantsAgentchecklist(agentChecklistId) {
|
|
126
|
+
deleteAssistantsAgentchecklist(agentChecklistId, opts) {
|
|
127
|
+
opts = opts || {};
|
|
128
|
+
|
|
113
129
|
// verify the required parameter 'agentChecklistId' is set
|
|
114
130
|
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
115
131
|
throw 'Missing the required parameter "agentChecklistId" when calling deleteAssistantsAgentchecklist';
|
|
@@ -125,7 +141,8 @@ class AgentAssistantsApi {
|
|
|
125
141
|
null,
|
|
126
142
|
['PureCloud OAuth'],
|
|
127
143
|
['application/json'],
|
|
128
|
-
['application/json']
|
|
144
|
+
['application/json'],
|
|
145
|
+
opts['customHeaders']
|
|
129
146
|
);
|
|
130
147
|
}
|
|
131
148
|
|
|
@@ -137,6 +154,7 @@ class AgentAssistantsApi {
|
|
|
137
154
|
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
138
155
|
* @param {String} opts.languageVariation Language variation
|
|
139
156
|
* @param {Boolean} opts.fallbackToPrimaryAssistant Fall back to primary assistant if specified variation is not found
|
|
157
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
140
158
|
*/
|
|
141
159
|
getAssistant(assistantId, opts) {
|
|
142
160
|
opts = opts || {};
|
|
@@ -156,7 +174,8 @@ class AgentAssistantsApi {
|
|
|
156
174
|
null,
|
|
157
175
|
['PureCloud OAuth'],
|
|
158
176
|
['application/json'],
|
|
159
|
-
['application/json']
|
|
177
|
+
['application/json'],
|
|
178
|
+
opts['customHeaders']
|
|
160
179
|
);
|
|
161
180
|
}
|
|
162
181
|
|
|
@@ -167,6 +186,7 @@ class AgentAssistantsApi {
|
|
|
167
186
|
* @param {String} queueId Queue ID
|
|
168
187
|
* @param {Object} opts Optional parameters
|
|
169
188
|
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
189
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
170
190
|
*/
|
|
171
191
|
getAssistantQueue(assistantId, queueId, opts) {
|
|
172
192
|
opts = opts || {};
|
|
@@ -190,7 +210,8 @@ class AgentAssistantsApi {
|
|
|
190
210
|
null,
|
|
191
211
|
['PureCloud OAuth'],
|
|
192
212
|
['application/json'],
|
|
193
|
-
['application/json']
|
|
213
|
+
['application/json'],
|
|
214
|
+
opts['customHeaders']
|
|
194
215
|
);
|
|
195
216
|
}
|
|
196
217
|
|
|
@@ -200,8 +221,12 @@ class AgentAssistantsApi {
|
|
|
200
221
|
* @param {String} assistantId Assistant ID
|
|
201
222
|
* @param {String} queueId Queue ID
|
|
202
223
|
* @param {String} jobId Job ID
|
|
224
|
+
* @param {Object} opts Optional parameters
|
|
225
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
203
226
|
*/
|
|
204
|
-
getAssistantQueueUsersJob(assistantId, queueId, jobId) {
|
|
227
|
+
getAssistantQueueUsersJob(assistantId, queueId, jobId, opts) {
|
|
228
|
+
opts = opts || {};
|
|
229
|
+
|
|
205
230
|
// verify the required parameter 'assistantId' is set
|
|
206
231
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
207
232
|
throw 'Missing the required parameter "assistantId" when calling getAssistantQueueUsersJob';
|
|
@@ -225,7 +250,8 @@ class AgentAssistantsApi {
|
|
|
225
250
|
null,
|
|
226
251
|
['PureCloud OAuth'],
|
|
227
252
|
['application/json'],
|
|
228
|
-
['application/json']
|
|
253
|
+
['application/json'],
|
|
254
|
+
opts['customHeaders']
|
|
229
255
|
);
|
|
230
256
|
}
|
|
231
257
|
|
|
@@ -238,6 +264,7 @@ class AgentAssistantsApi {
|
|
|
238
264
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
239
265
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
240
266
|
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
267
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
241
268
|
*/
|
|
242
269
|
getAssistantQueues(assistantId, opts) {
|
|
243
270
|
opts = opts || {};
|
|
@@ -257,7 +284,8 @@ class AgentAssistantsApi {
|
|
|
257
284
|
null,
|
|
258
285
|
['PureCloud OAuth'],
|
|
259
286
|
['application/json'],
|
|
260
|
-
['application/json']
|
|
287
|
+
['application/json'],
|
|
288
|
+
opts['customHeaders']
|
|
261
289
|
);
|
|
262
290
|
}
|
|
263
291
|
|
|
@@ -271,6 +299,7 @@ class AgentAssistantsApi {
|
|
|
271
299
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
272
300
|
* @param {String} opts.name Return the assistant by the given name.
|
|
273
301
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
302
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
274
303
|
*/
|
|
275
304
|
getAssistants(opts) {
|
|
276
305
|
opts = opts || {};
|
|
@@ -286,7 +315,8 @@ class AgentAssistantsApi {
|
|
|
286
315
|
null,
|
|
287
316
|
['PureCloud OAuth'],
|
|
288
317
|
['application/json'],
|
|
289
|
-
['application/json']
|
|
318
|
+
['application/json'],
|
|
319
|
+
opts['customHeaders']
|
|
290
320
|
);
|
|
291
321
|
}
|
|
292
322
|
|
|
@@ -294,8 +324,12 @@ class AgentAssistantsApi {
|
|
|
294
324
|
* Get an agent checklist
|
|
295
325
|
*
|
|
296
326
|
* @param {String} agentChecklistId Agent Checklist ID
|
|
327
|
+
* @param {Object} opts Optional parameters
|
|
328
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
297
329
|
*/
|
|
298
|
-
getAssistantsAgentchecklist(agentChecklistId) {
|
|
330
|
+
getAssistantsAgentchecklist(agentChecklistId, opts) {
|
|
331
|
+
opts = opts || {};
|
|
332
|
+
|
|
299
333
|
// verify the required parameter 'agentChecklistId' is set
|
|
300
334
|
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
301
335
|
throw 'Missing the required parameter "agentChecklistId" when calling getAssistantsAgentchecklist';
|
|
@@ -311,7 +345,8 @@ class AgentAssistantsApi {
|
|
|
311
345
|
null,
|
|
312
346
|
['PureCloud OAuth'],
|
|
313
347
|
['application/json'],
|
|
314
|
-
['application/json']
|
|
348
|
+
['application/json'],
|
|
349
|
+
opts['customHeaders']
|
|
315
350
|
);
|
|
316
351
|
}
|
|
317
352
|
|
|
@@ -326,6 +361,7 @@ class AgentAssistantsApi {
|
|
|
326
361
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
327
362
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
328
363
|
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
364
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
329
365
|
*/
|
|
330
366
|
getAssistantsAgentchecklists(opts) {
|
|
331
367
|
opts = opts || {};
|
|
@@ -341,15 +377,20 @@ class AgentAssistantsApi {
|
|
|
341
377
|
null,
|
|
342
378
|
['PureCloud OAuth'],
|
|
343
379
|
['application/json'],
|
|
344
|
-
['application/json']
|
|
380
|
+
['application/json'],
|
|
381
|
+
opts['customHeaders']
|
|
345
382
|
);
|
|
346
383
|
}
|
|
347
384
|
|
|
348
385
|
/**
|
|
349
386
|
* Get the list of supported languages
|
|
350
387
|
*
|
|
388
|
+
* @param {Object} opts Optional parameters
|
|
389
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
351
390
|
*/
|
|
352
|
-
getAssistantsAgentchecklistsLanguages() {
|
|
391
|
+
getAssistantsAgentchecklistsLanguages(opts) {
|
|
392
|
+
opts = opts || {};
|
|
393
|
+
|
|
353
394
|
|
|
354
395
|
return this.apiClient.callApi(
|
|
355
396
|
'/api/v2/assistants/agentchecklists/languages',
|
|
@@ -361,7 +402,8 @@ class AgentAssistantsApi {
|
|
|
361
402
|
null,
|
|
362
403
|
['PureCloud OAuth'],
|
|
363
404
|
['application/json'],
|
|
364
|
-
['application/json']
|
|
405
|
+
['application/json'],
|
|
406
|
+
opts['customHeaders']
|
|
365
407
|
);
|
|
366
408
|
}
|
|
367
409
|
|
|
@@ -374,6 +416,7 @@ class AgentAssistantsApi {
|
|
|
374
416
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
375
417
|
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be retrieved.
|
|
376
418
|
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
419
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
377
420
|
*/
|
|
378
421
|
getAssistantsQueues(opts) {
|
|
379
422
|
opts = opts || {};
|
|
@@ -389,7 +432,8 @@ class AgentAssistantsApi {
|
|
|
389
432
|
null,
|
|
390
433
|
['PureCloud OAuth'],
|
|
391
434
|
['application/json'],
|
|
392
|
-
['application/json']
|
|
435
|
+
['application/json'],
|
|
436
|
+
opts['customHeaders']
|
|
393
437
|
);
|
|
394
438
|
}
|
|
395
439
|
|
|
@@ -398,8 +442,12 @@ class AgentAssistantsApi {
|
|
|
398
442
|
*
|
|
399
443
|
* @param {String} assistantId Assistant ID
|
|
400
444
|
* @param {Object} body
|
|
445
|
+
* @param {Object} opts Optional parameters
|
|
446
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
401
447
|
*/
|
|
402
|
-
patchAssistant(assistantId, body) {
|
|
448
|
+
patchAssistant(assistantId, body, opts) {
|
|
449
|
+
opts = opts || {};
|
|
450
|
+
|
|
403
451
|
// verify the required parameter 'assistantId' is set
|
|
404
452
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
405
453
|
throw 'Missing the required parameter "assistantId" when calling patchAssistant';
|
|
@@ -419,7 +467,8 @@ class AgentAssistantsApi {
|
|
|
419
467
|
body,
|
|
420
468
|
['PureCloud OAuth'],
|
|
421
469
|
['application/json'],
|
|
422
|
-
['application/json']
|
|
470
|
+
['application/json'],
|
|
471
|
+
opts['customHeaders']
|
|
423
472
|
);
|
|
424
473
|
}
|
|
425
474
|
|
|
@@ -428,8 +477,12 @@ class AgentAssistantsApi {
|
|
|
428
477
|
*
|
|
429
478
|
* @param {String} assistantId Assistant ID
|
|
430
479
|
* @param {Array.<Object>} body
|
|
480
|
+
* @param {Object} opts Optional parameters
|
|
481
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
431
482
|
*/
|
|
432
|
-
patchAssistantQueues(assistantId, body) {
|
|
483
|
+
patchAssistantQueues(assistantId, body, opts) {
|
|
484
|
+
opts = opts || {};
|
|
485
|
+
|
|
433
486
|
// verify the required parameter 'assistantId' is set
|
|
434
487
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
435
488
|
throw 'Missing the required parameter "assistantId" when calling patchAssistantQueues';
|
|
@@ -449,7 +502,8 @@ class AgentAssistantsApi {
|
|
|
449
502
|
body,
|
|
450
503
|
['PureCloud OAuth'],
|
|
451
504
|
['application/json'],
|
|
452
|
-
['application/json']
|
|
505
|
+
['application/json'],
|
|
506
|
+
opts['customHeaders']
|
|
453
507
|
);
|
|
454
508
|
}
|
|
455
509
|
|
|
@@ -459,8 +513,12 @@ class AgentAssistantsApi {
|
|
|
459
513
|
* @param {String} assistantId Assistant ID
|
|
460
514
|
* @param {String} queueId Queue ID
|
|
461
515
|
* @param {Object} body
|
|
516
|
+
* @param {Object} opts Optional parameters
|
|
517
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
462
518
|
*/
|
|
463
|
-
postAssistantQueueUsersBulkAdd(assistantId, queueId, body) {
|
|
519
|
+
postAssistantQueueUsersBulkAdd(assistantId, queueId, body, opts) {
|
|
520
|
+
opts = opts || {};
|
|
521
|
+
|
|
464
522
|
// verify the required parameter 'assistantId' is set
|
|
465
523
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
466
524
|
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkAdd';
|
|
@@ -484,7 +542,8 @@ class AgentAssistantsApi {
|
|
|
484
542
|
body,
|
|
485
543
|
['PureCloud OAuth'],
|
|
486
544
|
['application/json'],
|
|
487
|
-
['application/json']
|
|
545
|
+
['application/json'],
|
|
546
|
+
opts['customHeaders']
|
|
488
547
|
);
|
|
489
548
|
}
|
|
490
549
|
|
|
@@ -494,8 +553,12 @@ class AgentAssistantsApi {
|
|
|
494
553
|
* @param {String} assistantId Assistant ID
|
|
495
554
|
* @param {String} queueId Queue ID
|
|
496
555
|
* @param {Object} body
|
|
556
|
+
* @param {Object} opts Optional parameters
|
|
557
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
497
558
|
*/
|
|
498
|
-
postAssistantQueueUsersBulkRemove(assistantId, queueId, body) {
|
|
559
|
+
postAssistantQueueUsersBulkRemove(assistantId, queueId, body, opts) {
|
|
560
|
+
opts = opts || {};
|
|
561
|
+
|
|
499
562
|
// verify the required parameter 'assistantId' is set
|
|
500
563
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
501
564
|
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersBulkRemove';
|
|
@@ -519,7 +582,8 @@ class AgentAssistantsApi {
|
|
|
519
582
|
body,
|
|
520
583
|
['PureCloud OAuth'],
|
|
521
584
|
['application/json'],
|
|
522
|
-
['application/json']
|
|
585
|
+
['application/json'],
|
|
586
|
+
opts['customHeaders']
|
|
523
587
|
);
|
|
524
588
|
}
|
|
525
589
|
|
|
@@ -529,8 +593,12 @@ class AgentAssistantsApi {
|
|
|
529
593
|
* @param {String} assistantId Assistant ID
|
|
530
594
|
* @param {String} queueId Queue ID
|
|
531
595
|
* @param {Object} body
|
|
596
|
+
* @param {Object} opts Optional parameters
|
|
597
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
532
598
|
*/
|
|
533
|
-
postAssistantQueueUsersJobs(assistantId, queueId, body) {
|
|
599
|
+
postAssistantQueueUsersJobs(assistantId, queueId, body, opts) {
|
|
600
|
+
opts = opts || {};
|
|
601
|
+
|
|
534
602
|
// verify the required parameter 'assistantId' is set
|
|
535
603
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
536
604
|
throw 'Missing the required parameter "assistantId" when calling postAssistantQueueUsersJobs';
|
|
@@ -554,7 +622,8 @@ class AgentAssistantsApi {
|
|
|
554
622
|
body,
|
|
555
623
|
['PureCloud OAuth'],
|
|
556
624
|
['application/json'],
|
|
557
|
-
['application/json']
|
|
625
|
+
['application/json'],
|
|
626
|
+
opts['customHeaders']
|
|
558
627
|
);
|
|
559
628
|
}
|
|
560
629
|
|
|
@@ -566,6 +635,7 @@ class AgentAssistantsApi {
|
|
|
566
635
|
* @param {Object} body
|
|
567
636
|
* @param {Object} opts Optional parameters
|
|
568
637
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand with.
|
|
638
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
569
639
|
*/
|
|
570
640
|
postAssistantQueueUsersQuery(assistantId, queueId, body, opts) {
|
|
571
641
|
opts = opts || {};
|
|
@@ -593,7 +663,8 @@ class AgentAssistantsApi {
|
|
|
593
663
|
body,
|
|
594
664
|
['PureCloud OAuth'],
|
|
595
665
|
['application/json'],
|
|
596
|
-
['application/json']
|
|
666
|
+
['application/json'],
|
|
667
|
+
opts['customHeaders']
|
|
597
668
|
);
|
|
598
669
|
}
|
|
599
670
|
|
|
@@ -601,8 +672,12 @@ class AgentAssistantsApi {
|
|
|
601
672
|
* Create an Assistant.
|
|
602
673
|
*
|
|
603
674
|
* @param {Object} body
|
|
675
|
+
* @param {Object} opts Optional parameters
|
|
676
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
604
677
|
*/
|
|
605
|
-
postAssistants(body) {
|
|
678
|
+
postAssistants(body, opts) {
|
|
679
|
+
opts = opts || {};
|
|
680
|
+
|
|
606
681
|
// verify the required parameter 'body' is set
|
|
607
682
|
if (body === undefined || body === null) {
|
|
608
683
|
throw 'Missing the required parameter "body" when calling postAssistants';
|
|
@@ -618,7 +693,8 @@ class AgentAssistantsApi {
|
|
|
618
693
|
body,
|
|
619
694
|
['PureCloud OAuth'],
|
|
620
695
|
['application/json'],
|
|
621
|
-
['application/json']
|
|
696
|
+
['application/json'],
|
|
697
|
+
opts['customHeaders']
|
|
622
698
|
);
|
|
623
699
|
}
|
|
624
700
|
|
|
@@ -626,8 +702,12 @@ class AgentAssistantsApi {
|
|
|
626
702
|
* Create an agent checklist
|
|
627
703
|
*
|
|
628
704
|
* @param {Object} body Request body containing details of checklist to be added
|
|
705
|
+
* @param {Object} opts Optional parameters
|
|
706
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
629
707
|
*/
|
|
630
|
-
postAssistantsAgentchecklists(body) {
|
|
708
|
+
postAssistantsAgentchecklists(body, opts) {
|
|
709
|
+
opts = opts || {};
|
|
710
|
+
|
|
631
711
|
// verify the required parameter 'body' is set
|
|
632
712
|
if (body === undefined || body === null) {
|
|
633
713
|
throw 'Missing the required parameter "body" when calling postAssistantsAgentchecklists';
|
|
@@ -643,7 +723,8 @@ class AgentAssistantsApi {
|
|
|
643
723
|
body,
|
|
644
724
|
['PureCloud OAuth'],
|
|
645
725
|
['application/json'],
|
|
646
|
-
['application/json']
|
|
726
|
+
['application/json'],
|
|
727
|
+
opts['customHeaders']
|
|
647
728
|
);
|
|
648
729
|
}
|
|
649
730
|
|
|
@@ -653,8 +734,12 @@ class AgentAssistantsApi {
|
|
|
653
734
|
* @param {String} assistantId Assistant ID
|
|
654
735
|
* @param {String} queueId Queue ID
|
|
655
736
|
* @param {Object} body
|
|
737
|
+
* @param {Object} opts Optional parameters
|
|
738
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
656
739
|
*/
|
|
657
|
-
putAssistantQueue(assistantId, queueId, body) {
|
|
740
|
+
putAssistantQueue(assistantId, queueId, body, opts) {
|
|
741
|
+
opts = opts || {};
|
|
742
|
+
|
|
658
743
|
// verify the required parameter 'assistantId' is set
|
|
659
744
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
660
745
|
throw 'Missing the required parameter "assistantId" when calling putAssistantQueue';
|
|
@@ -678,7 +763,8 @@ class AgentAssistantsApi {
|
|
|
678
763
|
body,
|
|
679
764
|
['PureCloud OAuth'],
|
|
680
765
|
['application/json'],
|
|
681
|
-
['application/json']
|
|
766
|
+
['application/json'],
|
|
767
|
+
opts['customHeaders']
|
|
682
768
|
);
|
|
683
769
|
}
|
|
684
770
|
|
|
@@ -687,8 +773,12 @@ class AgentAssistantsApi {
|
|
|
687
773
|
*
|
|
688
774
|
* @param {String} agentChecklistId Agent Checklist ID
|
|
689
775
|
* @param {Object} body Request body containing details of checklist to be updated
|
|
776
|
+
* @param {Object} opts Optional parameters
|
|
777
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
690
778
|
*/
|
|
691
|
-
putAssistantsAgentchecklist(agentChecklistId, body) {
|
|
779
|
+
putAssistantsAgentchecklist(agentChecklistId, body, opts) {
|
|
780
|
+
opts = opts || {};
|
|
781
|
+
|
|
692
782
|
// verify the required parameter 'agentChecklistId' is set
|
|
693
783
|
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
694
784
|
throw 'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';
|
|
@@ -708,7 +798,8 @@ class AgentAssistantsApi {
|
|
|
708
798
|
body,
|
|
709
799
|
['PureCloud OAuth'],
|
|
710
800
|
['application/json'],
|
|
711
|
-
['application/json']
|
|
801
|
+
['application/json'],
|
|
802
|
+
opts['customHeaders']
|
|
712
803
|
);
|
|
713
804
|
}
|
|
714
805
|
|
|
@@ -5,7 +5,7 @@ class AgentCopilotApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AgentCopilot service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class AgentCopilotApi {
|
|
|
24
24
|
* Get copilot configuration of an assistant.
|
|
25
25
|
*
|
|
26
26
|
* @param {String} assistantId Assistant ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
getAssistantCopilot(assistantId) {
|
|
30
|
+
getAssistantCopilot(assistantId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'assistantId' is set
|
|
30
34
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
31
35
|
throw 'Missing the required parameter "assistantId" when calling getAssistantCopilot';
|
|
@@ -41,7 +45,8 @@ class AgentCopilotApi {
|
|
|
41
45
|
null,
|
|
42
46
|
['PureCloud OAuth'],
|
|
43
47
|
['application/json'],
|
|
44
|
-
['application/json']
|
|
48
|
+
['application/json'],
|
|
49
|
+
opts['customHeaders']
|
|
45
50
|
);
|
|
46
51
|
}
|
|
47
52
|
|
|
@@ -50,6 +55,7 @@ class AgentCopilotApi {
|
|
|
50
55
|
*
|
|
51
56
|
* @param {Object} opts Optional parameters
|
|
52
57
|
* @param {String} opts.language Which language are the features supported for
|
|
58
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
59
|
*/
|
|
54
60
|
getAssistantsCopilotFeaturesupport(opts) {
|
|
55
61
|
opts = opts || {};
|
|
@@ -65,7 +71,8 @@ class AgentCopilotApi {
|
|
|
65
71
|
null,
|
|
66
72
|
['PureCloud OAuth'],
|
|
67
73
|
['application/json'],
|
|
68
|
-
['application/json']
|
|
74
|
+
['application/json'],
|
|
75
|
+
opts['customHeaders']
|
|
69
76
|
);
|
|
70
77
|
}
|
|
71
78
|
|
|
@@ -74,8 +81,12 @@ class AgentCopilotApi {
|
|
|
74
81
|
*
|
|
75
82
|
* @param {String} assistantId Assistant ID
|
|
76
83
|
* @param {Object} body
|
|
84
|
+
* @param {Object} opts Optional parameters
|
|
85
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
77
86
|
*/
|
|
78
|
-
putAssistantCopilot(assistantId, body) {
|
|
87
|
+
putAssistantCopilot(assistantId, body, opts) {
|
|
88
|
+
opts = opts || {};
|
|
89
|
+
|
|
79
90
|
// verify the required parameter 'assistantId' is set
|
|
80
91
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
81
92
|
throw 'Missing the required parameter "assistantId" when calling putAssistantCopilot';
|
|
@@ -95,7 +106,8 @@ class AgentCopilotApi {
|
|
|
95
106
|
body,
|
|
96
107
|
['PureCloud OAuth'],
|
|
97
108
|
['application/json'],
|
|
98
|
-
['application/json']
|
|
109
|
+
['application/json'],
|
|
110
|
+
opts['customHeaders']
|
|
99
111
|
);
|
|
100
112
|
}
|
|
101
113
|
|
|
@@ -5,7 +5,7 @@ class AgentUIApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AgentUI service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class AgentUIApi {
|
|
|
24
24
|
* Delete agent auto answer settings
|
|
25
25
|
*
|
|
26
26
|
* @param {String} agentId The agent to apply the auto answer settings to
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
30
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'agentId' is set
|
|
30
34
|
if (agentId === undefined || agentId === null || agentId === '') {
|
|
31
35
|
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
@@ -41,7 +45,8 @@ class AgentUIApi {
|
|
|
41
45
|
null,
|
|
42
46
|
['PureCloud OAuth'],
|
|
43
47
|
['application/json'],
|
|
44
|
-
['application/json']
|
|
48
|
+
['application/json'],
|
|
49
|
+
opts['customHeaders']
|
|
45
50
|
);
|
|
46
51
|
}
|
|
47
52
|
|
|
@@ -49,8 +54,12 @@ class AgentUIApi {
|
|
|
49
54
|
* Get agent auto answer settings
|
|
50
55
|
*
|
|
51
56
|
* @param {String} agentId The agent to apply the auto answer settings to
|
|
57
|
+
* @param {Object} opts Optional parameters
|
|
58
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
52
59
|
*/
|
|
53
|
-
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
60
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, opts) {
|
|
61
|
+
opts = opts || {};
|
|
62
|
+
|
|
54
63
|
// verify the required parameter 'agentId' is set
|
|
55
64
|
if (agentId === undefined || agentId === null || agentId === '') {
|
|
56
65
|
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
@@ -66,7 +75,8 @@ class AgentUIApi {
|
|
|
66
75
|
null,
|
|
67
76
|
['PureCloud OAuth'],
|
|
68
77
|
['application/json'],
|
|
69
|
-
['application/json']
|
|
78
|
+
['application/json'],
|
|
79
|
+
opts['customHeaders']
|
|
70
80
|
);
|
|
71
81
|
}
|
|
72
82
|
|
|
@@ -75,8 +85,12 @@ class AgentUIApi {
|
|
|
75
85
|
*
|
|
76
86
|
* @param {String} agentId The agent to apply the auto answer settings to
|
|
77
87
|
* @param {Object} body AutoAnswerSettings
|
|
88
|
+
* @param {Object} opts Optional parameters
|
|
89
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78
90
|
*/
|
|
79
|
-
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
91
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body, opts) {
|
|
92
|
+
opts = opts || {};
|
|
93
|
+
|
|
80
94
|
// verify the required parameter 'agentId' is set
|
|
81
95
|
if (agentId === undefined || agentId === null || agentId === '') {
|
|
82
96
|
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
@@ -96,7 +110,8 @@ class AgentUIApi {
|
|
|
96
110
|
body,
|
|
97
111
|
['PureCloud OAuth'],
|
|
98
112
|
['application/json'],
|
|
99
|
-
['application/json']
|
|
113
|
+
['application/json'],
|
|
114
|
+
opts['customHeaders']
|
|
100
115
|
);
|
|
101
116
|
}
|
|
102
117
|
|
|
@@ -105,8 +120,12 @@ class AgentUIApi {
|
|
|
105
120
|
*
|
|
106
121
|
* @param {String} agentId The agent to apply the auto answer settings to
|
|
107
122
|
* @param {Object} body AutoAnswerSettings
|
|
123
|
+
* @param {Object} opts Optional parameters
|
|
124
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108
125
|
*/
|
|
109
|
-
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
126
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body, opts) {
|
|
127
|
+
opts = opts || {};
|
|
128
|
+
|
|
110
129
|
// verify the required parameter 'agentId' is set
|
|
111
130
|
if (agentId === undefined || agentId === null || agentId === '') {
|
|
112
131
|
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
@@ -126,7 +145,8 @@ class AgentUIApi {
|
|
|
126
145
|
body,
|
|
127
146
|
['PureCloud OAuth'],
|
|
128
147
|
['application/json'],
|
|
129
|
-
['application/json']
|
|
148
|
+
['application/json'],
|
|
149
|
+
opts['customHeaders']
|
|
130
150
|
);
|
|
131
151
|
}
|
|
132
152
|
|