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.
Files changed (97) hide show
  1. package/README.md +34 -3
  2. package/dist/node/purecloud-platform-client-v2.js +20042 -5569
  3. package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +11159 -5369
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +10600 -2242
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
  21. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
  72. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
  73. package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
  74. package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
  75. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
  76. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
  77. package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
  78. package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
  79. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
  80. package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
  81. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
  82. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
  83. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
  84. package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
  85. package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
  86. package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
  87. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
  88. package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
  89. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
  90. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
  91. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
  92. package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
  93. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
  94. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
  95. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
  96. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
  97. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class AlertingApi {
24
24
  * Delete an alert
25
25
  *
26
26
  * @param {String} alertId Alert ID
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteAlertingAlert(alertId) {
30
+ deleteAlertingAlert(alertId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'alertId' is set
30
34
  if (alertId === undefined || alertId === null || alertId === '') {
31
35
  throw 'Missing the required parameter "alertId" when calling deleteAlertingAlert';
@@ -41,15 +45,20 @@ class AlertingApi {
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
 
48
53
  /**
49
54
  * Delete all alerts for the user
50
55
  *
56
+ * @param {Object} opts Optional parameters
57
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
51
58
  */
52
- deleteAlertingAlertsAll() {
59
+ deleteAlertingAlertsAll(opts) {
60
+ opts = opts || {};
61
+
53
62
 
54
63
  return this.apiClient.callApi(
55
64
  '/api/v2/alerting/alerts/all',
@@ -61,7 +70,8 @@ class AlertingApi {
61
70
  null,
62
71
  ['PureCloud OAuth'],
63
72
  ['application/json'],
64
- ['application/json']
73
+ ['application/json'],
74
+ opts['customHeaders']
65
75
  );
66
76
  }
67
77
 
@@ -69,8 +79,12 @@ class AlertingApi {
69
79
  * Delete a rule.
70
80
  *
71
81
  * @param {String} ruleId Rule Id
82
+ * @param {Object} opts Optional parameters
83
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
72
84
  */
73
- deleteAlertingRule(ruleId) {
85
+ deleteAlertingRule(ruleId, opts) {
86
+ opts = opts || {};
87
+
74
88
  // verify the required parameter 'ruleId' is set
75
89
  if (ruleId === undefined || ruleId === null || ruleId === '') {
76
90
  throw 'Missing the required parameter "ruleId" when calling deleteAlertingRule';
@@ -86,7 +100,8 @@ class AlertingApi {
86
100
  null,
87
101
  ['PureCloud OAuth'],
88
102
  ['application/json'],
89
- ['application/json']
103
+ ['application/json'],
104
+ opts['customHeaders']
90
105
  );
91
106
  }
92
107
 
@@ -94,8 +109,12 @@ class AlertingApi {
94
109
  * Get an alert
95
110
  *
96
111
  * @param {String} alertId Alert ID
112
+ * @param {Object} opts Optional parameters
113
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
97
114
  */
98
- getAlertingAlert(alertId) {
115
+ getAlertingAlert(alertId, opts) {
116
+ opts = opts || {};
117
+
99
118
  // verify the required parameter 'alertId' is set
100
119
  if (alertId === undefined || alertId === null || alertId === '') {
101
120
  throw 'Missing the required parameter "alertId" when calling getAlertingAlert';
@@ -111,7 +130,8 @@ class AlertingApi {
111
130
  null,
112
131
  ['PureCloud OAuth'],
113
132
  ['application/json'],
114
- ['application/json']
133
+ ['application/json'],
134
+ opts['customHeaders']
115
135
  );
116
136
  }
117
137
 
@@ -119,8 +139,12 @@ class AlertingApi {
119
139
  * Get a rule.
120
140
  *
121
141
  * @param {String} ruleId Rule Id
142
+ * @param {Object} opts Optional parameters
143
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
122
144
  */
123
- getAlertingRule(ruleId) {
145
+ getAlertingRule(ruleId, opts) {
146
+ opts = opts || {};
147
+
124
148
  // verify the required parameter 'ruleId' is set
125
149
  if (ruleId === undefined || ruleId === null || ruleId === '') {
126
150
  throw 'Missing the required parameter "ruleId" when calling getAlertingRule';
@@ -136,7 +160,8 @@ class AlertingApi {
136
160
  null,
137
161
  ['PureCloud OAuth'],
138
162
  ['application/json'],
139
- ['application/json']
163
+ ['application/json'],
164
+ opts['customHeaders']
140
165
  );
141
166
  }
142
167
 
@@ -146,6 +171,7 @@ class AlertingApi {
146
171
  * @param {String} alertId Alert ID
147
172
  * @param {Object} opts Optional parameters
148
173
  * @param {Object} opts.body
174
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
149
175
  */
150
176
  patchAlertingAlert(alertId, opts) {
151
177
  opts = opts || {};
@@ -165,7 +191,8 @@ class AlertingApi {
165
191
  opts['body'],
166
192
  ['PureCloud OAuth'],
167
193
  ['application/json'],
168
- ['application/json']
194
+ ['application/json'],
195
+ opts['customHeaders']
169
196
  );
170
197
  }
171
198
 
@@ -174,6 +201,7 @@ class AlertingApi {
174
201
  *
175
202
  * @param {Object} opts Optional parameters
176
203
  * @param {Object} opts.body
204
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
177
205
  */
178
206
  patchAlertingAlertsAll(opts) {
179
207
  opts = opts || {};
@@ -189,7 +217,8 @@ class AlertingApi {
189
217
  opts['body'],
190
218
  ['PureCloud OAuth'],
191
219
  ['application/json'],
192
- ['application/json']
220
+ ['application/json'],
221
+ opts['customHeaders']
193
222
  );
194
223
  }
195
224
 
@@ -197,8 +226,12 @@ class AlertingApi {
197
226
  * Bulk alert updates
198
227
  *
199
228
  * @param {Object} body
229
+ * @param {Object} opts Optional parameters
230
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
200
231
  */
201
- patchAlertingAlertsBulk(body) {
232
+ patchAlertingAlertsBulk(body, opts) {
233
+ opts = opts || {};
234
+
202
235
  // verify the required parameter 'body' is set
203
236
  if (body === undefined || body === null) {
204
237
  throw 'Missing the required parameter "body" when calling patchAlertingAlertsBulk';
@@ -214,7 +247,8 @@ class AlertingApi {
214
247
  body,
215
248
  ['PureCloud OAuth'],
216
249
  ['application/json'],
217
- ['application/json']
250
+ ['application/json'],
251
+ opts['customHeaders']
218
252
  );
219
253
  }
220
254
 
@@ -222,8 +256,12 @@ class AlertingApi {
222
256
  * Bulk update of notification lists
223
257
  *
224
258
  * @param {Object} body
259
+ * @param {Object} opts Optional parameters
260
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
225
261
  */
226
- patchAlertingRulesBulk(body) {
262
+ patchAlertingRulesBulk(body, opts) {
263
+ opts = opts || {};
264
+
227
265
  // verify the required parameter 'body' is set
228
266
  if (body === undefined || body === null) {
229
267
  throw 'Missing the required parameter "body" when calling patchAlertingRulesBulk';
@@ -239,7 +277,8 @@ class AlertingApi {
239
277
  body,
240
278
  ['PureCloud OAuth'],
241
279
  ['application/json'],
242
- ['application/json']
280
+ ['application/json'],
281
+ opts['customHeaders']
243
282
  );
244
283
  }
245
284
 
@@ -248,6 +287,7 @@ class AlertingApi {
248
287
  *
249
288
  * @param {Object} opts Optional parameters
250
289
  * @param {Object} opts.body
290
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
251
291
  */
252
292
  postAlertingAlertsQuery(opts) {
253
293
  opts = opts || {};
@@ -263,7 +303,8 @@ class AlertingApi {
263
303
  opts['body'],
264
304
  ['PureCloud OAuth'],
265
305
  ['application/json'],
266
- ['application/json']
306
+ ['application/json'],
307
+ opts['customHeaders']
267
308
  );
268
309
  }
269
310
 
@@ -271,8 +312,12 @@ class AlertingApi {
271
312
  * Create a Rule.
272
313
  *
273
314
  * @param {Object} body rule to be created
315
+ * @param {Object} opts Optional parameters
316
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
274
317
  */
275
- postAlertingRules(body) {
318
+ postAlertingRules(body, opts) {
319
+ opts = opts || {};
320
+
276
321
  // verify the required parameter 'body' is set
277
322
  if (body === undefined || body === null) {
278
323
  throw 'Missing the required parameter "body" when calling postAlertingRules';
@@ -288,7 +333,8 @@ class AlertingApi {
288
333
  body,
289
334
  ['PureCloud OAuth'],
290
335
  ['application/json'],
291
- ['application/json']
336
+ ['application/json'],
337
+ opts['customHeaders']
292
338
  );
293
339
  }
294
340
 
@@ -296,8 +342,12 @@ class AlertingApi {
296
342
  * Bulk remove rules
297
343
  *
298
344
  * @param {Object} body
345
+ * @param {Object} opts Optional parameters
346
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
299
347
  */
300
- postAlertingRulesBulkRemove(body) {
348
+ postAlertingRulesBulkRemove(body, opts) {
349
+ opts = opts || {};
350
+
301
351
  // verify the required parameter 'body' is set
302
352
  if (body === undefined || body === null) {
303
353
  throw 'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';
@@ -313,7 +363,8 @@ class AlertingApi {
313
363
  body,
314
364
  ['PureCloud OAuth'],
315
365
  ['application/json'],
316
- ['application/json']
366
+ ['application/json'],
367
+ opts['customHeaders']
317
368
  );
318
369
  }
319
370
 
@@ -322,6 +373,7 @@ class AlertingApi {
322
373
  *
323
374
  * @param {Object} opts Optional parameters
324
375
  * @param {Object} opts.body
376
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
325
377
  */
326
378
  postAlertingRulesQuery(opts) {
327
379
  opts = opts || {};
@@ -337,7 +389,8 @@ class AlertingApi {
337
389
  opts['body'],
338
390
  ['PureCloud OAuth'],
339
391
  ['application/json'],
340
- ['application/json']
392
+ ['application/json'],
393
+ opts['customHeaders']
341
394
  );
342
395
  }
343
396
 
@@ -347,6 +400,7 @@ class AlertingApi {
347
400
  * @param {String} alertId Alert ID
348
401
  * @param {Object} opts Optional parameters
349
402
  * @param {Object} opts.body
403
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
350
404
  */
351
405
  putAlertingAlert(alertId, opts) {
352
406
  opts = opts || {};
@@ -366,7 +420,8 @@ class AlertingApi {
366
420
  opts['body'],
367
421
  ['PureCloud OAuth'],
368
422
  ['application/json'],
369
- ['application/json']
423
+ ['application/json'],
424
+ opts['customHeaders']
370
425
  );
371
426
  }
372
427
 
@@ -375,8 +430,12 @@ class AlertingApi {
375
430
  *
376
431
  * @param {String} ruleId Rule Id
377
432
  * @param {Object} body rule to be updated
433
+ * @param {Object} opts Optional parameters
434
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
378
435
  */
379
- putAlertingRule(ruleId, body) {
436
+ putAlertingRule(ruleId, body, opts) {
437
+ opts = opts || {};
438
+
380
439
  // verify the required parameter 'ruleId' is set
381
440
  if (ruleId === undefined || ruleId === null || ruleId === '') {
382
441
  throw 'Missing the required parameter "ruleId" when calling putAlertingRule';
@@ -396,7 +455,8 @@ class AlertingApi {
396
455
  body,
397
456
  ['PureCloud OAuth'],
398
457
  ['application/json'],
399
- ['application/json']
458
+ ['application/json'],
459
+ opts['customHeaders']
400
460
  );
401
461
  }
402
462