purecloud-platform-client-v2 192.2.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 +188 -467
- package/dist/web-amd/purecloud-platform-client-v2.js +188 -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/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
|
@@ -405,7 +405,7 @@ class Configuration {
|
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
407
|
* @module purecloud-platform-client-v2/ApiClient
|
|
408
|
-
* @version
|
|
408
|
+
* @version 193.0.0
|
|
409
409
|
*/
|
|
410
410
|
class ApiClient {
|
|
411
411
|
/**
|
|
@@ -1824,7 +1824,7 @@ class AlertingApi {
|
|
|
1824
1824
|
/**
|
|
1825
1825
|
* Alerting service.
|
|
1826
1826
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1827
|
-
* @version
|
|
1827
|
+
* @version 193.0.0
|
|
1828
1828
|
*/
|
|
1829
1829
|
|
|
1830
1830
|
/**
|
|
@@ -2485,7 +2485,7 @@ class AnalyticsApi {
|
|
|
2485
2485
|
/**
|
|
2486
2486
|
* Analytics service.
|
|
2487
2487
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2488
|
-
* @version
|
|
2488
|
+
* @version 193.0.0
|
|
2489
2489
|
*/
|
|
2490
2490
|
|
|
2491
2491
|
/**
|
|
@@ -2525,31 +2525,6 @@ class AnalyticsApi {
|
|
|
2525
2525
|
);
|
|
2526
2526
|
}
|
|
2527
2527
|
|
|
2528
|
-
/**
|
|
2529
|
-
* Delete a scheduled report job.
|
|
2530
|
-
*
|
|
2531
|
-
* @param {String} scheduleId Schedule ID
|
|
2532
|
-
*/
|
|
2533
|
-
deleteAnalyticsReportingSchedule(scheduleId) {
|
|
2534
|
-
// verify the required parameter 'scheduleId' is set
|
|
2535
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
2536
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteAnalyticsReportingSchedule';
|
|
2537
|
-
}
|
|
2538
|
-
|
|
2539
|
-
return this.apiClient.callApi(
|
|
2540
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
2541
|
-
'DELETE',
|
|
2542
|
-
{ 'scheduleId': scheduleId },
|
|
2543
|
-
{ },
|
|
2544
|
-
{ },
|
|
2545
|
-
{ },
|
|
2546
|
-
null,
|
|
2547
|
-
['PureCloud OAuth'],
|
|
2548
|
-
['application/json'],
|
|
2549
|
-
['application/json']
|
|
2550
|
-
);
|
|
2551
|
-
}
|
|
2552
|
-
|
|
2553
2528
|
/**
|
|
2554
2529
|
* Delete/cancel an async request
|
|
2555
2530
|
*
|
|
@@ -2631,9 +2606,44 @@ class AnalyticsApi {
|
|
|
2631
2606
|
);
|
|
2632
2607
|
}
|
|
2633
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
|
+
|
|
2634
2644
|
/**
|
|
2635
2645
|
* Get Reporting Turns.
|
|
2636
|
-
* 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.
|
|
2637
2647
|
* @param {String} botFlowId ID of the bot flow.
|
|
2638
2648
|
* @param {Object} opts Optional parameters
|
|
2639
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.
|
|
@@ -2643,6 +2653,7 @@ class AnalyticsApi {
|
|
|
2643
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.
|
|
2644
2654
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
2645
2655
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
2656
|
+
* @deprecated
|
|
2646
2657
|
*/
|
|
2647
2658
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
2648
2659
|
opts = opts || {};
|
|
@@ -3333,216 +3344,6 @@ class AnalyticsApi {
|
|
|
3333
3344
|
);
|
|
3334
3345
|
}
|
|
3335
3346
|
|
|
3336
|
-
/**
|
|
3337
|
-
* Get list of reporting metadata.
|
|
3338
|
-
*
|
|
3339
|
-
* @param {Object} opts Optional parameters
|
|
3340
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3341
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3342
|
-
* @param {String} opts.locale Locale
|
|
3343
|
-
*/
|
|
3344
|
-
getAnalyticsReportingMetadata(opts) {
|
|
3345
|
-
opts = opts || {};
|
|
3346
|
-
|
|
3347
|
-
|
|
3348
|
-
return this.apiClient.callApi(
|
|
3349
|
-
'/api/v2/analytics/reporting/metadata',
|
|
3350
|
-
'GET',
|
|
3351
|
-
{ },
|
|
3352
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'locale': opts['locale'] },
|
|
3353
|
-
{ },
|
|
3354
|
-
{ },
|
|
3355
|
-
null,
|
|
3356
|
-
['PureCloud OAuth'],
|
|
3357
|
-
['application/json'],
|
|
3358
|
-
['application/json']
|
|
3359
|
-
);
|
|
3360
|
-
}
|
|
3361
|
-
|
|
3362
|
-
/**
|
|
3363
|
-
* Get a reporting metadata.
|
|
3364
|
-
*
|
|
3365
|
-
* @param {String} reportId Report ID
|
|
3366
|
-
* @param {Object} opts Optional parameters
|
|
3367
|
-
* @param {String} opts.locale Locale
|
|
3368
|
-
*/
|
|
3369
|
-
getAnalyticsReportingReportIdMetadata(reportId, opts) {
|
|
3370
|
-
opts = opts || {};
|
|
3371
|
-
|
|
3372
|
-
// verify the required parameter 'reportId' is set
|
|
3373
|
-
if (reportId === undefined || reportId === null) {
|
|
3374
|
-
throw 'Missing the required parameter "reportId" when calling getAnalyticsReportingReportIdMetadata';
|
|
3375
|
-
}
|
|
3376
|
-
|
|
3377
|
-
return this.apiClient.callApi(
|
|
3378
|
-
'/api/v2/analytics/reporting/{reportId}/metadata',
|
|
3379
|
-
'GET',
|
|
3380
|
-
{ 'reportId': reportId },
|
|
3381
|
-
{ 'locale': opts['locale'] },
|
|
3382
|
-
{ },
|
|
3383
|
-
{ },
|
|
3384
|
-
null,
|
|
3385
|
-
['PureCloud OAuth'],
|
|
3386
|
-
['application/json'],
|
|
3387
|
-
['application/json']
|
|
3388
|
-
);
|
|
3389
|
-
}
|
|
3390
|
-
|
|
3391
|
-
/**
|
|
3392
|
-
* Get a list of report formats
|
|
3393
|
-
* Get a list of report formats.
|
|
3394
|
-
*/
|
|
3395
|
-
getAnalyticsReportingReportformats() {
|
|
3396
|
-
|
|
3397
|
-
return this.apiClient.callApi(
|
|
3398
|
-
'/api/v2/analytics/reporting/reportformats',
|
|
3399
|
-
'GET',
|
|
3400
|
-
{ },
|
|
3401
|
-
{ },
|
|
3402
|
-
{ },
|
|
3403
|
-
{ },
|
|
3404
|
-
null,
|
|
3405
|
-
['PureCloud OAuth'],
|
|
3406
|
-
['application/json'],
|
|
3407
|
-
['application/json']
|
|
3408
|
-
);
|
|
3409
|
-
}
|
|
3410
|
-
|
|
3411
|
-
/**
|
|
3412
|
-
* Get a scheduled report job.
|
|
3413
|
-
*
|
|
3414
|
-
* @param {String} scheduleId Schedule ID
|
|
3415
|
-
*/
|
|
3416
|
-
getAnalyticsReportingSchedule(scheduleId) {
|
|
3417
|
-
// verify the required parameter 'scheduleId' is set
|
|
3418
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3419
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingSchedule';
|
|
3420
|
-
}
|
|
3421
|
-
|
|
3422
|
-
return this.apiClient.callApi(
|
|
3423
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
3424
|
-
'GET',
|
|
3425
|
-
{ 'scheduleId': scheduleId },
|
|
3426
|
-
{ },
|
|
3427
|
-
{ },
|
|
3428
|
-
{ },
|
|
3429
|
-
null,
|
|
3430
|
-
['PureCloud OAuth'],
|
|
3431
|
-
['application/json'],
|
|
3432
|
-
['application/json']
|
|
3433
|
-
);
|
|
3434
|
-
}
|
|
3435
|
-
|
|
3436
|
-
/**
|
|
3437
|
-
* Get list of completed scheduled report jobs.
|
|
3438
|
-
*
|
|
3439
|
-
* @param {String} scheduleId Schedule ID
|
|
3440
|
-
* @param {Object} opts Optional parameters
|
|
3441
|
-
* @param {Number} opts.pageNumber (default to 1)
|
|
3442
|
-
* @param {Number} opts.pageSize (default to 25)
|
|
3443
|
-
*/
|
|
3444
|
-
getAnalyticsReportingScheduleHistory(scheduleId, opts) {
|
|
3445
|
-
opts = opts || {};
|
|
3446
|
-
|
|
3447
|
-
// verify the required parameter 'scheduleId' is set
|
|
3448
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3449
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistory';
|
|
3450
|
-
}
|
|
3451
|
-
|
|
3452
|
-
return this.apiClient.callApi(
|
|
3453
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history',
|
|
3454
|
-
'GET',
|
|
3455
|
-
{ 'scheduleId': scheduleId },
|
|
3456
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3457
|
-
{ },
|
|
3458
|
-
{ },
|
|
3459
|
-
null,
|
|
3460
|
-
['PureCloud OAuth'],
|
|
3461
|
-
['application/json'],
|
|
3462
|
-
['application/json']
|
|
3463
|
-
);
|
|
3464
|
-
}
|
|
3465
|
-
|
|
3466
|
-
/**
|
|
3467
|
-
* Get most recently completed scheduled report job.
|
|
3468
|
-
*
|
|
3469
|
-
* @param {String} scheduleId Schedule ID
|
|
3470
|
-
*/
|
|
3471
|
-
getAnalyticsReportingScheduleHistoryLatest(scheduleId) {
|
|
3472
|
-
// verify the required parameter 'scheduleId' is set
|
|
3473
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3474
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryLatest';
|
|
3475
|
-
}
|
|
3476
|
-
|
|
3477
|
-
return this.apiClient.callApi(
|
|
3478
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest',
|
|
3479
|
-
'GET',
|
|
3480
|
-
{ 'scheduleId': scheduleId },
|
|
3481
|
-
{ },
|
|
3482
|
-
{ },
|
|
3483
|
-
{ },
|
|
3484
|
-
null,
|
|
3485
|
-
['PureCloud OAuth'],
|
|
3486
|
-
['application/json'],
|
|
3487
|
-
['application/json']
|
|
3488
|
-
);
|
|
3489
|
-
}
|
|
3490
|
-
|
|
3491
|
-
/**
|
|
3492
|
-
* A completed scheduled report job
|
|
3493
|
-
* A completed scheduled report job.
|
|
3494
|
-
* @param {String} runId Run ID
|
|
3495
|
-
* @param {String} scheduleId Schedule ID
|
|
3496
|
-
*/
|
|
3497
|
-
getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId) {
|
|
3498
|
-
// verify the required parameter 'runId' is set
|
|
3499
|
-
if (runId === undefined || runId === null) {
|
|
3500
|
-
throw 'Missing the required parameter "runId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
3501
|
-
}
|
|
3502
|
-
// verify the required parameter 'scheduleId' is set
|
|
3503
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3504
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
3505
|
-
}
|
|
3506
|
-
|
|
3507
|
-
return this.apiClient.callApi(
|
|
3508
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}',
|
|
3509
|
-
'GET',
|
|
3510
|
-
{ 'runId': runId,'scheduleId': scheduleId },
|
|
3511
|
-
{ },
|
|
3512
|
-
{ },
|
|
3513
|
-
{ },
|
|
3514
|
-
null,
|
|
3515
|
-
['PureCloud OAuth'],
|
|
3516
|
-
['application/json'],
|
|
3517
|
-
['application/json']
|
|
3518
|
-
);
|
|
3519
|
-
}
|
|
3520
|
-
|
|
3521
|
-
/**
|
|
3522
|
-
* Get a list of scheduled report jobs
|
|
3523
|
-
* Get a list of scheduled report jobs.
|
|
3524
|
-
* @param {Object} opts Optional parameters
|
|
3525
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3526
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3527
|
-
*/
|
|
3528
|
-
getAnalyticsReportingSchedules(opts) {
|
|
3529
|
-
opts = opts || {};
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
return this.apiClient.callApi(
|
|
3533
|
-
'/api/v2/analytics/reporting/schedules',
|
|
3534
|
-
'GET',
|
|
3535
|
-
{ },
|
|
3536
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3537
|
-
{ },
|
|
3538
|
-
{ },
|
|
3539
|
-
null,
|
|
3540
|
-
['PureCloud OAuth'],
|
|
3541
|
-
['application/json'],
|
|
3542
|
-
['application/json']
|
|
3543
|
-
);
|
|
3544
|
-
}
|
|
3545
|
-
|
|
3546
3347
|
/**
|
|
3547
3348
|
* Get AnalyticsReportingSettings for an organization
|
|
3548
3349
|
*
|
|
@@ -3573,6 +3374,7 @@ class AnalyticsApi {
|
|
|
3573
3374
|
* @param {Number} opts.pageSize (default to 50)
|
|
3574
3375
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
3575
3376
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
3377
|
+
* @param {String} opts.name retrieve dashboards that match with given name
|
|
3576
3378
|
*/
|
|
3577
3379
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
3578
3380
|
opts = opts || {};
|
|
@@ -3586,27 +3388,7 @@ class AnalyticsApi {
|
|
|
3586
3388
|
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
3587
3389
|
'GET',
|
|
3588
3390
|
{ 'userId': userId },
|
|
3589
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
|
|
3590
|
-
{ },
|
|
3591
|
-
{ },
|
|
3592
|
-
null,
|
|
3593
|
-
['PureCloud OAuth'],
|
|
3594
|
-
['application/json'],
|
|
3595
|
-
['application/json']
|
|
3596
|
-
);
|
|
3597
|
-
}
|
|
3598
|
-
|
|
3599
|
-
/**
|
|
3600
|
-
* Get a list of report time periods.
|
|
3601
|
-
*
|
|
3602
|
-
*/
|
|
3603
|
-
getAnalyticsReportingTimeperiods() {
|
|
3604
|
-
|
|
3605
|
-
return this.apiClient.callApi(
|
|
3606
|
-
'/api/v2/analytics/reporting/timeperiods',
|
|
3607
|
-
'GET',
|
|
3608
|
-
{ },
|
|
3609
|
-
{ },
|
|
3391
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
|
|
3610
3392
|
{ },
|
|
3611
3393
|
{ },
|
|
3612
3394
|
null,
|
|
@@ -4135,7 +3917,6 @@ class AnalyticsApi {
|
|
|
4135
3917
|
* @param {Object} opts Optional parameters
|
|
4136
3918
|
* @param {Number} opts.pageSize The desired page size
|
|
4137
3919
|
* @param {Number} opts.pageNumber The desired page number
|
|
4138
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4139
3920
|
*/
|
|
4140
3921
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
4141
3922
|
opts = opts || {};
|
|
@@ -4394,7 +4175,6 @@ class AnalyticsApi {
|
|
|
4394
4175
|
* @param {Object} opts Optional parameters
|
|
4395
4176
|
* @param {Number} opts.pageSize The desired page size
|
|
4396
4177
|
* @param {Number} opts.pageNumber The desired page number
|
|
4397
|
-
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4398
4178
|
*/
|
|
4399
4179
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
4400
4180
|
opts = opts || {};
|
|
@@ -4696,58 +4476,6 @@ class AnalyticsApi {
|
|
|
4696
4476
|
);
|
|
4697
4477
|
}
|
|
4698
4478
|
|
|
4699
|
-
/**
|
|
4700
|
-
* Place a scheduled report immediately into the reporting queue
|
|
4701
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
4702
|
-
* @param {String} scheduleId Schedule ID
|
|
4703
|
-
* @deprecated
|
|
4704
|
-
*/
|
|
4705
|
-
postAnalyticsReportingScheduleRunreport(scheduleId) {
|
|
4706
|
-
// verify the required parameter 'scheduleId' is set
|
|
4707
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
4708
|
-
throw 'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';
|
|
4709
|
-
}
|
|
4710
|
-
|
|
4711
|
-
return this.apiClient.callApi(
|
|
4712
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/runreport',
|
|
4713
|
-
'POST',
|
|
4714
|
-
{ 'scheduleId': scheduleId },
|
|
4715
|
-
{ },
|
|
4716
|
-
{ },
|
|
4717
|
-
{ },
|
|
4718
|
-
null,
|
|
4719
|
-
['PureCloud OAuth'],
|
|
4720
|
-
['application/json'],
|
|
4721
|
-
['application/json']
|
|
4722
|
-
);
|
|
4723
|
-
}
|
|
4724
|
-
|
|
4725
|
-
/**
|
|
4726
|
-
* Create a scheduled report job
|
|
4727
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
4728
|
-
* @param {Object} body ReportSchedule
|
|
4729
|
-
* @deprecated
|
|
4730
|
-
*/
|
|
4731
|
-
postAnalyticsReportingSchedules(body) {
|
|
4732
|
-
// verify the required parameter 'body' is set
|
|
4733
|
-
if (body === undefined || body === null) {
|
|
4734
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';
|
|
4735
|
-
}
|
|
4736
|
-
|
|
4737
|
-
return this.apiClient.callApi(
|
|
4738
|
-
'/api/v2/analytics/reporting/schedules',
|
|
4739
|
-
'POST',
|
|
4740
|
-
{ },
|
|
4741
|
-
{ },
|
|
4742
|
-
{ },
|
|
4743
|
-
{ },
|
|
4744
|
-
body,
|
|
4745
|
-
['PureCloud OAuth'],
|
|
4746
|
-
['application/json'],
|
|
4747
|
-
['application/json']
|
|
4748
|
-
);
|
|
4749
|
-
}
|
|
4750
|
-
|
|
4751
4479
|
/**
|
|
4752
4480
|
* Bulk remove dashboard configurations
|
|
4753
4481
|
*
|
|
@@ -4831,7 +4559,6 @@ class AnalyticsApi {
|
|
|
4831
4559
|
* @param {Object} opts Optional parameters
|
|
4832
4560
|
* @param {Number} opts.pageSize The desired page size
|
|
4833
4561
|
* @param {Number} opts.pageNumber The desired page number
|
|
4834
|
-
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4835
4562
|
*/
|
|
4836
4563
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
4837
4564
|
opts = opts || {};
|
|
@@ -4965,7 +4692,6 @@ class AnalyticsApi {
|
|
|
4965
4692
|
* @param {Object} opts Optional parameters
|
|
4966
4693
|
* @param {Number} opts.pageSize The desired page size
|
|
4967
4694
|
* @param {Number} opts.pageNumber The desired page number
|
|
4968
|
-
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4969
4695
|
*/
|
|
4970
4696
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
4971
4697
|
opts = opts || {};
|
|
@@ -5047,7 +4773,6 @@ class AnalyticsApi {
|
|
|
5047
4773
|
* @param {Object} opts Optional parameters
|
|
5048
4774
|
* @param {Number} opts.pageSize The desired page size
|
|
5049
4775
|
* @param {Number} opts.pageNumber The desired page number
|
|
5050
|
-
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5051
4776
|
*/
|
|
5052
4777
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
5053
4778
|
opts = opts || {};
|
|
@@ -5222,44 +4947,13 @@ class AnalyticsApi {
|
|
|
5222
4947
|
);
|
|
5223
4948
|
}
|
|
5224
4949
|
|
|
5225
|
-
/**
|
|
5226
|
-
* Update a scheduled report job.
|
|
5227
|
-
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
5228
|
-
* @param {String} scheduleId Schedule ID
|
|
5229
|
-
* @param {Object} body ReportSchedule
|
|
5230
|
-
* @deprecated
|
|
5231
|
-
*/
|
|
5232
|
-
putAnalyticsReportingSchedule(scheduleId, body) {
|
|
5233
|
-
// verify the required parameter 'scheduleId' is set
|
|
5234
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
5235
|
-
throw 'Missing the required parameter "scheduleId" when calling putAnalyticsReportingSchedule';
|
|
5236
|
-
}
|
|
5237
|
-
// verify the required parameter 'body' is set
|
|
5238
|
-
if (body === undefined || body === null) {
|
|
5239
|
-
throw 'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';
|
|
5240
|
-
}
|
|
5241
|
-
|
|
5242
|
-
return this.apiClient.callApi(
|
|
5243
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
5244
|
-
'PUT',
|
|
5245
|
-
{ 'scheduleId': scheduleId },
|
|
5246
|
-
{ },
|
|
5247
|
-
{ },
|
|
5248
|
-
{ },
|
|
5249
|
-
body,
|
|
5250
|
-
['PureCloud OAuth'],
|
|
5251
|
-
['application/json'],
|
|
5252
|
-
['application/json']
|
|
5253
|
-
);
|
|
5254
|
-
}
|
|
5255
|
-
|
|
5256
4950
|
}
|
|
5257
4951
|
|
|
5258
4952
|
class ArchitectApi {
|
|
5259
4953
|
/**
|
|
5260
4954
|
* Architect service.
|
|
5261
4955
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5262
|
-
* @version
|
|
4956
|
+
* @version 193.0.0
|
|
5263
4957
|
*/
|
|
5264
4958
|
|
|
5265
4959
|
/**
|
|
@@ -9405,7 +9099,7 @@ class AuditApi {
|
|
|
9405
9099
|
/**
|
|
9406
9100
|
* Audit service.
|
|
9407
9101
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9408
|
-
* @version
|
|
9102
|
+
* @version 193.0.0
|
|
9409
9103
|
*/
|
|
9410
9104
|
|
|
9411
9105
|
/**
|
|
@@ -9576,7 +9270,7 @@ class AuthorizationApi {
|
|
|
9576
9270
|
/**
|
|
9577
9271
|
* Authorization service.
|
|
9578
9272
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9579
|
-
* @version
|
|
9273
|
+
* @version 193.0.0
|
|
9580
9274
|
*/
|
|
9581
9275
|
|
|
9582
9276
|
/**
|
|
@@ -10814,7 +10508,7 @@ class BillingApi {
|
|
|
10814
10508
|
/**
|
|
10815
10509
|
* Billing service.
|
|
10816
10510
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10817
|
-
* @version
|
|
10511
|
+
* @version 193.0.0
|
|
10818
10512
|
*/
|
|
10819
10513
|
|
|
10820
10514
|
/**
|
|
@@ -10894,7 +10588,7 @@ class CarrierServicesApi {
|
|
|
10894
10588
|
/**
|
|
10895
10589
|
* CarrierServices service.
|
|
10896
10590
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10897
|
-
* @version
|
|
10591
|
+
* @version 193.0.0
|
|
10898
10592
|
*/
|
|
10899
10593
|
|
|
10900
10594
|
/**
|
|
@@ -10964,7 +10658,7 @@ class ChatApi {
|
|
|
10964
10658
|
/**
|
|
10965
10659
|
* Chat service.
|
|
10966
10660
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10967
|
-
* @version
|
|
10661
|
+
* @version 193.0.0
|
|
10968
10662
|
*/
|
|
10969
10663
|
|
|
10970
10664
|
/**
|
|
@@ -11460,6 +11154,27 @@ class ChatApi {
|
|
|
11460
11154
|
);
|
|
11461
11155
|
}
|
|
11462
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
|
+
|
|
11463
11178
|
/**
|
|
11464
11179
|
* Set properties for a room
|
|
11465
11180
|
*
|
|
@@ -11616,6 +11331,32 @@ class ChatApi {
|
|
|
11616
11331
|
);
|
|
11617
11332
|
}
|
|
11618
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
|
+
|
|
11619
11360
|
/**
|
|
11620
11361
|
* Send a message to a room
|
|
11621
11362
|
*
|
|
@@ -11853,7 +11594,7 @@ class CoachingApi {
|
|
|
11853
11594
|
/**
|
|
11854
11595
|
* Coaching service.
|
|
11855
11596
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11856
|
-
* @version
|
|
11597
|
+
* @version 193.0.0
|
|
11857
11598
|
*/
|
|
11858
11599
|
|
|
11859
11600
|
/**
|
|
@@ -12430,7 +12171,7 @@ class ContentManagementApi {
|
|
|
12430
12171
|
/**
|
|
12431
12172
|
* ContentManagement service.
|
|
12432
12173
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12433
|
-
* @version
|
|
12174
|
+
* @version 193.0.0
|
|
12434
12175
|
*/
|
|
12435
12176
|
|
|
12436
12177
|
/**
|
|
@@ -13512,7 +13253,7 @@ class ConversationsApi {
|
|
|
13512
13253
|
/**
|
|
13513
13254
|
* Conversations service.
|
|
13514
13255
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13515
|
-
* @version
|
|
13256
|
+
* @version 193.0.0
|
|
13516
13257
|
*/
|
|
13517
13258
|
|
|
13518
13259
|
/**
|
|
@@ -17806,7 +17547,6 @@ class ConversationsApi {
|
|
|
17806
17547
|
* @param {Object} opts Optional parameters
|
|
17807
17548
|
* @param {Number} opts.pageSize The desired page size
|
|
17808
17549
|
* @param {Number} opts.pageNumber The desired page number
|
|
17809
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17810
17550
|
*/
|
|
17811
17551
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
17812
17552
|
opts = opts || {};
|
|
@@ -20754,7 +20494,7 @@ class DataExtensionsApi {
|
|
|
20754
20494
|
/**
|
|
20755
20495
|
* DataExtensions service.
|
|
20756
20496
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20757
|
-
* @version
|
|
20497
|
+
* @version 193.0.0
|
|
20758
20498
|
*/
|
|
20759
20499
|
|
|
20760
20500
|
/**
|
|
@@ -20840,7 +20580,7 @@ class DownloadsApi {
|
|
|
20840
20580
|
/**
|
|
20841
20581
|
* Downloads service.
|
|
20842
20582
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20843
|
-
* @version
|
|
20583
|
+
* @version 193.0.0
|
|
20844
20584
|
*/
|
|
20845
20585
|
|
|
20846
20586
|
/**
|
|
@@ -20892,7 +20632,7 @@ class EmailsApi {
|
|
|
20892
20632
|
/**
|
|
20893
20633
|
* Emails service.
|
|
20894
20634
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20895
|
-
* @version
|
|
20635
|
+
* @version 193.0.0
|
|
20896
20636
|
*/
|
|
20897
20637
|
|
|
20898
20638
|
/**
|
|
@@ -20957,7 +20697,7 @@ class EventsApi {
|
|
|
20957
20697
|
/**
|
|
20958
20698
|
* Events service.
|
|
20959
20699
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20960
|
-
* @version
|
|
20700
|
+
* @version 193.0.0
|
|
20961
20701
|
*/
|
|
20962
20702
|
|
|
20963
20703
|
/**
|
|
@@ -21053,7 +20793,7 @@ class ExternalContactsApi {
|
|
|
21053
20793
|
/**
|
|
21054
20794
|
* ExternalContacts service.
|
|
21055
20795
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21056
|
-
* @version
|
|
20796
|
+
* @version 193.0.0
|
|
21057
20797
|
*/
|
|
21058
20798
|
|
|
21059
20799
|
/**
|
|
@@ -23011,7 +22751,7 @@ class FaxApi {
|
|
|
23011
22751
|
/**
|
|
23012
22752
|
* Fax service.
|
|
23013
22753
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23014
|
-
* @version
|
|
22754
|
+
* @version 193.0.0
|
|
23015
22755
|
*/
|
|
23016
22756
|
|
|
23017
22757
|
/**
|
|
@@ -23226,7 +22966,7 @@ class FlowsApi {
|
|
|
23226
22966
|
/**
|
|
23227
22967
|
* Flows service.
|
|
23228
22968
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23229
|
-
* @version
|
|
22969
|
+
* @version 193.0.0
|
|
23230
22970
|
*/
|
|
23231
22971
|
|
|
23232
22972
|
/**
|
|
@@ -23304,7 +23044,6 @@ class FlowsApi {
|
|
|
23304
23044
|
* @param {Object} opts Optional parameters
|
|
23305
23045
|
* @param {Number} opts.pageSize The desired page size
|
|
23306
23046
|
* @param {Number} opts.pageNumber The desired page number
|
|
23307
|
-
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23308
23047
|
*/
|
|
23309
23048
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
23310
23049
|
opts = opts || {};
|
|
@@ -23410,7 +23149,7 @@ class GamificationApi {
|
|
|
23410
23149
|
/**
|
|
23411
23150
|
* Gamification service.
|
|
23412
23151
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23413
|
-
* @version
|
|
23152
|
+
* @version 193.0.0
|
|
23414
23153
|
*/
|
|
23415
23154
|
|
|
23416
23155
|
/**
|
|
@@ -25496,7 +25235,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25496
25235
|
/**
|
|
25497
25236
|
* GeneralDataProtectionRegulation service.
|
|
25498
25237
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25499
|
-
* @version
|
|
25238
|
+
* @version 193.0.0
|
|
25500
25239
|
*/
|
|
25501
25240
|
|
|
25502
25241
|
/**
|
|
@@ -25626,7 +25365,7 @@ class GeolocationApi {
|
|
|
25626
25365
|
/**
|
|
25627
25366
|
* Geolocation service.
|
|
25628
25367
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25629
|
-
* @version
|
|
25368
|
+
* @version 193.0.0
|
|
25630
25369
|
*/
|
|
25631
25370
|
|
|
25632
25371
|
/**
|
|
@@ -25757,7 +25496,7 @@ class GreetingsApi {
|
|
|
25757
25496
|
/**
|
|
25758
25497
|
* Greetings service.
|
|
25759
25498
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25760
|
-
* @version
|
|
25499
|
+
* @version 193.0.0
|
|
25761
25500
|
*/
|
|
25762
25501
|
|
|
25763
25502
|
/**
|
|
@@ -26212,7 +25951,7 @@ class GroupsApi {
|
|
|
26212
25951
|
/**
|
|
26213
25952
|
* Groups service.
|
|
26214
25953
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26215
|
-
* @version
|
|
25954
|
+
* @version 193.0.0
|
|
26216
25955
|
*/
|
|
26217
25956
|
|
|
26218
25957
|
/**
|
|
@@ -26731,7 +26470,7 @@ class IdentityProviderApi {
|
|
|
26731
26470
|
/**
|
|
26732
26471
|
* IdentityProvider service.
|
|
26733
26472
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26734
|
-
* @version
|
|
26473
|
+
* @version 193.0.0
|
|
26735
26474
|
*/
|
|
26736
26475
|
|
|
26737
26476
|
/**
|
|
@@ -27592,7 +27331,7 @@ class InfrastructureAsCodeApi {
|
|
|
27592
27331
|
/**
|
|
27593
27332
|
* InfrastructureAsCode service.
|
|
27594
27333
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27595
|
-
* @version
|
|
27334
|
+
* @version 193.0.0
|
|
27596
27335
|
*/
|
|
27597
27336
|
|
|
27598
27337
|
/**
|
|
@@ -27759,7 +27498,7 @@ class IntegrationsApi {
|
|
|
27759
27498
|
/**
|
|
27760
27499
|
* Integrations service.
|
|
27761
27500
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27762
|
-
* @version
|
|
27501
|
+
* @version 193.0.0
|
|
27763
27502
|
*/
|
|
27764
27503
|
|
|
27765
27504
|
/**
|
|
@@ -30111,7 +29850,7 @@ class JourneyApi {
|
|
|
30111
29850
|
/**
|
|
30112
29851
|
* Journey service.
|
|
30113
29852
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30114
|
-
* @version
|
|
29853
|
+
* @version 193.0.0
|
|
30115
29854
|
*/
|
|
30116
29855
|
|
|
30117
29856
|
/**
|
|
@@ -31700,7 +31439,7 @@ class KnowledgeApi {
|
|
|
31700
31439
|
/**
|
|
31701
31440
|
* Knowledge service.
|
|
31702
31441
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31703
|
-
* @version
|
|
31442
|
+
* @version 193.0.0
|
|
31704
31443
|
*/
|
|
31705
31444
|
|
|
31706
31445
|
/**
|
|
@@ -34943,7 +34682,7 @@ class LanguageUnderstandingApi {
|
|
|
34943
34682
|
/**
|
|
34944
34683
|
* LanguageUnderstanding service.
|
|
34945
34684
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34946
|
-
* @version
|
|
34685
|
+
* @version 193.0.0
|
|
34947
34686
|
*/
|
|
34948
34687
|
|
|
34949
34688
|
/**
|
|
@@ -35977,7 +35716,7 @@ class LanguagesApi {
|
|
|
35977
35716
|
/**
|
|
35978
35717
|
* Languages service.
|
|
35979
35718
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35980
|
-
* @version
|
|
35719
|
+
* @version 193.0.0
|
|
35981
35720
|
*/
|
|
35982
35721
|
|
|
35983
35722
|
/**
|
|
@@ -36199,7 +35938,7 @@ class LearningApi {
|
|
|
36199
35938
|
/**
|
|
36200
35939
|
* Learning service.
|
|
36201
35940
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36202
|
-
* @version
|
|
35941
|
+
* @version 193.0.0
|
|
36203
35942
|
*/
|
|
36204
35943
|
|
|
36205
35944
|
/**
|
|
@@ -37054,7 +36793,7 @@ class LicenseApi {
|
|
|
37054
36793
|
/**
|
|
37055
36794
|
* License service.
|
|
37056
36795
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37057
|
-
* @version
|
|
36796
|
+
* @version 193.0.0
|
|
37058
36797
|
*/
|
|
37059
36798
|
|
|
37060
36799
|
/**
|
|
@@ -37292,7 +37031,7 @@ class LocationsApi {
|
|
|
37292
37031
|
/**
|
|
37293
37032
|
* Locations service.
|
|
37294
37033
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37295
|
-
* @version
|
|
37034
|
+
* @version 193.0.0
|
|
37296
37035
|
*/
|
|
37297
37036
|
|
|
37298
37037
|
/**
|
|
@@ -37528,7 +37267,7 @@ class LogCaptureApi {
|
|
|
37528
37267
|
/**
|
|
37529
37268
|
* LogCapture service.
|
|
37530
37269
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37531
|
-
* @version
|
|
37270
|
+
* @version 193.0.0
|
|
37532
37271
|
*/
|
|
37533
37272
|
|
|
37534
37273
|
/**
|
|
@@ -37728,7 +37467,7 @@ class MessagingApi {
|
|
|
37728
37467
|
/**
|
|
37729
37468
|
* Messaging service.
|
|
37730
37469
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37731
|
-
* @version
|
|
37470
|
+
* @version 193.0.0
|
|
37732
37471
|
*/
|
|
37733
37472
|
|
|
37734
37473
|
/**
|
|
@@ -38087,7 +37826,7 @@ class MobileDevicesApi {
|
|
|
38087
37826
|
/**
|
|
38088
37827
|
* MobileDevices service.
|
|
38089
37828
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38090
|
-
* @version
|
|
37829
|
+
* @version 193.0.0
|
|
38091
37830
|
*/
|
|
38092
37831
|
|
|
38093
37832
|
/**
|
|
@@ -38238,7 +37977,7 @@ class NotificationsApi {
|
|
|
38238
37977
|
/**
|
|
38239
37978
|
* Notifications service.
|
|
38240
37979
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38241
|
-
* @version
|
|
37980
|
+
* @version 193.0.0
|
|
38242
37981
|
*/
|
|
38243
37982
|
|
|
38244
37983
|
/**
|
|
@@ -38471,7 +38210,7 @@ class OAuthApi {
|
|
|
38471
38210
|
/**
|
|
38472
38211
|
* OAuth service.
|
|
38473
38212
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38474
|
-
* @version
|
|
38213
|
+
* @version 193.0.0
|
|
38475
38214
|
*/
|
|
38476
38215
|
|
|
38477
38216
|
/**
|
|
@@ -38837,7 +38576,7 @@ class ObjectsApi {
|
|
|
38837
38576
|
/**
|
|
38838
38577
|
* Objects service.
|
|
38839
38578
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38840
|
-
* @version
|
|
38579
|
+
* @version 193.0.0
|
|
38841
38580
|
*/
|
|
38842
38581
|
|
|
38843
38582
|
/**
|
|
@@ -39107,7 +38846,7 @@ class OperationalEventsApi {
|
|
|
39107
38846
|
/**
|
|
39108
38847
|
* OperationalEvents service.
|
|
39109
38848
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39110
|
-
* @version
|
|
38849
|
+
* @version 193.0.0
|
|
39111
38850
|
*/
|
|
39112
38851
|
|
|
39113
38852
|
/**
|
|
@@ -39173,7 +38912,7 @@ class OrganizationApi {
|
|
|
39173
38912
|
/**
|
|
39174
38913
|
* Organization service.
|
|
39175
38914
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39176
|
-
* @version
|
|
38915
|
+
* @version 193.0.0
|
|
39177
38916
|
*/
|
|
39178
38917
|
|
|
39179
38918
|
/**
|
|
@@ -39349,6 +39088,26 @@ class OrganizationApi {
|
|
|
39349
39088
|
);
|
|
39350
39089
|
}
|
|
39351
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
|
+
|
|
39352
39111
|
/**
|
|
39353
39112
|
* Get the effective limits in a namespace for an organization
|
|
39354
39113
|
*
|
|
@@ -39628,7 +39387,7 @@ class OrganizationAuthorizationApi {
|
|
|
39628
39387
|
/**
|
|
39629
39388
|
* OrganizationAuthorization service.
|
|
39630
39389
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39631
|
-
* @version
|
|
39390
|
+
* @version 193.0.0
|
|
39632
39391
|
*/
|
|
39633
39392
|
|
|
39634
39393
|
/**
|
|
@@ -40975,7 +40734,7 @@ class OutboundApi {
|
|
|
40975
40734
|
/**
|
|
40976
40735
|
* Outbound service.
|
|
40977
40736
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40978
|
-
* @version
|
|
40737
|
+
* @version 193.0.0
|
|
40979
40738
|
*/
|
|
40980
40739
|
|
|
40981
40740
|
/**
|
|
@@ -45217,7 +44976,7 @@ class PresenceApi {
|
|
|
45217
44976
|
/**
|
|
45218
44977
|
* Presence service.
|
|
45219
44978
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45220
|
-
* @version
|
|
44979
|
+
* @version 193.0.0
|
|
45221
44980
|
*/
|
|
45222
44981
|
|
|
45223
44982
|
/**
|
|
@@ -45961,7 +45720,7 @@ class ProcessAutomationApi {
|
|
|
45961
45720
|
/**
|
|
45962
45721
|
* ProcessAutomation service.
|
|
45963
45722
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45964
|
-
* @version
|
|
45723
|
+
* @version 193.0.0
|
|
45965
45724
|
*/
|
|
45966
45725
|
|
|
45967
45726
|
/**
|
|
@@ -46200,7 +45959,7 @@ class QualityApi {
|
|
|
46200
45959
|
/**
|
|
46201
45960
|
* Quality service.
|
|
46202
45961
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46203
|
-
* @version
|
|
45962
|
+
* @version 193.0.0
|
|
46204
45963
|
*/
|
|
46205
45964
|
|
|
46206
45965
|
/**
|
|
@@ -46688,7 +46447,7 @@ class QualityApi {
|
|
|
46688
46447
|
|
|
46689
46448
|
/**
|
|
46690
46449
|
* Queries Evaluations and returns a paged list
|
|
46691
|
-
* 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.
|
|
46692
46451
|
* @param {Object} opts Optional parameters
|
|
46693
46452
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46694
46453
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -46708,7 +46467,7 @@ class QualityApi {
|
|
|
46708
46467
|
* @param {Array.<String>} opts.evaluationState
|
|
46709
46468
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
46710
46469
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
46711
|
-
* @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.
|
|
46712
46471
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
46713
46472
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
46714
46473
|
*/
|
|
@@ -47957,7 +47716,7 @@ class RecordingApi {
|
|
|
47957
47716
|
/**
|
|
47958
47717
|
* Recording service.
|
|
47959
47718
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47960
|
-
* @version
|
|
47719
|
+
* @version 193.0.0
|
|
47961
47720
|
*/
|
|
47962
47721
|
|
|
47963
47722
|
/**
|
|
@@ -49615,7 +49374,7 @@ class ResponseManagementApi {
|
|
|
49615
49374
|
/**
|
|
49616
49375
|
* ResponseManagement service.
|
|
49617
49376
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49618
|
-
* @version
|
|
49377
|
+
* @version 193.0.0
|
|
49619
49378
|
*/
|
|
49620
49379
|
|
|
49621
49380
|
/**
|
|
@@ -50125,7 +49884,7 @@ class RoutingApi {
|
|
|
50125
49884
|
/**
|
|
50126
49885
|
* Routing service.
|
|
50127
49886
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50128
|
-
* @version
|
|
49887
|
+
* @version 193.0.0
|
|
50129
49888
|
*/
|
|
50130
49889
|
|
|
50131
49890
|
/**
|
|
@@ -53022,7 +52781,6 @@ class RoutingApi {
|
|
|
53022
52781
|
* @param {Object} opts Optional parameters
|
|
53023
52782
|
* @param {Number} opts.pageSize The desired page size
|
|
53024
52783
|
* @param {Number} opts.pageNumber The desired page number
|
|
53025
|
-
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53026
52784
|
*/
|
|
53027
52785
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
53028
52786
|
opts = opts || {};
|
|
@@ -54105,7 +53863,7 @@ class SCIMApi {
|
|
|
54105
53863
|
/**
|
|
54106
53864
|
* SCIM service.
|
|
54107
53865
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54108
|
-
* @version
|
|
53866
|
+
* @version 193.0.0
|
|
54109
53867
|
*/
|
|
54110
53868
|
|
|
54111
53869
|
/**
|
|
@@ -54982,7 +54740,7 @@ class ScreenRecordingApi {
|
|
|
54982
54740
|
/**
|
|
54983
54741
|
* ScreenRecording service.
|
|
54984
54742
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54985
|
-
* @version
|
|
54743
|
+
* @version 193.0.0
|
|
54986
54744
|
*/
|
|
54987
54745
|
|
|
54988
54746
|
/**
|
|
@@ -55027,7 +54785,7 @@ class ScriptsApi {
|
|
|
55027
54785
|
/**
|
|
55028
54786
|
* Scripts service.
|
|
55029
54787
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55030
|
-
* @version
|
|
54788
|
+
* @version 193.0.0
|
|
55031
54789
|
*/
|
|
55032
54790
|
|
|
55033
54791
|
/**
|
|
@@ -55471,7 +55229,7 @@ class SearchApi {
|
|
|
55471
55229
|
/**
|
|
55472
55230
|
* Search service.
|
|
55473
55231
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55474
|
-
* @version
|
|
55232
|
+
* @version 193.0.0
|
|
55475
55233
|
*/
|
|
55476
55234
|
|
|
55477
55235
|
/**
|
|
@@ -56160,7 +55918,7 @@ class SettingsApi {
|
|
|
56160
55918
|
/**
|
|
56161
55919
|
* Settings service.
|
|
56162
55920
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56163
|
-
* @version
|
|
55921
|
+
* @version 193.0.0
|
|
56164
55922
|
*/
|
|
56165
55923
|
|
|
56166
55924
|
/**
|
|
@@ -56272,7 +56030,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56272
56030
|
/**
|
|
56273
56031
|
* SpeechTextAnalytics service.
|
|
56274
56032
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56275
|
-
* @version
|
|
56033
|
+
* @version 193.0.0
|
|
56276
56034
|
*/
|
|
56277
56035
|
|
|
56278
56036
|
/**
|
|
@@ -57386,7 +57144,7 @@ class StationsApi {
|
|
|
57386
57144
|
/**
|
|
57387
57145
|
* Stations service.
|
|
57388
57146
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57389
|
-
* @version
|
|
57147
|
+
* @version 193.0.0
|
|
57390
57148
|
*/
|
|
57391
57149
|
|
|
57392
57150
|
/**
|
|
@@ -57488,7 +57246,7 @@ class SuggestApi {
|
|
|
57488
57246
|
/**
|
|
57489
57247
|
* Suggest service.
|
|
57490
57248
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57491
|
-
* @version
|
|
57249
|
+
* @version 193.0.0
|
|
57492
57250
|
*/
|
|
57493
57251
|
|
|
57494
57252
|
/**
|
|
@@ -57627,7 +57385,7 @@ class TaskManagementApi {
|
|
|
57627
57385
|
/**
|
|
57628
57386
|
* TaskManagement service.
|
|
57629
57387
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57630
|
-
* @version
|
|
57388
|
+
* @version 193.0.0
|
|
57631
57389
|
*/
|
|
57632
57390
|
|
|
57633
57391
|
/**
|
|
@@ -57646,7 +57404,6 @@ class TaskManagementApi {
|
|
|
57646
57404
|
* Delete a workbin
|
|
57647
57405
|
*
|
|
57648
57406
|
* @param {String} workbinId Workbin ID
|
|
57649
|
-
* deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57650
57407
|
*/
|
|
57651
57408
|
deleteTaskmanagementWorkbin(workbinId) {
|
|
57652
57409
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57672,7 +57429,6 @@ class TaskManagementApi {
|
|
|
57672
57429
|
* Delete a workitem
|
|
57673
57430
|
*
|
|
57674
57431
|
* @param {String} workitemId Workitem ID
|
|
57675
|
-
* deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57676
57432
|
*/
|
|
57677
57433
|
deleteTaskmanagementWorkitem(workitemId) {
|
|
57678
57434
|
// verify the required parameter 'workitemId' is set
|
|
@@ -57698,7 +57454,6 @@ class TaskManagementApi {
|
|
|
57698
57454
|
* Delete a schema
|
|
57699
57455
|
*
|
|
57700
57456
|
* @param {String} schemaId Schema ID
|
|
57701
|
-
* deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57702
57457
|
*/
|
|
57703
57458
|
deleteTaskmanagementWorkitemsSchema(schemaId) {
|
|
57704
57459
|
// verify the required parameter 'schemaId' is set
|
|
@@ -57724,7 +57479,6 @@ class TaskManagementApi {
|
|
|
57724
57479
|
* Delete a worktype
|
|
57725
57480
|
*
|
|
57726
57481
|
* @param {String} worktypeId Worktype id
|
|
57727
|
-
* deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57728
57482
|
*/
|
|
57729
57483
|
deleteTaskmanagementWorktype(worktypeId) {
|
|
57730
57484
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57751,7 +57505,6 @@ class TaskManagementApi {
|
|
|
57751
57505
|
*
|
|
57752
57506
|
* @param {String} worktypeId Worktype id
|
|
57753
57507
|
* @param {String} statusId Status id
|
|
57754
|
-
* deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57755
57508
|
*/
|
|
57756
57509
|
deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
57757
57510
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57781,7 +57534,6 @@ class TaskManagementApi {
|
|
|
57781
57534
|
* Get a workbin
|
|
57782
57535
|
*
|
|
57783
57536
|
* @param {String} workbinId Workbin ID
|
|
57784
|
-
* getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57785
57537
|
*/
|
|
57786
57538
|
getTaskmanagementWorkbin(workbinId) {
|
|
57787
57539
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57904,7 +57656,6 @@ class TaskManagementApi {
|
|
|
57904
57656
|
* @param {String} workitemId Workitem ID
|
|
57905
57657
|
* @param {Object} opts Optional parameters
|
|
57906
57658
|
* @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
|
|
57907
|
-
* getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57908
57659
|
*/
|
|
57909
57660
|
getTaskmanagementWorkitem(workitemId, opts) {
|
|
57910
57661
|
opts = opts || {};
|
|
@@ -57970,7 +57721,6 @@ class TaskManagementApi {
|
|
|
57970
57721
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
57971
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)
|
|
57972
57723
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
57973
|
-
* getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57974
57724
|
*/
|
|
57975
57725
|
getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
|
|
57976
57726
|
opts = opts || {};
|
|
@@ -58070,7 +57820,6 @@ class TaskManagementApi {
|
|
|
58070
57820
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58071
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)
|
|
58072
57822
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
58073
|
-
* getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58074
57823
|
*/
|
|
58075
57824
|
getTaskmanagementWorkitemWrapups(workitemId, opts) {
|
|
58076
57825
|
opts = opts || {};
|
|
@@ -58098,7 +57847,6 @@ class TaskManagementApi {
|
|
|
58098
57847
|
* Get the workitem query job associated with the job id.
|
|
58099
57848
|
*
|
|
58100
57849
|
* @param {String} jobId jobId
|
|
58101
|
-
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58102
57850
|
*/
|
|
58103
57851
|
getTaskmanagementWorkitemsQueryJob(jobId) {
|
|
58104
57852
|
// verify the required parameter 'jobId' is set
|
|
@@ -58124,7 +57872,6 @@ class TaskManagementApi {
|
|
|
58124
57872
|
* Get results from for workitem query job
|
|
58125
57873
|
*
|
|
58126
57874
|
* @param {String} jobId jobId
|
|
58127
|
-
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58128
57875
|
*/
|
|
58129
57876
|
getTaskmanagementWorkitemsQueryJobResults(jobId) {
|
|
58130
57877
|
// verify the required parameter 'jobId' is set
|
|
@@ -58150,7 +57897,6 @@ class TaskManagementApi {
|
|
|
58150
57897
|
* Get a schema
|
|
58151
57898
|
*
|
|
58152
57899
|
* @param {String} schemaId Schema ID
|
|
58153
|
-
* getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58154
57900
|
*/
|
|
58155
57901
|
getTaskmanagementWorkitemsSchema(schemaId) {
|
|
58156
57902
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58177,7 +57923,6 @@ class TaskManagementApi {
|
|
|
58177
57923
|
*
|
|
58178
57924
|
* @param {String} schemaId Schema ID
|
|
58179
57925
|
* @param {String} versionId Schema version
|
|
58180
|
-
* getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58181
57926
|
*/
|
|
58182
57927
|
getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
|
|
58183
57928
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58207,7 +57952,6 @@ class TaskManagementApi {
|
|
|
58207
57952
|
* Get all versions of a schema
|
|
58208
57953
|
*
|
|
58209
57954
|
* @param {String} schemaId Schema ID
|
|
58210
|
-
* getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58211
57955
|
*/
|
|
58212
57956
|
getTaskmanagementWorkitemsSchemaVersions(schemaId) {
|
|
58213
57957
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58232,7 +57976,6 @@ class TaskManagementApi {
|
|
|
58232
57976
|
/**
|
|
58233
57977
|
* Get a list of schemas.
|
|
58234
57978
|
*
|
|
58235
|
-
* getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58236
57979
|
*/
|
|
58237
57980
|
getTaskmanagementWorkitemsSchemas() {
|
|
58238
57981
|
|
|
@@ -58256,7 +57999,6 @@ class TaskManagementApi {
|
|
|
58256
57999
|
* @param {String} worktypeId Worktype id
|
|
58257
58000
|
* @param {Object} opts Optional parameters
|
|
58258
58001
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
58259
|
-
* getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58260
58002
|
*/
|
|
58261
58003
|
getTaskmanagementWorktype(worktypeId, opts) {
|
|
58262
58004
|
opts = opts || {};
|
|
@@ -58317,7 +58059,6 @@ class TaskManagementApi {
|
|
|
58317
58059
|
*
|
|
58318
58060
|
* @param {String} worktypeId Worktype id
|
|
58319
58061
|
* @param {String} statusId Status id
|
|
58320
|
-
* getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58321
58062
|
*/
|
|
58322
58063
|
getTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
58323
58064
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58347,7 +58088,6 @@ class TaskManagementApi {
|
|
|
58347
58088
|
* Get list of statuses for this worktype.
|
|
58348
58089
|
*
|
|
58349
58090
|
* @param {String} worktypeId Worktype id
|
|
58350
|
-
* getTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58351
58091
|
*/
|
|
58352
58092
|
getTaskmanagementWorktypeStatuses(worktypeId) {
|
|
58353
58093
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58437,7 +58177,6 @@ class TaskManagementApi {
|
|
|
58437
58177
|
*
|
|
58438
58178
|
* @param {String} workbinId Workbin ID
|
|
58439
58179
|
* @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
|
|
58440
|
-
* patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58441
58180
|
*/
|
|
58442
58181
|
patchTaskmanagementWorkbin(workbinId, body) {
|
|
58443
58182
|
// verify the required parameter 'workbinId' is set
|
|
@@ -58468,7 +58207,6 @@ class TaskManagementApi {
|
|
|
58468
58207
|
*
|
|
58469
58208
|
* @param {String} workitemId Workitem ID
|
|
58470
58209
|
* @param {Object} body Workitem
|
|
58471
|
-
* patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58472
58210
|
*/
|
|
58473
58211
|
patchTaskmanagementWorkitem(workitemId, body) {
|
|
58474
58212
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58499,7 +58237,6 @@ class TaskManagementApi {
|
|
|
58499
58237
|
*
|
|
58500
58238
|
* @param {String} workitemId Workitem ID
|
|
58501
58239
|
* @param {Object} body Targeted user
|
|
58502
|
-
* patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58503
58240
|
*/
|
|
58504
58241
|
patchTaskmanagementWorkitemAssignment(workitemId, body) {
|
|
58505
58242
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58531,7 +58268,6 @@ class TaskManagementApi {
|
|
|
58531
58268
|
* @param {String} workitemId The ID of the Workitem.
|
|
58532
58269
|
* @param {String} userId The ID of the user
|
|
58533
58270
|
* @param {Object} body Request body to add/remove a wrapup code for a workitem
|
|
58534
|
-
* patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58535
58271
|
*/
|
|
58536
58272
|
patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
|
|
58537
58273
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58566,7 +58302,6 @@ class TaskManagementApi {
|
|
|
58566
58302
|
*
|
|
58567
58303
|
* @param {String} workitemId The ID of the Workitem.
|
|
58568
58304
|
* @param {Object} body Request body to add/remove the wrapup code for workitem
|
|
58569
|
-
* patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58570
58305
|
*/
|
|
58571
58306
|
patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
|
|
58572
58307
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58598,7 +58333,6 @@ class TaskManagementApi {
|
|
|
58598
58333
|
* @param {String} worktypeId Worktype id
|
|
58599
58334
|
* @param {Object} opts Optional parameters
|
|
58600
58335
|
* @param {Object} opts.body body
|
|
58601
|
-
* patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58602
58336
|
*/
|
|
58603
58337
|
patchTaskmanagementWorktype(worktypeId, opts) {
|
|
58604
58338
|
opts = opts || {};
|
|
@@ -58629,7 +58363,6 @@ class TaskManagementApi {
|
|
|
58629
58363
|
* @param {String} statusId Status id
|
|
58630
58364
|
* @param {Object} opts Optional parameters
|
|
58631
58365
|
* @param {Object} opts.body body
|
|
58632
|
-
* patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58633
58366
|
*/
|
|
58634
58367
|
patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
|
|
58635
58368
|
opts = opts || {};
|
|
@@ -58662,7 +58395,6 @@ class TaskManagementApi {
|
|
|
58662
58395
|
*
|
|
58663
58396
|
* @param {Object} opts Optional parameters
|
|
58664
58397
|
* @param {Object} opts.body body
|
|
58665
|
-
* postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58666
58398
|
*/
|
|
58667
58399
|
postTaskmanagementWorkbins(opts) {
|
|
58668
58400
|
opts = opts || {};
|
|
@@ -58686,7 +58418,6 @@ class TaskManagementApi {
|
|
|
58686
58418
|
* Query for workbins
|
|
58687
58419
|
*
|
|
58688
58420
|
* @param {Object} body QueryPostRequest
|
|
58689
|
-
* postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58690
58421
|
*/
|
|
58691
58422
|
postTaskmanagementWorkbinsQuery(body) {
|
|
58692
58423
|
// verify the required parameter 'body' is set
|
|
@@ -58712,7 +58443,6 @@ class TaskManagementApi {
|
|
|
58712
58443
|
* Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
|
|
58713
58444
|
*
|
|
58714
58445
|
* @param {String} workitemId Workitem ID
|
|
58715
|
-
* postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58716
58446
|
*/
|
|
58717
58447
|
postTaskmanagementWorkitemAcdCancel(workitemId) {
|
|
58718
58448
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58738,7 +58468,6 @@ class TaskManagementApi {
|
|
|
58738
58468
|
* Disconnect the assignee of the workitem
|
|
58739
58469
|
*
|
|
58740
58470
|
* @param {String} workitemId Workitem ID
|
|
58741
|
-
* postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58742
58471
|
*/
|
|
58743
58472
|
postTaskmanagementWorkitemDisconnect(workitemId) {
|
|
58744
58473
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58766,7 +58495,6 @@ class TaskManagementApi {
|
|
|
58766
58495
|
* @param {String} workitemId Workitem ID
|
|
58767
58496
|
* @param {Object} opts Optional parameters
|
|
58768
58497
|
* @param {Object} opts.body Terminated request
|
|
58769
|
-
* postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58770
58498
|
*/
|
|
58771
58499
|
postTaskmanagementWorkitemTerminate(workitemId, opts) {
|
|
58772
58500
|
opts = opts || {};
|
|
@@ -58794,7 +58522,6 @@ class TaskManagementApi {
|
|
|
58794
58522
|
* Create a workitem
|
|
58795
58523
|
*
|
|
58796
58524
|
* @param {Object} body Workitem
|
|
58797
|
-
* postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58798
58525
|
*/
|
|
58799
58526
|
postTaskmanagementWorkitems(body) {
|
|
58800
58527
|
// verify the required parameter 'body' is set
|
|
@@ -58846,7 +58573,6 @@ class TaskManagementApi {
|
|
|
58846
58573
|
* Create a workitem query job
|
|
58847
58574
|
*
|
|
58848
58575
|
* @param {Object} body WorkitemQueryJobCreate
|
|
58849
|
-
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58850
58576
|
*/
|
|
58851
58577
|
postTaskmanagementWorkitemsQueryJobs(body) {
|
|
58852
58578
|
// verify the required parameter 'body' is set
|
|
@@ -58872,7 +58598,6 @@ class TaskManagementApi {
|
|
|
58872
58598
|
* Create a schema
|
|
58873
58599
|
*
|
|
58874
58600
|
* @param {Object} body Schema
|
|
58875
|
-
* postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58876
58601
|
*/
|
|
58877
58602
|
postTaskmanagementWorkitemsSchemas(body) {
|
|
58878
58603
|
// verify the required parameter 'body' is set
|
|
@@ -58900,7 +58625,6 @@ class TaskManagementApi {
|
|
|
58900
58625
|
* @param {String} worktypeId Worktype id
|
|
58901
58626
|
* @param {Object} opts Optional parameters
|
|
58902
58627
|
* @param {Object} opts.body body
|
|
58903
|
-
* postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58904
58628
|
*/
|
|
58905
58629
|
postTaskmanagementWorktypeStatuses(worktypeId, opts) {
|
|
58906
58630
|
opts = opts || {};
|
|
@@ -58929,7 +58653,6 @@ class TaskManagementApi {
|
|
|
58929
58653
|
*
|
|
58930
58654
|
* @param {Object} opts Optional parameters
|
|
58931
58655
|
* @param {Object} opts.body body
|
|
58932
|
-
* postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58933
58656
|
*/
|
|
58934
58657
|
postTaskmanagementWorktypes(opts) {
|
|
58935
58658
|
opts = opts || {};
|
|
@@ -58953,7 +58676,6 @@ class TaskManagementApi {
|
|
|
58953
58676
|
* Query for worktypes
|
|
58954
58677
|
*
|
|
58955
58678
|
* @param {Object} body QueryPostRequest
|
|
58956
|
-
* postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58957
58679
|
*/
|
|
58958
58680
|
postTaskmanagementWorktypesQuery(body) {
|
|
58959
58681
|
// verify the required parameter 'body' is set
|
|
@@ -58980,7 +58702,6 @@ class TaskManagementApi {
|
|
|
58980
58702
|
*
|
|
58981
58703
|
* @param {String} schemaId Schema ID
|
|
58982
58704
|
* @param {Object} body Data Schema
|
|
58983
|
-
* putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58984
58705
|
*/
|
|
58985
58706
|
putTaskmanagementWorkitemsSchema(schemaId, body) {
|
|
58986
58707
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59012,7 +58733,7 @@ class TeamsApi {
|
|
|
59012
58733
|
/**
|
|
59013
58734
|
* Teams service.
|
|
59014
58735
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59015
|
-
* @version
|
|
58736
|
+
* @version 193.0.0
|
|
59016
58737
|
*/
|
|
59017
58738
|
|
|
59018
58739
|
/**
|
|
@@ -59204,7 +58925,6 @@ class TeamsApi {
|
|
|
59204
58925
|
* @param {Object} opts Optional parameters
|
|
59205
58926
|
* @param {Number} opts.pageSize The desired page size
|
|
59206
58927
|
* @param {Number} opts.pageNumber The desired page number
|
|
59207
|
-
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59208
58928
|
*/
|
|
59209
58929
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
59210
58930
|
opts = opts || {};
|
|
@@ -59314,7 +59034,7 @@ class TelephonyApi {
|
|
|
59314
59034
|
/**
|
|
59315
59035
|
* Telephony service.
|
|
59316
59036
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59317
|
-
* @version
|
|
59037
|
+
* @version 193.0.0
|
|
59318
59038
|
*/
|
|
59319
59039
|
|
|
59320
59040
|
/**
|
|
@@ -59496,7 +59216,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
59496
59216
|
/**
|
|
59497
59217
|
* TelephonyProvidersEdge service.
|
|
59498
59218
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59499
|
-
* @version
|
|
59219
|
+
* @version 193.0.0
|
|
59500
59220
|
*/
|
|
59501
59221
|
|
|
59502
59222
|
/**
|
|
@@ -62824,7 +62544,7 @@ class TextbotsApi {
|
|
|
62824
62544
|
/**
|
|
62825
62545
|
* Textbots service.
|
|
62826
62546
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62827
|
-
* @version
|
|
62547
|
+
* @version 193.0.0
|
|
62828
62548
|
*/
|
|
62829
62549
|
|
|
62830
62550
|
/**
|
|
@@ -62952,7 +62672,7 @@ class TokensApi {
|
|
|
62952
62672
|
/**
|
|
62953
62673
|
* Tokens service.
|
|
62954
62674
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62955
|
-
* @version
|
|
62675
|
+
* @version 193.0.0
|
|
62956
62676
|
*/
|
|
62957
62677
|
|
|
62958
62678
|
/**
|
|
@@ -63106,7 +62826,7 @@ class UploadsApi {
|
|
|
63106
62826
|
/**
|
|
63107
62827
|
* Uploads service.
|
|
63108
62828
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63109
|
-
* @version
|
|
62829
|
+
* @version 193.0.0
|
|
63110
62830
|
*/
|
|
63111
62831
|
|
|
63112
62832
|
/**
|
|
@@ -63375,7 +63095,7 @@ class UsageApi {
|
|
|
63375
63095
|
/**
|
|
63376
63096
|
* Usage service.
|
|
63377
63097
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63378
|
-
* @version
|
|
63098
|
+
* @version 193.0.0
|
|
63379
63099
|
*/
|
|
63380
63100
|
|
|
63381
63101
|
/**
|
|
@@ -63590,7 +63310,7 @@ class UserRecordingsApi {
|
|
|
63590
63310
|
/**
|
|
63591
63311
|
* UserRecordings service.
|
|
63592
63312
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63593
|
-
* @version
|
|
63313
|
+
* @version 193.0.0
|
|
63594
63314
|
*/
|
|
63595
63315
|
|
|
63596
63316
|
/**
|
|
@@ -63775,7 +63495,7 @@ class UsersApi {
|
|
|
63775
63495
|
/**
|
|
63776
63496
|
* Users service.
|
|
63777
63497
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63778
|
-
* @version
|
|
63498
|
+
* @version 193.0.0
|
|
63779
63499
|
*/
|
|
63780
63500
|
|
|
63781
63501
|
/**
|
|
@@ -65445,7 +65165,6 @@ class UsersApi {
|
|
|
65445
65165
|
* @param {Object} opts Optional parameters
|
|
65446
65166
|
* @param {Number} opts.pageSize The desired page size
|
|
65447
65167
|
* @param {Number} opts.pageNumber The desired page number
|
|
65448
|
-
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65449
65168
|
*/
|
|
65450
65169
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
65451
65170
|
opts = opts || {};
|
|
@@ -66434,7 +66153,7 @@ class UtilitiesApi {
|
|
|
66434
66153
|
/**
|
|
66435
66154
|
* Utilities service.
|
|
66436
66155
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66437
|
-
* @version
|
|
66156
|
+
* @version 193.0.0
|
|
66438
66157
|
*/
|
|
66439
66158
|
|
|
66440
66159
|
/**
|
|
@@ -66545,7 +66264,7 @@ class VoicemailApi {
|
|
|
66545
66264
|
/**
|
|
66546
66265
|
* Voicemail service.
|
|
66547
66266
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66548
|
-
* @version
|
|
66267
|
+
* @version 193.0.0
|
|
66549
66268
|
*/
|
|
66550
66269
|
|
|
66551
66270
|
/**
|
|
@@ -67212,7 +66931,7 @@ class WebChatApi {
|
|
|
67212
66931
|
/**
|
|
67213
66932
|
* WebChat service.
|
|
67214
66933
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67215
|
-
* @version
|
|
66934
|
+
* @version 193.0.0
|
|
67216
66935
|
*/
|
|
67217
66936
|
|
|
67218
66937
|
/**
|
|
@@ -67763,7 +67482,7 @@ class WebDeploymentsApi {
|
|
|
67763
67482
|
/**
|
|
67764
67483
|
* WebDeployments service.
|
|
67765
67484
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67766
|
-
* @version
|
|
67485
|
+
* @version 193.0.0
|
|
67767
67486
|
*/
|
|
67768
67487
|
|
|
67769
67488
|
/**
|
|
@@ -68290,7 +68009,7 @@ class WebMessagingApi {
|
|
|
68290
68009
|
/**
|
|
68291
68010
|
* WebMessaging service.
|
|
68292
68011
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68293
|
-
* @version
|
|
68012
|
+
* @version 193.0.0
|
|
68294
68013
|
*/
|
|
68295
68014
|
|
|
68296
68015
|
/**
|
|
@@ -68336,7 +68055,7 @@ class WidgetsApi {
|
|
|
68336
68055
|
/**
|
|
68337
68056
|
* Widgets service.
|
|
68338
68057
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68339
|
-
* @version
|
|
68058
|
+
* @version 193.0.0
|
|
68340
68059
|
*/
|
|
68341
68060
|
|
|
68342
68061
|
/**
|
|
@@ -68482,7 +68201,7 @@ class WorkforceManagementApi {
|
|
|
68482
68201
|
/**
|
|
68483
68202
|
* WorkforceManagement service.
|
|
68484
68203
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68485
|
-
* @version
|
|
68204
|
+
* @version 193.0.0
|
|
68486
68205
|
*/
|
|
68487
68206
|
|
|
68488
68207
|
/**
|
|
@@ -70522,6 +70241,7 @@ class WorkforceManagementApi {
|
|
|
70522
70241
|
* @param {String} agentId The agent id
|
|
70523
70242
|
* @param {Object} opts Optional parameters
|
|
70524
70243
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
70244
|
+
* @param {Array.<String>} opts.expand
|
|
70525
70245
|
*/
|
|
70526
70246
|
getWorkforcemanagementManagementunitAgent(managementUnitId, agentId, opts) {
|
|
70527
70247
|
opts = opts || {};
|
|
@@ -70539,7 +70259,7 @@ class WorkforceManagementApi {
|
|
|
70539
70259
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}',
|
|
70540
70260
|
'GET',
|
|
70541
70261
|
{ 'managementUnitId': managementUnitId,'agentId': agentId },
|
|
70542
|
-
{ 'excludeCapabilities': opts['excludeCapabilities'] },
|
|
70262
|
+
{ 'excludeCapabilities': opts['excludeCapabilities'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70543
70263
|
{ },
|
|
70544
70264
|
{ },
|
|
70545
70265
|
null,
|
|
@@ -71080,6 +70800,7 @@ class WorkforceManagementApi {
|
|
|
71080
70800
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
71081
70801
|
* @param {Object} opts Optional parameters
|
|
71082
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
|
|
71083
70804
|
*/
|
|
71084
70805
|
getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
71085
70806
|
opts = opts || {};
|
|
@@ -71093,7 +70814,7 @@ class WorkforceManagementApi {
|
|
|
71093
70814
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
71094
70815
|
'GET',
|
|
71095
70816
|
{ 'managementUnitId': managementUnitId },
|
|
71096
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70817
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'exclude': this.apiClient.buildCollectionParam(opts['exclude'], 'multi') },
|
|
71097
70818
|
{ },
|
|
71098
70819
|
{ },
|
|
71099
70820
|
null,
|
|
@@ -74393,7 +74114,7 @@ class WorkforceManagementApi {
|
|
|
74393
74114
|
* </pre>
|
|
74394
74115
|
* </p>
|
|
74395
74116
|
* @module purecloud-platform-client-v2/index
|
|
74396
|
-
* @version
|
|
74117
|
+
* @version 193.0.0
|
|
74397
74118
|
*/
|
|
74398
74119
|
class platformClient {
|
|
74399
74120
|
constructor() {
|