purecloud-platform-client-v2 190.0.0 → 192.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 +654 -173
- package/dist/web-amd/purecloud-platform-client-v2.js +654 -173
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +419 -288
- package/dist/web-cjs/purecloud-platform-client-v2.js +467 -323
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +846 -290
- 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 +162 -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 +13 -5
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +127 -39
- 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 +50 -16
- 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/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +45 -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/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +3 -2
- 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 +22 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -2
- 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/LogCaptureApi.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/OperationalEventsApi.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 +4 -3
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
- 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/TaskManagementApi.js +79 -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 -22
- 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 +11 -6
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -5
- 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 +5 -3
- 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
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2728,8 +2728,8 @@ class OutboundApi {
|
|
|
2728
2728
|
}
|
|
2729
2729
|
|
|
2730
2730
|
/**
|
|
2731
|
-
* Retrieves audits for dialer.
|
|
2732
|
-
*
|
|
2731
|
+
* Retrieves audits for dialer. (Deprecated)
|
|
2732
|
+
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
2733
2733
|
* @param {Object} body AuditSearch
|
|
2734
2734
|
* @param {Object} opts Optional parameters
|
|
2735
2735
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -2737,6 +2737,7 @@ class OutboundApi {
|
|
|
2737
2737
|
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
2738
2738
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
2739
2739
|
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
2740
|
+
* @deprecated
|
|
2740
2741
|
*/
|
|
2741
2742
|
postOutboundAudits(body, opts) {
|
|
2742
2743
|
opts = opts || {};
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -341,7 +341,7 @@ class QualityApi {
|
|
|
341
341
|
|
|
342
342
|
/**
|
|
343
343
|
* Get the list of calibrations
|
|
344
|
-
*
|
|
344
|
+
* NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.
|
|
345
345
|
* @param {String} calibratorId user id of calibrator
|
|
346
346
|
* @param {Object} opts Optional parameters
|
|
347
347
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -493,7 +493,7 @@ class QualityApi {
|
|
|
493
493
|
|
|
494
494
|
/**
|
|
495
495
|
* Queries Evaluations and returns a paged list
|
|
496
|
-
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
496
|
+
* Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch.
|
|
497
497
|
* @param {Object} opts Optional parameters
|
|
498
498
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
499
499
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -891,10 +891,11 @@ class RecordingApi {
|
|
|
891
891
|
|
|
892
892
|
/**
|
|
893
893
|
* Retrieves a paged listing of screen recording sessions
|
|
894
|
-
*
|
|
894
|
+
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
895
895
|
* @param {Object} opts Optional parameters
|
|
896
896
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
897
897
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
898
|
+
* @deprecated
|
|
898
899
|
*/
|
|
899
900
|
getRecordingsScreensessions(opts) {
|
|
900
901
|
opts = opts || {};
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -282,6 +282,31 @@ class ResponseManagementApi {
|
|
|
282
282
|
);
|
|
283
283
|
}
|
|
284
284
|
|
|
285
|
+
/**
|
|
286
|
+
* Get response libraries.
|
|
287
|
+
*
|
|
288
|
+
* @param {Object} body LibraryIDs (max allowed 50)
|
|
289
|
+
*/
|
|
290
|
+
postResponsemanagementLibrariesBulk(body) {
|
|
291
|
+
// verify the required parameter 'body' is set
|
|
292
|
+
if (body === undefined || body === null) {
|
|
293
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementLibrariesBulk';
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
return this.apiClient.callApi(
|
|
297
|
+
'/api/v2/responsemanagement/libraries/bulk',
|
|
298
|
+
'POST',
|
|
299
|
+
{ },
|
|
300
|
+
{ },
|
|
301
|
+
{ },
|
|
302
|
+
{ },
|
|
303
|
+
body,
|
|
304
|
+
['PureCloud OAuth'],
|
|
305
|
+
['application/json'],
|
|
306
|
+
['application/json']
|
|
307
|
+
);
|
|
308
|
+
}
|
|
309
|
+
|
|
285
310
|
/**
|
|
286
311
|
* Search response assets
|
|
287
312
|
*
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3410,6 +3410,32 @@ class RoutingApi {
|
|
|
3410
3410
|
);
|
|
3411
3411
|
}
|
|
3412
3412
|
|
|
3413
|
+
/**
|
|
3414
|
+
* Provision an alphanumeric number for SMS
|
|
3415
|
+
*
|
|
3416
|
+
* @param {Object} body SmsPhoneNumber
|
|
3417
|
+
* postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3418
|
+
*/
|
|
3419
|
+
postRoutingSmsPhonenumbersAlphanumeric(body) {
|
|
3420
|
+
// verify the required parameter 'body' is set
|
|
3421
|
+
if (body === undefined || body === null) {
|
|
3422
|
+
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersAlphanumeric';
|
|
3423
|
+
}
|
|
3424
|
+
|
|
3425
|
+
return this.apiClient.callApi(
|
|
3426
|
+
'/api/v2/routing/sms/phonenumbers/alphanumeric',
|
|
3427
|
+
'POST',
|
|
3428
|
+
{ },
|
|
3429
|
+
{ },
|
|
3430
|
+
{ },
|
|
3431
|
+
{ },
|
|
3432
|
+
body,
|
|
3433
|
+
['PureCloud OAuth'],
|
|
3434
|
+
['application/json'],
|
|
3435
|
+
['application/json']
|
|
3436
|
+
);
|
|
3437
|
+
}
|
|
3438
|
+
|
|
3413
3439
|
/**
|
|
3414
3440
|
* Imports a phone number for SMS
|
|
3415
3441
|
*
|
|
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SpeechTextAnalytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -595,7 +595,7 @@ class SpeechTextAnalyticsApi {
|
|
|
595
595
|
*
|
|
596
596
|
* @param {Object} opts Optional parameters
|
|
597
597
|
* @param {String} opts.nextPage The key for listing the next page
|
|
598
|
-
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
598
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
|
|
599
599
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
600
600
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
601
601
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
@@ -5,7 +5,7 @@ class TaskManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TaskManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -472,6 +472,58 @@ class TaskManagementApi {
|
|
|
472
472
|
);
|
|
473
473
|
}
|
|
474
474
|
|
|
475
|
+
/**
|
|
476
|
+
* Get the workitem query job associated with the job id.
|
|
477
|
+
*
|
|
478
|
+
* @param {String} jobId jobId
|
|
479
|
+
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
480
|
+
*/
|
|
481
|
+
getTaskmanagementWorkitemsQueryJob(jobId) {
|
|
482
|
+
// verify the required parameter 'jobId' is set
|
|
483
|
+
if (jobId === undefined || jobId === null) {
|
|
484
|
+
throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJob';
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
return this.apiClient.callApi(
|
|
488
|
+
'/api/v2/taskmanagement/workitems/query/jobs/{jobId}',
|
|
489
|
+
'GET',
|
|
490
|
+
{ 'jobId': jobId },
|
|
491
|
+
{ },
|
|
492
|
+
{ },
|
|
493
|
+
{ },
|
|
494
|
+
null,
|
|
495
|
+
['PureCloud OAuth'],
|
|
496
|
+
['application/json'],
|
|
497
|
+
['application/json']
|
|
498
|
+
);
|
|
499
|
+
}
|
|
500
|
+
|
|
501
|
+
/**
|
|
502
|
+
* Get results from for workitem query job
|
|
503
|
+
*
|
|
504
|
+
* @param {String} jobId jobId
|
|
505
|
+
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
506
|
+
*/
|
|
507
|
+
getTaskmanagementWorkitemsQueryJobResults(jobId) {
|
|
508
|
+
// verify the required parameter 'jobId' is set
|
|
509
|
+
if (jobId === undefined || jobId === null) {
|
|
510
|
+
throw 'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJobResults';
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
return this.apiClient.callApi(
|
|
514
|
+
'/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results',
|
|
515
|
+
'GET',
|
|
516
|
+
{ 'jobId': jobId },
|
|
517
|
+
{ },
|
|
518
|
+
{ },
|
|
519
|
+
{ },
|
|
520
|
+
null,
|
|
521
|
+
['PureCloud OAuth'],
|
|
522
|
+
['application/json'],
|
|
523
|
+
['application/json']
|
|
524
|
+
);
|
|
525
|
+
}
|
|
526
|
+
|
|
475
527
|
/**
|
|
476
528
|
* Get a schema
|
|
477
529
|
*
|
|
@@ -1168,6 +1220,32 @@ class TaskManagementApi {
|
|
|
1168
1220
|
);
|
|
1169
1221
|
}
|
|
1170
1222
|
|
|
1223
|
+
/**
|
|
1224
|
+
* Create a workitem query job
|
|
1225
|
+
*
|
|
1226
|
+
* @param {Object} body WorkitemQueryJobCreate
|
|
1227
|
+
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1228
|
+
*/
|
|
1229
|
+
postTaskmanagementWorkitemsQueryJobs(body) {
|
|
1230
|
+
// verify the required parameter 'body' is set
|
|
1231
|
+
if (body === undefined || body === null) {
|
|
1232
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQueryJobs';
|
|
1233
|
+
}
|
|
1234
|
+
|
|
1235
|
+
return this.apiClient.callApi(
|
|
1236
|
+
'/api/v2/taskmanagement/workitems/query/jobs',
|
|
1237
|
+
'POST',
|
|
1238
|
+
{ },
|
|
1239
|
+
{ },
|
|
1240
|
+
{ },
|
|
1241
|
+
{ },
|
|
1242
|
+
body,
|
|
1243
|
+
['PureCloud OAuth'],
|
|
1244
|
+
['application/json'],
|
|
1245
|
+
['application/json']
|
|
1246
|
+
);
|
|
1247
|
+
}
|
|
1248
|
+
|
|
1171
1249
|
/**
|
|
1172
1250
|
* Create a schema
|
|
1173
1251
|
*
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -772,27 +772,6 @@ class TelephonyProvidersEdgeApi {
|
|
|
772
772
|
);
|
|
773
773
|
}
|
|
774
774
|
|
|
775
|
-
/**
|
|
776
|
-
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
777
|
-
*
|
|
778
|
-
* @deprecated
|
|
779
|
-
*/
|
|
780
|
-
getTelephonyProvidersEdgesAvailablelanguages() {
|
|
781
|
-
|
|
782
|
-
return this.apiClient.callApi(
|
|
783
|
-
'/api/v2/telephony/providers/edges/availablelanguages',
|
|
784
|
-
'GET',
|
|
785
|
-
{ },
|
|
786
|
-
{ },
|
|
787
|
-
{ },
|
|
788
|
-
{ },
|
|
789
|
-
null,
|
|
790
|
-
['PureCloud OAuth'],
|
|
791
|
-
['application/json'],
|
|
792
|
-
['application/json']
|
|
793
|
-
);
|
|
794
|
-
}
|
|
795
|
-
|
|
796
775
|
/**
|
|
797
776
|
* Get the list of certificate authorities.
|
|
798
777
|
*
|
|
@@ -5,7 +5,7 @@ class UsageApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Usage service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -105,11 +105,16 @@ class UsageApi {
|
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
* Get the results of a usage search
|
|
108
|
+
* Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
|
|
109
109
|
*
|
|
110
110
|
* @param {String} executionId ID of the search execution
|
|
111
|
+
* @param {Object} opts Optional parameters
|
|
112
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned
|
|
113
|
+
* @param {Number} opts.pageSize The max number of entities to be returned per request. Maximum page size of 1000
|
|
111
114
|
*/
|
|
112
|
-
getUsageSimplesearchExecutionIdResults(executionId) {
|
|
115
|
+
getUsageSimplesearchExecutionIdResults(executionId, opts) {
|
|
116
|
+
opts = opts || {};
|
|
117
|
+
|
|
113
118
|
// verify the required parameter 'executionId' is set
|
|
114
119
|
if (executionId === undefined || executionId === null) {
|
|
115
120
|
throw 'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';
|
|
@@ -119,7 +124,7 @@ class UsageApi {
|
|
|
119
124
|
'/api/v2/usage/simplesearch/{executionId}/results',
|
|
120
125
|
'GET',
|
|
121
126
|
{ 'executionId': executionId },
|
|
122
|
-
{
|
|
127
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
123
128
|
{ },
|
|
124
129
|
{ },
|
|
125
130
|
null,
|
|
@@ -185,8 +190,8 @@ class UsageApi {
|
|
|
185
190
|
}
|
|
186
191
|
|
|
187
192
|
/**
|
|
188
|
-
* Search organization API Usage
|
|
189
|
-
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
193
|
+
* Search organization API Usage
|
|
194
|
+
* After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results
|
|
190
195
|
* @param {Object} body SimpleSearch
|
|
191
196
|
*/
|
|
192
197
|
postUsageSimplesearch(body) {
|
|
@@ -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 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -501,8 +501,12 @@ class UsersApi {
|
|
|
501
501
|
* Returns a listing of roles and permissions for a user.
|
|
502
502
|
*
|
|
503
503
|
* @param {String} subjectId Subject ID (user or group)
|
|
504
|
+
* @param {Object} opts Optional parameters
|
|
505
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
504
506
|
*/
|
|
505
|
-
getAuthorizationSubject(subjectId) {
|
|
507
|
+
getAuthorizationSubject(subjectId, opts) {
|
|
508
|
+
opts = opts || {};
|
|
509
|
+
|
|
506
510
|
// verify the required parameter 'subjectId' is set
|
|
507
511
|
if (subjectId === undefined || subjectId === null) {
|
|
508
512
|
throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
|
|
@@ -512,7 +516,7 @@ class UsersApi {
|
|
|
512
516
|
'/api/v2/authorization/subjects/{subjectId}',
|
|
513
517
|
'GET',
|
|
514
518
|
{ 'subjectId': subjectId },
|
|
515
|
-
{
|
|
519
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
516
520
|
{ },
|
|
517
521
|
{ },
|
|
518
522
|
null,
|
|
@@ -525,14 +529,18 @@ class UsersApi {
|
|
|
525
529
|
/**
|
|
526
530
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
527
531
|
*
|
|
532
|
+
* @param {Object} opts Optional parameters
|
|
533
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
528
534
|
*/
|
|
529
|
-
getAuthorizationSubjectsMe() {
|
|
535
|
+
getAuthorizationSubjectsMe(opts) {
|
|
536
|
+
opts = opts || {};
|
|
537
|
+
|
|
530
538
|
|
|
531
539
|
return this.apiClient.callApi(
|
|
532
540
|
'/api/v2/authorization/subjects/me',
|
|
533
541
|
'GET',
|
|
534
542
|
{ },
|
|
535
|
-
{
|
|
543
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
536
544
|
{ },
|
|
537
545
|
{ },
|
|
538
546
|
null,
|
|
@@ -5,7 +5,7 @@ class WebChatApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WebChat service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 192.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -145,9 +145,10 @@ class WebChatApi {
|
|
|
145
145
|
|
|
146
146
|
/**
|
|
147
147
|
* Get a media request in the conversation
|
|
148
|
-
*
|
|
148
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
149
149
|
* @param {String} conversationId conversationId
|
|
150
150
|
* @param {String} mediaRequestId mediaRequestId
|
|
151
|
+
* @deprecated
|
|
151
152
|
*/
|
|
152
153
|
getWebchatGuestConversationMediarequest(conversationId, mediaRequestId) {
|
|
153
154
|
// verify the required parameter 'conversationId' is set
|
|
@@ -343,10 +344,11 @@ class WebChatApi {
|
|
|
343
344
|
|
|
344
345
|
/**
|
|
345
346
|
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
346
|
-
*
|
|
347
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
347
348
|
* @param {String} conversationId conversationId
|
|
348
349
|
* @param {String} mediaRequestId mediaRequestId
|
|
349
350
|
* @param {Object} body Request
|
|
351
|
+
* @deprecated
|
|
350
352
|
*/
|
|
351
353
|
patchWebchatGuestConversationMediarequest(conversationId, mediaRequestId, body) {
|
|
352
354
|
// verify the required parameter 'conversationId' is set
|