purecloud-platform-client-v2 94.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 (68) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +547 -1265
  3. package/dist/web-amd/purecloud-platform-client-v2.js +547 -1265
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +547 -1265
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +552 -1269
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +513 -289
  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 +3 -3
  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 +26 -10
  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 +7 -7
  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 +26 -26
  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 +3 -3
  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 +123 -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 +306 -1147
  67. package/src/purecloud-platform-client-v2/index.js +1 -7
  68. package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
@@ -18,7 +18,7 @@ var PureCloudRegionHosts = {
18
18
 
19
19
  /**
20
20
  * @module purecloud-platform-client-v2/ApiClient
21
- * @version 94.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': '94.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 94.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 94.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 94.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 94.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 94.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 94.0.0
6424
+ * @version 97.0.0
6423
6425
  */
6424
6426
 
6425
6427
  /**
@@ -6437,8 +6439,8 @@ class BillingApi {
6437
6439
  /**
6438
6440
  * Get a report of the billable license usages
6439
6441
  * Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
6440
- * @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
6441
- * @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
6442
+ * @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
6443
+ * @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
6442
6444
  */
6443
6445
  getBillingReportsBillableusage(startDate, endDate) {
6444
6446
  // verify the required parameter 'startDate' is set
@@ -6499,7 +6501,7 @@ class CoachingApi {
6499
6501
  /**
6500
6502
  * Coaching service.
6501
6503
  * @module purecloud-platform-client-v2/api/CoachingApi
6502
- * @version 94.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 94.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 94.0.0
8164
+ * @version 97.0.0
8163
8165
  */
8164
8166
 
8165
8167
  /**
@@ -11788,7 +11790,7 @@ class ConversationsApi {
11788
11790
 
11789
11791
  /**
11790
11792
  * Send message
11791
- *
11793
+ * Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.
11792
11794
  * @param {String} conversationId conversationId
11793
11795
  * @param {String} communicationId communicationId
11794
11796
  * @param {Object} body Message
@@ -11969,8 +11971,12 @@ class ConversationsApi {
11969
11971
  * Create a Facebook Integration
11970
11972
  *
11971
11973
  * @param {Object} body FacebookIntegrationRequest
11974
+ * @param {Object} opts Optional parameters
11975
+ * @param {Boolean} opts.async Create a Facebook integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Facebook integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
11972
11976
  */
11973
- postConversationsMessagingIntegrationsFacebook(body) {
11977
+ postConversationsMessagingIntegrationsFacebook(body, opts) {
11978
+ opts = opts || {};
11979
+
11974
11980
  // verify the required parameter 'body' is set
11975
11981
  if (body === undefined || body === null) {
11976
11982
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';
@@ -11980,7 +11986,7 @@ class ConversationsApi {
11980
11986
  '/api/v2/conversations/messaging/integrations/facebook',
11981
11987
  'POST',
11982
11988
  { },
11983
- { },
11989
+ { 'async': opts['async'] },
11984
11990
  { },
11985
11991
  { },
11986
11992
  body,
@@ -11994,8 +12000,12 @@ class ConversationsApi {
11994
12000
  * Create a LINE messenger Integration
11995
12001
  *
11996
12002
  * @param {Object} body LineIntegrationRequest
12003
+ * @param {Object} opts Optional parameters
12004
+ * @param {Boolean} opts.async Create a LINE integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new LINE integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
11997
12005
  */
11998
- postConversationsMessagingIntegrationsLine(body) {
12006
+ postConversationsMessagingIntegrationsLine(body, opts) {
12007
+ opts = opts || {};
12008
+
11999
12009
  // verify the required parameter 'body' is set
12000
12010
  if (body === undefined || body === null) {
12001
12011
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
@@ -12005,7 +12015,7 @@ class ConversationsApi {
12005
12015
  '/api/v2/conversations/messaging/integrations/line',
12006
12016
  'POST',
12007
12017
  { },
12008
- { },
12018
+ { 'async': opts['async'] },
12009
12019
  { },
12010
12020
  { },
12011
12021
  body,
@@ -12019,8 +12029,12 @@ class ConversationsApi {
12019
12029
  * Create a Twitter Integration
12020
12030
  *
12021
12031
  * @param {Object} body TwitterIntegrationRequest
12032
+ * @param {Object} opts Optional parameters
12033
+ * @param {Boolean} opts.async Create a Twitter integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Twitter integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
12022
12034
  */
12023
- postConversationsMessagingIntegrationsTwitter(body) {
12035
+ postConversationsMessagingIntegrationsTwitter(body, opts) {
12036
+ opts = opts || {};
12037
+
12024
12038
  // verify the required parameter 'body' is set
12025
12039
  if (body === undefined || body === null) {
12026
12040
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
@@ -12030,7 +12044,7 @@ class ConversationsApi {
12030
12044
  '/api/v2/conversations/messaging/integrations/twitter',
12031
12045
  'POST',
12032
12046
  { },
12033
- { },
12047
+ { 'async': opts['async'] },
12034
12048
  { },
12035
12049
  { },
12036
12050
  body,
@@ -12044,8 +12058,12 @@ class ConversationsApi {
12044
12058
  * Create a WhatsApp Integration
12045
12059
  * You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
12046
12060
  * @param {Object} body WhatsAppIntegrationRequest
12061
+ * @param {Object} opts Optional parameters
12062
+ * @param {Boolean} opts.async Create a WhatsApp integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new WhatsApp integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
12047
12063
  */
12048
- postConversationsMessagingIntegrationsWhatsapp(body) {
12064
+ postConversationsMessagingIntegrationsWhatsapp(body, opts) {
12065
+ opts = opts || {};
12066
+
12049
12067
  // verify the required parameter 'body' is set
12050
12068
  if (body === undefined || body === null) {
12051
12069
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';
@@ -12055,7 +12073,7 @@ class ConversationsApi {
12055
12073
  '/api/v2/conversations/messaging/integrations/whatsapp',
12056
12074
  'POST',
12057
12075
  { },
12058
- { },
12076
+ { 'async': opts['async'] },
12059
12077
  { },
12060
12078
  { },
12061
12079
  body,
@@ -12201,7 +12219,7 @@ class DataExtensionsApi {
12201
12219
  /**
12202
12220
  * DataExtensions service.
12203
12221
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
12204
- * @version 94.0.0
12222
+ * @version 97.0.0
12205
12223
  */
12206
12224
 
12207
12225
  /**
@@ -12287,7 +12305,7 @@ class ExternalContactsApi {
12287
12305
  /**
12288
12306
  * ExternalContacts service.
12289
12307
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
12290
- * @version 94.0.0
12308
+ * @version 97.0.0
12291
12309
  */
12292
12310
 
12293
12311
  /**
@@ -13630,7 +13648,7 @@ class FaxApi {
13630
13648
  /**
13631
13649
  * Fax service.
13632
13650
  * @module purecloud-platform-client-v2/api/FaxApi
13633
- * @version 94.0.0
13651
+ * @version 97.0.0
13634
13652
  */
13635
13653
 
13636
13654
  /**
@@ -13801,7 +13819,7 @@ class FlowsApi {
13801
13819
  /**
13802
13820
  * Flows service.
13803
13821
  * @module purecloud-platform-client-v2/api/FlowsApi
13804
- * @version 94.0.0
13822
+ * @version 97.0.0
13805
13823
  */
13806
13824
 
13807
13825
  /**
@@ -13872,7 +13890,7 @@ class GeneralDataProtectionRegulationApi {
13872
13890
  /**
13873
13891
  * GeneralDataProtectionRegulation service.
13874
13892
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
13875
- * @version 94.0.0
13893
+ * @version 97.0.0
13876
13894
  */
13877
13895
 
13878
13896
  /**
@@ -14002,7 +14020,7 @@ class GeolocationApi {
14002
14020
  /**
14003
14021
  * Geolocation service.
14004
14022
  * @module purecloud-platform-client-v2/api/GeolocationApi
14005
- * @version 94.0.0
14023
+ * @version 97.0.0
14006
14024
  */
14007
14025
 
14008
14026
  /**
@@ -14133,7 +14151,7 @@ class GreetingsApi {
14133
14151
  /**
14134
14152
  * Greetings service.
14135
14153
  * @module purecloud-platform-client-v2/api/GreetingsApi
14136
- * @version 94.0.0
14154
+ * @version 97.0.0
14137
14155
  */
14138
14156
 
14139
14157
  /**
@@ -14588,7 +14606,7 @@ class GroupsApi {
14588
14606
  /**
14589
14607
  * Groups service.
14590
14608
  * @module purecloud-platform-client-v2/api/GroupsApi
14591
- * @version 94.0.0
14609
+ * @version 97.0.0
14592
14610
  */
14593
14611
 
14594
14612
  /**
@@ -14993,7 +15011,7 @@ class IdentityProviderApi {
14993
15011
  /**
14994
15012
  * IdentityProvider service.
14995
15013
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
14996
- * @version 94.0.0
15014
+ * @version 97.0.0
14997
15015
  */
14998
15016
 
14999
15017
  /**
@@ -15749,7 +15767,7 @@ class IntegrationsApi {
15749
15767
  /**
15750
15768
  * Integrations service.
15751
15769
  * @module purecloud-platform-client-v2/api/IntegrationsApi
15752
- * @version 94.0.0
15770
+ * @version 97.0.0
15753
15771
  */
15754
15772
 
15755
15773
  /**
@@ -17241,7 +17259,7 @@ class JourneyApi {
17241
17259
  /**
17242
17260
  * Journey service.
17243
17261
  * @module purecloud-platform-client-v2/api/JourneyApi
17244
- * @version 94.0.0
17262
+ * @version 97.0.0
17245
17263
  */
17246
17264
 
17247
17265
  /**
@@ -17306,6 +17324,107 @@ class JourneyApi {
17306
17324
  );
17307
17325
  }
17308
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
+
17309
17428
  /**
17310
17429
  * Update a single action target.
17311
17430
  *
@@ -17360,13 +17479,42 @@ class JourneyApi {
17360
17479
  );
17361
17480
  }
17362
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
+
17363
17511
  }
17364
17512
 
17365
17513
  class KnowledgeApi {
17366
17514
  /**
17367
17515
  * Knowledge service.
17368
17516
  * @module purecloud-platform-client-v2/api/KnowledgeApi
17369
- * @version 94.0.0
17517
+ * @version 97.0.0
17370
17518
  */
17371
17519
 
17372
17520
  /**
@@ -17682,7 +17830,7 @@ class KnowledgeApi {
17682
17830
  }
17683
17831
 
17684
17832
  /**
17685
- * Get All trainings information for a knowledgebase
17833
+ * Get all trainings information for a knowledgebase
17686
17834
  *
17687
17835
  * @param {String} knowledgeBaseId Knowledge base ID
17688
17836
  * @param {Object} languageCode Language code, format: iso2-LOCALE
@@ -17691,6 +17839,7 @@ class KnowledgeApi {
17691
17839
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17692
17840
  * @param {String} opts.limit Number of entities to return. Maximum of 200.
17693
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.
17694
17843
  */
17695
17844
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
17696
17845
  opts = opts || {};
@@ -17708,7 +17857,7 @@ class KnowledgeApi {
17708
17857
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
17709
17858
  'GET',
17710
17859
  { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
17711
- { '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'] },
17712
17861
  { },
17713
17862
  { },
17714
17863
  null,
@@ -18086,7 +18235,7 @@ class LanguageUnderstandingApi {
18086
18235
  /**
18087
18236
  * LanguageUnderstanding service.
18088
18237
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
18089
- * @version 94.0.0
18238
+ * @version 97.0.0
18090
18239
  */
18091
18240
 
18092
18241
  /**
@@ -18652,7 +18801,7 @@ class LanguagesApi {
18652
18801
  /**
18653
18802
  * Languages service.
18654
18803
  * @module purecloud-platform-client-v2/api/LanguagesApi
18655
- * @version 94.0.0
18804
+ * @version 97.0.0
18656
18805
  */
18657
18806
 
18658
18807
  /**
@@ -18920,7 +19069,7 @@ class LicenseApi {
18920
19069
  /**
18921
19070
  * License service.
18922
19071
  * @module purecloud-platform-client-v2/api/LicenseApi
18923
- * @version 94.0.0
19072
+ * @version 97.0.0
18924
19073
  */
18925
19074
 
18926
19075
  /**
@@ -19158,7 +19307,7 @@ class LocationsApi {
19158
19307
  /**
19159
19308
  * Locations service.
19160
19309
  * @module purecloud-platform-client-v2/api/LocationsApi
19161
- * @version 94.0.0
19310
+ * @version 97.0.0
19162
19311
  */
19163
19312
 
19164
19313
  /**
@@ -19394,7 +19543,7 @@ class MobileDevicesApi {
19394
19543
  /**
19395
19544
  * MobileDevices service.
19396
19545
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
19397
- * @version 94.0.0
19546
+ * @version 97.0.0
19398
19547
  */
19399
19548
 
19400
19549
  /**
@@ -19545,7 +19694,7 @@ class NotificationsApi {
19545
19694
  /**
19546
19695
  * Notifications service.
19547
19696
  * @module purecloud-platform-client-v2/api/NotificationsApi
19548
- * @version 94.0.0
19697
+ * @version 97.0.0
19549
19698
  */
19550
19699
 
19551
19700
  /**
@@ -19744,7 +19893,7 @@ class OAuthApi {
19744
19893
  /**
19745
19894
  * OAuth service.
19746
19895
  * @module purecloud-platform-client-v2/api/OAuthApi
19747
- * @version 94.0.0
19896
+ * @version 97.0.0
19748
19897
  */
19749
19898
 
19750
19899
  /**
@@ -20102,7 +20251,7 @@ class ObjectsApi {
20102
20251
  /**
20103
20252
  * Objects service.
20104
20253
  * @module purecloud-platform-client-v2/api/ObjectsApi
20105
- * @version 94.0.0
20254
+ * @version 97.0.0
20106
20255
  */
20107
20256
 
20108
20257
  /**
@@ -20343,7 +20492,7 @@ class OrganizationApi {
20343
20492
  /**
20344
20493
  * Organization service.
20345
20494
  * @module purecloud-platform-client-v2/api/OrganizationApi
20346
- * @version 94.0.0
20495
+ * @version 97.0.0
20347
20496
  */
20348
20497
 
20349
20498
  /**
@@ -20598,7 +20747,7 @@ class OrganizationAuthorizationApi {
20598
20747
  /**
20599
20748
  * OrganizationAuthorization service.
20600
20749
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
20601
- * @version 94.0.0
20750
+ * @version 97.0.0
20602
20751
  */
20603
20752
 
20604
20753
  /**
@@ -21308,7 +21457,7 @@ class OutboundApi {
21308
21457
  /**
21309
21458
  * Outbound service.
21310
21459
  * @module purecloud-platform-client-v2/api/OutboundApi
21311
- * @version 94.0.0
21460
+ * @version 97.0.0
21312
21461
  */
21313
21462
 
21314
21463
  /**
@@ -24282,7 +24431,7 @@ class PresenceApi {
24282
24431
  /**
24283
24432
  * Presence service.
24284
24433
  * @module purecloud-platform-client-v2/api/PresenceApi
24285
- * @version 94.0.0
24434
+ * @version 97.0.0
24286
24435
  */
24287
24436
 
24288
24437
  /**
@@ -24629,7 +24778,7 @@ class QualityApi {
24629
24778
  /**
24630
24779
  * Quality service.
24631
24780
  * @module purecloud-platform-client-v2/api/QualityApi
24632
- * @version 94.0.0
24781
+ * @version 97.0.0
24633
24782
  */
24634
24783
 
24635
24784
  /**
@@ -24843,8 +24992,8 @@ class QualityApi {
24843
24992
  * @param {Array.<String>} opts.expand variable name requested by expand list
24844
24993
  * @param {String} opts.nextPage next page token
24845
24994
  * @param {String} opts.previousPage Previous page token
24846
- * @param {Date} opts.startTime Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
24847
- * @param {Date} opts.endTime End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
24995
+ * @param {Date} opts.startTime Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
24996
+ * @param {Date} opts.endTime End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
24848
24997
  * @param {Array.<String>} opts.agentUserId user id of agent requested
24849
24998
  * @param {String} opts.evaluatorUserId user id of the evaluator
24850
24999
  * @param {String} opts.name name
@@ -24910,8 +25059,8 @@ class QualityApi {
24910
25059
  * @param {String} opts.nextPage next page token
24911
25060
  * @param {String} opts.previousPage Previous page token
24912
25061
  * @param {String} opts.conversationId conversation id
24913
- * @param {Date} opts.startTime Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
24914
- * @param {Date} opts.endTime end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
25062
+ * @param {Date} opts.startTime Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
25063
+ * @param {Date} opts.endTime end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
24915
25064
  */
24916
25065
  getQualityCalibrations(calibratorId, opts) {
24917
25066
  opts = opts || {};
@@ -25081,8 +25230,8 @@ class QualityApi {
25081
25230
  * @param {Array.<String>} opts.expand variable name requested by expand list
25082
25231
  * @param {String} opts.nextPage next page token
25083
25232
  * @param {String} opts.previousPage Previous page token
25084
- * @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
25085
- * @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
25233
+ * @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
25234
+ * @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
25086
25235
  * @param {String} opts.name Evaluator name
25087
25236
  * @param {Array.<String>} opts.permission permission strings
25088
25237
  * @param {String} opts.group group id
@@ -26326,7 +26475,7 @@ class RecordingApi {
26326
26475
  /**
26327
26476
  * Recording service.
26328
26477
  * @module purecloud-platform-client-v2/api/RecordingApi
26329
- * @version 94.0.0
26478
+ * @version 97.0.0
26330
26479
  */
26331
26480
 
26332
26481
  /**
@@ -27572,7 +27721,7 @@ class ResponseManagementApi {
27572
27721
  /**
27573
27722
  * ResponseManagement service.
27574
27723
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
27575
- * @version 94.0.0
27724
+ * @version 97.0.0
27576
27725
  */
27577
27726
 
27578
27727
  /**
@@ -27897,7 +28046,7 @@ class RoutingApi {
27897
28046
  /**
27898
28047
  * Routing service.
27899
28048
  * @module purecloud-platform-client-v2/api/RoutingApi
27900
- * @version 94.0.0
28049
+ * @version 97.0.0
27901
28050
  */
27902
28051
 
27903
28052
  /**
@@ -30195,7 +30344,7 @@ class SCIMApi {
30195
30344
  /**
30196
30345
  * SCIM service.
30197
30346
  * @module purecloud-platform-client-v2/api/SCIMApi
30198
- * @version 94.0.0
30347
+ * @version 97.0.0
30199
30348
  */
30200
30349
 
30201
30350
  /**
@@ -30331,8 +30480,8 @@ class SCIMApi {
30331
30480
  *
30332
30481
  * @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
30333
30482
  * @param {Object} opts Optional parameters
30334
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30335
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
30483
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30484
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30336
30485
  * @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
30337
30486
  */
30338
30487
  getScimGroup(groupId, opts) {
@@ -30362,9 +30511,9 @@ class SCIMApi {
30362
30511
  *
30363
30512
  * @param {Object} opts Optional parameters
30364
30513
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
30365
- * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
30366
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30367
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
30514
+ * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \&quot;excludedAttributes\&quot; or \&quot;attributes\&quot; query parameters to exclude or only include secondary lookup values such as \&quot;externalId\&quot;, \&quot;roles\&quot;, \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\&quot;, or \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\&quot;. (default to 25)
30515
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30516
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30368
30517
  * @param {String} opts.filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \&quot;id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\&quot;, \&quot;displayname eq Sales\&quot;.
30369
30518
  */
30370
30519
  getScimGroups(opts) {
@@ -30508,9 +30657,9 @@ class SCIMApi {
30508
30657
  *
30509
30658
  * @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
30510
30659
  * @param {Object} opts Optional parameters
30511
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30512
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
30513
- * @param {String} opts.ifNoneMatch TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
30660
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30661
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30662
+ * @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
30514
30663
  */
30515
30664
  getScimUser(userId, opts) {
30516
30665
  opts = opts || {};
@@ -30539,9 +30688,9 @@ class SCIMApi {
30539
30688
  * To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \&quot;active eq false\&quot;. By default, returns SCIM attributes \&quot;externalId\&quot;, \&quot;enterprise-user:manager\&quot;, and \&quot;roles\&quot;. To exclude these attributes, set the attributes parameter to \&quot;id,active\&quot; or the excludeAttributes parameter to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
30540
30689
  * @param {Object} opts Optional parameters
30541
30690
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
30542
- * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
30543
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30544
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
30691
+ * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \&quot;excludedAttributes\&quot; or \&quot;attributes\&quot; query parameters to exclude or only include secondary lookup values such as \&quot;externalId\&quot;, \&quot;roles\&quot;, \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\&quot;, or \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\&quot;. (default to 25)
30692
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30693
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30545
30694
  * @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;, \&quot;employeeNumber eq 9876543210\&quot;.
30546
30695
  */
30547
30696
  getScimUsers(opts) {
@@ -30567,9 +30716,9 @@ class SCIMApi {
30567
30716
  *
30568
30717
  * @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
30569
30718
  * @param {Object} opts Optional parameters
30570
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30571
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
30572
- * @param {String} opts.ifNoneMatch TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
30719
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30720
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30721
+ * @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
30573
30722
  */
30574
30723
  getScimV2Group(groupId, opts) {
30575
30724
  opts = opts || {};
@@ -30599,9 +30748,9 @@ class SCIMApi {
30599
30748
  * @param {String} filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \&quot;id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\&quot;, \&quot;displayname eq Sales\&quot;.
30600
30749
  * @param {Object} opts Optional parameters
30601
30750
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
30602
- * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
30603
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30604
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
30751
+ * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \&quot;excludedAttributes\&quot; or \&quot;attributes\&quot; query parameters to exclude or only include secondary lookup values such as \&quot;externalId\&quot;, \&quot;roles\&quot;, \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\&quot;, or \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\&quot;. (default to 25)
30752
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30753
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns \&quot;id\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30605
30754
  */
30606
30755
  getScimV2Groups(filter, opts) {
30607
30756
  opts = opts || {};
@@ -30748,8 +30897,8 @@ class SCIMApi {
30748
30897
  *
30749
30898
  * @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
30750
30899
  * @param {Object} opts Optional parameters
30751
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30752
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
30900
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30901
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30753
30902
  * @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
30754
30903
  */
30755
30904
  getScimV2User(userId, opts) {
@@ -30779,9 +30928,9 @@ class SCIMApi {
30779
30928
  * To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \&quot;active eq false\&quot;. By default, returns SCIM attributes \&quot;externalId\&quot;, \&quot;enterprise-user:manager\&quot;, and \&quot;roles\&quot;. To exclude these attributes, set the attributes parameter to \&quot;id,active\&quot; or the excludeAttributes parameter to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
30780
30929
  * @param {Object} opts Optional parameters
30781
30930
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
30782
- * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
30783
- * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30784
- * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
30931
+ * @param {Number} opts.count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \&quot;excludedAttributes\&quot; or \&quot;attributes\&quot; query parameters to exclude or only include secondary lookup values such as \&quot;externalId\&quot;, \&quot;roles\&quot;, \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\&quot;, or \&quot;urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\&quot;. (default to 25)
30932
+ * @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
30933
+ * @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Always returns the \&quot;id\&quot;, \&quot;userName\&quot;, \&quot;active\&quot;, and \&quot;meta\&quot; attributes. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes.
30785
30934
  * @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;, \&quot;employeeNumber eq 9876543210\&quot;.
30786
30935
  */
30787
30936
  getScimV2Users(opts) {
@@ -30939,8 +31088,8 @@ class SCIMApi {
30939
31088
  }
30940
31089
 
30941
31090
  /**
30942
- * Creates a group
30943
- * Creates a Genesys Cloud group with group visibility set to \&quot;public\&quot; and rules visibility set to \&quot;true\&quot;. Auto-creates an \&quot;externalId\&quot;. \&quot;externalId\&quot; is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
31091
+ * Create a group
31092
+ * Creates a Genesys Cloud group with group visibility set to \&quot;public\&quot; and rules visibility set to \&quot;true\&quot;. Auto-creates an \&quot;externalId\&quot;. \&quot;externalId\&quot; is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} is allowed.
30944
31093
  * @param {Object} body The information used to create a group.
30945
31094
  */
30946
31095
  postScimGroups(body) {
@@ -30991,7 +31140,7 @@ class SCIMApi {
30991
31140
  /**
30992
31141
  * Create a group
30993
31142
  * Creates an \&quot;official\&quot; Genesys Cloud group with group visibility set to \&quot;public\&quot; and rules visibility set to \&quot;true\&quot;. Auto-creates an \&quot;externalId\&quot;. \&quot;externalId\&quot; is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
30994
- * @param {Object} body Creates a group.
31143
+ * @param {Object} body The information used to create a group.
30995
31144
  */
30996
31145
  postScimV2Groups(body) {
30997
31146
  // verify the required parameter 'body' is set
@@ -31180,7 +31329,7 @@ class ScriptsApi {
31180
31329
  /**
31181
31330
  * Scripts service.
31182
31331
  * @module purecloud-platform-client-v2/api/ScriptsApi
31183
- * @version 94.0.0
31332
+ * @version 97.0.0
31184
31333
  */
31185
31334
 
31186
31335
  /**
@@ -31533,7 +31682,7 @@ class SearchApi {
31533
31682
  /**
31534
31683
  * Search service.
31535
31684
  * @module purecloud-platform-client-v2/api/SearchApi
31536
- * @version 94.0.0
31685
+ * @version 97.0.0
31537
31686
  */
31538
31687
 
31539
31688
  /**
@@ -32043,7 +32192,7 @@ class SpeechTextAnalyticsApi {
32043
32192
  /**
32044
32193
  * SpeechTextAnalytics service.
32045
32194
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
32046
- * @version 94.0.0
32195
+ * @version 97.0.0
32047
32196
  */
32048
32197
 
32049
32198
  /**
@@ -32119,7 +32268,7 @@ class StationsApi {
32119
32268
  /**
32120
32269
  * Stations service.
32121
32270
  * @module purecloud-platform-client-v2/api/StationsApi
32122
- * @version 94.0.0
32271
+ * @version 97.0.0
32123
32272
  */
32124
32273
 
32125
32274
  /**
@@ -32266,7 +32415,7 @@ class SuggestApi {
32266
32415
  /**
32267
32416
  * Suggest service.
32268
32417
  * @module purecloud-platform-client-v2/api/SuggestApi
32269
- * @version 94.0.0
32418
+ * @version 97.0.0
32270
32419
  */
32271
32420
 
32272
32421
  /**
@@ -32405,7 +32554,7 @@ class TelephonyApi {
32405
32554
  /**
32406
32555
  * Telephony service.
32407
32556
  * @module purecloud-platform-client-v2/api/TelephonyApi
32408
- * @version 94.0.0
32557
+ * @version 97.0.0
32409
32558
  */
32410
32559
 
32411
32560
  /**
@@ -32423,8 +32572,8 @@ class TelephonyApi {
32423
32572
  /**
32424
32573
  * Fetch SIP metadata
32425
32574
  * Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
32426
- * @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
32427
- * @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
32575
+ * @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
32576
+ * @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
32428
32577
  * @param {Object} opts Optional parameters
32429
32578
  * @param {String} opts.callId unique identification of the placed call
32430
32579
  * @param {String} opts.toUser User to who the call was placed
@@ -32513,7 +32662,7 @@ class TelephonyProvidersEdgeApi {
32513
32662
  /**
32514
32663
  * TelephonyProvidersEdge service.
32515
32664
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
32516
- * @version 94.0.0
32665
+ * @version 97.0.0
32517
32666
  */
32518
32667
 
32519
32668
  /**
@@ -36090,7 +36239,7 @@ class TextbotsApi {
36090
36239
  /**
36091
36240
  * Textbots service.
36092
36241
  * @module purecloud-platform-client-v2/api/TextbotsApi
36093
- * @version 94.0.0
36242
+ * @version 97.0.0
36094
36243
  */
36095
36244
 
36096
36245
  /**
@@ -36136,7 +36285,7 @@ class TokensApi {
36136
36285
  /**
36137
36286
  * Tokens service.
36138
36287
  * @module purecloud-platform-client-v2/api/TokensApi
36139
- * @version 94.0.0
36288
+ * @version 97.0.0
36140
36289
  */
36141
36290
 
36142
36291
  /**
@@ -36222,7 +36371,7 @@ class UploadsApi {
36222
36371
  /**
36223
36372
  * Uploads service.
36224
36373
  * @module purecloud-platform-client-v2/api/UploadsApi
36225
- * @version 94.0.0
36374
+ * @version 97.0.0
36226
36375
  */
36227
36376
 
36228
36377
  /**
@@ -36268,7 +36417,7 @@ class UsageApi {
36268
36417
  /**
36269
36418
  * Usage service.
36270
36419
  * @module purecloud-platform-client-v2/api/UsageApi
36271
- * @version 94.0.0
36420
+ * @version 97.0.0
36272
36421
  */
36273
36422
 
36274
36423
  /**
@@ -36335,154 +36484,11 @@ class UsageApi {
36335
36484
 
36336
36485
  }
36337
36486
 
36338
- class UserDevelopmentApi {
36339
- /**
36340
- * UserDevelopment service.
36341
- * @module purecloud-platform-client-v2/api/UserDevelopmentApi
36342
- * @version 94.0.0
36343
- */
36344
-
36345
- /**
36346
- * Constructs a new UserDevelopmentApi.
36347
- * @alias module:purecloud-platform-client-v2/api/UserDevelopmentApi
36348
- * @class
36349
- * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
36350
- * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
36351
- */
36352
- constructor(apiClient) {
36353
- this.apiClient = apiClient || ApiClient.instance;
36354
- }
36355
-
36356
-
36357
- /**
36358
- * Get list of Development Activities
36359
- * Either moduleId or userId is required. Results are filtered based on the applicable permissions.
36360
- * @param {Object} opts Optional parameters
36361
- * @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
36362
- * @param {String} opts.moduleId Specifies the ID of the learning module.
36363
- * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
36364
- * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
36365
- * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
36366
- * @param {Number} opts.pageSize Page size (default to 25)
36367
- * @param {Number} opts.pageNumber Page number (default to 1)
36368
- * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
36369
- * @param {Array.<String>} opts.types Specifies the activity types.
36370
- * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
36371
- * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
36372
- */
36373
- getUsersDevelopmentActivities(opts) {
36374
- opts = opts || {};
36375
-
36376
-
36377
- return this.apiClient.callApi(
36378
- '/api/v2/users/development/activities',
36379
- 'GET',
36380
- { },
36381
- { 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
36382
- { },
36383
- { },
36384
- null,
36385
- ['PureCloud OAuth'],
36386
- ['application/json'],
36387
- ['application/json']
36388
- );
36389
- }
36390
-
36391
- /**
36392
- * Get list of Development Activities for current user
36393
- * Results are filtered based on the applicable permissions.
36394
- * @param {Object} opts Optional parameters
36395
- * @param {String} opts.moduleId Specifies the ID of the learning module.
36396
- * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
36397
- * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
36398
- * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
36399
- * @param {Number} opts.pageSize Page size (default to 25)
36400
- * @param {Number} opts.pageNumber Page number (default to 1)
36401
- * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
36402
- * @param {Array.<String>} opts.types Specifies the activity types.
36403
- * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
36404
- * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
36405
- */
36406
- getUsersDevelopmentActivitiesMe(opts) {
36407
- opts = opts || {};
36408
-
36409
-
36410
- return this.apiClient.callApi(
36411
- '/api/v2/users/development/activities/me',
36412
- 'GET',
36413
- { },
36414
- { 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
36415
- { },
36416
- { },
36417
- null,
36418
- ['PureCloud OAuth'],
36419
- ['application/json'],
36420
- ['application/json']
36421
- );
36422
- }
36423
-
36424
- /**
36425
- * Get a Development Activity
36426
- *
36427
- * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
36428
- * @param {Object} type Specifies the activity type.
36429
- */
36430
- getUsersDevelopmentActivity(activityId, type) {
36431
- // verify the required parameter 'activityId' is set
36432
- if (activityId === undefined || activityId === null) {
36433
- throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
36434
- }
36435
- // verify the required parameter 'type' is set
36436
- if (type === undefined || type === null) {
36437
- throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
36438
- }
36439
-
36440
- return this.apiClient.callApi(
36441
- '/api/v2/users/development/activities/{activityId}',
36442
- 'GET',
36443
- { 'activityId': activityId },
36444
- { 'type': type },
36445
- { },
36446
- { },
36447
- null,
36448
- ['PureCloud OAuth'],
36449
- ['application/json'],
36450
- ['application/json']
36451
- );
36452
- }
36453
-
36454
- /**
36455
- * Retrieve aggregated development activity data
36456
- * Results are filtered based on the applicable permissions.
36457
- * @param {Object} body Aggregate Request
36458
- */
36459
- postUsersDevelopmentActivitiesAggregatesQuery(body) {
36460
- // verify the required parameter 'body' is set
36461
- if (body === undefined || body === null) {
36462
- throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
36463
- }
36464
-
36465
- return this.apiClient.callApi(
36466
- '/api/v2/users/development/activities/aggregates/query',
36467
- 'POST',
36468
- { },
36469
- { },
36470
- { },
36471
- { },
36472
- body,
36473
- ['PureCloud OAuth'],
36474
- ['application/json'],
36475
- ['application/json']
36476
- );
36477
- }
36478
-
36479
- }
36480
-
36481
36487
  class UserRecordingsApi {
36482
36488
  /**
36483
36489
  * UserRecordings service.
36484
36490
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
36485
- * @version 94.0.0
36491
+ * @version 97.0.0
36486
36492
  */
36487
36493
 
36488
36494
  /**
@@ -36666,7 +36672,7 @@ class UsersApi {
36666
36672
  /**
36667
36673
  * Users service.
36668
36674
  * @module purecloud-platform-client-v2/api/UsersApi
36669
- * @version 94.0.0
36675
+ * @version 97.0.0
36670
36676
  */
36671
36677
 
36672
36678
  /**
@@ -37710,6 +37716,103 @@ class UsersApi {
37710
37716
  );
37711
37717
  }
37712
37718
 
37719
+ /**
37720
+ * Get list of Development Activities
37721
+ * Either moduleId or userId is required. Results are filtered based on the applicable permissions.
37722
+ * @param {Object} opts Optional parameters
37723
+ * @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
37724
+ * @param {String} opts.moduleId Specifies the ID of the learning module.
37725
+ * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
37726
+ * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
37727
+ * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
37728
+ * @param {Number} opts.pageSize Page size (default to 25)
37729
+ * @param {Number} opts.pageNumber Page number (default to 1)
37730
+ * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
37731
+ * @param {Array.<String>} opts.types Specifies the activity types.
37732
+ * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
37733
+ * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
37734
+ */
37735
+ getUsersDevelopmentActivities(opts) {
37736
+ opts = opts || {};
37737
+
37738
+
37739
+ return this.apiClient.callApi(
37740
+ '/api/v2/users/development/activities',
37741
+ 'GET',
37742
+ { },
37743
+ { 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
37744
+ { },
37745
+ { },
37746
+ null,
37747
+ ['PureCloud OAuth'],
37748
+ ['application/json'],
37749
+ ['application/json']
37750
+ );
37751
+ }
37752
+
37753
+ /**
37754
+ * Get list of Development Activities for current user
37755
+ * Results are filtered based on the applicable permissions.
37756
+ * @param {Object} opts Optional parameters
37757
+ * @param {String} opts.moduleId Specifies the ID of the learning module.
37758
+ * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
37759
+ * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
37760
+ * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
37761
+ * @param {Number} opts.pageSize Page size (default to 25)
37762
+ * @param {Number} opts.pageNumber Page number (default to 1)
37763
+ * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
37764
+ * @param {Array.<String>} opts.types Specifies the activity types.
37765
+ * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
37766
+ * @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
37767
+ */
37768
+ getUsersDevelopmentActivitiesMe(opts) {
37769
+ opts = opts || {};
37770
+
37771
+
37772
+ return this.apiClient.callApi(
37773
+ '/api/v2/users/development/activities/me',
37774
+ 'GET',
37775
+ { },
37776
+ { 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
37777
+ { },
37778
+ { },
37779
+ null,
37780
+ ['PureCloud OAuth'],
37781
+ ['application/json'],
37782
+ ['application/json']
37783
+ );
37784
+ }
37785
+
37786
+ /**
37787
+ * Get a Development Activity
37788
+ *
37789
+ * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
37790
+ * @param {Object} type Specifies the activity type.
37791
+ */
37792
+ getUsersDevelopmentActivity(activityId, type) {
37793
+ // verify the required parameter 'activityId' is set
37794
+ if (activityId === undefined || activityId === null) {
37795
+ throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
37796
+ }
37797
+ // verify the required parameter 'type' is set
37798
+ if (type === undefined || type === null) {
37799
+ throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
37800
+ }
37801
+
37802
+ return this.apiClient.callApi(
37803
+ '/api/v2/users/development/activities/{activityId}',
37804
+ 'GET',
37805
+ { 'activityId': activityId },
37806
+ { 'type': type },
37807
+ { },
37808
+ { },
37809
+ null,
37810
+ ['PureCloud OAuth'],
37811
+ ['application/json'],
37812
+ ['application/json']
37813
+ );
37814
+ }
37815
+
37713
37816
  /**
37714
37817
  * Get current user details.
37715
37818
  * This request is not valid when using the Client Credentials OAuth grant.
@@ -38396,6 +38499,31 @@ class UsersApi {
38396
38499
  );
38397
38500
  }
38398
38501
 
38502
+ /**
38503
+ * Retrieve aggregated development activity data
38504
+ * Results are filtered based on the applicable permissions.
38505
+ * @param {Object} body Aggregate Request
38506
+ */
38507
+ postUsersDevelopmentActivitiesAggregatesQuery(body) {
38508
+ // verify the required parameter 'body' is set
38509
+ if (body === undefined || body === null) {
38510
+ throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
38511
+ }
38512
+
38513
+ return this.apiClient.callApi(
38514
+ '/api/v2/users/development/activities/aggregates/query',
38515
+ 'POST',
38516
+ { },
38517
+ { },
38518
+ { },
38519
+ { },
38520
+ body,
38521
+ ['PureCloud OAuth'],
38522
+ ['application/json'],
38523
+ ['application/json']
38524
+ );
38525
+ }
38526
+
38399
38527
  /**
38400
38528
  * Change your password
38401
38529
  *
@@ -38757,7 +38885,7 @@ class UtilitiesApi {
38757
38885
  /**
38758
38886
  * Utilities service.
38759
38887
  * @module purecloud-platform-client-v2/api/UtilitiesApi
38760
- * @version 94.0.0
38888
+ * @version 97.0.0
38761
38889
  */
38762
38890
 
38763
38891
  /**
@@ -38868,7 +38996,7 @@ class VoicemailApi {
38868
38996
  /**
38869
38997
  * Voicemail service.
38870
38998
  * @module purecloud-platform-client-v2/api/VoicemailApi
38871
- * @version 94.0.0
38999
+ * @version 97.0.0
38872
39000
  */
38873
39001
 
38874
39002
  /**
@@ -39505,7 +39633,7 @@ class WebChatApi {
39505
39633
  /**
39506
39634
  * WebChat service.
39507
39635
  * @module purecloud-platform-client-v2/api/WebChatApi
39508
- * @version 94.0.0
39636
+ * @version 97.0.0
39509
39637
  */
39510
39638
 
39511
39639
  /**
@@ -40049,7 +40177,7 @@ class WidgetsApi {
40049
40177
  /**
40050
40178
  * Widgets service.
40051
40179
  * @module purecloud-platform-client-v2/api/WidgetsApi
40052
- * @version 94.0.0
40180
+ * @version 97.0.0
40053
40181
  */
40054
40182
 
40055
40183
  /**
@@ -40195,7 +40323,7 @@ class WorkforceManagementApi {
40195
40323
  /**
40196
40324
  * WorkforceManagement service.
40197
40325
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
40198
- * @version 94.0.0
40326
+ * @version 97.0.0
40199
40327
  */
40200
40328
 
40201
40329
  /**
@@ -40450,166 +40578,6 @@ class WorkforceManagementApi {
40450
40578
  );
40451
40579
  }
40452
40580
 
40453
- /**
40454
- * Deprecated/Gone: Use the new business unit activity code resources
40455
- *
40456
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
40457
- * @param {String} acId The ID of the activity code to delete
40458
- */
40459
- deleteWorkforcemanagementManagementunitActivitycode(muId, acId) {
40460
- // verify the required parameter 'muId' is set
40461
- if (muId === undefined || muId === null) {
40462
- throw 'Missing the required parameter "muId" when calling deleteWorkforcemanagementManagementunitActivitycode';
40463
- }
40464
- // verify the required parameter 'acId' is set
40465
- if (acId === undefined || acId === null) {
40466
- throw 'Missing the required parameter "acId" when calling deleteWorkforcemanagementManagementunitActivitycode';
40467
- }
40468
-
40469
- return this.apiClient.callApi(
40470
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
40471
- 'DELETE',
40472
- { 'muId': muId,'acId': acId },
40473
- { },
40474
- { },
40475
- { },
40476
- null,
40477
- ['PureCloud OAuth'],
40478
- ['application/json'],
40479
- ['application/json']
40480
- );
40481
- }
40482
-
40483
- /**
40484
- * Gone. Scheduling has moved under business units
40485
- *
40486
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
40487
- * @param {String} runId The ID of the schedule run
40488
- */
40489
- deleteWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
40490
- // verify the required parameter 'managementUnitId' is set
40491
- if (managementUnitId === undefined || managementUnitId === null) {
40492
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
40493
- }
40494
- // verify the required parameter 'runId' is set
40495
- if (runId === undefined || runId === null) {
40496
- throw 'Missing the required parameter "runId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
40497
- }
40498
-
40499
- return this.apiClient.callApi(
40500
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
40501
- 'DELETE',
40502
- { 'managementUnitId': managementUnitId,'runId': runId },
40503
- { },
40504
- { },
40505
- { },
40506
- null,
40507
- ['PureCloud OAuth'],
40508
- ['application/json'],
40509
- ['application/json']
40510
- );
40511
- }
40512
-
40513
- /**
40514
- * Gone. Replaced with service goal templates and planning groups under business units
40515
- *
40516
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
40517
- * @param {String} serviceGoalGroupId Gone. The ID of the service goal group to delete
40518
- */
40519
- deleteWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
40520
- // verify the required parameter 'managementUnitId' is set
40521
- if (managementUnitId === undefined || managementUnitId === null) {
40522
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
40523
- }
40524
- // verify the required parameter 'serviceGoalGroupId' is set
40525
- if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
40526
- throw 'Missing the required parameter "serviceGoalGroupId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
40527
- }
40528
-
40529
- return this.apiClient.callApi(
40530
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
40531
- 'DELETE',
40532
- { 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
40533
- { },
40534
- { },
40535
- { },
40536
- null,
40537
- ['PureCloud OAuth'],
40538
- ['application/json'],
40539
- ['application/json']
40540
- );
40541
- }
40542
-
40543
- /**
40544
- * Gone. Scheduling has moved under business units
40545
- *
40546
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
40547
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
40548
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to delete
40549
- */
40550
- deleteWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
40551
- // verify the required parameter 'managementUnitId' is set
40552
- if (managementUnitId === undefined || managementUnitId === null) {
40553
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
40554
- }
40555
- // verify the required parameter 'weekId' is set
40556
- if (weekId === undefined || weekId === null) {
40557
- throw 'Missing the required parameter "weekId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
40558
- }
40559
- // verify the required parameter 'scheduleId' is set
40560
- if (scheduleId === undefined || scheduleId === null) {
40561
- throw 'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
40562
- }
40563
-
40564
- return this.apiClient.callApi(
40565
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
40566
- 'DELETE',
40567
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
40568
- { },
40569
- { },
40570
- { },
40571
- null,
40572
- ['PureCloud OAuth'],
40573
- ['application/json'],
40574
- ['application/json']
40575
- );
40576
- }
40577
-
40578
- /**
40579
- * Gone. Use equivalent business unit resource instead
40580
- *
40581
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
40582
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
40583
- * @param {String} forecastId (Gone/Deprecated): The ID of the forecast
40584
- */
40585
- deleteWorkforcemanagementManagementunitWeekShorttermforecast(managementUnitId, weekDateId, forecastId) {
40586
- // verify the required parameter 'managementUnitId' is set
40587
- if (managementUnitId === undefined || managementUnitId === null) {
40588
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
40589
- }
40590
- // verify the required parameter 'weekDateId' is set
40591
- if (weekDateId === undefined || weekDateId === null) {
40592
- throw 'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
40593
- }
40594
- // verify the required parameter 'forecastId' is set
40595
- if (forecastId === undefined || forecastId === null) {
40596
- throw 'Missing the required parameter "forecastId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
40597
- }
40598
-
40599
- return this.apiClient.callApi(
40600
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}',
40601
- 'DELETE',
40602
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
40603
- { },
40604
- { },
40605
- { },
40606
- null,
40607
- ['PureCloud OAuth'],
40608
- ['application/json'],
40609
- ['application/json']
40610
- );
40611
- }
40612
-
40613
40581
  /**
40614
40582
  * Delete a work plan
40615
40583
  *
@@ -40640,6 +40608,36 @@ class WorkforceManagementApi {
40640
40608
  );
40641
40609
  }
40642
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
+
40643
40641
  /**
40644
40642
  * Get a list of UserScheduleAdherence records for the requested users
40645
40643
  *
@@ -41444,36 +41442,6 @@ class WorkforceManagementApi {
41444
41442
  );
41445
41443
  }
41446
41444
 
41447
- /**
41448
- * Get an activity code
41449
- *
41450
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41451
- * @param {String} acId The ID of the activity code to fetch
41452
- */
41453
- getWorkforcemanagementManagementunitActivitycode(muId, acId) {
41454
- // verify the required parameter 'muId' is set
41455
- if (muId === undefined || muId === null) {
41456
- throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitActivitycode';
41457
- }
41458
- // verify the required parameter 'acId' is set
41459
- if (acId === undefined || acId === null) {
41460
- throw 'Missing the required parameter "acId" when calling getWorkforcemanagementManagementunitActivitycode';
41461
- }
41462
-
41463
- return this.apiClient.callApi(
41464
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
41465
- 'GET',
41466
- { 'muId': muId,'acId': acId },
41467
- { },
41468
- { },
41469
- { },
41470
- null,
41471
- ['PureCloud OAuth'],
41472
- ['application/json'],
41473
- ['application/json']
41474
- );
41475
- }
41476
-
41477
41445
  /**
41478
41446
  * Get activity codes
41479
41447
  *
@@ -41592,196 +41560,6 @@ class WorkforceManagementApi {
41592
41560
  );
41593
41561
  }
41594
41562
 
41595
- /**
41596
- * Gone. Moved under business units
41597
- *
41598
- * @param {String} muId The management unit ID of the management unit
41599
- */
41600
- getWorkforcemanagementManagementunitIntradayQueues(muId) {
41601
- // verify the required parameter 'muId' is set
41602
- if (muId === undefined || muId === null) {
41603
- throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitIntradayQueues';
41604
- }
41605
-
41606
- return this.apiClient.callApi(
41607
- '/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues',
41608
- 'GET',
41609
- { 'muId': muId },
41610
- { },
41611
- { },
41612
- { },
41613
- null,
41614
- ['PureCloud OAuth'],
41615
- ['application/json'],
41616
- ['application/json']
41617
- );
41618
- }
41619
-
41620
- /**
41621
- * Gone. Scheduling has moved under business units
41622
- *
41623
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
41624
- * @param {String} runId The ID of the schedule run
41625
- */
41626
- getWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
41627
- // verify the required parameter 'managementUnitId' is set
41628
- if (managementUnitId === undefined || managementUnitId === null) {
41629
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRun';
41630
- }
41631
- // verify the required parameter 'runId' is set
41632
- if (runId === undefined || runId === null) {
41633
- throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRun';
41634
- }
41635
-
41636
- return this.apiClient.callApi(
41637
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
41638
- 'GET',
41639
- { 'managementUnitId': managementUnitId,'runId': runId },
41640
- { },
41641
- { },
41642
- { },
41643
- null,
41644
- ['PureCloud OAuth'],
41645
- ['application/json'],
41646
- ['application/json']
41647
- );
41648
- }
41649
-
41650
- /**
41651
- * Gone. Scheduling has moved under business units
41652
- *
41653
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
41654
- * @param {String} runId The ID of the schedule run
41655
- */
41656
- getWorkforcemanagementManagementunitSchedulingRunResult(managementUnitId, runId) {
41657
- // verify the required parameter 'managementUnitId' is set
41658
- if (managementUnitId === undefined || managementUnitId === null) {
41659
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
41660
- }
41661
- // verify the required parameter 'runId' is set
41662
- if (runId === undefined || runId === null) {
41663
- throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
41664
- }
41665
-
41666
- return this.apiClient.callApi(
41667
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result',
41668
- 'GET',
41669
- { 'managementUnitId': managementUnitId,'runId': runId },
41670
- { },
41671
- { },
41672
- { },
41673
- null,
41674
- ['PureCloud OAuth'],
41675
- ['application/json'],
41676
- ['application/json']
41677
- );
41678
- }
41679
-
41680
- /**
41681
- * Gone. Scheduling has moved under business units
41682
- *
41683
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
41684
- */
41685
- getWorkforcemanagementManagementunitSchedulingRuns(managementUnitId) {
41686
- // verify the required parameter 'managementUnitId' is set
41687
- if (managementUnitId === undefined || managementUnitId === null) {
41688
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRuns';
41689
- }
41690
-
41691
- return this.apiClient.callApi(
41692
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs',
41693
- 'GET',
41694
- { 'managementUnitId': managementUnitId },
41695
- { },
41696
- { },
41697
- { },
41698
- null,
41699
- ['PureCloud OAuth'],
41700
- ['application/json'],
41701
- ['application/json']
41702
- );
41703
- }
41704
-
41705
- /**
41706
- * Gone. Replaced with service goal templates and planning groups under business units
41707
- *
41708
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41709
- * @param {String} serviceGoalGroupId Gone. The ID of the service goal group to fetch
41710
- */
41711
- getWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
41712
- // verify the required parameter 'managementUnitId' is set
41713
- if (managementUnitId === undefined || managementUnitId === null) {
41714
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
41715
- }
41716
- // verify the required parameter 'serviceGoalGroupId' is set
41717
- if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
41718
- throw 'Missing the required parameter "serviceGoalGroupId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
41719
- }
41720
-
41721
- return this.apiClient.callApi(
41722
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
41723
- 'GET',
41724
- { 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
41725
- { },
41726
- { },
41727
- { },
41728
- null,
41729
- ['PureCloud OAuth'],
41730
- ['application/json'],
41731
- ['application/json']
41732
- );
41733
- }
41734
-
41735
- /**
41736
- * Gone. Replaced with service goal templates and planning groups under business units
41737
- *
41738
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41739
- */
41740
- getWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
41741
- // verify the required parameter 'managementUnitId' is set
41742
- if (managementUnitId === undefined || managementUnitId === null) {
41743
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroups';
41744
- }
41745
-
41746
- return this.apiClient.callApi(
41747
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
41748
- 'GET',
41749
- { 'managementUnitId': managementUnitId },
41750
- { },
41751
- { },
41752
- { },
41753
- null,
41754
- ['PureCloud OAuth'],
41755
- ['application/json'],
41756
- ['application/json']
41757
- );
41758
- }
41759
-
41760
- /**
41761
- * Gone. Get management unit settings via expand parameters on the GET management unit
41762
- *
41763
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41764
- */
41765
- getWorkforcemanagementManagementunitSettings(muId) {
41766
- // verify the required parameter 'muId' is set
41767
- if (muId === undefined || muId === null) {
41768
- throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitSettings';
41769
- }
41770
-
41771
- return this.apiClient.callApi(
41772
- '/api/v2/workforcemanagement/managementunits/{muId}/settings',
41773
- 'GET',
41774
- { 'muId': muId },
41775
- { },
41776
- { },
41777
- { },
41778
- null,
41779
- ['PureCloud OAuth'],
41780
- ['application/json'],
41781
- ['application/json']
41782
- );
41783
- }
41784
-
41785
41563
  /**
41786
41564
  * Gets a summary of all shift trades in the matched state
41787
41565
  *
@@ -41966,41 +41744,6 @@ class WorkforceManagementApi {
41966
41744
  );
41967
41745
  }
41968
41746
 
41969
- /**
41970
- * Gone. Scheduling has moved under business units
41971
- *
41972
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
41973
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
41974
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to fetch generation results
41975
- */
41976
- getWorkforcemanagementManagementunitWeekScheduleGenerationresults(managementUnitId, weekId, scheduleId) {
41977
- // verify the required parameter 'managementUnitId' is set
41978
- if (managementUnitId === undefined || managementUnitId === null) {
41979
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
41980
- }
41981
- // verify the required parameter 'weekId' is set
41982
- if (weekId === undefined || weekId === null) {
41983
- throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
41984
- }
41985
- // verify the required parameter 'scheduleId' is set
41986
- if (scheduleId === undefined || scheduleId === null) {
41987
- throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
41988
- }
41989
-
41990
- return this.apiClient.callApi(
41991
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults',
41992
- 'GET',
41993
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
41994
- { },
41995
- { },
41996
- { },
41997
- null,
41998
- ['PureCloud OAuth'],
41999
- ['application/json'],
42000
- ['application/json']
42001
- );
42002
- }
42003
-
42004
41747
  /**
42005
41748
  * Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
42006
41749
  *
@@ -42071,71 +41814,6 @@ class WorkforceManagementApi {
42071
41814
  );
42072
41815
  }
42073
41816
 
42074
- /**
42075
- * Gone. Use equivalent business unit resource instead
42076
- *
42077
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
42078
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
42079
- * @param {String} forecastId (Gone/Deprecated): The ID of the forecast
42080
- */
42081
- getWorkforcemanagementManagementunitWeekShorttermforecastFinal(managementUnitId, weekDateId, forecastId) {
42082
- // verify the required parameter 'managementUnitId' is set
42083
- if (managementUnitId === undefined || managementUnitId === null) {
42084
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
42085
- }
42086
- // verify the required parameter 'weekDateId' is set
42087
- if (weekDateId === undefined || weekDateId === null) {
42088
- throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
42089
- }
42090
- // verify the required parameter 'forecastId' is set
42091
- if (forecastId === undefined || forecastId === null) {
42092
- throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
42093
- }
42094
-
42095
- return this.apiClient.callApi(
42096
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final',
42097
- 'GET',
42098
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
42099
- { },
42100
- { },
42101
- { },
42102
- null,
42103
- ['PureCloud OAuth'],
42104
- ['application/json'],
42105
- ['application/json']
42106
- );
42107
- }
42108
-
42109
- /**
42110
- * Gone. Use equivalent business unit resource instead
42111
- *
42112
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
42113
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
42114
- */
42115
- getWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
42116
- // verify the required parameter 'managementUnitId' is set
42117
- if (managementUnitId === undefined || managementUnitId === null) {
42118
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
42119
- }
42120
- // verify the required parameter 'weekDateId' is set
42121
- if (weekDateId === undefined || weekDateId === null) {
42122
- throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
42123
- }
42124
-
42125
- return this.apiClient.callApi(
42126
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
42127
- 'GET',
42128
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
42129
- { },
42130
- { },
42131
- { },
42132
- null,
42133
- ['PureCloud OAuth'],
42134
- ['application/json'],
42135
- ['application/json']
42136
- );
42137
- }
42138
-
42139
41817
  /**
42140
41818
  * Get a work plan
42141
41819
  *
@@ -42166,6 +41844,65 @@ class WorkforceManagementApi {
42166
41844
  );
42167
41845
  }
42168
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
+
42169
41906
  /**
42170
41907
  * Get work plans
42171
41908
  *
@@ -42555,129 +42292,6 @@ class WorkforceManagementApi {
42555
42292
  );
42556
42293
  }
42557
42294
 
42558
- /**
42559
- * Deprecated/Gone: Use the new business unit activity code resources
42560
- *
42561
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42562
- * @param {String} acId The ID of the activity code to update
42563
- * @param {Object} opts Optional parameters
42564
- * @param {Object} opts.body body
42565
- */
42566
- patchWorkforcemanagementManagementunitActivitycode(muId, acId, opts) {
42567
- opts = opts || {};
42568
-
42569
- // verify the required parameter 'muId' is set
42570
- if (muId === undefined || muId === null) {
42571
- throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitActivitycode';
42572
- }
42573
- // verify the required parameter 'acId' is set
42574
- if (acId === undefined || acId === null) {
42575
- throw 'Missing the required parameter "acId" when calling patchWorkforcemanagementManagementunitActivitycode';
42576
- }
42577
-
42578
- return this.apiClient.callApi(
42579
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
42580
- 'PATCH',
42581
- { 'muId': muId,'acId': acId },
42582
- { },
42583
- { },
42584
- { },
42585
- opts['body'],
42586
- ['PureCloud OAuth'],
42587
- ['application/json'],
42588
- ['application/json']
42589
- );
42590
- }
42591
-
42592
- /**
42593
- * Gone. Scheduling has moved under business units
42594
- *
42595
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
42596
- * @param {String} runId The ID of the schedule run
42597
- * @param {Object} opts Optional parameters
42598
- * @param {Object} opts.body body
42599
- */
42600
- patchWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId, opts) {
42601
- opts = opts || {};
42602
-
42603
- // verify the required parameter 'managementUnitId' is set
42604
- if (managementUnitId === undefined || managementUnitId === null) {
42605
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
42606
- }
42607
- // verify the required parameter 'runId' is set
42608
- if (runId === undefined || runId === null) {
42609
- throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
42610
- }
42611
-
42612
- return this.apiClient.callApi(
42613
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
42614
- 'PATCH',
42615
- { 'managementUnitId': managementUnitId,'runId': runId },
42616
- { },
42617
- { },
42618
- { },
42619
- opts['body'],
42620
- ['PureCloud OAuth'],
42621
- ['application/json'],
42622
- ['application/json']
42623
- );
42624
- }
42625
-
42626
- /**
42627
- * Gone. Replaced with service goal templates and planning groups under business units
42628
- *
42629
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42630
- * @param {String} serviceGoalGroupId Gone. The ID of the service goal group to update
42631
- */
42632
- patchWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
42633
- // verify the required parameter 'managementUnitId' is set
42634
- if (managementUnitId === undefined || managementUnitId === null) {
42635
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
42636
- }
42637
- // verify the required parameter 'serviceGoalGroupId' is set
42638
- if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
42639
- throw 'Missing the required parameter "serviceGoalGroupId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
42640
- }
42641
-
42642
- return this.apiClient.callApi(
42643
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
42644
- 'PATCH',
42645
- { 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
42646
- { },
42647
- { },
42648
- { },
42649
- null,
42650
- ['PureCloud OAuth'],
42651
- ['application/json'],
42652
- ['application/json']
42653
- );
42654
- }
42655
-
42656
- /**
42657
- * Gone. Update settings by PATCHing the management unit
42658
- *
42659
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42660
- */
42661
- patchWorkforcemanagementManagementunitSettings(muId) {
42662
- // verify the required parameter 'muId' is set
42663
- if (muId === undefined || muId === null) {
42664
- throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitSettings';
42665
- }
42666
-
42667
- return this.apiClient.callApi(
42668
- '/api/v2/workforcemanagement/managementunits/{muId}/settings',
42669
- 'PATCH',
42670
- { 'muId': muId },
42671
- { },
42672
- { },
42673
- { },
42674
- null,
42675
- ['PureCloud OAuth'],
42676
- ['application/json'],
42677
- ['application/json']
42678
- );
42679
- }
42680
-
42681
42295
  /**
42682
42296
  * Update a time off request
42683
42297
  *
@@ -42717,41 +42331,6 @@ class WorkforceManagementApi {
42717
42331
  );
42718
42332
  }
42719
42333
 
42720
- /**
42721
- * Gone. Scheduling has moved under business units
42722
- *
42723
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42724
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
42725
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500
42726
- */
42727
- patchWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
42728
- // verify the required parameter 'managementUnitId' is set
42729
- if (managementUnitId === undefined || managementUnitId === null) {
42730
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
42731
- }
42732
- // verify the required parameter 'weekId' is set
42733
- if (weekId === undefined || weekId === null) {
42734
- throw 'Missing the required parameter "weekId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
42735
- }
42736
- // verify the required parameter 'scheduleId' is set
42737
- if (scheduleId === undefined || scheduleId === null) {
42738
- throw 'Missing the required parameter "scheduleId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
42739
- }
42740
-
42741
- return this.apiClient.callApi(
42742
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
42743
- 'PATCH',
42744
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
42745
- { },
42746
- { },
42747
- { },
42748
- null,
42749
- ['PureCloud OAuth'],
42750
- ['application/json'],
42751
- ['application/json']
42752
- );
42753
- }
42754
-
42755
42334
  /**
42756
42335
  * Updates a shift trade. This route can only be called by the initiating agent
42757
42336
  *
@@ -42826,6 +42405,40 @@ class WorkforceManagementApi {
42826
42405
  );
42827
42406
  }
42828
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
+
42829
42442
  /**
42830
42443
  * Update a time off request for the current user
42831
42444
  *
@@ -43353,31 +42966,6 @@ class WorkforceManagementApi {
43353
42966
  );
43354
42967
  }
43355
42968
 
43356
- /**
43357
- * Deprecated/Gone: Use the new business unit activity code resources
43358
- *
43359
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43360
- */
43361
- postWorkforcemanagementManagementunitActivitycodes(muId) {
43362
- // verify the required parameter 'muId' is set
43363
- if (muId === undefined || muId === null) {
43364
- throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitActivitycodes';
43365
- }
43366
-
43367
- return this.apiClient.callApi(
43368
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes',
43369
- 'POST',
43370
- { 'muId': muId },
43371
- { },
43372
- { },
43373
- { },
43374
- null,
43375
- ['PureCloud OAuth'],
43376
- ['application/json'],
43377
- ['application/json']
43378
- );
43379
- }
43380
-
43381
42969
  /**
43382
42970
  * Query published schedules for given given time range for set of users
43383
42971
  *
@@ -43438,31 +43026,6 @@ class WorkforceManagementApi {
43438
43026
  );
43439
43027
  }
43440
43028
 
43441
- /**
43442
- * Gone. Moved under business units
43443
- *
43444
- * @param {String} muId The management unit ID of the management unit
43445
- */
43446
- postWorkforcemanagementManagementunitIntraday(muId) {
43447
- // verify the required parameter 'muId' is set
43448
- if (muId === undefined || muId === null) {
43449
- throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitIntraday';
43450
- }
43451
-
43452
- return this.apiClient.callApi(
43453
- '/api/v2/workforcemanagement/managementunits/{muId}/intraday',
43454
- 'POST',
43455
- { 'muId': muId },
43456
- { },
43457
- { },
43458
- { },
43459
- null,
43460
- ['PureCloud OAuth'],
43461
- ['application/json'],
43462
- ['application/json']
43463
- );
43464
- }
43465
-
43466
43029
  /**
43467
43030
  * Move the requested management unit to a new business unit
43468
43031
  * Returns status 200 if the management unit is already in the requested business unit
@@ -43521,31 +43084,6 @@ class WorkforceManagementApi {
43521
43084
  );
43522
43085
  }
43523
43086
 
43524
- /**
43525
- * Gone. Replaced with service goal templates and planning groups under business units
43526
- *
43527
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43528
- */
43529
- postWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
43530
- // verify the required parameter 'managementUnitId' is set
43531
- if (managementUnitId === undefined || managementUnitId === null) {
43532
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitServicegoalgroups';
43533
- }
43534
-
43535
- return this.apiClient.callApi(
43536
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
43537
- 'POST',
43538
- { 'managementUnitId': managementUnitId },
43539
- { },
43540
- { },
43541
- { },
43542
- null,
43543
- ['PureCloud OAuth'],
43544
- ['application/json'],
43545
- ['application/json']
43546
- );
43547
- }
43548
-
43549
43087
  /**
43550
43088
  * Create a new time off request
43551
43089
  *
@@ -43575,35 +43113,6 @@ class WorkforceManagementApi {
43575
43113
  );
43576
43114
  }
43577
43115
 
43578
- /**
43579
- * Gone. All data is now returned in the query route
43580
- *
43581
- * @param {String} muId The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43582
- * @param {Object} opts Optional parameters
43583
- * @param {Object} opts.body body
43584
- */
43585
- postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails(muId, opts) {
43586
- opts = opts || {};
43587
-
43588
- // verify the required parameter 'muId' is set
43589
- if (muId === undefined || muId === null) {
43590
- throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails';
43591
- }
43592
-
43593
- return this.apiClient.callApi(
43594
- '/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails',
43595
- 'POST',
43596
- { 'muId': muId },
43597
- { },
43598
- { },
43599
- { },
43600
- opts['body'],
43601
- ['PureCloud OAuth'],
43602
- ['application/json'],
43603
- ['application/json']
43604
- );
43605
- }
43606
-
43607
43116
  /**
43608
43117
  * Gets the lookup ids to fetch the specified set of requests
43609
43118
  *
@@ -43633,166 +43142,6 @@ class WorkforceManagementApi {
43633
43142
  );
43634
43143
  }
43635
43144
 
43636
- /**
43637
- * Gone. Scheduling has moved under business units
43638
- *
43639
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43640
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
43641
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to copy from
43642
- */
43643
- postWorkforcemanagementManagementunitWeekScheduleCopy(managementUnitId, weekId, scheduleId) {
43644
- // verify the required parameter 'managementUnitId' is set
43645
- if (managementUnitId === undefined || managementUnitId === null) {
43646
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
43647
- }
43648
- // verify the required parameter 'weekId' is set
43649
- if (weekId === undefined || weekId === null) {
43650
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
43651
- }
43652
- // verify the required parameter 'scheduleId' is set
43653
- if (scheduleId === undefined || scheduleId === null) {
43654
- throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
43655
- }
43656
-
43657
- return this.apiClient.callApi(
43658
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy',
43659
- 'POST',
43660
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
43661
- { },
43662
- { },
43663
- { },
43664
- null,
43665
- ['PureCloud OAuth'],
43666
- ['application/json'],
43667
- ['application/json']
43668
- );
43669
- }
43670
-
43671
- /**
43672
- * Gone. Scheduling has moved under business units
43673
- *
43674
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43675
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
43676
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to re-optimize
43677
- */
43678
- postWorkforcemanagementManagementunitWeekScheduleReschedule(managementUnitId, weekId, scheduleId) {
43679
- // verify the required parameter 'managementUnitId' is set
43680
- if (managementUnitId === undefined || managementUnitId === null) {
43681
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
43682
- }
43683
- // verify the required parameter 'weekId' is set
43684
- if (weekId === undefined || weekId === null) {
43685
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
43686
- }
43687
- // verify the required parameter 'scheduleId' is set
43688
- if (scheduleId === undefined || scheduleId === null) {
43689
- throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
43690
- }
43691
-
43692
- return this.apiClient.callApi(
43693
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule',
43694
- 'POST',
43695
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
43696
- { },
43697
- { },
43698
- { },
43699
- null,
43700
- ['PureCloud OAuth'],
43701
- ['application/json'],
43702
- ['application/json']
43703
- );
43704
- }
43705
-
43706
- /**
43707
- * Gone. Scheduling has moved under business units
43708
- *
43709
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43710
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
43711
- */
43712
- postWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId) {
43713
- // verify the required parameter 'managementUnitId' is set
43714
- if (managementUnitId === undefined || managementUnitId === null) {
43715
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedules';
43716
- }
43717
- // verify the required parameter 'weekId' is set
43718
- if (weekId === undefined || weekId === null) {
43719
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
43720
- }
43721
-
43722
- return this.apiClient.callApi(
43723
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules',
43724
- 'POST',
43725
- { 'managementUnitId': managementUnitId,'weekId': weekId },
43726
- { },
43727
- { },
43728
- { },
43729
- null,
43730
- ['PureCloud OAuth'],
43731
- ['application/json'],
43732
- ['application/json']
43733
- );
43734
- }
43735
-
43736
- /**
43737
- * Gone. Scheduling has moved under business units
43738
- *
43739
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43740
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
43741
- */
43742
- postWorkforcemanagementManagementunitWeekSchedulesGenerate(managementUnitId, weekId) {
43743
- // verify the required parameter 'managementUnitId' is set
43744
- if (managementUnitId === undefined || managementUnitId === null) {
43745
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
43746
- }
43747
- // verify the required parameter 'weekId' is set
43748
- if (weekId === undefined || weekId === null) {
43749
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
43750
- }
43751
-
43752
- return this.apiClient.callApi(
43753
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate',
43754
- 'POST',
43755
- { 'managementUnitId': managementUnitId,'weekId': weekId },
43756
- { },
43757
- { },
43758
- { },
43759
- null,
43760
- ['PureCloud OAuth'],
43761
- ['application/json'],
43762
- ['application/json']
43763
- );
43764
- }
43765
-
43766
- /**
43767
- * Gone. Scheduling has moved under business units
43768
- *
43769
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43770
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
43771
- */
43772
- postWorkforcemanagementManagementunitWeekSchedulesPartialupload(managementUnitId, weekId) {
43773
- // verify the required parameter 'managementUnitId' is set
43774
- if (managementUnitId === undefined || managementUnitId === null) {
43775
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
43776
- }
43777
- // verify the required parameter 'weekId' is set
43778
- if (weekId === undefined || weekId === null) {
43779
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
43780
- }
43781
-
43782
- return this.apiClient.callApi(
43783
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload',
43784
- 'POST',
43785
- { 'managementUnitId': managementUnitId,'weekId': weekId },
43786
- { },
43787
- { },
43788
- { },
43789
- null,
43790
- ['PureCloud OAuth'],
43791
- ['application/json'],
43792
- ['application/json']
43793
- );
43794
- }
43795
-
43796
43145
  /**
43797
43146
  * Matches a shift trade. This route can only be called by the receiving agent
43798
43147
  *
@@ -43943,94 +43292,33 @@ class WorkforceManagementApi {
43943
43292
  }
43944
43293
 
43945
43294
  /**
43946
- * Gone. Use equivalent business unit resource instead
43947
- *
43948
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
43949
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
43950
- * @param {String} forecastId (Gone/Deprecated): The ID of the forecast
43951
- */
43952
- postWorkforcemanagementManagementunitWeekShorttermforecastCopy(managementUnitId, weekDateId, forecastId) {
43953
- // verify the required parameter 'managementUnitId' is set
43954
- if (managementUnitId === undefined || managementUnitId === null) {
43955
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
43956
- }
43957
- // verify the required parameter 'weekDateId' is set
43958
- if (weekDateId === undefined || weekDateId === null) {
43959
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
43960
- }
43961
- // verify the required parameter 'forecastId' is set
43962
- if (forecastId === undefined || forecastId === null) {
43963
- throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
43964
- }
43965
-
43966
- return this.apiClient.callApi(
43967
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy',
43968
- 'POST',
43969
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
43970
- { },
43971
- { },
43972
- { },
43973
- null,
43974
- ['PureCloud OAuth'],
43975
- ['application/json'],
43976
- ['application/json']
43977
- );
43978
- }
43979
-
43980
- /**
43981
- * Gone. Use equivalent business unit resource instead
43982
- *
43983
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
43984
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
43985
- */
43986
- postWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
43987
- // verify the required parameter 'managementUnitId' is set
43988
- if (managementUnitId === undefined || managementUnitId === null) {
43989
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
43990
- }
43991
- // verify the required parameter 'weekDateId' is set
43992
- if (weekDateId === undefined || weekDateId === null) {
43993
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
43994
- }
43995
-
43996
- return this.apiClient.callApi(
43997
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
43998
- 'POST',
43999
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
44000
- { },
44001
- { },
44002
- { },
44003
- null,
44004
- ['PureCloud OAuth'],
44005
- ['application/json'],
44006
- ['application/json']
44007
- );
44008
- }
44009
-
44010
- /**
44011
- * Gone. Use equivalent business unit resource instead
43295
+ * Create a copy of work plan
44012
43296
  *
44013
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
44014
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
43297
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43298
+ * @param {String} workPlanId The ID of the work plan to create a copy
43299
+ * @param {Object} opts Optional parameters
43300
+ * @param {Object} opts.body body
44015
43301
  */
44016
- postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate(managementUnitId, weekDateId) {
43302
+ postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
43303
+ opts = opts || {};
43304
+
44017
43305
  // verify the required parameter 'managementUnitId' is set
44018
43306
  if (managementUnitId === undefined || managementUnitId === null) {
44019
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate';
43307
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
44020
43308
  }
44021
- // verify the required parameter 'weekDateId' is set
44022
- if (weekDateId === undefined || weekDateId === null) {
44023
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate';
43309
+ // verify the required parameter 'workPlanId' is set
43310
+ if (workPlanId === undefined || workPlanId === null) {
43311
+ throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
44024
43312
  }
44025
43313
 
44026
43314
  return this.apiClient.callApi(
44027
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/generate',
43315
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
44028
43316
  'POST',
44029
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
43317
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
44030
43318
  { },
44031
43319
  { },
44032
43320
  { },
44033
- null,
43321
+ opts['body'],
44034
43322
  ['PureCloud OAuth'],
44035
43323
  ['application/json'],
44036
43324
  ['application/json']
@@ -44038,29 +43326,34 @@ class WorkforceManagementApi {
44038
43326
  }
44039
43327
 
44040
43328
  /**
44041
- * Gone. Use equivalent business unit resource instead
43329
+ * Validate Work Plan
44042
43330
  *
44043
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
44044
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
43331
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43332
+ * @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word &#39;new&#39; for the ID.
43333
+ * @param {Object} opts Optional parameters
43334
+ * @param {Object} opts.body body
43335
+ * @param {Array.<String>} opts.expand
44045
43336
  */
44046
- postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload(managementUnitId, weekDateId) {
43337
+ postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
43338
+ opts = opts || {};
43339
+
44047
43340
  // verify the required parameter 'managementUnitId' is set
44048
43341
  if (managementUnitId === undefined || managementUnitId === null) {
44049
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload';
43342
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
44050
43343
  }
44051
- // verify the required parameter 'weekDateId' is set
44052
- if (weekDateId === undefined || weekDateId === null) {
44053
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload';
43344
+ // verify the required parameter 'workPlanId' is set
43345
+ if (workPlanId === undefined || workPlanId === null) {
43346
+ throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
44054
43347
  }
44055
43348
 
44056
43349
  return this.apiClient.callApi(
44057
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/partialupload',
43350
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
44058
43351
  'POST',
44059
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
44060
- { },
43352
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
43353
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
44061
43354
  { },
44062
43355
  { },
44063
- null,
43356
+ opts['body'],
44064
43357
  ['PureCloud OAuth'],
44065
43358
  ['application/json'],
44066
43359
  ['application/json']
@@ -44068,29 +43361,29 @@ class WorkforceManagementApi {
44068
43361
  }
44069
43362
 
44070
43363
  /**
44071
- * Create a copy of work plan
43364
+ * Create a copy of work plan rotation
44072
43365
  *
44073
43366
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
44074
- * @param {String} workPlanId The ID of the work plan to create a copy
43367
+ * @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
44075
43368
  * @param {Object} opts Optional parameters
44076
43369
  * @param {Object} opts.body body
44077
43370
  */
44078
- postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
43371
+ postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
44079
43372
  opts = opts || {};
44080
43373
 
44081
43374
  // verify the required parameter 'managementUnitId' is set
44082
43375
  if (managementUnitId === undefined || managementUnitId === null) {
44083
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
43376
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
44084
43377
  }
44085
- // verify the required parameter 'workPlanId' is set
44086
- if (workPlanId === undefined || workPlanId === null) {
44087
- throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
43378
+ // verify the required parameter 'workPlanRotationId' is set
43379
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
43380
+ throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
44088
43381
  }
44089
43382
 
44090
43383
  return this.apiClient.callApi(
44091
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
43384
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
44092
43385
  'POST',
44093
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
43386
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
44094
43387
  { },
44095
43388
  { },
44096
43389
  { },
@@ -44102,31 +43395,25 @@ class WorkforceManagementApi {
44102
43395
  }
44103
43396
 
44104
43397
  /**
44105
- * Validate Work Plan
43398
+ * Create a new work plan rotation
44106
43399
  *
44107
43400
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
44108
- * @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word &#39;new&#39; for the ID.
44109
43401
  * @param {Object} opts Optional parameters
44110
43402
  * @param {Object} opts.body body
44111
- * @param {Array.<String>} opts.expand
44112
43403
  */
44113
- postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
43404
+ postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
44114
43405
  opts = opts || {};
44115
43406
 
44116
43407
  // verify the required parameter 'managementUnitId' is set
44117
43408
  if (managementUnitId === undefined || managementUnitId === null) {
44118
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
44119
- }
44120
- // verify the required parameter 'workPlanId' is set
44121
- if (workPlanId === undefined || workPlanId === null) {
44122
- throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
43409
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
44123
43410
  }
44124
43411
 
44125
43412
  return this.apiClient.callApi(
44126
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
43413
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
44127
43414
  'POST',
44128
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
44129
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
43415
+ { 'managementUnitId': managementUnitId },
43416
+ { },
44130
43417
  { },
44131
43418
  { },
44132
43419
  opts['body'],
@@ -44292,7 +43579,7 @@ class WorkforceManagementApi {
44292
43579
  * </pre>
44293
43580
  * </p>
44294
43581
  * @module purecloud-platform-client-v2/index
44295
- * @version 94.0.0
43582
+ * @version 97.0.0
44296
43583
  */
44297
43584
  class platformClient {
44298
43585
  constructor() {
@@ -44551,11 +43838,6 @@ class platformClient {
44551
43838
  * @property {module:purecloud-platform-client-v2/api/UsageApi}
44552
43839
  */
44553
43840
  this.UsageApi = UsageApi;
44554
- /**
44555
- * The UserDevelopmentApi service constructor.
44556
- * @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
44557
- */
44558
- this.UserDevelopmentApi = UserDevelopmentApi;
44559
43841
  /**
44560
43842
  * The UserRecordingsApi service constructor.
44561
43843
  * @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}