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 ChatApi {
5
5
  /**
6
6
  * Chat service.
7
7
  * @module purecloud-platform-client-v2/api/ChatApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -25,8 +25,12 @@ class ChatApi {
25
25
  *
26
26
  * @param {String} roomJid roomId
27
27
  * @param {String} messageId messageId
28
+ * @param {Object} opts Optional parameters
29
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
28
30
  */
29
- deleteChatsRoomMessage(roomJid, messageId) {
31
+ deleteChatsRoomMessage(roomJid, messageId, opts) {
32
+ opts = opts || {};
33
+
30
34
  // verify the required parameter 'roomJid' is set
31
35
  if (roomJid === undefined || roomJid === null || roomJid === '') {
32
36
  throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';
@@ -46,7 +50,8 @@ class ChatApi {
46
50
  null,
47
51
  ['PureCloud OAuth'],
48
52
  ['application/json'],
49
- ['application/json']
53
+ ['application/json'],
54
+ opts['customHeaders']
50
55
  );
51
56
  }
52
57
 
@@ -55,8 +60,12 @@ class ChatApi {
55
60
  *
56
61
  * @param {String} roomJid roomJid
57
62
  * @param {String} pinnedMessageId pinnedMessageId
63
+ * @param {Object} opts Optional parameters
64
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
58
65
  */
59
- deleteChatsRoomMessagesPin(roomJid, pinnedMessageId) {
66
+ deleteChatsRoomMessagesPin(roomJid, pinnedMessageId, opts) {
67
+ opts = opts || {};
68
+
60
69
  // verify the required parameter 'roomJid' is set
61
70
  if (roomJid === undefined || roomJid === null || roomJid === '') {
62
71
  throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';
@@ -76,7 +85,8 @@ class ChatApi {
76
85
  null,
77
86
  ['PureCloud OAuth'],
78
87
  ['application/json'],
79
- ['application/json']
88
+ ['application/json'],
89
+ opts['customHeaders']
80
90
  );
81
91
  }
82
92
 
@@ -85,8 +95,12 @@ class ChatApi {
85
95
  *
86
96
  * @param {String} roomJid roomJid
87
97
  * @param {String} userId userId
98
+ * @param {Object} opts Optional parameters
99
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
88
100
  */
89
- deleteChatsRoomParticipant(roomJid, userId) {
101
+ deleteChatsRoomParticipant(roomJid, userId, opts) {
102
+ opts = opts || {};
103
+
90
104
  // verify the required parameter 'roomJid' is set
91
105
  if (roomJid === undefined || roomJid === null || roomJid === '') {
92
106
  throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
@@ -106,7 +120,8 @@ class ChatApi {
106
120
  null,
107
121
  ['PureCloud OAuth'],
108
122
  ['application/json'],
109
- ['application/json']
123
+ ['application/json'],
124
+ opts['customHeaders']
110
125
  );
111
126
  }
112
127
 
@@ -115,8 +130,12 @@ class ChatApi {
115
130
  *
116
131
  * @param {String} userId userId
117
132
  * @param {String} messageId messageId
133
+ * @param {Object} opts Optional parameters
134
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
118
135
  */
119
- deleteChatsUserMessage(userId, messageId) {
136
+ deleteChatsUserMessage(userId, messageId, opts) {
137
+ opts = opts || {};
138
+
120
139
  // verify the required parameter 'userId' is set
121
140
  if (userId === undefined || userId === null || userId === '') {
122
141
  throw 'Missing the required parameter "userId" when calling deleteChatsUserMessage';
@@ -136,7 +155,8 @@ class ChatApi {
136
155
  null,
137
156
  ['PureCloud OAuth'],
138
157
  ['application/json'],
139
- ['application/json']
158
+ ['application/json'],
159
+ opts['customHeaders']
140
160
  );
141
161
  }
142
162
 
@@ -145,8 +165,12 @@ class ChatApi {
145
165
  *
146
166
  * @param {String} userId userId
147
167
  * @param {String} pinnedMessageId pinnedMessageId
168
+ * @param {Object} opts Optional parameters
169
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
148
170
  */
149
- deleteChatsUserMessagesPin(userId, pinnedMessageId) {
171
+ deleteChatsUserMessagesPin(userId, pinnedMessageId, opts) {
172
+ opts = opts || {};
173
+
150
174
  // verify the required parameter 'userId' is set
151
175
  if (userId === undefined || userId === null || userId === '') {
152
176
  throw 'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';
@@ -166,15 +190,20 @@ class ChatApi {
166
190
  null,
167
191
  ['PureCloud OAuth'],
168
192
  ['application/json'],
169
- ['application/json']
193
+ ['application/json'],
194
+ opts['customHeaders']
170
195
  );
171
196
  }
172
197
 
173
198
  /**
174
199
  * Delete a user's chat settings
175
200
  *
201
+ * @param {Object} opts Optional parameters
202
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
176
203
  */
177
- deleteChatsUsersMeSettings() {
204
+ deleteChatsUsersMeSettings(opts) {
205
+ opts = opts || {};
206
+
178
207
 
179
208
  return this.apiClient.callApi(
180
209
  '/api/v2/chats/users/me/settings',
@@ -186,7 +215,8 @@ class ChatApi {
186
215
  null,
187
216
  ['PureCloud OAuth'],
188
217
  ['application/json'],
189
- ['application/json']
218
+ ['application/json'],
219
+ opts['customHeaders']
190
220
  );
191
221
  }
192
222
 
@@ -194,8 +224,12 @@ class ChatApi {
194
224
  * Get a message
195
225
  *
196
226
  * @param {String} messageId messageId
227
+ * @param {Object} opts Optional parameters
228
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
197
229
  */
198
- getChatsMessage(messageId) {
230
+ getChatsMessage(messageId, opts) {
231
+ opts = opts || {};
232
+
199
233
  // verify the required parameter 'messageId' is set
200
234
  if (messageId === undefined || messageId === null || messageId === '') {
201
235
  throw 'Missing the required parameter "messageId" when calling getChatsMessage';
@@ -211,7 +245,8 @@ class ChatApi {
211
245
  null,
212
246
  ['PureCloud OAuth'],
213
247
  ['application/json'],
214
- ['application/json']
248
+ ['application/json'],
249
+ opts['customHeaders']
215
250
  );
216
251
  }
217
252
 
@@ -219,8 +254,12 @@ class ChatApi {
219
254
  * Get a room
220
255
  *
221
256
  * @param {String} roomJid roomJid
257
+ * @param {Object} opts Optional parameters
258
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
222
259
  */
223
- getChatsRoom(roomJid) {
260
+ getChatsRoom(roomJid, opts) {
261
+ opts = opts || {};
262
+
224
263
  // verify the required parameter 'roomJid' is set
225
264
  if (roomJid === undefined || roomJid === null || roomJid === '') {
226
265
  throw 'Missing the required parameter "roomJid" when calling getChatsRoom';
@@ -236,7 +275,8 @@ class ChatApi {
236
275
  null,
237
276
  ['PureCloud OAuth'],
238
277
  ['application/json'],
239
- ['application/json']
278
+ ['application/json'],
279
+ opts['customHeaders']
240
280
  );
241
281
  }
242
282
 
@@ -245,8 +285,12 @@ class ChatApi {
245
285
  *
246
286
  * @param {String} roomJid roomJid
247
287
  * @param {String} messageIds messageIds, comma separated
288
+ * @param {Object} opts Optional parameters
289
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
248
290
  */
249
- getChatsRoomMessage(roomJid, messageIds) {
291
+ getChatsRoomMessage(roomJid, messageIds, opts) {
292
+ opts = opts || {};
293
+
250
294
  // verify the required parameter 'roomJid' is set
251
295
  if (roomJid === undefined || roomJid === null || roomJid === '') {
252
296
  throw 'Missing the required parameter "roomJid" when calling getChatsRoomMessage';
@@ -266,7 +310,8 @@ class ChatApi {
266
310
  null,
267
311
  ['PureCloud OAuth'],
268
312
  ['application/json'],
269
- ['application/json']
313
+ ['application/json'],
314
+ opts['customHeaders']
270
315
  );
271
316
  }
272
317
 
@@ -279,6 +324,7 @@ class ChatApi {
279
324
  * @param {String} opts.before The cutoff date for messages to retrieve
280
325
  * @param {String} opts.after The beginning date for messages to retrieve
281
326
  * @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
327
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
282
328
  */
283
329
  getChatsRoomMessages(roomJid, opts) {
284
330
  opts = opts || {};
@@ -298,7 +344,8 @@ class ChatApi {
298
344
  null,
299
345
  ['PureCloud OAuth'],
300
346
  ['application/json'],
301
- ['application/json']
347
+ ['application/json'],
348
+ opts['customHeaders']
302
349
  );
303
350
  }
304
351
 
@@ -307,8 +354,12 @@ class ChatApi {
307
354
  *
308
355
  * @param {String} roomJid roomJid
309
356
  * @param {String} participantJid participantJid
357
+ * @param {Object} opts Optional parameters
358
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
310
359
  */
311
- getChatsRoomParticipant(roomJid, participantJid) {
360
+ getChatsRoomParticipant(roomJid, participantJid, opts) {
361
+ opts = opts || {};
362
+
312
363
  // verify the required parameter 'roomJid' is set
313
364
  if (roomJid === undefined || roomJid === null || roomJid === '') {
314
365
  throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';
@@ -328,7 +379,8 @@ class ChatApi {
328
379
  null,
329
380
  ['PureCloud OAuth'],
330
381
  ['application/json'],
331
- ['application/json']
382
+ ['application/json'],
383
+ opts['customHeaders']
332
384
  );
333
385
  }
334
386
 
@@ -338,6 +390,7 @@ class ChatApi {
338
390
  * @param {String} roomJid roomJid
339
391
  * @param {Object} opts Optional parameters
340
392
  * @param {Boolean} opts.notify Whether to get users to notify
393
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
341
394
  */
342
395
  getChatsRoomParticipants(roomJid, opts) {
343
396
  opts = opts || {};
@@ -357,15 +410,20 @@ class ChatApi {
357
410
  null,
358
411
  ['PureCloud OAuth'],
359
412
  ['application/json'],
360
- ['application/json']
413
+ ['application/json'],
414
+ opts['customHeaders']
361
415
  );
362
416
  }
363
417
 
364
418
  /**
365
419
  * Get Chat Settings.
366
420
  *
421
+ * @param {Object} opts Optional parameters
422
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
367
423
  */
368
- getChatsSettings() {
424
+ getChatsSettings(opts) {
425
+ opts = opts || {};
426
+
369
427
 
370
428
  return this.apiClient.callApi(
371
429
  '/api/v2/chats/settings',
@@ -377,7 +435,8 @@ class ChatApi {
377
435
  null,
378
436
  ['PureCloud OAuth'],
379
437
  ['application/json'],
380
- ['application/json']
438
+ ['application/json'],
439
+ opts['customHeaders']
381
440
  );
382
441
  }
383
442
 
@@ -390,6 +449,7 @@ class ChatApi {
390
449
  * @param {String} opts.before The cutoff date for messages to retrieve
391
450
  * @param {String} opts.after The beginning date for messages to retrieve
392
451
  * @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
452
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
393
453
  */
394
454
  getChatsThreadMessages(threadId, opts) {
395
455
  opts = opts || {};
@@ -409,7 +469,8 @@ class ChatApi {
409
469
  null,
410
470
  ['PureCloud OAuth'],
411
471
  ['application/json'],
412
- ['application/json']
472
+ ['application/json'],
473
+ opts['customHeaders']
413
474
  );
414
475
  }
415
476
 
@@ -417,8 +478,12 @@ class ChatApi {
417
478
  * Get information for a 1on1
418
479
  *
419
480
  * @param {String} userId userId
481
+ * @param {Object} opts Optional parameters
482
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
420
483
  */
421
- getChatsUser(userId) {
484
+ getChatsUser(userId, opts) {
485
+ opts = opts || {};
486
+
422
487
  // verify the required parameter 'userId' is set
423
488
  if (userId === undefined || userId === null || userId === '') {
424
489
  throw 'Missing the required parameter "userId" when calling getChatsUser';
@@ -434,7 +499,8 @@ class ChatApi {
434
499
  null,
435
500
  ['PureCloud OAuth'],
436
501
  ['application/json'],
437
- ['application/json']
502
+ ['application/json'],
503
+ opts['customHeaders']
438
504
  );
439
505
  }
440
506
 
@@ -443,8 +509,12 @@ class ChatApi {
443
509
  *
444
510
  * @param {String} userId userId
445
511
  * @param {String} messageIds messageIds, comma separated
512
+ * @param {Object} opts Optional parameters
513
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
446
514
  */
447
- getChatsUserMessage(userId, messageIds) {
515
+ getChatsUserMessage(userId, messageIds, opts) {
516
+ opts = opts || {};
517
+
448
518
  // verify the required parameter 'userId' is set
449
519
  if (userId === undefined || userId === null || userId === '') {
450
520
  throw 'Missing the required parameter "userId" when calling getChatsUserMessage';
@@ -464,7 +534,8 @@ class ChatApi {
464
534
  null,
465
535
  ['PureCloud OAuth'],
466
536
  ['application/json'],
467
- ['application/json']
537
+ ['application/json'],
538
+ opts['customHeaders']
468
539
  );
469
540
  }
470
541
 
@@ -477,6 +548,7 @@ class ChatApi {
477
548
  * @param {String} opts.before The cutoff date for messages to retrieve
478
549
  * @param {String} opts.after The beginning date for messages to retrieve
479
550
  * @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
551
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
480
552
  */
481
553
  getChatsUserMessages(userId, opts) {
482
554
  opts = opts || {};
@@ -496,7 +568,8 @@ class ChatApi {
496
568
  null,
497
569
  ['PureCloud OAuth'],
498
570
  ['application/json'],
499
- ['application/json']
571
+ ['application/json'],
572
+ opts['customHeaders']
500
573
  );
501
574
  }
502
575
 
@@ -504,8 +577,12 @@ class ChatApi {
504
577
  * Get a user's chat settings
505
578
  *
506
579
  * @param {String} userId User ID
580
+ * @param {Object} opts Optional parameters
581
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
507
582
  */
508
- getChatsUserSettings(userId) {
583
+ getChatsUserSettings(userId, opts) {
584
+ opts = opts || {};
585
+
509
586
  // verify the required parameter 'userId' is set
510
587
  if (userId === undefined || userId === null || userId === '') {
511
588
  throw 'Missing the required parameter "userId" when calling getChatsUserSettings';
@@ -521,15 +598,20 @@ class ChatApi {
521
598
  null,
522
599
  ['PureCloud OAuth'],
523
600
  ['application/json'],
524
- ['application/json']
601
+ ['application/json'],
602
+ opts['customHeaders']
525
603
  );
526
604
  }
527
605
 
528
606
  /**
529
607
  * Get a user's chat settings
530
608
  *
609
+ * @param {Object} opts Optional parameters
610
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
531
611
  */
532
- getChatsUsersMeSettings() {
612
+ getChatsUsersMeSettings(opts) {
613
+ opts = opts || {};
614
+
533
615
 
534
616
  return this.apiClient.callApi(
535
617
  '/api/v2/chats/users/me/settings',
@@ -541,7 +623,8 @@ class ChatApi {
541
623
  null,
542
624
  ['PureCloud OAuth'],
543
625
  ['application/json'],
544
- ['application/json']
626
+ ['application/json'],
627
+ opts['customHeaders']
545
628
  );
546
629
  }
547
630
 
@@ -550,8 +633,12 @@ class ChatApi {
550
633
  *
551
634
  * @param {String} roomJid roomJid
552
635
  * @param {Object} body Room properties
636
+ * @param {Object} opts Optional parameters
637
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
553
638
  */
554
- patchChatsRoom(roomJid, body) {
639
+ patchChatsRoom(roomJid, body, opts) {
640
+ opts = opts || {};
641
+
555
642
  // verify the required parameter 'roomJid' is set
556
643
  if (roomJid === undefined || roomJid === null || roomJid === '') {
557
644
  throw 'Missing the required parameter "roomJid" when calling patchChatsRoom';
@@ -571,7 +658,8 @@ class ChatApi {
571
658
  body,
572
659
  ['PureCloud OAuth'],
573
660
  ['application/json'],
574
- ['application/json']
661
+ ['application/json'],
662
+ opts['customHeaders']
575
663
  );
576
664
  }
577
665
 
@@ -581,8 +669,12 @@ class ChatApi {
581
669
  * @param {String} roomJid roomId
582
670
  * @param {String} messageId messageId
583
671
  * @param {Object} body messageBody
672
+ * @param {Object} opts Optional parameters
673
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
584
674
  */
585
- patchChatsRoomMessage(roomJid, messageId, body) {
675
+ patchChatsRoomMessage(roomJid, messageId, body, opts) {
676
+ opts = opts || {};
677
+
586
678
  // verify the required parameter 'roomJid' is set
587
679
  if (roomJid === undefined || roomJid === null || roomJid === '') {
588
680
  throw 'Missing the required parameter "roomJid" when calling patchChatsRoomMessage';
@@ -606,7 +698,8 @@ class ChatApi {
606
698
  body,
607
699
  ['PureCloud OAuth'],
608
700
  ['application/json'],
609
- ['application/json']
701
+ ['application/json'],
702
+ opts['customHeaders']
610
703
  );
611
704
  }
612
705
 
@@ -614,8 +707,12 @@ class ChatApi {
614
707
  * Patch Chat Settings.
615
708
  *
616
709
  * @param {Object} body Chat
710
+ * @param {Object} opts Optional parameters
711
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
617
712
  */
618
- patchChatsSettings(body) {
713
+ patchChatsSettings(body, opts) {
714
+ opts = opts || {};
715
+
619
716
  // verify the required parameter 'body' is set
620
717
  if (body === undefined || body === null) {
621
718
  throw 'Missing the required parameter "body" when calling patchChatsSettings';
@@ -631,7 +728,8 @@ class ChatApi {
631
728
  body,
632
729
  ['PureCloud OAuth'],
633
730
  ['application/json'],
634
- ['application/json']
731
+ ['application/json'],
732
+ opts['customHeaders']
635
733
  );
636
734
  }
637
735
 
@@ -641,8 +739,12 @@ class ChatApi {
641
739
  * @param {String} userId userId
642
740
  * @param {String} messageId messageId
643
741
  * @param {Object} body message body
742
+ * @param {Object} opts Optional parameters
743
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
644
744
  */
645
- patchChatsUserMessage(userId, messageId, body) {
745
+ patchChatsUserMessage(userId, messageId, body, opts) {
746
+ opts = opts || {};
747
+
646
748
  // verify the required parameter 'userId' is set
647
749
  if (userId === undefined || userId === null || userId === '') {
648
750
  throw 'Missing the required parameter "userId" when calling patchChatsUserMessage';
@@ -666,7 +768,8 @@ class ChatApi {
666
768
  body,
667
769
  ['PureCloud OAuth'],
668
770
  ['application/json'],
669
- ['application/json']
771
+ ['application/json'],
772
+ opts['customHeaders']
670
773
  );
671
774
  }
672
775
 
@@ -675,8 +778,12 @@ class ChatApi {
675
778
  *
676
779
  * @param {String} userId User ID
677
780
  * @param {Object} body
781
+ * @param {Object} opts Optional parameters
782
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
678
783
  */
679
- patchChatsUserSettings(userId, body) {
784
+ patchChatsUserSettings(userId, body, opts) {
785
+ opts = opts || {};
786
+
680
787
  // verify the required parameter 'userId' is set
681
788
  if (userId === undefined || userId === null || userId === '') {
682
789
  throw 'Missing the required parameter "userId" when calling patchChatsUserSettings';
@@ -696,7 +803,8 @@ class ChatApi {
696
803
  body,
697
804
  ['PureCloud OAuth'],
698
805
  ['application/json'],
699
- ['application/json']
806
+ ['application/json'],
807
+ opts['customHeaders']
700
808
  );
701
809
  }
702
810
 
@@ -704,8 +812,12 @@ class ChatApi {
704
812
  * Update a user's chat settings
705
813
  *
706
814
  * @param {Object} body
815
+ * @param {Object} opts Optional parameters
816
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
707
817
  */
708
- patchChatsUsersMeSettings(body) {
818
+ patchChatsUsersMeSettings(body, opts) {
819
+ opts = opts || {};
820
+
709
821
  // verify the required parameter 'body' is set
710
822
  if (body === undefined || body === null) {
711
823
  throw 'Missing the required parameter "body" when calling patchChatsUsersMeSettings';
@@ -721,7 +833,8 @@ class ChatApi {
721
833
  body,
722
834
  ['PureCloud OAuth'],
723
835
  ['application/json'],
724
- ['application/json']
836
+ ['application/json'],
837
+ opts['customHeaders']
725
838
  );
726
839
  }
727
840
 
@@ -730,8 +843,12 @@ class ChatApi {
730
843
  *
731
844
  * @param {String} roomJid roomId
732
845
  * @param {Object} body messageBody
846
+ * @param {Object} opts Optional parameters
847
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
733
848
  */
734
- postChatsRoomMessages(roomJid, body) {
849
+ postChatsRoomMessages(roomJid, body, opts) {
850
+ opts = opts || {};
851
+
735
852
  // verify the required parameter 'roomJid' is set
736
853
  if (roomJid === undefined || roomJid === null || roomJid === '') {
737
854
  throw 'Missing the required parameter "roomJid" when calling postChatsRoomMessages';
@@ -751,7 +868,8 @@ class ChatApi {
751
868
  body,
752
869
  ['PureCloud OAuth'],
753
870
  ['application/json'],
754
- ['application/json']
871
+ ['application/json'],
872
+ opts['customHeaders']
755
873
  );
756
874
  }
757
875
 
@@ -760,8 +878,12 @@ class ChatApi {
760
878
  *
761
879
  * @param {String} roomJid roomJid
762
880
  * @param {Object} body Pinned Message Ids
881
+ * @param {Object} opts Optional parameters
882
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
763
883
  */
764
- postChatsRoomMessagesPins(roomJid, body) {
884
+ postChatsRoomMessagesPins(roomJid, body, opts) {
885
+ opts = opts || {};
886
+
765
887
  // verify the required parameter 'roomJid' is set
766
888
  if (roomJid === undefined || roomJid === null || roomJid === '') {
767
889
  throw 'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';
@@ -781,7 +903,8 @@ class ChatApi {
781
903
  body,
782
904
  ['PureCloud OAuth'],
783
905
  ['application/json'],
784
- ['application/json']
906
+ ['application/json'],
907
+ opts['customHeaders']
785
908
  );
786
909
  }
787
910
 
@@ -790,8 +913,12 @@ class ChatApi {
790
913
  *
791
914
  * @param {String} roomJid roomJid
792
915
  * @param {String} userId userId
916
+ * @param {Object} opts Optional parameters
917
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
793
918
  */
794
- postChatsRoomParticipant(roomJid, userId) {
919
+ postChatsRoomParticipant(roomJid, userId, opts) {
920
+ opts = opts || {};
921
+
795
922
  // verify the required parameter 'roomJid' is set
796
923
  if (roomJid === undefined || roomJid === null || roomJid === '') {
797
924
  throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
@@ -811,7 +938,8 @@ class ChatApi {
811
938
  null,
812
939
  ['PureCloud OAuth'],
813
940
  ['application/json'],
814
- ['application/json']
941
+ ['application/json'],
942
+ opts['customHeaders']
815
943
  );
816
944
  }
817
945
 
@@ -819,8 +947,12 @@ class ChatApi {
819
947
  * Create an adhoc room
820
948
  *
821
949
  * @param {Object} body Room properties
950
+ * @param {Object} opts Optional parameters
951
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
822
952
  */
823
- postChatsRooms(body) {
953
+ postChatsRooms(body, opts) {
954
+ opts = opts || {};
955
+
824
956
  // verify the required parameter 'body' is set
825
957
  if (body === undefined || body === null) {
826
958
  throw 'Missing the required parameter "body" when calling postChatsRooms';
@@ -836,7 +968,8 @@ class ChatApi {
836
968
  body,
837
969
  ['PureCloud OAuth'],
838
970
  ['application/json'],
839
- ['application/json']
971
+ ['application/json'],
972
+ opts['customHeaders']
840
973
  );
841
974
  }
842
975
 
@@ -845,8 +978,12 @@ class ChatApi {
845
978
  *
846
979
  * @param {String} userId userId
847
980
  * @param {Object} body message body
981
+ * @param {Object} opts Optional parameters
982
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
848
983
  */
849
- postChatsUserMessages(userId, body) {
984
+ postChatsUserMessages(userId, body, opts) {
985
+ opts = opts || {};
986
+
850
987
  // verify the required parameter 'userId' is set
851
988
  if (userId === undefined || userId === null || userId === '') {
852
989
  throw 'Missing the required parameter "userId" when calling postChatsUserMessages';
@@ -866,7 +1003,8 @@ class ChatApi {
866
1003
  body,
867
1004
  ['PureCloud OAuth'],
868
1005
  ['application/json'],
869
- ['application/json']
1006
+ ['application/json'],
1007
+ opts['customHeaders']
870
1008
  );
871
1009
  }
872
1010
 
@@ -875,8 +1013,12 @@ class ChatApi {
875
1013
  *
876
1014
  * @param {String} userId userId
877
1015
  * @param {Object} body Pinned Message Ids
1016
+ * @param {Object} opts Optional parameters
1017
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
878
1018
  */
879
- postChatsUserMessagesPins(userId, body) {
1019
+ postChatsUserMessagesPins(userId, body, opts) {
1020
+ opts = opts || {};
1021
+
880
1022
  // verify the required parameter 'userId' is set
881
1023
  if (userId === undefined || userId === null || userId === '') {
882
1024
  throw 'Missing the required parameter "userId" when calling postChatsUserMessagesPins';
@@ -896,7 +1038,8 @@ class ChatApi {
896
1038
  body,
897
1039
  ['PureCloud OAuth'],
898
1040
  ['application/json'],
899
- ['application/json']
1041
+ ['application/json'],
1042
+ opts['customHeaders']
900
1043
  );
901
1044
  }
902
1045
 
@@ -904,8 +1047,12 @@ class ChatApi {
904
1047
  * Create a user's chat settings
905
1048
  *
906
1049
  * @param {Object} body
1050
+ * @param {Object} opts Optional parameters
1051
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
907
1052
  */
908
- postChatsUsersMeSettings(body) {
1053
+ postChatsUsersMeSettings(body, opts) {
1054
+ opts = opts || {};
1055
+
909
1056
  // verify the required parameter 'body' is set
910
1057
  if (body === undefined || body === null) {
911
1058
  throw 'Missing the required parameter "body" when calling postChatsUsersMeSettings';
@@ -921,7 +1068,8 @@ class ChatApi {
921
1068
  body,
922
1069
  ['PureCloud OAuth'],
923
1070
  ['application/json'],
924
- ['application/json']
1071
+ ['application/json'],
1072
+ opts['customHeaders']
925
1073
  );
926
1074
  }
927
1075
 
@@ -930,8 +1078,12 @@ class ChatApi {
930
1078
  *
931
1079
  * @param {String} messageId messageId
932
1080
  * @param {Object} body reactionUpdate
1081
+ * @param {Object} opts Optional parameters
1082
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
933
1083
  */
934
- putChatsMessageReactions(messageId, body) {
1084
+ putChatsMessageReactions(messageId, body, opts) {
1085
+ opts = opts || {};
1086
+
935
1087
  // verify the required parameter 'messageId' is set
936
1088
  if (messageId === undefined || messageId === null || messageId === '') {
937
1089
  throw 'Missing the required parameter "messageId" when calling putChatsMessageReactions';
@@ -951,7 +1103,8 @@ class ChatApi {
951
1103
  body,
952
1104
  ['PureCloud OAuth'],
953
1105
  ['application/json'],
954
- ['application/json']
1106
+ ['application/json'],
1107
+ opts['customHeaders']
955
1108
  );
956
1109
  }
957
1110
 
@@ -959,8 +1112,12 @@ class ChatApi {
959
1112
  * Update Chat Settings.
960
1113
  *
961
1114
  * @param {Object} body Chat
1115
+ * @param {Object} opts Optional parameters
1116
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
962
1117
  */
963
- putChatsSettings(body) {
1118
+ putChatsSettings(body, opts) {
1119
+ opts = opts || {};
1120
+
964
1121
  // verify the required parameter 'body' is set
965
1122
  if (body === undefined || body === null) {
966
1123
  throw 'Missing the required parameter "body" when calling putChatsSettings';
@@ -976,7 +1133,8 @@ class ChatApi {
976
1133
  body,
977
1134
  ['PureCloud OAuth'],
978
1135
  ['application/json'],
979
- ['application/json']
1136
+ ['application/json'],
1137
+ opts['customHeaders']
980
1138
  );
981
1139
  }
982
1140