purecloud-platform-client-v2 151.0.0 → 153.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 +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.js +712 -150
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +712 -150
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +579 -212
- 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 +30 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +46 -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 +16 -10
- 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/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 -65
- 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 +3 -3
- 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 +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 +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +226 -2
- 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 +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 +325 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 153.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -314,6 +314,31 @@ class RoutingApi {
|
|
|
314
314
|
);
|
|
315
315
|
}
|
|
316
316
|
|
|
317
|
+
/**
|
|
318
|
+
* Remove skill group definition
|
|
319
|
+
*
|
|
320
|
+
* @param {String} skillGroupId Skill Group ID
|
|
321
|
+
*/
|
|
322
|
+
deleteRoutingSkillgroup(skillGroupId) {
|
|
323
|
+
// verify the required parameter 'skillGroupId' is set
|
|
324
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
325
|
+
throw 'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
return this.apiClient.callApi(
|
|
329
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
330
|
+
'DELETE',
|
|
331
|
+
{ 'skillGroupId': skillGroupId },
|
|
332
|
+
{ },
|
|
333
|
+
{ },
|
|
334
|
+
{ },
|
|
335
|
+
null,
|
|
336
|
+
['PureCloud OAuth'],
|
|
337
|
+
['application/json'],
|
|
338
|
+
['application/json']
|
|
339
|
+
);
|
|
340
|
+
}
|
|
341
|
+
|
|
317
342
|
/**
|
|
318
343
|
* Delete an Address by Id for SMS
|
|
319
344
|
*
|
|
@@ -706,6 +731,8 @@ class RoutingApi {
|
|
|
706
731
|
* Get domains
|
|
707
732
|
*
|
|
708
733
|
* @param {Object} opts Optional parameters
|
|
734
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
735
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
709
736
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
710
737
|
*/
|
|
711
738
|
getRoutingEmailDomains(opts) {
|
|
@@ -716,7 +743,7 @@ class RoutingApi {
|
|
|
716
743
|
'/api/v2/routing/email/domains',
|
|
717
744
|
'GET',
|
|
718
745
|
{ },
|
|
719
|
-
{ 'excludeStatus': opts['excludeStatus'] },
|
|
746
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'excludeStatus': opts['excludeStatus'] },
|
|
720
747
|
{ },
|
|
721
748
|
{ },
|
|
722
749
|
null,
|
|
@@ -1499,6 +1526,119 @@ class RoutingApi {
|
|
|
1499
1526
|
);
|
|
1500
1527
|
}
|
|
1501
1528
|
|
|
1529
|
+
/**
|
|
1530
|
+
* Get skill group
|
|
1531
|
+
*
|
|
1532
|
+
* @param {String} skillGroupId Skill Group ID
|
|
1533
|
+
*/
|
|
1534
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
1535
|
+
// verify the required parameter 'skillGroupId' is set
|
|
1536
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
1537
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
1538
|
+
}
|
|
1539
|
+
|
|
1540
|
+
return this.apiClient.callApi(
|
|
1541
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
1542
|
+
'GET',
|
|
1543
|
+
{ 'skillGroupId': skillGroupId },
|
|
1544
|
+
{ },
|
|
1545
|
+
{ },
|
|
1546
|
+
{ },
|
|
1547
|
+
null,
|
|
1548
|
+
['PureCloud OAuth'],
|
|
1549
|
+
['application/json'],
|
|
1550
|
+
['application/json']
|
|
1551
|
+
);
|
|
1552
|
+
}
|
|
1553
|
+
|
|
1554
|
+
/**
|
|
1555
|
+
* Get skill group members
|
|
1556
|
+
*
|
|
1557
|
+
* @param {String} skillGroupId Skill Group ID
|
|
1558
|
+
* @param {Object} opts Optional parameters
|
|
1559
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1560
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
1561
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
1562
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
1563
|
+
*/
|
|
1564
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
1565
|
+
opts = opts || {};
|
|
1566
|
+
|
|
1567
|
+
// verify the required parameter 'skillGroupId' is set
|
|
1568
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
1569
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
1570
|
+
}
|
|
1571
|
+
|
|
1572
|
+
return this.apiClient.callApi(
|
|
1573
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
1574
|
+
'GET',
|
|
1575
|
+
{ 'skillGroupId': skillGroupId },
|
|
1576
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
1577
|
+
{ },
|
|
1578
|
+
{ },
|
|
1579
|
+
null,
|
|
1580
|
+
['PureCloud OAuth'],
|
|
1581
|
+
['application/json'],
|
|
1582
|
+
['application/json']
|
|
1583
|
+
);
|
|
1584
|
+
}
|
|
1585
|
+
|
|
1586
|
+
/**
|
|
1587
|
+
* Get list of member divisions for this skill group.
|
|
1588
|
+
*
|
|
1589
|
+
* @param {String} skillGroupId Skill Group ID
|
|
1590
|
+
* @param {Object} opts Optional parameters
|
|
1591
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
1592
|
+
*/
|
|
1593
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
1594
|
+
opts = opts || {};
|
|
1595
|
+
|
|
1596
|
+
// verify the required parameter 'skillGroupId' is set
|
|
1597
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
1598
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
1599
|
+
}
|
|
1600
|
+
|
|
1601
|
+
return this.apiClient.callApi(
|
|
1602
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
1603
|
+
'GET',
|
|
1604
|
+
{ 'skillGroupId': skillGroupId },
|
|
1605
|
+
{ 'expand': opts['expand'] },
|
|
1606
|
+
{ },
|
|
1607
|
+
{ },
|
|
1608
|
+
null,
|
|
1609
|
+
['PureCloud OAuth'],
|
|
1610
|
+
['application/json'],
|
|
1611
|
+
['application/json']
|
|
1612
|
+
);
|
|
1613
|
+
}
|
|
1614
|
+
|
|
1615
|
+
/**
|
|
1616
|
+
* Get skill group listing
|
|
1617
|
+
*
|
|
1618
|
+
* @param {Object} opts Optional parameters
|
|
1619
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1620
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
1621
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
1622
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
1623
|
+
*/
|
|
1624
|
+
getRoutingSkillgroups(opts) {
|
|
1625
|
+
opts = opts || {};
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
return this.apiClient.callApi(
|
|
1629
|
+
'/api/v2/routing/skillgroups',
|
|
1630
|
+
'GET',
|
|
1631
|
+
{ },
|
|
1632
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
1633
|
+
{ },
|
|
1634
|
+
{ },
|
|
1635
|
+
null,
|
|
1636
|
+
['PureCloud OAuth'],
|
|
1637
|
+
['application/json'],
|
|
1638
|
+
['application/json']
|
|
1639
|
+
);
|
|
1640
|
+
}
|
|
1641
|
+
|
|
1502
1642
|
/**
|
|
1503
1643
|
* Get the list of routing skills.
|
|
1504
1644
|
*
|
|
@@ -2137,6 +2277,36 @@ class RoutingApi {
|
|
|
2137
2277
|
);
|
|
2138
2278
|
}
|
|
2139
2279
|
|
|
2280
|
+
/**
|
|
2281
|
+
* Update skill group definition
|
|
2282
|
+
*
|
|
2283
|
+
* @param {String} skillGroupId Skill Group ID
|
|
2284
|
+
* @param {Object} body Update skill groups
|
|
2285
|
+
*/
|
|
2286
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
2287
|
+
// verify the required parameter 'skillGroupId' is set
|
|
2288
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
2289
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
2290
|
+
}
|
|
2291
|
+
// verify the required parameter 'body' is set
|
|
2292
|
+
if (body === undefined || body === null) {
|
|
2293
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
2294
|
+
}
|
|
2295
|
+
|
|
2296
|
+
return this.apiClient.callApi(
|
|
2297
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
2298
|
+
'PATCH',
|
|
2299
|
+
{ 'skillGroupId': skillGroupId },
|
|
2300
|
+
{ },
|
|
2301
|
+
{ },
|
|
2302
|
+
{ },
|
|
2303
|
+
body,
|
|
2304
|
+
['PureCloud OAuth'],
|
|
2305
|
+
['application/json'],
|
|
2306
|
+
['application/json']
|
|
2307
|
+
);
|
|
2308
|
+
}
|
|
2309
|
+
|
|
2140
2310
|
/**
|
|
2141
2311
|
* Join or unjoin a queue for a user
|
|
2142
2312
|
*
|
|
@@ -2680,6 +2850,60 @@ class RoutingApi {
|
|
|
2680
2850
|
);
|
|
2681
2851
|
}
|
|
2682
2852
|
|
|
2853
|
+
/**
|
|
2854
|
+
* Add or remove member divisions for this skill group.
|
|
2855
|
+
*
|
|
2856
|
+
* @param {String} skillGroupId Skill Group ID
|
|
2857
|
+
* @param {Object} opts Optional parameters
|
|
2858
|
+
* @param {Object} opts.body
|
|
2859
|
+
*/
|
|
2860
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
2861
|
+
opts = opts || {};
|
|
2862
|
+
|
|
2863
|
+
// verify the required parameter 'skillGroupId' is set
|
|
2864
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
2865
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
2866
|
+
}
|
|
2867
|
+
|
|
2868
|
+
return this.apiClient.callApi(
|
|
2869
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
2870
|
+
'POST',
|
|
2871
|
+
{ 'skillGroupId': skillGroupId },
|
|
2872
|
+
{ },
|
|
2873
|
+
{ },
|
|
2874
|
+
{ },
|
|
2875
|
+
opts['body'],
|
|
2876
|
+
['PureCloud OAuth'],
|
|
2877
|
+
['application/json'],
|
|
2878
|
+
['application/json']
|
|
2879
|
+
);
|
|
2880
|
+
}
|
|
2881
|
+
|
|
2882
|
+
/**
|
|
2883
|
+
* Create a skill group
|
|
2884
|
+
*
|
|
2885
|
+
* @param {Object} body Create skill group
|
|
2886
|
+
*/
|
|
2887
|
+
postRoutingSkillgroups(body) {
|
|
2888
|
+
// verify the required parameter 'body' is set
|
|
2889
|
+
if (body === undefined || body === null) {
|
|
2890
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
2891
|
+
}
|
|
2892
|
+
|
|
2893
|
+
return this.apiClient.callApi(
|
|
2894
|
+
'/api/v2/routing/skillgroups',
|
|
2895
|
+
'POST',
|
|
2896
|
+
{ },
|
|
2897
|
+
{ },
|
|
2898
|
+
{ },
|
|
2899
|
+
{ },
|
|
2900
|
+
body,
|
|
2901
|
+
['PureCloud OAuth'],
|
|
2902
|
+
['application/json'],
|
|
2903
|
+
['application/json']
|
|
2904
|
+
);
|
|
2905
|
+
}
|
|
2906
|
+
|
|
2683
2907
|
/**
|
|
2684
2908
|
* Create Skill
|
|
2685
2909
|
*
|