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
|
@@ -18,6 +18,9 @@ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
|
|
|
18
18
|
ap_south_1: 'aps1.pure.cloud',
|
|
19
19
|
us_east_2: 'use2.us-gov-pure.cloud',
|
|
20
20
|
sa_east_1: 'sae1.pure.cloud',
|
|
21
|
+
me_central_1: 'mec1.pure.cloud',
|
|
22
|
+
ap_northeast_3: 'apne3.pure.cloud',
|
|
23
|
+
eu_central_2: 'euc2.pure.cloud',
|
|
21
24
|
};
|
|
22
25
|
|
|
23
26
|
const logLevels = {
|
|
@@ -399,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
402
|
|
|
400
403
|
/**
|
|
401
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
405
|
+
* @version 193.0.0
|
|
403
406
|
*/
|
|
404
407
|
class ApiClient {
|
|
405
408
|
/**
|
|
@@ -1818,7 +1821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1818
1821
|
/**
|
|
1819
1822
|
* Alerting service.
|
|
1820
1823
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1821
|
-
* @version
|
|
1824
|
+
* @version 193.0.0
|
|
1822
1825
|
*/
|
|
1823
1826
|
|
|
1824
1827
|
/**
|
|
@@ -2479,7 +2482,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2479
2482
|
/**
|
|
2480
2483
|
* Analytics service.
|
|
2481
2484
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2482
|
-
* @version
|
|
2485
|
+
* @version 193.0.0
|
|
2483
2486
|
*/
|
|
2484
2487
|
|
|
2485
2488
|
/**
|
|
@@ -2519,31 +2522,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2519
2522
|
);
|
|
2520
2523
|
}
|
|
2521
2524
|
|
|
2522
|
-
/**
|
|
2523
|
-
* Delete a scheduled report job.
|
|
2524
|
-
*
|
|
2525
|
-
* @param {String} scheduleId Schedule ID
|
|
2526
|
-
*/
|
|
2527
|
-
deleteAnalyticsReportingSchedule(scheduleId) {
|
|
2528
|
-
// verify the required parameter 'scheduleId' is set
|
|
2529
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
2530
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteAnalyticsReportingSchedule';
|
|
2531
|
-
}
|
|
2532
|
-
|
|
2533
|
-
return this.apiClient.callApi(
|
|
2534
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
2535
|
-
'DELETE',
|
|
2536
|
-
{ 'scheduleId': scheduleId },
|
|
2537
|
-
{ },
|
|
2538
|
-
{ },
|
|
2539
|
-
{ },
|
|
2540
|
-
null,
|
|
2541
|
-
['PureCloud OAuth'],
|
|
2542
|
-
['application/json'],
|
|
2543
|
-
['application/json']
|
|
2544
|
-
);
|
|
2545
|
-
}
|
|
2546
|
-
|
|
2547
2525
|
/**
|
|
2548
2526
|
* Delete/cancel an async request
|
|
2549
2527
|
*
|
|
@@ -2625,9 +2603,44 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2625
2603
|
);
|
|
2626
2604
|
}
|
|
2627
2605
|
|
|
2606
|
+
/**
|
|
2607
|
+
* Get Reporting Turns (division aware).
|
|
2608
|
+
* 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.
|
|
2609
|
+
* @param {String} botFlowId ID of the bot flow.
|
|
2610
|
+
* @param {Object} opts Optional parameters
|
|
2611
|
+
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
2612
|
+
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
2613
|
+
* @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
|
|
2614
|
+
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
2615
|
+
* @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.
|
|
2616
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
2617
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
2618
|
+
*/
|
|
2619
|
+
getAnalyticsBotflowDivisionsReportingturns(botFlowId, opts) {
|
|
2620
|
+
opts = opts || {};
|
|
2621
|
+
|
|
2622
|
+
// verify the required parameter 'botFlowId' is set
|
|
2623
|
+
if (botFlowId === undefined || botFlowId === null) {
|
|
2624
|
+
throw 'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowDivisionsReportingturns';
|
|
2625
|
+
}
|
|
2626
|
+
|
|
2627
|
+
return this.apiClient.callApi(
|
|
2628
|
+
'/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns',
|
|
2629
|
+
'GET',
|
|
2630
|
+
{ 'botFlowId': botFlowId },
|
|
2631
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
2632
|
+
{ },
|
|
2633
|
+
{ },
|
|
2634
|
+
null,
|
|
2635
|
+
['PureCloud OAuth'],
|
|
2636
|
+
['application/json'],
|
|
2637
|
+
['application/json']
|
|
2638
|
+
);
|
|
2639
|
+
}
|
|
2640
|
+
|
|
2628
2641
|
/**
|
|
2629
2642
|
* Get Reporting Turns.
|
|
2630
|
-
* 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.
|
|
2643
|
+
* 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.
|
|
2631
2644
|
* @param {String} botFlowId ID of the bot flow.
|
|
2632
2645
|
* @param {Object} opts Optional parameters
|
|
2633
2646
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -2637,6 +2650,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2637
2650
|
* @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.
|
|
2638
2651
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
2639
2652
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
2653
|
+
* @deprecated
|
|
2640
2654
|
*/
|
|
2641
2655
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
2642
2656
|
opts = opts || {};
|
|
@@ -3327,216 +3341,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3327
3341
|
);
|
|
3328
3342
|
}
|
|
3329
3343
|
|
|
3330
|
-
/**
|
|
3331
|
-
* Get list of reporting metadata.
|
|
3332
|
-
*
|
|
3333
|
-
* @param {Object} opts Optional parameters
|
|
3334
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3335
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3336
|
-
* @param {String} opts.locale Locale
|
|
3337
|
-
*/
|
|
3338
|
-
getAnalyticsReportingMetadata(opts) {
|
|
3339
|
-
opts = opts || {};
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
return this.apiClient.callApi(
|
|
3343
|
-
'/api/v2/analytics/reporting/metadata',
|
|
3344
|
-
'GET',
|
|
3345
|
-
{ },
|
|
3346
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'locale': opts['locale'] },
|
|
3347
|
-
{ },
|
|
3348
|
-
{ },
|
|
3349
|
-
null,
|
|
3350
|
-
['PureCloud OAuth'],
|
|
3351
|
-
['application/json'],
|
|
3352
|
-
['application/json']
|
|
3353
|
-
);
|
|
3354
|
-
}
|
|
3355
|
-
|
|
3356
|
-
/**
|
|
3357
|
-
* Get a reporting metadata.
|
|
3358
|
-
*
|
|
3359
|
-
* @param {String} reportId Report ID
|
|
3360
|
-
* @param {Object} opts Optional parameters
|
|
3361
|
-
* @param {String} opts.locale Locale
|
|
3362
|
-
*/
|
|
3363
|
-
getAnalyticsReportingReportIdMetadata(reportId, opts) {
|
|
3364
|
-
opts = opts || {};
|
|
3365
|
-
|
|
3366
|
-
// verify the required parameter 'reportId' is set
|
|
3367
|
-
if (reportId === undefined || reportId === null) {
|
|
3368
|
-
throw 'Missing the required parameter "reportId" when calling getAnalyticsReportingReportIdMetadata';
|
|
3369
|
-
}
|
|
3370
|
-
|
|
3371
|
-
return this.apiClient.callApi(
|
|
3372
|
-
'/api/v2/analytics/reporting/{reportId}/metadata',
|
|
3373
|
-
'GET',
|
|
3374
|
-
{ 'reportId': reportId },
|
|
3375
|
-
{ 'locale': opts['locale'] },
|
|
3376
|
-
{ },
|
|
3377
|
-
{ },
|
|
3378
|
-
null,
|
|
3379
|
-
['PureCloud OAuth'],
|
|
3380
|
-
['application/json'],
|
|
3381
|
-
['application/json']
|
|
3382
|
-
);
|
|
3383
|
-
}
|
|
3384
|
-
|
|
3385
|
-
/**
|
|
3386
|
-
* Get a list of report formats
|
|
3387
|
-
* Get a list of report formats.
|
|
3388
|
-
*/
|
|
3389
|
-
getAnalyticsReportingReportformats() {
|
|
3390
|
-
|
|
3391
|
-
return this.apiClient.callApi(
|
|
3392
|
-
'/api/v2/analytics/reporting/reportformats',
|
|
3393
|
-
'GET',
|
|
3394
|
-
{ },
|
|
3395
|
-
{ },
|
|
3396
|
-
{ },
|
|
3397
|
-
{ },
|
|
3398
|
-
null,
|
|
3399
|
-
['PureCloud OAuth'],
|
|
3400
|
-
['application/json'],
|
|
3401
|
-
['application/json']
|
|
3402
|
-
);
|
|
3403
|
-
}
|
|
3404
|
-
|
|
3405
|
-
/**
|
|
3406
|
-
* Get a scheduled report job.
|
|
3407
|
-
*
|
|
3408
|
-
* @param {String} scheduleId Schedule ID
|
|
3409
|
-
*/
|
|
3410
|
-
getAnalyticsReportingSchedule(scheduleId) {
|
|
3411
|
-
// verify the required parameter 'scheduleId' is set
|
|
3412
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3413
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingSchedule';
|
|
3414
|
-
}
|
|
3415
|
-
|
|
3416
|
-
return this.apiClient.callApi(
|
|
3417
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
3418
|
-
'GET',
|
|
3419
|
-
{ 'scheduleId': scheduleId },
|
|
3420
|
-
{ },
|
|
3421
|
-
{ },
|
|
3422
|
-
{ },
|
|
3423
|
-
null,
|
|
3424
|
-
['PureCloud OAuth'],
|
|
3425
|
-
['application/json'],
|
|
3426
|
-
['application/json']
|
|
3427
|
-
);
|
|
3428
|
-
}
|
|
3429
|
-
|
|
3430
|
-
/**
|
|
3431
|
-
* Get list of completed scheduled report jobs.
|
|
3432
|
-
*
|
|
3433
|
-
* @param {String} scheduleId Schedule ID
|
|
3434
|
-
* @param {Object} opts Optional parameters
|
|
3435
|
-
* @param {Number} opts.pageNumber (default to 1)
|
|
3436
|
-
* @param {Number} opts.pageSize (default to 25)
|
|
3437
|
-
*/
|
|
3438
|
-
getAnalyticsReportingScheduleHistory(scheduleId, opts) {
|
|
3439
|
-
opts = opts || {};
|
|
3440
|
-
|
|
3441
|
-
// verify the required parameter 'scheduleId' is set
|
|
3442
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3443
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistory';
|
|
3444
|
-
}
|
|
3445
|
-
|
|
3446
|
-
return this.apiClient.callApi(
|
|
3447
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history',
|
|
3448
|
-
'GET',
|
|
3449
|
-
{ 'scheduleId': scheduleId },
|
|
3450
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3451
|
-
{ },
|
|
3452
|
-
{ },
|
|
3453
|
-
null,
|
|
3454
|
-
['PureCloud OAuth'],
|
|
3455
|
-
['application/json'],
|
|
3456
|
-
['application/json']
|
|
3457
|
-
);
|
|
3458
|
-
}
|
|
3459
|
-
|
|
3460
|
-
/**
|
|
3461
|
-
* Get most recently completed scheduled report job.
|
|
3462
|
-
*
|
|
3463
|
-
* @param {String} scheduleId Schedule ID
|
|
3464
|
-
*/
|
|
3465
|
-
getAnalyticsReportingScheduleHistoryLatest(scheduleId) {
|
|
3466
|
-
// verify the required parameter 'scheduleId' is set
|
|
3467
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3468
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryLatest';
|
|
3469
|
-
}
|
|
3470
|
-
|
|
3471
|
-
return this.apiClient.callApi(
|
|
3472
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest',
|
|
3473
|
-
'GET',
|
|
3474
|
-
{ 'scheduleId': scheduleId },
|
|
3475
|
-
{ },
|
|
3476
|
-
{ },
|
|
3477
|
-
{ },
|
|
3478
|
-
null,
|
|
3479
|
-
['PureCloud OAuth'],
|
|
3480
|
-
['application/json'],
|
|
3481
|
-
['application/json']
|
|
3482
|
-
);
|
|
3483
|
-
}
|
|
3484
|
-
|
|
3485
|
-
/**
|
|
3486
|
-
* A completed scheduled report job
|
|
3487
|
-
* A completed scheduled report job.
|
|
3488
|
-
* @param {String} runId Run ID
|
|
3489
|
-
* @param {String} scheduleId Schedule ID
|
|
3490
|
-
*/
|
|
3491
|
-
getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId) {
|
|
3492
|
-
// verify the required parameter 'runId' is set
|
|
3493
|
-
if (runId === undefined || runId === null) {
|
|
3494
|
-
throw 'Missing the required parameter "runId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
3495
|
-
}
|
|
3496
|
-
// verify the required parameter 'scheduleId' is set
|
|
3497
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
3498
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
3499
|
-
}
|
|
3500
|
-
|
|
3501
|
-
return this.apiClient.callApi(
|
|
3502
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}',
|
|
3503
|
-
'GET',
|
|
3504
|
-
{ 'runId': runId,'scheduleId': scheduleId },
|
|
3505
|
-
{ },
|
|
3506
|
-
{ },
|
|
3507
|
-
{ },
|
|
3508
|
-
null,
|
|
3509
|
-
['PureCloud OAuth'],
|
|
3510
|
-
['application/json'],
|
|
3511
|
-
['application/json']
|
|
3512
|
-
);
|
|
3513
|
-
}
|
|
3514
|
-
|
|
3515
|
-
/**
|
|
3516
|
-
* Get a list of scheduled report jobs
|
|
3517
|
-
* Get a list of scheduled report jobs.
|
|
3518
|
-
* @param {Object} opts Optional parameters
|
|
3519
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3520
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3521
|
-
*/
|
|
3522
|
-
getAnalyticsReportingSchedules(opts) {
|
|
3523
|
-
opts = opts || {};
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
return this.apiClient.callApi(
|
|
3527
|
-
'/api/v2/analytics/reporting/schedules',
|
|
3528
|
-
'GET',
|
|
3529
|
-
{ },
|
|
3530
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3531
|
-
{ },
|
|
3532
|
-
{ },
|
|
3533
|
-
null,
|
|
3534
|
-
['PureCloud OAuth'],
|
|
3535
|
-
['application/json'],
|
|
3536
|
-
['application/json']
|
|
3537
|
-
);
|
|
3538
|
-
}
|
|
3539
|
-
|
|
3540
3344
|
/**
|
|
3541
3345
|
* Get AnalyticsReportingSettings for an organization
|
|
3542
3346
|
*
|
|
@@ -3567,6 +3371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3567
3371
|
* @param {Number} opts.pageSize (default to 50)
|
|
3568
3372
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
3569
3373
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
3374
|
+
* @param {String} opts.name retrieve dashboards that match with given name
|
|
3570
3375
|
*/
|
|
3571
3376
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
3572
3377
|
opts = opts || {};
|
|
@@ -3580,27 +3385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3580
3385
|
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
3581
3386
|
'GET',
|
|
3582
3387
|
{ 'userId': userId },
|
|
3583
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
|
|
3584
|
-
{ },
|
|
3585
|
-
{ },
|
|
3586
|
-
null,
|
|
3587
|
-
['PureCloud OAuth'],
|
|
3588
|
-
['application/json'],
|
|
3589
|
-
['application/json']
|
|
3590
|
-
);
|
|
3591
|
-
}
|
|
3592
|
-
|
|
3593
|
-
/**
|
|
3594
|
-
* Get a list of report time periods.
|
|
3595
|
-
*
|
|
3596
|
-
*/
|
|
3597
|
-
getAnalyticsReportingTimeperiods() {
|
|
3598
|
-
|
|
3599
|
-
return this.apiClient.callApi(
|
|
3600
|
-
'/api/v2/analytics/reporting/timeperiods',
|
|
3601
|
-
'GET',
|
|
3602
|
-
{ },
|
|
3603
|
-
{ },
|
|
3388
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
|
|
3604
3389
|
{ },
|
|
3605
3390
|
{ },
|
|
3606
3391
|
null,
|
|
@@ -4129,7 +3914,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4129
3914
|
* @param {Object} opts Optional parameters
|
|
4130
3915
|
* @param {Number} opts.pageSize The desired page size
|
|
4131
3916
|
* @param {Number} opts.pageNumber The desired page number
|
|
4132
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4133
3917
|
*/
|
|
4134
3918
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
4135
3919
|
opts = opts || {};
|
|
@@ -4388,7 +4172,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4388
4172
|
* @param {Object} opts Optional parameters
|
|
4389
4173
|
* @param {Number} opts.pageSize The desired page size
|
|
4390
4174
|
* @param {Number} opts.pageNumber The desired page number
|
|
4391
|
-
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4392
4175
|
*/
|
|
4393
4176
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
4394
4177
|
opts = opts || {};
|
|
@@ -4690,58 +4473,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4690
4473
|
);
|
|
4691
4474
|
}
|
|
4692
4475
|
|
|
4693
|
-
/**
|
|
4694
|
-
* Place a scheduled report immediately into the reporting queue
|
|
4695
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
4696
|
-
* @param {String} scheduleId Schedule ID
|
|
4697
|
-
* @deprecated
|
|
4698
|
-
*/
|
|
4699
|
-
postAnalyticsReportingScheduleRunreport(scheduleId) {
|
|
4700
|
-
// verify the required parameter 'scheduleId' is set
|
|
4701
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
4702
|
-
throw 'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';
|
|
4703
|
-
}
|
|
4704
|
-
|
|
4705
|
-
return this.apiClient.callApi(
|
|
4706
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/runreport',
|
|
4707
|
-
'POST',
|
|
4708
|
-
{ 'scheduleId': scheduleId },
|
|
4709
|
-
{ },
|
|
4710
|
-
{ },
|
|
4711
|
-
{ },
|
|
4712
|
-
null,
|
|
4713
|
-
['PureCloud OAuth'],
|
|
4714
|
-
['application/json'],
|
|
4715
|
-
['application/json']
|
|
4716
|
-
);
|
|
4717
|
-
}
|
|
4718
|
-
|
|
4719
|
-
/**
|
|
4720
|
-
* Create a scheduled report job
|
|
4721
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
4722
|
-
* @param {Object} body ReportSchedule
|
|
4723
|
-
* @deprecated
|
|
4724
|
-
*/
|
|
4725
|
-
postAnalyticsReportingSchedules(body) {
|
|
4726
|
-
// verify the required parameter 'body' is set
|
|
4727
|
-
if (body === undefined || body === null) {
|
|
4728
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';
|
|
4729
|
-
}
|
|
4730
|
-
|
|
4731
|
-
return this.apiClient.callApi(
|
|
4732
|
-
'/api/v2/analytics/reporting/schedules',
|
|
4733
|
-
'POST',
|
|
4734
|
-
{ },
|
|
4735
|
-
{ },
|
|
4736
|
-
{ },
|
|
4737
|
-
{ },
|
|
4738
|
-
body,
|
|
4739
|
-
['PureCloud OAuth'],
|
|
4740
|
-
['application/json'],
|
|
4741
|
-
['application/json']
|
|
4742
|
-
);
|
|
4743
|
-
}
|
|
4744
|
-
|
|
4745
4476
|
/**
|
|
4746
4477
|
* Bulk remove dashboard configurations
|
|
4747
4478
|
*
|
|
@@ -4825,7 +4556,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4825
4556
|
* @param {Object} opts Optional parameters
|
|
4826
4557
|
* @param {Number} opts.pageSize The desired page size
|
|
4827
4558
|
* @param {Number} opts.pageNumber The desired page number
|
|
4828
|
-
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4829
4559
|
*/
|
|
4830
4560
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
4831
4561
|
opts = opts || {};
|
|
@@ -4959,7 +4689,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4959
4689
|
* @param {Object} opts Optional parameters
|
|
4960
4690
|
* @param {Number} opts.pageSize The desired page size
|
|
4961
4691
|
* @param {Number} opts.pageNumber The desired page number
|
|
4962
|
-
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4963
4692
|
*/
|
|
4964
4693
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
4965
4694
|
opts = opts || {};
|
|
@@ -5041,7 +4770,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5041
4770
|
* @param {Object} opts Optional parameters
|
|
5042
4771
|
* @param {Number} opts.pageSize The desired page size
|
|
5043
4772
|
* @param {Number} opts.pageNumber The desired page number
|
|
5044
|
-
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5045
4773
|
*/
|
|
5046
4774
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
5047
4775
|
opts = opts || {};
|
|
@@ -5216,44 +4944,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5216
4944
|
);
|
|
5217
4945
|
}
|
|
5218
4946
|
|
|
5219
|
-
/**
|
|
5220
|
-
* Update a scheduled report job.
|
|
5221
|
-
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
5222
|
-
* @param {String} scheduleId Schedule ID
|
|
5223
|
-
* @param {Object} body ReportSchedule
|
|
5224
|
-
* @deprecated
|
|
5225
|
-
*/
|
|
5226
|
-
putAnalyticsReportingSchedule(scheduleId, body) {
|
|
5227
|
-
// verify the required parameter 'scheduleId' is set
|
|
5228
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
5229
|
-
throw 'Missing the required parameter "scheduleId" when calling putAnalyticsReportingSchedule';
|
|
5230
|
-
}
|
|
5231
|
-
// verify the required parameter 'body' is set
|
|
5232
|
-
if (body === undefined || body === null) {
|
|
5233
|
-
throw 'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';
|
|
5234
|
-
}
|
|
5235
|
-
|
|
5236
|
-
return this.apiClient.callApi(
|
|
5237
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
5238
|
-
'PUT',
|
|
5239
|
-
{ 'scheduleId': scheduleId },
|
|
5240
|
-
{ },
|
|
5241
|
-
{ },
|
|
5242
|
-
{ },
|
|
5243
|
-
body,
|
|
5244
|
-
['PureCloud OAuth'],
|
|
5245
|
-
['application/json'],
|
|
5246
|
-
['application/json']
|
|
5247
|
-
);
|
|
5248
|
-
}
|
|
5249
|
-
|
|
5250
4947
|
}
|
|
5251
4948
|
|
|
5252
4949
|
class ArchitectApi {
|
|
5253
4950
|
/**
|
|
5254
4951
|
* Architect service.
|
|
5255
4952
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5256
|
-
* @version
|
|
4953
|
+
* @version 193.0.0
|
|
5257
4954
|
*/
|
|
5258
4955
|
|
|
5259
4956
|
/**
|
|
@@ -9399,7 +9096,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9399
9096
|
/**
|
|
9400
9097
|
* Audit service.
|
|
9401
9098
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9402
|
-
* @version
|
|
9099
|
+
* @version 193.0.0
|
|
9403
9100
|
*/
|
|
9404
9101
|
|
|
9405
9102
|
/**
|
|
@@ -9570,7 +9267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9570
9267
|
/**
|
|
9571
9268
|
* Authorization service.
|
|
9572
9269
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9573
|
-
* @version
|
|
9270
|
+
* @version 193.0.0
|
|
9574
9271
|
*/
|
|
9575
9272
|
|
|
9576
9273
|
/**
|
|
@@ -10808,7 +10505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10808
10505
|
/**
|
|
10809
10506
|
* Billing service.
|
|
10810
10507
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10811
|
-
* @version
|
|
10508
|
+
* @version 193.0.0
|
|
10812
10509
|
*/
|
|
10813
10510
|
|
|
10814
10511
|
/**
|
|
@@ -10888,7 +10585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10888
10585
|
/**
|
|
10889
10586
|
* CarrierServices service.
|
|
10890
10587
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10891
|
-
* @version
|
|
10588
|
+
* @version 193.0.0
|
|
10892
10589
|
*/
|
|
10893
10590
|
|
|
10894
10591
|
/**
|
|
@@ -10958,7 +10655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10958
10655
|
/**
|
|
10959
10656
|
* Chat service.
|
|
10960
10657
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10961
|
-
* @version
|
|
10658
|
+
* @version 193.0.0
|
|
10962
10659
|
*/
|
|
10963
10660
|
|
|
10964
10661
|
/**
|
|
@@ -11454,6 +11151,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11454
11151
|
);
|
|
11455
11152
|
}
|
|
11456
11153
|
|
|
11154
|
+
/**
|
|
11155
|
+
* Get a user's chat settings
|
|
11156
|
+
*
|
|
11157
|
+
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11158
|
+
*/
|
|
11159
|
+
getChatsUsersMeSettings() {
|
|
11160
|
+
|
|
11161
|
+
return this.apiClient.callApi(
|
|
11162
|
+
'/api/v2/chats/users/me/settings',
|
|
11163
|
+
'GET',
|
|
11164
|
+
{ },
|
|
11165
|
+
{ },
|
|
11166
|
+
{ },
|
|
11167
|
+
{ },
|
|
11168
|
+
null,
|
|
11169
|
+
['PureCloud OAuth'],
|
|
11170
|
+
['application/json'],
|
|
11171
|
+
['application/json']
|
|
11172
|
+
);
|
|
11173
|
+
}
|
|
11174
|
+
|
|
11457
11175
|
/**
|
|
11458
11176
|
* Set properties for a room
|
|
11459
11177
|
*
|
|
@@ -11610,6 +11328,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11610
11328
|
);
|
|
11611
11329
|
}
|
|
11612
11330
|
|
|
11331
|
+
/**
|
|
11332
|
+
* Update a user's chat settings
|
|
11333
|
+
*
|
|
11334
|
+
* @param {Object} body
|
|
11335
|
+
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11336
|
+
*/
|
|
11337
|
+
patchChatsUsersMeSettings(body) {
|
|
11338
|
+
// verify the required parameter 'body' is set
|
|
11339
|
+
if (body === undefined || body === null) {
|
|
11340
|
+
throw 'Missing the required parameter "body" when calling patchChatsUsersMeSettings';
|
|
11341
|
+
}
|
|
11342
|
+
|
|
11343
|
+
return this.apiClient.callApi(
|
|
11344
|
+
'/api/v2/chats/users/me/settings',
|
|
11345
|
+
'PATCH',
|
|
11346
|
+
{ },
|
|
11347
|
+
{ },
|
|
11348
|
+
{ },
|
|
11349
|
+
{ },
|
|
11350
|
+
body,
|
|
11351
|
+
['PureCloud OAuth'],
|
|
11352
|
+
['application/json'],
|
|
11353
|
+
['application/json']
|
|
11354
|
+
);
|
|
11355
|
+
}
|
|
11356
|
+
|
|
11613
11357
|
/**
|
|
11614
11358
|
* Send a message to a room
|
|
11615
11359
|
*
|
|
@@ -11847,7 +11591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11847
11591
|
/**
|
|
11848
11592
|
* Coaching service.
|
|
11849
11593
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11850
|
-
* @version
|
|
11594
|
+
* @version 193.0.0
|
|
11851
11595
|
*/
|
|
11852
11596
|
|
|
11853
11597
|
/**
|
|
@@ -12424,7 +12168,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12424
12168
|
/**
|
|
12425
12169
|
* ContentManagement service.
|
|
12426
12170
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12427
|
-
* @version
|
|
12171
|
+
* @version 193.0.0
|
|
12428
12172
|
*/
|
|
12429
12173
|
|
|
12430
12174
|
/**
|
|
@@ -13506,7 +13250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13506
13250
|
/**
|
|
13507
13251
|
* Conversations service.
|
|
13508
13252
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13509
|
-
* @version
|
|
13253
|
+
* @version 193.0.0
|
|
13510
13254
|
*/
|
|
13511
13255
|
|
|
13512
13256
|
/**
|
|
@@ -17800,7 +17544,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17800
17544
|
* @param {Object} opts Optional parameters
|
|
17801
17545
|
* @param {Number} opts.pageSize The desired page size
|
|
17802
17546
|
* @param {Number} opts.pageNumber The desired page number
|
|
17803
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17804
17547
|
*/
|
|
17805
17548
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
17806
17549
|
opts = opts || {};
|
|
@@ -20748,7 +20491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20748
20491
|
/**
|
|
20749
20492
|
* DataExtensions service.
|
|
20750
20493
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20751
|
-
* @version
|
|
20494
|
+
* @version 193.0.0
|
|
20752
20495
|
*/
|
|
20753
20496
|
|
|
20754
20497
|
/**
|
|
@@ -20834,7 +20577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20834
20577
|
/**
|
|
20835
20578
|
* Downloads service.
|
|
20836
20579
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20837
|
-
* @version
|
|
20580
|
+
* @version 193.0.0
|
|
20838
20581
|
*/
|
|
20839
20582
|
|
|
20840
20583
|
/**
|
|
@@ -20886,7 +20629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20886
20629
|
/**
|
|
20887
20630
|
* Emails service.
|
|
20888
20631
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20889
|
-
* @version
|
|
20632
|
+
* @version 193.0.0
|
|
20890
20633
|
*/
|
|
20891
20634
|
|
|
20892
20635
|
/**
|
|
@@ -20951,7 +20694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20951
20694
|
/**
|
|
20952
20695
|
* Events service.
|
|
20953
20696
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20954
|
-
* @version
|
|
20697
|
+
* @version 193.0.0
|
|
20955
20698
|
*/
|
|
20956
20699
|
|
|
20957
20700
|
/**
|
|
@@ -21047,7 +20790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21047
20790
|
/**
|
|
21048
20791
|
* ExternalContacts service.
|
|
21049
20792
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21050
|
-
* @version
|
|
20793
|
+
* @version 193.0.0
|
|
21051
20794
|
*/
|
|
21052
20795
|
|
|
21053
20796
|
/**
|
|
@@ -23005,7 +22748,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23005
22748
|
/**
|
|
23006
22749
|
* Fax service.
|
|
23007
22750
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23008
|
-
* @version
|
|
22751
|
+
* @version 193.0.0
|
|
23009
22752
|
*/
|
|
23010
22753
|
|
|
23011
22754
|
/**
|
|
@@ -23220,7 +22963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23220
22963
|
/**
|
|
23221
22964
|
* Flows service.
|
|
23222
22965
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23223
|
-
* @version
|
|
22966
|
+
* @version 193.0.0
|
|
23224
22967
|
*/
|
|
23225
22968
|
|
|
23226
22969
|
/**
|
|
@@ -23298,7 +23041,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23298
23041
|
* @param {Object} opts Optional parameters
|
|
23299
23042
|
* @param {Number} opts.pageSize The desired page size
|
|
23300
23043
|
* @param {Number} opts.pageNumber The desired page number
|
|
23301
|
-
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23302
23044
|
*/
|
|
23303
23045
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
23304
23046
|
opts = opts || {};
|
|
@@ -23404,7 +23146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23404
23146
|
/**
|
|
23405
23147
|
* Gamification service.
|
|
23406
23148
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23407
|
-
* @version
|
|
23149
|
+
* @version 193.0.0
|
|
23408
23150
|
*/
|
|
23409
23151
|
|
|
23410
23152
|
/**
|
|
@@ -25490,7 +25232,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25490
25232
|
/**
|
|
25491
25233
|
* GeneralDataProtectionRegulation service.
|
|
25492
25234
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25493
|
-
* @version
|
|
25235
|
+
* @version 193.0.0
|
|
25494
25236
|
*/
|
|
25495
25237
|
|
|
25496
25238
|
/**
|
|
@@ -25620,7 +25362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25620
25362
|
/**
|
|
25621
25363
|
* Geolocation service.
|
|
25622
25364
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25623
|
-
* @version
|
|
25365
|
+
* @version 193.0.0
|
|
25624
25366
|
*/
|
|
25625
25367
|
|
|
25626
25368
|
/**
|
|
@@ -25751,7 +25493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25751
25493
|
/**
|
|
25752
25494
|
* Greetings service.
|
|
25753
25495
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25754
|
-
* @version
|
|
25496
|
+
* @version 193.0.0
|
|
25755
25497
|
*/
|
|
25756
25498
|
|
|
25757
25499
|
/**
|
|
@@ -26206,7 +25948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26206
25948
|
/**
|
|
26207
25949
|
* Groups service.
|
|
26208
25950
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26209
|
-
* @version
|
|
25951
|
+
* @version 193.0.0
|
|
26210
25952
|
*/
|
|
26211
25953
|
|
|
26212
25954
|
/**
|
|
@@ -26725,7 +26467,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26725
26467
|
/**
|
|
26726
26468
|
* IdentityProvider service.
|
|
26727
26469
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26728
|
-
* @version
|
|
26470
|
+
* @version 193.0.0
|
|
26729
26471
|
*/
|
|
26730
26472
|
|
|
26731
26473
|
/**
|
|
@@ -27586,7 +27328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27586
27328
|
/**
|
|
27587
27329
|
* InfrastructureAsCode service.
|
|
27588
27330
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27589
|
-
* @version
|
|
27331
|
+
* @version 193.0.0
|
|
27590
27332
|
*/
|
|
27591
27333
|
|
|
27592
27334
|
/**
|
|
@@ -27753,7 +27495,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27753
27495
|
/**
|
|
27754
27496
|
* Integrations service.
|
|
27755
27497
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27756
|
-
* @version
|
|
27498
|
+
* @version 193.0.0
|
|
27757
27499
|
*/
|
|
27758
27500
|
|
|
27759
27501
|
/**
|
|
@@ -30105,7 +29847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30105
29847
|
/**
|
|
30106
29848
|
* Journey service.
|
|
30107
29849
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30108
|
-
* @version
|
|
29850
|
+
* @version 193.0.0
|
|
30109
29851
|
*/
|
|
30110
29852
|
|
|
30111
29853
|
/**
|
|
@@ -31694,7 +31436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31694
31436
|
/**
|
|
31695
31437
|
* Knowledge service.
|
|
31696
31438
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31697
|
-
* @version
|
|
31439
|
+
* @version 193.0.0
|
|
31698
31440
|
*/
|
|
31699
31441
|
|
|
31700
31442
|
/**
|
|
@@ -34937,7 +34679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34937
34679
|
/**
|
|
34938
34680
|
* LanguageUnderstanding service.
|
|
34939
34681
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34940
|
-
* @version
|
|
34682
|
+
* @version 193.0.0
|
|
34941
34683
|
*/
|
|
34942
34684
|
|
|
34943
34685
|
/**
|
|
@@ -35971,7 +35713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35971
35713
|
/**
|
|
35972
35714
|
* Languages service.
|
|
35973
35715
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35974
|
-
* @version
|
|
35716
|
+
* @version 193.0.0
|
|
35975
35717
|
*/
|
|
35976
35718
|
|
|
35977
35719
|
/**
|
|
@@ -36193,7 +35935,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36193
35935
|
/**
|
|
36194
35936
|
* Learning service.
|
|
36195
35937
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36196
|
-
* @version
|
|
35938
|
+
* @version 193.0.0
|
|
36197
35939
|
*/
|
|
36198
35940
|
|
|
36199
35941
|
/**
|
|
@@ -37048,7 +36790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37048
36790
|
/**
|
|
37049
36791
|
* License service.
|
|
37050
36792
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37051
|
-
* @version
|
|
36793
|
+
* @version 193.0.0
|
|
37052
36794
|
*/
|
|
37053
36795
|
|
|
37054
36796
|
/**
|
|
@@ -37286,7 +37028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37286
37028
|
/**
|
|
37287
37029
|
* Locations service.
|
|
37288
37030
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37289
|
-
* @version
|
|
37031
|
+
* @version 193.0.0
|
|
37290
37032
|
*/
|
|
37291
37033
|
|
|
37292
37034
|
/**
|
|
@@ -37522,7 +37264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37522
37264
|
/**
|
|
37523
37265
|
* LogCapture service.
|
|
37524
37266
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37525
|
-
* @version
|
|
37267
|
+
* @version 193.0.0
|
|
37526
37268
|
*/
|
|
37527
37269
|
|
|
37528
37270
|
/**
|
|
@@ -37722,7 +37464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37722
37464
|
/**
|
|
37723
37465
|
* Messaging service.
|
|
37724
37466
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37725
|
-
* @version
|
|
37467
|
+
* @version 193.0.0
|
|
37726
37468
|
*/
|
|
37727
37469
|
|
|
37728
37470
|
/**
|
|
@@ -38081,7 +37823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38081
37823
|
/**
|
|
38082
37824
|
* MobileDevices service.
|
|
38083
37825
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38084
|
-
* @version
|
|
37826
|
+
* @version 193.0.0
|
|
38085
37827
|
*/
|
|
38086
37828
|
|
|
38087
37829
|
/**
|
|
@@ -38232,7 +37974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38232
37974
|
/**
|
|
38233
37975
|
* Notifications service.
|
|
38234
37976
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38235
|
-
* @version
|
|
37977
|
+
* @version 193.0.0
|
|
38236
37978
|
*/
|
|
38237
37979
|
|
|
38238
37980
|
/**
|
|
@@ -38465,7 +38207,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38465
38207
|
/**
|
|
38466
38208
|
* OAuth service.
|
|
38467
38209
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38468
|
-
* @version
|
|
38210
|
+
* @version 193.0.0
|
|
38469
38211
|
*/
|
|
38470
38212
|
|
|
38471
38213
|
/**
|
|
@@ -38831,7 +38573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38831
38573
|
/**
|
|
38832
38574
|
* Objects service.
|
|
38833
38575
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38834
|
-
* @version
|
|
38576
|
+
* @version 193.0.0
|
|
38835
38577
|
*/
|
|
38836
38578
|
|
|
38837
38579
|
/**
|
|
@@ -39101,7 +38843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39101
38843
|
/**
|
|
39102
38844
|
* OperationalEvents service.
|
|
39103
38845
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39104
|
-
* @version
|
|
38846
|
+
* @version 193.0.0
|
|
39105
38847
|
*/
|
|
39106
38848
|
|
|
39107
38849
|
/**
|
|
@@ -39167,7 +38909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39167
38909
|
/**
|
|
39168
38910
|
* Organization service.
|
|
39169
38911
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39170
|
-
* @version
|
|
38912
|
+
* @version 193.0.0
|
|
39171
38913
|
*/
|
|
39172
38914
|
|
|
39173
38915
|
/**
|
|
@@ -39343,6 +39085,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39343
39085
|
);
|
|
39344
39086
|
}
|
|
39345
39087
|
|
|
39088
|
+
/**
|
|
39089
|
+
* Get free trial limit documentation
|
|
39090
|
+
*
|
|
39091
|
+
*/
|
|
39092
|
+
getOrganizationsLimitsDocsFreetrial() {
|
|
39093
|
+
|
|
39094
|
+
return this.apiClient.callApi(
|
|
39095
|
+
'/api/v2/organizations/limits/docs/freetrial',
|
|
39096
|
+
'GET',
|
|
39097
|
+
{ },
|
|
39098
|
+
{ },
|
|
39099
|
+
{ },
|
|
39100
|
+
{ },
|
|
39101
|
+
null,
|
|
39102
|
+
['PureCloud OAuth'],
|
|
39103
|
+
['application/json'],
|
|
39104
|
+
['application/json']
|
|
39105
|
+
);
|
|
39106
|
+
}
|
|
39107
|
+
|
|
39346
39108
|
/**
|
|
39347
39109
|
* Get the effective limits in a namespace for an organization
|
|
39348
39110
|
*
|
|
@@ -39622,7 +39384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39622
39384
|
/**
|
|
39623
39385
|
* OrganizationAuthorization service.
|
|
39624
39386
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39625
|
-
* @version
|
|
39387
|
+
* @version 193.0.0
|
|
39626
39388
|
*/
|
|
39627
39389
|
|
|
39628
39390
|
/**
|
|
@@ -40969,7 +40731,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40969
40731
|
/**
|
|
40970
40732
|
* Outbound service.
|
|
40971
40733
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40972
|
-
* @version
|
|
40734
|
+
* @version 193.0.0
|
|
40973
40735
|
*/
|
|
40974
40736
|
|
|
40975
40737
|
/**
|
|
@@ -45211,7 +44973,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45211
44973
|
/**
|
|
45212
44974
|
* Presence service.
|
|
45213
44975
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45214
|
-
* @version
|
|
44976
|
+
* @version 193.0.0
|
|
45215
44977
|
*/
|
|
45216
44978
|
|
|
45217
44979
|
/**
|
|
@@ -45955,7 +45717,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45955
45717
|
/**
|
|
45956
45718
|
* ProcessAutomation service.
|
|
45957
45719
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45958
|
-
* @version
|
|
45720
|
+
* @version 193.0.0
|
|
45959
45721
|
*/
|
|
45960
45722
|
|
|
45961
45723
|
/**
|
|
@@ -46194,7 +45956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46194
45956
|
/**
|
|
46195
45957
|
* Quality service.
|
|
46196
45958
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46197
|
-
* @version
|
|
45959
|
+
* @version 193.0.0
|
|
46198
45960
|
*/
|
|
46199
45961
|
|
|
46200
45962
|
/**
|
|
@@ -46682,7 +46444,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46682
46444
|
|
|
46683
46445
|
/**
|
|
46684
46446
|
* Queries Evaluations and returns a paged list
|
|
46685
|
-
* 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.
|
|
46447
|
+
* 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.
|
|
46686
46448
|
* @param {Object} opts Optional parameters
|
|
46687
46449
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46688
46450
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -46702,7 +46464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46702
46464
|
* @param {Array.<String>} opts.evaluationState
|
|
46703
46465
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
46704
46466
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
46705
|
-
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
46467
|
+
* @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.
|
|
46706
46468
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
46707
46469
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
46708
46470
|
*/
|
|
@@ -47951,7 +47713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47951
47713
|
/**
|
|
47952
47714
|
* Recording service.
|
|
47953
47715
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47954
|
-
* @version
|
|
47716
|
+
* @version 193.0.0
|
|
47955
47717
|
*/
|
|
47956
47718
|
|
|
47957
47719
|
/**
|
|
@@ -49609,7 +49371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49609
49371
|
/**
|
|
49610
49372
|
* ResponseManagement service.
|
|
49611
49373
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49612
|
-
* @version
|
|
49374
|
+
* @version 193.0.0
|
|
49613
49375
|
*/
|
|
49614
49376
|
|
|
49615
49377
|
/**
|
|
@@ -50119,7 +49881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50119
49881
|
/**
|
|
50120
49882
|
* Routing service.
|
|
50121
49883
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50122
|
-
* @version
|
|
49884
|
+
* @version 193.0.0
|
|
50123
49885
|
*/
|
|
50124
49886
|
|
|
50125
49887
|
/**
|
|
@@ -53016,7 +52778,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53016
52778
|
* @param {Object} opts Optional parameters
|
|
53017
52779
|
* @param {Number} opts.pageSize The desired page size
|
|
53018
52780
|
* @param {Number} opts.pageNumber The desired page number
|
|
53019
|
-
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53020
52781
|
*/
|
|
53021
52782
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
53022
52783
|
opts = opts || {};
|
|
@@ -54099,7 +53860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54099
53860
|
/**
|
|
54100
53861
|
* SCIM service.
|
|
54101
53862
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54102
|
-
* @version
|
|
53863
|
+
* @version 193.0.0
|
|
54103
53864
|
*/
|
|
54104
53865
|
|
|
54105
53866
|
/**
|
|
@@ -54976,7 +54737,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54976
54737
|
/**
|
|
54977
54738
|
* ScreenRecording service.
|
|
54978
54739
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54979
|
-
* @version
|
|
54740
|
+
* @version 193.0.0
|
|
54980
54741
|
*/
|
|
54981
54742
|
|
|
54982
54743
|
/**
|
|
@@ -55021,7 +54782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55021
54782
|
/**
|
|
55022
54783
|
* Scripts service.
|
|
55023
54784
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55024
|
-
* @version
|
|
54785
|
+
* @version 193.0.0
|
|
55025
54786
|
*/
|
|
55026
54787
|
|
|
55027
54788
|
/**
|
|
@@ -55465,7 +55226,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55465
55226
|
/**
|
|
55466
55227
|
* Search service.
|
|
55467
55228
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55468
|
-
* @version
|
|
55229
|
+
* @version 193.0.0
|
|
55469
55230
|
*/
|
|
55470
55231
|
|
|
55471
55232
|
/**
|
|
@@ -56154,7 +55915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56154
55915
|
/**
|
|
56155
55916
|
* Settings service.
|
|
56156
55917
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56157
|
-
* @version
|
|
55918
|
+
* @version 193.0.0
|
|
56158
55919
|
*/
|
|
56159
55920
|
|
|
56160
55921
|
/**
|
|
@@ -56266,7 +56027,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56266
56027
|
/**
|
|
56267
56028
|
* SpeechTextAnalytics service.
|
|
56268
56029
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56269
|
-
* @version
|
|
56030
|
+
* @version 193.0.0
|
|
56270
56031
|
*/
|
|
56271
56032
|
|
|
56272
56033
|
/**
|
|
@@ -57380,7 +57141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57380
57141
|
/**
|
|
57381
57142
|
* Stations service.
|
|
57382
57143
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57383
|
-
* @version
|
|
57144
|
+
* @version 193.0.0
|
|
57384
57145
|
*/
|
|
57385
57146
|
|
|
57386
57147
|
/**
|
|
@@ -57482,7 +57243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57482
57243
|
/**
|
|
57483
57244
|
* Suggest service.
|
|
57484
57245
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57485
|
-
* @version
|
|
57246
|
+
* @version 193.0.0
|
|
57486
57247
|
*/
|
|
57487
57248
|
|
|
57488
57249
|
/**
|
|
@@ -57621,7 +57382,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57621
57382
|
/**
|
|
57622
57383
|
* TaskManagement service.
|
|
57623
57384
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57624
|
-
* @version
|
|
57385
|
+
* @version 193.0.0
|
|
57625
57386
|
*/
|
|
57626
57387
|
|
|
57627
57388
|
/**
|
|
@@ -57640,7 +57401,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57640
57401
|
* Delete a workbin
|
|
57641
57402
|
*
|
|
57642
57403
|
* @param {String} workbinId Workbin ID
|
|
57643
|
-
* deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57644
57404
|
*/
|
|
57645
57405
|
deleteTaskmanagementWorkbin(workbinId) {
|
|
57646
57406
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57666,7 +57426,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57666
57426
|
* Delete a workitem
|
|
57667
57427
|
*
|
|
57668
57428
|
* @param {String} workitemId Workitem ID
|
|
57669
|
-
* deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57670
57429
|
*/
|
|
57671
57430
|
deleteTaskmanagementWorkitem(workitemId) {
|
|
57672
57431
|
// verify the required parameter 'workitemId' is set
|
|
@@ -57692,7 +57451,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57692
57451
|
* Delete a schema
|
|
57693
57452
|
*
|
|
57694
57453
|
* @param {String} schemaId Schema ID
|
|
57695
|
-
* deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57696
57454
|
*/
|
|
57697
57455
|
deleteTaskmanagementWorkitemsSchema(schemaId) {
|
|
57698
57456
|
// verify the required parameter 'schemaId' is set
|
|
@@ -57718,7 +57476,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57718
57476
|
* Delete a worktype
|
|
57719
57477
|
*
|
|
57720
57478
|
* @param {String} worktypeId Worktype id
|
|
57721
|
-
* deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57722
57479
|
*/
|
|
57723
57480
|
deleteTaskmanagementWorktype(worktypeId) {
|
|
57724
57481
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57745,7 +57502,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57745
57502
|
*
|
|
57746
57503
|
* @param {String} worktypeId Worktype id
|
|
57747
57504
|
* @param {String} statusId Status id
|
|
57748
|
-
* deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57749
57505
|
*/
|
|
57750
57506
|
deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
57751
57507
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57775,7 +57531,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57775
57531
|
* Get a workbin
|
|
57776
57532
|
*
|
|
57777
57533
|
* @param {String} workbinId Workbin ID
|
|
57778
|
-
* getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57779
57534
|
*/
|
|
57780
57535
|
getTaskmanagementWorkbin(workbinId) {
|
|
57781
57536
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57898,7 +57653,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57898
57653
|
* @param {String} workitemId Workitem ID
|
|
57899
57654
|
* @param {Object} opts Optional parameters
|
|
57900
57655
|
* @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
|
|
57901
|
-
* getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57902
57656
|
*/
|
|
57903
57657
|
getTaskmanagementWorkitem(workitemId, opts) {
|
|
57904
57658
|
opts = opts || {};
|
|
@@ -57964,7 +57718,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57964
57718
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
57965
57719
|
* @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)
|
|
57966
57720
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
57967
|
-
* getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57968
57721
|
*/
|
|
57969
57722
|
getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
|
|
57970
57723
|
opts = opts || {};
|
|
@@ -58064,7 +57817,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58064
57817
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58065
57818
|
* @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)
|
|
58066
57819
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
58067
|
-
* getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58068
57820
|
*/
|
|
58069
57821
|
getTaskmanagementWorkitemWrapups(workitemId, opts) {
|
|
58070
57822
|
opts = opts || {};
|
|
@@ -58092,7 +57844,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58092
57844
|
* Get the workitem query job associated with the job id.
|
|
58093
57845
|
*
|
|
58094
57846
|
* @param {String} jobId jobId
|
|
58095
|
-
* getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58096
57847
|
*/
|
|
58097
57848
|
getTaskmanagementWorkitemsQueryJob(jobId) {
|
|
58098
57849
|
// verify the required parameter 'jobId' is set
|
|
@@ -58118,7 +57869,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58118
57869
|
* Get results from for workitem query job
|
|
58119
57870
|
*
|
|
58120
57871
|
* @param {String} jobId jobId
|
|
58121
|
-
* getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58122
57872
|
*/
|
|
58123
57873
|
getTaskmanagementWorkitemsQueryJobResults(jobId) {
|
|
58124
57874
|
// verify the required parameter 'jobId' is set
|
|
@@ -58144,7 +57894,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58144
57894
|
* Get a schema
|
|
58145
57895
|
*
|
|
58146
57896
|
* @param {String} schemaId Schema ID
|
|
58147
|
-
* getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58148
57897
|
*/
|
|
58149
57898
|
getTaskmanagementWorkitemsSchema(schemaId) {
|
|
58150
57899
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58171,7 +57920,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58171
57920
|
*
|
|
58172
57921
|
* @param {String} schemaId Schema ID
|
|
58173
57922
|
* @param {String} versionId Schema version
|
|
58174
|
-
* getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58175
57923
|
*/
|
|
58176
57924
|
getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
|
|
58177
57925
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58201,7 +57949,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58201
57949
|
* Get all versions of a schema
|
|
58202
57950
|
*
|
|
58203
57951
|
* @param {String} schemaId Schema ID
|
|
58204
|
-
* getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58205
57952
|
*/
|
|
58206
57953
|
getTaskmanagementWorkitemsSchemaVersions(schemaId) {
|
|
58207
57954
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58226,7 +57973,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58226
57973
|
/**
|
|
58227
57974
|
* Get a list of schemas.
|
|
58228
57975
|
*
|
|
58229
|
-
* getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58230
57976
|
*/
|
|
58231
57977
|
getTaskmanagementWorkitemsSchemas() {
|
|
58232
57978
|
|
|
@@ -58250,7 +57996,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58250
57996
|
* @param {String} worktypeId Worktype id
|
|
58251
57997
|
* @param {Object} opts Optional parameters
|
|
58252
57998
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
58253
|
-
* getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58254
57999
|
*/
|
|
58255
58000
|
getTaskmanagementWorktype(worktypeId, opts) {
|
|
58256
58001
|
opts = opts || {};
|
|
@@ -58311,7 +58056,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58311
58056
|
*
|
|
58312
58057
|
* @param {String} worktypeId Worktype id
|
|
58313
58058
|
* @param {String} statusId Status id
|
|
58314
|
-
* getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58315
58059
|
*/
|
|
58316
58060
|
getTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
58317
58061
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58341,7 +58085,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58341
58085
|
* Get list of statuses for this worktype.
|
|
58342
58086
|
*
|
|
58343
58087
|
* @param {String} worktypeId Worktype id
|
|
58344
|
-
* getTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58345
58088
|
*/
|
|
58346
58089
|
getTaskmanagementWorktypeStatuses(worktypeId) {
|
|
58347
58090
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58431,7 +58174,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58431
58174
|
*
|
|
58432
58175
|
* @param {String} workbinId Workbin ID
|
|
58433
58176
|
* @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
|
|
58434
|
-
* patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58435
58177
|
*/
|
|
58436
58178
|
patchTaskmanagementWorkbin(workbinId, body) {
|
|
58437
58179
|
// verify the required parameter 'workbinId' is set
|
|
@@ -58462,7 +58204,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58462
58204
|
*
|
|
58463
58205
|
* @param {String} workitemId Workitem ID
|
|
58464
58206
|
* @param {Object} body Workitem
|
|
58465
|
-
* patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58466
58207
|
*/
|
|
58467
58208
|
patchTaskmanagementWorkitem(workitemId, body) {
|
|
58468
58209
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58493,7 +58234,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58493
58234
|
*
|
|
58494
58235
|
* @param {String} workitemId Workitem ID
|
|
58495
58236
|
* @param {Object} body Targeted user
|
|
58496
|
-
* patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58497
58237
|
*/
|
|
58498
58238
|
patchTaskmanagementWorkitemAssignment(workitemId, body) {
|
|
58499
58239
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58525,7 +58265,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58525
58265
|
* @param {String} workitemId The ID of the Workitem.
|
|
58526
58266
|
* @param {String} userId The ID of the user
|
|
58527
58267
|
* @param {Object} body Request body to add/remove a wrapup code for a workitem
|
|
58528
|
-
* patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58529
58268
|
*/
|
|
58530
58269
|
patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
|
|
58531
58270
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58560,7 +58299,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58560
58299
|
*
|
|
58561
58300
|
* @param {String} workitemId The ID of the Workitem.
|
|
58562
58301
|
* @param {Object} body Request body to add/remove the wrapup code for workitem
|
|
58563
|
-
* patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58564
58302
|
*/
|
|
58565
58303
|
patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
|
|
58566
58304
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58592,7 +58330,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58592
58330
|
* @param {String} worktypeId Worktype id
|
|
58593
58331
|
* @param {Object} opts Optional parameters
|
|
58594
58332
|
* @param {Object} opts.body body
|
|
58595
|
-
* patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58596
58333
|
*/
|
|
58597
58334
|
patchTaskmanagementWorktype(worktypeId, opts) {
|
|
58598
58335
|
opts = opts || {};
|
|
@@ -58623,7 +58360,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58623
58360
|
* @param {String} statusId Status id
|
|
58624
58361
|
* @param {Object} opts Optional parameters
|
|
58625
58362
|
* @param {Object} opts.body body
|
|
58626
|
-
* patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58627
58363
|
*/
|
|
58628
58364
|
patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
|
|
58629
58365
|
opts = opts || {};
|
|
@@ -58656,7 +58392,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58656
58392
|
*
|
|
58657
58393
|
* @param {Object} opts Optional parameters
|
|
58658
58394
|
* @param {Object} opts.body body
|
|
58659
|
-
* postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58660
58395
|
*/
|
|
58661
58396
|
postTaskmanagementWorkbins(opts) {
|
|
58662
58397
|
opts = opts || {};
|
|
@@ -58680,7 +58415,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58680
58415
|
* Query for workbins
|
|
58681
58416
|
*
|
|
58682
58417
|
* @param {Object} body QueryPostRequest
|
|
58683
|
-
* postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58684
58418
|
*/
|
|
58685
58419
|
postTaskmanagementWorkbinsQuery(body) {
|
|
58686
58420
|
// verify the required parameter 'body' is set
|
|
@@ -58706,7 +58440,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58706
58440
|
* Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
|
|
58707
58441
|
*
|
|
58708
58442
|
* @param {String} workitemId Workitem ID
|
|
58709
|
-
* postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58710
58443
|
*/
|
|
58711
58444
|
postTaskmanagementWorkitemAcdCancel(workitemId) {
|
|
58712
58445
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58732,7 +58465,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58732
58465
|
* Disconnect the assignee of the workitem
|
|
58733
58466
|
*
|
|
58734
58467
|
* @param {String} workitemId Workitem ID
|
|
58735
|
-
* postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58736
58468
|
*/
|
|
58737
58469
|
postTaskmanagementWorkitemDisconnect(workitemId) {
|
|
58738
58470
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58760,7 +58492,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58760
58492
|
* @param {String} workitemId Workitem ID
|
|
58761
58493
|
* @param {Object} opts Optional parameters
|
|
58762
58494
|
* @param {Object} opts.body Terminated request
|
|
58763
|
-
* postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58764
58495
|
*/
|
|
58765
58496
|
postTaskmanagementWorkitemTerminate(workitemId, opts) {
|
|
58766
58497
|
opts = opts || {};
|
|
@@ -58788,7 +58519,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58788
58519
|
* Create a workitem
|
|
58789
58520
|
*
|
|
58790
58521
|
* @param {Object} body Workitem
|
|
58791
|
-
* postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58792
58522
|
*/
|
|
58793
58523
|
postTaskmanagementWorkitems(body) {
|
|
58794
58524
|
// verify the required parameter 'body' is set
|
|
@@ -58840,7 +58570,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58840
58570
|
* Create a workitem query job
|
|
58841
58571
|
*
|
|
58842
58572
|
* @param {Object} body WorkitemQueryJobCreate
|
|
58843
|
-
* postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58844
58573
|
*/
|
|
58845
58574
|
postTaskmanagementWorkitemsQueryJobs(body) {
|
|
58846
58575
|
// verify the required parameter 'body' is set
|
|
@@ -58866,7 +58595,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58866
58595
|
* Create a schema
|
|
58867
58596
|
*
|
|
58868
58597
|
* @param {Object} body Schema
|
|
58869
|
-
* postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58870
58598
|
*/
|
|
58871
58599
|
postTaskmanagementWorkitemsSchemas(body) {
|
|
58872
58600
|
// verify the required parameter 'body' is set
|
|
@@ -58894,7 +58622,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58894
58622
|
* @param {String} worktypeId Worktype id
|
|
58895
58623
|
* @param {Object} opts Optional parameters
|
|
58896
58624
|
* @param {Object} opts.body body
|
|
58897
|
-
* postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58898
58625
|
*/
|
|
58899
58626
|
postTaskmanagementWorktypeStatuses(worktypeId, opts) {
|
|
58900
58627
|
opts = opts || {};
|
|
@@ -58923,7 +58650,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58923
58650
|
*
|
|
58924
58651
|
* @param {Object} opts Optional parameters
|
|
58925
58652
|
* @param {Object} opts.body body
|
|
58926
|
-
* postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58927
58653
|
*/
|
|
58928
58654
|
postTaskmanagementWorktypes(opts) {
|
|
58929
58655
|
opts = opts || {};
|
|
@@ -58947,7 +58673,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58947
58673
|
* Query for worktypes
|
|
58948
58674
|
*
|
|
58949
58675
|
* @param {Object} body QueryPostRequest
|
|
58950
|
-
* postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58951
58676
|
*/
|
|
58952
58677
|
postTaskmanagementWorktypesQuery(body) {
|
|
58953
58678
|
// verify the required parameter 'body' is set
|
|
@@ -58974,7 +58699,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58974
58699
|
*
|
|
58975
58700
|
* @param {String} schemaId Schema ID
|
|
58976
58701
|
* @param {Object} body Data Schema
|
|
58977
|
-
* putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58978
58702
|
*/
|
|
58979
58703
|
putTaskmanagementWorkitemsSchema(schemaId, body) {
|
|
58980
58704
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59006,7 +58730,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59006
58730
|
/**
|
|
59007
58731
|
* Teams service.
|
|
59008
58732
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59009
|
-
* @version
|
|
58733
|
+
* @version 193.0.0
|
|
59010
58734
|
*/
|
|
59011
58735
|
|
|
59012
58736
|
/**
|
|
@@ -59198,7 +58922,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59198
58922
|
* @param {Object} opts Optional parameters
|
|
59199
58923
|
* @param {Number} opts.pageSize The desired page size
|
|
59200
58924
|
* @param {Number} opts.pageNumber The desired page number
|
|
59201
|
-
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59202
58925
|
*/
|
|
59203
58926
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
59204
58927
|
opts = opts || {};
|
|
@@ -59308,7 +59031,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59308
59031
|
/**
|
|
59309
59032
|
* Telephony service.
|
|
59310
59033
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59311
|
-
* @version
|
|
59034
|
+
* @version 193.0.0
|
|
59312
59035
|
*/
|
|
59313
59036
|
|
|
59314
59037
|
/**
|
|
@@ -59490,7 +59213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59490
59213
|
/**
|
|
59491
59214
|
* TelephonyProvidersEdge service.
|
|
59492
59215
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59493
|
-
* @version
|
|
59216
|
+
* @version 193.0.0
|
|
59494
59217
|
*/
|
|
59495
59218
|
|
|
59496
59219
|
/**
|
|
@@ -62818,7 +62541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62818
62541
|
/**
|
|
62819
62542
|
* Textbots service.
|
|
62820
62543
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62821
|
-
* @version
|
|
62544
|
+
* @version 193.0.0
|
|
62822
62545
|
*/
|
|
62823
62546
|
|
|
62824
62547
|
/**
|
|
@@ -62946,7 +62669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62946
62669
|
/**
|
|
62947
62670
|
* Tokens service.
|
|
62948
62671
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62949
|
-
* @version
|
|
62672
|
+
* @version 193.0.0
|
|
62950
62673
|
*/
|
|
62951
62674
|
|
|
62952
62675
|
/**
|
|
@@ -63100,7 +62823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63100
62823
|
/**
|
|
63101
62824
|
* Uploads service.
|
|
63102
62825
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63103
|
-
* @version
|
|
62826
|
+
* @version 193.0.0
|
|
63104
62827
|
*/
|
|
63105
62828
|
|
|
63106
62829
|
/**
|
|
@@ -63369,7 +63092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63369
63092
|
/**
|
|
63370
63093
|
* Usage service.
|
|
63371
63094
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63372
|
-
* @version
|
|
63095
|
+
* @version 193.0.0
|
|
63373
63096
|
*/
|
|
63374
63097
|
|
|
63375
63098
|
/**
|
|
@@ -63584,7 +63307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63584
63307
|
/**
|
|
63585
63308
|
* UserRecordings service.
|
|
63586
63309
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63587
|
-
* @version
|
|
63310
|
+
* @version 193.0.0
|
|
63588
63311
|
*/
|
|
63589
63312
|
|
|
63590
63313
|
/**
|
|
@@ -63769,7 +63492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63769
63492
|
/**
|
|
63770
63493
|
* Users service.
|
|
63771
63494
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63772
|
-
* @version
|
|
63495
|
+
* @version 193.0.0
|
|
63773
63496
|
*/
|
|
63774
63497
|
|
|
63775
63498
|
/**
|
|
@@ -65439,7 +65162,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65439
65162
|
* @param {Object} opts Optional parameters
|
|
65440
65163
|
* @param {Number} opts.pageSize The desired page size
|
|
65441
65164
|
* @param {Number} opts.pageNumber The desired page number
|
|
65442
|
-
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65443
65165
|
*/
|
|
65444
65166
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
65445
65167
|
opts = opts || {};
|
|
@@ -66428,7 +66150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66428
66150
|
/**
|
|
66429
66151
|
* Utilities service.
|
|
66430
66152
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66431
|
-
* @version
|
|
66153
|
+
* @version 193.0.0
|
|
66432
66154
|
*/
|
|
66433
66155
|
|
|
66434
66156
|
/**
|
|
@@ -66539,7 +66261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66539
66261
|
/**
|
|
66540
66262
|
* Voicemail service.
|
|
66541
66263
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66542
|
-
* @version
|
|
66264
|
+
* @version 193.0.0
|
|
66543
66265
|
*/
|
|
66544
66266
|
|
|
66545
66267
|
/**
|
|
@@ -67206,7 +66928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67206
66928
|
/**
|
|
67207
66929
|
* WebChat service.
|
|
67208
66930
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67209
|
-
* @version
|
|
66931
|
+
* @version 193.0.0
|
|
67210
66932
|
*/
|
|
67211
66933
|
|
|
67212
66934
|
/**
|
|
@@ -67757,7 +67479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67757
67479
|
/**
|
|
67758
67480
|
* WebDeployments service.
|
|
67759
67481
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67760
|
-
* @version
|
|
67482
|
+
* @version 193.0.0
|
|
67761
67483
|
*/
|
|
67762
67484
|
|
|
67763
67485
|
/**
|
|
@@ -68284,7 +68006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68284
68006
|
/**
|
|
68285
68007
|
* WebMessaging service.
|
|
68286
68008
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68287
|
-
* @version
|
|
68009
|
+
* @version 193.0.0
|
|
68288
68010
|
*/
|
|
68289
68011
|
|
|
68290
68012
|
/**
|
|
@@ -68330,7 +68052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68330
68052
|
/**
|
|
68331
68053
|
* Widgets service.
|
|
68332
68054
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68333
|
-
* @version
|
|
68055
|
+
* @version 193.0.0
|
|
68334
68056
|
*/
|
|
68335
68057
|
|
|
68336
68058
|
/**
|
|
@@ -68476,7 +68198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68476
68198
|
/**
|
|
68477
68199
|
* WorkforceManagement service.
|
|
68478
68200
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68479
|
-
* @version
|
|
68201
|
+
* @version 193.0.0
|
|
68480
68202
|
*/
|
|
68481
68203
|
|
|
68482
68204
|
/**
|
|
@@ -70516,6 +70238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70516
70238
|
* @param {String} agentId The agent id
|
|
70517
70239
|
* @param {Object} opts Optional parameters
|
|
70518
70240
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
70241
|
+
* @param {Array.<String>} opts.expand
|
|
70519
70242
|
*/
|
|
70520
70243
|
getWorkforcemanagementManagementunitAgent(managementUnitId, agentId, opts) {
|
|
70521
70244
|
opts = opts || {};
|
|
@@ -70533,7 +70256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70533
70256
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}',
|
|
70534
70257
|
'GET',
|
|
70535
70258
|
{ 'managementUnitId': managementUnitId,'agentId': agentId },
|
|
70536
|
-
{ 'excludeCapabilities': opts['excludeCapabilities'] },
|
|
70259
|
+
{ 'excludeCapabilities': opts['excludeCapabilities'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70537
70260
|
{ },
|
|
70538
70261
|
{ },
|
|
70539
70262
|
null,
|
|
@@ -71074,6 +70797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71074
70797
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
71075
70798
|
* @param {Object} opts Optional parameters
|
|
71076
70799
|
* @param {Array.<String>} opts.expand Include to access additional data on the work plans
|
|
70800
|
+
* @param {Array.<String>} opts.exclude Exclude specific data on the work plans from the response
|
|
71077
70801
|
*/
|
|
71078
70802
|
getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
71079
70803
|
opts = opts || {};
|
|
@@ -71087,7 +70811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71087
70811
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
71088
70812
|
'GET',
|
|
71089
70813
|
{ 'managementUnitId': managementUnitId },
|
|
71090
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70814
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'exclude': this.apiClient.buildCollectionParam(opts['exclude'], 'multi') },
|
|
71091
70815
|
{ },
|
|
71092
70816
|
{ },
|
|
71093
70817
|
null,
|
|
@@ -74387,7 +74111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74387
74111
|
* </pre>
|
|
74388
74112
|
* </p>
|
|
74389
74113
|
* @module purecloud-platform-client-v2/index
|
|
74390
|
-
* @version
|
|
74114
|
+
* @version 193.0.0
|
|
74391
74115
|
*/
|
|
74392
74116
|
class platformClient {
|
|
74393
74117
|
constructor() {
|