purecloud-platform-client-v2 186.0.1 → 188.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 +1047 -185
- package/dist/web-amd/purecloud-platform-client-v2.js +1047 -185
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +367 -151
- package/dist/web-cjs/purecloud-platform-client-v2.js +455 -196
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +899 -240
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +26 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +27 -8
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -2
- 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 +4 -22
- 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 +40 -12
- 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 +106 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +136 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -34
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +263 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +3 -2
- 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 +219 -4
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -6
- 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 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +50 -0
- 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 +3 -2
- 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 -27
- 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 +94 -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 +7 -1
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 188.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1818,7 +1818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1818
1818
|
/**
|
|
1819
1819
|
* Alerting service.
|
|
1820
1820
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1821
|
-
* @version
|
|
1821
|
+
* @version 188.0.0
|
|
1822
1822
|
*/
|
|
1823
1823
|
|
|
1824
1824
|
/**
|
|
@@ -2479,7 +2479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2479
2479
|
/**
|
|
2480
2480
|
* Analytics service.
|
|
2481
2481
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2482
|
-
* @version
|
|
2482
|
+
* @version 188.0.0
|
|
2483
2483
|
*/
|
|
2484
2484
|
|
|
2485
2485
|
/**
|
|
@@ -4274,7 +4274,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4274
4274
|
* Query for flow execution aggregates
|
|
4275
4275
|
*
|
|
4276
4276
|
* @param {Object} body query
|
|
4277
|
-
* postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4278
4277
|
*/
|
|
4279
4278
|
postAnalyticsFlowexecutionsAggregatesQuery(body) {
|
|
4280
4279
|
// verify the required parameter 'body' is set
|
|
@@ -4531,6 +4530,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4531
4530
|
);
|
|
4532
4531
|
}
|
|
4533
4532
|
|
|
4533
|
+
/**
|
|
4534
|
+
* Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded
|
|
4535
|
+
*
|
|
4536
|
+
* @param {Object} body query
|
|
4537
|
+
*/
|
|
4538
|
+
postAnalyticsRatelimitsAggregatesQuery(body) {
|
|
4539
|
+
// verify the required parameter 'body' is set
|
|
4540
|
+
if (body === undefined || body === null) {
|
|
4541
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';
|
|
4542
|
+
}
|
|
4543
|
+
|
|
4544
|
+
return this.apiClient.callApi(
|
|
4545
|
+
'/api/v2/analytics/ratelimits/aggregates/query',
|
|
4546
|
+
'POST',
|
|
4547
|
+
{ },
|
|
4548
|
+
{ },
|
|
4549
|
+
{ },
|
|
4550
|
+
{ },
|
|
4551
|
+
body,
|
|
4552
|
+
['PureCloud OAuth'],
|
|
4553
|
+
['application/json'],
|
|
4554
|
+
['application/json']
|
|
4555
|
+
);
|
|
4556
|
+
}
|
|
4557
|
+
|
|
4534
4558
|
/**
|
|
4535
4559
|
* Generate a view export request
|
|
4536
4560
|
* This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
|
|
@@ -5069,7 +5093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5069
5093
|
/**
|
|
5070
5094
|
* Architect service.
|
|
5071
5095
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5072
|
-
* @version
|
|
5096
|
+
* @version 188.0.0
|
|
5073
5097
|
*/
|
|
5074
5098
|
|
|
5075
5099
|
/**
|
|
@@ -6125,8 +6149,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6125
6149
|
* Get specified user prompt
|
|
6126
6150
|
*
|
|
6127
6151
|
* @param {String} promptId Prompt ID
|
|
6152
|
+
* @param {Object} opts Optional parameters
|
|
6153
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6154
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6155
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6128
6156
|
*/
|
|
6129
|
-
getArchitectPrompt(promptId) {
|
|
6157
|
+
getArchitectPrompt(promptId, opts) {
|
|
6158
|
+
opts = opts || {};
|
|
6159
|
+
|
|
6130
6160
|
// verify the required parameter 'promptId' is set
|
|
6131
6161
|
if (promptId === undefined || promptId === null) {
|
|
6132
6162
|
throw 'Missing the required parameter "promptId" when calling getArchitectPrompt';
|
|
@@ -6136,7 +6166,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6136
6166
|
'/api/v2/architect/prompts/{promptId}',
|
|
6137
6167
|
'GET',
|
|
6138
6168
|
{ 'promptId': promptId },
|
|
6139
|
-
{
|
|
6169
|
+
{ 'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6140
6170
|
{ },
|
|
6141
6171
|
{ },
|
|
6142
6172
|
null,
|
|
@@ -6255,6 +6285,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6255
6285
|
* @param {String} opts.nameOrDescription Name or description
|
|
6256
6286
|
* @param {String} opts.sortBy Sort by (default to id)
|
|
6257
6287
|
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
6288
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6289
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6290
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6258
6291
|
*/
|
|
6259
6292
|
getArchitectPrompts(opts) {
|
|
6260
6293
|
opts = opts || {};
|
|
@@ -6264,7 +6297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6264
6297
|
'/api/v2/architect/prompts',
|
|
6265
6298
|
'GET',
|
|
6266
6299
|
{ },
|
|
6267
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': this.apiClient.buildCollectionParam(opts['name'], 'multi'),'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
6300
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': this.apiClient.buildCollectionParam(opts['name'], 'multi'),'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6268
6301
|
{ },
|
|
6269
6302
|
{ },
|
|
6270
6303
|
null,
|
|
@@ -6447,8 +6480,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6447
6480
|
* Get a system prompt
|
|
6448
6481
|
*
|
|
6449
6482
|
* @param {String} promptId promptId
|
|
6483
|
+
* @param {Object} opts Optional parameters
|
|
6484
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6485
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6486
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6450
6487
|
*/
|
|
6451
|
-
getArchitectSystemprompt(promptId) {
|
|
6488
|
+
getArchitectSystemprompt(promptId, opts) {
|
|
6489
|
+
opts = opts || {};
|
|
6490
|
+
|
|
6452
6491
|
// verify the required parameter 'promptId' is set
|
|
6453
6492
|
if (promptId === undefined || promptId === null) {
|
|
6454
6493
|
throw 'Missing the required parameter "promptId" when calling getArchitectSystemprompt';
|
|
@@ -6458,7 +6497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6458
6497
|
'/api/v2/architect/systemprompts/{promptId}',
|
|
6459
6498
|
'GET',
|
|
6460
6499
|
{ 'promptId': promptId },
|
|
6461
|
-
{
|
|
6500
|
+
{ 'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6462
6501
|
{ },
|
|
6463
6502
|
{ },
|
|
6464
6503
|
null,
|
|
@@ -6579,6 +6618,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6579
6618
|
* @param {String} opts.name Name
|
|
6580
6619
|
* @param {String} opts.description Description
|
|
6581
6620
|
* @param {String} opts.nameOrDescription Name or description
|
|
6621
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
6622
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
6623
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
6582
6624
|
*/
|
|
6583
6625
|
getArchitectSystemprompts(opts) {
|
|
6584
6626
|
opts = opts || {};
|
|
@@ -6588,7 +6630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6588
6630
|
'/api/v2/architect/systemprompts',
|
|
6589
6631
|
'GET',
|
|
6590
6632
|
{ },
|
|
6591
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'] },
|
|
6633
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
6592
6634
|
{ },
|
|
6593
6635
|
{ },
|
|
6594
6636
|
null,
|
|
@@ -8430,6 +8472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8430
8472
|
* @param {Object} body query
|
|
8431
8473
|
* @param {Object} opts Optional parameters
|
|
8432
8474
|
* @param {Boolean} opts.indexOnly indexes only
|
|
8475
|
+
* @param {Number} opts.pageSize number of results to return (default to 50)
|
|
8433
8476
|
* postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8434
8477
|
*/
|
|
8435
8478
|
postFlowsInstancesQuery(body, opts) {
|
|
@@ -8444,7 +8487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8444
8487
|
'/api/v2/flows/instances/query',
|
|
8445
8488
|
'POST',
|
|
8446
8489
|
{ },
|
|
8447
|
-
{ 'indexOnly': opts['indexOnly'] },
|
|
8490
|
+
{ 'indexOnly': opts['indexOnly'],'pageSize': opts['pageSize'] },
|
|
8448
8491
|
{ },
|
|
8449
8492
|
{ },
|
|
8450
8493
|
body,
|
|
@@ -8904,7 +8947,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8904
8947
|
/**
|
|
8905
8948
|
* Audit service.
|
|
8906
8949
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8907
|
-
* @version
|
|
8950
|
+
* @version 188.0.0
|
|
8908
8951
|
*/
|
|
8909
8952
|
|
|
8910
8953
|
/**
|
|
@@ -9075,7 +9118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9075
9118
|
/**
|
|
9076
9119
|
* Authorization service.
|
|
9077
9120
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9078
|
-
* @version
|
|
9121
|
+
* @version 188.0.0
|
|
9079
9122
|
*/
|
|
9080
9123
|
|
|
9081
9124
|
/**
|
|
@@ -9249,6 +9292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9249
9292
|
* @param {String} opts.nextPage next page token
|
|
9250
9293
|
* @param {String} opts.previousPage Previous page token
|
|
9251
9294
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
9295
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
9252
9296
|
* @param {String} opts.name Search term to filter by division name
|
|
9253
9297
|
*/
|
|
9254
9298
|
getAuthorizationDivisions(opts) {
|
|
@@ -9259,7 +9303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9259
9303
|
'/api/v2/authorization/divisions',
|
|
9260
9304
|
'GET',
|
|
9261
9305
|
{ },
|
|
9262
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
9306
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
9263
9307
|
{ },
|
|
9264
9308
|
{ },
|
|
9265
9309
|
null,
|
|
@@ -10304,7 +10348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10304
10348
|
/**
|
|
10305
10349
|
* Billing service.
|
|
10306
10350
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10307
|
-
* @version
|
|
10351
|
+
* @version 188.0.0
|
|
10308
10352
|
*/
|
|
10309
10353
|
|
|
10310
10354
|
/**
|
|
@@ -10384,7 +10428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10384
10428
|
/**
|
|
10385
10429
|
* CarrierServices service.
|
|
10386
10430
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10387
|
-
* @version
|
|
10431
|
+
* @version 188.0.0
|
|
10388
10432
|
*/
|
|
10389
10433
|
|
|
10390
10434
|
/**
|
|
@@ -10454,7 +10498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10454
10498
|
/**
|
|
10455
10499
|
* Chat service.
|
|
10456
10500
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10457
|
-
* @version
|
|
10501
|
+
* @version 188.0.0
|
|
10458
10502
|
*/
|
|
10459
10503
|
|
|
10460
10504
|
/**
|
|
@@ -10681,12 +10725,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10681
10725
|
*
|
|
10682
10726
|
* @param {String} roomJid roomJid
|
|
10683
10727
|
* @param {Object} opts Optional parameters
|
|
10684
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10685
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10686
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
10687
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10688
|
-
* @param {String} opts.nextPage next page token
|
|
10689
|
-
* @param {String} opts.previousPage Previous page token
|
|
10690
10728
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10691
10729
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10692
10730
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -10704,7 +10742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10704
10742
|
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
10705
10743
|
'GET',
|
|
10706
10744
|
{ 'roomJid': roomJid },
|
|
10707
|
-
{ '
|
|
10745
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10708
10746
|
{ },
|
|
10709
10747
|
{ },
|
|
10710
10748
|
null,
|
|
@@ -10739,12 +10777,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10739
10777
|
*
|
|
10740
10778
|
* @param {String} threadId threadId
|
|
10741
10779
|
* @param {Object} opts Optional parameters
|
|
10742
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10743
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10744
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
10745
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10746
|
-
* @param {String} opts.nextPage next page token
|
|
10747
|
-
* @param {String} opts.previousPage Previous page token
|
|
10748
10780
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10749
10781
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10750
10782
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -10762,7 +10794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10762
10794
|
'/api/v2/chats/threads/{threadId}/messages',
|
|
10763
10795
|
'GET',
|
|
10764
10796
|
{ 'threadId': threadId },
|
|
10765
|
-
{ '
|
|
10797
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10766
10798
|
{ },
|
|
10767
10799
|
{ },
|
|
10768
10800
|
null,
|
|
@@ -10808,12 +10840,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10808
10840
|
*
|
|
10809
10841
|
* @param {String} userId userId
|
|
10810
10842
|
* @param {Object} opts Optional parameters
|
|
10811
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
10812
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
10813
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
10814
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
10815
|
-
* @param {String} opts.nextPage next page token
|
|
10816
|
-
* @param {String} opts.previousPage Previous page token
|
|
10817
10843
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
10818
10844
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
10819
10845
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -10831,7 +10857,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10831
10857
|
'/api/v2/chats/users/{userId}/messages',
|
|
10832
10858
|
'GET',
|
|
10833
10859
|
{ 'userId': userId },
|
|
10834
|
-
{ '
|
|
10860
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
10835
10861
|
{ },
|
|
10836
10862
|
{ },
|
|
10837
10863
|
null,
|
|
@@ -11207,7 +11233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11207
11233
|
/**
|
|
11208
11234
|
* Coaching service.
|
|
11209
11235
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11210
|
-
* @version
|
|
11236
|
+
* @version 188.0.0
|
|
11211
11237
|
*/
|
|
11212
11238
|
|
|
11213
11239
|
/**
|
|
@@ -11784,7 +11810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11784
11810
|
/**
|
|
11785
11811
|
* ContentManagement service.
|
|
11786
11812
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11787
|
-
* @version
|
|
11813
|
+
* @version 188.0.0
|
|
11788
11814
|
*/
|
|
11789
11815
|
|
|
11790
11816
|
/**
|
|
@@ -12866,7 +12892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12866
12892
|
/**
|
|
12867
12893
|
* Conversations service.
|
|
12868
12894
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12869
|
-
* @version
|
|
12895
|
+
* @version 188.0.0
|
|
12870
12896
|
*/
|
|
12871
12897
|
|
|
12872
12898
|
/**
|
|
@@ -16942,8 +16968,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16942
16968
|
}
|
|
16943
16969
|
|
|
16944
16970
|
/**
|
|
16945
|
-
* Update
|
|
16946
|
-
*
|
|
16971
|
+
* Update a WhatsApp messaging integration
|
|
16972
|
+
*
|
|
16947
16973
|
* @param {String} integrationId Integration ID
|
|
16948
16974
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
16949
16975
|
*/
|
|
@@ -17433,7 +17459,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17433
17459
|
* @param {String} conversationId conversation ID
|
|
17434
17460
|
* @param {String} participantId participant ID
|
|
17435
17461
|
* @param {Object} body Transfer request
|
|
17436
|
-
* postConversationParticipantReplaceAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17437
17462
|
*/
|
|
17438
17463
|
postConversationParticipantReplaceAgent(conversationId, participantId, body) {
|
|
17439
17464
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17469,7 +17494,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17469
17494
|
* @param {String} conversationId conversation ID
|
|
17470
17495
|
* @param {String} participantId participant ID
|
|
17471
17496
|
* @param {Object} body Transfer request
|
|
17472
|
-
* postConversationParticipantReplaceExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17473
17497
|
*/
|
|
17474
17498
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
17475
17499
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17505,7 +17529,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17505
17529
|
* @param {String} conversationId conversation ID
|
|
17506
17530
|
* @param {String} participantId participant ID
|
|
17507
17531
|
* @param {Object} body Transfer request
|
|
17508
|
-
* postConversationParticipantReplaceQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17509
17532
|
*/
|
|
17510
17533
|
postConversationParticipantReplaceQueue(conversationId, participantId, body) {
|
|
17511
17534
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17569,6 +17592,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17569
17592
|
);
|
|
17570
17593
|
}
|
|
17571
17594
|
|
|
17595
|
+
/**
|
|
17596
|
+
* Submit feedback for the summary.
|
|
17597
|
+
*
|
|
17598
|
+
* @param {String} conversationId Conversation ID
|
|
17599
|
+
* @param {String} summaryId Summary ID
|
|
17600
|
+
* @param {Object} opts Optional parameters
|
|
17601
|
+
* @param {Object} opts.body
|
|
17602
|
+
*/
|
|
17603
|
+
postConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
17604
|
+
opts = opts || {};
|
|
17605
|
+
|
|
17606
|
+
// verify the required parameter 'conversationId' is set
|
|
17607
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17608
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSummaryFeedback';
|
|
17609
|
+
}
|
|
17610
|
+
// verify the required parameter 'summaryId' is set
|
|
17611
|
+
if (summaryId === undefined || summaryId === null) {
|
|
17612
|
+
throw 'Missing the required parameter "summaryId" when calling postConversationSummaryFeedback';
|
|
17613
|
+
}
|
|
17614
|
+
|
|
17615
|
+
return this.apiClient.callApi(
|
|
17616
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback',
|
|
17617
|
+
'POST',
|
|
17618
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
17619
|
+
{ },
|
|
17620
|
+
{ },
|
|
17621
|
+
{ },
|
|
17622
|
+
opts['body'],
|
|
17623
|
+
['PureCloud OAuth'],
|
|
17624
|
+
['application/json'],
|
|
17625
|
+
['application/json']
|
|
17626
|
+
);
|
|
17627
|
+
}
|
|
17628
|
+
|
|
17572
17629
|
/**
|
|
17573
17630
|
* Place a new call as part of a callback conversation.
|
|
17574
17631
|
*
|
|
@@ -17740,7 +17797,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17740
17797
|
* @param {String} conversationId conversationId
|
|
17741
17798
|
* @param {String} participantId participantId
|
|
17742
17799
|
* @param {Object} body Destination agent and initial speak to
|
|
17743
|
-
* postConversationsCallParticipantConsultAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17744
17800
|
*/
|
|
17745
17801
|
postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
|
|
17746
17802
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17776,7 +17832,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17776
17832
|
* @param {String} conversationId conversationId
|
|
17777
17833
|
* @param {String} participantId participantId
|
|
17778
17834
|
* @param {Object} body Destination address and initial speak to
|
|
17779
|
-
* postConversationsCallParticipantConsultExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17780
17835
|
*/
|
|
17781
17836
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
17782
17837
|
// verify the required parameter 'conversationId' is set
|
|
@@ -17812,7 +17867,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17812
17867
|
* @param {String} conversationId conversationId
|
|
17813
17868
|
* @param {String} participantId participantId
|
|
17814
17869
|
* @param {Object} body Destination queue and initial speak to
|
|
17815
|
-
* postConversationsCallParticipantConsultQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17816
17870
|
*/
|
|
17817
17871
|
postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
|
|
17818
17872
|
// verify the required parameter 'conversationId' is set
|
|
@@ -18905,7 +18959,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18905
18959
|
*
|
|
18906
18960
|
* @param {String} conversationId conversationId
|
|
18907
18961
|
* @param {String} participantId participantId
|
|
18908
|
-
* postConversationsMessageParticipantMonitor is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18909
18962
|
*/
|
|
18910
18963
|
postConversationsMessageParticipantMonitor(conversationId, participantId) {
|
|
18911
18964
|
// verify the required parameter 'conversationId' is set
|
|
@@ -19092,9 +19145,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19092
19145
|
}
|
|
19093
19146
|
|
|
19094
19147
|
/**
|
|
19095
|
-
* Create a LINE messenger Integration
|
|
19096
|
-
*
|
|
19148
|
+
* Create a LINE messenger Integration (Deprecated)
|
|
19149
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
19097
19150
|
* @param {Object} body LineIntegrationRequest
|
|
19151
|
+
* @deprecated
|
|
19098
19152
|
*/
|
|
19099
19153
|
postConversationsMessagingIntegrationsLine(body) {
|
|
19100
19154
|
// verify the required parameter 'body' is set
|
|
@@ -20006,7 +20060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20006
20060
|
/**
|
|
20007
20061
|
* DataExtensions service.
|
|
20008
20062
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20009
|
-
* @version
|
|
20063
|
+
* @version 188.0.0
|
|
20010
20064
|
*/
|
|
20011
20065
|
|
|
20012
20066
|
/**
|
|
@@ -20092,7 +20146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20092
20146
|
/**
|
|
20093
20147
|
* Downloads service.
|
|
20094
20148
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20095
|
-
* @version
|
|
20149
|
+
* @version 188.0.0
|
|
20096
20150
|
*/
|
|
20097
20151
|
|
|
20098
20152
|
/**
|
|
@@ -20144,7 +20198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20144
20198
|
/**
|
|
20145
20199
|
* Emails service.
|
|
20146
20200
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20147
|
-
* @version
|
|
20201
|
+
* @version 188.0.0
|
|
20148
20202
|
*/
|
|
20149
20203
|
|
|
20150
20204
|
/**
|
|
@@ -20209,7 +20263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20209
20263
|
/**
|
|
20210
20264
|
* Events service.
|
|
20211
20265
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20212
|
-
* @version
|
|
20266
|
+
* @version 188.0.0
|
|
20213
20267
|
*/
|
|
20214
20268
|
|
|
20215
20269
|
/**
|
|
@@ -20305,7 +20359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20305
20359
|
/**
|
|
20306
20360
|
* ExternalContacts service.
|
|
20307
20361
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20308
|
-
* @version
|
|
20362
|
+
* @version 188.0.0
|
|
20309
20363
|
*/
|
|
20310
20364
|
|
|
20311
20365
|
/**
|
|
@@ -22263,7 +22317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22263
22317
|
/**
|
|
22264
22318
|
* Fax service.
|
|
22265
22319
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22266
|
-
* @version
|
|
22320
|
+
* @version 188.0.0
|
|
22267
22321
|
*/
|
|
22268
22322
|
|
|
22269
22323
|
/**
|
|
@@ -22434,7 +22488,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22434
22488
|
/**
|
|
22435
22489
|
* Flows service.
|
|
22436
22490
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22437
|
-
* @version
|
|
22491
|
+
* @version 188.0.0
|
|
22438
22492
|
*/
|
|
22439
22493
|
|
|
22440
22494
|
/**
|
|
@@ -22618,7 +22672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22618
22672
|
/**
|
|
22619
22673
|
* Gamification service.
|
|
22620
22674
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22621
|
-
* @version
|
|
22675
|
+
* @version 188.0.0
|
|
22622
22676
|
*/
|
|
22623
22677
|
|
|
22624
22678
|
/**
|
|
@@ -24704,7 +24758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24704
24758
|
/**
|
|
24705
24759
|
* GeneralDataProtectionRegulation service.
|
|
24706
24760
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24707
|
-
* @version
|
|
24761
|
+
* @version 188.0.0
|
|
24708
24762
|
*/
|
|
24709
24763
|
|
|
24710
24764
|
/**
|
|
@@ -24834,7 +24888,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24834
24888
|
/**
|
|
24835
24889
|
* Geolocation service.
|
|
24836
24890
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24837
|
-
* @version
|
|
24891
|
+
* @version 188.0.0
|
|
24838
24892
|
*/
|
|
24839
24893
|
|
|
24840
24894
|
/**
|
|
@@ -24965,7 +25019,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24965
25019
|
/**
|
|
24966
25020
|
* Greetings service.
|
|
24967
25021
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24968
|
-
* @version
|
|
25022
|
+
* @version 188.0.0
|
|
24969
25023
|
*/
|
|
24970
25024
|
|
|
24971
25025
|
/**
|
|
@@ -25420,7 +25474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25420
25474
|
/**
|
|
25421
25475
|
* Groups service.
|
|
25422
25476
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25423
|
-
* @version
|
|
25477
|
+
* @version 188.0.0
|
|
25424
25478
|
*/
|
|
25425
25479
|
|
|
25426
25480
|
/**
|
|
@@ -25939,7 +25993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25939
25993
|
/**
|
|
25940
25994
|
* IdentityProvider service.
|
|
25941
25995
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25942
|
-
* @version
|
|
25996
|
+
* @version 188.0.0
|
|
25943
25997
|
*/
|
|
25944
25998
|
|
|
25945
25999
|
/**
|
|
@@ -25954,6 +26008,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25954
26008
|
}
|
|
25955
26009
|
|
|
25956
26010
|
|
|
26011
|
+
/**
|
|
26012
|
+
* Delete Identity Provider
|
|
26013
|
+
*
|
|
26014
|
+
* @param {String} providerId Provider ID
|
|
26015
|
+
*/
|
|
26016
|
+
deleteIdentityprovider(providerId) {
|
|
26017
|
+
// verify the required parameter 'providerId' is set
|
|
26018
|
+
if (providerId === undefined || providerId === null) {
|
|
26019
|
+
throw 'Missing the required parameter "providerId" when calling deleteIdentityprovider';
|
|
26020
|
+
}
|
|
26021
|
+
|
|
26022
|
+
return this.apiClient.callApi(
|
|
26023
|
+
'/api/v2/identityproviders/{providerId}',
|
|
26024
|
+
'DELETE',
|
|
26025
|
+
{ 'providerId': providerId },
|
|
26026
|
+
{ },
|
|
26027
|
+
{ },
|
|
26028
|
+
{ },
|
|
26029
|
+
null,
|
|
26030
|
+
['PureCloud OAuth'],
|
|
26031
|
+
['application/json'],
|
|
26032
|
+
['application/json']
|
|
26033
|
+
);
|
|
26034
|
+
}
|
|
26035
|
+
|
|
25957
26036
|
/**
|
|
25958
26037
|
* Delete ADFS Identity Provider
|
|
25959
26038
|
*
|
|
@@ -26174,6 +26253,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26174
26253
|
);
|
|
26175
26254
|
}
|
|
26176
26255
|
|
|
26256
|
+
/**
|
|
26257
|
+
* Get Identity Provider
|
|
26258
|
+
*
|
|
26259
|
+
* @param {String} providerId Provider ID
|
|
26260
|
+
*/
|
|
26261
|
+
getIdentityprovider(providerId) {
|
|
26262
|
+
// verify the required parameter 'providerId' is set
|
|
26263
|
+
if (providerId === undefined || providerId === null) {
|
|
26264
|
+
throw 'Missing the required parameter "providerId" when calling getIdentityprovider';
|
|
26265
|
+
}
|
|
26266
|
+
|
|
26267
|
+
return this.apiClient.callApi(
|
|
26268
|
+
'/api/v2/identityproviders/{providerId}',
|
|
26269
|
+
'GET',
|
|
26270
|
+
{ 'providerId': providerId },
|
|
26271
|
+
{ },
|
|
26272
|
+
{ },
|
|
26273
|
+
{ },
|
|
26274
|
+
null,
|
|
26275
|
+
['PureCloud OAuth'],
|
|
26276
|
+
['application/json'],
|
|
26277
|
+
['application/json']
|
|
26278
|
+
);
|
|
26279
|
+
}
|
|
26280
|
+
|
|
26177
26281
|
/**
|
|
26178
26282
|
* The list of identity providers
|
|
26179
26283
|
*
|
|
@@ -26414,6 +26518,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26414
26518
|
);
|
|
26415
26519
|
}
|
|
26416
26520
|
|
|
26521
|
+
/**
|
|
26522
|
+
* Create Identity Provider
|
|
26523
|
+
*
|
|
26524
|
+
* @param {Object} body Provider
|
|
26525
|
+
*/
|
|
26526
|
+
postIdentityproviders(body) {
|
|
26527
|
+
// verify the required parameter 'body' is set
|
|
26528
|
+
if (body === undefined || body === null) {
|
|
26529
|
+
throw 'Missing the required parameter "body" when calling postIdentityproviders';
|
|
26530
|
+
}
|
|
26531
|
+
|
|
26532
|
+
return this.apiClient.callApi(
|
|
26533
|
+
'/api/v2/identityproviders',
|
|
26534
|
+
'POST',
|
|
26535
|
+
{ },
|
|
26536
|
+
{ },
|
|
26537
|
+
{ },
|
|
26538
|
+
{ },
|
|
26539
|
+
body,
|
|
26540
|
+
['PureCloud OAuth'],
|
|
26541
|
+
['application/json'],
|
|
26542
|
+
['application/json']
|
|
26543
|
+
);
|
|
26544
|
+
}
|
|
26545
|
+
|
|
26546
|
+
/**
|
|
26547
|
+
* Update Identity Provider
|
|
26548
|
+
*
|
|
26549
|
+
* @param {String} providerId Provider ID
|
|
26550
|
+
* @param {Object} body Provider
|
|
26551
|
+
*/
|
|
26552
|
+
putIdentityprovider(providerId, body) {
|
|
26553
|
+
// verify the required parameter 'providerId' is set
|
|
26554
|
+
if (providerId === undefined || providerId === null) {
|
|
26555
|
+
throw 'Missing the required parameter "providerId" when calling putIdentityprovider';
|
|
26556
|
+
}
|
|
26557
|
+
// verify the required parameter 'body' is set
|
|
26558
|
+
if (body === undefined || body === null) {
|
|
26559
|
+
throw 'Missing the required parameter "body" when calling putIdentityprovider';
|
|
26560
|
+
}
|
|
26561
|
+
|
|
26562
|
+
return this.apiClient.callApi(
|
|
26563
|
+
'/api/v2/identityproviders/{providerId}',
|
|
26564
|
+
'PUT',
|
|
26565
|
+
{ 'providerId': providerId },
|
|
26566
|
+
{ },
|
|
26567
|
+
{ },
|
|
26568
|
+
{ },
|
|
26569
|
+
body,
|
|
26570
|
+
['PureCloud OAuth'],
|
|
26571
|
+
['application/json'],
|
|
26572
|
+
['application/json']
|
|
26573
|
+
);
|
|
26574
|
+
}
|
|
26575
|
+
|
|
26417
26576
|
/**
|
|
26418
26577
|
* Update/Create ADFS Identity Provider
|
|
26419
26578
|
*
|
|
@@ -26695,7 +26854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26695
26854
|
/**
|
|
26696
26855
|
* InfrastructureAsCode service.
|
|
26697
26856
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26698
|
-
* @version
|
|
26857
|
+
* @version 188.0.0
|
|
26699
26858
|
*/
|
|
26700
26859
|
|
|
26701
26860
|
/**
|
|
@@ -26862,7 +27021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26862
27021
|
/**
|
|
26863
27022
|
* Integrations service.
|
|
26864
27023
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26865
|
-
* @version
|
|
27024
|
+
* @version 188.0.0
|
|
26866
27025
|
*/
|
|
26867
27026
|
|
|
26868
27027
|
/**
|
|
@@ -27125,6 +27284,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27125
27284
|
);
|
|
27126
27285
|
}
|
|
27127
27286
|
|
|
27287
|
+
/**
|
|
27288
|
+
* Get draft function settings for Action
|
|
27289
|
+
*
|
|
27290
|
+
* @param {String} actionId actionId
|
|
27291
|
+
* getIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27292
|
+
*/
|
|
27293
|
+
getIntegrationsActionDraftFunction(actionId) {
|
|
27294
|
+
// verify the required parameter 'actionId' is set
|
|
27295
|
+
if (actionId === undefined || actionId === null) {
|
|
27296
|
+
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftFunction';
|
|
27297
|
+
}
|
|
27298
|
+
|
|
27299
|
+
return this.apiClient.callApi(
|
|
27300
|
+
'/api/v2/integrations/actions/{actionId}/draft/function',
|
|
27301
|
+
'GET',
|
|
27302
|
+
{ 'actionId': actionId },
|
|
27303
|
+
{ },
|
|
27304
|
+
{ },
|
|
27305
|
+
{ },
|
|
27306
|
+
null,
|
|
27307
|
+
['PureCloud OAuth'],
|
|
27308
|
+
['application/json'],
|
|
27309
|
+
['application/json']
|
|
27310
|
+
);
|
|
27311
|
+
}
|
|
27312
|
+
|
|
27128
27313
|
/**
|
|
27129
27314
|
* Retrieve schema for a Draft based on filename.
|
|
27130
27315
|
*
|
|
@@ -27210,6 +27395,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27210
27395
|
);
|
|
27211
27396
|
}
|
|
27212
27397
|
|
|
27398
|
+
/**
|
|
27399
|
+
* Get published function settings for Action
|
|
27400
|
+
*
|
|
27401
|
+
* @param {String} actionId actionId
|
|
27402
|
+
* getIntegrationsActionFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27403
|
+
*/
|
|
27404
|
+
getIntegrationsActionFunction(actionId) {
|
|
27405
|
+
// verify the required parameter 'actionId' is set
|
|
27406
|
+
if (actionId === undefined || actionId === null) {
|
|
27407
|
+
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionFunction';
|
|
27408
|
+
}
|
|
27409
|
+
|
|
27410
|
+
return this.apiClient.callApi(
|
|
27411
|
+
'/api/v2/integrations/actions/{actionId}/function',
|
|
27412
|
+
'GET',
|
|
27413
|
+
{ 'actionId': actionId },
|
|
27414
|
+
{ },
|
|
27415
|
+
{ },
|
|
27416
|
+
{ },
|
|
27417
|
+
null,
|
|
27418
|
+
['PureCloud OAuth'],
|
|
27419
|
+
['application/json'],
|
|
27420
|
+
['application/json']
|
|
27421
|
+
);
|
|
27422
|
+
}
|
|
27423
|
+
|
|
27213
27424
|
/**
|
|
27214
27425
|
* Retrieve schema for an action based on filename.
|
|
27215
27426
|
*
|
|
@@ -27393,6 +27604,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27393
27604
|
);
|
|
27394
27605
|
}
|
|
27395
27606
|
|
|
27607
|
+
/**
|
|
27608
|
+
* Get action function settings for Action
|
|
27609
|
+
*
|
|
27610
|
+
* getIntegrationsActionsFunctionsRuntimes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27611
|
+
*/
|
|
27612
|
+
getIntegrationsActionsFunctionsRuntimes() {
|
|
27613
|
+
|
|
27614
|
+
return this.apiClient.callApi(
|
|
27615
|
+
'/api/v2/integrations/actions/functions/runtimes',
|
|
27616
|
+
'GET',
|
|
27617
|
+
{ },
|
|
27618
|
+
{ },
|
|
27619
|
+
{ },
|
|
27620
|
+
{ },
|
|
27621
|
+
null,
|
|
27622
|
+
['PureCloud OAuth'],
|
|
27623
|
+
['application/json'],
|
|
27624
|
+
['application/json']
|
|
27625
|
+
);
|
|
27626
|
+
}
|
|
27627
|
+
|
|
27396
27628
|
/**
|
|
27397
27629
|
* Get a specific botConnector bot, plus versions, for this integration
|
|
27398
27630
|
*
|
|
@@ -28376,6 +28608,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28376
28608
|
);
|
|
28377
28609
|
}
|
|
28378
28610
|
|
|
28611
|
+
/**
|
|
28612
|
+
* Create upload presigned URL for draft function package file.
|
|
28613
|
+
*
|
|
28614
|
+
* @param {String} actionId actionId
|
|
28615
|
+
* @param {Object} body Input used to request URL upload.
|
|
28616
|
+
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28617
|
+
*/
|
|
28618
|
+
postIntegrationsActionDraftFunctionUpload(actionId, body) {
|
|
28619
|
+
// verify the required parameter 'actionId' is set
|
|
28620
|
+
if (actionId === undefined || actionId === null) {
|
|
28621
|
+
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';
|
|
28622
|
+
}
|
|
28623
|
+
// verify the required parameter 'body' is set
|
|
28624
|
+
if (body === undefined || body === null) {
|
|
28625
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';
|
|
28626
|
+
}
|
|
28627
|
+
|
|
28628
|
+
return this.apiClient.callApi(
|
|
28629
|
+
'/api/v2/integrations/actions/{actionId}/draft/function/upload',
|
|
28630
|
+
'POST',
|
|
28631
|
+
{ 'actionId': actionId },
|
|
28632
|
+
{ },
|
|
28633
|
+
{ },
|
|
28634
|
+
{ },
|
|
28635
|
+
body,
|
|
28636
|
+
['PureCloud OAuth'],
|
|
28637
|
+
['application/json'],
|
|
28638
|
+
['application/json']
|
|
28639
|
+
);
|
|
28640
|
+
}
|
|
28641
|
+
|
|
28379
28642
|
/**
|
|
28380
28643
|
* Publish a Draft and make it the active Action configuration
|
|
28381
28644
|
*
|
|
@@ -28698,6 +28961,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28698
28961
|
);
|
|
28699
28962
|
}
|
|
28700
28963
|
|
|
28964
|
+
/**
|
|
28965
|
+
* Update draft function settings.
|
|
28966
|
+
*
|
|
28967
|
+
* @param {String} actionId actionId
|
|
28968
|
+
* @param {Object} body Input used to update function settings.
|
|
28969
|
+
* putIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28970
|
+
*/
|
|
28971
|
+
putIntegrationsActionDraftFunction(actionId, body) {
|
|
28972
|
+
// verify the required parameter 'actionId' is set
|
|
28973
|
+
if (actionId === undefined || actionId === null) {
|
|
28974
|
+
throw 'Missing the required parameter "actionId" when calling putIntegrationsActionDraftFunction';
|
|
28975
|
+
}
|
|
28976
|
+
// verify the required parameter 'body' is set
|
|
28977
|
+
if (body === undefined || body === null) {
|
|
28978
|
+
throw 'Missing the required parameter "body" when calling putIntegrationsActionDraftFunction';
|
|
28979
|
+
}
|
|
28980
|
+
|
|
28981
|
+
return this.apiClient.callApi(
|
|
28982
|
+
'/api/v2/integrations/actions/{actionId}/draft/function',
|
|
28983
|
+
'PUT',
|
|
28984
|
+
{ 'actionId': actionId },
|
|
28985
|
+
{ },
|
|
28986
|
+
{ },
|
|
28987
|
+
{ },
|
|
28988
|
+
body,
|
|
28989
|
+
['PureCloud OAuth'],
|
|
28990
|
+
['application/json'],
|
|
28991
|
+
['application/json']
|
|
28992
|
+
);
|
|
28993
|
+
}
|
|
28994
|
+
|
|
28701
28995
|
/**
|
|
28702
28996
|
* Set a list of botConnector bots plus versions for this integration
|
|
28703
28997
|
*
|
|
@@ -28849,7 +29143,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28849
29143
|
/**
|
|
28850
29144
|
* Journey service.
|
|
28851
29145
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28852
|
-
* @version
|
|
29146
|
+
* @version 188.0.0
|
|
28853
29147
|
*/
|
|
28854
29148
|
|
|
28855
29149
|
/**
|
|
@@ -29616,39 +29910,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29616
29910
|
);
|
|
29617
29911
|
}
|
|
29618
29912
|
|
|
29619
|
-
/**
|
|
29620
|
-
* Retrieve segment assignments by session ID.
|
|
29621
|
-
*
|
|
29622
|
-
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
29623
|
-
* @param {Object} opts Optional parameters
|
|
29624
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
29625
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
29626
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
29627
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
29628
|
-
* getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29629
|
-
*/
|
|
29630
|
-
getJourneySessionSegments(sessionId, opts) {
|
|
29631
|
-
opts = opts || {};
|
|
29632
|
-
|
|
29633
|
-
// verify the required parameter 'sessionId' is set
|
|
29634
|
-
if (sessionId === undefined || sessionId === null) {
|
|
29635
|
-
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
29636
|
-
}
|
|
29637
|
-
|
|
29638
|
-
return this.apiClient.callApi(
|
|
29639
|
-
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
29640
|
-
'GET',
|
|
29641
|
-
{ 'sessionId': sessionId },
|
|
29642
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
29643
|
-
{ },
|
|
29644
|
-
{ },
|
|
29645
|
-
null,
|
|
29646
|
-
['PureCloud OAuth'],
|
|
29647
|
-
['application/json'],
|
|
29648
|
-
['application/json']
|
|
29649
|
-
);
|
|
29650
|
-
}
|
|
29651
|
-
|
|
29652
29913
|
/**
|
|
29653
29914
|
* Update single action map.
|
|
29654
29915
|
*
|
|
@@ -30080,7 +30341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30080
30341
|
/**
|
|
30081
30342
|
* Knowledge service.
|
|
30082
30343
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
30083
|
-
* @version
|
|
30344
|
+
* @version 188.0.0
|
|
30084
30345
|
*/
|
|
30085
30346
|
|
|
30086
30347
|
/**
|
|
@@ -31422,6 +31683,103 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31422
31683
|
);
|
|
31423
31684
|
}
|
|
31424
31685
|
|
|
31686
|
+
/**
|
|
31687
|
+
* Get operations
|
|
31688
|
+
*
|
|
31689
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31690
|
+
* @param {Object} opts Optional parameters
|
|
31691
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31692
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31693
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31694
|
+
* @param {Array.<String>} opts.userId If specified, retrieves operations associated with user ids, comma separated values expected.
|
|
31695
|
+
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
31696
|
+
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
31697
|
+
* @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
|
|
31698
|
+
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31699
|
+
*/
|
|
31700
|
+
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
31701
|
+
opts = opts || {};
|
|
31702
|
+
|
|
31703
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31704
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31705
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';
|
|
31706
|
+
}
|
|
31707
|
+
|
|
31708
|
+
return this.apiClient.callApi(
|
|
31709
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations',
|
|
31710
|
+
'GET',
|
|
31711
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
31712
|
+
{ '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'] },
|
|
31713
|
+
{ },
|
|
31714
|
+
{ },
|
|
31715
|
+
null,
|
|
31716
|
+
['PureCloud OAuth'],
|
|
31717
|
+
['application/json'],
|
|
31718
|
+
['application/json']
|
|
31719
|
+
);
|
|
31720
|
+
}
|
|
31721
|
+
|
|
31722
|
+
/**
|
|
31723
|
+
* Get ids of operation creator users and oauth clients
|
|
31724
|
+
*
|
|
31725
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31726
|
+
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31727
|
+
*/
|
|
31728
|
+
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
31729
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31730
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31731
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';
|
|
31732
|
+
}
|
|
31733
|
+
|
|
31734
|
+
return this.apiClient.callApi(
|
|
31735
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query',
|
|
31736
|
+
'GET',
|
|
31737
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
31738
|
+
{ },
|
|
31739
|
+
{ },
|
|
31740
|
+
{ },
|
|
31741
|
+
null,
|
|
31742
|
+
['PureCloud OAuth'],
|
|
31743
|
+
['application/json'],
|
|
31744
|
+
['application/json']
|
|
31745
|
+
);
|
|
31746
|
+
}
|
|
31747
|
+
|
|
31748
|
+
/**
|
|
31749
|
+
* Get parse job report
|
|
31750
|
+
*
|
|
31751
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31752
|
+
* @param {String} parseJobId Parse job ID
|
|
31753
|
+
* @param {Object} opts Optional parameters
|
|
31754
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
31755
|
+
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31756
|
+
*/
|
|
31757
|
+
getKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, opts) {
|
|
31758
|
+
opts = opts || {};
|
|
31759
|
+
|
|
31760
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31761
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31762
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';
|
|
31763
|
+
}
|
|
31764
|
+
// verify the required parameter 'parseJobId' is set
|
|
31765
|
+
if (parseJobId === undefined || parseJobId === null) {
|
|
31766
|
+
throw 'Missing the required parameter "parseJobId" when calling getKnowledgeKnowledgebaseParseJob';
|
|
31767
|
+
}
|
|
31768
|
+
|
|
31769
|
+
return this.apiClient.callApi(
|
|
31770
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}',
|
|
31771
|
+
'GET',
|
|
31772
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'parseJobId': parseJobId },
|
|
31773
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
31774
|
+
{ },
|
|
31775
|
+
{ },
|
|
31776
|
+
null,
|
|
31777
|
+
['PureCloud OAuth'],
|
|
31778
|
+
['application/json'],
|
|
31779
|
+
['application/json']
|
|
31780
|
+
);
|
|
31781
|
+
}
|
|
31782
|
+
|
|
31425
31783
|
/**
|
|
31426
31784
|
* Get knowledge base unanswered group for a particular groupId
|
|
31427
31785
|
*
|
|
@@ -31530,6 +31888,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31530
31888
|
);
|
|
31531
31889
|
}
|
|
31532
31890
|
|
|
31891
|
+
/**
|
|
31892
|
+
* Get content upload from URL job status
|
|
31893
|
+
*
|
|
31894
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31895
|
+
* @param {String} jobId Upload job ID
|
|
31896
|
+
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31897
|
+
*/
|
|
31898
|
+
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
31899
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31900
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31901
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
|
|
31902
|
+
}
|
|
31903
|
+
// verify the required parameter 'jobId' is set
|
|
31904
|
+
if (jobId === undefined || jobId === null) {
|
|
31905
|
+
throw 'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
|
|
31906
|
+
}
|
|
31907
|
+
|
|
31908
|
+
return this.apiClient.callApi(
|
|
31909
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}',
|
|
31910
|
+
'GET',
|
|
31911
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'jobId': jobId },
|
|
31912
|
+
{ },
|
|
31913
|
+
{ },
|
|
31914
|
+
{ },
|
|
31915
|
+
null,
|
|
31916
|
+
['PureCloud OAuth'],
|
|
31917
|
+
['application/json'],
|
|
31918
|
+
['application/json']
|
|
31919
|
+
);
|
|
31920
|
+
}
|
|
31921
|
+
|
|
31533
31922
|
/**
|
|
31534
31923
|
* Get knowledge bases
|
|
31535
31924
|
*
|
|
@@ -32000,6 +32389,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32000
32389
|
);
|
|
32001
32390
|
}
|
|
32002
32391
|
|
|
32392
|
+
/**
|
|
32393
|
+
* Send update to the parse operation
|
|
32394
|
+
*
|
|
32395
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32396
|
+
* @param {String} parseJobId Parse job ID
|
|
32397
|
+
* @param {Object} body
|
|
32398
|
+
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32399
|
+
*/
|
|
32400
|
+
patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, body) {
|
|
32401
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32402
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32403
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';
|
|
32404
|
+
}
|
|
32405
|
+
// verify the required parameter 'parseJobId' is set
|
|
32406
|
+
if (parseJobId === undefined || parseJobId === null) {
|
|
32407
|
+
throw 'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';
|
|
32408
|
+
}
|
|
32409
|
+
// verify the required parameter 'body' is set
|
|
32410
|
+
if (body === undefined || body === null) {
|
|
32411
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseParseJob';
|
|
32412
|
+
}
|
|
32413
|
+
|
|
32414
|
+
return this.apiClient.callApi(
|
|
32415
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}',
|
|
32416
|
+
'PATCH',
|
|
32417
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'parseJobId': parseJobId },
|
|
32418
|
+
{ },
|
|
32419
|
+
{ },
|
|
32420
|
+
{ },
|
|
32421
|
+
body,
|
|
32422
|
+
['PureCloud OAuth'],
|
|
32423
|
+
['application/json'],
|
|
32424
|
+
['application/json']
|
|
32425
|
+
);
|
|
32426
|
+
}
|
|
32427
|
+
|
|
32003
32428
|
/**
|
|
32004
32429
|
* Update a Knowledge base unanswered phrase group
|
|
32005
32430
|
*
|
|
@@ -32840,6 +33265,73 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32840
33265
|
);
|
|
32841
33266
|
}
|
|
32842
33267
|
|
|
33268
|
+
/**
|
|
33269
|
+
* Import the parsed articles
|
|
33270
|
+
*
|
|
33271
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33272
|
+
* @param {String} parseJobId Parse job ID
|
|
33273
|
+
* @param {Object} body
|
|
33274
|
+
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33275
|
+
*/
|
|
33276
|
+
postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId, parseJobId, body) {
|
|
33277
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33278
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33279
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobImport';
|
|
33280
|
+
}
|
|
33281
|
+
// verify the required parameter 'parseJobId' is set
|
|
33282
|
+
if (parseJobId === undefined || parseJobId === null) {
|
|
33283
|
+
throw 'Missing the required parameter "parseJobId" when calling postKnowledgeKnowledgebaseParseJobImport';
|
|
33284
|
+
}
|
|
33285
|
+
// verify the required parameter 'body' is set
|
|
33286
|
+
if (body === undefined || body === null) {
|
|
33287
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobImport';
|
|
33288
|
+
}
|
|
33289
|
+
|
|
33290
|
+
return this.apiClient.callApi(
|
|
33291
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import',
|
|
33292
|
+
'POST',
|
|
33293
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'parseJobId': parseJobId },
|
|
33294
|
+
{ },
|
|
33295
|
+
{ },
|
|
33296
|
+
{ },
|
|
33297
|
+
body,
|
|
33298
|
+
['PureCloud OAuth'],
|
|
33299
|
+
['application/json'],
|
|
33300
|
+
['application/json']
|
|
33301
|
+
);
|
|
33302
|
+
}
|
|
33303
|
+
|
|
33304
|
+
/**
|
|
33305
|
+
* Create parse job
|
|
33306
|
+
*
|
|
33307
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33308
|
+
* @param {Object} body
|
|
33309
|
+
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33310
|
+
*/
|
|
33311
|
+
postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId, body) {
|
|
33312
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33313
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33314
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobs';
|
|
33315
|
+
}
|
|
33316
|
+
// verify the required parameter 'body' is set
|
|
33317
|
+
if (body === undefined || body === null) {
|
|
33318
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobs';
|
|
33319
|
+
}
|
|
33320
|
+
|
|
33321
|
+
return this.apiClient.callApi(
|
|
33322
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs',
|
|
33323
|
+
'POST',
|
|
33324
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33325
|
+
{ },
|
|
33326
|
+
{ },
|
|
33327
|
+
{ },
|
|
33328
|
+
body,
|
|
33329
|
+
['PureCloud OAuth'],
|
|
33330
|
+
['application/json'],
|
|
33331
|
+
['application/json']
|
|
33332
|
+
);
|
|
33333
|
+
}
|
|
33334
|
+
|
|
32843
33335
|
/**
|
|
32844
33336
|
* Search Documents
|
|
32845
33337
|
*
|
|
@@ -32870,6 +33362,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32870
33362
|
);
|
|
32871
33363
|
}
|
|
32872
33364
|
|
|
33365
|
+
/**
|
|
33366
|
+
* Create content upload from URL job
|
|
33367
|
+
*
|
|
33368
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33369
|
+
* @param {Object} body uploadRequest
|
|
33370
|
+
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33371
|
+
*/
|
|
33372
|
+
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
33373
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33374
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33375
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
|
|
33376
|
+
}
|
|
33377
|
+
// verify the required parameter 'body' is set
|
|
33378
|
+
if (body === undefined || body === null) {
|
|
33379
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
|
|
33380
|
+
}
|
|
33381
|
+
|
|
33382
|
+
return this.apiClient.callApi(
|
|
33383
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs',
|
|
33384
|
+
'POST',
|
|
33385
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33386
|
+
{ },
|
|
33387
|
+
{ },
|
|
33388
|
+
{ },
|
|
33389
|
+
body,
|
|
33390
|
+
['PureCloud OAuth'],
|
|
33391
|
+
['application/json'],
|
|
33392
|
+
['application/json']
|
|
33393
|
+
);
|
|
33394
|
+
}
|
|
33395
|
+
|
|
32873
33396
|
/**
|
|
32874
33397
|
* Create new knowledge base
|
|
32875
33398
|
*
|
|
@@ -32901,7 +33424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32901
33424
|
/**
|
|
32902
33425
|
* LanguageUnderstanding service.
|
|
32903
33426
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32904
|
-
* @version
|
|
33427
|
+
* @version 188.0.0
|
|
32905
33428
|
*/
|
|
32906
33429
|
|
|
32907
33430
|
/**
|
|
@@ -33914,7 +34437,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33914
34437
|
/**
|
|
33915
34438
|
* Languages service.
|
|
33916
34439
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33917
|
-
* @version
|
|
34440
|
+
* @version 188.0.0
|
|
33918
34441
|
*/
|
|
33919
34442
|
|
|
33920
34443
|
/**
|
|
@@ -34136,7 +34659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34136
34659
|
/**
|
|
34137
34660
|
* Learning service.
|
|
34138
34661
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
34139
|
-
* @version
|
|
34662
|
+
* @version 188.0.0
|
|
34140
34663
|
*/
|
|
34141
34664
|
|
|
34142
34665
|
/**
|
|
@@ -34992,7 +35515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34992
35515
|
/**
|
|
34993
35516
|
* License service.
|
|
34994
35517
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34995
|
-
* @version
|
|
35518
|
+
* @version 188.0.0
|
|
34996
35519
|
*/
|
|
34997
35520
|
|
|
34998
35521
|
/**
|
|
@@ -35230,7 +35753,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35230
35753
|
/**
|
|
35231
35754
|
* Locations service.
|
|
35232
35755
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
35233
|
-
* @version
|
|
35756
|
+
* @version 188.0.0
|
|
35234
35757
|
*/
|
|
35235
35758
|
|
|
35236
35759
|
/**
|
|
@@ -35466,7 +35989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35466
35989
|
/**
|
|
35467
35990
|
* LogCapture service.
|
|
35468
35991
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
35469
|
-
* @version
|
|
35992
|
+
* @version 188.0.0
|
|
35470
35993
|
*/
|
|
35471
35994
|
|
|
35472
35995
|
/**
|
|
@@ -35666,7 +36189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35666
36189
|
/**
|
|
35667
36190
|
* Messaging service.
|
|
35668
36191
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35669
|
-
* @version
|
|
36192
|
+
* @version 188.0.0
|
|
35670
36193
|
*/
|
|
35671
36194
|
|
|
35672
36195
|
/**
|
|
@@ -36025,7 +36548,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36025
36548
|
/**
|
|
36026
36549
|
* MobileDevices service.
|
|
36027
36550
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
36028
|
-
* @version
|
|
36551
|
+
* @version 188.0.0
|
|
36029
36552
|
*/
|
|
36030
36553
|
|
|
36031
36554
|
/**
|
|
@@ -36176,7 +36699,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36176
36699
|
/**
|
|
36177
36700
|
* Notifications service.
|
|
36178
36701
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
36179
|
-
* @version
|
|
36702
|
+
* @version 188.0.0
|
|
36180
36703
|
*/
|
|
36181
36704
|
|
|
36182
36705
|
/**
|
|
@@ -36409,7 +36932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36409
36932
|
/**
|
|
36410
36933
|
* OAuth service.
|
|
36411
36934
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
36412
|
-
* @version
|
|
36935
|
+
* @version 188.0.0
|
|
36413
36936
|
*/
|
|
36414
36937
|
|
|
36415
36938
|
/**
|
|
@@ -36775,7 +37298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36775
37298
|
/**
|
|
36776
37299
|
* Objects service.
|
|
36777
37300
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36778
|
-
* @version
|
|
37301
|
+
* @version 188.0.0
|
|
36779
37302
|
*/
|
|
36780
37303
|
|
|
36781
37304
|
/**
|
|
@@ -36859,6 +37382,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36859
37382
|
* @param {String} opts.nextPage next page token
|
|
36860
37383
|
* @param {String} opts.previousPage Previous page token
|
|
36861
37384
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
37385
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
36862
37386
|
* @param {String} opts.name Search term to filter by division name
|
|
36863
37387
|
*/
|
|
36864
37388
|
getAuthorizationDivisions(opts) {
|
|
@@ -36869,7 +37393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36869
37393
|
'/api/v2/authorization/divisions',
|
|
36870
37394
|
'GET',
|
|
36871
37395
|
{ },
|
|
36872
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
37396
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
36873
37397
|
{ },
|
|
36874
37398
|
{ },
|
|
36875
37399
|
null,
|
|
@@ -37044,7 +37568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37044
37568
|
/**
|
|
37045
37569
|
* OperationalEvents service.
|
|
37046
37570
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
37047
|
-
* @version
|
|
37571
|
+
* @version 188.0.0
|
|
37048
37572
|
*/
|
|
37049
37573
|
|
|
37050
37574
|
/**
|
|
@@ -37110,7 +37634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37110
37634
|
/**
|
|
37111
37635
|
* Organization service.
|
|
37112
37636
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
37113
|
-
* @version
|
|
37637
|
+
* @version 188.0.0
|
|
37114
37638
|
*/
|
|
37115
37639
|
|
|
37116
37640
|
/**
|
|
@@ -37565,7 +38089,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37565
38089
|
/**
|
|
37566
38090
|
* OrganizationAuthorization service.
|
|
37567
38091
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
37568
|
-
* @version
|
|
38092
|
+
* @version 188.0.0
|
|
37569
38093
|
*/
|
|
37570
38094
|
|
|
37571
38095
|
/**
|
|
@@ -38912,7 +39436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38912
39436
|
/**
|
|
38913
39437
|
* Outbound service.
|
|
38914
39438
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38915
|
-
* @version
|
|
39439
|
+
* @version 188.0.0
|
|
38916
39440
|
*/
|
|
38917
39441
|
|
|
38918
39442
|
/**
|
|
@@ -39399,6 +39923,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39399
39923
|
);
|
|
39400
39924
|
}
|
|
39401
39925
|
|
|
39926
|
+
/**
|
|
39927
|
+
* Delete File Specification Template
|
|
39928
|
+
*
|
|
39929
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
39930
|
+
*/
|
|
39931
|
+
deleteOutboundFilespecificationtemplate(fileSpecificationTemplateId) {
|
|
39932
|
+
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
39933
|
+
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null) {
|
|
39934
|
+
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling deleteOutboundFilespecificationtemplate';
|
|
39935
|
+
}
|
|
39936
|
+
|
|
39937
|
+
return this.apiClient.callApi(
|
|
39938
|
+
'/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}',
|
|
39939
|
+
'DELETE',
|
|
39940
|
+
{ 'fileSpecificationTemplateId': fileSpecificationTemplateId },
|
|
39941
|
+
{ },
|
|
39942
|
+
{ },
|
|
39943
|
+
{ },
|
|
39944
|
+
null,
|
|
39945
|
+
['PureCloud OAuth'],
|
|
39946
|
+
['application/json'],
|
|
39947
|
+
['application/json']
|
|
39948
|
+
);
|
|
39949
|
+
}
|
|
39950
|
+
|
|
39951
|
+
/**
|
|
39952
|
+
* Delete multiple file specification templates.
|
|
39953
|
+
*
|
|
39954
|
+
* @param {Array.<String>} id File Specification template id(s) to delete
|
|
39955
|
+
*/
|
|
39956
|
+
deleteOutboundFilespecificationtemplatesBulk(id) {
|
|
39957
|
+
// verify the required parameter 'id' is set
|
|
39958
|
+
if (id === undefined || id === null) {
|
|
39959
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundFilespecificationtemplatesBulk';
|
|
39960
|
+
}
|
|
39961
|
+
|
|
39962
|
+
return this.apiClient.callApi(
|
|
39963
|
+
'/api/v2/outbound/filespecificationtemplates/bulk',
|
|
39964
|
+
'DELETE',
|
|
39965
|
+
{ },
|
|
39966
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
39967
|
+
{ },
|
|
39968
|
+
{ },
|
|
39969
|
+
null,
|
|
39970
|
+
['PureCloud OAuth'],
|
|
39971
|
+
['application/json'],
|
|
39972
|
+
['application/json']
|
|
39973
|
+
);
|
|
39974
|
+
}
|
|
39975
|
+
|
|
39402
39976
|
/**
|
|
39403
39977
|
* Delete Import Template
|
|
39404
39978
|
*
|
|
@@ -40806,12 +41380,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40806
41380
|
);
|
|
40807
41381
|
}
|
|
40808
41382
|
|
|
41383
|
+
/**
|
|
41384
|
+
* Get File Specification Template
|
|
41385
|
+
*
|
|
41386
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
41387
|
+
*/
|
|
41388
|
+
getOutboundFilespecificationtemplate(fileSpecificationTemplateId) {
|
|
41389
|
+
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
41390
|
+
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null) {
|
|
41391
|
+
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling getOutboundFilespecificationtemplate';
|
|
41392
|
+
}
|
|
41393
|
+
|
|
41394
|
+
return this.apiClient.callApi(
|
|
41395
|
+
'/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}',
|
|
41396
|
+
'GET',
|
|
41397
|
+
{ 'fileSpecificationTemplateId': fileSpecificationTemplateId },
|
|
41398
|
+
{ },
|
|
41399
|
+
{ },
|
|
41400
|
+
{ },
|
|
41401
|
+
null,
|
|
41402
|
+
['PureCloud OAuth'],
|
|
41403
|
+
['application/json'],
|
|
41404
|
+
['application/json']
|
|
41405
|
+
);
|
|
41406
|
+
}
|
|
41407
|
+
|
|
41408
|
+
/**
|
|
41409
|
+
* Query File Specification Templates
|
|
41410
|
+
*
|
|
41411
|
+
* @param {Object} opts Optional parameters
|
|
41412
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
41413
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41414
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
41415
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
41416
|
+
* @param {String} opts.name Name
|
|
41417
|
+
* @param {String} opts.sortBy Sort by
|
|
41418
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
41419
|
+
*/
|
|
41420
|
+
getOutboundFilespecificationtemplates(opts) {
|
|
41421
|
+
opts = opts || {};
|
|
41422
|
+
|
|
41423
|
+
|
|
41424
|
+
return this.apiClient.callApi(
|
|
41425
|
+
'/api/v2/outbound/filespecificationtemplates',
|
|
41426
|
+
'GET',
|
|
41427
|
+
{ },
|
|
41428
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
41429
|
+
{ },
|
|
41430
|
+
{ },
|
|
41431
|
+
null,
|
|
41432
|
+
['PureCloud OAuth'],
|
|
41433
|
+
['application/json'],
|
|
41434
|
+
['application/json']
|
|
41435
|
+
);
|
|
41436
|
+
}
|
|
41437
|
+
|
|
40809
41438
|
/**
|
|
40810
41439
|
* Get Import Template
|
|
40811
41440
|
*
|
|
40812
41441
|
* @param {String} importTemplateId Import Template ID
|
|
41442
|
+
* @param {Object} opts Optional parameters
|
|
41443
|
+
* @param {Boolean} opts.includeImportStatus Import status (default to false)
|
|
40813
41444
|
*/
|
|
40814
|
-
getOutboundImporttemplate(importTemplateId) {
|
|
41445
|
+
getOutboundImporttemplate(importTemplateId, opts) {
|
|
41446
|
+
opts = opts || {};
|
|
41447
|
+
|
|
40815
41448
|
// verify the required parameter 'importTemplateId' is set
|
|
40816
41449
|
if (importTemplateId === undefined || importTemplateId === null) {
|
|
40817
41450
|
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';
|
|
@@ -40821,7 +41454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40821
41454
|
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
40822
41455
|
'GET',
|
|
40823
41456
|
{ 'importTemplateId': importTemplateId },
|
|
40824
|
-
{
|
|
41457
|
+
{ 'includeImportStatus': opts['includeImportStatus'] },
|
|
40825
41458
|
{ },
|
|
40826
41459
|
{ },
|
|
40827
41460
|
null,
|
|
@@ -40864,6 +41497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40864
41497
|
* Query Import Templates
|
|
40865
41498
|
*
|
|
40866
41499
|
* @param {Object} opts Optional parameters
|
|
41500
|
+
* @param {Boolean} opts.includeImportStatus Import status (default to false)
|
|
40867
41501
|
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
40868
41502
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40869
41503
|
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
@@ -40881,7 +41515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40881
41515
|
'/api/v2/outbound/importtemplates',
|
|
40882
41516
|
'GET',
|
|
40883
41517
|
{ },
|
|
40884
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
|
|
41518
|
+
{ 'includeImportStatus': opts['includeImportStatus'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
|
|
40885
41519
|
{ },
|
|
40886
41520
|
{ },
|
|
40887
41521
|
null,
|
|
@@ -41879,6 +42513,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41879
42513
|
);
|
|
41880
42514
|
}
|
|
41881
42515
|
|
|
42516
|
+
/**
|
|
42517
|
+
* Retrieve multiple contact list filters
|
|
42518
|
+
*
|
|
42519
|
+
* @param {Object} body The contact list filters to retrieve
|
|
42520
|
+
*/
|
|
42521
|
+
postOutboundContactlistfiltersBulkRetrieve(body) {
|
|
42522
|
+
// verify the required parameter 'body' is set
|
|
42523
|
+
if (body === undefined || body === null) {
|
|
42524
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistfiltersBulkRetrieve';
|
|
42525
|
+
}
|
|
42526
|
+
|
|
42527
|
+
return this.apiClient.callApi(
|
|
42528
|
+
'/api/v2/outbound/contactlistfilters/bulk/retrieve',
|
|
42529
|
+
'POST',
|
|
42530
|
+
{ },
|
|
42531
|
+
{ },
|
|
42532
|
+
{ },
|
|
42533
|
+
{ },
|
|
42534
|
+
body,
|
|
42535
|
+
['PureCloud OAuth'],
|
|
42536
|
+
['application/json'],
|
|
42537
|
+
['application/json']
|
|
42538
|
+
);
|
|
42539
|
+
}
|
|
42540
|
+
|
|
41882
42541
|
/**
|
|
41883
42542
|
* Get a preview of the output of a contact list filter
|
|
41884
42543
|
*
|
|
@@ -41979,6 +42638,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41979
42638
|
);
|
|
41980
42639
|
}
|
|
41981
42640
|
|
|
42641
|
+
/**
|
|
42642
|
+
* Get multiple contact list templates
|
|
42643
|
+
*
|
|
42644
|
+
* @param {Object} body contact list templates to get
|
|
42645
|
+
*/
|
|
42646
|
+
postOutboundContactlisttemplatesBulkRetrieve(body) {
|
|
42647
|
+
// verify the required parameter 'body' is set
|
|
42648
|
+
if (body === undefined || body === null) {
|
|
42649
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkRetrieve';
|
|
42650
|
+
}
|
|
42651
|
+
|
|
42652
|
+
return this.apiClient.callApi(
|
|
42653
|
+
'/api/v2/outbound/contactlisttemplates/bulk/retrieve',
|
|
42654
|
+
'POST',
|
|
42655
|
+
{ },
|
|
42656
|
+
{ },
|
|
42657
|
+
{ },
|
|
42658
|
+
{ },
|
|
42659
|
+
body,
|
|
42660
|
+
['PureCloud OAuth'],
|
|
42661
|
+
['application/json'],
|
|
42662
|
+
['application/json']
|
|
42663
|
+
);
|
|
42664
|
+
}
|
|
42665
|
+
|
|
41982
42666
|
/**
|
|
41983
42667
|
* Add phone numbers to a Dialer DNC list.
|
|
41984
42668
|
*
|
|
@@ -42143,6 +42827,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42143
42827
|
);
|
|
42144
42828
|
}
|
|
42145
42829
|
|
|
42830
|
+
/**
|
|
42831
|
+
* Create File Specification Template
|
|
42832
|
+
*
|
|
42833
|
+
* @param {Object} body FileSpecificationTemplate
|
|
42834
|
+
*/
|
|
42835
|
+
postOutboundFilespecificationtemplates(body) {
|
|
42836
|
+
// verify the required parameter 'body' is set
|
|
42837
|
+
if (body === undefined || body === null) {
|
|
42838
|
+
throw 'Missing the required parameter "body" when calling postOutboundFilespecificationtemplates';
|
|
42839
|
+
}
|
|
42840
|
+
|
|
42841
|
+
return this.apiClient.callApi(
|
|
42842
|
+
'/api/v2/outbound/filespecificationtemplates',
|
|
42843
|
+
'POST',
|
|
42844
|
+
{ },
|
|
42845
|
+
{ },
|
|
42846
|
+
{ },
|
|
42847
|
+
{ },
|
|
42848
|
+
body,
|
|
42849
|
+
['PureCloud OAuth'],
|
|
42850
|
+
['application/json'],
|
|
42851
|
+
['application/json']
|
|
42852
|
+
);
|
|
42853
|
+
}
|
|
42854
|
+
|
|
42146
42855
|
/**
|
|
42147
42856
|
* Create Import Template
|
|
42148
42857
|
*
|
|
@@ -42663,6 +43372,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42663
43372
|
);
|
|
42664
43373
|
}
|
|
42665
43374
|
|
|
43375
|
+
/**
|
|
43376
|
+
* Update File Specification Template
|
|
43377
|
+
*
|
|
43378
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
43379
|
+
* @param {Object} body fileSpecificationTemplate
|
|
43380
|
+
*/
|
|
43381
|
+
putOutboundFilespecificationtemplate(fileSpecificationTemplateId, body) {
|
|
43382
|
+
// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
43383
|
+
if (fileSpecificationTemplateId === undefined || fileSpecificationTemplateId === null) {
|
|
43384
|
+
throw 'Missing the required parameter "fileSpecificationTemplateId" when calling putOutboundFilespecificationtemplate';
|
|
43385
|
+
}
|
|
43386
|
+
// verify the required parameter 'body' is set
|
|
43387
|
+
if (body === undefined || body === null) {
|
|
43388
|
+
throw 'Missing the required parameter "body" when calling putOutboundFilespecificationtemplate';
|
|
43389
|
+
}
|
|
43390
|
+
|
|
43391
|
+
return this.apiClient.callApi(
|
|
43392
|
+
'/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}',
|
|
43393
|
+
'PUT',
|
|
43394
|
+
{ 'fileSpecificationTemplateId': fileSpecificationTemplateId },
|
|
43395
|
+
{ },
|
|
43396
|
+
{ },
|
|
43397
|
+
{ },
|
|
43398
|
+
body,
|
|
43399
|
+
['PureCloud OAuth'],
|
|
43400
|
+
['application/json'],
|
|
43401
|
+
['application/json']
|
|
43402
|
+
);
|
|
43403
|
+
}
|
|
43404
|
+
|
|
42666
43405
|
/**
|
|
42667
43406
|
* Update Import Template
|
|
42668
43407
|
*
|
|
@@ -42934,7 +43673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42934
43673
|
/**
|
|
42935
43674
|
* Presence service.
|
|
42936
43675
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
42937
|
-
* @version
|
|
43676
|
+
* @version 188.0.0
|
|
42938
43677
|
*/
|
|
42939
43678
|
|
|
42940
43679
|
/**
|
|
@@ -43000,9 +43739,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43000
43739
|
}
|
|
43001
43740
|
|
|
43002
43741
|
/**
|
|
43003
|
-
* Delete a Presence Definition
|
|
43742
|
+
* Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
|
|
43004
43743
|
*
|
|
43005
43744
|
* @param {String} presenceId Organization Presence ID
|
|
43745
|
+
* @deprecated
|
|
43006
43746
|
*/
|
|
43007
43747
|
deletePresencedefinition(presenceId) {
|
|
43008
43748
|
// verify the required parameter 'presenceId' is set
|
|
@@ -43174,11 +43914,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43174
43914
|
}
|
|
43175
43915
|
|
|
43176
43916
|
/**
|
|
43177
|
-
* Get a Presence Definition
|
|
43917
|
+
* Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
|
|
43178
43918
|
*
|
|
43179
43919
|
* @param {String} presenceId Organization Presence ID
|
|
43180
43920
|
* @param {Object} opts Optional parameters
|
|
43181
43921
|
* @param {String} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
43922
|
+
* @deprecated
|
|
43182
43923
|
*/
|
|
43183
43924
|
getPresencedefinition(presenceId, opts) {
|
|
43184
43925
|
opts = opts || {};
|
|
@@ -43203,13 +43944,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43203
43944
|
}
|
|
43204
43945
|
|
|
43205
43946
|
/**
|
|
43206
|
-
* Get an Organization's list of Presence Definitions
|
|
43947
|
+
* Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
|
|
43207
43948
|
*
|
|
43208
43949
|
* @param {Object} opts Optional parameters
|
|
43209
43950
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43210
43951
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43211
43952
|
* @param {String} opts.deleted Deleted query can be TRUE, FALSE or ALL (default to false)
|
|
43212
43953
|
* @param {String} opts.localeCode The locale code to fetch for each presence definition. Use ALL to fetch everything.
|
|
43954
|
+
* @deprecated
|
|
43213
43955
|
*/
|
|
43214
43956
|
getPresencedefinitions(opts) {
|
|
43215
43957
|
opts = opts || {};
|
|
@@ -43473,9 +44215,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43473
44215
|
}
|
|
43474
44216
|
|
|
43475
44217
|
/**
|
|
43476
|
-
* Create a Presence Definition
|
|
44218
|
+
* Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
|
|
43477
44219
|
*
|
|
43478
44220
|
* @param {Object} body The Presence Definition to create
|
|
44221
|
+
* @deprecated
|
|
43479
44222
|
*/
|
|
43480
44223
|
postPresencedefinitions(body) {
|
|
43481
44224
|
// verify the required parameter 'body' is set
|
|
@@ -43613,10 +44356,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43613
44356
|
}
|
|
43614
44357
|
|
|
43615
44358
|
/**
|
|
43616
|
-
* Update a Presence Definition
|
|
44359
|
+
* Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
|
|
43617
44360
|
*
|
|
43618
44361
|
* @param {String} presenceId Organization Presence ID
|
|
43619
44362
|
* @param {Object} body The OrganizationPresence to update
|
|
44363
|
+
* @deprecated
|
|
43620
44364
|
*/
|
|
43621
44365
|
putPresencedefinition(presenceId, body) {
|
|
43622
44366
|
// verify the required parameter 'presenceId' is set
|
|
@@ -43673,7 +44417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43673
44417
|
/**
|
|
43674
44418
|
* ProcessAutomation service.
|
|
43675
44419
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
43676
|
-
* @version
|
|
44420
|
+
* @version 188.0.0
|
|
43677
44421
|
*/
|
|
43678
44422
|
|
|
43679
44423
|
/**
|
|
@@ -43912,7 +44656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43912
44656
|
/**
|
|
43913
44657
|
* Quality service.
|
|
43914
44658
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
43915
|
-
* @version
|
|
44659
|
+
* @version 188.0.0
|
|
43916
44660
|
*/
|
|
43917
44661
|
|
|
43918
44662
|
/**
|
|
@@ -45669,7 +46413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45669
46413
|
/**
|
|
45670
46414
|
* Recording service.
|
|
45671
46415
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
45672
|
-
* @version
|
|
46416
|
+
* @version 188.0.0
|
|
45673
46417
|
*/
|
|
45674
46418
|
|
|
45675
46419
|
/**
|
|
@@ -47306,7 +48050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47306
48050
|
/**
|
|
47307
48051
|
* ResponseManagement service.
|
|
47308
48052
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
47309
|
-
* @version
|
|
48053
|
+
* @version 188.0.0
|
|
47310
48054
|
*/
|
|
47311
48055
|
|
|
47312
48056
|
/**
|
|
@@ -47791,7 +48535,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47791
48535
|
/**
|
|
47792
48536
|
* Routing service.
|
|
47793
48537
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
47794
|
-
* @version
|
|
48538
|
+
* @version 188.0.0
|
|
47795
48539
|
*/
|
|
47796
48540
|
|
|
47797
48541
|
/**
|
|
@@ -51744,7 +52488,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51744
52488
|
/**
|
|
51745
52489
|
* SCIM service.
|
|
51746
52490
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
51747
|
-
* @version
|
|
52491
|
+
* @version 188.0.0
|
|
51748
52492
|
*/
|
|
51749
52493
|
|
|
51750
52494
|
/**
|
|
@@ -52617,11 +53361,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52617
53361
|
|
|
52618
53362
|
}
|
|
52619
53363
|
|
|
53364
|
+
class ScreenRecordingApi {
|
|
53365
|
+
/**
|
|
53366
|
+
* ScreenRecording service.
|
|
53367
|
+
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
53368
|
+
* @version 188.0.0
|
|
53369
|
+
*/
|
|
53370
|
+
|
|
53371
|
+
/**
|
|
53372
|
+
* Constructs a new ScreenRecordingApi.
|
|
53373
|
+
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
53374
|
+
* @class
|
|
53375
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
53376
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
53377
|
+
*/
|
|
53378
|
+
constructor(apiClient) {
|
|
53379
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
53380
|
+
}
|
|
53381
|
+
|
|
53382
|
+
|
|
53383
|
+
/**
|
|
53384
|
+
* Sign identifying information for screen recording
|
|
53385
|
+
*
|
|
53386
|
+
* @param {Object} opts Optional parameters
|
|
53387
|
+
* @param {Object} opts.body
|
|
53388
|
+
*/
|
|
53389
|
+
postScreenrecordingToken(opts) {
|
|
53390
|
+
opts = opts || {};
|
|
53391
|
+
|
|
53392
|
+
|
|
53393
|
+
return this.apiClient.callApi(
|
|
53394
|
+
'/api/v2/screenrecording/token',
|
|
53395
|
+
'POST',
|
|
53396
|
+
{ },
|
|
53397
|
+
{ },
|
|
53398
|
+
{ },
|
|
53399
|
+
{ },
|
|
53400
|
+
opts['body'],
|
|
53401
|
+
['PureCloud OAuth'],
|
|
53402
|
+
['application/json'],
|
|
53403
|
+
['application/json']
|
|
53404
|
+
);
|
|
53405
|
+
}
|
|
53406
|
+
|
|
53407
|
+
}
|
|
53408
|
+
|
|
52620
53409
|
class ScriptsApi {
|
|
52621
53410
|
/**
|
|
52622
53411
|
* Scripts service.
|
|
52623
53412
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
52624
|
-
* @version
|
|
53413
|
+
* @version 188.0.0
|
|
52625
53414
|
*/
|
|
52626
53415
|
|
|
52627
53416
|
/**
|
|
@@ -53065,7 +53854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53065
53854
|
/**
|
|
53066
53855
|
* Search service.
|
|
53067
53856
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
53068
|
-
* @version
|
|
53857
|
+
* @version 188.0.0
|
|
53069
53858
|
*/
|
|
53070
53859
|
|
|
53071
53860
|
/**
|
|
@@ -53754,7 +54543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53754
54543
|
/**
|
|
53755
54544
|
* Settings service.
|
|
53756
54545
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
53757
|
-
* @version
|
|
54546
|
+
* @version 188.0.0
|
|
53758
54547
|
*/
|
|
53759
54548
|
|
|
53760
54549
|
/**
|
|
@@ -53819,7 +54608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53819
54608
|
/**
|
|
53820
54609
|
* SpeechTextAnalytics service.
|
|
53821
54610
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
53822
|
-
* @version
|
|
54611
|
+
* @version 188.0.0
|
|
53823
54612
|
*/
|
|
53824
54613
|
|
|
53825
54614
|
/**
|
|
@@ -54413,6 +55202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54413
55202
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
54414
55203
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
54415
55204
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
55205
|
+
* @param {Array.<String>} opts.dialects Comma separated dialect strings to filter by. Maximum of 15 dialects allowed.
|
|
54416
55206
|
* @param {Object} opts.sortBy Sort results by. Defaults to name
|
|
54417
55207
|
* @param {Object} opts.sortOrder Sort order. Defaults to asc
|
|
54418
55208
|
*/
|
|
@@ -54424,7 +55214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54424
55214
|
'/api/v2/speechandtextanalytics/topics',
|
|
54425
55215
|
'GET',
|
|
54426
55216
|
{ },
|
|
54427
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
55217
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'dialects': this.apiClient.buildCollectionParam(opts['dialects'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
54428
55218
|
{ },
|
|
54429
55219
|
{ },
|
|
54430
55220
|
null,
|
|
@@ -54932,7 +55722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54932
55722
|
/**
|
|
54933
55723
|
* Stations service.
|
|
54934
55724
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
54935
|
-
* @version
|
|
55725
|
+
* @version 188.0.0
|
|
54936
55726
|
*/
|
|
54937
55727
|
|
|
54938
55728
|
/**
|
|
@@ -55034,7 +55824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55034
55824
|
/**
|
|
55035
55825
|
* Suggest service.
|
|
55036
55826
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
55037
|
-
* @version
|
|
55827
|
+
* @version 188.0.0
|
|
55038
55828
|
*/
|
|
55039
55829
|
|
|
55040
55830
|
/**
|
|
@@ -55173,7 +55963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55173
55963
|
/**
|
|
55174
55964
|
* TaskManagement service.
|
|
55175
55965
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
55176
|
-
* @version
|
|
55966
|
+
* @version 188.0.0
|
|
55177
55967
|
*/
|
|
55178
55968
|
|
|
55179
55969
|
/**
|
|
@@ -56454,7 +57244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56454
57244
|
/**
|
|
56455
57245
|
* Teams service.
|
|
56456
57246
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
56457
|
-
* @version
|
|
57247
|
+
* @version 188.0.0
|
|
56458
57248
|
*/
|
|
56459
57249
|
|
|
56460
57250
|
/**
|
|
@@ -56756,7 +57546,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56756
57546
|
/**
|
|
56757
57547
|
* Telephony service.
|
|
56758
57548
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
56759
|
-
* @version
|
|
57549
|
+
* @version 188.0.0
|
|
56760
57550
|
*/
|
|
56761
57551
|
|
|
56762
57552
|
/**
|
|
@@ -56938,7 +57728,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56938
57728
|
/**
|
|
56939
57729
|
* TelephonyProvidersEdge service.
|
|
56940
57730
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
56941
|
-
* @version
|
|
57731
|
+
* @version 188.0.0
|
|
56942
57732
|
*/
|
|
56943
57733
|
|
|
56944
57734
|
/**
|
|
@@ -58416,32 +59206,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58416
59206
|
);
|
|
58417
59207
|
}
|
|
58418
59208
|
|
|
58419
|
-
/**
|
|
58420
|
-
* Get outbound route
|
|
58421
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
58422
|
-
* @param {String} outboundRouteId Outbound route ID
|
|
58423
|
-
* @deprecated
|
|
58424
|
-
*/
|
|
58425
|
-
getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
58426
|
-
// verify the required parameter 'outboundRouteId' is set
|
|
58427
|
-
if (outboundRouteId === undefined || outboundRouteId === null) {
|
|
58428
|
-
throw 'Missing the required parameter "outboundRouteId" when calling getTelephonyProvidersEdgesOutboundroute';
|
|
58429
|
-
}
|
|
58430
|
-
|
|
58431
|
-
return this.apiClient.callApi(
|
|
58432
|
-
'/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
|
|
58433
|
-
'GET',
|
|
58434
|
-
{ 'outboundRouteId': outboundRouteId },
|
|
58435
|
-
{ },
|
|
58436
|
-
{ },
|
|
58437
|
-
{ },
|
|
58438
|
-
null,
|
|
58439
|
-
['PureCloud OAuth'],
|
|
58440
|
-
['application/json'],
|
|
58441
|
-
['application/json']
|
|
58442
|
-
);
|
|
58443
|
-
}
|
|
58444
|
-
|
|
58445
59209
|
/**
|
|
58446
59210
|
* Get outbound routes
|
|
58447
59211
|
*
|
|
@@ -60313,7 +61077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60313
61077
|
/**
|
|
60314
61078
|
* Textbots service.
|
|
60315
61079
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
60316
|
-
* @version
|
|
61080
|
+
* @version 188.0.0
|
|
60317
61081
|
*/
|
|
60318
61082
|
|
|
60319
61083
|
/**
|
|
@@ -60441,7 +61205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60441
61205
|
/**
|
|
60442
61206
|
* Tokens service.
|
|
60443
61207
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
60444
|
-
* @version
|
|
61208
|
+
* @version 188.0.0
|
|
60445
61209
|
*/
|
|
60446
61210
|
|
|
60447
61211
|
/**
|
|
@@ -60597,7 +61361,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60597
61361
|
/**
|
|
60598
61362
|
* Uploads service.
|
|
60599
61363
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
60600
|
-
* @version
|
|
61364
|
+
* @version 188.0.0
|
|
60601
61365
|
*/
|
|
60602
61366
|
|
|
60603
61367
|
/**
|
|
@@ -60612,6 +61376,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60612
61376
|
}
|
|
60613
61377
|
|
|
60614
61378
|
|
|
61379
|
+
/**
|
|
61380
|
+
* Get content upload from URL job status
|
|
61381
|
+
*
|
|
61382
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
61383
|
+
* @param {String} jobId Upload job ID
|
|
61384
|
+
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61385
|
+
*/
|
|
61386
|
+
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
61387
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
61388
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
61389
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
|
|
61390
|
+
}
|
|
61391
|
+
// verify the required parameter 'jobId' is set
|
|
61392
|
+
if (jobId === undefined || jobId === null) {
|
|
61393
|
+
throw 'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
|
|
61394
|
+
}
|
|
61395
|
+
|
|
61396
|
+
return this.apiClient.callApi(
|
|
61397
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}',
|
|
61398
|
+
'GET',
|
|
61399
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'jobId': jobId },
|
|
61400
|
+
{ },
|
|
61401
|
+
{ },
|
|
61402
|
+
{ },
|
|
61403
|
+
null,
|
|
61404
|
+
['PureCloud OAuth'],
|
|
61405
|
+
['application/json'],
|
|
61406
|
+
['application/json']
|
|
61407
|
+
);
|
|
61408
|
+
}
|
|
61409
|
+
|
|
61410
|
+
/**
|
|
61411
|
+
* Create upload presigned URL for draft function package file.
|
|
61412
|
+
*
|
|
61413
|
+
* @param {String} actionId actionId
|
|
61414
|
+
* @param {Object} body Input used to request URL upload.
|
|
61415
|
+
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61416
|
+
*/
|
|
61417
|
+
postIntegrationsActionDraftFunctionUpload(actionId, body) {
|
|
61418
|
+
// verify the required parameter 'actionId' is set
|
|
61419
|
+
if (actionId === undefined || actionId === null) {
|
|
61420
|
+
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';
|
|
61421
|
+
}
|
|
61422
|
+
// verify the required parameter 'body' is set
|
|
61423
|
+
if (body === undefined || body === null) {
|
|
61424
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';
|
|
61425
|
+
}
|
|
61426
|
+
|
|
61427
|
+
return this.apiClient.callApi(
|
|
61428
|
+
'/api/v2/integrations/actions/{actionId}/draft/function/upload',
|
|
61429
|
+
'POST',
|
|
61430
|
+
{ 'actionId': actionId },
|
|
61431
|
+
{ },
|
|
61432
|
+
{ },
|
|
61433
|
+
{ },
|
|
61434
|
+
body,
|
|
61435
|
+
['PureCloud OAuth'],
|
|
61436
|
+
['application/json'],
|
|
61437
|
+
['application/json']
|
|
61438
|
+
);
|
|
61439
|
+
}
|
|
61440
|
+
|
|
60615
61441
|
/**
|
|
60616
61442
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
60617
61443
|
*
|
|
@@ -60637,6 +61463,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60637
61463
|
);
|
|
60638
61464
|
}
|
|
60639
61465
|
|
|
61466
|
+
/**
|
|
61467
|
+
* Create content upload from URL job
|
|
61468
|
+
*
|
|
61469
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
61470
|
+
* @param {Object} body uploadRequest
|
|
61471
|
+
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61472
|
+
*/
|
|
61473
|
+
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
61474
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
61475
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
61476
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
|
|
61477
|
+
}
|
|
61478
|
+
// verify the required parameter 'body' is set
|
|
61479
|
+
if (body === undefined || body === null) {
|
|
61480
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
|
|
61481
|
+
}
|
|
61482
|
+
|
|
61483
|
+
return this.apiClient.callApi(
|
|
61484
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs',
|
|
61485
|
+
'POST',
|
|
61486
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
61487
|
+
{ },
|
|
61488
|
+
{ },
|
|
61489
|
+
{ },
|
|
61490
|
+
body,
|
|
61491
|
+
['PureCloud OAuth'],
|
|
61492
|
+
['application/json'],
|
|
61493
|
+
['application/json']
|
|
61494
|
+
);
|
|
61495
|
+
}
|
|
61496
|
+
|
|
60640
61497
|
/**
|
|
60641
61498
|
* Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner
|
|
60642
61499
|
*
|
|
@@ -60773,7 +61630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60773
61630
|
/**
|
|
60774
61631
|
* Usage service.
|
|
60775
61632
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
60776
|
-
* @version
|
|
61633
|
+
* @version 188.0.0
|
|
60777
61634
|
*/
|
|
60778
61635
|
|
|
60779
61636
|
/**
|
|
@@ -60983,7 +61840,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60983
61840
|
/**
|
|
60984
61841
|
* UserRecordings service.
|
|
60985
61842
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
60986
|
-
* @version
|
|
61843
|
+
* @version 188.0.0
|
|
60987
61844
|
*/
|
|
60988
61845
|
|
|
60989
61846
|
/**
|
|
@@ -61168,7 +62025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61168
62025
|
/**
|
|
61169
62026
|
* Users service.
|
|
61170
62027
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
61171
|
-
* @version
|
|
62028
|
+
* @version 188.0.0
|
|
61172
62029
|
*/
|
|
61173
62030
|
|
|
61174
62031
|
/**
|
|
@@ -63819,7 +64676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63819
64676
|
/**
|
|
63820
64677
|
* Utilities service.
|
|
63821
64678
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
63822
|
-
* @version
|
|
64679
|
+
* @version 188.0.0
|
|
63823
64680
|
*/
|
|
63824
64681
|
|
|
63825
64682
|
/**
|
|
@@ -63930,7 +64787,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63930
64787
|
/**
|
|
63931
64788
|
* Voicemail service.
|
|
63932
64789
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
63933
|
-
* @version
|
|
64790
|
+
* @version 188.0.0
|
|
63934
64791
|
*/
|
|
63935
64792
|
|
|
63936
64793
|
/**
|
|
@@ -64597,7 +65454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64597
65454
|
/**
|
|
64598
65455
|
* WebChat service.
|
|
64599
65456
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
64600
|
-
* @version
|
|
65457
|
+
* @version 188.0.0
|
|
64601
65458
|
*/
|
|
64602
65459
|
|
|
64603
65460
|
/**
|
|
@@ -65146,7 +66003,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65146
66003
|
/**
|
|
65147
66004
|
* WebDeployments service.
|
|
65148
66005
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
65149
|
-
* @version
|
|
66006
|
+
* @version 188.0.0
|
|
65150
66007
|
*/
|
|
65151
66008
|
|
|
65152
66009
|
/**
|
|
@@ -65673,7 +66530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65673
66530
|
/**
|
|
65674
66531
|
* WebMessaging service.
|
|
65675
66532
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
65676
|
-
* @version
|
|
66533
|
+
* @version 188.0.0
|
|
65677
66534
|
*/
|
|
65678
66535
|
|
|
65679
66536
|
/**
|
|
@@ -65719,7 +66576,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65719
66576
|
/**
|
|
65720
66577
|
* Widgets service.
|
|
65721
66578
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
65722
|
-
* @version
|
|
66579
|
+
* @version 188.0.0
|
|
65723
66580
|
*/
|
|
65724
66581
|
|
|
65725
66582
|
/**
|
|
@@ -65865,7 +66722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65865
66722
|
/**
|
|
65866
66723
|
* WorkforceManagement service.
|
|
65867
66724
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
65868
|
-
* @version
|
|
66725
|
+
* @version 188.0.0
|
|
65869
66726
|
*/
|
|
65870
66727
|
|
|
65871
66728
|
/**
|
|
@@ -71260,7 +72117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71260
72117
|
* </pre>
|
|
71261
72118
|
* </p>
|
|
71262
72119
|
* @module purecloud-platform-client-v2/index
|
|
71263
|
-
* @version
|
|
72120
|
+
* @version 188.0.0
|
|
71264
72121
|
*/
|
|
71265
72122
|
class platformClient {
|
|
71266
72123
|
constructor() {
|
|
@@ -71524,6 +72381,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71524
72381
|
* @property {module:purecloud-platform-client-v2/api/SCIMApi}
|
|
71525
72382
|
*/
|
|
71526
72383
|
this.SCIMApi = SCIMApi;
|
|
72384
|
+
/**
|
|
72385
|
+
* The ScreenRecordingApi service constructor.
|
|
72386
|
+
* @property {module:purecloud-platform-client-v2/api/ScreenRecordingApi}
|
|
72387
|
+
*/
|
|
72388
|
+
this.ScreenRecordingApi = ScreenRecordingApi;
|
|
71527
72389
|
/**
|
|
71528
72390
|
* The ScriptsApi service constructor.
|
|
71529
72391
|
* @property {module:purecloud-platform-client-v2/api/ScriptsApi}
|