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
|
@@ -20,6 +20,7 @@ var PureCloudRegionHosts = {
|
|
|
20
20
|
eu_west_2: 'euw2.pure.cloud',
|
|
21
21
|
ap_south_1: 'aps1.pure.cloud',
|
|
22
22
|
us_east_2: 'use2.us-gov-pure.cloud',
|
|
23
|
+
sa_east_1: 'sae1.pure.cloud',
|
|
23
24
|
};
|
|
24
25
|
|
|
25
26
|
const logLevels = {
|
|
@@ -401,7 +402,7 @@ class Configuration {
|
|
|
401
402
|
|
|
402
403
|
/**
|
|
403
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
404
|
-
* @version
|
|
405
|
+
* @version 146.0.0
|
|
405
406
|
*/
|
|
406
407
|
class ApiClient {
|
|
407
408
|
/**
|
|
@@ -1480,7 +1481,7 @@ class AlertingApi {
|
|
|
1480
1481
|
/**
|
|
1481
1482
|
* Alerting service.
|
|
1482
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1483
|
-
* @version
|
|
1484
|
+
* @version 146.0.0
|
|
1484
1485
|
*/
|
|
1485
1486
|
|
|
1486
1487
|
/**
|
|
@@ -1794,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1794
1795
|
/**
|
|
1795
1796
|
* Analytics service.
|
|
1796
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1797
|
-
* @version
|
|
1798
|
+
* @version 146.0.0
|
|
1798
1799
|
*/
|
|
1799
1800
|
|
|
1800
1801
|
/**
|
|
@@ -2976,7 +2977,7 @@ class ArchitectApi {
|
|
|
2976
2977
|
/**
|
|
2977
2978
|
* Architect service.
|
|
2978
2979
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2979
|
-
* @version
|
|
2980
|
+
* @version 146.0.0
|
|
2980
2981
|
*/
|
|
2981
2982
|
|
|
2982
2983
|
/**
|
|
@@ -3734,6 +3735,7 @@ class ArchitectApi {
|
|
|
3734
3735
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
3735
3736
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
3736
3737
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
3738
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
3737
3739
|
*/
|
|
3738
3740
|
getArchitectIvrs(opts) {
|
|
3739
3741
|
opts = opts || {};
|
|
@@ -3743,7 +3745,7 @@ class ArchitectApi {
|
|
|
3743
3745
|
'/api/v2/architect/ivrs',
|
|
3744
3746
|
'GET',
|
|
3745
3747
|
{ },
|
|
3746
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
3748
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
3747
3749
|
{ },
|
|
3748
3750
|
{ },
|
|
3749
3751
|
null,
|
|
@@ -6021,7 +6023,7 @@ class AuditApi {
|
|
|
6021
6023
|
/**
|
|
6022
6024
|
* Audit service.
|
|
6023
6025
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6024
|
-
* @version
|
|
6026
|
+
* @version 146.0.0
|
|
6025
6027
|
*/
|
|
6026
6028
|
|
|
6027
6029
|
/**
|
|
@@ -6192,7 +6194,7 @@ class AuthorizationApi {
|
|
|
6192
6194
|
/**
|
|
6193
6195
|
* Authorization service.
|
|
6194
6196
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6195
|
-
* @version
|
|
6197
|
+
* @version 146.0.0
|
|
6196
6198
|
*/
|
|
6197
6199
|
|
|
6198
6200
|
/**
|
|
@@ -7375,7 +7377,7 @@ class BillingApi {
|
|
|
7375
7377
|
/**
|
|
7376
7378
|
* Billing service.
|
|
7377
7379
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7378
|
-
* @version
|
|
7380
|
+
* @version 146.0.0
|
|
7379
7381
|
*/
|
|
7380
7382
|
|
|
7381
7383
|
/**
|
|
@@ -7455,7 +7457,7 @@ class ChatApi {
|
|
|
7455
7457
|
/**
|
|
7456
7458
|
* Chat service.
|
|
7457
7459
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7458
|
-
* @version
|
|
7460
|
+
* @version 146.0.0
|
|
7459
7461
|
*/
|
|
7460
7462
|
|
|
7461
7463
|
/**
|
|
@@ -7546,7 +7548,7 @@ class CoachingApi {
|
|
|
7546
7548
|
/**
|
|
7547
7549
|
* Coaching service.
|
|
7548
7550
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7549
|
-
* @version
|
|
7551
|
+
* @version 146.0.0
|
|
7550
7552
|
*/
|
|
7551
7553
|
|
|
7552
7554
|
/**
|
|
@@ -8123,7 +8125,7 @@ class ContentManagementApi {
|
|
|
8123
8125
|
/**
|
|
8124
8126
|
* ContentManagement service.
|
|
8125
8127
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8126
|
-
* @version
|
|
8128
|
+
* @version 146.0.0
|
|
8127
8129
|
*/
|
|
8128
8130
|
|
|
8129
8131
|
/**
|
|
@@ -9263,7 +9265,7 @@ class ConversationsApi {
|
|
|
9263
9265
|
/**
|
|
9264
9266
|
* Conversations service.
|
|
9265
9267
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9266
|
-
* @version
|
|
9268
|
+
* @version 146.0.0
|
|
9267
9269
|
*/
|
|
9268
9270
|
|
|
9269
9271
|
/**
|
|
@@ -9856,6 +9858,31 @@ class ConversationsApi {
|
|
|
9856
9858
|
);
|
|
9857
9859
|
}
|
|
9858
9860
|
|
|
9861
|
+
/**
|
|
9862
|
+
* Get the secure attributes on a conversation.
|
|
9863
|
+
*
|
|
9864
|
+
* @param {String} conversationId conversation ID
|
|
9865
|
+
*/
|
|
9866
|
+
getConversationSecureattributes(conversationId) {
|
|
9867
|
+
// verify the required parameter 'conversationId' is set
|
|
9868
|
+
if (conversationId === undefined || conversationId === null) {
|
|
9869
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
|
|
9870
|
+
}
|
|
9871
|
+
|
|
9872
|
+
return this.apiClient.callApi(
|
|
9873
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
9874
|
+
'GET',
|
|
9875
|
+
{ 'conversationId': conversationId },
|
|
9876
|
+
{ },
|
|
9877
|
+
{ },
|
|
9878
|
+
{ },
|
|
9879
|
+
null,
|
|
9880
|
+
['PureCloud OAuth'],
|
|
9881
|
+
['application/json'],
|
|
9882
|
+
['application/json']
|
|
9883
|
+
);
|
|
9884
|
+
}
|
|
9885
|
+
|
|
9859
9886
|
/**
|
|
9860
9887
|
* Get active conversations for the logged in user
|
|
9861
9888
|
*
|
|
@@ -10639,6 +10666,51 @@ class ConversationsApi {
|
|
|
10639
10666
|
);
|
|
10640
10667
|
}
|
|
10641
10668
|
|
|
10669
|
+
/**
|
|
10670
|
+
* Get the encryption key configurations
|
|
10671
|
+
*
|
|
10672
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
10673
|
+
*/
|
|
10674
|
+
getConversationsKeyconfiguration(keyconfigurationsId) {
|
|
10675
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
10676
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
10677
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
|
|
10678
|
+
}
|
|
10679
|
+
|
|
10680
|
+
return this.apiClient.callApi(
|
|
10681
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
10682
|
+
'GET',
|
|
10683
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
10684
|
+
{ },
|
|
10685
|
+
{ },
|
|
10686
|
+
{ },
|
|
10687
|
+
null,
|
|
10688
|
+
['PureCloud OAuth'],
|
|
10689
|
+
['application/json'],
|
|
10690
|
+
['application/json']
|
|
10691
|
+
);
|
|
10692
|
+
}
|
|
10693
|
+
|
|
10694
|
+
/**
|
|
10695
|
+
* Get a list of key configurations data
|
|
10696
|
+
*
|
|
10697
|
+
*/
|
|
10698
|
+
getConversationsKeyconfigurations() {
|
|
10699
|
+
|
|
10700
|
+
return this.apiClient.callApi(
|
|
10701
|
+
'/api/v2/conversations/keyconfigurations',
|
|
10702
|
+
'GET',
|
|
10703
|
+
{ },
|
|
10704
|
+
{ },
|
|
10705
|
+
{ },
|
|
10706
|
+
{ },
|
|
10707
|
+
null,
|
|
10708
|
+
['PureCloud OAuth'],
|
|
10709
|
+
['application/json'],
|
|
10710
|
+
['application/json']
|
|
10711
|
+
);
|
|
10712
|
+
}
|
|
10713
|
+
|
|
10642
10714
|
/**
|
|
10643
10715
|
* Get message conversation
|
|
10644
10716
|
*
|
|
@@ -11355,6 +11427,36 @@ class ConversationsApi {
|
|
|
11355
11427
|
);
|
|
11356
11428
|
}
|
|
11357
11429
|
|
|
11430
|
+
/**
|
|
11431
|
+
* Update the secure attributes on a conversation.
|
|
11432
|
+
*
|
|
11433
|
+
* @param {String} conversationId conversation ID
|
|
11434
|
+
* @param {Object} body Conversation Secure Attributes
|
|
11435
|
+
*/
|
|
11436
|
+
patchConversationSecureattributes(conversationId, body) {
|
|
11437
|
+
// verify the required parameter 'conversationId' is set
|
|
11438
|
+
if (conversationId === undefined || conversationId === null) {
|
|
11439
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
|
|
11440
|
+
}
|
|
11441
|
+
// verify the required parameter 'body' is set
|
|
11442
|
+
if (body === undefined || body === null) {
|
|
11443
|
+
throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
|
|
11444
|
+
}
|
|
11445
|
+
|
|
11446
|
+
return this.apiClient.callApi(
|
|
11447
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
11448
|
+
'PATCH',
|
|
11449
|
+
{ 'conversationId': conversationId },
|
|
11450
|
+
{ },
|
|
11451
|
+
{ },
|
|
11452
|
+
{ },
|
|
11453
|
+
body,
|
|
11454
|
+
['PureCloud OAuth'],
|
|
11455
|
+
['application/json'],
|
|
11456
|
+
['application/json']
|
|
11457
|
+
);
|
|
11458
|
+
}
|
|
11459
|
+
|
|
11358
11460
|
/**
|
|
11359
11461
|
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11360
11462
|
*
|
|
@@ -13357,6 +13459,56 @@ class ConversationsApi {
|
|
|
13357
13459
|
);
|
|
13358
13460
|
}
|
|
13359
13461
|
|
|
13462
|
+
/**
|
|
13463
|
+
* Setup configurations for encryption key creation
|
|
13464
|
+
*
|
|
13465
|
+
* @param {Object} body Encryption Configuration
|
|
13466
|
+
*/
|
|
13467
|
+
postConversationsKeyconfigurations(body) {
|
|
13468
|
+
// verify the required parameter 'body' is set
|
|
13469
|
+
if (body === undefined || body === null) {
|
|
13470
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
|
|
13471
|
+
}
|
|
13472
|
+
|
|
13473
|
+
return this.apiClient.callApi(
|
|
13474
|
+
'/api/v2/conversations/keyconfigurations',
|
|
13475
|
+
'POST',
|
|
13476
|
+
{ },
|
|
13477
|
+
{ },
|
|
13478
|
+
{ },
|
|
13479
|
+
{ },
|
|
13480
|
+
body,
|
|
13481
|
+
['PureCloud OAuth'],
|
|
13482
|
+
['application/json'],
|
|
13483
|
+
['application/json']
|
|
13484
|
+
);
|
|
13485
|
+
}
|
|
13486
|
+
|
|
13487
|
+
/**
|
|
13488
|
+
* Validate encryption key configurations without saving it
|
|
13489
|
+
*
|
|
13490
|
+
* @param {Object} body Encryption Configuration
|
|
13491
|
+
*/
|
|
13492
|
+
postConversationsKeyconfigurationsValidate(body) {
|
|
13493
|
+
// verify the required parameter 'body' is set
|
|
13494
|
+
if (body === undefined || body === null) {
|
|
13495
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
|
|
13496
|
+
}
|
|
13497
|
+
|
|
13498
|
+
return this.apiClient.callApi(
|
|
13499
|
+
'/api/v2/conversations/keyconfigurations/validate',
|
|
13500
|
+
'POST',
|
|
13501
|
+
{ },
|
|
13502
|
+
{ },
|
|
13503
|
+
{ },
|
|
13504
|
+
{ },
|
|
13505
|
+
body,
|
|
13506
|
+
['PureCloud OAuth'],
|
|
13507
|
+
['application/json'],
|
|
13508
|
+
['application/json']
|
|
13509
|
+
);
|
|
13510
|
+
}
|
|
13511
|
+
|
|
13360
13512
|
/**
|
|
13361
13513
|
* Send message
|
|
13362
13514
|
* 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.
|
|
@@ -13741,6 +13893,36 @@ class ConversationsApi {
|
|
|
13741
13893
|
);
|
|
13742
13894
|
}
|
|
13743
13895
|
|
|
13896
|
+
/**
|
|
13897
|
+
* Set the secure attributes on a conversation.
|
|
13898
|
+
*
|
|
13899
|
+
* @param {String} conversationId conversation ID
|
|
13900
|
+
* @param {Object} body Conversation Secure Attributes
|
|
13901
|
+
*/
|
|
13902
|
+
putConversationSecureattributes(conversationId, body) {
|
|
13903
|
+
// verify the required parameter 'conversationId' is set
|
|
13904
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13905
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
|
|
13906
|
+
}
|
|
13907
|
+
// verify the required parameter 'body' is set
|
|
13908
|
+
if (body === undefined || body === null) {
|
|
13909
|
+
throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
|
|
13910
|
+
}
|
|
13911
|
+
|
|
13912
|
+
return this.apiClient.callApi(
|
|
13913
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
13914
|
+
'PUT',
|
|
13915
|
+
{ 'conversationId': conversationId },
|
|
13916
|
+
{ },
|
|
13917
|
+
{ },
|
|
13918
|
+
{ },
|
|
13919
|
+
body,
|
|
13920
|
+
['PureCloud OAuth'],
|
|
13921
|
+
['application/json'],
|
|
13922
|
+
['application/json']
|
|
13923
|
+
);
|
|
13924
|
+
}
|
|
13925
|
+
|
|
13744
13926
|
/**
|
|
13745
13927
|
* Update the tags on a conversation.
|
|
13746
13928
|
*
|
|
@@ -13991,6 +14173,36 @@ class ConversationsApi {
|
|
|
13991
14173
|
);
|
|
13992
14174
|
}
|
|
13993
14175
|
|
|
14176
|
+
/**
|
|
14177
|
+
* Update the encryption key configurations
|
|
14178
|
+
*
|
|
14179
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
14180
|
+
* @param {Object} body Encryption key configuration metadata
|
|
14181
|
+
*/
|
|
14182
|
+
putConversationsKeyconfiguration(keyconfigurationsId, body) {
|
|
14183
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
14184
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
14185
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
|
|
14186
|
+
}
|
|
14187
|
+
// verify the required parameter 'body' is set
|
|
14188
|
+
if (body === undefined || body === null) {
|
|
14189
|
+
throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
|
|
14190
|
+
}
|
|
14191
|
+
|
|
14192
|
+
return this.apiClient.callApi(
|
|
14193
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
14194
|
+
'PUT',
|
|
14195
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
14196
|
+
{ },
|
|
14197
|
+
{ },
|
|
14198
|
+
{ },
|
|
14199
|
+
body,
|
|
14200
|
+
['PureCloud OAuth'],
|
|
14201
|
+
['application/json'],
|
|
14202
|
+
['application/json']
|
|
14203
|
+
);
|
|
14204
|
+
}
|
|
14205
|
+
|
|
13994
14206
|
/**
|
|
13995
14207
|
* Update a conversation by setting its recording state
|
|
13996
14208
|
*
|
|
@@ -14197,7 +14409,7 @@ class DataExtensionsApi {
|
|
|
14197
14409
|
/**
|
|
14198
14410
|
* DataExtensions service.
|
|
14199
14411
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14200
|
-
* @version
|
|
14412
|
+
* @version 146.0.0
|
|
14201
14413
|
*/
|
|
14202
14414
|
|
|
14203
14415
|
/**
|
|
@@ -14283,7 +14495,7 @@ class ExternalContactsApi {
|
|
|
14283
14495
|
/**
|
|
14284
14496
|
* ExternalContacts service.
|
|
14285
14497
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14286
|
-
* @version
|
|
14498
|
+
* @version 146.0.0
|
|
14287
14499
|
*/
|
|
14288
14500
|
|
|
14289
14501
|
/**
|
|
@@ -16026,7 +16238,7 @@ class FaxApi {
|
|
|
16026
16238
|
/**
|
|
16027
16239
|
* Fax service.
|
|
16028
16240
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16029
|
-
* @version
|
|
16241
|
+
* @version 146.0.0
|
|
16030
16242
|
*/
|
|
16031
16243
|
|
|
16032
16244
|
/**
|
|
@@ -16197,7 +16409,7 @@ class FlowsApi {
|
|
|
16197
16409
|
/**
|
|
16198
16410
|
* Flows service.
|
|
16199
16411
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16200
|
-
* @version
|
|
16412
|
+
* @version 146.0.0
|
|
16201
16413
|
*/
|
|
16202
16414
|
|
|
16203
16415
|
/**
|
|
@@ -16268,7 +16480,7 @@ class GamificationApi {
|
|
|
16268
16480
|
/**
|
|
16269
16481
|
* Gamification service.
|
|
16270
16482
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16271
|
-
* @version
|
|
16483
|
+
* @version 146.0.0
|
|
16272
16484
|
*/
|
|
16273
16485
|
|
|
16274
16486
|
/**
|
|
@@ -17022,14 +17234,14 @@ class GamificationApi {
|
|
|
17022
17234
|
* @param {String} profileId performanceProfileId
|
|
17023
17235
|
* @param {String} metricId metricId
|
|
17024
17236
|
* @param {Object} filterType Filter type for the query request.
|
|
17025
|
-
* @param {String} filterId ID for the filter type. For example, division Id
|
|
17026
17237
|
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17027
17238
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17028
17239
|
* @param {Object} opts Optional parameters
|
|
17240
|
+
* @param {String} opts.filterId ID for the filter type. Only required when filterType is Division.
|
|
17029
17241
|
* @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
|
|
17030
17242
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
17031
17243
|
*/
|
|
17032
|
-
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType,
|
|
17244
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, opts) {
|
|
17033
17245
|
opts = opts || {};
|
|
17034
17246
|
|
|
17035
17247
|
// verify the required parameter 'profileId' is set
|
|
@@ -17044,10 +17256,6 @@ class GamificationApi {
|
|
|
17044
17256
|
if (filterType === undefined || filterType === null) {
|
|
17045
17257
|
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
17046
17258
|
}
|
|
17047
|
-
// verify the required parameter 'filterId' is set
|
|
17048
|
-
if (filterId === undefined || filterId === null) {
|
|
17049
|
-
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
17050
|
-
}
|
|
17051
17259
|
// verify the required parameter 'startWorkday' is set
|
|
17052
17260
|
if (startWorkday === undefined || startWorkday === null) {
|
|
17053
17261
|
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
@@ -17061,7 +17269,7 @@ class GamificationApi {
|
|
|
17061
17269
|
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
17062
17270
|
'GET',
|
|
17063
17271
|
{ 'profileId': profileId,'metricId': metricId },
|
|
17064
|
-
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17272
|
+
{ 'filterType': filterType,'filterId': opts['filterId'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17065
17273
|
{ },
|
|
17066
17274
|
{ },
|
|
17067
17275
|
null,
|
|
@@ -18003,7 +18211,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18003
18211
|
/**
|
|
18004
18212
|
* GeneralDataProtectionRegulation service.
|
|
18005
18213
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18006
|
-
* @version
|
|
18214
|
+
* @version 146.0.0
|
|
18007
18215
|
*/
|
|
18008
18216
|
|
|
18009
18217
|
/**
|
|
@@ -18133,7 +18341,7 @@ class GeolocationApi {
|
|
|
18133
18341
|
/**
|
|
18134
18342
|
* Geolocation service.
|
|
18135
18343
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18136
|
-
* @version
|
|
18344
|
+
* @version 146.0.0
|
|
18137
18345
|
*/
|
|
18138
18346
|
|
|
18139
18347
|
/**
|
|
@@ -18264,7 +18472,7 @@ class GreetingsApi {
|
|
|
18264
18472
|
/**
|
|
18265
18473
|
* Greetings service.
|
|
18266
18474
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18267
|
-
* @version
|
|
18475
|
+
* @version 146.0.0
|
|
18268
18476
|
*/
|
|
18269
18477
|
|
|
18270
18478
|
/**
|
|
@@ -18719,7 +18927,7 @@ class GroupsApi {
|
|
|
18719
18927
|
/**
|
|
18720
18928
|
* Groups service.
|
|
18721
18929
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18722
|
-
* @version
|
|
18930
|
+
* @version 146.0.0
|
|
18723
18931
|
*/
|
|
18724
18932
|
|
|
18725
18933
|
/**
|
|
@@ -19124,7 +19332,7 @@ class IdentityProviderApi {
|
|
|
19124
19332
|
/**
|
|
19125
19333
|
* IdentityProvider service.
|
|
19126
19334
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19127
|
-
* @version
|
|
19335
|
+
* @version 146.0.0
|
|
19128
19336
|
*/
|
|
19129
19337
|
|
|
19130
19338
|
/**
|
|
@@ -19880,7 +20088,7 @@ class IntegrationsApi {
|
|
|
19880
20088
|
/**
|
|
19881
20089
|
* Integrations service.
|
|
19882
20090
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19883
|
-
* @version
|
|
20091
|
+
* @version 146.0.0
|
|
19884
20092
|
*/
|
|
19885
20093
|
|
|
19886
20094
|
/**
|
|
@@ -21557,7 +21765,7 @@ class JourneyApi {
|
|
|
21557
21765
|
/**
|
|
21558
21766
|
* Journey service.
|
|
21559
21767
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21560
|
-
* @version
|
|
21768
|
+
* @version 146.0.0
|
|
21561
21769
|
*/
|
|
21562
21770
|
|
|
21563
21771
|
/**
|
|
@@ -22268,7 +22476,7 @@ class KnowledgeApi {
|
|
|
22268
22476
|
/**
|
|
22269
22477
|
* Knowledge service.
|
|
22270
22478
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22271
|
-
* @version
|
|
22479
|
+
* @version 146.0.0
|
|
22272
22480
|
*/
|
|
22273
22481
|
|
|
22274
22482
|
/**
|
|
@@ -22308,6 +22516,191 @@ class KnowledgeApi {
|
|
|
22308
22516
|
);
|
|
22309
22517
|
}
|
|
22310
22518
|
|
|
22519
|
+
/**
|
|
22520
|
+
* Delete category
|
|
22521
|
+
*
|
|
22522
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22523
|
+
* @param {String} categoryId Category ID
|
|
22524
|
+
*/
|
|
22525
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
22526
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22527
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22528
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
22529
|
+
}
|
|
22530
|
+
// verify the required parameter 'categoryId' is set
|
|
22531
|
+
if (categoryId === undefined || categoryId === null) {
|
|
22532
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
22533
|
+
}
|
|
22534
|
+
|
|
22535
|
+
return this.apiClient.callApi(
|
|
22536
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
22537
|
+
'DELETE',
|
|
22538
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
22539
|
+
{ },
|
|
22540
|
+
{ },
|
|
22541
|
+
{ },
|
|
22542
|
+
null,
|
|
22543
|
+
['PureCloud OAuth'],
|
|
22544
|
+
['application/json'],
|
|
22545
|
+
['application/json']
|
|
22546
|
+
);
|
|
22547
|
+
}
|
|
22548
|
+
|
|
22549
|
+
/**
|
|
22550
|
+
* Delete document.
|
|
22551
|
+
*
|
|
22552
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
22553
|
+
* @param {String} documentId Document ID.
|
|
22554
|
+
*/
|
|
22555
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
22556
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22557
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22558
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
22559
|
+
}
|
|
22560
|
+
// verify the required parameter 'documentId' is set
|
|
22561
|
+
if (documentId === undefined || documentId === null) {
|
|
22562
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
22563
|
+
}
|
|
22564
|
+
|
|
22565
|
+
return this.apiClient.callApi(
|
|
22566
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
22567
|
+
'DELETE',
|
|
22568
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
22569
|
+
{ },
|
|
22570
|
+
{ },
|
|
22571
|
+
{ },
|
|
22572
|
+
null,
|
|
22573
|
+
['PureCloud OAuth'],
|
|
22574
|
+
['application/json'],
|
|
22575
|
+
['application/json']
|
|
22576
|
+
);
|
|
22577
|
+
}
|
|
22578
|
+
|
|
22579
|
+
/**
|
|
22580
|
+
* Delete a variation for a document.
|
|
22581
|
+
*
|
|
22582
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
22583
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
22584
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
22585
|
+
*/
|
|
22586
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
22587
|
+
// verify the required parameter 'documentVariationId' is set
|
|
22588
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
22589
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22590
|
+
}
|
|
22591
|
+
// verify the required parameter 'documentId' is set
|
|
22592
|
+
if (documentId === undefined || documentId === null) {
|
|
22593
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22594
|
+
}
|
|
22595
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22596
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22597
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22598
|
+
}
|
|
22599
|
+
|
|
22600
|
+
return this.apiClient.callApi(
|
|
22601
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
22602
|
+
'DELETE',
|
|
22603
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
22604
|
+
{ },
|
|
22605
|
+
{ },
|
|
22606
|
+
{ },
|
|
22607
|
+
null,
|
|
22608
|
+
['PureCloud OAuth'],
|
|
22609
|
+
['application/json'],
|
|
22610
|
+
['application/json']
|
|
22611
|
+
);
|
|
22612
|
+
}
|
|
22613
|
+
|
|
22614
|
+
/**
|
|
22615
|
+
* Delete export job
|
|
22616
|
+
*
|
|
22617
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22618
|
+
* @param {String} exportJobId Export job ID
|
|
22619
|
+
*/
|
|
22620
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
22621
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22622
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22623
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
22624
|
+
}
|
|
22625
|
+
// verify the required parameter 'exportJobId' is set
|
|
22626
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
22627
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
22628
|
+
}
|
|
22629
|
+
|
|
22630
|
+
return this.apiClient.callApi(
|
|
22631
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
22632
|
+
'DELETE',
|
|
22633
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
22634
|
+
{ },
|
|
22635
|
+
{ },
|
|
22636
|
+
{ },
|
|
22637
|
+
null,
|
|
22638
|
+
['PureCloud OAuth'],
|
|
22639
|
+
['application/json'],
|
|
22640
|
+
['application/json']
|
|
22641
|
+
);
|
|
22642
|
+
}
|
|
22643
|
+
|
|
22644
|
+
/**
|
|
22645
|
+
* Delete import job
|
|
22646
|
+
*
|
|
22647
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22648
|
+
* @param {String} importJobId Import job ID
|
|
22649
|
+
*/
|
|
22650
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
22651
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22652
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22653
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
22654
|
+
}
|
|
22655
|
+
// verify the required parameter 'importJobId' is set
|
|
22656
|
+
if (importJobId === undefined || importJobId === null) {
|
|
22657
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
22658
|
+
}
|
|
22659
|
+
|
|
22660
|
+
return this.apiClient.callApi(
|
|
22661
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
22662
|
+
'DELETE',
|
|
22663
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
22664
|
+
{ },
|
|
22665
|
+
{ },
|
|
22666
|
+
{ },
|
|
22667
|
+
null,
|
|
22668
|
+
['PureCloud OAuth'],
|
|
22669
|
+
['application/json'],
|
|
22670
|
+
['application/json']
|
|
22671
|
+
);
|
|
22672
|
+
}
|
|
22673
|
+
|
|
22674
|
+
/**
|
|
22675
|
+
* Delete label
|
|
22676
|
+
*
|
|
22677
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22678
|
+
* @param {String} labelId Label ID
|
|
22679
|
+
*/
|
|
22680
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
22681
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22682
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22683
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
22684
|
+
}
|
|
22685
|
+
// verify the required parameter 'labelId' is set
|
|
22686
|
+
if (labelId === undefined || labelId === null) {
|
|
22687
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
22688
|
+
}
|
|
22689
|
+
|
|
22690
|
+
return this.apiClient.callApi(
|
|
22691
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
22692
|
+
'DELETE',
|
|
22693
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
22694
|
+
{ },
|
|
22695
|
+
{ },
|
|
22696
|
+
{ },
|
|
22697
|
+
null,
|
|
22698
|
+
['PureCloud OAuth'],
|
|
22699
|
+
['application/json'],
|
|
22700
|
+
['application/json']
|
|
22701
|
+
);
|
|
22702
|
+
}
|
|
22703
|
+
|
|
22311
22704
|
/**
|
|
22312
22705
|
* Delete category
|
|
22313
22706
|
*
|
|
@@ -22413,6 +22806,104 @@ class KnowledgeApi {
|
|
|
22413
22806
|
);
|
|
22414
22807
|
}
|
|
22415
22808
|
|
|
22809
|
+
/**
|
|
22810
|
+
* Get categories
|
|
22811
|
+
*
|
|
22812
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22813
|
+
* @param {Object} opts Optional parameters
|
|
22814
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22815
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22816
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22817
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
22818
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
22819
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
22820
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
22821
|
+
* @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.
|
|
22822
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
22823
|
+
*/
|
|
22824
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
22825
|
+
opts = opts || {};
|
|
22826
|
+
|
|
22827
|
+
// verify the required parameter 'sessionId' is set
|
|
22828
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22829
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
22830
|
+
}
|
|
22831
|
+
|
|
22832
|
+
return this.apiClient.callApi(
|
|
22833
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
22834
|
+
'GET',
|
|
22835
|
+
{ 'sessionId': sessionId },
|
|
22836
|
+
{ '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'] },
|
|
22837
|
+
{ },
|
|
22838
|
+
{ },
|
|
22839
|
+
null,
|
|
22840
|
+
['PureCloud OAuth'],
|
|
22841
|
+
['application/json'],
|
|
22842
|
+
['application/json']
|
|
22843
|
+
);
|
|
22844
|
+
}
|
|
22845
|
+
|
|
22846
|
+
/**
|
|
22847
|
+
* Get a knowledge document by ID.
|
|
22848
|
+
*
|
|
22849
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22850
|
+
* @param {String} documentId Document ID
|
|
22851
|
+
*/
|
|
22852
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
22853
|
+
// verify the required parameter 'sessionId' is set
|
|
22854
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22855
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
22856
|
+
}
|
|
22857
|
+
// verify the required parameter 'documentId' is set
|
|
22858
|
+
if (documentId === undefined || documentId === null) {
|
|
22859
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
22860
|
+
}
|
|
22861
|
+
|
|
22862
|
+
return this.apiClient.callApi(
|
|
22863
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
22864
|
+
'GET',
|
|
22865
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
22866
|
+
{ },
|
|
22867
|
+
{ },
|
|
22868
|
+
{ },
|
|
22869
|
+
null,
|
|
22870
|
+
['PureCloud OAuth'],
|
|
22871
|
+
['application/json'],
|
|
22872
|
+
['application/json']
|
|
22873
|
+
);
|
|
22874
|
+
}
|
|
22875
|
+
|
|
22876
|
+
/**
|
|
22877
|
+
* Get documents.
|
|
22878
|
+
*
|
|
22879
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22880
|
+
* @param {Object} opts Optional parameters
|
|
22881
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
22882
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
22883
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22884
|
+
*/
|
|
22885
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
22886
|
+
opts = opts || {};
|
|
22887
|
+
|
|
22888
|
+
// verify the required parameter 'sessionId' is set
|
|
22889
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22890
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
22891
|
+
}
|
|
22892
|
+
|
|
22893
|
+
return this.apiClient.callApi(
|
|
22894
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
22895
|
+
'GET',
|
|
22896
|
+
{ 'sessionId': sessionId },
|
|
22897
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
22898
|
+
{ },
|
|
22899
|
+
{ },
|
|
22900
|
+
null,
|
|
22901
|
+
['PureCloud OAuth'],
|
|
22902
|
+
['application/json'],
|
|
22903
|
+
['application/json']
|
|
22904
|
+
);
|
|
22905
|
+
}
|
|
22906
|
+
|
|
22416
22907
|
/**
|
|
22417
22908
|
* Get knowledge base
|
|
22418
22909
|
*
|
|
@@ -22438,6 +22929,501 @@ class KnowledgeApi {
|
|
|
22438
22929
|
);
|
|
22439
22930
|
}
|
|
22440
22931
|
|
|
22932
|
+
/**
|
|
22933
|
+
* Get categories
|
|
22934
|
+
*
|
|
22935
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22936
|
+
* @param {Object} opts Optional parameters
|
|
22937
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22938
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22939
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22940
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
22941
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
22942
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
22943
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
22944
|
+
* @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.
|
|
22945
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
22946
|
+
*/
|
|
22947
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
22948
|
+
opts = opts || {};
|
|
22949
|
+
|
|
22950
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22951
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22952
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
22953
|
+
}
|
|
22954
|
+
|
|
22955
|
+
return this.apiClient.callApi(
|
|
22956
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
22957
|
+
'GET',
|
|
22958
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
22959
|
+
{ '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'] },
|
|
22960
|
+
{ },
|
|
22961
|
+
{ },
|
|
22962
|
+
null,
|
|
22963
|
+
['PureCloud OAuth'],
|
|
22964
|
+
['application/json'],
|
|
22965
|
+
['application/json']
|
|
22966
|
+
);
|
|
22967
|
+
}
|
|
22968
|
+
|
|
22969
|
+
/**
|
|
22970
|
+
* Get category
|
|
22971
|
+
*
|
|
22972
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22973
|
+
* @param {String} categoryId Category ID
|
|
22974
|
+
*/
|
|
22975
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
22976
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22977
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22978
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
22979
|
+
}
|
|
22980
|
+
// verify the required parameter 'categoryId' is set
|
|
22981
|
+
if (categoryId === undefined || categoryId === null) {
|
|
22982
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
22983
|
+
}
|
|
22984
|
+
|
|
22985
|
+
return this.apiClient.callApi(
|
|
22986
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
22987
|
+
'GET',
|
|
22988
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
22989
|
+
{ },
|
|
22990
|
+
{ },
|
|
22991
|
+
{ },
|
|
22992
|
+
null,
|
|
22993
|
+
['PureCloud OAuth'],
|
|
22994
|
+
['application/json'],
|
|
22995
|
+
['application/json']
|
|
22996
|
+
);
|
|
22997
|
+
}
|
|
22998
|
+
|
|
22999
|
+
/**
|
|
23000
|
+
* Get document.
|
|
23001
|
+
*
|
|
23002
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23003
|
+
* @param {String} documentId Document ID.
|
|
23004
|
+
* @param {Object} opts Optional parameters
|
|
23005
|
+
* @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.
|
|
23006
|
+
* @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.
|
|
23007
|
+
*/
|
|
23008
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
23009
|
+
opts = opts || {};
|
|
23010
|
+
|
|
23011
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23012
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23013
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
23014
|
+
}
|
|
23015
|
+
// verify the required parameter 'documentId' is set
|
|
23016
|
+
if (documentId === undefined || documentId === null) {
|
|
23017
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
23018
|
+
}
|
|
23019
|
+
|
|
23020
|
+
return this.apiClient.callApi(
|
|
23021
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
23022
|
+
'GET',
|
|
23023
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23024
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
23025
|
+
{ },
|
|
23026
|
+
{ },
|
|
23027
|
+
null,
|
|
23028
|
+
['PureCloud OAuth'],
|
|
23029
|
+
['application/json'],
|
|
23030
|
+
['application/json']
|
|
23031
|
+
);
|
|
23032
|
+
}
|
|
23033
|
+
|
|
23034
|
+
/**
|
|
23035
|
+
* Get a variation for a document.
|
|
23036
|
+
*
|
|
23037
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
23038
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
23039
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
23040
|
+
* @param {Object} opts Optional parameters
|
|
23041
|
+
* @param {Object} opts.documentState The state of the document.
|
|
23042
|
+
*/
|
|
23043
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
23044
|
+
opts = opts || {};
|
|
23045
|
+
|
|
23046
|
+
// verify the required parameter 'documentVariationId' is set
|
|
23047
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
23048
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23049
|
+
}
|
|
23050
|
+
// verify the required parameter 'documentId' is set
|
|
23051
|
+
if (documentId === undefined || documentId === null) {
|
|
23052
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23053
|
+
}
|
|
23054
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23055
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23056
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23057
|
+
}
|
|
23058
|
+
|
|
23059
|
+
return this.apiClient.callApi(
|
|
23060
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
23061
|
+
'GET',
|
|
23062
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
23063
|
+
{ 'documentState': opts['documentState'] },
|
|
23064
|
+
{ },
|
|
23065
|
+
{ },
|
|
23066
|
+
null,
|
|
23067
|
+
['PureCloud OAuth'],
|
|
23068
|
+
['application/json'],
|
|
23069
|
+
['application/json']
|
|
23070
|
+
);
|
|
23071
|
+
}
|
|
23072
|
+
|
|
23073
|
+
/**
|
|
23074
|
+
* Get variations for a document.
|
|
23075
|
+
*
|
|
23076
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23077
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23078
|
+
* @param {Object} opts Optional parameters
|
|
23079
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23080
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23081
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23082
|
+
* @param {Object} opts.documentState The state of the document.
|
|
23083
|
+
*/
|
|
23084
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
23085
|
+
opts = opts || {};
|
|
23086
|
+
|
|
23087
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23088
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23089
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
23090
|
+
}
|
|
23091
|
+
// verify the required parameter 'documentId' is set
|
|
23092
|
+
if (documentId === undefined || documentId === null) {
|
|
23093
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
23094
|
+
}
|
|
23095
|
+
|
|
23096
|
+
return this.apiClient.callApi(
|
|
23097
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
23098
|
+
'GET',
|
|
23099
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23100
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
23101
|
+
{ },
|
|
23102
|
+
{ },
|
|
23103
|
+
null,
|
|
23104
|
+
['PureCloud OAuth'],
|
|
23105
|
+
['application/json'],
|
|
23106
|
+
['application/json']
|
|
23107
|
+
);
|
|
23108
|
+
}
|
|
23109
|
+
|
|
23110
|
+
/**
|
|
23111
|
+
* Get document version.
|
|
23112
|
+
*
|
|
23113
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23114
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23115
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23116
|
+
* @param {Object} opts Optional parameters
|
|
23117
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23118
|
+
*/
|
|
23119
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
23120
|
+
opts = opts || {};
|
|
23121
|
+
|
|
23122
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23123
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23124
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23125
|
+
}
|
|
23126
|
+
// verify the required parameter 'documentId' is set
|
|
23127
|
+
if (documentId === undefined || documentId === null) {
|
|
23128
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23129
|
+
}
|
|
23130
|
+
// verify the required parameter 'versionId' is set
|
|
23131
|
+
if (versionId === undefined || versionId === null) {
|
|
23132
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23133
|
+
}
|
|
23134
|
+
|
|
23135
|
+
return this.apiClient.callApi(
|
|
23136
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
23137
|
+
'GET',
|
|
23138
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
23139
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23140
|
+
{ },
|
|
23141
|
+
{ },
|
|
23142
|
+
null,
|
|
23143
|
+
['PureCloud OAuth'],
|
|
23144
|
+
['application/json'],
|
|
23145
|
+
['application/json']
|
|
23146
|
+
);
|
|
23147
|
+
}
|
|
23148
|
+
|
|
23149
|
+
/**
|
|
23150
|
+
* Get variation for the given document version.
|
|
23151
|
+
*
|
|
23152
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23153
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23154
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23155
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
23156
|
+
*/
|
|
23157
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
23158
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23159
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23160
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23161
|
+
}
|
|
23162
|
+
// verify the required parameter 'documentId' is set
|
|
23163
|
+
if (documentId === undefined || documentId === null) {
|
|
23164
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23165
|
+
}
|
|
23166
|
+
// verify the required parameter 'versionId' is set
|
|
23167
|
+
if (versionId === undefined || versionId === null) {
|
|
23168
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23169
|
+
}
|
|
23170
|
+
// verify the required parameter 'variationId' is set
|
|
23171
|
+
if (variationId === undefined || variationId === null) {
|
|
23172
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23173
|
+
}
|
|
23174
|
+
|
|
23175
|
+
return this.apiClient.callApi(
|
|
23176
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
23177
|
+
'GET',
|
|
23178
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
23179
|
+
{ },
|
|
23180
|
+
{ },
|
|
23181
|
+
{ },
|
|
23182
|
+
null,
|
|
23183
|
+
['PureCloud OAuth'],
|
|
23184
|
+
['application/json'],
|
|
23185
|
+
['application/json']
|
|
23186
|
+
);
|
|
23187
|
+
}
|
|
23188
|
+
|
|
23189
|
+
/**
|
|
23190
|
+
* Get variations for the given document version.
|
|
23191
|
+
*
|
|
23192
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23193
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23194
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23195
|
+
* @param {Object} opts Optional parameters
|
|
23196
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23197
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23198
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23199
|
+
*/
|
|
23200
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
23201
|
+
opts = opts || {};
|
|
23202
|
+
|
|
23203
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23204
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23205
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23206
|
+
}
|
|
23207
|
+
// verify the required parameter 'documentId' is set
|
|
23208
|
+
if (documentId === undefined || documentId === null) {
|
|
23209
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23210
|
+
}
|
|
23211
|
+
// verify the required parameter 'versionId' is set
|
|
23212
|
+
if (versionId === undefined || versionId === null) {
|
|
23213
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23214
|
+
}
|
|
23215
|
+
|
|
23216
|
+
return this.apiClient.callApi(
|
|
23217
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
23218
|
+
'GET',
|
|
23219
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
23220
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
23221
|
+
{ },
|
|
23222
|
+
{ },
|
|
23223
|
+
null,
|
|
23224
|
+
['PureCloud OAuth'],
|
|
23225
|
+
['application/json'],
|
|
23226
|
+
['application/json']
|
|
23227
|
+
);
|
|
23228
|
+
}
|
|
23229
|
+
|
|
23230
|
+
/**
|
|
23231
|
+
* Get document versions.
|
|
23232
|
+
*
|
|
23233
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23234
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23235
|
+
* @param {Object} opts Optional parameters
|
|
23236
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23237
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23238
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23239
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23240
|
+
*/
|
|
23241
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
23242
|
+
opts = opts || {};
|
|
23243
|
+
|
|
23244
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23245
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23246
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
23247
|
+
}
|
|
23248
|
+
// verify the required parameter 'documentId' is set
|
|
23249
|
+
if (documentId === undefined || documentId === null) {
|
|
23250
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
23251
|
+
}
|
|
23252
|
+
|
|
23253
|
+
return this.apiClient.callApi(
|
|
23254
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
23255
|
+
'GET',
|
|
23256
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23257
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23258
|
+
{ },
|
|
23259
|
+
{ },
|
|
23260
|
+
null,
|
|
23261
|
+
['PureCloud OAuth'],
|
|
23262
|
+
['application/json'],
|
|
23263
|
+
['application/json']
|
|
23264
|
+
);
|
|
23265
|
+
}
|
|
23266
|
+
|
|
23267
|
+
/**
|
|
23268
|
+
* Get documents.
|
|
23269
|
+
*
|
|
23270
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23271
|
+
* @param {Object} opts Optional parameters
|
|
23272
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23273
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23274
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23275
|
+
* @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
|
|
23276
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23277
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23278
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
23279
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
23280
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23281
|
+
*/
|
|
23282
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
23283
|
+
opts = opts || {};
|
|
23284
|
+
|
|
23285
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23286
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23287
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
23288
|
+
}
|
|
23289
|
+
|
|
23290
|
+
return this.apiClient.callApi(
|
|
23291
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
23292
|
+
'GET',
|
|
23293
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23294
|
+
{ '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') },
|
|
23295
|
+
{ },
|
|
23296
|
+
{ },
|
|
23297
|
+
null,
|
|
23298
|
+
['PureCloud OAuth'],
|
|
23299
|
+
['application/json'],
|
|
23300
|
+
['application/json']
|
|
23301
|
+
);
|
|
23302
|
+
}
|
|
23303
|
+
|
|
23304
|
+
/**
|
|
23305
|
+
* Get export job report
|
|
23306
|
+
*
|
|
23307
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23308
|
+
* @param {String} exportJobId Export job ID
|
|
23309
|
+
*/
|
|
23310
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
23311
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23312
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23313
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
23314
|
+
}
|
|
23315
|
+
// verify the required parameter 'exportJobId' is set
|
|
23316
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
23317
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
23318
|
+
}
|
|
23319
|
+
|
|
23320
|
+
return this.apiClient.callApi(
|
|
23321
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
23322
|
+
'GET',
|
|
23323
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
23324
|
+
{ },
|
|
23325
|
+
{ },
|
|
23326
|
+
{ },
|
|
23327
|
+
null,
|
|
23328
|
+
['PureCloud OAuth'],
|
|
23329
|
+
['application/json'],
|
|
23330
|
+
['application/json']
|
|
23331
|
+
);
|
|
23332
|
+
}
|
|
23333
|
+
|
|
23334
|
+
/**
|
|
23335
|
+
* Get import job report
|
|
23336
|
+
*
|
|
23337
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23338
|
+
* @param {String} importJobId Import job ID
|
|
23339
|
+
*/
|
|
23340
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
23341
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23342
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23343
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
23344
|
+
}
|
|
23345
|
+
// verify the required parameter 'importJobId' is set
|
|
23346
|
+
if (importJobId === undefined || importJobId === null) {
|
|
23347
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
23348
|
+
}
|
|
23349
|
+
|
|
23350
|
+
return this.apiClient.callApi(
|
|
23351
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
23352
|
+
'GET',
|
|
23353
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
23354
|
+
{ },
|
|
23355
|
+
{ },
|
|
23356
|
+
{ },
|
|
23357
|
+
null,
|
|
23358
|
+
['PureCloud OAuth'],
|
|
23359
|
+
['application/json'],
|
|
23360
|
+
['application/json']
|
|
23361
|
+
);
|
|
23362
|
+
}
|
|
23363
|
+
|
|
23364
|
+
/**
|
|
23365
|
+
* Get label
|
|
23366
|
+
*
|
|
23367
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23368
|
+
* @param {String} labelId Label ID
|
|
23369
|
+
*/
|
|
23370
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
23371
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23372
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23373
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
23374
|
+
}
|
|
23375
|
+
// verify the required parameter 'labelId' is set
|
|
23376
|
+
if (labelId === undefined || labelId === null) {
|
|
23377
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
23378
|
+
}
|
|
23379
|
+
|
|
23380
|
+
return this.apiClient.callApi(
|
|
23381
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
23382
|
+
'GET',
|
|
23383
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
23384
|
+
{ },
|
|
23385
|
+
{ },
|
|
23386
|
+
{ },
|
|
23387
|
+
null,
|
|
23388
|
+
['PureCloud OAuth'],
|
|
23389
|
+
['application/json'],
|
|
23390
|
+
['application/json']
|
|
23391
|
+
);
|
|
23392
|
+
}
|
|
23393
|
+
|
|
23394
|
+
/**
|
|
23395
|
+
* Get labels
|
|
23396
|
+
*
|
|
23397
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23398
|
+
* @param {Object} opts Optional parameters
|
|
23399
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23400
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23401
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23402
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
23403
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
23404
|
+
*/
|
|
23405
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
23406
|
+
opts = opts || {};
|
|
23407
|
+
|
|
23408
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23409
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23410
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
23411
|
+
}
|
|
23412
|
+
|
|
23413
|
+
return this.apiClient.callApi(
|
|
23414
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
23415
|
+
'GET',
|
|
23416
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23417
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
23418
|
+
{ },
|
|
23419
|
+
{ },
|
|
23420
|
+
null,
|
|
23421
|
+
['PureCloud OAuth'],
|
|
23422
|
+
['application/json'],
|
|
23423
|
+
['application/json']
|
|
23424
|
+
);
|
|
23425
|
+
}
|
|
23426
|
+
|
|
22441
23427
|
/**
|
|
22442
23428
|
* Get categories
|
|
22443
23429
|
*
|
|
@@ -22696,6 +23682,108 @@ class KnowledgeApi {
|
|
|
22696
23682
|
);
|
|
22697
23683
|
}
|
|
22698
23684
|
|
|
23685
|
+
/**
|
|
23686
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
23687
|
+
*
|
|
23688
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23689
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
23690
|
+
* @param {Object} opts Optional parameters
|
|
23691
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23692
|
+
*/
|
|
23693
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
23694
|
+
opts = opts || {};
|
|
23695
|
+
|
|
23696
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23697
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23698
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
23699
|
+
}
|
|
23700
|
+
// verify the required parameter 'groupId' is set
|
|
23701
|
+
if (groupId === undefined || groupId === null) {
|
|
23702
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
23703
|
+
}
|
|
23704
|
+
|
|
23705
|
+
return this.apiClient.callApi(
|
|
23706
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
23707
|
+
'GET',
|
|
23708
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
23709
|
+
{ 'app': opts['app'] },
|
|
23710
|
+
{ },
|
|
23711
|
+
{ },
|
|
23712
|
+
null,
|
|
23713
|
+
['PureCloud OAuth'],
|
|
23714
|
+
['application/json'],
|
|
23715
|
+
['application/json']
|
|
23716
|
+
);
|
|
23717
|
+
}
|
|
23718
|
+
|
|
23719
|
+
/**
|
|
23720
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
23721
|
+
*
|
|
23722
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23723
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
23724
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
23725
|
+
* @param {Object} opts Optional parameters
|
|
23726
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23727
|
+
*/
|
|
23728
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
23729
|
+
opts = opts || {};
|
|
23730
|
+
|
|
23731
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23732
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23733
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23734
|
+
}
|
|
23735
|
+
// verify the required parameter 'groupId' is set
|
|
23736
|
+
if (groupId === undefined || groupId === null) {
|
|
23737
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23738
|
+
}
|
|
23739
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
23740
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
23741
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23742
|
+
}
|
|
23743
|
+
|
|
23744
|
+
return this.apiClient.callApi(
|
|
23745
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
23746
|
+
'GET',
|
|
23747
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
23748
|
+
{ 'app': opts['app'] },
|
|
23749
|
+
{ },
|
|
23750
|
+
{ },
|
|
23751
|
+
null,
|
|
23752
|
+
['PureCloud OAuth'],
|
|
23753
|
+
['application/json'],
|
|
23754
|
+
['application/json']
|
|
23755
|
+
);
|
|
23756
|
+
}
|
|
23757
|
+
|
|
23758
|
+
/**
|
|
23759
|
+
* Get knowledge base unanswered groups
|
|
23760
|
+
*
|
|
23761
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23762
|
+
* @param {Object} opts Optional parameters
|
|
23763
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23764
|
+
*/
|
|
23765
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
23766
|
+
opts = opts || {};
|
|
23767
|
+
|
|
23768
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23769
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23770
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
23771
|
+
}
|
|
23772
|
+
|
|
23773
|
+
return this.apiClient.callApi(
|
|
23774
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
23775
|
+
'GET',
|
|
23776
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23777
|
+
{ 'app': opts['app'] },
|
|
23778
|
+
{ },
|
|
23779
|
+
{ },
|
|
23780
|
+
null,
|
|
23781
|
+
['PureCloud OAuth'],
|
|
23782
|
+
['application/json'],
|
|
23783
|
+
['application/json']
|
|
23784
|
+
);
|
|
23785
|
+
}
|
|
23786
|
+
|
|
22699
23787
|
/**
|
|
22700
23788
|
* Get knowledge bases
|
|
22701
23789
|
*
|
|
@@ -22728,6 +23816,41 @@ class KnowledgeApi {
|
|
|
22728
23816
|
);
|
|
22729
23817
|
}
|
|
22730
23818
|
|
|
23819
|
+
/**
|
|
23820
|
+
* Update search result.
|
|
23821
|
+
*
|
|
23822
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
23823
|
+
* @param {String} searchId Search Result ID
|
|
23824
|
+
* @param {Object} body
|
|
23825
|
+
*/
|
|
23826
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
23827
|
+
// verify the required parameter 'sessionId' is set
|
|
23828
|
+
if (sessionId === undefined || sessionId === null) {
|
|
23829
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23830
|
+
}
|
|
23831
|
+
// verify the required parameter 'searchId' is set
|
|
23832
|
+
if (searchId === undefined || searchId === null) {
|
|
23833
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23834
|
+
}
|
|
23835
|
+
// verify the required parameter 'body' is set
|
|
23836
|
+
if (body === undefined || body === null) {
|
|
23837
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23838
|
+
}
|
|
23839
|
+
|
|
23840
|
+
return this.apiClient.callApi(
|
|
23841
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
23842
|
+
'PATCH',
|
|
23843
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
23844
|
+
{ },
|
|
23845
|
+
{ },
|
|
23846
|
+
{ },
|
|
23847
|
+
body,
|
|
23848
|
+
['PureCloud OAuth'],
|
|
23849
|
+
['application/json'],
|
|
23850
|
+
['application/json']
|
|
23851
|
+
);
|
|
23852
|
+
}
|
|
23853
|
+
|
|
22731
23854
|
/**
|
|
22732
23855
|
* Update knowledge base
|
|
22733
23856
|
*
|
|
@@ -22758,6 +23881,220 @@ class KnowledgeApi {
|
|
|
22758
23881
|
);
|
|
22759
23882
|
}
|
|
22760
23883
|
|
|
23884
|
+
/**
|
|
23885
|
+
* Update category
|
|
23886
|
+
*
|
|
23887
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23888
|
+
* @param {String} categoryId Category ID
|
|
23889
|
+
* @param {Object} body
|
|
23890
|
+
*/
|
|
23891
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
23892
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23893
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23894
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23895
|
+
}
|
|
23896
|
+
// verify the required parameter 'categoryId' is set
|
|
23897
|
+
if (categoryId === undefined || categoryId === null) {
|
|
23898
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23899
|
+
}
|
|
23900
|
+
// verify the required parameter 'body' is set
|
|
23901
|
+
if (body === undefined || body === null) {
|
|
23902
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23903
|
+
}
|
|
23904
|
+
|
|
23905
|
+
return this.apiClient.callApi(
|
|
23906
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
23907
|
+
'PATCH',
|
|
23908
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
23909
|
+
{ },
|
|
23910
|
+
{ },
|
|
23911
|
+
{ },
|
|
23912
|
+
body,
|
|
23913
|
+
['PureCloud OAuth'],
|
|
23914
|
+
['application/json'],
|
|
23915
|
+
['application/json']
|
|
23916
|
+
);
|
|
23917
|
+
}
|
|
23918
|
+
|
|
23919
|
+
/**
|
|
23920
|
+
* Update document.
|
|
23921
|
+
*
|
|
23922
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23923
|
+
* @param {String} documentId Document ID.
|
|
23924
|
+
* @param {Object} body
|
|
23925
|
+
*/
|
|
23926
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
23927
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23928
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23929
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23930
|
+
}
|
|
23931
|
+
// verify the required parameter 'documentId' is set
|
|
23932
|
+
if (documentId === undefined || documentId === null) {
|
|
23933
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23934
|
+
}
|
|
23935
|
+
// verify the required parameter 'body' is set
|
|
23936
|
+
if (body === undefined || body === null) {
|
|
23937
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23938
|
+
}
|
|
23939
|
+
|
|
23940
|
+
return this.apiClient.callApi(
|
|
23941
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
23942
|
+
'PATCH',
|
|
23943
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23944
|
+
{ },
|
|
23945
|
+
{ },
|
|
23946
|
+
{ },
|
|
23947
|
+
body,
|
|
23948
|
+
['PureCloud OAuth'],
|
|
23949
|
+
['application/json'],
|
|
23950
|
+
['application/json']
|
|
23951
|
+
);
|
|
23952
|
+
}
|
|
23953
|
+
|
|
23954
|
+
/**
|
|
23955
|
+
* Update a variation for a document.
|
|
23956
|
+
*
|
|
23957
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
23958
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
23959
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
23960
|
+
* @param {Object} body
|
|
23961
|
+
*/
|
|
23962
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
23963
|
+
// verify the required parameter 'documentVariationId' is set
|
|
23964
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
23965
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23966
|
+
}
|
|
23967
|
+
// verify the required parameter 'documentId' is set
|
|
23968
|
+
if (documentId === undefined || documentId === null) {
|
|
23969
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23970
|
+
}
|
|
23971
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23972
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23973
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23974
|
+
}
|
|
23975
|
+
// verify the required parameter 'body' is set
|
|
23976
|
+
if (body === undefined || body === null) {
|
|
23977
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23978
|
+
}
|
|
23979
|
+
|
|
23980
|
+
return this.apiClient.callApi(
|
|
23981
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
23982
|
+
'PATCH',
|
|
23983
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
23984
|
+
{ },
|
|
23985
|
+
{ },
|
|
23986
|
+
{ },
|
|
23987
|
+
body,
|
|
23988
|
+
['PureCloud OAuth'],
|
|
23989
|
+
['application/json'],
|
|
23990
|
+
['application/json']
|
|
23991
|
+
);
|
|
23992
|
+
}
|
|
23993
|
+
|
|
23994
|
+
/**
|
|
23995
|
+
* Update search result.
|
|
23996
|
+
*
|
|
23997
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
23998
|
+
* @param {String} searchId Search Result ID
|
|
23999
|
+
* @param {Object} opts Optional parameters
|
|
24000
|
+
* @param {Object} opts.body
|
|
24001
|
+
*/
|
|
24002
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
24003
|
+
opts = opts || {};
|
|
24004
|
+
|
|
24005
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24006
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24007
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
24008
|
+
}
|
|
24009
|
+
// verify the required parameter 'searchId' is set
|
|
24010
|
+
if (searchId === undefined || searchId === null) {
|
|
24011
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
24012
|
+
}
|
|
24013
|
+
|
|
24014
|
+
return this.apiClient.callApi(
|
|
24015
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
24016
|
+
'PATCH',
|
|
24017
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
24018
|
+
{ },
|
|
24019
|
+
{ },
|
|
24020
|
+
{ },
|
|
24021
|
+
opts['body'],
|
|
24022
|
+
['PureCloud OAuth'],
|
|
24023
|
+
['application/json'],
|
|
24024
|
+
['application/json']
|
|
24025
|
+
);
|
|
24026
|
+
}
|
|
24027
|
+
|
|
24028
|
+
/**
|
|
24029
|
+
* Start import job
|
|
24030
|
+
*
|
|
24031
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24032
|
+
* @param {String} importJobId Import job ID
|
|
24033
|
+
* @param {Object} body
|
|
24034
|
+
*/
|
|
24035
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
24036
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24037
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24038
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24039
|
+
}
|
|
24040
|
+
// verify the required parameter 'importJobId' is set
|
|
24041
|
+
if (importJobId === undefined || importJobId === null) {
|
|
24042
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24043
|
+
}
|
|
24044
|
+
// verify the required parameter 'body' is set
|
|
24045
|
+
if (body === undefined || body === null) {
|
|
24046
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24047
|
+
}
|
|
24048
|
+
|
|
24049
|
+
return this.apiClient.callApi(
|
|
24050
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
24051
|
+
'PATCH',
|
|
24052
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
24053
|
+
{ },
|
|
24054
|
+
{ },
|
|
24055
|
+
{ },
|
|
24056
|
+
body,
|
|
24057
|
+
['PureCloud OAuth'],
|
|
24058
|
+
['application/json'],
|
|
24059
|
+
['application/json']
|
|
24060
|
+
);
|
|
24061
|
+
}
|
|
24062
|
+
|
|
24063
|
+
/**
|
|
24064
|
+
* Update label
|
|
24065
|
+
*
|
|
24066
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24067
|
+
* @param {String} labelId Label ID
|
|
24068
|
+
* @param {Object} body
|
|
24069
|
+
*/
|
|
24070
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
24071
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24072
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24073
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24074
|
+
}
|
|
24075
|
+
// verify the required parameter 'labelId' is set
|
|
24076
|
+
if (labelId === undefined || labelId === null) {
|
|
24077
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24078
|
+
}
|
|
24079
|
+
// verify the required parameter 'body' is set
|
|
24080
|
+
if (body === undefined || body === null) {
|
|
24081
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24082
|
+
}
|
|
24083
|
+
|
|
24084
|
+
return this.apiClient.callApi(
|
|
24085
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
24086
|
+
'PATCH',
|
|
24087
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
24088
|
+
{ },
|
|
24089
|
+
{ },
|
|
24090
|
+
{ },
|
|
24091
|
+
body,
|
|
24092
|
+
['PureCloud OAuth'],
|
|
24093
|
+
['application/json'],
|
|
24094
|
+
['application/json']
|
|
24095
|
+
);
|
|
24096
|
+
}
|
|
24097
|
+
|
|
22761
24098
|
/**
|
|
22762
24099
|
* Update category
|
|
22763
24100
|
*
|
|
@@ -22913,6 +24250,46 @@ class KnowledgeApi {
|
|
|
22913
24250
|
);
|
|
22914
24251
|
}
|
|
22915
24252
|
|
|
24253
|
+
/**
|
|
24254
|
+
* Update a Knowledge base unanswered phrase group
|
|
24255
|
+
*
|
|
24256
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24257
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
24258
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
24259
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
24260
|
+
*/
|
|
24261
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
24262
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24263
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24264
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24265
|
+
}
|
|
24266
|
+
// verify the required parameter 'groupId' is set
|
|
24267
|
+
if (groupId === undefined || groupId === null) {
|
|
24268
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24269
|
+
}
|
|
24270
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
24271
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
24272
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24273
|
+
}
|
|
24274
|
+
// verify the required parameter 'body' is set
|
|
24275
|
+
if (body === undefined || body === null) {
|
|
24276
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24277
|
+
}
|
|
24278
|
+
|
|
24279
|
+
return this.apiClient.callApi(
|
|
24280
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
24281
|
+
'PATCH',
|
|
24282
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
24283
|
+
{ },
|
|
24284
|
+
{ },
|
|
24285
|
+
{ },
|
|
24286
|
+
body,
|
|
24287
|
+
['PureCloud OAuth'],
|
|
24288
|
+
['application/json'],
|
|
24289
|
+
['application/json']
|
|
24290
|
+
);
|
|
24291
|
+
}
|
|
24292
|
+
|
|
22916
24293
|
/**
|
|
22917
24294
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
22918
24295
|
*
|
|
@@ -22938,6 +24315,369 @@ class KnowledgeApi {
|
|
|
22938
24315
|
);
|
|
22939
24316
|
}
|
|
22940
24317
|
|
|
24318
|
+
/**
|
|
24319
|
+
* Search the documents in a guest session.
|
|
24320
|
+
*
|
|
24321
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24322
|
+
* @param {Object} opts Optional parameters
|
|
24323
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
24324
|
+
* @param {Object} opts.body
|
|
24325
|
+
*/
|
|
24326
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
24327
|
+
opts = opts || {};
|
|
24328
|
+
|
|
24329
|
+
// verify the required parameter 'sessionId' is set
|
|
24330
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24331
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
24332
|
+
}
|
|
24333
|
+
|
|
24334
|
+
return this.apiClient.callApi(
|
|
24335
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
24336
|
+
'POST',
|
|
24337
|
+
{ 'sessionId': sessionId },
|
|
24338
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24339
|
+
{ },
|
|
24340
|
+
{ },
|
|
24341
|
+
opts['body'],
|
|
24342
|
+
['PureCloud OAuth'],
|
|
24343
|
+
['application/json'],
|
|
24344
|
+
['application/json']
|
|
24345
|
+
);
|
|
24346
|
+
}
|
|
24347
|
+
|
|
24348
|
+
/**
|
|
24349
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
24350
|
+
*
|
|
24351
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24352
|
+
* @param {Object} opts Optional parameters
|
|
24353
|
+
* @param {Object} opts.body
|
|
24354
|
+
*/
|
|
24355
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
24356
|
+
opts = opts || {};
|
|
24357
|
+
|
|
24358
|
+
// verify the required parameter 'sessionId' is set
|
|
24359
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24360
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
24361
|
+
}
|
|
24362
|
+
|
|
24363
|
+
return this.apiClient.callApi(
|
|
24364
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
24365
|
+
'POST',
|
|
24366
|
+
{ 'sessionId': sessionId },
|
|
24367
|
+
{ },
|
|
24368
|
+
{ },
|
|
24369
|
+
{ },
|
|
24370
|
+
opts['body'],
|
|
24371
|
+
['PureCloud OAuth'],
|
|
24372
|
+
['application/json'],
|
|
24373
|
+
['application/json']
|
|
24374
|
+
);
|
|
24375
|
+
}
|
|
24376
|
+
|
|
24377
|
+
/**
|
|
24378
|
+
* Create guest session
|
|
24379
|
+
*
|
|
24380
|
+
* @param {Object} body
|
|
24381
|
+
*/
|
|
24382
|
+
postKnowledgeGuestSessions(body) {
|
|
24383
|
+
// verify the required parameter 'body' is set
|
|
24384
|
+
if (body === undefined || body === null) {
|
|
24385
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
24386
|
+
}
|
|
24387
|
+
|
|
24388
|
+
return this.apiClient.callApi(
|
|
24389
|
+
'/api/v2/knowledge/guest/sessions',
|
|
24390
|
+
'POST',
|
|
24391
|
+
{ },
|
|
24392
|
+
{ },
|
|
24393
|
+
{ },
|
|
24394
|
+
{ },
|
|
24395
|
+
body,
|
|
24396
|
+
['PureCloud OAuth'],
|
|
24397
|
+
['application/json'],
|
|
24398
|
+
['application/json']
|
|
24399
|
+
);
|
|
24400
|
+
}
|
|
24401
|
+
|
|
24402
|
+
/**
|
|
24403
|
+
* Create new category
|
|
24404
|
+
*
|
|
24405
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24406
|
+
* @param {Object} body
|
|
24407
|
+
*/
|
|
24408
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
24409
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24410
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24411
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
24412
|
+
}
|
|
24413
|
+
// verify the required parameter 'body' is set
|
|
24414
|
+
if (body === undefined || body === null) {
|
|
24415
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
24416
|
+
}
|
|
24417
|
+
|
|
24418
|
+
return this.apiClient.callApi(
|
|
24419
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
24420
|
+
'POST',
|
|
24421
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24422
|
+
{ },
|
|
24423
|
+
{ },
|
|
24424
|
+
{ },
|
|
24425
|
+
body,
|
|
24426
|
+
['PureCloud OAuth'],
|
|
24427
|
+
['application/json'],
|
|
24428
|
+
['application/json']
|
|
24429
|
+
);
|
|
24430
|
+
}
|
|
24431
|
+
|
|
24432
|
+
/**
|
|
24433
|
+
* Create a variation for a document.
|
|
24434
|
+
*
|
|
24435
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24436
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24437
|
+
* @param {Object} body
|
|
24438
|
+
*/
|
|
24439
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
24440
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24441
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24442
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24443
|
+
}
|
|
24444
|
+
// verify the required parameter 'documentId' is set
|
|
24445
|
+
if (documentId === undefined || documentId === null) {
|
|
24446
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24447
|
+
}
|
|
24448
|
+
// verify the required parameter 'body' is set
|
|
24449
|
+
if (body === undefined || body === null) {
|
|
24450
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24451
|
+
}
|
|
24452
|
+
|
|
24453
|
+
return this.apiClient.callApi(
|
|
24454
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
24455
|
+
'POST',
|
|
24456
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24457
|
+
{ },
|
|
24458
|
+
{ },
|
|
24459
|
+
{ },
|
|
24460
|
+
body,
|
|
24461
|
+
['PureCloud OAuth'],
|
|
24462
|
+
['application/json'],
|
|
24463
|
+
['application/json']
|
|
24464
|
+
);
|
|
24465
|
+
}
|
|
24466
|
+
|
|
24467
|
+
/**
|
|
24468
|
+
* Creates or restores a document version.
|
|
24469
|
+
*
|
|
24470
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24471
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24472
|
+
* @param {Object} body
|
|
24473
|
+
*/
|
|
24474
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
24475
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24476
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24477
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24478
|
+
}
|
|
24479
|
+
// verify the required parameter 'documentId' is set
|
|
24480
|
+
if (documentId === undefined || documentId === null) {
|
|
24481
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24482
|
+
}
|
|
24483
|
+
// verify the required parameter 'body' is set
|
|
24484
|
+
if (body === undefined || body === null) {
|
|
24485
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24486
|
+
}
|
|
24487
|
+
|
|
24488
|
+
return this.apiClient.callApi(
|
|
24489
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
24490
|
+
'POST',
|
|
24491
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24492
|
+
{ },
|
|
24493
|
+
{ },
|
|
24494
|
+
{ },
|
|
24495
|
+
body,
|
|
24496
|
+
['PureCloud OAuth'],
|
|
24497
|
+
['application/json'],
|
|
24498
|
+
['application/json']
|
|
24499
|
+
);
|
|
24500
|
+
}
|
|
24501
|
+
|
|
24502
|
+
/**
|
|
24503
|
+
* Create document.
|
|
24504
|
+
*
|
|
24505
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24506
|
+
* @param {Object} body
|
|
24507
|
+
*/
|
|
24508
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
24509
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24510
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24511
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
24512
|
+
}
|
|
24513
|
+
// verify the required parameter 'body' is set
|
|
24514
|
+
if (body === undefined || body === null) {
|
|
24515
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
24516
|
+
}
|
|
24517
|
+
|
|
24518
|
+
return this.apiClient.callApi(
|
|
24519
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
24520
|
+
'POST',
|
|
24521
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24522
|
+
{ },
|
|
24523
|
+
{ },
|
|
24524
|
+
{ },
|
|
24525
|
+
body,
|
|
24526
|
+
['PureCloud OAuth'],
|
|
24527
|
+
['application/json'],
|
|
24528
|
+
['application/json']
|
|
24529
|
+
);
|
|
24530
|
+
}
|
|
24531
|
+
|
|
24532
|
+
/**
|
|
24533
|
+
* Search the documents in a knowledge base.
|
|
24534
|
+
*
|
|
24535
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
24536
|
+
* @param {Object} opts Optional parameters
|
|
24537
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
24538
|
+
* @param {Object} opts.body
|
|
24539
|
+
*/
|
|
24540
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
24541
|
+
opts = opts || {};
|
|
24542
|
+
|
|
24543
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24544
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24545
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
24546
|
+
}
|
|
24547
|
+
|
|
24548
|
+
return this.apiClient.callApi(
|
|
24549
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
24550
|
+
'POST',
|
|
24551
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24552
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24553
|
+
{ },
|
|
24554
|
+
{ },
|
|
24555
|
+
opts['body'],
|
|
24556
|
+
['PureCloud OAuth'],
|
|
24557
|
+
['application/json'],
|
|
24558
|
+
['application/json']
|
|
24559
|
+
);
|
|
24560
|
+
}
|
|
24561
|
+
|
|
24562
|
+
/**
|
|
24563
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
24564
|
+
*
|
|
24565
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
24566
|
+
* @param {Object} opts Optional parameters
|
|
24567
|
+
* @param {Object} opts.body
|
|
24568
|
+
*/
|
|
24569
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
24570
|
+
opts = opts || {};
|
|
24571
|
+
|
|
24572
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24573
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24574
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
24575
|
+
}
|
|
24576
|
+
|
|
24577
|
+
return this.apiClient.callApi(
|
|
24578
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
24579
|
+
'POST',
|
|
24580
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24581
|
+
{ },
|
|
24582
|
+
{ },
|
|
24583
|
+
{ },
|
|
24584
|
+
opts['body'],
|
|
24585
|
+
['PureCloud OAuth'],
|
|
24586
|
+
['application/json'],
|
|
24587
|
+
['application/json']
|
|
24588
|
+
);
|
|
24589
|
+
}
|
|
24590
|
+
|
|
24591
|
+
/**
|
|
24592
|
+
* Create export job
|
|
24593
|
+
*
|
|
24594
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24595
|
+
* @param {Object} body
|
|
24596
|
+
*/
|
|
24597
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
24598
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24599
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24600
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
24601
|
+
}
|
|
24602
|
+
// verify the required parameter 'body' is set
|
|
24603
|
+
if (body === undefined || body === null) {
|
|
24604
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
24605
|
+
}
|
|
24606
|
+
|
|
24607
|
+
return this.apiClient.callApi(
|
|
24608
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
24609
|
+
'POST',
|
|
24610
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24611
|
+
{ },
|
|
24612
|
+
{ },
|
|
24613
|
+
{ },
|
|
24614
|
+
body,
|
|
24615
|
+
['PureCloud OAuth'],
|
|
24616
|
+
['application/json'],
|
|
24617
|
+
['application/json']
|
|
24618
|
+
);
|
|
24619
|
+
}
|
|
24620
|
+
|
|
24621
|
+
/**
|
|
24622
|
+
* Create import job
|
|
24623
|
+
*
|
|
24624
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24625
|
+
* @param {Object} body
|
|
24626
|
+
*/
|
|
24627
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
24628
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24629
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24630
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
24631
|
+
}
|
|
24632
|
+
// verify the required parameter 'body' is set
|
|
24633
|
+
if (body === undefined || body === null) {
|
|
24634
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
24635
|
+
}
|
|
24636
|
+
|
|
24637
|
+
return this.apiClient.callApi(
|
|
24638
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
24639
|
+
'POST',
|
|
24640
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24641
|
+
{ },
|
|
24642
|
+
{ },
|
|
24643
|
+
{ },
|
|
24644
|
+
body,
|
|
24645
|
+
['PureCloud OAuth'],
|
|
24646
|
+
['application/json'],
|
|
24647
|
+
['application/json']
|
|
24648
|
+
);
|
|
24649
|
+
}
|
|
24650
|
+
|
|
24651
|
+
/**
|
|
24652
|
+
* Create new label
|
|
24653
|
+
*
|
|
24654
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24655
|
+
* @param {Object} body
|
|
24656
|
+
*/
|
|
24657
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
24658
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24659
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24660
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
24661
|
+
}
|
|
24662
|
+
// verify the required parameter 'body' is set
|
|
24663
|
+
if (body === undefined || body === null) {
|
|
24664
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
24665
|
+
}
|
|
24666
|
+
|
|
24667
|
+
return this.apiClient.callApi(
|
|
24668
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
24669
|
+
'POST',
|
|
24670
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24671
|
+
{ },
|
|
24672
|
+
{ },
|
|
24673
|
+
{ },
|
|
24674
|
+
body,
|
|
24675
|
+
['PureCloud OAuth'],
|
|
24676
|
+
['application/json'],
|
|
24677
|
+
['application/json']
|
|
24678
|
+
);
|
|
24679
|
+
}
|
|
24680
|
+
|
|
22941
24681
|
/**
|
|
22942
24682
|
* Create new category
|
|
22943
24683
|
*
|
|
@@ -23168,7 +24908,7 @@ class LanguageUnderstandingApi {
|
|
|
23168
24908
|
/**
|
|
23169
24909
|
* LanguageUnderstanding service.
|
|
23170
24910
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
23171
|
-
* @version
|
|
24911
|
+
* @version 146.0.0
|
|
23172
24912
|
*/
|
|
23173
24913
|
|
|
23174
24914
|
/**
|
|
@@ -24072,7 +25812,7 @@ class LanguagesApi {
|
|
|
24072
25812
|
/**
|
|
24073
25813
|
* Languages service.
|
|
24074
25814
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24075
|
-
* @version
|
|
25815
|
+
* @version 146.0.0
|
|
24076
25816
|
*/
|
|
24077
25817
|
|
|
24078
25818
|
/**
|
|
@@ -24340,7 +26080,7 @@ class LearningApi {
|
|
|
24340
26080
|
/**
|
|
24341
26081
|
* Learning service.
|
|
24342
26082
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
24343
|
-
* @version
|
|
26083
|
+
* @version 146.0.0
|
|
24344
26084
|
*/
|
|
24345
26085
|
|
|
24346
26086
|
/**
|
|
@@ -24693,6 +26433,31 @@ class LearningApi {
|
|
|
24693
26433
|
);
|
|
24694
26434
|
}
|
|
24695
26435
|
|
|
26436
|
+
/**
|
|
26437
|
+
* Get a specific Learning Module cover art using ID
|
|
26438
|
+
*
|
|
26439
|
+
* @param {String} coverArtId Key identifier for the cover art
|
|
26440
|
+
*/
|
|
26441
|
+
getLearningModulesCoverartCoverArtId(coverArtId) {
|
|
26442
|
+
// verify the required parameter 'coverArtId' is set
|
|
26443
|
+
if (coverArtId === undefined || coverArtId === null) {
|
|
26444
|
+
throw 'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';
|
|
26445
|
+
}
|
|
26446
|
+
|
|
26447
|
+
return this.apiClient.callApi(
|
|
26448
|
+
'/api/v2/learning/modules/coverart/{coverArtId}',
|
|
26449
|
+
'GET',
|
|
26450
|
+
{ 'coverArtId': coverArtId },
|
|
26451
|
+
{ },
|
|
26452
|
+
{ },
|
|
26453
|
+
{ },
|
|
26454
|
+
null,
|
|
26455
|
+
['PureCloud OAuth'],
|
|
26456
|
+
['application/json'],
|
|
26457
|
+
['application/json']
|
|
26458
|
+
);
|
|
26459
|
+
}
|
|
26460
|
+
|
|
24696
26461
|
/**
|
|
24697
26462
|
* Update Learning Assignment
|
|
24698
26463
|
*
|
|
@@ -25075,7 +26840,7 @@ class LicenseApi {
|
|
|
25075
26840
|
/**
|
|
25076
26841
|
* License service.
|
|
25077
26842
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
25078
|
-
* @version
|
|
26843
|
+
* @version 146.0.0
|
|
25079
26844
|
*/
|
|
25080
26845
|
|
|
25081
26846
|
/**
|
|
@@ -25313,7 +27078,7 @@ class LocationsApi {
|
|
|
25313
27078
|
/**
|
|
25314
27079
|
* Locations service.
|
|
25315
27080
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25316
|
-
* @version
|
|
27081
|
+
* @version 146.0.0
|
|
25317
27082
|
*/
|
|
25318
27083
|
|
|
25319
27084
|
/**
|
|
@@ -25549,7 +27314,7 @@ class MessagingApi {
|
|
|
25549
27314
|
/**
|
|
25550
27315
|
* Messaging service.
|
|
25551
27316
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
25552
|
-
* @version
|
|
27317
|
+
* @version 146.0.0
|
|
25553
27318
|
*/
|
|
25554
27319
|
|
|
25555
27320
|
/**
|
|
@@ -25700,7 +27465,7 @@ class MobileDevicesApi {
|
|
|
25700
27465
|
/**
|
|
25701
27466
|
* MobileDevices service.
|
|
25702
27467
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25703
|
-
* @version
|
|
27468
|
+
* @version 146.0.0
|
|
25704
27469
|
*/
|
|
25705
27470
|
|
|
25706
27471
|
/**
|
|
@@ -25851,7 +27616,7 @@ class NotificationsApi {
|
|
|
25851
27616
|
/**
|
|
25852
27617
|
* Notifications service.
|
|
25853
27618
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25854
|
-
* @version
|
|
27619
|
+
* @version 146.0.0
|
|
25855
27620
|
*/
|
|
25856
27621
|
|
|
25857
27622
|
/**
|
|
@@ -26076,7 +27841,7 @@ class OAuthApi {
|
|
|
26076
27841
|
/**
|
|
26077
27842
|
* OAuth service.
|
|
26078
27843
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
26079
|
-
* @version
|
|
27844
|
+
* @version 146.0.0
|
|
26080
27845
|
*/
|
|
26081
27846
|
|
|
26082
27847
|
/**
|
|
@@ -26442,7 +28207,7 @@ class ObjectsApi {
|
|
|
26442
28207
|
/**
|
|
26443
28208
|
* Objects service.
|
|
26444
28209
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26445
|
-
* @version
|
|
28210
|
+
* @version 146.0.0
|
|
26446
28211
|
*/
|
|
26447
28212
|
|
|
26448
28213
|
/**
|
|
@@ -26713,7 +28478,7 @@ class OrganizationApi {
|
|
|
26713
28478
|
/**
|
|
26714
28479
|
* Organization service.
|
|
26715
28480
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26716
|
-
* @version
|
|
28481
|
+
* @version 146.0.0
|
|
26717
28482
|
*/
|
|
26718
28483
|
|
|
26719
28484
|
/**
|
|
@@ -27116,7 +28881,7 @@ class OrganizationAuthorizationApi {
|
|
|
27116
28881
|
/**
|
|
27117
28882
|
* OrganizationAuthorization service.
|
|
27118
28883
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
27119
|
-
* @version
|
|
28884
|
+
* @version 146.0.0
|
|
27120
28885
|
*/
|
|
27121
28886
|
|
|
27122
28887
|
/**
|
|
@@ -28041,7 +29806,7 @@ class OutboundApi {
|
|
|
28041
29806
|
/**
|
|
28042
29807
|
* Outbound service.
|
|
28043
29808
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
28044
|
-
* @version
|
|
29809
|
+
* @version 146.0.0
|
|
28045
29810
|
*/
|
|
28046
29811
|
|
|
28047
29812
|
/**
|
|
@@ -31296,7 +33061,7 @@ class PresenceApi {
|
|
|
31296
33061
|
/**
|
|
31297
33062
|
* Presence service.
|
|
31298
33063
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
31299
|
-
* @version
|
|
33064
|
+
* @version 146.0.0
|
|
31300
33065
|
*/
|
|
31301
33066
|
|
|
31302
33067
|
/**
|
|
@@ -31618,7 +33383,7 @@ class QualityApi {
|
|
|
31618
33383
|
/**
|
|
31619
33384
|
* Quality service.
|
|
31620
33385
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31621
|
-
* @version
|
|
33386
|
+
* @version 146.0.0
|
|
31622
33387
|
*/
|
|
31623
33388
|
|
|
31624
33389
|
/**
|
|
@@ -33196,7 +34961,7 @@ class RecordingApi {
|
|
|
33196
34961
|
/**
|
|
33197
34962
|
* Recording service.
|
|
33198
34963
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
33199
|
-
* @version
|
|
34964
|
+
* @version 146.0.0
|
|
33200
34965
|
*/
|
|
33201
34966
|
|
|
33202
34967
|
/**
|
|
@@ -34849,7 +36614,7 @@ class ResponseManagementApi {
|
|
|
34849
36614
|
/**
|
|
34850
36615
|
* ResponseManagement service.
|
|
34851
36616
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34852
|
-
* @version
|
|
36617
|
+
* @version 146.0.0
|
|
34853
36618
|
*/
|
|
34854
36619
|
|
|
34855
36620
|
/**
|
|
@@ -35333,7 +37098,7 @@ class RoutingApi {
|
|
|
35333
37098
|
/**
|
|
35334
37099
|
* Routing service.
|
|
35335
37100
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
35336
|
-
* @version
|
|
37101
|
+
* @version 146.0.0
|
|
35337
37102
|
*/
|
|
35338
37103
|
|
|
35339
37104
|
/**
|
|
@@ -35899,6 +37664,26 @@ class RoutingApi {
|
|
|
35899
37664
|
);
|
|
35900
37665
|
}
|
|
35901
37666
|
|
|
37667
|
+
/**
|
|
37668
|
+
* Get available media types
|
|
37669
|
+
*
|
|
37670
|
+
*/
|
|
37671
|
+
getRoutingAvailablemediatypes() {
|
|
37672
|
+
|
|
37673
|
+
return this.apiClient.callApi(
|
|
37674
|
+
'/api/v2/routing/availablemediatypes',
|
|
37675
|
+
'GET',
|
|
37676
|
+
{ },
|
|
37677
|
+
{ },
|
|
37678
|
+
{ },
|
|
37679
|
+
{ },
|
|
37680
|
+
null,
|
|
37681
|
+
['PureCloud OAuth'],
|
|
37682
|
+
['application/json'],
|
|
37683
|
+
['application/json']
|
|
37684
|
+
);
|
|
37685
|
+
}
|
|
37686
|
+
|
|
35902
37687
|
/**
|
|
35903
37688
|
* Get domain
|
|
35904
37689
|
*
|
|
@@ -38254,7 +40039,7 @@ class SCIMApi {
|
|
|
38254
40039
|
/**
|
|
38255
40040
|
* SCIM service.
|
|
38256
40041
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
38257
|
-
* @version
|
|
40042
|
+
* @version 146.0.0
|
|
38258
40043
|
*/
|
|
38259
40044
|
|
|
38260
40045
|
/**
|
|
@@ -39131,7 +40916,7 @@ class ScriptsApi {
|
|
|
39131
40916
|
/**
|
|
39132
40917
|
* Scripts service.
|
|
39133
40918
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
39134
|
-
* @version
|
|
40919
|
+
* @version 146.0.0
|
|
39135
40920
|
*/
|
|
39136
40921
|
|
|
39137
40922
|
/**
|
|
@@ -39550,7 +41335,7 @@ class SearchApi {
|
|
|
39550
41335
|
/**
|
|
39551
41336
|
* Search service.
|
|
39552
41337
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39553
|
-
* @version
|
|
41338
|
+
* @version 146.0.0
|
|
39554
41339
|
*/
|
|
39555
41340
|
|
|
39556
41341
|
/**
|
|
@@ -40110,7 +41895,7 @@ class SpeechTextAnalyticsApi {
|
|
|
40110
41895
|
/**
|
|
40111
41896
|
* SpeechTextAnalytics service.
|
|
40112
41897
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
40113
|
-
* @version
|
|
41898
|
+
* @version 146.0.0
|
|
40114
41899
|
*/
|
|
40115
41900
|
|
|
40116
41901
|
/**
|
|
@@ -40964,7 +42749,7 @@ class StationsApi {
|
|
|
40964
42749
|
/**
|
|
40965
42750
|
* Stations service.
|
|
40966
42751
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40967
|
-
* @version
|
|
42752
|
+
* @version 146.0.0
|
|
40968
42753
|
*/
|
|
40969
42754
|
|
|
40970
42755
|
/**
|
|
@@ -41111,7 +42896,7 @@ class SuggestApi {
|
|
|
41111
42896
|
/**
|
|
41112
42897
|
* Suggest service.
|
|
41113
42898
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
41114
|
-
* @version
|
|
42899
|
+
* @version 146.0.0
|
|
41115
42900
|
*/
|
|
41116
42901
|
|
|
41117
42902
|
/**
|
|
@@ -41250,7 +43035,7 @@ class TeamsApi {
|
|
|
41250
43035
|
/**
|
|
41251
43036
|
* Teams service.
|
|
41252
43037
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
41253
|
-
* @version
|
|
43038
|
+
* @version 146.0.0
|
|
41254
43039
|
*/
|
|
41255
43040
|
|
|
41256
43041
|
/**
|
|
@@ -41429,7 +43214,7 @@ class TelephonyApi {
|
|
|
41429
43214
|
/**
|
|
41430
43215
|
* Telephony service.
|
|
41431
43216
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
41432
|
-
* @version
|
|
43217
|
+
* @version 146.0.0
|
|
41433
43218
|
*/
|
|
41434
43219
|
|
|
41435
43220
|
/**
|
|
@@ -41537,7 +43322,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
41537
43322
|
/**
|
|
41538
43323
|
* TelephonyProvidersEdge service.
|
|
41539
43324
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
41540
|
-
* @version
|
|
43325
|
+
* @version 146.0.0
|
|
41541
43326
|
*/
|
|
41542
43327
|
|
|
41543
43328
|
/**
|
|
@@ -45170,7 +46955,7 @@ class TextbotsApi {
|
|
|
45170
46955
|
/**
|
|
45171
46956
|
* Textbots service.
|
|
45172
46957
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
45173
|
-
* @version
|
|
46958
|
+
* @version 146.0.0
|
|
45174
46959
|
*/
|
|
45175
46960
|
|
|
45176
46961
|
/**
|
|
@@ -45298,7 +47083,7 @@ class TokensApi {
|
|
|
45298
47083
|
/**
|
|
45299
47084
|
* Tokens service.
|
|
45300
47085
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
45301
|
-
* @version
|
|
47086
|
+
* @version 146.0.0
|
|
45302
47087
|
*/
|
|
45303
47088
|
|
|
45304
47089
|
/**
|
|
@@ -45404,7 +47189,7 @@ class UploadsApi {
|
|
|
45404
47189
|
/**
|
|
45405
47190
|
* Uploads service.
|
|
45406
47191
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
45407
|
-
* @version
|
|
47192
|
+
* @version 146.0.0
|
|
45408
47193
|
*/
|
|
45409
47194
|
|
|
45410
47195
|
/**
|
|
@@ -45474,6 +47259,31 @@ class UploadsApi {
|
|
|
45474
47259
|
);
|
|
45475
47260
|
}
|
|
45476
47261
|
|
|
47262
|
+
/**
|
|
47263
|
+
* Generates pre-signed URL to upload cover art for learning modules
|
|
47264
|
+
*
|
|
47265
|
+
* @param {Object} body query
|
|
47266
|
+
*/
|
|
47267
|
+
postUploadsLearningCoverart(body) {
|
|
47268
|
+
// verify the required parameter 'body' is set
|
|
47269
|
+
if (body === undefined || body === null) {
|
|
47270
|
+
throw 'Missing the required parameter "body" when calling postUploadsLearningCoverart';
|
|
47271
|
+
}
|
|
47272
|
+
|
|
47273
|
+
return this.apiClient.callApi(
|
|
47274
|
+
'/api/v2/uploads/learning/coverart',
|
|
47275
|
+
'POST',
|
|
47276
|
+
{ },
|
|
47277
|
+
{ },
|
|
47278
|
+
{ },
|
|
47279
|
+
{ },
|
|
47280
|
+
body,
|
|
47281
|
+
['PureCloud OAuth'],
|
|
47282
|
+
['application/json'],
|
|
47283
|
+
['application/json']
|
|
47284
|
+
);
|
|
47285
|
+
}
|
|
47286
|
+
|
|
45477
47287
|
/**
|
|
45478
47288
|
* Creates presigned url for uploading a public asset image
|
|
45479
47289
|
*
|
|
@@ -45555,7 +47365,7 @@ class UsageApi {
|
|
|
45555
47365
|
/**
|
|
45556
47366
|
* Usage service.
|
|
45557
47367
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
45558
|
-
* @version
|
|
47368
|
+
* @version 146.0.0
|
|
45559
47369
|
*/
|
|
45560
47370
|
|
|
45561
47371
|
/**
|
|
@@ -45626,7 +47436,7 @@ class UserRecordingsApi {
|
|
|
45626
47436
|
/**
|
|
45627
47437
|
* UserRecordings service.
|
|
45628
47438
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
45629
|
-
* @version
|
|
47439
|
+
* @version 146.0.0
|
|
45630
47440
|
*/
|
|
45631
47441
|
|
|
45632
47442
|
/**
|
|
@@ -45810,7 +47620,7 @@ class UsersApi {
|
|
|
45810
47620
|
/**
|
|
45811
47621
|
* Users service.
|
|
45812
47622
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45813
|
-
* @version
|
|
47623
|
+
* @version 146.0.0
|
|
45814
47624
|
*/
|
|
45815
47625
|
|
|
45816
47626
|
/**
|
|
@@ -47673,7 +49483,7 @@ class UsersApi {
|
|
|
47673
49483
|
|
|
47674
49484
|
/**
|
|
47675
49485
|
* Create user
|
|
47676
|
-
*
|
|
49486
|
+
* 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.
|
|
47677
49487
|
* @param {Object} body User
|
|
47678
49488
|
*/
|
|
47679
49489
|
postUsers(body) {
|
|
@@ -48112,7 +49922,7 @@ class UtilitiesApi {
|
|
|
48112
49922
|
/**
|
|
48113
49923
|
* Utilities service.
|
|
48114
49924
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
48115
|
-
* @version
|
|
49925
|
+
* @version 146.0.0
|
|
48116
49926
|
*/
|
|
48117
49927
|
|
|
48118
49928
|
/**
|
|
@@ -48223,7 +50033,7 @@ class VoicemailApi {
|
|
|
48223
50033
|
/**
|
|
48224
50034
|
* Voicemail service.
|
|
48225
50035
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
48226
|
-
* @version
|
|
50036
|
+
* @version 146.0.0
|
|
48227
50037
|
*/
|
|
48228
50038
|
|
|
48229
50039
|
/**
|
|
@@ -48890,7 +50700,7 @@ class WebChatApi {
|
|
|
48890
50700
|
/**
|
|
48891
50701
|
* WebChat service.
|
|
48892
50702
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48893
|
-
* @version
|
|
50703
|
+
* @version 146.0.0
|
|
48894
50704
|
*/
|
|
48895
50705
|
|
|
48896
50706
|
/**
|
|
@@ -49434,7 +51244,7 @@ class WebDeploymentsApi {
|
|
|
49434
51244
|
/**
|
|
49435
51245
|
* WebDeployments service.
|
|
49436
51246
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
49437
|
-
* @version
|
|
51247
|
+
* @version 146.0.0
|
|
49438
51248
|
*/
|
|
49439
51249
|
|
|
49440
51250
|
/**
|
|
@@ -49789,7 +51599,7 @@ class WebMessagingApi {
|
|
|
49789
51599
|
/**
|
|
49790
51600
|
* WebMessaging service.
|
|
49791
51601
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49792
|
-
* @version
|
|
51602
|
+
* @version 146.0.0
|
|
49793
51603
|
*/
|
|
49794
51604
|
|
|
49795
51605
|
/**
|
|
@@ -49835,7 +51645,7 @@ class WidgetsApi {
|
|
|
49835
51645
|
/**
|
|
49836
51646
|
* Widgets service.
|
|
49837
51647
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49838
|
-
* @version
|
|
51648
|
+
* @version 146.0.0
|
|
49839
51649
|
*/
|
|
49840
51650
|
|
|
49841
51651
|
/**
|
|
@@ -49981,7 +51791,7 @@ class WorkforceManagementApi {
|
|
|
49981
51791
|
/**
|
|
49982
51792
|
* WorkforceManagement service.
|
|
49983
51793
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49984
|
-
* @version
|
|
51794
|
+
* @version 146.0.0
|
|
49985
51795
|
*/
|
|
49986
51796
|
|
|
49987
51797
|
/**
|
|
@@ -54257,7 +56067,7 @@ class WorkforceManagementApi {
|
|
|
54257
56067
|
* </pre>
|
|
54258
56068
|
* </p>
|
|
54259
56069
|
* @module purecloud-platform-client-v2/index
|
|
54260
|
-
* @version
|
|
56070
|
+
* @version 146.0.0
|
|
54261
56071
|
*/
|
|
54262
56072
|
class platformClient {
|
|
54263
56073
|
constructor() {
|