purecloud-platform-client-v2 166.0.0 → 168.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 +747 -205
- package/dist/web-amd/purecloud-platform-client-v2.js +747 -205
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +747 -205
- package/dist/web-cjs/purecloud-platform-client-v2.js +747 -205
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +885 -413
- package/package.json +7 -7
- 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 +3 -3
- 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/CarrierServicesApi.js +75 -0
- 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 +32 -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 +2 -2
- 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 +470 -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/InfrastructureAsCodeApi.js +69 -4
- 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 +26 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -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 -46
- 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 -81
- 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 +2 -2
- package/src/purecloud-platform-client-v2/index.js +7 -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 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1769,6 +1769,31 @@ class OutboundApi {
|
|
|
1769
1769
|
);
|
|
1770
1770
|
}
|
|
1771
1771
|
|
|
1772
|
+
/**
|
|
1773
|
+
* Get messaging campaign diagnostics
|
|
1774
|
+
*
|
|
1775
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
1776
|
+
*/
|
|
1777
|
+
getOutboundMessagingcampaignDiagnostics(messagingCampaignId) {
|
|
1778
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
1779
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
1780
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignDiagnostics';
|
|
1781
|
+
}
|
|
1782
|
+
|
|
1783
|
+
return this.apiClient.callApi(
|
|
1784
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics',
|
|
1785
|
+
'GET',
|
|
1786
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
1787
|
+
{ },
|
|
1788
|
+
{ },
|
|
1789
|
+
{ },
|
|
1790
|
+
null,
|
|
1791
|
+
['PureCloud OAuth'],
|
|
1792
|
+
['application/json'],
|
|
1793
|
+
['application/json']
|
|
1794
|
+
);
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1772
1797
|
/**
|
|
1773
1798
|
* Get messaging campaign's progress
|
|
1774
1799
|
*
|
|
@@ -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 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1426,7 +1426,7 @@ class QualityApi {
|
|
|
1426
1426
|
* @param {String} evaluationId evaluationId
|
|
1427
1427
|
* @param {Object} body evaluation
|
|
1428
1428
|
* @param {Object} opts Optional parameters
|
|
1429
|
-
* @param {String} opts.expand evaluatorId, evaluationForm
|
|
1429
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
1430
1430
|
*/
|
|
1431
1431
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
1432
1432
|
opts = opts || {};
|
|
@@ -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 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -312,7 +312,7 @@ class RecordingApi {
|
|
|
312
312
|
}
|
|
313
313
|
|
|
314
314
|
/**
|
|
315
|
-
* Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if recording:recording:view permission is missing.
|
|
315
|
+
* Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.
|
|
316
316
|
*
|
|
317
317
|
* @param {String} conversationId Conversation ID
|
|
318
318
|
*/
|
|
@@ -5,7 +5,7 @@ class ResponseManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ResponseManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -102,6 +102,7 @@ class ResponseManagementApi {
|
|
|
102
102
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
103
103
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
104
104
|
* @param {Object} opts.messagingTemplateFilter Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel
|
|
105
|
+
* @param {String} opts.libraryPrefix Returns a list of libraries that contain the prefix provided
|
|
105
106
|
*/
|
|
106
107
|
getResponsemanagementLibraries(opts) {
|
|
107
108
|
opts = opts || {};
|
|
@@ -111,7 +112,7 @@ class ResponseManagementApi {
|
|
|
111
112
|
'/api/v2/responsemanagement/libraries',
|
|
112
113
|
'GET',
|
|
113
114
|
{ },
|
|
114
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'] },
|
|
115
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'],'libraryPrefix': opts['libraryPrefix'] },
|
|
115
116
|
{ },
|
|
116
117
|
{ },
|
|
117
118
|
null,
|
|
@@ -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 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1115,6 +1115,7 @@ class RoutingApi {
|
|
|
1115
1115
|
*
|
|
1116
1116
|
* @param {Object} opts Optional parameters
|
|
1117
1117
|
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
1118
|
+
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
1118
1119
|
*/
|
|
1119
1120
|
getRoutingPredictorsKeyperformanceindicators(opts) {
|
|
1120
1121
|
opts = opts || {};
|
|
@@ -1124,7 +1125,7 @@ class RoutingApi {
|
|
|
1124
1125
|
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
1125
1126
|
'GET',
|
|
1126
1127
|
{ },
|
|
1127
|
-
{ 'kpiGroup': opts['kpiGroup'] },
|
|
1128
|
+
{ 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1128
1129
|
{ },
|
|
1129
1130
|
{ },
|
|
1130
1131
|
null,
|
|
@@ -5,7 +5,7 @@ class StationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Stations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -101,51 +101,6 @@ class StationsApi {
|
|
|
101
101
|
);
|
|
102
102
|
}
|
|
103
103
|
|
|
104
|
-
/**
|
|
105
|
-
* Get an organization's StationSettings
|
|
106
|
-
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
107
|
-
*/
|
|
108
|
-
getStationsSettings() {
|
|
109
|
-
|
|
110
|
-
return this.apiClient.callApi(
|
|
111
|
-
'/api/v2/stations/settings',
|
|
112
|
-
'GET',
|
|
113
|
-
{ },
|
|
114
|
-
{ },
|
|
115
|
-
{ },
|
|
116
|
-
{ },
|
|
117
|
-
null,
|
|
118
|
-
['PureCloud OAuth'],
|
|
119
|
-
['application/json'],
|
|
120
|
-
['application/json']
|
|
121
|
-
);
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* Patch an organization's StationSettings
|
|
126
|
-
* This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
|
|
127
|
-
* @param {Object} body Station settings
|
|
128
|
-
*/
|
|
129
|
-
patchStationsSettings(body) {
|
|
130
|
-
// verify the required parameter 'body' is set
|
|
131
|
-
if (body === undefined || body === null) {
|
|
132
|
-
throw 'Missing the required parameter "body" when calling patchStationsSettings';
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
return this.apiClient.callApi(
|
|
136
|
-
'/api/v2/stations/settings',
|
|
137
|
-
'PATCH',
|
|
138
|
-
{ },
|
|
139
|
-
{ },
|
|
140
|
-
{ },
|
|
141
|
-
{ },
|
|
142
|
-
body,
|
|
143
|
-
['PureCloud OAuth'],
|
|
144
|
-
['application/json'],
|
|
145
|
-
['application/json']
|
|
146
|
-
);
|
|
147
|
-
}
|
|
148
|
-
|
|
149
104
|
}
|
|
150
105
|
|
|
151
106
|
|
|
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TelephonyProvidersEdge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -200,31 +200,6 @@ class TelephonyProvidersEdgeApi {
|
|
|
200
200
|
);
|
|
201
201
|
}
|
|
202
202
|
|
|
203
|
-
/**
|
|
204
|
-
* Delete Outbound Route
|
|
205
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
206
|
-
* @param {String} outboundRouteId Outbound route ID
|
|
207
|
-
*/
|
|
208
|
-
deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
209
|
-
// verify the required parameter 'outboundRouteId' is set
|
|
210
|
-
if (outboundRouteId === undefined || outboundRouteId === null) {
|
|
211
|
-
throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
|
|
212
|
-
}
|
|
213
|
-
|
|
214
|
-
return this.apiClient.callApi(
|
|
215
|
-
'/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
|
|
216
|
-
'DELETE',
|
|
217
|
-
{ 'outboundRouteId': outboundRouteId },
|
|
218
|
-
{ },
|
|
219
|
-
{ },
|
|
220
|
-
{ },
|
|
221
|
-
null,
|
|
222
|
-
['PureCloud OAuth'],
|
|
223
|
-
['application/json'],
|
|
224
|
-
['application/json']
|
|
225
|
-
);
|
|
226
|
-
}
|
|
227
|
-
|
|
228
203
|
/**
|
|
229
204
|
* Delete a Phone by ID
|
|
230
205
|
*
|
|
@@ -2639,31 +2614,6 @@ class TelephonyProvidersEdgeApi {
|
|
|
2639
2614
|
);
|
|
2640
2615
|
}
|
|
2641
2616
|
|
|
2642
|
-
/**
|
|
2643
|
-
* Create outbound rule
|
|
2644
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
|
|
2645
|
-
* @param {Object} body OutboundRoute
|
|
2646
|
-
*/
|
|
2647
|
-
postTelephonyProvidersEdgesOutboundroutes(body) {
|
|
2648
|
-
// verify the required parameter 'body' is set
|
|
2649
|
-
if (body === undefined || body === null) {
|
|
2650
|
-
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
|
|
2651
|
-
}
|
|
2652
|
-
|
|
2653
|
-
return this.apiClient.callApi(
|
|
2654
|
-
'/api/v2/telephony/providers/edges/outboundroutes',
|
|
2655
|
-
'POST',
|
|
2656
|
-
{ },
|
|
2657
|
-
{ },
|
|
2658
|
-
{ },
|
|
2659
|
-
{ },
|
|
2660
|
-
body,
|
|
2661
|
-
['PureCloud OAuth'],
|
|
2662
|
-
['application/json'],
|
|
2663
|
-
['application/json']
|
|
2664
|
-
);
|
|
2665
|
-
}
|
|
2666
|
-
|
|
2667
2617
|
/**
|
|
2668
2618
|
* Reboot a Phone
|
|
2669
2619
|
*
|
|
@@ -3064,36 +3014,6 @@ class TelephonyProvidersEdgeApi {
|
|
|
3064
3014
|
);
|
|
3065
3015
|
}
|
|
3066
3016
|
|
|
3067
|
-
/**
|
|
3068
|
-
* Update outbound route
|
|
3069
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
3070
|
-
* @param {String} outboundRouteId Outbound route ID
|
|
3071
|
-
* @param {Object} body OutboundRoute
|
|
3072
|
-
*/
|
|
3073
|
-
putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
|
|
3074
|
-
// verify the required parameter 'outboundRouteId' is set
|
|
3075
|
-
if (outboundRouteId === undefined || outboundRouteId === null) {
|
|
3076
|
-
throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
|
|
3077
|
-
}
|
|
3078
|
-
// verify the required parameter 'body' is set
|
|
3079
|
-
if (body === undefined || body === null) {
|
|
3080
|
-
throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
|
|
3081
|
-
}
|
|
3082
|
-
|
|
3083
|
-
return this.apiClient.callApi(
|
|
3084
|
-
'/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
|
|
3085
|
-
'PUT',
|
|
3086
|
-
{ 'outboundRouteId': outboundRouteId },
|
|
3087
|
-
{ },
|
|
3088
|
-
{ },
|
|
3089
|
-
{ },
|
|
3090
|
-
body,
|
|
3091
|
-
['PureCloud OAuth'],
|
|
3092
|
-
['application/json'],
|
|
3093
|
-
['application/json']
|
|
3094
|
-
);
|
|
3095
|
-
}
|
|
3096
|
-
|
|
3097
3017
|
/**
|
|
3098
3018
|
* Update a Phone by ID
|
|
3099
3019
|
*
|
|
@@ -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 168.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2928,7 +2928,7 @@ class WorkforceManagementApi {
|
|
|
2928
2928
|
}
|
|
2929
2929
|
|
|
2930
2930
|
/**
|
|
2931
|
-
*
|
|
2931
|
+
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
2932
2932
|
*
|
|
2933
2933
|
* @param {Object} opts Optional parameters
|
|
2934
2934
|
* @param {Object} opts.body body
|