purecloud-platform-client-v2 133.0.0 → 134.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 +532 -95
- package/dist/web-amd/purecloud-platform-client-v2.js +532 -95
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +532 -95
- package/dist/web-cjs/purecloud-platform-client-v2.js +544 -99
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +662 -11
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.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 +76 -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/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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -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/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 +14 -6
- 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 +160 -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 -26
- 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 +221 -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 134.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3003,6 +3003,86 @@ class WorkforceManagementApi {
|
|
|
3003
3003
|
);
|
|
3004
3004
|
}
|
|
3005
3005
|
|
|
3006
|
+
/**
|
|
3007
|
+
* Starts processing a schedule update
|
|
3008
|
+
* Call after uploading the schedule data to the url supplied by the /update/uploadurl route
|
|
3009
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3010
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
3011
|
+
* @param {String} scheduleId The ID of the schedule
|
|
3012
|
+
* @param {Object} body body
|
|
3013
|
+
*/
|
|
3014
|
+
postWorkforcemanagementBusinessunitWeekScheduleUpdate(businessUnitId, weekId, scheduleId, body) {
|
|
3015
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3016
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3017
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
3018
|
+
}
|
|
3019
|
+
// verify the required parameter 'weekId' is set
|
|
3020
|
+
if (weekId === undefined || weekId === null) {
|
|
3021
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
3022
|
+
}
|
|
3023
|
+
// verify the required parameter 'scheduleId' is set
|
|
3024
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
3025
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
3026
|
+
}
|
|
3027
|
+
// verify the required parameter 'body' is set
|
|
3028
|
+
if (body === undefined || body === null) {
|
|
3029
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
3030
|
+
}
|
|
3031
|
+
|
|
3032
|
+
return this.apiClient.callApi(
|
|
3033
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update',
|
|
3034
|
+
'POST',
|
|
3035
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
3036
|
+
{ },
|
|
3037
|
+
{ },
|
|
3038
|
+
{ },
|
|
3039
|
+
body,
|
|
3040
|
+
['PureCloud OAuth'],
|
|
3041
|
+
['application/json'],
|
|
3042
|
+
['application/json']
|
|
3043
|
+
);
|
|
3044
|
+
}
|
|
3045
|
+
|
|
3046
|
+
/**
|
|
3047
|
+
* Creates a signed upload URL for updating a schedule
|
|
3048
|
+
* Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process
|
|
3049
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3050
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
3051
|
+
* @param {String} scheduleId The ID of the schedule
|
|
3052
|
+
* @param {Object} body body
|
|
3053
|
+
*/
|
|
3054
|
+
postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(businessUnitId, weekId, scheduleId, body) {
|
|
3055
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3056
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3057
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
3058
|
+
}
|
|
3059
|
+
// verify the required parameter 'weekId' is set
|
|
3060
|
+
if (weekId === undefined || weekId === null) {
|
|
3061
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
3062
|
+
}
|
|
3063
|
+
// verify the required parameter 'scheduleId' is set
|
|
3064
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
3065
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
3066
|
+
}
|
|
3067
|
+
// verify the required parameter 'body' is set
|
|
3068
|
+
if (body === undefined || body === null) {
|
|
3069
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
3070
|
+
}
|
|
3071
|
+
|
|
3072
|
+
return this.apiClient.callApi(
|
|
3073
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl',
|
|
3074
|
+
'POST',
|
|
3075
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
3076
|
+
{ },
|
|
3077
|
+
{ },
|
|
3078
|
+
{ },
|
|
3079
|
+
body,
|
|
3080
|
+
['PureCloud OAuth'],
|
|
3081
|
+
['application/json'],
|
|
3082
|
+
['application/json']
|
|
3083
|
+
);
|
|
3084
|
+
}
|
|
3085
|
+
|
|
3006
3086
|
/**
|
|
3007
3087
|
* Create a blank schedule
|
|
3008
3088
|
*
|
|
@@ -3073,6 +3153,76 @@ class WorkforceManagementApi {
|
|
|
3073
3153
|
);
|
|
3074
3154
|
}
|
|
3075
3155
|
|
|
3156
|
+
/**
|
|
3157
|
+
* Starts processing a schedule import
|
|
3158
|
+
* Call after uploading the schedule data to the url supplied by the /import/uploadurl route
|
|
3159
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3160
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
3161
|
+
* @param {Object} body
|
|
3162
|
+
*/
|
|
3163
|
+
postWorkforcemanagementBusinessunitWeekSchedulesImport(businessUnitId, weekId, body) {
|
|
3164
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3165
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3166
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
|
|
3167
|
+
}
|
|
3168
|
+
// verify the required parameter 'weekId' is set
|
|
3169
|
+
if (weekId === undefined || weekId === null) {
|
|
3170
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
|
|
3171
|
+
}
|
|
3172
|
+
// verify the required parameter 'body' is set
|
|
3173
|
+
if (body === undefined || body === null) {
|
|
3174
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
|
|
3175
|
+
}
|
|
3176
|
+
|
|
3177
|
+
return this.apiClient.callApi(
|
|
3178
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import',
|
|
3179
|
+
'POST',
|
|
3180
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId },
|
|
3181
|
+
{ },
|
|
3182
|
+
{ },
|
|
3183
|
+
{ },
|
|
3184
|
+
body,
|
|
3185
|
+
['PureCloud OAuth'],
|
|
3186
|
+
['application/json'],
|
|
3187
|
+
['application/json']
|
|
3188
|
+
);
|
|
3189
|
+
}
|
|
3190
|
+
|
|
3191
|
+
/**
|
|
3192
|
+
* Creates a signed upload URL for importing a schedule
|
|
3193
|
+
* Once the upload is complete, call the /import route to start the schedule import process
|
|
3194
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3195
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
3196
|
+
* @param {Object} body body
|
|
3197
|
+
*/
|
|
3198
|
+
postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(businessUnitId, weekId, body) {
|
|
3199
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3200
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3201
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
|
|
3202
|
+
}
|
|
3203
|
+
// verify the required parameter 'weekId' is set
|
|
3204
|
+
if (weekId === undefined || weekId === null) {
|
|
3205
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
|
|
3206
|
+
}
|
|
3207
|
+
// verify the required parameter 'body' is set
|
|
3208
|
+
if (body === undefined || body === null) {
|
|
3209
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
|
|
3210
|
+
}
|
|
3211
|
+
|
|
3212
|
+
return this.apiClient.callApi(
|
|
3213
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl',
|
|
3214
|
+
'POST',
|
|
3215
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId },
|
|
3216
|
+
{ },
|
|
3217
|
+
{ },
|
|
3218
|
+
{ },
|
|
3219
|
+
body,
|
|
3220
|
+
['PureCloud OAuth'],
|
|
3221
|
+
['application/json'],
|
|
3222
|
+
['application/json']
|
|
3223
|
+
);
|
|
3224
|
+
}
|
|
3225
|
+
|
|
3076
3226
|
/**
|
|
3077
3227
|
* Copy a short term forecast
|
|
3078
3228
|
*
|
|
@@ -3156,6 +3306,76 @@ class WorkforceManagementApi {
|
|
|
3156
3306
|
);
|
|
3157
3307
|
}
|
|
3158
3308
|
|
|
3309
|
+
/**
|
|
3310
|
+
* Starts importing the uploaded short term forecast
|
|
3311
|
+
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
3312
|
+
* @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
|
|
3313
|
+
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
3314
|
+
* @param {Object} body
|
|
3315
|
+
*/
|
|
3316
|
+
postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body) {
|
|
3317
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3318
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3319
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
|
|
3320
|
+
}
|
|
3321
|
+
// verify the required parameter 'weekDateId' is set
|
|
3322
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
3323
|
+
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
|
|
3324
|
+
}
|
|
3325
|
+
// verify the required parameter 'body' is set
|
|
3326
|
+
if (body === undefined || body === null) {
|
|
3327
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
|
|
3328
|
+
}
|
|
3329
|
+
|
|
3330
|
+
return this.apiClient.callApi(
|
|
3331
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import',
|
|
3332
|
+
'POST',
|
|
3333
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId },
|
|
3334
|
+
{ },
|
|
3335
|
+
{ },
|
|
3336
|
+
{ },
|
|
3337
|
+
body,
|
|
3338
|
+
['PureCloud OAuth'],
|
|
3339
|
+
['application/json'],
|
|
3340
|
+
['application/json']
|
|
3341
|
+
);
|
|
3342
|
+
}
|
|
3343
|
+
|
|
3344
|
+
/**
|
|
3345
|
+
* Creates a signed upload URL for importing a short term forecast
|
|
3346
|
+
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
3347
|
+
* @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
|
|
3348
|
+
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
3349
|
+
* @param {Object} body body
|
|
3350
|
+
*/
|
|
3351
|
+
postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(businessUnitId, weekDateId, body) {
|
|
3352
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3353
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3354
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
|
|
3355
|
+
}
|
|
3356
|
+
// verify the required parameter 'weekDateId' is set
|
|
3357
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
3358
|
+
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
|
|
3359
|
+
}
|
|
3360
|
+
// verify the required parameter 'body' is set
|
|
3361
|
+
if (body === undefined || body === null) {
|
|
3362
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
|
|
3363
|
+
}
|
|
3364
|
+
|
|
3365
|
+
return this.apiClient.callApi(
|
|
3366
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl',
|
|
3367
|
+
'POST',
|
|
3368
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId },
|
|
3369
|
+
{ },
|
|
3370
|
+
{ },
|
|
3371
|
+
{ },
|
|
3372
|
+
body,
|
|
3373
|
+
['PureCloud OAuth'],
|
|
3374
|
+
['application/json'],
|
|
3375
|
+
['application/json']
|
|
3376
|
+
);
|
|
3377
|
+
}
|
|
3378
|
+
|
|
3159
3379
|
/**
|
|
3160
3380
|
* Add a new business unit
|
|
3161
3381
|
* It may take a minute or two for a new business unit to be available for api operations
|