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 IntentsApi {
5
5
  /**
6
6
  * Intents service.
7
7
  * @module purecloud-platform-client-v2/api/IntentsApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class IntentsApi {
24
24
  * Delete category for categoryId
25
25
  *
26
26
  * @param {String} categoryId Category id
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteIntentsCategory(categoryId) {
30
+ deleteIntentsCategory(categoryId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'categoryId' is set
30
34
  if (categoryId === undefined || categoryId === null || categoryId === '') {
31
35
  throw 'Missing the required parameter "categoryId" when calling deleteIntentsCategory';
@@ -41,7 +45,8 @@ class IntentsApi {
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 IntentsApi {
49
54
  * Delete customer intent for customerIntentId
50
55
  *
51
56
  * @param {String} customerIntentId Customer Intent id
57
+ * @param {Object} opts Optional parameters
58
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
52
59
  */
53
- deleteIntentsCustomerintent(customerIntentId) {
60
+ deleteIntentsCustomerintent(customerIntentId, opts) {
61
+ opts = opts || {};
62
+
54
63
  // verify the required parameter 'customerIntentId' is set
55
64
  if (customerIntentId === undefined || customerIntentId === null || customerIntentId === '') {
56
65
  throw 'Missing the required parameter "customerIntentId" when calling deleteIntentsCustomerintent';
@@ -66,7 +75,8 @@ class IntentsApi {
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
 
@@ -77,6 +87,7 @@ class IntentsApi {
77
87
  * @param {Object} opts Optional parameters
78
88
  * @param {Number} opts.pageSize The total page size requested (default to 25)
79
89
  * @param {Number} opts.pageNumber The page number requested (default to 1)
90
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
80
91
  */
81
92
  getIntentsAssignmentsExternalcontact(externalContactId, opts) {
82
93
  opts = opts || {};
@@ -96,7 +107,8 @@ class IntentsApi {
96
107
  null,
97
108
  ['PureCloud OAuth'],
98
109
  ['application/json'],
99
- ['application/json']
110
+ ['application/json'],
111
+ opts['customHeaders']
100
112
  );
101
113
  }
102
114
 
@@ -107,6 +119,7 @@ class IntentsApi {
107
119
  * @param {Number} opts.pageSize The total page size requested (default to 25)
108
120
  * @param {Number} opts.pageNumber The page number requested (default to 1)
109
121
  * @param {String} opts.queryValue Search query value to filter results by
122
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110
123
  */
111
124
  getIntentsCategories(opts) {
112
125
  opts = opts || {};
@@ -122,7 +135,8 @@ class IntentsApi {
122
135
  null,
123
136
  ['PureCloud OAuth'],
124
137
  ['application/json'],
125
- ['application/json']
138
+ ['application/json'],
139
+ opts['customHeaders']
126
140
  );
127
141
  }
128
142
 
@@ -130,8 +144,12 @@ class IntentsApi {
130
144
  * Get category for categoryId
131
145
  *
132
146
  * @param {String} categoryId Category id
147
+ * @param {Object} opts Optional parameters
148
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
133
149
  */
134
- getIntentsCategory(categoryId) {
150
+ getIntentsCategory(categoryId, opts) {
151
+ opts = opts || {};
152
+
135
153
  // verify the required parameter 'categoryId' is set
136
154
  if (categoryId === undefined || categoryId === null || categoryId === '') {
137
155
  throw 'Missing the required parameter "categoryId" when calling getIntentsCategory';
@@ -147,7 +165,8 @@ class IntentsApi {
147
165
  null,
148
166
  ['PureCloud OAuth'],
149
167
  ['application/json'],
150
- ['application/json']
168
+ ['application/json'],
169
+ opts['customHeaders']
151
170
  );
152
171
  }
153
172
 
@@ -155,8 +174,12 @@ class IntentsApi {
155
174
  * Get customer intent for customerIntentId
156
175
  *
157
176
  * @param {String} customerIntentId Customer Intent id
177
+ * @param {Object} opts Optional parameters
178
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
158
179
  */
159
- getIntentsCustomerintent(customerIntentId) {
180
+ getIntentsCustomerintent(customerIntentId, opts) {
181
+ opts = opts || {};
182
+
160
183
  // verify the required parameter 'customerIntentId' is set
161
184
  if (customerIntentId === undefined || customerIntentId === null || customerIntentId === '') {
162
185
  throw 'Missing the required parameter "customerIntentId" when calling getIntentsCustomerintent';
@@ -172,7 +195,8 @@ class IntentsApi {
172
195
  null,
173
196
  ['PureCloud OAuth'],
174
197
  ['application/json'],
175
- ['application/json']
198
+ ['application/json'],
199
+ opts['customHeaders']
176
200
  );
177
201
  }
178
202
 
@@ -184,6 +208,7 @@ class IntentsApi {
184
208
  * @param {Number} opts.pageSize The total page size requested (default to 25)
185
209
  * @param {Number} opts.pageNumber The page number requested (default to 1)
186
210
  * @param {String} opts.queryValue Search query value to filter results by
211
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
187
212
  */
188
213
  getIntentsCustomerintentSourceintents(customerIntentId, opts) {
189
214
  opts = opts || {};
@@ -203,7 +228,8 @@ class IntentsApi {
203
228
  null,
204
229
  ['PureCloud OAuth'],
205
230
  ['application/json'],
206
- ['application/json']
231
+ ['application/json'],
232
+ opts['customHeaders']
207
233
  );
208
234
  }
209
235
 
@@ -215,6 +241,7 @@ class IntentsApi {
215
241
  * @param {Number} opts.pageNumber The page number requested (default to 1)
216
242
  * @param {String} opts.queryValue Search query value to filter results by
217
243
  * @param {String} opts.categoryId CategoryId to filter query by
244
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
218
245
  */
219
246
  getIntentsCustomerintents(opts) {
220
247
  opts = opts || {};
@@ -230,7 +257,8 @@ class IntentsApi {
230
257
  null,
231
258
  ['PureCloud OAuth'],
232
259
  ['application/json'],
233
- ['application/json']
260
+ ['application/json'],
261
+ opts['customHeaders']
234
262
  );
235
263
  }
236
264
 
@@ -242,6 +270,7 @@ class IntentsApi {
242
270
  * @param {Number} opts.pageNumber The page number requested (default to 1)
243
271
  * @param {Object} opts.type Source Type to query by. If none selected default response will be for type Segment.
244
272
  * @param {String} opts.sourceId Source Id to query by. Only required for sourceType: Copilot, Bot, Digitalbot
273
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
245
274
  */
246
275
  getIntentsSourceintents(opts) {
247
276
  opts = opts || {};
@@ -257,7 +286,8 @@ class IntentsApi {
257
286
  null,
258
287
  ['PureCloud OAuth'],
259
288
  ['application/json'],
260
- ['application/json']
289
+ ['application/json'],
290
+ opts['customHeaders']
261
291
  );
262
292
  }
263
293
 
@@ -266,8 +296,12 @@ class IntentsApi {
266
296
  *
267
297
  * @param {String} categoryId Category id
268
298
  * @param {Object} body category
299
+ * @param {Object} opts Optional parameters
300
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
269
301
  */
270
- patchIntentsCategory(categoryId, body) {
302
+ patchIntentsCategory(categoryId, body, opts) {
303
+ opts = opts || {};
304
+
271
305
  // verify the required parameter 'categoryId' is set
272
306
  if (categoryId === undefined || categoryId === null || categoryId === '') {
273
307
  throw 'Missing the required parameter "categoryId" when calling patchIntentsCategory';
@@ -287,7 +321,8 @@ class IntentsApi {
287
321
  body,
288
322
  ['PureCloud OAuth'],
289
323
  ['application/json'],
290
- ['application/json']
324
+ ['application/json'],
325
+ opts['customHeaders']
291
326
  );
292
327
  }
293
328
 
@@ -296,8 +331,12 @@ class IntentsApi {
296
331
  *
297
332
  * @param {String} customerIntentId Customer Intent id
298
333
  * @param {Object} body Customer intent
334
+ * @param {Object} opts Optional parameters
335
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
299
336
  */
300
- patchIntentsCustomerintent(customerIntentId, body) {
337
+ patchIntentsCustomerintent(customerIntentId, body, opts) {
338
+ opts = opts || {};
339
+
301
340
  // verify the required parameter 'customerIntentId' is set
302
341
  if (customerIntentId === undefined || customerIntentId === null || customerIntentId === '') {
303
342
  throw 'Missing the required parameter "customerIntentId" when calling patchIntentsCustomerintent';
@@ -317,7 +356,8 @@ class IntentsApi {
317
356
  body,
318
357
  ['PureCloud OAuth'],
319
358
  ['application/json'],
320
- ['application/json']
359
+ ['application/json'],
360
+ opts['customHeaders']
321
361
  );
322
362
  }
323
363
 
@@ -327,8 +367,12 @@ class IntentsApi {
327
367
  * @param {String} externalContactId External Contact id
328
368
  * @param {String} customerIntentId Customer Intent id
329
369
  * @param {Object} body Customer intent assignment
370
+ * @param {Object} opts Optional parameters
371
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
330
372
  */
331
- postIntentsAssignmentsExternalcontactCustomerintentAssignment(externalContactId, customerIntentId, body) {
373
+ postIntentsAssignmentsExternalcontactCustomerintentAssignment(externalContactId, customerIntentId, body, opts) {
374
+ opts = opts || {};
375
+
332
376
  // verify the required parameter 'externalContactId' is set
333
377
  if (externalContactId === undefined || externalContactId === null || externalContactId === '') {
334
378
  throw 'Missing the required parameter "externalContactId" when calling postIntentsAssignmentsExternalcontactCustomerintentAssignment';
@@ -352,7 +396,8 @@ class IntentsApi {
352
396
  body,
353
397
  ['PureCloud OAuth'],
354
398
  ['application/json'],
355
- ['application/json']
399
+ ['application/json'],
400
+ opts['customHeaders']
356
401
  );
357
402
  }
358
403
 
@@ -360,8 +405,12 @@ class IntentsApi {
360
405
  * Create category
361
406
  *
362
407
  * @param {Object} body category
408
+ * @param {Object} opts Optional parameters
409
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
363
410
  */
364
- postIntentsCategories(body) {
411
+ postIntentsCategories(body, opts) {
412
+ opts = opts || {};
413
+
365
414
  // verify the required parameter 'body' is set
366
415
  if (body === undefined || body === null) {
367
416
  throw 'Missing the required parameter "body" when calling postIntentsCategories';
@@ -377,7 +426,8 @@ class IntentsApi {
377
426
  body,
378
427
  ['PureCloud OAuth'],
379
428
  ['application/json'],
380
- ['application/json']
429
+ ['application/json'],
430
+ opts['customHeaders']
381
431
  );
382
432
  }
383
433
 
@@ -386,8 +436,12 @@ class IntentsApi {
386
436
  *
387
437
  * @param {String} customerIntentId Customer Intent id
388
438
  * @param {Object} body Source intents to be added
439
+ * @param {Object} opts Optional parameters
440
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
389
441
  */
390
- postIntentsCustomerintentSourceintentsBulkAdd(customerIntentId, body) {
442
+ postIntentsCustomerintentSourceintentsBulkAdd(customerIntentId, body, opts) {
443
+ opts = opts || {};
444
+
391
445
  // verify the required parameter 'customerIntentId' is set
392
446
  if (customerIntentId === undefined || customerIntentId === null || customerIntentId === '') {
393
447
  throw 'Missing the required parameter "customerIntentId" when calling postIntentsCustomerintentSourceintentsBulkAdd';
@@ -407,7 +461,8 @@ class IntentsApi {
407
461
  body,
408
462
  ['PureCloud OAuth'],
409
463
  ['application/json'],
410
- ['application/json']
464
+ ['application/json'],
465
+ opts['customHeaders']
411
466
  );
412
467
  }
413
468
 
@@ -416,8 +471,12 @@ class IntentsApi {
416
471
  *
417
472
  * @param {String} customerIntentId Customer Intent id
418
473
  * @param {Object} body Source intents to be removed
474
+ * @param {Object} opts Optional parameters
475
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
419
476
  */
420
- postIntentsCustomerintentSourceintentsBulkRemove(customerIntentId, body) {
477
+ postIntentsCustomerintentSourceintentsBulkRemove(customerIntentId, body, opts) {
478
+ opts = opts || {};
479
+
421
480
  // verify the required parameter 'customerIntentId' is set
422
481
  if (customerIntentId === undefined || customerIntentId === null || customerIntentId === '') {
423
482
  throw 'Missing the required parameter "customerIntentId" when calling postIntentsCustomerintentSourceintentsBulkRemove';
@@ -437,7 +496,8 @@ class IntentsApi {
437
496
  body,
438
497
  ['PureCloud OAuth'],
439
498
  ['application/json'],
440
- ['application/json']
499
+ ['application/json'],
500
+ opts['customHeaders']
441
501
  );
442
502
  }
443
503
 
@@ -445,8 +505,12 @@ class IntentsApi {
445
505
  * Create customer intents
446
506
  *
447
507
  * @param {Object} body Customer intent
508
+ * @param {Object} opts Optional parameters
509
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
448
510
  */
449
- postIntentsCustomerintents(body) {
511
+ postIntentsCustomerintents(body, opts) {
512
+ opts = opts || {};
513
+
450
514
  // verify the required parameter 'body' is set
451
515
  if (body === undefined || body === null) {
452
516
  throw 'Missing the required parameter "body" when calling postIntentsCustomerintents';
@@ -462,7 +526,8 @@ class IntentsApi {
462
526
  body,
463
527
  ['PureCloud OAuth'],
464
528
  ['application/json'],
465
- ['application/json']
529
+ ['application/json'],
530
+ opts['customHeaders']
466
531
  );
467
532
  }
468
533