purecloud-platform-client-v2 96.0.0 → 97.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 (67) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +381 -62
  3. package/dist/web-amd/purecloud-platform-client-v2.js +381 -62
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +381 -62
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +382 -62
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +378 -209
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -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 +4 -2
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/JourneyApi.js +131 -1
  31. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -3
  32. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +187 -1
  67. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -18,7 +18,7 @@ var PureCloudRegionHosts = {
18
18
 
19
19
  /**
20
20
  * @module purecloud-platform-client-v2/ApiClient
21
- * @version 96.0.0
21
+ * @version 97.0.0
22
22
  */
23
23
  class ApiClient {
24
24
  /**
@@ -774,7 +774,7 @@ class ApiClient {
774
774
 
775
775
  // set header parameters
776
776
  request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
777
- //request.set({ 'purecloud-sdk': '96.0.0' });
777
+ //request.set({ 'purecloud-sdk': '97.0.0' });
778
778
 
779
779
  // set request timeout
780
780
  request.timeout(this.timeout);
@@ -899,7 +899,7 @@ class AlertingApi {
899
899
  /**
900
900
  * Alerting service.
901
901
  * @module purecloud-platform-client-v2/api/AlertingApi
902
- * @version 96.0.0
902
+ * @version 97.0.0
903
903
  */
904
904
 
905
905
  /**
@@ -1213,7 +1213,7 @@ class AnalyticsApi {
1213
1213
  /**
1214
1214
  * Analytics service.
1215
1215
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1216
- * @version 96.0.0
1216
+ * @version 97.0.0
1217
1217
  */
1218
1218
 
1219
1219
  /**
@@ -2293,7 +2293,7 @@ class ArchitectApi {
2293
2293
  /**
2294
2294
  * Architect service.
2295
2295
  * @module purecloud-platform-client-v2/api/ArchitectApi
2296
- * @version 96.0.0
2296
+ * @version 97.0.0
2297
2297
  */
2298
2298
 
2299
2299
  /**
@@ -5131,7 +5131,7 @@ class AuditApi {
5131
5131
  /**
5132
5132
  * Audit service.
5133
5133
  * @module purecloud-platform-client-v2/api/AuditApi
5134
- * @version 96.0.0
5134
+ * @version 97.0.0
5135
5135
  */
5136
5136
 
5137
5137
  /**
@@ -5302,7 +5302,7 @@ class AuthorizationApi {
5302
5302
  /**
5303
5303
  * Authorization service.
5304
5304
  * @module purecloud-platform-client-v2/api/AuthorizationApi
5305
- * @version 96.0.0
5305
+ * @version 97.0.0
5306
5306
  */
5307
5307
 
5308
5308
  /**
@@ -5637,6 +5637,8 @@ class AuthorizationApi {
5637
5637
  * @param {Object} opts Optional parameters
5638
5638
  * @param {Number} opts.pageSize Page size (default to 25)
5639
5639
  * @param {Number} opts.pageNumber Page number (default to 1)
5640
+ * @param {Object} opts.queryType Query filter type
5641
+ * @param {String} opts.query Comma-separated list of permissions or domains to query
5640
5642
  */
5641
5643
  getAuthorizationPermissions(opts) {
5642
5644
  opts = opts || {};
@@ -5646,7 +5648,7 @@ class AuthorizationApi {
5646
5648
  '/api/v2/authorization/permissions',
5647
5649
  'GET',
5648
5650
  { },
5649
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
5651
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
5650
5652
  { },
5651
5653
  { },
5652
5654
  null,
@@ -6419,7 +6421,7 @@ class BillingApi {
6419
6421
  /**
6420
6422
  * Billing service.
6421
6423
  * @module purecloud-platform-client-v2/api/BillingApi
6422
- * @version 96.0.0
6424
+ * @version 97.0.0
6423
6425
  */
6424
6426
 
6425
6427
  /**
@@ -6499,7 +6501,7 @@ class CoachingApi {
6499
6501
  /**
6500
6502
  * Coaching service.
6501
6503
  * @module purecloud-platform-client-v2/api/CoachingApi
6502
- * @version 96.0.0
6504
+ * @version 97.0.0
6503
6505
  */
6504
6506
 
6505
6507
  /**
@@ -7019,7 +7021,7 @@ class ContentManagementApi {
7019
7021
  /**
7020
7022
  * ContentManagement service.
7021
7023
  * @module purecloud-platform-client-v2/api/ContentManagementApi
7022
- * @version 96.0.0
7024
+ * @version 97.0.0
7023
7025
  */
7024
7026
 
7025
7027
  /**
@@ -8159,7 +8161,7 @@ class ConversationsApi {
8159
8161
  /**
8160
8162
  * Conversations service.
8161
8163
  * @module purecloud-platform-client-v2/api/ConversationsApi
8162
- * @version 96.0.0
8164
+ * @version 97.0.0
8163
8165
  */
8164
8166
 
8165
8167
  /**
@@ -12217,7 +12219,7 @@ class DataExtensionsApi {
12217
12219
  /**
12218
12220
  * DataExtensions service.
12219
12221
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
12220
- * @version 96.0.0
12222
+ * @version 97.0.0
12221
12223
  */
12222
12224
 
12223
12225
  /**
@@ -12303,7 +12305,7 @@ class ExternalContactsApi {
12303
12305
  /**
12304
12306
  * ExternalContacts service.
12305
12307
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
12306
- * @version 96.0.0
12308
+ * @version 97.0.0
12307
12309
  */
12308
12310
 
12309
12311
  /**
@@ -13646,7 +13648,7 @@ class FaxApi {
13646
13648
  /**
13647
13649
  * Fax service.
13648
13650
  * @module purecloud-platform-client-v2/api/FaxApi
13649
- * @version 96.0.0
13651
+ * @version 97.0.0
13650
13652
  */
13651
13653
 
13652
13654
  /**
@@ -13817,7 +13819,7 @@ class FlowsApi {
13817
13819
  /**
13818
13820
  * Flows service.
13819
13821
  * @module purecloud-platform-client-v2/api/FlowsApi
13820
- * @version 96.0.0
13822
+ * @version 97.0.0
13821
13823
  */
13822
13824
 
13823
13825
  /**
@@ -13888,7 +13890,7 @@ class GeneralDataProtectionRegulationApi {
13888
13890
  /**
13889
13891
  * GeneralDataProtectionRegulation service.
13890
13892
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
13891
- * @version 96.0.0
13893
+ * @version 97.0.0
13892
13894
  */
13893
13895
 
13894
13896
  /**
@@ -14018,7 +14020,7 @@ class GeolocationApi {
14018
14020
  /**
14019
14021
  * Geolocation service.
14020
14022
  * @module purecloud-platform-client-v2/api/GeolocationApi
14021
- * @version 96.0.0
14023
+ * @version 97.0.0
14022
14024
  */
14023
14025
 
14024
14026
  /**
@@ -14149,7 +14151,7 @@ class GreetingsApi {
14149
14151
  /**
14150
14152
  * Greetings service.
14151
14153
  * @module purecloud-platform-client-v2/api/GreetingsApi
14152
- * @version 96.0.0
14154
+ * @version 97.0.0
14153
14155
  */
14154
14156
 
14155
14157
  /**
@@ -14604,7 +14606,7 @@ class GroupsApi {
14604
14606
  /**
14605
14607
  * Groups service.
14606
14608
  * @module purecloud-platform-client-v2/api/GroupsApi
14607
- * @version 96.0.0
14609
+ * @version 97.0.0
14608
14610
  */
14609
14611
 
14610
14612
  /**
@@ -15009,7 +15011,7 @@ class IdentityProviderApi {
15009
15011
  /**
15010
15012
  * IdentityProvider service.
15011
15013
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
15012
- * @version 96.0.0
15014
+ * @version 97.0.0
15013
15015
  */
15014
15016
 
15015
15017
  /**
@@ -15765,7 +15767,7 @@ class IntegrationsApi {
15765
15767
  /**
15766
15768
  * Integrations service.
15767
15769
  * @module purecloud-platform-client-v2/api/IntegrationsApi
15768
- * @version 96.0.0
15770
+ * @version 97.0.0
15769
15771
  */
15770
15772
 
15771
15773
  /**
@@ -17257,7 +17259,7 @@ class JourneyApi {
17257
17259
  /**
17258
17260
  * Journey service.
17259
17261
  * @module purecloud-platform-client-v2/api/JourneyApi
17260
- * @version 96.0.0
17262
+ * @version 97.0.0
17261
17263
  */
17262
17264
 
17263
17265
  /**
@@ -17322,6 +17324,107 @@ class JourneyApi {
17322
17324
  );
17323
17325
  }
17324
17326
 
17327
+ /**
17328
+ * Retrieve segment assignments by customer ID.
17329
+ *
17330
+ * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
17331
+ * @param {String} customerId Primary identifier of the customer to query for segment assignments.
17332
+ * @param {Object} opts Optional parameters
17333
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17334
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17335
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
17336
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
17337
+ */
17338
+ getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
17339
+ opts = opts || {};
17340
+
17341
+ // verify the required parameter 'customerIdType' is set
17342
+ if (customerIdType === undefined || customerIdType === null) {
17343
+ throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
17344
+ }
17345
+ // verify the required parameter 'customerId' is set
17346
+ if (customerId === undefined || customerId === null) {
17347
+ throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
17348
+ }
17349
+
17350
+ return this.apiClient.callApi(
17351
+ '/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
17352
+ 'GET',
17353
+ { 'customerIdType': customerIdType,'customerId': customerId },
17354
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
17355
+ { },
17356
+ { },
17357
+ null,
17358
+ ['PureCloud OAuth'],
17359
+ ['application/json'],
17360
+ ['application/json']
17361
+ );
17362
+ }
17363
+
17364
+ /**
17365
+ * Retrieve segment assignments by external contact ID.
17366
+ *
17367
+ * @param {String} externalContactId ID of the external contact to query for segment assignments.
17368
+ * @param {Object} opts Optional parameters
17369
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17370
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17371
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
17372
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
17373
+ */
17374
+ getJourneyExternalcontactSegments(externalContactId, opts) {
17375
+ opts = opts || {};
17376
+
17377
+ // verify the required parameter 'externalContactId' is set
17378
+ if (externalContactId === undefined || externalContactId === null) {
17379
+ throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
17380
+ }
17381
+
17382
+ return this.apiClient.callApi(
17383
+ '/api/v2/journey/externalcontacts/{externalContactId}/segments',
17384
+ 'GET',
17385
+ { 'externalContactId': externalContactId },
17386
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
17387
+ { },
17388
+ { },
17389
+ null,
17390
+ ['PureCloud OAuth'],
17391
+ ['application/json'],
17392
+ ['application/json']
17393
+ );
17394
+ }
17395
+
17396
+ /**
17397
+ * Retrieve segment assignments by session ID.
17398
+ *
17399
+ * @param {String} sessionId ID of the session to query for segment assignments.
17400
+ * @param {Object} opts Optional parameters
17401
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17402
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17403
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
17404
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
17405
+ */
17406
+ getJourneySessionSegments(sessionId, opts) {
17407
+ opts = opts || {};
17408
+
17409
+ // verify the required parameter 'sessionId' is set
17410
+ if (sessionId === undefined || sessionId === null) {
17411
+ throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
17412
+ }
17413
+
17414
+ return this.apiClient.callApi(
17415
+ '/api/v2/journey/sessions/{sessionId}/segments',
17416
+ 'GET',
17417
+ { 'sessionId': sessionId },
17418
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
17419
+ { },
17420
+ { },
17421
+ null,
17422
+ ['PureCloud OAuth'],
17423
+ ['application/json'],
17424
+ ['application/json']
17425
+ );
17426
+ }
17427
+
17325
17428
  /**
17326
17429
  * Update a single action target.
17327
17430
  *
@@ -17376,13 +17479,42 @@ class JourneyApi {
17376
17479
  );
17377
17480
  }
17378
17481
 
17482
+ /**
17483
+ * Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
17484
+ *
17485
+ * @param {String} externalContactId ID of the external contact to query for segment assignments.
17486
+ * @param {Object} opts Optional parameters
17487
+ * @param {Array.<Object>} opts.body
17488
+ */
17489
+ postJourneyExternalcontactSegments(externalContactId, opts) {
17490
+ opts = opts || {};
17491
+
17492
+ // verify the required parameter 'externalContactId' is set
17493
+ if (externalContactId === undefined || externalContactId === null) {
17494
+ throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
17495
+ }
17496
+
17497
+ return this.apiClient.callApi(
17498
+ '/api/v2/journey/externalcontacts/{externalContactId}/segments',
17499
+ 'POST',
17500
+ { 'externalContactId': externalContactId },
17501
+ { },
17502
+ { },
17503
+ { },
17504
+ opts['body'],
17505
+ ['PureCloud OAuth'],
17506
+ ['application/json'],
17507
+ ['application/json']
17508
+ );
17509
+ }
17510
+
17379
17511
  }
17380
17512
 
17381
17513
  class KnowledgeApi {
17382
17514
  /**
17383
17515
  * Knowledge service.
17384
17516
  * @module purecloud-platform-client-v2/api/KnowledgeApi
17385
- * @version 96.0.0
17517
+ * @version 97.0.0
17386
17518
  */
17387
17519
 
17388
17520
  /**
@@ -17698,7 +17830,7 @@ class KnowledgeApi {
17698
17830
  }
17699
17831
 
17700
17832
  /**
17701
- * Get All trainings information for a knowledgebase
17833
+ * Get all trainings information for a knowledgebase
17702
17834
  *
17703
17835
  * @param {String} knowledgeBaseId Knowledge base ID
17704
17836
  * @param {Object} languageCode Language code, format: iso2-LOCALE
@@ -17707,6 +17839,7 @@ class KnowledgeApi {
17707
17839
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17708
17840
  * @param {String} opts.limit Number of entities to return. Maximum of 200.
17709
17841
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17842
+ * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
17710
17843
  */
17711
17844
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
17712
17845
  opts = opts || {};
@@ -17724,7 +17857,7 @@ class KnowledgeApi {
17724
17857
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
17725
17858
  'GET',
17726
17859
  { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
17727
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
17860
+ { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
17728
17861
  { },
17729
17862
  { },
17730
17863
  null,
@@ -18102,7 +18235,7 @@ class LanguageUnderstandingApi {
18102
18235
  /**
18103
18236
  * LanguageUnderstanding service.
18104
18237
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
18105
- * @version 96.0.0
18238
+ * @version 97.0.0
18106
18239
  */
18107
18240
 
18108
18241
  /**
@@ -18668,7 +18801,7 @@ class LanguagesApi {
18668
18801
  /**
18669
18802
  * Languages service.
18670
18803
  * @module purecloud-platform-client-v2/api/LanguagesApi
18671
- * @version 96.0.0
18804
+ * @version 97.0.0
18672
18805
  */
18673
18806
 
18674
18807
  /**
@@ -18936,7 +19069,7 @@ class LicenseApi {
18936
19069
  /**
18937
19070
  * License service.
18938
19071
  * @module purecloud-platform-client-v2/api/LicenseApi
18939
- * @version 96.0.0
19072
+ * @version 97.0.0
18940
19073
  */
18941
19074
 
18942
19075
  /**
@@ -19174,7 +19307,7 @@ class LocationsApi {
19174
19307
  /**
19175
19308
  * Locations service.
19176
19309
  * @module purecloud-platform-client-v2/api/LocationsApi
19177
- * @version 96.0.0
19310
+ * @version 97.0.0
19178
19311
  */
19179
19312
 
19180
19313
  /**
@@ -19410,7 +19543,7 @@ class MobileDevicesApi {
19410
19543
  /**
19411
19544
  * MobileDevices service.
19412
19545
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
19413
- * @version 96.0.0
19546
+ * @version 97.0.0
19414
19547
  */
19415
19548
 
19416
19549
  /**
@@ -19561,7 +19694,7 @@ class NotificationsApi {
19561
19694
  /**
19562
19695
  * Notifications service.
19563
19696
  * @module purecloud-platform-client-v2/api/NotificationsApi
19564
- * @version 96.0.0
19697
+ * @version 97.0.0
19565
19698
  */
19566
19699
 
19567
19700
  /**
@@ -19760,7 +19893,7 @@ class OAuthApi {
19760
19893
  /**
19761
19894
  * OAuth service.
19762
19895
  * @module purecloud-platform-client-v2/api/OAuthApi
19763
- * @version 96.0.0
19896
+ * @version 97.0.0
19764
19897
  */
19765
19898
 
19766
19899
  /**
@@ -20118,7 +20251,7 @@ class ObjectsApi {
20118
20251
  /**
20119
20252
  * Objects service.
20120
20253
  * @module purecloud-platform-client-v2/api/ObjectsApi
20121
- * @version 96.0.0
20254
+ * @version 97.0.0
20122
20255
  */
20123
20256
 
20124
20257
  /**
@@ -20359,7 +20492,7 @@ class OrganizationApi {
20359
20492
  /**
20360
20493
  * Organization service.
20361
20494
  * @module purecloud-platform-client-v2/api/OrganizationApi
20362
- * @version 96.0.0
20495
+ * @version 97.0.0
20363
20496
  */
20364
20497
 
20365
20498
  /**
@@ -20614,7 +20747,7 @@ class OrganizationAuthorizationApi {
20614
20747
  /**
20615
20748
  * OrganizationAuthorization service.
20616
20749
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
20617
- * @version 96.0.0
20750
+ * @version 97.0.0
20618
20751
  */
20619
20752
 
20620
20753
  /**
@@ -21324,7 +21457,7 @@ class OutboundApi {
21324
21457
  /**
21325
21458
  * Outbound service.
21326
21459
  * @module purecloud-platform-client-v2/api/OutboundApi
21327
- * @version 96.0.0
21460
+ * @version 97.0.0
21328
21461
  */
21329
21462
 
21330
21463
  /**
@@ -24298,7 +24431,7 @@ class PresenceApi {
24298
24431
  /**
24299
24432
  * Presence service.
24300
24433
  * @module purecloud-platform-client-v2/api/PresenceApi
24301
- * @version 96.0.0
24434
+ * @version 97.0.0
24302
24435
  */
24303
24436
 
24304
24437
  /**
@@ -24645,7 +24778,7 @@ class QualityApi {
24645
24778
  /**
24646
24779
  * Quality service.
24647
24780
  * @module purecloud-platform-client-v2/api/QualityApi
24648
- * @version 96.0.0
24781
+ * @version 97.0.0
24649
24782
  */
24650
24783
 
24651
24784
  /**
@@ -26342,7 +26475,7 @@ class RecordingApi {
26342
26475
  /**
26343
26476
  * Recording service.
26344
26477
  * @module purecloud-platform-client-v2/api/RecordingApi
26345
- * @version 96.0.0
26478
+ * @version 97.0.0
26346
26479
  */
26347
26480
 
26348
26481
  /**
@@ -27588,7 +27721,7 @@ class ResponseManagementApi {
27588
27721
  /**
27589
27722
  * ResponseManagement service.
27590
27723
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
27591
- * @version 96.0.0
27724
+ * @version 97.0.0
27592
27725
  */
27593
27726
 
27594
27727
  /**
@@ -27913,7 +28046,7 @@ class RoutingApi {
27913
28046
  /**
27914
28047
  * Routing service.
27915
28048
  * @module purecloud-platform-client-v2/api/RoutingApi
27916
- * @version 96.0.0
28049
+ * @version 97.0.0
27917
28050
  */
27918
28051
 
27919
28052
  /**
@@ -30211,7 +30344,7 @@ class SCIMApi {
30211
30344
  /**
30212
30345
  * SCIM service.
30213
30346
  * @module purecloud-platform-client-v2/api/SCIMApi
30214
- * @version 96.0.0
30347
+ * @version 97.0.0
30215
30348
  */
30216
30349
 
30217
30350
  /**
@@ -31196,7 +31329,7 @@ class ScriptsApi {
31196
31329
  /**
31197
31330
  * Scripts service.
31198
31331
  * @module purecloud-platform-client-v2/api/ScriptsApi
31199
- * @version 96.0.0
31332
+ * @version 97.0.0
31200
31333
  */
31201
31334
 
31202
31335
  /**
@@ -31549,7 +31682,7 @@ class SearchApi {
31549
31682
  /**
31550
31683
  * Search service.
31551
31684
  * @module purecloud-platform-client-v2/api/SearchApi
31552
- * @version 96.0.0
31685
+ * @version 97.0.0
31553
31686
  */
31554
31687
 
31555
31688
  /**
@@ -32059,7 +32192,7 @@ class SpeechTextAnalyticsApi {
32059
32192
  /**
32060
32193
  * SpeechTextAnalytics service.
32061
32194
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
32062
- * @version 96.0.0
32195
+ * @version 97.0.0
32063
32196
  */
32064
32197
 
32065
32198
  /**
@@ -32135,7 +32268,7 @@ class StationsApi {
32135
32268
  /**
32136
32269
  * Stations service.
32137
32270
  * @module purecloud-platform-client-v2/api/StationsApi
32138
- * @version 96.0.0
32271
+ * @version 97.0.0
32139
32272
  */
32140
32273
 
32141
32274
  /**
@@ -32282,7 +32415,7 @@ class SuggestApi {
32282
32415
  /**
32283
32416
  * Suggest service.
32284
32417
  * @module purecloud-platform-client-v2/api/SuggestApi
32285
- * @version 96.0.0
32418
+ * @version 97.0.0
32286
32419
  */
32287
32420
 
32288
32421
  /**
@@ -32421,7 +32554,7 @@ class TelephonyApi {
32421
32554
  /**
32422
32555
  * Telephony service.
32423
32556
  * @module purecloud-platform-client-v2/api/TelephonyApi
32424
- * @version 96.0.0
32557
+ * @version 97.0.0
32425
32558
  */
32426
32559
 
32427
32560
  /**
@@ -32529,7 +32662,7 @@ class TelephonyProvidersEdgeApi {
32529
32662
  /**
32530
32663
  * TelephonyProvidersEdge service.
32531
32664
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
32532
- * @version 96.0.0
32665
+ * @version 97.0.0
32533
32666
  */
32534
32667
 
32535
32668
  /**
@@ -36106,7 +36239,7 @@ class TextbotsApi {
36106
36239
  /**
36107
36240
  * Textbots service.
36108
36241
  * @module purecloud-platform-client-v2/api/TextbotsApi
36109
- * @version 96.0.0
36242
+ * @version 97.0.0
36110
36243
  */
36111
36244
 
36112
36245
  /**
@@ -36152,7 +36285,7 @@ class TokensApi {
36152
36285
  /**
36153
36286
  * Tokens service.
36154
36287
  * @module purecloud-platform-client-v2/api/TokensApi
36155
- * @version 96.0.0
36288
+ * @version 97.0.0
36156
36289
  */
36157
36290
 
36158
36291
  /**
@@ -36238,7 +36371,7 @@ class UploadsApi {
36238
36371
  /**
36239
36372
  * Uploads service.
36240
36373
  * @module purecloud-platform-client-v2/api/UploadsApi
36241
- * @version 96.0.0
36374
+ * @version 97.0.0
36242
36375
  */
36243
36376
 
36244
36377
  /**
@@ -36284,7 +36417,7 @@ class UsageApi {
36284
36417
  /**
36285
36418
  * Usage service.
36286
36419
  * @module purecloud-platform-client-v2/api/UsageApi
36287
- * @version 96.0.0
36420
+ * @version 97.0.0
36288
36421
  */
36289
36422
 
36290
36423
  /**
@@ -36355,7 +36488,7 @@ class UserRecordingsApi {
36355
36488
  /**
36356
36489
  * UserRecordings service.
36357
36490
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
36358
- * @version 96.0.0
36491
+ * @version 97.0.0
36359
36492
  */
36360
36493
 
36361
36494
  /**
@@ -36539,7 +36672,7 @@ class UsersApi {
36539
36672
  /**
36540
36673
  * Users service.
36541
36674
  * @module purecloud-platform-client-v2/api/UsersApi
36542
- * @version 96.0.0
36675
+ * @version 97.0.0
36543
36676
  */
36544
36677
 
36545
36678
  /**
@@ -38752,7 +38885,7 @@ class UtilitiesApi {
38752
38885
  /**
38753
38886
  * Utilities service.
38754
38887
  * @module purecloud-platform-client-v2/api/UtilitiesApi
38755
- * @version 96.0.0
38888
+ * @version 97.0.0
38756
38889
  */
38757
38890
 
38758
38891
  /**
@@ -38863,7 +38996,7 @@ class VoicemailApi {
38863
38996
  /**
38864
38997
  * Voicemail service.
38865
38998
  * @module purecloud-platform-client-v2/api/VoicemailApi
38866
- * @version 96.0.0
38999
+ * @version 97.0.0
38867
39000
  */
38868
39001
 
38869
39002
  /**
@@ -39500,7 +39633,7 @@ class WebChatApi {
39500
39633
  /**
39501
39634
  * WebChat service.
39502
39635
  * @module purecloud-platform-client-v2/api/WebChatApi
39503
- * @version 96.0.0
39636
+ * @version 97.0.0
39504
39637
  */
39505
39638
 
39506
39639
  /**
@@ -40044,7 +40177,7 @@ class WidgetsApi {
40044
40177
  /**
40045
40178
  * Widgets service.
40046
40179
  * @module purecloud-platform-client-v2/api/WidgetsApi
40047
- * @version 96.0.0
40180
+ * @version 97.0.0
40048
40181
  */
40049
40182
 
40050
40183
  /**
@@ -40190,7 +40323,7 @@ class WorkforceManagementApi {
40190
40323
  /**
40191
40324
  * WorkforceManagement service.
40192
40325
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
40193
- * @version 96.0.0
40326
+ * @version 97.0.0
40194
40327
  */
40195
40328
 
40196
40329
  /**
@@ -40475,6 +40608,36 @@ class WorkforceManagementApi {
40475
40608
  );
40476
40609
  }
40477
40610
 
40611
+ /**
40612
+ * Delete a work plan rotation
40613
+ *
40614
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
40615
+ * @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
40616
+ */
40617
+ deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
40618
+ // verify the required parameter 'managementUnitId' is set
40619
+ if (managementUnitId === undefined || managementUnitId === null) {
40620
+ throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
40621
+ }
40622
+ // verify the required parameter 'workPlanRotationId' is set
40623
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
40624
+ throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
40625
+ }
40626
+
40627
+ return this.apiClient.callApi(
40628
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
40629
+ 'DELETE',
40630
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
40631
+ { },
40632
+ { },
40633
+ { },
40634
+ null,
40635
+ ['PureCloud OAuth'],
40636
+ ['application/json'],
40637
+ ['application/json']
40638
+ );
40639
+ }
40640
+
40478
40641
  /**
40479
40642
  * Get a list of UserScheduleAdherence records for the requested users
40480
40643
  *
@@ -41681,6 +41844,65 @@ class WorkforceManagementApi {
41681
41844
  );
41682
41845
  }
41683
41846
 
41847
+ /**
41848
+ * Get a work plan rotation
41849
+ *
41850
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41851
+ * @param {String} workPlanRotationId The ID of the work plan rotation to fetch
41852
+ */
41853
+ getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
41854
+ // verify the required parameter 'managementUnitId' is set
41855
+ if (managementUnitId === undefined || managementUnitId === null) {
41856
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
41857
+ }
41858
+ // verify the required parameter 'workPlanRotationId' is set
41859
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
41860
+ throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
41861
+ }
41862
+
41863
+ return this.apiClient.callApi(
41864
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
41865
+ 'GET',
41866
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
41867
+ { },
41868
+ { },
41869
+ { },
41870
+ null,
41871
+ ['PureCloud OAuth'],
41872
+ ['application/json'],
41873
+ ['application/json']
41874
+ );
41875
+ }
41876
+
41877
+ /**
41878
+ * Get work plan rotations
41879
+ *
41880
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41881
+ * @param {Object} opts Optional parameters
41882
+ * @param {Array.<String>} opts.expand
41883
+ */
41884
+ getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
41885
+ opts = opts || {};
41886
+
41887
+ // verify the required parameter 'managementUnitId' is set
41888
+ if (managementUnitId === undefined || managementUnitId === null) {
41889
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
41890
+ }
41891
+
41892
+ return this.apiClient.callApi(
41893
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
41894
+ 'GET',
41895
+ { 'managementUnitId': managementUnitId },
41896
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
41897
+ { },
41898
+ { },
41899
+ null,
41900
+ ['PureCloud OAuth'],
41901
+ ['application/json'],
41902
+ ['application/json']
41903
+ );
41904
+ }
41905
+
41684
41906
  /**
41685
41907
  * Get work plans
41686
41908
  *
@@ -42183,6 +42405,40 @@ class WorkforceManagementApi {
42183
42405
  );
42184
42406
  }
42185
42407
 
42408
+ /**
42409
+ * Update a work plan rotation
42410
+ *
42411
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42412
+ * @param {String} workPlanRotationId The ID of the work plan rotation to update
42413
+ * @param {Object} opts Optional parameters
42414
+ * @param {Object} opts.body body
42415
+ */
42416
+ patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
42417
+ opts = opts || {};
42418
+
42419
+ // verify the required parameter 'managementUnitId' is set
42420
+ if (managementUnitId === undefined || managementUnitId === null) {
42421
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
42422
+ }
42423
+ // verify the required parameter 'workPlanRotationId' is set
42424
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
42425
+ throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
42426
+ }
42427
+
42428
+ return this.apiClient.callApi(
42429
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
42430
+ 'PATCH',
42431
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
42432
+ { },
42433
+ { },
42434
+ { },
42435
+ opts['body'],
42436
+ ['PureCloud OAuth'],
42437
+ ['application/json'],
42438
+ ['application/json']
42439
+ );
42440
+ }
42441
+
42186
42442
  /**
42187
42443
  * Update a time off request for the current user
42188
42444
  *
@@ -43104,6 +43360,69 @@ class WorkforceManagementApi {
43104
43360
  );
43105
43361
  }
43106
43362
 
43363
+ /**
43364
+ * Create a copy of work plan rotation
43365
+ *
43366
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43367
+ * @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
43368
+ * @param {Object} opts Optional parameters
43369
+ * @param {Object} opts.body body
43370
+ */
43371
+ postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
43372
+ opts = opts || {};
43373
+
43374
+ // verify the required parameter 'managementUnitId' is set
43375
+ if (managementUnitId === undefined || managementUnitId === null) {
43376
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
43377
+ }
43378
+ // verify the required parameter 'workPlanRotationId' is set
43379
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
43380
+ throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
43381
+ }
43382
+
43383
+ return this.apiClient.callApi(
43384
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
43385
+ 'POST',
43386
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
43387
+ { },
43388
+ { },
43389
+ { },
43390
+ opts['body'],
43391
+ ['PureCloud OAuth'],
43392
+ ['application/json'],
43393
+ ['application/json']
43394
+ );
43395
+ }
43396
+
43397
+ /**
43398
+ * Create a new work plan rotation
43399
+ *
43400
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43401
+ * @param {Object} opts Optional parameters
43402
+ * @param {Object} opts.body body
43403
+ */
43404
+ postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
43405
+ opts = opts || {};
43406
+
43407
+ // verify the required parameter 'managementUnitId' is set
43408
+ if (managementUnitId === undefined || managementUnitId === null) {
43409
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
43410
+ }
43411
+
43412
+ return this.apiClient.callApi(
43413
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
43414
+ 'POST',
43415
+ { 'managementUnitId': managementUnitId },
43416
+ { },
43417
+ { },
43418
+ { },
43419
+ opts['body'],
43420
+ ['PureCloud OAuth'],
43421
+ ['application/json'],
43422
+ ['application/json']
43423
+ );
43424
+ }
43425
+
43107
43426
  /**
43108
43427
  * Create a new work plan
43109
43428
  *
@@ -43260,7 +43579,7 @@ class WorkforceManagementApi {
43260
43579
  * </pre>
43261
43580
  * </p>
43262
43581
  * @module purecloud-platform-client-v2/index
43263
- * @version 96.0.0
43582
+ * @version 97.0.0
43264
43583
  */
43265
43584
  class platformClient {
43266
43585
  constructor() {