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 LearningApi {
5
5
  /**
6
6
  * Learning service.
7
7
  * @module purecloud-platform-client-v2/api/LearningApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class LearningApi {
24
24
  * Delete a learning assignment
25
25
  *
26
26
  * @param {String} assignmentId The Learning Assignment ID
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteLearningAssignment(assignmentId) {
30
+ deleteLearningAssignment(assignmentId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'assignmentId' is set
30
34
  if (assignmentId === undefined || assignmentId === null || assignmentId === '') {
31
35
  throw 'Missing the required parameter "assignmentId" when calling deleteLearningAssignment';
@@ -41,7 +45,8 @@ class LearningApi {
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 LearningApi {
49
54
  * Delete a learning module
50
55
  * This will delete a learning module if it is unpublished or it will delete a published and archived learning module
51
56
  * @param {String} moduleId The ID of the learning module
57
+ * @param {Object} opts Optional parameters
58
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
52
59
  */
53
- deleteLearningModule(moduleId) {
60
+ deleteLearningModule(moduleId, opts) {
61
+ opts = opts || {};
62
+
54
63
  // verify the required parameter 'moduleId' is set
55
64
  if (moduleId === undefined || moduleId === null || moduleId === '') {
56
65
  throw 'Missing the required parameter "moduleId" when calling deleteLearningModule';
@@ -66,7 +75,8 @@ class LearningApi {
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
 
@@ -76,6 +86,7 @@ class LearningApi {
76
86
  * @param {String} assignmentId The ID of Learning Assignment
77
87
  * @param {Object} opts Optional parameters
78
88
  * @param {Array.<String>} opts.expand Fields to expand in response
89
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
79
90
  */
80
91
  getLearningAssignment(assignmentId, opts) {
81
92
  opts = opts || {};
@@ -95,7 +106,8 @@ class LearningApi {
95
106
  null,
96
107
  ['PureCloud OAuth'],
97
108
  ['application/json'],
98
- ['application/json']
109
+ ['application/json'],
110
+ opts['customHeaders']
99
111
  );
100
112
  }
101
113
 
@@ -108,6 +120,7 @@ class LearningApi {
108
120
  * @param {String} opts.shareableContentObjectId The ID of SCO to load
109
121
  * @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
110
122
  * @param {Array.<String>} opts.expand Fields to expand in response
123
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
111
124
  */
112
125
  getLearningAssignmentStep(assignmentId, stepId, opts) {
113
126
  opts = opts || {};
@@ -131,7 +144,8 @@ class LearningApi {
131
144
  null,
132
145
  ['PureCloud OAuth'],
133
146
  ['application/json'],
134
- ['application/json']
147
+ ['application/json'],
148
+ opts['customHeaders']
135
149
  );
136
150
  }
137
151
 
@@ -154,6 +168,7 @@ class LearningApi {
154
168
  * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
155
169
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
156
170
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
171
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
157
172
  */
158
173
  getLearningAssignments(opts) {
159
174
  opts = opts || {};
@@ -169,7 +184,8 @@ class LearningApi {
169
184
  null,
170
185
  ['PureCloud OAuth'],
171
186
  ['application/json'],
172
- ['application/json']
187
+ ['application/json'],
188
+ opts['customHeaders']
173
189
  );
174
190
  }
175
191
 
@@ -191,6 +207,7 @@ class LearningApi {
191
207
  * @param {Array.<String>} opts.types Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
192
208
  * @param {Array.<String>} opts.states Specifies the assignment states to filter by
193
209
  * @param {Array.<String>} opts.expand Specifies the expand option for returning additional information
210
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
194
211
  */
195
212
  getLearningAssignmentsMe(opts) {
196
213
  opts = opts || {};
@@ -206,7 +223,8 @@ class LearningApi {
206
223
  null,
207
224
  ['PureCloud OAuth'],
208
225
  ['application/json'],
209
- ['application/json']
226
+ ['application/json'],
227
+ opts['customHeaders']
210
228
  );
211
229
  }
212
230
 
@@ -216,6 +234,7 @@ class LearningApi {
216
234
  * @param {String} moduleId The ID of the learning module
217
235
  * @param {Object} opts Optional parameters
218
236
  * @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
237
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
219
238
  */
220
239
  getLearningModule(moduleId, opts) {
221
240
  opts = opts || {};
@@ -235,7 +254,8 @@ class LearningApi {
235
254
  null,
236
255
  ['PureCloud OAuth'],
237
256
  ['application/json'],
238
- ['application/json']
257
+ ['application/json'],
258
+ opts['customHeaders']
239
259
  );
240
260
  }
241
261
 
@@ -244,8 +264,12 @@ class LearningApi {
244
264
  *
245
265
  * @param {String} moduleId The ID of the learning module
246
266
  * @param {String} jobId The ID of the learning module job
267
+ * @param {Object} opts Optional parameters
268
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
247
269
  */
248
- getLearningModuleJob(moduleId, jobId) {
270
+ getLearningModuleJob(moduleId, jobId, opts) {
271
+ opts = opts || {};
272
+
249
273
  // verify the required parameter 'moduleId' is set
250
274
  if (moduleId === undefined || moduleId === null || moduleId === '') {
251
275
  throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
@@ -265,7 +289,8 @@ class LearningApi {
265
289
  null,
266
290
  ['PureCloud OAuth'],
267
291
  ['application/json'],
268
- ['application/json']
292
+ ['application/json'],
293
+ opts['customHeaders']
269
294
  );
270
295
  }
271
296
 
@@ -273,8 +298,12 @@ class LearningApi {
273
298
  * Get a learning module preview
274
299
  *
275
300
  * @param {String} moduleId The ID of the learning module
301
+ * @param {Object} opts Optional parameters
302
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
276
303
  */
277
- getLearningModulePreview(moduleId) {
304
+ getLearningModulePreview(moduleId, opts) {
305
+ opts = opts || {};
306
+
278
307
  // verify the required parameter 'moduleId' is set
279
308
  if (moduleId === undefined || moduleId === null || moduleId === '') {
280
309
  throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview';
@@ -290,7 +319,8 @@ class LearningApi {
290
319
  null,
291
320
  ['PureCloud OAuth'],
292
321
  ['application/json'],
293
- ['application/json']
322
+ ['application/json'],
323
+ opts['customHeaders']
294
324
  );
295
325
  }
296
326
 
@@ -298,8 +328,12 @@ class LearningApi {
298
328
  * Get a learning module rule
299
329
  *
300
330
  * @param {String} moduleId The ID of the learning module
331
+ * @param {Object} opts Optional parameters
332
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
301
333
  */
302
- getLearningModuleRule(moduleId) {
334
+ getLearningModuleRule(moduleId, opts) {
335
+ opts = opts || {};
336
+
303
337
  // verify the required parameter 'moduleId' is set
304
338
  if (moduleId === undefined || moduleId === null || moduleId === '') {
305
339
  throw 'Missing the required parameter "moduleId" when calling getLearningModuleRule';
@@ -315,7 +349,8 @@ class LearningApi {
315
349
  null,
316
350
  ['PureCloud OAuth'],
317
351
  ['application/json'],
318
- ['application/json']
352
+ ['application/json'],
353
+ opts['customHeaders']
319
354
  );
320
355
  }
321
356
 
@@ -326,6 +361,7 @@ class LearningApi {
326
361
  * @param {String} versionId The version of learning module
327
362
  * @param {Object} opts Optional parameters
328
363
  * @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
364
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
329
365
  */
330
366
  getLearningModuleVersion(moduleId, versionId, opts) {
331
367
  opts = opts || {};
@@ -349,7 +385,8 @@ class LearningApi {
349
385
  null,
350
386
  ['PureCloud OAuth'],
351
387
  ['application/json'],
352
- ['application/json']
388
+ ['application/json'],
389
+ opts['customHeaders']
353
390
  );
354
391
  }
355
392
 
@@ -368,6 +405,7 @@ class LearningApi {
368
405
  * @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
369
406
  * @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
370
407
  * @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
408
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
371
409
  */
372
410
  getLearningModules(opts) {
373
411
  opts = opts || {};
@@ -383,7 +421,8 @@ class LearningApi {
383
421
  null,
384
422
  ['PureCloud OAuth'],
385
423
  ['application/json'],
386
- ['application/json']
424
+ ['application/json'],
425
+ opts['customHeaders']
387
426
  );
388
427
  }
389
428
 
@@ -398,6 +437,7 @@ class LearningApi {
398
437
  * @param {Object} opts.overdue Specifies if only modules with overdue/not overdue (overdue is True or False) assignments are returned. If overdue is Any or omitted, both are returned and can including modules that are unassigned. (default to Any)
399
438
  * @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
400
439
  * @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
440
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
401
441
  */
402
442
  getLearningModulesAssignments(userIds, opts) {
403
443
  opts = opts || {};
@@ -417,7 +457,8 @@ class LearningApi {
417
457
  null,
418
458
  ['PureCloud OAuth'],
419
459
  ['application/json'],
420
- ['application/json']
460
+ ['application/json'],
461
+ opts['customHeaders']
421
462
  );
422
463
  }
423
464
 
@@ -425,8 +466,12 @@ class LearningApi {
425
466
  * Get a specific Learning Module cover art using ID
426
467
  *
427
468
  * @param {String} coverArtId Key identifier for the cover art
469
+ * @param {Object} opts Optional parameters
470
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
428
471
  */
429
- getLearningModulesCoverartCoverArtId(coverArtId) {
472
+ getLearningModulesCoverartCoverArtId(coverArtId, opts) {
473
+ opts = opts || {};
474
+
430
475
  // verify the required parameter 'coverArtId' is set
431
476
  if (coverArtId === undefined || coverArtId === null || coverArtId === '') {
432
477
  throw 'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';
@@ -442,7 +487,8 @@ class LearningApi {
442
487
  null,
443
488
  ['PureCloud OAuth'],
444
489
  ['application/json'],
445
- ['application/json']
490
+ ['application/json'],
491
+ opts['customHeaders']
446
492
  );
447
493
  }
448
494
 
@@ -450,8 +496,12 @@ class LearningApi {
450
496
  * Retrieve the status of the job for the slots where a learning activity can be scheduled.
451
497
  *
452
498
  * @param {String} jobId The ID of the job
499
+ * @param {Object} opts Optional parameters
500
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
453
501
  */
454
- getLearningScheduleslotsJob(jobId) {
502
+ getLearningScheduleslotsJob(jobId, opts) {
503
+ opts = opts || {};
504
+
455
505
  // verify the required parameter 'jobId' is set
456
506
  if (jobId === undefined || jobId === null || jobId === '') {
457
507
  throw 'Missing the required parameter "jobId" when calling getLearningScheduleslotsJob';
@@ -467,7 +517,8 @@ class LearningApi {
467
517
  null,
468
518
  ['PureCloud OAuth'],
469
519
  ['application/json'],
470
- ['application/json']
520
+ ['application/json'],
521
+ opts['customHeaders']
471
522
  );
472
523
  }
473
524
 
@@ -475,8 +526,12 @@ class LearningApi {
475
526
  * Get Learning SCORM Result
476
527
  *
477
528
  * @param {String} scormId The ID of the SCORM package
529
+ * @param {Object} opts Optional parameters
530
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
478
531
  */
479
- getLearningScormScormId(scormId) {
532
+ getLearningScormScormId(scormId, opts) {
533
+ opts = opts || {};
534
+
480
535
  // verify the required parameter 'scormId' is set
481
536
  if (scormId === undefined || scormId === null || scormId === '') {
482
537
  throw 'Missing the required parameter "scormId" when calling getLearningScormScormId';
@@ -492,7 +547,8 @@ class LearningApi {
492
547
  null,
493
548
  ['PureCloud OAuth'],
494
549
  ['application/json'],
495
- ['application/json']
550
+ ['application/json'],
551
+ opts['customHeaders']
496
552
  );
497
553
  }
498
554
 
@@ -502,6 +558,7 @@ class LearningApi {
502
558
  * @param {String} assignmentId The ID of Learning Assignment
503
559
  * @param {Object} opts Optional parameters
504
560
  * @param {Object} opts.body The Learning Assignment to be updated
561
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
505
562
  */
506
563
  patchLearningAssignment(assignmentId, opts) {
507
564
  opts = opts || {};
@@ -521,7 +578,8 @@ class LearningApi {
521
578
  opts['body'],
522
579
  ['PureCloud OAuth'],
523
580
  ['application/json'],
524
- ['application/json']
581
+ ['application/json'],
582
+ opts['customHeaders']
525
583
  );
526
584
  }
527
585
 
@@ -531,6 +589,7 @@ class LearningApi {
531
589
  * @param {String} assignmentId The ID of Learning Assignment
532
590
  * @param {Object} opts Optional parameters
533
591
  * @param {Object} opts.body The Learning assignment reschedule model
592
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
534
593
  */
535
594
  patchLearningAssignmentReschedule(assignmentId, opts) {
536
595
  opts = opts || {};
@@ -550,7 +609,8 @@ class LearningApi {
550
609
  opts['body'],
551
610
  ['PureCloud OAuth'],
552
611
  ['application/json'],
553
- ['application/json']
612
+ ['application/json'],
613
+ opts['customHeaders']
554
614
  );
555
615
  }
556
616
 
@@ -561,6 +621,7 @@ class LearningApi {
561
621
  * @param {String} stepId The ID of Learning Assignment Step
562
622
  * @param {Object} opts Optional parameters
563
623
  * @param {Object} opts.body The Learning Assignment Step to be updated
624
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
564
625
  */
565
626
  patchLearningAssignmentStep(assignmentId, stepId, opts) {
566
627
  opts = opts || {};
@@ -584,7 +645,8 @@ class LearningApi {
584
645
  opts['body'],
585
646
  ['PureCloud OAuth'],
586
647
  ['application/json'],
587
- ['application/json']
648
+ ['application/json'],
649
+ opts['customHeaders']
588
650
  );
589
651
  }
590
652
 
@@ -594,8 +656,12 @@ class LearningApi {
594
656
  * @param {String} moduleId Key identifier for the module
595
657
  * @param {String} userId Key identifier for the user
596
658
  * @param {Object} body The learning request for updating the assignment
659
+ * @param {Object} opts Optional parameters
660
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
597
661
  */
598
- patchLearningModuleUserAssignments(moduleId, userId, body) {
662
+ patchLearningModuleUserAssignments(moduleId, userId, body, opts) {
663
+ opts = opts || {};
664
+
599
665
  // verify the required parameter 'moduleId' is set
600
666
  if (moduleId === undefined || moduleId === null || moduleId === '') {
601
667
  throw 'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';
@@ -619,7 +685,8 @@ class LearningApi {
619
685
  body,
620
686
  ['PureCloud OAuth'],
621
687
  ['application/json'],
622
- ['application/json']
688
+ ['application/json'],
689
+ opts['customHeaders']
623
690
  );
624
691
  }
625
692
 
@@ -627,8 +694,12 @@ class LearningApi {
627
694
  * Score learning assessment for preview
628
695
  *
629
696
  * @param {Object} body Assessment form and answers to score
697
+ * @param {Object} opts Optional parameters
698
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
630
699
  */
631
- postLearningAssessmentsScoring(body) {
700
+ postLearningAssessmentsScoring(body, opts) {
701
+ opts = opts || {};
702
+
632
703
  // verify the required parameter 'body' is set
633
704
  if (body === undefined || body === null) {
634
705
  throw 'Missing the required parameter "body" when calling postLearningAssessmentsScoring';
@@ -644,7 +715,8 @@ class LearningApi {
644
715
  body,
645
716
  ['PureCloud OAuth'],
646
717
  ['application/json'],
647
- ['application/json']
718
+ ['application/json'],
719
+ opts['customHeaders']
648
720
  );
649
721
  }
650
722
 
@@ -652,8 +724,12 @@ class LearningApi {
652
724
  * Reassign Learning Assignment
653
725
  * This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
654
726
  * @param {String} assignmentId The Learning Assignment ID
727
+ * @param {Object} opts Optional parameters
728
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
655
729
  */
656
- postLearningAssignmentReassign(assignmentId) {
730
+ postLearningAssignmentReassign(assignmentId, opts) {
731
+ opts = opts || {};
732
+
657
733
  // verify the required parameter 'assignmentId' is set
658
734
  if (assignmentId === undefined || assignmentId === null || assignmentId === '') {
659
735
  throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
@@ -669,7 +745,8 @@ class LearningApi {
669
745
  null,
670
746
  ['PureCloud OAuth'],
671
747
  ['application/json'],
672
- ['application/json']
748
+ ['application/json'],
749
+ opts['customHeaders']
673
750
  );
674
751
  }
675
752
 
@@ -677,8 +754,12 @@ class LearningApi {
677
754
  * Reset Learning Assignment
678
755
  * This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
679
756
  * @param {String} assignmentId The Learning Assignment ID
757
+ * @param {Object} opts Optional parameters
758
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
680
759
  */
681
- postLearningAssignmentReset(assignmentId) {
760
+ postLearningAssignmentReset(assignmentId, opts) {
761
+ opts = opts || {};
762
+
682
763
  // verify the required parameter 'assignmentId' is set
683
764
  if (assignmentId === undefined || assignmentId === null || assignmentId === '') {
684
765
  throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
@@ -694,7 +775,8 @@ class LearningApi {
694
775
  null,
695
776
  ['PureCloud OAuth'],
696
777
  ['application/json'],
697
- ['application/json']
778
+ ['application/json'],
779
+ opts['customHeaders']
698
780
  );
699
781
  }
700
782
 
@@ -703,6 +785,7 @@ class LearningApi {
703
785
  *
704
786
  * @param {Object} opts Optional parameters
705
787
  * @param {Object} opts.body The Learning Assignment to be created
788
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
706
789
  */
707
790
  postLearningAssignments(opts) {
708
791
  opts = opts || {};
@@ -718,7 +801,8 @@ class LearningApi {
718
801
  opts['body'],
719
802
  ['PureCloud OAuth'],
720
803
  ['application/json'],
721
- ['application/json']
804
+ ['application/json'],
805
+ opts['customHeaders']
722
806
  );
723
807
  }
724
808
 
@@ -726,8 +810,12 @@ class LearningApi {
726
810
  * Retrieve aggregated assignment data
727
811
  *
728
812
  * @param {Object} body Aggregate Request
813
+ * @param {Object} opts Optional parameters
814
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
729
815
  */
730
- postLearningAssignmentsAggregatesQuery(body) {
816
+ postLearningAssignmentsAggregatesQuery(body, opts) {
817
+ opts = opts || {};
818
+
731
819
  // verify the required parameter 'body' is set
732
820
  if (body === undefined || body === null) {
733
821
  throw 'Missing the required parameter "body" when calling postLearningAssignmentsAggregatesQuery';
@@ -743,7 +831,8 @@ class LearningApi {
743
831
  body,
744
832
  ['PureCloud OAuth'],
745
833
  ['application/json'],
746
- ['application/json']
834
+ ['application/json'],
835
+ opts['customHeaders']
747
836
  );
748
837
  }
749
838
 
@@ -752,6 +841,7 @@ class LearningApi {
752
841
  *
753
842
  * @param {Object} opts Optional parameters
754
843
  * @param {Array.<Object>} opts.body The learning assignments to be created
844
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
755
845
  */
756
846
  postLearningAssignmentsBulkadd(opts) {
757
847
  opts = opts || {};
@@ -767,7 +857,8 @@ class LearningApi {
767
857
  opts['body'],
768
858
  ['PureCloud OAuth'],
769
859
  ['application/json'],
770
- ['application/json']
860
+ ['application/json'],
861
+ opts['customHeaders']
771
862
  );
772
863
  }
773
864
 
@@ -776,6 +867,7 @@ class LearningApi {
776
867
  *
777
868
  * @param {Object} opts Optional parameters
778
869
  * @param {Array.<String>} opts.body The IDs of the learning assignments to be removed
870
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
779
871
  */
780
872
  postLearningAssignmentsBulkremove(opts) {
781
873
  opts = opts || {};
@@ -791,7 +883,8 @@ class LearningApi {
791
883
  opts['body'],
792
884
  ['PureCloud OAuth'],
793
885
  ['application/json'],
794
- ['application/json']
886
+ ['application/json'],
887
+ opts['customHeaders']
795
888
  );
796
889
  }
797
890
 
@@ -800,8 +893,12 @@ class LearningApi {
800
893
  * This will initiate operation specified in the request body for a learning module
801
894
  * @param {String} moduleId The ID of the learning module
802
895
  * @param {Object} body The learning module job request
896
+ * @param {Object} opts Optional parameters
897
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
803
898
  */
804
- postLearningModuleJobs(moduleId, body) {
899
+ postLearningModuleJobs(moduleId, body, opts) {
900
+ opts = opts || {};
901
+
805
902
  // verify the required parameter 'moduleId' is set
806
903
  if (moduleId === undefined || moduleId === null || moduleId === '') {
807
904
  throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
@@ -821,7 +918,8 @@ class LearningApi {
821
918
  body,
822
919
  ['PureCloud OAuth'],
823
920
  ['application/json'],
824
- ['application/json']
921
+ ['application/json'],
922
+ opts['customHeaders']
825
923
  );
826
924
  }
827
925
 
@@ -831,6 +929,7 @@ class LearningApi {
831
929
  * @param {String} moduleId The ID of the learning module
832
930
  * @param {Object} opts Optional parameters
833
931
  * @param {Object} opts.body The request body
932
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
834
933
  */
835
934
  postLearningModulePublish(moduleId, opts) {
836
935
  opts = opts || {};
@@ -850,7 +949,8 @@ class LearningApi {
850
949
  opts['body'],
851
950
  ['PureCloud OAuth'],
852
951
  ['application/json'],
853
- ['application/json']
952
+ ['application/json'],
953
+ opts['customHeaders']
854
954
  );
855
955
  }
856
956
 
@@ -858,9 +958,13 @@ class LearningApi {
858
958
  * Migrate a legacy learning module rule to a users rule.
859
959
  *
860
960
  * @param {String} moduleId The ID of the learning module
961
+ * @param {Object} opts Optional parameters
962
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
861
963
  * postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
862
964
  */
863
- postLearningModuleRuleMigrate(moduleId) {
965
+ postLearningModuleRuleMigrate(moduleId, opts) {
966
+ opts = opts || {};
967
+
864
968
  // verify the required parameter 'moduleId' is set
865
969
  if (moduleId === undefined || moduleId === null || moduleId === '') {
866
970
  throw 'Missing the required parameter "moduleId" when calling postLearningModuleRuleMigrate';
@@ -876,7 +980,8 @@ class LearningApi {
876
980
  null,
877
981
  ['PureCloud OAuth'],
878
982
  ['application/json'],
879
- ['application/json']
983
+ ['application/json'],
984
+ opts['customHeaders']
880
985
  );
881
986
  }
882
987
 
@@ -884,8 +989,12 @@ class LearningApi {
884
989
  * Create a new learning module
885
990
  * This will create a new unpublished learning module with the specified fields.
886
991
  * @param {Object} body The learning module to be created
992
+ * @param {Object} opts Optional parameters
993
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
887
994
  */
888
- postLearningModules(body) {
995
+ postLearningModules(body, opts) {
996
+ opts = opts || {};
997
+
889
998
  // verify the required parameter 'body' is set
890
999
  if (body === undefined || body === null) {
891
1000
  throw 'Missing the required parameter "body" when calling postLearningModules';
@@ -901,7 +1010,8 @@ class LearningApi {
901
1010
  body,
902
1011
  ['PureCloud OAuth'],
903
1012
  ['application/json'],
904
- ['application/json']
1013
+ ['application/json'],
1014
+ opts['customHeaders']
905
1015
  );
906
1016
  }
907
1017
 
@@ -911,8 +1021,12 @@ class LearningApi {
911
1021
  * @param {Number} pageSize Page size
912
1022
  * @param {Number} pageNumber Page number
913
1023
  * @param {Object} body The learning module rule to fetch users
1024
+ * @param {Object} opts Optional parameters
1025
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
914
1026
  */
915
- postLearningRulesQuery(pageSize, pageNumber, body) {
1027
+ postLearningRulesQuery(pageSize, pageNumber, body, opts) {
1028
+ opts = opts || {};
1029
+
916
1030
  // verify the required parameter 'pageSize' is set
917
1031
  if (pageSize === undefined || pageSize === null) {
918
1032
  throw 'Missing the required parameter "pageSize" when calling postLearningRulesQuery';
@@ -936,7 +1050,8 @@ class LearningApi {
936
1050
  body,
937
1051
  ['PureCloud OAuth'],
938
1052
  ['application/json'],
939
- ['application/json']
1053
+ ['application/json'],
1054
+ opts['customHeaders']
940
1055
  );
941
1056
  }
942
1057
 
@@ -944,8 +1059,12 @@ class LearningApi {
944
1059
  * Start job to retrieve slots where a learning activity can be scheduled.
945
1060
  *
946
1061
  * @param {Object} body The slots search request
1062
+ * @param {Object} opts Optional parameters
1063
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
947
1064
  */
948
- postLearningScheduleslotsJobs(body) {
1065
+ postLearningScheduleslotsJobs(body, opts) {
1066
+ opts = opts || {};
1067
+
949
1068
  // verify the required parameter 'body' is set
950
1069
  if (body === undefined || body === null) {
951
1070
  throw 'Missing the required parameter "body" when calling postLearningScheduleslotsJobs';
@@ -961,7 +1080,8 @@ class LearningApi {
961
1080
  body,
962
1081
  ['PureCloud OAuth'],
963
1082
  ['application/json'],
964
- ['application/json']
1083
+ ['application/json'],
1084
+ opts['customHeaders']
965
1085
  );
966
1086
  }
967
1087
 
@@ -969,8 +1089,12 @@ class LearningApi {
969
1089
  * Get list of possible slots where a learning activity can be scheduled.
970
1090
  *
971
1091
  * @param {Object} body The slot search request
1092
+ * @param {Object} opts Optional parameters
1093
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
972
1094
  */
973
- postLearningScheduleslotsQuery(body) {
1095
+ postLearningScheduleslotsQuery(body, opts) {
1096
+ opts = opts || {};
1097
+
974
1098
  // verify the required parameter 'body' is set
975
1099
  if (body === undefined || body === null) {
976
1100
  throw 'Missing the required parameter "body" when calling postLearningScheduleslotsQuery';
@@ -986,7 +1110,8 @@ class LearningApi {
986
1110
  body,
987
1111
  ['PureCloud OAuth'],
988
1112
  ['application/json'],
989
- ['application/json']
1113
+ ['application/json'],
1114
+ opts['customHeaders']
990
1115
  );
991
1116
  }
992
1117
 
@@ -995,6 +1120,7 @@ class LearningApi {
995
1120
  *
996
1121
  * @param {Object} opts Optional parameters
997
1122
  * @param {Object} opts.body The SCORM package to be uploaded
1123
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
998
1124
  */
999
1125
  postLearningScorm(opts) {
1000
1126
  opts = opts || {};
@@ -1010,7 +1136,8 @@ class LearningApi {
1010
1136
  opts['body'],
1011
1137
  ['PureCloud OAuth'],
1012
1138
  ['application/json'],
1013
- ['application/json']
1139
+ ['application/json'],
1140
+ opts['customHeaders']
1014
1141
  );
1015
1142
  }
1016
1143
 
@@ -1019,8 +1146,12 @@ class LearningApi {
1019
1146
  * This will update the name, description, completion time in days and inform steps for a learning module
1020
1147
  * @param {String} moduleId The ID of the learning module
1021
1148
  * @param {Object} body The learning module to be updated
1149
+ * @param {Object} opts Optional parameters
1150
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1022
1151
  */
1023
- putLearningModule(moduleId, body) {
1152
+ putLearningModule(moduleId, body, opts) {
1153
+ opts = opts || {};
1154
+
1024
1155
  // verify the required parameter 'moduleId' is set
1025
1156
  if (moduleId === undefined || moduleId === null || moduleId === '') {
1026
1157
  throw 'Missing the required parameter "moduleId" when calling putLearningModule';
@@ -1040,7 +1171,8 @@ class LearningApi {
1040
1171
  body,
1041
1172
  ['PureCloud OAuth'],
1042
1173
  ['application/json'],
1043
- ['application/json']
1174
+ ['application/json'],
1175
+ opts['customHeaders']
1044
1176
  );
1045
1177
  }
1046
1178
 
@@ -1049,8 +1181,12 @@ class LearningApi {
1049
1181
  * This will update a learning module preview
1050
1182
  * @param {String} moduleId The ID of the learning module
1051
1183
  * @param {Object} body The learning module to be updated
1184
+ * @param {Object} opts Optional parameters
1185
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1052
1186
  */
1053
- putLearningModulePreview(moduleId, body) {
1187
+ putLearningModulePreview(moduleId, body, opts) {
1188
+ opts = opts || {};
1189
+
1054
1190
  // verify the required parameter 'moduleId' is set
1055
1191
  if (moduleId === undefined || moduleId === null || moduleId === '') {
1056
1192
  throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview';
@@ -1070,7 +1206,8 @@ class LearningApi {
1070
1206
  body,
1071
1207
  ['PureCloud OAuth'],
1072
1208
  ['application/json'],
1073
- ['application/json']
1209
+ ['application/json'],
1210
+ opts['customHeaders']
1074
1211
  );
1075
1212
  }
1076
1213
 
@@ -1081,6 +1218,7 @@ class LearningApi {
1081
1218
  * @param {Object} body The learning module rule to be updated
1082
1219
  * @param {Object} opts Optional parameters
1083
1220
  * @param {Boolean} opts.assign Whether to assign the module to users or not (default to true)
1221
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1084
1222
  */
1085
1223
  putLearningModuleRule(moduleId, body, opts) {
1086
1224
  opts = opts || {};
@@ -1104,7 +1242,8 @@ class LearningApi {
1104
1242
  body,
1105
1243
  ['PureCloud OAuth'],
1106
1244
  ['application/json'],
1107
- ['application/json']
1245
+ ['application/json'],
1246
+ opts['customHeaders']
1108
1247
  );
1109
1248
  }
1110
1249