purecloud-platform-client-v2 139.0.0 → 141.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 +420 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +420 -117
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +420 -116
- package/dist/web-cjs/purecloud-platform-client-v2.js +2514 -154
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +499 -207
- package/package.json +2 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +18 -16
- 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 +156 -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 +145 -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 +11 -5
- 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 LearningApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Learning service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 141.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
|
*
|
|
@@ -294,6 +324,40 @@ class LearningApi {
|
|
|
294
324
|
);
|
|
295
325
|
}
|
|
296
326
|
|
|
327
|
+
/**
|
|
328
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
329
|
+
*
|
|
330
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
331
|
+
* @param {Object} opts Optional parameters
|
|
332
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
333
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
334
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
335
|
+
* @param {Object} opts.overdue Specifies if only modules with overdue/not overdue (overdue is True or False) assignments are returned. If overdue is Any or omitted, both are returned and can including modules that are unassigned. (default to Any)
|
|
336
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
337
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
338
|
+
*/
|
|
339
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
340
|
+
opts = opts || {};
|
|
341
|
+
|
|
342
|
+
// verify the required parameter 'userIds' is set
|
|
343
|
+
if (userIds === undefined || userIds === null) {
|
|
344
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
return this.apiClient.callApi(
|
|
348
|
+
'/api/v2/learning/modules/assignments',
|
|
349
|
+
'GET',
|
|
350
|
+
{ },
|
|
351
|
+
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'searchTerm': opts['searchTerm'],'overdue': opts['overdue'],'assignmentStates': this.apiClient.buildCollectionParam(opts['assignmentStates'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
352
|
+
{ },
|
|
353
|
+
{ },
|
|
354
|
+
null,
|
|
355
|
+
['PureCloud OAuth'],
|
|
356
|
+
['application/json'],
|
|
357
|
+
['application/json']
|
|
358
|
+
);
|
|
359
|
+
}
|
|
360
|
+
|
|
297
361
|
/**
|
|
298
362
|
* Update Learning Assignment
|
|
299
363
|
*
|
|
@@ -348,6 +412,56 @@ class LearningApi {
|
|
|
348
412
|
);
|
|
349
413
|
}
|
|
350
414
|
|
|
415
|
+
/**
|
|
416
|
+
* Reassign Learning Assignment
|
|
417
|
+
* This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
|
|
418
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
419
|
+
*/
|
|
420
|
+
postLearningAssignmentReassign(assignmentId) {
|
|
421
|
+
// verify the required parameter 'assignmentId' is set
|
|
422
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
423
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
return this.apiClient.callApi(
|
|
427
|
+
'/api/v2/learning/assignments/{assignmentId}/reassign',
|
|
428
|
+
'POST',
|
|
429
|
+
{ 'assignmentId': assignmentId },
|
|
430
|
+
{ },
|
|
431
|
+
{ },
|
|
432
|
+
{ },
|
|
433
|
+
null,
|
|
434
|
+
['PureCloud OAuth'],
|
|
435
|
+
['application/json'],
|
|
436
|
+
['application/json']
|
|
437
|
+
);
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
/**
|
|
441
|
+
* Reset Learning Assignment
|
|
442
|
+
* This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
|
|
443
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
444
|
+
*/
|
|
445
|
+
postLearningAssignmentReset(assignmentId) {
|
|
446
|
+
// verify the required parameter 'assignmentId' is set
|
|
447
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
448
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
return this.apiClient.callApi(
|
|
452
|
+
'/api/v2/learning/assignments/{assignmentId}/reset',
|
|
453
|
+
'POST',
|
|
454
|
+
{ 'assignmentId': assignmentId },
|
|
455
|
+
{ },
|
|
456
|
+
{ },
|
|
457
|
+
{ },
|
|
458
|
+
null,
|
|
459
|
+
['PureCloud OAuth'],
|
|
460
|
+
['application/json'],
|
|
461
|
+
['application/json']
|
|
462
|
+
);
|
|
463
|
+
}
|
|
464
|
+
|
|
351
465
|
/**
|
|
352
466
|
* Create Learning Assignment
|
|
353
467
|
*
|
|
@@ -445,6 +559,36 @@ class LearningApi {
|
|
|
445
559
|
);
|
|
446
560
|
}
|
|
447
561
|
|
|
562
|
+
/**
|
|
563
|
+
* Starts a specified operation on learning module
|
|
564
|
+
* This will initiate operation specified in the request body for a learning module
|
|
565
|
+
* @param {String} moduleId The ID of the learning module
|
|
566
|
+
* @param {Object} body The learning module job request
|
|
567
|
+
*/
|
|
568
|
+
postLearningModuleJobs(moduleId, body) {
|
|
569
|
+
// verify the required parameter 'moduleId' is set
|
|
570
|
+
if (moduleId === undefined || moduleId === null) {
|
|
571
|
+
throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
|
|
572
|
+
}
|
|
573
|
+
// verify the required parameter 'body' is set
|
|
574
|
+
if (body === undefined || body === null) {
|
|
575
|
+
throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
return this.apiClient.callApi(
|
|
579
|
+
'/api/v2/learning/modules/{moduleId}/jobs',
|
|
580
|
+
'POST',
|
|
581
|
+
{ 'moduleId': moduleId },
|
|
582
|
+
{ },
|
|
583
|
+
{ },
|
|
584
|
+
{ },
|
|
585
|
+
body,
|
|
586
|
+
['PureCloud OAuth'],
|
|
587
|
+
['application/json'],
|
|
588
|
+
['application/json']
|
|
589
|
+
);
|
|
590
|
+
}
|
|
591
|
+
|
|
448
592
|
/**
|
|
449
593
|
* Publish a Learning module
|
|
450
594
|
*
|
|
@@ -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 141.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 141.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,
|
|
@@ -1111,6 +1115,8 @@ class RoutingApi {
|
|
|
1111
1115
|
* @param {String} opts.name Filter by queue name
|
|
1112
1116
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
1113
1117
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
1118
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
1119
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
1114
1120
|
*/
|
|
1115
1121
|
getRoutingQueues(opts) {
|
|
1116
1122
|
opts = opts || {};
|
|
@@ -1120,7 +1126,7 @@ class RoutingApi {
|
|
|
1120
1126
|
'/api/v2/routing/queues',
|
|
1121
1127
|
'GET',
|
|
1122
1128
|
{ },
|
|
1123
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
1129
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
|
|
1124
1130
|
{ },
|
|
1125
1131
|
{ },
|
|
1126
1132
|
null,
|
|
@@ -5,7 +5,7 @@ class UsersApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Users service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 141.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -825,18 +825,18 @@ class UsersApi {
|
|
|
825
825
|
/**
|
|
826
826
|
* Returns a listing of roles and permissions for a user.
|
|
827
827
|
*
|
|
828
|
-
* @param {String}
|
|
828
|
+
* @param {String} subjectId User ID
|
|
829
829
|
*/
|
|
830
|
-
getUserRoles(
|
|
831
|
-
// verify the required parameter '
|
|
832
|
-
if (
|
|
833
|
-
throw 'Missing the required parameter "
|
|
830
|
+
getUserRoles(subjectId) {
|
|
831
|
+
// verify the required parameter 'subjectId' is set
|
|
832
|
+
if (subjectId === undefined || subjectId === null) {
|
|
833
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
834
834
|
}
|
|
835
835
|
|
|
836
836
|
return this.apiClient.callApi(
|
|
837
|
-
'/api/v2/users/{
|
|
837
|
+
'/api/v2/users/{subjectId}/roles',
|
|
838
838
|
'GET',
|
|
839
|
-
{ '
|
|
839
|
+
{ 'subjectId': subjectId },
|
|
840
840
|
{ },
|
|
841
841
|
{ },
|
|
842
842
|
{ },
|
|
@@ -2089,13 +2089,13 @@ class UsersApi {
|
|
|
2089
2089
|
/**
|
|
2090
2090
|
* Sets the user's roles
|
|
2091
2091
|
*
|
|
2092
|
-
* @param {String}
|
|
2092
|
+
* @param {String} subjectId User ID
|
|
2093
2093
|
* @param {Array.<String>} body List of roles
|
|
2094
2094
|
*/
|
|
2095
|
-
putUserRoles(
|
|
2096
|
-
// verify the required parameter '
|
|
2097
|
-
if (
|
|
2098
|
-
throw 'Missing the required parameter "
|
|
2095
|
+
putUserRoles(subjectId, body) {
|
|
2096
|
+
// verify the required parameter 'subjectId' is set
|
|
2097
|
+
if (subjectId === undefined || subjectId === null) {
|
|
2098
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
2099
2099
|
}
|
|
2100
2100
|
// verify the required parameter 'body' is set
|
|
2101
2101
|
if (body === undefined || body === null) {
|
|
@@ -2103,9 +2103,9 @@ class UsersApi {
|
|
|
2103
2103
|
}
|
|
2104
2104
|
|
|
2105
2105
|
return this.apiClient.callApi(
|
|
2106
|
-
'/api/v2/users/{
|
|
2106
|
+
'/api/v2/users/{subjectId}/roles',
|
|
2107
2107
|
'PUT',
|
|
2108
|
-
{ '
|
|
2108
|
+
{ 'subjectId': subjectId },
|
|
2109
2109
|
{ },
|
|
2110
2110
|
{ },
|
|
2111
2111
|
{ },
|