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 UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -25,8 +25,12 @@ class UsageApi {
25
25
  *
26
26
  * @param {String} executionId ID of the query execution
27
27
  * @param {String} clientId Client ID
28
+ * @param {Object} opts Optional parameters
29
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
28
30
  */
29
- getOauthClientUsageQueryResult(executionId, clientId) {
31
+ getOauthClientUsageQueryResult(executionId, clientId, opts) {
32
+ opts = opts || {};
33
+
30
34
  // verify the required parameter 'executionId' is set
31
35
  if (executionId === undefined || executionId === null || executionId === '') {
32
36
  throw 'Missing the required parameter "executionId" when calling getOauthClientUsageQueryResult';
@@ -46,7 +50,8 @@ class UsageApi {
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
 
@@ -56,6 +61,7 @@ class UsageApi {
56
61
  * @param {String} clientId Client ID
57
62
  * @param {Object} opts Optional parameters
58
63
  * @param {String} opts.days Previous number of days to query (default to 7)
64
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
59
65
  */
60
66
  getOauthClientUsageSummary(clientId, opts) {
61
67
  opts = opts || {};
@@ -75,7 +81,8 @@ class UsageApi {
75
81
  null,
76
82
  ['PureCloud OAuth'],
77
83
  ['application/json'],
78
- ['application/json']
84
+ ['application/json'],
85
+ opts['customHeaders']
79
86
  );
80
87
  }
81
88
 
@@ -86,6 +93,7 @@ class UsageApi {
86
93
  * @param {Object} opts Optional parameters
87
94
  * @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
88
95
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
96
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89
97
  */
90
98
  getUsageAggregatesQueryJob(jobId, opts) {
91
99
  opts = opts || {};
@@ -105,7 +113,8 @@ class UsageApi {
105
113
  null,
106
114
  ['PureCloud OAuth'],
107
115
  ['application/json'],
108
- ['application/json']
116
+ ['application/json'],
117
+ opts['customHeaders']
109
118
  );
110
119
  }
111
120
 
@@ -117,6 +126,7 @@ class UsageApi {
117
126
  * @param {Object} opts Optional parameters
118
127
  * @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
119
128
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
129
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
120
130
  */
121
131
  getUsageClientClientIdAggregatesQueryJob(clientId, jobId, opts) {
122
132
  opts = opts || {};
@@ -140,7 +150,8 @@ class UsageApi {
140
150
  null,
141
151
  ['PureCloud OAuth'],
142
152
  ['application/json'],
143
- ['application/json']
153
+ ['application/json'],
154
+ opts['customHeaders']
144
155
  );
145
156
  }
146
157
 
@@ -148,8 +159,12 @@ class UsageApi {
148
159
  * Get the results of a usage query
149
160
  *
150
161
  * @param {String} executionId ID of the query execution
162
+ * @param {Object} opts Optional parameters
163
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
151
164
  */
152
- getUsageQueryExecutionIdResults(executionId) {
165
+ getUsageQueryExecutionIdResults(executionId, opts) {
166
+ opts = opts || {};
167
+
153
168
  // verify the required parameter 'executionId' is set
154
169
  if (executionId === undefined || executionId === null || executionId === '') {
155
170
  throw 'Missing the required parameter "executionId" when calling getUsageQueryExecutionIdResults';
@@ -165,7 +180,8 @@ class UsageApi {
165
180
  null,
166
181
  ['PureCloud OAuth'],
167
182
  ['application/json'],
168
- ['application/json']
183
+ ['application/json'],
184
+ opts['customHeaders']
169
185
  );
170
186
  }
171
187
 
@@ -176,6 +192,7 @@ class UsageApi {
176
192
  * @param {Object} opts Optional parameters
177
193
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned
178
194
  * @param {Number} opts.pageSize The max number of entities to be returned per request. Maximum page size of 1000
195
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
179
196
  */
180
197
  getUsageSimplesearchExecutionIdResults(executionId, opts) {
181
198
  opts = opts || {};
@@ -195,7 +212,8 @@ class UsageApi {
195
212
  null,
196
213
  ['PureCloud OAuth'],
197
214
  ['application/json'],
198
- ['application/json']
215
+ ['application/json'],
216
+ opts['customHeaders']
199
217
  );
200
218
  }
201
219
 
@@ -204,8 +222,12 @@ class UsageApi {
204
222
  * After calling this method, you will then need to poll for the query results based on the returned execution Id
205
223
  * @param {String} clientId Client ID
206
224
  * @param {Object} body Query
225
+ * @param {Object} opts Optional parameters
226
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
207
227
  */
208
- postOauthClientUsageQuery(clientId, body) {
228
+ postOauthClientUsageQuery(clientId, body, opts) {
229
+ opts = opts || {};
230
+
209
231
  // verify the required parameter 'clientId' is set
210
232
  if (clientId === undefined || clientId === null || clientId === '') {
211
233
  throw 'Missing the required parameter "clientId" when calling postOauthClientUsageQuery';
@@ -225,7 +247,8 @@ class UsageApi {
225
247
  body,
226
248
  ['PureCloud OAuth'],
227
249
  ['application/json'],
228
- ['application/json']
250
+ ['application/json'],
251
+ opts['customHeaders']
229
252
  );
230
253
  }
231
254
 
@@ -233,8 +256,12 @@ class UsageApi {
233
256
  * Query your organization's public api usage.
234
257
  * After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
235
258
  * @param {Object} body Query
259
+ * @param {Object} opts Optional parameters
260
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
236
261
  */
237
- postUsageAggregatesQueryJobs(body) {
262
+ postUsageAggregatesQueryJobs(body, opts) {
263
+ opts = opts || {};
264
+
238
265
  // verify the required parameter 'body' is set
239
266
  if (body === undefined || body === null) {
240
267
  throw 'Missing the required parameter "body" when calling postUsageAggregatesQueryJobs';
@@ -250,7 +277,8 @@ class UsageApi {
250
277
  body,
251
278
  ['PureCloud OAuth'],
252
279
  ['application/json'],
253
- ['application/json']
280
+ ['application/json'],
281
+ opts['customHeaders']
254
282
  );
255
283
  }
256
284
 
@@ -259,8 +287,12 @@ class UsageApi {
259
287
  * After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
260
288
  * @param {String} clientId clientId
261
289
  * @param {Object} body Query
290
+ * @param {Object} opts Optional parameters
291
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
262
292
  */
263
- postUsageClientClientIdAggregatesQueryJobs(clientId, body) {
293
+ postUsageClientClientIdAggregatesQueryJobs(clientId, body, opts) {
294
+ opts = opts || {};
295
+
264
296
  // verify the required parameter 'clientId' is set
265
297
  if (clientId === undefined || clientId === null || clientId === '') {
266
298
  throw 'Missing the required parameter "clientId" when calling postUsageClientClientIdAggregatesQueryJobs';
@@ -280,7 +312,8 @@ class UsageApi {
280
312
  body,
281
313
  ['PureCloud OAuth'],
282
314
  ['application/json'],
283
- ['application/json']
315
+ ['application/json'],
316
+ opts['customHeaders']
284
317
  );
285
318
  }
286
319
 
@@ -288,8 +321,12 @@ class UsageApi {
288
321
  * Query organization API Usage -
289
322
  * After calling this method, you will then need to poll for the query results based on the returned execution Id
290
323
  * @param {Object} body Query
324
+ * @param {Object} opts Optional parameters
325
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
291
326
  */
292
- postUsageQuery(body) {
327
+ postUsageQuery(body, opts) {
328
+ opts = opts || {};
329
+
293
330
  // verify the required parameter 'body' is set
294
331
  if (body === undefined || body === null) {
295
332
  throw 'Missing the required parameter "body" when calling postUsageQuery';
@@ -305,7 +342,8 @@ class UsageApi {
305
342
  body,
306
343
  ['PureCloud OAuth'],
307
344
  ['application/json'],
308
- ['application/json']
345
+ ['application/json'],
346
+ opts['customHeaders']
309
347
  );
310
348
  }
311
349
 
@@ -313,8 +351,12 @@ class UsageApi {
313
351
  * Search organization API Usage
314
352
  * After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
315
353
  * @param {Object} body SimpleSearch
354
+ * @param {Object} opts Optional parameters
355
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
316
356
  */
317
- postUsageSimplesearch(body) {
357
+ postUsageSimplesearch(body, opts) {
358
+ opts = opts || {};
359
+
318
360
  // verify the required parameter 'body' is set
319
361
  if (body === undefined || body === null) {
320
362
  throw 'Missing the required parameter "body" when calling postUsageSimplesearch';
@@ -330,7 +372,8 @@ class UsageApi {
330
372
  body,
331
373
  ['PureCloud OAuth'],
332
374
  ['application/json'],
333
- ['application/json']
375
+ ['application/json'],
376
+ opts['customHeaders']
334
377
  );
335
378
  }
336
379
 
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class UserRecordingsApi {
24
24
  * Delete a user recording.
25
25
  *
26
26
  * @param {String} recordingId User Recording ID
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteUserrecording(recordingId) {
30
+ deleteUserrecording(recordingId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'recordingId' is set
30
34
  if (recordingId === undefined || recordingId === null || recordingId === '') {
31
35
  throw 'Missing the required parameter "recordingId" when calling deleteUserrecording';
@@ -41,7 +45,8 @@ class UserRecordingsApi {
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 UserRecordingsApi {
51
56
  * @param {String} recordingId User Recording ID
52
57
  * @param {Object} opts Optional parameters
53
58
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
59
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
54
60
  */
55
61
  getUserrecording(recordingId, opts) {
56
62
  opts = opts || {};
@@ -70,7 +76,8 @@ class UserRecordingsApi {
70
76
  null,
71
77
  ['PureCloud OAuth'],
72
78
  ['application/json'],
73
- ['application/json']
79
+ ['application/json'],
80
+ opts['customHeaders']
74
81
  );
75
82
  }
76
83
 
@@ -80,6 +87,7 @@ class UserRecordingsApi {
80
87
  * @param {String} recordingId User Recording ID
81
88
  * @param {Object} opts Optional parameters
82
89
  * @param {Object} opts.formatId The desired media format. (default to WEBM)
90
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
83
91
  */
84
92
  getUserrecordingTranscoding(recordingId, opts) {
85
93
  opts = opts || {};
@@ -99,7 +107,8 @@ class UserRecordingsApi {
99
107
  null,
100
108
  ['PureCloud OAuth'],
101
109
  ['application/json'],
102
- ['application/json']
110
+ ['application/json'],
111
+ opts['customHeaders']
103
112
  );
104
113
  }
105
114
 
@@ -110,6 +119,7 @@ class UserRecordingsApi {
110
119
  * @param {Number} opts.pageSize Page size (default to 25)
111
120
  * @param {Number} opts.pageNumber Page number (default to 1)
112
121
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
122
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
113
123
  */
114
124
  getUserrecordings(opts) {
115
125
  opts = opts || {};
@@ -125,15 +135,20 @@ class UserRecordingsApi {
125
135
  null,
126
136
  ['PureCloud OAuth'],
127
137
  ['application/json'],
128
- ['application/json']
138
+ ['application/json'],
139
+ opts['customHeaders']
129
140
  );
130
141
  }
131
142
 
132
143
  /**
133
144
  * Get user recording summary
134
145
  *
146
+ * @param {Object} opts Optional parameters
147
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
135
148
  */
136
- getUserrecordingsSummary() {
149
+ getUserrecordingsSummary(opts) {
150
+ opts = opts || {};
151
+
137
152
 
138
153
  return this.apiClient.callApi(
139
154
  '/api/v2/userrecordings/summary',
@@ -145,7 +160,8 @@ class UserRecordingsApi {
145
160
  null,
146
161
  ['PureCloud OAuth'],
147
162
  ['application/json'],
148
- ['application/json']
163
+ ['application/json'],
164
+ opts['customHeaders']
149
165
  );
150
166
  }
151
167
 
@@ -156,6 +172,7 @@ class UserRecordingsApi {
156
172
  * @param {Object} body UserRecording
157
173
  * @param {Object} opts Optional parameters
158
174
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
175
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
159
176
  */
160
177
  putUserrecording(recordingId, body, opts) {
161
178
  opts = opts || {};
@@ -179,7 +196,8 @@ class UserRecordingsApi {
179
196
  body,
180
197
  ['PureCloud OAuth'],
181
198
  ['application/json'],
182
- ['application/json']
199
+ ['application/json'],
200
+ opts['customHeaders']
183
201
  );
184
202
  }
185
203