purecloud-platform-client-v2 194.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 +589 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +589 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +205 -96
- package/dist/web-cjs/purecloud-platform-client-v2.js +205 -96
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +401 -299
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +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 -32
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +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
|
@@ -402,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 195.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1477,6 +1477,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1477
1477
|
if (param instanceof Date) {
|
|
1478
1478
|
return param.toJSON();
|
|
1479
1479
|
}
|
|
1480
|
+
if (param instanceof Boolean) {
|
|
1481
|
+
return param.toString().toLowerCase();
|
|
1482
|
+
}
|
|
1480
1483
|
return param.toString();
|
|
1481
1484
|
}
|
|
1482
1485
|
|
|
@@ -1821,7 +1824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1821
1824
|
/**
|
|
1822
1825
|
* Alerting service.
|
|
1823
1826
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1824
|
-
* @version
|
|
1827
|
+
* @version 195.0.0
|
|
1825
1828
|
*/
|
|
1826
1829
|
|
|
1827
1830
|
/**
|
|
@@ -2482,7 +2485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2482
2485
|
/**
|
|
2483
2486
|
* Analytics service.
|
|
2484
2487
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2485
|
-
* @version
|
|
2488
|
+
* @version 195.0.0
|
|
2486
2489
|
*/
|
|
2487
2490
|
|
|
2488
2491
|
/**
|
|
@@ -2603,6 +2606,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2603
2606
|
);
|
|
2604
2607
|
}
|
|
2605
2608
|
|
|
2609
|
+
/**
|
|
2610
|
+
* Get status for async query for agent copilot aggregates
|
|
2611
|
+
*
|
|
2612
|
+
* @param {String} jobId jobId
|
|
2613
|
+
* getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2614
|
+
*/
|
|
2615
|
+
getAnalyticsAgentcopilotsAggregatesJob(jobId) {
|
|
2616
|
+
// verify the required parameter 'jobId' is set
|
|
2617
|
+
if (jobId === undefined || jobId === null) {
|
|
2618
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob';
|
|
2619
|
+
}
|
|
2620
|
+
|
|
2621
|
+
return this.apiClient.callApi(
|
|
2622
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}',
|
|
2623
|
+
'GET',
|
|
2624
|
+
{ 'jobId': jobId },
|
|
2625
|
+
{ },
|
|
2626
|
+
{ },
|
|
2627
|
+
{ },
|
|
2628
|
+
null,
|
|
2629
|
+
['PureCloud OAuth'],
|
|
2630
|
+
['application/json'],
|
|
2631
|
+
['application/json']
|
|
2632
|
+
);
|
|
2633
|
+
}
|
|
2634
|
+
|
|
2635
|
+
/**
|
|
2636
|
+
* Fetch a page of results for an async aggregates query
|
|
2637
|
+
*
|
|
2638
|
+
* @param {String} jobId jobId
|
|
2639
|
+
* @param {Object} opts Optional parameters
|
|
2640
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2641
|
+
* getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2642
|
+
*/
|
|
2643
|
+
getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) {
|
|
2644
|
+
opts = opts || {};
|
|
2645
|
+
|
|
2646
|
+
// verify the required parameter 'jobId' is set
|
|
2647
|
+
if (jobId === undefined || jobId === null) {
|
|
2648
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults';
|
|
2649
|
+
}
|
|
2650
|
+
|
|
2651
|
+
return this.apiClient.callApi(
|
|
2652
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results',
|
|
2653
|
+
'GET',
|
|
2654
|
+
{ 'jobId': jobId },
|
|
2655
|
+
{ 'cursor': opts['cursor'] },
|
|
2656
|
+
{ },
|
|
2657
|
+
{ },
|
|
2658
|
+
null,
|
|
2659
|
+
['PureCloud OAuth'],
|
|
2660
|
+
['application/json'],
|
|
2661
|
+
['application/json']
|
|
2662
|
+
);
|
|
2663
|
+
}
|
|
2664
|
+
|
|
2606
2665
|
/**
|
|
2607
2666
|
* Get Reporting Turns (division aware).
|
|
2608
2667
|
* 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.
|
|
@@ -3361,6 +3420,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3361
3420
|
);
|
|
3362
3421
|
}
|
|
3363
3422
|
|
|
3423
|
+
/**
|
|
3424
|
+
* Get list of dashboard configurations
|
|
3425
|
+
*
|
|
3426
|
+
* @param {Object} dashboardType List dashboard of given type
|
|
3427
|
+
* @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
|
|
3428
|
+
* @param {Object} opts Optional parameters
|
|
3429
|
+
* @param {String} opts.sortBy (default to desc)
|
|
3430
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
3431
|
+
* @param {Number} opts.pageSize (default to 9)
|
|
3432
|
+
*/
|
|
3433
|
+
getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) {
|
|
3434
|
+
opts = opts || {};
|
|
3435
|
+
|
|
3436
|
+
// verify the required parameter 'dashboardType' is set
|
|
3437
|
+
if (dashboardType === undefined || dashboardType === null) {
|
|
3438
|
+
throw 'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery';
|
|
3439
|
+
}
|
|
3440
|
+
// verify the required parameter 'dashboardAccessFilter' is set
|
|
3441
|
+
if (dashboardAccessFilter === undefined || dashboardAccessFilter === null) {
|
|
3442
|
+
throw 'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery';
|
|
3443
|
+
}
|
|
3444
|
+
|
|
3445
|
+
return this.apiClient.callApi(
|
|
3446
|
+
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
3447
|
+
'GET',
|
|
3448
|
+
{ },
|
|
3449
|
+
{ 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3450
|
+
{ },
|
|
3451
|
+
{ },
|
|
3452
|
+
null,
|
|
3453
|
+
['PureCloud OAuth'],
|
|
3454
|
+
['application/json'],
|
|
3455
|
+
['application/json']
|
|
3456
|
+
);
|
|
3457
|
+
}
|
|
3458
|
+
|
|
3364
3459
|
/**
|
|
3365
3460
|
* Get list of dashboards for an user
|
|
3366
3461
|
*
|
|
@@ -3826,6 +3921,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3826
3921
|
);
|
|
3827
3922
|
}
|
|
3828
3923
|
|
|
3924
|
+
/**
|
|
3925
|
+
* Query for agent copilot aggregates asynchronously
|
|
3926
|
+
*
|
|
3927
|
+
* @param {Object} body query
|
|
3928
|
+
* postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3929
|
+
*/
|
|
3930
|
+
postAnalyticsAgentcopilotsAggregatesJobs(body) {
|
|
3931
|
+
// verify the required parameter 'body' is set
|
|
3932
|
+
if (body === undefined || body === null) {
|
|
3933
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs';
|
|
3934
|
+
}
|
|
3935
|
+
|
|
3936
|
+
return this.apiClient.callApi(
|
|
3937
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs',
|
|
3938
|
+
'POST',
|
|
3939
|
+
{ },
|
|
3940
|
+
{ },
|
|
3941
|
+
{ },
|
|
3942
|
+
{ },
|
|
3943
|
+
body,
|
|
3944
|
+
['PureCloud OAuth'],
|
|
3945
|
+
['application/json'],
|
|
3946
|
+
['application/json']
|
|
3947
|
+
);
|
|
3948
|
+
}
|
|
3949
|
+
|
|
3950
|
+
/**
|
|
3951
|
+
* Query for agent copilot aggregates
|
|
3952
|
+
*
|
|
3953
|
+
* @param {Object} body query
|
|
3954
|
+
* postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3955
|
+
*/
|
|
3956
|
+
postAnalyticsAgentcopilotsAggregatesQuery(body) {
|
|
3957
|
+
// verify the required parameter 'body' is set
|
|
3958
|
+
if (body === undefined || body === null) {
|
|
3959
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery';
|
|
3960
|
+
}
|
|
3961
|
+
|
|
3962
|
+
return this.apiClient.callApi(
|
|
3963
|
+
'/api/v2/analytics/agentcopilots/aggregates/query',
|
|
3964
|
+
'POST',
|
|
3965
|
+
{ },
|
|
3966
|
+
{ },
|
|
3967
|
+
{ },
|
|
3968
|
+
{ },
|
|
3969
|
+
body,
|
|
3970
|
+
['PureCloud OAuth'],
|
|
3971
|
+
['application/json'],
|
|
3972
|
+
['application/json']
|
|
3973
|
+
);
|
|
3974
|
+
}
|
|
3975
|
+
|
|
3829
3976
|
/**
|
|
3830
3977
|
* Query for bot aggregates asynchronously
|
|
3831
3978
|
*
|
|
@@ -4399,8 +4546,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4399
4546
|
}
|
|
4400
4547
|
|
|
4401
4548
|
/**
|
|
4402
|
-
* Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded
|
|
4403
|
-
*
|
|
4549
|
+
* 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.
|
|
4550
|
+
* The max property can be used to determine estimated rate limit value hit.
|
|
4404
4551
|
* @param {Object} body query
|
|
4405
4552
|
*/
|
|
4406
4553
|
postAnalyticsRatelimitsAggregatesQuery(body) {
|
|
@@ -4950,7 +5097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4950
5097
|
/**
|
|
4951
5098
|
* Architect service.
|
|
4952
5099
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4953
|
-
* @version
|
|
5100
|
+
* @version 195.0.0
|
|
4954
5101
|
*/
|
|
4955
5102
|
|
|
4956
5103
|
/**
|
|
@@ -9096,7 +9243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9096
9243
|
/**
|
|
9097
9244
|
* Audit service.
|
|
9098
9245
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9099
|
-
* @version
|
|
9246
|
+
* @version 195.0.0
|
|
9100
9247
|
*/
|
|
9101
9248
|
|
|
9102
9249
|
/**
|
|
@@ -9296,7 +9443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9296
9443
|
/**
|
|
9297
9444
|
* Authorization service.
|
|
9298
9445
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9299
|
-
* @version
|
|
9446
|
+
* @version 195.0.0
|
|
9300
9447
|
*/
|
|
9301
9448
|
|
|
9302
9449
|
/**
|
|
@@ -10534,7 +10681,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10534
10681
|
/**
|
|
10535
10682
|
* Billing service.
|
|
10536
10683
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10537
|
-
* @version
|
|
10684
|
+
* @version 195.0.0
|
|
10538
10685
|
*/
|
|
10539
10686
|
|
|
10540
10687
|
/**
|
|
@@ -10614,7 +10761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10614
10761
|
/**
|
|
10615
10762
|
* CarrierServices service.
|
|
10616
10763
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10617
|
-
* @version
|
|
10764
|
+
* @version 195.0.0
|
|
10618
10765
|
*/
|
|
10619
10766
|
|
|
10620
10767
|
/**
|
|
@@ -10684,7 +10831,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10684
10831
|
/**
|
|
10685
10832
|
* Chat service.
|
|
10686
10833
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10687
|
-
* @version
|
|
10834
|
+
* @version 195.0.0
|
|
10688
10835
|
*/
|
|
10689
10836
|
|
|
10690
10837
|
/**
|
|
@@ -11620,7 +11767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11620
11767
|
/**
|
|
11621
11768
|
* Coaching service.
|
|
11622
11769
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11623
|
-
* @version
|
|
11770
|
+
* @version 195.0.0
|
|
11624
11771
|
*/
|
|
11625
11772
|
|
|
11626
11773
|
/**
|
|
@@ -12197,7 +12344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12197
12344
|
/**
|
|
12198
12345
|
* ContentManagement service.
|
|
12199
12346
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12200
|
-
* @version
|
|
12347
|
+
* @version 195.0.0
|
|
12201
12348
|
*/
|
|
12202
12349
|
|
|
12203
12350
|
/**
|
|
@@ -13279,7 +13426,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13279
13426
|
/**
|
|
13280
13427
|
* Conversations service.
|
|
13281
13428
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13282
|
-
* @version
|
|
13429
|
+
* @version 195.0.0
|
|
13283
13430
|
*/
|
|
13284
13431
|
|
|
13285
13432
|
/**
|
|
@@ -15687,37 +15834,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15687
15834
|
);
|
|
15688
15835
|
}
|
|
15689
15836
|
|
|
15690
|
-
/**
|
|
15691
|
-
* Get a list of Messaging Stickers (Deprecated)
|
|
15692
|
-
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
15693
|
-
* @param {Object} messengerType Messenger Type
|
|
15694
|
-
* @param {Object} opts Optional parameters
|
|
15695
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15696
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15697
|
-
* @deprecated
|
|
15698
|
-
*/
|
|
15699
|
-
getConversationsMessagingSticker(messengerType, opts) {
|
|
15700
|
-
opts = opts || {};
|
|
15701
|
-
|
|
15702
|
-
// verify the required parameter 'messengerType' is set
|
|
15703
|
-
if (messengerType === undefined || messengerType === null) {
|
|
15704
|
-
throw 'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker';
|
|
15705
|
-
}
|
|
15706
|
-
|
|
15707
|
-
return this.apiClient.callApi(
|
|
15708
|
-
'/api/v2/conversations/messaging/stickers/{messengerType}',
|
|
15709
|
-
'GET',
|
|
15710
|
-
{ 'messengerType': messengerType },
|
|
15711
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
15712
|
-
{ },
|
|
15713
|
-
{ },
|
|
15714
|
-
null,
|
|
15715
|
-
['PureCloud OAuth'],
|
|
15716
|
-
['application/json'],
|
|
15717
|
-
['application/json']
|
|
15718
|
-
);
|
|
15719
|
-
}
|
|
15720
|
-
|
|
15721
15837
|
/**
|
|
15722
15838
|
* Get a list of Supported Content profiles
|
|
15723
15839
|
*
|
|
@@ -18820,6 +18936,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18820
18936
|
);
|
|
18821
18937
|
}
|
|
18822
18938
|
|
|
18939
|
+
/**
|
|
18940
|
+
* Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
|
|
18941
|
+
*
|
|
18942
|
+
* @param {String} conversationId conversationId
|
|
18943
|
+
*/
|
|
18944
|
+
postConversationsEmailReconnect(conversationId) {
|
|
18945
|
+
// verify the required parameter 'conversationId' is set
|
|
18946
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18947
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect';
|
|
18948
|
+
}
|
|
18949
|
+
|
|
18950
|
+
return this.apiClient.callApi(
|
|
18951
|
+
'/api/v2/conversations/emails/{conversationId}/reconnect',
|
|
18952
|
+
'POST',
|
|
18953
|
+
{ 'conversationId': conversationId },
|
|
18954
|
+
{ },
|
|
18955
|
+
{ },
|
|
18956
|
+
{ },
|
|
18957
|
+
null,
|
|
18958
|
+
['PureCloud OAuth'],
|
|
18959
|
+
['application/json'],
|
|
18960
|
+
['application/json']
|
|
18961
|
+
);
|
|
18962
|
+
}
|
|
18963
|
+
|
|
18823
18964
|
/**
|
|
18824
18965
|
* Create an email conversation
|
|
18825
18966
|
* 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.
|
|
@@ -20236,7 +20377,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20236
20377
|
/**
|
|
20237
20378
|
* DataExtensions service.
|
|
20238
20379
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20239
|
-
* @version
|
|
20380
|
+
* @version 195.0.0
|
|
20240
20381
|
*/
|
|
20241
20382
|
|
|
20242
20383
|
/**
|
|
@@ -20322,7 +20463,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20322
20463
|
/**
|
|
20323
20464
|
* Downloads service.
|
|
20324
20465
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20325
|
-
* @version
|
|
20466
|
+
* @version 195.0.0
|
|
20326
20467
|
*/
|
|
20327
20468
|
|
|
20328
20469
|
/**
|
|
@@ -20374,7 +20515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20374
20515
|
/**
|
|
20375
20516
|
* Emails service.
|
|
20376
20517
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20377
|
-
* @version
|
|
20518
|
+
* @version 195.0.0
|
|
20378
20519
|
*/
|
|
20379
20520
|
|
|
20380
20521
|
/**
|
|
@@ -20439,7 +20580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20439
20580
|
/**
|
|
20440
20581
|
* Events service.
|
|
20441
20582
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20442
|
-
* @version
|
|
20583
|
+
* @version 195.0.0
|
|
20443
20584
|
*/
|
|
20444
20585
|
|
|
20445
20586
|
/**
|
|
@@ -20535,7 +20676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20535
20676
|
/**
|
|
20536
20677
|
* ExternalContacts service.
|
|
20537
20678
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20538
|
-
* @version
|
|
20679
|
+
* @version 195.0.0
|
|
20539
20680
|
*/
|
|
20540
20681
|
|
|
20541
20682
|
/**
|
|
@@ -22493,7 +22634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22493
22634
|
/**
|
|
22494
22635
|
* Fax service.
|
|
22495
22636
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22496
|
-
* @version
|
|
22637
|
+
* @version 195.0.0
|
|
22497
22638
|
*/
|
|
22498
22639
|
|
|
22499
22640
|
/**
|
|
@@ -22708,7 +22849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22708
22849
|
/**
|
|
22709
22850
|
* Flows service.
|
|
22710
22851
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22711
|
-
* @version
|
|
22852
|
+
* @version 195.0.0
|
|
22712
22853
|
*/
|
|
22713
22854
|
|
|
22714
22855
|
/**
|
|
@@ -22891,7 +23032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22891
23032
|
/**
|
|
22892
23033
|
* Gamification service.
|
|
22893
23034
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22894
|
-
* @version
|
|
23035
|
+
* @version 195.0.0
|
|
22895
23036
|
*/
|
|
22896
23037
|
|
|
22897
23038
|
/**
|
|
@@ -24977,7 +25118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24977
25118
|
/**
|
|
24978
25119
|
* GeneralDataProtectionRegulation service.
|
|
24979
25120
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24980
|
-
* @version
|
|
25121
|
+
* @version 195.0.0
|
|
24981
25122
|
*/
|
|
24982
25123
|
|
|
24983
25124
|
/**
|
|
@@ -25107,7 +25248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25107
25248
|
/**
|
|
25108
25249
|
* Geolocation service.
|
|
25109
25250
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25110
|
-
* @version
|
|
25251
|
+
* @version 195.0.0
|
|
25111
25252
|
*/
|
|
25112
25253
|
|
|
25113
25254
|
/**
|
|
@@ -25238,7 +25379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25238
25379
|
/**
|
|
25239
25380
|
* Greetings service.
|
|
25240
25381
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25241
|
-
* @version
|
|
25382
|
+
* @version 195.0.0
|
|
25242
25383
|
*/
|
|
25243
25384
|
|
|
25244
25385
|
/**
|
|
@@ -25693,7 +25834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25693
25834
|
/**
|
|
25694
25835
|
* Groups service.
|
|
25695
25836
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25696
|
-
* @version
|
|
25837
|
+
* @version 195.0.0
|
|
25697
25838
|
*/
|
|
25698
25839
|
|
|
25699
25840
|
/**
|
|
@@ -26212,7 +26353,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26212
26353
|
/**
|
|
26213
26354
|
* IdentityProvider service.
|
|
26214
26355
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26215
|
-
* @version
|
|
26356
|
+
* @version 195.0.0
|
|
26216
26357
|
*/
|
|
26217
26358
|
|
|
26218
26359
|
/**
|
|
@@ -27073,7 +27214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27073
27214
|
/**
|
|
27074
27215
|
* InfrastructureAsCode service.
|
|
27075
27216
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27076
|
-
* @version
|
|
27217
|
+
* @version 195.0.0
|
|
27077
27218
|
*/
|
|
27078
27219
|
|
|
27079
27220
|
/**
|
|
@@ -27240,7 +27381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27240
27381
|
/**
|
|
27241
27382
|
* Integrations service.
|
|
27242
27383
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27243
|
-
* @version
|
|
27384
|
+
* @version 195.0.0
|
|
27244
27385
|
*/
|
|
27245
27386
|
|
|
27246
27387
|
/**
|
|
@@ -29592,7 +29733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29592
29733
|
/**
|
|
29593
29734
|
* Journey service.
|
|
29594
29735
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29595
|
-
* @version
|
|
29736
|
+
* @version 195.0.0
|
|
29596
29737
|
*/
|
|
29597
29738
|
|
|
29598
29739
|
/**
|
|
@@ -31181,7 +31322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31181
31322
|
/**
|
|
31182
31323
|
* Knowledge service.
|
|
31183
31324
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31184
|
-
* @version
|
|
31325
|
+
* @version 195.0.0
|
|
31185
31326
|
*/
|
|
31186
31327
|
|
|
31187
31328
|
/**
|
|
@@ -32535,6 +32676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32535
32676
|
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
32536
32677
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
32537
32678
|
* @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
|
|
32679
|
+
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
32538
32680
|
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32539
32681
|
*/
|
|
32540
32682
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
@@ -32549,7 +32691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32549
32691
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations',
|
|
32550
32692
|
'GET',
|
|
32551
32693
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32552
|
-
{ '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'] },
|
|
32694
|
+
{ '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') },
|
|
32553
32695
|
{ },
|
|
32554
32696
|
{ },
|
|
32555
32697
|
null,
|
|
@@ -34424,7 +34566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34424
34566
|
/**
|
|
34425
34567
|
* LanguageUnderstanding service.
|
|
34426
34568
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34427
|
-
* @version
|
|
34569
|
+
* @version 195.0.0
|
|
34428
34570
|
*/
|
|
34429
34571
|
|
|
34430
34572
|
/**
|
|
@@ -35458,7 +35600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35458
35600
|
/**
|
|
35459
35601
|
* Languages service.
|
|
35460
35602
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35461
|
-
* @version
|
|
35603
|
+
* @version 195.0.0
|
|
35462
35604
|
*/
|
|
35463
35605
|
|
|
35464
35606
|
/**
|
|
@@ -35680,7 +35822,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35680
35822
|
/**
|
|
35681
35823
|
* Learning service.
|
|
35682
35824
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35683
|
-
* @version
|
|
35825
|
+
* @version 195.0.0
|
|
35684
35826
|
*/
|
|
35685
35827
|
|
|
35686
35828
|
/**
|
|
@@ -35774,6 +35916,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35774
35916
|
);
|
|
35775
35917
|
}
|
|
35776
35918
|
|
|
35919
|
+
/**
|
|
35920
|
+
* Get Learning Assignment Step
|
|
35921
|
+
* Permission not required if you are the assigned user of the learning assignment
|
|
35922
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
35923
|
+
* @param {String} stepId The ID of Learning Assignment Step
|
|
35924
|
+
* @param {Object} opts Optional parameters
|
|
35925
|
+
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
35926
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35927
|
+
*/
|
|
35928
|
+
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
35929
|
+
opts = opts || {};
|
|
35930
|
+
|
|
35931
|
+
// verify the required parameter 'assignmentId' is set
|
|
35932
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
35933
|
+
throw 'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';
|
|
35934
|
+
}
|
|
35935
|
+
// verify the required parameter 'stepId' is set
|
|
35936
|
+
if (stepId === undefined || stepId === null) {
|
|
35937
|
+
throw 'Missing the required parameter "stepId" when calling getLearningAssignmentStep';
|
|
35938
|
+
}
|
|
35939
|
+
|
|
35940
|
+
return this.apiClient.callApi(
|
|
35941
|
+
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35942
|
+
'GET',
|
|
35943
|
+
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35944
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35945
|
+
{ },
|
|
35946
|
+
{ },
|
|
35947
|
+
null,
|
|
35948
|
+
['PureCloud OAuth'],
|
|
35949
|
+
['application/json'],
|
|
35950
|
+
['application/json']
|
|
35951
|
+
);
|
|
35952
|
+
}
|
|
35953
|
+
|
|
35777
35954
|
/**
|
|
35778
35955
|
* List of Learning module Assignments
|
|
35779
35956
|
* Either moduleId or user value is required
|
|
@@ -35908,6 +36085,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35908
36085
|
);
|
|
35909
36086
|
}
|
|
35910
36087
|
|
|
36088
|
+
/**
|
|
36089
|
+
* Get a learning module preview
|
|
36090
|
+
*
|
|
36091
|
+
* @param {String} moduleId The ID of the learning module
|
|
36092
|
+
*/
|
|
36093
|
+
getLearningModulePreview(moduleId) {
|
|
36094
|
+
// verify the required parameter 'moduleId' is set
|
|
36095
|
+
if (moduleId === undefined || moduleId === null) {
|
|
36096
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview';
|
|
36097
|
+
}
|
|
36098
|
+
|
|
36099
|
+
return this.apiClient.callApi(
|
|
36100
|
+
'/api/v2/learning/modules/{moduleId}/preview',
|
|
36101
|
+
'GET',
|
|
36102
|
+
{ 'moduleId': moduleId },
|
|
36103
|
+
{ },
|
|
36104
|
+
{ },
|
|
36105
|
+
{ },
|
|
36106
|
+
null,
|
|
36107
|
+
['PureCloud OAuth'],
|
|
36108
|
+
['application/json'],
|
|
36109
|
+
['application/json']
|
|
36110
|
+
);
|
|
36111
|
+
}
|
|
36112
|
+
|
|
35911
36113
|
/**
|
|
35912
36114
|
* Get a learning module rule
|
|
35913
36115
|
*
|
|
@@ -36060,6 +36262,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36060
36262
|
);
|
|
36061
36263
|
}
|
|
36062
36264
|
|
|
36265
|
+
/**
|
|
36266
|
+
* Get Learning SCORM Result
|
|
36267
|
+
*
|
|
36268
|
+
* @param {String} scormId The ID of the SCORM package
|
|
36269
|
+
*/
|
|
36270
|
+
getLearningScormScormId(scormId) {
|
|
36271
|
+
// verify the required parameter 'scormId' is set
|
|
36272
|
+
if (scormId === undefined || scormId === null) {
|
|
36273
|
+
throw 'Missing the required parameter "scormId" when calling getLearningScormScormId';
|
|
36274
|
+
}
|
|
36275
|
+
|
|
36276
|
+
return this.apiClient.callApi(
|
|
36277
|
+
'/api/v2/learning/scorm/{scormId}',
|
|
36278
|
+
'GET',
|
|
36279
|
+
{ 'scormId': scormId },
|
|
36280
|
+
{ },
|
|
36281
|
+
{ },
|
|
36282
|
+
{ },
|
|
36283
|
+
null,
|
|
36284
|
+
['PureCloud OAuth'],
|
|
36285
|
+
['application/json'],
|
|
36286
|
+
['application/json']
|
|
36287
|
+
);
|
|
36288
|
+
}
|
|
36289
|
+
|
|
36063
36290
|
/**
|
|
36064
36291
|
* Update Learning Assignment
|
|
36065
36292
|
*
|
|
@@ -36118,6 +36345,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36118
36345
|
);
|
|
36119
36346
|
}
|
|
36120
36347
|
|
|
36348
|
+
/**
|
|
36349
|
+
* Update Learning Assignment Step
|
|
36350
|
+
* Permission not required if you are the assigned user of the learning assignment
|
|
36351
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
36352
|
+
* @param {String} stepId The ID of Learning Assignment Step
|
|
36353
|
+
* @param {Object} opts Optional parameters
|
|
36354
|
+
* @param {Object} opts.body The Learning Assignment Step to be updated
|
|
36355
|
+
*/
|
|
36356
|
+
patchLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
36357
|
+
opts = opts || {};
|
|
36358
|
+
|
|
36359
|
+
// verify the required parameter 'assignmentId' is set
|
|
36360
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
36361
|
+
throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep';
|
|
36362
|
+
}
|
|
36363
|
+
// verify the required parameter 'stepId' is set
|
|
36364
|
+
if (stepId === undefined || stepId === null) {
|
|
36365
|
+
throw 'Missing the required parameter "stepId" when calling patchLearningAssignmentStep';
|
|
36366
|
+
}
|
|
36367
|
+
|
|
36368
|
+
return this.apiClient.callApi(
|
|
36369
|
+
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
36370
|
+
'PATCH',
|
|
36371
|
+
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
36372
|
+
{ },
|
|
36373
|
+
{ },
|
|
36374
|
+
{ },
|
|
36375
|
+
opts['body'],
|
|
36376
|
+
['PureCloud OAuth'],
|
|
36377
|
+
['application/json'],
|
|
36378
|
+
['application/json']
|
|
36379
|
+
);
|
|
36380
|
+
}
|
|
36381
|
+
|
|
36121
36382
|
/**
|
|
36122
36383
|
* Update an external assignment for a specific user
|
|
36123
36384
|
*
|
|
@@ -36469,6 +36730,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36469
36730
|
);
|
|
36470
36731
|
}
|
|
36471
36732
|
|
|
36733
|
+
/**
|
|
36734
|
+
* Create a SCORM package upload request
|
|
36735
|
+
*
|
|
36736
|
+
* @param {Object} opts Optional parameters
|
|
36737
|
+
* @param {Object} opts.body The SCORM package to be uploaded
|
|
36738
|
+
*/
|
|
36739
|
+
postLearningScorm(opts) {
|
|
36740
|
+
opts = opts || {};
|
|
36741
|
+
|
|
36742
|
+
|
|
36743
|
+
return this.apiClient.callApi(
|
|
36744
|
+
'/api/v2/learning/scorm',
|
|
36745
|
+
'POST',
|
|
36746
|
+
{ },
|
|
36747
|
+
{ },
|
|
36748
|
+
{ },
|
|
36749
|
+
{ },
|
|
36750
|
+
opts['body'],
|
|
36751
|
+
['PureCloud OAuth'],
|
|
36752
|
+
['application/json'],
|
|
36753
|
+
['application/json']
|
|
36754
|
+
);
|
|
36755
|
+
}
|
|
36756
|
+
|
|
36472
36757
|
/**
|
|
36473
36758
|
* Update a learning module
|
|
36474
36759
|
* This will update the name, description, completion time in days and inform steps for a learning module
|
|
@@ -36499,6 +36784,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36499
36784
|
);
|
|
36500
36785
|
}
|
|
36501
36786
|
|
|
36787
|
+
/**
|
|
36788
|
+
* Update a learning module preview
|
|
36789
|
+
* This will update a learning module preview
|
|
36790
|
+
* @param {String} moduleId The ID of the learning module
|
|
36791
|
+
* @param {Object} body The learning module to be updated
|
|
36792
|
+
*/
|
|
36793
|
+
putLearningModulePreview(moduleId, body) {
|
|
36794
|
+
// verify the required parameter 'moduleId' is set
|
|
36795
|
+
if (moduleId === undefined || moduleId === null) {
|
|
36796
|
+
throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview';
|
|
36797
|
+
}
|
|
36798
|
+
// verify the required parameter 'body' is set
|
|
36799
|
+
if (body === undefined || body === null) {
|
|
36800
|
+
throw 'Missing the required parameter "body" when calling putLearningModulePreview';
|
|
36801
|
+
}
|
|
36802
|
+
|
|
36803
|
+
return this.apiClient.callApi(
|
|
36804
|
+
'/api/v2/learning/modules/{moduleId}/preview',
|
|
36805
|
+
'PUT',
|
|
36806
|
+
{ 'moduleId': moduleId },
|
|
36807
|
+
{ },
|
|
36808
|
+
{ },
|
|
36809
|
+
{ },
|
|
36810
|
+
body,
|
|
36811
|
+
['PureCloud OAuth'],
|
|
36812
|
+
['application/json'],
|
|
36813
|
+
['application/json']
|
|
36814
|
+
);
|
|
36815
|
+
}
|
|
36816
|
+
|
|
36502
36817
|
/**
|
|
36503
36818
|
* Update a learning module rule
|
|
36504
36819
|
* This will update a learning module rule with the specified fields.
|
|
@@ -36535,7 +36850,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36535
36850
|
/**
|
|
36536
36851
|
* License service.
|
|
36537
36852
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36538
|
-
* @version
|
|
36853
|
+
* @version 195.0.0
|
|
36539
36854
|
*/
|
|
36540
36855
|
|
|
36541
36856
|
/**
|
|
@@ -36773,7 +37088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36773
37088
|
/**
|
|
36774
37089
|
* Locations service.
|
|
36775
37090
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36776
|
-
* @version
|
|
37091
|
+
* @version 195.0.0
|
|
36777
37092
|
*/
|
|
36778
37093
|
|
|
36779
37094
|
/**
|
|
@@ -37009,7 +37324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37009
37324
|
/**
|
|
37010
37325
|
* LogCapture service.
|
|
37011
37326
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37012
|
-
* @version
|
|
37327
|
+
* @version 195.0.0
|
|
37013
37328
|
*/
|
|
37014
37329
|
|
|
37015
37330
|
/**
|
|
@@ -37209,7 +37524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37209
37524
|
/**
|
|
37210
37525
|
* Messaging service.
|
|
37211
37526
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37212
|
-
* @version
|
|
37527
|
+
* @version 195.0.0
|
|
37213
37528
|
*/
|
|
37214
37529
|
|
|
37215
37530
|
/**
|
|
@@ -37568,7 +37883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37568
37883
|
/**
|
|
37569
37884
|
* MobileDevices service.
|
|
37570
37885
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37571
|
-
* @version
|
|
37886
|
+
* @version 195.0.0
|
|
37572
37887
|
*/
|
|
37573
37888
|
|
|
37574
37889
|
/**
|
|
@@ -37719,7 +38034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37719
38034
|
/**
|
|
37720
38035
|
* Notifications service.
|
|
37721
38036
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37722
|
-
* @version
|
|
38037
|
+
* @version 195.0.0
|
|
37723
38038
|
*/
|
|
37724
38039
|
|
|
37725
38040
|
/**
|
|
@@ -37952,7 +38267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37952
38267
|
/**
|
|
37953
38268
|
* OAuth service.
|
|
37954
38269
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37955
|
-
* @version
|
|
38270
|
+
* @version 195.0.0
|
|
37956
38271
|
*/
|
|
37957
38272
|
|
|
37958
38273
|
/**
|
|
@@ -38318,7 +38633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38318
38633
|
/**
|
|
38319
38634
|
* Objects service.
|
|
38320
38635
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38321
|
-
* @version
|
|
38636
|
+
* @version 195.0.0
|
|
38322
38637
|
*/
|
|
38323
38638
|
|
|
38324
38639
|
/**
|
|
@@ -38588,7 +38903,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38588
38903
|
/**
|
|
38589
38904
|
* OperationalEvents service.
|
|
38590
38905
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38591
|
-
* @version
|
|
38906
|
+
* @version 195.0.0
|
|
38592
38907
|
*/
|
|
38593
38908
|
|
|
38594
38909
|
/**
|
|
@@ -38654,7 +38969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38654
38969
|
/**
|
|
38655
38970
|
* Organization service.
|
|
38656
38971
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38657
|
-
* @version
|
|
38972
|
+
* @version 195.0.0
|
|
38658
38973
|
*/
|
|
38659
38974
|
|
|
38660
38975
|
/**
|
|
@@ -39129,7 +39444,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39129
39444
|
/**
|
|
39130
39445
|
* OrganizationAuthorization service.
|
|
39131
39446
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39132
|
-
* @version
|
|
39447
|
+
* @version 195.0.0
|
|
39133
39448
|
*/
|
|
39134
39449
|
|
|
39135
39450
|
/**
|
|
@@ -40476,7 +40791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40476
40791
|
/**
|
|
40477
40792
|
* Outbound service.
|
|
40478
40793
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40479
|
-
* @version
|
|
40794
|
+
* @version 195.0.0
|
|
40480
40795
|
*/
|
|
40481
40796
|
|
|
40482
40797
|
/**
|
|
@@ -44842,7 +45157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44842
45157
|
/**
|
|
44843
45158
|
* Presence service.
|
|
44844
45159
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
44845
|
-
* @version
|
|
45160
|
+
* @version 195.0.0
|
|
44846
45161
|
*/
|
|
44847
45162
|
|
|
44848
45163
|
/**
|
|
@@ -45586,7 +45901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45586
45901
|
/**
|
|
45587
45902
|
* ProcessAutomation service.
|
|
45588
45903
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45589
|
-
* @version
|
|
45904
|
+
* @version 195.0.0
|
|
45590
45905
|
*/
|
|
45591
45906
|
|
|
45592
45907
|
/**
|
|
@@ -45825,7 +46140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45825
46140
|
/**
|
|
45826
46141
|
* Quality service.
|
|
45827
46142
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
45828
|
-
* @version
|
|
46143
|
+
* @version 195.0.0
|
|
45829
46144
|
*/
|
|
45830
46145
|
|
|
45831
46146
|
/**
|
|
@@ -47582,7 +47897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47582
47897
|
/**
|
|
47583
47898
|
* Recording service.
|
|
47584
47899
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47585
|
-
* @version
|
|
47900
|
+
* @version 195.0.0
|
|
47586
47901
|
*/
|
|
47587
47902
|
|
|
47588
47903
|
/**
|
|
@@ -49240,7 +49555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49240
49555
|
/**
|
|
49241
49556
|
* ResponseManagement service.
|
|
49242
49557
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49243
|
-
* @version
|
|
49558
|
+
* @version 195.0.0
|
|
49244
49559
|
*/
|
|
49245
49560
|
|
|
49246
49561
|
/**
|
|
@@ -49750,7 +50065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49750
50065
|
/**
|
|
49751
50066
|
* Routing service.
|
|
49752
50067
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
49753
|
-
* @version
|
|
50068
|
+
* @version 195.0.0
|
|
49754
50069
|
*/
|
|
49755
50070
|
|
|
49756
50071
|
/**
|
|
@@ -50211,7 +50526,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50211
50526
|
* @param {String} labelId Utilization Label ID
|
|
50212
50527
|
* @param {Object} opts Optional parameters
|
|
50213
50528
|
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
50214
|
-
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
50215
50529
|
*/
|
|
50216
50530
|
deleteRoutingUtilizationLabel(labelId, opts) {
|
|
50217
50531
|
opts = opts || {};
|
|
@@ -51730,7 +52044,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51730
52044
|
* Get details about this utilization label
|
|
51731
52045
|
*
|
|
51732
52046
|
* @param {String} labelId Utilization Label ID
|
|
51733
|
-
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51734
52047
|
*/
|
|
51735
52048
|
getRoutingUtilizationLabel(labelId) {
|
|
51736
52049
|
// verify the required parameter 'labelId' is set
|
|
@@ -51756,7 +52069,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51756
52069
|
* Get list of agent ids associated with a utilization label
|
|
51757
52070
|
*
|
|
51758
52071
|
* @param {String} labelId Utilization Label ID
|
|
51759
|
-
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51760
52072
|
*/
|
|
51761
52073
|
getRoutingUtilizationLabelAgents(labelId) {
|
|
51762
52074
|
// verify the required parameter 'labelId' is set
|
|
@@ -51786,7 +52098,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51786
52098
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
51787
52099
|
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
51788
52100
|
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
51789
|
-
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
51790
52101
|
*/
|
|
51791
52102
|
getRoutingUtilizationLabels(opts) {
|
|
51792
52103
|
opts = opts || {};
|
|
@@ -53209,7 +53520,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53209
53520
|
* Create a utilization label
|
|
53210
53521
|
*
|
|
53211
53522
|
* @param {Object} body UtilizationLabel
|
|
53212
|
-
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53213
53523
|
*/
|
|
53214
53524
|
postRoutingUtilizationLabels(body) {
|
|
53215
53525
|
// verify the required parameter 'body' is set
|
|
@@ -53602,7 +53912,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53602
53912
|
*
|
|
53603
53913
|
* @param {String} labelId Utilization Label ID
|
|
53604
53914
|
* @param {Object} body UtilizationLabel
|
|
53605
|
-
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53606
53915
|
*/
|
|
53607
53916
|
putRoutingUtilizationLabel(labelId, body) {
|
|
53608
53917
|
// verify the required parameter 'labelId' is set
|
|
@@ -53729,7 +54038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53729
54038
|
/**
|
|
53730
54039
|
* SCIM service.
|
|
53731
54040
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
53732
|
-
* @version
|
|
54041
|
+
* @version 195.0.0
|
|
53733
54042
|
*/
|
|
53734
54043
|
|
|
53735
54044
|
/**
|
|
@@ -54606,7 +54915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54606
54915
|
/**
|
|
54607
54916
|
* ScreenRecording service.
|
|
54608
54917
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54609
|
-
* @version
|
|
54918
|
+
* @version 195.0.0
|
|
54610
54919
|
*/
|
|
54611
54920
|
|
|
54612
54921
|
/**
|
|
@@ -54651,7 +54960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54651
54960
|
/**
|
|
54652
54961
|
* Scripts service.
|
|
54653
54962
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54654
|
-
* @version
|
|
54963
|
+
* @version 195.0.0
|
|
54655
54964
|
*/
|
|
54656
54965
|
|
|
54657
54966
|
/**
|
|
@@ -55095,7 +55404,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55095
55404
|
/**
|
|
55096
55405
|
* Search service.
|
|
55097
55406
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55098
|
-
* @version
|
|
55407
|
+
* @version 195.0.0
|
|
55099
55408
|
*/
|
|
55100
55409
|
|
|
55101
55410
|
/**
|
|
@@ -55784,7 +56093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55784
56093
|
/**
|
|
55785
56094
|
* Settings service.
|
|
55786
56095
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
55787
|
-
* @version
|
|
56096
|
+
* @version 195.0.0
|
|
55788
56097
|
*/
|
|
55789
56098
|
|
|
55790
56099
|
/**
|
|
@@ -55896,7 +56205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55896
56205
|
/**
|
|
55897
56206
|
* SpeechTextAnalytics service.
|
|
55898
56207
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
55899
|
-
* @version
|
|
56208
|
+
* @version 195.0.0
|
|
55900
56209
|
*/
|
|
55901
56210
|
|
|
55902
56211
|
/**
|
|
@@ -55911,6 +56220,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55911
56220
|
}
|
|
55912
56221
|
|
|
55913
56222
|
|
|
56223
|
+
/**
|
|
56224
|
+
* Delete a Speech and Text Analytics category by ID
|
|
56225
|
+
*
|
|
56226
|
+
* @param {String} categoryId The id of the category
|
|
56227
|
+
*/
|
|
56228
|
+
deleteSpeechandtextanalyticsCategory(categoryId) {
|
|
56229
|
+
// verify the required parameter 'categoryId' is set
|
|
56230
|
+
if (categoryId === undefined || categoryId === null) {
|
|
56231
|
+
throw 'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory';
|
|
56232
|
+
}
|
|
56233
|
+
|
|
56234
|
+
return this.apiClient.callApi(
|
|
56235
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
56236
|
+
'DELETE',
|
|
56237
|
+
{ 'categoryId': categoryId },
|
|
56238
|
+
{ },
|
|
56239
|
+
{ },
|
|
56240
|
+
{ },
|
|
56241
|
+
null,
|
|
56242
|
+
['PureCloud OAuth'],
|
|
56243
|
+
['application/json'],
|
|
56244
|
+
['application/json']
|
|
56245
|
+
);
|
|
56246
|
+
}
|
|
56247
|
+
|
|
55914
56248
|
/**
|
|
55915
56249
|
* Delete a Speech and Text Analytics DictionaryFeedback by Id
|
|
55916
56250
|
*
|
|
@@ -56035,6 +56369,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56035
56369
|
);
|
|
56036
56370
|
}
|
|
56037
56371
|
|
|
56372
|
+
/**
|
|
56373
|
+
* Get the list of Speech and Text Analytics categories
|
|
56374
|
+
*
|
|
56375
|
+
* @param {Object} opts Optional parameters
|
|
56376
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
|
|
56377
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
56378
|
+
* @param {String} opts.name The category name filter applied to the listing
|
|
56379
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
56380
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
56381
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
56382
|
+
*/
|
|
56383
|
+
getSpeechandtextanalyticsCategories(opts) {
|
|
56384
|
+
opts = opts || {};
|
|
56385
|
+
|
|
56386
|
+
|
|
56387
|
+
return this.apiClient.callApi(
|
|
56388
|
+
'/api/v2/speechandtextanalytics/categories',
|
|
56389
|
+
'GET',
|
|
56390
|
+
{ },
|
|
56391
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') },
|
|
56392
|
+
{ },
|
|
56393
|
+
{ },
|
|
56394
|
+
null,
|
|
56395
|
+
['PureCloud OAuth'],
|
|
56396
|
+
['application/json'],
|
|
56397
|
+
['application/json']
|
|
56398
|
+
);
|
|
56399
|
+
}
|
|
56400
|
+
|
|
56401
|
+
/**
|
|
56402
|
+
* Get a Speech and Text Analytics Category by ID
|
|
56403
|
+
*
|
|
56404
|
+
* @param {String} categoryId The id of the category
|
|
56405
|
+
*/
|
|
56406
|
+
getSpeechandtextanalyticsCategory(categoryId) {
|
|
56407
|
+
// verify the required parameter 'categoryId' is set
|
|
56408
|
+
if (categoryId === undefined || categoryId === null) {
|
|
56409
|
+
throw 'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory';
|
|
56410
|
+
}
|
|
56411
|
+
|
|
56412
|
+
return this.apiClient.callApi(
|
|
56413
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
56414
|
+
'GET',
|
|
56415
|
+
{ 'categoryId': categoryId },
|
|
56416
|
+
{ },
|
|
56417
|
+
{ },
|
|
56418
|
+
{ },
|
|
56419
|
+
null,
|
|
56420
|
+
['PureCloud OAuth'],
|
|
56421
|
+
['application/json'],
|
|
56422
|
+
['application/json']
|
|
56423
|
+
);
|
|
56424
|
+
}
|
|
56425
|
+
|
|
56038
56426
|
/**
|
|
56039
56427
|
* Get Speech and Text Analytics for a specific conversation
|
|
56040
56428
|
*
|
|
@@ -56060,6 +56448,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56060
56448
|
);
|
|
56061
56449
|
}
|
|
56062
56450
|
|
|
56451
|
+
/**
|
|
56452
|
+
* Get the list of detected Speech and Text Analytics categories of conversation
|
|
56453
|
+
*
|
|
56454
|
+
* @param {String} conversationId The id of the conversation
|
|
56455
|
+
* @param {Object} opts Optional parameters
|
|
56456
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
|
|
56457
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
56458
|
+
*/
|
|
56459
|
+
getSpeechandtextanalyticsConversationCategories(conversationId, opts) {
|
|
56460
|
+
opts = opts || {};
|
|
56461
|
+
|
|
56462
|
+
// verify the required parameter 'conversationId' is set
|
|
56463
|
+
if (conversationId === undefined || conversationId === null) {
|
|
56464
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories';
|
|
56465
|
+
}
|
|
56466
|
+
|
|
56467
|
+
return this.apiClient.callApi(
|
|
56468
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/categories',
|
|
56469
|
+
'GET',
|
|
56470
|
+
{ 'conversationId': conversationId },
|
|
56471
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
56472
|
+
{ },
|
|
56473
|
+
{ },
|
|
56474
|
+
null,
|
|
56475
|
+
['PureCloud OAuth'],
|
|
56476
|
+
['application/json'],
|
|
56477
|
+
['application/json']
|
|
56478
|
+
);
|
|
56479
|
+
}
|
|
56480
|
+
|
|
56063
56481
|
/**
|
|
56064
56482
|
* Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
|
56065
56483
|
*
|
|
@@ -56630,6 +57048,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56630
57048
|
);
|
|
56631
57049
|
}
|
|
56632
57050
|
|
|
57051
|
+
/**
|
|
57052
|
+
* Create new Speech and Text Analytics category
|
|
57053
|
+
*
|
|
57054
|
+
* @param {Object} body The category to create
|
|
57055
|
+
*/
|
|
57056
|
+
postSpeechandtextanalyticsCategories(body) {
|
|
57057
|
+
// verify the required parameter 'body' is set
|
|
57058
|
+
if (body === undefined || body === null) {
|
|
57059
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories';
|
|
57060
|
+
}
|
|
57061
|
+
|
|
57062
|
+
return this.apiClient.callApi(
|
|
57063
|
+
'/api/v2/speechandtextanalytics/categories',
|
|
57064
|
+
'POST',
|
|
57065
|
+
{ },
|
|
57066
|
+
{ },
|
|
57067
|
+
{ },
|
|
57068
|
+
{ },
|
|
57069
|
+
body,
|
|
57070
|
+
['PureCloud OAuth'],
|
|
57071
|
+
['application/json'],
|
|
57072
|
+
['application/json']
|
|
57073
|
+
);
|
|
57074
|
+
}
|
|
57075
|
+
|
|
56633
57076
|
/**
|
|
56634
57077
|
* Create a Speech and Text Analytics DictionaryFeedback
|
|
56635
57078
|
*
|
|
@@ -56830,6 +57273,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56830
57273
|
);
|
|
56831
57274
|
}
|
|
56832
57275
|
|
|
57276
|
+
/**
|
|
57277
|
+
* Update a Speech and Text Analytics category by ID
|
|
57278
|
+
*
|
|
57279
|
+
* @param {String} categoryId The id of the category
|
|
57280
|
+
* @param {Object} body The updated category
|
|
57281
|
+
*/
|
|
57282
|
+
putSpeechandtextanalyticsCategory(categoryId, body) {
|
|
57283
|
+
// verify the required parameter 'categoryId' is set
|
|
57284
|
+
if (categoryId === undefined || categoryId === null) {
|
|
57285
|
+
throw 'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory';
|
|
57286
|
+
}
|
|
57287
|
+
// verify the required parameter 'body' is set
|
|
57288
|
+
if (body === undefined || body === null) {
|
|
57289
|
+
throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory';
|
|
57290
|
+
}
|
|
57291
|
+
|
|
57292
|
+
return this.apiClient.callApi(
|
|
57293
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
57294
|
+
'PUT',
|
|
57295
|
+
{ 'categoryId': categoryId },
|
|
57296
|
+
{ },
|
|
57297
|
+
{ },
|
|
57298
|
+
{ },
|
|
57299
|
+
body,
|
|
57300
|
+
['PureCloud OAuth'],
|
|
57301
|
+
['application/json'],
|
|
57302
|
+
['application/json']
|
|
57303
|
+
);
|
|
57304
|
+
}
|
|
57305
|
+
|
|
56833
57306
|
/**
|
|
56834
57307
|
* Update existing Speech and Text Analytics dictionary feedback by id
|
|
56835
57308
|
*
|
|
@@ -57010,7 +57483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57010
57483
|
/**
|
|
57011
57484
|
* Stations service.
|
|
57012
57485
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57013
|
-
* @version
|
|
57486
|
+
* @version 195.0.0
|
|
57014
57487
|
*/
|
|
57015
57488
|
|
|
57016
57489
|
/**
|
|
@@ -57112,7 +57585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57112
57585
|
/**
|
|
57113
57586
|
* Suggest service.
|
|
57114
57587
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57115
|
-
* @version
|
|
57588
|
+
* @version 195.0.0
|
|
57116
57589
|
*/
|
|
57117
57590
|
|
|
57118
57591
|
/**
|
|
@@ -57251,7 +57724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57251
57724
|
/**
|
|
57252
57725
|
* TaskManagement service.
|
|
57253
57726
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57254
|
-
* @version
|
|
57727
|
+
* @version 195.0.0
|
|
57255
57728
|
*/
|
|
57256
57729
|
|
|
57257
57730
|
/**
|
|
@@ -58599,7 +59072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58599
59072
|
/**
|
|
58600
59073
|
* Teams service.
|
|
58601
59074
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
58602
|
-
* @version
|
|
59075
|
+
* @version 195.0.0
|
|
58603
59076
|
*/
|
|
58604
59077
|
|
|
58605
59078
|
/**
|
|
@@ -58900,7 +59373,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58900
59373
|
/**
|
|
58901
59374
|
* Telephony service.
|
|
58902
59375
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
58903
|
-
* @version
|
|
59376
|
+
* @version 195.0.0
|
|
58904
59377
|
*/
|
|
58905
59378
|
|
|
58906
59379
|
/**
|
|
@@ -59082,7 +59555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59082
59555
|
/**
|
|
59083
59556
|
* TelephonyProvidersEdge service.
|
|
59084
59557
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59085
|
-
* @version
|
|
59558
|
+
* @version 195.0.0
|
|
59086
59559
|
*/
|
|
59087
59560
|
|
|
59088
59561
|
/**
|
|
@@ -62410,7 +62883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62410
62883
|
/**
|
|
62411
62884
|
* Textbots service.
|
|
62412
62885
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62413
|
-
* @version
|
|
62886
|
+
* @version 195.0.0
|
|
62414
62887
|
*/
|
|
62415
62888
|
|
|
62416
62889
|
/**
|
|
@@ -62538,7 +63011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62538
63011
|
/**
|
|
62539
63012
|
* Tokens service.
|
|
62540
63013
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62541
|
-
* @version
|
|
63014
|
+
* @version 195.0.0
|
|
62542
63015
|
*/
|
|
62543
63016
|
|
|
62544
63017
|
/**
|
|
@@ -62692,7 +63165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62692
63165
|
/**
|
|
62693
63166
|
* Uploads service.
|
|
62694
63167
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
62695
|
-
* @version
|
|
63168
|
+
* @version 195.0.0
|
|
62696
63169
|
*/
|
|
62697
63170
|
|
|
62698
63171
|
/**
|
|
@@ -62961,7 +63434,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62961
63434
|
/**
|
|
62962
63435
|
* Usage service.
|
|
62963
63436
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
62964
|
-
* @version
|
|
63437
|
+
* @version 195.0.0
|
|
62965
63438
|
*/
|
|
62966
63439
|
|
|
62967
63440
|
/**
|
|
@@ -63176,7 +63649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63176
63649
|
/**
|
|
63177
63650
|
* UserRecordings service.
|
|
63178
63651
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63179
|
-
* @version
|
|
63652
|
+
* @version 195.0.0
|
|
63180
63653
|
*/
|
|
63181
63654
|
|
|
63182
63655
|
/**
|
|
@@ -63361,7 +63834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63361
63834
|
/**
|
|
63362
63835
|
* Users service.
|
|
63363
63836
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63364
|
-
* @version
|
|
63837
|
+
* @version 195.0.0
|
|
63365
63838
|
*/
|
|
63366
63839
|
|
|
63367
63840
|
/**
|
|
@@ -66019,7 +66492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66019
66492
|
/**
|
|
66020
66493
|
* Utilities service.
|
|
66021
66494
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66022
|
-
* @version
|
|
66495
|
+
* @version 195.0.0
|
|
66023
66496
|
*/
|
|
66024
66497
|
|
|
66025
66498
|
/**
|
|
@@ -66130,7 +66603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66130
66603
|
/**
|
|
66131
66604
|
* Voicemail service.
|
|
66132
66605
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66133
|
-
* @version
|
|
66606
|
+
* @version 195.0.0
|
|
66134
66607
|
*/
|
|
66135
66608
|
|
|
66136
66609
|
/**
|
|
@@ -66797,7 +67270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66797
67270
|
/**
|
|
66798
67271
|
* WebChat service.
|
|
66799
67272
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
66800
|
-
* @version
|
|
67273
|
+
* @version 195.0.0
|
|
66801
67274
|
*/
|
|
66802
67275
|
|
|
66803
67276
|
/**
|
|
@@ -67348,7 +67821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67348
67821
|
/**
|
|
67349
67822
|
* WebDeployments service.
|
|
67350
67823
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67351
|
-
* @version
|
|
67824
|
+
* @version 195.0.0
|
|
67352
67825
|
*/
|
|
67353
67826
|
|
|
67354
67827
|
/**
|
|
@@ -67875,7 +68348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67875
68348
|
/**
|
|
67876
68349
|
* WebMessaging service.
|
|
67877
68350
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
67878
|
-
* @version
|
|
68351
|
+
* @version 195.0.0
|
|
67879
68352
|
*/
|
|
67880
68353
|
|
|
67881
68354
|
/**
|
|
@@ -67921,7 +68394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67921
68394
|
/**
|
|
67922
68395
|
* Widgets service.
|
|
67923
68396
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
67924
|
-
* @version
|
|
68397
|
+
* @version 195.0.0
|
|
67925
68398
|
*/
|
|
67926
68399
|
|
|
67927
68400
|
/**
|
|
@@ -68067,7 +68540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68067
68540
|
/**
|
|
68068
68541
|
* WorkforceManagement service.
|
|
68069
68542
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68070
|
-
* @version
|
|
68543
|
+
* @version 195.0.0
|
|
68071
68544
|
*/
|
|
68072
68545
|
|
|
68073
68546
|
/**
|
|
@@ -73980,7 +74453,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73980
74453
|
* </pre>
|
|
73981
74454
|
* </p>
|
|
73982
74455
|
* @module purecloud-platform-client-v2/index
|
|
73983
|
-
* @version
|
|
74456
|
+
* @version 195.0.0
|
|
73984
74457
|
*/
|
|
73985
74458
|
class platformClient {
|
|
73986
74459
|
constructor() {
|