purecloud-platform-client-v2 252.1.0 → 253.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 (97) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +908 -340
  3. package/dist/web-amd/purecloud-platform-client-v2.js +908 -340
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +336 -177
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +336 -177
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +632 -102
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +6 -6
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -7
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +42 -1
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +179 -156
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -47
  83. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  95. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  96. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +472 -39
  97. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 252.1.0
8
+ * @version 253.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1868,6 +1868,42 @@ class WorkforceManagementApi {
1868
1868
  );
1869
1869
  }
1870
1870
 
1871
+ /**
1872
+ * Get opportunity details
1873
+ *
1874
+ * @param {String} businessUnitId The ID of the business unit
1875
+ * @param {String} opportunityId The ID of the opportunity
1876
+ * @param {Object} opts Optional parameters
1877
+ * @param {Object} opts.expand List of resources to expand
1878
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1879
+ */
1880
+ getWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, opts) {
1881
+ opts = opts || {};
1882
+
1883
+ // verify the required parameter 'businessUnitId' is set
1884
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
1885
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';
1886
+ }
1887
+ // verify the required parameter 'opportunityId' is set
1888
+ if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
1889
+ throw 'Missing the required parameter "opportunityId" when calling getWorkforcemanagementBusinessunitOpportunity';
1890
+ }
1891
+
1892
+ return this.apiClient.callApi(
1893
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
1894
+ 'GET',
1895
+ { 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
1896
+ { 'expand': opts['expand'] },
1897
+ { },
1898
+ { },
1899
+ null,
1900
+ ['PureCloud OAuth'],
1901
+ ['application/json'],
1902
+ ['application/json'],
1903
+ opts['customHeaders']
1904
+ );
1905
+ }
1906
+
1871
1907
  /**
1872
1908
  * Get a planning group
1873
1909
  *
@@ -3701,11 +3737,12 @@ class WorkforceManagementApi {
3701
3737
 
3702
3738
  /**
3703
3739
  * Gets all the shift trades for a given agent
3704
- *
3740
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
3705
3741
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3706
3742
  * @param {String} agentId The agent id
3707
3743
  * @param {Object} opts Optional parameters
3708
3744
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
3745
+ * @deprecated
3709
3746
  */
