purecloud-platform-client-v2 216.0.0 → 218.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 (91) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1546 -567
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1546 -567
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +502 -282
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +507 -285
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +951 -292
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -305
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +112 -1
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +9 -8
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -8
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +387 -2
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +243 -4
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +5 -3
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +13 -16
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +9 -8
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -68
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +19 -7
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -2
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -29
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +182 -1
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +403 -20
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -3
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +58 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class ScriptsApi {
5
5
  /**
6
6
  * Scripts service.
7
7
  * @module purecloud-platform-client-v2/api/ScriptsApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SearchApi {
5
5
  /**
6
6
  * Search service.
7
7
  * @module purecloud-platform-client-v2/api/SearchApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SettingsApi {
5
5
  /**
6
6
  * Settings service.
7
7
  * @module purecloud-platform-client-v2/api/SettingsApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SocialMediaApi {
5
5
  /**
6
6
  * SocialMedia service.
7
7
  * @module purecloud-platform-client-v2/api/SocialMediaApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -20,13 +20,63 @@ class SocialMediaApi {
20
20
  }
21
21
 
22
22
 
23
+ /**
24
+ * Delete an escalation rule.
25
+ *
26
+ * @param {String} escalationRuleId escalationRuleId
27
+ */
28
+ deleteSocialmediaEscalationrule(escalationRuleId) {
29
+ // verify the required parameter 'escalationRuleId' is set
30
+ if (escalationRuleId === undefined || escalationRuleId === null) {
31
+ throw 'Missing the required parameter "escalationRuleId" when calling deleteSocialmediaEscalationrule';
32
+ }
33
+
34
+ return this.apiClient.callApi(
35
+ '/api/v2/socialmedia/escalationrules/{escalationRuleId}',
36
+ 'DELETE',
37
+ { 'escalationRuleId': escalationRuleId },
38
+ { },
39
+ { },
40
+ { },
41
+ null,
42
+ ['PureCloud OAuth'],
43
+ ['application/json'],
44
+ ['application/json']
45
+ );
46
+ }
47
+
48
+ /**
49
+ * Delete a social media message.
50
+ *
51
+ * @param {String} messageId messageId
52
+ * deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53
+ */
54
+ deleteSocialmediaMessage(messageId) {
55
+ // verify the required parameter 'messageId' is set
56
+ if (messageId === undefined || messageId === null) {
57
+ throw 'Missing the required parameter "messageId" when calling deleteSocialmediaMessage';
58
+ }
59
+
60
+ return this.apiClient.callApi(
61
+ '/api/v2/socialmedia/messages/{messageId}',
62
+ 'DELETE',
63
+ { 'messageId': messageId },
64
+ { },
65
+ { },
66
+ { },
67
+ null,
68
+ ['PureCloud OAuth'],
69
+ ['application/json'],
70
+ ['application/json']
71
+ );
72
+ }
73
+
23
74
  /**
24
75
  * Delete a social topic.
25
76
  *
26
77
  * @param {String} topicId topicId
27
78
  * @param {Object} opts Optional parameters
28
79
  * @param {Boolean} opts.hardDelete Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default.
29
- * deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30
80
  */
31
81
  deleteSocialmediaTopic(topicId, opts) {
32
82
  opts = opts || {};
@@ -57,7 +107,6 @@ class SocialMediaApi {
57
107
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
58
108
  * @param {Object} opts Optional parameters
59
109
  * @param {Boolean} opts.hardDelete Determines whether a Facebook data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
60
- * deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61
110
  */
62
111
  deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
63
112
  opts = opts || {};
@@ -127,7 +176,6 @@ class SocialMediaApi {
127
176
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
128
177
  * @param {Object} opts Optional parameters
129
178
  * @param {Boolean} opts.hardDelete Determines whether a X (formally Twitter) data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
130
- * deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
131
179
  */
132
180
  deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
133
181
  opts = opts || {};
@@ -155,13 +203,175 @@ class SocialMediaApi {
155
203
  );
156
204
  }
157
205
 
206
+ /**
207
+ * Get status for async query for social media aggregates
208
+ *
209
+ * @param {String} jobId jobId
210
+ */
211
+ getSocialmediaAnalyticsAggregatesJob(jobId) {
212
+ // verify the required parameter 'jobId' is set
213
+ if (jobId === undefined || jobId === null) {
214
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJob';
215
+ }
216
+
217
+ return this.apiClient.callApi(
218
+ '/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}',
219
+ 'GET',
220
+ { 'jobId': jobId },
221
+ { },
222
+ { },
223
+ { },
224
+ null,
225
+ ['PureCloud OAuth'],
226
+ ['application/json'],
227
+ ['application/json']
228
+ );
229
+ }
230
+
231
+ /**
232
+ * Fetch a page of results for an async social media query
233
+ *
234
+ * @param {String} jobId jobId
235
+ * @param {Object} opts Optional parameters
236
+ * @param {String} opts.cursor Cursor token to retrieve next page
237
+ */
238
+ getSocialmediaAnalyticsAggregatesJobResults(jobId, opts) {
239
+ opts = opts || {};
240
+
241
+ // verify the required parameter 'jobId' is set
242
+ if (jobId === undefined || jobId === null) {
243
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJobResults';
244
+ }
245
+
246
+ return this.apiClient.callApi(
247
+ '/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results',
248
+ 'GET',
249
+ { 'jobId': jobId },
250
+ { 'cursor': opts['cursor'] },
251
+ { },
252
+ { },
253
+ null,
254
+ ['PureCloud OAuth'],
255
+ ['application/json'],
256
+ ['application/json']
257
+ );
258
+ }
259
+
260
+ /**
261
+ * Get status for async query for social media messages job
262
+ *
263
+ * @param {String} jobId jobId
264
+ */
265
+ getSocialmediaAnalyticsMessagesJob(jobId) {
266
+ // verify the required parameter 'jobId' is set
267
+ if (jobId === undefined || jobId === null) {
268
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJob';
269
+ }
270
+
271
+ return this.apiClient.callApi(
272
+ '/api/v2/socialmedia/analytics/messages/jobs/{jobId}',
273
+ 'GET',
274
+ { 'jobId': jobId },
275
+ { },
276
+ { },
277
+ { },
278
+ null,
279
+ ['PureCloud OAuth'],
280
+ ['application/json'],
281
+ ['application/json']
282
+ );
283
+ }
284
+
285
+ /**
286
+ * Fetch a page of results for an async social media messages query
287
+ *
288
+ * @param {String} jobId jobId
289
+ * @param {Object} opts Optional parameters
290
+ * @param {String} opts.cursor Cursor token to retrieve next page
291
+ */
292
+ getSocialmediaAnalyticsMessagesJobResults(jobId, opts) {
293
+ opts = opts || {};
294
+
295
+ // verify the required parameter 'jobId' is set
296
+ if (jobId === undefined || jobId === null) {
297
+ throw 'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJobResults';
298
+ }
299
+
300
+ return this.apiClient.callApi(
301
+ '/api/v2/socialmedia/analytics/messages/jobs/{jobId}/results',
302
+ 'GET',
303
+ { 'jobId': jobId },
304
+ { 'cursor': opts['cursor'] },
305
+ { },
306
+ { },
307
+ null,
308
+ ['PureCloud OAuth'],
309
+ ['application/json'],
310
+ ['application/json']
311
+ );
312
+ }
313
+
314
+ /**
315
+ * Get a single escalation rule.
316
+ *
317
+ * @param {String} escalationRuleId escalationRuleId
318
+ */
319
+ getSocialmediaEscalationrule(escalationRuleId) {
320
+ // verify the required parameter 'escalationRuleId' is set
321
+ if (escalationRuleId === undefined || escalationRuleId === null) {
322
+ throw 'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';
323
+ }
324
+
325
+ return this.apiClient.callApi(
326
+ '/api/v2/socialmedia/escalationrules/{escalationRuleId}',
327
+ 'GET',
328
+ { 'escalationRuleId': escalationRuleId },
329
+ { },
330
+ { },
331
+ { },
332
+ null,
333
+ ['PureCloud OAuth'],
334
+ ['application/json'],
335
+ ['application/json']
336
+ );
337
+ }
338
+
339
+ /**
340
+ * Retrieve all escalation rules for a division.
341
+ *
342
+ * @param {String} divisionId One division ID
343
+ * @param {Object} opts Optional parameters
344
+ * @param {Number} opts.pageNumber Page number (default to 1)
345
+ * @param {Number} opts.pageSize Page size (default to 25)
346
+ */
347
+ getSocialmediaEscalationrules(divisionId, opts) {
348
+ opts = opts || {};
349
+
350
+ // verify the required parameter 'divisionId' is set
351
+ if (divisionId === undefined || divisionId === null) {
352
+ throw 'Missing the required parameter "divisionId" when calling getSocialmediaEscalationrules';
353
+ }
354
+
355
+ return this.apiClient.callApi(
356
+ '/api/v2/socialmedia/escalationrules',
357
+ 'GET',
358
+ { },
359
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionId': divisionId },
360
+ { },
361
+ { },
362
+ null,
363
+ ['PureCloud OAuth'],
364
+ ['application/json'],
365
+ ['application/json']
366
+ );
367
+ }
368
+
158
369
  /**
159
370
  * Get a single social topic.
160
371
  *
161
372
  * @param {String} topicId topicId
162
373
  * @param {Object} opts Optional parameters
163
374
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
164
- * getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
165
375
  */
166
376
  getSocialmediaTopic(topicId, opts) {
167
377
  opts = opts || {};
@@ -185,6 +395,37 @@ class SocialMediaApi {
185
395
  );
186
396
  }
187
397
 
398
+ /**
399
+ * Retrieve all social topic data ingestion rules with pagination.
400
+ *
401
+ * @param {String} topicId topicId
402
+ * @param {Object} opts Optional parameters
403
+ * @param {Number} opts.pageNumber Page number (default to 1)
404
+ * @param {Number} opts.pageSize Page size (default to 25)
405
+ * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
406
+ */
407
+ getSocialmediaTopicDataingestionrules(topicId, opts) {
408
+ opts = opts || {};
409
+
410
+ // verify the required parameter 'topicId' is set
411
+ if (topicId === undefined || topicId === null) {
412
+ throw 'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrules';
413
+ }
414
+
415
+ return this.apiClient.callApi(
416
+ '/api/v2/socialmedia/topics/{topicId}/dataingestionrules',
417
+ 'GET',
418
+ { 'topicId': topicId },
419
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'includeDeleted': opts['includeDeleted'] },
420
+ { },
421
+ { },
422
+ null,
423
+ ['PureCloud OAuth'],
424
+ ['application/json'],
425
+ ['application/json']
426
+ );
427
+ }
428
+
188
429
  /**
189
430
  * Get a single Facebook data ingestion rule.
190
431
  *
@@ -192,7 +433,6 @@ class SocialMediaApi {
192
433
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
193
434
  * @param {Object} opts Optional parameters
194
435
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
195
- * getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
196
436
  */
197
437
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
198
438
  opts = opts || {};
@@ -228,7 +468,6 @@ class SocialMediaApi {
228
468
  * @param {String} dataIngestionRuleVersion version
229
469
  * @param {Object} opts Optional parameters
230
470
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
231
- * getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
232
471
  */
233
472
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId, facebookIngestionRuleId, dataIngestionRuleVersion, opts) {
234
473
  opts = opts || {};
@@ -269,7 +508,6 @@ class SocialMediaApi {
269
508
  * @param {Number} opts.pageNumber Page number (default to 1)
270
509
  * @param {Number} opts.pageSize Page size (default to 25)
271
510
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
272
- * getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
273
511
  */
274
512
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId, facebookIngestionRuleId, opts) {
275
513
  opts = opts || {};
@@ -416,7 +654,6 @@ class SocialMediaApi {
416
654
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
417
655
  * @param {Object} opts Optional parameters
418
656
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
419
- * getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
420
657
  */
421
658
  getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
422
659
  opts = opts || {};
@@ -452,7 +689,6 @@ class SocialMediaApi {
452
689
  * @param {String} dataIngestionRuleVersion version
453
690
  * @param {Object} opts Optional parameters
454
691
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
455
- * getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
456
692
  */
457
693
  getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId, twitterIngestionRuleId, dataIngestionRuleVersion, opts) {
458
694
  opts = opts || {};
@@ -493,7 +729,6 @@ class SocialMediaApi {
493
729
  * @param {Number} opts.pageNumber Page number (default to 1)
494
730
  * @param {Number} opts.pageSize Page size (default to 25)
495
731
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
496
- * getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
497
732
  */
498
733
  getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId, twitterIngestionRuleId, opts) {
499
734
  opts = opts || {};
@@ -529,7 +764,6 @@ class SocialMediaApi {
529
764
  * @param {Number} opts.pageSize Page size (default to 25)
530
765
  * @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
531
766
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
532
- * getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
533
767
  */
534
768
  getSocialmediaTopics(opts) {
535
769
  opts = opts || {};
@@ -555,7 +789,6 @@ class SocialMediaApi {
555
789
  * @param {String} topicId topicId
556
790
  * @param {Object} opts Optional parameters
557
791
  * @param {Object} opts.body
558
- * patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
559
792
  */
560
793
  patchSocialmediaTopic(topicId, opts) {
561
794
  opts = opts || {};
@@ -586,7 +819,6 @@ class SocialMediaApi {
586
819
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
587
820
  * @param {Object} opts Optional parameters
588
821
  * @param {Object} opts.body
589
- * patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
590
822
  */
591
823
  patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
592
824
  opts = opts || {};
@@ -656,7 +888,6 @@ class SocialMediaApi {
656
888
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
657
889
  * @param {Object} opts Optional parameters
658
890
  * @param {Object} opts.body
659
- * patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
660
891
  */
661
892
  patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
662
893
  opts = opts || {};
@@ -684,13 +915,115 @@ class SocialMediaApi {
684
915
  );
685
916
  }
686
917
 
918
+ /**
919
+ * Query for social media aggregates asynchronously
920
+ *
921
+ * @param {Object} body query
922
+ */
923
+ postSocialmediaAnalyticsAggregatesJobs(body) {
924
+ // verify the required parameter 'body' is set
925
+ if (body === undefined || body === null) {
926
+ throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsAggregatesJobs';
927
+ }
928
+
929
+ return this.apiClient.callApi(
930
+ '/api/v2/socialmedia/analytics/aggregates/jobs',
931
+ 'POST',
932
+ { },
933
+ { },
934
+ { },
935
+ { },
936
+ body,
937
+ ['PureCloud OAuth'],
938
+ ['application/json'],
939
+ ['application/json']
940
+ );
941
+ }
942
+
943
+ /**
944
+ * Query for social media messages asynchronously
945
+ *
946
+ * @param {Object} body query
947
+ */
948
+ postSocialmediaAnalyticsMessagesJobs(body) {
949
+ // verify the required parameter 'body' is set
950
+ if (body === undefined || body === null) {
951
+ throw 'Missing the required parameter "body" when calling postSocialmediaAnalyticsMessagesJobs';
952
+ }
953
+
954
+ return this.apiClient.callApi(
955
+ '/api/v2/socialmedia/analytics/messages/jobs',
956
+ 'POST',
957
+ { },
958
+ { },
959
+ { },
960
+ { },
961
+ body,
962
+ ['PureCloud OAuth'],
963
+ ['application/json'],
964
+ ['application/json']
965
+ );
966
+ }
967
+
968
+ /**
969
+ * Create an escalation rule.
970
+ *
971
+ * @param {Object} opts Optional parameters
972
+ * @param {Object} opts.body
973
+ */
974
+ postSocialmediaEscalationrules(opts) {
975
+ opts = opts || {};
976
+
977
+
978
+ return this.apiClient.callApi(
979
+ '/api/v2/socialmedia/escalationrules',
980
+ 'POST',
981
+ { },
982
+ { },
983
+ { },
984
+ { },
985
+ opts['body'],
986
+ ['PureCloud OAuth'],
987
+ ['application/json'],
988
+ ['application/json']
989
+ );
990
+ }
991
+
992
+ /**
993
+ * Escalate message to a conversation manually
994
+ *
995
+ * @param {String} divisionId One division ID
996
+ * @param {Object} opts Optional parameters
997
+ * @param {Object} opts.body
998
+ */
999
+ postSocialmediaEscalationsMessages(divisionId, opts) {
1000
+ opts = opts || {};
1001
+
1002
+ // verify the required parameter 'divisionId' is set
1003
+ if (divisionId === undefined || divisionId === null) {
1004
+ throw 'Missing the required parameter "divisionId" when calling postSocialmediaEscalationsMessages';
1005
+ }
1006
+
1007
+ return this.apiClient.callApi(
1008
+ '/api/v2/socialmedia/escalations/messages',
1009
+ 'POST',
1010
+ { },
1011
+ { 'divisionId': divisionId },
1012
+ { },
1013
+ { },
1014
+ opts['body'],
1015
+ ['PureCloud OAuth'],
1016
+ ['application/json'],
1017
+ ['application/json']
1018
+ );
1019
+ }
1020
+
687
1021
  /**
688
1022
  * Create an Facebook data ingestion rule.
689
1023
  *
690
1024
  * @param {String} topicId topicId
691
1025
  * @param {Object} opts Optional parameters
692
1026
  * @param {Object} opts.body
693
- * postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
694
1027
  */
695
1028
  postSocialmediaTopicDataingestionrulesFacebook(topicId, opts) {
696
1029
  opts = opts || {};
@@ -750,7 +1083,6 @@ class SocialMediaApi {
750
1083
  * @param {String} topicId topicId
751
1084
  * @param {Object} opts Optional parameters
752
1085
  * @param {Object} opts.body
753
- * postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
754
1086
  */
755
1087
  postSocialmediaTopicDataingestionrulesTwitter(topicId, opts) {
756
1088
  opts = opts || {};
@@ -779,7 +1111,6 @@ class SocialMediaApi {
779
1111
  *
780
1112
  * @param {Object} opts Optional parameters
781
1113
  * @param {Object} opts.body
782
- * postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
783
1114
  */
784
1115
  postSocialmediaTopics(opts) {
785
1116
  opts = opts || {};
@@ -799,6 +1130,60 @@ class SocialMediaApi {
799
1130
  );
800
1131
  }
801
1132
 
1133
+ /**
1134
+ * Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
1135
+ *
1136
+ * @param {Object} body TwitterDataHistoricalTweetRequest
1137
+ */
1138
+ postSocialmediaTwitterHistoricalTweets(body) {
1139
+ // verify the required parameter 'body' is set
1140
+ if (body === undefined || body === null) {
1141
+ throw 'Missing the required parameter "body" when calling postSocialmediaTwitterHistoricalTweets';
1142
+ }
1143
+
1144
+ return this.apiClient.callApi(
1145
+ '/api/v2/socialmedia/twitter/historical/tweets',
1146
+ 'POST',
1147
+ { },
1148
+ { },
1149
+ { },
1150
+ { },
1151
+ body,
1152
+ ['PureCloud OAuth'],
1153
+ ['application/json'],
1154
+ ['application/json']
1155
+ );
1156
+ }
1157
+
1158
+ /**
1159
+ * Update the escalation rule.
1160
+ *
1161
+ * @param {String} escalationRuleId escalationRuleId
1162
+ * @param {Object} opts Optional parameters
1163
+ * @param {Object} opts.body
1164
+ */
1165
+ putSocialmediaEscalationrule(escalationRuleId, opts) {
1166
+ opts = opts || {};
1167
+
1168
+ // verify the required parameter 'escalationRuleId' is set
1169
+ if (escalationRuleId === undefined || escalationRuleId === null) {
1170
+ throw 'Missing the required parameter "escalationRuleId" when calling putSocialmediaEscalationrule';
1171
+ }
1172
+
1173
+ return this.apiClient.callApi(
1174
+ '/api/v2/socialmedia/escalationrules/{escalationRuleId}',
1175
+ 'PUT',
1176
+ { 'escalationRuleId': escalationRuleId },
1177
+ { },
1178
+ { },
1179
+ { },
1180
+ opts['body'],
1181
+ ['PureCloud OAuth'],
1182
+ ['application/json'],
1183
+ ['application/json']
1184
+ );
1185
+ }
1186
+
802
1187
  /**
803
1188
  * Update the Facebook data ingestion rule.
804
1189
  *
@@ -806,7 +1191,6 @@ class SocialMediaApi {
806
1191
  * @param {String} facebookIngestionRuleId facebookIngestionRuleId
807
1192
  * @param {Object} opts Optional parameters
808
1193
  * @param {Object} opts.body
809
- * putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
810
1194
  */
811
1195
  putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId, facebookIngestionRuleId, opts) {
812
1196
  opts = opts || {};
@@ -876,7 +1260,6 @@ class SocialMediaApi {
876
1260
  * @param {String} twitterIngestionRuleId twitterIngestionRuleId
877
1261
  * @param {Object} opts Optional parameters
878
1262
  * @param {Object} opts.body
879
- * putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
880
1263
  */
881
1264
  putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId, twitterIngestionRuleId, opts) {
882
1265
  opts = opts || {};
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SuggestApi {
5
5
  /**
6
6
  * Suggest service.
7
7
  * @module purecloud-platform-client-v2/api/SuggestApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TaskManagementApi {
5
5
  /**
6
6
  * TaskManagement service.
7
7
  * @module purecloud-platform-client-v2/api/TaskManagementApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TeamsApi {
5
5
  /**
6
6
  * Teams service.
7
7
  * @module purecloud-platform-client-v2/api/TeamsApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TelephonyApi {
5
5
  /**
6
6
  * Telephony service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyApi
8
- * @version 216.0.0
8
+ * @version 218.0.0
9
9
  */
10
10
 
11
11
  /**