purecloud-platform-client-v2 146.0.0 → 148.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 (75) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +660 -198
  3. package/dist/web-amd/purecloud-platform-client-v2.js +660 -198
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +660 -198
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +661 -199
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +490 -145
  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/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +46 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -51
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +3 -2
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -78
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +76 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -2
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +135 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +243 -0
  49. package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
  50. package/src/purecloud-platform-client-v2/api/RecordingApi.js +31 -1
  51. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +3 -2
  67. package/src/purecloud-platform-client-v2/api/UsersApi.js +31 -1
  68. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +30 -1
  72. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class ObjectsApi {
5
5
  /**
6
6
  * Objects service.
7
7
  * @module purecloud-platform-client-v2/api/ObjectsApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationApi {
5
5
  /**
6
6
  * Organization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
5
5
  /**
6
6
  * OrganizationAuthorization service.
7
7
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class OutboundApi {
5
5
  /**
6
6
  * Outbound service.
7
7
  * @module purecloud-platform-client-v2/api/OutboundApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -305,6 +305,31 @@ class OutboundApi {
305
305
  );
306
306
  }
307
307
 
308
+ /**
309
+ * Delete an Outbound Digital Rule Set
310
+ *
311
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
312
+ */
313
+ deleteOutboundDigitalruleset(digitalRuleSetId) {
314
+ // verify the required parameter 'digitalRuleSetId' is set
315
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
316
+ throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
317
+ }
318
+
319
+ return this.apiClient.callApi(
320
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
321
+ 'DELETE',
322
+ { 'digitalRuleSetId': digitalRuleSetId },
323
+ { },
324
+ { },
325
+ { },
326
+ null,
327
+ ['PureCloud OAuth'],
328
+ ['application/json'],
329
+ ['application/json']
330
+ );
331
+ }
332
+
308
333
  /**
309
334
  * Delete dialer DNC list
310
335
  *
@@ -1342,6 +1367,60 @@ class OutboundApi {
1342
1367
  );
1343
1368
  }
1344
1369
 
1370
+ /**
1371
+ * Get an Outbound Digital Rule Set
1372
+ *
1373
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
1374
+ */
1375
+ getOutboundDigitalruleset(digitalRuleSetId) {
1376
+ // verify the required parameter 'digitalRuleSetId' is set
1377
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
1378
+ throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
1379
+ }
1380
+
1381
+ return this.apiClient.callApi(
1382
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
1383
+ 'GET',
1384
+ { 'digitalRuleSetId': digitalRuleSetId },
1385
+ { },
1386
+ { },
1387
+ { },
1388
+ null,
1389
+ ['PureCloud OAuth'],
1390
+ ['application/json'],
1391
+ ['application/json']
1392
+ );
1393
+ }
1394
+
1395
+ /**
1396
+ * Query a list of Outbound Digital Rule Sets
1397
+ *
1398
+ * @param {Object} opts Optional parameters
1399
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
1400
+ * @param {Number} opts.pageNumber Page number (default to 1)
1401
+ * @param {Object} opts.sortBy The field to sort by (default to name)
1402
+ * @param {Object} opts.sortOrder The direction to sort (default to ascending)
1403
+ * @param {String} opts.name Name
1404
+ * @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
1405
+ */
1406
+ getOutboundDigitalrulesets(opts) {
1407
+ opts = opts || {};
1408
+
1409
+
1410
+ return this.apiClient.callApi(
1411
+ '/api/v2/outbound/digitalrulesets',
1412
+ 'GET',
1413
+ { },
1414
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
1415
+ { },
1416
+ { },
1417
+ null,
1418
+ ['PureCloud OAuth'],
1419
+ ['application/json'],
1420
+ ['application/json']
1421
+ );
1422
+ }
1423
+
1345
1424
  /**
1346
1425
  * Get dialer DNC list
1347
1426
  *
@@ -2525,6 +2604,31 @@ class OutboundApi {
2525
2604
  );
2526
2605
  }
2527
2606
 
2607
+ /**
2608
+ * Create an Outbound Digital Rule Set
2609
+ *
2610
+ * @param {Object} body Digital Rule Set
2611
+ */
2612
+ postOutboundDigitalrulesets(body) {
2613
+ // verify the required parameter 'body' is set
2614
+ if (body === undefined || body === null) {
2615
+ throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
2616
+ }
2617
+
2618
+ return this.apiClient.callApi(
2619
+ '/api/v2/outbound/digitalrulesets',
2620
+ 'POST',
2621
+ { },
2622
+ { },
2623
+ { },
2624
+ { },
2625
+ body,
2626
+ ['PureCloud OAuth'],
2627
+ ['application/json'],
2628
+ ['application/json']
2629
+ );
2630
+ }
2631
+
2528
2632
  /**
2529
2633
  * Initiate the export of a dnc list.
2530
2634
  * Returns 200 if received OK.
@@ -2989,6 +3093,36 @@ class OutboundApi {
2989
3093
  );
2990
3094
  }
2991
3095
 
3096
+ /**
3097
+ * Update an Outbound Digital Rule Set
3098
+ *
3099
+ * @param {String} digitalRuleSetId The Digital Rule Set ID
3100
+ * @param {Object} body Digital Rule Set
3101
+ */
3102
+ putOutboundDigitalruleset(digitalRuleSetId, body) {
3103
+ // verify the required parameter 'digitalRuleSetId' is set
3104
+ if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
3105
+ throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
3106
+ }
3107
+ // verify the required parameter 'body' is set
3108
+ if (body === undefined || body === null) {
3109
+ throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
3110
+ }
3111
+
3112
+ return this.apiClient.callApi(
3113
+ '/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
3114
+ 'PUT',
3115
+ { 'digitalRuleSetId': digitalRuleSetId },
3116
+ { },
3117
+ { },
3118
+ { },
3119
+ body,
3120
+ ['PureCloud OAuth'],
3121
+ ['application/json'],
3122
+ ['application/json']
3123
+ );
3124
+ }
3125
+
2992
3126
  /**
2993
3127
  * Update dialer DNC list
2994
3128
  *
@@ -5,7 +5,7 @@ class PresenceApi {
5
5
  /**
6
6
  * Presence service.
7
7
  * @module purecloud-platform-client-v2/api/PresenceApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -0,0 +1,243 @@
1
+ import ApiClient from '../ApiClient.js';
2
+
3
+
4
+ class ProcessAutomationApi {
5
+ /**
6
+ * ProcessAutomation service.
7
+ * @module purecloud-platform-client-v2/api/ProcessAutomationApi
8
+ * @version 148.0.0
9
+ */
10
+
11
+ /**
12
+ * Constructs a new ProcessAutomationApi.
13
+ * @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
14
+ * @class
15
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
16
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
17
+ */
18
+ constructor(apiClient) {
19
+ this.apiClient = apiClient || ApiClient.instance;
20
+ }
21
+
22
+
23
+ /**
24
+ * Delete a Trigger
25
+ *
26
+ * @param {String} triggerId triggerId
27
+ */
28
+ deleteProcessautomationTrigger(triggerId) {
29
+ // verify the required parameter 'triggerId' is set
30
+ if (triggerId === undefined || triggerId === null) {
31
+ throw 'Missing the required parameter "triggerId" when calling deleteProcessautomationTrigger';
32
+ }
33
+
34
+ return this.apiClient.callApi(
35
+ '/api/v2/processautomation/triggers/{triggerId}',
36
+ 'DELETE',
37
+ { 'triggerId': triggerId },
38
+ { },
39
+ { },
40
+ { },
41
+ null,
42
+ ['PureCloud OAuth'],
43
+ ['application/json'],
44
+ ['application/json']
45
+ );
46
+ }
47
+
48
+ /**
49
+ * Retrieve a single Trigger matching id.
50
+ *
51
+ * @param {String} triggerId triggerId
52
+ */
53
+ getProcessautomationTrigger(triggerId) {
54
+ // verify the required parameter 'triggerId' is set
55
+ if (triggerId === undefined || triggerId === null) {
56
+ throw 'Missing the required parameter "triggerId" when calling getProcessautomationTrigger';
57
+ }
58
+
59
+ return this.apiClient.callApi(
60
+ '/api/v2/processautomation/triggers/{triggerId}',
61
+ 'GET',
62
+ { 'triggerId': triggerId },
63
+ { },
64
+ { },
65
+ { },
66
+ null,
67
+ ['PureCloud OAuth'],
68
+ ['application/json'],
69
+ ['application/json']
70
+ );
71
+ }
72
+
73
+ /**
74
+ * Retrieves all triggers
75
+ *
76
+ * @param {Object} opts Optional parameters
77
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
78
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
79
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
80
+ * @param {String} opts.topicName Topic name
81
+ * @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
82
+ */
83
+ getProcessautomationTriggers(opts) {
84
+ opts = opts || {};
85
+
86
+
87
+ return this.apiClient.callApi(
88
+ '/api/v2/processautomation/triggers',
89
+ 'GET',
90
+ { },
91
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'topicName': opts['topicName'],'enabled': opts['enabled'] },
92
+ { },
93
+ { },
94
+ null,
95
+ ['PureCloud OAuth'],
96
+ ['application/json'],
97
+ ['application/json']
98
+ );
99
+ }
100
+
101
+ /**
102
+ * Get topics available for organization
103
+ *
104
+ * @param {Object} opts Optional parameters
105
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
106
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
107
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
108
+ */
109
+ getProcessautomationTriggersTopics(opts) {
110
+ opts = opts || {};
111
+
112
+
113
+ return this.apiClient.callApi(
114
+ '/api/v2/processautomation/triggers/topics',
115
+ 'GET',
116
+ { },
117
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
118
+ { },
119
+ { },
120
+ null,
121
+ ['PureCloud OAuth'],
122
+ ['application/json'],
123
+ ['application/json']
124
+ );
125
+ }
126
+
127
+ /**
128
+ * Test the matching of a Trigger based on provided event body
129
+ *
130
+ * @param {String} triggerId triggerId
131
+ * @param {Object} opts Optional parameters
132
+ * @param {String} opts.body eventBody
133
+ */
134
+ postProcessautomationTriggerTest(triggerId, opts) {
135
+ opts = opts || {};
136
+
137
+ // verify the required parameter 'triggerId' is set
138
+ if (triggerId === undefined || triggerId === null) {
139
+ throw 'Missing the required parameter "triggerId" when calling postProcessautomationTriggerTest';
140
+ }
141
+
142
+ return this.apiClient.callApi(
143
+ '/api/v2/processautomation/triggers/{triggerId}/test',
144
+ 'POST',
145
+ { 'triggerId': triggerId },
146
+ { },
147
+ { },
148
+ { },
149
+ opts['body'],
150
+ ['PureCloud OAuth'],
151
+ ['application/json'],
152
+ ['application/json']
153
+ );
154
+ }
155
+
156
+ /**
157
+ * Create a Trigger
158
+ *
159
+ * @param {Object} body Input used to create a Trigger.
160
+ */
161
+ postProcessautomationTriggers(body) {
162
+ // verify the required parameter 'body' is set
163
+ if (body === undefined || body === null) {
164
+ throw 'Missing the required parameter "body" when calling postProcessautomationTriggers';
165
+ }
166
+
167
+ return this.apiClient.callApi(
168
+ '/api/v2/processautomation/triggers',
169
+ 'POST',
170
+ { },
171
+ { },
172
+ { },
173
+ { },
174
+ body,
175
+ ['PureCloud OAuth'],
176
+ ['application/json'],
177
+ ['application/json']
178
+ );
179
+ }
180
+
181
+ /**
182
+ * Test the matching of all organization Triggers on given topic using provided event body
183
+ *
184
+ * @param {String} topicName topicName
185
+ * @param {Object} opts Optional parameters
186
+ * @param {String} opts.body eventBody
187
+ */
188
+ postProcessautomationTriggersTopicTest(topicName, opts) {
189
+ opts = opts || {};
190
+
191
+ // verify the required parameter 'topicName' is set
192
+ if (topicName === undefined || topicName === null) {
193
+ throw 'Missing the required parameter "topicName" when calling postProcessautomationTriggersTopicTest';
194
+ }
195
+
196
+ return this.apiClient.callApi(
197
+ '/api/v2/processautomation/triggers/topics/{topicName}/test',
198
+ 'POST',
199
+ { 'topicName': topicName },
200
+ { },
201
+ { },
202
+ { },
203
+ opts['body'],
204
+ ['PureCloud OAuth'],
205
+ ['application/json'],
206
+ ['application/json']
207
+ );
208
+ }
209
+
210
+ /**
211
+ * Update a Trigger
212
+ *
213
+ * @param {String} triggerId triggerId
214
+ * @param {Object} body Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)
215
+ */
216
+ putProcessautomationTrigger(triggerId, body) {
217
+ // verify the required parameter 'triggerId' is set
218
+ if (triggerId === undefined || triggerId === null) {
219
+ throw 'Missing the required parameter "triggerId" when calling putProcessautomationTrigger';
220
+ }
221
+ // verify the required parameter 'body' is set
222
+ if (body === undefined || body === null) {
223
+ throw 'Missing the required parameter "body" when calling putProcessautomationTrigger';
224
+ }
225
+
226
+ return this.apiClient.callApi(
227
+ '/api/v2/processautomation/triggers/{triggerId}',
228
+ 'PUT',
229
+ { 'triggerId': triggerId },
230
+ { },
231
+ { },
232
+ { },
233
+ body,
234
+ ['PureCloud OAuth'],
235
+ ['application/json'],
236
+ ['application/json']
237
+ );
238
+ }
239
+
240
+ }
241
+
242
+
243
+ export default ProcessAutomationApi;
@@ -5,7 +5,7 @@ class QualityApi {
5
5
  /**
6
6
  * Quality service.
7
7
  * @module purecloud-platform-client-v2/api/QualityApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -515,7 +515,7 @@ class QualityApi {
515
515
  * @param {String} opts.sortBy variable name requested to sort by
516
516
  * @param {String} opts.nextPage next page token
517
517
  * @param {String} opts.previousPage Previous page token
518
- * @param {String} opts.expand Expand
518
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
519
519
  * @param {String} opts.name Name
520
520
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
521
521
  */
@@ -602,7 +602,7 @@ class QualityApi {
602
602
  * @param {String} opts.sortBy variable name requested to sort by
603
603
  * @param {String} opts.nextPage next page token
604
604
  * @param {String} opts.previousPage Previous page token
605
- * @param {String} opts.expand Expand
605
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
606
606
  * @param {String} opts.name Name
607
607
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
608
608
  */
@@ -713,7 +713,7 @@ class QualityApi {
713
713
  * @param {String} opts.sortBy variable name requested to sort by
714
714
  * @param {String} opts.nextPage next page token
715
715
  * @param {String} opts.previousPage Previous page token
716
- * @param {String} opts.expand Expand
716
+ * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
717
717
  * @param {String} opts.name Name
718
718
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
719
719
  */
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -879,6 +879,36 @@ class RecordingApi {
879
879
  );
880
880
  }
881
881
 
882
+ /**
883
+ * Query for recording retention data
884
+ *
885
+ * @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
886
+ * @param {Object} opts Optional parameters
887
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
888
+ * @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
889
+ */
890
+ getRecordingsRetentionQuery(retentionThresholdDays, opts) {
891
+ opts = opts || {};
892
+
893
+ // verify the required parameter 'retentionThresholdDays' is set
894
+ if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
895
+ throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
896
+ }
897
+
898
+ return this.apiClient.callApi(
899
+ '/api/v2/recordings/retention/query',
900
+ 'GET',
901
+ { },
902
+ { 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
903
+ { },
904
+ { },
905
+ null,
906
+ ['PureCloud OAuth'],
907
+ ['application/json'],
908
+ ['application/json']
909
+ );
910
+ }
911
+
882
912
  /**
883
913
  * Retrieves a paged listing of screen recording sessions
884
914
  *
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RoutingApi {
5
5
  /**
6
6
  * Routing service.
7
7
  * @module purecloud-platform-client-v2/api/RoutingApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ScriptsApi {
5
5
  /**
6
6
  * Scripts service.
7
7
  * @module purecloud-platform-client-v2/api/ScriptsApi
8
- * @version 146.0.0
8
+ * @version 148.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 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 146.0.0
8
+ * @version 148.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 146.0.0
8
+ * @version 148.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 146.0.0
8
+ * @version 148.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 146.0.0
8
+ * @version 148.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 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
5
5
  /**
6
6
  * TelephonyProvidersEdge service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UploadsApi {
5
5
  /**
6
6
  * Uploads service.
7
7
  * @module purecloud-platform-client-v2/api/UploadsApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 146.0.0
8
+ * @version 148.0.0
9
9
  */
10
10
 
11
11
  /**