purecloud-platform-client-v2 139.0.0 → 140.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 +214 -100
- package/dist/web-amd/purecloud-platform-client-v2.js +214 -100
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +214 -100
- package/dist/web-cjs/purecloud-platform-client-v2.js +214 -100
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +180 -10
- 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 +15 -15
- 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 +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/GamificationApi.js +5 -5
- 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 +111 -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 +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 +2 -2
- 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 +8 -4
- 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 +15 -15
- 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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class AuthorizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Authorization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 140.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -610,18 +610,18 @@ class AuthorizationApi {
|
|
|
610
610
|
/**
|
|
611
611
|
* Returns a listing of roles and permissions for a user.
|
|
612
612
|
*
|
|
613
|
-
* @param {String}
|
|
613
|
+
* @param {String} subjectId User ID
|
|
614
614
|
*/
|
|
615
|
-
getUserRoles(
|
|
616
|
-
// verify the required parameter '
|
|
617
|
-
if (
|
|
618
|
-
throw 'Missing the required parameter "
|
|
615
|
+
getUserRoles(subjectId) {
|
|
616
|
+
// verify the required parameter 'subjectId' is set
|
|
617
|
+
if (subjectId === undefined || subjectId === null) {
|
|
618
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
619
619
|
}
|
|
620
620
|
|
|
621
621
|
return this.apiClient.callApi(
|
|
622
|
-
'/api/v2/users/{
|
|
622
|
+
'/api/v2/users/{subjectId}/roles',
|
|
623
623
|
'GET',
|
|
624
|
-
{ '
|
|
624
|
+
{ 'subjectId': subjectId },
|
|
625
625
|
{ },
|
|
626
626
|
{ },
|
|
627
627
|
{ },
|
|
@@ -1155,13 +1155,13 @@ class AuthorizationApi {
|
|
|
1155
1155
|
/**
|
|
1156
1156
|
* Sets the user's roles
|
|
1157
1157
|
*
|
|
1158
|
-
* @param {String}
|
|
1158
|
+
* @param {String} subjectId User ID
|
|
1159
1159
|
* @param {Array.<String>} body List of roles
|
|
1160
1160
|
*/
|
|
1161
|
-
putUserRoles(
|
|
1162
|
-
// verify the required parameter '
|
|
1163
|
-
if (
|
|
1164
|
-
throw 'Missing the required parameter "
|
|
1161
|
+
putUserRoles(subjectId, body) {
|
|
1162
|
+
// verify the required parameter 'subjectId' is set
|
|
1163
|
+
if (subjectId === undefined || subjectId === null) {
|
|
1164
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
1165
1165
|
}
|
|
1166
1166
|
// verify the required parameter 'body' is set
|
|
1167
1167
|
if (body === undefined || body === null) {
|
|
@@ -1169,9 +1169,9 @@ class AuthorizationApi {
|
|
|
1169
1169
|
}
|
|
1170
1170
|
|
|
1171
1171
|
return this.apiClient.callApi(
|
|
1172
|
-
'/api/v2/users/{
|
|
1172
|
+
'/api/v2/users/{subjectId}/roles',
|
|
1173
1173
|
'PUT',
|
|
1174
|
-
{ '
|
|
1174
|
+
{ 'subjectId': subjectId },
|
|
1175
1175
|
{ },
|
|
1176
1176
|
{ },
|
|
1177
1177
|
{ },
|
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 140.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -150,7 +150,7 @@ class GamificationApi {
|
|
|
150
150
|
|
|
151
151
|
/**
|
|
152
152
|
* Gamified metric by id
|
|
153
|
-
*
|
|
153
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
154
154
|
* @param {String} metricId metric Id
|
|
155
155
|
* @param {Object} opts Optional parameters
|
|
156
156
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
@@ -225,7 +225,7 @@ class GamificationApi {
|
|
|
225
225
|
|
|
226
226
|
/**
|
|
227
227
|
* All gamified metrics for a given profile
|
|
228
|
-
*
|
|
228
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
229
229
|
* @param {Object} opts Optional parameters
|
|
230
230
|
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
231
231
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
@@ -1080,7 +1080,7 @@ class GamificationApi {
|
|
|
1080
1080
|
|
|
1081
1081
|
/**
|
|
1082
1082
|
* Creates a gamified metric with a given metric definition and metric objective
|
|
1083
|
-
*
|
|
1083
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
1084
1084
|
* @param {Object} body Metric
|
|
1085
1085
|
*/
|
|
1086
1086
|
postGamificationMetrics(body) {
|
|
@@ -1309,7 +1309,7 @@ class GamificationApi {
|
|
|
1309
1309
|
|
|
1310
1310
|
/**
|
|
1311
1311
|
* Updates a metric
|
|
1312
|
-
*
|
|
1312
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
1313
1313
|
* @param {String} metricId metric Id
|
|
1314
1314
|
* @param {Object} body Metric
|
|
1315
1315
|
* @param {Object} opts Optional parameters
|
|
@@ -5,7 +5,7 @@ class LearningApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Learning service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 140.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -203,6 +203,36 @@ class LearningApi {
|
|
|
203
203
|
);
|
|
204
204
|
}
|
|
205
205
|
|
|
206
|
+
/**
|
|
207
|
+
* Get a specific Learning Module job status
|
|
208
|
+
*
|
|
209
|
+
* @param {String} moduleId The ID of the learning module
|
|
210
|
+
* @param {String} jobId The ID of the learning module job
|
|
211
|
+
*/
|
|
212
|
+
getLearningModuleJob(moduleId, jobId) {
|
|
213
|
+
// verify the required parameter 'moduleId' is set
|
|
214
|
+
if (moduleId === undefined || moduleId === null) {
|
|
215
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
|
|
216
|
+
}
|
|
217
|
+
// verify the required parameter 'jobId' is set
|
|
218
|
+
if (jobId === undefined || jobId === null) {
|
|
219
|
+
throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
return this.apiClient.callApi(
|
|
223
|
+
'/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
|
|
224
|
+
'GET',
|
|
225
|
+
{ 'moduleId': moduleId,'jobId': jobId },
|
|
226
|
+
{ },
|
|
227
|
+
{ },
|
|
228
|
+
{ },
|
|
229
|
+
null,
|
|
230
|
+
['PureCloud OAuth'],
|
|
231
|
+
['application/json'],
|
|
232
|
+
['application/json']
|
|
233
|
+
);
|
|
234
|
+
}
|
|
235
|
+
|
|
206
236
|
/**
|
|
207
237
|
* Get a learning module rule
|
|
208
238
|
*
|
|
@@ -348,6 +378,56 @@ class LearningApi {
|
|
|
348
378
|
);
|
|
349
379
|
}
|
|
350
380
|
|
|
381
|
+
/**
|
|
382
|
+
* Reassign Learning Assignment
|
|
383
|
+
* This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
|
|
384
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
385
|
+
*/
|
|
386
|
+
postLearningAssignmentReassign(assignmentId) {
|
|
387
|
+
// verify the required parameter 'assignmentId' is set
|
|
388
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
389
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
return this.apiClient.callApi(
|
|
393
|
+
'/api/v2/learning/assignments/{assignmentId}/reassign',
|
|
394
|
+
'POST',
|
|
395
|
+
{ 'assignmentId': assignmentId },
|
|
396
|
+
{ },
|
|
397
|
+
{ },
|
|
398
|
+
{ },
|
|
399
|
+
null,
|
|
400
|
+
['PureCloud OAuth'],
|
|
401
|
+
['application/json'],
|
|
402
|
+
['application/json']
|
|
403
|
+
);
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
/**
|
|
407
|
+
* Reset Learning Assignment
|
|
408
|
+
* This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
|
|
409
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
410
|
+
*/
|
|
411
|
+
postLearningAssignmentReset(assignmentId) {
|
|
412
|
+
// verify the required parameter 'assignmentId' is set
|
|
413
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
414
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
return this.apiClient.callApi(
|
|
418
|
+
'/api/v2/learning/assignments/{assignmentId}/reset',
|
|
419
|
+
'POST',
|
|
420
|
+
{ 'assignmentId': assignmentId },
|
|
421
|
+
{ },
|
|
422
|
+
{ },
|
|
423
|
+
{ },
|
|
424
|
+
null,
|
|
425
|
+
['PureCloud OAuth'],
|
|
426
|
+
['application/json'],
|
|
427
|
+
['application/json']
|
|
428
|
+
);
|
|
429
|
+
}
|
|
430
|
+
|
|
351
431
|
/**
|
|
352
432
|
* Create Learning Assignment
|
|
353
433
|
*
|
|
@@ -445,6 +525,36 @@ class LearningApi {
|
|
|
445
525
|
);
|
|
446
526
|
}
|
|
447
527
|
|
|
528
|
+
/**
|
|
529
|
+
* Starts a specified operation on learning module
|
|
530
|
+
* This will initiate operation specified in the request body for a learning module
|
|
531
|
+
* @param {String} moduleId The ID of the learning module
|
|
532
|
+
* @param {Object} body The learning module job request
|
|
533
|
+
*/
|
|
534
|
+
postLearningModuleJobs(moduleId, body) {
|
|
535
|
+
// verify the required parameter 'moduleId' is set
|
|
536
|
+
if (moduleId === undefined || moduleId === null) {
|
|
537
|
+
throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
|
|
538
|
+
}
|
|
539
|
+
// verify the required parameter 'body' is set
|
|
540
|
+
if (body === undefined || body === null) {
|
|
541
|
+
throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
return this.apiClient.callApi(
|
|
545
|
+
'/api/v2/learning/modules/{moduleId}/jobs',
|
|
546
|
+
'POST',
|
|
547
|
+
{ 'moduleId': moduleId },
|
|
548
|
+
{ },
|
|
549
|
+
{ },
|
|
550
|
+
{ },
|
|
551
|
+
body,
|
|
552
|
+
['PureCloud OAuth'],
|
|
553
|
+
['application/json'],
|
|
554
|
+
['application/json']
|
|
555
|
+
);
|
|
556
|
+
}
|
|
557
|
+
|
|
448
558
|
/**
|
|
449
559
|
* Publish a Learning module
|
|
450
560
|
*
|
|
@@ -5,7 +5,7 @@ class QualityApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Quality service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 140.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -763,7 +763,7 @@ class QualityApi {
|
|
|
763
763
|
/**
|
|
764
764
|
* Retrieve a list of the latest form versions by context ids
|
|
765
765
|
*
|
|
766
|
-
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
|
|
766
|
+
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.
|
|
767
767
|
* @param {Object} opts Optional parameters
|
|
768
768
|
* @param {Boolean} opts.published If true, the latest published version will be included. If false, only the unpublished version will be included. (default to true)
|
|
769
769
|
*/
|
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 140.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -834,16 +834,20 @@ class RoutingApi {
|
|
|
834
834
|
}
|
|
835
835
|
|
|
836
836
|
/**
|
|
837
|
-
* Get a list of Key Performance Indicators
|
|
837
|
+
* Get a list of Key Performance Indicators
|
|
838
838
|
*
|
|
839
|
+
* @param {Object} opts Optional parameters
|
|
840
|
+
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
839
841
|
*/
|
|
840
|
-
getRoutingPredictorsKeyperformanceindicators() {
|
|
842
|
+
getRoutingPredictorsKeyperformanceindicators(opts) {
|
|
843
|
+
opts = opts || {};
|
|
844
|
+
|
|
841
845
|
|
|
842
846
|
return this.apiClient.callApi(
|
|
843
847
|
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
844
848
|
'GET',
|
|
845
849
|
{ },
|
|
846
|
-
{
|
|
850
|
+
{ 'kpiGroup': opts['kpiGroup'] },
|
|
847
851
|
{ },
|
|
848
852
|
{ },
|
|
849
853
|
null,
|