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 ScriptsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Scripts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,8 +24,12 @@ class ScriptsApi {
|
|
|
24
24
|
* Get a script
|
|
25
25
|
*
|
|
26
26
|
* @param {String} scriptId Script ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
*/
|
|
28
|
-
getScript(scriptId) {
|
|
30
|
+
getScript(scriptId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
29
33
|
// verify the required parameter 'scriptId' is set
|
|
30
34
|
if (scriptId === undefined || scriptId === null || scriptId === '') {
|
|
31
35
|
throw 'Missing the required parameter "scriptId" when calling getScript';
|
|
@@ -41,7 +45,8 @@ class ScriptsApi {
|
|
|
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
|
|
|
@@ -52,6 +57,7 @@ class ScriptsApi {
|
|
|
52
57
|
* @param {String} pageId Page ID
|
|
53
58
|
* @param {Object} opts Optional parameters
|
|
54
59
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
60
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
55
61
|
*/
|
|
56
62
|
getScriptPage(scriptId, pageId, opts) {
|
|
57
63
|
opts = opts || {};
|
|
@@ -75,7 +81,8 @@ class ScriptsApi {
|
|
|
75
81
|
null,
|
|
76
82
|
['PureCloud OAuth'],
|
|
77
83
|
['application/json'],
|
|
78
|
-
['application/json']
|
|
84
|
+
['application/json'],
|
|
85
|
+
opts['customHeaders']
|
|
79
86
|
);
|
|
80
87
|
}
|
|
81
88
|
|
|
@@ -85,6 +92,7 @@ class ScriptsApi {
|
|
|
85
92
|
* @param {String} scriptId Script ID
|
|
86
93
|
* @param {Object} opts Optional parameters
|
|
87
94
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
95
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
88
96
|
*/
|
|
89
97
|
getScriptPages(scriptId, opts) {
|
|
90
98
|
opts = opts || {};
|
|
@@ -104,7 +112,8 @@ class ScriptsApi {
|
|
|
104
112
|
null,
|
|
105
113
|
['PureCloud OAuth'],
|
|
106
114
|
['application/json'],
|
|
107
|
-
['application/json']
|
|
115
|
+
['application/json'],
|
|
116
|
+
opts['customHeaders']
|
|
108
117
|
);
|
|
109
118
|
}
|
|
110
119
|
|
|
@@ -122,6 +131,7 @@ class ScriptsApi {
|
|
|
122
131
|
* @param {Object} opts.sortOrder SortOrder
|
|
123
132
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
124
133
|
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
134
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
125
135
|
*/
|
|
126
136
|
getScripts(opts) {
|
|
127
137
|
opts = opts || {};
|
|
@@ -137,7 +147,8 @@ class ScriptsApi {
|
|
|
137
147
|
null,
|
|
138
148
|
['PureCloud OAuth'],
|
|
139
149
|
['application/json'],
|
|
140
|
-
['application/json']
|
|
150
|
+
['application/json'],
|
|
151
|
+
opts['customHeaders']
|
|
141
152
|
);
|
|
142
153
|
}
|
|
143
154
|
|
|
@@ -155,6 +166,7 @@ class ScriptsApi {
|
|
|
155
166
|
* @param {Object} opts.sortOrder SortOrder
|
|
156
167
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
157
168
|
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
169
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
158
170
|
*/
|
|
159
171
|
getScriptsDivisionviews(opts) {
|
|
160
172
|
opts = opts || {};
|
|
@@ -170,7 +182,8 @@ class ScriptsApi {
|
|
|
170
182
|
null,
|
|
171
183
|
['PureCloud OAuth'],
|
|
172
184
|
['application/json'],
|
|
173
|
-
['application/json']
|
|
185
|
+
['application/json'],
|
|
186
|
+
opts['customHeaders']
|
|
174
187
|
);
|
|
175
188
|
}
|
|
176
189
|
|
|
@@ -186,6 +199,7 @@ class ScriptsApi {
|
|
|
186
199
|
* @param {String} opts.flowId Secure flow id filter
|
|
187
200
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
188
201
|
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
202
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
189
203
|
*/
|
|
190
204
|
getScriptsPublished(opts) {
|
|
191
205
|
opts = opts || {};
|
|
@@ -201,7 +215,8 @@ class ScriptsApi {
|
|
|
201
215
|
null,
|
|
202
216
|
['PureCloud OAuth'],
|
|
203
217
|
['application/json'],
|
|
204
|
-
['application/json']
|
|
218
|
+
['application/json'],
|
|
219
|
+
opts['customHeaders']
|
|
205
220
|
);
|
|
206
221
|
}
|
|
207
222
|
|
|
@@ -214,6 +229,7 @@ class ScriptsApi {
|
|
|
214
229
|
* @param {Object} opts.output output
|
|
215
230
|
* @param {Object} opts.type type
|
|
216
231
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
232
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
217
233
|
*/
|
|
218
234
|
getScriptsPublishedDivisionviewVariables(scriptId, opts) {
|
|
219
235
|
opts = opts || {};
|
|
@@ -233,7 +249,8 @@ class ScriptsApi {
|
|
|
233
249
|
null,
|
|
234
250
|
['PureCloud OAuth'],
|
|
235
251
|
['application/json'],
|
|
236
|
-
['application/json']
|
|
252
|
+
['application/json'],
|
|
253
|
+
opts['customHeaders']
|
|
237
254
|
);
|
|
238
255
|
}
|
|
239
256
|
|
|
@@ -249,6 +266,7 @@ class ScriptsApi {
|
|
|
249
266
|
* @param {String} opts.flowId Secure flow id filter
|
|
250
267
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
251
268
|
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
269
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
252
270
|
*/
|
|
253
271
|
getScriptsPublishedDivisionviews(opts) {
|
|
254
272
|
opts = opts || {};
|
|
@@ -264,7 +282,8 @@ class ScriptsApi {
|
|
|
264
282
|
null,
|
|
265
283
|
['PureCloud OAuth'],
|
|
266
284
|
['application/json'],
|
|
267
|
-
['application/json']
|
|
285
|
+
['application/json'],
|
|
286
|
+
opts['customHeaders']
|
|
268
287
|
);
|
|
269
288
|
}
|
|
270
289
|
|
|
@@ -274,6 +293,7 @@ class ScriptsApi {
|
|
|
274
293
|
* @param {String} scriptId Script ID
|
|
275
294
|
* @param {Object} opts Optional parameters
|
|
276
295
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
296
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
277
297
|
*/
|
|
278
298
|
getScriptsPublishedScriptId(scriptId, opts) {
|
|
279
299
|
opts = opts || {};
|
|
@@ -293,7 +313,8 @@ class ScriptsApi {
|
|
|
293
313
|
null,
|
|
294
314
|
['PureCloud OAuth'],
|
|
295
315
|
['application/json'],
|
|
296
|
-
['application/json']
|
|
316
|
+
['application/json'],
|
|
317
|
+
opts['customHeaders']
|
|
297
318
|
);
|
|
298
319
|
}
|
|
299
320
|
|
|
@@ -304,6 +325,7 @@ class ScriptsApi {
|
|
|
304
325
|
* @param {String} pageId Page ID
|
|
305
326
|
* @param {Object} opts Optional parameters
|
|
306
327
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
328
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
307
329
|
*/
|
|
308
330
|
getScriptsPublishedScriptIdPage(scriptId, pageId, opts) {
|
|
309
331
|
opts = opts || {};
|
|
@@ -327,7 +349,8 @@ class ScriptsApi {
|
|
|
327
349
|
null,
|
|
328
350
|
['PureCloud OAuth'],
|
|
329
351
|
['application/json'],
|
|
330
|
-
['application/json']
|
|
352
|
+
['application/json'],
|
|
353
|
+
opts['customHeaders']
|
|
331
354
|
);
|
|
332
355
|
}
|
|
333
356
|
|
|
@@ -337,6 +360,7 @@ class ScriptsApi {
|
|
|
337
360
|
* @param {String} scriptId Script ID
|
|
338
361
|
* @param {Object} opts Optional parameters
|
|
339
362
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
363
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
340
364
|
*/
|
|
341
365
|
getScriptsPublishedScriptIdPages(scriptId, opts) {
|
|
342
366
|
opts = opts || {};
|
|
@@ -356,7 +380,8 @@ class ScriptsApi {
|
|
|
356
380
|
null,
|
|
357
381
|
['PureCloud OAuth'],
|
|
358
382
|
['application/json'],
|
|
359
|
-
['application/json']
|
|
383
|
+
['application/json'],
|
|
384
|
+
opts['customHeaders']
|
|
360
385
|
);
|
|
361
386
|
}
|
|
362
387
|
|
|
@@ -369,6 +394,7 @@ class ScriptsApi {
|
|
|
369
394
|
* @param {Object} opts.output output
|
|
370
395
|
* @param {Object} opts.type type
|
|
371
396
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
397
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
372
398
|
*/
|
|
373
399
|
getScriptsPublishedScriptIdVariables(scriptId, opts) {
|
|
374
400
|
opts = opts || {};
|
|
@@ -388,7 +414,8 @@ class ScriptsApi {
|
|
|
388
414
|
null,
|
|
389
415
|
['PureCloud OAuth'],
|
|
390
416
|
['application/json'],
|
|
391
|
-
['application/json']
|
|
417
|
+
['application/json'],
|
|
418
|
+
opts['customHeaders']
|
|
392
419
|
);
|
|
393
420
|
}
|
|
394
421
|
|
|
@@ -398,6 +425,7 @@ class ScriptsApi {
|
|
|
398
425
|
* @param {String} uploadId Upload ID
|
|
399
426
|
* @param {Object} opts Optional parameters
|
|
400
427
|
* @param {Boolean} opts.longPoll Enable longPolling endpoint (default to false)
|
|
428
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
401
429
|
*/
|
|
402
430
|
getScriptsUploadStatus(uploadId, opts) {
|
|
403
431
|
opts = opts || {};
|
|
@@ -417,7 +445,8 @@ class ScriptsApi {
|
|
|
417
445
|
null,
|
|
418
446
|
['PureCloud OAuth'],
|
|
419
447
|
['application/json'],
|
|
420
|
-
['application/json']
|
|
448
|
+
['application/json'],
|
|
449
|
+
opts['customHeaders']
|
|
421
450
|
);
|
|
422
451
|
}
|
|
423
452
|
|
|
@@ -427,6 +456,7 @@ class ScriptsApi {
|
|
|
427
456
|
* @param {String} scriptId Script ID
|
|
428
457
|
* @param {Object} opts Optional parameters
|
|
429
458
|
* @param {Object} opts.body
|
|
459
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
430
460
|
*/
|
|
431
461
|
postScriptExport(scriptId, opts) {
|
|
432
462
|
opts = opts || {};
|
|
@@ -446,7 +476,8 @@ class ScriptsApi {
|
|
|
446
476
|
opts['body'],
|
|
447
477
|
['PureCloud OAuth'],
|
|
448
478
|
['application/json'],
|
|
449
|
-
['application/json']
|
|
479
|
+
['application/json'],
|
|
480
|
+
opts['customHeaders']
|
|
450
481
|
);
|
|
451
482
|
}
|
|
452
483
|
|
|
@@ -456,6 +487,7 @@ class ScriptsApi {
|
|
|
456
487
|
* @param {Object} opts Optional parameters
|
|
457
488
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
458
489
|
* @param {Object} opts.body body
|
|
490
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
459
491
|
*/
|
|
460
492
|
postScriptsPublished(opts) {
|
|
461
493
|
opts = opts || {};
|
|
@@ -471,7 +503,8 @@ class ScriptsApi {
|
|
|
471
503
|
opts['body'],
|
|
472
504
|
['PureCloud OAuth'],
|
|
473
505
|
['application/json'],
|
|
474
|
-
['application/json']
|
|
506
|
+
['application/json'],
|
|
507
|
+
opts['customHeaders']
|
|
475
508
|
);
|
|
476
509
|
}
|
|
477
510
|
|