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
@@ -16,7 +16,7 @@ define(['superagent'], function (superagent) { 'use strict';
16
16
 
17
17
  /**
18
18
  * @module purecloud-platform-client-v2/ApiClient
19
- * @version 96.0.0
19
+ * @version 97.0.0
20
20
  */
21
21
  class ApiClient {
22
22
  /**
@@ -772,7 +772,7 @@ define(['superagent'], function (superagent) { 'use strict';
772
772
 
773
773
  // set header parameters
774
774
  request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
775
- //request.set({ 'purecloud-sdk': '96.0.0' });
775
+ //request.set({ 'purecloud-sdk': '97.0.0' });
776
776
 
777
777
  // set request timeout
778
778
  request.timeout(this.timeout);
@@ -897,7 +897,7 @@ define(['superagent'], function (superagent) { 'use strict';
897
897
  /**
898
898
  * Alerting service.
899
899
  * @module purecloud-platform-client-v2/api/AlertingApi
900
- * @version 96.0.0
900
+ * @version 97.0.0
901
901
  */
902
902
 
903
903
  /**
@@ -1211,7 +1211,7 @@ define(['superagent'], function (superagent) { 'use strict';
1211
1211
  /**
1212
1212
  * Analytics service.
1213
1213
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1214
- * @version 96.0.0
1214
+ * @version 97.0.0
1215
1215
  */
1216
1216
 
1217
1217
  /**
@@ -2291,7 +2291,7 @@ define(['superagent'], function (superagent) { 'use strict';
2291
2291
  /**
2292
2292
  * Architect service.
2293
2293
  * @module purecloud-platform-client-v2/api/ArchitectApi
2294
- * @version 96.0.0
2294
+ * @version 97.0.0
2295
2295
  */
2296
2296
 
2297
2297
  /**
@@ -5129,7 +5129,7 @@ define(['superagent'], function (superagent) { 'use strict';
5129
5129
  /**
5130
5130
  * Audit service.
5131
5131
  * @module purecloud-platform-client-v2/api/AuditApi
5132
- * @version 96.0.0
5132
+ * @version 97.0.0
5133
5133
  */
5134
5134
 
5135
5135
  /**
@@ -5300,7 +5300,7 @@ define(['superagent'], function (superagent) { 'use strict';
5300
5300
  /**
5301
5301
  * Authorization service.
5302
5302
  * @module purecloud-platform-client-v2/api/AuthorizationApi
5303
- * @version 96.0.0
5303
+ * @version 97.0.0
5304
5304
  */
5305
5305
 
5306
5306
  /**
@@ -5635,6 +5635,8 @@ define(['superagent'], function (superagent) { 'use strict';
5635
5635
  * @param {Object} opts Optional parameters
5636
5636
  * @param {Number} opts.pageSize Page size (default to 25)
5637
5637
  * @param {Number} opts.pageNumber Page number (default to 1)
5638
+ * @param {Object} opts.queryType Query filter type
5639
+ * @param {String} opts.query Comma-separated list of permissions or domains to query
5638
5640
  */
5639
5641
  getAuthorizationPermissions(opts) {
5640
5642
  opts = opts || {};
@@ -5644,7 +5646,7 @@ define(['superagent'], function (superagent) { 'use strict';
5644
5646
  '/api/v2/authorization/permissions',
5645
5647
  'GET',
5646
5648
  { },
5647
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
5649
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
5648
5650
  { },
5649
5651
  { },
5650
5652
  null,
@@ -6417,7 +6419,7 @@ define(['superagent'], function (superagent) { 'use strict';
6417
6419
  /**
6418
6420
  * Billing service.
6419
6421
  * @module purecloud-platform-client-v2/api/BillingApi
6420
- * @version 96.0.0
6422
+ * @version 97.0.0
6421
6423
  */
6422
6424
 
6423
6425
  /**
@@ -6497,7 +6499,7 @@ define(['superagent'], function (superagent) { 'use strict';
6497
6499
  /**
6498
6500
  * Coaching service.
6499
6501
  * @module purecloud-platform-client-v2/api/CoachingApi
6500
- * @version 96.0.0
6502
+ * @version 97.0.0
6501
6503
  */
6502
6504
 
6503
6505
  /**
@@ -7017,7 +7019,7 @@ define(['superagent'], function (superagent) { 'use strict';
7017
7019
  /**
7018
7020
  * ContentManagement service.
7019
7021
  * @module purecloud-platform-client-v2/api/ContentManagementApi
7020
- * @version 96.0.0
7022
+ * @version 97.0.0
7021
7023
  */
7022
7024
 
7023
7025
  /**
@@ -8157,7 +8159,7 @@ define(['superagent'], function (superagent) { 'use strict';
8157
8159
  /**
8158
8160
  * Conversations service.
8159
8161
  * @module purecloud-platform-client-v2/api/ConversationsApi
8160
- * @version 96.0.0
8162
+ * @version 97.0.0
8161
8163
  */
8162
8164
 
8163
8165
  /**
@@ -12215,7 +12217,7 @@ define(['superagent'], function (superagent) { 'use strict';
12215
12217
  /**
12216
12218
  * DataExtensions service.
12217
12219
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
12218
- * @version 96.0.0
12220
+ * @version 97.0.0
12219
12221
  */
12220
12222
 
12221
12223
  /**
@@ -12301,7 +12303,7 @@ define(['superagent'], function (superagent) { 'use strict';
12301
12303
  /**
12302
12304
  * ExternalContacts service.
12303
12305
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
12304
- * @version 96.0.0
12306
+ * @version 97.0.0
12305
12307
  */
12306
12308
 
12307
12309
  /**
@@ -13644,7 +13646,7 @@ define(['superagent'], function (superagent) { 'use strict';
13644
13646
  /**
13645
13647
  * Fax service.
13646
13648
  * @module purecloud-platform-client-v2/api/FaxApi
13647
- * @version 96.0.0
13649
+ * @version 97.0.0
13648
13650
  */
13649
13651
 
13650
13652
  /**
@@ -13815,7 +13817,7 @@ define(['superagent'], function (superagent) { 'use strict';
13815
13817
  /**
13816
13818
  * Flows service.
13817
13819
  * @module purecloud-platform-client-v2/api/FlowsApi
13818
- * @version 96.0.0
13820
+ * @version 97.0.0
13819
13821
  */
13820
13822
 
13821
13823
  /**
@@ -13886,7 +13888,7 @@ define(['superagent'], function (superagent) { 'use strict';
13886
13888
  /**
13887
13889
  * GeneralDataProtectionRegulation service.
13888
13890
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
13889
- * @version 96.0.0
13891
+ * @version 97.0.0
13890
13892
  */
13891
13893
 
13892
13894
  /**
@@ -14016,7 +14018,7 @@ define(['superagent'], function (superagent) { 'use strict';
14016
14018
  /**
14017
14019
  * Geolocation service.
14018
14020
  * @module purecloud-platform-client-v2/api/GeolocationApi
14019
- * @version 96.0.0
14021
+ * @version 97.0.0
14020
14022
  */
14021
14023
 
14022
14024
  /**
@@ -14147,7 +14149,7 @@ define(['superagent'], function (superagent) { 'use strict';
14147
14149
  /**
14148
14150
  * Greetings service.
14149
14151
  * @module purecloud-platform-client-v2/api/GreetingsApi
14150
- * @version 96.0.0
14152
+ * @version 97.0.0
14151
14153
  */
14152
14154
 
14153
14155
  /**
@@ -14602,7 +14604,7 @@ define(['superagent'], function (superagent) { 'use strict';
14602
14604
  /**
14603
14605
  * Groups service.
14604
14606
  * @module purecloud-platform-client-v2/api/GroupsApi
14605
- * @version 96.0.0
14607
+ * @version 97.0.0
14606
14608
  */
14607
14609
 
14608
14610
  /**
@@ -15007,7 +15009,7 @@ define(['superagent'], function (superagent) { 'use strict';
15007
15009
  /**
15008
15010
  * IdentityProvider service.
15009
15011
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
15010
- * @version 96.0.0
15012
+ * @version 97.0.0
15011
15013
  */
15012
15014
 
15013
15015
  /**
@@ -15763,7 +15765,7 @@ define(['superagent'], function (superagent) { 'use strict';
15763
15765
  /**
15764
15766
  * Integrations service.
15765
15767
  * @module purecloud-platform-client-v2/api/IntegrationsApi
15766
- * @version 96.0.0
15768
+ * @version 97.0.0
15767
15769
  */
15768
15770
 
15769
15771
  /**
@@ -17255,7 +17257,7 @@ define(['superagent'], function (superagent) { 'use strict';
17255
17257
  /**
17256
17258
  * Journey service.
17257
17259
  * @module purecloud-platform-client-v2/api/JourneyApi
17258
- * @version 96.0.0
17260
+ * @version 97.0.0
17259
17261
  */
17260
17262
 
17261
17263
  /**
@@ -17320,6 +17322,107 @@ define(['superagent'], function (superagent) { 'use strict';
17320
17322
  );
17321
17323
  }
17322
17324
 
17325
+ /**
17326
+ * Retrieve segment assignments by customer ID.
17327
+ *
17328
+ * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
17329
+ * @param {String} customerId Primary identifier of the customer to query for segment assignments.
17330
+ * @param {Object} opts Optional parameters
17331
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17332
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17333
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
17334
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
17335
+ */
17336
+ getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
17337
+ opts = opts || {};
17338
+
17339
+ // verify the required parameter 'customerIdType' is set
17340
+ if (customerIdType === undefined || customerIdType === null) {
17341
+ throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
17342
+ }
17343
+ // verify the required parameter 'customerId' is set
17344
+ if (customerId === undefined || customerId === null) {
17345
+ throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
17346
+ }
17347
+
17348
+ return this.apiClient.callApi(
17349
+ '/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
17350
+ 'GET',
17351
+ { 'customerIdType': customerIdType,'customerId': customerId },
17352
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
17353
+ { },
17354
+ { },
17355
+ null,
17356
+ ['PureCloud OAuth'],
17357
+ ['application/json'],
17358
+ ['application/json']
17359
+ );
17360
+ }
17361
+
17362
+ /**
17363
+ * Retrieve segment assignments by external contact ID.
17364
+ *
17365
+ * @param {String} externalContactId ID of the external contact to query for segment assignments.
17366
+ * @param {Object} opts Optional parameters
17367
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17368
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17369
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
17370
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
17371
+ */
17372
+ getJourneyExternalcontactSegments(externalContactId, opts) {
17373
+ opts = opts || {};
17374
+
17375
+ // verify the required parameter 'externalContactId' is set
17376
+ if (externalContactId === undefined || externalContactId === null) {
17377
+ throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
17378
+ }
17379
+
17380
+ return this.apiClient.callApi(
17381
+ '/api/v2/journey/externalcontacts/{externalContactId}/segments',
17382
+ 'GET',
17383
+ { 'externalContactId': externalContactId },
17384
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
17385
+ { },
17386
+ { },
17387
+ null,
17388
+ ['PureCloud OAuth'],
17389
+ ['application/json'],
17390
+ ['application/json']
17391
+ );
17392
+ }
17393
+
17394
+ /**
17395
+ * Retrieve segment assignments by session ID.
17396
+ *
17397
+ * @param {String} sessionId ID of the session to query for segment assignments.
17398
+ * @param {Object} opts Optional parameters
17399
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17400
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17401
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
17402
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
17403
+ */
17404
+ getJourneySessionSegments(sessionId, opts) {
17405
+ opts = opts || {};
17406
+
17407
+ // verify the required parameter 'sessionId' is set
17408
+ if (sessionId === undefined || sessionId === null) {
17409
+ throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
17410
+ }
17411
+
17412
+ return this.apiClient.callApi(
17413
+ '/api/v2/journey/sessions/{sessionId}/segments',
17414
+ 'GET',
17415
+ { 'sessionId': sessionId },
17416
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
17417
+ { },
17418
+ { },
17419
+ null,
17420
+ ['PureCloud OAuth'],
17421
+ ['application/json'],
17422
+ ['application/json']
17423
+ );
17424
+ }
17425
+
17323
17426
  /**
17324
17427
  * Update a single action target.
17325
17428
  *
@@ -17374,13 +17477,42 @@ define(['superagent'], function (superagent) { 'use strict';
17374
17477
  );
17375
17478
  }
17376
17479
 
17480
+ /**
17481
+ * Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
17482
+ *
17483
+ * @param {String} externalContactId ID of the external contact to query for segment assignments.
17484
+ * @param {Object} opts Optional parameters
17485
+ * @param {Array.<Object>} opts.body
17486
+ */
17487
+ postJourneyExternalcontactSegments(externalContactId, opts) {
17488
+ opts = opts || {};
17489
+
17490
+ // verify the required parameter 'externalContactId' is set
17491
+ if (externalContactId === undefined || externalContactId === null) {
17492
+ throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
17493
+ }
17494
+
17495
+ return this.apiClient.callApi(
17496
+ '/api/v2/journey/externalcontacts/{externalContactId}/segments',
17497
+ 'POST',
17498
+ { 'externalContactId': externalContactId },
17499
+ { },
17500
+ { },
17501
+ { },
17502
+ opts['body'],
17503
+ ['PureCloud OAuth'],
17504
+ ['application/json'],
17505
+ ['application/json']
17506
+ );
17507
+ }
17508
+
17377
17509
  }
17378
17510
 
17379
17511
  class KnowledgeApi {
17380
17512
  /**
17381
17513
  * Knowledge service.
17382
17514
  * @module purecloud-platform-client-v2/api/KnowledgeApi
17383
- * @version 96.0.0
17515
+ * @version 97.0.0
17384
17516
  */
17385
17517
 
17386
17518
  /**
@@ -17696,7 +17828,7 @@ define(['superagent'], function (superagent) { 'use strict';
17696
17828
  }
17697
17829
 
17698
17830
  /**
17699
- * Get All trainings information for a knowledgebase
17831
+ * Get all trainings information for a knowledgebase
17700
17832
  *
17701
17833
  * @param {String} knowledgeBaseId Knowledge base ID
17702
17834
  * @param {Object} languageCode Language code, format: iso2-LOCALE
@@ -17705,6 +17837,7 @@ define(['superagent'], function (superagent) { 'use strict';
17705
17837
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17706
17838
  * @param {String} opts.limit Number of entities to return. Maximum of 200.
17707
17839
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17840
+ * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
17708
17841
  */
17709
17842
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
17710
17843
  opts = opts || {};
@@ -17722,7 +17855,7 @@ define(['superagent'], function (superagent) { 'use strict';
17722
17855
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
17723
17856
  'GET',
17724
17857
  { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
17725
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
17858
+ { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
17726
17859
  { },
17727
17860
  { },
17728
17861
  null,
@@ -18100,7 +18233,7 @@ define(['superagent'], function (superagent) { 'use strict';
18100
18233
  /**
18101
18234
  * LanguageUnderstanding service.
18102
18235
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
18103
- * @version 96.0.0
18236
+ * @version 97.0.0
18104
18237
  */
18105
18238
 
18106
18239
  /**
@@ -18666,7 +18799,7 @@ define(['superagent'], function (superagent) { 'use strict';
18666
18799
  /**
18667
18800
  * Languages service.
18668
18801
  * @module purecloud-platform-client-v2/api/LanguagesApi
18669
- * @version 96.0.0
18802
+ * @version 97.0.0
18670
18803
  */
18671
18804
 
18672
18805
  /**
@@ -18934,7 +19067,7 @@ define(['superagent'], function (superagent) { 'use strict';
18934
19067
  /**
18935
19068
  * License service.
18936
19069
  * @module purecloud-platform-client-v2/api/LicenseApi
18937
- * @version 96.0.0
19070
+ * @version 97.0.0
18938
19071
  */
18939
19072
 
18940
19073
  /**
@@ -19172,7 +19305,7 @@ define(['superagent'], function (superagent) { 'use strict';
19172
19305
  /**
19173
19306
  * Locations service.
19174
19307
  * @module purecloud-platform-client-v2/api/LocationsApi
19175
- * @version 96.0.0
19308
+ * @version 97.0.0
19176
19309
  */
19177
19310
 
19178
19311
  /**
@@ -19408,7 +19541,7 @@ define(['superagent'], function (superagent) { 'use strict';
19408
19541
  /**
19409
19542
  * MobileDevices service.
19410
19543
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
19411
- * @version 96.0.0
19544
+ * @version 97.0.0
19412
19545
  */
19413
19546
 
19414
19547
  /**
@@ -19559,7 +19692,7 @@ define(['superagent'], function (superagent) { 'use strict';
19559
19692
  /**
19560
19693
  * Notifications service.
19561
19694
  * @module purecloud-platform-client-v2/api/NotificationsApi
19562
- * @version 96.0.0
19695
+ * @version 97.0.0
19563
19696
  */
19564
19697
 
19565
19698
  /**
@@ -19758,7 +19891,7 @@ define(['superagent'], function (superagent) { 'use strict';
19758
19891
  /**
19759
19892
  * OAuth service.
19760
19893
  * @module purecloud-platform-client-v2/api/OAuthApi
19761
- * @version 96.0.0
19894
+ * @version 97.0.0
19762
19895
  */
19763
19896
 
19764
19897
  /**
@@ -20116,7 +20249,7 @@ define(['superagent'], function (superagent) { 'use strict';
20116
20249
  /**
20117
20250
  * Objects service.
20118
20251
  * @module purecloud-platform-client-v2/api/ObjectsApi
20119
- * @version 96.0.0
20252
+ * @version 97.0.0
20120
20253
  */
20121
20254
 
20122
20255
  /**
@@ -20357,7 +20490,7 @@ define(['superagent'], function (superagent) { 'use strict';
20357
20490
  /**
20358
20491
  * Organization service.
20359
20492
  * @module purecloud-platform-client-v2/api/OrganizationApi
20360
- * @version 96.0.0
20493
+ * @version 97.0.0
20361
20494
  */
20362
20495
 
20363
20496
  /**
@@ -20612,7 +20745,7 @@ define(['superagent'], function (superagent) { 'use strict';
20612
20745
  /**
20613
20746
  * OrganizationAuthorization service.
20614
20747
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
20615
- * @version 96.0.0
20748
+ * @version 97.0.0
20616
20749
  */
20617
20750
 
20618
20751
  /**
@@ -21322,7 +21455,7 @@ define(['superagent'], function (superagent) { 'use strict';
21322
21455
  /**
21323
21456
  * Outbound service.
21324
21457
  * @module purecloud-platform-client-v2/api/OutboundApi
21325
- * @version 96.0.0
21458
+ * @version 97.0.0
21326
21459
  */
21327
21460
 
21328
21461
  /**
@@ -24296,7 +24429,7 @@ define(['superagent'], function (superagent) { 'use strict';
24296
24429
  /**
24297
24430
  * Presence service.
24298
24431
  * @module purecloud-platform-client-v2/api/PresenceApi
24299
- * @version 96.0.0
24432
+ * @version 97.0.0
24300
24433
  */
24301
24434
 
24302
24435
  /**
@@ -24643,7 +24776,7 @@ define(['superagent'], function (superagent) { 'use strict';
24643
24776
  /**
24644
24777
  * Quality service.
24645
24778
  * @module purecloud-platform-client-v2/api/QualityApi
24646
- * @version 96.0.0
24779
+ * @version 97.0.0
24647
24780
  */
24648
24781
 
24649
24782
  /**
@@ -26340,7 +26473,7 @@ define(['superagent'], function (superagent) { 'use strict';
26340
26473
  /**
26341
26474
  * Recording service.
26342
26475
  * @module purecloud-platform-client-v2/api/RecordingApi
26343
- * @version 96.0.0
26476
+ * @version 97.0.0
26344
26477
  */
26345
26478
 
26346
26479
  /**
@@ -27586,7 +27719,7 @@ define(['superagent'], function (superagent) { 'use strict';
27586
27719
  /**
27587
27720
  * ResponseManagement service.
27588
27721
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
27589
- * @version 96.0.0
27722
+ * @version 97.0.0
27590
27723
  */
27591
27724
 
27592
27725
  /**
@@ -27911,7 +28044,7 @@ define(['superagent'], function (superagent) { 'use strict';
27911
28044
  /**
27912
28045
  * Routing service.
27913
28046
  * @module purecloud-platform-client-v2/api/RoutingApi
27914
- * @version 96.0.0
28047
+ * @version 97.0.0
27915
28048
  */
27916
28049
 
27917
28050
  /**
@@ -30209,7 +30342,7 @@ define(['superagent'], function (superagent) { 'use strict';
30209
30342
  /**
30210
30343
  * SCIM service.
30211
30344
  * @module purecloud-platform-client-v2/api/SCIMApi
30212
- * @version 96.0.0
30345
+ * @version 97.0.0
30213
30346
  */
30214
30347
 
30215
30348
  /**
@@ -31194,7 +31327,7 @@ define(['superagent'], function (superagent) { 'use strict';
31194
31327
  /**
31195
31328
  * Scripts service.
31196
31329
  * @module purecloud-platform-client-v2/api/ScriptsApi
31197
- * @version 96.0.0
31330
+ * @version 97.0.0
31198
31331
  */
31199
31332
 
31200
31333
  /**
@@ -31547,7 +31680,7 @@ define(['superagent'], function (superagent) { 'use strict';
31547
31680
  /**
31548
31681
  * Search service.
31549
31682
  * @module purecloud-platform-client-v2/api/SearchApi
31550
- * @version 96.0.0
31683
+ * @version 97.0.0
31551
31684
  */
31552
31685
 
31553
31686
  /**
@@ -32057,7 +32190,7 @@ define(['superagent'], function (superagent) { 'use strict';
32057
32190
  /**
32058
32191
  * SpeechTextAnalytics service.
32059
32192
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
32060
- * @version 96.0.0
32193
+ * @version 97.0.0
32061
32194
  */
32062
32195
 
32063
32196
  /**
@@ -32133,7 +32266,7 @@ define(['superagent'], function (superagent) { 'use strict';
32133
32266
  /**
32134
32267
  * Stations service.
32135
32268
  * @module purecloud-platform-client-v2/api/StationsApi
32136
- * @version 96.0.0
32269
+ * @version 97.0.0
32137
32270
  */
32138
32271
 
32139
32272
  /**
@@ -32280,7 +32413,7 @@ define(['superagent'], function (superagent) { 'use strict';
32280
32413
  /**
32281
32414
  * Suggest service.
32282
32415
  * @module purecloud-platform-client-v2/api/SuggestApi
32283
- * @version 96.0.0
32416
+ * @version 97.0.0
32284
32417
  */
32285
32418
 
32286
32419
  /**
@@ -32419,7 +32552,7 @@ define(['superagent'], function (superagent) { 'use strict';
32419
32552
  /**
32420
32553
  * Telephony service.
32421
32554
  * @module purecloud-platform-client-v2/api/TelephonyApi
32422
- * @version 96.0.0
32555
+ * @version 97.0.0
32423
32556
  */
32424
32557
 
32425
32558
  /**
@@ -32527,7 +32660,7 @@ define(['superagent'], function (superagent) { 'use strict';
32527
32660
  /**
32528
32661
  * TelephonyProvidersEdge service.
32529
32662
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
32530
- * @version 96.0.0
32663
+ * @version 97.0.0
32531
32664
  */
32532
32665
 
32533
32666
  /**
@@ -36104,7 +36237,7 @@ define(['superagent'], function (superagent) { 'use strict';
36104
36237
  /**
36105
36238
  * Textbots service.
36106
36239
  * @module purecloud-platform-client-v2/api/TextbotsApi
36107
- * @version 96.0.0
36240
+ * @version 97.0.0
36108
36241
  */
36109
36242
 
36110
36243
  /**
@@ -36150,7 +36283,7 @@ define(['superagent'], function (superagent) { 'use strict';
36150
36283
  /**
36151
36284
  * Tokens service.
36152
36285
  * @module purecloud-platform-client-v2/api/TokensApi
36153
- * @version 96.0.0
36286
+ * @version 97.0.0
36154
36287
  */
36155
36288
 
36156
36289
  /**
@@ -36236,7 +36369,7 @@ define(['superagent'], function (superagent) { 'use strict';
36236
36369
  /**
36237
36370
  * Uploads service.
36238
36371
  * @module purecloud-platform-client-v2/api/UploadsApi
36239
- * @version 96.0.0
36372
+ * @version 97.0.0
36240
36373
  */
36241
36374
 
36242
36375
  /**
@@ -36282,7 +36415,7 @@ define(['superagent'], function (superagent) { 'use strict';
36282
36415
  /**
36283
36416
  * Usage service.
36284
36417
  * @module purecloud-platform-client-v2/api/UsageApi
36285
- * @version 96.0.0
36418
+ * @version 97.0.0
36286
36419
  */
36287
36420
 
36288
36421
  /**
@@ -36353,7 +36486,7 @@ define(['superagent'], function (superagent) { 'use strict';
36353
36486
  /**
36354
36487
  * UserRecordings service.
36355
36488
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
36356
- * @version 96.0.0
36489
+ * @version 97.0.0
36357
36490
  */
36358
36491
 
36359
36492
  /**
@@ -36537,7 +36670,7 @@ define(['superagent'], function (superagent) { 'use strict';
36537
36670
  /**
36538
36671
  * Users service.
36539
36672
  * @module purecloud-platform-client-v2/api/UsersApi
36540
- * @version 96.0.0
36673
+ * @version 97.0.0
36541
36674
  */
36542
36675
 
36543
36676
  /**
@@ -38750,7 +38883,7 @@ define(['superagent'], function (superagent) { 'use strict';
38750
38883
  /**
38751
38884
  * Utilities service.
38752
38885
  * @module purecloud-platform-client-v2/api/UtilitiesApi
38753
- * @version 96.0.0
38886
+ * @version 97.0.0
38754
38887
  */
38755
38888
 
38756
38889
  /**
@@ -38861,7 +38994,7 @@ define(['superagent'], function (superagent) { 'use strict';
38861
38994
  /**
38862
38995
  * Voicemail service.
38863
38996
  * @module purecloud-platform-client-v2/api/VoicemailApi
38864
- * @version 96.0.0
38997
+ * @version 97.0.0
38865
38998
  */
38866
38999
 
38867
39000
  /**
@@ -39498,7 +39631,7 @@ define(['superagent'], function (superagent) { 'use strict';
39498
39631
  /**
39499
39632
  * WebChat service.
39500
39633
  * @module purecloud-platform-client-v2/api/WebChatApi
39501
- * @version 96.0.0
39634
+ * @version 97.0.0
39502
39635
  */
39503
39636
 
39504
39637
  /**
@@ -40042,7 +40175,7 @@ define(['superagent'], function (superagent) { 'use strict';
40042
40175
  /**
40043
40176
  * Widgets service.
40044
40177
  * @module purecloud-platform-client-v2/api/WidgetsApi
40045
- * @version 96.0.0
40178
+ * @version 97.0.0
40046
40179
  */
40047
40180
 
40048
40181
  /**
@@ -40188,7 +40321,7 @@ define(['superagent'], function (superagent) { 'use strict';
40188
40321
  /**
40189
40322
  * WorkforceManagement service.
40190
40323
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
40191
- * @version 96.0.0
40324
+ * @version 97.0.0
40192
40325
  */
40193
40326
 
40194
40327
  /**
@@ -40473,6 +40606,36 @@ define(['superagent'], function (superagent) { 'use strict';
40473
40606
  );
40474
40607
  }
40475
40608
 
40609
+ /**
40610
+ * Delete a work plan rotation
40611
+ *
40612
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
40613
+ * @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
40614
+ */
40615
+ deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
40616
+ // verify the required parameter 'managementUnitId' is set
40617
+ if (managementUnitId === undefined || managementUnitId === null) {
40618
+ throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
40619
+ }
40620
+ // verify the required parameter 'workPlanRotationId' is set
40621
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
40622
+ throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
40623
+ }
40624
+
40625
+ return this.apiClient.callApi(
40626
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
40627
+ 'DELETE',
40628
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
40629
+ { },
40630
+ { },
40631
+ { },
40632
+ null,
40633
+ ['PureCloud OAuth'],
40634
+ ['application/json'],
40635
+ ['application/json']
40636
+ );
40637
+ }
40638
+
40476
40639
  /**
40477
40640
  * Get a list of UserScheduleAdherence records for the requested users
40478
40641
  *
@@ -41679,6 +41842,65 @@ define(['superagent'], function (superagent) { 'use strict';
41679
41842
  );
41680
41843
  }
41681
41844
 
41845
+ /**
41846
+ * Get a work plan rotation
41847
+ *
41848
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41849
+ * @param {String} workPlanRotationId The ID of the work plan rotation to fetch
41850
+ */
41851
+ getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
41852
+ // verify the required parameter 'managementUnitId' is set
41853
+ if (managementUnitId === undefined || managementUnitId === null) {
41854
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
41855
+ }
41856
+ // verify the required parameter 'workPlanRotationId' is set
41857
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
41858
+ throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
41859
+ }
41860
+
41861
+ return this.apiClient.callApi(
41862
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
41863
+ 'GET',
41864
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
41865
+ { },
41866
+ { },
41867
+ { },
41868
+ null,
41869
+ ['PureCloud OAuth'],
41870
+ ['application/json'],
41871
+ ['application/json']
41872
+ );
41873
+ }
41874
+
41875
+ /**
41876
+ * Get work plan rotations
41877
+ *
41878
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41879
+ * @param {Object} opts Optional parameters
41880
+ * @param {Array.<String>} opts.expand
41881
+ */
41882
+ getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
41883
+ opts = opts || {};
41884
+
41885
+ // verify the required parameter 'managementUnitId' is set
41886
+ if (managementUnitId === undefined || managementUnitId === null) {
41887
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
41888
+ }
41889
+
41890
+ return this.apiClient.callApi(
41891
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
41892
+ 'GET',
41893
+ { 'managementUnitId': managementUnitId },
41894
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
41895
+ { },
41896
+ { },
41897
+ null,
41898
+ ['PureCloud OAuth'],
41899
+ ['application/json'],
41900
+ ['application/json']
41901
+ );
41902
+ }
41903
+
41682
41904
  /**
41683
41905
  * Get work plans
41684
41906
  *
@@ -42181,6 +42403,40 @@ define(['superagent'], function (superagent) { 'use strict';
42181
42403
  );
42182
42404
  }
42183
42405
 
42406
+ /**
42407
+ * Update a work plan rotation
42408
+ *
42409
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42410
+ * @param {String} workPlanRotationId The ID of the work plan rotation to update
42411
+ * @param {Object} opts Optional parameters
42412
+ * @param {Object} opts.body body
42413
+ */
42414
+ patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
42415
+ opts = opts || {};
42416
+
42417
+ // verify the required parameter 'managementUnitId' is set
42418
+ if (managementUnitId === undefined || managementUnitId === null) {
42419
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
42420
+ }
42421
+ // verify the required parameter 'workPlanRotationId' is set
42422
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
42423
+ throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
42424
+ }
42425
+
42426
+ return this.apiClient.callApi(
42427
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
42428
+ 'PATCH',
42429
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
42430
+ { },
42431
+ { },
42432
+ { },
42433
+ opts['body'],
42434
+ ['PureCloud OAuth'],
42435
+ ['application/json'],
42436
+ ['application/json']
42437
+ );
42438
+ }
42439
+
42184
42440
  /**
42185
42441
  * Update a time off request for the current user
42186
42442
  *
@@ -43102,6 +43358,69 @@ define(['superagent'], function (superagent) { 'use strict';
43102
43358
  );
43103
43359
  }
43104
43360
 
43361
+ /**
43362
+ * Create a copy of work plan rotation
43363
+ *
43364
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43365
+ * @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
43366
+ * @param {Object} opts Optional parameters
43367
+ * @param {Object} opts.body body
43368
+ */
43369
+ postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
43370
+ opts = opts || {};
43371
+
43372
+ // verify the required parameter 'managementUnitId' is set
43373
+ if (managementUnitId === undefined || managementUnitId === null) {
43374
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
43375
+ }
43376
+ // verify the required parameter 'workPlanRotationId' is set
43377
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
43378
+ throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
43379
+ }
43380
+
43381
+ return this.apiClient.callApi(
43382
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
43383
+ 'POST',
43384
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
43385
+ { },
43386
+ { },
43387
+ { },
43388
+ opts['body'],
43389
+ ['PureCloud OAuth'],
43390
+ ['application/json'],
43391
+ ['application/json']
43392
+ );
43393
+ }
43394
+
43395
+ /**
43396
+ * Create a new work plan rotation
43397
+ *
43398
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43399
+ * @param {Object} opts Optional parameters
43400
+ * @param {Object} opts.body body
43401
+ */
43402
+ postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
43403
+ opts = opts || {};
43404
+
43405
+ // verify the required parameter 'managementUnitId' is set
43406
+ if (managementUnitId === undefined || managementUnitId === null) {
43407
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
43408
+ }
43409
+
43410
+ return this.apiClient.callApi(
43411
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
43412
+ 'POST',
43413
+ { 'managementUnitId': managementUnitId },
43414
+ { },
43415
+ { },
43416
+ { },
43417
+ opts['body'],
43418
+ ['PureCloud OAuth'],
43419
+ ['application/json'],
43420
+ ['application/json']
43421
+ );
43422
+ }
43423
+
43105
43424
  /**
43106
43425
  * Create a new work plan
43107
43426
  *
@@ -43258,7 +43577,7 @@ define(['superagent'], function (superagent) { 'use strict';
43258
43577
  * </pre>
43259
43578
  * </p>
43260
43579
  * @module purecloud-platform-client-v2/index
43261
- * @version 96.0.0
43580
+ * @version 97.0.0
43262
43581
  */
43263
43582
  class platformClient {
43264
43583
  constructor() {