purecloud-platform-client-v2 189.0.0 → 190.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 +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.js +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +300 -112
- package/dist/web-cjs/purecloud-platform-client-v2.js +385 -144
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +824 -453
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +86 -20
- 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 +13 -8
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +2 -2
- 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/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +22 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -7
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.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/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.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/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +516 -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 190.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -165,6 +165,96 @@ class WorkforceManagementApi {
|
|
|
165
165
|
);
|
|
166
166
|
}
|
|
167
167
|
|
|
168
|
+
/**
|
|
169
|
+
* Deletes a staffing group
|
|
170
|
+
*
|
|
171
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
172
|
+
* @param {String} staffingGroupId The ID of the staffing group to delete
|
|
173
|
+
*/
|
|
174
|
+
deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
175
|
+
// verify the required parameter 'businessUnitId' is set
|
|
176
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
177
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
178
|
+
}
|
|
179
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
180
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
181
|
+
throw 'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
return this.apiClient.callApi(
|
|
185
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
186
|
+
'DELETE',
|
|
187
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
188
|
+
{ },
|
|
189
|
+
{ },
|
|
190
|
+
{ },
|
|
191
|
+
null,
|
|
192
|
+
['PureCloud OAuth'],
|
|
193
|
+
['application/json'],
|
|
194
|
+
['application/json']
|
|
195
|
+
);
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* Deletes a time-off limit object
|
|
200
|
+
*
|
|
201
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
202
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to delete
|
|
203
|
+
*/
|
|
204
|
+
deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
205
|
+
// verify the required parameter 'businessUnitId' is set
|
|
206
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
207
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
208
|
+
}
|
|
209
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
210
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
211
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
return this.apiClient.callApi(
|
|
215
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
216
|
+
'DELETE',
|
|
217
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
218
|
+
{ },
|
|
219
|
+
{ },
|
|
220
|
+
{ },
|
|
221
|
+
null,
|
|
222
|
+
['PureCloud OAuth'],
|
|
223
|
+
['application/json'],
|
|
224
|
+
['application/json']
|
|
225
|
+
);
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Deletes a time-off plan
|
|
230
|
+
*
|
|
231
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
232
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to delete
|
|
233
|
+
*/
|
|
234
|
+
deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
235
|
+
// verify the required parameter 'businessUnitId' is set
|
|
236
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
237
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
238
|
+
}
|
|
239
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
240
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
241
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
return this.apiClient.callApi(
|
|
245
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
246
|
+
'DELETE',
|
|
247
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
248
|
+
{ },
|
|
249
|
+
{ },
|
|
250
|
+
{ },
|
|
251
|
+
null,
|
|
252
|
+
['PureCloud OAuth'],
|
|
253
|
+
['application/json'],
|
|
254
|
+
['application/json']
|
|
255
|
+
);
|
|
256
|
+
}
|
|
257
|
+
|
|
168
258
|
/**
|
|
169
259
|
* Delete a schedule
|
|
170
260
|
*
|
|
@@ -987,6 +1077,184 @@ class WorkforceManagementApi {
|
|
|
987
1077
|
);
|
|
988
1078
|
}
|
|
989
1079
|
|
|
1080
|
+
/**
|
|
1081
|
+
* Gets a staffing group
|
|
1082
|
+
*
|
|
1083
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1084
|
+
* @param {String} staffingGroupId The ID of the staffing group to fetch
|
|
1085
|
+
*/
|
|
1086
|
+
getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId) {
|
|
1087
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1088
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1089
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
1090
|
+
}
|
|
1091
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
1092
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
1093
|
+
throw 'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';
|
|
1094
|
+
}
|
|
1095
|
+
|
|
1096
|
+
return this.apiClient.callApi(
|
|
1097
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
1098
|
+
'GET',
|
|
1099
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
1100
|
+
{ },
|
|
1101
|
+
{ },
|
|
1102
|
+
{ },
|
|
1103
|
+
null,
|
|
1104
|
+
['PureCloud OAuth'],
|
|
1105
|
+
['application/json'],
|
|
1106
|
+
['application/json']
|
|
1107
|
+
);
|
|
1108
|
+
}
|
|
1109
|
+
|
|
1110
|
+
/**
|
|
1111
|
+
* Gets a list of staffing groups
|
|
1112
|
+
*
|
|
1113
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1114
|
+
* @param {Object} opts Optional parameters
|
|
1115
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
1116
|
+
*/
|
|
1117
|
+
getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
1118
|
+
opts = opts || {};
|
|
1119
|
+
|
|
1120
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1121
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1122
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';
|
|
1123
|
+
}
|
|
1124
|
+
|
|
1125
|
+
return this.apiClient.callApi(
|
|
1126
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
1127
|
+
'GET',
|
|
1128
|
+
{ 'businessUnitId': businessUnitId },
|
|
1129
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
1130
|
+
{ },
|
|
1131
|
+
{ },
|
|
1132
|
+
null,
|
|
1133
|
+
['PureCloud OAuth'],
|
|
1134
|
+
['application/json'],
|
|
1135
|
+
['application/json']
|
|
1136
|
+
);
|
|
1137
|
+
}
|
|
1138
|
+
|
|
1139
|
+
/**
|
|
1140
|
+
* Gets a time-off limit object
|
|
1141
|
+
* Returns properties of time-off limit object, but not daily values
|
|
1142
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1143
|
+
* @param {String} timeOffLimitId The ID of the time-off limit to fetch
|
|
1144
|
+
*/
|
|
1145
|
+
getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId, timeOffLimitId) {
|
|
1146
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1147
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1148
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
1149
|
+
}
|
|
1150
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
1151
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
1152
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';
|
|
1153
|
+
}
|
|
1154
|
+
|
|
1155
|
+
return this.apiClient.callApi(
|
|
1156
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}',
|
|
1157
|
+
'GET',
|
|
1158
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
1159
|
+
{ },
|
|
1160
|
+
{ },
|
|
1161
|
+
{ },
|
|
1162
|
+
null,
|
|
1163
|
+
['PureCloud OAuth'],
|
|
1164
|
+
['application/json'],
|
|
1165
|
+
['application/json']
|
|
1166
|
+
);
|
|
1167
|
+
}
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* Gets a list of time-off limit objects
|
|
1171
|
+
*
|
|
1172
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1173
|
+
* @param {Object} opts Optional parameters
|
|
1174
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
|
|
1175
|
+
*/
|
|
1176
|
+
getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
1177
|
+
opts = opts || {};
|
|
1178
|
+
|
|
1179
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1180
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1181
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1184
|
+
return this.apiClient.callApi(
|
|
1185
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
1186
|
+
'GET',
|
|
1187
|
+
{ 'businessUnitId': businessUnitId },
|
|
1188
|
+
{ 'managementUnitId': opts['managementUnitId'] },
|
|
1189
|
+
{ },
|
|
1190
|
+
{ },
|
|
1191
|
+
null,
|
|
1192
|
+
['PureCloud OAuth'],
|
|
1193
|
+
['application/json'],
|
|
1194
|
+
['application/json']
|
|
1195
|
+
);
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1198
|
+
/**
|
|
1199
|
+
* Gets a time-off plan
|
|
1200
|
+
*
|
|
1201
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1202
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to fetch
|
|
1203
|
+
*/
|
|
1204
|
+
getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId) {
|
|
1205
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1206
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1207
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
1208
|
+
}
|
|
1209
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
1210
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
1211
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';
|
|
1212
|
+
}
|
|
1213
|
+
|
|
1214
|
+
return this.apiClient.callApi(
|
|
1215
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
1216
|
+
'GET',
|
|
1217
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
1218
|
+
{ },
|
|
1219
|
+
{ },
|
|
1220
|
+
{ },
|
|
1221
|
+
null,
|
|
1222
|
+
['PureCloud OAuth'],
|
|
1223
|
+
['application/json'],
|
|
1224
|
+
['application/json']
|
|
1225
|
+
);
|
|
1226
|
+
}
|
|
1227
|
+
|
|
1228
|
+
/**
|
|
1229
|
+
* Gets a list of time-off plans
|
|
1230
|
+
*
|
|
1231
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1232
|
+
* @param {Object} opts Optional parameters
|
|
1233
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
1234
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
1235
|
+
*/
|
|
1236
|
+
getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
1237
|
+
opts = opts || {};
|
|
1238
|
+
|
|
1239
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1240
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1241
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1244
|
+
return this.apiClient.callApi(
|
|
1245
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
1246
|
+
'GET',
|
|
1247
|
+
{ 'businessUnitId': businessUnitId },
|
|
1248
|
+
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
|
|
1249
|
+
{ },
|
|
1250
|
+
{ },
|
|
1251
|
+
null,
|
|
1252
|
+
['PureCloud OAuth'],
|
|
1253
|
+
['application/json'],
|
|
1254
|
+
['application/json']
|
|
1255
|
+
);
|
|
1256
|
+
}
|
|
1257
|
+
|
|
990
1258
|
/**
|
|
991
1259
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
992
1260
|
*
|
|
@@ -2799,6 +3067,74 @@ class WorkforceManagementApi {
|
|
|
2799
3067
|
);
|
|
2800
3068
|
}
|
|
2801
3069
|
|
|
3070
|
+
/**
|
|
3071
|
+
* Updates a staffing group
|
|
3072
|
+
*
|
|
3073
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3074
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
3075
|
+
* @param {Object} opts Optional parameters
|
|
3076
|
+
* @param {Object} opts.body body
|
|
3077
|
+
*/
|
|
3078
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
|
|
3079
|
+
opts = opts || {};
|
|
3080
|
+
|
|
3081
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3082
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3083
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
3084
|
+
}
|
|
3085
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
3086
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
3087
|
+
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
3088
|
+
}
|
|
3089
|
+
|
|
3090
|
+
return this.apiClient.callApi(
|
|
3091
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
3092
|
+
'PATCH',
|
|
3093
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
3094
|
+
{ },
|
|
3095
|
+
{ },
|
|
3096
|
+
{ },
|
|
3097
|
+
opts['body'],
|
|
3098
|
+
['PureCloud OAuth'],
|
|
3099
|
+
['application/json'],
|
|
3100
|
+
['application/json']
|
|
3101
|
+
);
|
|
3102
|
+
}
|
|
3103
|
+
|
|
3104
|
+
/**
|
|
3105
|
+
* Updates a time-off plan
|
|
3106
|
+
*
|
|
3107
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3108
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
3109
|
+
* @param {Object} opts Optional parameters
|
|
3110
|
+
* @param {Object} opts.body body
|
|
3111
|
+
*/
|
|
3112
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
|
|
3113
|
+
opts = opts || {};
|
|
3114
|
+
|
|
3115
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3116
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3117
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
3118
|
+
}
|
|
3119
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
3120
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
3121
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
3122
|
+
}
|
|
3123
|
+
|
|
3124
|
+
return this.apiClient.callApi(
|
|
3125
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
3126
|
+
'PATCH',
|
|
3127
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
3128
|
+
{ },
|
|
3129
|
+
{ },
|
|
3130
|
+
{ },
|
|
3131
|
+
opts['body'],
|
|
3132
|
+
['PureCloud OAuth'],
|
|
3133
|
+
['application/json'],
|
|
3134
|
+
['application/json']
|
|
3135
|
+
);
|
|
3136
|
+
}
|
|
3137
|
+
|
|
2802
3138
|
/**
|
|
2803
3139
|
* Update the requested management unit
|
|
2804
3140
|
*
|
|
@@ -3590,6 +3926,151 @@ class WorkforceManagementApi {
|
|
|
3590
3926
|
);
|
|
3591
3927
|
}
|
|
3592
3928
|
|
|
3929
|
+
/**
|
|
3930
|
+
* Creates a new staffing group
|
|
3931
|
+
*
|
|
3932
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3933
|
+
* @param {Object} opts Optional parameters
|
|
3934
|
+
* @param {Object} opts.body body
|
|
3935
|
+
*/
|
|
3936
|
+
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, opts) {
|
|
3937
|
+
opts = opts || {};
|
|
3938
|
+
|
|
3939
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3940
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3941
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
3942
|
+
}
|
|
3943
|
+
|
|
3944
|
+
return this.apiClient.callApi(
|
|
3945
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
3946
|
+
'POST',
|
|
3947
|
+
{ 'businessUnitId': businessUnitId },
|
|
3948
|
+
{ },
|
|
3949
|
+
{ },
|
|
3950
|
+
{ },
|
|
3951
|
+
opts['body'],
|
|
3952
|
+
['PureCloud OAuth'],
|
|
3953
|
+
['application/json'],
|
|
3954
|
+
['application/json']
|
|
3955
|
+
);
|
|
3956
|
+
}
|
|
3957
|
+
|
|
3958
|
+
/**
|
|
3959
|
+
* Gets staffing group associations for a list of user IDs
|
|
3960
|
+
*
|
|
3961
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3962
|
+
* @param {Object} opts Optional parameters
|
|
3963
|
+
* @param {Object} opts.body body
|
|
3964
|
+
*/
|
|
3965
|
+
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, opts) {
|
|
3966
|
+
opts = opts || {};
|
|
3967
|
+
|
|
3968
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3969
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3970
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
3971
|
+
}
|
|
3972
|
+
|
|
3973
|
+
return this.apiClient.callApi(
|
|
3974
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
|
|
3975
|
+
'POST',
|
|
3976
|
+
{ 'businessUnitId': businessUnitId },
|
|
3977
|
+
{ },
|
|
3978
|
+
{ },
|
|
3979
|
+
{ },
|
|
3980
|
+
opts['body'],
|
|
3981
|
+
['PureCloud OAuth'],
|
|
3982
|
+
['application/json'],
|
|
3983
|
+
['application/json']
|
|
3984
|
+
);
|
|
3985
|
+
}
|
|
3986
|
+
|
|
3987
|
+
/**
|
|
3988
|
+
* Creates a new time-off limit object
|
|
3989
|
+
*
|
|
3990
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3991
|
+
* @param {Object} opts Optional parameters
|
|
3992
|
+
* @param {Object} opts.body body
|
|
3993
|
+
*/
|
|
3994
|
+
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, opts) {
|
|
3995
|
+
opts = opts || {};
|
|
3996
|
+
|
|
3997
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3998
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3999
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
4000
|
+
}
|
|
4001
|
+
|
|
4002
|
+
return this.apiClient.callApi(
|
|
4003
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
4004
|
+
'POST',
|
|
4005
|
+
{ 'businessUnitId': businessUnitId },
|
|
4006
|
+
{ },
|
|
4007
|
+
{ },
|
|
4008
|
+
{ },
|
|
4009
|
+
opts['body'],
|
|
4010
|
+
['PureCloud OAuth'],
|
|
4011
|
+
['application/json'],
|
|
4012
|
+
['application/json']
|
|
4013
|
+
);
|
|
4014
|
+
}
|
|
4015
|
+
|
|
4016
|
+
/**
|
|
4017
|
+
* Retrieves time-off limit related values based on a given set of filters.
|
|
4018
|
+
*
|
|
4019
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
4020
|
+
* @param {Object} opts Optional parameters
|
|
4021
|
+
* @param {Object} opts.body body
|
|
4022
|
+
*/
|
|
4023
|
+
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, opts) {
|
|
4024
|
+
opts = opts || {};
|
|
4025
|
+
|
|
4026
|
+
// verify the required parameter 'businessUnitId' is set
|
|
4027
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
4028
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
4029
|
+
}
|
|
4030
|
+
|
|
4031
|
+
return this.apiClient.callApi(
|
|
4032
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
|
|
4033
|
+
'POST',
|
|
4034
|
+
{ 'businessUnitId': businessUnitId },
|
|
4035
|
+
{ },
|
|
4036
|
+
{ },
|
|
4037
|
+
{ },
|
|
4038
|
+
opts['body'],
|
|
4039
|
+
['PureCloud OAuth'],
|
|
4040
|
+
['application/json'],
|
|
4041
|
+
['application/json']
|
|
4042
|
+
);
|
|
4043
|
+
}
|
|
4044
|
+
|
|
4045
|
+
/**
|
|
4046
|
+
* Creates a new time-off plan
|
|
4047
|
+
*
|
|
4048
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
4049
|
+
* @param {Object} opts Optional parameters
|
|
4050
|
+
* @param {Object} opts.body body
|
|
4051
|
+
*/
|
|
4052
|
+
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
4053
|
+
opts = opts || {};
|
|
4054
|
+
|
|
4055
|
+
// verify the required parameter 'businessUnitId' is set
|
|
4056
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
4057
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
4058
|
+
}
|
|
4059
|
+
|
|
4060
|
+
return this.apiClient.callApi(
|
|
4061
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
4062
|
+
'POST',
|
|
4063
|
+
{ 'businessUnitId': businessUnitId },
|
|
4064
|
+
{ },
|
|
4065
|
+
{ },
|
|
4066
|
+
{ },
|
|
4067
|
+
opts['body'],
|
|
4068
|
+
['PureCloud OAuth'],
|
|
4069
|
+
['application/json'],
|
|
4070
|
+
['application/json']
|
|
4071
|
+
);
|
|
4072
|
+
}
|
|
4073
|
+
|
|
3593
4074
|
/**
|
|
3594
4075
|
* Loads agent schedule data from the schedule. Used in combination with the metadata route
|
|
3595
4076
|
*
|
|
@@ -5336,6 +5817,40 @@ class WorkforceManagementApi {
|
|
|
5336
5817
|
);
|
|
5337
5818
|
}
|
|
5338
5819
|
|
|
5820
|
+
/**
|
|
5821
|
+
* Sets daily values for a date range of time-off limit object
|
|
5822
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
5823
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5824
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
5825
|
+
* @param {Object} opts Optional parameters
|
|
5826
|
+
* @param {Object} opts.body body
|
|
5827
|
+
*/
|
|
5828
|
+
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, opts) {
|
|
5829
|
+
opts = opts || {};
|
|
5830
|
+
|
|
5831
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5832
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
5833
|
+
throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
5834
|
+
}
|
|
5835
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
5836
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
5837
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
5838
|
+
}
|
|
5839
|
+
|
|
5840
|
+
return this.apiClient.callApi(
|
|
5841
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
5842
|
+
'PUT',
|
|
5843
|
+
{ 'businessUnitId': businessUnitId,'timeOffLimitId': timeOffLimitId },
|
|
5844
|
+
{ },
|
|
5845
|
+
{ },
|
|
5846
|
+
{ },
|
|
5847
|
+
opts['body'],
|
|
5848
|
+
['PureCloud OAuth'],
|
|
5849
|
+
['application/json'],
|
|
5850
|
+
['application/json']
|
|
5851
|
+
);
|
|
5852
|
+
}
|
|
5853
|
+
|
|
5339
5854
|
/**
|
|
5340
5855
|
* Sets daily values for a date range of time off limit object
|
|
5341
5856
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|