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 MessagingApi {
5
5
  /**
6
6
  * Messaging service.
7
7
  * @module purecloud-platform-client-v2/api/MessagingApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,9 +24,13 @@ class MessagingApi {
24
24
  * Delete a messaging setting
25
25
  *
26
26
  * @param {String} messageSettingId Message Settings ID
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  * @deprecated
28
30
  */
29
- deleteMessagingSetting(messageSettingId) {
31
+ deleteMessagingSetting(messageSettingId, opts) {
32
+ opts = opts || {};
33
+
30
34
  // verify the required parameter 'messageSettingId' is set
31
35
  if (messageSettingId === undefined || messageSettingId === null || messageSettingId === '') {
32
36
  throw 'Missing the required parameter "messageSettingId" when calling deleteMessagingSetting';
@@ -42,16 +46,21 @@ class MessagingApi {
42
46
  null,
43
47
  ['PureCloud OAuth'],
44
48
  ['application/json'],
45
- ['application/json']
49
+ ['application/json'],
50
+ opts['customHeaders']
46
51
  );
47
52
  }
48
53
 
49
54
  /**
50
55
  * Delete the organization's default setting, a global default will be applied to integrations without settings
51
56
  * When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
57
+ * @param {Object} opts Optional parameters
58
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
52
59
  * @deprecated
53
60
  */
54
- deleteMessagingSettingsDefault() {
61
+ deleteMessagingSettingsDefault(opts) {
62
+ opts = opts || {};
63
+
55
64
 
56
65
  return this.apiClient.callApi(
57
66
  '/api/v2/messaging/settings/default',
@@ -63,7 +72,8 @@ class MessagingApi {
63
72
  null,
64
73
  ['PureCloud OAuth'],
65
74
  ['application/json'],
66
- ['application/json']
75
+ ['application/json'],
76
+ opts['customHeaders']
67
77
  );
68
78
  }
69
79
 
@@ -71,9 +81,13 @@ class MessagingApi {
71
81
  * Delete a supported content profile
72
82
  * Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
73
83
  * @param {String} supportedContentId Supported Content ID
84
+ * @param {Object} opts Optional parameters
85
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
74
86
  * @deprecated
75
87
  */
76
- deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
88
+ deleteMessagingSupportedcontentSupportedContentId(supportedContentId, opts) {
89
+ opts = opts || {};
90
+
77
91
  // verify the required parameter 'supportedContentId' is set
78
92
  if (supportedContentId === undefined || supportedContentId === null || supportedContentId === '') {
79
93
  throw 'Missing the required parameter "supportedContentId" when calling deleteMessagingSupportedcontentSupportedContentId';
@@ -89,7 +103,8 @@ class MessagingApi {
89
103
  null,
90
104
  ['PureCloud OAuth'],
91
105
  ['application/json'],
92
- ['application/json']
106
+ ['application/json'],
107
+ opts['customHeaders']
93
108
  );
94
109
  }
95
110
 
@@ -97,9 +112,13 @@ class MessagingApi {
97
112
  * Get a messaging setting
98
113
  *
99
114
  * @param {String} messageSettingId Message Settings ID
115
+ * @param {Object} opts Optional parameters
116
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
100
117
  * @deprecated
101
118
  */
102
- getMessagingSetting(messageSettingId) {
119
+ getMessagingSetting(messageSettingId, opts) {
120
+ opts = opts || {};
121
+
103
122
  // verify the required parameter 'messageSettingId' is set
104
123
  if (messageSettingId === undefined || messageSettingId === null || messageSettingId === '') {
105
124
  throw 'Missing the required parameter "messageSettingId" when calling getMessagingSetting';
@@ -115,7 +134,8 @@ class MessagingApi {
115
134
  null,
116
135
  ['PureCloud OAuth'],
117
136
  ['application/json'],
118
- ['application/json']
137
+ ['application/json'],
138
+ opts['customHeaders']
119
139
  );
120
140
  }
121
141
 
@@ -125,6 +145,7 @@ class MessagingApi {
125
145
  * @param {Object} opts Optional parameters
126
146
  * @param {Number} opts.pageSize Page size (default to 25)
127
147
  * @param {Number} opts.pageNumber Page number (default to 1)
148
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
128
149
  * @deprecated
129
150
  */
130
151
  getMessagingSettings(opts) {
@@ -141,16 +162,21 @@ class MessagingApi {
141
162
  null,
142
163
  ['PureCloud OAuth'],
143
164
  ['application/json'],
144
- ['application/json']
165
+ ['application/json'],
166
+ opts['customHeaders']
145
167
  );
146
168
  }
147
169
 
148
170
  /**
149
171
  * Get the organization's default settings that will be used as the default when creating an integration.
150
172
  * When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
173
+ * @param {Object} opts Optional parameters
174
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
151
175
  * @deprecated
152
176
  */
153
- getMessagingSettingsDefault() {
177
+ getMessagingSettingsDefault(opts) {
178
+ opts = opts || {};
179
+
154
180
 
155
181
  return this.apiClient.callApi(
156
182
  '/api/v2/messaging/settings/default',
@@ -162,7 +188,8 @@ class MessagingApi {
162
188
  null,
163
189
  ['PureCloud OAuth'],
164
190
  ['application/json'],
165
- ['application/json']
191
+ ['application/json'],
192
+ opts['customHeaders']
166
193
  );
167
194
  }
168
195
 
@@ -172,6 +199,7 @@ class MessagingApi {
172
199
  * @param {Object} opts Optional parameters
173
200
  * @param {Number} opts.pageSize Page size (default to 25)
174
201
  * @param {Number} opts.pageNumber Page number (default to 1)
202
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
175
203
  * @deprecated
176
204
  */
177
205
  getMessagingSupportedcontent(opts) {
@@ -188,7 +216,8 @@ class MessagingApi {
188
216
  null,
189
217
  ['PureCloud OAuth'],
190
218
  ['application/json'],
191
- ['application/json']
219
+ ['application/json'],
220
+ opts['customHeaders']
192
221
  );
193
222
  }
194
223
 
@@ -196,9 +225,13 @@ class MessagingApi {
196
225
  * Get a supported content profile
197
226
  * Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
198
227
  * @param {String} supportedContentId Supported Content ID
228
+ * @param {Object} opts Optional parameters
229
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
199
230
  * @deprecated
200
231
  */
201
- getMessagingSupportedcontentSupportedContentId(supportedContentId) {
232
+ getMessagingSupportedcontentSupportedContentId(supportedContentId, opts) {
233
+ opts = opts || {};
234
+
202
235
  // verify the required parameter 'supportedContentId' is set
203
236
  if (supportedContentId === undefined || supportedContentId === null || supportedContentId === '') {
204
237
  throw 'Missing the required parameter "supportedContentId" when calling getMessagingSupportedcontentSupportedContentId';
@@ -214,7 +247,8 @@ class MessagingApi {
214
247
  null,
215
248
  ['PureCloud OAuth'],
216
249
  ['application/json'],
217
- ['application/json']
250
+ ['application/json'],
251
+ opts['customHeaders']
218
252
  );
219
253
  }
220
254
 
@@ -223,9 +257,13 @@ class MessagingApi {
223
257
  *
224
258
  * @param {String} messageSettingId Message Settings ID
225
259
  * @param {Object} body MessagingSetting
260
+ * @param {Object} opts Optional parameters
261
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
226
262
  * @deprecated
227
263
  */
228
- patchMessagingSetting(messageSettingId, body) {
264
+ patchMessagingSetting(messageSettingId, body, opts) {
265
+ opts = opts || {};
266
+
229
267
  // verify the required parameter 'messageSettingId' is set
230
268
  if (messageSettingId === undefined || messageSettingId === null || messageSettingId === '') {
231
269
  throw 'Missing the required parameter "messageSettingId" when calling patchMessagingSetting';
@@ -245,7 +283,8 @@ class MessagingApi {
245
283
  body,
246
284
  ['PureCloud OAuth'],
247
285
  ['application/json'],
248
- ['application/json']
286
+ ['application/json'],
287
+ opts['customHeaders']
249
288
  );
250
289
  }
251
290
 
@@ -254,9 +293,13 @@ class MessagingApi {
254
293
  * Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
255
294
  * @param {String} supportedContentId Supported Content ID
256
295
  * @param {Object} body SupportedContent
296
+ * @param {Object} opts Optional parameters
297
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
257
298
  * @deprecated
258
299
  */
259
- patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
300
+ patchMessagingSupportedcontentSupportedContentId(supportedContentId, body, opts) {
301
+ opts = opts || {};
302
+
260
303
  // verify the required parameter 'supportedContentId' is set
261
304
  if (supportedContentId === undefined || supportedContentId === null || supportedContentId === '') {
262
305
  throw 'Missing the required parameter "supportedContentId" when calling patchMessagingSupportedcontentSupportedContentId';
@@ -276,7 +319,8 @@ class MessagingApi {
276
319
  body,
277
320
  ['PureCloud OAuth'],
278
321
  ['application/json'],
279
- ['application/json']
322
+ ['application/json'],
323
+ opts['customHeaders']
280
324
  );
281
325
  }
282
326
 
@@ -284,9 +328,13 @@ class MessagingApi {
284
328
  * Create a messaging setting
285
329
  *
286
330
  * @param {Object} body MessagingSetting
331
+ * @param {Object} opts Optional parameters
332
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
287
333
  * @deprecated
288
334
  */
289
- postMessagingSettings(body) {
335
+ postMessagingSettings(body, opts) {
336
+ opts = opts || {};
337
+
290
338
  // verify the required parameter 'body' is set
291
339
  if (body === undefined || body === null) {
292
340
  throw 'Missing the required parameter "body" when calling postMessagingSettings';
@@ -302,7 +350,8 @@ class MessagingApi {
302
350
  body,
303
351
  ['PureCloud OAuth'],
304
352
  ['application/json'],
305
- ['application/json']
353
+ ['application/json'],
354
+ opts['customHeaders']
306
355
  );
307
356
  }
308
357
 
@@ -310,9 +359,13 @@ class MessagingApi {
310
359
  * Create a Supported Content profile
311
360
  * Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
312
361
  * @param {Object} body SupportedContent
362
+ * @param {Object} opts Optional parameters
363
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
313
364
  * @deprecated
314
365
  */
315
- postMessagingSupportedcontent(body) {
366
+ postMessagingSupportedcontent(body, opts) {
367
+ opts = opts || {};
368
+
316
369
  // verify the required parameter 'body' is set
317
370
  if (body === undefined || body === null) {
318
371
  throw 'Missing the required parameter "body" when calling postMessagingSupportedcontent';
@@ -328,7 +381,8 @@ class MessagingApi {
328
381
  body,
329
382
  ['PureCloud OAuth'],
330
383
  ['application/json'],
331
- ['application/json']
384
+ ['application/json'],
385
+ opts['customHeaders']
332
386
  );
333
387
  }
334
388
 
@@ -336,9 +390,13 @@ class MessagingApi {
336
390
  * Set the organization's default settings that may be applied to an integration when it is created.
337
391
  * When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
338
392
  * @param {Object} body Messaging Setting ID
393
+ * @param {Object} opts Optional parameters
394
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
339
395
  * @deprecated
340
396
  */
341
- putMessagingSettingsDefault(body) {
397
+ putMessagingSettingsDefault(body, opts) {
398
+ opts = opts || {};
399
+
342
400
  // verify the required parameter 'body' is set
343
401
  if (body === undefined || body === null) {
344
402
  throw 'Missing the required parameter "body" when calling putMessagingSettingsDefault';
@@ -354,7 +412,8 @@ class MessagingApi {
354
412
  body,
355
413
  ['PureCloud OAuth'],
356
414
  ['application/json'],
357
- ['application/json']
415
+ ['application/json'],
416
+ opts['customHeaders']
358
417
  );
359
418
  }
360
419
 
@@ -5,7 +5,7 @@ class MobileDevicesApi {
5
5
  /**
6
6
  * MobileDevices service.
7
7
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class MobileDevicesApi {
24
24
  * Delete device
25
25
  *
26
26
  * @param {String} deviceId Device ID
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteMobiledevice(deviceId) {
30
+ deleteMobiledevice(deviceId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'deviceId' is set
30
34
  if (deviceId === undefined || deviceId === null || deviceId === '') {
31
35
  throw 'Missing the required parameter "deviceId" when calling deleteMobiledevice';
@@ -41,7 +45,8 @@ class MobileDevicesApi {
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 MobileDevicesApi {
49
54
  * Get device
50
55
  *
51
56
  * @param {String} deviceId Device ID
57
+ * @param {Object} opts Optional parameters
58
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
52
59
  */
53
- getMobiledevice(deviceId) {
60
+ getMobiledevice(deviceId, opts) {
61
+ opts = opts || {};
62
+
54
63
  // verify the required parameter 'deviceId' is set
55
64
  if (deviceId === undefined || deviceId === null || deviceId === '') {
56
65
  throw 'Missing the required parameter "deviceId" when calling getMobiledevice';
@@ -66,7 +75,8 @@ class MobileDevicesApi {
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 MobileDevicesApi {
77
87
  * @param {Number} opts.pageSize Page size (default to 25)
78
88
  * @param {Number} opts.pageNumber Page number (default to 1)
79
89
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ascending)
90
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
80
91
  */
81
92
  getMobiledevices(opts) {
82
93
  opts = opts || {};
@@ -92,7 +103,8 @@ class MobileDevicesApi {
92
103
  null,
93
104
  ['PureCloud OAuth'],
94
105
  ['application/json'],
95
- ['application/json']
106
+ ['application/json'],
107
+ opts['customHeaders']
96
108
  );
97
109
  }
98
110
 
@@ -100,8 +112,12 @@ class MobileDevicesApi {
100
112
  * Create User device
101
113
  *
102
114
  * @param {Object} body Device
115
+ * @param {Object} opts Optional parameters
116
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
103
117
  */
104
- postMobiledevices(body) {
118
+ postMobiledevices(body, opts) {
119
+ opts = opts || {};
120
+
105
121
  // verify the required parameter 'body' is set
106
122
  if (body === undefined || body === null) {
107
123
  throw 'Missing the required parameter "body" when calling postMobiledevices';
@@ -117,7 +133,8 @@ class MobileDevicesApi {
117
133
  body,
118
134
  ['PureCloud OAuth'],
119
135
  ['application/json'],
120
- ['application/json']
136
+ ['application/json'],
137
+ opts['customHeaders']
121
138
  );
122
139
  }
123
140
 
@@ -127,6 +144,7 @@ class MobileDevicesApi {
127
144
  * @param {String} deviceId Device ID
128
145
  * @param {Object} opts Optional parameters
129
146
  * @param {Object} opts.body Device
147
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
130
148
  */
131
149
  putMobiledevice(deviceId, opts) {
132
150
  opts = opts || {};
@@ -146,7 +164,8 @@ class MobileDevicesApi {
146
164
  opts['body'],
147
165
  ['PureCloud OAuth'],
148
166
  ['application/json'],
149
- ['application/json']
167
+ ['application/json'],
168
+ opts['customHeaders']
150
169
  );
151
170
  }
152
171
 
@@ -5,7 +5,7 @@ class NotificationsApi {
5
5
  /**
6
6
  * Notifications service.
7
7
  * @module purecloud-platform-client-v2/api/NotificationsApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class NotificationsApi {
24
24
  * Remove all subscriptions
25
25
  *
26
26
  * @param {String} channelId Channel ID
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteNotificationsChannelSubscriptions(channelId) {
30
+ deleteNotificationsChannelSubscriptions(channelId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'channelId' is set
30
34
  if (channelId === undefined || channelId === null || channelId === '') {
31
35
  throw 'Missing the required parameter "channelId" when calling deleteNotificationsChannelSubscriptions';
@@ -41,7 +45,8 @@ class NotificationsApi {
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
 
@@ -51,6 +56,7 @@ class NotificationsApi {
51
56
  * @param {Object} opts Optional parameters
52
57
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
53
58
  * @param {Boolean} opts.includePreview Whether or not to include Preview topics (default to true)
59
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
54
60
  */
55
61
  getNotificationsAvailabletopics(opts) {
56
62
  opts = opts || {};
@@ -66,7 +72,8 @@ class NotificationsApi {
66
72
  null,
67
73
  ['PureCloud OAuth'],
68
74
  ['application/json'],
69
- ['application/json']
75
+ ['application/json'],
76
+ opts['customHeaders']
70
77
  );
71
78
  }
72
79
 
@@ -74,8 +81,12 @@ class NotificationsApi {
74
81
  * The list of all subscriptions for this channel
75
82
  *
76
83
  * @param {String} channelId Channel ID
84
+ * @param {Object} opts Optional parameters
85
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
77
86
  */
78
- getNotificationsChannelSubscriptions(channelId) {
87
+ getNotificationsChannelSubscriptions(channelId, opts) {
88
+ opts = opts || {};
89
+
79
90
  // verify the required parameter 'channelId' is set
80
91
  if (channelId === undefined || channelId === null || channelId === '') {
81
92
  throw 'Missing the required parameter "channelId" when calling getNotificationsChannelSubscriptions';
@@ -91,7 +102,8 @@ class NotificationsApi {
91
102
  null,
92
103
  ['PureCloud OAuth'],
93
104
  ['application/json'],
94
- ['application/json']
105
+ ['application/json'],
106
+ opts['customHeaders']
95
107
  );
96
108
  }
97
109
 
@@ -100,6 +112,7 @@ class NotificationsApi {
100
112
  *
101
113
  * @param {Object} opts Optional parameters
102
114
  * @param {Object} opts.includechannels Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence. (default to token)
115
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
103
116
  */
104
117
  getNotificationsChannels(opts) {
105
118
  opts = opts || {};
@@ -115,7 +128,8 @@ class NotificationsApi {
115
128
  null,
116
129
  ['PureCloud OAuth'],
117
130
  ['application/json'],
118
- ['application/json']
131
+ ['application/json'],
132
+ opts['customHeaders']
119
133
  );
120
134
  }
121
135
 
@@ -123,8 +137,12 @@ class NotificationsApi {
123
137
  * Verify a channel still exists and is valid
124
138
  * Returns a 200 OK if channel exists, and a 404 Not Found if it doesnt
125
139
  * @param {String} channelId Channel ID
140
+ * @param {Object} opts Optional parameters
141
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
126
142
  */
127
- headNotificationsChannel(channelId) {
143
+ headNotificationsChannel(channelId, opts) {
144
+ opts = opts || {};
145
+
128
146
  // verify the required parameter 'channelId' is set
129
147
  if (channelId === undefined || channelId === null || channelId === '') {
130
148
  throw 'Missing the required parameter "channelId" when calling headNotificationsChannel';
@@ -140,7 +158,8 @@ class NotificationsApi {
140
158
  null,
141
159
  ['PureCloud OAuth'],
142
160
  ['application/json'],
143
- ['application/json']
161
+ ['application/json'],
162
+ opts['customHeaders']
144
163
  );
145
164
  }
146
165
 
@@ -151,6 +170,7 @@ class NotificationsApi {
151
170
  * @param {Array.<Object>} body Body
152
171
  * @param {Object} opts Optional parameters
153
172
  * @param {Boolean} opts.ignoreErrors Optionally prevent throwing of errors for failed permissions checks. (default to false)
173
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
154
174
  */
155
175
  postNotificationsChannelSubscriptions(channelId, body, opts) {
156
176
  opts = opts || {};
@@ -174,15 +194,20 @@ class NotificationsApi {
174
194
  body,
175
195
  ['PureCloud OAuth'],
176
196
  ['application/json'],
177
- ['application/json']
197
+ ['application/json'],
198
+ opts['customHeaders']
178
199
  );
179
200
  }
180
201
 
181
202
  /**
182
203
  * Create a new channel
183
204
  * There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.
205
+ * @param {Object} opts Optional parameters
206
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
184
207
  */
185
- postNotificationsChannels() {
208
+ postNotificationsChannels(opts) {
209
+ opts = opts || {};
210
+
186
211
 
187
212
  return this.apiClient.callApi(
188
213
  '/api/v2/notifications/channels',
@@ -194,7 +219,8 @@ class NotificationsApi {
194
219
  null,
195
220
  ['PureCloud OAuth'],
196
221
  ['application/json'],
197
- ['application/json']
222
+ ['application/json'],
223
+ opts['customHeaders']
198
224
  );
199
225
  }
200
226
 
@@ -205,6 +231,7 @@ class NotificationsApi {
205
231
  * @param {Array.<Object>} body Body
206
232
  * @param {Object} opts Optional parameters
207
233
  * @param {Boolean} opts.ignoreErrors Optionally prevent throwing of errors for failed permissions checks. (default to false)
234
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
208
235
  */
209
236
  putNotificationsChannelSubscriptions(channelId, body, opts) {
210
237
  opts = opts || {};
@@ -228,7 +255,8 @@ class NotificationsApi {
228
255
  body,
229
256
  ['PureCloud OAuth'],
230
257
  ['application/json'],
231
- ['application/json']
258
+ ['application/json'],
259
+ opts['customHeaders']
232
260
  );
233
261
  }
234
262