purecloud-platform-client-v2 95.0.0 → 98.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +412 -1256
  3. package/dist/web-amd/purecloud-platform-client-v2.js +412 -1256
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +412 -1256
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +418 -1263
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +319 -128
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +3 -3
  17. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -10
  20. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +6 -4
  32. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/QualityApi.js +9 -8
  45. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/SCIMApi.js +26 -26
  49. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +3 -3
  55. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/UsersApi.js +123 -1
  62. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +309 -1148
  67. package/src/purecloud-platform-client-v2/index.js +1 -7
  68. 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 95.0.0
8
+ * @version 98.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -261,155 +261,25 @@ class WorkforceManagementApi {
261
261
  }
262
262
 
263
263
  /**
264
- * Deprecated/Gone: Use the new business unit activity code resources
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} weekId First day of schedule week in yyyy-MM-dd format.
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
- deleteWorkforcemanagementManagementunitWeekShorttermforecast(managementUnitId, weekDateId, forecastId) {
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 deleteWorkforcemanagementManagementunitWeekShorttermforecast';
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 'forecastId' is set
405
- if (forecastId === undefined || forecastId === null) {
406
- throw 'Missing the required parameter "forecastId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
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}/weeks/{weekDateId}/shorttermforecasts/{forecastId}',
280
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
411
281
  'DELETE',
412
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
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} workPlanId The ID of the work plan to delete
297
+ * @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
428
298
  */
429
- deleteWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId) {
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 deleteWorkforcemanagementManagementunitWorkplan';
302
+ throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
433
303
  }
434
- // verify the required parameter 'workPlanId' is set
435
- if (workPlanId === undefined || workPlanId === null) {
436
- throw 'Missing the required parameter "workPlanId" when calling deleteWorkforcemanagementManagementunitWorkplan';
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}/workplans/{workPlanId}',
310
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
441
311
  'DELETE',
442
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
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
- * Gone. Moved under business units
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
- getWorkforcemanagementManagementunitIntradayQueues(muId) {
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 getWorkforcemanagementManagementunitIntradayQueues';
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}/intraday/queues',
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
- * Gone. Scheduling has moved under business units
1271
+ * Gets list of users available for whom you can send direct shift trade requests
1432
1272
  *
