purecloud-platform-client-v2 133.0.2 → 135.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 +680 -200
- package/dist/web-amd/purecloud-platform-client-v2.js +680 -200
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +680 -200
- package/dist/web-cjs/purecloud-platform-client-v2.js +692 -204
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1060 -221
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- 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 +78 -3
- 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 +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 +14 -6
- 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 +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +160 -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 +69 -3
- 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 +2 -2
- 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 -26
- 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 +269 -49
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
|
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6
|
-
* @version
|
|
6
|
+
* @version 135.0.0
|
|
7
7
|
*/
|
|
8
8
|
class ApiClient {
|
|
9
9
|
/**
|
|
@@ -950,7 +950,7 @@ class ApiClient {
|
|
|
950
950
|
|
|
951
951
|
// set header parameters
|
|
952
952
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
953
|
-
//request.set({ 'purecloud-sdk': '
|
|
953
|
+
//request.set({ 'purecloud-sdk': '135.0.0' });
|
|
954
954
|
|
|
955
955
|
// set request timeout
|
|
956
956
|
request.timeout(that.timeout);
|
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 135.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1910,7 +1910,7 @@ class ConversationsApi {
|
|
|
1910
1910
|
/**
|
|
1911
1911
|
* Get a list of Messaging Stickers
|
|
1912
1912
|
*
|
|
1913
|
-
* @param {
|
|
1913
|
+
* @param {Object} messengerType Messenger Type
|
|
1914
1914
|
* @param {Object} opts Optional parameters
|
|
1915
1915
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1916
1916
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -2098,7 +2098,7 @@ class ConversationsApi {
|
|
|
2098
2098
|
}
|
|
2099
2099
|
|
|
2100
2100
|
/**
|
|
2101
|
-
* Update a conversation by setting
|
|
2101
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2102
2102
|
*
|
|
2103
2103
|
* @param {String} conversationId conversationId
|
|
2104
2104
|
* @param {Object} body Conversation
|
|
@@ -2412,6 +2412,31 @@ class ConversationsApi {
|
|
|
2412
2412
|
);
|
|
2413
2413
|
}
|
|
2414
2414
|
|
|
2415
|
+
/**
|
|
2416
|
+
* Update a scheduled callback
|
|
2417
|
+
*
|
|
2418
|
+
* @param {Object} body PatchCallbackRequest
|
|
2419
|
+
*/
|
|
2420
|
+
patchConversationsCallbacks(body) {
|
|
2421
|
+
// verify the required parameter 'body' is set
|
|
2422
|
+
if (body === undefined || body === null) {
|
|
2423
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallbacks';
|
|
2424
|
+
}
|
|
2425
|
+
|
|
2426
|
+
return this.apiClient.callApi(
|
|
2427
|
+
'/api/v2/conversations/callbacks',
|
|
2428
|
+
'PATCH',
|
|
2429
|
+
{ },
|
|
2430
|
+
{ },
|
|
2431
|
+
{ },
|
|
2432
|
+
{ },
|
|
2433
|
+
body,
|
|
2434
|
+
['PureCloud OAuth'],
|
|
2435
|
+
['application/json'],
|
|
2436
|
+
['application/json']
|
|
2437
|
+
);
|
|
2438
|
+
}
|
|
2439
|
+
|
|
2415
2440
|
/**
|
|
2416
2441
|
* Update a conversation by disconnecting all of the participants
|
|
2417
2442
|
*
|
|
@@ -3665,6 +3690,56 @@ class ConversationsApi {
|
|
|
3665
3690
|
);
|
|
3666
3691
|
}
|
|
3667
3692
|
|
|
3693
|
+
/**
|
|
3694
|
+
* Disconnect multiple scheduled callbacks
|
|
3695
|
+
*
|
|
3696
|
+
* @param {Object} body BulkCallbackDisconnectRequest
|
|
3697
|
+
*/
|
|
3698
|
+
postConversationsCallbacksBulkDisconnect(body) {
|
|
3699
|
+
// verify the required parameter 'body' is set
|
|
3700
|
+
if (body === undefined || body === null) {
|
|
3701
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallbacksBulkDisconnect';
|
|
3702
|
+
}
|
|
3703
|
+
|
|
3704
|
+
return this.apiClient.callApi(
|
|
3705
|
+
'/api/v2/conversations/callbacks/bulk/disconnect',
|
|
3706
|
+
'POST',
|
|
3707
|
+
{ },
|
|
3708
|
+
{ },
|
|
3709
|
+
{ },
|
|
3710
|
+
{ },
|
|
3711
|
+
body,
|
|
3712
|
+
['PureCloud OAuth'],
|
|
3713
|
+
['application/json'],
|
|
3714
|
+
['application/json']
|
|
3715
|
+
);
|
|
3716
|
+
}
|
|
3717
|
+
|
|
3718
|
+
/**
|
|
3719
|
+
* Update multiple scheduled callbacks
|
|
3720
|
+
*
|
|
3721
|
+
* @param {Object} body BulkCallbackPatchRequest
|
|
3722
|
+
*/
|
|
3723
|
+
postConversationsCallbacksBulkUpdate(body) {
|
|
3724
|
+
// verify the required parameter 'body' is set
|
|
3725
|
+
if (body === undefined || body === null) {
|
|
3726
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallbacksBulkUpdate';
|
|
3727
|
+
}
|
|
3728
|
+
|
|
3729
|
+
return this.apiClient.callApi(
|
|
3730
|
+
'/api/v2/conversations/callbacks/bulk/update',
|
|
3731
|
+
'POST',
|
|
3732
|
+
{ },
|
|
3733
|
+
{ },
|
|
3734
|
+
{ },
|
|
3735
|
+
{ },
|
|
3736
|
+
body,
|
|
3737
|
+
['PureCloud OAuth'],
|
|
3738
|
+
['application/json'],
|
|
3739
|
+
['application/json']
|
|
3740
|
+
);
|
|
3741
|
+
}
|
|
3742
|
+
|
|
3668
3743
|
/**
|
|
3669
3744
|
* Create a call conversation
|
|
3670
3745
|
*
|
|
@@ -5,7 +5,7 @@ class OAuthApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* OAuth service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 135.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -49,8 +49,12 @@ class OAuthApi {
|
|
|
49
49
|
* Get a client that is authorized by the resource owner
|
|
50
50
|
*
|
|
51
51
|
* @param {String} clientId The ID of client
|
|
52
|
+
* @param {Object} opts Optional parameters
|
|
53
|
+
* @param {String} opts.acceptLanguage The language in which to display the client descriptions. (default to en-us)
|
|
52
54
|
*/
|
|
53
|
-
getOauthAuthorization(clientId) {
|
|
55
|
+
getOauthAuthorization(clientId, opts) {
|
|
56
|
+
opts = opts || {};
|
|
57
|
+
|
|
54
58
|
// verify the required parameter 'clientId' is set
|
|
55
59
|
if (clientId === undefined || clientId === null) {
|
|
56
60
|
throw 'Missing the required parameter "clientId" when calling getOauthAuthorization';
|
|
@@ -61,7 +65,7 @@ class OAuthApi {
|
|
|
61
65
|
'GET',
|
|
62
66
|
{ 'clientId': clientId },
|
|
63
67
|
{ },
|
|
64
|
-
{
|
|
68
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
65
69
|
{ },
|
|
66
70
|
null,
|
|
67
71
|
['PureCloud OAuth'],
|
|
@@ -71,17 +75,21 @@ class OAuthApi {
|
|
|
71
75
|
}
|
|
72
76
|
|
|
73
77
|
/**
|
|
74
|
-
* List clients that
|
|
78
|
+
* List clients that have been authorized, requested, or revoked by the resource owner
|
|
75
79
|
*
|
|
80
|
+
* @param {Object} opts Optional parameters
|
|
81
|
+
* @param {String} opts.acceptLanguage The language in which to display the client descriptions. (default to en-us)
|
|
76
82
|
*/
|
|
77
|
-
getOauthAuthorizations() {
|
|
83
|
+
getOauthAuthorizations(opts) {
|
|
84
|
+
opts = opts || {};
|
|
85
|
+
|
|
78
86
|
|
|
79
87
|
return this.apiClient.callApi(
|
|
80
88
|
'/api/v2/oauth/authorizations',
|
|
81
89
|
'GET',
|
|
82
90
|
{ },
|
|
83
91
|
{ },
|
|
84
|
-
{
|
|
92
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
85
93
|
{ },
|
|
86
94
|
null,
|
|
87
95
|
['PureCloud OAuth'],
|
|
@@ -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 135.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -355,6 +355,31 @@ class OutboundApi {
|
|
|
355
355
|
);
|
|
356
356
|
}
|
|
357
357
|
|
|
358
|
+
/**
|
|
359
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
360
|
+
*
|
|
361
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
362
|
+
*/
|
|
363
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
364
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
365
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
366
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
return this.apiClient.callApi(
|
|
370
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
371
|
+
'DELETE',
|
|
372
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
373
|
+
{ },
|
|
374
|
+
{ },
|
|
375
|
+
{ },
|
|
376
|
+
null,
|
|
377
|
+
['PureCloud OAuth'],
|
|
378
|
+
['application/json'],
|
|
379
|
+
['application/json']
|
|
380
|
+
);
|
|
381
|
+
}
|
|
382
|
+
|
|
358
383
|
/**
|
|
359
384
|
* Delete a Rule Set.
|
|
360
385
|
*
|
|
@@ -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 135.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -151,31 +151,6 @@ class PresenceApi {
|
|
|
151
151
|
);
|
|
152
152
|
}
|
|
153
153
|
|
|
154
|
-
/**
|
|
155
|
-
* Get a user's Microsoft Teams presence.
|
|
156
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
157
|
-
* @param {String} userId user Id
|
|
158
|
-
*/
|
|
159
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
160
|
-
// verify the required parameter 'userId' is set
|
|
161
|
-
if (userId === undefined || userId === null) {
|
|
162
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
return this.apiClient.callApi(
|
|
166
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
167
|
-
'GET',
|
|
168
|
-
{ 'userId': userId },
|
|
169
|
-
{ },
|
|
170
|
-
{ },
|
|
171
|
-
{ },
|
|
172
|
-
null,
|
|
173
|
-
['PureCloud OAuth'],
|
|
174
|
-
['application/json'],
|
|
175
|
-
['application/json']
|
|
176
|
-
);
|
|
177
|
-
}
|
|
178
|
-
|
|
179
154
|
/**
|
|
180
155
|
* Get a user's Genesys Cloud presence.
|
|
181
156
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -201,31 +176,6 @@ class PresenceApi {
|
|
|
201
176
|
);
|
|
202
177
|
}
|
|
203
178
|
|
|
204
|
-
/**
|
|
205
|
-
* Get a user's Zoom Phone presence.
|
|
206
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
207
|
-
* @param {String} userId user Id
|
|
208
|
-
*/
|
|
209
|
-
getUserPresencesZoomphone(userId) {
|
|
210
|
-
// verify the required parameter 'userId' is set
|
|
211
|
-
if (userId === undefined || userId === null) {
|
|
212
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
return this.apiClient.callApi(
|
|
216
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
217
|
-
'GET',
|
|
218
|
-
{ 'userId': userId },
|
|
219
|
-
{ },
|
|
220
|
-
{ },
|
|
221
|
-
{ },
|
|
222
|
-
null,
|
|
223
|
-
['PureCloud OAuth'],
|
|
224
|
-
['application/json'],
|
|
225
|
-
['application/json']
|
|
226
|
-
);
|
|
227
|
-
}
|
|
228
|
-
|
|
229
179
|
/**
|
|
230
180
|
* Patch a user's Presence
|
|
231
181
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|