purecloud-platform-client-v2 134.0.0 → 136.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.
- package/README.md +32 -29
- package/dist/node/purecloud-platform-client-v2.js +388 -214
- package/dist/web-amd/purecloud-platform-client-v2.js +388 -214
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +388 -214
- package/dist/web-cjs/purecloud-platform-client-v2.js +398 -225
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +364 -35
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +29 -29
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +11 -9
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +132 -5
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -51
- 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
|
|
8
|
+
* @version 136.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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
@@ -3226,7 +3226,7 @@ class WorkforceManagementApi {
|
|
|
3226
3226
|
/**
|
|
3227
3227
|
* Copy a short term forecast
|
|
3228
3228
|
*
|
|
3229
|
-
* @param {String} businessUnitId The
|
|
3229
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
3230
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
|
|
3231
3231
|
* @param {String} forecastId The ID of the forecast to copy
|
|
3232
3232
|
* @param {Object} body body
|
|
@@ -3270,7 +3270,7 @@ class WorkforceManagementApi {
|
|
|
3270
3270
|
/**
|
|
3271
3271
|
* Generate a short term forecast
|
|
3272
3272
|
*
|
|
3273
|
-
* @param {String} businessUnitId The
|
|
3273
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
3274
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
|
|
3275
3275
|
* @param {Object} body
|
|
3276
3276
|
* @param {Object} opts Optional parameters
|
|
@@ -3309,7 +3309,7 @@ class WorkforceManagementApi {
|
|
|
3309
3309
|
/**
|
|
3310
3310
|
* Starts importing the uploaded short term forecast
|
|
3311
3311
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
3312
|
-
* @param {String} businessUnitId The
|
|
3312
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
3313
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
3314
|
* @param {Object} body
|
|
3315
3315
|
*/
|
|
@@ -3344,7 +3344,7 @@ class WorkforceManagementApi {
|
|
|
3344
3344
|
/**
|
|
3345
3345
|
* Creates a signed upload URL for importing a short term forecast
|
|
3346
3346
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
3347
|
-
* @param {String} businessUnitId The
|
|
3347
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
3348
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
3349
|
* @param {Object} body body
|
|
3350
3350
|
*/
|
|
@@ -3471,7 +3471,7 @@ class WorkforceManagementApi {
|
|
|
3471
3471
|
/**
|
|
3472
3472
|
* Query published schedules for given given time range for set of users
|
|
3473
3473
|
*
|
|
3474
|
-
* @param {String} managementUnitId The
|
|
3474
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3475
3475
|
* @param {Object} opts Optional parameters
|
|
3476
3476
|
* @param {Object} opts.body body
|
|
3477
3477
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -3502,7 +3502,7 @@ class WorkforceManagementApi {
|
|
|
3502
3502
|
/**
|
|
3503
3503
|
* Request a historical adherence report
|
|
3504
3504
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
3505
|
-
* @param {String} managementUnitId The
|
|
3505
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
3506
3506
|
* @param {Object} opts Optional parameters
|
|
3507
3507
|
* @param {Object} opts.body body
|
|
3508
3508
|
*/
|
|
@@ -3560,7 +3560,7 @@ class WorkforceManagementApi {
|
|
|
3560
3560
|
/**
|
|
3561
3561
|
* Query published schedules for given given time range for set of users
|
|
3562
3562
|
*
|
|
3563
|
-
* @param {String} managementUnitId The
|
|
3563
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3564
3564
|
* @param {Object} opts Optional parameters
|
|
3565
3565
|
* @param {Object} opts.body body
|
|
3566
3566
|
*/
|
|
@@ -3589,7 +3589,7 @@ class WorkforceManagementApi {
|
|
|
3589
3589
|
/**
|
|
3590
3590
|
* Creates a new time off limit object under management unit.
|
|
3591
3591
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
3592
|
-
* @param {String} managementUnitId The
|
|
3592
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
3593
3593
|
* @param {Object} opts Optional parameters
|
|
3594
3594
|
* @param {Object} opts.body body
|
|
3595
3595
|
*/
|
|
@@ -3618,7 +3618,7 @@ class WorkforceManagementApi {
|
|
|
3618
3618
|
/**
|
|
3619
3619
|
* Retrieves time off limit related values based on a given set of filters.
|
|
3620
3620
|
*
|
|
3621
|
-
* @param {String} managementUnitId The
|
|
3621
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
3622
3622
|
* @param {Object} opts Optional parameters
|
|
3623
3623
|
* @param {Object} opts.body body
|
|
3624
3624
|
*/
|
|
@@ -3647,7 +3647,7 @@ class WorkforceManagementApi {
|
|
|
3647
3647
|
/**
|
|
3648
3648
|
* Creates a new time off plan
|
|
3649
3649
|
*
|
|
3650
|
-
* @param {String} managementUnitId The management unit
|
|
3650
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
3651
3651
|
* @param {Object} opts Optional parameters
|
|
3652
3652
|
* @param {Object} opts.body body
|
|
3653
3653
|
*/
|
|
@@ -3676,7 +3676,7 @@ class WorkforceManagementApi {
|
|
|
3676
3676
|
/**
|
|
3677
3677
|
* Create a new time off request
|
|
3678
3678
|
*
|
|
3679
|
-
* @param {String} managementUnitId The
|
|
3679
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3680
3680
|
* @param {Object} opts Optional parameters
|
|
3681
3681
|
* @param {Object} opts.body body
|
|
3682
3682
|
*/
|
|
@@ -3705,7 +3705,7 @@ class WorkforceManagementApi {
|
|
|
3705
3705
|
/**
|
|
3706
3706
|
* Fetches time off requests matching the conditions specified in the request body
|
|
3707
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
|
|
3708
|
-
* @param {String} managementUnitId The
|
|
3708
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3709
3709
|
* @param {Object} opts Optional parameters
|
|
3710
3710
|
* @param {Object} opts.body body
|
|
3711
3711
|
*/
|
|
@@ -3734,7 +3734,7 @@ class WorkforceManagementApi {
|
|
|
3734
3734
|
/**
|
|
3735
3735
|
* Retrieves daily waitlist position for a list of time off requests
|
|
3736
3736
|
*
|
|
3737
|
-
* @param {String} managementUnitId The
|
|
3737
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
3738
3738
|
* @param {Object} opts Optional parameters
|
|
3739
3739
|
* @param {Object} opts.body body
|
|
3740
3740
|
*/
|
|
@@ -3763,7 +3763,7 @@ class WorkforceManagementApi {
|
|
|
3763
3763
|
/**
|
|
3764
3764
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
3765
3765
|
*
|
|
3766
|
-
* @param {String} managementUnitId The
|
|
3766
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3767
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
|
|
3768
3768
|
* @param {Object} body body
|
|
3769
3769
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -3803,7 +3803,7 @@ class WorkforceManagementApi {
|
|
|
3803
3803
|
/**
|
|
3804
3804
|
* Adds a shift trade
|
|
3805
3805
|
*
|
|
3806
|
-
* @param {String} managementUnitId The
|
|
3806
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3807
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
|
|
3808
3808
|
* @param {Object} body body
|
|
3809
3809
|
*/
|
|
@@ -3838,7 +3838,7 @@ class WorkforceManagementApi {
|
|
|
3838
3838
|
/**
|
|
3839
3839
|
* Searches for potential shift trade matches for the current agent
|
|
3840
3840
|
*
|
|
3841
|
-
* @param {String} managementUnitId The
|
|
3841
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3842
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
|
|
3843
3843
|
* @param {Object} body body
|
|
3844
3844
|
*/
|
|
@@ -3873,7 +3873,7 @@ class WorkforceManagementApi {
|
|
|
3873
3873
|
/**
|
|
3874
3874
|
* Updates the state of a batch of shift trades
|
|
3875
3875
|
* Admin functionality is not supported with \"mine\".
|
|
3876
|
-
* @param {String} managementUnitId The
|
|
3876
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3877
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
|
|
3878
3878
|
* @param {Object} body body
|
|
3879
3879
|
* @param {Object} opts Optional parameters
|
|
@@ -4194,7 +4194,7 @@ class WorkforceManagementApi {
|
|
|
4194
4194
|
/**
|
|
4195
4195
|
* Sets daily values for a date range of time off limit object
|
|
4196
4196
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
4197
|
-
* @param {String} managementUnitId The
|
|
4197
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
4198
4198
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
4199
4199
|
* @param {Object} opts Optional parameters
|
|
4200
4200
|
* @param {Object} opts.body body
|