purecloud-platform-client-v2 192.1.0 → 193.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 +191 -467
- package/dist/web-amd/purecloud-platform-client-v2.js +191 -467
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +193 -278
- package/dist/web-cjs/purecloud-platform-client-v2.js +193 -278
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +583 -602
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +3 -0
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +40 -346
- 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/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +48 -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 +1 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -2
- 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 +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/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 +21 -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/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +3 -3
- 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 -2
- 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 +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/TaskManagementApi.js +1 -38
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -2
- 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 +1 -2
- 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 +5 -3
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -21,6 +21,9 @@ var PureCloudRegionHosts = {
|
|
|
21
21
|
ap_south_1: 'aps1.pure.cloud',
|
|
22
22
|
us_east_2: 'use2.us-gov-pure.cloud',
|
|
23
23
|
sa_east_1: 'sae1.pure.cloud',
|
|
24
|
+
me_central_1: 'mec1.pure.cloud',
|
|
25
|
+
ap_northeast_3: 'apne3.pure.cloud',
|
|
26
|
+
eu_central_2: 'euc2.pure.cloud',
|
|
24
27
|
};
|
|
25
28
|
|
|
26
29
|
const logLevels = {
|
|
@@ -402,7 +405,7 @@ class Configuration {
|
|
|
402
405
|
|
|
403
406
|
/**
|
|
404
407
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
408
|
+
* @version 193.0.0
|
|
406
409
|
*/
|
|
407
410
|
class ApiClient {
|
|
408
411
|
/**
|
|
@@ -1821,7 +1824,7 @@ class AlertingApi {
|
|
|
1821
1824
|
/**
|
|
1822
1825
|
* Alerting service.
|
|
1823
1826
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1824
|
-
* @version
|
|
1827
|
+
* @version 193.0.0
|
|
1825
1828
|
*/
|
|
1826
1829
|
|
|
1827
1830
|
/**
|
|
@@ -2482,7 +2485,7 @@ class AnalyticsApi {
|
|
|
2482
2485
|
/**
|
|
2483
2486
|
* Analytics service.
|
|
2484
2487
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2485
|
-
* @version
|
|
2488
|
+
* @version 193.0.0
|
|
2486
2489
|
*/
|
|
2487
2490
|
|
|
2488
2491
|
/**
|
|
@@ -2522,31 +2525,6 @@ class AnalyticsApi {
|
|
|
2522
2525
|
);
|
|
2523
2526
|
}
|
|
2524
2527
|
|
|
2525
|
-
/**
|
|
2526
|
-
* Delete a scheduled report job.
|
|
2527
|
-
*
|
|
2528
|
-
* @param {String} scheduleId Schedule ID
|
|
2529
|
-
*/
|
|
2530
|
-
deleteAnalyticsReportingSchedule(scheduleId) {
|
|
2531
|
-
// verify the required parameter 'scheduleId' is set
|
|
2532
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
2533
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteAnalyticsReportingSchedule';
|
|
2534
|
-
}
|
|
2535
|
-
|
|
2536
|
-
return this.apiClient.callApi(
|
|
2537
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
2538
|
-
'DELETE',
|
|
2539
|
-
{ 'scheduleId': scheduleId },
|
|
2540
|
-
{ },
|
|
2541
|
-
{ },
|
|
2542
|
-
{ },
|
|
2543
|
-
null,
|
|
2544
|
-
['PureCloud OAuth'],
|
|
2545
|
-
['application/json'],
|
|
2546
|
-
['application/json']
|
|
2547
|
-
);
|
|
2548
|
-
}
|
|
2549
|
-
|
|
2550
2528
|
/**
|
|
2551
2529
|
* Delete/cancel an async request
|
|
2552
2530
|
*
|
|
@@ -2628,9 +2606,44 @@ class AnalyticsApi {
|
|
|
2628
2606
|
);
|
|
2629
2607
|
}
|
|
2630
2608
|
|
|
2609
|
+
/**
|
|
2610
|
+
* Get Reporting Turns (division aware).
|
|
2611
|
+
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
2612
|
+
* @param {String} botFlowId ID of the bot flow.
|
|
2613
|
+
* @param {Object} opts Optional parameters
|
|
2614
|
+
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
2615
|
+
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
2616
|
+
* @param {String} opts.interval Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
2617
|
+
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
2618
|
+
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
2619
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
2620
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
2621
|
+
*/
|
|
2622
|
+
getAnalyticsBotflowDivisionsReportingturns(botFlowId, opts) {
|
|
2623
|
+
opts = opts || {};
|
|
2624
|
+
|
|
2625
|
+
// verify the required parameter 'botFlowId' is set
|
|
2626
|
+
if (botFlowId === undefined || botFlowId === null) {
|
|
2627
|
+
throw 'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowDivisionsReportingturns';
|
|
2628
|
+
}
|
|
2629
|
+
|
|
2630
|
+
return this.apiClient.callApi(
|
|
2631
|
+
'/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns',
|
|
2632
|
+
'GET',
|
|
2633
|
+
{ 'botFlowId': botFlowId },
|
|
2634
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
2635
|
+
{ },
|
|
2636
|
+
{ },
|
|
2637
|
+
null,
|
|
2638
|
+
['PureCloud OAuth'],
|
|
2639
|
+
['application/json'],
|
|
2640
|
+
['application/json']
|
|
2641
|
+
);
|
|
2642
|
+
}
|
|
2643
|
+
|
|
2631
2644
|
/**
|
|
2632
2645
|
* Get Reporting Turns.
|
|
2633
|
-
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
2646
|
+
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
2634
2647
|
* @param {String} botFlowId ID of the bot flow.
|
|
2635
2648
|
* @param {Object} opts Optional parameters
|
|
2636
2649
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -2640,6 +2653,7 @@ class AnalyticsApi {
|
|
|
2640
2653
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
2641
2654
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
2642
2655
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
2656
|
+
* @deprecated
|
|
2643
2657
|
*/
|
|
2644
2658
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
2645
2659
|
opts = opts || {};
|
|
@@ -3330,216 +3344,6 @@ class AnalyticsApi {
|
|
|
3330
3344
|
);
|
|
3331
3345
|
}
|
|
3332
3346
|
|
|
3333
|
-
/**
|
|
3334
|
-
* Get list of reporting metadata.
|
|
3335
|
-
*
|
|
3336
|
-
* @param {Object} opts Optional parameters
|
|
3337
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3338
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3339
|
-
* @param {String} opts.locale Locale
|
|
3340
|
-
*/
|
|
3341
|
-
getAnalyticsReportingMetadata(opts) {
|
|
3342
|
-
opts = opts || {};
|
|
3343
|
-
|
|
3344
|
-
|
|
3345
|
-
return this.apiClient.callApi(
|
|
3346
|
-
'/api/v2/analytics/reporting/metadata',
|
|
3347
|
-
'GET',
|
|
3348
|
-
{ },
|
|
3349
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'locale': opts['locale'] },
|
|
3350
|
-
{ },
|
|
3351
|
-
{ },
|
|
3352
|
-
null,
|
|
3353
|
-
['PureCloud OAuth'],
|
|
3354
|
-
['application/json'],
|
|
3355
|
-
['application/json']
|
|
3356
|
-
);
|
|
3357
|
-
}
|
|
3358
|
-
|
|
3359
|
-
/**
|
|
3360
|
-
* Get a reporting metadata.
|
|
3361
|
-
*
|
|
3362
|
-
* @param {String} reportId Report ID
|
|
3363
|
-
* @param {Object} opts Optional parameters
|
|
3364
|
-
* @param {String} opts.locale Locale
|
|
3365
|
-
*/
|
|
3366
|
-
getAnalyticsReportingReportIdMetadata(reportId, opts) {
|
|
3367
|
-
opts = opts || {};
|
|
3368
|
-
|
|
3369
|
-
// verify the required parameter 'reportId' is set
|
|
3370
|
-
if (reportId === undefined || reportId === null) {
|
|
3371
|
-
throw 'Missing the required parameter "reportId" when calling getAnalyticsReportingReportIdMetadata';
|
|
3372
|
-
}
|
|
3373
|
-
|
|
3374
|
-
return this.apiClient.callApi(
|
|
3375
|
-
'/api/v2/analytics/reporting/{reportId}/metadata',
|
|
3376
|
-
'GET',
|
|
3377
|
-
{ 'reportId': reportId },
|
|
3378
|
-
{ 'locale': opts['locale'] },
|
|
3379
|
-
{ },
|
|
3380
|
-
{ },
|
|
3381
|
-
null,
|
|
3382
|
-
['PureCloud OAuth'],
|
|
3383
|
-
['application/json'],
|
|
3384
|
-
['application/json']
|
|
3385
|
-
);
|
|
3386
|
-
}
|
|
3387
|
-
|
|
3388
|
-
/**
|
|
3389
|
-
* Get a list of report formats
|
|
3390
|
-
* Get a list of report formats.
|
|
3391
|
-
*/
|
|
3392
|
-
getAnalyticsReportingReportformats() {
|
|
3393
|
-
|
|
3394
|
-
return this.apiClient.callApi(
|
|
3395
|
-
'/api/v2/analytics/reporting/reportformats',
|
|
3396
|
-
'GET',
|
|
3397
|
-
{ },
|
|
3398
|
-
{ },
|
|
3399
|
-
{ },
|
|
3400
|
-
{ },
|
|
3401
|
-
null,
|
|
3402
|
-
['PureCloud OAuth'],
|
|
3403
|
-
['application/json'],
|
|
3404
|
-
['application/json']
|
|
3405
|
-
);
|
|
3406
|
-
}
|
|
3407
|
-
|
|
3408
|
-
/**
|
|
3409
|
-
* Get a scheduled report job.
|
|
3410
|
-
*
|
|
3411
|
-
* @param {String} scheduleId Schedule ID
|
|
3412
|
-
*/
|
|
3413
|
-
getAnalyticsReportingSchedule(scheduleId) {
|
|
3414
|
-
// verify the required parameter 'scheduleId' is set
|
|
3415
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3416
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingSchedule';
|
|
3417
|
-
}
|
|
3418
|
-
|
|
3419
|
-
return this.apiClient.callApi(
|
|
3420
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
3421
|
-
'GET',
|
|
3422
|
-
{ 'scheduleId': scheduleId },
|
|
3423
|
-
{ },
|
|
3424
|
-
{ },
|
|
3425
|
-
{ },
|
|
3426
|
-
null,
|
|
3427
|
-
['PureCloud OAuth'],
|
|
3428
|
-
['application/json'],
|
|
3429
|
-
['application/json']
|
|
3430
|
-
);
|
|
3431
|
-
}
|
|
3432
|
-
|
|
3433
|
-
/**
|
|
3434
|
-
* Get list of completed scheduled report jobs.
|
|
3435
|
-
*
|
|
3436
|
-
* @param {String} scheduleId Schedule ID
|
|
3437
|
-
* @param {Object} opts Optional parameters
|
|
3438
|
-
* @param {Number} opts.pageNumber (default to 1)
|
|
3439
|
-
* @param {Number} opts.pageSize (default to 25)
|
|
3440
|
-
*/
|
|
3441
|
-
getAnalyticsReportingScheduleHistory(scheduleId, opts) {
|
|
3442
|
-
opts = opts || {};
|
|
3443
|
-
|
|
3444
|
-
// verify the required parameter 'scheduleId' is set
|
|
3445
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3446
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistory';
|
|
3447
|
-
}
|
|
3448
|
-
|
|
3449
|
-
return this.apiClient.callApi(
|
|
3450
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history',
|
|
3451
|
-
'GET',
|
|
3452
|
-
{ 'scheduleId': scheduleId },
|
|
3453
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3454
|
-
{ },
|
|
3455
|
-
{ },
|
|
3456
|
-
null,
|
|
3457
|
-
['PureCloud OAuth'],
|
|
3458
|
-
['application/json'],
|
|
3459
|
-
['application/json']
|
|
3460
|
-
);
|
|
3461
|
-
}
|
|
3462
|
-
|
|
3463
|
-
/**
|
|
3464
|
-
* Get most recently completed scheduled report job.
|
|
3465
|
-
*
|
|
3466
|
-
* @param {String} scheduleId Schedule ID
|
|
3467
|
-
*/
|
|
3468
|
-
getAnalyticsReportingScheduleHistoryLatest(scheduleId) {
|
|
3469
|
-
// verify the required parameter 'scheduleId' is set
|
|
3470
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3471
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryLatest';
|
|
3472
|
-
}
|
|
3473
|
-
|
|
3474
|
-
return this.apiClient.callApi(
|
|
3475
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest',
|
|
3476
|
-
'GET',
|
|
3477
|
-
{ 'scheduleId': scheduleId },
|
|
3478
|
-
{ },
|
|
3479
|
-
{ },
|
|
3480
|
-
{ },
|
|
3481
|
-
null,
|
|
3482
|
-
['PureCloud OAuth'],
|
|
3483
|
-
['application/json'],
|
|
3484
|
-
['application/json']
|
|
3485
|
-
);
|
|
3486
|
-
}
|
|
3487
|
-
|
|
3488
|
-
/**
|
|
3489
|
-
* A completed scheduled report job
|
|
3490
|
-
* A completed scheduled report job.
|
|
3491
|
-
* @param {String} runId Run ID
|
|
3492
|
-
* @param {String} scheduleId Schedule ID
|
|
3493
|
-
*/
|
|
3494
|
-
getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId) {
|
|
3495
|
-
// verify the required parameter 'runId' is set
|
|
3496
|
-
if (runId === undefined || runId === null) {
|
|
3497
|
-
throw 'Missing the required parameter "runId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
3498
|
-
}
|
|
3499
|
-
// verify the required parameter 'scheduleId' is set
|
|
3500
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3501
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
3502
|
-
}
|
|
3503
|
-
|
|
3504
|
-
return this.apiClient.callApi(
|
|
3505
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}',
|
|
3506
|
-
'GET',
|
|
3507
|
-
{ 'runId': runId,'scheduleId': scheduleId },
|
|
3508
|
-
{ },
|
|
3509
|
-
{ },
|
|
3510
|
-
{ },
|
|
3511
|
-
null,
|
|
3512
|
-
['PureCloud OAuth'],
|
|
3513
|
-
['application/json'],
|
|
3514
|
-
['application/json']
|
|
3515
|
-
);
|
|
3516
|
-
}
|
|
3517
|
-
|
|
3518
|
-
/**
|
|
3519
|
-
* Get a list of scheduled report jobs
|
|
3520
|
-
* Get a list of scheduled report jobs.
|
|
3521
|
-
* @param {Object} opts Optional parameters
|
|
3522
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3523
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3524
|
-
*/
|
|
3525
|
-
getAnalyticsReportingSchedules(opts) {
|
|
3526
|
-
opts = opts || {};
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
return this.apiClient.callApi(
|
|
3530
|
-
'/api/v2/analytics/reporting/schedules',
|
|
3531
|
-
'GET',
|
|
3532
|
-
{ },
|
|
3533
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3534
|
-
{ },
|
|
3535
|
-
{ },
|
|
3536
|
-
null,
|
|
3537
|
-
['PureCloud OAuth'],
|
|
3538
|
-
['application/json'],
|
|
3539
|
-
['application/json']
|
|
3540
|
-
);
|
|
3541
|
-
}
|
|
3542
|
-
|
|
3543
3347
|
/**
|
|
3544
3348
|
* Get AnalyticsReportingSettings for an organization
|
|
3545
3349
|
*
|
|
@@ -3570,6 +3374,7 @@ class AnalyticsApi {
|
|
|
3570
3374
|
* @param {Number} opts.pageSize (default to 50)
|
|
3571
3375
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
3572
3376
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
3377
|
+
* @param {String} opts.name retrieve dashboards that match with given name
|
|
3573
3378
|
*/
|
|
3574
3379
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
3575
3380
|
opts = opts || {};
|
|
@@ -3583,27 +3388,7 @@ class AnalyticsApi {
|
|
|
3583
3388
|
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
3584
3389
|
'GET',
|
|
3585
3390
|
{ 'userId': userId },
|
|
3586
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
|
|
3587
|
-
{ },
|
|
3588
|
-
{ },
|
|
3589
|
-
null,
|
|
3590
|
-
['PureCloud OAuth'],
|
|
3591
|
-
['application/json'],
|
|
3592
|
-
['application/json']
|
|
3593
|
-
);
|
|
3594
|
-
}
|
|
3595
|
-
|
|
3596
|
-
/**
|
|
3597
|
-
* Get a list of report time periods.
|
|
3598
|
-
*
|
|
3599
|
-
*/
|
|
3600
|
-
getAnalyticsReportingTimeperiods() {
|
|
3601
|
-
|
|
3602
|
-
return this.apiClient.callApi(
|
|
3603
|
-
'/api/v2/analytics/reporting/timeperiods',
|
|
3604
|
-
'GET',
|
|
3605
|
-
{ },
|
|
3606
|
-
{ },
|
|
3391
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
|
|
3607
3392
|
{ },
|
|
3608
3393
|
{ },
|
|
3609
3394
|
null,
|
|
@@ -4132,7 +3917,6 @@ class AnalyticsApi {
|
|
|
4132
3917
|
* @param {Object} opts Optional parameters
|
|
4133
3918
|
* @param {Number} opts.pageSize The desired page size
|
|
4134
3919
|
* @param {Number} opts.pageNumber The desired page number
|
|
4135
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4136
3920
|
*/
|
|
4137
3921
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
4138
3922
|
opts = opts || {};
|
|
@@ -4391,7 +4175,6 @@ class AnalyticsApi {
|
|
|
4391
4175
|
* @param {Object} opts Optional parameters
|
|
4392
4176
|
* @param {Number} opts.pageSize The desired page size
|
|
4393
4177
|
* @param {Number} opts.pageNumber The desired page number
|
|
4394
|
-
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4395
4178
|
*/
|
|
4396
4179
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
4397
4180
|
opts = opts || {};
|
|
@@ -4693,58 +4476,6 @@ class AnalyticsApi {
|
|
|
4693
4476
|
);
|
|
4694
4477
|
}
|
|
4695
4478
|
|
|
4696
|
-
/**
|
|
4697
|
-
* Place a scheduled report immediately into the reporting queue
|
|
4698
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
4699
|
-
* @param {String} scheduleId Schedule ID
|
|
4700
|
-
* @deprecated
|
|
4701
|
-
*/
|
|
4702
|
-
postAnalyticsReportingScheduleRunreport(scheduleId) {
|
|
4703
|
-
// verify the required parameter 'scheduleId' is set
|
|
4704
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
4705
|
-
throw 'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';
|
|
4706
|
-
}
|
|
4707
|
-
|
|
4708
|
-
return this.apiClient.callApi(
|
|
4709
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/runreport',
|
|
4710
|
-
'POST',
|
|
4711
|
-
{ 'scheduleId': scheduleId },
|
|
4712
|
-
{ },
|
|
4713
|
-
{ },
|
|
4714
|
-
{ },
|
|
4715
|
-
null,
|
|
4716
|
-
['PureCloud OAuth'],
|
|
4717
|
-
['application/json'],
|
|
4718
|
-
['application/json']
|
|
4719
|
-
);
|
|
4720
|
-
}
|
|
4721
|
-
|
|
4722
|
-
/**
|
|
4723
|
-
* Create a scheduled report job
|
|
4724
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
4725
|
-
* @param {Object} body ReportSchedule
|
|
4726
|
-
* @deprecated
|
|
4727
|
-
*/
|
|
4728
|
-
postAnalyticsReportingSchedules(body) {
|
|
4729
|
-
// verify the required parameter 'body' is set
|
|
4730
|
-
if (body === undefined || body === null) {
|
|
4731
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';
|
|
4732
|
-
}
|
|
4733
|
-
|
|
4734
|
-
return this.apiClient.callApi(
|
|
4735
|
-
'/api/v2/analytics/reporting/schedules',
|
|
4736
|
-
'POST',
|
|
4737
|
-
{ },
|
|
4738
|
-
{ },
|
|
4739
|
-
{ },
|
|
4740
|
-
{ },
|
|
4741
|
-
body,
|
|
4742
|
-
['PureCloud OAuth'],
|
|
4743
|
-
['application/json'],
|
|
4744
|
-
['application/json']
|
|
4745
|
-
);
|
|
4746
|
-
}
|
|
4747
|
-
|
|
4748
4479
|
/**
|
|
4749
4480
|
* Bulk remove dashboard configurations
|
|
4750
4481
|
*
|
|
@@ -4828,7 +4559,6 @@ class AnalyticsApi {
|
|
|
4828
4559
|
* @param {Object} opts Optional parameters
|
|
4829
4560
|
* @param {Number} opts.pageSize The desired page size
|
|
4830
4561
|
* @param {Number} opts.pageNumber The desired page number
|
|
4831
|
-
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4832
4562
|
*/
|
|
4833
4563
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
4834
4564
|
opts = opts || {};
|
|
@@ -4962,7 +4692,6 @@ class AnalyticsApi {
|
|
|
4962
4692
|
* @param {Object} opts Optional parameters
|
|
4963
4693
|
* @param {Number} opts.pageSize The desired page size
|
|
4964
4694
|
* @param {Number} opts.pageNumber The desired page number
|
|
4965
|
-
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4966
4695
|
*/
|
|
4967
4696
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
4968
4697
|
opts = opts || {};
|
|
@@ -5044,7 +4773,6 @@ class AnalyticsApi {
|
|
|
5044
4773
|
* @param {Object} opts Optional parameters
|
|
5045
4774
|
* @param {Number} opts.pageSize The desired page size
|
|
5046
4775
|
* @param {Number} opts.pageNumber The desired page number
|
|
5047
|
-
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5048
4776
|
*/
|
|
5049
4777
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
5050
4778
|
opts = opts || {};
|
|
@@ -5219,44 +4947,13 @@ class AnalyticsApi {
|
|
|
5219
4947
|
);
|
|
5220
4948
|
}
|
|
5221
4949
|
|
|
5222
|
-
/**
|
|
5223
|
-
* Update a scheduled report job.
|
|
5224
|
-
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
5225
|
-
* @param {String} scheduleId Schedule ID
|
|
5226
|
-
* @param {Object} body ReportSchedule
|
|
5227
|
-
* @deprecated
|
|
5228
|
-
*/
|
|
5229
|
-
putAnalyticsReportingSchedule(scheduleId, body) {
|
|
5230
|
-
// verify the required parameter 'scheduleId' is set
|
|
5231
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
5232
|
-
throw 'Missing the required parameter "scheduleId" when calling putAnalyticsReportingSchedule';
|
|
5233
|
-
}
|
|
5234
|
-
// verify the required parameter 'body' is set
|
|
5235
|
-
if (body === undefined || body === null) {
|
|
5236
|
-
throw 'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';
|
|
5237
|
-
}
|
|
5238
|
-
|
|
5239
|
-
return this.apiClient.callApi(
|
|
5240
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
5241
|
-
'PUT',
|
|
5242
|
-
{ 'scheduleId': scheduleId },
|
|
5243
|
-
{ },
|
|
5244
|
-
{ },
|
|
5245
|
-
{ },
|
|
5246
|
-
body,
|
|
5247
|
-
['PureCloud OAuth'],
|
|
5248
|
-
['application/json'],
|
|
5249
|
-
['application/json']
|
|
5250
|
-
);
|
|
5251
|
-
}
|
|
5252
|
-
|
|
5253
4950
|
}
|
|
5254
4951
|
|
|
5255
4952
|
class ArchitectApi {
|
|
5256
4953
|
/**
|
|
5257
4954
|
* Architect service.
|
|
5258
4955
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5259
|
-
* @version
|
|
4956
|
+
* @version 193.0.0
|
|
5260
4957
|
*/
|
|
5261
4958
|
|
|
5262
4959
|
/**
|
|
@@ -9402,7 +9099,7 @@ class AuditApi {
|
|
|
9402
9099
|
/**
|
|
9403
9100
|
* Audit service.
|
|
9404
9101
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9405
|
-
* @version
|
|
9102
|
+
* @version 193.0.0
|
|
9406
9103
|
*/
|
|
9407
9104
|
|
|
9408
9105
|
/**
|
|
@@ -9573,7 +9270,7 @@ class AuthorizationApi {
|
|
|
9573
9270
|
/**
|
|
9574
9271
|
* Authorization service.
|
|
9575
9272
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9576
|
-
* @version
|
|
9273
|
+
* @version 193.0.0
|
|
9577
9274
|
*/
|
|
9578
9275
|
|
|
9579
9276
|
/**
|
|
@@ -10811,7 +10508,7 @@ class BillingApi {
|
|
|
10811
10508
|
/**
|
|
10812
10509
|
* Billing service.
|
|
10813
10510
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10814
|
-
* @version
|
|
10511
|
+
* @version 193.0.0
|
|
10815
10512
|
*/
|
|
10816
10513
|
|
|
10817
10514
|
/**
|
|
@@ -10891,7 +10588,7 @@ class CarrierServicesApi {
|
|
|
10891
10588
|
/**
|
|
10892
10589
|
* CarrierServices service.
|
|
10893
10590
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10894
|
-
* @version
|
|
10591
|
+
* @version 193.0.0
|
|
10895
10592
|
*/
|
|
10896
10593
|
|
|
10897
10594
|
/**
|
|
@@ -10961,7 +10658,7 @@ class ChatApi {
|
|
|
10961
10658
|
/**
|
|
10962
10659
|
* Chat service.
|
|
10963
10660
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10964
|
-
* @version
|
|
10661
|
+
* @version 193.0.0
|
|
10965
10662
|
*/
|
|
10966
10663
|
|
|
10967
10664
|
/**
|
|
@@ -11457,6 +11154,27 @@ class ChatApi {
|
|
|
11457
11154
|
);
|
|
11458
11155
|
}
|
|
11459
11156
|
|
|
11157
|
+
/**
|
|
11158
|
+
* Get a user's chat settings
|
|
11159
|
+
*
|
|
11160
|
+
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11161
|
+
*/
|
|
11162
|
+
getChatsUsersMeSettings() {
|
|
11163
|
+
|
|
11164
|
+
return this.apiClient.callApi(
|
|
11165
|
+
'/api/v2/chats/users/me/settings',
|
|
11166
|
+
'GET',
|
|
11167
|
+
{ },
|
|
11168
|
+
{ },
|
|
11169
|
+
{ },
|
|
11170
|
+
{ },
|
|
11171
|
+
null,
|
|
11172
|
+
['PureCloud OAuth'],
|
|
11173
|
+
['application/json'],
|
|
11174
|
+
['application/json']
|
|
11175
|
+
);
|
|
11176
|
+
}
|
|
11177
|
+
|
|
11460
11178
|
/**
|
|
11461
11179
|
* Set properties for a room
|
|
11462
11180
|
*
|
|
@@ -11613,6 +11331,32 @@ class ChatApi {
|
|
|
11613
11331
|
);
|
|
11614
11332
|
}
|
|
11615
11333
|
|
|
11334
|
+
/**
|
|
11335
|
+
* Update a user's chat settings
|
|
11336
|
+
*
|
|
11337
|
+
* @param {Object} body
|
|
11338
|
+
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11339
|
+
*/
|
|
11340
|
+
patchChatsUsersMeSettings(body) {
|
|
11341
|
+
// verify the required parameter 'body' is set
|
|
11342
|
+
if (body === undefined || body === null) {
|
|
11343
|
+
throw 'Missing the required parameter "body" when calling patchChatsUsersMeSettings';
|
|
11344
|
+
}
|
|
11345
|
+
|
|
11346
|
+
return this.apiClient.callApi(
|
|
11347
|
+
'/api/v2/chats/users/me/settings',
|
|
11348
|
+
'PATCH',
|
|
11349
|
+
{ },
|
|
11350
|
+
{ },
|
|
11351
|
+
{ },
|
|
11352
|
+
{ },
|
|
11353
|
+
body,
|
|
11354
|
+
['PureCloud OAuth'],
|
|
11355
|
+
['application/json'],
|
|
11356
|
+
['application/json']
|
|
11357
|
+
);
|
|
11358
|
+
}
|
|
11359
|
+
|
|
11616
11360
|
/**
|
|
11617
11361
|
* Send a message to a room
|
|
11618
11362
|
*
|
|
@@ -11850,7 +11594,7 @@ class CoachingApi {
|
|
|
11850
11594
|
/**
|
|
11851
11595
|
* Coaching service.
|
|
11852
11596
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11853
|
-
* @version
|
|
11597
|
+
* @version 193.0.0
|
|
11854
11598
|
*/
|
|
11855
11599
|
|
|
11856
11600
|
/**
|
|
@@ -12427,7 +12171,7 @@ class ContentManagementApi {
|
|
|
12427
12171
|
/**
|
|
12428
12172
|
* ContentManagement service.
|
|
12429
12173
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12430
|
-
* @version
|
|
12174
|
+
* @version 193.0.0
|
|
12431
12175
|
*/
|
|
12432
12176
|
|
|
12433
12177
|
/**
|
|
@@ -13509,7 +13253,7 @@ class ConversationsApi {
|
|
|
13509
13253
|
/**
|
|
13510
13254
|
* Conversations service.
|
|
13511
13255
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13512
|
-
* @version
|
|
13256
|
+
* @version 193.0.0
|
|
13513
13257
|
*/
|
|
13514
13258
|
|
|
13515
13259
|
/**
|
|
@@ -17803,7 +17547,6 @@ class ConversationsApi {
|
|
|
17803
17547
|
* @param {Object} opts Optional parameters
|
|
17804
17548
|
* @param {Number} opts.pageSize The desired page size
|
|
17805
17549
|
* @param {Number} opts.pageNumber The desired page number
|
|
17806
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17807
17550
|
*/
|
|
17808
17551
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
17809
17552
|
opts = opts || {};
|
|
@@ -20751,7 +20494,7 @@ class DataExtensionsApi {
|
|
|
20751
20494
|
/**
|
|
20752
20495
|
* DataExtensions service.
|
|
20753
20496
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20754
|
-
* @version
|
|
20497
|
+
* @version 193.0.0
|
|
20755
20498
|
*/
|
|
20756
20499
|
|
|
20757
20500
|
/**
|
|
@@ -20837,7 +20580,7 @@ class DownloadsApi {
|
|
|
20837
20580
|
/**
|
|
20838
20581
|
* Downloads service.
|
|
20839
20582
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20840
|
-
* @version
|
|
20583
|
+
* @version 193.0.0
|
|
20841
20584
|
*/
|
|
20842
20585
|
|
|
20843
20586
|
/**
|
|
@@ -20889,7 +20632,7 @@ class EmailsApi {
|
|
|
20889
20632
|
/**
|
|
20890
20633
|
* Emails service.
|
|
20891
20634
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20892
|
-
* @version
|
|
20635
|
+
* @version 193.0.0
|
|
20893
20636
|
*/
|
|
20894
20637
|
|
|
20895
20638
|
/**
|
|
@@ -20954,7 +20697,7 @@ class EventsApi {
|
|
|
20954
20697
|
/**
|
|
20955
20698
|
* Events service.
|
|
20956
20699
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20957
|
-
* @version
|
|
20700
|
+
* @version 193.0.0
|
|
20958
20701
|
*/
|
|
20959
20702
|
|
|
20960
20703
|
/**
|
|
@@ -21050,7 +20793,7 @@ class ExternalContactsApi {
|
|
|
21050
20793
|
/**
|
|
21051
20794
|
* ExternalContacts service.
|
|
21052
20795
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21053
|
-
* @version
|
|
20796
|
+
* @version 193.0.0
|
|
21054
20797
|
*/
|
|
21055
20798
|
|
|
21056
20799
|
/**
|
|
@@ -23008,7 +22751,7 @@ class FaxApi {
|
|
|
23008
22751
|
/**
|
|
23009
22752
|
* Fax service.
|
|
23010
22753
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23011
|
-
* @version
|
|
22754
|
+
* @version 193.0.0
|
|
23012
22755
|
*/
|
|
23013
22756
|
|
|
23014
22757
|
/**
|
|
@@ -23223,7 +22966,7 @@ class FlowsApi {
|
|
|
23223
22966
|
/**
|
|
23224
22967
|
* Flows service.
|
|
23225
22968
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23226
|
-
* @version
|
|
22969
|
+
* @version 193.0.0
|
|
23227
22970
|
*/
|
|
23228
22971
|
|
|
23229
22972
|
/**
|
|
@@ -23301,7 +23044,6 @@ class FlowsApi {
|
|
|
23301
23044
|
* @param {Object} opts Optional parameters
|
|
23302
23045
|
* @param {Number} opts.pageSize The desired page size
|
|
23303
23046
|
* @param {Number} opts.pageNumber The desired page number
|
|
23304
|
-
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23305
23047
|
*/
|
|
23306
23048
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
23307
23049
|
opts = opts || {};
|
|
@@ -23407,7 +23149,7 @@ class GamificationApi {
|
|
|
23407
23149
|
/**
|
|
23408
23150
|
* Gamification service.
|
|
23409
23151
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23410
|
-
* @version
|
|
23152
|
+
* @version 193.0.0
|
|
23411
23153
|
*/
|
|
23412
23154
|
|
|
23413
23155
|
/**
|
|
@@ -25493,7 +25235,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25493
25235
|
/**
|
|
25494
25236
|
* GeneralDataProtectionRegulation service.
|
|
25495
25237
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25496
|
-
* @version
|
|
25238
|
+
* @version 193.0.0
|
|
25497
25239
|
*/
|
|
25498
25240
|
|
|
25499
25241
|
/**
|
|
@@ -25623,7 +25365,7 @@ class GeolocationApi {
|
|
|
25623
25365
|
/**
|
|
25624
25366
|
* Geolocation service.
|
|
25625
25367
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25626
|
-
* @version
|
|
25368
|
+
* @version 193.0.0
|
|
25627
25369
|
*/
|
|
25628
25370
|
|
|
25629
25371
|
/**
|
|
@@ -25754,7 +25496,7 @@ class GreetingsApi {
|
|
|
25754
25496
|
/**
|
|
25755
25497
|
* Greetings service.
|
|
25756
25498
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25757
|
-
* @version
|
|
25499
|
+
* @version 193.0.0
|
|
25758
25500
|
*/
|
|
25759
25501
|
|
|
25760
25502
|
/**
|
|
@@ -26209,7 +25951,7 @@ class GroupsApi {
|
|
|
26209
25951
|
/**
|
|
26210
25952
|
* Groups service.
|
|
26211
25953
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26212
|
-
* @version
|
|
25954
|
+
* @version 193.0.0
|
|
26213
25955
|
*/
|
|
26214
25956
|
|
|
26215
25957
|
/**
|
|
@@ -26728,7 +26470,7 @@ class IdentityProviderApi {
|
|
|
26728
26470
|
/**
|
|
26729
26471
|
* IdentityProvider service.
|
|
26730
26472
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26731
|
-
* @version
|
|
26473
|
+
* @version 193.0.0
|
|
26732
26474
|
*/
|
|
26733
26475
|
|
|
26734
26476
|
/**
|
|
@@ -27589,7 +27331,7 @@ class InfrastructureAsCodeApi {
|
|
|
27589
27331
|
/**
|
|
27590
27332
|
* InfrastructureAsCode service.
|
|
27591
27333
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27592
|
-
* @version
|
|
27334
|
+
* @version 193.0.0
|
|
27593
27335
|
*/
|
|
27594
27336
|
|
|
27595
27337
|
/**
|
|
@@ -27756,7 +27498,7 @@ class IntegrationsApi {
|
|
|
27756
27498
|
/**
|
|
27757
27499
|
* Integrations service.
|
|
27758
27500
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27759
|
-
* @version
|
|
27501
|
+
* @version 193.0.0
|
|
27760
27502
|
*/
|
|
27761
27503
|
|
|
27762
27504
|
/**
|
|
@@ -30108,7 +29850,7 @@ class JourneyApi {
|
|
|
30108
29850
|
/**
|
|
30109
29851
|
* Journey service.
|
|
30110
29852
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30111
|
-
* @version
|
|
29853
|
+
* @version 193.0.0
|
|
30112
29854
|
*/
|
|
30113
29855
|
|
|
30114
29856
|
/**
|
|
@@ -31697,7 +31439,7 @@ class KnowledgeApi {
|
|
|
31697
31439
|
/**
|
|
31698
31440
|
* Knowledge service.
|
|
31699
31441
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31700
|
-
* @version
|
|
31442
|
+
* @version 193.0.0
|
|
31701
31443
|
*/
|
|
31702
31444
|
|
|
31703
31445
|
/**
|
|
@@ -34940,7 +34682,7 @@ class LanguageUnderstandingApi {
|
|
|
34940
34682
|
/**
|
|
34941
34683
|
* LanguageUnderstanding service.
|
|
34942
34684
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34943
|
-
* @version
|
|
34685
|
+
* @version 193.0.0
|
|
34944
34686
|
*/
|
|
34945
34687
|
|
|
34946
34688
|
/**
|
|
@@ -35974,7 +35716,7 @@ class LanguagesApi {
|
|
|
35974
35716
|
/**
|
|
35975
35717
|
* Languages service.
|
|
35976
35718
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35977
|
-
* @version
|
|
35719
|
+
* @version 193.0.0
|
|
35978
35720
|
*/
|
|
35979
35721
|
|
|
35980
35722
|
/**
|
|
@@ -36196,7 +35938,7 @@ class LearningApi {
|
|
|
36196
35938
|
/**
|
|
36197
35939
|
* Learning service.
|
|
36198
35940
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36199
|
-
* @version
|
|
35941
|
+
* @version 193.0.0
|
|
36200
35942
|
*/
|
|
36201
35943
|
|
|
36202
35944
|
/**
|
|
@@ -37051,7 +36793,7 @@ class LicenseApi {
|
|
|
37051
36793
|
/**
|
|
37052
36794
|
* License service.
|
|
37053
36795
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37054
|
-
* @version
|
|
36796
|
+
* @version 193.0.0
|
|
37055
36797
|
*/
|
|
37056
36798
|
|
|
37057
36799
|
/**
|
|
@@ -37289,7 +37031,7 @@ class LocationsApi {
|
|
|
37289
37031
|
/**
|
|
37290
37032
|
* Locations service.
|
|
37291
37033
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37292
|
-
* @version
|
|
37034
|
+
* @version 193.0.0
|
|
37293
37035
|
*/
|
|
37294
37036
|
|
|
37295
37037
|
/**
|
|
@@ -37525,7 +37267,7 @@ class LogCaptureApi {
|
|
|
37525
37267
|
/**
|
|
37526
37268
|
* LogCapture service.
|
|
37527
37269
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37528
|
-
* @version
|
|
37270
|
+
* @version 193.0.0
|
|
37529
37271
|
*/
|
|
37530
37272
|
|
|
37531
37273
|
/**
|
|
@@ -37725,7 +37467,7 @@ class MessagingApi {
|
|
|
37725
37467
|
/**
|
|
37726
37468
|
* Messaging service.
|
|
37727
37469
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37728
|
-
* @version
|
|
37470
|
+
* @version 193.0.0
|
|
37729
37471
|
*/
|
|
37730
37472
|
|
|
37731
37473
|
/**
|
|
@@ -38084,7 +37826,7 @@ class MobileDevicesApi {
|
|
|
38084
37826
|
/**
|
|
38085
37827
|
* MobileDevices service.
|
|
38086
37828
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38087
|
-
* @version
|
|
37829
|
+
* @version 193.0.0
|
|
38088
37830
|
*/
|
|
38089
37831
|
|
|
38090
37832
|
/**
|
|
@@ -38235,7 +37977,7 @@ class NotificationsApi {
|
|
|
38235
37977
|
/**
|
|
38236
37978
|
* Notifications service.
|
|
38237
37979
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38238
|
-
* @version
|
|
37980
|
+
* @version 193.0.0
|
|
38239
37981
|
*/
|
|
38240
37982
|
|
|
38241
37983
|
/**
|
|
@@ -38468,7 +38210,7 @@ class OAuthApi {
|
|
|
38468
38210
|
/**
|
|
38469
38211
|
* OAuth service.
|
|
38470
38212
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38471
|
-
* @version
|
|
38213
|
+
* @version 193.0.0
|
|
38472
38214
|
*/
|
|
38473
38215
|
|
|
38474
38216
|
/**
|
|
@@ -38834,7 +38576,7 @@ class ObjectsApi {
|
|
|
38834
38576
|
/**
|
|
38835
38577
|
* Objects service.
|
|
38836
38578
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38837
|
-
* @version
|
|
38579
|
+
* @version 193.0.0
|
|
38838
38580
|
*/
|
|
38839
38581
|
|
|
38840
38582
|
/**
|
|
@@ -39104,7 +38846,7 @@ class OperationalEventsApi {
|
|
|
39104
38846
|
/**
|
|
39105
38847
|
* OperationalEvents service.
|
|
39106
38848
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39107
|
-
* @version
|
|
38849
|
+
* @version 193.0.0
|
|
39108
38850
|
*/
|
|
39109
38851
|
|
|
39110
38852
|
/**
|
|
@@ -39170,7 +38912,7 @@ class OrganizationApi {
|
|
|
39170
38912
|
/**
|
|
39171
38913
|
* Organization service.
|
|
39172
38914
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39173
|
-
* @version
|
|
38915
|
+
* @version 193.0.0
|
|
39174
38916
|
*/
|
|
39175
38917
|
|
|
39176
38918
|
/**
|
|
@@ -39346,6 +39088,26 @@ class OrganizationApi {
|
|
|
39346
39088
|
);
|
|
39347
39089
|
}
|
|
39348
39090
|
|
|
39091
|
+
/**
|
|
39092
|
+
* Get free trial limit documentation
|
|
39093
|
+
*
|
|
39094
|
+
*/
|
|
39095
|
+
getOrganizationsLimitsDocsFreetrial() {
|
|
39096
|
+
|
|
39097
|
+
return this.apiClient.callApi(
|
|
39098
|
+
'/api/v2/organizations/limits/docs/freetrial',
|
|
39099
|
+
'GET',
|
|
39100
|
+
{ },
|
|
39101
|
+
{ },
|
|
39102
|
+
{ },
|
|
39103
|
+
{ },
|
|
39104
|
+
null,
|
|
39105
|
+
['PureCloud OAuth'],
|
|
39106
|
+
['application/json'],
|
|
39107
|
+
['application/json']
|
|
39108
|
+
);
|
|
39109
|
+
}
|
|
39110
|
+
|
|
39349
39111
|
/**
|
|
39350
39112
|
* Get the effective limits in a namespace for an organization
|
|
39351
39113
|
*
|
|
@@ -39625,7 +39387,7 @@ class OrganizationAuthorizationApi {
|
|
|
39625
39387
|
/**
|
|
39626
39388
|
* OrganizationAuthorization service.
|
|
39627
39389
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39628
|
-
* @version
|
|
39390
|
+
* @version 193.0.0
|
|
39629
39391
|
*/
|
|
39630
39392
|
|
|
39631
39393
|
/**
|
|
@@ -40972,7 +40734,7 @@ class OutboundApi {
|
|
|
40972
40734
|
/**
|
|
40973
40735
|
* Outbound service.
|
|
40974
40736
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40975
|
-
* @version
|
|
40737
|
+
* @version 193.0.0
|
|
40976
40738
|
*/
|
|
40977
40739
|
|
|
40978
40740
|
/**
|
|
@@ -45214,7 +44976,7 @@ class PresenceApi {
|
|
|
45214
44976
|
/**
|
|
45215
44977
|
* Presence service.
|
|
45216
44978
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45217
|
-
* @version
|
|
44979
|
+
* @version 193.0.0
|
|
45218
44980
|
*/
|
|
45219
44981
|
|
|
45220
44982
|
/**
|
|
@@ -45958,7 +45720,7 @@ class ProcessAutomationApi {
|
|
|
45958
45720
|
/**
|
|
45959
45721
|
* ProcessAutomation service.
|
|
45960
45722
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45961
|
-
* @version
|
|
45723
|
+
* @version 193.0.0
|
|
45962
45724
|
*/
|
|
45963
45725
|
|
|
45964
45726
|
/**
|
|
@@ -46197,7 +45959,7 @@ class QualityApi {
|
|
|
46197
45959
|
/**
|
|
46198
45960
|
* Quality service.
|
|
46199
45961
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46200
|
-
* @version
|
|
45962
|
+
* @version 193.0.0
|
|
46201
45963
|
*/
|
|
46202
45964
|
|
|
46203
45965
|
/**
|
|
@@ -46685,7 +46447,7 @@ class QualityApi {
|
|
|
46685
46447
|
|
|
46686
46448
|
/**
|
|
46687
46449
|
* Queries Evaluations and returns a paged list
|
|
46688
|
-
* 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.
|
|
46450
|
+
* 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. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given propertys value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.
|
|
46689
46451
|
* @param {Object} opts Optional parameters
|
|
46690
46452
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46691
46453
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -46705,7 +46467,7 @@ class QualityApi {
|
|
|
46705
46467
|
* @param {Array.<String>} opts.evaluationState
|
|
46706
46468
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
46707
46469
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
46708
|
-
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
46470
|
+
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.
|
|
46709
46471
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
46710
46472
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
46711
46473
|
*/
|
|
@@ -47954,7 +47716,7 @@ class RecordingApi {
|
|
|
47954
47716
|
/**
|
|
47955
47717
|
* Recording service.
|
|
47956
47718
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47957
|
-
* @version
|
|
47719
|
+
* @version 193.0.0
|
|
47958
47720
|
*/
|
|
47959
47721
|
|
|
47960
47722
|
/**
|
|
@@ -49612,7 +49374,7 @@ class ResponseManagementApi {
|
|
|
49612
49374
|
/**
|
|
49613
49375
|
* ResponseManagement service.
|
|
49614
49376
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49615
|
-
* @version
|
|
49377
|
+
* @version 193.0.0
|
|
49616
49378
|
*/
|
|
49617
49379
|
|
|
49618
49380
|
/**
|
|
@@ -50122,7 +49884,7 @@ class RoutingApi {
|
|
|
50122
49884
|
/**
|
|
50123
49885
|
* Routing service.
|
|
50124
49886
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50125
|
-
* @version
|
|
49887
|
+
* @version 193.0.0
|
|
50126
49888
|
*/
|
|
50127
49889
|
|
|
50128
49890
|
/**
|
|
@@ -53019,7 +52781,6 @@ class RoutingApi {
|
|
|
53019
52781
|
* @param {Object} opts Optional parameters
|
|
53020
52782
|
* @param {Number} opts.pageSize The desired page size
|
|
53021
52783
|
* @param {Number} opts.pageNumber The desired page number
|
|
53022
|
-
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53023
52784
|
*/
|
|
53024
52785
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
53025
52786
|
opts = opts || {};
|
|
@@ -54102,7 +53863,7 @@ class SCIMApi {
|
|
|
54102
53863
|
/**
|
|
54103
53864
|
* SCIM service.
|
|
54104
53865
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54105
|
-
* @version
|
|
53866
|
+
* @version 193.0.0
|
|
54106
53867
|
*/
|
|
54107
53868
|
|
|
54108
53869
|
/**
|
|
@@ -54979,7 +54740,7 @@ class ScreenRecordingApi {
|
|
|
54979
54740
|
/**
|
|
54980
54741
|
* ScreenRecording service.
|
|
54981
54742
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54982
|
-
* @version
|
|
54743
|
+
* @version 193.0.0
|
|
54983
54744
|
*/
|
|
54984
54745
|
|
|
54985
54746
|
/**
|
|
@@ -55024,7 +54785,7 @@ class ScriptsApi {
|
|
|
55024
54785
|
/**
|
|
55025
54786
|
* Scripts service.
|
|
55026
54787
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55027
|
-
* @version
|
|
54788
|
+
* @version 193.0.0
|
|
55028
54789
|
*/
|
|
55029
54790
|
|
|
55030
54791
|
/**
|
|
@@ -55468,7 +55229,7 @@ class SearchApi {
|
|
|
55468
55229
|
/**
|
|
55469
55230
|
* Search service.
|
|
55470
55231
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55471
|
-
* @version
|
|
55232
|
+
* @version 193.0.0
|
|
55472
55233
|
*/
|
|
55473
55234
|
|
|
55474
55235
|
/**
|
|
@@ -56157,7 +55918,7 @@ class SettingsApi {
|
|
|
56157
55918
|
/**
|
|
56158
55919
|
* Settings service.
|
|
56159
55920
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56160
|
-
* @version
|
|
55921
|
+
* @version 193.0.0
|
|
56161
55922
|
*/
|
|
56162
55923
|
|
|
56163
55924
|
/**
|
|
@@ -56269,7 +56030,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56269
56030
|
/**
|
|
56270
56031
|
* SpeechTextAnalytics service.
|
|
56271
56032
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56272
|
-
* @version
|
|
56033
|
+
* @version 193.0.0
|
|
56273
56034
|
*/
|
|
56274
56035
|
|
|
56275
56036
|
/**
|
|
@@ -57383,7 +57144,7 @@ class StationsApi {
|
|
|
57383
57144
|
/**
|
|
57384
57145
|
* Stations service.
|
|
57385
57146
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57386
|
-
* @version
|
|
57147
|
+
* @version 193.0.0
|
|
57387
57148
|
*/
|
|
57388
57149
|
|
|
57389
57150
|
/**
|
|
@@ -57485,7 +57246,7 @@ class SuggestApi {
|
|
|
57485
57246
|
/**
|
|
57486
57247
|
* Suggest service.
|
|
57487
57248
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57488
|
-
* @version
|
|
57249
|
+
* @version 193.0.0
|
|
57489
57250
|
*/
|
|
57490
57251
|
|
|
57491
57252
|
/**
|
|
@@ -57624,7 +57385,7 @@ class TaskManagementApi {
|
|
|
57624
57385
|
/**
|
|
57625
57386
|
* TaskManagement service.
|
|
57626
57387
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57627
|
-
* @version
|
|
57388
|
+
* @version 193.0.0
|
|
57628
57389
|
*/
|
|
57629
57390
|
|
|
57630
57391
|
/**
|
|
@@ -57643,7 +57404,6 @@ class TaskManagementApi {
|
|
|
57643
57404
|
* Delete a workbin
|
|
57644
57405
|
*
|
|
57645
57406
|
* @param {String} workbinId Workbin ID
|
|
57646
|
-
* deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57647
57407
|
*/
|
|
57648
57408
|
deleteTaskmanagementWorkbin(workbinId) {
|
|
57649
57409
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57669,7 +57429,6 @@ class TaskManagementApi {
|
|
|
57669
57429
|
* Delete a workitem
|
|
57670
57430
|
*
|
|
57671
57431
|
* @param {String} workitemId Workitem ID
|
|
57672
|
-
* deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57673
57432
|
*/
|
|
57674
57433
|
deleteTaskmanagementWorkitem(workitemId) {
|
|
57675
57434
|
// verify the required parameter 'workitemId' is set
|
|
@@ -57695,7 +57454,6 @@ class TaskManagementApi {
|
|
|
57695
57454
|
* Delete a schema
|
|
57696
57455
|
*
|
|
57697
57456
|
* @param {String} schemaId Schema ID
|
|
57698
|
-
* deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57699
57457
|
*/
|
|
57700
57458
|
deleteTaskmanagementWorkitemsSchema(schemaId) {
|
|
57701
57459
|
// verify the required parameter 'schemaId' is set
|
|
@@ -57721,7 +57479,6 @@ class TaskManagementApi {
|
|
|
57721
57479
|
* Delete a worktype
|
|
57722
57480
|
*
|
|
57723
57481
|
* @param {String} worktypeId Worktype id
|
|
57724
|
-
* deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57725
57482
|
*/
|
|
57726
57483
|
deleteTaskmanagementWorktype(worktypeId) {
|
|
57727
57484
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57748,7 +57505,6 @@ class TaskManagementApi {
|
|
|
57748
57505
|
*
|
|
57749
57506
|
* @param {String} worktypeId Worktype id
|
|
57750
57507
|
* @param {String} statusId Status id
|
|
57751
|
-
* deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57752
57508
|
*/
|
|
57753
57509
|
deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
57754
57510
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57778,7 +57534,6 @@ class TaskManagementApi {
|
|
|
57778
57534
|
* Get a workbin
|
|
57779
57535
|
*
|
|
57780
57536
|
* @param {String} workbinId Workbin ID
|
|
57781
|
-
* getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57782
57537
|
*/
|
|
57783
57538
|
getTaskmanagementWorkbin(workbinId) {
|
|
57784
57539
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57901,7 +57656,6 @@ class TaskManagementApi {
|
|
|
57901
57656
|
* @param {String} workitemId Workitem ID
|
|
57902
57657
|
* @param {Object} opts Optional parameters
|
|
57903
57658
|
* @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
|
|
57904
|
-
* getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57905
57659
|
*/
|
|
57906
57660
|
getTaskmanagementWorkitem(workitemId, opts) {
|
|
57907
57661
|
opts = opts || {};
|
|
@@ -57967,7 +57721,6 @@ class TaskManagementApi {
|
|
|
57967
57721
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
57968
57722
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
|
|
57969
57723
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
57970
|
-
* getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57971
57724
|
*/
|
|
57972
57725
|
getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
|
|
57973
57726
|
opts = opts || {};
|
|
@@ -58067,7 +57820,6 @@ class TaskManagementApi {
|
|
|
58067
57820
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58068
57821
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
|
|
58069
57822
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
58070
|
-
* getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58071
57823
|
*/
|
|
58072
57824
|
getTaskmanagementWorkitemWrapups(workitemId, opts) {
|
|
58073
57825
|
opts = opts || {};
|
|
@@ -58095,7 +57847,6 @@ class TaskManagementApi {
|
|
|
58095
57847
|
* Get the workitem query job associated with the job id.
|
|
58096
57848
|
*
|
|
58097
57849
|
* @param {String} jobId jobId
|
|
58098
|
-
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58099
57850
|
*/
|
|
58100
57851
|
getTaskmanagementWorkitemsQueryJob(jobId) {
|
|
58101
57852
|
// verify the required parameter 'jobId' is set
|
|
@@ -58121,7 +57872,6 @@ class TaskManagementApi {
|
|
|
58121
57872
|
* Get results from for workitem query job
|
|
58122
57873
|
*
|
|
58123
57874
|
* @param {String} jobId jobId
|
|
58124
|
-
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58125
57875
|
*/
|
|
58126
57876
|
getTaskmanagementWorkitemsQueryJobResults(jobId) {
|
|
58127
57877
|
// verify the required parameter 'jobId' is set
|
|
@@ -58147,7 +57897,6 @@ class TaskManagementApi {
|
|
|
58147
57897
|
* Get a schema
|
|
58148
57898
|
*
|
|
58149
57899
|
* @param {String} schemaId Schema ID
|
|
58150
|
-
* getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58151
57900
|
*/
|
|
58152
57901
|
getTaskmanagementWorkitemsSchema(schemaId) {
|
|
58153
57902
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58174,7 +57923,6 @@ class TaskManagementApi {
|
|
|
58174
57923
|
*
|
|
58175
57924
|
* @param {String} schemaId Schema ID
|
|
58176
57925
|
* @param {String} versionId Schema version
|
|
58177
|
-
* getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58178
57926
|
*/
|
|
58179
57927
|
getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
|
|
58180
57928
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58204,7 +57952,6 @@ class TaskManagementApi {
|
|
|
58204
57952
|
* Get all versions of a schema
|
|
58205
57953
|
*
|
|
58206
57954
|
* @param {String} schemaId Schema ID
|
|
58207
|
-
* getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58208
57955
|
*/
|
|
58209
57956
|
getTaskmanagementWorkitemsSchemaVersions(schemaId) {
|
|
58210
57957
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58229,7 +57976,6 @@ class TaskManagementApi {
|
|
|
58229
57976
|
/**
|
|
58230
57977
|
* Get a list of schemas.
|
|
58231
57978
|
*
|
|
58232
|
-
* getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58233
57979
|
*/
|
|
58234
57980
|
getTaskmanagementWorkitemsSchemas() {
|
|
58235
57981
|
|
|
@@ -58253,7 +57999,6 @@ class TaskManagementApi {
|
|
|
58253
57999
|
* @param {String} worktypeId Worktype id
|
|
58254
58000
|
* @param {Object} opts Optional parameters
|
|
58255
58001
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
58256
|
-
* getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58257
58002
|
*/
|
|
58258
58003
|
getTaskmanagementWorktype(worktypeId, opts) {
|
|
58259
58004
|
opts = opts || {};
|
|
@@ -58314,7 +58059,6 @@ class TaskManagementApi {
|
|
|
58314
58059
|
*
|
|
58315
58060
|
* @param {String} worktypeId Worktype id
|
|
58316
58061
|
* @param {String} statusId Status id
|
|
58317
|
-
* getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58318
58062
|
*/
|
|
58319
58063
|
getTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
58320
58064
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58344,7 +58088,6 @@ class TaskManagementApi {
|
|
|
58344
58088
|
* Get list of statuses for this worktype.
|
|
58345
58089
|
*
|
|
58346
58090
|
* @param {String} worktypeId Worktype id
|
|
58347
|
-
* getTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58348
58091
|
*/
|
|
58349
58092
|
getTaskmanagementWorktypeStatuses(worktypeId) {
|
|
58350
58093
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58434,7 +58177,6 @@ class TaskManagementApi {
|
|
|
58434
58177
|
*
|
|
58435
58178
|
* @param {String} workbinId Workbin ID
|
|
58436
58179
|
* @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
|
|
58437
|
-
* patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58438
58180
|
*/
|
|
58439
58181
|
patchTaskmanagementWorkbin(workbinId, body) {
|
|
58440
58182
|
// verify the required parameter 'workbinId' is set
|
|
@@ -58465,7 +58207,6 @@ class TaskManagementApi {
|
|
|
58465
58207
|
*
|
|
58466
58208
|
* @param {String} workitemId Workitem ID
|
|
58467
58209
|
* @param {Object} body Workitem
|
|
58468
|
-
* patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58469
58210
|
*/
|
|
58470
58211
|
patchTaskmanagementWorkitem(workitemId, body) {
|
|
58471
58212
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58496,7 +58237,6 @@ class TaskManagementApi {
|
|
|
58496
58237
|
*
|
|
58497
58238
|
* @param {String} workitemId Workitem ID
|
|
58498
58239
|
* @param {Object} body Targeted user
|
|
58499
|
-
* patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58500
58240
|
*/
|
|
58501
58241
|
patchTaskmanagementWorkitemAssignment(workitemId, body) {
|
|
58502
58242
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58528,7 +58268,6 @@ class TaskManagementApi {
|
|
|
58528
58268
|
* @param {String} workitemId The ID of the Workitem.
|
|
58529
58269
|
* @param {String} userId The ID of the user
|
|
58530
58270
|
* @param {Object} body Request body to add/remove a wrapup code for a workitem
|
|
58531
|
-
* patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58532
58271
|
*/
|
|
58533
58272
|
patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
|
|
58534
58273
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58563,7 +58302,6 @@ class TaskManagementApi {
|
|
|
58563
58302
|
*
|
|
58564
58303
|
* @param {String} workitemId The ID of the Workitem.
|
|
58565
58304
|
* @param {Object} body Request body to add/remove the wrapup code for workitem
|
|
58566
|
-
* patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58567
58305
|
*/
|
|
58568
58306
|
patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
|
|
58569
58307
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58595,7 +58333,6 @@ class TaskManagementApi {
|
|
|
58595
58333
|
* @param {String} worktypeId Worktype id
|
|
58596
58334
|
* @param {Object} opts Optional parameters
|
|
58597
58335
|
* @param {Object} opts.body body
|
|
58598
|
-
* patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58599
58336
|
*/
|
|
58600
58337
|
patchTaskmanagementWorktype(worktypeId, opts) {
|
|
58601
58338
|
opts = opts || {};
|
|
@@ -58626,7 +58363,6 @@ class TaskManagementApi {
|
|
|
58626
58363
|
* @param {String} statusId Status id
|
|
58627
58364
|
* @param {Object} opts Optional parameters
|
|
58628
58365
|
* @param {Object} opts.body body
|
|
58629
|
-
* patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58630
58366
|
*/
|
|
58631
58367
|
patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
|
|
58632
58368
|
opts = opts || {};
|
|
@@ -58659,7 +58395,6 @@ class TaskManagementApi {
|
|
|
58659
58395
|
*
|
|
58660
58396
|
* @param {Object} opts Optional parameters
|
|
58661
58397
|
* @param {Object} opts.body body
|
|
58662
|
-
* postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58663
58398
|
*/
|
|
58664
58399
|
postTaskmanagementWorkbins(opts) {
|
|
58665
58400
|
opts = opts || {};
|
|
@@ -58683,7 +58418,6 @@ class TaskManagementApi {
|
|
|
58683
58418
|
* Query for workbins
|
|
58684
58419
|
*
|
|
58685
58420
|
* @param {Object} body QueryPostRequest
|
|
58686
|
-
* postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58687
58421
|
*/
|
|
58688
58422
|
postTaskmanagementWorkbinsQuery(body) {
|
|
58689
58423
|
// verify the required parameter 'body' is set
|
|
@@ -58709,7 +58443,6 @@ class TaskManagementApi {
|
|
|
58709
58443
|
* Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
|
|
58710
58444
|
*
|
|
58711
58445
|
* @param {String} workitemId Workitem ID
|
|
58712
|
-
* postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58713
58446
|
*/
|
|
58714
58447
|
postTaskmanagementWorkitemAcdCancel(workitemId) {
|
|
58715
58448
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58735,7 +58468,6 @@ class TaskManagementApi {
|
|
|
58735
58468
|
* Disconnect the assignee of the workitem
|
|
58736
58469
|
*
|
|
58737
58470
|
* @param {String} workitemId Workitem ID
|
|
58738
|
-
* postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58739
58471
|
*/
|
|
58740
58472
|
postTaskmanagementWorkitemDisconnect(workitemId) {
|
|
58741
58473
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58763,7 +58495,6 @@ class TaskManagementApi {
|
|
|
58763
58495
|
* @param {String} workitemId Workitem ID
|
|
58764
58496
|
* @param {Object} opts Optional parameters
|
|
58765
58497
|
* @param {Object} opts.body Terminated request
|
|
58766
|
-
* postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58767
58498
|
*/
|
|
58768
58499
|
postTaskmanagementWorkitemTerminate(workitemId, opts) {
|
|
58769
58500
|
opts = opts || {};
|
|
@@ -58791,7 +58522,6 @@ class TaskManagementApi {
|
|
|
58791
58522
|
* Create a workitem
|
|
58792
58523
|
*
|
|
58793
58524
|
* @param {Object} body Workitem
|
|
58794
|
-
* postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58795
58525
|
*/
|
|
58796
58526
|
postTaskmanagementWorkitems(body) {
|
|
58797
58527
|
// verify the required parameter 'body' is set
|
|
@@ -58843,7 +58573,6 @@ class TaskManagementApi {
|
|
|
58843
58573
|
* Create a workitem query job
|
|
58844
58574
|
*
|
|
58845
58575
|
* @param {Object} body WorkitemQueryJobCreate
|
|
58846
|
-
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58847
58576
|
*/
|
|
58848
58577
|
postTaskmanagementWorkitemsQueryJobs(body) {
|
|
58849
58578
|
// verify the required parameter 'body' is set
|
|
@@ -58869,7 +58598,6 @@ class TaskManagementApi {
|
|
|
58869
58598
|
* Create a schema
|
|
58870
58599
|
*
|
|
58871
58600
|
* @param {Object} body Schema
|
|
58872
|
-
* postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58873
58601
|
*/
|
|
58874
58602
|
postTaskmanagementWorkitemsSchemas(body) {
|
|
58875
58603
|
// verify the required parameter 'body' is set
|
|
@@ -58897,7 +58625,6 @@ class TaskManagementApi {
|
|
|
58897
58625
|
* @param {String} worktypeId Worktype id
|
|
58898
58626
|
* @param {Object} opts Optional parameters
|
|
58899
58627
|
* @param {Object} opts.body body
|
|
58900
|
-
* postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58901
58628
|
*/
|
|
58902
58629
|
postTaskmanagementWorktypeStatuses(worktypeId, opts) {
|
|
58903
58630
|
opts = opts || {};
|
|
@@ -58926,7 +58653,6 @@ class TaskManagementApi {
|
|
|
58926
58653
|
*
|
|
58927
58654
|
* @param {Object} opts Optional parameters
|
|
58928
58655
|
* @param {Object} opts.body body
|
|
58929
|
-
* postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58930
58656
|
*/
|
|
58931
58657
|
postTaskmanagementWorktypes(opts) {
|
|
58932
58658
|
opts = opts || {};
|
|
@@ -58950,7 +58676,6 @@ class TaskManagementApi {
|
|
|
58950
58676
|
* Query for worktypes
|
|
58951
58677
|
*
|
|
58952
58678
|
* @param {Object} body QueryPostRequest
|
|
58953
|
-
* postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58954
58679
|
*/
|
|
58955
58680
|
postTaskmanagementWorktypesQuery(body) {
|
|
58956
58681
|
// verify the required parameter 'body' is set
|
|
@@ -58977,7 +58702,6 @@ class TaskManagementApi {
|
|
|
58977
58702
|
*
|
|
58978
58703
|
* @param {String} schemaId Schema ID
|
|
58979
58704
|
* @param {Object} body Data Schema
|
|
58980
|
-
* putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58981
58705
|
*/
|
|
58982
58706
|
putTaskmanagementWorkitemsSchema(schemaId, body) {
|
|
58983
58707
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59009,7 +58733,7 @@ class TeamsApi {
|
|
|
59009
58733
|
/**
|
|
59010
58734
|
* Teams service.
|
|
59011
58735
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59012
|
-
* @version
|
|
58736
|
+
* @version 193.0.0
|
|
59013
58737
|
*/
|
|
59014
58738
|
|
|
59015
58739
|
/**
|
|
@@ -59201,7 +58925,6 @@ class TeamsApi {
|
|
|
59201
58925
|
* @param {Object} opts Optional parameters
|
|
59202
58926
|
* @param {Number} opts.pageSize The desired page size
|
|
59203
58927
|
* @param {Number} opts.pageNumber The desired page number
|
|
59204
|
-
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59205
58928
|
*/
|
|
59206
58929
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
59207
58930
|
opts = opts || {};
|
|
@@ -59311,7 +59034,7 @@ class TelephonyApi {
|
|
|
59311
59034
|
/**
|
|
59312
59035
|
* Telephony service.
|
|
59313
59036
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59314
|
-
* @version
|
|
59037
|
+
* @version 193.0.0
|
|
59315
59038
|
*/
|
|
59316
59039
|
|
|
59317
59040
|
/**
|
|
@@ -59493,7 +59216,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
59493
59216
|
/**
|
|
59494
59217
|
* TelephonyProvidersEdge service.
|
|
59495
59218
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59496
|
-
* @version
|
|
59219
|
+
* @version 193.0.0
|
|
59497
59220
|
*/
|
|
59498
59221
|
|
|
59499
59222
|
/**
|
|
@@ -62821,7 +62544,7 @@ class TextbotsApi {
|
|
|
62821
62544
|
/**
|
|
62822
62545
|
* Textbots service.
|
|
62823
62546
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62824
|
-
* @version
|
|
62547
|
+
* @version 193.0.0
|
|
62825
62548
|
*/
|
|
62826
62549
|
|
|
62827
62550
|
/**
|
|
@@ -62949,7 +62672,7 @@ class TokensApi {
|
|
|
62949
62672
|
/**
|
|
62950
62673
|
* Tokens service.
|
|
62951
62674
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62952
|
-
* @version
|
|
62675
|
+
* @version 193.0.0
|
|
62953
62676
|
*/
|
|
62954
62677
|
|
|
62955
62678
|
/**
|
|
@@ -63103,7 +62826,7 @@ class UploadsApi {
|
|
|
63103
62826
|
/**
|
|
63104
62827
|
* Uploads service.
|
|
63105
62828
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63106
|
-
* @version
|
|
62829
|
+
* @version 193.0.0
|
|
63107
62830
|
*/
|
|
63108
62831
|
|
|
63109
62832
|
/**
|
|
@@ -63372,7 +63095,7 @@ class UsageApi {
|
|
|
63372
63095
|
/**
|
|
63373
63096
|
* Usage service.
|
|
63374
63097
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63375
|
-
* @version
|
|
63098
|
+
* @version 193.0.0
|
|
63376
63099
|
*/
|
|
63377
63100
|
|
|
63378
63101
|
/**
|
|
@@ -63587,7 +63310,7 @@ class UserRecordingsApi {
|
|
|
63587
63310
|
/**
|
|
63588
63311
|
* UserRecordings service.
|
|
63589
63312
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63590
|
-
* @version
|
|
63313
|
+
* @version 193.0.0
|
|
63591
63314
|
*/
|
|
63592
63315
|
|
|
63593
63316
|
/**
|
|
@@ -63772,7 +63495,7 @@ class UsersApi {
|
|
|
63772
63495
|
/**
|
|
63773
63496
|
* Users service.
|
|
63774
63497
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63775
|
-
* @version
|
|
63498
|
+
* @version 193.0.0
|
|
63776
63499
|
*/
|
|
63777
63500
|
|
|
63778
63501
|
/**
|
|
@@ -65442,7 +65165,6 @@ class UsersApi {
|
|
|
65442
65165
|
* @param {Object} opts Optional parameters
|
|
65443
65166
|
* @param {Number} opts.pageSize The desired page size
|
|
65444
65167
|
* @param {Number} opts.pageNumber The desired page number
|
|
65445
|
-
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65446
65168
|
*/
|
|
65447
65169
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
65448
65170
|
opts = opts || {};
|
|
@@ -66431,7 +66153,7 @@ class UtilitiesApi {
|
|
|
66431
66153
|
/**
|
|
66432
66154
|
* Utilities service.
|
|
66433
66155
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66434
|
-
* @version
|
|
66156
|
+
* @version 193.0.0
|
|
66435
66157
|
*/
|
|
66436
66158
|
|
|
66437
66159
|
/**
|
|
@@ -66542,7 +66264,7 @@ class VoicemailApi {
|
|
|
66542
66264
|
/**
|
|
66543
66265
|
* Voicemail service.
|
|
66544
66266
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66545
|
-
* @version
|
|
66267
|
+
* @version 193.0.0
|
|
66546
66268
|
*/
|
|
66547
66269
|
|
|
66548
66270
|
/**
|
|
@@ -67209,7 +66931,7 @@ class WebChatApi {
|
|
|
67209
66931
|
/**
|
|
67210
66932
|
* WebChat service.
|
|
67211
66933
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67212
|
-
* @version
|
|
66934
|
+
* @version 193.0.0
|
|
67213
66935
|
*/
|
|
67214
66936
|
|
|
67215
66937
|
/**
|
|
@@ -67760,7 +67482,7 @@ class WebDeploymentsApi {
|
|
|
67760
67482
|
/**
|
|
67761
67483
|
* WebDeployments service.
|
|
67762
67484
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67763
|
-
* @version
|
|
67485
|
+
* @version 193.0.0
|
|
67764
67486
|
*/
|
|
67765
67487
|
|
|
67766
67488
|
/**
|
|
@@ -68287,7 +68009,7 @@ class WebMessagingApi {
|
|
|
68287
68009
|
/**
|
|
68288
68010
|
* WebMessaging service.
|
|
68289
68011
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68290
|
-
* @version
|
|
68012
|
+
* @version 193.0.0
|
|
68291
68013
|
*/
|
|
68292
68014
|
|
|
68293
68015
|
/**
|
|
@@ -68333,7 +68055,7 @@ class WidgetsApi {
|
|
|
68333
68055
|
/**
|
|
68334
68056
|
* Widgets service.
|
|
68335
68057
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68336
|
-
* @version
|
|
68058
|
+
* @version 193.0.0
|
|
68337
68059
|
*/
|
|
68338
68060
|
|
|
68339
68061
|
/**
|
|
@@ -68479,7 +68201,7 @@ class WorkforceManagementApi {
|
|
|
68479
68201
|
/**
|
|
68480
68202
|
* WorkforceManagement service.
|
|
68481
68203
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68482
|
-
* @version
|
|
68204
|
+
* @version 193.0.0
|
|
68483
68205
|
*/
|
|
68484
68206
|
|
|
68485
68207
|
/**
|
|
@@ -70519,6 +70241,7 @@ class WorkforceManagementApi {
|
|
|
70519
70241
|
* @param {String} agentId The agent id
|
|
70520
70242
|
* @param {Object} opts Optional parameters
|
|
70521
70243
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
70244
|
+
* @param {Array.<String>} opts.expand
|
|
70522
70245
|
*/
|
|
70523
70246
|
getWorkforcemanagementManagementunitAgent(managementUnitId, agentId, opts) {
|
|
70524
70247
|
opts = opts || {};
|
|
@@ -70536,7 +70259,7 @@ class WorkforceManagementApi {
|
|
|
70536
70259
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}',
|
|
70537
70260
|
'GET',
|
|
70538
70261
|
{ 'managementUnitId': managementUnitId,'agentId': agentId },
|
|
70539
|
-
{ 'excludeCapabilities': opts['excludeCapabilities'] },
|
|
70262
|
+
{ 'excludeCapabilities': opts['excludeCapabilities'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70540
70263
|
{ },
|
|
70541
70264
|
{ },
|
|
70542
70265
|
null,
|
|
@@ -71077,6 +70800,7 @@ class WorkforceManagementApi {
|
|
|
71077
70800
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
71078
70801
|
* @param {Object} opts Optional parameters
|
|
71079
70802
|
* @param {Array.<String>} opts.expand Include to access additional data on the work plans
|
|
70803
|
+
* @param {Array.<String>} opts.exclude Exclude specific data on the work plans from the response
|
|
71080
70804
|
*/
|
|
71081
70805
|
getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
71082
70806
|
opts = opts || {};
|
|
@@ -71090,7 +70814,7 @@ class WorkforceManagementApi {
|
|
|
71090
70814
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
71091
70815
|
'GET',
|
|
71092
70816
|
{ 'managementUnitId': managementUnitId },
|
|
71093
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70817
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'exclude': this.apiClient.buildCollectionParam(opts['exclude'], 'multi') },
|
|
71094
70818
|
{ },
|
|
71095
70819
|
{ },
|
|
71096
70820
|
null,
|
|
@@ -74390,7 +74114,7 @@ class WorkforceManagementApi {
|
|
|
74390
74114
|
* </pre>
|
|
74391
74115
|
* </p>
|
|
74392
74116
|
* @module purecloud-platform-client-v2/index
|
|
74393
|
-
* @version
|
|
74117
|
+
* @version 193.0.0
|
|
74394
74118
|
*/
|
|
74395
74119
|
class platformClient {
|
|
74396
74120
|
constructor() {
|