purecloud-platform-client-v2 252.1.0 → 254.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 +1979 -556
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1979 -556
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +686 -393
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +686 -393
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1094 -117
  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 -62
  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 +435 -1
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
  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 +2 -6
  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 -5
  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 -11
  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 -9
  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 +333 -158
  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 +268 -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 -5
  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 +481 -43
  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 254.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
  *
@@ -2490,6 +2526,7 @@ class WorkforceManagementApi {
2490
2526
  * @param {Object} opts Optional parameters
2491
2527
  * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
2492
2528
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
2529
+ * @param {Array.<String>} opts.expand Include to access additional data for the time-off plans
2493
2530
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
2494
2531
  */
2495
2532
  getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
@@ -2504,7 +2541,7 @@ class WorkforceManagementApi {
2504
2541
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
2505
2542
  'GET',
2506
2543
  { 'businessUnitId': businessUnitId },
2507
- { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
2544
+ { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
2508
2545
  { },
2509
2546
  { },
2510
2547
  null,
@@ -2804,6 +2841,8 @@ class WorkforceManagementApi {
2804
2841
  * @param {String} businessUnitId The ID of the business unit
2805
2842
  * @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
2806
2843
  * @param {Object} opts Optional parameters
2844
+ * @param {String} opts.earliestWeekDate If weekId == 'recent', specify the earliest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
2845
+ * @param {String} opts.latestWeekDate If weekId == 'recent', specify the latest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
2807
2846
  * @param {Boolean} opts.includeOnlyPublished includeOnlyPublished
2808
2847
  * @param {Object} opts.expand expand
2809
2848
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
@@ -2824,7 +2863,7 @@ class WorkforceManagementApi {
2824
2863
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules',
2825
2864
  'GET',
2826
2865
  { 'businessUnitId': businessUnitId,'weekId': weekId },
2827
- { 'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
2866
+ { 'earliestWeekDate': opts['earliestWeekDate'],'latestWeekDate': opts['latestWeekDate'],'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
2828
2867
  { },
2829
2868
  { },
2830
2869
  null,
@@ -3701,11 +3740,12 @@ class WorkforceManagementApi {
3701
3740
 
3702
3741
  /**
3703
3742
  * Gets all the shift trades for a given agent
3704
- *
3743
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
3705
3744
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3706
3745
  * @param {String} agentId The agent id
3707
3746
  * @param {Object} opts Optional parameters
3708
3747
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
3748
+ * @deprecated
3709
3749
  */
3710
3750
  getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId, opts) {
3711
3751
  opts = opts || {};
@@ -3736,10 +3776,11 @@ class WorkforceManagementApi {
3736
3776
 
3737
3777
  /**
3738
3778
  * Gets a summary of all shift trades in the matched state
3739
- *
3779
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
3740
3780
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3741
3781
  * @param {Object} opts Optional parameters
3742
3782
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
3783
+ * @deprecated
3743
3784
  */
3744
3785
  getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId, opts) {
3745
3786
  opts = opts || {};
@@ -4153,7 +4194,7 @@ class WorkforceManagementApi {
4153
4194
 
4154
4195
  /**
4155
4196
  * Gets all the shift trades for a given week
4156
- *
4197
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
4157
4198
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
4158
4199
  * @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
4200
  * @param {Object} opts Optional parameters
@@ -4161,6 +4202,7 @@ class WorkforceManagementApi {
4161
4202
  * @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
4203
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
4163
4204
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4205
+ * @deprecated
4164
4206
  */
4165
4207
  getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
4166
4208
  opts = opts || {};
@@ -4436,9 +4478,10 @@ class WorkforceManagementApi {
4436
4478
 
4437
4479
  /**
4438
4480
  * Gets all of my shift trades
4439
- *
4481
+ * Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
4440
4482
  * @param {Object} opts Optional parameters
4441
4483
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4484
+ * @deprecated
4442
4485
  */
4443
4486
  getWorkforcemanagementShifttrades(opts) {
4444
4487
  opts = opts || {};
@@ -5300,9 +5343,49 @@ class WorkforceManagementApi {
5300
5343
  );
5301
5344
  }
5302
5345
 
5346
+ /**
5347
+ * Update the opportunity
5348
+ * Only opportunities with Draft status can be updated.
5349
+ * @param {String} businessUnitId The ID of the business unit
5350
+ * @param {String} opportunityId The ID of the opportunity
5351
+ * @param {Object} body body
5352
+ * @param {Object} opts Optional parameters
5353
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5354
+ */
5355
+ patchWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, body, opts) {
5356
+ opts = opts || {};
5357
+
5358
+ // verify the required parameter 'businessUnitId' is set
5359
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
5360
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';
5361
+ }
5362
+ // verify the required parameter 'opportunityId' is set
5363
+ if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
5364
+ throw 'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';
5365
+ }
5366
+ // verify the required parameter 'body' is set
5367
+ if (body === undefined || body === null) {
5368
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';
5369
+ }
5370
+
5371
+ return this.apiClient.callApi(
5372
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
5373
+ 'PATCH',
5374
+ { 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
5375
+ { },
5376
+ { },
5377
+ { },
5378
+ body,
5379
+ ['PureCloud OAuth'],
5380
+ ['application/json'],
5381
+ ['application/json'],
5382
+ opts['customHeaders']
5383
+ );
5384
+ }
5385
+
5303
5386
  /**
5304
5387
  * Updates the planning group
5305
- *
5388
+ * If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
5306
5389
  * @param {String} businessUnitId The ID of the business unit.
5307
5390
  * @param {String} planningGroupId The ID of a planning group to update
5308
5391
  * @param {Object} body body
@@ -5977,13 +6060,14 @@ class WorkforceManagementApi {
5977
6060
 
5978
6061
  /**
5979
6062
  * Updates a shift trade. This route can only be called by the initiating agent
5980
- *
6063
+ * Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
5981
6064
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
5982
6065
  * @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
6066
  * @param {String} tradeId The ID of the shift trade to update
5984
6067
  * @param {Object} body body
5985
6068
  * @param {Object} opts Optional parameters
5986
6069
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6070
+ * @deprecated
5987
6071
  */
5988
6072
  patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body, opts) {
5989
6073
  opts = opts || {};
@@ -6328,33 +6412,6 @@ class WorkforceManagementApi {
6328
6412
  );
6329
6413
  }
6330
6414
 
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
6415
  /**
6359
6416
  * Request a historical adherence report in bulk
6360
6417
  *
@@ -6609,6 +6666,98 @@ class WorkforceManagementApi {
6609
6666
  );
6610
6667
  }
6611
6668
 
6669
+ /**
6670
+ * Bulk add enrollments to opportunities for the authenticated agent
6671
+ * Allows an agent to enroll in opportunities. This endpoint can return partial success.
6672
+ * @param {Object} body body
6673
+ * @param {Object} opts Optional parameters
6674
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6675
+ */
6676
+ postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body, opts) {
6677
+ opts = opts || {};
6678
+
6679
+ // verify the required parameter 'body' is set
6680
+ if (body === undefined || body === null) {
6681
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';
6682
+ }
6683
+
6684
+ return this.apiClient.callApi(
6685
+ '/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add',
6686
+ 'POST',
6687
+ { },
6688
+ { },
6689
+ { },
6690
+ { },
6691
+ body,
6692
+ ['PureCloud OAuth'],
6693
+ ['application/json'],
6694
+ ['application/json'],
6695
+ opts['customHeaders']
6696
+ );
6697
+ }
6698
+
6699
+ /**
6700
+ * Bulk update enrollment status for the authenticated agent
6701
+ * Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
6702
+ * @param {Object} body body
6703
+ * @param {Object} opts Optional parameters
6704
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6705
+ */
6706
+ postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body, opts) {
6707
+ opts = opts || {};
6708
+
6709
+ // verify the required parameter 'body' is set
6710
+ if (body === undefined || body === null) {
6711
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';
6712
+ }
6713
+
6714
+ return this.apiClient.callApi(
6715
+ '/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update',
6716
+ 'POST',
6717
+ { },
6718
+ { },
6719
+ { },
6720
+ { },
6721
+ body,
6722
+ ['PureCloud OAuth'],
6723
+ ['application/json'],
6724
+ ['application/json'],
6725
+ opts['customHeaders']
6726
+ );
6727
+ }
6728
+
6729
+ /**
6730
+ * Query opportunities for the authenticated agent
6731
+ * Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
6732
+ * @param {Object} body body
6733
+ * @param {Object} opts Optional parameters
6734
+ * @param {Object} opts.expand List of resources to expand
6735
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
6736
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6737
+ */
6738
+ postWorkforcemanagementAgentsOpportunitiesQuery(body, opts) {
6739
+ opts = opts || {};
6740
+
6741
+ // verify the required parameter 'body' is set
6742
+ if (body === undefined || body === null) {
6743
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';
6744
+ }
6745
+
6746
+ return this.apiClient.callApi(
6747
+ '/api/v2/workforcemanagement/agents/opportunities/query',
6748
+ 'POST',
6749
+ { },
6750
+ { 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
6751
+ { },
6752
+ { },
6753
+ body,
6754
+ ['PureCloud OAuth'],
6755
+ ['application/json'],
6756
+ ['application/json'],
6757
+ opts['customHeaders']
6758
+ );
6759
+ }
6760
+
6612
6761
  /**
6613
6762
  * Fetch agent schedules for the logged in user's management unit
6614
6763
  *
@@ -7278,8 +7427,291 @@ class WorkforceManagementApi {
7278
7427
  }
7279
7428
 
7280
7429
  /**
7281
- * Adds a new planning group
7430
+ * Bulk add opportunities
7431
+ *
7432
+ * @param {String} businessUnitId The ID of the business unit
7433
+ * @param {Object} body body
7434
+ * @param {Object} opts Optional parameters
7435
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7436
+ */
7437
+ postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId, body, opts) {
7438
+ opts = opts || {};
7439
+
7440
+ // verify the required parameter 'businessUnitId' is set
7441
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7442
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
7443
+ }
7444
+ // verify the required parameter 'body' is set
7445
+ if (body === undefined || body === null) {
7446
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
7447
+ }
7448
+
7449
+ return this.apiClient.callApi(
7450
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add',
7451
+ 'POST',
7452
+ { 'businessUnitId': businessUnitId },
7453
+ { },
7454
+ { },
7455
+ { },
7456
+ body,
7457
+ ['PureCloud OAuth'],
7458
+ ['application/json'],
7459
+ ['application/json'],
7460
+ opts['customHeaders']
7461
+ );
7462
+ }
7463
+
7464
+ /**
7465
+ * Bulk publish opportunities
7466
+ * Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
7467
+ * @param {String} businessUnitId The ID of the business unit
7468
+ * @param {Object} body body
7469
+ * @param {Object} opts Optional parameters
7470
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7471
+ */
7472
+ postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId, body, opts) {
7473
+ opts = opts || {};
7474
+
7475
+ // verify the required parameter 'businessUnitId' is set
7476
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7477
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
7478
+ }
7479
+ // verify the required parameter 'body' is set
7480
+ if (body === undefined || body === null) {
7481
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
7482
+ }
7483
+
7484
+ return this.apiClient.callApi(
7485
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish',
7486
+ 'POST',
7487
+ { 'businessUnitId': businessUnitId },
7488
+ { },
7489
+ { },
7490
+ { },
7491
+ body,
7492
+ ['PureCloud OAuth'],
7493
+ ['application/json'],
7494
+ ['application/json'],
7495
+ opts['customHeaders']
7496
+ );
7497
+ }
7498
+
7499
+ /**
7500
+ * Bulk remove opportunities
7501
+ * This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
7502
+ * @param {String} businessUnitId The ID of the business unit
7503
+ * @param {Object} body body
7504
+ * @param {Object} opts Optional parameters
7505
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7506
+ */
7507
+ postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId, body, opts) {
7508
+ opts = opts || {};
7509
+
7510
+ // verify the required parameter 'businessUnitId' is set
7511
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7512
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
7513
+ }
7514
+ // verify the required parameter 'body' is set
7515
+ if (body === undefined || body === null) {
7516
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
7517
+ }
7518
+
7519
+ return this.apiClient.callApi(
7520
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove',
7521
+ 'POST',
7522
+ { 'businessUnitId': businessUnitId },
7523
+ { },
7524
+ { },
7525
+ { },
7526
+ body,
7527
+ ['PureCloud OAuth'],
7528
+ ['application/json'],
7529
+ ['application/json'],
7530
+ opts['customHeaders']
7531
+ );
7532
+ }
7533
+
7534
+ /**
7535
+ * Bulk update opportunities status
7536
+ * If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
7537
+ * @param {String} businessUnitId The ID of the business unit
7538
+ * @param {Object} body body
7539
+ * @param {Object} opts Optional parameters
7540
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7541
+ */
7542
+ postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId, body, opts) {
7543
+ opts = opts || {};
7544
+
7545
+ // verify the required parameter 'businessUnitId' is set
7546
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7547
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
7548
+ }
7549
+ // verify the required parameter 'body' is set
7550
+ if (body === undefined || body === null) {
7551
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
7552
+ }
7553
+
7554
+ return this.apiClient.callApi(
7555
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update',
7556
+ 'POST',
7557
+ { 'businessUnitId': businessUnitId },
7558
+ { },
7559
+ { },
7560
+ { },
7561
+ body,
7562
+ ['PureCloud OAuth'],
7563
+ ['application/json'],
7564
+ ['application/json'],
7565
+ opts['customHeaders']
7566
+ );
7567
+ }
7568
+
7569
+ /**
7570
+ * Bulk update enrollment status
7571
+ * Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
7572
+ * @param {String} businessUnitId The ID of the business unit
7573
+ * @param {Object} body body
7574
+ * @param {Object} opts Optional parameters
7575
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7576
+ */
7577
+ postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId, body, opts) {
7578
+ opts = opts || {};
7579
+
7580
+ // verify the required parameter 'businessUnitId' is set
7581
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7582
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
7583
+ }
7584
+ // verify the required parameter 'body' is set
7585
+ if (body === undefined || body === null) {
7586
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
7587
+ }
7588
+
7589
+ return this.apiClient.callApi(
7590
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update',
7591
+ 'POST',
7592
+ { 'businessUnitId': businessUnitId },
7593
+ { },
7594
+ { },
7595
+ { },
7596
+ body,
7597
+ ['PureCloud OAuth'],
7598
+ ['application/json'],
7599
+ ['application/json'],
7600
+ opts['customHeaders']
7601
+ );
7602
+ }
7603
+
7604
+ /**
7605
+ * Query enrollments
7606
+ * For more information about opportunities, use the expand parameter.
7607
+ * @param {String} businessUnitId The ID of the business unit
7608
+ * @param {Object} body body
7609
+ * @param {Object} opts Optional parameters
7610
+ * @param {Object} opts.expand List of resources to expand
7611
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
7612
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7613
+ */
7614
+ postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId, body, opts) {
7615
+ opts = opts || {};
7616
+
7617
+ // verify the required parameter 'businessUnitId' is set
7618
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7619
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
7620
+ }
7621
+ // verify the required parameter 'body' is set
7622
+ if (body === undefined || body === null) {
7623
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
7624
+ }
7625
+
7626
+ return this.apiClient.callApi(
7627
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query',
7628
+ 'POST',
7629
+ { 'businessUnitId': businessUnitId },
7630
+ { 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
7631
+ { },
7632
+ { },
7633
+ body,
7634
+ ['PureCloud OAuth'],
7635
+ ['application/json'],
7636
+ ['application/json'],
7637
+ opts['customHeaders']
7638
+ );
7639
+ }
7640
+
7641
+ /**
7642
+ * Query opportunities by external activity IDs
7282
7643
  *
7644
+ * @param {String} businessUnitId The ID of the business unit
7645
+ * @param {Object} body body
7646
+ * @param {Object} opts Optional parameters
7647
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7648
+ */
7649
+ postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId, body, opts) {
7650
+ opts = opts || {};
7651
+
7652
+ // verify the required parameter 'businessUnitId' is set
7653
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7654
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
7655
+ }
7656
+ // verify the required parameter 'body' is set
7657
+ if (body === undefined || body === null) {
7658
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
7659
+ }
7660
+
7661
+ return this.apiClient.callApi(
7662
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query',
7663
+ 'POST',
7664
+ { 'businessUnitId': businessUnitId },
7665
+ { },
7666
+ { },
7667
+ { },
7668
+ body,
7669
+ ['PureCloud OAuth'],
7670
+ ['application/json'],
7671
+ ['application/json'],
7672
+ opts['customHeaders']
7673
+ );
7674
+ }
7675
+
7676
+ /**
7677
+ * Query opportunities within the specified date range
7678
+ *
7679
+ * @param {String} businessUnitId The ID of the business unit
7680
+ * @param {Object} body body
7681
+ * @param {Object} opts Optional parameters
7682
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
7683
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7684
+ */
7685
+ postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId, body, opts) {
7686
+ opts = opts || {};
7687
+
7688
+ // verify the required parameter 'businessUnitId' is set
7689
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
7690
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
7691
+ }
7692
+ // verify the required parameter 'body' is set
7693
+ if (body === undefined || body === null) {
7694
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
7695
+ }
7696
+
7697
+ return this.apiClient.callApi(
7698
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query',
7699
+ 'POST',
7700
+ { 'businessUnitId': businessUnitId },
7701
+ { 'forceDownloadService': opts['forceDownloadService'] },
7702
+ { },
7703
+ { },
7704
+ body,
7705
+ ['PureCloud OAuth'],
7706
+ ['application/json'],
7707
+ ['application/json'],
7708
+ opts['customHeaders']
7709
+ );
7710
+ }
7711
+
7712
+ /**
7713
+ * Adds a new planning group
7714
+ * If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
7283
7715
  * @param {String} businessUnitId The ID of the business unit.
7284
7716
  * @param {Object} body body
7285
7717
  * @param {Object} opts Optional parameters
@@ -9265,6 +9697,7 @@ class WorkforceManagementApi {
9265
9697
  * @param {String} userId The id of the user for whom the time off request estimate is requested
9266
9698
  * @param {Object} body body
9267
9699
  * @param {Object} opts Optional parameters
9700
+ * @param {Object} opts.includeOnly Limit response to the specified field
9268
9701
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9269
9702
  */
