purecloud-platform-client-v2 126.1.0 → 130.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 +305 -79
- package/dist/web-amd/purecloud-platform-client-v2.js +305 -79
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +305 -79
- package/dist/web-cjs/purecloud-platform-client-v2.js +305 -79
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +411 -215
- 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 +5 -3
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- 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 +121 -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 +30 -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/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/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +14 -10
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -4
- 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 +21 -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 +21 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +28 -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 +2 -2
- 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 +1 -1
- 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 130.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': '130.0.0' });
|
|
954
954
|
|
|
955
955
|
// set request timeout
|
|
956
956
|
request.timeout(that.timeout);
|
|
@@ -5,7 +5,7 @@ class CoachingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Coaching service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 130.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -204,6 +204,7 @@ class CoachingApi {
|
|
|
204
204
|
* @param {Array.<String>} opts.relationships Relationships to filter by
|
|
205
205
|
* @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
206
206
|
* @param {Object} opts.overdue Overdue status to filter by
|
|
207
|
+
* @param {Object} opts.intervalCondition Filter condition for interval
|
|
207
208
|
*/
|
|
208
209
|
getCoachingAppointments(userIds, opts) {
|
|
209
210
|
opts = opts || {};
|
|
@@ -217,7 +218,7 @@ class CoachingApi {
|
|
|
217
218
|
'/api/v2/coaching/appointments',
|
|
218
219
|
'GET',
|
|
219
220
|
{ },
|
|
220
|
-
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
|
|
221
|
+
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
|
|
221
222
|
{ },
|
|
222
223
|
{ },
|
|
223
224
|
null,
|
|
@@ -240,6 +241,7 @@ class CoachingApi {
|
|
|
240
241
|
* @param {Array.<String>} opts.relationships Relationships to filter by
|
|
241
242
|
* @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
242
243
|
* @param {Object} opts.overdue Overdue status to filter by
|
|
244
|
+
* @param {Object} opts.intervalCondition Filter condition for interval
|
|
243
245
|
*/
|
|
244
246
|
getCoachingAppointmentsMe(opts) {
|
|
245
247
|
opts = opts || {};
|
|
@@ -249,7 +251,7 @@ class CoachingApi {
|
|
|
249
251
|
'/api/v2/coaching/appointments/me',
|
|
250
252
|
'GET',
|
|
251
253
|
{ },
|
|
252
|
-
{ 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
|
|
254
|
+
{ 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
|
|
253
255
|
{ },
|
|
254
256
|
{ },
|
|
255
257
|
null,
|
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 130.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -273,6 +273,31 @@ class GamificationApi {
|
|
|
273
273
|
);
|
|
274
274
|
}
|
|
275
275
|
|
|
276
|
+
/**
|
|
277
|
+
* Members of a given performance profile
|
|
278
|
+
*
|
|
279
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
280
|
+
*/
|
|
281
|
+
getGamificationProfileMembers(performanceProfileId) {
|
|
282
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
283
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
284
|
+
throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
return this.apiClient.callApi(
|
|
288
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members',
|
|
289
|
+
'GET',
|
|
290
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
291
|
+
{ },
|
|
292
|
+
{ },
|
|
293
|
+
{ },
|
|
294
|
+
null,
|
|
295
|
+
['PureCloud OAuth'],
|
|
296
|
+
['application/json'],
|
|
297
|
+
['application/json']
|
|
298
|
+
);
|
|
299
|
+
}
|
|
300
|
+
|
|
276
301
|
/**
|
|
277
302
|
* Performance profile gamified metric by id
|
|
278
303
|
*
|
|
@@ -1127,6 +1152,101 @@ class GamificationApi {
|
|
|
1127
1152
|
);
|
|
1128
1153
|
}
|
|
1129
1154
|
|
|
1155
|
+
/**
|
|
1156
|
+
* Assign members to a given performance profile
|
|
1157
|
+
*
|
|
1158
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
1159
|
+
* @param {Object} body assignUsers
|
|
1160
|
+
*/
|
|
1161
|
+
postGamificationProfileMembers(performanceProfileId, body) {
|
|
1162
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
1163
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
1164
|
+
throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
|
|
1165
|
+
}
|
|
1166
|
+
// verify the required parameter 'body' is set
|
|
1167
|
+
if (body === undefined || body === null) {
|
|
1168
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMembers';
|
|
1169
|
+
}
|
|
1170
|
+
|
|
1171
|
+
return this.apiClient.callApi(
|
|
1172
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members',
|
|
1173
|
+
'POST',
|
|
1174
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
1175
|
+
{ },
|
|
1176
|
+
{ },
|
|
1177
|
+
{ },
|
|
1178
|
+
body,
|
|
1179
|
+
['PureCloud OAuth'],
|
|
1180
|
+
['application/json'],
|
|
1181
|
+
['application/json']
|
|
1182
|
+
);
|
|
1183
|
+
}
|
|
1184
|
+
|
|
1185
|
+
/**
|
|
1186
|
+
* Validate member assignment
|
|
1187
|
+
*
|
|
1188
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
1189
|
+
* @param {Object} body memberAssignments
|
|
1190
|
+
*/
|
|
1191
|
+
postGamificationProfileMembersValidate(performanceProfileId, body) {
|
|
1192
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
1193
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
1194
|
+
throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
|
|
1195
|
+
}
|
|
1196
|
+
// verify the required parameter 'body' is set
|
|
1197
|
+
if (body === undefined || body === null) {
|
|
1198
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1201
|
+
return this.apiClient.callApi(
|
|
1202
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
|
|
1203
|
+
'POST',
|
|
1204
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
1205
|
+
{ },
|
|
1206
|
+
{ },
|
|
1207
|
+
{ },
|
|
1208
|
+
body,
|
|
1209
|
+
['PureCloud OAuth'],
|
|
1210
|
+
['application/json'],
|
|
1211
|
+
['application/json']
|
|
1212
|
+
);
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* Creates a linked metric
|
|
1217
|
+
*
|
|
1218
|
+
* @param {String} sourceProfileId Source Performance Profile Id
|
|
1219
|
+
* @param {String} sourceMetricId Source Metric Id
|
|
1220
|
+
* @param {Object} body linkedMetric
|
|
1221
|
+
*/
|
|
1222
|
+
postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) {
|
|
1223
|
+
// verify the required parameter 'sourceProfileId' is set
|
|
1224
|
+
if (sourceProfileId === undefined || sourceProfileId === null) {
|
|
1225
|
+
throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
|
|
1226
|
+
}
|
|
1227
|
+
// verify the required parameter 'sourceMetricId' is set
|
|
1228
|
+
if (sourceMetricId === undefined || sourceMetricId === null) {
|
|
1229
|
+
throw 'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';
|
|
1230
|
+
}
|
|
1231
|
+
// verify the required parameter 'body' is set
|
|
1232
|
+
if (body === undefined || body === null) {
|
|
1233
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMetricLink';
|
|
1234
|
+
}
|
|
1235
|
+
|
|
1236
|
+
return this.apiClient.callApi(
|
|
1237
|
+
'/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link',
|
|
1238
|
+
'POST',
|
|
1239
|
+
{ 'sourceProfileId': sourceProfileId,'sourceMetricId': sourceMetricId },
|
|
1240
|
+
{ },
|
|
1241
|
+
{ },
|
|
1242
|
+
{ },
|
|
1243
|
+
body,
|
|
1244
|
+
['PureCloud OAuth'],
|
|
1245
|
+
['application/json'],
|
|
1246
|
+
['application/json']
|
|
1247
|
+
);
|
|
1248
|
+
}
|
|
1249
|
+
|
|
1130
1250
|
/**
|
|
1131
1251
|
* Creates a gamified metric with a given metric definition and metric objective under in a performance profile
|
|
1132
1252
|
*
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 130.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -662,6 +662,35 @@ class IntegrationsApi {
|
|
|
662
662
|
);
|
|
663
663
|
}
|
|
664
664
|
|
|
665
|
+
/**
|
|
666
|
+
* UC integration client application configuration.
|
|
667
|
+
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
668
|
+
* @param {Object} opts Optional parameters
|
|
669
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
670
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
671
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
672
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
673
|
+
* @param {String} opts.nextPage next page token
|
|
674
|
+
* @param {String} opts.previousPage Previous page token
|
|
675
|
+
*/
|
|
676
|
+
getIntegrationsClientappsUnifiedcommunications(opts) {
|
|
677
|
+
opts = opts || {};
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
return this.apiClient.callApi(
|
|
681
|
+
'/api/v2/integrations/clientapps/unifiedcommunications',
|
|
682
|
+
'GET',
|
|
683
|
+
{ },
|
|
684
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
|
|
685
|
+
{ },
|
|
686
|
+
{ },
|
|
687
|
+
null,
|
|
688
|
+
['PureCloud OAuth'],
|
|
689
|
+
['application/json'],
|
|
690
|
+
['application/json']
|
|
691
|
+
);
|
|
692
|
+
}
|
|
693
|
+
|
|
665
694
|
/**
|
|
666
695
|
* Get a single credential with sensitive fields redacted
|
|
667
696
|
*
|