3710
3747
  getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId, opts) {
3711
3748
  opts = opts || {};
@@ -3736,10 +3773,11 @@ class WorkforceManagementApi {
3736
3773
 
3737
3774
  /**
3738
3775
  * Gets a summary of all shift trades in the matched state
3739
- *
3776
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
3740
3777
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3741
3778
  * @param {Object} opts Optional parameters
3742
3779
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
3780
+ * @deprecated
3743
3781
  */
3744
3782
  getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId, opts) {
3745
3783
  opts = opts || {};
@@ -4153,7 +4191,7 @@ class WorkforceManagementApi {
4153
4191
 
4154
4192
  /**
4155
4193
  * Gets all the shift trades for a given week
4156
- *
4194
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
4157
4195
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
4158
4196
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
4159
4197
  * @param {Object} opts Optional parameters
@@ -4161,6 +4199,7 @@ class WorkforceManagementApi {
4161
4199
  * @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
4162
4200
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
4163
4201
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4202
+ * @deprecated
4164
4203
  */
4165
4204
  getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
4166
4205
  opts = opts || {};
@@ -4436,9 +4475,10 @@ class WorkforceManagementApi {
4436
4475
 
4437
4476
  /**
4438
4477
  * Gets all of my shift trades
4439
- *
4478
+ * Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
4440
4479
  * @param {Object} opts Optional parameters
4441
4480
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4481
+ * @deprecated
4442
4482
  */
4443
4483
  getWorkforcemanagementShifttrades(opts) {
4444
4484
  opts = opts || {};
@@ -5300,9 +5340,49 @@ class WorkforceManagementApi {
5300
5340
  );
5301
5341
  }
5302
5342
 
5343
+ /**
5344
+ * Update the opportunity
5345
+ * Only opportunities with Draft status can be updated.
5346
+ * @param {String} businessUnitId The ID of the business unit
5347
+ * @param {String} opportunityId The ID of the opportunity
5348
+ * @param {Object} body body
5349
+ * @param {Object} opts Optional parameters
5350
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5351
+ */
5352
+ patchWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, body, opts) {
5353
+ opts = opts || {};
5354
+
5355
+ // verify the required parameter 'businessUnitId' is set
5356
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
5357
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';
5358
+ }
5359
+ // verify the required parameter 'opportunityId' is set
5360
+ if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
5361
+ throw 'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';
5362
+ }
5363
+ // verify the required parameter 'body' is set
5364
+ if (body === undefined || body === null) {
5365
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';
5366
+ }
5367
+
5368
+ return this.apiClient.callApi(
5369
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
5370
+ 'PATCH',
5371
+ { 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
5372
+ { },
5373
+ { },
5374
+ { },
5375
+ body,
5376
+ ['PureCloud OAuth'],
5377
+ ['application/json'],
5378
+ ['application/json'],
5379
+ opts['customHeaders']
5380
+ );
5381
+ }
5382
+
5303
5383
  /**
5304
5384
  * Updates the planning group
5305
- *
5385
+ * If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
5306
5386
  * @param {String} businessUnitId The ID of the business unit.
5307
5387
  * @param {String} planningGroupId The ID of a planning group to update
5308
5388
  * @param {Object} body body
@@ -5977,13 +6057,14 @@ class WorkforceManagementApi {
5977
6057
 
5978
6058
  /**
5979
6059
  * Updates a shift trade. This route can only be called by the initiating agent
5980
- *
6060
+ * Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
5981
6061
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
5982
6062
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
5983
6063
  * @param {String} tradeId The ID of the shift trade to update
5984
6064
  * @param {Object} body body
5985
6065
  * @param {Object} opts Optional parameters
5986
6066
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6067
+ * @deprecated
5987
6068
  */
5988
6069
  patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body, opts) {
5989
6070
  opts = opts || {};
@@ -6328,33 +6409,6 @@ class WorkforceManagementApi {
6328
6409
  );
6329
6410
  }
6330
6411
 
6331
- /**
6332
- * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
6333
- *
6334
- * @param {Object} opts Optional parameters
6335
- * @param {Object} opts.body body
6336
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6337
- * @deprecated
6338
- */
6339
- postWorkforcemanagementAdherenceHistorical(opts) {
6340
- opts = opts || {};
6341
-
6342
-
6343
- return this.apiClient.callApi(
6344
- '/api/v2/workforcemanagement/adherence/historical',
6345
- 'POST',
6346
- { },
6347
- { },
6348
- { },
6349
- { },
6350
- opts['body'],
6351
- ['PureCloud OAuth'],
6352
- ['application/json'],
6353
- ['application/json'],
6354
- opts['customHeaders']
6355
- );
6356
- }
6357
-
6358
6412
  /**
6359
6413
  * Request a historical adherence report in bulk
6360
6414
  *
@@ -6609,6 +6663,98 @@ class WorkforceManagementApi {
6609
6663
  );
6610
6664
  }
6611
6665
 
6666
+ /**
6667
+ * Bulk add enrollments to opportunities for the authenticated agent
6668
+ * Allows an agent to enroll in opportunities. This endpoint can return partial success.
6669
+ * @param {Object} body body
6670
+ * @param {Object} opts Optional parameters
6671
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6672
+ */
6673
+ postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body, opts) {
6674
+ opts = opts || {};
6675
+
6676
+ // verify the required parameter 'body' is set
6677
+ if (body === undefined || body === null) {
6678
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';
6679
+ }
6680
+
6681
+ return this.apiClient.callApi(
6682
+ '/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add',
6683
+ 'POST',
6684
+ { },
6685
+ { },
6686
+ { },
6687
+ { },
6688
+ body,
6689
+ ['PureCloud OAuth'],
6690
+ ['application/json'],
6691
+ ['application/json'],
6692
+ opts['customHeaders']
6693
+ );
6694
+ }
6695
+
6696
+ /**
6697
+ * Bulk update enrollment status for the authenticated agent
6698
+ * Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
6699
+ * @param {Object} body body
6700
+ * @param {Object} opts Optional parameters
6701
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6702
+ */
6703
+ postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body, opts) {
6704
+ opts = opts || {};
6705
+
6706
+ // verify the required parameter 'body' is set
6707
+ if (body === undefined || body === null) {
6708
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';
6709
+ }
6710
+
6711
+ return this.apiClient.callApi(
6712
+ '/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update',
6713
+ 'POST',
6714
+ { },
6715
+ { },
6716
+ { },
6717
+ { },
6718
+ body,
6719
+ ['PureCloud OAuth'],
6720
+ ['application/json'],
6721
+ ['application/json'],
6722
+ opts['customHeaders']
6723
+ );
6724
+ }
6725
+
6726
+ /**
6727
+ * Query opportunities for the authenticated agent
6728
+ * Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
6729
+ * @param {Object} body body
6730
+ * @param {Object} opts Optional parameters
6731
+ * @param {Object} opts.expand List of resources to expand
6732
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
6733
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6734
+ */
6735
+ postWorkforcemanagementAgentsOpportunitiesQuery(body, opts) {
6736
+ opts = opts || {};
6737
+
6738
+ // verify the required parameter 'body' is set
6739
+ if (body === undefined || body === null) {
6740
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';
6741
+ }
6742
+
6743
+ return this.apiClient.callApi(
6744
+ '/api/v2/workforcemanagement/agents/opportunities/query',
6745
+ 'POST',
6746
+ { },
6747
+ { 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
6748
+ { },
6749
+ { },
6750
+ body,
6751
+ ['PureCloud OAuth'],
6752
+ ['application/json'],
6753
+ ['application/json'],
6754
+ opts['customHeaders']
6755
+ );
6756
+ }
6757
+
6612
6758
  /**
6613
6759
  * Fetch agent schedules for the logged in user's management unit
6614
6760
  *
@@ -7278,8 +7424,291 @@ class WorkforceManagementApi {
7278
7424
  }
7279
7425
 
7280
7426
  /**
7281
- * Adds a new planning group
7427
+ * Bulk add opportunities
7282
7428
  *
7429
+ * @param {String} businessUnitId The ID of the business unit
7430
+ * @param {Object} body body
7431
+ * @param {Object} opts Optional parameters
7432
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7433
+ */
7434
+ postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId, body, opts) {
7435
+ opts = opts || {};
7436
+
7437
+ // verify the required parameter 'businessUnitId' is set
7438
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7439
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
7440
+ }
7441
+ // verify the required parameter 'body' is set
7442
+ if (body === undefined || body === null) {
7443
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
7444
+ }
7445
+
7446
+ return this.apiClient.callApi(
7447
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add',
7448
+ 'POST',
7449
+ { 'businessUnitId': businessUnitId },
7450
+ { },
7451
+ { },
7452
+ { },
7453
+ body,
7454
+ ['PureCloud OAuth'],
7455
+ ['application/json'],
7456
+ ['application/json'],
7457
+ opts['customHeaders']
7458
+ );
7459
+ }
7460
+
7461
+ /**
7462
+ * Bulk publish opportunities
7463
+ * Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
7464
+ * @param {String} businessUnitId The ID of the business unit
7465
+ * @param {Object} body body
7466
+ * @param {Object} opts Optional parameters
7467
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7468
+ */
7469
+ postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId, body, opts) {
7470
+ opts = opts || {};
7471
+
7472
+ // verify the required parameter 'businessUnitId' is set
7473
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7474
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
7475
+ }
7476
+ // verify the required parameter 'body' is set
7477
+ if (body === undefined || body === null) {
7478
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
7479
+ }
7480
+
7481
+ return this.apiClient.callApi(
7482
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish',
7483
+ 'POST',
7484
+ { 'businessUnitId': businessUnitId },
7485
+ { },
7486
+ { },
7487
+ { },
7488
+ body,
7489
+ ['PureCloud OAuth'],
7490
+ ['application/json'],
7491
+ ['application/json'],
7492
+ opts['customHeaders']
7493
+ );
7494
+ }
7495
+
7496
+ /**
7497
+ * Bulk remove opportunities
7498
+ * This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
7499
+ * @param {String} businessUnitId The ID of the business unit
7500
+ * @param {Object} body body
7501
+ * @param {Object} opts Optional parameters
7502
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7503
+ */
7504
+ postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId, body, opts) {
7505
+ opts = opts || {};
7506
+
7507
+ // verify the required parameter 'businessUnitId' is set
7508
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7509
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
7510
+ }
7511
+ // verify the required parameter 'body' is set
7512
+ if (body === undefined || body === null) {
7513
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
7514
+ }
7515
+
7516
+ return this.apiClient.callApi(
7517
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove',
7518
+ 'POST',
7519
+ { 'businessUnitId': businessUnitId },
7520
+ { },
7521
+ { },
7522
+ { },
7523
+ body,
7524
+ ['PureCloud OAuth'],
7525
+ ['application/json'],
7526
+ ['application/json'],
7527
+ opts['customHeaders']
7528
+ );
7529
+ }
7530
+
7531
+ /**
7532
+ * Bulk update opportunities status
7533
+ * If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
7534
+ * @param {String} businessUnitId The ID of the business unit
7535
+ * @param {Object} body body
7536
+ * @param {Object} opts Optional parameters
7537
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7538
+ */
7539
+ postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId, body, opts) {
7540
+ opts = opts || {};
7541
+
7542
+ // verify the required parameter 'businessUnitId' is set
7543
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7544
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
7545
+ }
7546
+ // verify the required parameter 'body' is set
7547
+ if (body === undefined || body === null) {
7548
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
7549
+ }
7550
+
7551
+ return this.apiClient.callApi(
7552
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update',
7553
+ 'POST',
7554
+ { 'businessUnitId': businessUnitId },
7555
+ { },
7556
+ { },
7557
+ { },
7558
+ body,
7559
+ ['PureCloud OAuth'],
7560
+ ['application/json'],
7561
+ ['application/json'],
7562
+ opts['customHeaders']
7563
+ );
7564
+ }
7565
+
7566
+ /**
7567
+ * Bulk update enrollment status
7568
+ * Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
7569
+ * @param {String} businessUnitId The ID of the business unit
7570
+ * @param {Object} body body
7571
+ * @param {Object} opts Optional parameters
7572
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7573
+ */
7574
+ postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId, body, opts) {
7575
+ opts = opts || {};
7576
+
7577
+ // verify the required parameter 'businessUnitId' is set
7578
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7579
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
7580
+ }
7581
+ // verify the required parameter 'body' is set
7582
+ if (body === undefined || body === null) {
7583
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
7584
+ }
7585
+
7586
+ return this.apiClient.callApi(
7587
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update',
7588
+ 'POST',
7589
+ { 'businessUnitId': businessUnitId },
7590
+ { },
7591
+ { },
7592
+ { },
7593
+ body,
7594
+ ['PureCloud OAuth'],
7595
+ ['application/json'],
7596
+ ['application/json'],
7597
+ opts['customHeaders']
7598
+ );
7599
+ }
7600
+
7601
+ /**
7602
+ * Query enrollments
7603
+ * For more information about opportunities, use the expand parameter.
7604
+ * @param {String} businessUnitId The ID of the business unit
7605
+ * @param {Object} body body
7606
+ * @param {Object} opts Optional parameters
7607
+ * @param {Object} opts.expand List of resources to expand
7608
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
7609
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7610
+ */
7611
+ postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId, body, opts) {
7612
+ opts = opts || {};
7613
+
7614
+ // verify the required parameter 'businessUnitId' is set
7615
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7616
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
7617
+ }
7618
+ // verify the required parameter 'body' is set
7619
+ if (body === undefined || body === null) {
7620
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
7621
+ }
7622
+
7623
+ return this.apiClient.callApi(
7624
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query',
7625
+ 'POST',
7626
+ { 'businessUnitId': businessUnitId },
7627
+ { 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
7628
+ { },
7629
+ { },
7630
+ body,
7631
+ ['PureCloud OAuth'],
7632
+ ['application/json'],
7633
+ ['application/json'],
7634
+ opts['customHeaders']
7635
+ );
7636
+ }
7637
+
7638
+ /**
7639
+ * Query opportunities by external activity IDs
7640
+ *
7641
+ * @param {String} businessUnitId The ID of the business unit
7642
+ * @param {Object} body body
7643
+ * @param {Object} opts Optional parameters
7644
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7645
+ */
7646
+ postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId, body, opts) {
7647
+ opts = opts || {};
7648
+
7649
+ // verify the required parameter 'businessUnitId' is set
7650
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7651
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
7652
+ }
7653
+ // verify the required parameter 'body' is set
7654
+ if (body === undefined || body === null) {
7655
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
7656
+ }
7657
+
7658
+ return this.apiClient.callApi(
7659
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query',
7660
+ 'POST',
7661
+ { 'businessUnitId': businessUnitId },
7662
+ { },
7663
+ { },
7664
+ { },
7665
+ body,
7666
+ ['PureCloud OAuth'],
7667
+ ['application/json'],
7668
+ ['application/json'],
7669
+ opts['customHeaders']
7670
+ );
7671
+ }
7672
+
7673
+ /**
7674
+ * Query opportunities within the specified date range
7675
+ *
7676
+ * @param {String} businessUnitId The ID of the business unit
7677
+ * @param {Object} body body
7678
+ * @param {Object} opts Optional parameters
7679
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
7680
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7681
+ */
7682
+ postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId, body, opts) {
7683
+ opts = opts || {};
7684
+
7685
+ // verify the required parameter 'businessUnitId' is set
7686
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7687
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
7688
+ }
7689
+ // verify the required parameter 'body' is set
7690
+ if (body === undefined || body === null) {
7691
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
7692
+ }
7693
+
7694
+ return this.apiClient.callApi(
7695
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query',
7696
+ 'POST',
7697
+ { 'businessUnitId': businessUnitId },
7698
+ { 'forceDownloadService': opts['forceDownloadService'] },
7699
+ { },
7700
+ { },
7701
+ body,
7702
+ ['PureCloud OAuth'],
7703
+ ['application/json'],
7704
+ ['application/json'],
7705
+ opts['customHeaders']
7706
+ );
7707
+ }
7708
+
7709
+ /**
7710
+ * Adds a new planning group
7711
+ * If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
7283
7712
  * @param {String} businessUnitId The ID of the business unit.
7284
7713
  * @param {Object} body body
7285
7714
  * @param {Object} opts Optional parameters
@@ -9300,13 +9729,14 @@ class WorkforceManagementApi {
9300
9729
 
9301
9730
  /**
9302
9731
  * Matches a shift trade. This route can only be called by the receiving agent
9303
- *
9732
+ * Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
9304
9733
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9305
9734
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
9306
9735
  * @param {String} tradeId The ID of the shift trade to update
9307
9736
  * @param {Object} body body
9308
9737
  * @param {Object} opts Optional parameters
9309
9738
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9739
+ * @deprecated
9310
9740
  */
