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
@@ -1983,7 +1983,7 @@ function isSlowBuffer (obj) {
1983
1983
 
1984
1984
  /**
1985
1985
  * @module purecloud-platform-client-v2/ApiClient
1986
- * @version 94.0.0
1986
+ * @version 97.0.0
1987
1987
  */
1988
1988
  class ApiClient {
1989
1989
  /**
@@ -2739,7 +2739,7 @@ class ApiClient {
2739
2739
 
2740
2740
  // set header parameters
2741
2741
  request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
2742
- //request.set({ 'purecloud-sdk': '94.0.0' });
2742
+ //request.set({ 'purecloud-sdk': '97.0.0' });
2743
2743
 
2744
2744
  // set request timeout
2745
2745
  request.timeout(this.timeout);
@@ -2864,7 +2864,7 @@ class AlertingApi {
2864
2864
  /**
2865
2865
  * Alerting service.
2866
2866
  * @module purecloud-platform-client-v2/api/AlertingApi
2867
- * @version 94.0.0
2867
+ * @version 97.0.0
2868
2868
  */
2869
2869
 
2870
2870
  /**
@@ -3178,7 +3178,7 @@ class AnalyticsApi {
3178
3178
  /**
3179
3179
  * Analytics service.
3180
3180
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3181
- * @version 94.0.0
3181
+ * @version 97.0.0
3182
3182
  */
3183
3183
 
3184
3184
  /**
@@ -4258,7 +4258,7 @@ class ArchitectApi {
4258
4258
  /**
4259
4259
  * Architect service.
4260
4260
  * @module purecloud-platform-client-v2/api/ArchitectApi
4261
- * @version 94.0.0
4261
+ * @version 97.0.0
4262
4262
  */
4263
4263
 
4264
4264
  /**
@@ -7096,7 +7096,7 @@ class AuditApi {
7096
7096
  /**
7097
7097
  * Audit service.
7098
7098
  * @module purecloud-platform-client-v2/api/AuditApi
7099
- * @version 94.0.0
7099
+ * @version 97.0.0
7100
7100
  */
7101
7101
 
7102
7102
  /**
@@ -7267,7 +7267,7 @@ class AuthorizationApi {
7267
7267
  /**
7268
7268
  * Authorization service.
7269
7269
  * @module purecloud-platform-client-v2/api/AuthorizationApi
7270
- * @version 94.0.0
7270
+ * @version 97.0.0
7271
7271
  */
7272
7272
 
7273
7273
  /**
@@ -7602,6 +7602,8 @@ class AuthorizationApi {
7602
7602
  * @param {Object} opts Optional parameters
7603
7603
  * @param {Number} opts.pageSize Page size (default to 25)
7604
7604
  * @param {Number} opts.pageNumber Page number (default to 1)
7605
+ * @param {Object} opts.queryType Query filter type
7606
+ * @param {String} opts.query Comma-separated list of permissions or domains to query
7605
7607
  */
7606
7608
  getAuthorizationPermissions(opts) {
7607
7609
  opts = opts || {};
@@ -7611,7 +7613,7 @@ class AuthorizationApi {
7611
7613
  '/api/v2/authorization/permissions',
7612
7614
  'GET',
7613
7615
  { },
7614
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
7616
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
7615
7617
  { },
7616
7618
  { },
7617
7619
  null,
@@ -8384,7 +8386,7 @@ class BillingApi {
8384
8386
  /**
8385
8387
  * Billing service.
8386
8388
  * @module purecloud-platform-client-v2/api/BillingApi
8387
- * @version 94.0.0
8389
+ * @version 97.0.0
8388
8390
  */
8389
8391
 
8390
8392
  /**
@@ -8402,8 +8404,8 @@ class BillingApi {
8402
8404
  /**
8403
8405
  * Get a report of the billable license usages
8404
8406
  * 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.
8405
- * @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
8406
- * @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
8407
+ * @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
8408
+ * @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
8407
8409
  */
8408
8410
  getBillingReportsBillableusage(startDate, endDate) {
8409
8411
  // verify the required parameter 'startDate' is set
@@ -8464,7 +8466,7 @@ class CoachingApi {
8464
8466
  /**
8465
8467
  * Coaching service.
8466
8468
  * @module purecloud-platform-client-v2/api/CoachingApi
8467
- * @version 94.0.0
8469
+ * @version 97.0.0
8468
8470
  */
8469
8471
 
8470
8472
  /**
@@ -8984,7 +8986,7 @@ class ContentManagementApi {
8984
8986
  /**
8985
8987
  * ContentManagement service.
8986
8988
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8987
- * @version 94.0.0
8989
+ * @version 97.0.0
8988
8990
  */
8989
8991
 
8990
8992
  /**
@@ -10124,7 +10126,7 @@ class ConversationsApi {
10124
10126
  /**
10125
10127
  * Conversations service.
10126
10128
  * @module purecloud-platform-client-v2/api/ConversationsApi
10127
- * @version 94.0.0
10129
+ * @version 97.0.0
10128
10130
  */
10129
10131
 
10130
10132
  /**
@@ -13753,7 +13755,7 @@ class ConversationsApi {
13753
13755
 
13754
13756
  /**
13755
13757
  * Send message
13756
- *
13758
+ * 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.
13757
13759
  * @param {String} conversationId conversationId
13758
13760
  * @param {String} communicationId communicationId
13759
13761
  * @param {Object} body Message
@@ -13934,8 +13936,12 @@ class ConversationsApi {
13934
13936
  * Create a Facebook Integration
13935
13937
  *
13936
13938
  * @param {Object} body FacebookIntegrationRequest
13939
+ * @param {Object} opts Optional parameters
13940
+ * @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)
13937
13941
  */
13938
- postConversationsMessagingIntegrationsFacebook(body) {
13942
+ postConversationsMessagingIntegrationsFacebook(body, opts) {
13943
+ opts = opts || {};
13944
+
13939
13945
  // verify the required parameter 'body' is set
13940
13946
  if (body === undefined || body === null) {
13941
13947
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';
@@ -13945,7 +13951,7 @@ class ConversationsApi {
13945
13951
  '/api/v2/conversations/messaging/integrations/facebook',
13946
13952
  'POST',
13947
13953
  { },
13948
- { },
13954
+ { 'async': opts['async'] },
13949
13955
  { },
13950
13956
  { },
13951
13957
  body,
@@ -13959,8 +13965,12 @@ class ConversationsApi {
13959
13965
  * Create a LINE messenger Integration
13960
13966
  *
13961
13967
  * @param {Object} body LineIntegrationRequest
13968
+ * @param {Object} opts Optional parameters
13969
+ * @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)
13962
13970
  */
13963
- postConversationsMessagingIntegrationsLine(body) {
13971
+ postConversationsMessagingIntegrationsLine(body, opts) {
13972
+ opts = opts || {};
13973
+
13964
13974
  // verify the required parameter 'body' is set
13965
13975
  if (body === undefined || body === null) {
13966
13976
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
@@ -13970,7 +13980,7 @@ class ConversationsApi {
13970
13980
  '/api/v2/conversations/messaging/integrations/line',
13971
13981
  'POST',
13972
13982
  { },
13973
- { },
13983
+ { 'async': opts['async'] },
13974
13984
  { },
13975
13985
  { },
13976
13986
  body,
@@ -13984,8 +13994,12 @@ class ConversationsApi {
13984
13994
  * Create a Twitter Integration
13985
13995
  *
13986
13996
  * @param {Object} body TwitterIntegrationRequest
13997
+ * @param {Object} opts Optional parameters
13998
+ * @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)
13987
13999
  */
13988
- postConversationsMessagingIntegrationsTwitter(body) {
14000
+ postConversationsMessagingIntegrationsTwitter(body, opts) {
14001
+ opts = opts || {};
14002
+
13989
14003
  // verify the required parameter 'body' is set
13990
14004
  if (body === undefined || body === null) {
13991
14005
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
@@ -13995,7 +14009,7 @@ class ConversationsApi {
13995
14009
  '/api/v2/conversations/messaging/integrations/twitter',
13996
14010
  'POST',
13997
14011
  { },
13998
- { },
14012
+ { 'async': opts['async'] },
13999
14013
  { },
14000
14014
  { },
14001
14015
  body,
@@ -14009,8 +14023,12 @@ class ConversationsApi {
14009
14023
  * Create a WhatsApp Integration
14010
14024
  * 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.
14011
14025
  * @param {Object} body WhatsAppIntegrationRequest
14026
+ * @param {Object} opts Optional parameters
14027
+ * @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)
14012
14028
  */
14013
- postConversationsMessagingIntegrationsWhatsapp(body) {
14029
+ postConversationsMessagingIntegrationsWhatsapp(body, opts) {
14030
+ opts = opts || {};
14031
+
14014
14032
  // verify the required parameter 'body' is set
14015
14033
  if (body === undefined || body === null) {
14016
14034
  throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';
@@ -14020,7 +14038,7 @@ class ConversationsApi {
14020
14038
  '/api/v2/conversations/messaging/integrations/whatsapp',
14021
14039
  'POST',
14022
14040
  { },
14023
- { },
14041
+ { 'async': opts['async'] },
14024
14042
  { },
14025
14043
  { },
14026
14044
  body,
@@ -14166,7 +14184,7 @@ class DataExtensionsApi {
14166
14184
  /**
14167
14185
  * DataExtensions service.
14168
14186
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
14169
- * @version 94.0.0
14187
+ * @version 97.0.0
14170
14188
  */
14171
14189
 
14172
14190
  /**
@@ -14252,7 +14270,7 @@ class ExternalContactsApi {
14252
14270
  /**
14253
14271
  * ExternalContacts service.
14254
14272
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
14255
- * @version 94.0.0
14273
+ * @version 97.0.0
14256
14274
  */
14257
14275
 
14258
14276
  /**
@@ -15595,7 +15613,7 @@ class FaxApi {
15595
15613
  /**
15596
15614
  * Fax service.
15597
15615
  * @module purecloud-platform-client-v2/api/FaxApi
15598
- * @version 94.0.0
15616
+ * @version 97.0.0
15599
15617
  */
15600
15618
 
15601
15619
  /**
@@ -15766,7 +15784,7 @@ class FlowsApi {
15766
15784
  /**
15767
15785
  * Flows service.
15768
15786
  * @module purecloud-platform-client-v2/api/FlowsApi
15769
- * @version 94.0.0
15787
+ * @version 97.0.0
15770
15788
  */
15771
15789
 
15772
15790
  /**
@@ -15837,7 +15855,7 @@ class GeneralDataProtectionRegulationApi {
15837
15855
  /**
15838
15856
  * GeneralDataProtectionRegulation service.
15839
15857
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
15840
- * @version 94.0.0
15858
+ * @version 97.0.0
15841
15859
  */
15842
15860
 
15843
15861
  /**
@@ -15967,7 +15985,7 @@ class GeolocationApi {
15967
15985
  /**
15968
15986
  * Geolocation service.
15969
15987
  * @module purecloud-platform-client-v2/api/GeolocationApi
15970
- * @version 94.0.0
15988
+ * @version 97.0.0
15971
15989
  */
15972
15990
 
15973
15991
  /**
@@ -16098,7 +16116,7 @@ class GreetingsApi {
16098
16116
  /**
16099
16117
  * Greetings service.
16100
16118
  * @module purecloud-platform-client-v2/api/GreetingsApi
16101
- * @version 94.0.0
16119
+ * @version 97.0.0
16102
16120
  */
16103
16121
 
16104
16122
  /**
@@ -16553,7 +16571,7 @@ class GroupsApi {
16553
16571
  /**
16554
16572
  * Groups service.
16555
16573
  * @module purecloud-platform-client-v2/api/GroupsApi
16556
- * @version 94.0.0
16574
+ * @version 97.0.0
16557
16575
  */
16558
16576
 
16559
16577
  /**
@@ -16958,7 +16976,7 @@ class IdentityProviderApi {
16958
16976
  /**
16959
16977
  * IdentityProvider service.
16960
16978
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
16961
- * @version 94.0.0
16979
+ * @version 97.0.0
16962
16980
  */
16963
16981
 
16964
16982
  /**
@@ -17714,7 +17732,7 @@ class IntegrationsApi {
17714
17732
  /**
17715
17733
  * Integrations service.
17716
17734
  * @module purecloud-platform-client-v2/api/IntegrationsApi
17717
- * @version 94.0.0
17735
+ * @version 97.0.0
17718
17736
  */
17719
17737
 
17720
17738
  /**
@@ -19206,7 +19224,7 @@ class JourneyApi {
19206
19224
  /**
19207
19225
  * Journey service.
19208
19226
  * @module purecloud-platform-client-v2/api/JourneyApi
19209
- * @version 94.0.0
19227
+ * @version 97.0.0
19210
19228
  */
19211
19229
 
19212
19230
  /**
@@ -19271,6 +19289,107 @@ class JourneyApi {
19271
19289
  );
19272
19290
  }
19273
19291
 
19292
+ /**
19293
+ * Retrieve segment assignments by customer ID.
19294
+ *
19295
+ * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
19296
+ * @param {String} customerId Primary identifier of the customer to query for segment assignments.
19297
+ * @param {Object} opts Optional parameters
19298
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
19299
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
19300
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
19301
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
19302
+ */
19303
+ getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
19304
+ opts = opts || {};
19305
+
19306
+ // verify the required parameter 'customerIdType' is set
19307
+ if (customerIdType === undefined || customerIdType === null) {
19308
+ throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
19309
+ }
19310
+ // verify the required parameter 'customerId' is set
19311
+ if (customerId === undefined || customerId === null) {
19312
+ throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
19313
+ }
19314
+
19315
+ return this.apiClient.callApi(
19316
+ '/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
19317
+ 'GET',
19318
+ { 'customerIdType': customerIdType,'customerId': customerId },
19319
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
19320
+ { },
19321
+ { },
19322
+ null,
19323
+ ['PureCloud OAuth'],
19324
+ ['application/json'],
19325
+ ['application/json']
19326
+ );
19327
+ }
19328
+
19329
+ /**
19330
+ * Retrieve segment assignments by external contact ID.
19331
+ *
19332
+ * @param {String} externalContactId ID of the external contact to query for segment assignments.
19333
+ * @param {Object} opts Optional parameters
19334
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
19335
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
19336
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
19337
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
19338
+ */
19339
+ getJourneyExternalcontactSegments(externalContactId, opts) {
19340
+ opts = opts || {};
19341
+
19342
+ // verify the required parameter 'externalContactId' is set
19343
+ if (externalContactId === undefined || externalContactId === null) {
19344
+ throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
19345
+ }
19346
+
19347
+ return this.apiClient.callApi(
19348
+ '/api/v2/journey/externalcontacts/{externalContactId}/segments',
19349
+ 'GET',
19350
+ { 'externalContactId': externalContactId },
19351
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
19352
+ { },
19353
+ { },
19354
+ null,
19355
+ ['PureCloud OAuth'],
19356
+ ['application/json'],
19357
+ ['application/json']
19358
+ );
19359
+ }
19360
+
19361
+ /**
19362
+ * Retrieve segment assignments by session ID.
19363
+ *
19364
+ * @param {String} sessionId ID of the session to query for segment assignments.
19365
+ * @param {Object} opts Optional parameters
19366
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
19367
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
19368
+ * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
19369
+ * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
19370
+ */
19371
+ getJourneySessionSegments(sessionId, opts) {
19372
+ opts = opts || {};
19373
+
19374
+ // verify the required parameter 'sessionId' is set
19375
+ if (sessionId === undefined || sessionId === null) {
19376
+ throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
19377
+ }
19378
+
19379
+ return this.apiClient.callApi(
19380
+ '/api/v2/journey/sessions/{sessionId}/segments',
19381
+ 'GET',
19382
+ { 'sessionId': sessionId },
19383
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
19384
+ { },
19385
+ { },
19386
+ null,
19387
+ ['PureCloud OAuth'],
19388
+ ['application/json'],
19389
+ ['application/json']
19390
+ );
19391
+ }
19392
+
19274
19393
  /**
19275
19394
  * Update a single action target.
19276
19395
  *
@@ -19325,13 +19444,42 @@ class JourneyApi {
19325
19444
  );
19326
19445
  }
19327
19446
 
19447
+ /**
19448
+ * Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
19449
+ *
19450
+ * @param {String} externalContactId ID of the external contact to query for segment assignments.
19451
+ * @param {Object} opts Optional parameters
19452
+ * @param {Array.<Object>} opts.body
19453
+ */
19454
+ postJourneyExternalcontactSegments(externalContactId, opts) {
19455
+ opts = opts || {};
19456
+
19457
+ // verify the required parameter 'externalContactId' is set
19458
+ if (externalContactId === undefined || externalContactId === null) {
19459
+ throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
19460
+ }
19461
+
19462
+ return this.apiClient.callApi(
19463
+ '/api/v2/journey/externalcontacts/{externalContactId}/segments',
19464
+ 'POST',
19465
+ { 'externalContactId': externalContactId },
19466
+ { },
19467
+ { },
19468
+ { },
19469
+ opts['body'],
19470
+ ['PureCloud OAuth'],
19471
+ ['application/json'],
19472
+ ['application/json']
19473
+ );
19474
+ }
19475
+
19328
19476
  }
19329
19477
 
19330
19478
  class KnowledgeApi {
19331
19479
  /**
19332
19480
  * Knowledge service.
19333
19481
  * @module purecloud-platform-client-v2/api/KnowledgeApi
19334
- * @version 94.0.0
19482
+ * @version 97.0.0
19335
19483
  */
19336
19484
 
19337
19485
  /**
@@ -19647,7 +19795,7 @@ class KnowledgeApi {
19647
19795
  }
19648
19796
 
19649
19797
  /**
19650
- * Get All trainings information for a knowledgebase
19798
+ * Get all trainings information for a knowledgebase
19651
19799
  *
19652
19800
  * @param {String} knowledgeBaseId Knowledge base ID
19653
19801
  * @param {Object} languageCode Language code, format: iso2-LOCALE
@@ -19656,6 +19804,7 @@ class KnowledgeApi {
19656
19804
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
19657
19805
  * @param {String} opts.limit Number of entities to return. Maximum of 200.
19658
19806
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
19807
+ * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
19659
19808
  */
19660
19809
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
19661
19810
  opts = opts || {};
@@ -19673,7 +19822,7 @@ class KnowledgeApi {
19673
19822
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
19674
19823
  'GET',
19675
19824
  { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
19676
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
19825
+ { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
19677
19826
  { },
19678
19827
  { },
19679
19828
  null,
@@ -20051,7 +20200,7 @@ class LanguageUnderstandingApi {
20051
20200
  /**
20052
20201
  * LanguageUnderstanding service.
20053
20202
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
20054
- * @version 94.0.0
20203
+ * @version 97.0.0
20055
20204
  */
20056
20205
 
20057
20206
  /**
@@ -20617,7 +20766,7 @@ class LanguagesApi {
20617
20766
  /**
20618
20767
  * Languages service.
20619
20768
  * @module purecloud-platform-client-v2/api/LanguagesApi
20620
- * @version 94.0.0
20769
+ * @version 97.0.0
20621
20770
  */
20622
20771
 
20623
20772
  /**
@@ -20885,7 +21034,7 @@ class LicenseApi {
20885
21034
  /**
20886
21035
  * License service.
20887
21036
  * @module purecloud-platform-client-v2/api/LicenseApi
20888
- * @version 94.0.0
21037
+ * @version 97.0.0
20889
21038
  */
20890
21039
 
20891
21040
  /**
@@ -21123,7 +21272,7 @@ class LocationsApi {
21123
21272
  /**
21124
21273
  * Locations service.
21125
21274
  * @module purecloud-platform-client-v2/api/LocationsApi
21126
- * @version 94.0.0
21275
+ * @version 97.0.0
21127
21276
  */
21128
21277
 
21129
21278
  /**
@@ -21359,7 +21508,7 @@ class MobileDevicesApi {
21359
21508
  /**
21360
21509
  * MobileDevices service.
21361
21510
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
21362
- * @version 94.0.0
21511
+ * @version 97.0.0
21363
21512
  */
21364
21513
 
21365
21514
  /**
@@ -21510,7 +21659,7 @@ class NotificationsApi {
21510
21659
  /**
21511
21660
  * Notifications service.
21512
21661
  * @module purecloud-platform-client-v2/api/NotificationsApi
21513
- * @version 94.0.0
21662
+ * @version 97.0.0
21514
21663
  */
21515
21664
 
21516
21665
  /**
@@ -21709,7 +21858,7 @@ class OAuthApi {
21709
21858
  /**
21710
21859
  * OAuth service.
21711
21860
  * @module purecloud-platform-client-v2/api/OAuthApi
21712
- * @version 94.0.0
21861
+ * @version 97.0.0
21713
21862
  */
21714
21863
 
21715
21864
  /**
@@ -22067,7 +22216,7 @@ class ObjectsApi {
22067
22216
  /**
22068
22217
  * Objects service.
22069
22218
  * @module purecloud-platform-client-v2/api/ObjectsApi
22070
- * @version 94.0.0
22219
+ * @version 97.0.0
22071
22220
  */
22072
22221
 
22073
22222
  /**
@@ -22308,7 +22457,7 @@ class OrganizationApi {
22308
22457
  /**
22309
22458
  * Organization service.
22310
22459
  * @module purecloud-platform-client-v2/api/OrganizationApi
22311
- * @version 94.0.0
22460
+ * @version 97.0.0
22312
22461
  */
22313
22462
 
22314
22463
  /**
@@ -22563,7 +22712,7 @@ class OrganizationAuthorizationApi {
22563
22712
  /**
22564
22713
  * OrganizationAuthorization service.
22565
22714
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
22566
- * @version 94.0.0
22715
+ * @version 97.0.0
22567
22716
  */
22568
22717
 
22569
22718
  /**
@@ -23273,7 +23422,7 @@ class OutboundApi {
23273
23422
  /**
23274
23423
  * Outbound service.
23275
23424
  * @module purecloud-platform-client-v2/api/OutboundApi
23276
- * @version 94.0.0
23425
+ * @version 97.0.0
23277
23426
  */
23278
23427
 
23279
23428
  /**
@@ -26247,7 +26396,7 @@ class PresenceApi {
26247
26396
  /**
26248
26397
  * Presence service.
26249
26398
  * @module purecloud-platform-client-v2/api/PresenceApi
26250
- * @version 94.0.0
26399
+ * @version 97.0.0
26251
26400
  */
26252
26401
 
26253
26402
  /**
@@ -26594,7 +26743,7 @@ class QualityApi {
26594
26743
  /**
26595
26744
  * Quality service.
26596
26745
  * @module purecloud-platform-client-v2/api/QualityApi
26597
- * @version 94.0.0
26746
+ * @version 97.0.0
26598
26747
  */
26599
26748
 
26600
26749
  /**
@@ -26808,8 +26957,8 @@ class QualityApi {
26808
26957
  * @param {Array.<String>} opts.expand variable name requested by expand list
26809
26958
  * @param {String} opts.nextPage next page token
26810
26959
  * @param {String} opts.previousPage Previous page token
26811
- * @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
26812
- * @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
26960
+ * @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
26961
+ * @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
26813
26962
  * @param {Array.<String>} opts.agentUserId user id of agent requested
26814
26963
  * @param {String} opts.evaluatorUserId user id of the evaluator
26815
26964
  * @param {String} opts.name name
@@ -26875,8 +27024,8 @@ class QualityApi {
26875
27024
  * @param {String} opts.nextPage next page token
26876
27025
  * @param {String} opts.previousPage Previous page token
26877
27026
  * @param {String} opts.conversationId conversation id
26878
- * @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
26879
- * @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
27027
+ * @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
27028
+ * @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
26880
27029
  */
26881
27030
  getQualityCalibrations(calibratorId, opts) {
26882
27031
  opts = opts || {};
@@ -27046,8 +27195,8 @@ class QualityApi {
27046
27195
  * @param {Array.<String>} opts.expand variable name requested by expand list
27047
27196
  * @param {String} opts.nextPage next page token
27048
27197
  * @param {String} opts.previousPage Previous page token
27049
- * @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
27050
- * @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
27198
+ * @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
27199
+ * @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
27051
27200
  * @param {String} opts.name Evaluator name
27052
27201
  * @param {Array.<String>} opts.permission permission strings
27053
27202
  * @param {String} opts.group group id
@@ -28291,7 +28440,7 @@ class RecordingApi {
28291
28440
  /**
28292
28441
  * Recording service.
28293
28442
  * @module purecloud-platform-client-v2/api/RecordingApi
28294
- * @version 94.0.0
28443
+ * @version 97.0.0
28295
28444
  */
28296
28445
 
28297
28446
  /**
@@ -29537,7 +29686,7 @@ class ResponseManagementApi {
29537
29686
  /**
29538
29687
  * ResponseManagement service.
29539
29688
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
29540
- * @version 94.0.0
29689
+ * @version 97.0.0
29541
29690
  */
29542
29691
 
29543
29692
  /**
@@ -29862,7 +30011,7 @@ class RoutingApi {
29862
30011
  /**
29863
30012
  * Routing service.
29864
30013
  * @module purecloud-platform-client-v2/api/RoutingApi
29865
- * @version 94.0.0
30014
+ * @version 97.0.0
29866
30015
  */
29867
30016
 
29868
30017
  /**
@@ -32160,7 +32309,7 @@ class SCIMApi {
32160
32309
  /**
32161
32310
  * SCIM service.
32162
32311
  * @module purecloud-platform-client-v2/api/SCIMApi
32163
- * @version 94.0.0
32312
+ * @version 97.0.0
32164
32313
  */
32165
32314
 
32166
32315
  /**
@@ -32296,8 +32445,8 @@ class SCIMApi {
32296
32445
  *
32297
32446
  * @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
32298
32447
  * @param {Object} opts Optional parameters
32299
- * @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.
32300
- * @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.
32448
+ * @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.
32449
+ * @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.
32301
32450
  * @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.
32302
32451
  */
32303
32452
  getScimGroup(groupId, opts) {
@@ -32327,9 +32476,9 @@ class SCIMApi {
32327
32476
  *
32328
32477
  * @param {Object} opts Optional parameters
32329
32478
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
32330
- * @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)
32331
- * @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.
32332
- * @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.
32479
+ * @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)
32480
+ * @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.
32481
+ * @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.
32333
32482
  * @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;.
32334
32483
  */
32335
32484
  getScimGroups(opts) {
@@ -32473,9 +32622,9 @@ class SCIMApi {
32473
32622
  *
32474
32623
  * @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
32475
32624
  * @param {Object} opts Optional parameters
32476
- * @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.
32477
- * @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.
32478
- * @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.
32625
+ * @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.
32626
+ * @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.
32627
+ * @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.
32479
32628
  */
32480
32629
  getScimUser(userId, opts) {
32481
32630
  opts = opts || {};
@@ -32504,9 +32653,9 @@ class SCIMApi {
32504
32653
  * 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;.
32505
32654
  * @param {Object} opts Optional parameters
32506
32655
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
32507
- * @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)
32508
- * @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.
32509
- * @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.
32656
+ * @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)
32657
+ * @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.
32658
+ * @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.
32510
32659
  * @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;.
32511
32660
  */
32512
32661
  getScimUsers(opts) {
@@ -32532,9 +32681,9 @@ class SCIMApi {
32532
32681
  *
32533
32682
  * @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
32534
32683
  * @param {Object} opts Optional parameters
32535
- * @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.
32536
- * @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.
32537
- * @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.
32684
+ * @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.
32685
+ * @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.
32686
+ * @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.
32538
32687
  */
32539
32688
  getScimV2Group(groupId, opts) {
32540
32689
  opts = opts || {};
@@ -32564,9 +32713,9 @@ class SCIMApi {
32564
32713
  * @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;.
32565
32714
  * @param {Object} opts Optional parameters
32566
32715
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
32567
- * @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)
32568
- * @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.
32569
- * @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.
32716
+ * @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)
32717
+ * @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.
32718
+ * @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.
32570
32719
  */
32571
32720
  getScimV2Groups(filter, opts) {
32572
32721
  opts = opts || {};
@@ -32713,8 +32862,8 @@ class SCIMApi {
32713
32862
  *
32714
32863
  * @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
32715
32864
  * @param {Object} opts Optional parameters
32716
- * @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.
32717
- * @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.
32865
+ * @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.
32866
+ * @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.
32718
32867
  * @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.
32719
32868
  */
32720
32869
  getScimV2User(userId, opts) {
@@ -32744,9 +32893,9 @@ class SCIMApi {
32744
32893
  * 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;.
32745
32894
  * @param {Object} opts Optional parameters
32746
32895
  * @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
32747
- * @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)
32748
- * @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.
32749
- * @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.
32896
+ * @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)
32897
+ * @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.
32898
+ * @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.
32750
32899
  * @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;.
32751
32900
  */
32752
32901
  getScimV2Users(opts) {
@@ -32904,8 +33053,8 @@ class SCIMApi {
32904
33053
  }
32905
33054
 
32906
33055
  /**
32907
- * Creates a group
32908
- * 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.
33056
+ * Create a group
33057
+ * 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.
32909
33058
  * @param {Object} body The information used to create a group.
32910
33059
  */
32911
33060
  postScimGroups(body) {
@@ -32956,7 +33105,7 @@ class SCIMApi {
32956
33105
  /**
32957
33106
  * Create a group
32958
33107
  * 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.
32959
- * @param {Object} body Creates a group.
33108
+ * @param {Object} body The information used to create a group.
32960
33109
  */
32961
33110
  postScimV2Groups(body) {
32962
33111
  // verify the required parameter 'body' is set
@@ -33145,7 +33294,7 @@ class ScriptsApi {
33145
33294
  /**
33146
33295
  * Scripts service.
33147
33296
  * @module purecloud-platform-client-v2/api/ScriptsApi
33148
- * @version 94.0.0
33297
+ * @version 97.0.0
33149
33298
  */
33150
33299
 
33151
33300
  /**
@@ -33498,7 +33647,7 @@ class SearchApi {
33498
33647
  /**
33499
33648
  * Search service.
33500
33649
  * @module purecloud-platform-client-v2/api/SearchApi
33501
- * @version 94.0.0
33650
+ * @version 97.0.0
33502
33651
  */
33503
33652
 
33504
33653
  /**
@@ -34008,7 +34157,7 @@ class SpeechTextAnalyticsApi {
34008
34157
  /**
34009
34158
  * SpeechTextAnalytics service.
34010
34159
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
34011
- * @version 94.0.0
34160
+ * @version 97.0.0
34012
34161
  */
34013
34162
 
34014
34163
  /**
@@ -34084,7 +34233,7 @@ class StationsApi {
34084
34233
  /**
34085
34234
  * Stations service.
34086
34235
  * @module purecloud-platform-client-v2/api/StationsApi
34087
- * @version 94.0.0
34236
+ * @version 97.0.0
34088
34237
  */
34089
34238
 
34090
34239
  /**
@@ -34231,7 +34380,7 @@ class SuggestApi {
34231
34380
  /**
34232
34381
  * Suggest service.
34233
34382
  * @module purecloud-platform-client-v2/api/SuggestApi
34234
- * @version 94.0.0
34383
+ * @version 97.0.0
34235
34384
  */
34236
34385
 
34237
34386
  /**
@@ -34370,7 +34519,7 @@ class TelephonyApi {
34370
34519
  /**
34371
34520
  * Telephony service.
34372
34521
  * @module purecloud-platform-client-v2/api/TelephonyApi
34373
- * @version 94.0.0
34522
+ * @version 97.0.0
34374
34523
  */
34375
34524
 
34376
34525
  /**
@@ -34388,8 +34537,8 @@ class TelephonyApi {
34388
34537
  /**
34389
34538
  * Fetch SIP metadata
34390
34539
  * 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
34391
- * @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
34392
- * @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
34540
+ * @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
34541
+ * @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
34393
34542
  * @param {Object} opts Optional parameters
34394
34543
  * @param {String} opts.callId unique identification of the placed call
34395
34544
  * @param {String} opts.toUser User to who the call was placed
@@ -34478,7 +34627,7 @@ class TelephonyProvidersEdgeApi {
34478
34627
  /**
34479
34628
  * TelephonyProvidersEdge service.
34480
34629
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
34481
- * @version 94.0.0
34630
+ * @version 97.0.0
34482
34631
  */
34483
34632
 
34484
34633
  /**
@@ -38055,7 +38204,7 @@ class TextbotsApi {
38055
38204
  /**
38056
38205
  * Textbots service.
38057
38206
  * @module purecloud-platform-client-v2/api/TextbotsApi
38058
- * @version 94.0.0
38207
+ * @version 97.0.0
38059
38208
  */
38060
38209
 
38061
38210
  /**
@@ -38101,7 +38250,7 @@ class TokensApi {
38101
38250
  /**
38102
38251
  * Tokens service.
38103
38252
  * @module purecloud-platform-client-v2/api/TokensApi
38104
- * @version 94.0.0
38253
+ * @version 97.0.0
38105
38254
  */
38106
38255
 
38107
38256
  /**
@@ -38187,7 +38336,7 @@ class UploadsApi {
38187
38336
  /**
38188
38337
  * Uploads service.
38189
38338
  * @module purecloud-platform-client-v2/api/UploadsApi
38190
- * @version 94.0.0
38339
+ * @version 97.0.0
38191
38340
  */
38192
38341
 
38193
38342
  /**
@@ -38233,7 +38382,7 @@ class UsageApi {
38233
38382
  /**
38234
38383
  * Usage service.
38235
38384
  * @module purecloud-platform-client-v2/api/UsageApi
38236
- * @version 94.0.0
38385
+ * @version 97.0.0
38237
38386
  */
38238
38387
 
38239
38388
  /**
@@ -38300,154 +38449,11 @@ class UsageApi {
38300
38449
 
38301
38450
  }
38302
38451
 
38303
- class UserDevelopmentApi {
38304
- /**
38305
- * UserDevelopment service.
38306
- * @module purecloud-platform-client-v2/api/UserDevelopmentApi
38307
- * @version 94.0.0
38308
- */
38309
-
38310
- /**
38311
- * Constructs a new UserDevelopmentApi.
38312
- * @alias module:purecloud-platform-client-v2/api/UserDevelopmentApi
38313
- * @class
38314
- * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
38315
- * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
38316
- */
38317
- constructor(apiClient) {
38318
- this.apiClient = apiClient || ApiClient.instance;
38319
- }
38320
-
38321
-
38322
- /**
38323
- * Get list of Development Activities
38324
- * Either moduleId or userId is required. Results are filtered based on the applicable permissions.
38325
- * @param {Object} opts Optional parameters
38326
- * @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.
38327
- * @param {String} opts.moduleId Specifies the ID of the learning module.
38328
- * @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
38329
- * @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
38330
- * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
38331
- * @param {Number} opts.pageSize Page size (default to 25)
38332
- * @param {Number} opts.pageNumber Page number (default to 1)
38333
- * @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)
38334
- * @param {Array.<String>} opts.types Specifies the activity types.
38335
- * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
38336
- * @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.
38337
- */
38338
- getUsersDevelopmentActivities(opts) {
38339
- opts = opts || {};
38340
-
38341
-
38342
- return this.apiClient.callApi(
38343
- '/api/v2/users/development/activities',
38344
- 'GET',
38345
- { },
38346
- { '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') },
38347
- { },
38348
- { },
38349
- null,
38350
- ['PureCloud OAuth'],
38351
- ['application/json'],
38352
- ['application/json']
38353
- );
38354
- }
38355
-
38356
- /**
38357
- * Get list of Development Activities for current user
38358
- * Results are filtered based on the applicable permissions.
38359
- * @param {Object} opts Optional parameters
38360
- * @param {String} opts.moduleId Specifies the ID of the learning module.
38361
- * @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
38362
- * @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
38363
- * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
38364
- * @param {Number} opts.pageSize Page size (default to 25)
38365
- * @param {Number} opts.pageNumber Page number (default to 1)
38366
- * @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)
38367
- * @param {Array.<String>} opts.types Specifies the activity types.
38368
- * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
38369
- * @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.
38370
- */
38371
- getUsersDevelopmentActivitiesMe(opts) {
38372
- opts = opts || {};
38373
-
38374
-
38375
- return this.apiClient.callApi(
38376
- '/api/v2/users/development/activities/me',
38377
- 'GET',
38378
- { },
38379
- { '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') },
38380
- { },
38381
- { },
38382
- null,
38383
- ['PureCloud OAuth'],
38384
- ['application/json'],
38385
- ['application/json']
38386
- );
38387
- }
38388
-
38389
- /**
38390
- * Get a Development Activity
38391
- *
38392
- * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
38393
- * @param {Object} type Specifies the activity type.
38394
- */
38395
- getUsersDevelopmentActivity(activityId, type) {
38396
- // verify the required parameter 'activityId' is set
38397
- if (activityId === undefined || activityId === null) {
38398
- throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
38399
- }
38400
- // verify the required parameter 'type' is set
38401
- if (type === undefined || type === null) {
38402
- throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
38403
- }
38404
-
38405
- return this.apiClient.callApi(
38406
- '/api/v2/users/development/activities/{activityId}',
38407
- 'GET',
38408
- { 'activityId': activityId },
38409
- { 'type': type },
38410
- { },
38411
- { },
38412
- null,
38413
- ['PureCloud OAuth'],
38414
- ['application/json'],
38415
- ['application/json']
38416
- );
38417
- }
38418
-
38419
- /**
38420
- * Retrieve aggregated development activity data
38421
- * Results are filtered based on the applicable permissions.
38422
- * @param {Object} body Aggregate Request
38423
- */
38424
- postUsersDevelopmentActivitiesAggregatesQuery(body) {
38425
- // verify the required parameter 'body' is set
38426
- if (body === undefined || body === null) {
38427
- throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
38428
- }
38429
-
38430
- return this.apiClient.callApi(
38431
- '/api/v2/users/development/activities/aggregates/query',
38432
- 'POST',
38433
- { },
38434
- { },
38435
- { },
38436
- { },
38437
- body,
38438
- ['PureCloud OAuth'],
38439
- ['application/json'],
38440
- ['application/json']
38441
- );
38442
- }
38443
-
38444
- }
38445
-
38446
38452
  class UserRecordingsApi {
38447
38453
  /**
38448
38454
  * UserRecordings service.
38449
38455
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
38450
- * @version 94.0.0
38456
+ * @version 97.0.0
38451
38457
  */
38452
38458
 
38453
38459
  /**
@@ -38631,7 +38637,7 @@ class UsersApi {
38631
38637
  /**
38632
38638
  * Users service.
38633
38639
  * @module purecloud-platform-client-v2/api/UsersApi
38634
- * @version 94.0.0
38640
+ * @version 97.0.0
38635
38641
  */
38636
38642
 
38637
38643
  /**
@@ -39675,6 +39681,103 @@ class UsersApi {
39675
39681
  );
39676
39682
  }
39677
39683
 
39684
+ /**
39685
+ * Get list of Development Activities
39686
+ * Either moduleId or userId is required. Results are filtered based on the applicable permissions.
39687
+ * @param {Object} opts Optional parameters
39688
+ * @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.
39689
+ * @param {String} opts.moduleId Specifies the ID of the learning module.
39690
+ * @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
39691
+ * @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
39692
+ * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
39693
+ * @param {Number} opts.pageSize Page size (default to 25)
39694
+ * @param {Number} opts.pageNumber Page number (default to 1)
39695
+ * @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)
39696
+ * @param {Array.<String>} opts.types Specifies the activity types.
39697
+ * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
39698
+ * @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.
39699
+ */
39700
+ getUsersDevelopmentActivities(opts) {
39701
+ opts = opts || {};
39702
+
39703
+
39704
+ return this.apiClient.callApi(
39705
+ '/api/v2/users/development/activities',
39706
+ 'GET',
39707
+ { },
39708
+ { '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') },
39709
+ { },
39710
+ { },
39711
+ null,
39712
+ ['PureCloud OAuth'],
39713
+ ['application/json'],
39714
+ ['application/json']
39715
+ );
39716
+ }
39717
+
39718
+ /**
39719
+ * Get list of Development Activities for current user
39720
+ * Results are filtered based on the applicable permissions.
39721
+ * @param {Object} opts Optional parameters
39722
+ * @param {String} opts.moduleId Specifies the ID of the learning module.
39723
+ * @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
39724
+ * @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
39725
+ * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
39726
+ * @param {Number} opts.pageSize Page size (default to 25)
39727
+ * @param {Number} opts.pageNumber Page number (default to 1)
39728
+ * @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)
39729
+ * @param {Array.<String>} opts.types Specifies the activity types.
39730
+ * @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
39731
+ * @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.
39732
+ */
39733
+ getUsersDevelopmentActivitiesMe(opts) {
39734
+ opts = opts || {};
39735
+
39736
+
39737
+ return this.apiClient.callApi(
39738
+ '/api/v2/users/development/activities/me',
39739
+ 'GET',
39740
+ { },
39741
+ { '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') },
39742
+ { },
39743
+ { },
39744
+ null,
39745
+ ['PureCloud OAuth'],
39746
+ ['application/json'],
39747
+ ['application/json']
39748
+ );
39749
+ }
39750
+
39751
+ /**
39752
+ * Get a Development Activity
39753
+ *
39754
+ * @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
39755
+ * @param {Object} type Specifies the activity type.
39756
+ */
39757
+ getUsersDevelopmentActivity(activityId, type) {
39758
+ // verify the required parameter 'activityId' is set
39759
+ if (activityId === undefined || activityId === null) {
39760
+ throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
39761
+ }
39762
+ // verify the required parameter 'type' is set
39763
+ if (type === undefined || type === null) {
39764
+ throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
39765
+ }
39766
+
39767
+ return this.apiClient.callApi(
39768
+ '/api/v2/users/development/activities/{activityId}',
39769
+ 'GET',
39770
+ { 'activityId': activityId },
39771
+ { 'type': type },
39772
+ { },
39773
+ { },
39774
+ null,
39775
+ ['PureCloud OAuth'],
39776
+ ['application/json'],
39777
+ ['application/json']
39778
+ );
39779
+ }
39780
+
39678
39781
  /**
39679
39782
  * Get current user details.
39680
39783
  * This request is not valid when using the Client Credentials OAuth grant.
@@ -40361,6 +40464,31 @@ class UsersApi {
40361
40464
  );
40362
40465
  }
40363
40466
 
40467
+ /**
40468
+ * Retrieve aggregated development activity data
40469
+ * Results are filtered based on the applicable permissions.
40470
+ * @param {Object} body Aggregate Request
40471
+ */
40472
+ postUsersDevelopmentActivitiesAggregatesQuery(body) {
40473
+ // verify the required parameter 'body' is set
40474
+ if (body === undefined || body === null) {
40475
+ throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
40476
+ }
40477
+
40478
+ return this.apiClient.callApi(
40479
+ '/api/v2/users/development/activities/aggregates/query',
40480
+ 'POST',
40481
+ { },
40482
+ { },
40483
+ { },
40484
+ { },
40485
+ body,
40486
+ ['PureCloud OAuth'],
40487
+ ['application/json'],
40488
+ ['application/json']
40489
+ );
40490
+ }
40491
+
40364
40492
  /**
40365
40493
  * Change your password
40366
40494
  *
@@ -40722,7 +40850,7 @@ class UtilitiesApi {
40722
40850
  /**
40723
40851
  * Utilities service.
40724
40852
  * @module purecloud-platform-client-v2/api/UtilitiesApi
40725
- * @version 94.0.0
40853
+ * @version 97.0.0
40726
40854
  */
40727
40855
 
40728
40856
  /**
@@ -40833,7 +40961,7 @@ class VoicemailApi {
40833
40961
  /**
40834
40962
  * Voicemail service.
40835
40963
  * @module purecloud-platform-client-v2/api/VoicemailApi
40836
- * @version 94.0.0
40964
+ * @version 97.0.0
40837
40965
  */
40838
40966
 
40839
40967
  /**
@@ -41470,7 +41598,7 @@ class WebChatApi {
41470
41598
  /**
41471
41599
  * WebChat service.
41472
41600
  * @module purecloud-platform-client-v2/api/WebChatApi
41473
- * @version 94.0.0
41601
+ * @version 97.0.0
41474
41602
  */
41475
41603
 
41476
41604
  /**
@@ -42014,7 +42142,7 @@ class WidgetsApi {
42014
42142
  /**
42015
42143
  * Widgets service.
42016
42144
  * @module purecloud-platform-client-v2/api/WidgetsApi
42017
- * @version 94.0.0
42145
+ * @version 97.0.0
42018
42146
  */
42019
42147
 
42020
42148
  /**
@@ -42160,7 +42288,7 @@ class WorkforceManagementApi {
42160
42288
  /**
42161
42289
  * WorkforceManagement service.
42162
42290
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
42163
- * @version 94.0.0
42291
+ * @version 97.0.0
42164
42292
  */
42165
42293
 
42166
42294
  /**
@@ -42415,166 +42543,6 @@ class WorkforceManagementApi {
42415
42543
  );
42416
42544
  }
42417
42545
 
42418
- /**
42419
- * Deprecated/Gone: Use the new business unit activity code resources
42420
- *
42421
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42422
- * @param {String} acId The ID of the activity code to delete
42423
- */
42424
- deleteWorkforcemanagementManagementunitActivitycode(muId, acId) {
42425
- // verify the required parameter 'muId' is set
42426
- if (muId === undefined || muId === null) {
42427
- throw 'Missing the required parameter "muId" when calling deleteWorkforcemanagementManagementunitActivitycode';
42428
- }
42429
- // verify the required parameter 'acId' is set
42430
- if (acId === undefined || acId === null) {
42431
- throw 'Missing the required parameter "acId" when calling deleteWorkforcemanagementManagementunitActivitycode';
42432
- }
42433
-
42434
- return this.apiClient.callApi(
42435
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
42436
- 'DELETE',
42437
- { 'muId': muId,'acId': acId },
42438
- { },
42439
- { },
42440
- { },
42441
- null,
42442
- ['PureCloud OAuth'],
42443
- ['application/json'],
42444
- ['application/json']
42445
- );
42446
- }
42447
-
42448
- /**
42449
- * Gone. Scheduling has moved under business units
42450
- *
42451
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
42452
- * @param {String} runId The ID of the schedule run
42453
- */
42454
- deleteWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
42455
- // verify the required parameter 'managementUnitId' is set
42456
- if (managementUnitId === undefined || managementUnitId === null) {
42457
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
42458
- }
42459
- // verify the required parameter 'runId' is set
42460
- if (runId === undefined || runId === null) {
42461
- throw 'Missing the required parameter "runId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
42462
- }
42463
-
42464
- return this.apiClient.callApi(
42465
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
42466
- 'DELETE',
42467
- { 'managementUnitId': managementUnitId,'runId': runId },
42468
- { },
42469
- { },
42470
- { },
42471
- null,
42472
- ['PureCloud OAuth'],
42473
- ['application/json'],
42474
- ['application/json']
42475
- );
42476
- }
42477
-
42478
- /**
42479
- * Gone. Replaced with service goal templates and planning groups under business units
42480
- *
42481
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42482
- * @param {String} serviceGoalGroupId Gone. The ID of the service goal group to delete
42483
- */
42484
- deleteWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
42485
- // verify the required parameter 'managementUnitId' is set
42486
- if (managementUnitId === undefined || managementUnitId === null) {
42487
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
42488
- }
42489
- // verify the required parameter 'serviceGoalGroupId' is set
42490
- if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
42491
- throw 'Missing the required parameter "serviceGoalGroupId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
42492
- }
42493
-
42494
- return this.apiClient.callApi(
42495
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
42496
- 'DELETE',
42497
- { 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
42498
- { },
42499
- { },
42500
- { },
42501
- null,
42502
- ['PureCloud OAuth'],
42503
- ['application/json'],
42504
- ['application/json']
42505
- );
42506
- }
42507
-
42508
- /**
42509
- * Gone. Scheduling has moved under business units
42510
- *
42511
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42512
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
42513
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to delete
42514
- */
42515
- deleteWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
42516
- // verify the required parameter 'managementUnitId' is set
42517
- if (managementUnitId === undefined || managementUnitId === null) {
42518
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
42519
- }
42520
- // verify the required parameter 'weekId' is set
42521
- if (weekId === undefined || weekId === null) {
42522
- throw 'Missing the required parameter "weekId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
42523
- }
42524
- // verify the required parameter 'scheduleId' is set
42525
- if (scheduleId === undefined || scheduleId === null) {
42526
- throw 'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
42527
- }
42528
-
42529
- return this.apiClient.callApi(
42530
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
42531
- 'DELETE',
42532
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
42533
- { },
42534
- { },
42535
- { },
42536
- null,
42537
- ['PureCloud OAuth'],
42538
- ['application/json'],
42539
- ['application/json']
42540
- );
42541
- }
42542
-
42543
- /**
42544
- * Gone. Use equivalent business unit resource instead
42545
- *
42546
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
42547
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
42548
- * @param {String} forecastId (Gone/Deprecated): The ID of the forecast
42549
- */
42550
- deleteWorkforcemanagementManagementunitWeekShorttermforecast(managementUnitId, weekDateId, forecastId) {
42551
- // verify the required parameter 'managementUnitId' is set
42552
- if (managementUnitId === undefined || managementUnitId === null) {
42553
- throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
42554
- }
42555
- // verify the required parameter 'weekDateId' is set
42556
- if (weekDateId === undefined || weekDateId === null) {
42557
- throw 'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
42558
- }
42559
- // verify the required parameter 'forecastId' is set
42560
- if (forecastId === undefined || forecastId === null) {
42561
- throw 'Missing the required parameter "forecastId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
42562
- }
42563
-
42564
- return this.apiClient.callApi(
42565
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}',
42566
- 'DELETE',
42567
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
42568
- { },
42569
- { },
42570
- { },
42571
- null,
42572
- ['PureCloud OAuth'],
42573
- ['application/json'],
42574
- ['application/json']
42575
- );
42576
- }
42577
-
42578
42546
  /**
42579
42547
  * Delete a work plan
42580
42548
  *
@@ -42605,6 +42573,36 @@ class WorkforceManagementApi {
42605
42573
  );
42606
42574
  }
42607
42575
 
42576
+ /**
42577
+ * Delete a work plan rotation
42578
+ *
42579
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
42580
+ * @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
42581
+ */
42582
+ deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
42583
+ // verify the required parameter 'managementUnitId' is set
42584
+ if (managementUnitId === undefined || managementUnitId === null) {
42585
+ throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
42586
+ }
42587
+ // verify the required parameter 'workPlanRotationId' is set
42588
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
42589
+ throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
42590
+ }
42591
+
42592
+ return this.apiClient.callApi(
42593
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
42594
+ 'DELETE',
42595
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
42596
+ { },
42597
+ { },
42598
+ { },
42599
+ null,
42600
+ ['PureCloud OAuth'],
42601
+ ['application/json'],
42602
+ ['application/json']
42603
+ );
42604
+ }
42605
+
42608
42606
  /**
42609
42607
  * Get a list of UserScheduleAdherence records for the requested users
42610
42608
  *
@@ -43409,36 +43407,6 @@ class WorkforceManagementApi {
43409
43407
  );
43410
43408
  }
43411
43409
 
43412
- /**
43413
- * Get an activity code
43414
- *
43415
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43416
- * @param {String} acId The ID of the activity code to fetch
43417
- */
43418
- getWorkforcemanagementManagementunitActivitycode(muId, acId) {
43419
- // verify the required parameter 'muId' is set
43420
- if (muId === undefined || muId === null) {
43421
- throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitActivitycode';
43422
- }
43423
- // verify the required parameter 'acId' is set
43424
- if (acId === undefined || acId === null) {
43425
- throw 'Missing the required parameter "acId" when calling getWorkforcemanagementManagementunitActivitycode';
43426
- }
43427
-
43428
- return this.apiClient.callApi(
43429
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
43430
- 'GET',
43431
- { 'muId': muId,'acId': acId },
43432
- { },
43433
- { },
43434
- { },
43435
- null,
43436
- ['PureCloud OAuth'],
43437
- ['application/json'],
43438
- ['application/json']
43439
- );
43440
- }
43441
-
43442
43410
  /**
43443
43411
  * Get activity codes
43444
43412
  *
@@ -43557,196 +43525,6 @@ class WorkforceManagementApi {
43557
43525
  );
43558
43526
  }
43559
43527
 
43560
- /**
43561
- * Gone. Moved under business units
43562
- *
43563
- * @param {String} muId The management unit ID of the management unit
43564
- */
43565
- getWorkforcemanagementManagementunitIntradayQueues(muId) {
43566
- // verify the required parameter 'muId' is set
43567
- if (muId === undefined || muId === null) {
43568
- throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitIntradayQueues';
43569
- }
43570
-
43571
- return this.apiClient.callApi(
43572
- '/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues',
43573
- 'GET',
43574
- { 'muId': muId },
43575
- { },
43576
- { },
43577
- { },
43578
- null,
43579
- ['PureCloud OAuth'],
43580
- ['application/json'],
43581
- ['application/json']
43582
- );
43583
- }
43584
-
43585
- /**
43586
- * Gone. Scheduling has moved under business units
43587
- *
43588
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
43589
- * @param {String} runId The ID of the schedule run
43590
- */
43591
- getWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
43592
- // verify the required parameter 'managementUnitId' is set
43593
- if (managementUnitId === undefined || managementUnitId === null) {
43594
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRun';
43595
- }
43596
- // verify the required parameter 'runId' is set
43597
- if (runId === undefined || runId === null) {
43598
- throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRun';
43599
- }
43600
-
43601
- return this.apiClient.callApi(
43602
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
43603
- 'GET',
43604
- { 'managementUnitId': managementUnitId,'runId': runId },
43605
- { },
43606
- { },
43607
- { },
43608
- null,
43609
- ['PureCloud OAuth'],
43610
- ['application/json'],
43611
- ['application/json']
43612
- );
43613
- }
43614
-
43615
- /**
43616
- * Gone. Scheduling has moved under business units
43617
- *
43618
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
43619
- * @param {String} runId The ID of the schedule run
43620
- */
43621
- getWorkforcemanagementManagementunitSchedulingRunResult(managementUnitId, runId) {
43622
- // verify the required parameter 'managementUnitId' is set
43623
- if (managementUnitId === undefined || managementUnitId === null) {
43624
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
43625
- }
43626
- // verify the required parameter 'runId' is set
43627
- if (runId === undefined || runId === null) {
43628
- throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
43629
- }
43630
-
43631
- return this.apiClient.callApi(
43632
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result',
43633
- 'GET',
43634
- { 'managementUnitId': managementUnitId,'runId': runId },
43635
- { },
43636
- { },
43637
- { },
43638
- null,
43639
- ['PureCloud OAuth'],
43640
- ['application/json'],
43641
- ['application/json']
43642
- );
43643
- }
43644
-
43645
- /**
43646
- * Gone. Scheduling has moved under business units
43647
- *
43648
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
43649
- */
43650
- getWorkforcemanagementManagementunitSchedulingRuns(managementUnitId) {
43651
- // verify the required parameter 'managementUnitId' is set
43652
- if (managementUnitId === undefined || managementUnitId === null) {
43653
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRuns';
43654
- }
43655
-
43656
- return this.apiClient.callApi(
43657
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs',
43658
- 'GET',
43659
- { 'managementUnitId': managementUnitId },
43660
- { },
43661
- { },
43662
- { },
43663
- null,
43664
- ['PureCloud OAuth'],
43665
- ['application/json'],
43666
- ['application/json']
43667
- );
43668
- }
43669
-
43670
- /**
43671
- * Gone. Replaced with service goal templates and planning groups under business units
43672
- *
43673
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43674
- * @param {String} serviceGoalGroupId Gone. The ID of the service goal group to fetch
43675
- */
43676
- getWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
43677
- // verify the required parameter 'managementUnitId' is set
43678
- if (managementUnitId === undefined || managementUnitId === null) {
43679
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
43680
- }
43681
- // verify the required parameter 'serviceGoalGroupId' is set
43682
- if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
43683
- throw 'Missing the required parameter "serviceGoalGroupId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
43684
- }
43685
-
43686
- return this.apiClient.callApi(
43687
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
43688
- 'GET',
43689
- { 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
43690
- { },
43691
- { },
43692
- { },
43693
- null,
43694
- ['PureCloud OAuth'],
43695
- ['application/json'],
43696
- ['application/json']
43697
- );
43698
- }
43699
-
43700
- /**
43701
- * Gone. Replaced with service goal templates and planning groups under business units
43702
- *
43703
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43704
- */
43705
- getWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
43706
- // verify the required parameter 'managementUnitId' is set
43707
- if (managementUnitId === undefined || managementUnitId === null) {
43708
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroups';
43709
- }
43710
-
43711
- return this.apiClient.callApi(
43712
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
43713
- 'GET',
43714
- { 'managementUnitId': managementUnitId },
43715
- { },
43716
- { },
43717
- { },
43718
- null,
43719
- ['PureCloud OAuth'],
43720
- ['application/json'],
43721
- ['application/json']
43722
- );
43723
- }
43724
-
43725
- /**
43726
- * Gone. Get management unit settings via expand parameters on the GET management unit
43727
- *
43728
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43729
- */
43730
- getWorkforcemanagementManagementunitSettings(muId) {
43731
- // verify the required parameter 'muId' is set
43732
- if (muId === undefined || muId === null) {
43733
- throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitSettings';
43734
- }
43735
-
43736
- return this.apiClient.callApi(
43737
- '/api/v2/workforcemanagement/managementunits/{muId}/settings',
43738
- 'GET',
43739
- { 'muId': muId },
43740
- { },
43741
- { },
43742
- { },
43743
- null,
43744
- ['PureCloud OAuth'],
43745
- ['application/json'],
43746
- ['application/json']
43747
- );
43748
- }
43749
-
43750
43528
  /**
43751
43529
  * Gets a summary of all shift trades in the matched state
43752
43530
  *
@@ -43931,41 +43709,6 @@ class WorkforceManagementApi {
43931
43709
  );
43932
43710
  }
43933
43711
 
43934
- /**
43935
- * Gone. Scheduling has moved under business units
43936
- *
43937
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43938
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
43939
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to fetch generation results
43940
- */
43941
- getWorkforcemanagementManagementunitWeekScheduleGenerationresults(managementUnitId, weekId, scheduleId) {
43942
- // verify the required parameter 'managementUnitId' is set
43943
- if (managementUnitId === undefined || managementUnitId === null) {
43944
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
43945
- }
43946
- // verify the required parameter 'weekId' is set
43947
- if (weekId === undefined || weekId === null) {
43948
- throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
43949
- }
43950
- // verify the required parameter 'scheduleId' is set
43951
- if (scheduleId === undefined || scheduleId === null) {
43952
- throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
43953
- }
43954
-
43955
- return this.apiClient.callApi(
43956
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults',
43957
- 'GET',
43958
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
43959
- { },
43960
- { },
43961
- { },
43962
- null,
43963
- ['PureCloud OAuth'],
43964
- ['application/json'],
43965
- ['application/json']
43966
- );
43967
- }
43968
-
43969
43712
  /**
43970
43713
  * Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
43971
43714
  *
@@ -44036,71 +43779,6 @@ class WorkforceManagementApi {
44036
43779
  );
44037
43780
  }
44038
43781
 
44039
- /**
44040
- * Gone. Use equivalent business unit resource instead
44041
- *
44042
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
44043
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
44044
- * @param {String} forecastId (Gone/Deprecated): The ID of the forecast
44045
- */
44046
- getWorkforcemanagementManagementunitWeekShorttermforecastFinal(managementUnitId, weekDateId, forecastId) {
44047
- // verify the required parameter 'managementUnitId' is set
44048
- if (managementUnitId === undefined || managementUnitId === null) {
44049
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
44050
- }
44051
- // verify the required parameter 'weekDateId' is set
44052
- if (weekDateId === undefined || weekDateId === null) {
44053
- throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
44054
- }
44055
- // verify the required parameter 'forecastId' is set
44056
- if (forecastId === undefined || forecastId === null) {
44057
- throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
44058
- }
44059
-
44060
- return this.apiClient.callApi(
44061
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final',
44062
- 'GET',
44063
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
44064
- { },
44065
- { },
44066
- { },
44067
- null,
44068
- ['PureCloud OAuth'],
44069
- ['application/json'],
44070
- ['application/json']
44071
- );
44072
- }
44073
-
44074
- /**
44075
- * Gone. Use equivalent business unit resource instead
44076
- *
44077
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
44078
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
44079
- */
44080
- getWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
44081
- // verify the required parameter 'managementUnitId' is set
44082
- if (managementUnitId === undefined || managementUnitId === null) {
44083
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
44084
- }
44085
- // verify the required parameter 'weekDateId' is set
44086
- if (weekDateId === undefined || weekDateId === null) {
44087
- throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
44088
- }
44089
-
44090
- return this.apiClient.callApi(
44091
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
44092
- 'GET',
44093
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
44094
- { },
44095
- { },
44096
- { },
44097
- null,
44098
- ['PureCloud OAuth'],
44099
- ['application/json'],
44100
- ['application/json']
44101
- );
44102
- }
44103
-
44104
43782
  /**
44105
43783
  * Get a work plan
44106
43784
  *
@@ -44131,6 +43809,65 @@ class WorkforceManagementApi {
44131
43809
  );
44132
43810
  }
44133
43811
 
43812
+ /**
43813
+ * Get a work plan rotation
43814
+ *
43815
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43816
+ * @param {String} workPlanRotationId The ID of the work plan rotation to fetch
43817
+ */
43818
+ getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
43819
+ // verify the required parameter 'managementUnitId' is set
43820
+ if (managementUnitId === undefined || managementUnitId === null) {
43821
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
43822
+ }
43823
+ // verify the required parameter 'workPlanRotationId' is set
43824
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
43825
+ throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
43826
+ }
43827
+
43828
+ return this.apiClient.callApi(
43829
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
43830
+ 'GET',
43831
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
43832
+ { },
43833
+ { },
43834
+ { },
43835
+ null,
43836
+ ['PureCloud OAuth'],
43837
+ ['application/json'],
43838
+ ['application/json']
43839
+ );
43840
+ }
43841
+
43842
+ /**
43843
+ * Get work plan rotations
43844
+ *
43845
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
43846
+ * @param {Object} opts Optional parameters
43847
+ * @param {Array.<String>} opts.expand
43848
+ */
43849
+ getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
43850
+ opts = opts || {};
43851
+
43852
+ // verify the required parameter 'managementUnitId' is set
43853
+ if (managementUnitId === undefined || managementUnitId === null) {
43854
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
43855
+ }
43856
+
43857
+ return this.apiClient.callApi(
43858
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
43859
+ 'GET',
43860
+ { 'managementUnitId': managementUnitId },
43861
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
43862
+ { },
43863
+ { },
43864
+ null,
43865
+ ['PureCloud OAuth'],
43866
+ ['application/json'],
43867
+ ['application/json']
43868
+ );
43869
+ }
43870
+
44134
43871
  /**
44135
43872
  * Get work plans
44136
43873
  *
@@ -44520,129 +44257,6 @@ class WorkforceManagementApi {
44520
44257
  );
44521
44258
  }
44522
44259
 
44523
- /**
44524
- * Deprecated/Gone: Use the new business unit activity code resources
44525
- *
44526
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
44527
- * @param {String} acId The ID of the activity code to update
44528
- * @param {Object} opts Optional parameters
44529
- * @param {Object} opts.body body
44530
- */
44531
- patchWorkforcemanagementManagementunitActivitycode(muId, acId, opts) {
44532
- opts = opts || {};
44533
-
44534
- // verify the required parameter 'muId' is set
44535
- if (muId === undefined || muId === null) {
44536
- throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitActivitycode';
44537
- }
44538
- // verify the required parameter 'acId' is set
44539
- if (acId === undefined || acId === null) {
44540
- throw 'Missing the required parameter "acId" when calling patchWorkforcemanagementManagementunitActivitycode';
44541
- }
44542
-
44543
- return this.apiClient.callApi(
44544
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
44545
- 'PATCH',
44546
- { 'muId': muId,'acId': acId },
44547
- { },
44548
- { },
44549
- { },
44550
- opts['body'],
44551
- ['PureCloud OAuth'],
44552
- ['application/json'],
44553
- ['application/json']
44554
- );
44555
- }
44556
-
44557
- /**
44558
- * Gone. Scheduling has moved under business units
44559
- *
44560
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
44561
- * @param {String} runId The ID of the schedule run
44562
- * @param {Object} opts Optional parameters
44563
- * @param {Object} opts.body body
44564
- */
44565
- patchWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId, opts) {
44566
- opts = opts || {};
44567
-
44568
- // verify the required parameter 'managementUnitId' is set
44569
- if (managementUnitId === undefined || managementUnitId === null) {
44570
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
44571
- }
44572
- // verify the required parameter 'runId' is set
44573
- if (runId === undefined || runId === null) {
44574
- throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
44575
- }
44576
-
44577
- return this.apiClient.callApi(
44578
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
44579
- 'PATCH',
44580
- { 'managementUnitId': managementUnitId,'runId': runId },
44581
- { },
44582
- { },
44583
- { },
44584
- opts['body'],
44585
- ['PureCloud OAuth'],
44586
- ['application/json'],
44587
- ['application/json']
44588
- );
44589
- }
44590
-
44591
- /**
44592
- * Gone. Replaced with service goal templates and planning groups under business units
44593
- *
44594
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
44595
- * @param {String} serviceGoalGroupId Gone. The ID of the service goal group to update
44596
- */
44597
- patchWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
44598
- // verify the required parameter 'managementUnitId' is set
44599
- if (managementUnitId === undefined || managementUnitId === null) {
44600
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
44601
- }
44602
- // verify the required parameter 'serviceGoalGroupId' is set
44603
- if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
44604
- throw 'Missing the required parameter "serviceGoalGroupId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
44605
- }
44606
-
44607
- return this.apiClient.callApi(
44608
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
44609
- 'PATCH',
44610
- { 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
44611
- { },
44612
- { },
44613
- { },
44614
- null,
44615
- ['PureCloud OAuth'],
44616
- ['application/json'],
44617
- ['application/json']
44618
- );
44619
- }
44620
-
44621
- /**
44622
- * Gone. Update settings by PATCHing the management unit
44623
- *
44624
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
44625
- */
44626
- patchWorkforcemanagementManagementunitSettings(muId) {
44627
- // verify the required parameter 'muId' is set
44628
- if (muId === undefined || muId === null) {
44629
- throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitSettings';
44630
- }
44631
-
44632
- return this.apiClient.callApi(
44633
- '/api/v2/workforcemanagement/managementunits/{muId}/settings',
44634
- 'PATCH',
44635
- { 'muId': muId },
44636
- { },
44637
- { },
44638
- { },
44639
- null,
44640
- ['PureCloud OAuth'],
44641
- ['application/json'],
44642
- ['application/json']
44643
- );
44644
- }
44645
-
44646
44260
  /**
44647
44261
  * Update a time off request
44648
44262
  *
@@ -44682,41 +44296,6 @@ class WorkforceManagementApi {
44682
44296
  );
44683
44297
  }
44684
44298
 
44685
- /**
44686
- * Gone. Scheduling has moved under business units
44687
- *
44688
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
44689
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
44690
- * @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
44691
- */
44692
- patchWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
44693
- // verify the required parameter 'managementUnitId' is set
44694
- if (managementUnitId === undefined || managementUnitId === null) {
44695
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
44696
- }
44697
- // verify the required parameter 'weekId' is set
44698
- if (weekId === undefined || weekId === null) {
44699
- throw 'Missing the required parameter "weekId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
44700
- }
44701
- // verify the required parameter 'scheduleId' is set
44702
- if (scheduleId === undefined || scheduleId === null) {
44703
- throw 'Missing the required parameter "scheduleId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
44704
- }
44705
-
44706
- return this.apiClient.callApi(
44707
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
44708
- 'PATCH',
44709
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
44710
- { },
44711
- { },
44712
- { },
44713
- null,
44714
- ['PureCloud OAuth'],
44715
- ['application/json'],
44716
- ['application/json']
44717
- );
44718
- }
44719
-
44720
44299
  /**
44721
44300
  * Updates a shift trade. This route can only be called by the initiating agent
44722
44301
  *
@@ -44791,6 +44370,40 @@ class WorkforceManagementApi {
44791
44370
  );
44792
44371
  }
44793
44372
 
44373
+ /**
44374
+ * Update a work plan rotation
44375
+ *
44376
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
44377
+ * @param {String} workPlanRotationId The ID of the work plan rotation to update
44378
+ * @param {Object} opts Optional parameters
44379
+ * @param {Object} opts.body body
44380
+ */
44381
+ patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
44382
+ opts = opts || {};
44383
+
44384
+ // verify the required parameter 'managementUnitId' is set
44385
+ if (managementUnitId === undefined || managementUnitId === null) {
44386
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
44387
+ }
44388
+ // verify the required parameter 'workPlanRotationId' is set
44389
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
44390
+ throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
44391
+ }
44392
+
44393
+ return this.apiClient.callApi(
44394
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
44395
+ 'PATCH',
44396
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
44397
+ { },
44398
+ { },
44399
+ { },
44400
+ opts['body'],
44401
+ ['PureCloud OAuth'],
44402
+ ['application/json'],
44403
+ ['application/json']
44404
+ );
44405
+ }
44406
+
44794
44407
  /**
44795
44408
  * Update a time off request for the current user
44796
44409
  *
@@ -45318,31 +44931,6 @@ class WorkforceManagementApi {
45318
44931
  );
45319
44932
  }
45320
44933
 
45321
- /**
45322
- * Deprecated/Gone: Use the new business unit activity code resources
45323
- *
45324
- * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45325
- */
45326
- postWorkforcemanagementManagementunitActivitycodes(muId) {
45327
- // verify the required parameter 'muId' is set
45328
- if (muId === undefined || muId === null) {
45329
- throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitActivitycodes';
45330
- }
45331
-
45332
- return this.apiClient.callApi(
45333
- '/api/v2/workforcemanagement/managementunits/{muId}/activitycodes',
45334
- 'POST',
45335
- { 'muId': muId },
45336
- { },
45337
- { },
45338
- { },
45339
- null,
45340
- ['PureCloud OAuth'],
45341
- ['application/json'],
45342
- ['application/json']
45343
- );
45344
- }
45345
-
45346
44934
  /**
45347
44935
  * Query published schedules for given given time range for set of users
45348
44936
  *
@@ -45403,31 +44991,6 @@ class WorkforceManagementApi {
45403
44991
  );
45404
44992
  }
45405
44993
 
45406
- /**
45407
- * Gone. Moved under business units
45408
- *
45409
- * @param {String} muId The management unit ID of the management unit
45410
- */
45411
- postWorkforcemanagementManagementunitIntraday(muId) {
45412
- // verify the required parameter 'muId' is set
45413
- if (muId === undefined || muId === null) {
45414
- throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitIntraday';
45415
- }
45416
-
45417
- return this.apiClient.callApi(
45418
- '/api/v2/workforcemanagement/managementunits/{muId}/intraday',
45419
- 'POST',
45420
- { 'muId': muId },
45421
- { },
45422
- { },
45423
- { },
45424
- null,
45425
- ['PureCloud OAuth'],
45426
- ['application/json'],
45427
- ['application/json']
45428
- );
45429
- }
45430
-
45431
44994
  /**
45432
44995
  * Move the requested management unit to a new business unit
45433
44996
  * Returns status 200 if the management unit is already in the requested business unit
@@ -45486,31 +45049,6 @@ class WorkforceManagementApi {
45486
45049
  );
45487
45050
  }
45488
45051
 
45489
- /**
45490
- * Gone. Replaced with service goal templates and planning groups under business units
45491
- *
45492
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45493
- */
45494
- postWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
45495
- // verify the required parameter 'managementUnitId' is set
45496
- if (managementUnitId === undefined || managementUnitId === null) {
45497
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitServicegoalgroups';
45498
- }
45499
-
45500
- return this.apiClient.callApi(
45501
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
45502
- 'POST',
45503
- { 'managementUnitId': managementUnitId },
45504
- { },
45505
- { },
45506
- { },
45507
- null,
45508
- ['PureCloud OAuth'],
45509
- ['application/json'],
45510
- ['application/json']
45511
- );
45512
- }
45513
-
45514
45052
  /**
45515
45053
  * Create a new time off request
45516
45054
  *
@@ -45540,35 +45078,6 @@ class WorkforceManagementApi {
45540
45078
  );
45541
45079
  }
45542
45080
 
45543
- /**
45544
- * Gone. All data is now returned in the query route
45545
- *
45546
- * @param {String} muId The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45547
- * @param {Object} opts Optional parameters
45548
- * @param {Object} opts.body body
45549
- */
45550
- postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails(muId, opts) {
45551
- opts = opts || {};
45552
-
45553
- // verify the required parameter 'muId' is set
45554
- if (muId === undefined || muId === null) {
45555
- throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails';
45556
- }
45557
-
45558
- return this.apiClient.callApi(
45559
- '/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails',
45560
- 'POST',
45561
- { 'muId': muId },
45562
- { },
45563
- { },
45564
- { },
45565
- opts['body'],
45566
- ['PureCloud OAuth'],
45567
- ['application/json'],
45568
- ['application/json']
45569
- );
45570
- }
45571
-
45572
45081
  /**
45573
45082
  * Gets the lookup ids to fetch the specified set of requests
45574
45083
  *
@@ -45598,166 +45107,6 @@ class WorkforceManagementApi {
45598
45107
  );
45599
45108
  }
45600
45109
 
45601
- /**
45602
- * Gone. Scheduling has moved under business units
45603
- *
45604
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45605
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
45606
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to copy from
45607
- */
45608
- postWorkforcemanagementManagementunitWeekScheduleCopy(managementUnitId, weekId, scheduleId) {
45609
- // verify the required parameter 'managementUnitId' is set
45610
- if (managementUnitId === undefined || managementUnitId === null) {
45611
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
45612
- }
45613
- // verify the required parameter 'weekId' is set
45614
- if (weekId === undefined || weekId === null) {
45615
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
45616
- }
45617
- // verify the required parameter 'scheduleId' is set
45618
- if (scheduleId === undefined || scheduleId === null) {
45619
- throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
45620
- }
45621
-
45622
- return this.apiClient.callApi(
45623
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy',
45624
- 'POST',
45625
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
45626
- { },
45627
- { },
45628
- { },
45629
- null,
45630
- ['PureCloud OAuth'],
45631
- ['application/json'],
45632
- ['application/json']
45633
- );
45634
- }
45635
-
45636
- /**
45637
- * Gone. Scheduling has moved under business units
45638
- *
45639
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45640
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
45641
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to re-optimize
45642
- */
45643
- postWorkforcemanagementManagementunitWeekScheduleReschedule(managementUnitId, weekId, scheduleId) {
45644
- // verify the required parameter 'managementUnitId' is set
45645
- if (managementUnitId === undefined || managementUnitId === null) {
45646
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
45647
- }
45648
- // verify the required parameter 'weekId' is set
45649
- if (weekId === undefined || weekId === null) {
45650
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
45651
- }
45652
- // verify the required parameter 'scheduleId' is set
45653
- if (scheduleId === undefined || scheduleId === null) {
45654
- throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
45655
- }
45656
-
45657
- return this.apiClient.callApi(
45658
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule',
45659
- 'POST',
45660
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
45661
- { },
45662
- { },
45663
- { },
45664
- null,
45665
- ['PureCloud OAuth'],
45666
- ['application/json'],
45667
- ['application/json']
45668
- );
45669
- }
45670
-
45671
- /**
45672
- * Gone. Scheduling has moved under business units
45673
- *
45674
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45675
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
45676
- */
45677
- postWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId) {
45678
- // verify the required parameter 'managementUnitId' is set
45679
- if (managementUnitId === undefined || managementUnitId === null) {
45680
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedules';
45681
- }
45682
- // verify the required parameter 'weekId' is set
45683
- if (weekId === undefined || weekId === null) {
45684
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
45685
- }
45686
-
45687
- return this.apiClient.callApi(
45688
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules',
45689
- 'POST',
45690
- { 'managementUnitId': managementUnitId,'weekId': weekId },
45691
- { },
45692
- { },
45693
- { },
45694
- null,
45695
- ['PureCloud OAuth'],
45696
- ['application/json'],
45697
- ['application/json']
45698
- );
45699
- }
45700
-
45701
- /**
45702
- * Gone. Scheduling has moved under business units
45703
- *
45704
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45705
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
45706
- */
45707
- postWorkforcemanagementManagementunitWeekSchedulesGenerate(managementUnitId, weekId) {
45708
- // verify the required parameter 'managementUnitId' is set
45709
- if (managementUnitId === undefined || managementUnitId === null) {
45710
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
45711
- }
45712
- // verify the required parameter 'weekId' is set
45713
- if (weekId === undefined || weekId === null) {
45714
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
45715
- }
45716
-
45717
- return this.apiClient.callApi(
45718
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate',
45719
- 'POST',
45720
- { 'managementUnitId': managementUnitId,'weekId': weekId },
45721
- { },
45722
- { },
45723
- { },
45724
- null,
45725
- ['PureCloud OAuth'],
45726
- ['application/json'],
45727
- ['application/json']
45728
- );
45729
- }
45730
-
45731
- /**
45732
- * Gone. Scheduling has moved under business units
45733
- *
45734
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45735
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
45736
- */
45737
- postWorkforcemanagementManagementunitWeekSchedulesPartialupload(managementUnitId, weekId) {
45738
- // verify the required parameter 'managementUnitId' is set
45739
- if (managementUnitId === undefined || managementUnitId === null) {
45740
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
45741
- }
45742
- // verify the required parameter 'weekId' is set
45743
- if (weekId === undefined || weekId === null) {
45744
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
45745
- }
45746
-
45747
- return this.apiClient.callApi(
45748
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload',
45749
- 'POST',
45750
- { 'managementUnitId': managementUnitId,'weekId': weekId },
45751
- { },
45752
- { },
45753
- { },
45754
- null,
45755
- ['PureCloud OAuth'],
45756
- ['application/json'],
45757
- ['application/json']
45758
- );
45759
- }
45760
-
45761
45110
  /**
45762
45111
  * Matches a shift trade. This route can only be called by the receiving agent
45763
45112
  *
@@ -45908,94 +45257,33 @@ class WorkforceManagementApi {
45908
45257
  }
45909
45258
 
45910
45259
  /**
45911
- * Gone. Use equivalent business unit resource instead
45912
- *
45913
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
45914
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
45915
- * @param {String} forecastId (Gone/Deprecated): The ID of the forecast
45916
- */
45917
- postWorkforcemanagementManagementunitWeekShorttermforecastCopy(managementUnitId, weekDateId, forecastId) {
45918
- // verify the required parameter 'managementUnitId' is set
45919
- if (managementUnitId === undefined || managementUnitId === null) {
45920
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
45921
- }
45922
- // verify the required parameter 'weekDateId' is set
45923
- if (weekDateId === undefined || weekDateId === null) {
45924
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
45925
- }
45926
- // verify the required parameter 'forecastId' is set
45927
- if (forecastId === undefined || forecastId === null) {
45928
- throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
45929
- }
45930
-
45931
- return this.apiClient.callApi(
45932
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy',
45933
- 'POST',
45934
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
45935
- { },
45936
- { },
45937
- { },
45938
- null,
45939
- ['PureCloud OAuth'],
45940
- ['application/json'],
45941
- ['application/json']
45942
- );
45943
- }
45944
-
45945
- /**
45946
- * Gone. Use equivalent business unit resource instead
45947
- *
45948
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
45949
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
45950
- */
45951
- postWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
45952
- // verify the required parameter 'managementUnitId' is set
45953
- if (managementUnitId === undefined || managementUnitId === null) {
45954
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
45955
- }
45956
- // verify the required parameter 'weekDateId' is set
45957
- if (weekDateId === undefined || weekDateId === null) {
45958
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
45959
- }
45960
-
45961
- return this.apiClient.callApi(
45962
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
45963
- 'POST',
45964
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
45965
- { },
45966
- { },
45967
- { },
45968
- null,
45969
- ['PureCloud OAuth'],
45970
- ['application/json'],
45971
- ['application/json']
45972
- );
45973
- }
45974
-
45975
- /**
45976
- * Gone. Use equivalent business unit resource instead
45260
+ * Create a copy of work plan
45977
45261
  *
45978
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
45979
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
45262
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45263
+ * @param {String} workPlanId The ID of the work plan to create a copy
45264
+ * @param {Object} opts Optional parameters
45265
+ * @param {Object} opts.body body
45980
45266
  */
45981
- postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate(managementUnitId, weekDateId) {
45267
+ postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
45268
+ opts = opts || {};
45269
+
45982
45270
  // verify the required parameter 'managementUnitId' is set
45983
45271
  if (managementUnitId === undefined || managementUnitId === null) {
45984
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate';
45272
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
45985
45273
  }
45986
- // verify the required parameter 'weekDateId' is set
45987
- if (weekDateId === undefined || weekDateId === null) {
45988
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate';
45274
+ // verify the required parameter 'workPlanId' is set
45275
+ if (workPlanId === undefined || workPlanId === null) {
45276
+ throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
45989
45277
  }
45990
45278
 
45991
45279
  return this.apiClient.callApi(
45992
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/generate',
45280
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
45993
45281
  'POST',
45994
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
45282
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
45995
45283
  { },
45996
45284
  { },
45997
45285
  { },
45998
- null,
45286
+ opts['body'],
45999
45287
  ['PureCloud OAuth'],
46000
45288
  ['application/json'],
46001
45289
  ['application/json']
@@ -46003,29 +45291,34 @@ class WorkforceManagementApi {
46003
45291
  }
46004
45292
 
46005
45293
  /**
46006
- * Gone. Use equivalent business unit resource instead
45294
+ * Validate Work Plan
46007
45295
  *
46008
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
46009
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
45296
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
45297
+ * @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word &#39;new&#39; for the ID.
45298
+ * @param {Object} opts Optional parameters
45299
+ * @param {Object} opts.body body
45300
+ * @param {Array.<String>} opts.expand
46010
45301
  */
46011
- postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload(managementUnitId, weekDateId) {
45302
+ postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
45303
+ opts = opts || {};
45304
+
46012
45305
  // verify the required parameter 'managementUnitId' is set
46013
45306
  if (managementUnitId === undefined || managementUnitId === null) {
46014
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload';
45307
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
46015
45308
  }
46016
- // verify the required parameter 'weekDateId' is set
46017
- if (weekDateId === undefined || weekDateId === null) {
46018
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload';
45309
+ // verify the required parameter 'workPlanId' is set
45310
+ if (workPlanId === undefined || workPlanId === null) {
45311
+ throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
46019
45312
  }
46020
45313
 
46021
45314
  return this.apiClient.callApi(
46022
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/partialupload',
45315
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
46023
45316
  'POST',
46024
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
46025
- { },
45317
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
45318
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
46026
45319
  { },
46027
45320
  { },
46028
- null,
45321
+ opts['body'],
46029
45322
  ['PureCloud OAuth'],
46030
45323
  ['application/json'],
46031
45324
  ['application/json']
@@ -46033,29 +45326,29 @@ class WorkforceManagementApi {
46033
45326
  }
46034
45327
 
46035
45328
  /**
46036
- * Create a copy of work plan
45329
+ * Create a copy of work plan rotation
46037
45330
  *
46038
45331
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
46039
- * @param {String} workPlanId The ID of the work plan to create a copy
45332
+ * @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
46040
45333
  * @param {Object} opts Optional parameters
46041
45334
  * @param {Object} opts.body body
46042
45335
  */
46043
- postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
45336
+ postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
46044
45337
  opts = opts || {};
46045
45338
 
46046
45339
  // verify the required parameter 'managementUnitId' is set
46047
45340
  if (managementUnitId === undefined || managementUnitId === null) {
46048
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
45341
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
46049
45342
  }
46050
- // verify the required parameter 'workPlanId' is set
46051
- if (workPlanId === undefined || workPlanId === null) {
46052
- throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
45343
+ // verify the required parameter 'workPlanRotationId' is set
45344
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
45345
+ throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
46053
45346
  }
46054
45347
 
46055
45348
  return this.apiClient.callApi(
46056
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
45349
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
46057
45350
  'POST',
46058
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
45351
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
46059
45352
  { },
46060
45353
  { },
46061
45354
  { },
@@ -46067,31 +45360,25 @@ class WorkforceManagementApi {
46067
45360
  }
46068
45361
 
46069
45362
  /**
46070
- * Validate Work Plan
45363
+ * Create a new work plan rotation
46071
45364
  *
46072
45365
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
46073
- * @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word &#39;new&#39; for the ID.
46074
45366
  * @param {Object} opts Optional parameters
46075
45367
  * @param {Object} opts.body body
46076
- * @param {Array.<String>} opts.expand
46077
45368
  */
46078
- postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
45369
+ postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
46079
45370
  opts = opts || {};
46080
45371
 
46081
45372
  // verify the required parameter 'managementUnitId' is set
46082
45373
  if (managementUnitId === undefined || managementUnitId === null) {
46083
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
46084
- }
46085
- // verify the required parameter 'workPlanId' is set
46086
- if (workPlanId === undefined || workPlanId === null) {
46087
- throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
45374
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
46088
45375
  }
46089
45376
 
46090
45377
  return this.apiClient.callApi(
46091
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
45378
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
46092
45379
  'POST',
46093
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
46094
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
45380
+ { 'managementUnitId': managementUnitId },
45381
+ { },
46095
45382
  { },
46096
45383
  { },
46097
45384
  opts['body'],
@@ -46257,7 +45544,7 @@ class WorkforceManagementApi {
46257
45544
  * </pre>
46258
45545
  * </p>
46259
45546
  * @module purecloud-platform-client-v2/index
46260
- * @version 94.0.0
45547
+ * @version 97.0.0
46261
45548
  */
46262
45549
  class platformClient {
46263
45550
  constructor() {
@@ -46516,11 +45803,6 @@ class platformClient {
46516
45803
  * @property {module:purecloud-platform-client-v2/api/UsageApi}
46517
45804
  */
46518
45805
  this.UsageApi = UsageApi;
46519
- /**
46520
- * The UserDevelopmentApi service constructor.
46521
- * @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
46522
- */
46523
- this.UserDevelopmentApi = UserDevelopmentApi;
46524
45806
  /**
46525
45807
  * The UserRecordingsApi service constructor.
46526
45808
  * @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}