purecloud-platform-client-v2 194.0.0 → 196.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 +618 -119
- package/dist/web-amd/purecloud-platform-client-v2.js +618 -119
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +215 -99
- package/dist/web-cjs/purecloud-platform-client-v2.js +219 -100
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +644 -516
- 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 +29 -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 +2 -4
- 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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.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 196.0.0
|
|
29596
29737
|
*/
|
|
29597
29738
|
|
|
29598
29739
|
/**
|
|
@@ -30613,6 +30754,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30613
30754
|
);
|
|
30614
30755
|
}
|
|
30615
30756
|
|
|
30757
|
+
/**
|
|
30758
|
+
* Get the jobs for an organization.
|
|
30759
|
+
*
|
|
30760
|
+
* @param {Object} opts Optional parameters
|
|
30761
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
30762
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
30763
|
+
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
30764
|
+
* @param {String} opts.statuses Job statuses to filter for
|
|
30765
|
+
* getJourneyViewsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30766
|
+
*/
|
|
30767
|
+
getJourneyViewsJobs(opts) {
|
|
30768
|
+
opts = opts || {};
|
|
30769
|
+
|
|
30770
|
+
|
|
30771
|
+
return this.apiClient.callApi(
|
|
30772
|
+
'/api/v2/journey/views/jobs',
|
|
30773
|
+
'GET',
|
|
30774
|
+
{ },
|
|
30775
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'interval': opts['interval'],'statuses': opts['statuses'] },
|
|
30776
|
+
{ },
|
|
30777
|
+
{ },
|
|
30778
|
+
null,
|
|
30779
|
+
['PureCloud OAuth'],
|
|
30780
|
+
['application/json'],
|
|
30781
|
+
['application/json']
|
|
30782
|
+
);
|
|
30783
|
+
}
|
|
30784
|
+
|
|
30616
30785
|
/**
|
|
30617
30786
|
* Update single action map.
|
|
30618
30787
|
*
|
|
@@ -31181,7 +31350,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31181
31350
|
/**
|
|
31182
31351
|
* Knowledge service.
|
|
31183
31352
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31184
|
-
* @version
|
|
31353
|
+
* @version 196.0.0
|
|
31185
31354
|
*/
|
|
31186
31355
|
|
|
31187
31356
|
/**
|
|
@@ -32535,6 +32704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32535
32704
|
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
32536
32705
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
32537
32706
|
* @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
|
|
32707
|
+
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
32538
32708
|
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32539
32709
|
*/
|
|
32540
32710
|
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
@@ -32549,7 +32719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32549
32719
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations',
|
|
32550
32720
|
'GET',
|
|
32551
32721
|
{ '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'] },
|
|
32722
|
+
{ '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
32723
|
{ },
|
|
32554
32724
|
{ },
|
|
32555
32725
|
null,
|
|
@@ -34424,7 +34594,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34424
34594
|
/**
|
|
34425
34595
|
* LanguageUnderstanding service.
|
|
34426
34596
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34427
|
-
* @version
|
|
34597
|
+
* @version 196.0.0
|
|
34428
34598
|
*/
|
|
34429
34599
|
|
|
34430
34600
|
/**
|
|
@@ -35458,7 +35628,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35458
35628
|
/**
|
|
35459
35629
|
* Languages service.
|
|
35460
35630
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35461
|
-
* @version
|
|
35631
|
+
* @version 196.0.0
|
|
35462
35632
|
*/
|
|
35463
35633
|
|
|
35464
35634
|
/**
|
|
@@ -35680,7 +35850,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35680
35850
|
/**
|
|
35681
35851
|
* Learning service.
|
|
35682
35852
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35683
|
-
* @version
|
|
35853
|
+
* @version 196.0.0
|
|
35684
35854
|
*/
|
|
35685
35855
|
|
|
35686
35856
|
/**
|
|
@@ -35774,6 +35944,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35774
35944
|
);
|
|
35775
35945
|
}
|
|
35776
35946
|
|
|
35947
|
+
/**
|
|
35948
|
+
* Get Learning Assignment Step
|
|
35949
|
+
* Permission not required if you are the assigned user of the learning assignment
|
|
35950
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
35951
|
+
* @param {String} stepId The ID of Learning Assignment Step
|
|
35952
|
+
* @param {Object} opts Optional parameters
|
|
35953
|
+
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
35954
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35955
|
+
*/
|
|
35956
|
+
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
35957
|
+
opts = opts || {};
|
|
35958
|
+
|
|
35959
|
+
// verify the required parameter 'assignmentId' is set
|
|
35960
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
35961
|
+
throw 'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';
|
|
35962
|
+
}
|
|
35963
|
+
// verify the required parameter 'stepId' is set
|
|
35964
|
+
if (stepId === undefined || stepId === null) {
|
|
35965
|
+
throw 'Missing the required parameter "stepId" when calling getLearningAssignmentStep';
|
|
35966
|
+
}
|
|
35967
|
+
|
|
35968
|
+
return this.apiClient.callApi(
|
|
35969
|
+
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35970
|
+
'GET',
|
|
35971
|
+
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35972
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35973
|
+
{ },
|
|
35974
|
+
{ },
|
|
35975
|
+
null,
|
|
35976
|
+
['PureCloud OAuth'],
|
|
35977
|
+
['application/json'],
|
|
35978
|
+
['application/json']
|
|
35979
|
+
);
|
|
35980
|
+
}
|
|
35981
|
+
|
|
35777
35982
|
/**
|
|
35778
35983
|
* List of Learning module Assignments
|
|
35779
35984
|
* Either moduleId or user value is required
|
|
@@ -35908,6 +36113,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35908
36113
|
);
|
|
35909
36114
|
}
|
|
35910
36115
|
|
|
36116
|
+
/**
|
|
36117
|
+
* Get a learning module preview
|
|
36118
|
+
*
|
|
36119
|
+
* @param {String} moduleId The ID of the learning module
|
|
36120
|
+
*/
|
|
36121
|
+
getLearningModulePreview(moduleId) {
|
|
36122
|
+
// verify the required parameter 'moduleId' is set
|
|
36123
|
+
if (moduleId === undefined || moduleId === null) {
|
|
36124
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview';
|
|
36125
|
+
}
|
|
36126
|
+
|
|
36127
|
+
return this.apiClient.callApi(
|
|
36128
|
+
'/api/v2/learning/modules/{moduleId}/preview',
|
|
36129
|
+
'GET',
|
|
36130
|
+
{ 'moduleId': moduleId },
|
|
36131
|
+
{ },
|
|
36132
|
+
{ },
|
|
36133
|
+
{ },
|
|
36134
|
+
null,
|
|
36135
|
+
['PureCloud OAuth'],
|
|
36136
|
+
['application/json'],
|
|
36137
|
+
['application/json']
|
|
36138
|
+
);
|
|
36139
|
+
}
|
|
36140
|
+
|
|
35911
36141
|
/**
|
|
35912
36142
|
* Get a learning module rule
|
|
35913
36143
|
*
|
|
@@ -36060,6 +36290,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36060
36290
|
);
|
|
36061
36291
|
}
|
|
36062
36292
|
|
|
36293
|
+
/**
|
|
36294
|
+
* Get Learning SCORM Result
|
|
36295
|
+
*
|
|
36296
|
+
* @param {String} scormId The ID of the SCORM package
|
|
36297
|
+
*/
|
|
36298
|
+
getLearningScormScormId(scormId) {
|
|
36299
|
+
// verify the required parameter 'scormId' is set
|
|
36300
|
+
if (scormId === undefined || scormId === null) {
|
|
36301
|
+
throw 'Missing the required parameter "scormId" when calling getLearningScormScormId';
|
|
36302
|
+
}
|
|
36303
|
+
|
|
36304
|
+
return this.apiClient.callApi(
|
|
36305
|
+
'/api/v2/learning/scorm/{scormId}',
|
|
36306
|
+
'GET',
|
|
36307
|
+
{ 'scormId': scormId },
|
|
36308
|
+
{ },
|
|
36309
|
+
{ },
|
|
36310
|
+
{ },
|
|
36311
|
+
null,
|
|
36312
|
+
['PureCloud OAuth'],
|
|
36313
|
+
['application/json'],
|
|
36314
|
+
['application/json']
|
|
36315
|
+
);
|
|
36316
|
+
}
|
|
36317
|
+
|
|
36063
36318
|
/**
|
|
36064
36319
|
* Update Learning Assignment
|
|
36065
36320
|
*
|
|
@@ -36118,6 +36373,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36118
36373
|
);
|
|
36119
36374
|
}
|
|
36120
36375
|
|
|
36376
|
+
/**
|
|
36377
|
+
* Update Learning Assignment Step
|
|
36378
|
+
* Permission not required if you are the assigned user of the learning assignment
|
|
36379
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
36380
|
+
* @param {String} stepId The ID of Learning Assignment Step
|
|
36381
|
+
* @param {Object} opts Optional parameters
|
|
36382
|
+
* @param {Object} opts.body The Learning Assignment Step to be updated
|
|
36383
|
+
*/
|
|
36384
|
+
patchLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
36385
|
+
opts = opts || {};
|
|
36386
|
+
|
|
36387
|
+
// verify the required parameter 'assignmentId' is set
|
|
36388
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
36389
|
+
throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep';
|
|
36390
|
+
}
|
|
36391
|
+
// verify the required parameter 'stepId' is set
|
|
36392
|
+
if (stepId === undefined || stepId === null) {
|
|
36393
|
+
throw 'Missing the required parameter "stepId" when calling patchLearningAssignmentStep';
|
|
36394
|
+
}
|
|
36395
|
+
|
|
36396
|
+
return this.apiClient.callApi(
|
|
36397
|
+
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
36398
|
+
'PATCH',
|
|
36399
|
+
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
36400
|
+
{ },
|
|
36401
|
+
{ },
|
|
36402
|
+
{ },
|
|
36403
|
+
opts['body'],
|
|
36404
|
+
['PureCloud OAuth'],
|
|
36405
|
+
['application/json'],
|
|
36406
|
+
['application/json']
|
|
36407
|
+
);
|
|
36408
|
+
}
|
|
36409
|
+
|
|
36121
36410
|
/**
|
|
36122
36411
|
* Update an external assignment for a specific user
|
|
36123
36412
|
*
|
|
@@ -36469,6 +36758,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36469
36758
|
);
|
|
36470
36759
|
}
|
|
36471
36760
|
|
|
36761
|
+
/**
|
|
36762
|
+
* Create a SCORM package upload request
|
|
36763
|
+
*
|
|
36764
|
+
* @param {Object} opts Optional parameters
|
|
36765
|
+
* @param {Object} opts.body The SCORM package to be uploaded
|
|
36766
|
+
*/
|
|
36767
|
+
postLearningScorm(opts) {
|
|
36768
|
+
opts = opts || {};
|
|
36769
|
+
|
|
36770
|
+
|
|
36771
|
+
return this.apiClient.callApi(
|
|
36772
|
+
'/api/v2/learning/scorm',
|
|
36773
|
+
'POST',
|
|
36774
|
+
{ },
|
|
36775
|
+
{ },
|
|
36776
|
+
{ },
|
|
36777
|
+
{ },
|
|
36778
|
+
opts['body'],
|
|
36779
|
+
['PureCloud OAuth'],
|
|
36780
|
+
['application/json'],
|
|
36781
|
+
['application/json']
|
|
36782
|
+
);
|
|
36783
|
+
}
|
|
36784
|
+
|
|
36472
36785
|
/**
|
|
36473
36786
|
* Update a learning module
|
|
36474
36787
|
* This will update the name, description, completion time in days and inform steps for a learning module
|
|
@@ -36499,6 +36812,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36499
36812
|
);
|
|
36500
36813
|
}
|
|
36501
36814
|
|
|
36815
|
+
/**
|
|
36816
|
+
* Update a learning module preview
|
|
36817
|
+
* This will update a learning module preview
|
|
36818
|
+
* @param {String} moduleId The ID of the learning module
|
|
36819
|
+
* @param {Object} body The learning module to be updated
|
|
36820
|
+
*/
|
|
36821
|
+
putLearningModulePreview(moduleId, body) {
|
|
36822
|
+
// verify the required parameter 'moduleId' is set
|
|
36823
|
+
if (moduleId === undefined || moduleId === null) {
|
|
36824
|
+
throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview';
|
|
36825
|
+
}
|
|
36826
|
+
// verify the required parameter 'body' is set
|
|
36827
|
+
if (body === undefined || body === null) {
|
|
36828
|
+
throw 'Missing the required parameter "body" when calling putLearningModulePreview';
|
|
36829
|
+
}
|
|
36830
|
+
|
|
36831
|
+
return this.apiClient.callApi(
|
|
36832
|
+
'/api/v2/learning/modules/{moduleId}/preview',
|
|
36833
|
+
'PUT',
|
|
36834
|
+
{ 'moduleId': moduleId },
|
|
36835
|
+
{ },
|
|
36836
|
+
{ },
|
|
36837
|
+
{ },
|
|
36838
|
+
body,
|
|
36839
|
+
['PureCloud OAuth'],
|
|
36840
|
+
['application/json'],
|
|
36841
|
+
['application/json']
|
|
36842
|
+
);
|
|
36843
|
+
}
|
|
36844
|
+
|
|
36502
36845
|
/**
|
|
36503
36846
|
* Update a learning module rule
|
|
36504
36847
|
* This will update a learning module rule with the specified fields.
|
|
@@ -36535,7 +36878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36535
36878
|
/**
|
|
36536
36879
|
* License service.
|
|
36537
36880
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36538
|
-
* @version
|
|
36881
|
+
* @version 196.0.0
|
|
36539
36882
|
*/
|
|
36540
36883
|
|
|
36541
36884
|
/**
|
|
@@ -36773,7 +37116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36773
37116
|
/**
|
|
36774
37117
|
* Locations service.
|
|
36775
37118
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
36776
|
-
* @version
|
|
37119
|
+
* @version 196.0.0
|
|
36777
37120
|
*/
|
|
36778
37121
|
|
|
36779
37122
|
/**
|
|
@@ -37009,7 +37352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37009
37352
|
/**
|
|
37010
37353
|
* LogCapture service.
|
|
37011
37354
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37012
|
-
* @version
|
|
37355
|
+
* @version 196.0.0
|
|
37013
37356
|
*/
|
|
37014
37357
|
|
|
37015
37358
|
/**
|
|
@@ -37209,7 +37552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37209
37552
|
/**
|
|
37210
37553
|
* Messaging service.
|
|
37211
37554
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37212
|
-
* @version
|
|
37555
|
+
* @version 196.0.0
|
|
37213
37556
|
*/
|
|
37214
37557
|
|
|
37215
37558
|
/**
|
|
@@ -37568,7 +37911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37568
37911
|
/**
|
|
37569
37912
|
* MobileDevices service.
|
|
37570
37913
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37571
|
-
* @version
|
|
37914
|
+
* @version 196.0.0
|
|
37572
37915
|
*/
|
|
37573
37916
|
|
|
37574
37917
|
/**
|
|
@@ -37719,7 +38062,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37719
38062
|
/**
|
|
37720
38063
|
* Notifications service.
|
|
37721
38064
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
37722
|
-
* @version
|
|
38065
|
+
* @version 196.0.0
|
|
37723
38066
|
*/
|
|
37724
38067
|
|
|
37725
38068
|
/**
|
|
@@ -37952,7 +38295,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37952
38295
|
/**
|
|
37953
38296
|
* OAuth service.
|
|
37954
38297
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
37955
|
-
* @version
|
|
38298
|
+
* @version 196.0.0
|
|
37956
38299
|
*/
|
|
37957
38300
|
|
|
37958
38301
|
/**
|
|
@@ -38318,7 +38661,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38318
38661
|
/**
|
|
38319
38662
|
* Objects service.
|
|
38320
38663
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38321
|
-
* @version
|
|
38664
|
+
* @version 196.0.0
|
|
38322
38665
|
*/
|
|
38323
38666
|
|
|
38324
38667
|
/**
|
|
@@ -38588,7 +38931,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38588
38931
|
/**
|
|
38589
38932
|
* OperationalEvents service.
|
|
38590
38933
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38591
|
-
* @version
|
|
38934
|
+
* @version 196.0.0
|
|
38592
38935
|
*/
|
|
38593
38936
|
|
|
38594
38937
|
/**
|
|
@@ -38654,7 +38997,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38654
38997
|
/**
|
|
38655
38998
|
* Organization service.
|
|
38656
38999
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38657
|
-
* @version
|
|
39000
|
+
* @version 196.0.0
|
|
38658
39001
|
*/
|
|
38659
39002
|
|
|
38660
39003
|
/**
|
|
@@ -39129,7 +39472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39129
39472
|
/**
|
|
39130
39473
|
* OrganizationAuthorization service.
|
|
39131
39474
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39132
|
-
* @version
|
|
39475
|
+
* @version 196.0.0
|
|
39133
39476
|
*/
|
|
39134
39477
|
|
|
39135
39478
|
/**
|
|
@@ -40476,7 +40819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40476
40819
|
/**
|
|
40477
40820
|
* Outbound service.
|
|
40478
40821
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40479
|
-
* @version
|
|
40822
|
+
* @version 196.0.0
|
|
40480
40823
|
*/
|
|
40481
40824
|
|
|
40482
40825
|
/**
|
|
@@ -44842,7 +45185,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44842
45185
|
/**
|
|
44843
45186
|
* Presence service.
|
|
44844
45187
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
44845
|
-
* @version
|
|
45188
|
+
* @version 196.0.0
|
|
44846
45189
|
*/
|
|
44847
45190
|
|
|
44848
45191
|
/**
|
|
@@ -45586,7 +45929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45586
45929
|
/**
|
|
45587
45930
|
* ProcessAutomation service.
|
|
45588
45931
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45589
|
-
* @version
|
|
45932
|
+
* @version 196.0.0
|
|
45590
45933
|
*/
|
|
45591
45934
|
|
|
45592
45935
|
/**
|
|
@@ -45825,7 +46168,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45825
46168
|
/**
|
|
45826
46169
|
* Quality service.
|
|
45827
46170
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
45828
|
-
* @version
|
|
46171
|
+
* @version 196.0.0
|
|
45829
46172
|
*/
|
|
45830
46173
|
|
|
45831
46174
|
/**
|
|
@@ -46317,9 +46660,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46317
46660
|
* @param {Object} opts Optional parameters
|
|
46318
46661
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46319
46662
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
46320
|
-
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
46321
46663
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
46322
|
-
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
46323
46664
|
* @param {String} opts.previousPage Previous page token
|
|
46324
46665
|
* @param {String} opts.conversationId conversationId specified
|
|
46325
46666
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -46345,7 +46686,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46345
46686
|
'/api/v2/quality/evaluations/query',
|
|
46346
46687
|
'GET',
|
|
46347
46688
|
{ },
|
|
46348
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
46689
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
46349
46690
|
{ },
|
|
46350
46691
|
{ },
|
|
46351
46692
|
null,
|
|
@@ -47582,7 +47923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47582
47923
|
/**
|
|
47583
47924
|
* Recording service.
|
|
47584
47925
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47585
|
-
* @version
|
|
47926
|
+
* @version 196.0.0
|
|
47586
47927
|
*/
|
|
47587
47928
|
|
|
47588
47929
|
/**
|
|
@@ -49240,7 +49581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49240
49581
|
/**
|
|
49241
49582
|
* ResponseManagement service.
|
|
49242
49583
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49243
|
-
* @version
|
|
49584
|
+
* @version 196.0.0
|
|
49244
49585
|
*/
|
|
49245
49586
|
|
|
49246
49587
|
/**
|
|
@@ -49750,7 +50091,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49750
50091
|
/**
|
|
49751
50092
|
* Routing service.
|
|
49752
50093
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
49753
|
-
* @version
|
|
50094
|
+
* @version 196.0.0
|
|
49754
50095
|
*/
|
|
49755
50096
|
|
|
49756
50097
|
/**
|
|
@@ -50211,7 +50552,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50211
50552
|
* @param {String} labelId Utilization Label ID
|
|
50212
50553
|
* @param {Object} opts Optional parameters
|
|
50213
50554
|
* @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
50555
|
*/
|
|
50216
50556
|
deleteRoutingUtilizationLabel(labelId, opts) {
|
|
50217
50557
|
opts = opts || {};
|
|
@@ -51730,7 +52070,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51730
52070
|
* Get details about this utilization label
|
|
51731
52071
|
*
|
|
51732
52072
|
* @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
52073
|
*/
|
|
51735
52074
|
getRoutingUtilizationLabel(labelId) {
|
|
51736
52075
|
// verify the required parameter 'labelId' is set
|
|
@@ -51756,7 +52095,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51756
52095
|
* Get list of agent ids associated with a utilization label
|
|
51757
52096
|
*
|
|
51758
52097
|
* @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
52098
|
*/
|
|
51761
52099
|
getRoutingUtilizationLabelAgents(labelId) {
|
|
51762
52100
|
// verify the required parameter 'labelId' is set
|
|
@@ -51786,7 +52124,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51786
52124
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
51787
52125
|
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
51788
52126
|
* @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
52127
|
*/
|
|
51791
52128
|
getRoutingUtilizationLabels(opts) {
|
|
51792
52129
|
opts = opts || {};
|
|
@@ -53209,7 +53546,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53209
53546
|
* Create a utilization label
|
|
53210
53547
|
*
|
|
53211
53548
|
* @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
53549
|
*/
|
|
53214
53550
|
postRoutingUtilizationLabels(body) {
|
|
53215
53551
|
// verify the required parameter 'body' is set
|
|
@@ -53602,7 +53938,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53602
53938
|
*
|
|
53603
53939
|
* @param {String} labelId Utilization Label ID
|
|
53604
53940
|
* @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
53941
|
*/
|
|
53607
53942
|
putRoutingUtilizationLabel(labelId, body) {
|
|
53608
53943
|
// verify the required parameter 'labelId' is set
|
|
@@ -53729,7 +54064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53729
54064
|
/**
|
|
53730
54065
|
* SCIM service.
|
|
53731
54066
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
53732
|
-
* @version
|
|
54067
|
+
* @version 196.0.0
|
|
53733
54068
|
*/
|
|
53734
54069
|
|
|
53735
54070
|
/**
|
|
@@ -54606,7 +54941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54606
54941
|
/**
|
|
54607
54942
|
* ScreenRecording service.
|
|
54608
54943
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54609
|
-
* @version
|
|
54944
|
+
* @version 196.0.0
|
|
54610
54945
|
*/
|
|
54611
54946
|
|
|
54612
54947
|
/**
|
|
@@ -54651,7 +54986,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54651
54986
|
/**
|
|
54652
54987
|
* Scripts service.
|
|
54653
54988
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54654
|
-
* @version
|
|
54989
|
+
* @version 196.0.0
|
|
54655
54990
|
*/
|
|
54656
54991
|
|
|
54657
54992
|
/**
|
|
@@ -55095,7 +55430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55095
55430
|
/**
|
|
55096
55431
|
* Search service.
|
|
55097
55432
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55098
|
-
* @version
|
|
55433
|
+
* @version 196.0.0
|
|
55099
55434
|
*/
|
|
55100
55435
|
|
|
55101
55436
|
/**
|
|
@@ -55784,7 +56119,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55784
56119
|
/**
|
|
55785
56120
|
* Settings service.
|
|
55786
56121
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
55787
|
-
* @version
|
|
56122
|
+
* @version 196.0.0
|
|
55788
56123
|
*/
|
|
55789
56124
|
|
|
55790
56125
|
/**
|
|
@@ -55896,7 +56231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55896
56231
|
/**
|
|
55897
56232
|
* SpeechTextAnalytics service.
|
|
55898
56233
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
55899
|
-
* @version
|
|
56234
|
+
* @version 196.0.0
|
|
55900
56235
|
*/
|
|
55901
56236
|
|
|
55902
56237
|
/**
|
|
@@ -55911,6 +56246,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55911
56246
|
}
|
|
55912
56247
|
|
|
55913
56248
|
|
|
56249
|
+
/**
|
|
56250
|
+
* Delete a Speech and Text Analytics category by ID
|
|
56251
|
+
*
|
|
56252
|
+
* @param {String} categoryId The id of the category
|
|
56253
|
+
*/
|
|
56254
|
+
deleteSpeechandtextanalyticsCategory(categoryId) {
|
|
56255
|
+
// verify the required parameter 'categoryId' is set
|
|
56256
|
+
if (categoryId === undefined || categoryId === null) {
|
|
56257
|
+
throw 'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory';
|
|
56258
|
+
}
|
|
56259
|
+
|
|
56260
|
+
return this.apiClient.callApi(
|
|
56261
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
56262
|
+
'DELETE',
|
|
56263
|
+
{ 'categoryId': categoryId },
|
|
56264
|
+
{ },
|
|
56265
|
+
{ },
|
|
56266
|
+
{ },
|
|
56267
|
+
null,
|
|
56268
|
+
['PureCloud OAuth'],
|
|
56269
|
+
['application/json'],
|
|
56270
|
+
['application/json']
|
|
56271
|
+
);
|
|
56272
|
+
}
|
|
56273
|
+
|
|
55914
56274
|
/**
|
|
55915
56275
|
* Delete a Speech and Text Analytics DictionaryFeedback by Id
|
|
55916
56276
|
*
|
|
@@ -56035,6 +56395,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56035
56395
|
);
|
|
56036
56396
|
}
|
|
56037
56397
|
|
|
56398
|
+
/**
|
|
56399
|
+
* Get the list of Speech and Text Analytics categories
|
|
56400
|
+
*
|
|
56401
|
+
* @param {Object} opts Optional parameters
|
|
56402
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
|
|
56403
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
56404
|
+
* @param {String} opts.name The category name filter applied to the listing
|
|
56405
|
+
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
56406
|
+
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
56407
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
56408
|
+
*/
|
|
56409
|
+
getSpeechandtextanalyticsCategories(opts) {
|
|
56410
|
+
opts = opts || {};
|
|
56411
|
+
|
|
56412
|
+
|
|
56413
|
+
return this.apiClient.callApi(
|
|
56414
|
+
'/api/v2/speechandtextanalytics/categories',
|
|
56415
|
+
'GET',
|
|
56416
|
+
{ },
|
|
56417
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') },
|
|
56418
|
+
{ },
|
|
56419
|
+
{ },
|
|
56420
|
+
null,
|
|
56421
|
+
['PureCloud OAuth'],
|
|
56422
|
+
['application/json'],
|
|
56423
|
+
['application/json']
|
|
56424
|
+
);
|
|
56425
|
+
}
|
|
56426
|
+
|
|
56427
|
+
/**
|
|
56428
|
+
* Get a Speech and Text Analytics Category by ID
|
|
56429
|
+
*
|
|
56430
|
+
* @param {String} categoryId The id of the category
|
|
56431
|
+
*/
|
|
56432
|
+
getSpeechandtextanalyticsCategory(categoryId) {
|
|
56433
|
+
// verify the required parameter 'categoryId' is set
|
|
56434
|
+
if (categoryId === undefined || categoryId === null) {
|
|
56435
|
+
throw 'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory';
|
|
56436
|
+
}
|
|
56437
|
+
|
|
56438
|
+
return this.apiClient.callApi(
|
|
56439
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
56440
|
+
'GET',
|
|
56441
|
+
{ 'categoryId': categoryId },
|
|
56442
|
+
{ },
|
|
56443
|
+
{ },
|
|
56444
|
+
{ },
|
|
56445
|
+
null,
|
|
56446
|
+
['PureCloud OAuth'],
|
|
56447
|
+
['application/json'],
|
|
56448
|
+
['application/json']
|
|
56449
|
+
);
|
|
56450
|
+
}
|
|
56451
|
+
|
|
56038
56452
|
/**
|
|
56039
56453
|
* Get Speech and Text Analytics for a specific conversation
|
|
56040
56454
|
*
|
|
@@ -56060,6 +56474,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56060
56474
|
);
|
|
56061
56475
|
}
|
|
56062
56476
|
|
|
56477
|
+
/**
|
|
56478
|
+
* Get the list of detected Speech and Text Analytics categories of conversation
|
|
56479
|
+
*
|
|
56480
|
+
* @param {String} conversationId The id of the conversation
|
|
56481
|
+
* @param {Object} opts Optional parameters
|
|
56482
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25)
|
|
56483
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
56484
|
+
*/
|
|
56485
|
+
getSpeechandtextanalyticsConversationCategories(conversationId, opts) {
|
|
56486
|
+
opts = opts || {};
|
|
56487
|
+
|
|
56488
|
+
// verify the required parameter 'conversationId' is set
|
|
56489
|
+
if (conversationId === undefined || conversationId === null) {
|
|
56490
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories';
|
|
56491
|
+
}
|
|
56492
|
+
|
|
56493
|
+
return this.apiClient.callApi(
|
|
56494
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/categories',
|
|
56495
|
+
'GET',
|
|
56496
|
+
{ 'conversationId': conversationId },
|
|
56497
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
56498
|
+
{ },
|
|
56499
|
+
{ },
|
|
56500
|
+
null,
|
|
56501
|
+
['PureCloud OAuth'],
|
|
56502
|
+
['application/json'],
|
|
56503
|
+
['application/json']
|
|
56504
|
+
);
|
|
56505
|
+
}
|
|
56506
|
+
|
|
56063
56507
|
/**
|
|
56064
56508
|
* Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
|
56065
56509
|
*
|
|
@@ -56630,6 +57074,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56630
57074
|
);
|
|
56631
57075
|
}
|
|
56632
57076
|
|
|
57077
|
+
/**
|
|
57078
|
+
* Create new Speech and Text Analytics category
|
|
57079
|
+
*
|
|
57080
|
+
* @param {Object} body The category to create
|
|
57081
|
+
*/
|
|
57082
|
+
postSpeechandtextanalyticsCategories(body) {
|
|
57083
|
+
// verify the required parameter 'body' is set
|
|
57084
|
+
if (body === undefined || body === null) {
|
|
57085
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories';
|
|
57086
|
+
}
|
|
57087
|
+
|
|
57088
|
+
return this.apiClient.callApi(
|
|
57089
|
+
'/api/v2/speechandtextanalytics/categories',
|
|
57090
|
+
'POST',
|
|
57091
|
+
{ },
|
|
57092
|
+
{ },
|
|
57093
|
+
{ },
|
|
57094
|
+
{ },
|
|
57095
|
+
body,
|
|
57096
|
+
['PureCloud OAuth'],
|
|
57097
|
+
['application/json'],
|
|
57098
|
+
['application/json']
|
|
57099
|
+
);
|
|
57100
|
+
}
|
|
57101
|
+
|
|
56633
57102
|
/**
|
|
56634
57103
|
* Create a Speech and Text Analytics DictionaryFeedback
|
|
56635
57104
|
*
|
|
@@ -56830,6 +57299,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56830
57299
|
);
|
|
56831
57300
|
}
|
|
56832
57301
|
|
|
57302
|
+
/**
|
|
57303
|
+
* Update a Speech and Text Analytics category by ID
|
|
57304
|
+
*
|
|
57305
|
+
* @param {String} categoryId The id of the category
|
|
57306
|
+
* @param {Object} body The updated category
|
|
57307
|
+
*/
|
|
57308
|
+
putSpeechandtextanalyticsCategory(categoryId, body) {
|
|
57309
|
+
// verify the required parameter 'categoryId' is set
|
|
57310
|
+
if (categoryId === undefined || categoryId === null) {
|
|
57311
|
+
throw 'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory';
|
|
57312
|
+
}
|
|
57313
|
+
// verify the required parameter 'body' is set
|
|
57314
|
+
if (body === undefined || body === null) {
|
|
57315
|
+
throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory';
|
|
57316
|
+
}
|
|
57317
|
+
|
|
57318
|
+
return this.apiClient.callApi(
|
|
57319
|
+
'/api/v2/speechandtextanalytics/categories/{categoryId}',
|
|
57320
|
+
'PUT',
|
|
57321
|
+
{ 'categoryId': categoryId },
|
|
57322
|
+
{ },
|
|
57323
|
+
{ },
|
|
57324
|
+
{ },
|
|
57325
|
+
body,
|
|
57326
|
+
['PureCloud OAuth'],
|
|
57327
|
+
['application/json'],
|
|
57328
|
+
['application/json']
|
|
57329
|
+
);
|
|
57330
|
+
}
|
|
57331
|
+
|
|
56833
57332
|
/**
|
|
56834
57333
|
* Update existing Speech and Text Analytics dictionary feedback by id
|
|
56835
57334
|
*
|
|
@@ -57010,7 +57509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57010
57509
|
/**
|
|
57011
57510
|
* Stations service.
|
|
57012
57511
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57013
|
-
* @version
|
|
57512
|
+
* @version 196.0.0
|
|
57014
57513
|
*/
|
|
57015
57514
|
|
|
57016
57515
|
/**
|
|
@@ -57112,7 +57611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57112
57611
|
/**
|
|
57113
57612
|
* Suggest service.
|
|
57114
57613
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57115
|
-
* @version
|
|
57614
|
+
* @version 196.0.0
|
|
57116
57615
|
*/
|
|
57117
57616
|
|
|
57118
57617
|
/**
|
|
@@ -57251,7 +57750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57251
57750
|
/**
|
|
57252
57751
|
* TaskManagement service.
|
|
57253
57752
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57254
|
-
* @version
|
|
57753
|
+
* @version 196.0.0
|
|
57255
57754
|
*/
|
|
57256
57755
|
|
|
57257
57756
|
/**
|
|
@@ -58599,7 +59098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58599
59098
|
/**
|
|
58600
59099
|
* Teams service.
|
|
58601
59100
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
58602
|
-
* @version
|
|
59101
|
+
* @version 196.0.0
|
|
58603
59102
|
*/
|
|
58604
59103
|
|
|
58605
59104
|
/**
|
|
@@ -58900,7 +59399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58900
59399
|
/**
|
|
58901
59400
|
* Telephony service.
|
|
58902
59401
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
58903
|
-
* @version
|
|
59402
|
+
* @version 196.0.0
|
|
58904
59403
|
*/
|
|
58905
59404
|
|
|
58906
59405
|
/**
|
|
@@ -59082,7 +59581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59082
59581
|
/**
|
|
59083
59582
|
* TelephonyProvidersEdge service.
|
|
59084
59583
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59085
|
-
* @version
|
|
59584
|
+
* @version 196.0.0
|
|
59086
59585
|
*/
|
|
59087
59586
|
|
|
59088
59587
|
/**
|
|
@@ -62410,7 +62909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62410
62909
|
/**
|
|
62411
62910
|
* Textbots service.
|
|
62412
62911
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62413
|
-
* @version
|
|
62912
|
+
* @version 196.0.0
|
|
62414
62913
|
*/
|
|
62415
62914
|
|
|
62416
62915
|
/**
|
|
@@ -62538,7 +63037,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62538
63037
|
/**
|
|
62539
63038
|
* Tokens service.
|
|
62540
63039
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
62541
|
-
* @version
|
|
63040
|
+
* @version 196.0.0
|
|
62542
63041
|
*/
|
|
62543
63042
|
|
|
62544
63043
|
/**
|
|
@@ -62692,7 +63191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62692
63191
|
/**
|
|
62693
63192
|
* Uploads service.
|
|
62694
63193
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
62695
|
-
* @version
|
|
63194
|
+
* @version 196.0.0
|
|
62696
63195
|
*/
|
|
62697
63196
|
|
|
62698
63197
|
/**
|
|
@@ -62961,7 +63460,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62961
63460
|
/**
|
|
62962
63461
|
* Usage service.
|
|
62963
63462
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
62964
|
-
* @version
|
|
63463
|
+
* @version 196.0.0
|
|
62965
63464
|
*/
|
|
62966
63465
|
|
|
62967
63466
|
/**
|
|
@@ -63176,7 +63675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63176
63675
|
/**
|
|
63177
63676
|
* UserRecordings service.
|
|
63178
63677
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63179
|
-
* @version
|
|
63678
|
+
* @version 196.0.0
|
|
63180
63679
|
*/
|
|
63181
63680
|
|
|
63182
63681
|
/**
|
|
@@ -63361,7 +63860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63361
63860
|
/**
|
|
63362
63861
|
* Users service.
|
|
63363
63862
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63364
|
-
* @version
|
|
63863
|
+
* @version 196.0.0
|
|
63365
63864
|
*/
|
|
63366
63865
|
|
|
63367
63866
|
/**
|
|
@@ -66019,7 +66518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66019
66518
|
/**
|
|
66020
66519
|
* Utilities service.
|
|
66021
66520
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66022
|
-
* @version
|
|
66521
|
+
* @version 196.0.0
|
|
66023
66522
|
*/
|
|
66024
66523
|
|
|
66025
66524
|
/**
|
|
@@ -66130,7 +66629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66130
66629
|
/**
|
|
66131
66630
|
* Voicemail service.
|
|
66132
66631
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66133
|
-
* @version
|
|
66632
|
+
* @version 196.0.0
|
|
66134
66633
|
*/
|
|
66135
66634
|
|
|
66136
66635
|
/**
|
|
@@ -66797,7 +67296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66797
67296
|
/**
|
|
66798
67297
|
* WebChat service.
|
|
66799
67298
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
66800
|
-
* @version
|
|
67299
|
+
* @version 196.0.0
|
|
66801
67300
|
*/
|
|
66802
67301
|
|
|
66803
67302
|
/**
|
|
@@ -67348,7 +67847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67348
67847
|
/**
|
|
67349
67848
|
* WebDeployments service.
|
|
67350
67849
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67351
|
-
* @version
|
|
67850
|
+
* @version 196.0.0
|
|
67352
67851
|
*/
|
|
67353
67852
|
|
|
67354
67853
|
/**
|
|
@@ -67875,7 +68374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67875
68374
|
/**
|
|
67876
68375
|
* WebMessaging service.
|
|
67877
68376
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
67878
|
-
* @version
|
|
68377
|
+
* @version 196.0.0
|
|
67879
68378
|
*/
|
|
67880
68379
|
|
|
67881
68380
|
/**
|
|
@@ -67921,7 +68420,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67921
68420
|
/**
|
|
67922
68421
|
* Widgets service.
|
|
67923
68422
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
67924
|
-
* @version
|
|
68423
|
+
* @version 196.0.0
|
|
67925
68424
|
*/
|
|
67926
68425
|
|
|
67927
68426
|
/**
|
|
@@ -68067,7 +68566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68067
68566
|
/**
|
|
68068
68567
|
* WorkforceManagement service.
|
|
68069
68568
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68070
|
-
* @version
|
|
68569
|
+
* @version 196.0.0
|
|
68071
68570
|
*/
|
|
68072
68571
|
|
|
68073
68572
|
/**
|
|
@@ -73980,7 +74479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73980
74479
|
* </pre>
|
|
73981
74480
|
* </p>
|
|
73982
74481
|
* @module purecloud-platform-client-v2/index
|
|
73983
|
-
* @version
|
|
74482
|
+
* @version 196.0.0
|
|
73984
74483
|
*/
|
|
73985
74484
|
class platformClient {
|
|
73986
74485
|
constructor() {
|