1433
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
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
- getWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
1437
- // verify the required parameter 'managementUnitId' is set
1438
- if (managementUnitId === undefined || managementUnitId === null) {
1439
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRun';
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/{managementUnitId}/scheduling/runs/{runId}',
1282
+ '/api/v2/workforcemanagement/managementunits/{muId}/shifttrades/users',
1448
1283
  'GET',
1449
- { 'managementUnitId': managementUnitId,'runId': runId },
1284
+ { 'muId': muId },
1450
1285
  { },
1451
1286
  { },
1452
1287
  { },
@@ -1458,25 +1293,30 @@ class WorkforceManagementApi {
1458
1293
  }
1459
1294
 
1460
1295
  /**
1461
- * Gone. Scheduling has moved under business units
1296
+ * Get a time off request
1462
1297
  *
1463
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
1464
- * @param {String} runId The ID of the schedule run
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
- getWorkforcemanagementManagementunitSchedulingRunResult(managementUnitId, runId) {
1467
- // verify the required parameter 'managementUnitId' is set
1468
- if (managementUnitId === undefined || managementUnitId === null) {
1469
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
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 'runId' is set
1472
- if (runId === undefined || runId === null) {
1473
- throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
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/{managementUnitId}/scheduling/runs/{runId}/result',
1317
+ '/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}',
1478
1318
  'GET',
1479
- { 'managementUnitId': managementUnitId,'runId': runId },
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
- * Gone. Scheduling has moved under business units
1331
+ * Get a list of time off requests for a given user
1492
1332
  *
1493
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
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
- getWorkforcemanagementManagementunitSchedulingRuns(managementUnitId) {
1496
- // verify the required parameter 'managementUnitId' is set
1497
- if (managementUnitId === undefined || managementUnitId === null) {
1498
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRuns';
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/{managementUnitId}/scheduling/runs',
1351
+ '/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests',
1503
1352
  'GET',
1504
- { 'managementUnitId': managementUnitId },
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
- * Gone. Replaced with service goal templates and planning groups under business units
1365
+ * Get users in the management unit
1517
1366
  *
1518
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
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
- getWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
1522
- // verify the required parameter 'managementUnitId' is set
1523
- if (managementUnitId === undefined || managementUnitId === null) {
1524
- throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
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/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
1376
+ '/api/v2/workforcemanagement/managementunits/{muId}/users',
1533
1377
  'GET',
1534
- { 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
1378
+ { 'muId': muId },
1535
1379
  { },
1536
1380
  { },
1537
1381
  { },
@@ -1543,21 +1387,36 @@ class WorkforceManagementApi {
1543
1387
  }
1544
1388
 
1545
1389
  /**
1546
- * Gone. Replaced with service goal templates and planning groups under business units
1390
+ * Deprecated. Use the equivalent business unit resource instead. Get a week schedule
1547
1391
  *
1548
- * @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
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
- getWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
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 getWorkforcemanagementManagementunitServicegoalgroups';
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}/servicegoalgroups',
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
- * Gone. Get management unit settings via expand parameters on the GET management unit
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} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
1574
- */
1575
- getWorkforcemanagementManagementunitSettings(muId) {
1576
- // verify the required parameter 'muId' is set
1577
- if (muId === undefined || muId === null) {
1578
- throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitSettings';
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
- * Gone. Use equivalent business unit resource instead
1500
+ * Get a work plan
1886
1501
  *
1887
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
1888
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
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
- getWorkforcemanagementManagementunitWeekShorttermforecastFinal(managementUnitId, weekDateId, forecastId) {
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 getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
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 'forecastId' is set
1901
- if (forecastId === undefined || forecastId === null) {
1902
- throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
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}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final',
1516
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
1907
1517
  'GET',
1908
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
1518
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
1909
1519
  { },
1910
1520
  { },
1911
1521
  { },
@@ -1917,25 +1527,25 @@ class WorkforceManagementApi {
1917
1527
  }
1918
1528
 
1919
1529
  /**
1920
- * Gone. Use equivalent business unit resource instead
1530
+ * Get a work plan rotation
1921
1531
  *
1922
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
1923
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
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
- getWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
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 getWorkforcemanagementManagementunitWeekShorttermforecasts';
1538
+ throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
1929
1539
  }
1930
- // verify the required parameter 'weekDateId' is set
1931
- if (weekDateId === undefined || weekDateId === null) {
1932
- throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
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}/weeks/{weekDateId}/shorttermforecasts',
1546
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
1937
1547
  'GET',
1938
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
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 a work plan
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 {String} workPlanId The ID of the work plan to fetch
1563
+ * @param {Object} opts Optional parameters
1564
+ * @param {Array.<String>} opts.expand
1954
1565
  */
1955
- getWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId) {
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 getWorkforcemanagementManagementunitWorkplan';
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}/workplans/{workPlanId}',
1575
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
1967
1576
  'GET',
1968
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
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 &#39;mine&#39; 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 &#39;mine&#39; 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 &#39;mine&#39; 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
- * Gone. Scheduling has moved under business units
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 &#39;mine&#39; for the management unit of the logged-in user.
2534
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
2535
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500
2019
+ * @param {String} managementUnitId The management unit ID of the management unit, or &#39;mine&#39; 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
- patchWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
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 patchWorkforcemanagementManagementunitWeekSchedule';
2027
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
2541
2028
  }
2542
- // verify the required parameter 'weekId' is set
2543
- if (weekId === undefined || weekId === null) {
2544
- throw 'Missing the required parameter "weekId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
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 'scheduleId' is set
2547
- if (scheduleId === undefined || scheduleId === null) {
2548
- throw 'Missing the required parameter "scheduleId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
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/{weekId}/schedules/{scheduleId}',
2043
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}',
2553
2044
  'PATCH',
2554
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
2045
+ { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'tradeId': tradeId },
2555
2046
  { },
2556
2047
  { },
2557
2048
  { },
2558
- null,
2049
+ body,
2559
2050
  ['PureCloud OAuth'],
2560
2051
  ['application/json'],
2561
2052
  ['application/json']
@@ -2563,39 +2054,34 @@ class WorkforceManagementApi {
2563
2054
  }
2564
2055
 
2565
2056
  /**
2566
- * Updates a shift trade. This route can only be called by the initiating agent
2057
+ * Update a work plan
2567
2058
  *
2568
- * @param {String} managementUnitId The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2569
- * @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
2570
- * @param {Object} body body
2571
- * @param {String} tradeId The ID of the shift trade to update
2059
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; 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
2063
+ * @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
2572
2064
  */
2573
- patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, body, tradeId) {
2065
+ patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
2066
+ opts = opts || {};
2067
+
2574
2068
  // verify the required parameter 'managementUnitId' is set
2575
2069
  if (managementUnitId === undefined || managementUnitId === null) {
2576
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
2577
- }
2578
- // verify the required parameter 'weekDateId' is set
2579
- if (weekDateId === undefined || weekDateId === null) {
2580
- throw 'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';
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';
2070
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplan';
2071
+ }
2072
+ // verify the required parameter 'workPlanId' is set
2073
+ if (workPlanId === undefined || workPlanId === null) {
2074
+ throw 'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';
2589
2075
  }
2590
2076
 
2591
2077
  return this.apiClient.callApi(
2592
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}',
2078
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
2593
2079
  'PATCH',
2594
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'tradeId': tradeId },
2595
- { },
2080
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
2081
+ { 'validationMode': opts['validationMode'] },
2596
2082
  { },
2597
2083
  { },
2598
- body,
2084
+ opts['body'],
2599
2085
  ['PureCloud OAuth'],
2600
2086
  ['application/json'],
2601
2087
  ['application/json']
@@ -2603,29 +2089,29 @@ class WorkforceManagementApi {
2603
2089
  }
2604
2090
 
2605
2091
  /**
2606
- * Update a work plan
2092
+ * Update a work plan rotation
2607
2093
  *
2608
2094
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2609
- * @param {String} workPlanId The ID of the work plan to update
2095
+ * @param {String} workPlanRotationId The ID of the work plan rotation to update
2610
2096
  * @param {Object} opts Optional parameters
2611
2097
  * @param {Object} opts.body body
2612
2098
  */
2613
- patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
2099
+ patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
2614
2100
  opts = opts || {};
2615
2101
 
2616
2102
  // verify the required parameter 'managementUnitId' is set
2617
2103
  if (managementUnitId === undefined || managementUnitId === null) {
2618
- throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplan';
2104
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
2619
2105
  }
2620
- // verify the required parameter 'workPlanId' is set
2621
- if (workPlanId === undefined || workPlanId === null) {
2622
- throw 'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';
2106
+ // verify the required parameter 'workPlanRotationId' is set
2107
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
2108
+ throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
2623
2109
  }
2624
2110
 
2625
2111
  return this.apiClient.callApi(
2626
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
2112
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
2627
2113
  'PATCH',
2628
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
2114
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
2629
2115
  { },
2630
2116
  { },
2631
2117
  { },
@@ -3141,269 +2627,18 @@ class WorkforceManagementApi {
3141
2627
 
3142
2628
  /**
3143
2629
  * 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 &#39;mine&#39; 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 &#39;mine&#39; 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 &#39;mine&#39; 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 &#39;mine&#39; 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 &#39;mine&#39; 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 &#39;mine&#39; 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 &#39;mine&#39; for the management unit of the logged-in user.
2630
+ * It may take a minute or two for a new business unit to be available for api operations
3392
2631
  * @param {Object} opts Optional parameters
3393
2632
  * @param {Object} opts.body body
3394
2633
  */
3395
- postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails(muId, opts) {
2634
+ postWorkforcemanagementBusinessunits(opts) {
3396
2635
  opts = opts || {};
3397
2636
 
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
2637
 
3403
2638
  return this.apiClient.callApi(
3404
- '/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails',
2639
+ '/api/v2/workforcemanagement/businessunits',
3405
2640
  'POST',
3406
- { 'muId': muId },
2641
+ { },
3407
2642
  { },
3408
2643
  { },
3409
2644
  { },
@@ -3415,25 +2650,27 @@ class WorkforceManagementApi {
3415
2650
  }
3416
2651
 
3417
2652
  /**
3418
- * Gets the lookup ids to fetch the specified set of requests
2653
+ * Query published schedules for given given time range for set of users
3419
2654
  *
3420
- * @param {String} muId The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2655
+ * @param {String} muId The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3421
2656
  * @param {Object} opts Optional parameters
3422
2657
  * @param {Object} opts.body body
2658
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
2659
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
3423
2660
  */
3424
- postWorkforcemanagementManagementunitTimeoffrequestsQuery(muId, opts) {
2661
+ postWorkforcemanagementManagementunitAgentschedulesSearch(muId, opts) {
3425
2662
  opts = opts || {};
3426
2663
 
3427
2664
  // verify the required parameter 'muId' is set
3428
2665
  if (muId === undefined || muId === null) {
3429
- throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
2666
+ throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
3430
2667
  }
3431
2668
 
3432
2669
  return this.apiClient.callApi(
3433
- '/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query',
2670
+ '/api/v2/workforcemanagement/managementunits/{muId}/agentschedules/search',
3434
2671
  'POST',
3435
2672
  { 'muId': muId },
3436
- { },
2673
+ { 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
3437
2674
  { },
3438
2675
  { },
3439
2676
  opts['body'],
@@ -3444,34 +2681,28 @@ class WorkforceManagementApi {
3444
2681
  }
3445
2682
 
3446
2683
  /**
3447
- * Gone. Scheduling has moved under business units
3448
- *
3449
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3450
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
3451
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to copy from
2684
+ * Request a historical adherence report
2685
+ * The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
2686
+ * @param {String} muId The management unit ID of the management unit
2687
+ * @param {Object} opts Optional parameters
2688
+ * @param {Object} opts.body body
3452
2689
  */
3453
- postWorkforcemanagementManagementunitWeekScheduleCopy(managementUnitId, weekId, scheduleId) {
3454
- // verify the required parameter 'managementUnitId' is set
3455
- if (managementUnitId === undefined || managementUnitId === null) {
3456
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
3457
- }
3458
- // verify the required parameter 'weekId' is set
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';
2690
+ postWorkforcemanagementManagementunitHistoricaladherencequery(muId, opts) {
2691
+ opts = opts || {};
2692
+
2693
+ // verify the required parameter 'muId' is set
2694
+ if (muId === undefined || muId === null) {
2695
+ throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
3465
2696
  }
3466
2697
 
3467
2698
  return this.apiClient.callApi(
3468
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy',
2699
+ '/api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery',
3469
2700
  'POST',
3470
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
2701
+ { 'muId': muId },
3471
2702
  { },
3472
2703
  { },
3473
2704
  { },
3474
- null,
2705
+ opts['body'],
3475
2706
  ['PureCloud OAuth'],
3476
2707
  ['application/json'],
3477
2708
  ['application/json']
@@ -3479,34 +2710,28 @@ class WorkforceManagementApi {
3479
2710
  }
3480
2711
 
3481
2712
  /**
3482
- * Gone. Scheduling has moved under business units
3483
- *
3484
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3485
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
3486
- * @param {String} scheduleId Gone/deprecated. The ID of the schedule to re-optimize
2713
+ * Move the requested management unit to a new business unit
2714
+ * Returns status 200 if the management unit is already in the requested business unit
2715
+ * @param {String} muId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2716
+ * @param {Object} opts Optional parameters
2717
+ * @param {Object} opts.body body
3487
2718
  */
3488
- postWorkforcemanagementManagementunitWeekScheduleReschedule(managementUnitId, weekId, scheduleId) {
3489
- // verify the required parameter 'managementUnitId' is set
3490
- if (managementUnitId === undefined || managementUnitId === null) {
3491
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
3492
- }
3493
- // verify the required parameter 'weekId' is set
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';
2719
+ postWorkforcemanagementManagementunitMove(muId, opts) {
2720
+ opts = opts || {};
2721
+
2722
+ // verify the required parameter 'muId' is set
2723
+ if (muId === undefined || muId === null) {
2724
+ throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitMove';
3500
2725
  }
3501
2726
 
3502
2727
  return this.apiClient.callApi(
3503
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule',
2728
+ '/api/v2/workforcemanagement/managementunits/{muId}/move',
3504
2729
  'POST',
3505
- { 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
2730
+ { 'muId': muId },
3506
2731
  { },
3507
2732
  { },
3508
2733
  { },
3509
- null,
2734
+ opts['body'],
3510
2735
  ['PureCloud OAuth'],
3511
2736
  ['application/json'],
3512
2737
  ['application/json']
@@ -3514,29 +2739,28 @@ class WorkforceManagementApi {
3514
2739
  }
3515
2740
 
3516
2741
  /**
3517
- * Gone. Scheduling has moved under business units
2742
+ * Query published schedules for given given time range for set of users
3518
2743
  *
3519
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3520
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
2744
+ * @param {String} muId The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2745
+ * @param {Object} opts Optional parameters
2746
+ * @param {Object} opts.body body
3521
2747
  */
3522
- postWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId) {
3523
- // verify the required parameter 'managementUnitId' is set
3524
- if (managementUnitId === undefined || managementUnitId === null) {
3525
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedules';
3526
- }
3527
- // verify the required parameter 'weekId' is set
3528
- if (weekId === undefined || weekId === null) {
3529
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
2748
+ postWorkforcemanagementManagementunitSchedulesSearch(muId, opts) {
2749
+ opts = opts || {};
2750
+
2751
+ // verify the required parameter 'muId' is set
2752
+ if (muId === undefined || muId === null) {
2753
+ throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitSchedulesSearch';
3530
2754
  }
3531
2755
 
3532
2756
  return this.apiClient.callApi(
3533
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules',
2757
+ '/api/v2/workforcemanagement/managementunits/{muId}/schedules/search',
3534
2758
  'POST',
3535
- { 'managementUnitId': managementUnitId,'weekId': weekId },
2759
+ { 'muId': muId },
3536
2760
  { },
3537
2761
  { },
3538
2762
  { },
3539
- null,
2763
+ opts['body'],
3540
2764
  ['PureCloud OAuth'],
3541
2765
  ['application/json'],
3542
2766
  ['application/json']
@@ -3544,29 +2768,28 @@ class WorkforceManagementApi {
3544
2768
  }
3545
2769
 
3546
2770
  /**
3547
- * Gone. Scheduling has moved under business units
2771
+ * Create a new time off request
3548
2772
  *
3549
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3550
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
2773
+ * @param {String} muId The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2774
+ * @param {Object} opts Optional parameters
2775
+ * @param {Object} opts.body body
3551
2776
  */
3552
- postWorkforcemanagementManagementunitWeekSchedulesGenerate(managementUnitId, weekId) {
3553
- // verify the required parameter 'managementUnitId' is set
3554
- if (managementUnitId === undefined || managementUnitId === null) {
3555
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
3556
- }
3557
- // verify the required parameter 'weekId' is set
3558
- if (weekId === undefined || weekId === null) {
3559
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
2777
+ postWorkforcemanagementManagementunitTimeoffrequests(muId, opts) {
2778
+ opts = opts || {};
2779
+
2780
+ // verify the required parameter 'muId' is set
2781
+ if (muId === undefined || muId === null) {
2782
+ throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequests';
3560
2783
  }
3561
2784
 
3562
2785
  return this.apiClient.callApi(
3563
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate',
2786
+ '/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests',
3564
2787
  'POST',
3565
- { 'managementUnitId': managementUnitId,'weekId': weekId },
2788
+ { 'muId': muId },
3566
2789
  { },
3567
2790
  { },
3568
2791
  { },
3569
- null,
2792
+ opts['body'],
3570
2793
  ['PureCloud OAuth'],
3571
2794
  ['application/json'],
3572
2795
  ['application/json']
@@ -3574,29 +2797,28 @@ class WorkforceManagementApi {
3574
2797
  }
3575
2798
 
3576
2799
  /**
3577
- * Gone. Scheduling has moved under business units
2800
+ * Gets the lookup ids to fetch the specified set of requests
3578
2801
  *
3579
- * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3580
- * @param {String} weekId First day of schedule week in yyyy-MM-dd format.
2802
+ * @param {String} muId The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2803
+ * @param {Object} opts Optional parameters
2804
+ * @param {Object} opts.body body
3581
2805
  */
3582
- postWorkforcemanagementManagementunitWeekSchedulesPartialupload(managementUnitId, weekId) {
3583
- // verify the required parameter 'managementUnitId' is set
3584
- if (managementUnitId === undefined || managementUnitId === null) {
3585
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
3586
- }
3587
- // verify the required parameter 'weekId' is set
3588
- if (weekId === undefined || weekId === null) {
3589
- throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
2806
+ postWorkforcemanagementManagementunitTimeoffrequestsQuery(muId, opts) {
2807
+ opts = opts || {};
2808
+
2809
+ // verify the required parameter 'muId' is set
2810
+ if (muId === undefined || muId === null) {
2811
+ throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
3590
2812
  }
3591
2813
 
3592
2814
  return this.apiClient.callApi(
3593
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload',
2815
+ '/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query',
3594
2816
  'POST',
3595
- { 'managementUnitId': managementUnitId,'weekId': weekId },
2817
+ { 'muId': muId },
3596
2818
  { },
3597
2819
  { },
3598
2820
  { },
3599
- null,
2821
+ opts['body'],
3600
2822
  ['PureCloud OAuth'],
3601
2823
  ['application/json'],
3602
2824
  ['application/json']
@@ -3753,94 +2975,33 @@ class WorkforceManagementApi {
3753
2975
  }
3754
2976
 
3755
2977
  /**
3756
- * Gone. Use equivalent business unit resource instead
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
2978
+ * Create a copy of work plan
3822
2979
  *
3823
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
3824
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
2980
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2981
+ * @param {String} workPlanId The ID of the work plan to create a copy
2982
+ * @param {Object} opts Optional parameters
2983
+ * @param {Object} opts.body body
3825
2984
  */
3826
- postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate(managementUnitId, weekDateId) {
2985
+ postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
2986
+ opts = opts || {};
2987
+
3827
2988
  // verify the required parameter 'managementUnitId' is set
3828
2989
  if (managementUnitId === undefined || managementUnitId === null) {
3829
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate';
2990
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
3830
2991
  }
3831
- // verify the required parameter 'weekDateId' is set
3832
- if (weekDateId === undefined || weekDateId === null) {
3833
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsGenerate';
2992
+ // verify the required parameter 'workPlanId' is set
2993
+ if (workPlanId === undefined || workPlanId === null) {
2994
+ throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
3834
2995
  }
3835
2996
 
3836
2997
  return this.apiClient.callApi(
3837
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/generate',
2998
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
3838
2999
  'POST',
3839
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
3000
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
3840
3001
  { },
3841
3002
  { },
3842
3003
  { },
3843
- null,
3004
+ opts['body'],
3844
3005
  ['PureCloud OAuth'],
3845
3006
  ['application/json'],
3846
3007
  ['application/json']
@@ -3848,29 +3009,34 @@ class WorkforceManagementApi {
3848
3009
  }
3849
3010
 
3850
3011
  /**
3851
- * Gone. Use equivalent business unit resource instead
3012
+ * Validate Work Plan
3852
3013
  *
3853
- * @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
3854
- * @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
3014
+ * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3015
+ * @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word &#39;new&#39; for the ID.
3016
+ * @param {Object} opts Optional parameters
3017
+ * @param {Object} opts.body body
3018
+ * @param {Array.<String>} opts.expand
3855
3019
  */
3856
- postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload(managementUnitId, weekDateId) {
3020
+ postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
3021
+ opts = opts || {};
3022
+
3857
3023
  // verify the required parameter 'managementUnitId' is set
3858
3024
  if (managementUnitId === undefined || managementUnitId === null) {
3859
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload';
3025
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
3860
3026
  }
3861
- // verify the required parameter 'weekDateId' is set
3862
- if (weekDateId === undefined || weekDateId === null) {
3863
- throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastsPartialupload';
3027
+ // verify the required parameter 'workPlanId' is set
3028
+ if (workPlanId === undefined || workPlanId === null) {
3029
+ throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
3864
3030
  }
3865
3031
 
3866
3032
  return this.apiClient.callApi(
3867
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/partialupload',
3033
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
3868
3034
  'POST',
3869
- { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
3870
- { },
3035
+ { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
3036
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
3871
3037
  { },
3872
3038
  { },
3873
- null,
3039
+ opts['body'],
3874
3040
  ['PureCloud OAuth'],
3875
3041
  ['application/json'],
3876
3042
  ['application/json']
@@ -3878,29 +3044,29 @@ class WorkforceManagementApi {
3878
3044
  }
3879
3045
 
3880
3046
  /**
3881
- * Create a copy of work plan
3047
+ * Create a copy of work plan rotation
3882
3048
  *
3883
3049
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3884
- * @param {String} workPlanId The ID of the work plan to create a copy
3050
+ * @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
3885
3051
  * @param {Object} opts Optional parameters
3886
3052
  * @param {Object} opts.body body
3887
3053
  */
3888
- postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
3054
+ postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
3889
3055
  opts = opts || {};
3890
3056
 
3891
3057
  // verify the required parameter 'managementUnitId' is set
3892
3058
  if (managementUnitId === undefined || managementUnitId === null) {
3893
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
3059
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
3894
3060
  }
3895
- // verify the required parameter 'workPlanId' is set
3896
- if (workPlanId === undefined || workPlanId === null) {
3897
- throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
3061
+ // verify the required parameter 'workPlanRotationId' is set
3062
+ if (workPlanRotationId === undefined || workPlanRotationId === null) {
3063
+ throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
3898
3064
  }
3899
3065
 
3900
3066
  return this.apiClient.callApi(
3901
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
3067
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
3902
3068
  'POST',
3903
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
3069
+ { 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
3904
3070
  { },
3905
3071
  { },
3906
3072
  { },
@@ -3912,31 +3078,25 @@ class WorkforceManagementApi {
3912
3078
  }
3913
3079
 
3914
3080
  /**
3915
- * Validate Work Plan
3081
+ * Create a new work plan rotation
3916
3082
  *
3917
3083
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; 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 &#39;new&#39; for the ID.
3919
3084
  * @param {Object} opts Optional parameters
3920
3085
  * @param {Object} opts.body body
3921
- * @param {Array.<String>} opts.expand
3922
3086
  */
3923
- postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
3087
+ postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
3924
3088
  opts = opts || {};
3925
3089
 
3926
3090
  // verify the required parameter 'managementUnitId' is set
3927
3091
  if (managementUnitId === undefined || managementUnitId === null) {
3928
- throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
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';
3092
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
3933
3093
  }
3934
3094
 
3935
3095
  return this.apiClient.callApi(
3936
- '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
3096
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
3937
3097
  'POST',
3938
- { 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
3939
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
3098
+ { 'managementUnitId': managementUnitId },
3099
+ { },
3940
3100
  { },
3941
3101
  { },
3942
3102
  opts['body'],
@@ -3952,6 +3112,7 @@ class WorkforceManagementApi {
3952
3112
  * @param {String} managementUnitId The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
3953
3113
  * @param {Object} opts Optional parameters
3954
3114
  * @param {Object} opts.body body
3115
+ * @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
3955
3116
  */
3956
3117
  postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
3957
3118
  opts = opts || {};
@@ -3965,7 +3126,7 @@ class WorkforceManagementApi {
3965
3126
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
3966
3127
  'POST',
3967
3128
  { 'managementUnitId': managementUnitId },
3968
- { },
3129
+ { 'validationMode': opts['validationMode'] },
3969
3130
  { },
3970
3131
  { },
3971
3132
  opts['body'],