purecloud-platform-client-v2 133.0.2 → 135.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 (73) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +680 -200
  3. package/dist/web-amd/purecloud-platform-client-v2.js +680 -200
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +680 -200
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +692 -204
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1060 -221
  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 +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +78 -3
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +14 -6
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -3
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +160 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
  60. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -26
  63. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +269 -49
  73. 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 133.0.2
8
+ * @version 135.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -203,7 +203,7 @@ class WorkforceManagementApi {
203
203
  /**
204
204
  * Delete a short term forecast
205
205
  * Must not be tied to any schedules
206
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
206
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
207
207
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
208
208
  * @param {String} forecastId The ID of the forecast
209
209
  */
@@ -283,7 +283,7 @@ class WorkforceManagementApi {
283
283
  /**
284
284
  * Deletes a time off limit object
285
285
  *
286
- * @param {String} managementUnitId The management unit ID of the management unit.
286
+ * @param {String} managementUnitId The ID of the management unit.
287
287
  * @param {String} timeOffLimitId The ID of the time off limit object to delete
288
288
  */
289
289
  deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
@@ -313,7 +313,7 @@ class WorkforceManagementApi {
313
313
  /**
314
314
  * Deletes a time off plan
315
315
  *
316
- * @param {String} managementUnitId The management unit ID.
316
+ * @param {String} managementUnitId The ID of the management unit
317
317
  * @param {String} timeOffPlanId The ID of the time off plan to delete
318
318
  */
319
319
  deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
@@ -582,7 +582,7 @@ class WorkforceManagementApi {
582
582
  /**
583
583
  * Get intraday planning groups for the given date
584
584
  *
585
- * @param {String} businessUnitId The business unit ID of the business unit
585
+ * @param {String} businessUnitId The ID of the business unit
586
586
  * @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
587
587
  */
588
588
  getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
@@ -1035,7 +1035,7 @@ class WorkforceManagementApi {
1035
1035
  /**
1036
1036
  * Get a short term forecast
1037
1037
  *
1038
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
1038
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
1039
1039
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1040
1040
  * @param {String} forecastId The ID of the forecast
1041
1041
  * @param {Object} opts Optional parameters
@@ -1074,7 +1074,7 @@ class WorkforceManagementApi {
1074
1074
  /**
1075
1075
  * Get the result of a short term forecast calculation
1076
1076
  * Includes modifications unless you pass the doNotApplyModifications query parameter
1077
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
1077
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
1078
1078
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1079
1079
  * @param {String} forecastId The ID of the forecast
1080
1080
  * @param {Object} opts Optional parameters
@@ -1114,7 +1114,7 @@ class WorkforceManagementApi {
1114
1114
  /**
1115
1115
  * Gets the forecast generation results
1116
1116
  *
1117
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
1117
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
1118
1118
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1119
1119
  * @param {String} forecastId The ID of the forecast
1120
1120
  */
@@ -1149,7 +1149,7 @@ class WorkforceManagementApi {
1149
1149
  /**
1150
1150
  * Get the result of a long term forecast calculation
1151
1151
  * Includes modifications unless you pass the doNotApplyModifications query parameter
1152
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
1152
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
1153
1153
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1154
1154
  * @param {String} forecastId The ID of the forecast
1155
1155
  * @param {Object} opts Optional parameters
@@ -1188,7 +1188,7 @@ class WorkforceManagementApi {
1188
1188
  /**
1189
1189
  * Gets the forecast planning group snapshot
1190
1190
  *
1191
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
1191
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
1192
1192
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1193
1193
  * @param {String} forecastId The ID of the forecast
1194
1194
  */
@@ -1223,7 +1223,7 @@ class WorkforceManagementApi {
1223
1223
  /**
1224
1224
  * Get short term forecasts
1225
1225
  * Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
1226
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
1226
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
1227
1227
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
1228
1228
  */
1229
1229
  getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
@@ -1441,7 +1441,7 @@ class WorkforceManagementApi {
1441
1441
  /**
1442
1442
  * Get a list of user schedule adherence records for the requested management unit
1443
1443
  *
1444
- * @param {String} managementUnitId The management unit ID of the management unit.
1444
+ * @param {String} managementUnitId The ID of the management unit
1445
1445
  * @param {Object} opts Optional parameters
1446
1446
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
1447
1447
  */
@@ -1470,7 +1470,7 @@ class WorkforceManagementApi {
1470
1470
  /**
1471
1471
  * Get data for agent in the management unit
1472
1472
  *
1473
- * @param {String} managementUnitId The id of the management unit, or 'mine' for the management unit of the logged-in user.
1473
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1474
1474
  * @param {String} agentId The agent id
1475
1475
  * @param {Object} opts Optional parameters
1476
1476
  * @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
@@ -1504,7 +1504,7 @@ class WorkforceManagementApi {
1504
1504
  /**
1505
1505
  * Gets all the shift trades for a given agent
1506
1506
  *
1507
- * @param {String} managementUnitId The id of the management unit, or 'mine' for the management unit of the logged-in user.
1507
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1508
1508
  * @param {String} agentId The agent id
1509
1509
  */
1510
1510
  getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
@@ -1534,7 +1534,7 @@ class WorkforceManagementApi {
1534
1534
  /**
1535
1535
  * Gets a summary of all shift trades in the matched state
1536
1536
  *
1537
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1537
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1538
1538
  */
1539
1539
  getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
1540
1540
  // verify the required parameter 'managementUnitId' is set
@@ -1559,7 +1559,7 @@ class WorkforceManagementApi {
1559
1559
  /**
1560
1560
  * Gets list of users available for whom you can send direct shift trade requests
1561
1561
  *
1562
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1562
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1563
1563
  */
1564
1564
  getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
1565
1565
  // verify the required parameter 'managementUnitId' is set
@@ -1584,7 +1584,7 @@ class WorkforceManagementApi {
1584
1584
  /**
1585
1585
  * Gets a time off limit object
1586
1586
  * Returns properties of time off limit object, but not daily values.
1587
- * @param {String} managementUnitId The management unit ID of the management unit.
1587
+ * @param {String} managementUnitId The ID of the management unit.
1588
1588
  * @param {String} timeOffLimitId The ID of the time off limit to fetch
1589
1589
  */
1590
1590
  getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
@@ -1614,7 +1614,7 @@ class WorkforceManagementApi {
1614
1614
  /**
1615
1615
  * Gets a list of time off limit objects under management unit.
1616
1616
  * Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
1617
- * @param {String} managementUnitId The management unit ID of the management unit.
1617
+ * @param {String} managementUnitId The ID of the management unit.
1618
1618
  */
1619
1619
  getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
1620
1620
  // verify the required parameter 'managementUnitId' is set
@@ -1639,7 +1639,7 @@ class WorkforceManagementApi {
1639
1639
  /**
1640
1640
  * Gets a time off plan
1641
1641
  *
1642
- * @param {String} managementUnitId The management unit ID.
1642
+ * @param {String} managementUnitId The ID of the management unit
1643
1643
  * @param {String} timeOffPlanId The ID of the time off plan to fetch
1644
1644
  */
1645
1645
  getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
@@ -1669,7 +1669,7 @@ class WorkforceManagementApi {
1669
1669
  /**
1670
1670
  * Gets a list of time off plans
1671
1671
  *
1672
- * @param {String} managementUnitId The management unit ID.
1672
+ * @param {String} managementUnitId The ID of the management unit
1673
1673
  */
1674
1674
  getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
1675
1675
  // verify the required parameter 'managementUnitId' is set
@@ -1694,7 +1694,7 @@ class WorkforceManagementApi {
1694
1694
  /**
1695
1695
  * Get a time off request
1696
1696
  *
1697
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
1697
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1698
1698
  * @param {String} userId The userId to whom the Time Off Request applies.
1699
1699
  * @param {String} timeOffRequestId Time Off Request Id
1700
1700
  */
@@ -1729,7 +1729,7 @@ class WorkforceManagementApi {
1729
1729
  /**
1730
1730
  * Retrieves time off limit, allocated and waitlisted values according to specific time off request
1731
1731
  *
1732
- * @param {String} managementUnitId The management unit ID of the management unit.
1732
+ * @param {String} managementUnitId The ID of the management unit.
1733
1733
  * @param {String} userId The userId to whom the time off request applies.
1734
1734
  * @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
1735
1735
  */
@@ -1764,7 +1764,7 @@ class WorkforceManagementApi {
1764
1764
  /**
1765
1765
  * Get a list of time off requests for a given user
1766
1766
  *
1767
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
1767
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1768
1768
  * @param {String} userId The userId to whom the Time Off Request applies.
1769
1769
  * @param {Object} opts Optional parameters
1770
1770
  * @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
@@ -1798,7 +1798,7 @@ class WorkforceManagementApi {
1798
1798
  /**
1799
1799
  * Get users in the management unit
1800
1800
  *
1801
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1801
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1802
1802
  */
1803
1803
  getWorkforcemanagementManagementunitUsers(managementUnitId) {
1804
1804
  // verify the required parameter 'managementUnitId' is set
@@ -1899,7 +1899,7 @@ class WorkforceManagementApi {
1899
1899
  /**
1900
1900
  * Gets all the shift trades for a given week
1901
1901
  *
1902
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1902
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1903
1903
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1904
1904
  * @param {Object} opts Optional parameters
1905
1905
  * @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
@@ -2172,7 +2172,7 @@ class WorkforceManagementApi {
2172
2172
  /**
2173
2173
  * Get a time off request for the current user
2174
2174
  *
2175
- * @param {String} timeOffRequestId Time Off Request Id
2175
+ * @param {String} timeOffRequestId The ID of the time off request
2176
2176
  */
2177
2177
  getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
2178
2178
  // verify the required parameter 'timeOffRequestId' is set
@@ -2197,7 +2197,7 @@ class WorkforceManagementApi {
2197
2197
  /**
2198
2198
  * Get the daily waitlist positions of a time off request for the current user
2199
2199
  *
2200
- * @param {String} timeOffRequestId Time Off Request Id
2200
+ * @param {String} timeOffRequestId The ID of the time off request
2201
2201
  */
2202
2202
  getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
2203
2203
  // verify the required parameter 'timeOffRequestId' is set
@@ -2440,7 +2440,7 @@ class WorkforceManagementApi {
2440
2440
  /**
2441
2441
  * Updates a time off limit object.
2442
2442
  * Updates time off limit object properties, but not daily values.
2443
- * @param {String} managementUnitId The management unit ID of the management unit.
2443
+ * @param {String} managementUnitId The ID of the management unit.
2444
2444
  * @param {String} timeOffLimitId The id of time off limit object to update
2445
2445
  * @param {Object} opts Optional parameters
2446
2446
  * @param {Object} opts.body body
@@ -2474,7 +2474,7 @@ class WorkforceManagementApi {
2474
2474
  /**
2475
2475
  * Updates a time off plan
2476
2476
  *
2477
- * @param {String} managementUnitId The management unit ID.
2477
+ * @param {String} managementUnitId The ID of the management unit
2478
2478
  * @param {String} timeOffPlanId The ID of the time off plan to update
2479
2479
  * @param {Object} opts Optional parameters
2480
2480
  * @param {Object} opts.body body
@@ -2508,7 +2508,7 @@ class WorkforceManagementApi {
2508
2508
  /**
2509
2509
  * Update a time off request
2510
2510
  *
2511
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
2511
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2512
2512
  * @param {String} userId The id of the user the requested time off request belongs to
2513
2513
  * @param {String} timeOffRequestId The id of the time off request to update
2514
2514
  * @param {Object} opts Optional parameters
@@ -2547,7 +2547,7 @@ class WorkforceManagementApi {
2547
2547
  /**
2548
2548
  * Updates a shift trade. This route can only be called by the initiating agent
2549
2549
  *
2550
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
2550
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2551
2551
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
2552
2552
  * @param {Object} body body
2553
2553
  * @param {String} tradeId The ID of the shift trade to update
@@ -2656,7 +2656,7 @@ class WorkforceManagementApi {
2656
2656
  /**
2657
2657
  * Update a time off request for the current user
2658
2658
  *
2659
- * @param {String} timeOffRequestId Time Off Request Id
2659
+ * @param {String} timeOffRequestId The ID of the time off request
2660
2660
  * @param {Object} opts Optional parameters
2661
2661
  * @param {Object} opts.body body
2662
2662
  */
@@ -2793,7 +2793,7 @@ class WorkforceManagementApi {
2793
2793
  /**
2794
2794
  * Get intraday data for the given date for the requested planningGroupIds
2795
2795
  *
2796
- * @param {String} businessUnitId The business unit ID of the business unit
2796
+ * @param {String} businessUnitId The ID of the business unit
2797
2797
  * @param {Object} opts Optional parameters
2798
2798
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
2799
2799
  * @param {Object} opts.body body
@@ -3003,6 +3003,86 @@ class WorkforceManagementApi {
3003
3003
  );
3004
3004
  }
3005
3005
 
3006
+ /**
3007
+ * Starts processing a schedule update
3008
+ * Call after uploading the schedule data to the url supplied by the /update/uploadurl route
3009
+ * @param {String} businessUnitId The ID of the business unit
3010
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3011
+ * @param {String} scheduleId The ID of the schedule
3012
+ * @param {Object} body body
3013
+ */
3014
+ postWorkforcemanagementBusinessunitWeekScheduleUpdate(businessUnitId, weekId, scheduleId, body) {
3015
+ // verify the required parameter 'businessUnitId' is set
3016
+ if (businessUnitId === undefined || businessUnitId === null) {
3017
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
3018
+ }
3019
+ // verify the required parameter 'weekId' is set
3020
+ if (weekId === undefined || weekId === null) {
3021
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
3022
+ }
3023
+ // verify the required parameter 'scheduleId' is set
3024
+ if (scheduleId === undefined || scheduleId === null) {
3025
+ throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
3026
+ }
3027
+ // verify the required parameter 'body' is set
3028
+ if (body === undefined || body === null) {
3029
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
3030
+ }
3031
+
3032
+ return this.apiClient.callApi(
3033
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update',
3034
+ 'POST',
3035
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
3036
+ { },
3037
+ { },
3038
+ { },
3039
+ body,
3040
+ ['PureCloud OAuth'],
3041
+ ['application/json'],
3042
+ ['application/json']
3043
+ );
3044
+ }
3045
+
3046
+ /**
3047
+ * Creates a signed upload URL for updating a schedule
3048
+ * Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process
3049
+ * @param {String} businessUnitId The ID of the business unit
3050
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3051
+ * @param {String} scheduleId The ID of the schedule
3052
+ * @param {Object} body body
3053
+ */
3054
+ postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(businessUnitId, weekId, scheduleId, body) {
3055
+ // verify the required parameter 'businessUnitId' is set
3056
+ if (businessUnitId === undefined || businessUnitId === null) {
3057
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
3058
+ }
3059
+ // verify the required parameter 'weekId' is set
3060
+ if (weekId === undefined || weekId === null) {
3061
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
3062
+ }
3063
+ // verify the required parameter 'scheduleId' is set
3064
+ if (scheduleId === undefined || scheduleId === null) {
3065
+ throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
3066
+ }
3067
+ // verify the required parameter 'body' is set
3068
+ if (body === undefined || body === null) {
3069
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
3070
+ }
3071
+
3072
+ return this.apiClient.callApi(
3073
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl',
3074
+ 'POST',
3075
+ { 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
3076
+ { },
3077
+ { },
3078
+ { },
3079
+ body,
3080
+ ['PureCloud OAuth'],
3081
+ ['application/json'],
3082
+ ['application/json']
3083
+ );
3084
+ }
3085
+
3006
3086
  /**
3007
3087
  * Create a blank schedule
3008
3088
  *
@@ -3073,10 +3153,80 @@ class WorkforceManagementApi {
3073
3153
  );
3074
3154
  }
3075
3155
 
3156
+ /**
3157
+ * Starts processing a schedule import
3158
+ * Call after uploading the schedule data to the url supplied by the /import/uploadurl route
3159
+ * @param {String} businessUnitId The ID of the business unit
3160
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3161
+ * @param {Object} body
3162
+ */
3163
+ postWorkforcemanagementBusinessunitWeekSchedulesImport(businessUnitId, weekId, body) {
3164
+ // verify the required parameter 'businessUnitId' is set
3165
+ if (businessUnitId === undefined || businessUnitId === null) {
3166
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
3167
+ }
3168
+ // verify the required parameter 'weekId' is set
3169
+ if (weekId === undefined || weekId === null) {
3170
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
3171
+ }
3172
+ // verify the required parameter 'body' is set
3173
+ if (body === undefined || body === null) {
3174
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
3175
+ }
3176
+
3177
+ return this.apiClient.callApi(
3178
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import',
3179
+ 'POST',
3180
+ { 'businessUnitId': businessUnitId,'weekId': weekId },
3181
+ { },
3182
+ { },
3183
+ { },
3184
+ body,
3185
+ ['PureCloud OAuth'],
3186
+ ['application/json'],
3187
+ ['application/json']
3188
+ );
3189
+ }
3190
+
3191
+ /**
3192
+ * Creates a signed upload URL for importing a schedule
3193
+ * Once the upload is complete, call the /import route to start the schedule import process
3194
+ * @param {String} businessUnitId The ID of the business unit
3195
+ * @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3196
+ * @param {Object} body body
3197
+ */
3198
+ postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(businessUnitId, weekId, body) {
3199
+ // verify the required parameter 'businessUnitId' is set
3200
+ if (businessUnitId === undefined || businessUnitId === null) {
3201
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
3202
+ }
3203
+ // verify the required parameter 'weekId' is set
3204
+ if (weekId === undefined || weekId === null) {
3205
+ throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
3206
+ }
3207
+ // verify the required parameter 'body' is set
3208
+ if (body === undefined || body === null) {
3209
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
3210
+ }
3211
+
3212
+ return this.apiClient.callApi(
3213
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl',
3214
+ 'POST',
3215
+ { 'businessUnitId': businessUnitId,'weekId': weekId },
3216
+ { },
3217
+ { },
3218
+ { },
3219
+ body,
3220
+ ['PureCloud OAuth'],
3221
+ ['application/json'],
3222
+ ['application/json']
3223
+ );
3224
+ }
3225
+
3076
3226
  /**
3077
3227
  * Copy a short term forecast
3078
3228
  *
3079
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
3229
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3080
3230
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3081
3231
  * @param {String} forecastId The ID of the forecast to copy
3082
3232
  * @param {Object} body body
@@ -3120,7 +3270,7 @@ class WorkforceManagementApi {
3120
3270
  /**
3121
3271
  * Generate a short term forecast
3122
3272
  *
3123
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
3273
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3124
3274
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3125
3275
  * @param {Object} body
3126
3276
  * @param {Object} opts Optional parameters
@@ -3156,6 +3306,76 @@ class WorkforceManagementApi {
3156
3306
  );
3157
3307
  }
3158
3308
 
3309
+ /**
3310
+ * Starts importing the uploaded short term forecast
3311
+ * Call after uploading the forecast data to the url supplied by the /import/uploadurl route
3312
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3313
+ * @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3314
+ * @param {Object} body
3315
+ */
3316
+ postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body) {
3317
+ // verify the required parameter 'businessUnitId' is set
3318
+ if (businessUnitId === undefined || businessUnitId === null) {
3319
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
3320
+ }
3321
+ // verify the required parameter 'weekDateId' is set
3322
+ if (weekDateId === undefined || weekDateId === null) {
3323
+ throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
3324
+ }
3325
+ // verify the required parameter 'body' is set
3326
+ if (body === undefined || body === null) {
3327
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
3328
+ }
3329
+
3330
+ return this.apiClient.callApi(
3331
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import',
3332
+ 'POST',
3333
+ { 'businessUnitId': businessUnitId,'weekDateId': weekDateId },
3334
+ { },
3335
+ { },
3336
+ { },
3337
+ body,
3338
+ ['PureCloud OAuth'],
3339
+ ['application/json'],
3340
+ ['application/json']
3341
+ );
3342
+ }
3343
+
3344
+ /**
3345
+ * Creates a signed upload URL for importing a short term forecast
3346
+ * Once the upload is complete, call the /import route to start the short term forecast import process
3347
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
3348
+ * @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3349
+ * @param {Object} body body
3350
+ */
3351
+ postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(businessUnitId, weekDateId, body) {
3352
+ // verify the required parameter 'businessUnitId' is set
3353
+ if (businessUnitId === undefined || businessUnitId === null) {
3354
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
3355
+ }
3356
+ // verify the required parameter 'weekDateId' is set
3357
+ if (weekDateId === undefined || weekDateId === null) {
3358
+ throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
3359
+ }
3360
+ // verify the required parameter 'body' is set
3361
+ if (body === undefined || body === null) {
3362
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
3363
+ }
3364
+
3365
+ return this.apiClient.callApi(
3366
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl',
3367
+ 'POST',
3368
+ { 'businessUnitId': businessUnitId,'weekDateId': weekDateId },
3369
+ { },
3370
+ { },
3371
+ { },
3372
+ body,
3373
+ ['PureCloud OAuth'],
3374
+ ['application/json'],
3375
+ ['application/json']
3376
+ );
3377
+ }
3378
+
3159
3379
  /**
3160
3380
  * Add a new business unit
3161
3381
  * It may take a minute or two for a new business unit to be available for api operations
@@ -3251,7 +3471,7 @@ class WorkforceManagementApi {
3251
3471
  /**
3252
3472
  * Query published schedules for given given time range for set of users
3253
3473
  *
3254
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3474
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3255
3475
  * @param {Object} opts Optional parameters
3256
3476
  * @param {Object} opts.body body
3257
3477
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
@@ -3282,7 +3502,7 @@ class WorkforceManagementApi {
3282
3502
  /**
3283
3503
  * Request a historical adherence report
3284
3504
  * The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
3285
- * @param {String} managementUnitId The management unit ID of the management unit
3505
+ * @param {String} managementUnitId The ID of the management unit
3286
3506
  * @param {Object} opts Optional parameters
3287
3507
  * @param {Object} opts.body body
3288
3508
  */
@@ -3340,7 +3560,7 @@ class WorkforceManagementApi {
3340
3560
  /**
3341
3561
  * Query published schedules for given given time range for set of users
3342
3562
  *
3343
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3563
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3344
3564
  * @param {Object} opts Optional parameters
3345
3565
  * @param {Object} opts.body body
3346
3566
  */
@@ -3369,7 +3589,7 @@ class WorkforceManagementApi {
3369
3589
  /**
3370
3590
  * Creates a new time off limit object under management unit.
3371
3591
  * Only one limit object is allowed under management unit, so an attempt to create second object will fail.
3372
- * @param {String} managementUnitId The management unit ID of the management unit.
3592
+ * @param {String} managementUnitId The ID of the management unit.
3373
3593
  * @param {Object} opts Optional parameters
3374
3594
  * @param {Object} opts.body body
3375
3595
  */
@@ -3398,7 +3618,7 @@ class WorkforceManagementApi {
3398
3618
  /**
3399
3619
  * Retrieves time off limit related values based on a given set of filters.
3400
3620
  *
3401
- * @param {String} managementUnitId The management unit ID of the management unit.
3621
+ * @param {String} managementUnitId The ID of the management unit.
3402
3622
  * @param {Object} opts Optional parameters
3403
3623
  * @param {Object} opts.body body
3404
3624
  */
@@ -3427,7 +3647,7 @@ class WorkforceManagementApi {
3427
3647
  /**
3428
3648
  * Creates a new time off plan
3429
3649
  *
3430
- * @param {String} managementUnitId The management unit ID.
3650
+ * @param {String} managementUnitId The ID of the management unit
3431
3651
  * @param {Object} opts Optional parameters
3432
3652
  * @param {Object} opts.body body
3433
3653
  */
@@ -3456,7 +3676,7 @@ class WorkforceManagementApi {
3456
3676
  /**
3457
3677
  * Create a new time off request
3458
3678
  *
3459
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3679
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3460
3680
  * @param {Object} opts Optional parameters
3461
3681
  * @param {Object} opts.body body
3462
3682
  */
@@ -3485,7 +3705,7 @@ class WorkforceManagementApi {
3485
3705
  /**
3486
3706
  * Fetches time off requests matching the conditions specified in the request body
3487
3707
  * Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
3488
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3708
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3489
3709
  * @param {Object} opts Optional parameters
3490
3710
  * @param {Object} opts.body body
3491
3711
  */
@@ -3514,7 +3734,7 @@ class WorkforceManagementApi {
3514
3734
  /**
3515
3735
  * Retrieves daily waitlist position for a list of time off requests
3516
3736
  *
3517
- * @param {String} managementUnitId The management unit ID of the management unit.
3737
+ * @param {String} managementUnitId The ID of the management unit.
3518
3738
  * @param {Object} opts Optional parameters
3519
3739
  * @param {Object} opts.body body
3520
3740
  */
@@ -3543,7 +3763,7 @@ class WorkforceManagementApi {
3543
3763
  /**
3544
3764
  * Matches a shift trade. This route can only be called by the receiving agent
3545
3765
  *
3546
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3766
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3547
3767
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3548
3768
  * @param {Object} body body
3549
3769
  * @param {String} tradeId The ID of the shift trade to update
@@ -3583,7 +3803,7 @@ class WorkforceManagementApi {
3583
3803
  /**
3584
3804
  * Adds a shift trade
3585
3805
  *
3586
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3806
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3587
3807
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3588
3808
  * @param {Object} body body
3589
3809
  */
@@ -3618,7 +3838,7 @@ class WorkforceManagementApi {
3618
3838
  /**
3619
3839
  * Searches for potential shift trade matches for the current agent
3620
3840
  *
3621
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3841
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3622
3842
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3623
3843
  * @param {Object} body body
3624
3844
  */
@@ -3653,7 +3873,7 @@ class WorkforceManagementApi {
3653
3873
  /**
3654
3874
  * Updates the state of a batch of shift trades
3655
3875
  * Admin functionality is not supported with \"mine\".
3656
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3876
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3657
3877
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3658
3878
  * @param {Object} body body
3659
3879
  * @param {Object} opts Optional parameters
@@ -3974,7 +4194,7 @@ class WorkforceManagementApi {
3974
4194
  /**
3975
4195
  * Sets daily values for a date range of time off limit object
3976
4196
  * Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
3977
- * @param {String} managementUnitId The management unit ID of the management unit.
4197
+ * @param {String} managementUnitId The ID of the management unit.
3978
4198
  * @param {String} timeOffLimitId The ID of the time off limit object to set values for
3979
4199
  * @param {Object} opts Optional parameters
3980
4200
  * @param {Object} opts.body body