purecloud-platform-client-v2 150.0.0 → 152.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 +619 -150
- package/dist/web-amd/purecloud-platform-client-v2.js +619 -150
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +619 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +619 -150
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +272 -18
- 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 +28 -2
- 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 +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 +49 -8
- 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 +32 -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 +3 -3
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +4 -4
- 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 +223 -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 +26 -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 +93 -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 +26 -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 +71 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class PresenceApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Presence service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -99,7 +99,7 @@ class PresenceApi {
|
|
|
99
99
|
* Get a list of Presence Sources
|
|
100
100
|
*
|
|
101
101
|
* @param {Object} opts Optional parameters
|
|
102
|
-
* @param {String} opts.
|
|
102
|
+
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
103
103
|
*/
|
|
104
104
|
getPresenceSources(opts) {
|
|
105
105
|
opts = opts || {};
|
|
@@ -109,7 +109,7 @@ class PresenceApi {
|
|
|
109
109
|
'/api/v2/presence/sources',
|
|
110
110
|
'GET',
|
|
111
111
|
{ },
|
|
112
|
-
{ '
|
|
112
|
+
{ 'deactivated': opts['deactivated'] },
|
|
113
113
|
{ },
|
|
114
114
|
{ },
|
|
115
115
|
null,
|
|
@@ -5,7 +5,7 @@ class ProcessAutomationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ProcessAutomation service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -46,7 +46,7 @@ class ProcessAutomationApi {
|
|
|
46
46
|
}
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
|
-
* Retrieve a single Trigger matching id
|
|
49
|
+
* Retrieve a single Trigger matching id
|
|
50
50
|
*
|
|
51
51
|
* @param {String} triggerId triggerId
|
|
52
52
|
*/
|
|
@@ -71,13 +71,13 @@ class ProcessAutomationApi {
|
|
|
71
71
|
}
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
* Retrieves all triggers
|
|
74
|
+
* Retrieves all triggers, optionally filtered by query parameters.
|
|
75
75
|
*
|
|
76
76
|
* @param {Object} opts Optional parameters
|
|
77
77
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
78
78
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
79
79
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
80
|
-
* @param {String} opts.topicName Topic name
|
|
80
|
+
* @param {String} opts.topicName Topic name(s). Separated by commas
|
|
81
81
|
* @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
|
|
82
82
|
*/
|
|
83
83
|
getProcessautomationTriggers(opts) {
|
|
@@ -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 152.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
|
*
|
|
@@ -1499,6 +1524,119 @@ class RoutingApi {
|
|
|
1499
1524
|
);
|
|
1500
1525
|
}
|
|
1501
1526
|
|
|
1527
|
+
/**
|
|
1528
|
+
* Get skill group
|
|
1529
|
+
*
|
|
1530
|
+
* @param {String} skillGroupId Skill Group ID
|
|
1531
|
+
*/
|
|
1532
|
+
getRoutingSkillgroup(skillGroupId) {
|
|
1533
|
+
// verify the required parameter 'skillGroupId' is set
|
|
1534
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
1535
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';
|
|
1536
|
+
}
|
|
1537
|
+
|
|
1538
|
+
return this.apiClient.callApi(
|
|
1539
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
1540
|
+
'GET',
|
|
1541
|
+
{ 'skillGroupId': skillGroupId },
|
|
1542
|
+
{ },
|
|
1543
|
+
{ },
|
|
1544
|
+
{ },
|
|
1545
|
+
null,
|
|
1546
|
+
['PureCloud OAuth'],
|
|
1547
|
+
['application/json'],
|
|
1548
|
+
['application/json']
|
|
1549
|
+
);
|
|
1550
|
+
}
|
|
1551
|
+
|
|
1552
|
+
/**
|
|
1553
|
+
* Get skill group members
|
|
1554
|
+
*
|
|
1555
|
+
* @param {String} skillGroupId Skill Group ID
|
|
1556
|
+
* @param {Object} opts Optional parameters
|
|
1557
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1558
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
1559
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
1560
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
1561
|
+
*/
|
|
1562
|
+
getRoutingSkillgroupMembers(skillGroupId, opts) {
|
|
1563
|
+
opts = opts || {};
|
|
1564
|
+
|
|
1565
|
+
// verify the required parameter 'skillGroupId' is set
|
|
1566
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
1567
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';
|
|
1568
|
+
}
|
|
1569
|
+
|
|
1570
|
+
return this.apiClient.callApi(
|
|
1571
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members',
|
|
1572
|
+
'GET',
|
|
1573
|
+
{ 'skillGroupId': skillGroupId },
|
|
1574
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
1575
|
+
{ },
|
|
1576
|
+
{ },
|
|
1577
|
+
null,
|
|
1578
|
+
['PureCloud OAuth'],
|
|
1579
|
+
['application/json'],
|
|
1580
|
+
['application/json']
|
|
1581
|
+
);
|
|
1582
|
+
}
|
|
1583
|
+
|
|
1584
|
+
/**
|
|
1585
|
+
* Get list of member divisions for this skill group.
|
|
1586
|
+
*
|
|
1587
|
+
* @param {String} skillGroupId Skill Group ID
|
|
1588
|
+
* @param {Object} opts Optional parameters
|
|
1589
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
1590
|
+
*/
|
|
1591
|
+
getRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
1592
|
+
opts = opts || {};
|
|
1593
|
+
|
|
1594
|
+
// verify the required parameter 'skillGroupId' is set
|
|
1595
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
1596
|
+
throw 'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';
|
|
1597
|
+
}
|
|
1598
|
+
|
|
1599
|
+
return this.apiClient.callApi(
|
|
1600
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
1601
|
+
'GET',
|
|
1602
|
+
{ 'skillGroupId': skillGroupId },
|
|
1603
|
+
{ 'expand': opts['expand'] },
|
|
1604
|
+
{ },
|
|
1605
|
+
{ },
|
|
1606
|
+
null,
|
|
1607
|
+
['PureCloud OAuth'],
|
|
1608
|
+
['application/json'],
|
|
1609
|
+
['application/json']
|
|
1610
|
+
);
|
|
1611
|
+
}
|
|
1612
|
+
|
|
1613
|
+
/**
|
|
1614
|
+
* Get skill group listing
|
|
1615
|
+
*
|
|
1616
|
+
* @param {Object} opts Optional parameters
|
|
1617
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1618
|
+
* @param {String} opts.name Return only skill group names whose names start with this value (case-insensitive matching)
|
|
1619
|
+
* @param {String} opts.after The cursor that points to the next item
|
|
1620
|
+
* @param {String} opts.before The cursor that points to the previous item
|
|
1621
|
+
*/
|
|
1622
|
+
getRoutingSkillgroups(opts) {
|
|
1623
|
+
opts = opts || {};
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
return this.apiClient.callApi(
|
|
1627
|
+
'/api/v2/routing/skillgroups',
|
|
1628
|
+
'GET',
|
|
1629
|
+
{ },
|
|
1630
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'] },
|
|
1631
|
+
{ },
|
|
1632
|
+
{ },
|
|
1633
|
+
null,
|
|
1634
|
+
['PureCloud OAuth'],
|
|
1635
|
+
['application/json'],
|
|
1636
|
+
['application/json']
|
|
1637
|
+
);
|
|
1638
|
+
}
|
|
1639
|
+
|
|
1502
1640
|
/**
|
|
1503
1641
|
* Get the list of routing skills.
|
|
1504
1642
|
*
|
|
@@ -2137,6 +2275,36 @@ class RoutingApi {
|
|
|
2137
2275
|
);
|
|
2138
2276
|
}
|
|
2139
2277
|
|
|
2278
|
+
/**
|
|
2279
|
+
* Update skill group definition
|
|
2280
|
+
*
|
|
2281
|
+
* @param {String} skillGroupId Skill Group ID
|
|
2282
|
+
* @param {Object} body Update skill groups
|
|
2283
|
+
*/
|
|
2284
|
+
patchRoutingSkillgroup(skillGroupId, body) {
|
|
2285
|
+
// verify the required parameter 'skillGroupId' is set
|
|
2286
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
2287
|
+
throw 'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';
|
|
2288
|
+
}
|
|
2289
|
+
// verify the required parameter 'body' is set
|
|
2290
|
+
if (body === undefined || body === null) {
|
|
2291
|
+
throw 'Missing the required parameter "body" when calling patchRoutingSkillgroup';
|
|
2292
|
+
}
|
|
2293
|
+
|
|
2294
|
+
return this.apiClient.callApi(
|
|
2295
|
+
'/api/v2/routing/skillgroups/{skillGroupId}',
|
|
2296
|
+
'PATCH',
|
|
2297
|
+
{ 'skillGroupId': skillGroupId },
|
|
2298
|
+
{ },
|
|
2299
|
+
{ },
|
|
2300
|
+
{ },
|
|
2301
|
+
body,
|
|
2302
|
+
['PureCloud OAuth'],
|
|
2303
|
+
['application/json'],
|
|
2304
|
+
['application/json']
|
|
2305
|
+
);
|
|
2306
|
+
}
|
|
2307
|
+
|
|
2140
2308
|
/**
|
|
2141
2309
|
* Join or unjoin a queue for a user
|
|
2142
2310
|
*
|
|
@@ -2680,6 +2848,60 @@ class RoutingApi {
|
|
|
2680
2848
|
);
|
|
2681
2849
|
}
|
|
2682
2850
|
|
|
2851
|
+
/**
|
|
2852
|
+
* Add or remove member divisions for this skill group.
|
|
2853
|
+
*
|
|
2854
|
+
* @param {String} skillGroupId Skill Group ID
|
|
2855
|
+
* @param {Object} opts Optional parameters
|
|
2856
|
+
* @param {Object} opts.body
|
|
2857
|
+
*/
|
|
2858
|
+
postRoutingSkillgroupMembersDivisions(skillGroupId, opts) {
|
|
2859
|
+
opts = opts || {};
|
|
2860
|
+
|
|
2861
|
+
// verify the required parameter 'skillGroupId' is set
|
|
2862
|
+
if (skillGroupId === undefined || skillGroupId === null) {
|
|
2863
|
+
throw 'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';
|
|
2864
|
+
}
|
|
2865
|
+
|
|
2866
|
+
return this.apiClient.callApi(
|
|
2867
|
+
'/api/v2/routing/skillgroups/{skillGroupId}/members/divisions',
|
|
2868
|
+
'POST',
|
|
2869
|
+
{ 'skillGroupId': skillGroupId },
|
|
2870
|
+
{ },
|
|
2871
|
+
{ },
|
|
2872
|
+
{ },
|
|
2873
|
+
opts['body'],
|
|
2874
|
+
['PureCloud OAuth'],
|
|
2875
|
+
['application/json'],
|
|
2876
|
+
['application/json']
|
|
2877
|
+
);
|
|
2878
|
+
}
|
|
2879
|
+
|
|
2880
|
+
/**
|
|
2881
|
+
* Create a skill group
|
|
2882
|
+
*
|
|
2883
|
+
* @param {Object} body Create skill group
|
|
2884
|
+
*/
|
|
2885
|
+
postRoutingSkillgroups(body) {
|
|
2886
|
+
// verify the required parameter 'body' is set
|
|
2887
|
+
if (body === undefined || body === null) {
|
|
2888
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillgroups';
|
|
2889
|
+
}
|
|
2890
|
+
|
|
2891
|
+
return this.apiClient.callApi(
|
|
2892
|
+
'/api/v2/routing/skillgroups',
|
|
2893
|
+
'POST',
|
|
2894
|
+
{ },
|
|
2895
|
+
{ },
|
|
2896
|
+
{ },
|
|
2897
|
+
{ },
|
|
2898
|
+
body,
|
|
2899
|
+
['PureCloud OAuth'],
|
|
2900
|
+
['application/json'],
|
|
2901
|
+
['application/json']
|
|
2902
|
+
);
|
|
2903
|
+
}
|
|
2904
|
+
|
|
2683
2905
|
/**
|
|
2684
2906
|
* Create Skill
|
|
2685
2907
|
*
|
|
@@ -5,7 +5,7 @@ class SearchApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Search service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -534,6 +534,31 @@ class SearchApi {
|
|
|
534
534
|
);
|
|
535
535
|
}
|
|
536
536
|
|
|
537
|
+
/**
|
|
538
|
+
* Search users assigned to teams
|
|
539
|
+
*
|
|
540
|
+
* @param {Object} body Search request options
|
|
541
|
+
*/
|
|
542
|
+
postUsersSearchTeamsAssign(body) {
|
|
543
|
+
// verify the required parameter 'body' is set
|
|
544
|
+
if (body === undefined || body === null) {
|
|
545
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
return this.apiClient.callApi(
|
|
549
|
+
'/api/v2/users/search/teams/assign',
|
|
550
|
+
'POST',
|
|
551
|
+
{ },
|
|
552
|
+
{ },
|
|
553
|
+
{ },
|
|
554
|
+
{ },
|
|
555
|
+
body,
|
|
556
|
+
['PureCloud OAuth'],
|
|
557
|
+
['application/json'],
|
|
558
|
+
['application/json']
|
|
559
|
+
);
|
|
560
|
+
}
|
|
561
|
+
|
|
537
562
|
/**
|
|
538
563
|
* Search voicemails
|
|
539
564
|
*
|
|
@@ -5,7 +5,7 @@ class TeamsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Teams service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -45,6 +45,36 @@ class TeamsApi {
|
|
|
45
45
|
);
|
|
46
46
|
}
|
|
47
47
|
|
|
48
|
+
/**
|
|
49
|
+
* Delete team members
|
|
50
|
+
*
|
|
51
|
+
* @param {String} teamId Team ID
|
|
52
|
+
* @param {String} id Comma separated list of member ids to remove
|
|
53
|
+
*/
|
|
54
|
+
deleteTeamMembers(teamId, id) {
|
|
55
|
+
// verify the required parameter 'teamId' is set
|
|
56
|
+
if (teamId === undefined || teamId === null) {
|
|
57
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeamMembers';
|
|
58
|
+
}
|
|
59
|
+
// verify the required parameter 'id' is set
|
|
60
|
+
if (id === undefined || id === null) {
|
|
61
|
+
throw 'Missing the required parameter "id" when calling deleteTeamMembers';
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
return this.apiClient.callApi(
|
|
65
|
+
'/api/v2/teams/{teamId}/members',
|
|
66
|
+
'DELETE',
|
|
67
|
+
{ 'teamId': teamId },
|
|
68
|
+
{ 'id': id },
|
|
69
|
+
{ },
|
|
70
|
+
{ },
|
|
71
|
+
null,
|
|
72
|
+
['PureCloud OAuth'],
|
|
73
|
+
['application/json'],
|
|
74
|
+
['application/json']
|
|
75
|
+
);
|
|
76
|
+
}
|
|
77
|
+
|
|
48
78
|
/**
|
|
49
79
|
* Get team
|
|
50
80
|
*
|
|
@@ -70,6 +100,38 @@ class TeamsApi {
|
|
|
70
100
|
);
|
|
71
101
|
}
|
|
72
102
|
|
|
103
|
+
/**
|
|
104
|
+
* Get team membership
|
|
105
|
+
*
|
|
106
|
+
* @param {String} teamId Team ID
|
|
107
|
+
* @param {Object} opts Optional parameters
|
|
108
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
109
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
110
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
111
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
112
|
+
*/
|
|
113
|
+
getTeamMembers(teamId, opts) {
|
|
114
|
+
opts = opts || {};
|
|
115
|
+
|
|
116
|
+
// verify the required parameter 'teamId' is set
|
|
117
|
+
if (teamId === undefined || teamId === null) {
|
|
118
|
+
throw 'Missing the required parameter "teamId" when calling getTeamMembers';
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
return this.apiClient.callApi(
|
|
122
|
+
'/api/v2/teams/{teamId}/members',
|
|
123
|
+
'GET',
|
|
124
|
+
{ 'teamId': teamId },
|
|
125
|
+
{ 'pageSize': opts['pageSize'],'before': opts['before'],'after': opts['after'],'expand': opts['expand'] },
|
|
126
|
+
{ },
|
|
127
|
+
{ },
|
|
128
|
+
null,
|
|
129
|
+
['PureCloud OAuth'],
|
|
130
|
+
['application/json'],
|
|
131
|
+
['application/json']
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
|
|
73
135
|
/**
|
|
74
136
|
* Get Team listing
|
|
75
137
|
*
|
|
@@ -128,6 +190,36 @@ class TeamsApi {
|
|
|
128
190
|
);
|
|
129
191
|
}
|
|
130
192
|
|
|
193
|
+
/**
|
|
194
|
+
* Add team members
|
|
195
|
+
*
|
|
196
|
+
* @param {String} teamId Team ID
|
|
197
|
+
* @param {Object} body TeamMembers
|
|
198
|
+
*/
|
|
199
|
+
postTeamMembers(teamId, body) {
|
|
200
|
+
// verify the required parameter 'teamId' is set
|
|
201
|
+
if (teamId === undefined || teamId === null) {
|
|
202
|
+
throw 'Missing the required parameter "teamId" when calling postTeamMembers';
|
|
203
|
+
}
|
|
204
|
+
// verify the required parameter 'body' is set
|
|
205
|
+
if (body === undefined || body === null) {
|
|
206
|
+
throw 'Missing the required parameter "body" when calling postTeamMembers';
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
return this.apiClient.callApi(
|
|
210
|
+
'/api/v2/teams/{teamId}/members',
|
|
211
|
+
'POST',
|
|
212
|
+
{ 'teamId': teamId },
|
|
213
|
+
{ },
|
|
214
|
+
{ },
|
|
215
|
+
{ },
|
|
216
|
+
body,
|
|
217
|
+
['PureCloud OAuth'],
|
|
218
|
+
['application/json'],
|
|
219
|
+
['application/json']
|
|
220
|
+
);
|
|
221
|
+
}
|
|
222
|
+
|
|
131
223
|
/**
|
|
132
224
|
* Create a team
|
|
133
225
|
*
|