purecloud-platform-client-v2 144.0.0 → 147.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 +2337 -305
- package/dist/web-amd/purecloud-platform-client-v2.js +2337 -305
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +2337 -305
- package/dist/web-cjs/purecloud-platform-client-v2.js +2337 -305
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1133 -49
- 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 +46 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- 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 +211 -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 +1779 -246
- 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 +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 +135 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +21 -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/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 +32 -2
- 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 +30 -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 OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 147.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -305,6 +305,31 @@ class OutboundApi {
|
|
|
305
305
|
);
|
|
306
306
|
}
|
|
307
307
|
|
|
308
|
+
/**
|
|
309
|
+
* Delete an Outbound Digital Rule Set
|
|
310
|
+
*
|
|
311
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
312
|
+
*/
|
|
313
|
+
deleteOutboundDigitalruleset(digitalRuleSetId) {
|
|
314
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
315
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
316
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
return this.apiClient.callApi(
|
|
320
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
321
|
+
'DELETE',
|
|
322
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
323
|
+
{ },
|
|
324
|
+
{ },
|
|
325
|
+
{ },
|
|
326
|
+
null,
|
|
327
|
+
['PureCloud OAuth'],
|
|
328
|
+
['application/json'],
|
|
329
|
+
['application/json']
|
|
330
|
+
);
|
|
331
|
+
}
|
|
332
|
+
|
|
308
333
|
/**
|
|
309
334
|
* Delete dialer DNC list
|
|
310
335
|
*
|
|
@@ -1342,6 +1367,60 @@ class OutboundApi {
|
|
|
1342
1367
|
);
|
|
1343
1368
|
}
|
|
1344
1369
|
|
|
1370
|
+
/**
|
|
1371
|
+
* Get an Outbound Digital Rule Set
|
|
1372
|
+
*
|
|
1373
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
1374
|
+
*/
|
|
1375
|
+
getOutboundDigitalruleset(digitalRuleSetId) {
|
|
1376
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
1377
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
1378
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
|
|
1379
|
+
}
|
|
1380
|
+
|
|
1381
|
+
return this.apiClient.callApi(
|
|
1382
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
1383
|
+
'GET',
|
|
1384
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
1385
|
+
{ },
|
|
1386
|
+
{ },
|
|
1387
|
+
{ },
|
|
1388
|
+
null,
|
|
1389
|
+
['PureCloud OAuth'],
|
|
1390
|
+
['application/json'],
|
|
1391
|
+
['application/json']
|
|
1392
|
+
);
|
|
1393
|
+
}
|
|
1394
|
+
|
|
1395
|
+
/**
|
|
1396
|
+
* Query a list of Outbound Digital Rule Sets
|
|
1397
|
+
*
|
|
1398
|
+
* @param {Object} opts Optional parameters
|
|
1399
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
1400
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1401
|
+
* @param {Object} opts.sortBy The field to sort by (default to name)
|
|
1402
|
+
* @param {Object} opts.sortOrder The direction to sort (default to ascending)
|
|
1403
|
+
* @param {String} opts.name Name
|
|
1404
|
+
* @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
|
|
1405
|
+
*/
|
|
1406
|
+
getOutboundDigitalrulesets(opts) {
|
|
1407
|
+
opts = opts || {};
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
return this.apiClient.callApi(
|
|
1411
|
+
'/api/v2/outbound/digitalrulesets',
|
|
1412
|
+
'GET',
|
|
1413
|
+
{ },
|
|
1414
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
1415
|
+
{ },
|
|
1416
|
+
{ },
|
|
1417
|
+
null,
|
|
1418
|
+
['PureCloud OAuth'],
|
|
1419
|
+
['application/json'],
|
|
1420
|
+
['application/json']
|
|
1421
|
+
);
|
|
1422
|
+
}
|
|
1423
|
+
|
|
1345
1424
|
/**
|
|
1346
1425
|
* Get dialer DNC list
|
|
1347
1426
|
*
|
|
@@ -2525,6 +2604,31 @@ class OutboundApi {
|
|
|
2525
2604
|
);
|
|
2526
2605
|
}
|
|
2527
2606
|
|
|
2607
|
+
/**
|
|
2608
|
+
* Create an Outbound Digital Rule Set
|
|
2609
|
+
*
|
|
2610
|
+
* @param {Object} body Digital Rule Set
|
|
2611
|
+
*/
|
|
2612
|
+
postOutboundDigitalrulesets(body) {
|
|
2613
|
+
// verify the required parameter 'body' is set
|
|
2614
|
+
if (body === undefined || body === null) {
|
|
2615
|
+
throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
|
|
2616
|
+
}
|
|
2617
|
+
|
|
2618
|
+
return this.apiClient.callApi(
|
|
2619
|
+
'/api/v2/outbound/digitalrulesets',
|
|
2620
|
+
'POST',
|
|
2621
|
+
{ },
|
|
2622
|
+
{ },
|
|
2623
|
+
{ },
|
|
2624
|
+
{ },
|
|
2625
|
+
body,
|
|
2626
|
+
['PureCloud OAuth'],
|
|
2627
|
+
['application/json'],
|
|
2628
|
+
['application/json']
|
|
2629
|
+
);
|
|
2630
|
+
}
|
|
2631
|
+
|
|
2528
2632
|
/**
|
|
2529
2633
|
* Initiate the export of a dnc list.
|
|
2530
2634
|
* Returns 200 if received OK.
|
|
@@ -2989,6 +3093,36 @@ class OutboundApi {
|
|
|
2989
3093
|
);
|
|
2990
3094
|
}
|
|
2991
3095
|
|
|
3096
|
+
/**
|
|
3097
|
+
* Update an Outbound Digital Rule Set
|
|
3098
|
+
*
|
|
3099
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
3100
|
+
* @param {Object} body Digital Rule Set
|
|
3101
|
+
*/
|
|
3102
|
+
putOutboundDigitalruleset(digitalRuleSetId, body) {
|
|
3103
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
3104
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
3105
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
|
|
3106
|
+
}
|
|
3107
|
+
// verify the required parameter 'body' is set
|
|
3108
|
+
if (body === undefined || body === null) {
|
|
3109
|
+
throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
|
|
3110
|
+
}
|
|
3111
|
+
|
|
3112
|
+
return this.apiClient.callApi(
|
|
3113
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
3114
|
+
'PUT',
|
|
3115
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
3116
|
+
{ },
|
|
3117
|
+
{ },
|
|
3118
|
+
{ },
|
|
3119
|
+
body,
|
|
3120
|
+
['PureCloud OAuth'],
|
|
3121
|
+
['application/json'],
|
|
3122
|
+
['application/json']
|
|
3123
|
+
);
|
|
3124
|
+
}
|
|
3125
|
+
|
|
2992
3126
|
/**
|
|
2993
3127
|
* Update dialer DNC list
|
|
2994
3128
|
*
|
|
@@ -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 147.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -515,7 +515,7 @@ class QualityApi {
|
|
|
515
515
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
516
516
|
* @param {String} opts.nextPage next page token
|
|
517
517
|
* @param {String} opts.previousPage Previous page token
|
|
518
|
-
* @param {
|
|
518
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
519
519
|
* @param {String} opts.name Name
|
|
520
520
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
521
521
|
*/
|
|
@@ -602,7 +602,7 @@ class QualityApi {
|
|
|
602
602
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
603
603
|
* @param {String} opts.nextPage next page token
|
|
604
604
|
* @param {String} opts.previousPage Previous page token
|
|
605
|
-
* @param {
|
|
605
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
606
606
|
* @param {String} opts.name Name
|
|
607
607
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
608
608
|
*/
|
|
@@ -713,7 +713,7 @@ class QualityApi {
|
|
|
713
713
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
714
714
|
* @param {String} opts.nextPage next page token
|
|
715
715
|
* @param {String} opts.previousPage Previous page token
|
|
716
|
-
* @param {
|
|
716
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
717
717
|
* @param {String} opts.name Name
|
|
718
718
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
719
719
|
*/
|
|
@@ -5,7 +5,7 @@ class RecordingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Recording service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 147.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -879,6 +879,36 @@ class RecordingApi {
|
|
|
879
879
|
);
|
|
880
880
|
}
|
|
881
881
|
|
|
882
|
+
/**
|
|
883
|
+
* Query for recording retention data
|
|
884
|
+
*
|
|
885
|
+
* @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
|
|
886
|
+
* @param {Object} opts Optional parameters
|
|
887
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
888
|
+
* @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
|
|
889
|
+
*/
|
|
890
|
+
getRecordingsRetentionQuery(retentionThresholdDays, opts) {
|
|
891
|
+
opts = opts || {};
|
|
892
|
+
|
|
893
|
+
// verify the required parameter 'retentionThresholdDays' is set
|
|
894
|
+
if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
|
|
895
|
+
throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
|
|
896
|
+
}
|
|
897
|
+
|
|
898
|
+
return this.apiClient.callApi(
|
|
899
|
+
'/api/v2/recordings/retention/query',
|
|
900
|
+
'GET',
|
|
901
|
+
{ },
|
|
902
|
+
{ 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
|
|
903
|
+
{ },
|
|
904
|
+
{ },
|
|
905
|
+
null,
|
|
906
|
+
['PureCloud OAuth'],
|
|
907
|
+
['application/json'],
|
|
908
|
+
['application/json']
|
|
909
|
+
);
|
|
910
|
+
}
|
|
911
|
+
|
|
882
912
|
/**
|
|
883
913
|
* Retrieves a paged listing of screen recording sessions
|
|
884
914
|
*
|
|
@@ -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 147.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -571,6 +571,26 @@ class RoutingApi {
|
|
|
571
571
|
);
|
|
572
572
|
}
|
|
573
573
|
|
|
574
|
+
/**
|
|
575
|
+
* Get available media types
|
|
576
|
+
*
|
|
577
|
+
*/
|
|
578
|
+
getRoutingAvailablemediatypes() {
|
|
579
|
+
|
|
580
|
+
return this.apiClient.callApi(
|
|
581
|
+
'/api/v2/routing/availablemediatypes',
|
|
582
|
+
'GET',
|
|
583
|
+
{ },
|
|
584
|
+
{ },
|
|
585
|
+
{ },
|
|
586
|
+
{ },
|
|
587
|
+
null,
|
|
588
|
+
['PureCloud OAuth'],
|
|
589
|
+
['application/json'],
|
|
590
|
+
['application/json']
|
|
591
|
+
);
|
|
592
|
+
}
|
|
593
|
+
|
|
574
594
|
/**
|
|
575
595
|
* Get domain
|
|
576
596
|
*
|
|
@@ -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 147.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1747,6 +1747,36 @@ class UsersApi {
|
|
|
1747
1747
|
);
|
|
1748
1748
|
}
|
|
1749
1749
|
|
|
1750
|
+
/**
|
|
1751
|
+
* Create mapping between external identifier and user. Limit 100 per entity.
|
|
1752
|
+
* Authority Name and External key are case sensitive.
|
|
1753
|
+
* @param {String} userId User ID
|
|
1754
|
+
* @param {Object} body
|
|
1755
|
+
*/
|
|
1756
|
+
postUserExternalid(userId, body) {
|
|
1757
|
+
// verify the required parameter 'userId' is set
|
|
1758
|
+
if (userId === undefined || userId === null) {
|
|
1759
|
+
throw 'Missing the required parameter "userId" when calling postUserExternalid';
|
|
1760
|
+
}
|
|
1761
|
+
// verify the required parameter 'body' is set
|
|
1762
|
+
if (body === undefined || body === null) {
|
|
1763
|
+
throw 'Missing the required parameter "body" when calling postUserExternalid';
|
|
1764
|
+
}
|
|
1765
|
+
|
|
1766
|
+
return this.apiClient.callApi(
|
|
1767
|
+
'/api/v2/users/{userId}/externalid',
|
|
1768
|
+
'POST',
|
|
1769
|
+
{ 'userId': userId },
|
|
1770
|
+
{ },
|
|
1771
|
+
{ },
|
|
1772
|
+
{ },
|
|
1773
|
+
body,
|
|
1774
|
+
['PureCloud OAuth'],
|
|
1775
|
+
['application/json'],
|
|
1776
|
+
['application/json']
|
|
1777
|
+
);
|
|
1778
|
+
}
|
|
1779
|
+
|
|
1750
1780
|
/**
|
|
1751
1781
|
* Send an activation email to the user
|
|
1752
1782
|
*
|
|
@@ -1868,7 +1898,7 @@ class UsersApi {
|
|
|
1868
1898
|
|
|
1869
1899
|
/**
|
|
1870
1900
|
* Create user
|
|
1871
|
-
*
|
|
1901
|
+
* If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
|
|
1872
1902
|
* @param {Object} body User
|
|
1873
1903
|
*/
|
|
1874
1904
|
postUsers(body) {
|