purecloud-platform-client-v2 94.0.0 → 97.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +547 -1265
- package/dist/web-amd/purecloud-platform-client-v2.js +547 -1265
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +547 -1265
- package/dist/web-cjs/purecloud-platform-client-v2.js +552 -1269
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +513 -289
- 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 +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +3 -3
- 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 +26 -10
- 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/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 +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +131 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -3
- 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/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +7 -7
- 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 +26 -26
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- 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 +3 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +123 -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/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +306 -1147
- package/src/purecloud-platform-client-v2/index.js +1 -7
- package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
|
@@ -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 97.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -261,155 +261,25 @@ class WorkforceManagementApi {
|
|
|
261
261
|
}
|
|
262
262
|
|
|
263
263
|
/**
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
267
|
-
* @param {String} acId The ID of the activity code to delete
|
|
268
|
-
*/
|
|
269
|
-
deleteWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
270
|
-
// verify the required parameter 'muId' is set
|
|
271
|
-
if (muId === undefined || muId === null) {
|
|
272
|
-
throw 'Missing the required parameter "muId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
273
|
-
}
|
|
274
|
-
// verify the required parameter 'acId' is set
|
|
275
|
-
if (acId === undefined || acId === null) {
|
|
276
|
-
throw 'Missing the required parameter "acId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
277
|
-
}
|
|
278
|
-
|
|
279
|
-
return this.apiClient.callApi(
|
|
280
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
281
|
-
'DELETE',
|
|
282
|
-
{ 'muId': muId,'acId': acId },
|
|
283
|
-
{ },
|
|
284
|
-
{ },
|
|
285
|
-
{ },
|
|
286
|
-
null,
|
|
287
|
-
['PureCloud OAuth'],
|
|
288
|
-
['application/json'],
|
|
289
|
-
['application/json']
|
|
290
|
-
);
|
|
291
|
-
}
|
|
292
|
-
|
|
293
|
-
/**
|
|
294
|
-
* Gone. Scheduling has moved under business units
|
|
295
|
-
*
|
|
296
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
297
|
-
* @param {String} runId The ID of the schedule run
|
|
298
|
-
*/
|
|
299
|
-
deleteWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
300
|
-
// verify the required parameter 'managementUnitId' is set
|
|
301
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
302
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
303
|
-
}
|
|
304
|
-
// verify the required parameter 'runId' is set
|
|
305
|
-
if (runId === undefined || runId === null) {
|
|
306
|
-
throw 'Missing the required parameter "runId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
return this.apiClient.callApi(
|
|
310
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
311
|
-
'DELETE',
|
|
312
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
313
|
-
{ },
|
|
314
|
-
{ },
|
|
315
|
-
{ },
|
|
316
|
-
null,
|
|
317
|
-
['PureCloud OAuth'],
|
|
318
|
-
['application/json'],
|
|
319
|
-
['application/json']
|
|
320
|
-
);
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
/**
|
|
324
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
325
|
-
*
|
|
326
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
327
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to delete
|
|
328
|
-
*/
|
|
329
|
-
deleteWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
330
|
-
// verify the required parameter 'managementUnitId' is set
|
|
331
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
332
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
333
|
-
}
|
|
334
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
335
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
336
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
337
|
-
}
|
|
338
|
-
|
|
339
|
-
return this.apiClient.callApi(
|
|
340
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
341
|
-
'DELETE',
|
|
342
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
343
|
-
{ },
|
|
344
|
-
{ },
|
|
345
|
-
{ },
|
|
346
|
-
null,
|
|
347
|
-
['PureCloud OAuth'],
|
|
348
|
-
['application/json'],
|
|
349
|
-
['application/json']
|
|
350
|
-
);
|
|
351
|
-
}
|
|
352
|
-
|
|
353
|
-
/**
|
|
354
|
-
* Gone. Scheduling has moved under business units
|
|
264
|
+
* Delete a work plan
|
|
355
265
|
*
|
|
356
266
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
357
|
-
* @param {String}
|
|
358
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to delete
|
|
359
|
-
*/
|
|
360
|
-
deleteWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
361
|
-
// verify the required parameter 'managementUnitId' is set
|
|
362
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
363
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
364
|
-
}
|
|
365
|
-
// verify the required parameter 'weekId' is set
|
|
366
|
-
if (weekId === undefined || weekId === null) {
|
|
367
|
-
throw 'Missing the required parameter "weekId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
368
|
-
}
|
|
369
|
-
// verify the required parameter 'scheduleId' is set
|
|
370
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
371
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
372
|
-
}
|
|
373
|
-
|
|
374
|
-
return this.apiClient.callApi(
|
|
375
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
376
|
-
'DELETE',
|
|
377
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
378
|
-
{ },
|
|
379
|
-
{ },
|
|
380
|
-
{ },
|
|
381
|
-
null,
|
|
382
|
-
['PureCloud OAuth'],
|
|
383
|
-
['application/json'],
|
|
384
|
-
['application/json']
|
|
385
|
-
);
|
|
386
|
-
}
|
|
387
|
-
|
|
388
|
-
/**
|
|
389
|
-
* Gone. Use equivalent business unit resource instead
|
|
390
|
-
*
|
|
391
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
392
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
393
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
267
|
+
* @param {String} workPlanId The ID of the work plan to delete
|
|
394
268
|
*/
|
|
395
|
-
|
|
269
|
+
deleteWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId) {
|
|
396
270
|
// verify the required parameter 'managementUnitId' is set
|
|
397
271
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
398
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
399
|
-
}
|
|
400
|
-
// verify the required parameter 'weekDateId' is set
|
|
401
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
402
|
-
throw 'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
272
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
403
273
|
}
|
|
404
|
-
// verify the required parameter '
|
|
405
|
-
if (
|
|
406
|
-
throw 'Missing the required parameter "
|
|
274
|
+
// verify the required parameter 'workPlanId' is set
|
|
275
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
276
|
+
throw 'Missing the required parameter "workPlanId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
407
277
|
}
|
|
408
278
|
|
|
409
279
|
return this.apiClient.callApi(
|
|
410
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
280
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
411
281
|
'DELETE',
|
|
412
|
-
{ 'managementUnitId': managementUnitId,'
|
|
282
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
413
283
|
{ },
|
|
414
284
|
{ },
|
|
415
285
|
{ },
|
|
@@ -421,25 +291,25 @@ class WorkforceManagementApi {
|
|
|
421
291
|
}
|
|
422
292
|
|
|
423
293
|
/**
|
|
424
|
-
* Delete a work plan
|
|
294
|
+
* Delete a work plan rotation
|
|
425
295
|
*
|
|
426
296
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
427
|
-
* @param {String}
|
|
297
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
428
298
|
*/
|
|
429
|
-
|
|
299
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
430
300
|
// verify the required parameter 'managementUnitId' is set
|
|
431
301
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
432
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
302
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
433
303
|
}
|
|
434
|
-
// verify the required parameter '
|
|
435
|
-
if (
|
|
436
|
-
throw 'Missing the required parameter "
|
|
304
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
305
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
306
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
437
307
|
}
|
|
438
308
|
|
|
439
309
|
return this.apiClient.callApi(
|
|
440
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
310
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
441
311
|
'DELETE',
|
|
442
|
-
{ 'managementUnitId': managementUnitId,'
|
|
312
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
443
313
|
{ },
|
|
444
314
|
{ },
|
|
445
315
|
{ },
|
|
@@ -1254,36 +1124,6 @@ class WorkforceManagementApi {
|
|
|
1254
1124
|
);
|
|
1255
1125
|
}
|
|
1256
1126
|
|
|
1257
|
-
/**
|
|
1258
|
-
* Get an activity code
|
|
1259
|
-
*
|
|
1260
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1261
|
-
* @param {String} acId The ID of the activity code to fetch
|
|
1262
|
-
*/
|
|
1263
|
-
getWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
1264
|
-
// verify the required parameter 'muId' is set
|
|
1265
|
-
if (muId === undefined || muId === null) {
|
|
1266
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
1267
|
-
}
|
|
1268
|
-
// verify the required parameter 'acId' is set
|
|
1269
|
-
if (acId === undefined || acId === null) {
|
|
1270
|
-
throw 'Missing the required parameter "acId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
1271
|
-
}
|
|
1272
|
-
|
|
1273
|
-
return this.apiClient.callApi(
|
|
1274
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
1275
|
-
'GET',
|
|
1276
|
-
{ 'muId': muId,'acId': acId },
|
|
1277
|
-
{ },
|
|
1278
|
-
{ },
|
|
1279
|
-
{ },
|
|
1280
|
-
null,
|
|
1281
|
-
['PureCloud OAuth'],
|
|
1282
|
-
['application/json'],
|
|
1283
|
-
['application/json']
|
|
1284
|
-
);
|
|
1285
|
-
}
|
|
1286
|
-
|
|
1287
1127
|
/**
|
|
1288
1128
|
* Get activity codes
|
|
1289
1129
|
*
|
|
@@ -1403,18 +1243,18 @@ class WorkforceManagementApi {
|
|
|
1403
1243
|
}
|
|
1404
1244
|
|
|
1405
1245
|
/**
|
|
1406
|
-
*
|
|
1246
|
+
* Gets a summary of all shift trades in the matched state
|
|
1407
1247
|
*
|
|
1408
|
-
* @param {String} muId The management unit ID of the management unit
|
|
1248
|
+
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1409
1249
|
*/
|
|
1410
|
-
|
|
1250
|
+
getWorkforcemanagementManagementunitShifttradesMatched(muId) {
|
|
1411
1251
|
// verify the required parameter 'muId' is set
|
|
1412
1252
|
if (muId === undefined || muId === null) {
|
|
1413
|
-
throw 'Missing the required parameter "muId" when calling
|
|
1253
|
+
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitShifttradesMatched';
|
|
1414
1254
|
}
|
|
1415
1255
|
|
|
1416
1256
|
return this.apiClient.callApi(
|
|
1417
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/
|
|
1257
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/shifttrades/matched',
|
|
1418
1258
|
'GET',
|
|
1419
1259
|
{ 'muId': muId },
|
|
1420
1260
|
{ },
|
|
@@ -1428,25 +1268,20 @@ class WorkforceManagementApi {
|
|
|
1428
1268
|
}
|
|
1429
1269
|
|
|
1430
1270
|
/**
|
|
1431
|
-
*
|
|
1271
|
+
* Gets list of users available for whom you can send direct shift trade requests
|
|
1432
1272
|
*
|
|
1433
|
-
* @param {String}
|
|
1434
|
-
* @param {String} runId The ID of the schedule run
|
|
1273
|
+
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1435
1274
|
*/
|
|
1436
|
-
|
|
1437
|
-
// verify the required parameter '
|
|
1438
|
-
if (
|
|
1439
|
-
throw 'Missing the required parameter "
|
|
1440
|
-
}
|
|
1441
|
-
// verify the required parameter 'runId' is set
|
|
1442
|
-
if (runId === undefined || runId === null) {
|
|
1443
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
1275
|
+
getWorkforcemanagementManagementunitShifttradesUsers(muId) {
|
|
1276
|
+
// verify the required parameter 'muId' is set
|
|
1277
|
+
if (muId === undefined || muId === null) {
|
|
1278
|
+
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitShifttradesUsers';
|
|
1444
1279
|
}
|
|
1445
1280
|
|
|
1446
1281
|
return this.apiClient.callApi(
|
|
1447
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
1282
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/shifttrades/users',
|
|
1448
1283
|
'GET',
|
|
1449
|
-
{ '
|
|
1284
|
+
{ 'muId': muId },
|
|
1450
1285
|
{ },
|
|
1451
1286
|
{ },
|
|
1452
1287
|
{ },
|
|
@@ -1458,25 +1293,30 @@ class WorkforceManagementApi {
|
|
|
1458
1293
|
}
|
|
1459
1294
|
|
|
1460
1295
|
/**
|
|
1461
|
-
*
|
|
1296
|
+
* Get a time off request
|
|
1462
1297
|
*
|
|
1463
|
-
* @param {String}
|
|
1464
|
-
* @param {String}
|
|
1298
|
+
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1299
|
+
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
1300
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
1465
1301
|
*/
|
|
1466
|
-
|
|
1467
|
-
// verify the required parameter '
|
|
1468
|
-
if (
|
|
1469
|
-
throw 'Missing the required parameter "
|
|
1302
|
+
getWorkforcemanagementManagementunitUserTimeoffrequest(muId, userId, timeOffRequestId) {
|
|
1303
|
+
// verify the required parameter 'muId' is set
|
|
1304
|
+
if (muId === undefined || muId === null) {
|
|
1305
|
+
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
1470
1306
|
}
|
|
1471
|
-
// verify the required parameter '
|
|
1472
|
-
if (
|
|
1473
|
-
throw 'Missing the required parameter "
|
|
1307
|
+
// verify the required parameter 'userId' is set
|
|
1308
|
+
if (userId === undefined || userId === null) {
|
|
1309
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
1310
|
+
}
|
|
1311
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
1312
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
1313
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
1474
1314
|
}
|
|
1475
1315
|
|
|
1476
1316
|
return this.apiClient.callApi(
|
|
1477
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
1317
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}',
|
|
1478
1318
|
'GET',
|
|
1479
|
-
{ '
|
|
1319
|
+
{ 'muId': muId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
1480
1320
|
{ },
|
|
1481
1321
|
{ },
|
|
1482
1322
|
{ },
|
|
@@ -1488,21 +1328,30 @@ class WorkforceManagementApi {
|
|
|
1488
1328
|
}
|
|
1489
1329
|
|
|
1490
1330
|
/**
|
|
1491
|
-
*
|
|
1331
|
+
* Get a list of time off requests for a given user
|
|
1492
1332
|
*
|
|
1493
|
-
* @param {String}
|
|
1333
|
+
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1334
|
+
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
1335
|
+
* @param {Object} opts Optional parameters
|
|
1336
|
+
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
1494
1337
|
*/
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1338
|
+
getWorkforcemanagementManagementunitUserTimeoffrequests(muId, userId, opts) {
|
|
1339
|
+
opts = opts || {};
|
|
1340
|
+
|
|
1341
|
+
// verify the required parameter 'muId' is set
|
|
1342
|
+
if (muId === undefined || muId === null) {
|
|
1343
|
+
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
|
|
1344
|
+
}
|
|
1345
|
+
// verify the required parameter 'userId' is set
|
|
1346
|
+
if (userId === undefined || userId === null) {
|
|
1347
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
|
|
1499
1348
|
}
|
|
1500
1349
|
|
|
1501
1350
|
return this.apiClient.callApi(
|
|
1502
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
1351
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests',
|
|
1503
1352
|
'GET',
|
|
1504
|
-
{ '
|
|
1505
|
-
{
|
|
1353
|
+
{ 'muId': muId,'userId': userId },
|
|
1354
|
+
{ 'recentlyReviewed': opts['recentlyReviewed'] },
|
|
1506
1355
|
{ },
|
|
1507
1356
|
{ },
|
|
1508
1357
|
null,
|
|
@@ -1513,25 +1362,20 @@ class WorkforceManagementApi {
|
|
|
1513
1362
|
}
|
|
1514
1363
|
|
|
1515
1364
|
/**
|
|
1516
|
-
*
|
|
1365
|
+
* Get users in the management unit
|
|
1517
1366
|
*
|
|
1518
|
-
* @param {String}
|
|
1519
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to fetch
|
|
1367
|
+
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1520
1368
|
*/
|
|
1521
|
-
|
|
1522
|
-
// verify the required parameter '
|
|
1523
|
-
if (
|
|
1524
|
-
throw 'Missing the required parameter "
|
|
1525
|
-
}
|
|
1526
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
1527
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
1528
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
1369
|
+
getWorkforcemanagementManagementunitUsers(muId) {
|
|
1370
|
+
// verify the required parameter 'muId' is set
|
|
1371
|
+
if (muId === undefined || muId === null) {
|
|
1372
|
+
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitUsers';
|
|
1529
1373
|
}
|
|
1530
1374
|
|
|
1531
1375
|
return this.apiClient.callApi(
|
|
1532
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
1376
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/users',
|
|
1533
1377
|
'GET',
|
|
1534
|
-
{ '
|
|
1378
|
+
{ 'muId': muId },
|
|
1535
1379
|
{ },
|
|
1536
1380
|
{ },
|
|
1537
1381
|
{ },
|
|
@@ -1543,21 +1387,36 @@ class WorkforceManagementApi {
|
|
|
1543
1387
|
}
|
|
1544
1388
|
|
|
1545
1389
|
/**
|
|
1546
|
-
*
|
|
1390
|
+
* Deprecated. Use the equivalent business unit resource instead. Get a week schedule
|
|
1547
1391
|
*
|
|
1548
|
-
* @param {String} managementUnitId
|
|
1392
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1393
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
1394
|
+
* @param {String} scheduleId The ID of the schedule to fetch
|
|
1395
|
+
* @param {Object} opts Optional parameters
|
|
1396
|
+
* @param {Object} opts.expand Which fields, if any, to expand
|
|
1397
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
1549
1398
|
*/
|
|
1550
|
-
|
|
1399
|
+
getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
|
|
1400
|
+
opts = opts || {};
|
|
1401
|
+
|
|
1551
1402
|
// verify the required parameter 'managementUnitId' is set
|
|
1552
1403
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1553
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
1404
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedule';
|
|
1405
|
+
}
|
|
1406
|
+
// verify the required parameter 'weekId' is set
|
|
1407
|
+
if (weekId === undefined || weekId === null) {
|
|
1408
|
+
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedule';
|
|
1409
|
+
}
|
|
1410
|
+
// verify the required parameter 'scheduleId' is set
|
|
1411
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
1412
|
+
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekSchedule';
|
|
1554
1413
|
}
|
|
1555
1414
|
|
|
1556
1415
|
return this.apiClient.callApi(
|
|
1557
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
1416
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
1558
1417
|
'GET',
|
|
1559
|
-
{ 'managementUnitId': managementUnitId },
|
|
1560
|
-
{
|
|
1418
|
+
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
1419
|
+
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
1561
1420
|
{ },
|
|
1562
1421
|
{ },
|
|
1563
1422
|
null,
|
|
@@ -1568,258 +1427,14 @@ class WorkforceManagementApi {
|
|
|
1568
1427
|
}
|
|
1569
1428
|
|
|
1570
1429
|
/**
|
|
1571
|
-
*
|
|
1430
|
+
* Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
|
|
1572
1431
|
*
|
|
1573
|
-
* @param {String}
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
}
|
|
1580
|
-
|
|
1581
|
-
return this.apiClient.callApi(
|
|
1582
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
1583
|
-
'GET',
|
|
1584
|
-
{ 'muId': muId },
|
|
1585
|
-
{ },
|
|
1586
|
-
{ },
|
|
1587
|
-
{ },
|
|
1588
|
-
null,
|
|
1589
|
-
['PureCloud OAuth'],
|
|
1590
|
-
['application/json'],
|
|
1591
|
-
['application/json']
|
|
1592
|
-
);
|
|
1593
|
-
}
|
|
1594
|
-
|
|
1595
|
-
/**
|
|
1596
|
-
* Gets a summary of all shift trades in the matched state
|
|
1597
|
-
*
|
|
1598
|
-
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1599
|
-
*/
|
|
1600
|
-
getWorkforcemanagementManagementunitShifttradesMatched(muId) {
|
|
1601
|
-
// verify the required parameter 'muId' is set
|
|
1602
|
-
if (muId === undefined || muId === null) {
|
|
1603
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitShifttradesMatched';
|
|
1604
|
-
}
|
|
1605
|
-
|
|
1606
|
-
return this.apiClient.callApi(
|
|
1607
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/shifttrades/matched',
|
|
1608
|
-
'GET',
|
|
1609
|
-
{ 'muId': muId },
|
|
1610
|
-
{ },
|
|
1611
|
-
{ },
|
|
1612
|
-
{ },
|
|
1613
|
-
null,
|
|
1614
|
-
['PureCloud OAuth'],
|
|
1615
|
-
['application/json'],
|
|
1616
|
-
['application/json']
|
|
1617
|
-
);
|
|
1618
|
-
}
|
|
1619
|
-
|
|
1620
|
-
/**
|
|
1621
|
-
* Gets list of users available for whom you can send direct shift trade requests
|
|
1622
|
-
*
|
|
1623
|
-
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1624
|
-
*/
|
|
1625
|
-
getWorkforcemanagementManagementunitShifttradesUsers(muId) {
|
|
1626
|
-
// verify the required parameter 'muId' is set
|
|
1627
|
-
if (muId === undefined || muId === null) {
|
|
1628
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitShifttradesUsers';
|
|
1629
|
-
}
|
|
1630
|
-
|
|
1631
|
-
return this.apiClient.callApi(
|
|
1632
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/shifttrades/users',
|
|
1633
|
-
'GET',
|
|
1634
|
-
{ 'muId': muId },
|
|
1635
|
-
{ },
|
|
1636
|
-
{ },
|
|
1637
|
-
{ },
|
|
1638
|
-
null,
|
|
1639
|
-
['PureCloud OAuth'],
|
|
1640
|
-
['application/json'],
|
|
1641
|
-
['application/json']
|
|
1642
|
-
);
|
|
1643
|
-
}
|
|
1644
|
-
|
|
1645
|
-
/**
|
|
1646
|
-
* Get a time off request
|
|
1647
|
-
*
|
|
1648
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1649
|
-
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
1650
|
-
* @param {String} timeOffRequestId Time Off Request Id
|
|
1651
|
-
*/
|
|
1652
|
-
getWorkforcemanagementManagementunitUserTimeoffrequest(muId, userId, timeOffRequestId) {
|
|
1653
|
-
// verify the required parameter 'muId' is set
|
|
1654
|
-
if (muId === undefined || muId === null) {
|
|
1655
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
1656
|
-
}
|
|
1657
|
-
// verify the required parameter 'userId' is set
|
|
1658
|
-
if (userId === undefined || userId === null) {
|
|
1659
|
-
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
1660
|
-
}
|
|
1661
|
-
// verify the required parameter 'timeOffRequestId' is set
|
|
1662
|
-
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
1663
|
-
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
1664
|
-
}
|
|
1665
|
-
|
|
1666
|
-
return this.apiClient.callApi(
|
|
1667
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}',
|
|
1668
|
-
'GET',
|
|
1669
|
-
{ 'muId': muId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
1670
|
-
{ },
|
|
1671
|
-
{ },
|
|
1672
|
-
{ },
|
|
1673
|
-
null,
|
|
1674
|
-
['PureCloud OAuth'],
|
|
1675
|
-
['application/json'],
|
|
1676
|
-
['application/json']
|
|
1677
|
-
);
|
|
1678
|
-
}
|
|
1679
|
-
|
|
1680
|
-
/**
|
|
1681
|
-
* Get a list of time off requests for a given user
|
|
1682
|
-
*
|
|
1683
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1684
|
-
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
1685
|
-
* @param {Object} opts Optional parameters
|
|
1686
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
1687
|
-
*/
|
|
1688
|
-
getWorkforcemanagementManagementunitUserTimeoffrequests(muId, userId, opts) {
|
|
1689
|
-
opts = opts || {};
|
|
1690
|
-
|
|
1691
|
-
// verify the required parameter 'muId' is set
|
|
1692
|
-
if (muId === undefined || muId === null) {
|
|
1693
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
|
|
1694
|
-
}
|
|
1695
|
-
// verify the required parameter 'userId' is set
|
|
1696
|
-
if (userId === undefined || userId === null) {
|
|
1697
|
-
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';
|
|
1698
|
-
}
|
|
1699
|
-
|
|
1700
|
-
return this.apiClient.callApi(
|
|
1701
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests',
|
|
1702
|
-
'GET',
|
|
1703
|
-
{ 'muId': muId,'userId': userId },
|
|
1704
|
-
{ 'recentlyReviewed': opts['recentlyReviewed'] },
|
|
1705
|
-
{ },
|
|
1706
|
-
{ },
|
|
1707
|
-
null,
|
|
1708
|
-
['PureCloud OAuth'],
|
|
1709
|
-
['application/json'],
|
|
1710
|
-
['application/json']
|
|
1711
|
-
);
|
|
1712
|
-
}
|
|
1713
|
-
|
|
1714
|
-
/**
|
|
1715
|
-
* Get users in the management unit
|
|
1716
|
-
*
|
|
1717
|
-
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1718
|
-
*/
|
|
1719
|
-
getWorkforcemanagementManagementunitUsers(muId) {
|
|
1720
|
-
// verify the required parameter 'muId' is set
|
|
1721
|
-
if (muId === undefined || muId === null) {
|
|
1722
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitUsers';
|
|
1723
|
-
}
|
|
1724
|
-
|
|
1725
|
-
return this.apiClient.callApi(
|
|
1726
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/users',
|
|
1727
|
-
'GET',
|
|
1728
|
-
{ 'muId': muId },
|
|
1729
|
-
{ },
|
|
1730
|
-
{ },
|
|
1731
|
-
{ },
|
|
1732
|
-
null,
|
|
1733
|
-
['PureCloud OAuth'],
|
|
1734
|
-
['application/json'],
|
|
1735
|
-
['application/json']
|
|
1736
|
-
);
|
|
1737
|
-
}
|
|
1738
|
-
|
|
1739
|
-
/**
|
|
1740
|
-
* Deprecated. Use the equivalent business unit resource instead. Get a week schedule
|
|
1741
|
-
*
|
|
1742
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1743
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
1744
|
-
* @param {String} scheduleId The ID of the schedule to fetch
|
|
1745
|
-
* @param {Object} opts Optional parameters
|
|
1746
|
-
* @param {Object} opts.expand Which fields, if any, to expand
|
|
1747
|
-
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
1748
|
-
*/
|
|
1749
|
-
getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
|
|
1750
|
-
opts = opts || {};
|
|
1751
|
-
|
|
1752
|
-
// verify the required parameter 'managementUnitId' is set
|
|
1753
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1754
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedule';
|
|
1755
|
-
}
|
|
1756
|
-
// verify the required parameter 'weekId' is set
|
|
1757
|
-
if (weekId === undefined || weekId === null) {
|
|
1758
|
-
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedule';
|
|
1759
|
-
}
|
|
1760
|
-
// verify the required parameter 'scheduleId' is set
|
|
1761
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
1762
|
-
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekSchedule';
|
|
1763
|
-
}
|
|
1764
|
-
|
|
1765
|
-
return this.apiClient.callApi(
|
|
1766
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
1767
|
-
'GET',
|
|
1768
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
1769
|
-
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
1770
|
-
{ },
|
|
1771
|
-
{ },
|
|
1772
|
-
null,
|
|
1773
|
-
['PureCloud OAuth'],
|
|
1774
|
-
['application/json'],
|
|
1775
|
-
['application/json']
|
|
1776
|
-
);
|
|
1777
|
-
}
|
|
1778
|
-
|
|
1779
|
-
/**
|
|
1780
|
-
* Gone. Scheduling has moved under business units
|
|
1781
|
-
*
|
|
1782
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1783
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
1784
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to fetch generation results
|
|
1785
|
-
*/
|
|
1786
|
-
getWorkforcemanagementManagementunitWeekScheduleGenerationresults(managementUnitId, weekId, scheduleId) {
|
|
1787
|
-
// verify the required parameter 'managementUnitId' is set
|
|
1788
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1789
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
1790
|
-
}
|
|
1791
|
-
// verify the required parameter 'weekId' is set
|
|
1792
|
-
if (weekId === undefined || weekId === null) {
|
|
1793
|
-
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
1794
|
-
}
|
|
1795
|
-
// verify the required parameter 'scheduleId' is set
|
|
1796
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
1797
|
-
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
1798
|
-
}
|
|
1799
|
-
|
|
1800
|
-
return this.apiClient.callApi(
|
|
1801
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults',
|
|
1802
|
-
'GET',
|
|
1803
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
1804
|
-
{ },
|
|
1805
|
-
{ },
|
|
1806
|
-
{ },
|
|
1807
|
-
null,
|
|
1808
|
-
['PureCloud OAuth'],
|
|
1809
|
-
['application/json'],
|
|
1810
|
-
['application/json']
|
|
1811
|
-
);
|
|
1812
|
-
}
|
|
1813
|
-
|
|
1814
|
-
/**
|
|
1815
|
-
* Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
|
|
1816
|
-
*
|
|
1817
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1818
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
1819
|
-
* @param {Object} opts Optional parameters
|
|
1820
|
-
* @param {Boolean} opts.includeOnlyPublished Return only published schedules
|
|
1821
|
-
* @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
|
|
1822
|
-
* @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
|
|
1432
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1433
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
1434
|
+
* @param {Object} opts Optional parameters
|
|
1435
|
+
* @param {Boolean} opts.includeOnlyPublished Return only published schedules
|
|
1436
|
+
* @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
|
|
1437
|
+
* @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
|
|
1823
1438
|
*/
|
|
1824
1439
|
getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
|
|
1825
1440
|
opts = opts || {};
|
|
@@ -1882,30 +1497,25 @@ class WorkforceManagementApi {
|
|
|
1882
1497
|
}
|
|
1883
1498
|
|
|
1884
1499
|
/**
|
|
1885
|
-
*
|
|
1500
|
+
* Get a work plan
|
|
1886
1501
|
*
|
|
1887
|
-
* @param {String} managementUnitId
|
|
1888
|
-
* @param {String}
|
|
1889
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
1502
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1503
|
+
* @param {String} workPlanId The ID of the work plan to fetch
|
|
1890
1504
|
*/
|
|
1891
|
-
|
|
1505
|
+
getWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId) {
|
|
1892
1506
|
// verify the required parameter 'managementUnitId' is set
|
|
1893
1507
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1894
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
1895
|
-
}
|
|
1896
|
-
// verify the required parameter 'weekDateId' is set
|
|
1897
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
1898
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
1508
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplan';
|
|
1899
1509
|
}
|
|
1900
|
-
// verify the required parameter '
|
|
1901
|
-
if (
|
|
1902
|
-
throw 'Missing the required parameter "
|
|
1510
|
+
// verify the required parameter 'workPlanId' is set
|
|
1511
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
1512
|
+
throw 'Missing the required parameter "workPlanId" when calling getWorkforcemanagementManagementunitWorkplan';
|
|
1903
1513
|
}
|
|
1904
1514
|
|
|
1905
1515
|
return this.apiClient.callApi(
|
|
1906
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
1516
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
1907
1517
|
'GET',
|
|
1908
|
-
{ 'managementUnitId': managementUnitId,'
|
|
1518
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
1909
1519
|
{ },
|
|
1910
1520
|
{ },
|
|
1911
1521
|
{ },
|
|
@@ -1917,25 +1527,25 @@ class WorkforceManagementApi {
|
|
|
1917
1527
|
}
|
|
1918
1528
|
|
|
1919
1529
|
/**
|
|
1920
|
-
*
|
|
1530
|
+
* Get a work plan rotation
|
|
1921
1531
|
*
|
|
1922
|
-
* @param {String} managementUnitId
|
|
1923
|
-
* @param {String}
|
|
1532
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1533
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to fetch
|
|
1924
1534
|
*/
|
|
1925
|
-
|
|
1535
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
1926
1536
|
// verify the required parameter 'managementUnitId' is set
|
|
1927
1537
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1928
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
1538
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
1929
1539
|
}
|
|
1930
|
-
// verify the required parameter '
|
|
1931
|
-
if (
|
|
1932
|
-
throw 'Missing the required parameter "
|
|
1540
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
1541
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
1542
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
1933
1543
|
}
|
|
1934
1544
|
|
|
1935
1545
|
return this.apiClient.callApi(
|
|
1936
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
1546
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
1937
1547
|
'GET',
|
|
1938
|
-
{ 'managementUnitId': managementUnitId,'
|
|
1548
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
1939
1549
|
{ },
|
|
1940
1550
|
{ },
|
|
1941
1551
|
{ },
|
|
@@ -1947,26 +1557,25 @@ class WorkforceManagementApi {
|
|
|
1947
1557
|
}
|
|
1948
1558
|
|
|
1949
1559
|
/**
|
|
1950
|
-
* Get
|
|
1560
|
+
* Get work plan rotations
|
|
1951
1561
|
*
|
|
1952
1562
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1953
|
-
* @param {
|
|
1563
|
+
* @param {Object} opts Optional parameters
|
|
1564
|
+
* @param {Array.<String>} opts.expand
|
|
1954
1565
|
*/
|
|
1955
|
-
|
|
1566
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
1567
|
+
opts = opts || {};
|
|
1568
|
+
|
|
1956
1569
|
// verify the required parameter 'managementUnitId' is set
|
|
1957
1570
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1958
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
1959
|
-
}
|
|
1960
|
-
// verify the required parameter 'workPlanId' is set
|
|
1961
|
-
if (workPlanId === undefined || workPlanId === null) {
|
|
1962
|
-
throw 'Missing the required parameter "workPlanId" when calling getWorkforcemanagementManagementunitWorkplan';
|
|
1571
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
1963
1572
|
}
|
|
1964
1573
|
|
|
1965
1574
|
return this.apiClient.callApi(
|
|
1966
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
1575
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
1967
1576
|
'GET',
|
|
1968
|
-
{ 'managementUnitId': managementUnitId
|
|
1969
|
-
{
|
|
1577
|
+
{ 'managementUnitId': managementUnitId },
|
|
1578
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1970
1579
|
{ },
|
|
1971
1580
|
{ },
|
|
1972
1581
|
null,
|
|
@@ -2365,129 +1974,6 @@ class WorkforceManagementApi {
|
|
|
2365
1974
|
);
|
|
2366
1975
|
}
|
|
2367
1976
|
|
|
2368
|
-
/**
|
|
2369
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
2370
|
-
*
|
|
2371
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2372
|
-
* @param {String} acId The ID of the activity code to update
|
|
2373
|
-
* @param {Object} opts Optional parameters
|
|
2374
|
-
* @param {Object} opts.body body
|
|
2375
|
-
*/
|
|
2376
|
-
patchWorkforcemanagementManagementunitActivitycode(muId, acId, opts) {
|
|
2377
|
-
opts = opts || {};
|
|
2378
|
-
|
|
2379
|
-
// verify the required parameter 'muId' is set
|
|
2380
|
-
if (muId === undefined || muId === null) {
|
|
2381
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
2382
|
-
}
|
|
2383
|
-
// verify the required parameter 'acId' is set
|
|
2384
|
-
if (acId === undefined || acId === null) {
|
|
2385
|
-
throw 'Missing the required parameter "acId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
2386
|
-
}
|
|
2387
|
-
|
|
2388
|
-
return this.apiClient.callApi(
|
|
2389
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
2390
|
-
'PATCH',
|
|
2391
|
-
{ 'muId': muId,'acId': acId },
|
|
2392
|
-
{ },
|
|
2393
|
-
{ },
|
|
2394
|
-
{ },
|
|
2395
|
-
opts['body'],
|
|
2396
|
-
['PureCloud OAuth'],
|
|
2397
|
-
['application/json'],
|
|
2398
|
-
['application/json']
|
|
2399
|
-
);
|
|
2400
|
-
}
|
|
2401
|
-
|
|
2402
|
-
/**
|
|
2403
|
-
* Gone. Scheduling has moved under business units
|
|
2404
|
-
*
|
|
2405
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
2406
|
-
* @param {String} runId The ID of the schedule run
|
|
2407
|
-
* @param {Object} opts Optional parameters
|
|
2408
|
-
* @param {Object} opts.body body
|
|
2409
|
-
*/
|
|
2410
|
-
patchWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId, opts) {
|
|
2411
|
-
opts = opts || {};
|
|
2412
|
-
|
|
2413
|
-
// verify the required parameter 'managementUnitId' is set
|
|
2414
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
2415
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
2416
|
-
}
|
|
2417
|
-
// verify the required parameter 'runId' is set
|
|
2418
|
-
if (runId === undefined || runId === null) {
|
|
2419
|
-
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
2420
|
-
}
|
|
2421
|
-
|
|
2422
|
-
return this.apiClient.callApi(
|
|
2423
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
2424
|
-
'PATCH',
|
|
2425
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
2426
|
-
{ },
|
|
2427
|
-
{ },
|
|
2428
|
-
{ },
|
|
2429
|
-
opts['body'],
|
|
2430
|
-
['PureCloud OAuth'],
|
|
2431
|
-
['application/json'],
|
|
2432
|
-
['application/json']
|
|
2433
|
-
);
|
|
2434
|
-
}
|
|
2435
|
-
|
|
2436
|
-
/**
|
|
2437
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
2438
|
-
*
|
|
2439
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2440
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to update
|
|
2441
|
-
*/
|
|
2442
|
-
patchWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
2443
|
-
// verify the required parameter 'managementUnitId' is set
|
|
2444
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
2445
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
2446
|
-
}
|
|
2447
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
2448
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
2449
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
2450
|
-
}
|
|
2451
|
-
|
|
2452
|
-
return this.apiClient.callApi(
|
|
2453
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
2454
|
-
'PATCH',
|
|
2455
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
2456
|
-
{ },
|
|
2457
|
-
{ },
|
|
2458
|
-
{ },
|
|
2459
|
-
null,
|
|
2460
|
-
['PureCloud OAuth'],
|
|
2461
|
-
['application/json'],
|
|
2462
|
-
['application/json']
|
|
2463
|
-
);
|
|
2464
|
-
}
|
|
2465
|
-
|
|
2466
|
-
/**
|
|
2467
|
-
* Gone. Update settings by PATCHing the management unit
|
|
2468
|
-
*
|
|
2469
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2470
|
-
*/
|
|
2471
|
-
patchWorkforcemanagementManagementunitSettings(muId) {
|
|
2472
|
-
// verify the required parameter 'muId' is set
|
|
2473
|
-
if (muId === undefined || muId === null) {
|
|
2474
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitSettings';
|
|
2475
|
-
}
|
|
2476
|
-
|
|
2477
|
-
return this.apiClient.callApi(
|
|
2478
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
2479
|
-
'PATCH',
|
|
2480
|
-
{ 'muId': muId },
|
|
2481
|
-
{ },
|
|
2482
|
-
{ },
|
|
2483
|
-
{ },
|
|
2484
|
-
null,
|
|
2485
|
-
['PureCloud OAuth'],
|
|
2486
|
-
['application/json'],
|
|
2487
|
-
['application/json']
|
|
2488
|
-
);
|
|
2489
|
-
}
|
|
2490
|
-
|
|
2491
1977
|
/**
|
|
2492
1978
|
* Update a time off request
|
|
2493
1979
|
*
|
|
@@ -2528,34 +2014,39 @@ class WorkforceManagementApi {
|
|
|
2528
2014
|
}
|
|
2529
2015
|
|
|
2530
2016
|
/**
|
|
2531
|
-
*
|
|
2017
|
+
* Updates a shift trade. This route can only be called by the initiating agent
|
|
2532
2018
|
*
|
|
2533
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2534
|
-
* @param {String}
|
|
2535
|
-
* @param {
|
|
2019
|
+
* @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2020
|
+
* @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
|
|
2021
|
+
* @param {Object} body body
|
|
2022
|
+
* @param {String} tradeId The ID of the shift trade to update
|
|
2536
2023
|
*/
|
|
2537
|
-
|
|
2024
|
+
patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, body, tradeId) {
|
|
2538
2025
|
// verify the required parameter 'managementUnitId' is set
|
|
2539
2026
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
2540
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
2027
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
|
|
2541
2028
|
}
|
|
2542
|
-
// verify the required parameter '
|
|
2543
|
-
if (
|
|
2544
|
-
throw 'Missing the required parameter "
|
|
2029
|
+
// verify the required parameter 'weekDateId' is set
|
|
2030
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
2031
|
+
throw 'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
|
|
2545
2032
|
}
|
|
2546
|
-
// verify the required parameter '
|
|
2547
|
-
if (
|
|
2548
|
-
throw 'Missing the required parameter "
|
|
2033
|
+
// verify the required parameter 'body' is set
|
|
2034
|
+
if (body === undefined || body === null) {
|
|
2035
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
|
|
2036
|
+
}
|
|
2037
|
+
// verify the required parameter 'tradeId' is set
|
|
2038
|
+
if (tradeId === undefined || tradeId === null) {
|
|
2039
|
+
throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
|
|
2549
2040
|
}
|
|
2550
2041
|
|
|
2551
2042
|
return this.apiClient.callApi(
|
|
2552
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{
|
|
2043
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}',
|
|
2553
2044
|
'PATCH',
|
|
2554
|
-
{ 'managementUnitId': managementUnitId,'
|
|
2045
|
+
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'tradeId': tradeId },
|
|
2555
2046
|
{ },
|
|
2556
2047
|
{ },
|
|
2557
2048
|
{ },
|
|
2558
|
-
|
|
2049
|
+
body,
|
|
2559
2050
|
['PureCloud OAuth'],
|
|
2560
2051
|
['application/json'],
|
|
2561
2052
|
['application/json']
|
|
@@ -2563,39 +2054,33 @@ class WorkforceManagementApi {
|
|
|
2563
2054
|
}
|
|
2564
2055
|
|
|
2565
2056
|
/**
|
|
2566
|
-
*
|
|
2057
|
+
* Update a work plan
|
|
2567
2058
|
*
|
|
2568
|
-
* @param {String} managementUnitId The
|
|
2569
|
-
* @param {String}
|
|
2570
|
-
* @param {Object}
|
|
2571
|
-
* @param {
|
|
2059
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2060
|
+
* @param {String} workPlanId The ID of the work plan to update
|
|
2061
|
+
* @param {Object} opts Optional parameters
|
|
2062
|
+
* @param {Object} opts.body body
|
|
2572
2063
|
*/
|
|
2573
|
-
|
|
2064
|
+
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
2065
|
+
opts = opts || {};
|
|
2066
|
+
|
|
2574
2067
|
// verify the required parameter 'managementUnitId' is set
|
|
2575
2068
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
2576
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
2577
|
-
}
|
|
2578
|
-
// verify the required parameter '
|
|
2579
|
-
if (
|
|
2580
|
-
throw 'Missing the required parameter "
|
|
2581
|
-
}
|
|
2582
|
-
// verify the required parameter 'body' is set
|
|
2583
|
-
if (body === undefined || body === null) {
|
|
2584
|
-
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
|
|
2585
|
-
}
|
|
2586
|
-
// verify the required parameter 'tradeId' is set
|
|
2587
|
-
if (tradeId === undefined || tradeId === null) {
|
|
2588
|
-
throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
|
|
2069
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
2070
|
+
}
|
|
2071
|
+
// verify the required parameter 'workPlanId' is set
|
|
2072
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
2073
|
+
throw 'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
2589
2074
|
}
|
|
2590
2075
|
|
|
2591
2076
|
return this.apiClient.callApi(
|
|
2592
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
2077
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
2593
2078
|
'PATCH',
|
|
2594
|
-
{ 'managementUnitId': managementUnitId,'
|
|
2079
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
2595
2080
|
{ },
|
|
2596
2081
|
{ },
|
|
2597
2082
|
{ },
|
|
2598
|
-
body,
|
|
2083
|
+
opts['body'],
|
|
2599
2084
|
['PureCloud OAuth'],
|
|
2600
2085
|
['application/json'],
|
|
2601
2086
|
['application/json']
|
|
@@ -2603,29 +2088,29 @@ class WorkforceManagementApi {
|
|
|
2603
2088
|
}
|
|
2604
2089
|
|
|
2605
2090
|
/**
|
|
2606
|
-
* Update a work plan
|
|
2091
|
+
* Update a work plan rotation
|
|
2607
2092
|
*
|
|
2608
2093
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2609
|
-
* @param {String}
|
|
2094
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
2610
2095
|
* @param {Object} opts Optional parameters
|
|
2611
2096
|
* @param {Object} opts.body body
|
|
2612
2097
|
*/
|
|
2613
|
-
|
|
2098
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
2614
2099
|
opts = opts || {};
|
|
2615
2100
|
|
|
2616
2101
|
// verify the required parameter 'managementUnitId' is set
|
|
2617
2102
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
2618
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
2103
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
2619
2104
|
}
|
|
2620
|
-
// verify the required parameter '
|
|
2621
|
-
if (
|
|
2622
|
-
throw 'Missing the required parameter "
|
|
2105
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
2106
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
2107
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
2623
2108
|
}
|
|
2624
2109
|
|
|
2625
2110
|
return this.apiClient.callApi(
|
|
2626
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
2111
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
2627
2112
|
'PATCH',
|
|
2628
|
-
{ 'managementUnitId': managementUnitId,'
|
|
2113
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
2629
2114
|
{ },
|
|
2630
2115
|
{ },
|
|
2631
2116
|
{ },
|
|
@@ -3140,270 +2625,19 @@ class WorkforceManagementApi {
|
|
|
3140
2625
|
}
|
|
3141
2626
|
|
|
3142
2627
|
/**
|
|
3143
|
-
* Add a new business unit
|
|
3144
|
-
* It may take a minute or two for a new business unit to be available for api operations
|
|
3145
|
-
* @param {Object} opts Optional parameters
|
|
3146
|
-
* @param {Object} opts.body body
|
|
3147
|
-
*/
|
|
3148
|
-
postWorkforcemanagementBusinessunits(opts) {
|
|
3149
|
-
opts = opts || {};
|
|
3150
|
-
|
|
3151
|
-
|
|
3152
|
-
return this.apiClient.callApi(
|
|
3153
|
-
'/api/v2/workforcemanagement/businessunits',
|
|
3154
|
-
'POST',
|
|
3155
|
-
{ },
|
|
3156
|
-
{ },
|
|
3157
|
-
{ },
|
|
3158
|
-
{ },
|
|
3159
|
-
opts['body'],
|
|
3160
|
-
['PureCloud OAuth'],
|
|
3161
|
-
['application/json'],
|
|
3162
|
-
['application/json']
|
|
3163
|
-
);
|
|
3164
|
-
}
|
|
3165
|
-
|
|
3166
|
-
/**
|
|
3167
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
3168
|
-
*
|
|
3169
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3170
|
-
*/
|
|
3171
|
-
postWorkforcemanagementManagementunitActivitycodes(muId) {
|
|
3172
|
-
// verify the required parameter 'muId' is set
|
|
3173
|
-
if (muId === undefined || muId === null) {
|
|
3174
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitActivitycodes';
|
|
3175
|
-
}
|
|
3176
|
-
|
|
3177
|
-
return this.apiClient.callApi(
|
|
3178
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes',
|
|
3179
|
-
'POST',
|
|
3180
|
-
{ 'muId': muId },
|
|
3181
|
-
{ },
|
|
3182
|
-
{ },
|
|
3183
|
-
{ },
|
|
3184
|
-
null,
|
|
3185
|
-
['PureCloud OAuth'],
|
|
3186
|
-
['application/json'],
|
|
3187
|
-
['application/json']
|
|
3188
|
-
);
|
|
3189
|
-
}
|
|
3190
|
-
|
|
3191
|
-
/**
|
|
3192
|
-
* Query published schedules for given given time range for set of users
|
|
3193
|
-
*
|
|
3194
|
-
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3195
|
-
* @param {Object} opts Optional parameters
|
|
3196
|
-
* @param {Object} opts.body body
|
|
3197
|
-
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
3198
|
-
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
3199
|
-
*/
|
|
3200
|
-
postWorkforcemanagementManagementunitAgentschedulesSearch(muId, opts) {
|
|
3201
|
-
opts = opts || {};
|
|
3202
|
-
|
|
3203
|
-
// verify the required parameter 'muId' is set
|
|
3204
|
-
if (muId === undefined || muId === null) {
|
|
3205
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
3206
|
-
}
|
|
3207
|
-
|
|
3208
|
-
return this.apiClient.callApi(
|
|
3209
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/agentschedules/search',
|
|
3210
|
-
'POST',
|
|
3211
|
-
{ 'muId': muId },
|
|
3212
|
-
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
3213
|
-
{ },
|
|
3214
|
-
{ },
|
|
3215
|
-
opts['body'],
|
|
3216
|
-
['PureCloud OAuth'],
|
|
3217
|
-
['application/json'],
|
|
3218
|
-
['application/json']
|
|
3219
|
-
);
|
|
3220
|
-
}
|
|
3221
|
-
|
|
3222
|
-
/**
|
|
3223
|
-
* Request a historical adherence report
|
|
3224
|
-
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
3225
|
-
* @param {String} muId The management unit ID of the management unit
|
|
3226
|
-
* @param {Object} opts Optional parameters
|
|
3227
|
-
* @param {Object} opts.body body
|
|
3228
|
-
*/
|
|
3229
|
-
postWorkforcemanagementManagementunitHistoricaladherencequery(muId, opts) {
|
|
3230
|
-
opts = opts || {};
|
|
3231
|
-
|
|
3232
|
-
// verify the required parameter 'muId' is set
|
|
3233
|
-
if (muId === undefined || muId === null) {
|
|
3234
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
3235
|
-
}
|
|
3236
|
-
|
|
3237
|
-
return this.apiClient.callApi(
|
|
3238
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery',
|
|
3239
|
-
'POST',
|
|
3240
|
-
{ 'muId': muId },
|
|
3241
|
-
{ },
|
|
3242
|
-
{ },
|
|
3243
|
-
{ },
|
|
3244
|
-
opts['body'],
|
|
3245
|
-
['PureCloud OAuth'],
|
|
3246
|
-
['application/json'],
|
|
3247
|
-
['application/json']
|
|
3248
|
-
);
|
|
3249
|
-
}
|
|
3250
|
-
|
|
3251
|
-
/**
|
|
3252
|
-
* Gone. Moved under business units
|
|
3253
|
-
*
|
|
3254
|
-
* @param {String} muId The management unit ID of the management unit
|
|
3255
|
-
*/
|
|
3256
|
-
postWorkforcemanagementManagementunitIntraday(muId) {
|
|
3257
|
-
// verify the required parameter 'muId' is set
|
|
3258
|
-
if (muId === undefined || muId === null) {
|
|
3259
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitIntraday';
|
|
3260
|
-
}
|
|
3261
|
-
|
|
3262
|
-
return this.apiClient.callApi(
|
|
3263
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday',
|
|
3264
|
-
'POST',
|
|
3265
|
-
{ 'muId': muId },
|
|
3266
|
-
{ },
|
|
3267
|
-
{ },
|
|
3268
|
-
{ },
|
|
3269
|
-
null,
|
|
3270
|
-
['PureCloud OAuth'],
|
|
3271
|
-
['application/json'],
|
|
3272
|
-
['application/json']
|
|
3273
|
-
);
|
|
3274
|
-
}
|
|
3275
|
-
|
|
3276
|
-
/**
|
|
3277
|
-
* Move the requested management unit to a new business unit
|
|
3278
|
-
* Returns status 200 if the management unit is already in the requested business unit
|
|
3279
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3280
|
-
* @param {Object} opts Optional parameters
|
|
3281
|
-
* @param {Object} opts.body body
|
|
3282
|
-
*/
|
|
3283
|
-
postWorkforcemanagementManagementunitMove(muId, opts) {
|
|
3284
|
-
opts = opts || {};
|
|
3285
|
-
|
|
3286
|
-
// verify the required parameter 'muId' is set
|
|
3287
|
-
if (muId === undefined || muId === null) {
|
|
3288
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitMove';
|
|
3289
|
-
}
|
|
3290
|
-
|
|
3291
|
-
return this.apiClient.callApi(
|
|
3292
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/move',
|
|
3293
|
-
'POST',
|
|
3294
|
-
{ 'muId': muId },
|
|
3295
|
-
{ },
|
|
3296
|
-
{ },
|
|
3297
|
-
{ },
|
|
3298
|
-
opts['body'],
|
|
3299
|
-
['PureCloud OAuth'],
|
|
3300
|
-
['application/json'],
|
|
3301
|
-
['application/json']
|
|
3302
|
-
);
|
|
3303
|
-
}
|
|
3304
|
-
|
|
3305
|
-
/**
|
|
3306
|
-
* Query published schedules for given given time range for set of users
|
|
3307
|
-
*
|
|
3308
|
-
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3309
|
-
* @param {Object} opts Optional parameters
|
|
3310
|
-
* @param {Object} opts.body body
|
|
3311
|
-
*/
|
|
3312
|
-
postWorkforcemanagementManagementunitSchedulesSearch(muId, opts) {
|
|
3313
|
-
opts = opts || {};
|
|
3314
|
-
|
|
3315
|
-
// verify the required parameter 'muId' is set
|
|
3316
|
-
if (muId === undefined || muId === null) {
|
|
3317
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
3318
|
-
}
|
|
3319
|
-
|
|
3320
|
-
return this.apiClient.callApi(
|
|
3321
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/schedules/search',
|
|
3322
|
-
'POST',
|
|
3323
|
-
{ 'muId': muId },
|
|
3324
|
-
{ },
|
|
3325
|
-
{ },
|
|
3326
|
-
{ },
|
|
3327
|
-
opts['body'],
|
|
3328
|
-
['PureCloud OAuth'],
|
|
3329
|
-
['application/json'],
|
|
3330
|
-
['application/json']
|
|
3331
|
-
);
|
|
3332
|
-
}
|
|
3333
|
-
|
|
3334
|
-
/**
|
|
3335
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
3336
|
-
*
|
|
3337
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3338
|
-
*/
|
|
3339
|
-
postWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
3340
|
-
// verify the required parameter 'managementUnitId' is set
|
|
3341
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3342
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitServicegoalgroups';
|
|
3343
|
-
}
|
|
3344
|
-
|
|
3345
|
-
return this.apiClient.callApi(
|
|
3346
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
3347
|
-
'POST',
|
|
3348
|
-
{ 'managementUnitId': managementUnitId },
|
|
3349
|
-
{ },
|
|
3350
|
-
{ },
|
|
3351
|
-
{ },
|
|
3352
|
-
null,
|
|
3353
|
-
['PureCloud OAuth'],
|
|
3354
|
-
['application/json'],
|
|
3355
|
-
['application/json']
|
|
3356
|
-
);
|
|
3357
|
-
}
|
|
3358
|
-
|
|
3359
|
-
/**
|
|
3360
|
-
* Create a new time off request
|
|
3361
|
-
*
|
|
3362
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3363
|
-
* @param {Object} opts Optional parameters
|
|
3364
|
-
* @param {Object} opts.body body
|
|
3365
|
-
*/
|
|
3366
|
-
postWorkforcemanagementManagementunitTimeoffrequests(muId, opts) {
|
|
3367
|
-
opts = opts || {};
|
|
3368
|
-
|
|
3369
|
-
// verify the required parameter 'muId' is set
|
|
3370
|
-
if (muId === undefined || muId === null) {
|
|
3371
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
3372
|
-
}
|
|
3373
|
-
|
|
3374
|
-
return this.apiClient.callApi(
|
|
3375
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests',
|
|
3376
|
-
'POST',
|
|
3377
|
-
{ 'muId': muId },
|
|
3378
|
-
{ },
|
|
3379
|
-
{ },
|
|
3380
|
-
{ },
|
|
3381
|
-
opts['body'],
|
|
3382
|
-
['PureCloud OAuth'],
|
|
3383
|
-
['application/json'],
|
|
3384
|
-
['application/json']
|
|
3385
|
-
);
|
|
3386
|
-
}
|
|
3387
|
-
|
|
3388
|
-
/**
|
|
3389
|
-
* Gone. All data is now returned in the query route
|
|
3390
|
-
*
|
|
3391
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2628
|
+
* Add a new business unit
|
|
2629
|
+
* It may take a minute or two for a new business unit to be available for api operations
|
|
3392
2630
|
* @param {Object} opts Optional parameters
|
|
3393
2631
|
* @param {Object} opts.body body
|
|
3394
2632
|
*/
|
|
3395
|
-
|
|
2633
|
+
postWorkforcemanagementBusinessunits(opts) {
|
|
3396
2634
|
opts = opts || {};
|
|
3397
2635
|
|
|
3398
|
-
// verify the required parameter 'muId' is set
|
|
3399
|
-
if (muId === undefined || muId === null) {
|
|
3400
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails';
|
|
3401
|
-
}
|
|
3402
2636
|
|
|
3403
2637
|
return this.apiClient.callApi(
|
|
3404
|
-
'/api/v2/workforcemanagement/
|
|
2638
|
+
'/api/v2/workforcemanagement/businessunits',
|
|
3405
2639
|
'POST',
|
|
3406
|
-
{
|
|
2640
|
+
{ },
|
|
3407
2641
|
{ },
|
|
3408
2642
|
{ },
|
|
3409
2643
|
{ },
|
|
@@ -3415,25 +2649,27 @@ class WorkforceManagementApi {
|
|
|
3415
2649
|
}
|
|
3416
2650
|
|
|
3417
2651
|
/**
|
|
3418
|
-
*
|
|
2652
|
+
* Query published schedules for given given time range for set of users
|
|
3419
2653
|
*
|
|
3420
|
-
* @param {String} muId The
|
|
2654
|
+
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3421
2655
|
* @param {Object} opts Optional parameters
|
|
3422
2656
|
* @param {Object} opts.body body
|
|
2657
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
2658
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
3423
2659
|
*/
|
|
3424
|
-
|
|
2660
|
+
postWorkforcemanagementManagementunitAgentschedulesSearch(muId, opts) {
|
|
3425
2661
|
opts = opts || {};
|
|
3426
2662
|
|
|
3427
2663
|
// verify the required parameter 'muId' is set
|
|
3428
2664
|
if (muId === undefined || muId === null) {
|
|
3429
|
-
throw 'Missing the required parameter "muId" when calling
|
|
2665
|
+
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
3430
2666
|
}
|
|
3431
2667
|
|
|
3432
2668
|
return this.apiClient.callApi(
|
|
3433
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/
|
|
2669
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/agentschedules/search',
|
|
3434
2670
|
'POST',
|
|
3435
2671
|
{ 'muId': muId },
|
|
3436
|
-
{
|
|
2672
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
3437
2673
|
{ },
|
|
3438
2674
|
{ },
|
|
3439
2675
|
opts['body'],
|
|
@@ -3444,34 +2680,28 @@ class WorkforceManagementApi {
|
|
|
3444
2680
|
}
|
|
3445
2681
|
|
|
3446
2682
|
/**
|
|
3447
|
-
*
|
|
3448
|
-
*
|
|
3449
|
-
* @param {String}
|
|
3450
|
-
* @param {
|
|
3451
|
-
* @param {
|
|
2683
|
+
* Request a historical adherence report
|
|
2684
|
+
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
2685
|
+
* @param {String} muId The management unit ID of the management unit
|
|
2686
|
+
* @param {Object} opts Optional parameters
|
|
2687
|
+
* @param {Object} opts.body body
|
|
3452
2688
|
*/
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
|
|
3459
|
-
if (weekId === undefined || weekId === null) {
|
|
3460
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
3461
|
-
}
|
|
3462
|
-
// verify the required parameter 'scheduleId' is set
|
|
3463
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3464
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
2689
|
+
postWorkforcemanagementManagementunitHistoricaladherencequery(muId, opts) {
|
|
2690
|
+
opts = opts || {};
|
|
2691
|
+
|
|
2692
|
+
// verify the required parameter 'muId' is set
|
|
2693
|
+
if (muId === undefined || muId === null) {
|
|
2694
|
+
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
3465
2695
|
}
|
|
3466
2696
|
|
|
3467
2697
|
return this.apiClient.callApi(
|
|
3468
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
2698
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery',
|
|
3469
2699
|
'POST',
|
|
3470
|
-
{ '
|
|
2700
|
+
{ 'muId': muId },
|
|
3471
2701
|
{ },
|
|
3472
2702
|
{ },
|
|
3473
2703
|
{ },
|
|
3474
|
-
|
|
2704
|
+
opts['body'],
|
|
3475
2705
|
['PureCloud OAuth'],
|
|
3476
2706
|
['application/json'],
|
|
3477
2707
|
['application/json']
|
|
@@ -3479,34 +2709,28 @@ class WorkforceManagementApi {
|
|
|
3479
2709
|
}
|
|
3480
2710
|
|
|
3481
2711
|
/**
|
|
3482
|
-
*
|
|
3483
|
-
*
|
|
3484
|
-
* @param {String}
|
|
3485
|
-
* @param {
|
|
3486
|
-
* @param {
|
|
2712
|
+
* Move the requested management unit to a new business unit
|
|
2713
|
+
* Returns status 200 if the management unit is already in the requested business unit
|
|
2714
|
+
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2715
|
+
* @param {Object} opts Optional parameters
|
|
2716
|
+
* @param {Object} opts.body body
|
|
3487
2717
|
*/
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
if (weekId === undefined || weekId === null) {
|
|
3495
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
3496
|
-
}
|
|
3497
|
-
// verify the required parameter 'scheduleId' is set
|
|
3498
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3499
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
2718
|
+
postWorkforcemanagementManagementunitMove(muId, opts) {
|
|
2719
|
+
opts = opts || {};
|
|
2720
|
+
|
|
2721
|
+
// verify the required parameter 'muId' is set
|
|
2722
|
+
if (muId === undefined || muId === null) {
|
|
2723
|
+
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitMove';
|
|
3500
2724
|
}
|
|
3501
2725
|
|
|
3502
2726
|
return this.apiClient.callApi(
|
|
3503
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
2727
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/move',
|
|
3504
2728
|
'POST',
|
|
3505
|
-
{ '
|
|
2729
|
+
{ 'muId': muId },
|
|
3506
2730
|
{ },
|
|
3507
2731
|
{ },
|
|
3508
2732
|
{ },
|
|
3509
|
-
|
|
2733
|
+
opts['body'],
|
|
3510
2734
|
['PureCloud OAuth'],
|
|
3511
2735
|
['application/json'],
|
|
3512
2736
|
['application/json']
|
|
@@ -3514,29 +2738,28 @@ class WorkforceManagementApi {
|
|
|
3514
2738
|
}
|
|
3515
2739
|
|
|
3516
2740
|
/**
|
|
3517
|
-
*
|
|
2741
|
+
* Query published schedules for given given time range for set of users
|
|
3518
2742
|
*
|
|
3519
|
-
* @param {String}
|
|
3520
|
-
* @param {
|
|
2743
|
+
* @param {String} muId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2744
|
+
* @param {Object} opts Optional parameters
|
|
2745
|
+
* @param {Object} opts.body body
|
|
3521
2746
|
*/
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
if (weekId === undefined || weekId === null) {
|
|
3529
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
2747
|
+
postWorkforcemanagementManagementunitSchedulesSearch(muId, opts) {
|
|
2748
|
+
opts = opts || {};
|
|
2749
|
+
|
|
2750
|
+
// verify the required parameter 'muId' is set
|
|
2751
|
+
if (muId === undefined || muId === null) {
|
|
2752
|
+
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
3530
2753
|
}
|
|
3531
2754
|
|
|
3532
2755
|
return this.apiClient.callApi(
|
|
3533
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
2756
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/schedules/search',
|
|
3534
2757
|
'POST',
|
|
3535
|
-
{ '
|
|
2758
|
+
{ 'muId': muId },
|
|
3536
2759
|
{ },
|
|
3537
2760
|
{ },
|
|
3538
2761
|
{ },
|
|
3539
|
-
|
|
2762
|
+
opts['body'],
|
|
3540
2763
|
['PureCloud OAuth'],
|
|
3541
2764
|
['application/json'],
|
|
3542
2765
|
['application/json']
|
|
@@ -3544,29 +2767,28 @@ class WorkforceManagementApi {
|
|
|
3544
2767
|
}
|
|
3545
2768
|
|
|
3546
2769
|
/**
|
|
3547
|
-
*
|
|
2770
|
+
* Create a new time off request
|
|
3548
2771
|
*
|
|
3549
|
-
* @param {String}
|
|
3550
|
-
* @param {
|
|
2772
|
+
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2773
|
+
* @param {Object} opts Optional parameters
|
|
2774
|
+
* @param {Object} opts.body body
|
|
3551
2775
|
*/
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
if (weekId === undefined || weekId === null) {
|
|
3559
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
2776
|
+
postWorkforcemanagementManagementunitTimeoffrequests(muId, opts) {
|
|
2777
|
+
opts = opts || {};
|
|
2778
|
+
|
|
2779
|
+
// verify the required parameter 'muId' is set
|
|
2780
|
+
if (muId === undefined || muId === null) {
|
|
2781
|
+
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
3560
2782
|
}
|
|
3561
2783
|
|
|
3562
2784
|
return this.apiClient.callApi(
|
|
3563
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
2785
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests',
|
|
3564
2786
|
'POST',
|
|
3565
|
-
{ '
|
|
2787
|
+
{ 'muId': muId },
|
|
3566
2788
|
{ },
|
|
3567
2789
|
{ },
|
|
3568
2790
|
{ },
|
|
3569
|
-
|
|
2791
|
+
opts['body'],
|
|
3570
2792
|
['PureCloud OAuth'],
|
|
3571
2793
|
['application/json'],
|
|
3572
2794
|
['application/json']
|
|
@@ -3574,29 +2796,28 @@ class WorkforceManagementApi {
|
|
|
3574
2796
|
}
|
|
3575
2797
|
|
|
3576
2798
|
/**
|
|
3577
|
-
*
|
|
2799
|
+
* Gets the lookup ids to fetch the specified set of requests
|
|
3578
2800
|
*
|
|
3579
|
-
* @param {String}
|
|
3580
|
-
* @param {
|
|
2801
|
+
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2802
|
+
* @param {Object} opts Optional parameters
|
|
2803
|
+
* @param {Object} opts.body body
|
|
3581
2804
|
*/
|
|
3582
|
-
|
|
3583
|
-
|
|
3584
|
-
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
if (weekId === undefined || weekId === null) {
|
|
3589
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
2805
|
+
postWorkforcemanagementManagementunitTimeoffrequestsQuery(muId, opts) {
|
|
2806
|
+
opts = opts || {};
|
|
2807
|
+
|
|
2808
|
+
// verify the required parameter 'muId' is set
|
|
2809
|
+
if (muId === undefined || muId === null) {
|
|
2810
|
+
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
|
|
3590
2811
|
}
|
|
3591
2812
|
|
|
3592
2813
|
return this.apiClient.callApi(
|
|
3593
|
-
'/api/v2/workforcemanagement/managementunits/{
|
|
2814
|
+
'/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query',
|
|
3594
2815
|
'POST',
|
|
3595
|
-
{ '
|
|
2816
|
+
{ 'muId': muId },
|
|
3596
2817
|
{ },
|
|
3597
2818
|
{ },
|
|
3598
2819
|
{ },
|
|
3599
|
-
|
|
2820
|
+
opts['body'],
|
|
3600
2821
|
['PureCloud OAuth'],
|
|
3601
2822
|
['application/json'],
|
|
3602
2823
|
['application/json']
|
|
@@ -3753,94 +2974,33 @@ class WorkforceManagementApi {
|
|
|
3753
2974
|
}
|
|
3754
2975
|
|
|
3755
2976
|
/**
|
|
3756
|
-
*
|
|
3757
|
-
*
|
|
3758
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
3759
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
3760
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
3761
|
-
*/
|
|
3762
|
-
postWorkforcemanagementManagementunitWeekShorttermforecastCopy(managementUnitId, weekDateId, forecastId) {
|
|
3763
|
-
// verify the required parameter 'managementUnitId' is set
|
|
3764
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3765
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
3766
|
-
}
|
|
3767
|
-
// verify the required parameter 'weekDateId' is set
|
|
3768
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
3769
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
3770
|
-
}
|
|
3771
|
-
// verify the required parameter 'forecastId' is set
|
|
3772
|
-
if (forecastId === undefined || forecastId === null) {
|
|
3773
|
-
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
3774
|
-
}
|
|
3775
|
-
|
|
3776
|
-
return this.apiClient.callApi(
|
|
3777
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy',
|
|
3778
|
-
'POST',
|
|
3779
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
3780
|
-
{ },
|
|
3781
|
-
{ },
|
|
3782
|
-
{ },
|
|
3783
|
-
null,
|
|
3784
|
-
['PureCloud OAuth'],
|
|
3785
|
-
['application/json'],
|
|
3786
|
-
['application/json']
|
|
3787
|
-
);
|
|
3788
|
-
}
|
|
3789
|
-
|
|
3790
|
-
/**
|
|
3791
|
-
* Gone. Use equivalent business unit resource instead
|
|
3792
|
-
*
|
|
3793
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
3794
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
3795
|
-
*/
|
|
3796
|
-
postWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
3797
|
-
// verify the required parameter 'managementUnitId' is set
|
|
3798
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3799
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
3800
|
-
}
|
|
3801
|
-
// verify the required parameter 'weekDateId' is set
|
|
3802
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
3803
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
3804
|
-
}
|
|
3805
|
-
|
|
3806
|
-
return this.apiClient.callApi(
|
|
3807
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
3808
|
-
'POST',
|
|
3809
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
3810
|
-
{ },
|
|
3811
|
-
{ },
|
|
3812
|
-
{ },
|
|
3813
|
-
null,
|
|
3814
|
-
['PureCloud OAuth'],
|
|
3815
|
-
['application/json'],
|
|
3816
|
-
['application/json']
|
|
3817
|
-
);
|
|
3818
|
-
}
|
|
3819
|
-
|
|
3820
|
-
/**
|
|
3821
|
-
* Gone. Use equivalent business unit resource instead
|
|
2977
|
+
* Create a copy of work plan
|
|
3822
2978
|
*
|
|
3823
|
-
* @param {String} managementUnitId
|
|
3824
|
-
* @param {String}
|
|
2979
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2980
|
+
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
2981
|
+
* @param {Object} opts Optional parameters
|
|
2982
|
+
* @param {Object} opts.body body
|
|
3825
2983
|
*/
|
|
3826
|
-
|
|
2984
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
|
|
2985
|
+
opts = opts || {};
|
|
2986
|
+
|
|
3827
2987
|
// verify the required parameter 'managementUnitId' is set
|
|
3828
2988
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3829
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
2989
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
3830
2990
|
}
|
|
3831
|
-
// verify the required parameter '
|
|
3832
|
-
if (
|
|
3833
|
-
throw 'Missing the required parameter "
|
|
2991
|
+
// verify the required parameter 'workPlanId' is set
|
|
2992
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
2993
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
3834
2994
|
}
|
|
3835
2995
|
|
|
3836
2996
|
return this.apiClient.callApi(
|
|
3837
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
2997
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
3838
2998
|
'POST',
|
|
3839
|
-
{ 'managementUnitId': managementUnitId,'
|
|
2999
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
3840
3000
|
{ },
|
|
3841
3001
|
{ },
|
|
3842
3002
|
{ },
|
|
3843
|
-
|
|
3003
|
+
opts['body'],
|
|
3844
3004
|
['PureCloud OAuth'],
|
|
3845
3005
|
['application/json'],
|
|
3846
3006
|
['application/json']
|
|
@@ -3848,29 +3008,34 @@ class WorkforceManagementApi {
|
|
|
3848
3008
|
}
|
|
3849
3009
|
|
|
3850
3010
|
/**
|
|
3851
|
-
*
|
|
3011
|
+
* Validate Work Plan
|
|
3852
3012
|
*
|
|
3853
|
-
* @param {String} managementUnitId
|
|
3854
|
-
* @param {String}
|
|
3013
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3014
|
+
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
3015
|
+
* @param {Object} opts Optional parameters
|
|
3016
|
+
* @param {Object} opts.body body
|
|
3017
|
+
* @param {Array.<String>} opts.expand
|
|
3855
3018
|
*/
|
|
3856
|
-
|
|
3019
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
3020
|
+
opts = opts || {};
|
|
3021
|
+
|
|
3857
3022
|
// verify the required parameter 'managementUnitId' is set
|
|
3858
3023
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3859
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
3024
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
3860
3025
|
}
|
|
3861
|
-
// verify the required parameter '
|
|
3862
|
-
if (
|
|
3863
|
-
throw 'Missing the required parameter "
|
|
3026
|
+
// verify the required parameter 'workPlanId' is set
|
|
3027
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
3028
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
3864
3029
|
}
|
|
3865
3030
|
|
|
3866
3031
|
return this.apiClient.callApi(
|
|
3867
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
3032
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
3868
3033
|
'POST',
|
|
3869
|
-
{ 'managementUnitId': managementUnitId,'
|
|
3870
|
-
{
|
|
3034
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
3035
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
3871
3036
|
{ },
|
|
3872
3037
|
{ },
|
|
3873
|
-
|
|
3038
|
+
opts['body'],
|
|
3874
3039
|
['PureCloud OAuth'],
|
|
3875
3040
|
['application/json'],
|
|
3876
3041
|
['application/json']
|
|
@@ -3878,29 +3043,29 @@ class WorkforceManagementApi {
|
|
|
3878
3043
|
}
|
|
3879
3044
|
|
|
3880
3045
|
/**
|
|
3881
|
-
* Create a copy of work plan
|
|
3046
|
+
* Create a copy of work plan rotation
|
|
3882
3047
|
*
|
|
3883
3048
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3884
|
-
* @param {String}
|
|
3049
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
3885
3050
|
* @param {Object} opts Optional parameters
|
|
3886
3051
|
* @param {Object} opts.body body
|
|
3887
3052
|
*/
|
|
3888
|
-
|
|
3053
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
3889
3054
|
opts = opts || {};
|
|
3890
3055
|
|
|
3891
3056
|
// verify the required parameter 'managementUnitId' is set
|
|
3892
3057
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3893
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
3058
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
3894
3059
|
}
|
|
3895
|
-
// verify the required parameter '
|
|
3896
|
-
if (
|
|
3897
|
-
throw 'Missing the required parameter "
|
|
3060
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
3061
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
3062
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
3898
3063
|
}
|
|
3899
3064
|
|
|
3900
3065
|
return this.apiClient.callApi(
|
|
3901
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
3066
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
3902
3067
|
'POST',
|
|
3903
|
-
{ 'managementUnitId': managementUnitId,'
|
|
3068
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
3904
3069
|
{ },
|
|
3905
3070
|
{ },
|
|
3906
3071
|
{ },
|
|
@@ -3912,31 +3077,25 @@ class WorkforceManagementApi {
|
|
|
3912
3077
|
}
|
|
3913
3078
|
|
|
3914
3079
|
/**
|
|
3915
|
-
*
|
|
3080
|
+
* Create a new work plan rotation
|
|
3916
3081
|
*
|
|
3917
3082
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3918
|
-
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
3919
3083
|
* @param {Object} opts Optional parameters
|
|
3920
3084
|
* @param {Object} opts.body body
|
|
3921
|
-
* @param {Array.<String>} opts.expand
|
|
3922
3085
|
*/
|
|
3923
|
-
|
|
3086
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
3924
3087
|
opts = opts || {};
|
|
3925
3088
|
|
|
3926
3089
|
// verify the required parameter 'managementUnitId' is set
|
|
3927
3090
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3928
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
3929
|
-
}
|
|
3930
|
-
// verify the required parameter 'workPlanId' is set
|
|
3931
|
-
if (workPlanId === undefined || workPlanId === null) {
|
|
3932
|
-
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
3091
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
3933
3092
|
}
|
|
3934
3093
|
|
|
3935
3094
|
return this.apiClient.callApi(
|
|
3936
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
3095
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
3937
3096
|
'POST',
|
|
3938
|
-
{ 'managementUnitId': managementUnitId
|
|
3939
|
-
{
|
|
3097
|
+
{ 'managementUnitId': managementUnitId },
|
|
3098
|
+
{ },
|
|
3940
3099
|
{ },
|
|
3941
3100
|
{ },
|
|
3942
3101
|
opts['body'],
|