purecloud-platform-client-v2 226.0.0 → 228.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1911 -237
- package/dist/web-amd/purecloud-platform-client-v2.js +1911 -237
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +596 -188
- package/dist/web-cjs/purecloud-platform-client-v2.js +596 -188
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1833 -774
- package/package.json +4 -4
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +32 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +391 -26
- 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/BusinessRulesApi.js +4 -46
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +52 -4
- 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 +61 -35
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +60 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- 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/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +86 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -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/LogCaptureApi.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/OperationalEventsApi.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 +101 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +53 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -26
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +158 -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/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +105 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- 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 +121 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -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 +12 -12
- 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 +6 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +519 -6
- 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 228.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -75,6 +75,40 @@ class WorkforceManagementApi {
|
|
|
75
75
|
);
|
|
76
76
|
}
|
|
77
77
|
|
|
78
|
+
/**
|
|
79
|
+
* Delete staffing group allocations history created for a capacity plan before the given date
|
|
80
|
+
*
|
|
81
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
82
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
83
|
+
* @param {Object} opts Optional parameters
|
|
84
|
+
* @param {String} opts.beforeDateId The date to delete records that are created on or before this date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
85
|
+
*/
|
|
86
|
+
deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory(businessUnitId, capacityPlanId, opts) {
|
|
87
|
+
opts = opts || {};
|
|
88
|
+
|
|
89
|
+
// verify the required parameter 'businessUnitId' is set
|
|
90
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
91
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory';
|
|
92
|
+
}
|
|
93
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
94
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
95
|
+
throw 'Missing the required parameter "capacityPlanId" when calling deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory';
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
return this.apiClient.callApi(
|
|
99
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory',
|
|
100
|
+
'DELETE',
|
|
101
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
102
|
+
{ 'beforeDateId': opts['beforeDateId'] },
|
|
103
|
+
{ },
|
|
104
|
+
{ },
|
|
105
|
+
null,
|
|
106
|
+
['PureCloud OAuth'],
|
|
107
|
+
['application/json'],
|
|
108
|
+
['application/json']
|
|
109
|
+
);
|
|
110
|
+
}
|
|
111
|
+
|
|
78
112
|
/**
|
|
79
113
|
* Deletes the planning group
|
|
80
114
|
*
|
|
@@ -930,6 +964,7 @@ class WorkforceManagementApi {
|
|
|
930
964
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
931
965
|
* @param {Object} opts Optional parameters
|
|
932
966
|
* @param {Array.<String>} opts.expand Include to access additional data on the business unit
|
|
967
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
933
968
|
*/
|
|
934
969
|
getWorkforcemanagementBusinessunit(businessUnitId, opts) {
|
|
935
970
|
opts = opts || {};
|
|
@@ -943,7 +978,7 @@ class WorkforceManagementApi {
|
|
|
943
978
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
944
979
|
'GET',
|
|
945
980
|
{ 'businessUnitId': businessUnitId },
|
|
946
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
981
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
947
982
|
{ },
|
|
948
983
|
{ },
|
|
949
984
|
null,
|
|
@@ -1216,6 +1251,156 @@ class WorkforceManagementApi {
|
|
|
1216
1251
|
);
|
|
1217
1252
|
}
|
|
1218
1253
|
|
|
1254
|
+
/**
|
|
1255
|
+
* Get a capacity plan
|
|
1256
|
+
*
|
|
1257
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1258
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
1259
|
+
*/
|
|
1260
|
+
getWorkforcemanagementBusinessunitCapacityplan(businessUnitId, capacityPlanId) {
|
|
1261
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1262
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
1263
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplan';
|
|
1264
|
+
}
|
|
1265
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
1266
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
1267
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplan';
|
|
1268
|
+
}
|
|
1269
|
+
|
|
1270
|
+
return this.apiClient.callApi(
|
|
1271
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}',
|
|
1272
|
+
'GET',
|
|
1273
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
1274
|
+
{ },
|
|
1275
|
+
{ },
|
|
1276
|
+
{ },
|
|
1277
|
+
null,
|
|
1278
|
+
['PureCloud OAuth'],
|
|
1279
|
+
['application/json'],
|
|
1280
|
+
['application/json']
|
|
1281
|
+
);
|
|
1282
|
+
}
|
|
1283
|
+
|
|
1284
|
+
/**
|
|
1285
|
+
* Get a capacity plan's staffing group allocations
|
|
1286
|
+
*
|
|
1287
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1288
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
1289
|
+
*/
|
|
1290
|
+
getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId) {
|
|
1291
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1292
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
1293
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
1294
|
+
}
|
|
1295
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
1296
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
1297
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
1298
|
+
}
|
|
1299
|
+
|
|
1300
|
+
return this.apiClient.callApi(
|
|
1301
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
|
|
1302
|
+
'GET',
|
|
1303
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
1304
|
+
{ },
|
|
1305
|
+
{ },
|
|
1306
|
+
{ },
|
|
1307
|
+
null,
|
|
1308
|
+
['PureCloud OAuth'],
|
|
1309
|
+
['application/json'],
|
|
1310
|
+
['application/json']
|
|
1311
|
+
);
|
|
1312
|
+
}
|
|
1313
|
+
|
|
1314
|
+
/**
|
|
1315
|
+
* Get a capacity plan's staffing requirements
|
|
1316
|
+
*
|
|
1317
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1318
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
1319
|
+
*/
|
|
1320
|
+
getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements(businessUnitId, capacityPlanId) {
|
|
1321
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1322
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
1323
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements';
|
|
1324
|
+
}
|
|
1325
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
1326
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
1327
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements';
|
|
1328
|
+
}
|
|
1329
|
+
|
|
1330
|
+
return this.apiClient.callApi(
|
|
1331
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffingrequirements',
|
|
1332
|
+
'GET',
|
|
1333
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
1334
|
+
{ },
|
|
1335
|
+
{ },
|
|
1336
|
+
{ },
|
|
1337
|
+
null,
|
|
1338
|
+
['PureCloud OAuth'],
|
|
1339
|
+
['application/json'],
|
|
1340
|
+
['application/json']
|
|
1341
|
+
);
|
|
1342
|
+
}
|
|
1343
|
+
|
|
1344
|
+
/**
|
|
1345
|
+
* Get the latest long term staffing requirements for a business unit
|
|
1346
|
+
*
|
|
1347
|
+
* @param {String} businessUnitId
|
|
1348
|
+
* @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
1349
|
+
* @param {String} forecastId forecastId of forecast
|
|
1350
|
+
*/
|
|
1351
|
+
getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(businessUnitId, weekDateId, forecastId) {
|
|
1352
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1353
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
1354
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
1355
|
+
}
|
|
1356
|
+
// verify the required parameter 'weekDateId' is set
|
|
1357
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
1358
|
+
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
1359
|
+
}
|
|
1360
|
+
// verify the required parameter 'forecastId' is set
|
|
1361
|
+
if (forecastId === undefined || forecastId === null || forecastId === '') {
|
|
1362
|
+
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
return this.apiClient.callApi(
|
|
1366
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}',
|
|
1367
|
+
'GET',
|
|
1368
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
1369
|
+
{ },
|
|
1370
|
+
{ },
|
|
1371
|
+
{ },
|
|
1372
|
+
null,
|
|
1373
|
+
['PureCloud OAuth'],
|
|
1374
|
+
['application/json'],
|
|
1375
|
+
['application/json']
|
|
1376
|
+
);
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1379
|
+
/**
|
|
1380
|
+
* Get list of capacity plans for a business unit
|
|
1381
|
+
*
|
|
1382
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1383
|
+
*/
|
|
1384
|
+
getWorkforcemanagementBusinessunitCapacityplans(businessUnitId) {
|
|
1385
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1386
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
1387
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplans';
|
|
1388
|
+
}
|
|
1389
|
+
|
|
1390
|
+
return this.apiClient.callApi(
|
|
1391
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans',
|
|
1392
|
+
'GET',
|
|
1393
|
+
{ 'businessUnitId': businessUnitId },
|
|
1394
|
+
{ },
|
|
1395
|
+
{ },
|
|
1396
|
+
{ },
|
|
1397
|
+
null,
|
|
1398
|
+
['PureCloud OAuth'],
|
|
1399
|
+
['application/json'],
|
|
1400
|
+
['application/json']
|
|
1401
|
+
);
|
|
1402
|
+
}
|
|
1403
|
+
|
|
1219
1404
|
/**
|
|
1220
1405
|
* Get intraday planning groups for the given date
|
|
1221
1406
|
*
|
|
@@ -3478,6 +3663,31 @@ class WorkforceManagementApi {
|
|
|
3478
3663
|
);
|
|
3479
3664
|
}
|
|
3480
3665
|
|
|
3666
|
+
/**
|
|
3667
|
+
* Get a list of user schedule adherence records for the requested team
|
|
3668
|
+
*
|
|
3669
|
+
* @param {String} teamId The ID of the team
|
|
3670
|
+
*/
|
|
3671
|
+
getWorkforcemanagementTeamAdherence(teamId) {
|
|
3672
|
+
// verify the required parameter 'teamId' is set
|
|
3673
|
+
if (teamId === undefined || teamId === null || teamId === '') {
|
|
3674
|
+
throw 'Missing the required parameter "teamId" when calling getWorkforcemanagementTeamAdherence';
|
|
3675
|
+
}
|
|
3676
|
+
|
|
3677
|
+
return this.apiClient.callApi(
|
|
3678
|
+
'/api/v2/workforcemanagement/teams/{teamId}/adherence',
|
|
3679
|
+
'GET',
|
|
3680
|
+
{ 'teamId': teamId },
|
|
3681
|
+
{ },
|
|
3682
|
+
{ },
|
|
3683
|
+
{ },
|
|
3684
|
+
null,
|
|
3685
|
+
['PureCloud OAuth'],
|
|
3686
|
+
['application/json'],
|
|
3687
|
+
['application/json']
|
|
3688
|
+
);
|
|
3689
|
+
}
|
|
3690
|
+
|
|
3481
3691
|
/**
|
|
3482
3692
|
* Query the results of time off types job
|
|
3483
3693
|
*
|
|
@@ -3763,8 +3973,12 @@ class WorkforceManagementApi {
|
|
|
3763
3973
|
*
|
|
3764
3974
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
3765
3975
|
* @param {Object} body body
|
|
3976
|
+
* @param {Object} opts Optional parameters
|
|
3977
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
3766
3978
|
*/
|
|
3767
|
-
patchWorkforcemanagementBusinessunit(businessUnitId, body) {
|
|
3979
|
+
patchWorkforcemanagementBusinessunit(businessUnitId, body, opts) {
|
|
3980
|
+
opts = opts || {};
|
|
3981
|
+
|
|
3768
3982
|
// verify the required parameter 'businessUnitId' is set
|
|
3769
3983
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
3770
3984
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';
|
|
@@ -3778,7 +3992,7 @@ class WorkforceManagementApi {
|
|
|
3778
3992
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
3779
3993
|
'PATCH',
|
|
3780
3994
|
{ 'businessUnitId': businessUnitId },
|
|
3781
|
-
{
|
|
3995
|
+
{ 'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
3782
3996
|
{ },
|
|
3783
3997
|
{ },
|
|
3784
3998
|
body,
|
|
@@ -3888,6 +4102,41 @@ class WorkforceManagementApi {
|
|
|
3888
4102
|
);
|
|
3889
4103
|
}
|
|
3890
4104
|
|
|
4105
|
+
/**
|
|
4106
|
+
* Update a capacity plan configuration
|
|
4107
|
+
*
|
|
4108
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
4109
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
4110
|
+
* @param {Object} body body
|
|
4111
|
+
*/
|
|
4112
|
+
patchWorkforcemanagementBusinessunitCapacityplan(businessUnitId, capacityPlanId, body) {
|
|
4113
|
+
// verify the required parameter 'businessUnitId' is set
|
|
4114
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
4115
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
4116
|
+
}
|
|
4117
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
4118
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
4119
|
+
throw 'Missing the required parameter "capacityPlanId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
4120
|
+
}
|
|
4121
|
+
// verify the required parameter 'body' is set
|
|
4122
|
+
if (body === undefined || body === null) {
|
|
4123
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
4124
|
+
}
|
|
4125
|
+
|
|
4126
|
+
return this.apiClient.callApi(
|
|
4127
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}',
|
|
4128
|
+
'PATCH',
|
|
4129
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
4130
|
+
{ },
|
|
4131
|
+
{ },
|
|
4132
|
+
{ },
|
|
4133
|
+
body,
|
|
4134
|
+
['PureCloud OAuth'],
|
|
4135
|
+
['application/json'],
|
|
4136
|
+
['application/json']
|
|
4137
|
+
);
|
|
4138
|
+
}
|
|
4139
|
+
|
|
3891
4140
|
/**
|
|
3892
4141
|
* Updates the planning group
|
|
3893
4142
|
*
|
|
@@ -5186,6 +5435,236 @@ class WorkforceManagementApi {
|
|
|
5186
5435
|
);
|
|
5187
5436
|
}
|
|
5188
5437
|
|
|
5438
|
+
/**
|
|
5439
|
+
* Copy a capacity plan
|
|
5440
|
+
*
|
|
5441
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5442
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
5443
|
+
* @param {Object} body body
|
|
5444
|
+
*/
|
|
5445
|
+
postWorkforcemanagementBusinessunitCapacityplanCopy(businessUnitId, capacityPlanId, body) {
|
|
5446
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5447
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5448
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
5449
|
+
}
|
|
5450
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
5451
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
5452
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
5453
|
+
}
|
|
5454
|
+
// verify the required parameter 'body' is set
|
|
5455
|
+
if (body === undefined || body === null) {
|
|
5456
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
5457
|
+
}
|
|
5458
|
+
|
|
5459
|
+
return this.apiClient.callApi(
|
|
5460
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/copy',
|
|
5461
|
+
'POST',
|
|
5462
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
5463
|
+
{ },
|
|
5464
|
+
{ },
|
|
5465
|
+
{ },
|
|
5466
|
+
body,
|
|
5467
|
+
['PureCloud OAuth'],
|
|
5468
|
+
['application/json'],
|
|
5469
|
+
['application/json']
|
|
5470
|
+
);
|
|
5471
|
+
}
|
|
5472
|
+
|
|
5473
|
+
/**
|
|
5474
|
+
* Regenerate requirements for capacity plan
|
|
5475
|
+
*
|
|
5476
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5477
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
5478
|
+
*/
|
|
5479
|
+
postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate(businessUnitId, capacityPlanId) {
|
|
5480
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5481
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5482
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate';
|
|
5483
|
+
}
|
|
5484
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
5485
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
5486
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate';
|
|
5487
|
+
}
|
|
5488
|
+
|
|
5489
|
+
return this.apiClient.callApi(
|
|
5490
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/requirement/generate',
|
|
5491
|
+
'POST',
|
|
5492
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
5493
|
+
{ },
|
|
5494
|
+
{ },
|
|
5495
|
+
{ },
|
|
5496
|
+
null,
|
|
5497
|
+
['PureCloud OAuth'],
|
|
5498
|
+
['application/json'],
|
|
5499
|
+
['application/json']
|
|
5500
|
+
);
|
|
5501
|
+
}
|
|
5502
|
+
|
|
5503
|
+
/**
|
|
5504
|
+
* Create staffing group allocations for a capacity plan
|
|
5505
|
+
*
|
|
5506
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5507
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
5508
|
+
* @param {Object} body
|
|
5509
|
+
*/
|
|
5510
|
+
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId, body) {
|
|
5511
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5512
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5513
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
5514
|
+
}
|
|
5515
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
5516
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
5517
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
5518
|
+
}
|
|
5519
|
+
// verify the required parameter 'body' is set
|
|
5520
|
+
if (body === undefined || body === null) {
|
|
5521
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
5522
|
+
}
|
|
5523
|
+
|
|
5524
|
+
return this.apiClient.callApi(
|
|
5525
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
|
|
5526
|
+
'POST',
|
|
5527
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
5528
|
+
{ },
|
|
5529
|
+
{ },
|
|
5530
|
+
{ },
|
|
5531
|
+
body,
|
|
5532
|
+
['PureCloud OAuth'],
|
|
5533
|
+
['application/json'],
|
|
5534
|
+
['application/json']
|
|
5535
|
+
);
|
|
5536
|
+
}
|
|
5537
|
+
|
|
5538
|
+
/**
|
|
5539
|
+
* Query staffing groups allocations history for a capacity plan
|
|
5540
|
+
*
|
|
5541
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5542
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
5543
|
+
* @param {Object} body
|
|
5544
|
+
*/
|
|
5545
|
+
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery(businessUnitId, capacityPlanId, body) {
|
|
5546
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5547
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5548
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
5549
|
+
}
|
|
5550
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
5551
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
5552
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
5553
|
+
}
|
|
5554
|
+
// verify the required parameter 'body' is set
|
|
5555
|
+
if (body === undefined || body === null) {
|
|
5556
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
5557
|
+
}
|
|
5558
|
+
|
|
5559
|
+
return this.apiClient.callApi(
|
|
5560
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory/query',
|
|
5561
|
+
'POST',
|
|
5562
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
5563
|
+
{ },
|
|
5564
|
+
{ },
|
|
5565
|
+
{ },
|
|
5566
|
+
body,
|
|
5567
|
+
['PureCloud OAuth'],
|
|
5568
|
+
['application/json'],
|
|
5569
|
+
['application/json']
|
|
5570
|
+
);
|
|
5571
|
+
}
|
|
5572
|
+
|
|
5573
|
+
/**
|
|
5574
|
+
* Force regenerate the latest long term staffing requirements for a business unit
|
|
5575
|
+
*
|
|
5576
|
+
* @param {String} businessUnitId
|
|
5577
|
+
* @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
5578
|
+
* @param {String} forecastId forecastId of forecast
|
|
5579
|
+
*/
|
|
5580
|
+
postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate(businessUnitId, weekDateId, forecastId) {
|
|
5581
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5582
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5583
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
5584
|
+
}
|
|
5585
|
+
// verify the required parameter 'weekDateId' is set
|
|
5586
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
5587
|
+
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
5588
|
+
}
|
|
5589
|
+
// verify the required parameter 'forecastId' is set
|
|
5590
|
+
if (forecastId === undefined || forecastId === null || forecastId === '') {
|
|
5591
|
+
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
5592
|
+
}
|
|
5593
|
+
|
|
5594
|
+
return this.apiClient.callApi(
|
|
5595
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}/forceregenerate',
|
|
5596
|
+
'POST',
|
|
5597
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
5598
|
+
{ },
|
|
5599
|
+
{ },
|
|
5600
|
+
{ },
|
|
5601
|
+
null,
|
|
5602
|
+
['PureCloud OAuth'],
|
|
5603
|
+
['application/json'],
|
|
5604
|
+
['application/json']
|
|
5605
|
+
);
|
|
5606
|
+
}
|
|
5607
|
+
|
|
5608
|
+
/**
|
|
5609
|
+
* Create a new capacity plan
|
|
5610
|
+
*
|
|
5611
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5612
|
+
* @param {Object} body body
|
|
5613
|
+
*/
|
|
5614
|
+
postWorkforcemanagementBusinessunitCapacityplans(businessUnitId, body) {
|
|
5615
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5616
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5617
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplans';
|
|
5618
|
+
}
|
|
5619
|
+
// verify the required parameter 'body' is set
|
|
5620
|
+
if (body === undefined || body === null) {
|
|
5621
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplans';
|
|
5622
|
+
}
|
|
5623
|
+
|
|
5624
|
+
return this.apiClient.callApi(
|
|
5625
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans',
|
|
5626
|
+
'POST',
|
|
5627
|
+
{ 'businessUnitId': businessUnitId },
|
|
5628
|
+
{ },
|
|
5629
|
+
{ },
|
|
5630
|
+
{ },
|
|
5631
|
+
body,
|
|
5632
|
+
['PureCloud OAuth'],
|
|
5633
|
+
['application/json'],
|
|
5634
|
+
['application/json']
|
|
5635
|
+
);
|
|
5636
|
+
}
|
|
5637
|
+
|
|
5638
|
+
/**
|
|
5639
|
+
* Delete capacity plans in a business unit
|
|
5640
|
+
*
|
|
5641
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5642
|
+
* @param {Object} body body
|
|
5643
|
+
*/
|
|
5644
|
+
postWorkforcemanagementBusinessunitCapacityplansBulkRemove(businessUnitId, body) {
|
|
5645
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5646
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5647
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplansBulkRemove';
|
|
5648
|
+
}
|
|
5649
|
+
// verify the required parameter 'body' is set
|
|
5650
|
+
if (body === undefined || body === null) {
|
|
5651
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplansBulkRemove';
|
|
5652
|
+
}
|
|
5653
|
+
|
|
5654
|
+
return this.apiClient.callApi(
|
|
5655
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/bulk/remove',
|
|
5656
|
+
'POST',
|
|
5657
|
+
{ 'businessUnitId': businessUnitId },
|
|
5658
|
+
{ },
|
|
5659
|
+
{ },
|
|
5660
|
+
{ },
|
|
5661
|
+
body,
|
|
5662
|
+
['PureCloud OAuth'],
|
|
5663
|
+
['application/json'],
|
|
5664
|
+
['application/json']
|
|
5665
|
+
);
|
|
5666
|
+
}
|
|
5667
|
+
|
|
5189
5668
|
/**
|
|
5190
5669
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
5191
5670
|
*
|
|
@@ -5310,6 +5789,36 @@ class WorkforceManagementApi {
|
|
|
5310
5789
|
);
|
|
5311
5790
|
}
|
|
5312
5791
|
|
|
5792
|
+
/**
|
|
5793
|
+
* Gets a list of planning group to staffing groups list association
|
|
5794
|
+
*
|
|
5795
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5796
|
+
* @param {Object} body body
|
|
5797
|
+
*/
|
|
5798
|
+
postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery(businessUnitId, body) {
|
|
5799
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5800
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5801
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery';
|
|
5802
|
+
}
|
|
5803
|
+
// verify the required parameter 'body' is set
|
|
5804
|
+
if (body === undefined || body === null) {
|
|
5805
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery';
|
|
5806
|
+
}
|
|
5807
|
+
|
|
5808
|
+
return this.apiClient.callApi(
|
|
5809
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/planninggroups/query',
|
|
5810
|
+
'POST',
|
|
5811
|
+
{ 'businessUnitId': businessUnitId },
|
|
5812
|
+
{ },
|
|
5813
|
+
{ },
|
|
5814
|
+
{ },
|
|
5815
|
+
body,
|
|
5816
|
+
['PureCloud OAuth'],
|
|
5817
|
+
['application/json'],
|
|
5818
|
+
['application/json']
|
|
5819
|
+
);
|
|
5820
|
+
}
|
|
5821
|
+
|
|
5313
5822
|
/**
|
|
5314
5823
|
* Gets staffing group associations for a list of user IDs
|
|
5315
5824
|
*
|
|
@@ -6116,8 +6625,12 @@ class WorkforceManagementApi {
|
|
|
6116
6625
|
* Add a new business unit
|
|
6117
6626
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
6118
6627
|
* @param {Object} body body
|
|
6628
|
+
* @param {Object} opts Optional parameters
|
|
6629
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
6119
6630
|
*/
|
|
6120
|
-
postWorkforcemanagementBusinessunits(body) {
|
|
6631
|
+
postWorkforcemanagementBusinessunits(body, opts) {
|
|
6632
|
+
opts = opts || {};
|
|
6633
|
+
|
|
6121
6634
|
// verify the required parameter 'body' is set
|
|
6122
6635
|
if (body === undefined || body === null) {
|
|
6123
6636
|
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunits';
|
|
@@ -6127,7 +6640,7 @@ class WorkforceManagementApi {
|
|
|
6127
6640
|
'/api/v2/workforcemanagement/businessunits',
|
|
6128
6641
|
'POST',
|
|
6129
6642
|
{ },
|
|
6130
|
-
{
|
|
6643
|
+
{ 'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
6131
6644
|
{ },
|
|
6132
6645
|
{ },
|
|
6133
6646
|
body,
|