purecloud-platform-client-v2 193.0.0 → 195.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 +748 -406
- package/dist/web-amd/purecloud-platform-client-v2.js +748 -406
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +253 -180
- package/dist/web-cjs/purecloud-platform-client-v2.js +253 -180
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +537 -453
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +4 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +147 -3
- 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 +1 -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 +26 -316
- 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 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -2
- 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 +174 -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 +1 -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 +1 -1
- 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 -7
- 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 +165 -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 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -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 -1
- 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 +1 -1
- 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 195.0.0
|
|
409
409
|
*/
|
|
410
410
|
class ApiClient {
|
|
411
411
|
/**
|
|
@@ -1480,6 +1480,9 @@ class ApiClient {
|
|
|
1480
1480
|
if (param instanceof Date) {
|
|
1481
1481
|
return param.toJSON();
|
|
1482
1482
|
}
|
|
1483
|
+
if (param instanceof Boolean) {
|
|
1484
|
+
return param.toString().toLowerCase();
|
|
1485
|
+
}
|
|
1483
1486
|
return param.toString();
|
|
1484
1487
|
}
|
|
1485
1488
|
|
|
@@ -1824,7 +1827,7 @@ class AlertingApi {
|
|
|
1824
1827
|
/**
|
|
1825
1828
|
* Alerting service.
|
|
1826
1829
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1827
|
-
* @version
|
|
1830
|
+
* @version 195.0.0
|
|
1828
1831
|
*/
|
|
1829
1832
|
|
|
1830
1833
|
/**
|
|
@@ -2485,7 +2488,7 @@ class AnalyticsApi {
|
|
|
2485
2488
|
/**
|
|
2486
2489
|
* Analytics service.
|
|
2487
2490
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2488
|
-
* @version
|
|
2491
|
+
* @version 195.0.0
|
|
2489
2492
|
*/
|
|
2490
2493
|
|
|
2491
2494
|
/**
|
|
@@ -2606,6 +2609,62 @@ class AnalyticsApi {
|
|
|
2606
2609
|
);
|
|
2607
2610
|
}
|
|
2608
2611
|
|
|
2612
|
+
/**
|
|
2613
|
+
* Get status for async query for agent copilot aggregates
|
|
2614
|
+
*
|
|
2615
|
+
* @param {String} jobId jobId
|
|
2616
|
+
* getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2617
|
+
*/
|
|
2618
|
+
getAnalyticsAgentcopilotsAggregatesJob(jobId) {
|
|
2619
|
+
// verify the required parameter 'jobId' is set
|
|
2620
|
+
if (jobId === undefined || jobId === null) {
|
|
2621
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob';
|
|
2622
|
+
}
|
|
2623
|
+
|
|
2624
|
+
return this.apiClient.callApi(
|
|
2625
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}',
|
|
2626
|
+
'GET',
|
|
2627
|
+
{ 'jobId': jobId },
|
|
2628
|
+
{ },
|
|
2629
|
+
{ },
|
|
2630
|
+
{ },
|
|
2631
|
+
null,
|
|
2632
|
+
['PureCloud OAuth'],
|
|
2633
|
+
['application/json'],
|
|
2634
|
+
['application/json']
|
|
2635
|
+
);
|
|
2636
|
+
}
|
|
2637
|
+
|
|
2638
|
+
/**
|
|
2639
|
+
* Fetch a page of results for an async aggregates query
|
|
2640
|
+
*
|
|
2641
|
+
* @param {String} jobId jobId
|
|
2642
|
+
* @param {Object} opts Optional parameters
|
|
2643
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2644
|
+
* getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2645
|
+
*/
|
|
2646
|
+
getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) {
|
|
2647
|
+
opts = opts || {};
|
|
2648
|
+
|
|
2649
|
+
// verify the required parameter 'jobId' is set
|
|
2650
|
+
if (jobId === undefined || jobId === null) {
|
|
2651
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults';
|
|
2652
|
+
}
|
|
2653
|
+
|
|
2654
|
+
return this.apiClient.callApi(
|
|
2655
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results',
|
|
2656
|
+
'GET',
|
|
2657
|
+
{ 'jobId': jobId },
|
|
2658
|
+
{ 'cursor': opts['cursor'] },
|
|
2659
|
+
{ },
|
|
2660
|
+
{ },
|
|
2661
|
+
null,
|
|
2662
|
+
['PureCloud OAuth'],
|
|
2663
|
+
['application/json'],
|
|
2664
|
+
['application/json']
|
|
2665
|
+
);
|
|
2666
|
+
}
|
|
2667
|
+
|
|
2609
2668
|
/**
|
|
2610
2669
|
* Get Reporting Turns (division aware).
|
|
2611
2670
|
* 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.
|
|
@@ -3364,6 +3423,42 @@ class AnalyticsApi {
|
|
|
3364
3423
|
);
|
|
3365
3424
|
}
|
|
3366
3425
|
|
|
3426
|
+
/**
|
|
3427
|
+
* Get list of dashboard configurations
|
|
3428
|
+
*
|
|
3429
|
+
* @param {Object} dashboardType List dashboard of given type
|
|
3430
|
+
* @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
|
|
3431
|
+
* @param {Object} opts Optional parameters
|
|
3432
|
+
* @param {String} opts.sortBy (default to desc)
|
|
3433
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
3434
|
+
* @param {Number} opts.pageSize (default to 9)
|
|
3435
|
+
*/
|
|
3436
|
+
getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) {
|
|
3437
|
+
opts = opts || {};
|
|
3438
|
+
|
|
3439
|
+
// verify the required parameter 'dashboardType' is set
|
|
3440
|
+
if (dashboardType === undefined || dashboardType === null) {
|
|
3441
|
+
throw 'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery';
|
|
3442
|
+
}
|
|
3443
|
+
// verify the required parameter 'dashboardAccessFilter' is set
|
|
3444
|
+
if (dashboardAccessFilter === undefined || dashboardAccessFilter === null) {
|
|
3445
|
+
throw 'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery';
|
|
3446
|
+
}
|
|
3447
|
+
|
|
3448
|
+
return this.apiClient.callApi(
|
|
3449
|
+
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
3450
|
+
'GET',
|
|
3451
|
+
{ },
|
|
3452
|
+
{ 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3453
|
+
{ },
|
|
3454
|
+
{ },
|
|
3455
|
+
null,
|
|
3456
|
+
['PureCloud OAuth'],
|
|
3457
|
+
['application/json'],
|
|
3458
|
+
['application/json']
|
|
3459
|
+
);
|
|
3460
|
+
}
|
|
3461
|
+
|
|
3367
3462
|
/**
|
|
3368
3463
|
* Get list of dashboards for an user
|
|
3369
3464
|
*
|
|
@@ -3829,6 +3924,58 @@ class AnalyticsApi {
|
|
|
3829
3924
|
);
|
|
3830
3925
|
}
|
|
3831
3926
|
|
|
3927
|
+
/**
|
|
3928
|
+
* Query for agent copilot aggregates asynchronously
|
|
3929
|
+
*
|
|
3930
|
+
* @param {Object} body query
|
|
3931
|
+
* postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3932
|
+
*/
|
|
3933
|
+
postAnalyticsAgentcopilotsAggregatesJobs(body) {
|
|
3934
|
+
// verify the required parameter 'body' is set
|
|
3935
|
+
if (body === undefined || body === null) {
|
|
3936
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs';
|
|
3937
|
+
}
|
|
3938
|
+
|
|
3939
|
+
return this.apiClient.callApi(
|
|
3940
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs',
|
|
3941
|
+
'POST',
|
|
3942
|
+
{ },
|
|
3943
|
+
{ },
|
|
3944
|
+
{ },
|
|
3945
|
+
{ },
|
|
3946
|
+
body,
|
|
3947
|
+
['PureCloud OAuth'],
|
|
3948
|
+
['application/json'],
|
|
3949
|
+
['application/json']
|
|
3950
|
+
);
|
|
3951
|
+
}
|
|
3952
|
+
|
|
3953
|
+
/**
|
|
3954
|
+
* Query for agent copilot aggregates
|
|
3955
|
+
*
|
|
3956
|
+
* @param {Object} body query
|
|
3957
|
+
* postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3958
|
+
*/
|
|
3959
|
+
postAnalyticsAgentcopilotsAggregatesQuery(body) {
|
|
3960
|
+
// verify the required parameter 'body' is set
|
|
3961
|
+
if (body === undefined || body === null) {
|
|
3962
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery';
|
|
3963
|
+
}
|
|
3964
|
+
|
|
3965
|
+
return this.apiClient.callApi(
|
|
3966
|
+
'/api/v2/analytics/agentcopilots/aggregates/query',
|
|
3967
|
+
'POST',
|
|
3968
|
+
{ },
|
|
3969
|
+
{ },
|
|
3970
|
+
{ },
|
|
3971
|
+
{ },
|
|
3972
|
+
body,
|
|
3973
|
+
['PureCloud OAuth'],
|
|
3974
|
+
['application/json'],
|
|
3975
|
+
['application/json']
|
|
3976
|
+
);
|
|
3977
|
+
}
|
|
3978
|
+
|
|
3832
3979
|
/**
|
|
3833
3980
|
* Query for bot aggregates asynchronously
|
|
3834
3981
|
*
|
|
@@ -4402,8 +4549,8 @@ class AnalyticsApi {
|
|
|
4402
4549
|
}
|
|
4403
4550
|
|
|
4404
4551
|
/**
|
|
4405
|
-
* Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded
|
|
4406
|
-
*
|
|
4552
|
+
* Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate.
|
|
4553
|
+
* The max property can be used to determine estimated rate limit value hit.
|
|
4407
4554
|
* @param {Object} body query
|
|
4408
4555
|
*/
|
|
4409
4556
|
postAnalyticsRatelimitsAggregatesQuery(body) {
|
|
@@ -4953,7 +5100,7 @@ class ArchitectApi {
|
|
|
4953
5100
|
/**
|
|
4954
5101
|
* Architect service.
|
|
4955
5102
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4956
|
-
* @version
|
|
5103
|
+
* @version 195.0.0
|
|
4957
5104
|
*/
|
|
4958
5105
|
|
|
4959
5106
|
/**
|
|
@@ -9099,7 +9246,7 @@ class AuditApi {
|
|
|
9099
9246
|
/**
|
|
9100
9247
|
* Audit service.
|
|
9101
9248
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9102
|
-
* @version
|
|
9249
|
+
* @version 195.0.0
|
|
9103
9250
|
*/
|
|
9104
9251
|
|
|
9105
9252
|
/**
|
|
@@ -9264,13 +9411,42 @@ class AuditApi {
|
|
|
9264
9411
|
);
|
|
9265
9412
|
}
|
|
9266
9413
|
|
|
9414
|
+
/**
|
|
9415
|
+
* Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.
|
|
9416
|
+
*
|
|
9417
|
+
* @param {Object} body query
|
|
9418
|
+
* @param {Object} opts Optional parameters
|
|
9419
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
9420
|
+
*/
|
|
9421
|
+
postAuditsQueryRealtimeRelated(body, opts) {
|
|
9422
|
+
opts = opts || {};
|
|
9423
|
+
|
|
9424
|
+
// verify the required parameter 'body' is set
|
|
9425
|
+
if (body === undefined || body === null) {
|
|
9426
|
+
throw 'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';
|
|
9427
|
+
}
|
|
9428
|
+
|
|
9429
|
+
return this.apiClient.callApi(
|
|
9430
|
+
'/api/v2/audits/query/realtime/related',
|
|
9431
|
+
'POST',
|
|
9432
|
+
{ },
|
|
9433
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
9434
|
+
{ },
|
|
9435
|
+
{ },
|
|
9436
|
+
body,
|
|
9437
|
+
['PureCloud OAuth'],
|
|
9438
|
+
['application/json'],
|
|
9439
|
+
['application/json']
|
|
9440
|
+
);
|
|
9441
|
+
}
|
|
9442
|
+
|
|
9267
9443
|
}
|
|
9268
9444
|
|
|
9269
9445
|
class AuthorizationApi {
|
|
9270
9446
|
/**
|
|
9271
9447
|
* Authorization service.
|
|
9272
9448
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9273
|
-
* @version
|
|
9449
|
+
* @version 195.0.0
|
|
9274
9450
|
*/
|
|
9275
9451
|
|
|
9276
9452
|
/**
|
|
@@ -10508,7 +10684,7 @@ class BillingApi {
|
|
|
10508
10684
|
/**
|
|
10509
10685
|
* Billing service.
|
|
10510
10686
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10511
|
-
* @version
|
|
10687
|
+
* @version 195.0.0
|
|
10512
10688
|
*/
|
|
10513
10689
|
|
|
10514
10690
|
/**
|
|
@@ -10588,7 +10764,7 @@ class CarrierServicesApi {
|
|
|
10588
10764
|
/**
|
|
10589
10765
|
* CarrierServices service.
|
|
10590
10766
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10591
|
-
* @version
|
|
10767
|
+
* @version 195.0.0
|
|
10592
10768
|
*/
|
|
10593
10769
|
|
|
10594
10770
|
/**
|
|
@@ -10658,7 +10834,7 @@ class ChatApi {
|
|
|
10658
10834
|
/**
|
|
10659
10835
|
* Chat service.
|
|
10660
10836
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10661
|
-
* @version
|
|
10837
|
+
* @version 195.0.0
|
|
10662
10838
|
*/
|
|
10663
10839
|
|
|
10664
10840
|
/**
|
|
@@ -11594,7 +11770,7 @@ class CoachingApi {
|
|
|
11594
11770
|
/**
|
|
11595
11771
|
* Coaching service.
|
|
11596
11772
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11597
|
-
* @version
|
|
11773
|
+
* @version 195.0.0
|
|
11598
11774
|
*/
|
|
11599
11775
|
|
|
11600
11776
|
/**
|
|
@@ -12171,7 +12347,7 @@ class ContentManagementApi {
|
|
|
12171
12347
|
/**
|
|
12172
12348
|
* ContentManagement service.
|
|
12173
12349
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12174
|
-
* @version
|
|
12350
|
+
* @version 195.0.0
|
|
12175
12351
|
*/
|
|
12176
12352
|
|
|
12177
12353
|
/**
|
|
@@ -13253,7 +13429,7 @@ class ConversationsApi {
|
|
|
13253
13429
|
/**
|
|
13254
13430
|
* Conversations service.
|
|
13255
13431
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13256
|
-
* @version
|
|
13432
|
+
* @version 195.0.0
|
|
13257
13433
|
*/
|
|
13258
13434
|
|
|
13259
13435
|
/**
|
|
@@ -13493,32 +13669,6 @@ class ConversationsApi {
|
|
|
13493
13669
|
);
|
|
13494
13670
|
}
|
|
13495
13671
|
|
|
13496
|
-
/**
|
|
13497
|
-
* Delete a LINE messenger integration (Deprecated)
|
|
13498
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
13499
|
-
* @param {String} integrationId Integration ID
|
|
13500
|
-
* @deprecated
|
|
13501
|
-
*/
|
|
13502
|
-
deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId) {
|
|
13503
|
-
// verify the required parameter 'integrationId' is set
|
|
13504
|
-
if (integrationId === undefined || integrationId === null) {
|
|
13505
|
-
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsLineIntegrationId';
|
|
13506
|
-
}
|
|
13507
|
-
|
|
13508
|
-
return this.apiClient.callApi(
|
|
13509
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
13510
|
-
'DELETE',
|
|
13511
|
-
{ 'integrationId': integrationId },
|
|
13512
|
-
{ },
|
|
13513
|
-
{ },
|
|
13514
|
-
{ },
|
|
13515
|
-
null,
|
|
13516
|
-
['PureCloud OAuth'],
|
|
13517
|
-
['application/json'],
|
|
13518
|
-
['application/json']
|
|
13519
|
-
);
|
|
13520
|
-
}
|
|
13521
|
-
|
|
13522
13672
|
/**
|
|
13523
13673
|
* Delete an Open messaging integration
|
|
13524
13674
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -13544,32 +13694,6 @@ class ConversationsApi {
|
|
|
13544
13694
|
);
|
|
13545
13695
|
}
|
|
13546
13696
|
|
|
13547
|
-
/**
|
|
13548
|
-
* Delete a Twitter messaging integration
|
|
13549
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
13550
|
-
* @param {String} integrationId Integration ID
|
|
13551
|
-
* @deprecated
|
|
13552
|
-
*/
|
|
13553
|
-
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
13554
|
-
// verify the required parameter 'integrationId' is set
|
|
13555
|
-
if (integrationId === undefined || integrationId === null) {
|
|
13556
|
-
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
13557
|
-
}
|
|
13558
|
-
|
|
13559
|
-
return this.apiClient.callApi(
|
|
13560
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
13561
|
-
'DELETE',
|
|
13562
|
-
{ 'integrationId': integrationId },
|
|
13563
|
-
{ },
|
|
13564
|
-
{ },
|
|
13565
|
-
{ },
|
|
13566
|
-
null,
|
|
13567
|
-
['PureCloud OAuth'],
|
|
13568
|
-
['application/json'],
|
|
13569
|
-
['application/json']
|
|
13570
|
-
);
|
|
13571
|
-
}
|
|
13572
|
-
|
|
13573
13697
|
/**
|
|
13574
13698
|
* Delete a WhatsApp messaging integration
|
|
13575
13699
|
*
|
|
@@ -15529,65 +15653,6 @@ class ConversationsApi {
|
|
|
15529
15653
|
);
|
|
15530
15654
|
}
|
|
15531
15655
|
|
|
15532
|
-
/**
|
|
15533
|
-
* Get a list of LINE messenger Integrations (Deprecated)
|
|
15534
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
15535
|
-
* @param {Object} opts Optional parameters
|
|
15536
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15537
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15538
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15539
|
-
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
15540
|
-
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
15541
|
-
* @deprecated
|
|
15542
|
-
*/
|
|
15543
|
-
getConversationsMessagingIntegrationsLine(opts) {
|
|
15544
|
-
opts = opts || {};
|
|
15545
|
-
|
|
15546
|
-
|
|
15547
|
-
return this.apiClient.callApi(
|
|
15548
|
-
'/api/v2/conversations/messaging/integrations/line',
|
|
15549
|
-
'GET',
|
|
15550
|
-
{ },
|
|
15551
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
15552
|
-
{ },
|
|
15553
|
-
{ },
|
|
15554
|
-
null,
|
|
15555
|
-
['PureCloud OAuth'],
|
|
15556
|
-
['application/json'],
|
|
15557
|
-
['application/json']
|
|
15558
|
-
);
|
|
15559
|
-
}
|
|
15560
|
-
|
|
15561
|
-
/**
|
|
15562
|
-
* Get a LINE messenger integration (Deprecated)
|
|
15563
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
15564
|
-
* @param {String} integrationId Integration ID
|
|
15565
|
-
* @param {Object} opts Optional parameters
|
|
15566
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15567
|
-
* @deprecated
|
|
15568
|
-
*/
|
|
15569
|
-
getConversationsMessagingIntegrationsLineIntegrationId(integrationId, opts) {
|
|
15570
|
-
opts = opts || {};
|
|
15571
|
-
|
|
15572
|
-
// verify the required parameter 'integrationId' is set
|
|
15573
|
-
if (integrationId === undefined || integrationId === null) {
|
|
15574
|
-
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsLineIntegrationId';
|
|
15575
|
-
}
|
|
15576
|
-
|
|
15577
|
-
return this.apiClient.callApi(
|
|
15578
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
15579
|
-
'GET',
|
|
15580
|
-
{ 'integrationId': integrationId },
|
|
15581
|
-
{ 'expand': opts['expand'] },
|
|
15582
|
-
{ },
|
|
15583
|
-
{ },
|
|
15584
|
-
null,
|
|
15585
|
-
['PureCloud OAuth'],
|
|
15586
|
-
['application/json'],
|
|
15587
|
-
['application/json']
|
|
15588
|
-
);
|
|
15589
|
-
}
|
|
15590
|
-
|
|
15591
15656
|
/**
|
|
15592
15657
|
* Get a list of Open messaging integrations
|
|
15593
15658
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -15645,65 +15710,6 @@ class ConversationsApi {
|
|
|
15645
15710
|
);
|
|
15646
15711
|
}
|
|
15647
15712
|
|
|
15648
|
-
/**
|
|
15649
|
-
* Get a list of Twitter Integrations (Deprecated)
|
|
15650
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15651
|
-
* @param {Object} opts Optional parameters
|
|
15652
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15653
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15654
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15655
|
-
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
15656
|
-
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
15657
|
-
* @deprecated
|
|
15658
|
-
*/
|
|
15659
|
-
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
15660
|
-
opts = opts || {};
|
|
15661
|
-
|
|
15662
|
-
|
|
15663
|
-
return this.apiClient.callApi(
|
|
15664
|
-
'/api/v2/conversations/messaging/integrations/twitter',
|
|
15665
|
-
'GET',
|
|
15666
|
-
{ },
|
|
15667
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
15668
|
-
{ },
|
|
15669
|
-
{ },
|
|
15670
|
-
null,
|
|
15671
|
-
['PureCloud OAuth'],
|
|
15672
|
-
['application/json'],
|
|
15673
|
-
['application/json']
|
|
15674
|
-
);
|
|
15675
|
-
}
|
|
15676
|
-
|
|
15677
|
-
/**
|
|
15678
|
-
* Get a Twitter messaging integration (Deprecated)
|
|
15679
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
15680
|
-
* @param {String} integrationId Integration ID
|
|
15681
|
-
* @param {Object} opts Optional parameters
|
|
15682
|
-
* @param {Object} opts.expand Expand instructions for the return value.
|
|
15683
|
-
* @deprecated
|
|
15684
|
-
*/
|
|
15685
|
-
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
15686
|
-
opts = opts || {};
|
|
15687
|
-
|
|
15688
|
-
// verify the required parameter 'integrationId' is set
|
|
15689
|
-
if (integrationId === undefined || integrationId === null) {
|
|
15690
|
-
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
15691
|
-
}
|
|
15692
|
-
|
|
15693
|
-
return this.apiClient.callApi(
|
|
15694
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
15695
|
-
'GET',
|
|
15696
|
-
{ 'integrationId': integrationId },
|
|
15697
|
-
{ 'expand': opts['expand'] },
|
|
15698
|
-
{ },
|
|
15699
|
-
{ },
|
|
15700
|
-
null,
|
|
15701
|
-
['PureCloud OAuth'],
|
|
15702
|
-
['application/json'],
|
|
15703
|
-
['application/json']
|
|
15704
|
-
);
|
|
15705
|
-
}
|
|
15706
|
-
|
|
15707
15713
|
/**
|
|
15708
15714
|
* Get a list of WhatsApp Integrations
|
|
15709
15715
|
*
|
|
@@ -15831,37 +15837,6 @@ class ConversationsApi {
|
|
|
15831
15837
|
);
|
|
15832
15838
|
}
|
|
15833
15839
|
|
|
15834
|
-
/**
|
|
15835
|
-
* Get a list of Messaging Stickers (Deprecated)
|
|
15836
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
15837
|
-
* @param {Object} messengerType Messenger Type
|
|
15838
|
-
* @param {Object} opts Optional parameters
|
|
15839
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15840
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15841
|
-
* @deprecated
|
|
15842
|
-
*/
|
|
15843
|
-
getConversationsMessagingSticker(messengerType, opts) {
|
|
15844
|
-
opts = opts || {};
|
|
15845
|
-
|
|
15846
|
-
// verify the required parameter 'messengerType' is set
|
|
15847
|
-
if (messengerType === undefined || messengerType === null) {
|
|
15848
|
-
throw 'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker';
|
|
15849
|
-
}
|
|
15850
|
-
|
|
15851
|
-
return this.apiClient.callApi(
|
|
15852
|
-
'/api/v2/conversations/messaging/stickers/{messengerType}',
|
|
15853
|
-
'GET',
|
|
15854
|
-
{ 'messengerType': messengerType },
|
|
15855
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
15856
|
-
{ },
|
|
15857
|
-
{ },
|
|
15858
|
-
null,
|
|
15859
|
-
['PureCloud OAuth'],
|
|
15860
|
-
['application/json'],
|
|
15861
|
-
['application/json']
|
|
15862
|
-
);
|
|
15863
|
-
}
|
|
15864
|
-
|
|
15865
15840
|
/**
|
|
15866
15841
|
* Get a list of Supported Content profiles
|
|
15867
15842
|
*
|
|
@@ -17334,37 +17309,6 @@ class ConversationsApi {
|
|
|
17334
17309
|
);
|
|
17335
17310
|
}
|
|
17336
17311
|
|
|
17337
|
-
/**
|
|
17338
|
-
* Update Twitter messaging integration
|
|
17339
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
17340
|
-
* @param {String} integrationId Integration ID
|
|
17341
|
-
* @param {Object} body TwitterIntegrationRequest
|
|
17342
|
-
* @deprecated
|
|
17343
|
-
*/
|
|
17344
|
-
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
17345
|
-
// verify the required parameter 'integrationId' is set
|
|
17346
|
-
if (integrationId === undefined || integrationId === null) {
|
|
17347
|
-
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
17348
|
-
}
|
|
17349
|
-
// verify the required parameter 'body' is set
|
|
17350
|
-
if (body === undefined || body === null) {
|
|
17351
|
-
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
17352
|
-
}
|
|
17353
|
-
|
|
17354
|
-
return this.apiClient.callApi(
|
|
17355
|
-
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
17356
|
-
'PATCH',
|
|
17357
|
-
{ 'integrationId': integrationId },
|
|
17358
|
-
{ },
|
|
17359
|
-
{ },
|
|
17360
|
-
{ },
|
|
17361
|
-
body,
|
|
17362
|
-
['PureCloud OAuth'],
|
|
17363
|
-
['application/json'],
|
|
17364
|
-
['application/json']
|
|
17365
|
-
);
|
|
17366
|
-
}
|
|
17367
|
-
|
|
17368
17312
|
/**
|
|
17369
17313
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
17370
17314
|
* 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
|
|
@@ -18995,6 +18939,31 @@ class ConversationsApi {
|
|
|
18995
18939
|
);
|
|
18996
18940
|
}
|
|
18997
18941
|
|
|
18942
|
+
/**
|
|
18943
|
+
* Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
|
|
18944
|
+
*
|
|
18945
|
+
* @param {String} conversationId conversationId
|
|
18946
|
+
*/
|
|
18947
|
+
postConversationsEmailReconnect(conversationId) {
|
|
18948
|
+
// verify the required parameter 'conversationId' is set
|
|
18949
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18950
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect';
|
|
18951
|
+
}
|
|
18952
|
+
|
|
18953
|
+
return this.apiClient.callApi(
|
|
18954
|
+
'/api/v2/conversations/emails/{conversationId}/reconnect',
|
|
18955
|
+
'POST',
|
|
18956
|
+
{ 'conversationId': conversationId },
|
|
18957
|
+
{ },
|
|
18958
|
+
{ },
|
|
18959
|
+
{ },
|
|
18960
|
+
null,
|
|
18961
|
+
['PureCloud OAuth'],
|
|
18962
|
+
['application/json'],
|
|
18963
|
+
['application/json']
|
|
18964
|
+
);
|
|
18965
|
+
}
|
|
18966
|
+
|
|
18998
18967
|
/**
|
|
18999
18968
|
* Create an email conversation
|
|
19000
18969
|
* If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
|
|
@@ -19574,32 +19543,6 @@ class ConversationsApi {
|
|
|
19574
19543
|
);
|
|
19575
19544
|
}
|
|
19576
19545
|
|
|
19577
|
-
/**
|
|
19578
|
-
* Create a LINE messenger Integration (Deprecated)
|
|
19579
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
19580
|
-
* @param {Object} body LineIntegrationRequest
|
|
19581
|
-
* @deprecated
|
|
19582
|
-
*/
|
|
19583
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
19584
|
-
// verify the required parameter 'body' is set
|
|
19585
|
-
if (body === undefined || body === null) {
|
|
19586
|
-
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
19587
|
-
}
|
|
19588
|
-
|
|
19589
|
-
return this.apiClient.callApi(
|
|
19590
|
-
'/api/v2/conversations/messaging/integrations/line',
|
|
19591
|
-
'POST',
|
|
19592
|
-
{ },
|
|
19593
|
-
{ },
|
|
19594
|
-
{ },
|
|
19595
|
-
{ },
|
|
19596
|
-
body,
|
|
19597
|
-
['PureCloud OAuth'],
|
|
19598
|
-
['application/json'],
|
|
19599
|
-
['application/json']
|
|
19600
|
-
);
|
|
19601
|
-
}
|
|
19602
|
-
|
|
19603
19546
|
/**
|
|
19604
19547
|
* Create an Open messaging integration
|
|
19605
19548
|
* See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
|
@@ -19625,32 +19568,6 @@ class ConversationsApi {
|
|
|
19625
19568
|
);
|
|
19626
19569
|
}
|
|
19627
19570
|
|
|
19628
|
-
/**
|
|
19629
|
-
* Create a Twitter Integration
|
|
19630
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
19631
|
-
* @param {Object} body TwitterIntegrationRequest
|
|
19632
|
-
* @deprecated
|
|
19633
|
-
*/
|
|
19634
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
19635
|
-
// verify the required parameter 'body' is set
|
|
19636
|
-
if (body === undefined || body === null) {
|
|
19637
|
-
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
19638
|
-
}
|
|
19639
|
-
|
|
19640
|
-
return this.apiClient.callApi(
|
|
19641
|
-
'/api/v2/conversations/messaging/integrations/twitter',
|
|
19642
|
-
'POST',
|
|
19643
|
-
{ },
|
|
19644
|
-
{ },
|
|
19645
|
-
{ },
|
|
19646
|
-
{ },
|
|
19647
|
-
body,
|
|
19648
|
-
['PureCloud OAuth'],
|
|
19649
|
-
['application/json'],
|
|
19650
|
-
['application/json']
|
|
19651
|
-
);
|
|
19652
|
-
}
|
|
19653
|
-
|
|
19654
19571
|
/**
|
|
19655
19572
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
19656
19573
|
* [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.
|
|
@@ -20291,37 +20208,6 @@ class ConversationsApi {
|
|
|
20291
20208
|
);
|
|
20292
20209
|
}
|
|
20293
20210
|
|
|
20294
|
-
/**
|
|
20295
|
-
* Update a LINE messenger integration (Deprecated)
|
|
20296
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
20297
|
-
* @param {String} integrationId Integration ID
|
|
20298
|
-
* @param {Object} body LineIntegrationRequest
|
|
20299
|
-
* @deprecated
|
|
20300
|
-
*/
|
|
20301
|
-
putConversationsMessagingIntegrationsLineIntegrationId(integrationId, body) {
|
|
20302
|
-
// verify the required parameter 'integrationId' is set
|
|
20303
|
-
if (integrationId === undefined || integrationId === null) {
|
|
20304
|
-
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIntegrationsLineIntegrationId';
|
|
20305
|
-
}
|
|
20306
|
-
// verify the required parameter 'body' is set
|
|
20307
|
-
if (body === undefined || body === null) {
|
|
20308
|
-
throw 'Missing the required parameter "body" when calling putConversationsMessagingIntegrationsLineIntegrationId';
|
|
20309
|
-
}
|
|
20310
|
-
|
|
20311
|
-
return this.apiClient.callApi(
|
|
20312
|
-
'/api/v2/conversations/messaging/integrations/line/{integrationId}',
|
|
20313
|
-
'PUT',
|
|
20314
|
-
{ 'integrationId': integrationId },
|
|
20315
|
-
{ },
|
|
20316
|
-
{ },
|
|
20317
|
-
{ },
|
|
20318
|
-
body,
|
|
20319
|
-
['PureCloud OAuth'],
|
|
20320
|
-
['application/json'],
|
|
20321
|
-
['application/json']
|
|
20322
|
-
);
|
|
20323
|
-
}
|
|
20324
|
-
|
|
20325
20211
|
/**
|
|
20326
20212
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
20327
20213
|
* 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.
|
|
@@ -20494,7 +20380,7 @@ class DataExtensionsApi {
|
|
|
20494
20380
|
/**
|
|
20495
20381
|
* DataExtensions service.
|
|
20496
20382
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20497
|
-
* @version
|
|
20383
|
+
* @version 195.0.0
|
|
20498
20384
|
*/
|
|
20499
20385
|
|
|
20500
20386
|
/**
|
|
@@ -20580,7 +20466,7 @@ class DownloadsApi {
|
|
|
20580
20466
|
/**
|
|
20581
20467
|
* Downloads service.
|
|
20582
20468
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20583
|
-
* @version
|
|
20469
|
+
* @version 195.0.0
|
|
20584
20470
|
*/
|
|
20585
20471
|
|
|
20586
20472
|
/**
|
|
@@ -20632,7 +20518,7 @@ class EmailsApi {
|
|
|
20632
20518
|
/**
|
|
20633
20519
|
* Emails service.
|
|
20634
20520
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20635
|
-
* @version
|
|
20521
|
+
* @version 195.0.0
|
|
20636
20522
|
*/
|
|
20637
20523
|
|
|
20638
20524
|
/**
|
|
@@ -20697,7 +20583,7 @@ class EventsApi {
|
|
|
20697
20583
|
/**
|
|
20698
20584
|
* Events service.
|
|
20699
20585
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20700
|
-
* @version
|
|
20586
|
+
* @version 195.0.0
|
|
20701
20587
|
*/
|
|
20702
20588
|
|
|
20703
20589
|
/**
|
|
@@ -20793,7 +20679,7 @@ class ExternalContactsApi {
|
|
|
20793
20679
|
/**
|
|
20794
20680
|
* ExternalContacts service.
|
|
20795
20681
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20796
|
-
* @version
|
|
20682
|
+
* @version 195.0.0
|
|
20797
20683
|
*/
|
|
20798
20684
|
|
|
20799
20685
|
/**
|
|
@@ -21306,7 +21192,7 @@ class ExternalContactsApi {
|
|
|
21306
21192
|
*
|
|
21307
21193
|
* @param {String} externalOrganizationId External Organization ID
|
|
21308
21194
|
* @param {Object} opts Optional parameters
|
|
21309
|
-
* @param {
|
|
21195
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalDataSources)
|
|
21310
21196
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
21311
21197
|
*/
|
|
21312
21198
|
getExternalcontactsOrganization(externalOrganizationId, opts) {
|
|
@@ -21321,7 +21207,7 @@ class ExternalContactsApi {
|
|
|
21321
21207
|
'/api/v2/externalcontacts/organizations/{externalOrganizationId}',
|
|
21322
21208
|
'GET',
|
|
21323
21209
|
{ 'externalOrganizationId': externalOrganizationId },
|
|
21324
|
-
{ 'expand': opts['expand'],'includeTrustors': opts['includeTrustors'] },
|
|
21210
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'] },
|
|
21325
21211
|
{ },
|
|
21326
21212
|
{ },
|
|
21327
21213
|
null,
|
|
@@ -21437,7 +21323,7 @@ class ExternalContactsApi {
|
|
|
21437
21323
|
* @param {Object} opts Optional parameters
|
|
21438
21324
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
21439
21325
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
21440
|
-
* @param {
|
|
21326
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21441
21327
|
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
21442
21328
|
*/
|
|
21443
21329
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
@@ -21452,7 +21338,7 @@ class ExternalContactsApi {
|
|
|
21452
21338
|
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships',
|
|
21453
21339
|
'GET',
|
|
21454
21340
|
{ 'externalOrganizationId': externalOrganizationId },
|
|
21455
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'sortOrder': opts['sortOrder'] },
|
|
21341
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'sortOrder': opts['sortOrder'] },
|
|
21456
21342
|
{ },
|
|
21457
21343
|
{ },
|
|
21458
21344
|
null,
|
|
@@ -21597,7 +21483,7 @@ class ExternalContactsApi {
|
|
|
21597
21483
|
*
|
|
21598
21484
|
* @param {String} relationshipId Relationship Id
|
|
21599
21485
|
* @param {Object} opts Optional parameters
|
|
21600
|
-
* @param {
|
|
21486
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21601
21487
|
*/
|
|
21602
21488
|
getExternalcontactsRelationship(relationshipId, opts) {
|
|
21603
21489
|
opts = opts || {};
|
|
@@ -21611,7 +21497,7 @@ class ExternalContactsApi {
|
|
|
21611
21497
|
'/api/v2/externalcontacts/relationships/{relationshipId}',
|
|
21612
21498
|
'GET',
|
|
21613
21499
|
{ 'relationshipId': relationshipId },
|
|
21614
|
-
{ 'expand': opts['expand'] },
|
|
21500
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
21615
21501
|
{ },
|
|
21616
21502
|
{ },
|
|
21617
21503
|
null,
|
|
@@ -22751,7 +22637,7 @@ class FaxApi {
|
|
|
22751
22637
|
/**
|
|
22752
22638
|
* Fax service.
|
|
22753
22639
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22754
|
-
* @version
|
|
22640
|
+
* @version 195.0.0
|
|
22755
22641
|
*/
|
|
22756
22642
|
|
|
22757
22643
|
/**
|
|
@@ -22966,7 +22852,7 @@ class FlowsApi {
|
|
|
22966
22852
|
/**
|
|
22967
22853
|
* Flows service.
|
|
22968
22854
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22969
|
-
* @version
|
|
22855
|
+
* @version 195.0.0
|
|
22970
22856
|
*/
|
|
22971
22857
|
|
|
22972
22858
|
/**
|
|
@@ -23149,7 +23035,7 @@ class GamificationApi {
|
|
|
23149
23035
|
/**
|
|
23150
23036
|
* Gamification service.
|
|
23151
23037
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23152
|
-
* @version
|
|
23038
|
+
* @version 195.0.0
|
|
23153
23039
|
*/
|
|
23154
23040
|
|
|
23155
23041
|
/**
|
|
@@ -25235,7 +25121,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25235
25121
|
/**
|
|
25236
25122
|
* GeneralDataProtectionRegulation service.
|
|
25237
25123
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25238
|
-
* @version
|
|
25124
|
+
* @version 195.0.0
|
|
25239
25125
|
*/
|
|
25240
25126
|
|
|
25241
25127
|
/**
|
|
@@ -25365,7 +25251,7 @@ class GeolocationApi {
|
|
|
25365
25251
|
/**
|
|
25366
25252
|
* Geolocation service.
|
|
25367
25253
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25368
|
-
* @version
|
|
25254
|
+
* @version 195.0.0
|
|
25369
25255
|
*/
|
|
25370
25256
|
|
|
25371
25257
|
/**
|
|
@@ -25496,7 +25382,7 @@ class GreetingsApi {
|
|
|
25496
25382
|
/**
|
|
25497
25383
|
* Greetings service.
|
|
25498
25384
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25499
|
-
* @version
|
|
25385
|
+
* @version 195.0.0
|
|
25500
25386
|
*/
|
|
25501
25387
|
|
|
25502
25388
|
/**
|
|
@@ -25951,7 +25837,7 @@ class GroupsApi {
|
|
|
25951
25837
|
/**
|
|
25952
25838
|
* Groups service.
|
|
25953
25839
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25954
|
-
* @version
|
|
25840
|
+
* @version 195.0.0
|
|
25955
25841
|
*/
|
|
25956
25842
|
|
|
25957
25843
|
/**
|
|
@@ -26470,7 +26356,7 @@ class IdentityProviderApi {
|
|
|
26470
26356
|
/**
|
|
26471
26357
|
* IdentityProvider service.
|
|
26472
26358
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26473
|
-
* @version
|
|
26359
|
+
* @version 195.0.0
|
|
26474
26360
|
*/
|
|
26475
26361
|
|
|
26476
26362
|
/**
|
|
@@ -27331,7 +27217,7 @@ class InfrastructureAsCodeApi {
|
|
|
27331
27217
|
/**
|
|
27332
27218
|
* InfrastructureAsCode service.
|
|
27333
27219
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27334
|
-
* @version
|
|
27220
|
+
* @version 195.0.0
|
|
27335
27221
|
*/
|
|
27336
27222
|
|
|
27337
27223
|
/**
|
|
@@ -27498,7 +27384,7 @@ class IntegrationsApi {
|
|
|
27498
27384
|
/**
|
|
27499
27385
|
* Integrations service.
|
|
27500
27386
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27501
|
-
* @version
|
|
27387
|
+
* @version 195.0.0
|
|
27502
27388
|
*/
|
|
27503
27389
|
|
|
27504
27390
|
/**
|
|
@@ -29850,7 +29736,7 @@ class JourneyApi {
|
|
|
29850
29736
|
/**
|
|
29851
29737
|
* Journey service.
|
|
29852
29738
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29853
|
-
* @version
|
|
29739
|
+
* @version 195.0.0
|
|
29854
29740
|
*/
|
|
29855
29741
|
|
|
29856
29742
|
/**
|
|
@@ -31439,7 +31325,7 @@ class KnowledgeApi {
|
|
|
31439
31325
|
/**
|
|
31440
31326
|
* Knowledge service.
|
|
31441
31327
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31442
|
-
* @version
|
|
31328
|
+
* @version 195.0.0
|
|
31443
31329
|
*/
|
|
31444
31330
|
|
|
31445
31331
|
/**
|
|
@@ -32793,6 +32679,7 @@ class KnowledgeApi {
|
|
|
32793
32679
|
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
32794
32680
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
32795
32681
|
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
32682
|
+
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
32796
32683
|
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32797
32684
|
*/
|
|
32798
32685
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
@@ -32807,7 +32694,7 @@ class KnowledgeApi {
|
|
|
32807
32694
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations',
|
|
32808
32695
|
'GET',
|
|
32809
32696
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32810
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'] },
|
|
32697
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'],'sourceId': this.apiClient.buildCollectionParam(opts['sourceId'], 'multi') },
|
|
32811
32698
|
{ },
|
|
32812
32699
|
{ },
|
|
32813
32700
|
null,
|
|
@@ -34682,7 +34569,7 @@ class LanguageUnderstandingApi {
|
|
|
34682
34569
|
/**
|
|
34683
34570
|
* LanguageUnderstanding service.
|
|
34684
34571
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34685
|
-
* @version
|
|
34572
|
+
* @version 195.0.0
|
|
34686
34573
|
*/
|
|
34687
34574
|
|
|
34688
34575
|
/**
|
|
@@ -35716,7 +35603,7 @@ class LanguagesApi {
|
|
|
35716
35603
|
/**
|
|
35717
35604
|
* Languages service.
|
|
35718
35605
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35719
|
-
* @version
|
|
35606
|
+
* @version 195.0.0
|
|
35720
35607
|
*/
|
|
35721
35608
|
|
|
35722
35609
|
/**
|
|
@@ -35938,7 +35825,7 @@ class LearningApi {
|
|
|
35938
35825
|
/**
|
|
35939
35826
|
* Learning service.
|
|
35940
35827
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35941
|
-
* @version
|
|
35828
|
+
* @version 195.0.0
|
|
35942
35829
|
*/
|
|
35943
35830
|
|
|
35944
35831
|
/**
|
|
@@ -36032,6 +35919,41 @@ class LearningApi {
|
|
|
36032
35919
|
);
|
|
36033
35920
|
}
|
|
36034
35921
|
|
|
35922
|
+
/**
|
|
35923
|
+
* Get Learning Assignment Step
|
|
35924
|
+
* Permission not required if you are the assigned user of the learning assignment
|
|
35925
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
35926
|
+
* @param {String} stepId The ID of Learning Assignment Step
|
|
35927
|
+
* @param {Object} opts Optional parameters
|
|
35928
|
+
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
35929
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35930
|
+
*/
|
|
35931
|
+
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
35932
|
+
opts = opts || {};
|
|
35933
|
+
|
|
35934
|
+
// verify the required parameter 'assignmentId' is set
|
|
35935
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
35936
|
+
throw 'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';
|
|
35937
|
+
}
|
|
35938
|
+
// verify the required parameter 'stepId' is set
|
|
35939
|
+
if (stepId === undefined || stepId === null) {
|
|
35940
|
+
throw 'Missing the required parameter "stepId" when calling getLearningAssignmentStep';
|
|
35941
|
+
}
|
|
35942
|
+
|
|
35943
|
+
return this.apiClient.callApi(
|
|
35944
|
+
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35945
|
+
'GET',
|
|
35946
|
+
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35947
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35948
|
+
{ },
|
|
35949
|
+
{ },
|
|
35950
|
+
null,
|
|
35951
|
+
['PureCloud OAuth'],
|
|
35952
|
+
['application/json'],
|
|
35953
|
+
['application/json']
|
|
35954
|
+
);
|
|
35955
|
+
}
|
|
35956
|
+
|
|
36035
35957
|
/**
|
|
36036
35958
|
* List of Learning module Assignments
|
|
36037
35959
|
* Either moduleId or user value is required
|
|
@@ -36166,6 +36088,31 @@ class LearningApi {
|
|
|
36166
36088
|
);
|
|
36167
36089
|
}
|
|
36168
36090
|
|
|
36091
|
+
/**
|
|
36092
|
+
* Get a learning module preview
|
|
36093
|
+
*
|
|
36094
|
+
* @param {String} moduleId The ID of the learning module
|
|
36095
|
+
*/
|
|
36096
|
+
getLearningModulePreview(moduleId) {
|
|
36097
|
+
// verify the required parameter 'moduleId' is set
|
|
36098
|
+
if (moduleId === undefined || moduleId === null) {
|
|
36099
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview';
|
|
36100
|
+
}
|
|
36101
|
+
|
|
36102
|
+
return this.apiClient.callApi(
|
|
36103
|
+
'/api/v2/learning/modules/{moduleId}/preview',
|
|
36104
|
+
'GET',
|
|
36105
|
+
{ 'moduleId': moduleId },
|
|
36106
|
+
{ },
|
|
36107
|
+
{ },
|
|
36108
|
+
{ },
|
|
36109
|
+
null,
|
|
36110
|
+
['PureCloud OAuth'],
|
|
36111
|
+
['application/json'],
|
|
36112
|
+
['application/json']
|
|
36113
|
+
);
|
|
36114
|
+
}
|
|
36115
|
+
|
|
36169
36116
|
/**
|
|
36170
36117
|
* Get a learning module rule
|
|
36171
36118
|
*
|
|
@@ -36318,6 +36265,31 @@ class LearningApi {
|
|
|
36318
36265
|
);
|
|
36319
36266
|
}
|
|
36320
36267
|
|
|
36268
|
+
/**
|
|
36269
|
+
* Get Learning SCORM Result
|
|
36270
|
+
*
|
|
36271
|
+
* @param {String} scormId The ID of the SCORM package
|
|
36272
|
+
*/
|
|
36273
|
+
getLearningScormScormId(scormId) {
|
|
36274
|
+
// verify the required parameter 'scormId' is set
|
|
36275
|
+
if (scormId === undefined || scormId === null) {
|
|
36276
|
+
throw 'Missing the required parameter "scormId" when calling getLearningScormScormId';
|
|
36277
|
+
}
|
|
36278
|
+
|
|
36279
|
+
return this.apiClient.callApi(
|
|
36280
|
+
'/api/v2/learning/scorm/{scormId}',
|
|
36281
|
+
'GET',
|
|
36282
|
+
{ 'scormId': scormId },
|
|
36283
|
+
{ },
|
|
36284
|
+
{ },
|
|
36285
|
+
{ },
|
|
36286
|
+
null,
|
|
36287
|
+
['PureCloud OAuth'],
|
|
36288
|
+
['application/json'],
|
|
36289
|
+
['application/json']
|
|
36290
|
+
);
|
|
36291
|
+
}
|
|
36292
|
+
|
|
36321
36293
|
/**
|
|
36322
36294
|
* Update Learning Assignment
|
|
36323
36295
|
*
|
|
@@ -36376,6 +36348,40 @@ class LearningApi {
|
|
|
36376
36348
|
);
|
|
36377
36349
|
}
|
|
36378
36350
|
|
|
36351
|
+
/**
|
|
36352
|
+
* Update Learning Assignment Step
|
|
36353
|
+
* Permission not required if you are the assigned user of the learning assignment
|
|
36354
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
36355
|
+
* @param {String} stepId The ID of Learning Assignment Step
|
|
36356
|
+
* @param {Object} opts Optional parameters
|
|
36357
|
+
* @param {Object} opts.body The Learning Assignment Step to be updated
|
|
36358
|
+
*/
|
|
36359
|
+
patchLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
36360
|
+
opts = opts || {};
|
|
36361
|
+
|
|
36362
|
+
// verify the required parameter 'assignmentId' is set
|
|
36363
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
36364
|
+
throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep';
|
|
36365
|
+
}
|
|
36366
|
+
// verify the required parameter 'stepId' is set
|
|
36367
|
+
if (stepId === undefined || stepId === null) {
|
|
36368
|
+
throw 'Missing the required parameter "stepId" when calling patchLearningAssignmentStep';
|
|
36369
|
+
}
|
|
36370
|
+
|
|
36371
|
+
return this.apiClient.callApi(
|
|
36372
|
+
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
36373
|
+
'PATCH',
|
|
36374
|
+
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
36375
|
+
{ },
|
|
36376
|
+
{ },
|
|
36377
|
+
{ },
|
|
36378
|
+
opts['body'],
|
|
36379
|
+
['PureCloud OAuth'],
|
|
36380
|
+
['application/json'],
|
|
36381
|
+
['application/json']
|
|
36382
|
+
);
|
|
36383
|
+
}
|
|
36384
|
+
|
|
36379
36385
|
/**
|
|
36380
36386
|
* Update an external assignment for a specific user
|
|
36381
36387
|
*
|
|
@@ -36727,6 +36733,30 @@ class LearningApi {
|
|
|
36727
36733
|
);
|
|
36728
36734
|
}
|
|
36729
36735
|
|
|
36736
|
+
/**
|
|
36737
|
+
* Create a SCORM package upload request
|
|
36738
|
+
*
|
|
36739
|
+
* @param {Object} opts Optional parameters
|
|
36740
|
+
* @param {Object} opts.body The SCORM package to be uploaded
|
|
36741
|
+
*/
|
|
36742
|
+
postLearningScorm(opts) {
|
|
36743
|
+
opts = opts || {};
|
|
36744
|
+
|
|
36745
|
+
|
|
36746
|
+
return this.apiClient.callApi(
|
|
36747
|
+
'/api/v2/learning/scorm',
|
|
36748
|
+
'POST',
|
|
36749
|
+
{ },
|
|
36750
|
+
{ },
|
|
36751
|
+
{ },
|
|
36752
|
+
{ },
|
|
36753
|
+
opts['body'],
|
|
36754
|
+
['PureCloud OAuth'],
|
|
36755
|
+
['application/json'],
|
|
36756
|
+
['application/json']
|
|
36757
|
+
);
|
|
36758
|
+
}
|
|
36759
|
+
|
|
36730
36760
|
/**
|
|
36731
36761
|
* Update a learning module
|
|
36732
36762
|
* This will update the name, description, completion time in days and inform steps for a learning module
|
|
@@ -36757,6 +36787,36 @@ class LearningApi {
|
|
|
36757
36787
|
);
|
|
36758
36788
|
}
|
|
36759
36789
|
|
|
36790
|
+
/**
|
|
36791
|
+
* Update a learning module preview
|
|
36792
|
+
* This will update a learning module preview
|
|
36793
|
+
* @param {String} moduleId The ID of the learning module
|
|
36794
|
+
* @param {Object} body The learning module to be updated
|
|
36795
|
+
*/
|
|
36796
|
+
putLearningModulePreview(moduleId, body) {
|
|
36797
|
+
// verify the required parameter 'moduleId' is set
|
|
36798
|
+
if (moduleId === undefined || moduleId === null) {
|
|
36799
|
+
throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview';
|
|
36800
|
+
}
|
|
36801
|
+
// verify the required parameter 'body' is set
|
|
36802
|
+
if (body === undefined || body === null) {
|
|
36803
|
+
throw 'Missing the required parameter "body" when calling putLearningModulePreview';
|
|
36804
|
+
}
|
|
36805
|
+
|
|
36806
|
+
return this.apiClient.callApi(
|
|
36807
|
+
'/api/v2/learning/modules/{moduleId}/preview',
|
|
36808
|
+
'PUT',
|
|
36809
|
+
{ 'moduleId': moduleId },
|
|
36810
|
+
{ },
|
|
36811
|
+
{ },
|
|
36812
|
+
{ },
|
|
36813
|
+
body,
|
|
36814
|
+
['PureCloud OAuth'],
|
|
36815
|
+
['application/json'],
|
|
36816
|
+
['application/json']
|
|
36817
|
+
);
|
|
36818
|
+
}
|
|
36819
|
+
|
|
36760
36820
|
/**
|
|
36761
36821
|
* Update a learning module rule
|
|
36762
36822
|
* This will update a learning module rule with the specified fields.
|
|
@@ -36793,7 +36853,7 @@ class LicenseApi {
|
|
|
36793
36853
|
/**
|
|
36794
36854
|
* License service.
|
|
36795
36855
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36796
|
-
* @version
|
|
36856
|
+
* @version 195.0.0
|
|
36797
36857
|
*/
|
|
36798
36858
|
|
|
36799
36859
|
/**
|
|
@@ -37031,7 +37091,7 @@ class LocationsApi {
|
|
|
37031
37091
|
/**
|
|
37032
37092
|
* Locations service.
|
|
37033
37093
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37034
|
-
* @version
|
|
37094
|
+
* @version 195.0.0
|
|
37035
37095
|
*/
|
|
37036
37096
|
|
|
37037
37097
|
/**
|
|
@@ -37267,7 +37327,7 @@ class LogCaptureApi {
|
|
|
37267
37327
|
/**
|
|
37268
37328
|
* LogCapture service.
|
|
37269
37329
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37270
|
-
* @version
|
|
37330
|
+
* @version 195.0.0
|
|
37271
37331
|
*/
|
|
37272
37332
|
|
|
37273
37333
|
/**
|
|
@@ -37467,7 +37527,7 @@ class MessagingApi {
|
|
|
37467
37527
|
/**
|
|
37468
37528
|
* Messaging service.
|
|
37469
37529
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37470
|
-
* @version
|
|
37530
|
+
* @version 195.0.0
|
|
37471
37531
|
*/
|
|
37472
37532
|
|
|
37473
37533
|
/**
|
|
@@ -37826,7 +37886,7 @@ class MobileDevicesApi {
|
|
|
37826
37886
|
/**
|
|
37827
37887
|
* MobileDevices service.
|
|
37828
37888
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37829
|
-
* @version
|
|
37889
|
+
* @version 195.0.0
|
|
37830
37890
|
*/
|
|
37831
37891
|
|
|
37832
37892
|
/**
|
|
@@ -37977,7 +38037,7 @@ class NotificationsApi {
|
|
|
37977
38037
|
/**
|
|
37978
38038
|
* Notifications service.
|
|
37979
38039
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37980
|
-
* @version
|
|
38040
|
+
* @version 195.0.0
|
|
37981
38041
|
*/
|
|
37982
38042
|
|
|
37983
38043
|
/**
|
|
@@ -38210,7 +38270,7 @@ class OAuthApi {
|
|
|
38210
38270
|
/**
|
|
38211
38271
|
* OAuth service.
|
|
38212
38272
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38213
|
-
* @version
|
|
38273
|
+
* @version 195.0.0
|
|
38214
38274
|
*/
|
|
38215
38275
|
|
|
38216
38276
|
/**
|
|
@@ -38576,7 +38636,7 @@ class ObjectsApi {
|
|
|
38576
38636
|
/**
|
|
38577
38637
|
* Objects service.
|
|
38578
38638
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38579
|
-
* @version
|
|
38639
|
+
* @version 195.0.0
|
|
38580
38640
|
*/
|
|
38581
38641
|
|
|
38582
38642
|
/**
|
|
@@ -38846,7 +38906,7 @@ class OperationalEventsApi {
|
|
|
38846
38906
|
/**
|
|
38847
38907
|
* OperationalEvents service.
|
|
38848
38908
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38849
|
-
* @version
|
|
38909
|
+
* @version 195.0.0
|
|
38850
38910
|
*/
|
|
38851
38911
|
|
|
38852
38912
|
/**
|
|
@@ -38912,7 +38972,7 @@ class OrganizationApi {
|
|
|
38912
38972
|
/**
|
|
38913
38973
|
* Organization service.
|
|
38914
38974
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38915
|
-
* @version
|
|
38975
|
+
* @version 195.0.0
|
|
38916
38976
|
*/
|
|
38917
38977
|
|
|
38918
38978
|
/**
|
|
@@ -39387,7 +39447,7 @@ class OrganizationAuthorizationApi {
|
|
|
39387
39447
|
/**
|
|
39388
39448
|
* OrganizationAuthorization service.
|
|
39389
39449
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39390
|
-
* @version
|
|
39450
|
+
* @version 195.0.0
|
|
39391
39451
|
*/
|
|
39392
39452
|
|
|
39393
39453
|
/**
|
|
@@ -40734,7 +40794,7 @@ class OutboundApi {
|
|
|
40734
40794
|
/**
|
|
40735
40795
|
* Outbound service.
|
|
40736
40796
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40737
|
-
* @version
|
|
40797
|
+
* @version 195.0.0
|
|
40738
40798
|
*/
|
|
40739
40799
|
|
|
40740
40800
|
/**
|
|
@@ -41786,6 +41846,40 @@ class OutboundApi {
|
|
|
41786
41846
|
);
|
|
41787
41847
|
}
|
|
41788
41848
|
|
|
41849
|
+
/**
|
|
41850
|
+
* Get line distribution information for campaigns using same Edge Group or Site as given campaign
|
|
41851
|
+
*
|
|
41852
|
+
* @param {String} campaignId Campaign ID
|
|
41853
|
+
* @param {Object} opts Optional parameters
|
|
41854
|
+
* @param {Boolean} opts.includeOnlyActiveCampaigns If true will return only active Campaigns (default to true)
|
|
41855
|
+
* @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.
|
|
41856
|
+
* @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.
|
|
41857
|
+
* @param {Boolean} opts.useWeight Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations
|
|
41858
|
+
* @param {Number} opts.relativeWeight Relative weight to be used in line distribution calculations instead of current Campaign's relative weight
|
|
41859
|
+
* @param {Number} opts.outboundLineCount The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count
|
|
41860
|
+
*/
|
|
41861
|
+
getOutboundCampaignLinedistribution(campaignId, opts) {
|
|
41862
|
+
opts = opts || {};
|
|
41863
|
+
|
|
41864
|
+
// verify the required parameter 'campaignId' is set
|
|
41865
|
+
if (campaignId === undefined || campaignId === null) {
|
|
41866
|
+
throw 'Missing the required parameter "campaignId" when calling getOutboundCampaignLinedistribution';
|
|
41867
|
+
}
|
|
41868
|
+
|
|
41869
|
+
return this.apiClient.callApi(
|
|
41870
|
+
'/api/v2/outbound/campaigns/{campaignId}/linedistribution',
|
|
41871
|
+
'GET',
|
|
41872
|
+
{ 'campaignId': campaignId },
|
|
41873
|
+
{ 'includeOnlyActiveCampaigns': opts['includeOnlyActiveCampaigns'],'edgeGroupId': opts['edgeGroupId'],'siteId': opts['siteId'],'useWeight': opts['useWeight'],'relativeWeight': opts['relativeWeight'],'outboundLineCount': opts['outboundLineCount'] },
|
|
41874
|
+
{ },
|
|
41875
|
+
{ },
|
|
41876
|
+
null,
|
|
41877
|
+
['PureCloud OAuth'],
|
|
41878
|
+
['application/json'],
|
|
41879
|
+
['application/json']
|
|
41880
|
+
);
|
|
41881
|
+
}
|
|
41882
|
+
|
|
41789
41883
|
/**
|
|
41790
41884
|
* Get campaign progress
|
|
41791
41885
|
*
|
|
@@ -43762,6 +43856,96 @@ class OutboundApi {
|
|
|
43762
43856
|
);
|
|
43763
43857
|
}
|
|
43764
43858
|
|
|
43859
|
+
/**
|
|
43860
|
+
* Start an async job to delete contacts using a filter.
|
|
43861
|
+
*
|
|
43862
|
+
* @param {String} contactListId Contact List ID
|
|
43863
|
+
* @param {Object} body Contact filter information.
|
|
43864
|
+
*/
|
|
43865
|
+
postOutboundContactlistContactsBulkRemove(contactListId, body) {
|
|
43866
|
+
// verify the required parameter 'contactListId' is set
|
|
43867
|
+
if (contactListId === undefined || contactListId === null) {
|
|
43868
|
+
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkRemove';
|
|
43869
|
+
}
|
|
43870
|
+
// verify the required parameter 'body' is set
|
|
43871
|
+
if (body === undefined || body === null) {
|
|
43872
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkRemove';
|
|
43873
|
+
}
|
|
43874
|
+
|
|
43875
|
+
return this.apiClient.callApi(
|
|
43876
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove',
|
|
43877
|
+
'POST',
|
|
43878
|
+
{ 'contactListId': contactListId },
|
|
43879
|
+
{ },
|
|
43880
|
+
{ },
|
|
43881
|
+
{ },
|
|
43882
|
+
body,
|
|
43883
|
+
['PureCloud OAuth'],
|
|
43884
|
+
['application/json'],
|
|
43885
|
+
['application/json']
|
|
43886
|
+
);
|
|
43887
|
+
}
|
|
43888
|
+
|
|
43889
|
+
/**
|
|
43890
|
+
* Start an async job to bulk edit contacts.
|
|
43891
|
+
*
|
|
43892
|
+
* @param {String} contactListId Contact List ID
|
|
43893
|
+
* @param {Object} body Contact bulk edit request information.
|
|
43894
|
+
*/
|
|
43895
|
+
postOutboundContactlistContactsBulkUpdate(contactListId, body) {
|
|
43896
|
+
// verify the required parameter 'contactListId' is set
|
|
43897
|
+
if (contactListId === undefined || contactListId === null) {
|
|
43898
|
+
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkUpdate';
|
|
43899
|
+
}
|
|
43900
|
+
// verify the required parameter 'body' is set
|
|
43901
|
+
if (body === undefined || body === null) {
|
|
43902
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkUpdate';
|
|
43903
|
+
}
|
|
43904
|
+
|
|
43905
|
+
return this.apiClient.callApi(
|
|
43906
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update',
|
|
43907
|
+
'POST',
|
|
43908
|
+
{ 'contactListId': contactListId },
|
|
43909
|
+
{ },
|
|
43910
|
+
{ },
|
|
43911
|
+
{ },
|
|
43912
|
+
body,
|
|
43913
|
+
['PureCloud OAuth'],
|
|
43914
|
+
['application/json'],
|
|
43915
|
+
['application/json']
|
|
43916
|
+
);
|
|
43917
|
+
}
|
|
43918
|
+
|
|
43919
|
+
/**
|
|
43920
|
+
* Query contacts from a contact list.
|
|
43921
|
+
*
|
|
43922
|
+
* @param {String} contactListId Contact List ID
|
|
43923
|
+
* @param {Object} body Contact search parameters.
|
|
43924
|
+
*/
|
|
43925
|
+
postOutboundContactlistContactsSearch(contactListId, body) {
|
|
43926
|
+
// verify the required parameter 'contactListId' is set
|
|
43927
|
+
if (contactListId === undefined || contactListId === null) {
|
|
43928
|
+
throw 'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsSearch';
|
|
43929
|
+
}
|
|
43930
|
+
// verify the required parameter 'body' is set
|
|
43931
|
+
if (body === undefined || body === null) {
|
|
43932
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistContactsSearch';
|
|
43933
|
+
}
|
|
43934
|
+
|
|
43935
|
+
return this.apiClient.callApi(
|
|
43936
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/search',
|
|
43937
|
+
'POST',
|
|
43938
|
+
{ 'contactListId': contactListId },
|
|
43939
|
+
{ },
|
|
43940
|
+
{ },
|
|
43941
|
+
{ },
|
|
43942
|
+
body,
|
|
43943
|
+
['PureCloud OAuth'],
|
|
43944
|
+
['application/json'],
|
|
43945
|
+
['application/json']
|
|
43946
|
+
);
|
|
43947
|
+
}
|
|
43948
|
+
|
|
43765
43949
|
/**
|
|
43766
43950
|
* Initiate the export of a contact list.
|
|
43767
43951
|
* Returns 200 if received OK.
|
|
@@ -44976,7 +45160,7 @@ class PresenceApi {
|
|
|
44976
45160
|
/**
|
|
44977
45161
|
* Presence service.
|
|
44978
45162
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
44979
|
-
* @version
|
|
45163
|
+
* @version 195.0.0
|
|
44980
45164
|
*/
|
|
44981
45165
|
|
|
44982
45166
|
/**
|
|
@@ -45720,7 +45904,7 @@ class ProcessAutomationApi {
|
|
|
45720
45904
|
/**
|
|
45721
45905
|
* ProcessAutomation service.
|
|
45722
45906
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45723
|
-
* @version
|
|
45907
|
+
* @version 195.0.0
|
|
45724
45908
|
*/
|
|
45725
45909
|
|
|
45726
45910
|
/**
|
|
@@ -45959,7 +46143,7 @@ class QualityApi {
|
|
|
45959
46143
|
/**
|
|
45960
46144
|
* Quality service.
|
|
45961
46145
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
45962
|
-
* @version
|
|
46146
|
+
* @version 195.0.0
|
|
45963
46147
|
*/
|
|
45964
46148
|
|
|
45965
46149
|
/**
|
|
@@ -47716,7 +47900,7 @@ class RecordingApi {
|
|
|
47716
47900
|
/**
|
|
47717
47901
|
* Recording service.
|
|
47718
47902
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47719
|
-
* @version
|
|
47903
|
+
* @version 195.0.0
|
|
47720
47904
|
*/
|
|
47721
47905
|
|
|
47722
47906
|
/**
|
|
@@ -49374,7 +49558,7 @@ class ResponseManagementApi {
|
|
|
49374
49558
|
/**
|
|
49375
49559
|
* ResponseManagement service.
|
|
49376
49560
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49377
|
-
* @version
|
|
49561
|
+
* @version 195.0.0
|
|
49378
49562
|
*/
|
|
49379
49563
|
|
|
49380
49564
|
/**
|
|
@@ -49884,7 +50068,7 @@ class RoutingApi {
|
|
|
49884
50068
|
/**
|
|
49885
50069
|
* Routing service.
|
|
49886
50070
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
49887
|
-
* @version
|
|
50071
|
+
* @version 195.0.0
|
|
49888
50072
|
*/
|
|
49889
50073
|
|
|
49890
50074
|
/**
|
|
@@ -50345,7 +50529,6 @@ class RoutingApi {
|
|
|
50345
50529
|
* @param {String} labelId Utilization Label ID
|
|
50346
50530
|
* @param {Object} opts Optional parameters
|
|
50347
50531
|
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
50348
|
-
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
50349
50532
|
*/
|
|
50350
50533
|
deleteRoutingUtilizationLabel(labelId, opts) {
|
|
50351
50534
|
opts = opts || {};
|
|
@@ -51864,7 +52047,6 @@ class RoutingApi {
|
|
|
51864
52047
|
* Get details about this utilization label
|
|
51865
52048
|
*
|
|
51866
52049
|
* @param {String} labelId Utilization Label ID
|
|
51867
|
-
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51868
52050
|
*/
|
|
51869
52051
|
getRoutingUtilizationLabel(labelId) {
|
|
51870
52052
|
// verify the required parameter 'labelId' is set
|
|
@@ -51890,7 +52072,6 @@ class RoutingApi {
|
|
|
51890
52072
|
* Get list of agent ids associated with a utilization label
|
|
51891
52073
|
*
|
|
51892
52074
|
* @param {String} labelId Utilization Label ID
|
|
51893
|
-
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51894
52075
|
*/
|
|
51895
52076
|
getRoutingUtilizationLabelAgents(labelId) {
|
|
51896
52077
|
// verify the required parameter 'labelId' is set
|
|
@@ -51920,7 +52101,6 @@ class RoutingApi {
|
|
|
51920
52101
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
51921
52102
|
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
51922
52103
|
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
51923
|
-
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51924
52104
|
*/
|
|
51925
52105
|
getRoutingUtilizationLabels(opts) {
|
|
51926
52106
|
opts = opts || {};
|
|
@@ -53343,7 +53523,6 @@ class RoutingApi {
|
|
|
53343
53523
|
* Create a utilization label
|
|
53344
53524
|
*
|
|
53345
53525
|
* @param {Object} body UtilizationLabel
|
|
53346
|
-
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53347
53526
|
*/
|
|
53348
53527
|
postRoutingUtilizationLabels(body) {
|
|
53349
53528
|
// verify the required parameter 'body' is set
|
|
@@ -53736,7 +53915,6 @@ class RoutingApi {
|
|
|
53736
53915
|
*
|
|
53737
53916
|
* @param {String} labelId Utilization Label ID
|
|
53738
53917
|
* @param {Object} body UtilizationLabel
|
|
53739
|
-
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53740
53918
|
*/
|
|
53741
53919
|
putRoutingUtilizationLabel(labelId, body) {
|
|
53742
53920
|
// verify the required parameter 'labelId' is set
|
|
@@ -53863,7 +54041,7 @@ class SCIMApi {
|
|
|
53863
54041
|
/**
|
|
53864
54042
|
* SCIM service.
|
|
53865
54043
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
53866
|
-
* @version
|
|
54044
|
+
* @version 195.0.0
|
|
53867
54045
|
*/
|
|
53868
54046
|
|
|
53869
54047
|
/**
|
|
@@ -54740,7 +54918,7 @@ class ScreenRecordingApi {
|
|
|
54740
54918
|
/**
|
|
54741
54919
|
* ScreenRecording service.
|
|
54742
54920
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54743
|
-
* @version
|
|
54921
|
+
* @version 195.0.0
|
|
54744
54922
|
*/
|
|
54745
54923
|
|
|
54746
54924
|
/**
|
|
@@ -54785,7 +54963,7 @@ class ScriptsApi {
|
|
|
54785
54963
|
/**
|
|
54786
54964
|
* Scripts service.
|
|
54787
54965
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54788
|
-
* @version
|
|
54966
|
+
* @version 195.0.0
|
|
54789
54967
|
*/
|
|
54790
54968
|
|
|
54791
54969
|
/**
|
|
@@ -55229,7 +55407,7 @@ class SearchApi {
|
|
|
55229
55407
|
/**
|
|
55230
55408
|
* Search service.
|
|
55231
55409
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55232
|
-
* @version
|
|
55410
|
+
* @version 195.0.0
|
|
55233
55411
|
*/
|
|
55234
55412
|
|
|
55235
55413
|
/**
|
|
@@ -55918,7 +56096,7 @@ class SettingsApi {
|
|
|
55918
56096
|
/**
|
|
55919
56097
|
* Settings service.
|
|
55920
56098
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
55921
|
-
* @version
|
|
56099
|
+
* @version 195.0.0
|
|
55922
56100
|
*/
|
|
55923
56101
|
|
|
55924
56102
|
/**
|
|
@@ -56030,7 +56208,7 @@ class SpeechTextAnalyticsApi {
|
|
|
56030
56208
|
/**
|
|
56031
56209
|
* SpeechTextAnalytics service.
|
|
56032
56210
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56033
|
-
* @version
|
|
56211
|
+
* @version 195.0.0
|
|
56034
56212
|
*/
|
|
56035
56213
|
|
|
56036
56214
|
/**
|
|
@@ -56045,6 +56223,31 @@ class SpeechTextAnalyticsApi {
|
|
|
56045
56223
|
}
|
|
56046
56224
|
|
|
56047
56225
|
|
|
56226
|
+
/**
|
|
56227
|
+
* Delete a Speech and Text Analytics category by ID
|
|
56228
|
+
*
|
|
56229
|
+
* @param {String} categoryId The id of the category
|
|
56230
|
+
*/
|
|
56231
|
+
deleteSpeechandtextanalyticsCategory(categoryId) {
|
|
56232
|
+
// verify the required parameter 'categoryId' is set
|
|
56233
|
+
if (categoryId === undefined || categoryId === null) {
|
|
56234
|
+
throw 'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory';
|
|
56235
|
+
}
|
|
56236
|
+
|
|
56237
|
+
return this.apiClient.callApi(
|
|
56238
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
56239
|
+
'DELETE',
|
|
56240
|
+
{ 'categoryId': categoryId },
|
|
56241
|
+
{ },
|
|
56242
|
+
{ },
|
|
56243
|
+
{ },
|
|
56244
|
+
null,
|
|
56245
|
+
['PureCloud OAuth'],
|
|
56246
|
+
['application/json'],
|
|
56247
|
+
['application/json']
|
|
56248
|
+
);
|
|
56249
|
+
}
|
|
56250
|
+
|
|
56048
56251
|
/**
|
|
56049
56252
|
* Delete a Speech and Text Analytics DictionaryFeedback by Id
|
|
56050
56253
|
*
|
|
@@ -56169,6 +56372,60 @@ class SpeechTextAnalyticsApi {
|
|
|
56169
56372
|
);
|
|
56170
56373
|
}
|
|
56171
56374
|
|
|
56375
|
+
/**
|
|
56376
|
+
* Get the list of Speech and Text Analytics categories
|
|
56377
|
+
*
|
|
56378
|
+
* @param {Object} opts Optional parameters
|
|
56379
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
|
|
56380
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
56381
|
+
* @param {String} opts.name The category name filter applied to the listing
|
|
56382
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
56383
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
56384
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
56385
|
+
*/
|
|
56386
|
+
getSpeechandtextanalyticsCategories(opts) {
|
|
56387
|
+
opts = opts || {};
|
|
56388
|
+
|
|
56389
|
+
|
|
56390
|
+
return this.apiClient.callApi(
|
|
56391
|
+
'/api/v2/speechandtextanalytics/categories',
|
|
56392
|
+
'GET',
|
|
56393
|
+
{ },
|
|
56394
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') },
|
|
56395
|
+
{ },
|
|
56396
|
+
{ },
|
|
56397
|
+
null,
|
|
56398
|
+
['PureCloud OAuth'],
|
|
56399
|
+
['application/json'],
|
|
56400
|
+
['application/json']
|
|
56401
|
+
);
|
|
56402
|
+
}
|
|
56403
|
+
|
|
56404
|
+
/**
|
|
56405
|
+
* Get a Speech and Text Analytics Category by ID
|
|
56406
|
+
*
|
|
56407
|
+
* @param {String} categoryId The id of the category
|
|
56408
|
+
*/
|
|
56409
|
+
getSpeechandtextanalyticsCategory(categoryId) {
|
|
56410
|
+
// verify the required parameter 'categoryId' is set
|
|
56411
|
+
if (categoryId === undefined || categoryId === null) {
|
|
56412
|
+
throw 'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory';
|
|
56413
|
+
}
|
|
56414
|
+
|
|
56415
|
+
return this.apiClient.callApi(
|
|
56416
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
56417
|
+
'GET',
|
|
56418
|
+
{ 'categoryId': categoryId },
|
|
56419
|
+
{ },
|
|
56420
|
+
{ },
|
|
56421
|
+
{ },
|
|
56422
|
+
null,
|
|
56423
|
+
['PureCloud OAuth'],
|
|
56424
|
+
['application/json'],
|
|
56425
|
+
['application/json']
|
|
56426
|
+
);
|
|
56427
|
+
}
|
|
56428
|
+
|
|
56172
56429
|
/**
|
|
56173
56430
|
* Get Speech and Text Analytics for a specific conversation
|
|
56174
56431
|
*
|
|
@@ -56194,6 +56451,36 @@ class SpeechTextAnalyticsApi {
|
|
|
56194
56451
|
);
|
|
56195
56452
|
}
|
|
56196
56453
|
|
|
56454
|
+
/**
|
|
56455
|
+
* Get the list of detected Speech and Text Analytics categories of conversation
|
|
56456
|
+
*
|
|
56457
|
+
* @param {String} conversationId The id of the conversation
|
|
56458
|
+
* @param {Object} opts Optional parameters
|
|
56459
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
|
|
56460
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
56461
|
+
*/
|
|
56462
|
+
getSpeechandtextanalyticsConversationCategories(conversationId, opts) {
|
|
56463
|
+
opts = opts || {};
|
|
56464
|
+
|
|
56465
|
+
// verify the required parameter 'conversationId' is set
|
|
56466
|
+
if (conversationId === undefined || conversationId === null) {
|
|
56467
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories';
|
|
56468
|
+
}
|
|
56469
|
+
|
|
56470
|
+
return this.apiClient.callApi(
|
|
56471
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/categories',
|
|
56472
|
+
'GET',
|
|
56473
|
+
{ 'conversationId': conversationId },
|
|
56474
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
56475
|
+
{ },
|
|
56476
|
+
{ },
|
|
56477
|
+
null,
|
|
56478
|
+
['PureCloud OAuth'],
|
|
56479
|
+
['application/json'],
|
|
56480
|
+
['application/json']
|
|
56481
|
+
);
|
|
56482
|
+
}
|
|
56483
|
+
|
|
56197
56484
|
/**
|
|
56198
56485
|
* Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
|
56199
56486
|
*
|
|
@@ -56764,6 +57051,31 @@ class SpeechTextAnalyticsApi {
|
|
|
56764
57051
|
);
|
|
56765
57052
|
}
|
|
56766
57053
|
|
|
57054
|
+
/**
|
|
57055
|
+
* Create new Speech and Text Analytics category
|
|
57056
|
+
*
|
|
57057
|
+
* @param {Object} body The category to create
|
|
57058
|
+
*/
|
|
57059
|
+
postSpeechandtextanalyticsCategories(body) {
|
|
57060
|
+
// verify the required parameter 'body' is set
|
|
57061
|
+
if (body === undefined || body === null) {
|
|
57062
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories';
|
|
57063
|
+
}
|
|
57064
|
+
|
|
57065
|
+
return this.apiClient.callApi(
|
|
57066
|
+
'/api/v2/speechandtextanalytics/categories',
|
|
57067
|
+
'POST',
|
|
57068
|
+
{ },
|
|
57069
|
+
{ },
|
|
57070
|
+
{ },
|
|
57071
|
+
{ },
|
|
57072
|
+
body,
|
|
57073
|
+
['PureCloud OAuth'],
|
|
57074
|
+
['application/json'],
|
|
57075
|
+
['application/json']
|
|
57076
|
+
);
|
|
57077
|
+
}
|
|
57078
|
+
|
|
56767
57079
|
/**
|
|
56768
57080
|
* Create a Speech and Text Analytics DictionaryFeedback
|
|
56769
57081
|
*
|
|
@@ -56964,6 +57276,36 @@ class SpeechTextAnalyticsApi {
|
|
|
56964
57276
|
);
|
|
56965
57277
|
}
|
|
56966
57278
|
|
|
57279
|
+
/**
|
|
57280
|
+
* Update a Speech and Text Analytics category by ID
|
|
57281
|
+
*
|
|
57282
|
+
* @param {String} categoryId The id of the category
|
|
57283
|
+
* @param {Object} body The updated category
|
|
57284
|
+
*/
|
|
57285
|
+
putSpeechandtextanalyticsCategory(categoryId, body) {
|
|
57286
|
+
// verify the required parameter 'categoryId' is set
|
|
57287
|
+
if (categoryId === undefined || categoryId === null) {
|
|
57288
|
+
throw 'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory';
|
|
57289
|
+
}
|
|
57290
|
+
// verify the required parameter 'body' is set
|
|
57291
|
+
if (body === undefined || body === null) {
|
|
57292
|
+
throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory';
|
|
57293
|
+
}
|
|
57294
|
+
|
|
57295
|
+
return this.apiClient.callApi(
|
|
57296
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
57297
|
+
'PUT',
|
|
57298
|
+
{ 'categoryId': categoryId },
|
|
57299
|
+
{ },
|
|
57300
|
+
{ },
|
|
57301
|
+
{ },
|
|
57302
|
+
body,
|
|
57303
|
+
['PureCloud OAuth'],
|
|
57304
|
+
['application/json'],
|
|
57305
|
+
['application/json']
|
|
57306
|
+
);
|
|
57307
|
+
}
|
|
57308
|
+
|
|
56967
57309
|
/**
|
|
56968
57310
|
* Update existing Speech and Text Analytics dictionary feedback by id
|
|
56969
57311
|
*
|
|
@@ -57144,7 +57486,7 @@ class StationsApi {
|
|
|
57144
57486
|
/**
|
|
57145
57487
|
* Stations service.
|
|
57146
57488
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57147
|
-
* @version
|
|
57489
|
+
* @version 195.0.0
|
|
57148
57490
|
*/
|
|
57149
57491
|
|
|
57150
57492
|
/**
|
|
@@ -57246,7 +57588,7 @@ class SuggestApi {
|
|
|
57246
57588
|
/**
|
|
57247
57589
|
* Suggest service.
|
|
57248
57590
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57249
|
-
* @version
|
|
57591
|
+
* @version 195.0.0
|
|
57250
57592
|
*/
|
|
57251
57593
|
|
|
57252
57594
|
/**
|
|
@@ -57385,7 +57727,7 @@ class TaskManagementApi {
|
|
|
57385
57727
|
/**
|
|
57386
57728
|
* TaskManagement service.
|
|
57387
57729
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57388
|
-
* @version
|
|
57730
|
+
* @version 195.0.0
|
|
57389
57731
|
*/
|
|
57390
57732
|
|
|
57391
57733
|
/**
|
|
@@ -58733,7 +59075,7 @@ class TeamsApi {
|
|
|
58733
59075
|
/**
|
|
58734
59076
|
* Teams service.
|
|
58735
59077
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
58736
|
-
* @version
|
|
59078
|
+
* @version 195.0.0
|
|
58737
59079
|
*/
|
|
58738
59080
|
|
|
58739
59081
|
/**
|
|
@@ -59034,7 +59376,7 @@ class TelephonyApi {
|
|
|
59034
59376
|
/**
|
|
59035
59377
|
* Telephony service.
|
|
59036
59378
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59037
|
-
* @version
|
|
59379
|
+
* @version 195.0.0
|
|
59038
59380
|
*/
|
|
59039
59381
|
|
|
59040
59382
|
/**
|
|
@@ -59216,7 +59558,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
59216
59558
|
/**
|
|
59217
59559
|
* TelephonyProvidersEdge service.
|
|
59218
59560
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59219
|
-
* @version
|
|
59561
|
+
* @version 195.0.0
|
|
59220
59562
|
*/
|
|
59221
59563
|
|
|
59222
59564
|
/**
|
|
@@ -62544,7 +62886,7 @@ class TextbotsApi {
|
|
|
62544
62886
|
/**
|
|
62545
62887
|
* Textbots service.
|
|
62546
62888
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62547
|
-
* @version
|
|
62889
|
+
* @version 195.0.0
|
|
62548
62890
|
*/
|
|
62549
62891
|
|
|
62550
62892
|
/**
|
|
@@ -62672,7 +63014,7 @@ class TokensApi {
|
|
|
62672
63014
|
/**
|
|
62673
63015
|
* Tokens service.
|
|
62674
63016
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62675
|
-
* @version
|
|
63017
|
+
* @version 195.0.0
|
|
62676
63018
|
*/
|
|
62677
63019
|
|
|
62678
63020
|
/**
|
|
@@ -62826,7 +63168,7 @@ class UploadsApi {
|
|
|
62826
63168
|
/**
|
|
62827
63169
|
* Uploads service.
|
|
62828
63170
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
62829
|
-
* @version
|
|
63171
|
+
* @version 195.0.0
|
|
62830
63172
|
*/
|
|
62831
63173
|
|
|
62832
63174
|
/**
|
|
@@ -63095,7 +63437,7 @@ class UsageApi {
|
|
|
63095
63437
|
/**
|
|
63096
63438
|
* Usage service.
|
|
63097
63439
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63098
|
-
* @version
|
|
63440
|
+
* @version 195.0.0
|
|
63099
63441
|
*/
|
|
63100
63442
|
|
|
63101
63443
|
/**
|
|
@@ -63310,7 +63652,7 @@ class UserRecordingsApi {
|
|
|
63310
63652
|
/**
|
|
63311
63653
|
* UserRecordings service.
|
|
63312
63654
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63313
|
-
* @version
|
|
63655
|
+
* @version 195.0.0
|
|
63314
63656
|
*/
|
|
63315
63657
|
|
|
63316
63658
|
/**
|
|
@@ -63495,7 +63837,7 @@ class UsersApi {
|
|
|
63495
63837
|
/**
|
|
63496
63838
|
* Users service.
|
|
63497
63839
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63498
|
-
* @version
|
|
63840
|
+
* @version 195.0.0
|
|
63499
63841
|
*/
|
|
63500
63842
|
|
|
63501
63843
|
/**
|
|
@@ -66153,7 +66495,7 @@ class UtilitiesApi {
|
|
|
66153
66495
|
/**
|
|
66154
66496
|
* Utilities service.
|
|
66155
66497
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66156
|
-
* @version
|
|
66498
|
+
* @version 195.0.0
|
|
66157
66499
|
*/
|
|
66158
66500
|
|
|
66159
66501
|
/**
|
|
@@ -66264,7 +66606,7 @@ class VoicemailApi {
|
|
|
66264
66606
|
/**
|
|
66265
66607
|
* Voicemail service.
|
|
66266
66608
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66267
|
-
* @version
|
|
66609
|
+
* @version 195.0.0
|
|
66268
66610
|
*/
|
|
66269
66611
|
|
|
66270
66612
|
/**
|
|
@@ -66931,7 +67273,7 @@ class WebChatApi {
|
|
|
66931
67273
|
/**
|
|
66932
67274
|
* WebChat service.
|
|
66933
67275
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
66934
|
-
* @version
|
|
67276
|
+
* @version 195.0.0
|
|
66935
67277
|
*/
|
|
66936
67278
|
|
|
66937
67279
|
/**
|
|
@@ -67482,7 +67824,7 @@ class WebDeploymentsApi {
|
|
|
67482
67824
|
/**
|
|
67483
67825
|
* WebDeployments service.
|
|
67484
67826
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67485
|
-
* @version
|
|
67827
|
+
* @version 195.0.0
|
|
67486
67828
|
*/
|
|
67487
67829
|
|
|
67488
67830
|
/**
|
|
@@ -68009,7 +68351,7 @@ class WebMessagingApi {
|
|
|
68009
68351
|
/**
|
|
68010
68352
|
* WebMessaging service.
|
|
68011
68353
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68012
|
-
* @version
|
|
68354
|
+
* @version 195.0.0
|
|
68013
68355
|
*/
|
|
68014
68356
|
|
|
68015
68357
|
/**
|
|
@@ -68055,7 +68397,7 @@ class WidgetsApi {
|
|
|
68055
68397
|
/**
|
|
68056
68398
|
* Widgets service.
|
|
68057
68399
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68058
|
-
* @version
|
|
68400
|
+
* @version 195.0.0
|
|
68059
68401
|
*/
|
|
68060
68402
|
|
|
68061
68403
|
/**
|
|
@@ -68201,7 +68543,7 @@ class WorkforceManagementApi {
|
|
|
68201
68543
|
/**
|
|
68202
68544
|
* WorkforceManagement service.
|
|
68203
68545
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68204
|
-
* @version
|
|
68546
|
+
* @version 195.0.0
|
|
68205
68547
|
*/
|
|
68206
68548
|
|
|
68207
68549
|
/**
|
|
@@ -74114,7 +74456,7 @@ class WorkforceManagementApi {
|
|
|
74114
74456
|
* </pre>
|
|
74115
74457
|
* </p>
|
|
74116
74458
|
* @module purecloud-platform-client-v2/index
|
|
74117
|
-
* @version
|
|
74459
|
+
* @version 195.0.0
|
|
74118
74460
|
*/
|
|
74119
74461
|
class platformClient {
|
|
74120
74462
|
constructor() {
|