9270
9703
  postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body, opts) {
@@ -9287,7 +9720,7 @@ class WorkforceManagementApi {
9287
9720
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
9288
9721
  'POST',
9289
9722
  { 'managementUnitId': managementUnitId,'userId': userId },
9290
- { },
9723
+ { 'includeOnly': opts['includeOnly'] },
9291
9724
  { },
9292
9725
  { },
9293
9726
  body,
@@ -9300,13 +9733,14 @@ class WorkforceManagementApi {
9300
9733
 
9301
9734
  /**
9302
9735
  * Matches a shift trade. This route can only be called by the receiving agent
9303
- *
9736
+ * Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
9304
9737
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9305
9738
  * @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
9739
  * @param {String} tradeId The ID of the shift trade to update
9307
9740
  * @param {Object} body body
9308
9741
  * @param {Object} opts Optional parameters
9309
9742
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9743
+ * @deprecated
9310
9744
  */
9311
9745
  postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body, opts) {
9312
9746
  opts = opts || {};
@@ -9345,12 +9779,13 @@ class WorkforceManagementApi {
9345
9779
 
9346
9780
  /**
9347
9781
  * Adds a shift trade
9348
- *
9782
+ * Deprecated. Use new route instead (/shifttrading/trades/jobs)
9349
9783
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9350
9784
  * @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
9785
  * @param {Object} body body
9352
9786
  * @param {Object} opts Optional parameters
9353
9787
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9788
+ * @deprecated
9354
9789
  */
9355
9790
  postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body, opts) {
9356
9791
  opts = opts || {};
@@ -9385,13 +9820,14 @@ class WorkforceManagementApi {
9385
9820
 
9386
9821
  /**
9387
9822
  * Searches for potential shift trade matches for the current agent
9388
- *
9823
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
9389
9824
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9390
9825
  * @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
9826
  * @param {Object} body body
9392
9827
  * @param {Object} opts Optional parameters
9393
9828
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
9394
9829
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9830
+ * @deprecated
9395
9831
  */
9396
9832
  postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
9397
9833
  opts = opts || {};
@@ -9426,13 +9862,14 @@ class WorkforceManagementApi {
9426
9862
 
9427
9863
  /**
9428
9864
  * Updates the state of a batch of shift trades
9429
- * Admin functionality is not supported with "mine".
9865
+ * Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
9430
9866
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
9431
9867
  * @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
9868
  * @param {Object} body body
9433
9869
  * @param {Object} opts Optional parameters
9434
9870
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
9435
9871
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
9872
+ * @deprecated
9436
9873
  */
9437
9874
  postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, opts) {
9438
9875
  opts = opts || {};
@@ -10080,6 +10517,7 @@ class WorkforceManagementApi {
10080
10517
  *
10081
10518
  * @param {Object} body body
10082
10519
  * @param {Object} opts Optional parameters
10520
+ * @param {Object} opts.includeOnly Limit response to the specified field
10083
10521
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
10084
10522
  */
10085
10523
  postWorkforcemanagementTimeoffrequestsEstimate(body, opts) {
@@ -10094,7 +10532,7 @@ class WorkforceManagementApi {
10094
10532
  '/api/v2/workforcemanagement/timeoffrequests/estimate',
10095
10533
  'POST',
10096
10534
  { },
10097
- { },
10535
+ { 'includeOnly': opts['includeOnly'] },
10098
10536
  { },
10099
10537
  { },
10100
10538
  body,