purecloud-platform-client-v2 192.2.0 → 194.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 +347 -757
- package/dist/web-amd/purecloud-platform-client-v2.js +347 -757
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +240 -361
- package/dist/web-cjs/purecloud-platform-client-v2.js +240 -361
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +714 -751
- 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 +30 -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 -286
- 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 +7 -7
- 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 +125 -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 194.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 194.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 194.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 194.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 194.0.0
|
|
9409
9103
|
*/
|
|
9410
9104
|
|
|
9411
9105
|
/**
|
|
@@ -9570,13 +9264,42 @@ class AuditApi {
|
|
|
9570
9264
|
);
|
|
9571
9265
|
}
|
|
9572
9266
|
|
|
9267
|
+
/**
|
|
9268
|
+
* Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.
|
|
9269
|
+
*
|
|
9270
|
+
* @param {Object} body query
|
|
9271
|
+
* @param {Object} opts Optional parameters
|
|
9272
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
9273
|
+
*/
|
|
9274
|
+
postAuditsQueryRealtimeRelated(body, opts) {
|
|
9275
|
+
opts = opts || {};
|
|
9276
|
+
|
|
9277
|
+
// verify the required parameter 'body' is set
|
|
9278
|
+
if (body === undefined || body === null) {
|
|
9279
|
+
throw 'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';
|
|
9280
|
+
}
|
|
9281
|
+
|
|
9282
|
+
return this.apiClient.callApi(
|
|
9283
|
+
'/api/v2/audits/query/realtime/related',
|
|
9284
|
+
'POST',
|
|
9285
|
+
{ },
|
|
9286
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
9287
|
+
{ },
|
|
9288
|
+
{ },
|
|
9289
|
+
body,
|
|
9290
|
+
['PureCloud OAuth'],
|
|
9291
|
+
['application/json'],
|
|
9292
|
+
['application/json']
|
|
9293
|
+
);
|
|
9294
|
+
}
|
|
9295
|
+
|
|
9573
9296
|
}
|
|
9574
9297
|
|
|
9575
9298
|
class AuthorizationApi {
|
|
9576
9299
|
/**
|
|
9577
9300
|
* Authorization service.
|
|
9578
9301
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9579
|
-
* @version
|
|
9302
|
+
* @version 194.0.0
|
|
9580
9303
|
*/
|
|
9581
9304
|
|
|
9582
9305
|
/**
|
|
@@ -10814,7 +10537,7 @@ class BillingApi {
|
|
|
10814
10537
|
/**
|
|
10815
10538
|
* Billing service.
|
|
10816
10539
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10817
|
-
* @version
|
|
10540
|
+
* @version 194.0.0
|
|
10818
10541
|
*/
|
|
10819
10542
|
|
|
10820
10543
|
/**
|
|
@@ -10894,7 +10617,7 @@ class CarrierServicesApi {
|
|
|
10894
10617
|
/**
|
|
10895
10618
|
* CarrierServices service.
|
|
10896
10619
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10897
|
-
* @version
|
|
10620
|
+
* @version 194.0.0
|
|
10898
10621
|
*/
|
|
10899
10622
|
|
|
10900
10623
|
/**
|
|
@@ -10964,7 +10687,7 @@ class ChatApi {
|
|
|
10964
10687
|
/**
|
|
10965
10688
|
* Chat service.
|
|
10966
10689
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10967
|
-
* @version
|
|
10690
|
+
* @version 194.0.0
|
|
10968
10691
|
*/
|
|
10969
10692
|
|
|
10970
10693
|
/**
|
|
@@ -11460,6 +11183,27 @@ class ChatApi {
|
|
|
11460
11183
|
);
|
|
11461
11184
|
}
|
|
11462
11185
|
|
|
11186
|
+
/**
|
|
11187
|
+
* Get a user's chat settings
|
|
11188
|
+
*
|
|
11189
|
+
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11190
|
+
*/
|
|
11191
|
+
getChatsUsersMeSettings() {
|
|
11192
|
+
|
|
11193
|
+
return this.apiClient.callApi(
|
|
11194
|
+
'/api/v2/chats/users/me/settings',
|
|
11195
|
+
'GET',
|
|
11196
|
+
{ },
|
|
11197
|
+
{ },
|
|
11198
|
+
{ },
|
|
11199
|
+
{ },
|
|
11200
|
+
null,
|
|
11201
|
+
['PureCloud OAuth'],
|
|
11202
|
+
['application/json'],
|
|
11203
|
+
['application/json']
|
|
11204
|
+
);
|
|
11205
|
+
}
|
|
11206
|
+
|
|
11463
11207
|
/**
|
|
11464
11208
|
* Set properties for a room
|
|
11465
11209
|
*
|
|
@@ -11616,6 +11360,32 @@ class ChatApi {
|
|
|
11616
11360
|
);
|
|
11617
11361
|
}
|
|
11618
11362
|
|
|
11363
|
+
/**
|
|
11364
|
+
* Update a user's chat settings
|
|
11365
|
+
*
|
|
11366
|
+
* @param {Object} body
|
|
11367
|
+
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11368
|
+
*/
|
|
11369
|
+
patchChatsUsersMeSettings(body) {
|
|
11370
|
+
// verify the required parameter 'body' is set
|
|
11371
|
+
if (body === undefined || body === null) {
|
|
11372
|
+
throw 'Missing the required parameter "body" when calling patchChatsUsersMeSettings';
|
|
11373
|
+
}
|
|
11374
|
+
|
|
11375
|
+
return this.apiClient.callApi(
|
|
11376
|
+
'/api/v2/chats/users/me/settings',
|
|
11377
|
+
'PATCH',
|
|
11378
|
+
{ },
|
|
11379
|
+
{ },
|
|
11380
|
+
{ },
|
|
11381
|
+
{ },
|
|
11382
|
+
body,
|
|
11383
|
+
['PureCloud OAuth'],
|
|
11384
|
+
['application/json'],
|
|
11385
|
+
['application/json']
|
|
11386
|
+
);
|
|
11387
|
+
}
|
|
11388
|
+
|
|
11619
11389
|
/**
|
|
11620
11390
|
* Send a message to a room
|
|
11621
11391
|
*
|
|
@@ -11853,7 +11623,7 @@ class CoachingApi {
|
|
|
11853
11623
|
/**
|
|
11854
11624
|
* Coaching service.
|
|
11855
11625
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11856
|
-
* @version
|
|
11626
|
+
* @version 194.0.0
|
|
11857
11627
|
*/
|
|
11858
11628
|
|
|
11859
11629
|
/**
|
|
@@ -12430,7 +12200,7 @@ class ContentManagementApi {
|
|
|
12430
12200
|
/**
|
|
12431
12201
|
* ContentManagement service.
|
|
12432
12202
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12433
|
-
* @version
|
|
12203
|
+
* @version 194.0.0
|
|
12434
12204
|
*/
|
|
12435
12205
|
|
|
12436
12206
|
/**
|
|
@@ -13512,7 +13282,7 @@ class ConversationsApi {
|
|
|
13512
13282
|
/**
|
|
13513
13283
|
* Conversations service.
|
|
13514
13284
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13515
|
-
* @version
|
|
13285
|
+
* @version 194.0.0
|
|
13516
13286
|
*/
|
|
13517
13287
|
|
|
13518
13288
|
/**
|
|
@@ -13752,32 +13522,6 @@ class ConversationsApi {
|
|
|
13752
13522
|
);
|
|
13753
13523
|
}
|
|
13754
13524
|
|
|
13755
|
-
/**
|
|
13756
|
-
* Delete a LINE messenger integration (Deprecated)
|
|
13757
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
13758
|
-
* @param {String} integrationId Integration ID
|
|
13759
|
-
* @deprecated
|
|
13760
|
-
*/
|
|
13761
|
-
deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId) {
|
|
13762
|
-
// verify the required parameter 'integrationId' is set
|
|
13763
|
-
if (integrationId === undefined || integrationId === null) {
|
|
13764
|
-
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsLineIntegrationId';
|
|
13765
|
-
}
|
|
13766
|
-
|
|
13767
|
-
return this.apiClient.callApi(
|
|
13768
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
13769
|
-
'DELETE',
|
|
13770
|
-
{ 'integrationId': integrationId },
|
|
13771
|
-
{ },
|
|
13772
|
-
{ },
|
|
13773
|
-
{ },
|
|
13774
|
-
null,
|
|
13775
|
-
['PureCloud OAuth'],
|
|
13776
|
-
['application/json'],
|
|
13777
|
-
['application/json']
|
|
13778
|
-
);
|
|
13779
|
-
}
|
|
13780
|
-
|
|
13781
13525
|
/**
|
|
13782
13526
|
* Delete an Open messaging integration
|
|
13783
13527
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -13803,32 +13547,6 @@ class ConversationsApi {
|
|
|
13803
13547
|
);
|
|
13804
13548
|
}
|
|
13805
13549
|
|
|
13806
|
-
/**
|
|
13807
|
-
* Delete a Twitter messaging integration
|
|
13808
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
13809
|
-
* @param {String} integrationId Integration ID
|
|
13810
|
-
* @deprecated
|
|
13811
|
-
*/
|
|
13812
|
-
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
13813
|
-
// verify the required parameter 'integrationId' is set
|
|
13814
|
-
if (integrationId === undefined || integrationId === null) {
|
|
13815
|
-
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
13816
|
-
}
|
|
13817
|
-
|
|
13818
|
-
return this.apiClient.callApi(
|
|
13819
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
13820
|
-
'DELETE',
|
|
13821
|
-
{ 'integrationId': integrationId },
|
|
13822
|
-
{ },
|
|
13823
|
-
{ },
|
|
13824
|
-
{ },
|
|
13825
|
-
null,
|
|
13826
|
-
['PureCloud OAuth'],
|
|
13827
|
-
['application/json'],
|
|
13828
|
-
['application/json']
|
|
13829
|
-
);
|
|
13830
|
-
}
|
|
13831
|
-
|
|
13832
13550
|
/**
|
|
13833
13551
|
* Delete a WhatsApp messaging integration
|
|
13834
13552
|
*
|
|
@@ -15788,65 +15506,6 @@ class ConversationsApi {
|
|
|
15788
15506
|
);
|
|
15789
15507
|
}
|
|
15790
15508
|
|
|
15791
|
-
/**
|
|
15792
|
-
* Get a list of LINE messenger Integrations (Deprecated)
|
|
15793
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
15794
|
-
* @param {Object} opts Optional parameters
|
|
15795
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15796
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15797
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15798
|
-
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
15799
|
-
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
15800
|
-
* @deprecated
|
|
15801
|
-
*/
|
|
15802
|
-
getConversationsMessagingIntegrationsLine(opts) {
|
|
15803
|
-
opts = opts || {};
|
|
15804
|
-
|
|
15805
|
-
|
|
15806
|
-
return this.apiClient.callApi(
|
|
15807
|
-
'/api/v2/conversations/messaging/integrations/line',
|
|
15808
|
-
'GET',
|
|
15809
|
-
{ },
|
|
15810
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
15811
|
-
{ },
|
|
15812
|
-
{ },
|
|
15813
|
-
null,
|
|
15814
|
-
['PureCloud OAuth'],
|
|
15815
|
-
['application/json'],
|
|
15816
|
-
['application/json']
|
|
15817
|
-
);
|
|
15818
|
-
}
|
|
15819
|
-
|
|
15820
|
-
/**
|
|
15821
|
-
* Get a LINE messenger integration (Deprecated)
|
|
15822
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
15823
|
-
* @param {String} integrationId Integration ID
|
|
15824
|
-
* @param {Object} opts Optional parameters
|
|
15825
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15826
|
-
* @deprecated
|
|
15827
|
-
*/
|
|
15828
|
-
getConversationsMessagingIntegrationsLineIntegrationId(integrationId, opts) {
|
|
15829
|
-
opts = opts || {};
|
|
15830
|
-
|
|
15831
|
-
// verify the required parameter 'integrationId' is set
|
|
15832
|
-
if (integrationId === undefined || integrationId === null) {
|
|
15833
|
-
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsLineIntegrationId';
|
|
15834
|
-
}
|
|
15835
|
-
|
|
15836
|
-
return this.apiClient.callApi(
|
|
15837
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
15838
|
-
'GET',
|
|
15839
|
-
{ 'integrationId': integrationId },
|
|
15840
|
-
{ 'expand': opts['expand'] },
|
|
15841
|
-
{ },
|
|
15842
|
-
{ },
|
|
15843
|
-
null,
|
|
15844
|
-
['PureCloud OAuth'],
|
|
15845
|
-
['application/json'],
|
|
15846
|
-
['application/json']
|
|
15847
|
-
);
|
|
15848
|
-
}
|
|
15849
|
-
|
|
15850
15509
|
/**
|
|
15851
15510
|
* Get a list of Open messaging integrations
|
|
15852
15511
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -15904,65 +15563,6 @@ class ConversationsApi {
|
|
|
15904
15563
|
);
|
|
15905
15564
|
}
|
|
15906
15565
|
|
|
15907
|
-
/**
|
|
15908
|
-
* Get a list of Twitter Integrations (Deprecated)
|
|
15909
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15910
|
-
* @param {Object} opts Optional parameters
|
|
15911
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15912
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15913
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15914
|
-
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
15915
|
-
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
15916
|
-
* @deprecated
|
|
15917
|
-
*/
|
|
15918
|
-
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
15919
|
-
opts = opts || {};
|
|
15920
|
-
|
|
15921
|
-
|
|
15922
|
-
return this.apiClient.callApi(
|
|
15923
|
-
'/api/v2/conversations/messaging/integrations/twitter',
|
|
15924
|
-
'GET',
|
|
15925
|
-
{ },
|
|
15926
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
15927
|
-
{ },
|
|
15928
|
-
{ },
|
|
15929
|
-
null,
|
|
15930
|
-
['PureCloud OAuth'],
|
|
15931
|
-
['application/json'],
|
|
15932
|
-
['application/json']
|
|
15933
|
-
);
|
|
15934
|
-
}
|
|
15935
|
-
|
|
15936
|
-
/**
|
|
15937
|
-
* Get a Twitter messaging integration (Deprecated)
|
|
15938
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15939
|
-
* @param {String} integrationId Integration ID
|
|
15940
|
-
* @param {Object} opts Optional parameters
|
|
15941
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15942
|
-
* @deprecated
|
|
15943
|
-
*/
|
|
15944
|
-
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
15945
|
-
opts = opts || {};
|
|
15946
|
-
|
|
15947
|
-
// verify the required parameter 'integrationId' is set
|
|
15948
|
-
if (integrationId === undefined || integrationId === null) {
|
|
15949
|
-
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
15950
|
-
}
|
|
15951
|
-
|
|
15952
|
-
return this.apiClient.callApi(
|
|
15953
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
15954
|
-
'GET',
|
|
15955
|
-
{ 'integrationId': integrationId },
|
|
15956
|
-
{ 'expand': opts['expand'] },
|
|
15957
|
-
{ },
|
|
15958
|
-
{ },
|
|
15959
|
-
null,
|
|
15960
|
-
['PureCloud OAuth'],
|
|
15961
|
-
['application/json'],
|
|
15962
|
-
['application/json']
|
|
15963
|
-
);
|
|
15964
|
-
}
|
|
15965
|
-
|
|
15966
15566
|
/**
|
|
15967
15567
|
* Get a list of WhatsApp Integrations
|
|
15968
15568
|
*
|
|
@@ -17593,37 +17193,6 @@ class ConversationsApi {
|
|
|
17593
17193
|
);
|
|
17594
17194
|
}
|
|
17595
17195
|
|
|
17596
|
-
/**
|
|
17597
|
-
* Update Twitter messaging integration
|
|
17598
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
17599
|
-
* @param {String} integrationId Integration ID
|
|
17600
|
-
* @param {Object} body TwitterIntegrationRequest
|
|
17601
|
-
* @deprecated
|
|
17602
|
-
*/
|
|
17603
|
-
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
17604
|
-
// verify the required parameter 'integrationId' is set
|
|
17605
|
-
if (integrationId === undefined || integrationId === null) {
|
|
17606
|
-
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
17607
|
-
}
|
|
17608
|
-
// verify the required parameter 'body' is set
|
|
17609
|
-
if (body === undefined || body === null) {
|
|
17610
|
-
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
17611
|
-
}
|
|
17612
|
-
|
|
17613
|
-
return this.apiClient.callApi(
|
|
17614
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
17615
|
-
'PATCH',
|
|
17616
|
-
{ 'integrationId': integrationId },
|
|
17617
|
-
{ },
|
|
17618
|
-
{ },
|
|
17619
|
-
{ },
|
|
17620
|
-
body,
|
|
17621
|
-
['PureCloud OAuth'],
|
|
17622
|
-
['application/json'],
|
|
17623
|
-
['application/json']
|
|
17624
|
-
);
|
|
17625
|
-
}
|
|
17626
|
-
|
|
17627
17196
|
/**
|
|
17628
17197
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
17629
17198
|
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
|
@@ -17806,7 +17375,6 @@ class ConversationsApi {
|
|
|
17806
17375
|
* @param {Object} opts Optional parameters
|
|
17807
17376
|
* @param {Number} opts.pageSize The desired page size
|
|
17808
17377
|
* @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
17378
|
*/
|
|
17811
17379
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
17812
17380
|
opts = opts || {};
|
|
@@ -19834,32 +19402,6 @@ class ConversationsApi {
|
|
|
19834
19402
|
);
|
|
19835
19403
|
}
|
|
19836
19404
|
|
|
19837
|
-
/**
|
|
19838
|
-
* Create a LINE messenger Integration (Deprecated)
|
|
19839
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
19840
|
-
* @param {Object} body LineIntegrationRequest
|
|
19841
|
-
* @deprecated
|
|
19842
|
-
*/
|
|
19843
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
19844
|
-
// verify the required parameter 'body' is set
|
|
19845
|
-
if (body === undefined || body === null) {
|
|
19846
|
-
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
19847
|
-
}
|
|
19848
|
-
|
|
19849
|
-
return this.apiClient.callApi(
|
|
19850
|
-
'/api/v2/conversations/messaging/integrations/line',
|
|
19851
|
-
'POST',
|
|
19852
|
-
{ },
|
|
19853
|
-
{ },
|
|
19854
|
-
{ },
|
|
19855
|
-
{ },
|
|
19856
|
-
body,
|
|
19857
|
-
['PureCloud OAuth'],
|
|
19858
|
-
['application/json'],
|
|
19859
|
-
['application/json']
|
|
19860
|
-
);
|
|
19861
|
-
}
|
|
19862
|
-
|
|
19863
19405
|
/**
|
|
19864
19406
|
* Create an Open messaging integration
|
|
19865
19407
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -19885,32 +19427,6 @@ class ConversationsApi {
|
|
|
19885
19427
|
);
|
|
19886
19428
|
}
|
|
19887
19429
|
|
|
19888
|
-
/**
|
|
19889
|
-
* Create a Twitter Integration
|
|
19890
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
19891
|
-
* @param {Object} body TwitterIntegrationRequest
|
|
19892
|
-
* @deprecated
|
|
19893
|
-
*/
|
|
19894
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
19895
|
-
// verify the required parameter 'body' is set
|
|
19896
|
-
if (body === undefined || body === null) {
|
|
19897
|
-
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
19898
|
-
}
|
|
19899
|
-
|
|
19900
|
-
return this.apiClient.callApi(
|
|
19901
|
-
'/api/v2/conversations/messaging/integrations/twitter',
|
|
19902
|
-
'POST',
|
|
19903
|
-
{ },
|
|
19904
|
-
{ },
|
|
19905
|
-
{ },
|
|
19906
|
-
{ },
|
|
19907
|
-
body,
|
|
19908
|
-
['PureCloud OAuth'],
|
|
19909
|
-
['application/json'],
|
|
19910
|
-
['application/json']
|
|
19911
|
-
);
|
|
19912
|
-
}
|
|
19913
|
-
|
|
19914
19430
|
/**
|
|
19915
19431
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
19916
19432
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
@@ -20551,37 +20067,6 @@ class ConversationsApi {
|
|
|
20551
20067
|
);
|
|
20552
20068
|
}
|
|
20553
20069
|
|
|
20554
|
-
/**
|
|
20555
|
-
* Update a LINE messenger integration (Deprecated)
|
|
20556
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
20557
|
-
* @param {String} integrationId Integration ID
|
|
20558
|
-
* @param {Object} body LineIntegrationRequest
|
|
20559
|
-
* @deprecated
|
|
20560
|
-
*/
|
|
20561
|
-
putConversationsMessagingIntegrationsLineIntegrationId(integrationId, body) {
|
|
20562
|
-
// verify the required parameter 'integrationId' is set
|
|
20563
|
-
if (integrationId === undefined || integrationId === null) {
|
|
20564
|
-
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIntegrationsLineIntegrationId';
|
|
20565
|
-
}
|
|
20566
|
-
// verify the required parameter 'body' is set
|
|
20567
|
-
if (body === undefined || body === null) {
|
|
20568
|
-
throw 'Missing the required parameter "body" when calling putConversationsMessagingIntegrationsLineIntegrationId';
|
|
20569
|
-
}
|
|
20570
|
-
|
|
20571
|
-
return this.apiClient.callApi(
|
|
20572
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
20573
|
-
'PUT',
|
|
20574
|
-
{ 'integrationId': integrationId },
|
|
20575
|
-
{ },
|
|
20576
|
-
{ },
|
|
20577
|
-
{ },
|
|
20578
|
-
body,
|
|
20579
|
-
['PureCloud OAuth'],
|
|
20580
|
-
['application/json'],
|
|
20581
|
-
['application/json']
|
|
20582
|
-
);
|
|
20583
|
-
}
|
|
20584
|
-
|
|
20585
20070
|
/**
|
|
20586
20071
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
20587
20072
|
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
@@ -20754,7 +20239,7 @@ class DataExtensionsApi {
|
|
|
20754
20239
|
/**
|
|
20755
20240
|
* DataExtensions service.
|
|
20756
20241
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20757
|
-
* @version
|
|
20242
|
+
* @version 194.0.0
|
|
20758
20243
|
*/
|
|
20759
20244
|
|
|
20760
20245
|
/**
|
|
@@ -20840,7 +20325,7 @@ class DownloadsApi {
|
|
|
20840
20325
|
/**
|
|
20841
20326
|
* Downloads service.
|
|
20842
20327
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20843
|
-
* @version
|
|
20328
|
+
* @version 194.0.0
|
|
20844
20329
|
*/
|
|
20845
20330
|
|
|
20846
20331
|
/**
|
|
@@ -20892,7 +20377,7 @@ class EmailsApi {
|
|
|
20892
20377
|
/**
|
|
20893
20378
|
* Emails service.
|
|
20894
20379
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20895
|
-
* @version
|
|
20380
|
+
* @version 194.0.0
|
|
20896
20381
|
*/
|
|
20897
20382
|
|
|
20898
20383
|
/**
|
|
@@ -20957,7 +20442,7 @@ class EventsApi {
|
|
|
20957
20442
|
/**
|
|
20958
20443
|
* Events service.
|
|
20959
20444
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20960
|
-
* @version
|
|
20445
|
+
* @version 194.0.0
|
|
20961
20446
|
*/
|
|
20962
20447
|
|
|
20963
20448
|
/**
|
|
@@ -21053,7 +20538,7 @@ class ExternalContactsApi {
|
|
|
21053
20538
|
/**
|
|
21054
20539
|
* ExternalContacts service.
|
|
21055
20540
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21056
|
-
* @version
|
|
20541
|
+
* @version 194.0.0
|
|
21057
20542
|
*/
|
|
21058
20543
|
|
|
21059
20544
|
/**
|
|
@@ -21566,7 +21051,7 @@ class ExternalContactsApi {
|
|
|
21566
21051
|
*
|
|
21567
21052
|
* @param {String} externalOrganizationId External Organization ID
|
|
21568
21053
|
* @param {Object} opts Optional parameters
|
|
21569
|
-
* @param {
|
|
21054
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalDataSources)
|
|
21570
21055
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
21571
21056
|
*/
|
|
21572
21057
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
@@ -21581,7 +21066,7 @@ class ExternalContactsApi {
|
|
|
21581
21066
|
'/api/v2/externalcontacts/organizations/{externalOrganizationId}',
|
|
21582
21067
|
'GET',
|
|
21583
21068
|
{ 'externalOrganizationId': externalOrganizationId },
|
|
21584
|
-
{ 'expand': opts['expand'],'includeTrustors': opts['includeTrustors'] },
|
|
21069
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'] },
|
|
21585
21070
|
{ },
|
|
21586
21071
|
{ },
|
|
21587
21072
|
null,
|
|
@@ -21697,7 +21182,7 @@ class ExternalContactsApi {
|
|
|
21697
21182
|
* @param {Object} opts Optional parameters
|
|
21698
21183
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
21699
21184
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
21700
|
-
* @param {
|
|
21185
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21701
21186
|
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
21702
21187
|
*/
|
|
21703
21188
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
@@ -21712,7 +21197,7 @@ class ExternalContactsApi {
|
|
|
21712
21197
|
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships',
|
|
21713
21198
|
'GET',
|
|
21714
21199
|
{ 'externalOrganizationId': externalOrganizationId },
|
|
21715
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'sortOrder': opts['sortOrder'] },
|
|
21200
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'sortOrder': opts['sortOrder'] },
|
|
21716
21201
|
{ },
|
|
21717
21202
|
{ },
|
|
21718
21203
|
null,
|
|
@@ -21857,7 +21342,7 @@ class ExternalContactsApi {
|
|
|
21857
21342
|
*
|
|
21858
21343
|
* @param {String} relationshipId Relationship Id
|
|
21859
21344
|
* @param {Object} opts Optional parameters
|
|
21860
|
-
* @param {
|
|
21345
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21861
21346
|
*/
|
|
21862
21347
|
getExternalcontactsRelationship(relationshipId, opts) {
|
|
21863
21348
|
opts = opts || {};
|
|
@@ -21871,7 +21356,7 @@ class ExternalContactsApi {
|
|
|
21871
21356
|
'/api/v2/externalcontacts/relationships/{relationshipId}',
|
|
21872
21357
|
'GET',
|
|
21873
21358
|
{ 'relationshipId': relationshipId },
|
|
21874
|
-
{ 'expand': opts['expand'] },
|
|
21359
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
21875
21360
|
{ },
|
|
21876
21361
|
{ },
|
|
21877
21362
|
null,
|
|
@@ -23011,7 +22496,7 @@ class FaxApi {
|
|
|
23011
22496
|
/**
|
|
23012
22497
|
* Fax service.
|
|
23013
22498
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23014
|
-
* @version
|
|
22499
|
+
* @version 194.0.0
|
|
23015
22500
|
*/
|
|
23016
22501
|
|
|
23017
22502
|
/**
|
|
@@ -23226,7 +22711,7 @@ class FlowsApi {
|
|
|
23226
22711
|
/**
|
|
23227
22712
|
* Flows service.
|
|
23228
22713
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23229
|
-
* @version
|
|
22714
|
+
* @version 194.0.0
|
|
23230
22715
|
*/
|
|
23231
22716
|
|
|
23232
22717
|
/**
|
|
@@ -23304,7 +22789,6 @@ class FlowsApi {
|
|
|
23304
22789
|
* @param {Object} opts Optional parameters
|
|
23305
22790
|
* @param {Number} opts.pageSize The desired page size
|
|
23306
22791
|
* @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
22792
|
*/
|
|
23309
22793
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
23310
22794
|
opts = opts || {};
|
|
@@ -23410,7 +22894,7 @@ class GamificationApi {
|
|
|
23410
22894
|
/**
|
|
23411
22895
|
* Gamification service.
|
|
23412
22896
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23413
|
-
* @version
|
|
22897
|
+
* @version 194.0.0
|
|
23414
22898
|
*/
|
|
23415
22899
|
|
|
23416
22900
|
/**
|
|
@@ -25496,7 +24980,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25496
24980
|
/**
|
|
25497
24981
|
* GeneralDataProtectionRegulation service.
|
|
25498
24982
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25499
|
-
* @version
|
|
24983
|
+
* @version 194.0.0
|
|
25500
24984
|
*/
|
|
25501
24985
|
|
|
25502
24986
|
/**
|
|
@@ -25626,7 +25110,7 @@ class GeolocationApi {
|
|
|
25626
25110
|
/**
|
|
25627
25111
|
* Geolocation service.
|
|
25628
25112
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25629
|
-
* @version
|
|
25113
|
+
* @version 194.0.0
|
|
25630
25114
|
*/
|
|
25631
25115
|
|
|
25632
25116
|
/**
|
|
@@ -25757,7 +25241,7 @@ class GreetingsApi {
|
|
|
25757
25241
|
/**
|
|
25758
25242
|
* Greetings service.
|
|
25759
25243
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25760
|
-
* @version
|
|
25244
|
+
* @version 194.0.0
|
|
25761
25245
|
*/
|
|
25762
25246
|
|
|
25763
25247
|
/**
|
|
@@ -26212,7 +25696,7 @@ class GroupsApi {
|
|
|
26212
25696
|
/**
|
|
26213
25697
|
* Groups service.
|
|
26214
25698
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26215
|
-
* @version
|
|
25699
|
+
* @version 194.0.0
|
|
26216
25700
|
*/
|
|
26217
25701
|
|
|
26218
25702
|
/**
|
|
@@ -26731,7 +26215,7 @@ class IdentityProviderApi {
|
|
|
26731
26215
|
/**
|
|
26732
26216
|
* IdentityProvider service.
|
|
26733
26217
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26734
|
-
* @version
|
|
26218
|
+
* @version 194.0.0
|
|
26735
26219
|
*/
|
|
26736
26220
|
|
|
26737
26221
|
/**
|
|
@@ -27592,7 +27076,7 @@ class InfrastructureAsCodeApi {
|
|
|
27592
27076
|
/**
|
|
27593
27077
|
* InfrastructureAsCode service.
|
|
27594
27078
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27595
|
-
* @version
|
|
27079
|
+
* @version 194.0.0
|
|
27596
27080
|
*/
|
|
27597
27081
|
|
|
27598
27082
|
/**
|
|
@@ -27759,7 +27243,7 @@ class IntegrationsApi {
|
|
|
27759
27243
|
/**
|
|
27760
27244
|
* Integrations service.
|
|
27761
27245
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27762
|
-
* @version
|
|
27246
|
+
* @version 194.0.0
|
|
27763
27247
|
*/
|
|
27764
27248
|
|
|
27765
27249
|
/**
|
|
@@ -30111,7 +29595,7 @@ class JourneyApi {
|
|
|
30111
29595
|
/**
|
|
30112
29596
|
* Journey service.
|
|
30113
29597
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30114
|
-
* @version
|
|
29598
|
+
* @version 194.0.0
|
|
30115
29599
|
*/
|
|
30116
29600
|
|
|
30117
29601
|
/**
|
|
@@ -31700,7 +31184,7 @@ class KnowledgeApi {
|
|
|
31700
31184
|
/**
|
|
31701
31185
|
* Knowledge service.
|
|
31702
31186
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31703
|
-
* @version
|
|
31187
|
+
* @version 194.0.0
|
|
31704
31188
|
*/
|
|
31705
31189
|
|
|
31706
31190
|
/**
|
|
@@ -34943,7 +34427,7 @@ class LanguageUnderstandingApi {
|
|
|
34943
34427
|
/**
|
|
34944
34428
|
* LanguageUnderstanding service.
|
|
34945
34429
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34946
|
-
* @version
|
|
34430
|
+
* @version 194.0.0
|
|
34947
34431
|
*/
|
|
34948
34432
|
|
|
34949
34433
|
/**
|
|
@@ -35977,7 +35461,7 @@ class LanguagesApi {
|
|
|
35977
35461
|
/**
|
|
35978
35462
|
* Languages service.
|
|
35979
35463
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35980
|
-
* @version
|
|
35464
|
+
* @version 194.0.0
|
|
35981
35465
|
*/
|
|
35982
35466
|
|
|
35983
35467
|
/**
|
|
@@ -36199,7 +35683,7 @@ class LearningApi {
|
|
|
36199
35683
|
/**
|
|
36200
35684
|
* Learning service.
|
|
36201
35685
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36202
|
-
* @version
|
|
35686
|
+
* @version 194.0.0
|
|
36203
35687
|
*/
|
|
36204
35688
|
|
|
36205
35689
|
/**
|
|
@@ -37054,7 +36538,7 @@ class LicenseApi {
|
|
|
37054
36538
|
/**
|
|
37055
36539
|
* License service.
|
|
37056
36540
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37057
|
-
* @version
|
|
36541
|
+
* @version 194.0.0
|
|
37058
36542
|
*/
|
|
37059
36543
|
|
|
37060
36544
|
/**
|
|
@@ -37292,7 +36776,7 @@ class LocationsApi {
|
|
|
37292
36776
|
/**
|
|
37293
36777
|
* Locations service.
|
|
37294
36778
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37295
|
-
* @version
|
|
36779
|
+
* @version 194.0.0
|
|
37296
36780
|
*/
|
|
37297
36781
|
|
|
37298
36782
|
/**
|
|
@@ -37528,7 +37012,7 @@ class LogCaptureApi {
|
|
|
37528
37012
|
/**
|
|
37529
37013
|
* LogCapture service.
|
|
37530
37014
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37531
|
-
* @version
|
|
37015
|
+
* @version 194.0.0
|
|
37532
37016
|
*/
|
|
37533
37017
|
|
|
37534
37018
|
/**
|
|
@@ -37728,7 +37212,7 @@ class MessagingApi {
|
|
|
37728
37212
|
/**
|
|
37729
37213
|
* Messaging service.
|
|
37730
37214
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37731
|
-
* @version
|
|
37215
|
+
* @version 194.0.0
|
|
37732
37216
|
*/
|
|
37733
37217
|
|
|
37734
37218
|
/**
|
|
@@ -38087,7 +37571,7 @@ class MobileDevicesApi {
|
|
|
38087
37571
|
/**
|
|
38088
37572
|
* MobileDevices service.
|
|
38089
37573
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38090
|
-
* @version
|
|
37574
|
+
* @version 194.0.0
|
|
38091
37575
|
*/
|
|
38092
37576
|
|
|
38093
37577
|
/**
|
|
@@ -38238,7 +37722,7 @@ class NotificationsApi {
|
|
|
38238
37722
|
/**
|
|
38239
37723
|
* Notifications service.
|
|
38240
37724
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38241
|
-
* @version
|
|
37725
|
+
* @version 194.0.0
|
|
38242
37726
|
*/
|
|
38243
37727
|
|
|
38244
37728
|
/**
|
|
@@ -38471,7 +37955,7 @@ class OAuthApi {
|
|
|
38471
37955
|
/**
|
|
38472
37956
|
* OAuth service.
|
|
38473
37957
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38474
|
-
* @version
|
|
37958
|
+
* @version 194.0.0
|
|
38475
37959
|
*/
|
|
38476
37960
|
|
|
38477
37961
|
/**
|
|
@@ -38837,7 +38321,7 @@ class ObjectsApi {
|
|
|
38837
38321
|
/**
|
|
38838
38322
|
* Objects service.
|
|
38839
38323
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38840
|
-
* @version
|
|
38324
|
+
* @version 194.0.0
|
|
38841
38325
|
*/
|
|
38842
38326
|
|
|
38843
38327
|
/**
|
|
@@ -39107,7 +38591,7 @@ class OperationalEventsApi {
|
|
|
39107
38591
|
/**
|
|
39108
38592
|
* OperationalEvents service.
|
|
39109
38593
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39110
|
-
* @version
|
|
38594
|
+
* @version 194.0.0
|
|
39111
38595
|
*/
|
|
39112
38596
|
|
|
39113
38597
|
/**
|
|
@@ -39173,7 +38657,7 @@ class OrganizationApi {
|
|
|
39173
38657
|
/**
|
|
39174
38658
|
* Organization service.
|
|
39175
38659
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39176
|
-
* @version
|
|
38660
|
+
* @version 194.0.0
|
|
39177
38661
|
*/
|
|
39178
38662
|
|
|
39179
38663
|
/**
|
|
@@ -39349,6 +38833,26 @@ class OrganizationApi {
|
|
|
39349
38833
|
);
|
|
39350
38834
|
}
|
|
39351
38835
|
|
|
38836
|
+
/**
|
|
38837
|
+
* Get free trial limit documentation
|
|
38838
|
+
*
|
|
38839
|
+
*/
|
|
38840
|
+
getOrganizationsLimitsDocsFreetrial() {
|
|
38841
|
+
|
|
38842
|
+
return this.apiClient.callApi(
|
|
38843
|
+
'/api/v2/organizations/limits/docs/freetrial',
|
|
38844
|
+
'GET',
|
|
38845
|
+
{ },
|
|
38846
|
+
{ },
|
|
38847
|
+
{ },
|
|
38848
|
+
{ },
|
|
38849
|
+
null,
|
|
38850
|
+
['PureCloud OAuth'],
|
|
38851
|
+
['application/json'],
|
|
38852
|
+
['application/json']
|
|
38853
|
+
);
|
|
38854
|
+
}
|
|
38855
|
+
|
|
39352
38856
|
/**
|
|
39353
38857
|
* Get the effective limits in a namespace for an organization
|
|
39354
38858
|
*
|
|
@@ -39628,7 +39132,7 @@ class OrganizationAuthorizationApi {
|
|
|
39628
39132
|
/**
|
|
39629
39133
|
* OrganizationAuthorization service.
|
|
39630
39134
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39631
|
-
* @version
|
|
39135
|
+
* @version 194.0.0
|
|
39632
39136
|
*/
|
|
39633
39137
|
|
|
39634
39138
|
/**
|
|
@@ -40975,7 +40479,7 @@ class OutboundApi {
|
|
|
40975
40479
|
/**
|
|
40976
40480
|
* Outbound service.
|
|
40977
40481
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40978
|
-
* @version
|
|
40482
|
+
* @version 194.0.0
|
|
40979
40483
|
*/
|
|
40980
40484
|
|
|
40981
40485
|
/**
|
|
@@ -42027,6 +41531,40 @@ class OutboundApi {
|
|
|
42027
41531
|
);
|
|
42028
41532
|
}
|
|
42029
41533
|
|
|
41534
|
+
/**
|
|
41535
|
+
* Get line distribution information for campaigns using same Edge Group or Site as given campaign
|
|
41536
|
+
*
|
|
41537
|
+
* @param {String} campaignId Campaign ID
|
|
41538
|
+
* @param {Object} opts Optional parameters
|
|
41539
|
+
* @param {Boolean} opts.includeOnlyActiveCampaigns If true will return only active Campaigns (default to true)
|
|
41540
|
+
* @param {String} opts.edgeGroupId Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive.
|
|
41541
|
+
* @param {String} opts.siteId Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive.
|
|
41542
|
+
* @param {Boolean} opts.useWeight Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations
|
|
41543
|
+
* @param {Number} opts.relativeWeight Relative weight to be used in line distribution calculations instead of current Campaign's relative weight
|
|
41544
|
+
* @param {Number} opts.outboundLineCount The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count
|
|
41545
|
+
*/
|
|
41546
|
+
getOutboundCampaignLinedistribution(campaignId, opts) {
|
|
41547
|
+
opts = opts || {};
|
|
41548
|
+
|
|
41549
|
+
// verify the required parameter 'campaignId' is set
|
|
41550
|
+
if (campaignId === undefined || campaignId === null) {
|
|
41551
|
+
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignLinedistribution';
|
|
41552
|
+
}
|
|
41553
|
+
|
|
41554
|
+
return this.apiClient.callApi(
|
|
41555
|
+
'/api/v2/outbound/campaigns/{campaignId}/linedistribution',
|
|
41556
|
+
'GET',
|
|
41557
|
+
{ 'campaignId': campaignId },
|
|
41558
|
+
{ 'includeOnlyActiveCampaigns': opts['includeOnlyActiveCampaigns'],'edgeGroupId': opts['edgeGroupId'],'siteId': opts['siteId'],'useWeight': opts['useWeight'],'relativeWeight': opts['relativeWeight'],'outboundLineCount': opts['outboundLineCount'] },
|
|
41559
|
+
{ },
|
|
41560
|
+
{ },
|
|
41561
|
+
null,
|
|
41562
|
+
['PureCloud OAuth'],
|
|
41563
|
+
['application/json'],
|
|
41564
|
+
['application/json']
|
|
41565
|
+
);
|
|
41566
|
+
}
|
|
41567
|
+
|
|
42030
41568
|
/**
|
|
42031
41569
|
* Get campaign progress
|
|
42032
41570
|
*
|
|
@@ -44003,6 +43541,96 @@ class OutboundApi {
|
|
|
44003
43541
|
);
|
|
44004
43542
|
}
|
|
44005
43543
|
|
|
43544
|
+
/**
|
|
43545
|
+
* Start an async job to delete contacts using a filter.
|
|
43546
|
+
*
|
|
43547
|
+
* @param {String} contactListId Contact List ID
|
|
43548
|
+
* @param {Object} body Contact filter information.
|
|
43549
|
+
*/
|
|
43550
|
+
postOutboundContactlistContactsBulkRemove(contactListId, body) {
|
|
43551
|
+
// verify the required parameter 'contactListId' is set
|
|
43552
|
+
if (contactListId === undefined || contactListId === null) {
|
|
43553
|
+
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkRemove';
|
|
43554
|
+
}
|
|
43555
|
+
// verify the required parameter 'body' is set
|
|
43556
|
+
if (body === undefined || body === null) {
|
|
43557
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkRemove';
|
|
43558
|
+
}
|
|
43559
|
+
|
|
43560
|
+
return this.apiClient.callApi(
|
|
43561
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove',
|
|
43562
|
+
'POST',
|
|
43563
|
+
{ 'contactListId': contactListId },
|
|
43564
|
+
{ },
|
|
43565
|
+
{ },
|
|
43566
|
+
{ },
|
|
43567
|
+
body,
|
|
43568
|
+
['PureCloud OAuth'],
|
|
43569
|
+
['application/json'],
|
|
43570
|
+
['application/json']
|
|
43571
|
+
);
|
|
43572
|
+
}
|
|
43573
|
+
|
|
43574
|
+
/**
|
|
43575
|
+
* Start an async job to bulk edit contacts.
|
|
43576
|
+
*
|
|
43577
|
+
* @param {String} contactListId Contact List ID
|
|
43578
|
+
* @param {Object} body Contact bulk edit request information.
|
|
43579
|
+
*/
|
|
43580
|
+
postOutboundContactlistContactsBulkUpdate(contactListId, body) {
|
|
43581
|
+
// verify the required parameter 'contactListId' is set
|
|
43582
|
+
if (contactListId === undefined || contactListId === null) {
|
|
43583
|
+
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkUpdate';
|
|
43584
|
+
}
|
|
43585
|
+
// verify the required parameter 'body' is set
|
|
43586
|
+
if (body === undefined || body === null) {
|
|
43587
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkUpdate';
|
|
43588
|
+
}
|
|
43589
|
+
|
|
43590
|
+
return this.apiClient.callApi(
|
|
43591
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update',
|
|
43592
|
+
'POST',
|
|
43593
|
+
{ 'contactListId': contactListId },
|
|
43594
|
+
{ },
|
|
43595
|
+
{ },
|
|
43596
|
+
{ },
|
|
43597
|
+
body,
|
|
43598
|
+
['PureCloud OAuth'],
|
|
43599
|
+
['application/json'],
|
|
43600
|
+
['application/json']
|
|
43601
|
+
);
|
|
43602
|
+
}
|
|
43603
|
+
|
|
43604
|
+
/**
|
|
43605
|
+
* Query contacts from a contact list.
|
|
43606
|
+
*
|
|
43607
|
+
* @param {String} contactListId Contact List ID
|
|
43608
|
+
* @param {Object} body Contact search parameters.
|
|
43609
|
+
*/
|
|
43610
|
+
postOutboundContactlistContactsSearch(contactListId, body) {
|
|
43611
|
+
// verify the required parameter 'contactListId' is set
|
|
43612
|
+
if (contactListId === undefined || contactListId === null) {
|
|
43613
|
+
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsSearch';
|
|
43614
|
+
}
|
|
43615
|
+
// verify the required parameter 'body' is set
|
|
43616
|
+
if (body === undefined || body === null) {
|
|
43617
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsSearch';
|
|
43618
|
+
}
|
|
43619
|
+
|
|
43620
|
+
return this.apiClient.callApi(
|
|
43621
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/search',
|
|
43622
|
+
'POST',
|
|
43623
|
+
{ 'contactListId': contactListId },
|
|
43624
|
+
{ },
|
|
43625
|
+
{ },
|
|
43626
|
+
{ },
|
|
43627
|
+
body,
|
|
43628
|
+
['PureCloud OAuth'],
|
|
43629
|
+
['application/json'],
|
|
43630
|
+
['application/json']
|
|
43631
|
+
);
|
|
43632
|
+
}
|
|
43633
|
+
|
|
44006
43634
|
/**
|
|
44007
43635
|
* Initiate the export of a contact list.
|
|
44008
43636
|
* Returns 200 if received OK.
|
|
@@ -45217,7 +44845,7 @@ class PresenceApi {
|
|
|
45217
44845
|
/**
|
|
45218
44846
|
* Presence service.
|
|
45219
44847
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45220
|
-
* @version
|
|
44848
|
+
* @version 194.0.0
|
|
45221
44849
|
*/
|
|
45222
44850
|
|
|
45223
44851
|
/**
|
|
@@ -45961,7 +45589,7 @@ class ProcessAutomationApi {
|
|
|
45961
45589
|
/**
|
|
45962
45590
|
* ProcessAutomation service.
|
|
45963
45591
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45964
|
-
* @version
|
|
45592
|
+
* @version 194.0.0
|
|
45965
45593
|
*/
|
|
45966
45594
|
|
|
45967
45595
|
/**
|
|
@@ -46200,7 +45828,7 @@ class QualityApi {
|
|
|
46200
45828
|
/**
|
|
46201
45829
|
* Quality service.
|
|
46202
45830
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46203
|
-
* @version
|
|
45831
|
+
* @version 194.0.0
|
|
46204
45832
|
*/
|
|
46205
45833
|
|
|
46206
45834
|
/**
|
|
@@ -46688,7 +46316,7 @@ class QualityApi {
|
|
|
46688
46316
|
|
|
46689
46317
|
/**
|
|
46690
46318
|
* 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.
|
|
46319
|
+
* 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
46320
|
* @param {Object} opts Optional parameters
|
|
46693
46321
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46694
46322
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -46708,7 +46336,7 @@ class QualityApi {
|
|
|
46708
46336
|
* @param {Array.<String>} opts.evaluationState
|
|
46709
46337
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
46710
46338
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
46711
|
-
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
46339
|
+
* @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
46340
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
46713
46341
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
46714
46342
|
*/
|
|
@@ -47957,7 +47585,7 @@ class RecordingApi {
|
|
|
47957
47585
|
/**
|
|
47958
47586
|
* Recording service.
|
|
47959
47587
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47960
|
-
* @version
|
|
47588
|
+
* @version 194.0.0
|
|
47961
47589
|
*/
|
|
47962
47590
|
|
|
47963
47591
|
/**
|
|
@@ -49615,7 +49243,7 @@ class ResponseManagementApi {
|
|
|
49615
49243
|
/**
|
|
49616
49244
|
* ResponseManagement service.
|
|
49617
49245
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49618
|
-
* @version
|
|
49246
|
+
* @version 194.0.0
|
|
49619
49247
|
*/
|
|
49620
49248
|
|
|
49621
49249
|
/**
|
|
@@ -50125,7 +49753,7 @@ class RoutingApi {
|
|
|
50125
49753
|
/**
|
|
50126
49754
|
* Routing service.
|
|
50127
49755
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50128
|
-
* @version
|
|
49756
|
+
* @version 194.0.0
|
|
50129
49757
|
*/
|
|
50130
49758
|
|
|
50131
49759
|
/**
|
|
@@ -53022,7 +52650,6 @@ class RoutingApi {
|
|
|
53022
52650
|
* @param {Object} opts Optional parameters
|
|
53023
52651
|
* @param {Number} opts.pageSize The desired page size
|
|
53024
52652
|
* @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
52653
|
*/
|
|
53027
52654
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
53028
52655
|
opts = opts || {};
|
|
@@ -54105,7 +53732,7 @@ class SCIMApi {
|
|
|
54105
53732
|
/**
|
|
54106
53733
|
* SCIM service.
|
|
54107
53734
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54108
|
-
* @version
|
|
53735
|
+
* @version 194.0.0
|
|
54109
53736
|
*/
|
|
54110
53737
|
|
|
54111
53738
|
/**
|
|
@@ -54982,7 +54609,7 @@ class ScreenRecordingApi {
|
|
|
54982
54609
|
/**
|
|
54983
54610
|
* ScreenRecording service.
|
|
54984
54611
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54985
|
-
* @version
|
|
54612
|
+
* @version 194.0.0
|
|
54986
54613
|
*/
|
|
54987
54614
|
|
|
54988
54615
|
/**
|
|
@@ -55027,7 +54654,7 @@ class ScriptsApi {
|
|
|
55027
54654
|
/**
|
|
55028
54655
|
* Scripts service.
|
|
55029
54656
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55030
|
-
* @version
|
|
54657
|
+
* @version 194.0.0
|
|
55031
54658
|
*/
|
|
55032
54659
|
|
|
55033
54660
|
/**
|
|
@@ -55471,7 +55098,7 @@ class SearchApi {
|
|
|
55471
55098
|
/**
|
|
55472
55099
|
* Search service.
|
|
55473
55100
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55474
|
-
* @version
|
|
55101
|
+
* @version 194.0.0
|
|
55475
55102
|
*/
|
|
55476
55103
|
|
|
55477
55104
|
/**
|
|
@@ -56160,7 +55787,7 @@ class SettingsApi {
|
|
|
56160
55787
|
/**
|
|
56161
55788
|
* Settings service.
|
|
56162
55789
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56163
|
-
* @version
|
|
55790
|
+
* @version 194.0.0
|
|
56164
55791
|
*/
|
|
56165
55792
|
|
|
56166
55793
|
/**
|
|
@@ -56272,7 +55899,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56272
55899
|
/**
|
|
56273
55900
|
* SpeechTextAnalytics service.
|
|
56274
55901
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56275
|
-
* @version
|
|
55902
|
+
* @version 194.0.0
|
|
56276
55903
|
*/
|
|
56277
55904
|
|
|
56278
55905
|
/**
|
|
@@ -57386,7 +57013,7 @@ class StationsApi {
|
|
|
57386
57013
|
/**
|
|
57387
57014
|
* Stations service.
|
|
57388
57015
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57389
|
-
* @version
|
|
57016
|
+
* @version 194.0.0
|
|
57390
57017
|
*/
|
|
57391
57018
|
|
|
57392
57019
|
/**
|
|
@@ -57488,7 +57115,7 @@ class SuggestApi {
|
|
|
57488
57115
|
/**
|
|
57489
57116
|
* Suggest service.
|
|
57490
57117
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57491
|
-
* @version
|
|
57118
|
+
* @version 194.0.0
|
|
57492
57119
|
*/
|
|
57493
57120
|
|
|
57494
57121
|
/**
|
|
@@ -57627,7 +57254,7 @@ class TaskManagementApi {
|
|
|
57627
57254
|
/**
|
|
57628
57255
|
* TaskManagement service.
|
|
57629
57256
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57630
|
-
* @version
|
|
57257
|
+
* @version 194.0.0
|
|
57631
57258
|
*/
|
|
57632
57259
|
|
|
57633
57260
|
/**
|
|
@@ -57646,7 +57273,6 @@ class TaskManagementApi {
|
|
|
57646
57273
|
* Delete a workbin
|
|
57647
57274
|
*
|
|
57648
57275
|
* @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
57276
|
*/
|
|
57651
57277
|
deleteTaskmanagementWorkbin(workbinId) {
|
|
57652
57278
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57672,7 +57298,6 @@ class TaskManagementApi {
|
|
|
57672
57298
|
* Delete a workitem
|
|
57673
57299
|
*
|
|
57674
57300
|
* @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
57301
|
*/
|
|
57677
57302
|
deleteTaskmanagementWorkitem(workitemId) {
|
|
57678
57303
|
// verify the required parameter 'workitemId' is set
|
|
@@ -57698,7 +57323,6 @@ class TaskManagementApi {
|
|
|
57698
57323
|
* Delete a schema
|
|
57699
57324
|
*
|
|
57700
57325
|
* @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
57326
|
*/
|
|
57703
57327
|
deleteTaskmanagementWorkitemsSchema(schemaId) {
|
|
57704
57328
|
// verify the required parameter 'schemaId' is set
|
|
@@ -57724,7 +57348,6 @@ class TaskManagementApi {
|
|
|
57724
57348
|
* Delete a worktype
|
|
57725
57349
|
*
|
|
57726
57350
|
* @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
57351
|
*/
|
|
57729
57352
|
deleteTaskmanagementWorktype(worktypeId) {
|
|
57730
57353
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57751,7 +57374,6 @@ class TaskManagementApi {
|
|
|
57751
57374
|
*
|
|
57752
57375
|
* @param {String} worktypeId Worktype id
|
|
57753
57376
|
* @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
57377
|
*/
|
|
57756
57378
|
deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
57757
57379
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -57781,7 +57403,6 @@ class TaskManagementApi {
|
|
|
57781
57403
|
* Get a workbin
|
|
57782
57404
|
*
|
|
57783
57405
|
* @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
57406
|
*/
|
|
57786
57407
|
getTaskmanagementWorkbin(workbinId) {
|
|
57787
57408
|
// verify the required parameter 'workbinId' is set
|
|
@@ -57904,7 +57525,6 @@ class TaskManagementApi {
|
|
|
57904
57525
|
* @param {String} workitemId Workitem ID
|
|
57905
57526
|
* @param {Object} opts Optional parameters
|
|
57906
57527
|
* @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
57528
|
*/
|
|
57909
57529
|
getTaskmanagementWorkitem(workitemId, opts) {
|
|
57910
57530
|
opts = opts || {};
|
|
@@ -57970,7 +57590,6 @@ class TaskManagementApi {
|
|
|
57970
57590
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
57971
57591
|
* @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
57592
|
* @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
57593
|
*/
|
|
57975
57594
|
getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
|
|
57976
57595
|
opts = opts || {};
|
|
@@ -58070,7 +57689,6 @@ class TaskManagementApi {
|
|
|
58070
57689
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58071
57690
|
* @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
57691
|
* @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
57692
|
*/
|
|
58075
57693
|
getTaskmanagementWorkitemWrapups(workitemId, opts) {
|
|
58076
57694
|
opts = opts || {};
|
|
@@ -58098,7 +57716,6 @@ class TaskManagementApi {
|
|
|
58098
57716
|
* Get the workitem query job associated with the job id.
|
|
58099
57717
|
*
|
|
58100
57718
|
* @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
57719
|
*/
|
|
58103
57720
|
getTaskmanagementWorkitemsQueryJob(jobId) {
|
|
58104
57721
|
// verify the required parameter 'jobId' is set
|
|
@@ -58124,7 +57741,6 @@ class TaskManagementApi {
|
|
|
58124
57741
|
* Get results from for workitem query job
|
|
58125
57742
|
*
|
|
58126
57743
|
* @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
57744
|
*/
|
|
58129
57745
|
getTaskmanagementWorkitemsQueryJobResults(jobId) {
|
|
58130
57746
|
// verify the required parameter 'jobId' is set
|
|
@@ -58150,7 +57766,6 @@ class TaskManagementApi {
|
|
|
58150
57766
|
* Get a schema
|
|
58151
57767
|
*
|
|
58152
57768
|
* @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
57769
|
*/
|
|
58155
57770
|
getTaskmanagementWorkitemsSchema(schemaId) {
|
|
58156
57771
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58177,7 +57792,6 @@ class TaskManagementApi {
|
|
|
58177
57792
|
*
|
|
58178
57793
|
* @param {String} schemaId Schema ID
|
|
58179
57794
|
* @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
57795
|
*/
|
|
58182
57796
|
getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
|
|
58183
57797
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58207,7 +57821,6 @@ class TaskManagementApi {
|
|
|
58207
57821
|
* Get all versions of a schema
|
|
58208
57822
|
*
|
|
58209
57823
|
* @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
57824
|
*/
|
|
58212
57825
|
getTaskmanagementWorkitemsSchemaVersions(schemaId) {
|
|
58213
57826
|
// verify the required parameter 'schemaId' is set
|
|
@@ -58232,7 +57845,6 @@ class TaskManagementApi {
|
|
|
58232
57845
|
/**
|
|
58233
57846
|
* Get a list of schemas.
|
|
58234
57847
|
*
|
|
58235
|
-
* getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58236
57848
|
*/
|
|
58237
57849
|
getTaskmanagementWorkitemsSchemas() {
|
|
58238
57850
|
|
|
@@ -58256,7 +57868,6 @@ class TaskManagementApi {
|
|
|
58256
57868
|
* @param {String} worktypeId Worktype id
|
|
58257
57869
|
* @param {Object} opts Optional parameters
|
|
58258
57870
|
* @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
57871
|
*/
|
|
58261
57872
|
getTaskmanagementWorktype(worktypeId, opts) {
|
|
58262
57873
|
opts = opts || {};
|
|
@@ -58317,7 +57928,6 @@ class TaskManagementApi {
|
|
|
58317
57928
|
*
|
|
58318
57929
|
* @param {String} worktypeId Worktype id
|
|
58319
57930
|
* @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
57931
|
*/
|
|
58322
57932
|
getTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
58323
57933
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58347,7 +57957,6 @@ class TaskManagementApi {
|
|
|
58347
57957
|
* Get list of statuses for this worktype.
|
|
58348
57958
|
*
|
|
58349
57959
|
* @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
57960
|
*/
|
|
58352
57961
|
getTaskmanagementWorktypeStatuses(worktypeId) {
|
|
58353
57962
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -58437,7 +58046,6 @@ class TaskManagementApi {
|
|
|
58437
58046
|
*
|
|
58438
58047
|
* @param {String} workbinId Workbin ID
|
|
58439
58048
|
* @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
58049
|
*/
|
|
58442
58050
|
patchTaskmanagementWorkbin(workbinId, body) {
|
|
58443
58051
|
// verify the required parameter 'workbinId' is set
|
|
@@ -58468,7 +58076,6 @@ class TaskManagementApi {
|
|
|
58468
58076
|
*
|
|
58469
58077
|
* @param {String} workitemId Workitem ID
|
|
58470
58078
|
* @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
58079
|
*/
|
|
58473
58080
|
patchTaskmanagementWorkitem(workitemId, body) {
|
|
58474
58081
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58499,7 +58106,6 @@ class TaskManagementApi {
|
|
|
58499
58106
|
*
|
|
58500
58107
|
* @param {String} workitemId Workitem ID
|
|
58501
58108
|
* @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
58109
|
*/
|
|
58504
58110
|
patchTaskmanagementWorkitemAssignment(workitemId, body) {
|
|
58505
58111
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58531,7 +58137,6 @@ class TaskManagementApi {
|
|
|
58531
58137
|
* @param {String} workitemId The ID of the Workitem.
|
|
58532
58138
|
* @param {String} userId The ID of the user
|
|
58533
58139
|
* @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
58140
|
*/
|
|
58536
58141
|
patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
|
|
58537
58142
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58566,7 +58171,6 @@ class TaskManagementApi {
|
|
|
58566
58171
|
*
|
|
58567
58172
|
* @param {String} workitemId The ID of the Workitem.
|
|
58568
58173
|
* @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
58174
|
*/
|
|
58571
58175
|
patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
|
|
58572
58176
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58598,7 +58202,6 @@ class TaskManagementApi {
|
|
|
58598
58202
|
* @param {String} worktypeId Worktype id
|
|
58599
58203
|
* @param {Object} opts Optional parameters
|
|
58600
58204
|
* @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
58205
|
*/
|
|
58603
58206
|
patchTaskmanagementWorktype(worktypeId, opts) {
|
|
58604
58207
|
opts = opts || {};
|
|
@@ -58629,7 +58232,6 @@ class TaskManagementApi {
|
|
|
58629
58232
|
* @param {String} statusId Status id
|
|
58630
58233
|
* @param {Object} opts Optional parameters
|
|
58631
58234
|
* @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
58235
|
*/
|
|
58634
58236
|
patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
|
|
58635
58237
|
opts = opts || {};
|
|
@@ -58662,7 +58264,6 @@ class TaskManagementApi {
|
|
|
58662
58264
|
*
|
|
58663
58265
|
* @param {Object} opts Optional parameters
|
|
58664
58266
|
* @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
58267
|
*/
|
|
58667
58268
|
postTaskmanagementWorkbins(opts) {
|
|
58668
58269
|
opts = opts || {};
|
|
@@ -58686,7 +58287,6 @@ class TaskManagementApi {
|
|
|
58686
58287
|
* Query for workbins
|
|
58687
58288
|
*
|
|
58688
58289
|
* @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
58290
|
*/
|
|
58691
58291
|
postTaskmanagementWorkbinsQuery(body) {
|
|
58692
58292
|
// verify the required parameter 'body' is set
|
|
@@ -58712,7 +58312,6 @@ class TaskManagementApi {
|
|
|
58712
58312
|
* Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
|
|
58713
58313
|
*
|
|
58714
58314
|
* @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
58315
|
*/
|
|
58717
58316
|
postTaskmanagementWorkitemAcdCancel(workitemId) {
|
|
58718
58317
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58738,7 +58337,6 @@ class TaskManagementApi {
|
|
|
58738
58337
|
* Disconnect the assignee of the workitem
|
|
58739
58338
|
*
|
|
58740
58339
|
* @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
58340
|
*/
|
|
58743
58341
|
postTaskmanagementWorkitemDisconnect(workitemId) {
|
|
58744
58342
|
// verify the required parameter 'workitemId' is set
|
|
@@ -58766,7 +58364,6 @@ class TaskManagementApi {
|
|
|
58766
58364
|
* @param {String} workitemId Workitem ID
|
|
58767
58365
|
* @param {Object} opts Optional parameters
|
|
58768
58366
|
* @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
58367
|
*/
|
|
58771
58368
|
postTaskmanagementWorkitemTerminate(workitemId, opts) {
|
|
58772
58369
|
opts = opts || {};
|
|
@@ -58794,7 +58391,6 @@ class TaskManagementApi {
|
|
|
58794
58391
|
* Create a workitem
|
|
58795
58392
|
*
|
|
58796
58393
|
* @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
58394
|
*/
|
|
58799
58395
|
postTaskmanagementWorkitems(body) {
|
|
58800
58396
|
// verify the required parameter 'body' is set
|
|
@@ -58846,7 +58442,6 @@ class TaskManagementApi {
|
|
|
58846
58442
|
* Create a workitem query job
|
|
58847
58443
|
*
|
|
58848
58444
|
* @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
58445
|
*/
|
|
58851
58446
|
postTaskmanagementWorkitemsQueryJobs(body) {
|
|
58852
58447
|
// verify the required parameter 'body' is set
|
|
@@ -58872,7 +58467,6 @@ class TaskManagementApi {
|
|
|
58872
58467
|
* Create a schema
|
|
58873
58468
|
*
|
|
58874
58469
|
* @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
58470
|
*/
|
|
58877
58471
|
postTaskmanagementWorkitemsSchemas(body) {
|
|
58878
58472
|
// verify the required parameter 'body' is set
|
|
@@ -58900,7 +58494,6 @@ class TaskManagementApi {
|
|
|
58900
58494
|
* @param {String} worktypeId Worktype id
|
|
58901
58495
|
* @param {Object} opts Optional parameters
|
|
58902
58496
|
* @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
58497
|
*/
|
|
58905
58498
|
postTaskmanagementWorktypeStatuses(worktypeId, opts) {
|
|
58906
58499
|
opts = opts || {};
|
|
@@ -58929,7 +58522,6 @@ class TaskManagementApi {
|
|
|
58929
58522
|
*
|
|
58930
58523
|
* @param {Object} opts Optional parameters
|
|
58931
58524
|
* @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
58525
|
*/
|
|
58934
58526
|
postTaskmanagementWorktypes(opts) {
|
|
58935
58527
|
opts = opts || {};
|
|
@@ -58953,7 +58545,6 @@ class TaskManagementApi {
|
|
|
58953
58545
|
* Query for worktypes
|
|
58954
58546
|
*
|
|
58955
58547
|
* @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
58548
|
*/
|
|
58958
58549
|
postTaskmanagementWorktypesQuery(body) {
|
|
58959
58550
|
// verify the required parameter 'body' is set
|
|
@@ -58980,7 +58571,6 @@ class TaskManagementApi {
|
|
|
58980
58571
|
*
|
|
58981
58572
|
* @param {String} schemaId Schema ID
|
|
58982
58573
|
* @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
58574
|
*/
|
|
58985
58575
|
putTaskmanagementWorkitemsSchema(schemaId, body) {
|
|
58986
58576
|
// verify the required parameter 'schemaId' is set
|
|
@@ -59012,7 +58602,7 @@ class TeamsApi {
|
|
|
59012
58602
|
/**
|
|
59013
58603
|
* Teams service.
|
|
59014
58604
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59015
|
-
* @version
|
|
58605
|
+
* @version 194.0.0
|
|
59016
58606
|
*/
|
|
59017
58607
|
|
|
59018
58608
|
/**
|
|
@@ -59204,7 +58794,6 @@ class TeamsApi {
|
|
|
59204
58794
|
* @param {Object} opts Optional parameters
|
|
59205
58795
|
* @param {Number} opts.pageSize The desired page size
|
|
59206
58796
|
* @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
58797
|
*/
|
|
59209
58798
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
59210
58799
|
opts = opts || {};
|
|
@@ -59314,7 +58903,7 @@ class TelephonyApi {
|
|
|
59314
58903
|
/**
|
|
59315
58904
|
* Telephony service.
|
|
59316
58905
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59317
|
-
* @version
|
|
58906
|
+
* @version 194.0.0
|
|
59318
58907
|
*/
|
|
59319
58908
|
|
|
59320
58909
|
/**
|
|
@@ -59496,7 +59085,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
59496
59085
|
/**
|
|
59497
59086
|
* TelephonyProvidersEdge service.
|
|
59498
59087
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59499
|
-
* @version
|
|
59088
|
+
* @version 194.0.0
|
|
59500
59089
|
*/
|
|
59501
59090
|
|
|
59502
59091
|
/**
|
|
@@ -62824,7 +62413,7 @@ class TextbotsApi {
|
|
|
62824
62413
|
/**
|
|
62825
62414
|
* Textbots service.
|
|
62826
62415
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62827
|
-
* @version
|
|
62416
|
+
* @version 194.0.0
|
|
62828
62417
|
*/
|
|
62829
62418
|
|
|
62830
62419
|
/**
|
|
@@ -62952,7 +62541,7 @@ class TokensApi {
|
|
|
62952
62541
|
/**
|
|
62953
62542
|
* Tokens service.
|
|
62954
62543
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62955
|
-
* @version
|
|
62544
|
+
* @version 194.0.0
|
|
62956
62545
|
*/
|
|
62957
62546
|
|
|
62958
62547
|
/**
|
|
@@ -63106,7 +62695,7 @@ class UploadsApi {
|
|
|
63106
62695
|
/**
|
|
63107
62696
|
* Uploads service.
|
|
63108
62697
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63109
|
-
* @version
|
|
62698
|
+
* @version 194.0.0
|
|
63110
62699
|
*/
|
|
63111
62700
|
|
|
63112
62701
|
/**
|
|
@@ -63375,7 +62964,7 @@ class UsageApi {
|
|
|
63375
62964
|
/**
|
|
63376
62965
|
* Usage service.
|
|
63377
62966
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63378
|
-
* @version
|
|
62967
|
+
* @version 194.0.0
|
|
63379
62968
|
*/
|
|
63380
62969
|
|
|
63381
62970
|
/**
|
|
@@ -63590,7 +63179,7 @@ class UserRecordingsApi {
|
|
|
63590
63179
|
/**
|
|
63591
63180
|
* UserRecordings service.
|
|
63592
63181
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63593
|
-
* @version
|
|
63182
|
+
* @version 194.0.0
|
|
63594
63183
|
*/
|
|
63595
63184
|
|
|
63596
63185
|
/**
|
|
@@ -63775,7 +63364,7 @@ class UsersApi {
|
|
|
63775
63364
|
/**
|
|
63776
63365
|
* Users service.
|
|
63777
63366
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63778
|
-
* @version
|
|
63367
|
+
* @version 194.0.0
|
|
63779
63368
|
*/
|
|
63780
63369
|
|
|
63781
63370
|
/**
|
|
@@ -65445,7 +65034,6 @@ class UsersApi {
|
|
|
65445
65034
|
* @param {Object} opts Optional parameters
|
|
65446
65035
|
* @param {Number} opts.pageSize The desired page size
|
|
65447
65036
|
* @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
65037
|
*/
|
|
65450
65038
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
65451
65039
|
opts = opts || {};
|
|
@@ -66434,7 +66022,7 @@ class UtilitiesApi {
|
|
|
66434
66022
|
/**
|
|
66435
66023
|
* Utilities service.
|
|
66436
66024
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66437
|
-
* @version
|
|
66025
|
+
* @version 194.0.0
|
|
66438
66026
|
*/
|
|
66439
66027
|
|
|
66440
66028
|
/**
|
|
@@ -66545,7 +66133,7 @@ class VoicemailApi {
|
|
|
66545
66133
|
/**
|
|
66546
66134
|
* Voicemail service.
|
|
66547
66135
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66548
|
-
* @version
|
|
66136
|
+
* @version 194.0.0
|
|
66549
66137
|
*/
|
|
66550
66138
|
|
|
66551
66139
|
/**
|
|
@@ -67212,7 +66800,7 @@ class WebChatApi {
|
|
|
67212
66800
|
/**
|
|
67213
66801
|
* WebChat service.
|
|
67214
66802
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67215
|
-
* @version
|
|
66803
|
+
* @version 194.0.0
|
|
67216
66804
|
*/
|
|
67217
66805
|
|
|
67218
66806
|
/**
|
|
@@ -67763,7 +67351,7 @@ class WebDeploymentsApi {
|
|
|
67763
67351
|
/**
|
|
67764
67352
|
* WebDeployments service.
|
|
67765
67353
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67766
|
-
* @version
|
|
67354
|
+
* @version 194.0.0
|
|
67767
67355
|
*/
|
|
67768
67356
|
|
|
67769
67357
|
/**
|
|
@@ -68290,7 +67878,7 @@ class WebMessagingApi {
|
|
|
68290
67878
|
/**
|
|
68291
67879
|
* WebMessaging service.
|
|
68292
67880
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68293
|
-
* @version
|
|
67881
|
+
* @version 194.0.0
|
|
68294
67882
|
*/
|
|
68295
67883
|
|
|
68296
67884
|
/**
|
|
@@ -68336,7 +67924,7 @@ class WidgetsApi {
|
|
|
68336
67924
|
/**
|
|
68337
67925
|
* Widgets service.
|
|
68338
67926
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68339
|
-
* @version
|
|
67927
|
+
* @version 194.0.0
|
|
68340
67928
|
*/
|
|
68341
67929
|
|
|
68342
67930
|
/**
|
|
@@ -68482,7 +68070,7 @@ class WorkforceManagementApi {
|
|
|
68482
68070
|
/**
|
|
68483
68071
|
* WorkforceManagement service.
|
|
68484
68072
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68485
|
-
* @version
|
|
68073
|
+
* @version 194.0.0
|
|
68486
68074
|
*/
|
|
68487
68075
|
|
|
68488
68076
|
/**
|
|
@@ -70522,6 +70110,7 @@ class WorkforceManagementApi {
|
|
|
70522
70110
|
* @param {String} agentId The agent id
|
|
70523
70111
|
* @param {Object} opts Optional parameters
|
|
70524
70112
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
70113
|
+
* @param {Array.<String>} opts.expand
|
|
70525
70114
|
*/
|
|
70526
70115
|
getWorkforcemanagementManagementunitAgent(managementUnitId, agentId, opts) {
|
|
70527
70116
|
opts = opts || {};
|
|
@@ -70539,7 +70128,7 @@ class WorkforceManagementApi {
|
|
|
70539
70128
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}',
|
|
70540
70129
|
'GET',
|
|
70541
70130
|
{ 'managementUnitId': managementUnitId,'agentId': agentId },
|
|
70542
|
-
{ 'excludeCapabilities': opts['excludeCapabilities'] },
|
|
70131
|
+
{ 'excludeCapabilities': opts['excludeCapabilities'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70543
70132
|
{ },
|
|
70544
70133
|
{ },
|
|
70545
70134
|
null,
|
|
@@ -71080,6 +70669,7 @@ class WorkforceManagementApi {
|
|
|
71080
70669
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
71081
70670
|
* @param {Object} opts Optional parameters
|
|
71082
70671
|
* @param {Array.<String>} opts.expand Include to access additional data on the work plans
|
|
70672
|
+
* @param {Array.<String>} opts.exclude Exclude specific data on the work plans from the response
|
|
71083
70673
|
*/
|
|
71084
70674
|
getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
71085
70675
|
opts = opts || {};
|
|
@@ -71093,7 +70683,7 @@ class WorkforceManagementApi {
|
|
|
71093
70683
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
71094
70684
|
'GET',
|
|
71095
70685
|
{ 'managementUnitId': managementUnitId },
|
|
71096
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70686
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'exclude': this.apiClient.buildCollectionParam(opts['exclude'], 'multi') },
|
|
71097
70687
|
{ },
|
|
71098
70688
|
{ },
|
|
71099
70689
|
null,
|
|
@@ -74393,7 +73983,7 @@ class WorkforceManagementApi {
|
|
|
74393
73983
|
* </pre>
|
|
74394
73984
|
* </p>
|
|
74395
73985
|
* @module purecloud-platform-client-v2/index
|
|
74396
|
-
* @version
|
|
73986
|
+
* @version 194.0.0
|
|
74397
73987
|
*/
|
|
74398
73988
|
class platformClient {
|
|
74399
73989
|
constructor() {
|