purecloud-platform-client-v2 143.0.0 → 146.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 +1884 -74
- package/dist/web-amd/purecloud-platform-client-v2.js +1884 -74
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1884 -74
- package/dist/web-cjs/purecloud-platform-client-v2.js +1884 -74
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +896 -14
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +1 -0
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +211 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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 +4 -8
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1778 -246
- 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 +26 -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/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +21 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -17,6 +17,7 @@ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
|
|
|
17
17
|
eu_west_2: 'euw2.pure.cloud',
|
|
18
18
|
ap_south_1: 'aps1.pure.cloud',
|
|
19
19
|
us_east_2: 'use2.us-gov-pure.cloud',
|
|
20
|
+
sa_east_1: 'sae1.pure.cloud',
|
|
20
21
|
};
|
|
21
22
|
|
|
22
23
|
const logLevels = {
|
|
@@ -398,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
398
399
|
|
|
399
400
|
/**
|
|
400
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
401
|
-
* @version
|
|
402
|
+
* @version 146.0.0
|
|
402
403
|
*/
|
|
403
404
|
class ApiClient {
|
|
404
405
|
/**
|
|
@@ -1477,7 +1478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1477
1478
|
/**
|
|
1478
1479
|
* Alerting service.
|
|
1479
1480
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1480
|
-
* @version
|
|
1481
|
+
* @version 146.0.0
|
|
1481
1482
|
*/
|
|
1482
1483
|
|
|
1483
1484
|
/**
|
|
@@ -1791,7 +1792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1791
1792
|
/**
|
|
1792
1793
|
* Analytics service.
|
|
1793
1794
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1794
|
-
* @version
|
|
1795
|
+
* @version 146.0.0
|
|
1795
1796
|
*/
|
|
1796
1797
|
|
|
1797
1798
|
/**
|
|
@@ -2973,7 +2974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2973
2974
|
/**
|
|
2974
2975
|
* Architect service.
|
|
2975
2976
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2976
|
-
* @version
|
|
2977
|
+
* @version 146.0.0
|
|
2977
2978
|
*/
|
|
2978
2979
|
|
|
2979
2980
|
/**
|
|
@@ -3731,6 +3732,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3731
3732
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
3732
3733
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
3733
3734
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
3735
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
3734
3736
|
*/
|
|
3735
3737
|
getArchitectIvrs(opts) {
|
|
3736
3738
|
opts = opts || {};
|
|
@@ -3740,7 +3742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3740
3742
|
'/api/v2/architect/ivrs',
|
|
3741
3743
|
'GET',
|
|
3742
3744
|
{ },
|
|
3743
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
3745
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
3744
3746
|
{ },
|
|
3745
3747
|
{ },
|
|
3746
3748
|
null,
|
|
@@ -6018,7 +6020,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6018
6020
|
/**
|
|
6019
6021
|
* Audit service.
|
|
6020
6022
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6021
|
-
* @version
|
|
6023
|
+
* @version 146.0.0
|
|
6022
6024
|
*/
|
|
6023
6025
|
|
|
6024
6026
|
/**
|
|
@@ -6189,7 +6191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6189
6191
|
/**
|
|
6190
6192
|
* Authorization service.
|
|
6191
6193
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6192
|
-
* @version
|
|
6194
|
+
* @version 146.0.0
|
|
6193
6195
|
*/
|
|
6194
6196
|
|
|
6195
6197
|
/**
|
|
@@ -7372,7 +7374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7372
7374
|
/**
|
|
7373
7375
|
* Billing service.
|
|
7374
7376
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7375
|
-
* @version
|
|
7377
|
+
* @version 146.0.0
|
|
7376
7378
|
*/
|
|
7377
7379
|
|
|
7378
7380
|
/**
|
|
@@ -7452,7 +7454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7452
7454
|
/**
|
|
7453
7455
|
* Chat service.
|
|
7454
7456
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7455
|
-
* @version
|
|
7457
|
+
* @version 146.0.0
|
|
7456
7458
|
*/
|
|
7457
7459
|
|
|
7458
7460
|
/**
|
|
@@ -7543,7 +7545,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7543
7545
|
/**
|
|
7544
7546
|
* Coaching service.
|
|
7545
7547
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7546
|
-
* @version
|
|
7548
|
+
* @version 146.0.0
|
|
7547
7549
|
*/
|
|
7548
7550
|
|
|
7549
7551
|
/**
|
|
@@ -8120,7 +8122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8120
8122
|
/**
|
|
8121
8123
|
* ContentManagement service.
|
|
8122
8124
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8123
|
-
* @version
|
|
8125
|
+
* @version 146.0.0
|
|
8124
8126
|
*/
|
|
8125
8127
|
|
|
8126
8128
|
/**
|
|
@@ -9260,7 +9262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9260
9262
|
/**
|
|
9261
9263
|
* Conversations service.
|
|
9262
9264
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9263
|
-
* @version
|
|
9265
|
+
* @version 146.0.0
|
|
9264
9266
|
*/
|
|
9265
9267
|
|
|
9266
9268
|
/**
|
|
@@ -9853,6 +9855,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9853
9855
|
);
|
|
9854
9856
|
}
|
|
9855
9857
|
|
|
9858
|
+
/**
|
|
9859
|
+
* Get the secure attributes on a conversation.
|
|
9860
|
+
*
|
|
9861
|
+
* @param {String} conversationId conversation ID
|
|
9862
|
+
*/
|
|
9863
|
+
getConversationSecureattributes(conversationId) {
|
|
9864
|
+
// verify the required parameter 'conversationId' is set
|
|
9865
|
+
if (conversationId === undefined || conversationId === null) {
|
|
9866
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
|
|
9867
|
+
}
|
|
9868
|
+
|
|
9869
|
+
return this.apiClient.callApi(
|
|
9870
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
9871
|
+
'GET',
|
|
9872
|
+
{ 'conversationId': conversationId },
|
|
9873
|
+
{ },
|
|
9874
|
+
{ },
|
|
9875
|
+
{ },
|
|
9876
|
+
null,
|
|
9877
|
+
['PureCloud OAuth'],
|
|
9878
|
+
['application/json'],
|
|
9879
|
+
['application/json']
|
|
9880
|
+
);
|
|
9881
|
+
}
|
|
9882
|
+
|
|
9856
9883
|
/**
|
|
9857
9884
|
* Get active conversations for the logged in user
|
|
9858
9885
|
*
|
|
@@ -10636,6 +10663,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10636
10663
|
);
|
|
10637
10664
|
}
|
|
10638
10665
|
|
|
10666
|
+
/**
|
|
10667
|
+
* Get the encryption key configurations
|
|
10668
|
+
*
|
|
10669
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
10670
|
+
*/
|
|
10671
|
+
getConversationsKeyconfiguration(keyconfigurationsId) {
|
|
10672
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
10673
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
10674
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
|
|
10675
|
+
}
|
|
10676
|
+
|
|
10677
|
+
return this.apiClient.callApi(
|
|
10678
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
10679
|
+
'GET',
|
|
10680
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
10681
|
+
{ },
|
|
10682
|
+
{ },
|
|
10683
|
+
{ },
|
|
10684
|
+
null,
|
|
10685
|
+
['PureCloud OAuth'],
|
|
10686
|
+
['application/json'],
|
|
10687
|
+
['application/json']
|
|
10688
|
+
);
|
|
10689
|
+
}
|
|
10690
|
+
|
|
10691
|
+
/**
|
|
10692
|
+
* Get a list of key configurations data
|
|
10693
|
+
*
|
|
10694
|
+
*/
|
|
10695
|
+
getConversationsKeyconfigurations() {
|
|
10696
|
+
|
|
10697
|
+
return this.apiClient.callApi(
|
|
10698
|
+
'/api/v2/conversations/keyconfigurations',
|
|
10699
|
+
'GET',
|
|
10700
|
+
{ },
|
|
10701
|
+
{ },
|
|
10702
|
+
{ },
|
|
10703
|
+
{ },
|
|
10704
|
+
null,
|
|
10705
|
+
['PureCloud OAuth'],
|
|
10706
|
+
['application/json'],
|
|
10707
|
+
['application/json']
|
|
10708
|
+
);
|
|
10709
|
+
}
|
|
10710
|
+
|
|
10639
10711
|
/**
|
|
10640
10712
|
* Get message conversation
|
|
10641
10713
|
*
|
|
@@ -11352,6 +11424,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11352
11424
|
);
|
|
11353
11425
|
}
|
|
11354
11426
|
|
|
11427
|
+
/**
|
|
11428
|
+
* Update the secure attributes on a conversation.
|
|
11429
|
+
*
|
|
11430
|
+
* @param {String} conversationId conversation ID
|
|
11431
|
+
* @param {Object} body Conversation Secure Attributes
|
|
11432
|
+
*/
|
|
11433
|
+
patchConversationSecureattributes(conversationId, body) {
|
|
11434
|
+
// verify the required parameter 'conversationId' is set
|
|
11435
|
+
if (conversationId === undefined || conversationId === null) {
|
|
11436
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
|
|
11437
|
+
}
|
|
11438
|
+
// verify the required parameter 'body' is set
|
|
11439
|
+
if (body === undefined || body === null) {
|
|
11440
|
+
throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
|
|
11441
|
+
}
|
|
11442
|
+
|
|
11443
|
+
return this.apiClient.callApi(
|
|
11444
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
11445
|
+
'PATCH',
|
|
11446
|
+
{ 'conversationId': conversationId },
|
|
11447
|
+
{ },
|
|
11448
|
+
{ },
|
|
11449
|
+
{ },
|
|
11450
|
+
body,
|
|
11451
|
+
['PureCloud OAuth'],
|
|
11452
|
+
['application/json'],
|
|
11453
|
+
['application/json']
|
|
11454
|
+
);
|
|
11455
|
+
}
|
|
11456
|
+
|
|
11355
11457
|
/**
|
|
11356
11458
|
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11357
11459
|
*
|
|
@@ -13354,6 +13456,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13354
13456
|
);
|
|
13355
13457
|
}
|
|
13356
13458
|
|
|
13459
|
+
/**
|
|
13460
|
+
* Setup configurations for encryption key creation
|
|
13461
|
+
*
|
|
13462
|
+
* @param {Object} body Encryption Configuration
|
|
13463
|
+
*/
|
|
13464
|
+
postConversationsKeyconfigurations(body) {
|
|
13465
|
+
// verify the required parameter 'body' is set
|
|
13466
|
+
if (body === undefined || body === null) {
|
|
13467
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
|
|
13468
|
+
}
|
|
13469
|
+
|
|
13470
|
+
return this.apiClient.callApi(
|
|
13471
|
+
'/api/v2/conversations/keyconfigurations',
|
|
13472
|
+
'POST',
|
|
13473
|
+
{ },
|
|
13474
|
+
{ },
|
|
13475
|
+
{ },
|
|
13476
|
+
{ },
|
|
13477
|
+
body,
|
|
13478
|
+
['PureCloud OAuth'],
|
|
13479
|
+
['application/json'],
|
|
13480
|
+
['application/json']
|
|
13481
|
+
);
|
|
13482
|
+
}
|
|
13483
|
+
|
|
13484
|
+
/**
|
|
13485
|
+
* Validate encryption key configurations without saving it
|
|
13486
|
+
*
|
|
13487
|
+
* @param {Object} body Encryption Configuration
|
|
13488
|
+
*/
|
|
13489
|
+
postConversationsKeyconfigurationsValidate(body) {
|
|
13490
|
+
// verify the required parameter 'body' is set
|
|
13491
|
+
if (body === undefined || body === null) {
|
|
13492
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
|
|
13493
|
+
}
|
|
13494
|
+
|
|
13495
|
+
return this.apiClient.callApi(
|
|
13496
|
+
'/api/v2/conversations/keyconfigurations/validate',
|
|
13497
|
+
'POST',
|
|
13498
|
+
{ },
|
|
13499
|
+
{ },
|
|
13500
|
+
{ },
|
|
13501
|
+
{ },
|
|
13502
|
+
body,
|
|
13503
|
+
['PureCloud OAuth'],
|
|
13504
|
+
['application/json'],
|
|
13505
|
+
['application/json']
|
|
13506
|
+
);
|
|
13507
|
+
}
|
|
13508
|
+
|
|
13357
13509
|
/**
|
|
13358
13510
|
* Send message
|
|
13359
13511
|
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.
|
|
@@ -13738,6 +13890,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13738
13890
|
);
|
|
13739
13891
|
}
|
|
13740
13892
|
|
|
13893
|
+
/**
|
|
13894
|
+
* Set the secure attributes on a conversation.
|
|
13895
|
+
*
|
|
13896
|
+
* @param {String} conversationId conversation ID
|
|
13897
|
+
* @param {Object} body Conversation Secure Attributes
|
|
13898
|
+
*/
|
|
13899
|
+
putConversationSecureattributes(conversationId, body) {
|
|
13900
|
+
// verify the required parameter 'conversationId' is set
|
|
13901
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13902
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
|
|
13903
|
+
}
|
|
13904
|
+
// verify the required parameter 'body' is set
|
|
13905
|
+
if (body === undefined || body === null) {
|
|
13906
|
+
throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
|
|
13907
|
+
}
|
|
13908
|
+
|
|
13909
|
+
return this.apiClient.callApi(
|
|
13910
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
13911
|
+
'PUT',
|
|
13912
|
+
{ 'conversationId': conversationId },
|
|
13913
|
+
{ },
|
|
13914
|
+
{ },
|
|
13915
|
+
{ },
|
|
13916
|
+
body,
|
|
13917
|
+
['PureCloud OAuth'],
|
|
13918
|
+
['application/json'],
|
|
13919
|
+
['application/json']
|
|
13920
|
+
);
|
|
13921
|
+
}
|
|
13922
|
+
|
|
13741
13923
|
/**
|
|
13742
13924
|
* Update the tags on a conversation.
|
|
13743
13925
|
*
|
|
@@ -13988,6 +14170,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13988
14170
|
);
|
|
13989
14171
|
}
|
|
13990
14172
|
|
|
14173
|
+
/**
|
|
14174
|
+
* Update the encryption key configurations
|
|
14175
|
+
*
|
|
14176
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
14177
|
+
* @param {Object} body Encryption key configuration metadata
|
|
14178
|
+
*/
|
|
14179
|
+
putConversationsKeyconfiguration(keyconfigurationsId, body) {
|
|
14180
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
14181
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
14182
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
|
|
14183
|
+
}
|
|
14184
|
+
// verify the required parameter 'body' is set
|
|
14185
|
+
if (body === undefined || body === null) {
|
|
14186
|
+
throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
|
|
14187
|
+
}
|
|
14188
|
+
|
|
14189
|
+
return this.apiClient.callApi(
|
|
14190
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
14191
|
+
'PUT',
|
|
14192
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
14193
|
+
{ },
|
|
14194
|
+
{ },
|
|
14195
|
+
{ },
|
|
14196
|
+
body,
|
|
14197
|
+
['PureCloud OAuth'],
|
|
14198
|
+
['application/json'],
|
|
14199
|
+
['application/json']
|
|
14200
|
+
);
|
|
14201
|
+
}
|
|
14202
|
+
|
|
13991
14203
|
/**
|
|
13992
14204
|
* Update a conversation by setting its recording state
|
|
13993
14205
|
*
|
|
@@ -14194,7 +14406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14194
14406
|
/**
|
|
14195
14407
|
* DataExtensions service.
|
|
14196
14408
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14197
|
-
* @version
|
|
14409
|
+
* @version 146.0.0
|
|
14198
14410
|
*/
|
|
14199
14411
|
|
|
14200
14412
|
/**
|
|
@@ -14280,7 +14492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14280
14492
|
/**
|
|
14281
14493
|
* ExternalContacts service.
|
|
14282
14494
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14283
|
-
* @version
|
|
14495
|
+
* @version 146.0.0
|
|
14284
14496
|
*/
|
|
14285
14497
|
|
|
14286
14498
|
/**
|
|
@@ -16023,7 +16235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16023
16235
|
/**
|
|
16024
16236
|
* Fax service.
|
|
16025
16237
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16026
|
-
* @version
|
|
16238
|
+
* @version 146.0.0
|
|
16027
16239
|
*/
|
|
16028
16240
|
|
|
16029
16241
|
/**
|
|
@@ -16194,7 +16406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16194
16406
|
/**
|
|
16195
16407
|
* Flows service.
|
|
16196
16408
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16197
|
-
* @version
|
|
16409
|
+
* @version 146.0.0
|
|
16198
16410
|
*/
|
|
16199
16411
|
|
|
16200
16412
|
/**
|
|
@@ -16265,7 +16477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16265
16477
|
/**
|
|
16266
16478
|
* Gamification service.
|
|
16267
16479
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16268
|
-
* @version
|
|
16480
|
+
* @version 146.0.0
|
|
16269
16481
|
*/
|
|
16270
16482
|
|
|
16271
16483
|
/**
|
|
@@ -17019,14 +17231,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17019
17231
|
* @param {String} profileId performanceProfileId
|
|
17020
17232
|
* @param {String} metricId metricId
|
|
17021
17233
|
* @param {Object} filterType Filter type for the query request.
|
|
17022
|
-
* @param {String} filterId ID for the filter type. For example, division Id
|
|
17023
17234
|
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17024
17235
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17025
17236
|
* @param {Object} opts Optional parameters
|
|
17237
|
+
* @param {String} opts.filterId ID for the filter type. Only required when filterType is Division.
|
|
17026
17238
|
* @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17027
17239
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
17028
17240
|
*/
|
|
17029
|
-
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType,
|
|
17241
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, opts) {
|
|
17030
17242
|
opts = opts || {};
|
|
17031
17243
|
|
|
17032
17244
|
// verify the required parameter 'profileId' is set
|
|
@@ -17041,10 +17253,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17041
17253
|
if (filterType === undefined || filterType === null) {
|
|
17042
17254
|
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
17043
17255
|
}
|
|
17044
|
-
// verify the required parameter 'filterId' is set
|
|
17045
|
-
if (filterId === undefined || filterId === null) {
|
|
17046
|
-
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
17047
|
-
}
|
|
17048
17256
|
// verify the required parameter 'startWorkday' is set
|
|
17049
17257
|
if (startWorkday === undefined || startWorkday === null) {
|
|
17050
17258
|
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
@@ -17058,7 +17266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17058
17266
|
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
17059
17267
|
'GET',
|
|
17060
17268
|
{ 'profileId': profileId,'metricId': metricId },
|
|
17061
|
-
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17269
|
+
{ 'filterType': filterType,'filterId': opts['filterId'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17062
17270
|
{ },
|
|
17063
17271
|
{ },
|
|
17064
17272
|
null,
|
|
@@ -18000,7 +18208,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18000
18208
|
/**
|
|
18001
18209
|
* GeneralDataProtectionRegulation service.
|
|
18002
18210
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18003
|
-
* @version
|
|
18211
|
+
* @version 146.0.0
|
|
18004
18212
|
*/
|
|
18005
18213
|
|
|
18006
18214
|
/**
|
|
@@ -18130,7 +18338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18130
18338
|
/**
|
|
18131
18339
|
* Geolocation service.
|
|
18132
18340
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18133
|
-
* @version
|
|
18341
|
+
* @version 146.0.0
|
|
18134
18342
|
*/
|
|
18135
18343
|
|
|
18136
18344
|
/**
|
|
@@ -18261,7 +18469,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18261
18469
|
/**
|
|
18262
18470
|
* Greetings service.
|
|
18263
18471
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18264
|
-
* @version
|
|
18472
|
+
* @version 146.0.0
|
|
18265
18473
|
*/
|
|
18266
18474
|
|
|
18267
18475
|
/**
|
|
@@ -18716,7 +18924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18716
18924
|
/**
|
|
18717
18925
|
* Groups service.
|
|
18718
18926
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18719
|
-
* @version
|
|
18927
|
+
* @version 146.0.0
|
|
18720
18928
|
*/
|
|
18721
18929
|
|
|
18722
18930
|
/**
|
|
@@ -19121,7 +19329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19121
19329
|
/**
|
|
19122
19330
|
* IdentityProvider service.
|
|
19123
19331
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19124
|
-
* @version
|
|
19332
|
+
* @version 146.0.0
|
|
19125
19333
|
*/
|
|
19126
19334
|
|
|
19127
19335
|
/**
|
|
@@ -19877,7 +20085,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19877
20085
|
/**
|
|
19878
20086
|
* Integrations service.
|
|
19879
20087
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19880
|
-
* @version
|
|
20088
|
+
* @version 146.0.0
|
|
19881
20089
|
*/
|
|
19882
20090
|
|
|
19883
20091
|
/**
|
|
@@ -21554,7 +21762,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21554
21762
|
/**
|
|
21555
21763
|
* Journey service.
|
|
21556
21764
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21557
|
-
* @version
|
|
21765
|
+
* @version 146.0.0
|
|
21558
21766
|
*/
|
|
21559
21767
|
|
|
21560
21768
|
/**
|
|
@@ -22265,7 +22473,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22265
22473
|
/**
|
|
22266
22474
|
* Knowledge service.
|
|
22267
22475
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22268
|
-
* @version
|
|
22476
|
+
* @version 146.0.0
|
|
22269
22477
|
*/
|
|
22270
22478
|
|
|
22271
22479
|
/**
|
|
@@ -22305,6 +22513,191 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22305
22513
|
);
|
|
22306
22514
|
}
|
|
22307
22515
|
|
|
22516
|
+
/**
|
|
22517
|
+
* Delete category
|
|
22518
|
+
*
|
|
22519
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22520
|
+
* @param {String} categoryId Category ID
|
|
22521
|
+
*/
|
|
22522
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
22523
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22524
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22525
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
22526
|
+
}
|
|
22527
|
+
// verify the required parameter 'categoryId' is set
|
|
22528
|
+
if (categoryId === undefined || categoryId === null) {
|
|
22529
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
22530
|
+
}
|
|
22531
|
+
|
|
22532
|
+
return this.apiClient.callApi(
|
|
22533
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
22534
|
+
'DELETE',
|
|
22535
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
22536
|
+
{ },
|
|
22537
|
+
{ },
|
|
22538
|
+
{ },
|
|
22539
|
+
null,
|
|
22540
|
+
['PureCloud OAuth'],
|
|
22541
|
+
['application/json'],
|
|
22542
|
+
['application/json']
|
|
22543
|
+
);
|
|
22544
|
+
}
|
|
22545
|
+
|
|
22546
|
+
/**
|
|
22547
|
+
* Delete document.
|
|
22548
|
+
*
|
|
22549
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
22550
|
+
* @param {String} documentId Document ID.
|
|
22551
|
+
*/
|
|
22552
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
22553
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22554
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22555
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
22556
|
+
}
|
|
22557
|
+
// verify the required parameter 'documentId' is set
|
|
22558
|
+
if (documentId === undefined || documentId === null) {
|
|
22559
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
22560
|
+
}
|
|
22561
|
+
|
|
22562
|
+
return this.apiClient.callApi(
|
|
22563
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
22564
|
+
'DELETE',
|
|
22565
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
22566
|
+
{ },
|
|
22567
|
+
{ },
|
|
22568
|
+
{ },
|
|
22569
|
+
null,
|
|
22570
|
+
['PureCloud OAuth'],
|
|
22571
|
+
['application/json'],
|
|
22572
|
+
['application/json']
|
|
22573
|
+
);
|
|
22574
|
+
}
|
|
22575
|
+
|
|
22576
|
+
/**
|
|
22577
|
+
* Delete a variation for a document.
|
|
22578
|
+
*
|
|
22579
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
22580
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
22581
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
22582
|
+
*/
|
|
22583
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
22584
|
+
// verify the required parameter 'documentVariationId' is set
|
|
22585
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
22586
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22587
|
+
}
|
|
22588
|
+
// verify the required parameter 'documentId' is set
|
|
22589
|
+
if (documentId === undefined || documentId === null) {
|
|
22590
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22591
|
+
}
|
|
22592
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22593
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22594
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22595
|
+
}
|
|
22596
|
+
|
|
22597
|
+
return this.apiClient.callApi(
|
|
22598
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
22599
|
+
'DELETE',
|
|
22600
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
22601
|
+
{ },
|
|
22602
|
+
{ },
|
|
22603
|
+
{ },
|
|
22604
|
+
null,
|
|
22605
|
+
['PureCloud OAuth'],
|
|
22606
|
+
['application/json'],
|
|
22607
|
+
['application/json']
|
|
22608
|
+
);
|
|
22609
|
+
}
|
|
22610
|
+
|
|
22611
|
+
/**
|
|
22612
|
+
* Delete export job
|
|
22613
|
+
*
|
|
22614
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22615
|
+
* @param {String} exportJobId Export job ID
|
|
22616
|
+
*/
|
|
22617
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
22618
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22619
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22620
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
22621
|
+
}
|
|
22622
|
+
// verify the required parameter 'exportJobId' is set
|
|
22623
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
22624
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
22625
|
+
}
|
|
22626
|
+
|
|
22627
|
+
return this.apiClient.callApi(
|
|
22628
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
22629
|
+
'DELETE',
|
|
22630
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
22631
|
+
{ },
|
|
22632
|
+
{ },
|
|
22633
|
+
{ },
|
|
22634
|
+
null,
|
|
22635
|
+
['PureCloud OAuth'],
|
|
22636
|
+
['application/json'],
|
|
22637
|
+
['application/json']
|
|
22638
|
+
);
|
|
22639
|
+
}
|
|
22640
|
+
|
|
22641
|
+
/**
|
|
22642
|
+
* Delete import job
|
|
22643
|
+
*
|
|
22644
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22645
|
+
* @param {String} importJobId Import job ID
|
|
22646
|
+
*/
|
|
22647
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
22648
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22649
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22650
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
22651
|
+
}
|
|
22652
|
+
// verify the required parameter 'importJobId' is set
|
|
22653
|
+
if (importJobId === undefined || importJobId === null) {
|
|
22654
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
22655
|
+
}
|
|
22656
|
+
|
|
22657
|
+
return this.apiClient.callApi(
|
|
22658
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
22659
|
+
'DELETE',
|
|
22660
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
22661
|
+
{ },
|
|
22662
|
+
{ },
|
|
22663
|
+
{ },
|
|
22664
|
+
null,
|
|
22665
|
+
['PureCloud OAuth'],
|
|
22666
|
+
['application/json'],
|
|
22667
|
+
['application/json']
|
|
22668
|
+
);
|
|
22669
|
+
}
|
|
22670
|
+
|
|
22671
|
+
/**
|
|
22672
|
+
* Delete label
|
|
22673
|
+
*
|
|
22674
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22675
|
+
* @param {String} labelId Label ID
|
|
22676
|
+
*/
|
|
22677
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
22678
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22679
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22680
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
22681
|
+
}
|
|
22682
|
+
// verify the required parameter 'labelId' is set
|
|
22683
|
+
if (labelId === undefined || labelId === null) {
|
|
22684
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
22685
|
+
}
|
|
22686
|
+
|
|
22687
|
+
return this.apiClient.callApi(
|
|
22688
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
22689
|
+
'DELETE',
|
|
22690
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
22691
|
+
{ },
|
|
22692
|
+
{ },
|
|
22693
|
+
{ },
|
|
22694
|
+
null,
|
|
22695
|
+
['PureCloud OAuth'],
|
|
22696
|
+
['application/json'],
|
|
22697
|
+
['application/json']
|
|
22698
|
+
);
|
|
22699
|
+
}
|
|
22700
|
+
|
|
22308
22701
|
/**
|
|
22309
22702
|
* Delete category
|
|
22310
22703
|
*
|
|
@@ -22410,6 +22803,104 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22410
22803
|
);
|
|
22411
22804
|
}
|
|
22412
22805
|
|
|
22806
|
+
/**
|
|
22807
|
+
* Get categories
|
|
22808
|
+
*
|
|
22809
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22810
|
+
* @param {Object} opts Optional parameters
|
|
22811
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22812
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22813
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22814
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
22815
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
22816
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
22817
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
22818
|
+
* @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
|
|
22819
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
22820
|
+
*/
|
|
22821
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
22822
|
+
opts = opts || {};
|
|
22823
|
+
|
|
22824
|
+
// verify the required parameter 'sessionId' is set
|
|
22825
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22826
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
22827
|
+
}
|
|
22828
|
+
|
|
22829
|
+
return this.apiClient.callApi(
|
|
22830
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
22831
|
+
'GET',
|
|
22832
|
+
{ 'sessionId': sessionId },
|
|
22833
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
22834
|
+
{ },
|
|
22835
|
+
{ },
|
|
22836
|
+
null,
|
|
22837
|
+
['PureCloud OAuth'],
|
|
22838
|
+
['application/json'],
|
|
22839
|
+
['application/json']
|
|
22840
|
+
);
|
|
22841
|
+
}
|
|
22842
|
+
|
|
22843
|
+
/**
|
|
22844
|
+
* Get a knowledge document by ID.
|
|
22845
|
+
*
|
|
22846
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22847
|
+
* @param {String} documentId Document ID
|
|
22848
|
+
*/
|
|
22849
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
22850
|
+
// verify the required parameter 'sessionId' is set
|
|
22851
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22852
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
22853
|
+
}
|
|
22854
|
+
// verify the required parameter 'documentId' is set
|
|
22855
|
+
if (documentId === undefined || documentId === null) {
|
|
22856
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
22857
|
+
}
|
|
22858
|
+
|
|
22859
|
+
return this.apiClient.callApi(
|
|
22860
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
22861
|
+
'GET',
|
|
22862
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
22863
|
+
{ },
|
|
22864
|
+
{ },
|
|
22865
|
+
{ },
|
|
22866
|
+
null,
|
|
22867
|
+
['PureCloud OAuth'],
|
|
22868
|
+
['application/json'],
|
|
22869
|
+
['application/json']
|
|
22870
|
+
);
|
|
22871
|
+
}
|
|
22872
|
+
|
|
22873
|
+
/**
|
|
22874
|
+
* Get documents.
|
|
22875
|
+
*
|
|
22876
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22877
|
+
* @param {Object} opts Optional parameters
|
|
22878
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
22879
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
22880
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22881
|
+
*/
|
|
22882
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
22883
|
+
opts = opts || {};
|
|
22884
|
+
|
|
22885
|
+
// verify the required parameter 'sessionId' is set
|
|
22886
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22887
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
22888
|
+
}
|
|
22889
|
+
|
|
22890
|
+
return this.apiClient.callApi(
|
|
22891
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
22892
|
+
'GET',
|
|
22893
|
+
{ 'sessionId': sessionId },
|
|
22894
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
22895
|
+
{ },
|
|
22896
|
+
{ },
|
|
22897
|
+
null,
|
|
22898
|
+
['PureCloud OAuth'],
|
|
22899
|
+
['application/json'],
|
|
22900
|
+
['application/json']
|
|
22901
|
+
);
|
|
22902
|
+
}
|
|
22903
|
+
|
|
22413
22904
|
/**
|
|
22414
22905
|
* Get knowledge base
|
|
22415
22906
|
*
|
|
@@ -22435,6 +22926,501 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22435
22926
|
);
|
|
22436
22927
|
}
|
|
22437
22928
|
|
|
22929
|
+
/**
|
|
22930
|
+
* Get categories
|
|
22931
|
+
*
|
|
22932
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22933
|
+
* @param {Object} opts Optional parameters
|
|
22934
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22935
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22936
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22937
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
22938
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
22939
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
22940
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
22941
|
+
* @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
|
|
22942
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
22943
|
+
*/
|
|
22944
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
22945
|
+
opts = opts || {};
|
|
22946
|
+
|
|
22947
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22948
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22949
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
22950
|
+
}
|
|
22951
|
+
|
|
22952
|
+
return this.apiClient.callApi(
|
|
22953
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
22954
|
+
'GET',
|
|
22955
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
22956
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
22957
|
+
{ },
|
|
22958
|
+
{ },
|
|
22959
|
+
null,
|
|
22960
|
+
['PureCloud OAuth'],
|
|
22961
|
+
['application/json'],
|
|
22962
|
+
['application/json']
|
|
22963
|
+
);
|
|
22964
|
+
}
|
|
22965
|
+
|
|
22966
|
+
/**
|
|
22967
|
+
* Get category
|
|
22968
|
+
*
|
|
22969
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22970
|
+
* @param {String} categoryId Category ID
|
|
22971
|
+
*/
|
|
22972
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
22973
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22974
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22975
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
22976
|
+
}
|
|
22977
|
+
// verify the required parameter 'categoryId' is set
|
|
22978
|
+
if (categoryId === undefined || categoryId === null) {
|
|
22979
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
22980
|
+
}
|
|
22981
|
+
|
|
22982
|
+
return this.apiClient.callApi(
|
|
22983
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
22984
|
+
'GET',
|
|
22985
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
22986
|
+
{ },
|
|
22987
|
+
{ },
|
|
22988
|
+
{ },
|
|
22989
|
+
null,
|
|
22990
|
+
['PureCloud OAuth'],
|
|
22991
|
+
['application/json'],
|
|
22992
|
+
['application/json']
|
|
22993
|
+
);
|
|
22994
|
+
}
|
|
22995
|
+
|
|
22996
|
+
/**
|
|
22997
|
+
* Get document.
|
|
22998
|
+
*
|
|
22999
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23000
|
+
* @param {String} documentId Document ID.
|
|
23001
|
+
* @param {Object} opts Optional parameters
|
|
23002
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.
|
|
23003
|
+
* @param {Object} opts.state when state is Draft, draft version of the document is returned,otherwise by default published version is returned in the response.
|
|
23004
|
+
*/
|
|
23005
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
23006
|
+
opts = opts || {};
|
|
23007
|
+
|
|
23008
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23009
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23010
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
23011
|
+
}
|
|
23012
|
+
// verify the required parameter 'documentId' is set
|
|
23013
|
+
if (documentId === undefined || documentId === null) {
|
|
23014
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
23015
|
+
}
|
|
23016
|
+
|
|
23017
|
+
return this.apiClient.callApi(
|
|
23018
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
23019
|
+
'GET',
|
|
23020
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23021
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
23022
|
+
{ },
|
|
23023
|
+
{ },
|
|
23024
|
+
null,
|
|
23025
|
+
['PureCloud OAuth'],
|
|
23026
|
+
['application/json'],
|
|
23027
|
+
['application/json']
|
|
23028
|
+
);
|
|
23029
|
+
}
|
|
23030
|
+
|
|
23031
|
+
/**
|
|
23032
|
+
* Get a variation for a document.
|
|
23033
|
+
*
|
|
23034
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
23035
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
23036
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
23037
|
+
* @param {Object} opts Optional parameters
|
|
23038
|
+
* @param {Object} opts.documentState The state of the document.
|
|
23039
|
+
*/
|
|
23040
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
23041
|
+
opts = opts || {};
|
|
23042
|
+
|
|
23043
|
+
// verify the required parameter 'documentVariationId' is set
|
|
23044
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
23045
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23046
|
+
}
|
|
23047
|
+
// verify the required parameter 'documentId' is set
|
|
23048
|
+
if (documentId === undefined || documentId === null) {
|
|
23049
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23050
|
+
}
|
|
23051
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23052
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23053
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23054
|
+
}
|
|
23055
|
+
|
|
23056
|
+
return this.apiClient.callApi(
|
|
23057
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
23058
|
+
'GET',
|
|
23059
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
23060
|
+
{ 'documentState': opts['documentState'] },
|
|
23061
|
+
{ },
|
|
23062
|
+
{ },
|
|
23063
|
+
null,
|
|
23064
|
+
['PureCloud OAuth'],
|
|
23065
|
+
['application/json'],
|
|
23066
|
+
['application/json']
|
|
23067
|
+
);
|
|
23068
|
+
}
|
|
23069
|
+
|
|
23070
|
+
/**
|
|
23071
|
+
* Get variations for a document.
|
|
23072
|
+
*
|
|
23073
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23074
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23075
|
+
* @param {Object} opts Optional parameters
|
|
23076
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23077
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23078
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23079
|
+
* @param {Object} opts.documentState The state of the document.
|
|
23080
|
+
*/
|
|
23081
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
23082
|
+
opts = opts || {};
|
|
23083
|
+
|
|
23084
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23085
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23086
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
23087
|
+
}
|
|
23088
|
+
// verify the required parameter 'documentId' is set
|
|
23089
|
+
if (documentId === undefined || documentId === null) {
|
|
23090
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
23091
|
+
}
|
|
23092
|
+
|
|
23093
|
+
return this.apiClient.callApi(
|
|
23094
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
23095
|
+
'GET',
|
|
23096
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23097
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
23098
|
+
{ },
|
|
23099
|
+
{ },
|
|
23100
|
+
null,
|
|
23101
|
+
['PureCloud OAuth'],
|
|
23102
|
+
['application/json'],
|
|
23103
|
+
['application/json']
|
|
23104
|
+
);
|
|
23105
|
+
}
|
|
23106
|
+
|
|
23107
|
+
/**
|
|
23108
|
+
* Get document version.
|
|
23109
|
+
*
|
|
23110
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23111
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23112
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23113
|
+
* @param {Object} opts Optional parameters
|
|
23114
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23115
|
+
*/
|
|
23116
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
23117
|
+
opts = opts || {};
|
|
23118
|
+
|
|
23119
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23120
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23121
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23122
|
+
}
|
|
23123
|
+
// verify the required parameter 'documentId' is set
|
|
23124
|
+
if (documentId === undefined || documentId === null) {
|
|
23125
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23126
|
+
}
|
|
23127
|
+
// verify the required parameter 'versionId' is set
|
|
23128
|
+
if (versionId === undefined || versionId === null) {
|
|
23129
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23130
|
+
}
|
|
23131
|
+
|
|
23132
|
+
return this.apiClient.callApi(
|
|
23133
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
23134
|
+
'GET',
|
|
23135
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
23136
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23137
|
+
{ },
|
|
23138
|
+
{ },
|
|
23139
|
+
null,
|
|
23140
|
+
['PureCloud OAuth'],
|
|
23141
|
+
['application/json'],
|
|
23142
|
+
['application/json']
|
|
23143
|
+
);
|
|
23144
|
+
}
|
|
23145
|
+
|
|
23146
|
+
/**
|
|
23147
|
+
* Get variation for the given document version.
|
|
23148
|
+
*
|
|
23149
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23150
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23151
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23152
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
23153
|
+
*/
|
|
23154
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
23155
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23156
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23157
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23158
|
+
}
|
|
23159
|
+
// verify the required parameter 'documentId' is set
|
|
23160
|
+
if (documentId === undefined || documentId === null) {
|
|
23161
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23162
|
+
}
|
|
23163
|
+
// verify the required parameter 'versionId' is set
|
|
23164
|
+
if (versionId === undefined || versionId === null) {
|
|
23165
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23166
|
+
}
|
|
23167
|
+
// verify the required parameter 'variationId' is set
|
|
23168
|
+
if (variationId === undefined || variationId === null) {
|
|
23169
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23170
|
+
}
|
|
23171
|
+
|
|
23172
|
+
return this.apiClient.callApi(
|
|
23173
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
23174
|
+
'GET',
|
|
23175
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
23176
|
+
{ },
|
|
23177
|
+
{ },
|
|
23178
|
+
{ },
|
|
23179
|
+
null,
|
|
23180
|
+
['PureCloud OAuth'],
|
|
23181
|
+
['application/json'],
|
|
23182
|
+
['application/json']
|
|
23183
|
+
);
|
|
23184
|
+
}
|
|
23185
|
+
|
|
23186
|
+
/**
|
|
23187
|
+
* Get variations for the given document version.
|
|
23188
|
+
*
|
|
23189
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23190
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23191
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23192
|
+
* @param {Object} opts Optional parameters
|
|
23193
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23194
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23195
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23196
|
+
*/
|
|
23197
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
23198
|
+
opts = opts || {};
|
|
23199
|
+
|
|
23200
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23201
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23202
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23203
|
+
}
|
|
23204
|
+
// verify the required parameter 'documentId' is set
|
|
23205
|
+
if (documentId === undefined || documentId === null) {
|
|
23206
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23207
|
+
}
|
|
23208
|
+
// verify the required parameter 'versionId' is set
|
|
23209
|
+
if (versionId === undefined || versionId === null) {
|
|
23210
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23211
|
+
}
|
|
23212
|
+
|
|
23213
|
+
return this.apiClient.callApi(
|
|
23214
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
23215
|
+
'GET',
|
|
23216
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
23217
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
23218
|
+
{ },
|
|
23219
|
+
{ },
|
|
23220
|
+
null,
|
|
23221
|
+
['PureCloud OAuth'],
|
|
23222
|
+
['application/json'],
|
|
23223
|
+
['application/json']
|
|
23224
|
+
);
|
|
23225
|
+
}
|
|
23226
|
+
|
|
23227
|
+
/**
|
|
23228
|
+
* Get document versions.
|
|
23229
|
+
*
|
|
23230
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23231
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23232
|
+
* @param {Object} opts Optional parameters
|
|
23233
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23234
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23235
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23236
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23237
|
+
*/
|
|
23238
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
23239
|
+
opts = opts || {};
|
|
23240
|
+
|
|
23241
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23242
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23243
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
23244
|
+
}
|
|
23245
|
+
// verify the required parameter 'documentId' is set
|
|
23246
|
+
if (documentId === undefined || documentId === null) {
|
|
23247
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
23248
|
+
}
|
|
23249
|
+
|
|
23250
|
+
return this.apiClient.callApi(
|
|
23251
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
23252
|
+
'GET',
|
|
23253
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23254
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23255
|
+
{ },
|
|
23256
|
+
{ },
|
|
23257
|
+
null,
|
|
23258
|
+
['PureCloud OAuth'],
|
|
23259
|
+
['application/json'],
|
|
23260
|
+
['application/json']
|
|
23261
|
+
);
|
|
23262
|
+
}
|
|
23263
|
+
|
|
23264
|
+
/**
|
|
23265
|
+
* Get documents.
|
|
23266
|
+
*
|
|
23267
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23268
|
+
* @param {Object} opts Optional parameters
|
|
23269
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23270
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23271
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23272
|
+
* @param {String} opts.interval Retrieves the documents 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
|
|
23273
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23274
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23275
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
23276
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
23277
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23278
|
+
*/
|
|
23279
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
23280
|
+
opts = opts || {};
|
|
23281
|
+
|
|
23282
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23283
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23284
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
23285
|
+
}
|
|
23286
|
+
|
|
23287
|
+
return this.apiClient.callApi(
|
|
23288
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
23289
|
+
'GET',
|
|
23290
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23291
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23292
|
+
{ },
|
|
23293
|
+
{ },
|
|
23294
|
+
null,
|
|
23295
|
+
['PureCloud OAuth'],
|
|
23296
|
+
['application/json'],
|
|
23297
|
+
['application/json']
|
|
23298
|
+
);
|
|
23299
|
+
}
|
|
23300
|
+
|
|
23301
|
+
/**
|
|
23302
|
+
* Get export job report
|
|
23303
|
+
*
|
|
23304
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23305
|
+
* @param {String} exportJobId Export job ID
|
|
23306
|
+
*/
|
|
23307
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
23308
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23309
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23310
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
23311
|
+
}
|
|
23312
|
+
// verify the required parameter 'exportJobId' is set
|
|
23313
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
23314
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
23315
|
+
}
|
|
23316
|
+
|
|
23317
|
+
return this.apiClient.callApi(
|
|
23318
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
23319
|
+
'GET',
|
|
23320
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
23321
|
+
{ },
|
|
23322
|
+
{ },
|
|
23323
|
+
{ },
|
|
23324
|
+
null,
|
|
23325
|
+
['PureCloud OAuth'],
|
|
23326
|
+
['application/json'],
|
|
23327
|
+
['application/json']
|
|
23328
|
+
);
|
|
23329
|
+
}
|
|
23330
|
+
|
|
23331
|
+
/**
|
|
23332
|
+
* Get import job report
|
|
23333
|
+
*
|
|
23334
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23335
|
+
* @param {String} importJobId Import job ID
|
|
23336
|
+
*/
|
|
23337
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
23338
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23339
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23340
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
23341
|
+
}
|
|
23342
|
+
// verify the required parameter 'importJobId' is set
|
|
23343
|
+
if (importJobId === undefined || importJobId === null) {
|
|
23344
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
23345
|
+
}
|
|
23346
|
+
|
|
23347
|
+
return this.apiClient.callApi(
|
|
23348
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
23349
|
+
'GET',
|
|
23350
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
23351
|
+
{ },
|
|
23352
|
+
{ },
|
|
23353
|
+
{ },
|
|
23354
|
+
null,
|
|
23355
|
+
['PureCloud OAuth'],
|
|
23356
|
+
['application/json'],
|
|
23357
|
+
['application/json']
|
|
23358
|
+
);
|
|
23359
|
+
}
|
|
23360
|
+
|
|
23361
|
+
/**
|
|
23362
|
+
* Get label
|
|
23363
|
+
*
|
|
23364
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23365
|
+
* @param {String} labelId Label ID
|
|
23366
|
+
*/
|
|
23367
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
23368
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23369
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23370
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
23371
|
+
}
|
|
23372
|
+
// verify the required parameter 'labelId' is set
|
|
23373
|
+
if (labelId === undefined || labelId === null) {
|
|
23374
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
23375
|
+
}
|
|
23376
|
+
|
|
23377
|
+
return this.apiClient.callApi(
|
|
23378
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
23379
|
+
'GET',
|
|
23380
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
23381
|
+
{ },
|
|
23382
|
+
{ },
|
|
23383
|
+
{ },
|
|
23384
|
+
null,
|
|
23385
|
+
['PureCloud OAuth'],
|
|
23386
|
+
['application/json'],
|
|
23387
|
+
['application/json']
|
|
23388
|
+
);
|
|
23389
|
+
}
|
|
23390
|
+
|
|
23391
|
+
/**
|
|
23392
|
+
* Get labels
|
|
23393
|
+
*
|
|
23394
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23395
|
+
* @param {Object} opts Optional parameters
|
|
23396
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23397
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23398
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23399
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
23400
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
23401
|
+
*/
|
|
23402
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
23403
|
+
opts = opts || {};
|
|
23404
|
+
|
|
23405
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23406
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23407
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
23408
|
+
}
|
|
23409
|
+
|
|
23410
|
+
return this.apiClient.callApi(
|
|
23411
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
23412
|
+
'GET',
|
|
23413
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23414
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
23415
|
+
{ },
|
|
23416
|
+
{ },
|
|
23417
|
+
null,
|
|
23418
|
+
['PureCloud OAuth'],
|
|
23419
|
+
['application/json'],
|
|
23420
|
+
['application/json']
|
|
23421
|
+
);
|
|
23422
|
+
}
|
|
23423
|
+
|
|
22438
23424
|
/**
|
|
22439
23425
|
* Get categories
|
|
22440
23426
|
*
|
|
@@ -22693,6 +23679,108 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22693
23679
|
);
|
|
22694
23680
|
}
|
|
22695
23681
|
|
|
23682
|
+
/**
|
|
23683
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
23684
|
+
*
|
|
23685
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23686
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
23687
|
+
* @param {Object} opts Optional parameters
|
|
23688
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23689
|
+
*/
|
|
23690
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
23691
|
+
opts = opts || {};
|
|
23692
|
+
|
|
23693
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23694
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23695
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
23696
|
+
}
|
|
23697
|
+
// verify the required parameter 'groupId' is set
|
|
23698
|
+
if (groupId === undefined || groupId === null) {
|
|
23699
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
23700
|
+
}
|
|
23701
|
+
|
|
23702
|
+
return this.apiClient.callApi(
|
|
23703
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
23704
|
+
'GET',
|
|
23705
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
23706
|
+
{ 'app': opts['app'] },
|
|
23707
|
+
{ },
|
|
23708
|
+
{ },
|
|
23709
|
+
null,
|
|
23710
|
+
['PureCloud OAuth'],
|
|
23711
|
+
['application/json'],
|
|
23712
|
+
['application/json']
|
|
23713
|
+
);
|
|
23714
|
+
}
|
|
23715
|
+
|
|
23716
|
+
/**
|
|
23717
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
23718
|
+
*
|
|
23719
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23720
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
23721
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
23722
|
+
* @param {Object} opts Optional parameters
|
|
23723
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23724
|
+
*/
|
|
23725
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
23726
|
+
opts = opts || {};
|
|
23727
|
+
|
|
23728
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23729
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23730
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23731
|
+
}
|
|
23732
|
+
// verify the required parameter 'groupId' is set
|
|
23733
|
+
if (groupId === undefined || groupId === null) {
|
|
23734
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23735
|
+
}
|
|
23736
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
23737
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
23738
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23739
|
+
}
|
|
23740
|
+
|
|
23741
|
+
return this.apiClient.callApi(
|
|
23742
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
23743
|
+
'GET',
|
|
23744
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
23745
|
+
{ 'app': opts['app'] },
|
|
23746
|
+
{ },
|
|
23747
|
+
{ },
|
|
23748
|
+
null,
|
|
23749
|
+
['PureCloud OAuth'],
|
|
23750
|
+
['application/json'],
|
|
23751
|
+
['application/json']
|
|
23752
|
+
);
|
|
23753
|
+
}
|
|
23754
|
+
|
|
23755
|
+
/**
|
|
23756
|
+
* Get knowledge base unanswered groups
|
|
23757
|
+
*
|
|
23758
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23759
|
+
* @param {Object} opts Optional parameters
|
|
23760
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23761
|
+
*/
|
|
23762
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
23763
|
+
opts = opts || {};
|
|
23764
|
+
|
|
23765
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23766
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23767
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
23768
|
+
}
|
|
23769
|
+
|
|
23770
|
+
return this.apiClient.callApi(
|
|
23771
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
23772
|
+
'GET',
|
|
23773
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23774
|
+
{ 'app': opts['app'] },
|
|
23775
|
+
{ },
|
|
23776
|
+
{ },
|
|
23777
|
+
null,
|
|
23778
|
+
['PureCloud OAuth'],
|
|
23779
|
+
['application/json'],
|
|
23780
|
+
['application/json']
|
|
23781
|
+
);
|
|
23782
|
+
}
|
|
23783
|
+
|
|
22696
23784
|
/**
|
|
22697
23785
|
* Get knowledge bases
|
|
22698
23786
|
*
|
|
@@ -22725,6 +23813,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22725
23813
|
);
|
|
22726
23814
|
}
|
|
22727
23815
|
|
|
23816
|
+
/**
|
|
23817
|
+
* Update search result.
|
|
23818
|
+
*
|
|
23819
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
23820
|
+
* @param {String} searchId Search Result ID
|
|
23821
|
+
* @param {Object} body
|
|
23822
|
+
*/
|
|
23823
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
23824
|
+
// verify the required parameter 'sessionId' is set
|
|
23825
|
+
if (sessionId === undefined || sessionId === null) {
|
|
23826
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23827
|
+
}
|
|
23828
|
+
// verify the required parameter 'searchId' is set
|
|
23829
|
+
if (searchId === undefined || searchId === null) {
|
|
23830
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23831
|
+
}
|
|
23832
|
+
// verify the required parameter 'body' is set
|
|
23833
|
+
if (body === undefined || body === null) {
|
|
23834
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23835
|
+
}
|
|
23836
|
+
|
|
23837
|
+
return this.apiClient.callApi(
|
|
23838
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
23839
|
+
'PATCH',
|
|
23840
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
23841
|
+
{ },
|
|
23842
|
+
{ },
|
|
23843
|
+
{ },
|
|
23844
|
+
body,
|
|
23845
|
+
['PureCloud OAuth'],
|
|
23846
|
+
['application/json'],
|
|
23847
|
+
['application/json']
|
|
23848
|
+
);
|
|
23849
|
+
}
|
|
23850
|
+
|
|
22728
23851
|
/**
|
|
22729
23852
|
* Update knowledge base
|
|
22730
23853
|
*
|
|
@@ -22755,6 +23878,220 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22755
23878
|
);
|
|
22756
23879
|
}
|
|
22757
23880
|
|
|
23881
|
+
/**
|
|
23882
|
+
* Update category
|
|
23883
|
+
*
|
|
23884
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23885
|
+
* @param {String} categoryId Category ID
|
|
23886
|
+
* @param {Object} body
|
|
23887
|
+
*/
|
|
23888
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
23889
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23890
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23891
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23892
|
+
}
|
|
23893
|
+
// verify the required parameter 'categoryId' is set
|
|
23894
|
+
if (categoryId === undefined || categoryId === null) {
|
|
23895
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23896
|
+
}
|
|
23897
|
+
// verify the required parameter 'body' is set
|
|
23898
|
+
if (body === undefined || body === null) {
|
|
23899
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23900
|
+
}
|
|
23901
|
+
|
|
23902
|
+
return this.apiClient.callApi(
|
|
23903
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
23904
|
+
'PATCH',
|
|
23905
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
23906
|
+
{ },
|
|
23907
|
+
{ },
|
|
23908
|
+
{ },
|
|
23909
|
+
body,
|
|
23910
|
+
['PureCloud OAuth'],
|
|
23911
|
+
['application/json'],
|
|
23912
|
+
['application/json']
|
|
23913
|
+
);
|
|
23914
|
+
}
|
|
23915
|
+
|
|
23916
|
+
/**
|
|
23917
|
+
* Update document.
|
|
23918
|
+
*
|
|
23919
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23920
|
+
* @param {String} documentId Document ID.
|
|
23921
|
+
* @param {Object} body
|
|
23922
|
+
*/
|
|
23923
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
23924
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23925
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23926
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23927
|
+
}
|
|
23928
|
+
// verify the required parameter 'documentId' is set
|
|
23929
|
+
if (documentId === undefined || documentId === null) {
|
|
23930
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23931
|
+
}
|
|
23932
|
+
// verify the required parameter 'body' is set
|
|
23933
|
+
if (body === undefined || body === null) {
|
|
23934
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23935
|
+
}
|
|
23936
|
+
|
|
23937
|
+
return this.apiClient.callApi(
|
|
23938
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
23939
|
+
'PATCH',
|
|
23940
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23941
|
+
{ },
|
|
23942
|
+
{ },
|
|
23943
|
+
{ },
|
|
23944
|
+
body,
|
|
23945
|
+
['PureCloud OAuth'],
|
|
23946
|
+
['application/json'],
|
|
23947
|
+
['application/json']
|
|
23948
|
+
);
|
|
23949
|
+
}
|
|
23950
|
+
|
|
23951
|
+
/**
|
|
23952
|
+
* Update a variation for a document.
|
|
23953
|
+
*
|
|
23954
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
23955
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
23956
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
23957
|
+
* @param {Object} body
|
|
23958
|
+
*/
|
|
23959
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
23960
|
+
// verify the required parameter 'documentVariationId' is set
|
|
23961
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
23962
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23963
|
+
}
|
|
23964
|
+
// verify the required parameter 'documentId' is set
|
|
23965
|
+
if (documentId === undefined || documentId === null) {
|
|
23966
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23967
|
+
}
|
|
23968
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23969
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23970
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23971
|
+
}
|
|
23972
|
+
// verify the required parameter 'body' is set
|
|
23973
|
+
if (body === undefined || body === null) {
|
|
23974
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23975
|
+
}
|
|
23976
|
+
|
|
23977
|
+
return this.apiClient.callApi(
|
|
23978
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
23979
|
+
'PATCH',
|
|
23980
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
23981
|
+
{ },
|
|
23982
|
+
{ },
|
|
23983
|
+
{ },
|
|
23984
|
+
body,
|
|
23985
|
+
['PureCloud OAuth'],
|
|
23986
|
+
['application/json'],
|
|
23987
|
+
['application/json']
|
|
23988
|
+
);
|
|
23989
|
+
}
|
|
23990
|
+
|
|
23991
|
+
/**
|
|
23992
|
+
* Update search result.
|
|
23993
|
+
*
|
|
23994
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
23995
|
+
* @param {String} searchId Search Result ID
|
|
23996
|
+
* @param {Object} opts Optional parameters
|
|
23997
|
+
* @param {Object} opts.body
|
|
23998
|
+
*/
|
|
23999
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
24000
|
+
opts = opts || {};
|
|
24001
|
+
|
|
24002
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24003
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24004
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
24005
|
+
}
|
|
24006
|
+
// verify the required parameter 'searchId' is set
|
|
24007
|
+
if (searchId === undefined || searchId === null) {
|
|
24008
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
24009
|
+
}
|
|
24010
|
+
|
|
24011
|
+
return this.apiClient.callApi(
|
|
24012
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
24013
|
+
'PATCH',
|
|
24014
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
24015
|
+
{ },
|
|
24016
|
+
{ },
|
|
24017
|
+
{ },
|
|
24018
|
+
opts['body'],
|
|
24019
|
+
['PureCloud OAuth'],
|
|
24020
|
+
['application/json'],
|
|
24021
|
+
['application/json']
|
|
24022
|
+
);
|
|
24023
|
+
}
|
|
24024
|
+
|
|
24025
|
+
/**
|
|
24026
|
+
* Start import job
|
|
24027
|
+
*
|
|
24028
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24029
|
+
* @param {String} importJobId Import job ID
|
|
24030
|
+
* @param {Object} body
|
|
24031
|
+
*/
|
|
24032
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
24033
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24034
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24035
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24036
|
+
}
|
|
24037
|
+
// verify the required parameter 'importJobId' is set
|
|
24038
|
+
if (importJobId === undefined || importJobId === null) {
|
|
24039
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24040
|
+
}
|
|
24041
|
+
// verify the required parameter 'body' is set
|
|
24042
|
+
if (body === undefined || body === null) {
|
|
24043
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24044
|
+
}
|
|
24045
|
+
|
|
24046
|
+
return this.apiClient.callApi(
|
|
24047
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
24048
|
+
'PATCH',
|
|
24049
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
24050
|
+
{ },
|
|
24051
|
+
{ },
|
|
24052
|
+
{ },
|
|
24053
|
+
body,
|
|
24054
|
+
['PureCloud OAuth'],
|
|
24055
|
+
['application/json'],
|
|
24056
|
+
['application/json']
|
|
24057
|
+
);
|
|
24058
|
+
}
|
|
24059
|
+
|
|
24060
|
+
/**
|
|
24061
|
+
* Update label
|
|
24062
|
+
*
|
|
24063
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24064
|
+
* @param {String} labelId Label ID
|
|
24065
|
+
* @param {Object} body
|
|
24066
|
+
*/
|
|
24067
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
24068
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24069
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24070
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24071
|
+
}
|
|
24072
|
+
// verify the required parameter 'labelId' is set
|
|
24073
|
+
if (labelId === undefined || labelId === null) {
|
|
24074
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24075
|
+
}
|
|
24076
|
+
// verify the required parameter 'body' is set
|
|
24077
|
+
if (body === undefined || body === null) {
|
|
24078
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24079
|
+
}
|
|
24080
|
+
|
|
24081
|
+
return this.apiClient.callApi(
|
|
24082
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
24083
|
+
'PATCH',
|
|
24084
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
24085
|
+
{ },
|
|
24086
|
+
{ },
|
|
24087
|
+
{ },
|
|
24088
|
+
body,
|
|
24089
|
+
['PureCloud OAuth'],
|
|
24090
|
+
['application/json'],
|
|
24091
|
+
['application/json']
|
|
24092
|
+
);
|
|
24093
|
+
}
|
|
24094
|
+
|
|
22758
24095
|
/**
|
|
22759
24096
|
* Update category
|
|
22760
24097
|
*
|
|
@@ -22910,6 +24247,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22910
24247
|
);
|
|
22911
24248
|
}
|
|
22912
24249
|
|
|
24250
|
+
/**
|
|
24251
|
+
* Update a Knowledge base unanswered phrase group
|
|
24252
|
+
*
|
|
24253
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24254
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
24255
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
24256
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
24257
|
+
*/
|
|
24258
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
24259
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24260
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24261
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24262
|
+
}
|
|
24263
|
+
// verify the required parameter 'groupId' is set
|
|
24264
|
+
if (groupId === undefined || groupId === null) {
|
|
24265
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24266
|
+
}
|
|
24267
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
24268
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
24269
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24270
|
+
}
|
|
24271
|
+
// verify the required parameter 'body' is set
|
|
24272
|
+
if (body === undefined || body === null) {
|
|
24273
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24274
|
+
}
|
|
24275
|
+
|
|
24276
|
+
return this.apiClient.callApi(
|
|
24277
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
24278
|
+
'PATCH',
|
|
24279
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
24280
|
+
{ },
|
|
24281
|
+
{ },
|
|
24282
|
+
{ },
|
|
24283
|
+
body,
|
|
24284
|
+
['PureCloud OAuth'],
|
|
24285
|
+
['application/json'],
|
|
24286
|
+
['application/json']
|
|
24287
|
+
);
|
|
24288
|
+
}
|
|
24289
|
+
|
|
22913
24290
|
/**
|
|
22914
24291
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
22915
24292
|
*
|
|
@@ -22935,6 +24312,369 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22935
24312
|
);
|
|
22936
24313
|
}
|
|
22937
24314
|
|
|
24315
|
+
/**
|
|
24316
|
+
* Search the documents in a guest session.
|
|
24317
|
+
*
|
|
24318
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24319
|
+
* @param {Object} opts Optional parameters
|
|
24320
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
24321
|
+
* @param {Object} opts.body
|
|
24322
|
+
*/
|
|
24323
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
24324
|
+
opts = opts || {};
|
|
24325
|
+
|
|
24326
|
+
// verify the required parameter 'sessionId' is set
|
|
24327
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24328
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
24329
|
+
}
|
|
24330
|
+
|
|
24331
|
+
return this.apiClient.callApi(
|
|
24332
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
24333
|
+
'POST',
|
|
24334
|
+
{ 'sessionId': sessionId },
|
|
24335
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24336
|
+
{ },
|
|
24337
|
+
{ },
|
|
24338
|
+
opts['body'],
|
|
24339
|
+
['PureCloud OAuth'],
|
|
24340
|
+
['application/json'],
|
|
24341
|
+
['application/json']
|
|
24342
|
+
);
|
|
24343
|
+
}
|
|
24344
|
+
|
|
24345
|
+
/**
|
|
24346
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
24347
|
+
*
|
|
24348
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24349
|
+
* @param {Object} opts Optional parameters
|
|
24350
|
+
* @param {Object} opts.body
|
|
24351
|
+
*/
|
|
24352
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
24353
|
+
opts = opts || {};
|
|
24354
|
+
|
|
24355
|
+
// verify the required parameter 'sessionId' is set
|
|
24356
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24357
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
24358
|
+
}
|
|
24359
|
+
|
|
24360
|
+
return this.apiClient.callApi(
|
|
24361
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
24362
|
+
'POST',
|
|
24363
|
+
{ 'sessionId': sessionId },
|
|
24364
|
+
{ },
|
|
24365
|
+
{ },
|
|
24366
|
+
{ },
|
|
24367
|
+
opts['body'],
|
|
24368
|
+
['PureCloud OAuth'],
|
|
24369
|
+
['application/json'],
|
|
24370
|
+
['application/json']
|
|
24371
|
+
);
|
|
24372
|
+
}
|
|
24373
|
+
|
|
24374
|
+
/**
|
|
24375
|
+
* Create guest session
|
|
24376
|
+
*
|
|
24377
|
+
* @param {Object} body
|
|
24378
|
+
*/
|
|
24379
|
+
postKnowledgeGuestSessions(body) {
|
|
24380
|
+
// verify the required parameter 'body' is set
|
|
24381
|
+
if (body === undefined || body === null) {
|
|
24382
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
24383
|
+
}
|
|
24384
|
+
|
|
24385
|
+
return this.apiClient.callApi(
|
|
24386
|
+
'/api/v2/knowledge/guest/sessions',
|
|
24387
|
+
'POST',
|
|
24388
|
+
{ },
|
|
24389
|
+
{ },
|
|
24390
|
+
{ },
|
|
24391
|
+
{ },
|
|
24392
|
+
body,
|
|
24393
|
+
['PureCloud OAuth'],
|
|
24394
|
+
['application/json'],
|
|
24395
|
+
['application/json']
|
|
24396
|
+
);
|
|
24397
|
+
}
|
|
24398
|
+
|
|
24399
|
+
/**
|
|
24400
|
+
* Create new category
|
|
24401
|
+
*
|
|
24402
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24403
|
+
* @param {Object} body
|
|
24404
|
+
*/
|
|
24405
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
24406
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24407
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24408
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
24409
|
+
}
|
|
24410
|
+
// verify the required parameter 'body' is set
|
|
24411
|
+
if (body === undefined || body === null) {
|
|
24412
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
24413
|
+
}
|
|
24414
|
+
|
|
24415
|
+
return this.apiClient.callApi(
|
|
24416
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
24417
|
+
'POST',
|
|
24418
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24419
|
+
{ },
|
|
24420
|
+
{ },
|
|
24421
|
+
{ },
|
|
24422
|
+
body,
|
|
24423
|
+
['PureCloud OAuth'],
|
|
24424
|
+
['application/json'],
|
|
24425
|
+
['application/json']
|
|
24426
|
+
);
|
|
24427
|
+
}
|
|
24428
|
+
|
|
24429
|
+
/**
|
|
24430
|
+
* Create a variation for a document.
|
|
24431
|
+
*
|
|
24432
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24433
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24434
|
+
* @param {Object} body
|
|
24435
|
+
*/
|
|
24436
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
24437
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24438
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24439
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24440
|
+
}
|
|
24441
|
+
// verify the required parameter 'documentId' is set
|
|
24442
|
+
if (documentId === undefined || documentId === null) {
|
|
24443
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24444
|
+
}
|
|
24445
|
+
// verify the required parameter 'body' is set
|
|
24446
|
+
if (body === undefined || body === null) {
|
|
24447
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24448
|
+
}
|
|
24449
|
+
|
|
24450
|
+
return this.apiClient.callApi(
|
|
24451
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
24452
|
+
'POST',
|
|
24453
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24454
|
+
{ },
|
|
24455
|
+
{ },
|
|
24456
|
+
{ },
|
|
24457
|
+
body,
|
|
24458
|
+
['PureCloud OAuth'],
|
|
24459
|
+
['application/json'],
|
|
24460
|
+
['application/json']
|
|
24461
|
+
);
|
|
24462
|
+
}
|
|
24463
|
+
|
|
24464
|
+
/**
|
|
24465
|
+
* Creates or restores a document version.
|
|
24466
|
+
*
|
|
24467
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24468
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24469
|
+
* @param {Object} body
|
|
24470
|
+
*/
|
|
24471
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
24472
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24473
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24474
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24475
|
+
}
|
|
24476
|
+
// verify the required parameter 'documentId' is set
|
|
24477
|
+
if (documentId === undefined || documentId === null) {
|
|
24478
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24479
|
+
}
|
|
24480
|
+
// verify the required parameter 'body' is set
|
|
24481
|
+
if (body === undefined || body === null) {
|
|
24482
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24483
|
+
}
|
|
24484
|
+
|
|
24485
|
+
return this.apiClient.callApi(
|
|
24486
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
24487
|
+
'POST',
|
|
24488
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24489
|
+
{ },
|
|
24490
|
+
{ },
|
|
24491
|
+
{ },
|
|
24492
|
+
body,
|
|
24493
|
+
['PureCloud OAuth'],
|
|
24494
|
+
['application/json'],
|
|
24495
|
+
['application/json']
|
|
24496
|
+
);
|
|
24497
|
+
}
|
|
24498
|
+
|
|
24499
|
+
/**
|
|
24500
|
+
* Create document.
|
|
24501
|
+
*
|
|
24502
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24503
|
+
* @param {Object} body
|
|
24504
|
+
*/
|
|
24505
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
24506
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24507
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24508
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
24509
|
+
}
|
|
24510
|
+
// verify the required parameter 'body' is set
|
|
24511
|
+
if (body === undefined || body === null) {
|
|
24512
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
24513
|
+
}
|
|
24514
|
+
|
|
24515
|
+
return this.apiClient.callApi(
|
|
24516
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
24517
|
+
'POST',
|
|
24518
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24519
|
+
{ },
|
|
24520
|
+
{ },
|
|
24521
|
+
{ },
|
|
24522
|
+
body,
|
|
24523
|
+
['PureCloud OAuth'],
|
|
24524
|
+
['application/json'],
|
|
24525
|
+
['application/json']
|
|
24526
|
+
);
|
|
24527
|
+
}
|
|
24528
|
+
|
|
24529
|
+
/**
|
|
24530
|
+
* Search the documents in a knowledge base.
|
|
24531
|
+
*
|
|
24532
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
24533
|
+
* @param {Object} opts Optional parameters
|
|
24534
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
24535
|
+
* @param {Object} opts.body
|
|
24536
|
+
*/
|
|
24537
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
24538
|
+
opts = opts || {};
|
|
24539
|
+
|
|
24540
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24541
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24542
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
24543
|
+
}
|
|
24544
|
+
|
|
24545
|
+
return this.apiClient.callApi(
|
|
24546
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
24547
|
+
'POST',
|
|
24548
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24549
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24550
|
+
{ },
|
|
24551
|
+
{ },
|
|
24552
|
+
opts['body'],
|
|
24553
|
+
['PureCloud OAuth'],
|
|
24554
|
+
['application/json'],
|
|
24555
|
+
['application/json']
|
|
24556
|
+
);
|
|
24557
|
+
}
|
|
24558
|
+
|
|
24559
|
+
/**
|
|
24560
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
24561
|
+
*
|
|
24562
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
24563
|
+
* @param {Object} opts Optional parameters
|
|
24564
|
+
* @param {Object} opts.body
|
|
24565
|
+
*/
|
|
24566
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
24567
|
+
opts = opts || {};
|
|
24568
|
+
|
|
24569
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24570
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24571
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
24572
|
+
}
|
|
24573
|
+
|
|
24574
|
+
return this.apiClient.callApi(
|
|
24575
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
24576
|
+
'POST',
|
|
24577
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24578
|
+
{ },
|
|
24579
|
+
{ },
|
|
24580
|
+
{ },
|
|
24581
|
+
opts['body'],
|
|
24582
|
+
['PureCloud OAuth'],
|
|
24583
|
+
['application/json'],
|
|
24584
|
+
['application/json']
|
|
24585
|
+
);
|
|
24586
|
+
}
|
|
24587
|
+
|
|
24588
|
+
/**
|
|
24589
|
+
* Create export job
|
|
24590
|
+
*
|
|
24591
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24592
|
+
* @param {Object} body
|
|
24593
|
+
*/
|
|
24594
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
24595
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24596
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24597
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
24598
|
+
}
|
|
24599
|
+
// verify the required parameter 'body' is set
|
|
24600
|
+
if (body === undefined || body === null) {
|
|
24601
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
24602
|
+
}
|
|
24603
|
+
|
|
24604
|
+
return this.apiClient.callApi(
|
|
24605
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
24606
|
+
'POST',
|
|
24607
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24608
|
+
{ },
|
|
24609
|
+
{ },
|
|
24610
|
+
{ },
|
|
24611
|
+
body,
|
|
24612
|
+
['PureCloud OAuth'],
|
|
24613
|
+
['application/json'],
|
|
24614
|
+
['application/json']
|
|
24615
|
+
);
|
|
24616
|
+
}
|
|
24617
|
+
|
|
24618
|
+
/**
|
|
24619
|
+
* Create import job
|
|
24620
|
+
*
|
|
24621
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24622
|
+
* @param {Object} body
|
|
24623
|
+
*/
|
|
24624
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
24625
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24626
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24627
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
24628
|
+
}
|
|
24629
|
+
// verify the required parameter 'body' is set
|
|
24630
|
+
if (body === undefined || body === null) {
|
|
24631
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
24632
|
+
}
|
|
24633
|
+
|
|
24634
|
+
return this.apiClient.callApi(
|
|
24635
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
24636
|
+
'POST',
|
|
24637
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24638
|
+
{ },
|
|
24639
|
+
{ },
|
|
24640
|
+
{ },
|
|
24641
|
+
body,
|
|
24642
|
+
['PureCloud OAuth'],
|
|
24643
|
+
['application/json'],
|
|
24644
|
+
['application/json']
|
|
24645
|
+
);
|
|
24646
|
+
}
|
|
24647
|
+
|
|
24648
|
+
/**
|
|
24649
|
+
* Create new label
|
|
24650
|
+
*
|
|
24651
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24652
|
+
* @param {Object} body
|
|
24653
|
+
*/
|
|
24654
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
24655
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24656
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24657
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
24658
|
+
}
|
|
24659
|
+
// verify the required parameter 'body' is set
|
|
24660
|
+
if (body === undefined || body === null) {
|
|
24661
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
24662
|
+
}
|
|
24663
|
+
|
|
24664
|
+
return this.apiClient.callApi(
|
|
24665
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
24666
|
+
'POST',
|
|
24667
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24668
|
+
{ },
|
|
24669
|
+
{ },
|
|
24670
|
+
{ },
|
|
24671
|
+
body,
|
|
24672
|
+
['PureCloud OAuth'],
|
|
24673
|
+
['application/json'],
|
|
24674
|
+
['application/json']
|
|
24675
|
+
);
|
|
24676
|
+
}
|
|
24677
|
+
|
|
22938
24678
|
/**
|
|
22939
24679
|
* Create new category
|
|
22940
24680
|
*
|
|
@@ -23165,7 +24905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23165
24905
|
/**
|
|
23166
24906
|
* LanguageUnderstanding service.
|
|
23167
24907
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
23168
|
-
* @version
|
|
24908
|
+
* @version 146.0.0
|
|
23169
24909
|
*/
|
|
23170
24910
|
|
|
23171
24911
|
/**
|
|
@@ -24069,7 +25809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24069
25809
|
/**
|
|
24070
25810
|
* Languages service.
|
|
24071
25811
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24072
|
-
* @version
|
|
25812
|
+
* @version 146.0.0
|
|
24073
25813
|
*/
|
|
24074
25814
|
|
|
24075
25815
|
/**
|
|
@@ -24337,7 +26077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24337
26077
|
/**
|
|
24338
26078
|
* Learning service.
|
|
24339
26079
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
24340
|
-
* @version
|
|
26080
|
+
* @version 146.0.0
|
|
24341
26081
|
*/
|
|
24342
26082
|
|
|
24343
26083
|
/**
|
|
@@ -24690,6 +26430,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24690
26430
|
);
|
|
24691
26431
|
}
|
|
24692
26432
|
|
|
26433
|
+
/**
|
|
26434
|
+
* Get a specific Learning Module cover art using ID
|
|
26435
|
+
*
|
|
26436
|
+
* @param {String} coverArtId Key identifier for the cover art
|
|
26437
|
+
*/
|
|
26438
|
+
getLearningModulesCoverartCoverArtId(coverArtId) {
|
|
26439
|
+
// verify the required parameter 'coverArtId' is set
|
|
26440
|
+
if (coverArtId === undefined || coverArtId === null) {
|
|
26441
|
+
throw 'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';
|
|
26442
|
+
}
|
|
26443
|
+
|
|
26444
|
+
return this.apiClient.callApi(
|
|
26445
|
+
'/api/v2/learning/modules/coverart/{coverArtId}',
|
|
26446
|
+
'GET',
|
|
26447
|
+
{ 'coverArtId': coverArtId },
|
|
26448
|
+
{ },
|
|
26449
|
+
{ },
|
|
26450
|
+
{ },
|
|
26451
|
+
null,
|
|
26452
|
+
['PureCloud OAuth'],
|
|
26453
|
+
['application/json'],
|
|
26454
|
+
['application/json']
|
|
26455
|
+
);
|
|
26456
|
+
}
|
|
26457
|
+
|
|
24693
26458
|
/**
|
|
24694
26459
|
* Update Learning Assignment
|
|
24695
26460
|
*
|
|
@@ -25072,7 +26837,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25072
26837
|
/**
|
|
25073
26838
|
* License service.
|
|
25074
26839
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
25075
|
-
* @version
|
|
26840
|
+
* @version 146.0.0
|
|
25076
26841
|
*/
|
|
25077
26842
|
|
|
25078
26843
|
/**
|
|
@@ -25310,7 +27075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25310
27075
|
/**
|
|
25311
27076
|
* Locations service.
|
|
25312
27077
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25313
|
-
* @version
|
|
27078
|
+
* @version 146.0.0
|
|
25314
27079
|
*/
|
|
25315
27080
|
|
|
25316
27081
|
/**
|
|
@@ -25546,7 +27311,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25546
27311
|
/**
|
|
25547
27312
|
* Messaging service.
|
|
25548
27313
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
25549
|
-
* @version
|
|
27314
|
+
* @version 146.0.0
|
|
25550
27315
|
*/
|
|
25551
27316
|
|
|
25552
27317
|
/**
|
|
@@ -25697,7 +27462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25697
27462
|
/**
|
|
25698
27463
|
* MobileDevices service.
|
|
25699
27464
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25700
|
-
* @version
|
|
27465
|
+
* @version 146.0.0
|
|
25701
27466
|
*/
|
|
25702
27467
|
|
|
25703
27468
|
/**
|
|
@@ -25848,7 +27613,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25848
27613
|
/**
|
|
25849
27614
|
* Notifications service.
|
|
25850
27615
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25851
|
-
* @version
|
|
27616
|
+
* @version 146.0.0
|
|
25852
27617
|
*/
|
|
25853
27618
|
|
|
25854
27619
|
/**
|
|
@@ -26073,7 +27838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26073
27838
|
/**
|
|
26074
27839
|
* OAuth service.
|
|
26075
27840
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
26076
|
-
* @version
|
|
27841
|
+
* @version 146.0.0
|
|
26077
27842
|
*/
|
|
26078
27843
|
|
|
26079
27844
|
/**
|
|
@@ -26439,7 +28204,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26439
28204
|
/**
|
|
26440
28205
|
* Objects service.
|
|
26441
28206
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26442
|
-
* @version
|
|
28207
|
+
* @version 146.0.0
|
|
26443
28208
|
*/
|
|
26444
28209
|
|
|
26445
28210
|
/**
|
|
@@ -26710,7 +28475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26710
28475
|
/**
|
|
26711
28476
|
* Organization service.
|
|
26712
28477
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26713
|
-
* @version
|
|
28478
|
+
* @version 146.0.0
|
|
26714
28479
|
*/
|
|
26715
28480
|
|
|
26716
28481
|
/**
|
|
@@ -27113,7 +28878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27113
28878
|
/**
|
|
27114
28879
|
* OrganizationAuthorization service.
|
|
27115
28880
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
27116
|
-
* @version
|
|
28881
|
+
* @version 146.0.0
|
|
27117
28882
|
*/
|
|
27118
28883
|
|
|
27119
28884
|
/**
|
|
@@ -28038,7 +29803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28038
29803
|
/**
|
|
28039
29804
|
* Outbound service.
|
|
28040
29805
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
28041
|
-
* @version
|
|
29806
|
+
* @version 146.0.0
|
|
28042
29807
|
*/
|
|
28043
29808
|
|
|
28044
29809
|
/**
|
|
@@ -31293,7 +33058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31293
33058
|
/**
|
|
31294
33059
|
* Presence service.
|
|
31295
33060
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
31296
|
-
* @version
|
|
33061
|
+
* @version 146.0.0
|
|
31297
33062
|
*/
|
|
31298
33063
|
|
|
31299
33064
|
/**
|
|
@@ -31615,7 +33380,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31615
33380
|
/**
|
|
31616
33381
|
* Quality service.
|
|
31617
33382
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31618
|
-
* @version
|
|
33383
|
+
* @version 146.0.0
|
|
31619
33384
|
*/
|
|
31620
33385
|
|
|
31621
33386
|
/**
|
|
@@ -33193,7 +34958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33193
34958
|
/**
|
|
33194
34959
|
* Recording service.
|
|
33195
34960
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
33196
|
-
* @version
|
|
34961
|
+
* @version 146.0.0
|
|
33197
34962
|
*/
|
|
33198
34963
|
|
|
33199
34964
|
/**
|
|
@@ -34846,7 +36611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34846
36611
|
/**
|
|
34847
36612
|
* ResponseManagement service.
|
|
34848
36613
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34849
|
-
* @version
|
|
36614
|
+
* @version 146.0.0
|
|
34850
36615
|
*/
|
|
34851
36616
|
|
|
34852
36617
|
/**
|
|
@@ -35330,7 +37095,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35330
37095
|
/**
|
|
35331
37096
|
* Routing service.
|
|
35332
37097
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
35333
|
-
* @version
|
|
37098
|
+
* @version 146.0.0
|
|
35334
37099
|
*/
|
|
35335
37100
|
|
|
35336
37101
|
/**
|
|
@@ -35896,6 +37661,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35896
37661
|
);
|
|
35897
37662
|
}
|
|
35898
37663
|
|
|
37664
|
+
/**
|
|
37665
|
+
* Get available media types
|
|
37666
|
+
*
|
|
37667
|
+
*/
|
|
37668
|
+
getRoutingAvailablemediatypes() {
|
|
37669
|
+
|
|
37670
|
+
return this.apiClient.callApi(
|
|
37671
|
+
'/api/v2/routing/availablemediatypes',
|
|
37672
|
+
'GET',
|
|
37673
|
+
{ },
|
|
37674
|
+
{ },
|
|
37675
|
+
{ },
|
|
37676
|
+
{ },
|
|
37677
|
+
null,
|
|
37678
|
+
['PureCloud OAuth'],
|
|
37679
|
+
['application/json'],
|
|
37680
|
+
['application/json']
|
|
37681
|
+
);
|
|
37682
|
+
}
|
|
37683
|
+
|
|
35899
37684
|
/**
|
|
35900
37685
|
* Get domain
|
|
35901
37686
|
*
|
|
@@ -38251,7 +40036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38251
40036
|
/**
|
|
38252
40037
|
* SCIM service.
|
|
38253
40038
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
38254
|
-
* @version
|
|
40039
|
+
* @version 146.0.0
|
|
38255
40040
|
*/
|
|
38256
40041
|
|
|
38257
40042
|
/**
|
|
@@ -39128,7 +40913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39128
40913
|
/**
|
|
39129
40914
|
* Scripts service.
|
|
39130
40915
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
39131
|
-
* @version
|
|
40916
|
+
* @version 146.0.0
|
|
39132
40917
|
*/
|
|
39133
40918
|
|
|
39134
40919
|
/**
|
|
@@ -39547,7 +41332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39547
41332
|
/**
|
|
39548
41333
|
* Search service.
|
|
39549
41334
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39550
|
-
* @version
|
|
41335
|
+
* @version 146.0.0
|
|
39551
41336
|
*/
|
|
39552
41337
|
|
|
39553
41338
|
/**
|
|
@@ -40107,7 +41892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40107
41892
|
/**
|
|
40108
41893
|
* SpeechTextAnalytics service.
|
|
40109
41894
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
40110
|
-
* @version
|
|
41895
|
+
* @version 146.0.0
|
|
40111
41896
|
*/
|
|
40112
41897
|
|
|
40113
41898
|
/**
|
|
@@ -40961,7 +42746,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40961
42746
|
/**
|
|
40962
42747
|
* Stations service.
|
|
40963
42748
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40964
|
-
* @version
|
|
42749
|
+
* @version 146.0.0
|
|
40965
42750
|
*/
|
|
40966
42751
|
|
|
40967
42752
|
/**
|
|
@@ -41108,7 +42893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41108
42893
|
/**
|
|
41109
42894
|
* Suggest service.
|
|
41110
42895
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
41111
|
-
* @version
|
|
42896
|
+
* @version 146.0.0
|
|
41112
42897
|
*/
|
|
41113
42898
|
|
|
41114
42899
|
/**
|
|
@@ -41247,7 +43032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41247
43032
|
/**
|
|
41248
43033
|
* Teams service.
|
|
41249
43034
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
41250
|
-
* @version
|
|
43035
|
+
* @version 146.0.0
|
|
41251
43036
|
*/
|
|
41252
43037
|
|
|
41253
43038
|
/**
|
|
@@ -41426,7 +43211,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41426
43211
|
/**
|
|
41427
43212
|
* Telephony service.
|
|
41428
43213
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
41429
|
-
* @version
|
|
43214
|
+
* @version 146.0.0
|
|
41430
43215
|
*/
|
|
41431
43216
|
|
|
41432
43217
|
/**
|
|
@@ -41534,7 +43319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41534
43319
|
/**
|
|
41535
43320
|
* TelephonyProvidersEdge service.
|
|
41536
43321
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
41537
|
-
* @version
|
|
43322
|
+
* @version 146.0.0
|
|
41538
43323
|
*/
|
|
41539
43324
|
|
|
41540
43325
|
/**
|
|
@@ -45167,7 +46952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45167
46952
|
/**
|
|
45168
46953
|
* Textbots service.
|
|
45169
46954
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
45170
|
-
* @version
|
|
46955
|
+
* @version 146.0.0
|
|
45171
46956
|
*/
|
|
45172
46957
|
|
|
45173
46958
|
/**
|
|
@@ -45295,7 +47080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45295
47080
|
/**
|
|
45296
47081
|
* Tokens service.
|
|
45297
47082
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
45298
|
-
* @version
|
|
47083
|
+
* @version 146.0.0
|
|
45299
47084
|
*/
|
|
45300
47085
|
|
|
45301
47086
|
/**
|
|
@@ -45401,7 +47186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45401
47186
|
/**
|
|
45402
47187
|
* Uploads service.
|
|
45403
47188
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
45404
|
-
* @version
|
|
47189
|
+
* @version 146.0.0
|
|
45405
47190
|
*/
|
|
45406
47191
|
|
|
45407
47192
|
/**
|
|
@@ -45471,6 +47256,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45471
47256
|
);
|
|
45472
47257
|
}
|
|
45473
47258
|
|
|
47259
|
+
/**
|
|
47260
|
+
* Generates pre-signed URL to upload cover art for learning modules
|
|
47261
|
+
*
|
|
47262
|
+
* @param {Object} body query
|
|
47263
|
+
*/
|
|
47264
|
+
postUploadsLearningCoverart(body) {
|
|
47265
|
+
// verify the required parameter 'body' is set
|
|
47266
|
+
if (body === undefined || body === null) {
|
|
47267
|
+
throw 'Missing the required parameter "body" when calling postUploadsLearningCoverart';
|
|
47268
|
+
}
|
|
47269
|
+
|
|
47270
|
+
return this.apiClient.callApi(
|
|
47271
|
+
'/api/v2/uploads/learning/coverart',
|
|
47272
|
+
'POST',
|
|
47273
|
+
{ },
|
|
47274
|
+
{ },
|
|
47275
|
+
{ },
|
|
47276
|
+
{ },
|
|
47277
|
+
body,
|
|
47278
|
+
['PureCloud OAuth'],
|
|
47279
|
+
['application/json'],
|
|
47280
|
+
['application/json']
|
|
47281
|
+
);
|
|
47282
|
+
}
|
|
47283
|
+
|
|
45474
47284
|
/**
|
|
45475
47285
|
* Creates presigned url for uploading a public asset image
|
|
45476
47286
|
*
|
|
@@ -45552,7 +47362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45552
47362
|
/**
|
|
45553
47363
|
* Usage service.
|
|
45554
47364
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
45555
|
-
* @version
|
|
47365
|
+
* @version 146.0.0
|
|
45556
47366
|
*/
|
|
45557
47367
|
|
|
45558
47368
|
/**
|
|
@@ -45623,7 +47433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45623
47433
|
/**
|
|
45624
47434
|
* UserRecordings service.
|
|
45625
47435
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
45626
|
-
* @version
|
|
47436
|
+
* @version 146.0.0
|
|
45627
47437
|
*/
|
|
45628
47438
|
|
|
45629
47439
|
/**
|
|
@@ -45807,7 +47617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45807
47617
|
/**
|
|
45808
47618
|
* Users service.
|
|
45809
47619
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45810
|
-
* @version
|
|
47620
|
+
* @version 146.0.0
|
|
45811
47621
|
*/
|
|
45812
47622
|
|
|
45813
47623
|
/**
|
|
@@ -47670,7 +49480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47670
49480
|
|
|
47671
49481
|
/**
|
|
47672
49482
|
* Create user
|
|
47673
|
-
*
|
|
49483
|
+
* If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
|
|
47674
49484
|
* @param {Object} body User
|
|
47675
49485
|
*/
|
|
47676
49486
|
postUsers(body) {
|
|
@@ -48109,7 +49919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48109
49919
|
/**
|
|
48110
49920
|
* Utilities service.
|
|
48111
49921
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
48112
|
-
* @version
|
|
49922
|
+
* @version 146.0.0
|
|
48113
49923
|
*/
|
|
48114
49924
|
|
|
48115
49925
|
/**
|
|
@@ -48220,7 +50030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48220
50030
|
/**
|
|
48221
50031
|
* Voicemail service.
|
|
48222
50032
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
48223
|
-
* @version
|
|
50033
|
+
* @version 146.0.0
|
|
48224
50034
|
*/
|
|
48225
50035
|
|
|
48226
50036
|
/**
|
|
@@ -48887,7 +50697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48887
50697
|
/**
|
|
48888
50698
|
* WebChat service.
|
|
48889
50699
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48890
|
-
* @version
|
|
50700
|
+
* @version 146.0.0
|
|
48891
50701
|
*/
|
|
48892
50702
|
|
|
48893
50703
|
/**
|
|
@@ -49431,7 +51241,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49431
51241
|
/**
|
|
49432
51242
|
* WebDeployments service.
|
|
49433
51243
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
49434
|
-
* @version
|
|
51244
|
+
* @version 146.0.0
|
|
49435
51245
|
*/
|
|
49436
51246
|
|
|
49437
51247
|
/**
|
|
@@ -49786,7 +51596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49786
51596
|
/**
|
|
49787
51597
|
* WebMessaging service.
|
|
49788
51598
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49789
|
-
* @version
|
|
51599
|
+
* @version 146.0.0
|
|
49790
51600
|
*/
|
|
49791
51601
|
|
|
49792
51602
|
/**
|
|
@@ -49832,7 +51642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49832
51642
|
/**
|
|
49833
51643
|
* Widgets service.
|
|
49834
51644
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49835
|
-
* @version
|
|
51645
|
+
* @version 146.0.0
|
|
49836
51646
|
*/
|
|
49837
51647
|
|
|
49838
51648
|
/**
|
|
@@ -49978,7 +51788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49978
51788
|
/**
|
|
49979
51789
|
* WorkforceManagement service.
|
|
49980
51790
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49981
|
-
* @version
|
|
51791
|
+
* @version 146.0.0
|
|
49982
51792
|
*/
|
|
49983
51793
|
|
|
49984
51794
|
/**
|
|
@@ -54254,7 +56064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54254
56064
|
* </pre>
|
|
54255
56065
|
* </p>
|
|
54256
56066
|
* @module purecloud-platform-client-v2/index
|
|
54257
|
-
* @version
|
|
56067
|
+
* @version 146.0.0
|
|
54258
56068
|
*/
|
|
54259
56069
|
class platformClient {
|
|
54260
56070
|
constructor() {
|