9311
9741
  postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body, opts) {
9312
9742
  opts = opts || {};
@@ -9345,12 +9775,13 @@ class WorkforceManagementApi {
9345
9775
 
9346
9776
  /**
9347
9777
  * Adds a shift trade
9348
- *
9778
+ * Deprecated. Use new route instead (/shifttrading/trades/jobs)
9349
9779
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9350
9780
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
9351
9781
  * @param {Object} body body
9352
9782
  * @param {Object} opts Optional parameters
9353
9783
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9784
+ * @deprecated
9354
9785
  */
9355
9786
  postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body, opts) {
9356
9787
  opts = opts || {};
@@ -9385,13 +9816,14 @@ class WorkforceManagementApi {
9385
9816
 
9386
9817
  /**
9387
9818
  * Searches for potential shift trade matches for the current agent
9388
- *
9819
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
9389
9820
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9390
9821
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
9391
9822
  * @param {Object} body body
9392
9823
  * @param {Object} opts Optional parameters
9393
9824
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
9394
9825
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9826
+ * @deprecated
9395
9827
  */
9396
9828
  postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
9397
9829
  opts = opts || {};
@@ -9426,13 +9858,14 @@ class WorkforceManagementApi {
9426
9858
 
9427
9859
  /**
9428
9860
  * Updates the state of a batch of shift trades
9429
- * Admin functionality is not supported with "mine".
9861
+ * Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
9430
9862
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9431
9863
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
9432
9864
  * @param {Object} body body
9433
9865
  * @param {Object} opts Optional parameters
9434
9866
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
9435
9867
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9868
+ * @deprecated
9436
9869
  */
9437
9870
  postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, opts) {
9438
9871
  opts = opts || {};
@@ -122,7 +122,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
122
122
  * </pre>
123
123
  * </p>
124
124
  * @module purecloud-platform-client-v2/index
125
- * @version 252.1.0
125
+ * @version 253.0.0
126
126
  */
127
127
  class platformClient {
128
128
  constructor() {