purecloud-platform-client-v2 150.0.0 → 151.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 +351 -73
- package/dist/web-amd/purecloud-platform-client-v2.js +351 -73
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +351 -73
- package/dist/web-cjs/purecloud-platform-client-v2.js +351 -73
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +297 -201
- 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 +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 +36 -1
- 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 -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 +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 +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 +1 -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 TeamsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Teams service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 151.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
|
*
|
|
@@ -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 151.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1996,6 +1996,31 @@ class UsersApi {
|
|
|
1996
1996
|
);
|
|
1997
1997
|
}
|
|
1998
1998
|
|
|
1999
|
+
/**
|
|
2000
|
+
* Search users assigned to teams
|
|
2001
|
+
*
|
|
2002
|
+
* @param {Object} body Search request options
|
|
2003
|
+
*/
|
|
2004
|
+
postUsersSearchTeamsAssign(body) {
|
|
2005
|
+
// verify the required parameter 'body' is set
|
|
2006
|
+
if (body === undefined || body === null) {
|
|
2007
|
+
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
2008
|
+
}
|
|
2009
|
+
|
|
2010
|
+
return this.apiClient.callApi(
|
|
2011
|
+
'/api/v2/users/search/teams/assign',
|
|
2012
|
+
'POST',
|
|
2013
|
+
{ },
|
|
2014
|
+
{ },
|
|
2015
|
+
{ },
|
|
2016
|
+
{ },
|
|
2017
|
+
body,
|
|
2018
|
+
['PureCloud OAuth'],
|
|
2019
|
+
['application/json'],
|
|
2020
|
+
['application/json']
|
|
2021
|
+
);
|
|
2022
|
+
}
|
|
2023
|
+
|
|
1999
2024
|
/**
|
|
2000
2025
|
* Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
|
2001
2026
|
*
|
|
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WorkforceManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 151.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3785,6 +3785,76 @@ class WorkforceManagementApi {
|
|
|
3785
3785
|
);
|
|
3786
3786
|
}
|
|
3787
3787
|
|
|
3788
|
+
/**
|
|
3789
|
+
* Query time off balances for a given user for specified activity code and dates
|
|
3790
|
+
*
|
|
3791
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
3792
|
+
* @param {String} userId The ID of the user
|
|
3793
|
+
* @param {Object} body The request body
|
|
3794
|
+
*/
|
|
3795
|
+
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body) {
|
|
3796
|
+
// verify the required parameter 'managementUnitId' is set
|
|
3797
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3798
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
3799
|
+
}
|
|
3800
|
+
// verify the required parameter 'userId' is set
|
|
3801
|
+
if (userId === undefined || userId === null) {
|
|
3802
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
3803
|
+
}
|
|
3804
|
+
// verify the required parameter 'body' is set
|
|
3805
|
+
if (body === undefined || body === null) {
|
|
3806
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';
|
|
3807
|
+
}
|
|
3808
|
+
|
|
3809
|
+
return this.apiClient.callApi(
|
|
3810
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs',
|
|
3811
|
+
'POST',
|
|
3812
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
3813
|
+
{ },
|
|
3814
|
+
{ },
|
|
3815
|
+
{ },
|
|
3816
|
+
body,
|
|
3817
|
+
['PureCloud OAuth'],
|
|
3818
|
+
['application/json'],
|
|
3819
|
+
['application/json']
|
|
3820
|
+
);
|
|
3821
|
+
}
|
|
3822
|
+
|
|
3823
|
+
/**
|
|
3824
|
+
* Query time off balances for dates spanned by a given time off request
|
|
3825
|
+
*
|
|
3826
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
3827
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
3828
|
+
* @param {String} timeOffRequestId The time off request id.
|
|
3829
|
+
*/
|
|
3830
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId) {
|
|
3831
|
+
// verify the required parameter 'managementUnitId' is set
|
|
3832
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
3833
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
3834
|
+
}
|
|
3835
|
+
// verify the required parameter 'userId' is set
|
|
3836
|
+
if (userId === undefined || userId === null) {
|
|
3837
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
3838
|
+
}
|
|
3839
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
3840
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
3841
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';
|
|
3842
|
+
}
|
|
3843
|
+
|
|
3844
|
+
return this.apiClient.callApi(
|
|
3845
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs',
|
|
3846
|
+
'POST',
|
|
3847
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
3848
|
+
{ },
|
|
3849
|
+
{ },
|
|
3850
|
+
{ },
|
|
3851
|
+
null,
|
|
3852
|
+
['PureCloud OAuth'],
|
|
3853
|
+
['application/json'],
|
|
3854
|
+
['application/json']
|
|
3855
|
+
);
|
|
3856
|
+
}
|
|
3857
|
+
|
|
3788
3858
|
/**
|
|
3789
3859
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
3790
3860
|
*
|