purecloud-platform-client-v2 96.0.0 → 97.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +381 -62
- package/dist/web-amd/purecloud-platform-client-v2.js +381 -62
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +381 -62
- package/dist/web-cjs/purecloud-platform-client-v2.js +382 -62
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +378 -209
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +131 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +187 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WorkforceManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 97.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -290,6 +290,36 @@ class WorkforceManagementApi {
|
|
|
290
290
|
);
|
|
291
291
|
}
|
|
292
292
|
|
|
293
|
+
/**
|
|
294
|
+
* Delete a work plan rotation
|
|
295
|
+
*
|
|
296
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
297
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
298
|
+
*/
|
|
299
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
300
|
+
// verify the required parameter 'managementUnitId' is set
|
|
301
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
302
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
303
|
+
}
|
|
304
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
305
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
306
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
return this.apiClient.callApi(
|
|
310
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
311
|
+
'DELETE',
|
|
312
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
313
|
+
{ },
|
|
314
|
+
{ },
|
|
315
|
+
{ },
|
|
316
|
+
null,
|
|
317
|
+
['PureCloud OAuth'],
|
|
318
|
+
['application/json'],
|
|
319
|
+
['application/json']
|
|
320
|
+
);
|
|
321
|
+
}
|
|
322
|
+
|
|
293
323
|
/**
|
|
294
324
|
* Get a list of UserScheduleAdherence records for the requested users
|
|
295
325
|
*
|
|
@@ -1496,6 +1526,65 @@ class WorkforceManagementApi {
|
|
|
1496
1526
|
);
|
|
1497
1527
|
}
|
|
1498
1528
|
|
|
1529
|
+
/**
|
|
1530
|
+
* Get a work plan rotation
|
|
1531
|
+
*
|
|
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
|
|
1534
|
+
*/
|
|
1535
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
1536
|
+
// verify the required parameter 'managementUnitId' is set
|
|
1537
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1538
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
1539
|
+
}
|
|
1540
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
1541
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
1542
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
1543
|
+
}
|
|
1544
|
+
|
|
1545
|
+
return this.apiClient.callApi(
|
|
1546
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
1547
|
+
'GET',
|
|
1548
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
1549
|
+
{ },
|
|
1550
|
+
{ },
|
|
1551
|
+
{ },
|
|
1552
|
+
null,
|
|
1553
|
+
['PureCloud OAuth'],
|
|
1554
|
+
['application/json'],
|
|
1555
|
+
['application/json']
|
|
1556
|
+
);
|
|
1557
|
+
}
|
|
1558
|
+
|
|
1559
|
+
/**
|
|
1560
|
+
* Get work plan rotations
|
|
1561
|
+
*
|
|
1562
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
1563
|
+
* @param {Object} opts Optional parameters
|
|
1564
|
+
* @param {Array.<String>} opts.expand
|
|
1565
|
+
*/
|
|
1566
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
1567
|
+
opts = opts || {};
|
|
1568
|
+
|
|
1569
|
+
// verify the required parameter 'managementUnitId' is set
|
|
1570
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
1571
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
return this.apiClient.callApi(
|
|
1575
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
1576
|
+
'GET',
|
|
1577
|
+
{ 'managementUnitId': managementUnitId },
|
|
1578
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1579
|
+
{ },
|
|
1580
|
+
{ },
|
|
1581
|
+
null,
|
|
1582
|
+
['PureCloud OAuth'],
|
|
1583
|
+
['application/json'],
|
|
1584
|
+
['application/json']
|
|
1585
|
+
);
|
|
1586
|
+
}
|
|
1587
|
+
|
|
1499
1588
|
/**
|
|
1500
1589
|
* Get work plans
|
|
1501
1590
|
*
|
|
@@ -1998,6 +2087,40 @@ class WorkforceManagementApi {
|
|
|
1998
2087
|
);
|
|
1999
2088
|
}
|
|
2000
2089
|
|
|
2090
|
+
/**
|
|
2091
|
+
* Update a work plan rotation
|
|
2092
|
+
*
|
|
2093
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
2094
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
2095
|
+
* @param {Object} opts Optional parameters
|
|
2096
|
+
* @param {Object} opts.body body
|
|
2097
|
+
*/
|
|
2098
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
2099
|
+
opts = opts || {};
|
|
2100
|
+
|
|
2101
|
+
// verify the required parameter 'managementUnitId' is set
|
|
2102
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
2103
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
2104
|
+
}
|
|
2105
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
2106
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
2107
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
2108
|
+
}
|
|
2109
|
+
|
|
2110
|
+
return this.apiClient.callApi(
|
|
2111
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
2112
|
+
'PATCH',
|
|
2113
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
2114
|
+
{ },
|
|
2115
|
+
{ },
|
|
2116
|
+
{ },
|
|
2117
|
+
opts['body'],
|
|
2118
|
+
['PureCloud OAuth'],
|
|
2119
|
+
['application/json'],
|
|
2120
|
+
['application/json']
|
|
2121
|
+
);
|
|
2122
|
+
}
|
|
2123
|
+
|
|
2001
2124
|
/**
|
|
2002
2125
|
* Update a time off request for the current user
|
|
2003
2126
|
*
|
|
@@ -2919,6 +3042,69 @@ class WorkforceManagementApi {
|
|
|
2919
3042
|
);
|
|
2920
3043
|
}
|
|
2921
3044
|
|
|
3045
|
+
/**
|
|
3046
|
+
* Create a copy of work plan rotation
|
|
3047
|
+
*
|
|
3048
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3049
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
3050
|
+
* @param {Object} opts Optional parameters
|
|
3051
|
+
* @param {Object} opts.body body
|
|
3052
|
+
*/
|
|
3053
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
3054
|
+
opts = opts || {};
|
|
3055
|
+
|
|
3056
|
+
// verify the required parameter 'managementUnitId' is set
|
|
3057
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3058
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
3059
|
+
}
|
|
3060
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
3061
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
3062
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
3063
|
+
}
|
|
3064
|
+
|
|
3065
|
+
return this.apiClient.callApi(
|
|
3066
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
3067
|
+
'POST',
|
|
3068
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
3069
|
+
{ },
|
|
3070
|
+
{ },
|
|
3071
|
+
{ },
|
|
3072
|
+
opts['body'],
|
|
3073
|
+
['PureCloud OAuth'],
|
|
3074
|
+
['application/json'],
|
|
3075
|
+
['application/json']
|
|
3076
|
+
);
|
|
3077
|
+
}
|
|
3078
|
+
|
|
3079
|
+
/**
|
|
3080
|
+
* Create a new work plan rotation
|
|
3081
|
+
*
|
|
3082
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
3083
|
+
* @param {Object} opts Optional parameters
|
|
3084
|
+
* @param {Object} opts.body body
|
|
3085
|
+
*/
|
|
3086
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
3087
|
+
opts = opts || {};
|
|
3088
|
+
|
|
3089
|
+
// verify the required parameter 'managementUnitId' is set
|
|
3090
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3091
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
3092
|
+
}
|
|
3093
|
+
|
|
3094
|
+
return this.apiClient.callApi(
|
|
3095
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
3096
|
+
'POST',
|
|
3097
|
+
{ 'managementUnitId': managementUnitId },
|
|
3098
|
+
{ },
|
|
3099
|
+
{ },
|
|
3100
|
+
{ },
|
|
3101
|
+
opts['body'],
|
|
3102
|
+
['PureCloud OAuth'],
|
|
3103
|
+
['application/json'],
|
|
3104
|
+
['application/json']
|
|
3105
|
+
);
|
|
3106
|
+
}
|
|
3107
|
+
|
|
2922
3108
|
/**
|
|
2923
3109
|
* Create a new work plan
|
|
2924
3110
|
*
|