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 SettingsApi {
5
5
  /**
6
6
  * Settings service.
7
7
  * @module purecloud-platform-client-v2/api/SettingsApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -23,8 +23,12 @@ class SettingsApi {
23
23
  /**
24
24
  * Reset email threading settings to default
25
25
  *
26
+ * @param {Object} opts Optional parameters
27
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
26
28
  */
27
- deleteEmailsSettingsThreading() {
29
+ deleteEmailsSettingsThreading(opts) {
30
+ opts = opts || {};
31
+
28
32
 
29
33
  return this.apiClient.callApi(
30
34
  '/api/v2/emails/settings/threading',
@@ -36,15 +40,20 @@ class SettingsApi {
36
40
  null,
37
41
  ['PureCloud OAuth'],
38
42
  ['application/json'],
39
- ['application/json']
43
+ ['application/json'],
44
+ opts['customHeaders']
40
45
  );
41
46
  }
42
47
 
43
48
  /**
44
49
  * Delete settings
45
50
  *
51
+ * @param {Object} opts Optional parameters
52
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
46
53
  */
47
- deleteExternalcontactsSettings() {
54
+ deleteExternalcontactsSettings(opts) {
55
+ opts = opts || {};
56
+
48
57
 
49
58
  return this.apiClient.callApi(
50
59
  '/api/v2/externalcontacts/settings',
@@ -56,7 +65,8 @@ class SettingsApi {
56
65
  null,
57
66
  ['PureCloud OAuth'],
58
67
  ['application/json'],
59
- ['application/json']
68
+ ['application/json'],
69
+ opts['customHeaders']
60
70
  );
61
71
  }
62
72
 
@@ -64,8 +74,12 @@ class SettingsApi {
64
74
  * Delete agent auto answer settings
65
75
  *
66
76
  * @param {String} agentId The agent to apply the auto answer settings to
77
+ * @param {Object} opts Optional parameters
78
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
67
79
  */
68
- deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
80
+ deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, opts) {
81
+ opts = opts || {};
82
+
69
83
  // verify the required parameter 'agentId' is set
70
84
  if (agentId === undefined || agentId === null || agentId === '') {
71
85
  throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
@@ -81,15 +95,20 @@ class SettingsApi {
81
95
  null,
82
96
  ['PureCloud OAuth'],
83
97
  ['application/json'],
84
- ['application/json']
98
+ ['application/json'],
99
+ opts['customHeaders']
85
100
  );
86
101
  }
87
102
 
88
103
  /**
89
104
  * Get email Contact Center settings
90
105
  *
106
+ * @param {Object} opts Optional parameters
107
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
91
108
  */
92
- getEmailsSettings() {
109
+ getEmailsSettings(opts) {
110
+ opts = opts || {};
111
+
93
112
 
94
113
  return this.apiClient.callApi(
95
114
  '/api/v2/emails/settings',
@@ -101,15 +120,20 @@ class SettingsApi {
101
120
  null,
102
121
  ['PureCloud OAuth'],
103
122
  ['application/json'],
104
- ['application/json']
123
+ ['application/json'],
124
+ opts['customHeaders']
105
125
  );
106
126
  }
107
127
 
108
128
  /**
109
129
  * Get email threading settings
110
130
  *
131
+ * @param {Object} opts Optional parameters
132
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
111
133
  */
112
- getEmailsSettingsThreading() {
134
+ getEmailsSettingsThreading(opts) {
135
+ opts = opts || {};
136
+
113
137
 
114
138
  return this.apiClient.callApi(
115
139
  '/api/v2/emails/settings/threading',
@@ -121,15 +145,20 @@ class SettingsApi {
121
145
  null,
122
146
  ['PureCloud OAuth'],
123
147
  ['application/json'],
124
- ['application/json']
148
+ ['application/json'],
149
+ opts['customHeaders']
125
150
  );
126
151
  }
127
152
 
128
153
  /**
129
154
  * Get settings
130
155
  *
156
+ * @param {Object} opts Optional parameters
157
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
131
158
  */
132
- getExternalcontactsSettings() {
159
+ getExternalcontactsSettings(opts) {
160
+ opts = opts || {};
161
+
133
162
 
134
163
  return this.apiClient.callApi(
135
164
  '/api/v2/externalcontacts/settings',
@@ -141,15 +170,20 @@ class SettingsApi {
141
170
  null,
142
171
  ['PureCloud OAuth'],
143
172
  ['application/json'],
144
- ['application/json']
173
+ ['application/json'],
174
+ opts['customHeaders']
145
175
  );
146
176
  }
147
177
 
148
178
  /**
149
179
  * Get the execution history enabled setting.
150
180
  * Get the execution history enabled setting.
181
+ * @param {Object} opts Optional parameters
182
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
151
183
  */
152
- getSettingsExecutiondata() {
184
+ getSettingsExecutiondata(opts) {
185
+ opts = opts || {};
186
+
153
187
 
154
188
  return this.apiClient.callApi(
155
189
  '/api/v2/settings/executiondata',
@@ -161,7 +195,8 @@ class SettingsApi {
161
195
  null,
162
196
  ['PureCloud OAuth'],
163
197
  ['application/json'],
164
- ['application/json']
198
+ ['application/json'],
199
+ opts['customHeaders']
165
200
  );
166
201
  }
167
202
 
@@ -169,8 +204,12 @@ class SettingsApi {
169
204
  * Get agent auto answer settings
170
205
  *
171
206
  * @param {String} agentId The agent to apply the auto answer settings to
207
+ * @param {Object} opts Optional parameters
208
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
172
209
  */
173
- getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
210
+ getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, opts) {
211
+ opts = opts || {};
212
+
174
213
  // verify the required parameter 'agentId' is set
175
214
  if (agentId === undefined || agentId === null || agentId === '') {
176
215
  throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
@@ -186,7 +225,8 @@ class SettingsApi {
186
225
  null,
187
226
  ['PureCloud OAuth'],
188
227
  ['application/json'],
189
- ['application/json']
228
+ ['application/json'],
229
+ opts['customHeaders']
190
230
  );
191
231
  }
192
232
 
@@ -195,6 +235,7 @@ class SettingsApi {
195
235
  *
196
236
  * @param {Object} opts Optional parameters
197
237
  * @param {Object} opts.body
238
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
198
239
  */
199
240
  patchEmailsSettings(opts) {
200
241
  opts = opts || {};
@@ -210,7 +251,8 @@ class SettingsApi {
210
251
  opts['body'],
211
252
  ['PureCloud OAuth'],
212
253
  ['application/json'],
213
- ['application/json']
254
+ ['application/json'],
255
+ opts['customHeaders']
214
256
  );
215
257
  }
216
258
 
@@ -219,6 +261,7 @@ class SettingsApi {
219
261
  *
220
262
  * @param {Object} opts Optional parameters
221
263
  * @param {Object} opts.body
264
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
222
265
  */
223
266
  patchEmailsSettingsThreading(opts) {
224
267
  opts = opts || {};
@@ -234,7 +277,8 @@ class SettingsApi {
234
277
  opts['body'],
235
278
  ['PureCloud OAuth'],
236
279
  ['application/json'],
237
- ['application/json']
280
+ ['application/json'],
281
+ opts['customHeaders']
238
282
  );
239
283
  }
240
284
 
@@ -242,8 +286,12 @@ class SettingsApi {
242
286
  * Edit the execution history on off setting.
243
287
  * Edit the execution history on off setting.
244
288
  * @param {Object} body New Execution Data Setting
289
+ * @param {Object} opts Optional parameters
290
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
245
291
  */
246
- patchSettingsExecutiondata(body) {
292
+ patchSettingsExecutiondata(body, opts) {
293
+ opts = opts || {};
294
+
247
295
  // verify the required parameter 'body' is set
248
296
  if (body === undefined || body === null) {
249
297
  throw 'Missing the required parameter "body" when calling patchSettingsExecutiondata';
@@ -259,7 +307,8 @@ class SettingsApi {
259
307
  body,
260
308
  ['PureCloud OAuth'],
261
309
  ['application/json'],
262
- ['application/json']
310
+ ['application/json'],
311
+ opts['customHeaders']
263
312
  );
264
313
  }
265
314
 
@@ -268,8 +317,12 @@ class SettingsApi {
268
317
  *
269
318
  * @param {String} agentId The agent to apply the auto answer settings to
270
319
  * @param {Object} body AutoAnswerSettings
320
+ * @param {Object} opts Optional parameters
321
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
271
322
  */
272
- patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
323
+ patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body, opts) {
324
+ opts = opts || {};
325
+
273
326
  // verify the required parameter 'agentId' is set
274
327
  if (agentId === undefined || agentId === null || agentId === '') {
275
328
  throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
@@ -289,7 +342,8 @@ class SettingsApi {
289
342
  body,
290
343
  ['PureCloud OAuth'],
291
344
  ['application/json'],
292
- ['application/json']
345
+ ['application/json'],
346
+ opts['customHeaders']
293
347
  );
294
348
  }
295
349
 
@@ -298,6 +352,7 @@ class SettingsApi {
298
352
  *
299
353
  * @param {Object} opts Optional parameters
300
354
  * @param {Object} opts.body
355
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
301
356
  */
302
357
  putExternalcontactsSettings(opts) {
303
358
  opts = opts || {};
@@ -313,7 +368,8 @@ class SettingsApi {
313
368
  opts['body'],
314
369
  ['PureCloud OAuth'],
315
370
  ['application/json'],
316
- ['application/json']
371
+ ['application/json'],
372
+ opts['customHeaders']
317
373
  );
318
374
  }
319
375
 
@@ -322,8 +378,12 @@ class SettingsApi {
322
378
  *
323
379
  * @param {String} agentId The agent to apply the auto answer settings to
324
380
  * @param {Object} body AutoAnswerSettings
381
+ * @param {Object} opts Optional parameters
382
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
325
383
  */
326
- putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
384
+ putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body, opts) {
385
+ opts = opts || {};
386
+
327
387
  // verify the required parameter 'agentId' is set
328
388
  if (agentId === undefined || agentId === null || agentId === '') {
329
389
  throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
@@ -343,7 +403,8 @@ class SettingsApi {
343
403
  body,
344
404
  ['PureCloud OAuth'],
345
405
  ['application/json'],
346
- ['application/json']
406
+ ['application/json'],
407
+ opts['customHeaders']
347
408
  );
348
409
  }
349
410