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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -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
|
var global$1 = (typeof global !== "undefined" ? global :
|
|
@@ -2278,7 +2279,7 @@ class Configuration {
|
|
|
2278
2279
|
|
|
2279
2280
|
/**
|
|
2280
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2281
|
-
* @version
|
|
2282
|
+
* @version 146.0.0
|
|
2282
2283
|
*/
|
|
2283
2284
|
class ApiClient {
|
|
2284
2285
|
/**
|
|
@@ -3350,7 +3351,7 @@ class AlertingApi {
|
|
|
3350
3351
|
/**
|
|
3351
3352
|
* Alerting service.
|
|
3352
3353
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3353
|
-
* @version
|
|
3354
|
+
* @version 146.0.0
|
|
3354
3355
|
*/
|
|
3355
3356
|
|
|
3356
3357
|
/**
|
|
@@ -3664,7 +3665,7 @@ class AnalyticsApi {
|
|
|
3664
3665
|
/**
|
|
3665
3666
|
* Analytics service.
|
|
3666
3667
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3667
|
-
* @version
|
|
3668
|
+
* @version 146.0.0
|
|
3668
3669
|
*/
|
|
3669
3670
|
|
|
3670
3671
|
/**
|
|
@@ -4846,7 +4847,7 @@ class ArchitectApi {
|
|
|
4846
4847
|
/**
|
|
4847
4848
|
* Architect service.
|
|
4848
4849
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4849
|
-
* @version
|
|
4850
|
+
* @version 146.0.0
|
|
4850
4851
|
*/
|
|
4851
4852
|
|
|
4852
4853
|
/**
|
|
@@ -5604,6 +5605,7 @@ class ArchitectApi {
|
|
|
5604
5605
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
5605
5606
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5606
5607
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
5608
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
5607
5609
|
*/
|
|
5608
5610
|
getArchitectIvrs(opts) {
|
|
5609
5611
|
opts = opts || {};
|
|
@@ -5613,7 +5615,7 @@ class ArchitectApi {
|
|
|
5613
5615
|
'/api/v2/architect/ivrs',
|
|
5614
5616
|
'GET',
|
|
5615
5617
|
{ },
|
|
5616
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
5618
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
5617
5619
|
{ },
|
|
5618
5620
|
{ },
|
|
5619
5621
|
null,
|
|
@@ -7891,7 +7893,7 @@ class AuditApi {
|
|
|
7891
7893
|
/**
|
|
7892
7894
|
* Audit service.
|
|
7893
7895
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7894
|
-
* @version
|
|
7896
|
+
* @version 146.0.0
|
|
7895
7897
|
*/
|
|
7896
7898
|
|
|
7897
7899
|
/**
|
|
@@ -8062,7 +8064,7 @@ class AuthorizationApi {
|
|
|
8062
8064
|
/**
|
|
8063
8065
|
* Authorization service.
|
|
8064
8066
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8065
|
-
* @version
|
|
8067
|
+
* @version 146.0.0
|
|
8066
8068
|
*/
|
|
8067
8069
|
|
|
8068
8070
|
/**
|
|
@@ -9245,7 +9247,7 @@ class BillingApi {
|
|
|
9245
9247
|
/**
|
|
9246
9248
|
* Billing service.
|
|
9247
9249
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9248
|
-
* @version
|
|
9250
|
+
* @version 146.0.0
|
|
9249
9251
|
*/
|
|
9250
9252
|
|
|
9251
9253
|
/**
|
|
@@ -9325,7 +9327,7 @@ class ChatApi {
|
|
|
9325
9327
|
/**
|
|
9326
9328
|
* Chat service.
|
|
9327
9329
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9328
|
-
* @version
|
|
9330
|
+
* @version 146.0.0
|
|
9329
9331
|
*/
|
|
9330
9332
|
|
|
9331
9333
|
/**
|
|
@@ -9416,7 +9418,7 @@ class CoachingApi {
|
|
|
9416
9418
|
/**
|
|
9417
9419
|
* Coaching service.
|
|
9418
9420
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9419
|
-
* @version
|
|
9421
|
+
* @version 146.0.0
|
|
9420
9422
|
*/
|
|
9421
9423
|
|
|
9422
9424
|
/**
|
|
@@ -9993,7 +9995,7 @@ class ContentManagementApi {
|
|
|
9993
9995
|
/**
|
|
9994
9996
|
* ContentManagement service.
|
|
9995
9997
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9996
|
-
* @version
|
|
9998
|
+
* @version 146.0.0
|
|
9997
9999
|
*/
|
|
9998
10000
|
|
|
9999
10001
|
/**
|
|
@@ -11133,7 +11135,7 @@ class ConversationsApi {
|
|
|
11133
11135
|
/**
|
|
11134
11136
|
* Conversations service.
|
|
11135
11137
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11136
|
-
* @version
|
|
11138
|
+
* @version 146.0.0
|
|
11137
11139
|
*/
|
|
11138
11140
|
|
|
11139
11141
|
/**
|
|
@@ -11726,6 +11728,31 @@ class ConversationsApi {
|
|
|
11726
11728
|
);
|
|
11727
11729
|
}
|
|
11728
11730
|
|
|
11731
|
+
/**
|
|
11732
|
+
* Get the secure attributes on a conversation.
|
|
11733
|
+
*
|
|
11734
|
+
* @param {String} conversationId conversation ID
|
|
11735
|
+
*/
|
|
11736
|
+
getConversationSecureattributes(conversationId) {
|
|
11737
|
+
// verify the required parameter 'conversationId' is set
|
|
11738
|
+
if (conversationId === undefined || conversationId === null) {
|
|
11739
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
|
|
11740
|
+
}
|
|
11741
|
+
|
|
11742
|
+
return this.apiClient.callApi(
|
|
11743
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
11744
|
+
'GET',
|
|
11745
|
+
{ 'conversationId': conversationId },
|
|
11746
|
+
{ },
|
|
11747
|
+
{ },
|
|
11748
|
+
{ },
|
|
11749
|
+
null,
|
|
11750
|
+
['PureCloud OAuth'],
|
|
11751
|
+
['application/json'],
|
|
11752
|
+
['application/json']
|
|
11753
|
+
);
|
|
11754
|
+
}
|
|
11755
|
+
|
|
11729
11756
|
/**
|
|
11730
11757
|
* Get active conversations for the logged in user
|
|
11731
11758
|
*
|
|
@@ -12509,6 +12536,51 @@ class ConversationsApi {
|
|
|
12509
12536
|
);
|
|
12510
12537
|
}
|
|
12511
12538
|
|
|
12539
|
+
/**
|
|
12540
|
+
* Get the encryption key configurations
|
|
12541
|
+
*
|
|
12542
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
12543
|
+
*/
|
|
12544
|
+
getConversationsKeyconfiguration(keyconfigurationsId) {
|
|
12545
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
12546
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
12547
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
|
|
12548
|
+
}
|
|
12549
|
+
|
|
12550
|
+
return this.apiClient.callApi(
|
|
12551
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
12552
|
+
'GET',
|
|
12553
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
12554
|
+
{ },
|
|
12555
|
+
{ },
|
|
12556
|
+
{ },
|
|
12557
|
+
null,
|
|
12558
|
+
['PureCloud OAuth'],
|
|
12559
|
+
['application/json'],
|
|
12560
|
+
['application/json']
|
|
12561
|
+
);
|
|
12562
|
+
}
|
|
12563
|
+
|
|
12564
|
+
/**
|
|
12565
|
+
* Get a list of key configurations data
|
|
12566
|
+
*
|
|
12567
|
+
*/
|
|
12568
|
+
getConversationsKeyconfigurations() {
|
|
12569
|
+
|
|
12570
|
+
return this.apiClient.callApi(
|
|
12571
|
+
'/api/v2/conversations/keyconfigurations',
|
|
12572
|
+
'GET',
|
|
12573
|
+
{ },
|
|
12574
|
+
{ },
|
|
12575
|
+
{ },
|
|
12576
|
+
{ },
|
|
12577
|
+
null,
|
|
12578
|
+
['PureCloud OAuth'],
|
|
12579
|
+
['application/json'],
|
|
12580
|
+
['application/json']
|
|
12581
|
+
);
|
|
12582
|
+
}
|
|
12583
|
+
|
|
12512
12584
|
/**
|
|
12513
12585
|
* Get message conversation
|
|
12514
12586
|
*
|
|
@@ -13225,6 +13297,36 @@ class ConversationsApi {
|
|
|
13225
13297
|
);
|
|
13226
13298
|
}
|
|
13227
13299
|
|
|
13300
|
+
/**
|
|
13301
|
+
* Update the secure attributes on a conversation.
|
|
13302
|
+
*
|
|
13303
|
+
* @param {String} conversationId conversation ID
|
|
13304
|
+
* @param {Object} body Conversation Secure Attributes
|
|
13305
|
+
*/
|
|
13306
|
+
patchConversationSecureattributes(conversationId, body) {
|
|
13307
|
+
// verify the required parameter 'conversationId' is set
|
|
13308
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13309
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
|
|
13310
|
+
}
|
|
13311
|
+
// verify the required parameter 'body' is set
|
|
13312
|
+
if (body === undefined || body === null) {
|
|
13313
|
+
throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
|
|
13314
|
+
}
|
|
13315
|
+
|
|
13316
|
+
return this.apiClient.callApi(
|
|
13317
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
13318
|
+
'PATCH',
|
|
13319
|
+
{ 'conversationId': conversationId },
|
|
13320
|
+
{ },
|
|
13321
|
+
{ },
|
|
13322
|
+
{ },
|
|
13323
|
+
body,
|
|
13324
|
+
['PureCloud OAuth'],
|
|
13325
|
+
['application/json'],
|
|
13326
|
+
['application/json']
|
|
13327
|
+
);
|
|
13328
|
+
}
|
|
13329
|
+
|
|
13228
13330
|
/**
|
|
13229
13331
|
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
13230
13332
|
*
|
|
@@ -15227,6 +15329,56 @@ class ConversationsApi {
|
|
|
15227
15329
|
);
|
|
15228
15330
|
}
|
|
15229
15331
|
|
|
15332
|
+
/**
|
|
15333
|
+
* Setup configurations for encryption key creation
|
|
15334
|
+
*
|
|
15335
|
+
* @param {Object} body Encryption Configuration
|
|
15336
|
+
*/
|
|
15337
|
+
postConversationsKeyconfigurations(body) {
|
|
15338
|
+
// verify the required parameter 'body' is set
|
|
15339
|
+
if (body === undefined || body === null) {
|
|
15340
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
|
|
15341
|
+
}
|
|
15342
|
+
|
|
15343
|
+
return this.apiClient.callApi(
|
|
15344
|
+
'/api/v2/conversations/keyconfigurations',
|
|
15345
|
+
'POST',
|
|
15346
|
+
{ },
|
|
15347
|
+
{ },
|
|
15348
|
+
{ },
|
|
15349
|
+
{ },
|
|
15350
|
+
body,
|
|
15351
|
+
['PureCloud OAuth'],
|
|
15352
|
+
['application/json'],
|
|
15353
|
+
['application/json']
|
|
15354
|
+
);
|
|
15355
|
+
}
|
|
15356
|
+
|
|
15357
|
+
/**
|
|
15358
|
+
* Validate encryption key configurations without saving it
|
|
15359
|
+
*
|
|
15360
|
+
* @param {Object} body Encryption Configuration
|
|
15361
|
+
*/
|
|
15362
|
+
postConversationsKeyconfigurationsValidate(body) {
|
|
15363
|
+
// verify the required parameter 'body' is set
|
|
15364
|
+
if (body === undefined || body === null) {
|
|
15365
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
|
|
15366
|
+
}
|
|
15367
|
+
|
|
15368
|
+
return this.apiClient.callApi(
|
|
15369
|
+
'/api/v2/conversations/keyconfigurations/validate',
|
|
15370
|
+
'POST',
|
|
15371
|
+
{ },
|
|
15372
|
+
{ },
|
|
15373
|
+
{ },
|
|
15374
|
+
{ },
|
|
15375
|
+
body,
|
|
15376
|
+
['PureCloud OAuth'],
|
|
15377
|
+
['application/json'],
|
|
15378
|
+
['application/json']
|
|
15379
|
+
);
|
|
15380
|
+
}
|
|
15381
|
+
|
|
15230
15382
|
/**
|
|
15231
15383
|
* Send message
|
|
15232
15384
|
* 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.
|
|
@@ -15611,6 +15763,36 @@ class ConversationsApi {
|
|
|
15611
15763
|
);
|
|
15612
15764
|
}
|
|
15613
15765
|
|
|
15766
|
+
/**
|
|
15767
|
+
* Set the secure attributes on a conversation.
|
|
15768
|
+
*
|
|
15769
|
+
* @param {String} conversationId conversation ID
|
|
15770
|
+
* @param {Object} body Conversation Secure Attributes
|
|
15771
|
+
*/
|
|
15772
|
+
putConversationSecureattributes(conversationId, body) {
|
|
15773
|
+
// verify the required parameter 'conversationId' is set
|
|
15774
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15775
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
|
|
15776
|
+
}
|
|
15777
|
+
// verify the required parameter 'body' is set
|
|
15778
|
+
if (body === undefined || body === null) {
|
|
15779
|
+
throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
|
|
15780
|
+
}
|
|
15781
|
+
|
|
15782
|
+
return this.apiClient.callApi(
|
|
15783
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
15784
|
+
'PUT',
|
|
15785
|
+
{ 'conversationId': conversationId },
|
|
15786
|
+
{ },
|
|
15787
|
+
{ },
|
|
15788
|
+
{ },
|
|
15789
|
+
body,
|
|
15790
|
+
['PureCloud OAuth'],
|
|
15791
|
+
['application/json'],
|
|
15792
|
+
['application/json']
|
|
15793
|
+
);
|
|
15794
|
+
}
|
|
15795
|
+
|
|
15614
15796
|
/**
|
|
15615
15797
|
* Update the tags on a conversation.
|
|
15616
15798
|
*
|
|
@@ -15861,6 +16043,36 @@ class ConversationsApi {
|
|
|
15861
16043
|
);
|
|
15862
16044
|
}
|
|
15863
16045
|
|
|
16046
|
+
/**
|
|
16047
|
+
* Update the encryption key configurations
|
|
16048
|
+
*
|
|
16049
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
16050
|
+
* @param {Object} body Encryption key configuration metadata
|
|
16051
|
+
*/
|
|
16052
|
+
putConversationsKeyconfiguration(keyconfigurationsId, body) {
|
|
16053
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
16054
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
16055
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
|
|
16056
|
+
}
|
|
16057
|
+
// verify the required parameter 'body' is set
|
|
16058
|
+
if (body === undefined || body === null) {
|
|
16059
|
+
throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
|
|
16060
|
+
}
|
|
16061
|
+
|
|
16062
|
+
return this.apiClient.callApi(
|
|
16063
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
16064
|
+
'PUT',
|
|
16065
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
16066
|
+
{ },
|
|
16067
|
+
{ },
|
|
16068
|
+
{ },
|
|
16069
|
+
body,
|
|
16070
|
+
['PureCloud OAuth'],
|
|
16071
|
+
['application/json'],
|
|
16072
|
+
['application/json']
|
|
16073
|
+
);
|
|
16074
|
+
}
|
|
16075
|
+
|
|
15864
16076
|
/**
|
|
15865
16077
|
* Update a conversation by setting its recording state
|
|
15866
16078
|
*
|
|
@@ -16067,7 +16279,7 @@ class DataExtensionsApi {
|
|
|
16067
16279
|
/**
|
|
16068
16280
|
* DataExtensions service.
|
|
16069
16281
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16070
|
-
* @version
|
|
16282
|
+
* @version 146.0.0
|
|
16071
16283
|
*/
|
|
16072
16284
|
|
|
16073
16285
|
/**
|
|
@@ -16153,7 +16365,7 @@ class ExternalContactsApi {
|
|
|
16153
16365
|
/**
|
|
16154
16366
|
* ExternalContacts service.
|
|
16155
16367
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16156
|
-
* @version
|
|
16368
|
+
* @version 146.0.0
|
|
16157
16369
|
*/
|
|
16158
16370
|
|
|
16159
16371
|
/**
|
|
@@ -17896,7 +18108,7 @@ class FaxApi {
|
|
|
17896
18108
|
/**
|
|
17897
18109
|
* Fax service.
|
|
17898
18110
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17899
|
-
* @version
|
|
18111
|
+
* @version 146.0.0
|
|
17900
18112
|
*/
|
|
17901
18113
|
|
|
17902
18114
|
/**
|
|
@@ -18067,7 +18279,7 @@ class FlowsApi {
|
|
|
18067
18279
|
/**
|
|
18068
18280
|
* Flows service.
|
|
18069
18281
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18070
|
-
* @version
|
|
18282
|
+
* @version 146.0.0
|
|
18071
18283
|
*/
|
|
18072
18284
|
|
|
18073
18285
|
/**
|
|
@@ -18138,7 +18350,7 @@ class GamificationApi {
|
|
|
18138
18350
|
/**
|
|
18139
18351
|
* Gamification service.
|
|
18140
18352
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18141
|
-
* @version
|
|
18353
|
+
* @version 146.0.0
|
|
18142
18354
|
*/
|
|
18143
18355
|
|
|
18144
18356
|
/**
|
|
@@ -18892,14 +19104,14 @@ class GamificationApi {
|
|
|
18892
19104
|
* @param {String} profileId performanceProfileId
|
|
18893
19105
|
* @param {String} metricId metricId
|
|
18894
19106
|
* @param {Object} filterType Filter type for the query request.
|
|
18895
|
-
* @param {String} filterId ID for the filter type. For example, division Id
|
|
18896
19107
|
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18897
19108
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18898
19109
|
* @param {Object} opts Optional parameters
|
|
19110
|
+
* @param {String} opts.filterId ID for the filter type. Only required when filterType is Division.
|
|
18899
19111
|
* @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
|
|
18900
19112
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
18901
19113
|
*/
|
|
18902
|
-
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType,
|
|
19114
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, opts) {
|
|
18903
19115
|
opts = opts || {};
|
|
18904
19116
|
|
|
18905
19117
|
// verify the required parameter 'profileId' is set
|
|
@@ -18914,10 +19126,6 @@ class GamificationApi {
|
|
|
18914
19126
|
if (filterType === undefined || filterType === null) {
|
|
18915
19127
|
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18916
19128
|
}
|
|
18917
|
-
// verify the required parameter 'filterId' is set
|
|
18918
|
-
if (filterId === undefined || filterId === null) {
|
|
18919
|
-
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18920
|
-
}
|
|
18921
19129
|
// verify the required parameter 'startWorkday' is set
|
|
18922
19130
|
if (startWorkday === undefined || startWorkday === null) {
|
|
18923
19131
|
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
@@ -18931,7 +19139,7 @@ class GamificationApi {
|
|
|
18931
19139
|
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
18932
19140
|
'GET',
|
|
18933
19141
|
{ 'profileId': profileId,'metricId': metricId },
|
|
18934
|
-
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
19142
|
+
{ 'filterType': filterType,'filterId': opts['filterId'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
18935
19143
|
{ },
|
|
18936
19144
|
{ },
|
|
18937
19145
|
null,
|
|
@@ -19873,7 +20081,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19873
20081
|
/**
|
|
19874
20082
|
* GeneralDataProtectionRegulation service.
|
|
19875
20083
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19876
|
-
* @version
|
|
20084
|
+
* @version 146.0.0
|
|
19877
20085
|
*/
|
|
19878
20086
|
|
|
19879
20087
|
/**
|
|
@@ -20003,7 +20211,7 @@ class GeolocationApi {
|
|
|
20003
20211
|
/**
|
|
20004
20212
|
* Geolocation service.
|
|
20005
20213
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20006
|
-
* @version
|
|
20214
|
+
* @version 146.0.0
|
|
20007
20215
|
*/
|
|
20008
20216
|
|
|
20009
20217
|
/**
|
|
@@ -20134,7 +20342,7 @@ class GreetingsApi {
|
|
|
20134
20342
|
/**
|
|
20135
20343
|
* Greetings service.
|
|
20136
20344
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20137
|
-
* @version
|
|
20345
|
+
* @version 146.0.0
|
|
20138
20346
|
*/
|
|
20139
20347
|
|
|
20140
20348
|
/**
|
|
@@ -20589,7 +20797,7 @@ class GroupsApi {
|
|
|
20589
20797
|
/**
|
|
20590
20798
|
* Groups service.
|
|
20591
20799
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20592
|
-
* @version
|
|
20800
|
+
* @version 146.0.0
|
|
20593
20801
|
*/
|
|
20594
20802
|
|
|
20595
20803
|
/**
|
|
@@ -20994,7 +21202,7 @@ class IdentityProviderApi {
|
|
|
20994
21202
|
/**
|
|
20995
21203
|
* IdentityProvider service.
|
|
20996
21204
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20997
|
-
* @version
|
|
21205
|
+
* @version 146.0.0
|
|
20998
21206
|
*/
|
|
20999
21207
|
|
|
21000
21208
|
/**
|
|
@@ -21750,7 +21958,7 @@ class IntegrationsApi {
|
|
|
21750
21958
|
/**
|
|
21751
21959
|
* Integrations service.
|
|
21752
21960
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21753
|
-
* @version
|
|
21961
|
+
* @version 146.0.0
|
|
21754
21962
|
*/
|
|
21755
21963
|
|
|
21756
21964
|
/**
|
|
@@ -23427,7 +23635,7 @@ class JourneyApi {
|
|
|
23427
23635
|
/**
|
|
23428
23636
|
* Journey service.
|
|
23429
23637
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23430
|
-
* @version
|
|
23638
|
+
* @version 146.0.0
|
|
23431
23639
|
*/
|
|
23432
23640
|
|
|
23433
23641
|
/**
|
|
@@ -24138,7 +24346,7 @@ class KnowledgeApi {
|
|
|
24138
24346
|
/**
|
|
24139
24347
|
* Knowledge service.
|
|
24140
24348
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24141
|
-
* @version
|
|
24349
|
+
* @version 146.0.0
|
|
24142
24350
|
*/
|
|
24143
24351
|
|
|
24144
24352
|
/**
|
|
@@ -24178,6 +24386,191 @@ class KnowledgeApi {
|
|
|
24178
24386
|
);
|
|
24179
24387
|
}
|
|
24180
24388
|
|
|
24389
|
+
/**
|
|
24390
|
+
* Delete category
|
|
24391
|
+
*
|
|
24392
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24393
|
+
* @param {String} categoryId Category ID
|
|
24394
|
+
*/
|
|
24395
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
24396
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24397
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24398
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
24399
|
+
}
|
|
24400
|
+
// verify the required parameter 'categoryId' is set
|
|
24401
|
+
if (categoryId === undefined || categoryId === null) {
|
|
24402
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
24403
|
+
}
|
|
24404
|
+
|
|
24405
|
+
return this.apiClient.callApi(
|
|
24406
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
24407
|
+
'DELETE',
|
|
24408
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
24409
|
+
{ },
|
|
24410
|
+
{ },
|
|
24411
|
+
{ },
|
|
24412
|
+
null,
|
|
24413
|
+
['PureCloud OAuth'],
|
|
24414
|
+
['application/json'],
|
|
24415
|
+
['application/json']
|
|
24416
|
+
);
|
|
24417
|
+
}
|
|
24418
|
+
|
|
24419
|
+
/**
|
|
24420
|
+
* Delete document.
|
|
24421
|
+
*
|
|
24422
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
24423
|
+
* @param {String} documentId Document ID.
|
|
24424
|
+
*/
|
|
24425
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
24426
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24427
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24428
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
24429
|
+
}
|
|
24430
|
+
// verify the required parameter 'documentId' is set
|
|
24431
|
+
if (documentId === undefined || documentId === null) {
|
|
24432
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
24433
|
+
}
|
|
24434
|
+
|
|
24435
|
+
return this.apiClient.callApi(
|
|
24436
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
24437
|
+
'DELETE',
|
|
24438
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24439
|
+
{ },
|
|
24440
|
+
{ },
|
|
24441
|
+
{ },
|
|
24442
|
+
null,
|
|
24443
|
+
['PureCloud OAuth'],
|
|
24444
|
+
['application/json'],
|
|
24445
|
+
['application/json']
|
|
24446
|
+
);
|
|
24447
|
+
}
|
|
24448
|
+
|
|
24449
|
+
/**
|
|
24450
|
+
* Delete a variation for a document.
|
|
24451
|
+
*
|
|
24452
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
24453
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
24454
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
24455
|
+
*/
|
|
24456
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
24457
|
+
// verify the required parameter 'documentVariationId' is set
|
|
24458
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
24459
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24460
|
+
}
|
|
24461
|
+
// verify the required parameter 'documentId' is set
|
|
24462
|
+
if (documentId === undefined || documentId === null) {
|
|
24463
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24464
|
+
}
|
|
24465
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24466
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24467
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24468
|
+
}
|
|
24469
|
+
|
|
24470
|
+
return this.apiClient.callApi(
|
|
24471
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
24472
|
+
'DELETE',
|
|
24473
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
24474
|
+
{ },
|
|
24475
|
+
{ },
|
|
24476
|
+
{ },
|
|
24477
|
+
null,
|
|
24478
|
+
['PureCloud OAuth'],
|
|
24479
|
+
['application/json'],
|
|
24480
|
+
['application/json']
|
|
24481
|
+
);
|
|
24482
|
+
}
|
|
24483
|
+
|
|
24484
|
+
/**
|
|
24485
|
+
* Delete export job
|
|
24486
|
+
*
|
|
24487
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24488
|
+
* @param {String} exportJobId Export job ID
|
|
24489
|
+
*/
|
|
24490
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
24491
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24492
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24493
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
24494
|
+
}
|
|
24495
|
+
// verify the required parameter 'exportJobId' is set
|
|
24496
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
24497
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
24498
|
+
}
|
|
24499
|
+
|
|
24500
|
+
return this.apiClient.callApi(
|
|
24501
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
24502
|
+
'DELETE',
|
|
24503
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
24504
|
+
{ },
|
|
24505
|
+
{ },
|
|
24506
|
+
{ },
|
|
24507
|
+
null,
|
|
24508
|
+
['PureCloud OAuth'],
|
|
24509
|
+
['application/json'],
|
|
24510
|
+
['application/json']
|
|
24511
|
+
);
|
|
24512
|
+
}
|
|
24513
|
+
|
|
24514
|
+
/**
|
|
24515
|
+
* Delete import job
|
|
24516
|
+
*
|
|
24517
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24518
|
+
* @param {String} importJobId Import job ID
|
|
24519
|
+
*/
|
|
24520
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
24521
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24522
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24523
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
24524
|
+
}
|
|
24525
|
+
// verify the required parameter 'importJobId' is set
|
|
24526
|
+
if (importJobId === undefined || importJobId === null) {
|
|
24527
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
24528
|
+
}
|
|
24529
|
+
|
|
24530
|
+
return this.apiClient.callApi(
|
|
24531
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
24532
|
+
'DELETE',
|
|
24533
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
24534
|
+
{ },
|
|
24535
|
+
{ },
|
|
24536
|
+
{ },
|
|
24537
|
+
null,
|
|
24538
|
+
['PureCloud OAuth'],
|
|
24539
|
+
['application/json'],
|
|
24540
|
+
['application/json']
|
|
24541
|
+
);
|
|
24542
|
+
}
|
|
24543
|
+
|
|
24544
|
+
/**
|
|
24545
|
+
* Delete label
|
|
24546
|
+
*
|
|
24547
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24548
|
+
* @param {String} labelId Label ID
|
|
24549
|
+
*/
|
|
24550
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
24551
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24552
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24553
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
24554
|
+
}
|
|
24555
|
+
// verify the required parameter 'labelId' is set
|
|
24556
|
+
if (labelId === undefined || labelId === null) {
|
|
24557
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
24558
|
+
}
|
|
24559
|
+
|
|
24560
|
+
return this.apiClient.callApi(
|
|
24561
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
24562
|
+
'DELETE',
|
|
24563
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
24564
|
+
{ },
|
|
24565
|
+
{ },
|
|
24566
|
+
{ },
|
|
24567
|
+
null,
|
|
24568
|
+
['PureCloud OAuth'],
|
|
24569
|
+
['application/json'],
|
|
24570
|
+
['application/json']
|
|
24571
|
+
);
|
|
24572
|
+
}
|
|
24573
|
+
|
|
24181
24574
|
/**
|
|
24182
24575
|
* Delete category
|
|
24183
24576
|
*
|
|
@@ -24283,6 +24676,104 @@ class KnowledgeApi {
|
|
|
24283
24676
|
);
|
|
24284
24677
|
}
|
|
24285
24678
|
|
|
24679
|
+
/**
|
|
24680
|
+
* Get categories
|
|
24681
|
+
*
|
|
24682
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24683
|
+
* @param {Object} opts Optional parameters
|
|
24684
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24685
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24686
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24687
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
24688
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
24689
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
24690
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
24691
|
+
* @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.
|
|
24692
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
24693
|
+
*/
|
|
24694
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
24695
|
+
opts = opts || {};
|
|
24696
|
+
|
|
24697
|
+
// verify the required parameter 'sessionId' is set
|
|
24698
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24699
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
24700
|
+
}
|
|
24701
|
+
|
|
24702
|
+
return this.apiClient.callApi(
|
|
24703
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
24704
|
+
'GET',
|
|
24705
|
+
{ 'sessionId': sessionId },
|
|
24706
|
+
{ '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'] },
|
|
24707
|
+
{ },
|
|
24708
|
+
{ },
|
|
24709
|
+
null,
|
|
24710
|
+
['PureCloud OAuth'],
|
|
24711
|
+
['application/json'],
|
|
24712
|
+
['application/json']
|
|
24713
|
+
);
|
|
24714
|
+
}
|
|
24715
|
+
|
|
24716
|
+
/**
|
|
24717
|
+
* Get a knowledge document by ID.
|
|
24718
|
+
*
|
|
24719
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24720
|
+
* @param {String} documentId Document ID
|
|
24721
|
+
*/
|
|
24722
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
24723
|
+
// verify the required parameter 'sessionId' is set
|
|
24724
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24725
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
24726
|
+
}
|
|
24727
|
+
// verify the required parameter 'documentId' is set
|
|
24728
|
+
if (documentId === undefined || documentId === null) {
|
|
24729
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
24730
|
+
}
|
|
24731
|
+
|
|
24732
|
+
return this.apiClient.callApi(
|
|
24733
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
24734
|
+
'GET',
|
|
24735
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
24736
|
+
{ },
|
|
24737
|
+
{ },
|
|
24738
|
+
{ },
|
|
24739
|
+
null,
|
|
24740
|
+
['PureCloud OAuth'],
|
|
24741
|
+
['application/json'],
|
|
24742
|
+
['application/json']
|
|
24743
|
+
);
|
|
24744
|
+
}
|
|
24745
|
+
|
|
24746
|
+
/**
|
|
24747
|
+
* Get documents.
|
|
24748
|
+
*
|
|
24749
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24750
|
+
* @param {Object} opts Optional parameters
|
|
24751
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
24752
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
24753
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24754
|
+
*/
|
|
24755
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
24756
|
+
opts = opts || {};
|
|
24757
|
+
|
|
24758
|
+
// verify the required parameter 'sessionId' is set
|
|
24759
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24760
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
24761
|
+
}
|
|
24762
|
+
|
|
24763
|
+
return this.apiClient.callApi(
|
|
24764
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
24765
|
+
'GET',
|
|
24766
|
+
{ 'sessionId': sessionId },
|
|
24767
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
24768
|
+
{ },
|
|
24769
|
+
{ },
|
|
24770
|
+
null,
|
|
24771
|
+
['PureCloud OAuth'],
|
|
24772
|
+
['application/json'],
|
|
24773
|
+
['application/json']
|
|
24774
|
+
);
|
|
24775
|
+
}
|
|
24776
|
+
|
|
24286
24777
|
/**
|
|
24287
24778
|
* Get knowledge base
|
|
24288
24779
|
*
|
|
@@ -24308,6 +24799,501 @@ class KnowledgeApi {
|
|
|
24308
24799
|
);
|
|
24309
24800
|
}
|
|
24310
24801
|
|
|
24802
|
+
/**
|
|
24803
|
+
* Get categories
|
|
24804
|
+
*
|
|
24805
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24806
|
+
* @param {Object} opts Optional parameters
|
|
24807
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24808
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24809
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24810
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
24811
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
24812
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
24813
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
24814
|
+
* @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.
|
|
24815
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
24816
|
+
*/
|
|
24817
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
24818
|
+
opts = opts || {};
|
|
24819
|
+
|
|
24820
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24821
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24822
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
24823
|
+
}
|
|
24824
|
+
|
|
24825
|
+
return this.apiClient.callApi(
|
|
24826
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
24827
|
+
'GET',
|
|
24828
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24829
|
+
{ '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'] },
|
|
24830
|
+
{ },
|
|
24831
|
+
{ },
|
|
24832
|
+
null,
|
|
24833
|
+
['PureCloud OAuth'],
|
|
24834
|
+
['application/json'],
|
|
24835
|
+
['application/json']
|
|
24836
|
+
);
|
|
24837
|
+
}
|
|
24838
|
+
|
|
24839
|
+
/**
|
|
24840
|
+
* Get category
|
|
24841
|
+
*
|
|
24842
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24843
|
+
* @param {String} categoryId Category ID
|
|
24844
|
+
*/
|
|
24845
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
24846
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24847
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24848
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
24849
|
+
}
|
|
24850
|
+
// verify the required parameter 'categoryId' is set
|
|
24851
|
+
if (categoryId === undefined || categoryId === null) {
|
|
24852
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
24853
|
+
}
|
|
24854
|
+
|
|
24855
|
+
return this.apiClient.callApi(
|
|
24856
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
24857
|
+
'GET',
|
|
24858
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
24859
|
+
{ },
|
|
24860
|
+
{ },
|
|
24861
|
+
{ },
|
|
24862
|
+
null,
|
|
24863
|
+
['PureCloud OAuth'],
|
|
24864
|
+
['application/json'],
|
|
24865
|
+
['application/json']
|
|
24866
|
+
);
|
|
24867
|
+
}
|
|
24868
|
+
|
|
24869
|
+
/**
|
|
24870
|
+
* Get document.
|
|
24871
|
+
*
|
|
24872
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
24873
|
+
* @param {String} documentId Document ID.
|
|
24874
|
+
* @param {Object} opts Optional parameters
|
|
24875
|
+
* @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.
|
|
24876
|
+
* @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.
|
|
24877
|
+
*/
|
|
24878
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
24879
|
+
opts = opts || {};
|
|
24880
|
+
|
|
24881
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24882
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24883
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
24884
|
+
}
|
|
24885
|
+
// verify the required parameter 'documentId' is set
|
|
24886
|
+
if (documentId === undefined || documentId === null) {
|
|
24887
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
24888
|
+
}
|
|
24889
|
+
|
|
24890
|
+
return this.apiClient.callApi(
|
|
24891
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
24892
|
+
'GET',
|
|
24893
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24894
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
24895
|
+
{ },
|
|
24896
|
+
{ },
|
|
24897
|
+
null,
|
|
24898
|
+
['PureCloud OAuth'],
|
|
24899
|
+
['application/json'],
|
|
24900
|
+
['application/json']
|
|
24901
|
+
);
|
|
24902
|
+
}
|
|
24903
|
+
|
|
24904
|
+
/**
|
|
24905
|
+
* Get a variation for a document.
|
|
24906
|
+
*
|
|
24907
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
24908
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
24909
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
24910
|
+
* @param {Object} opts Optional parameters
|
|
24911
|
+
* @param {Object} opts.documentState The state of the document.
|
|
24912
|
+
*/
|
|
24913
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
24914
|
+
opts = opts || {};
|
|
24915
|
+
|
|
24916
|
+
// verify the required parameter 'documentVariationId' is set
|
|
24917
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
24918
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24919
|
+
}
|
|
24920
|
+
// verify the required parameter 'documentId' is set
|
|
24921
|
+
if (documentId === undefined || documentId === null) {
|
|
24922
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24923
|
+
}
|
|
24924
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24925
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24926
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24927
|
+
}
|
|
24928
|
+
|
|
24929
|
+
return this.apiClient.callApi(
|
|
24930
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
24931
|
+
'GET',
|
|
24932
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
24933
|
+
{ 'documentState': opts['documentState'] },
|
|
24934
|
+
{ },
|
|
24935
|
+
{ },
|
|
24936
|
+
null,
|
|
24937
|
+
['PureCloud OAuth'],
|
|
24938
|
+
['application/json'],
|
|
24939
|
+
['application/json']
|
|
24940
|
+
);
|
|
24941
|
+
}
|
|
24942
|
+
|
|
24943
|
+
/**
|
|
24944
|
+
* Get variations for a document.
|
|
24945
|
+
*
|
|
24946
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24947
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24948
|
+
* @param {Object} opts Optional parameters
|
|
24949
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24950
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24951
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24952
|
+
* @param {Object} opts.documentState The state of the document.
|
|
24953
|
+
*/
|
|
24954
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
24955
|
+
opts = opts || {};
|
|
24956
|
+
|
|
24957
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24958
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24959
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
24960
|
+
}
|
|
24961
|
+
// verify the required parameter 'documentId' is set
|
|
24962
|
+
if (documentId === undefined || documentId === null) {
|
|
24963
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
24964
|
+
}
|
|
24965
|
+
|
|
24966
|
+
return this.apiClient.callApi(
|
|
24967
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
24968
|
+
'GET',
|
|
24969
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24970
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
24971
|
+
{ },
|
|
24972
|
+
{ },
|
|
24973
|
+
null,
|
|
24974
|
+
['PureCloud OAuth'],
|
|
24975
|
+
['application/json'],
|
|
24976
|
+
['application/json']
|
|
24977
|
+
);
|
|
24978
|
+
}
|
|
24979
|
+
|
|
24980
|
+
/**
|
|
24981
|
+
* Get document version.
|
|
24982
|
+
*
|
|
24983
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24984
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24985
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
24986
|
+
* @param {Object} opts Optional parameters
|
|
24987
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
24988
|
+
*/
|
|
24989
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
24990
|
+
opts = opts || {};
|
|
24991
|
+
|
|
24992
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24993
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24994
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
24995
|
+
}
|
|
24996
|
+
// verify the required parameter 'documentId' is set
|
|
24997
|
+
if (documentId === undefined || documentId === null) {
|
|
24998
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
24999
|
+
}
|
|
25000
|
+
// verify the required parameter 'versionId' is set
|
|
25001
|
+
if (versionId === undefined || versionId === null) {
|
|
25002
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
25003
|
+
}
|
|
25004
|
+
|
|
25005
|
+
return this.apiClient.callApi(
|
|
25006
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
25007
|
+
'GET',
|
|
25008
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
25009
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25010
|
+
{ },
|
|
25011
|
+
{ },
|
|
25012
|
+
null,
|
|
25013
|
+
['PureCloud OAuth'],
|
|
25014
|
+
['application/json'],
|
|
25015
|
+
['application/json']
|
|
25016
|
+
);
|
|
25017
|
+
}
|
|
25018
|
+
|
|
25019
|
+
/**
|
|
25020
|
+
* Get variation for the given document version.
|
|
25021
|
+
*
|
|
25022
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25023
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25024
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
25025
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
25026
|
+
*/
|
|
25027
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
25028
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25029
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25030
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25031
|
+
}
|
|
25032
|
+
// verify the required parameter 'documentId' is set
|
|
25033
|
+
if (documentId === undefined || documentId === null) {
|
|
25034
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25035
|
+
}
|
|
25036
|
+
// verify the required parameter 'versionId' is set
|
|
25037
|
+
if (versionId === undefined || versionId === null) {
|
|
25038
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25039
|
+
}
|
|
25040
|
+
// verify the required parameter 'variationId' is set
|
|
25041
|
+
if (variationId === undefined || variationId === null) {
|
|
25042
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25043
|
+
}
|
|
25044
|
+
|
|
25045
|
+
return this.apiClient.callApi(
|
|
25046
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
25047
|
+
'GET',
|
|
25048
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
25049
|
+
{ },
|
|
25050
|
+
{ },
|
|
25051
|
+
{ },
|
|
25052
|
+
null,
|
|
25053
|
+
['PureCloud OAuth'],
|
|
25054
|
+
['application/json'],
|
|
25055
|
+
['application/json']
|
|
25056
|
+
);
|
|
25057
|
+
}
|
|
25058
|
+
|
|
25059
|
+
/**
|
|
25060
|
+
* Get variations for the given document version.
|
|
25061
|
+
*
|
|
25062
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25063
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25064
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
25065
|
+
* @param {Object} opts Optional parameters
|
|
25066
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25067
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25068
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25069
|
+
*/
|
|
25070
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
25071
|
+
opts = opts || {};
|
|
25072
|
+
|
|
25073
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25074
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25075
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25076
|
+
}
|
|
25077
|
+
// verify the required parameter 'documentId' is set
|
|
25078
|
+
if (documentId === undefined || documentId === null) {
|
|
25079
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25080
|
+
}
|
|
25081
|
+
// verify the required parameter 'versionId' is set
|
|
25082
|
+
if (versionId === undefined || versionId === null) {
|
|
25083
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25084
|
+
}
|
|
25085
|
+
|
|
25086
|
+
return this.apiClient.callApi(
|
|
25087
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
25088
|
+
'GET',
|
|
25089
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
25090
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
25091
|
+
{ },
|
|
25092
|
+
{ },
|
|
25093
|
+
null,
|
|
25094
|
+
['PureCloud OAuth'],
|
|
25095
|
+
['application/json'],
|
|
25096
|
+
['application/json']
|
|
25097
|
+
);
|
|
25098
|
+
}
|
|
25099
|
+
|
|
25100
|
+
/**
|
|
25101
|
+
* Get document versions.
|
|
25102
|
+
*
|
|
25103
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25104
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25105
|
+
* @param {Object} opts Optional parameters
|
|
25106
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25107
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25108
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25109
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
25110
|
+
*/
|
|
25111
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
25112
|
+
opts = opts || {};
|
|
25113
|
+
|
|
25114
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25115
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25116
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
25117
|
+
}
|
|
25118
|
+
// verify the required parameter 'documentId' is set
|
|
25119
|
+
if (documentId === undefined || documentId === null) {
|
|
25120
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
25121
|
+
}
|
|
25122
|
+
|
|
25123
|
+
return this.apiClient.callApi(
|
|
25124
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
25125
|
+
'GET',
|
|
25126
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
25127
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25128
|
+
{ },
|
|
25129
|
+
{ },
|
|
25130
|
+
null,
|
|
25131
|
+
['PureCloud OAuth'],
|
|
25132
|
+
['application/json'],
|
|
25133
|
+
['application/json']
|
|
25134
|
+
);
|
|
25135
|
+
}
|
|
25136
|
+
|
|
25137
|
+
/**
|
|
25138
|
+
* Get documents.
|
|
25139
|
+
*
|
|
25140
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25141
|
+
* @param {Object} opts Optional parameters
|
|
25142
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25143
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25144
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25145
|
+
* @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
|
|
25146
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
25147
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
25148
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
25149
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
25150
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
25151
|
+
*/
|
|
25152
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
25153
|
+
opts = opts || {};
|
|
25154
|
+
|
|
25155
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25156
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25157
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
25158
|
+
}
|
|
25159
|
+
|
|
25160
|
+
return this.apiClient.callApi(
|
|
25161
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
25162
|
+
'GET',
|
|
25163
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25164
|
+
{ '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') },
|
|
25165
|
+
{ },
|
|
25166
|
+
{ },
|
|
25167
|
+
null,
|
|
25168
|
+
['PureCloud OAuth'],
|
|
25169
|
+
['application/json'],
|
|
25170
|
+
['application/json']
|
|
25171
|
+
);
|
|
25172
|
+
}
|
|
25173
|
+
|
|
25174
|
+
/**
|
|
25175
|
+
* Get export job report
|
|
25176
|
+
*
|
|
25177
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25178
|
+
* @param {String} exportJobId Export job ID
|
|
25179
|
+
*/
|
|
25180
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
25181
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25182
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25183
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
25184
|
+
}
|
|
25185
|
+
// verify the required parameter 'exportJobId' is set
|
|
25186
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
25187
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
25188
|
+
}
|
|
25189
|
+
|
|
25190
|
+
return this.apiClient.callApi(
|
|
25191
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
25192
|
+
'GET',
|
|
25193
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
25194
|
+
{ },
|
|
25195
|
+
{ },
|
|
25196
|
+
{ },
|
|
25197
|
+
null,
|
|
25198
|
+
['PureCloud OAuth'],
|
|
25199
|
+
['application/json'],
|
|
25200
|
+
['application/json']
|
|
25201
|
+
);
|
|
25202
|
+
}
|
|
25203
|
+
|
|
25204
|
+
/**
|
|
25205
|
+
* Get import job report
|
|
25206
|
+
*
|
|
25207
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25208
|
+
* @param {String} importJobId Import job ID
|
|
25209
|
+
*/
|
|
25210
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
25211
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25212
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25213
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
25214
|
+
}
|
|
25215
|
+
// verify the required parameter 'importJobId' is set
|
|
25216
|
+
if (importJobId === undefined || importJobId === null) {
|
|
25217
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
25218
|
+
}
|
|
25219
|
+
|
|
25220
|
+
return this.apiClient.callApi(
|
|
25221
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
25222
|
+
'GET',
|
|
25223
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
25224
|
+
{ },
|
|
25225
|
+
{ },
|
|
25226
|
+
{ },
|
|
25227
|
+
null,
|
|
25228
|
+
['PureCloud OAuth'],
|
|
25229
|
+
['application/json'],
|
|
25230
|
+
['application/json']
|
|
25231
|
+
);
|
|
25232
|
+
}
|
|
25233
|
+
|
|
25234
|
+
/**
|
|
25235
|
+
* Get label
|
|
25236
|
+
*
|
|
25237
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25238
|
+
* @param {String} labelId Label ID
|
|
25239
|
+
*/
|
|
25240
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
25241
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25242
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25243
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
25244
|
+
}
|
|
25245
|
+
// verify the required parameter 'labelId' is set
|
|
25246
|
+
if (labelId === undefined || labelId === null) {
|
|
25247
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
25248
|
+
}
|
|
25249
|
+
|
|
25250
|
+
return this.apiClient.callApi(
|
|
25251
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
25252
|
+
'GET',
|
|
25253
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
25254
|
+
{ },
|
|
25255
|
+
{ },
|
|
25256
|
+
{ },
|
|
25257
|
+
null,
|
|
25258
|
+
['PureCloud OAuth'],
|
|
25259
|
+
['application/json'],
|
|
25260
|
+
['application/json']
|
|
25261
|
+
);
|
|
25262
|
+
}
|
|
25263
|
+
|
|
25264
|
+
/**
|
|
25265
|
+
* Get labels
|
|
25266
|
+
*
|
|
25267
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25268
|
+
* @param {Object} opts Optional parameters
|
|
25269
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25270
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25271
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25272
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
25273
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
25274
|
+
*/
|
|
25275
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
25276
|
+
opts = opts || {};
|
|
25277
|
+
|
|
25278
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25279
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25280
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
25281
|
+
}
|
|
25282
|
+
|
|
25283
|
+
return this.apiClient.callApi(
|
|
25284
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
25285
|
+
'GET',
|
|
25286
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25287
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
25288
|
+
{ },
|
|
25289
|
+
{ },
|
|
25290
|
+
null,
|
|
25291
|
+
['PureCloud OAuth'],
|
|
25292
|
+
['application/json'],
|
|
25293
|
+
['application/json']
|
|
25294
|
+
);
|
|
25295
|
+
}
|
|
25296
|
+
|
|
24311
25297
|
/**
|
|
24312
25298
|
* Get categories
|
|
24313
25299
|
*
|
|
@@ -24566,6 +25552,108 @@ class KnowledgeApi {
|
|
|
24566
25552
|
);
|
|
24567
25553
|
}
|
|
24568
25554
|
|
|
25555
|
+
/**
|
|
25556
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
25557
|
+
*
|
|
25558
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25559
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
25560
|
+
* @param {Object} opts Optional parameters
|
|
25561
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25562
|
+
*/
|
|
25563
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
25564
|
+
opts = opts || {};
|
|
25565
|
+
|
|
25566
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25567
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25568
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
25569
|
+
}
|
|
25570
|
+
// verify the required parameter 'groupId' is set
|
|
25571
|
+
if (groupId === undefined || groupId === null) {
|
|
25572
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
25573
|
+
}
|
|
25574
|
+
|
|
25575
|
+
return this.apiClient.callApi(
|
|
25576
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
25577
|
+
'GET',
|
|
25578
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
25579
|
+
{ 'app': opts['app'] },
|
|
25580
|
+
{ },
|
|
25581
|
+
{ },
|
|
25582
|
+
null,
|
|
25583
|
+
['PureCloud OAuth'],
|
|
25584
|
+
['application/json'],
|
|
25585
|
+
['application/json']
|
|
25586
|
+
);
|
|
25587
|
+
}
|
|
25588
|
+
|
|
25589
|
+
/**
|
|
25590
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
25591
|
+
*
|
|
25592
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25593
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
25594
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
25595
|
+
* @param {Object} opts Optional parameters
|
|
25596
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25597
|
+
*/
|
|
25598
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
25599
|
+
opts = opts || {};
|
|
25600
|
+
|
|
25601
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25602
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25603
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25604
|
+
}
|
|
25605
|
+
// verify the required parameter 'groupId' is set
|
|
25606
|
+
if (groupId === undefined || groupId === null) {
|
|
25607
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25608
|
+
}
|
|
25609
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
25610
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
25611
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25612
|
+
}
|
|
25613
|
+
|
|
25614
|
+
return this.apiClient.callApi(
|
|
25615
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
25616
|
+
'GET',
|
|
25617
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
25618
|
+
{ 'app': opts['app'] },
|
|
25619
|
+
{ },
|
|
25620
|
+
{ },
|
|
25621
|
+
null,
|
|
25622
|
+
['PureCloud OAuth'],
|
|
25623
|
+
['application/json'],
|
|
25624
|
+
['application/json']
|
|
25625
|
+
);
|
|
25626
|
+
}
|
|
25627
|
+
|
|
25628
|
+
/**
|
|
25629
|
+
* Get knowledge base unanswered groups
|
|
25630
|
+
*
|
|
25631
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25632
|
+
* @param {Object} opts Optional parameters
|
|
25633
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25634
|
+
*/
|
|
25635
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
25636
|
+
opts = opts || {};
|
|
25637
|
+
|
|
25638
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25639
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25640
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
25641
|
+
}
|
|
25642
|
+
|
|
25643
|
+
return this.apiClient.callApi(
|
|
25644
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
25645
|
+
'GET',
|
|
25646
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25647
|
+
{ 'app': opts['app'] },
|
|
25648
|
+
{ },
|
|
25649
|
+
{ },
|
|
25650
|
+
null,
|
|
25651
|
+
['PureCloud OAuth'],
|
|
25652
|
+
['application/json'],
|
|
25653
|
+
['application/json']
|
|
25654
|
+
);
|
|
25655
|
+
}
|
|
25656
|
+
|
|
24569
25657
|
/**
|
|
24570
25658
|
* Get knowledge bases
|
|
24571
25659
|
*
|
|
@@ -24598,6 +25686,41 @@ class KnowledgeApi {
|
|
|
24598
25686
|
);
|
|
24599
25687
|
}
|
|
24600
25688
|
|
|
25689
|
+
/**
|
|
25690
|
+
* Update search result.
|
|
25691
|
+
*
|
|
25692
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
25693
|
+
* @param {String} searchId Search Result ID
|
|
25694
|
+
* @param {Object} body
|
|
25695
|
+
*/
|
|
25696
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
25697
|
+
// verify the required parameter 'sessionId' is set
|
|
25698
|
+
if (sessionId === undefined || sessionId === null) {
|
|
25699
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25700
|
+
}
|
|
25701
|
+
// verify the required parameter 'searchId' is set
|
|
25702
|
+
if (searchId === undefined || searchId === null) {
|
|
25703
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25704
|
+
}
|
|
25705
|
+
// verify the required parameter 'body' is set
|
|
25706
|
+
if (body === undefined || body === null) {
|
|
25707
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25708
|
+
}
|
|
25709
|
+
|
|
25710
|
+
return this.apiClient.callApi(
|
|
25711
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
25712
|
+
'PATCH',
|
|
25713
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
25714
|
+
{ },
|
|
25715
|
+
{ },
|
|
25716
|
+
{ },
|
|
25717
|
+
body,
|
|
25718
|
+
['PureCloud OAuth'],
|
|
25719
|
+
['application/json'],
|
|
25720
|
+
['application/json']
|
|
25721
|
+
);
|
|
25722
|
+
}
|
|
25723
|
+
|
|
24601
25724
|
/**
|
|
24602
25725
|
* Update knowledge base
|
|
24603
25726
|
*
|
|
@@ -24628,6 +25751,220 @@ class KnowledgeApi {
|
|
|
24628
25751
|
);
|
|
24629
25752
|
}
|
|
24630
25753
|
|
|
25754
|
+
/**
|
|
25755
|
+
* Update category
|
|
25756
|
+
*
|
|
25757
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25758
|
+
* @param {String} categoryId Category ID
|
|
25759
|
+
* @param {Object} body
|
|
25760
|
+
*/
|
|
25761
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
25762
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25763
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25764
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25765
|
+
}
|
|
25766
|
+
// verify the required parameter 'categoryId' is set
|
|
25767
|
+
if (categoryId === undefined || categoryId === null) {
|
|
25768
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25769
|
+
}
|
|
25770
|
+
// verify the required parameter 'body' is set
|
|
25771
|
+
if (body === undefined || body === null) {
|
|
25772
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25773
|
+
}
|
|
25774
|
+
|
|
25775
|
+
return this.apiClient.callApi(
|
|
25776
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
25777
|
+
'PATCH',
|
|
25778
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
25779
|
+
{ },
|
|
25780
|
+
{ },
|
|
25781
|
+
{ },
|
|
25782
|
+
body,
|
|
25783
|
+
['PureCloud OAuth'],
|
|
25784
|
+
['application/json'],
|
|
25785
|
+
['application/json']
|
|
25786
|
+
);
|
|
25787
|
+
}
|
|
25788
|
+
|
|
25789
|
+
/**
|
|
25790
|
+
* Update document.
|
|
25791
|
+
*
|
|
25792
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
25793
|
+
* @param {String} documentId Document ID.
|
|
25794
|
+
* @param {Object} body
|
|
25795
|
+
*/
|
|
25796
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
25797
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25798
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25799
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25800
|
+
}
|
|
25801
|
+
// verify the required parameter 'documentId' is set
|
|
25802
|
+
if (documentId === undefined || documentId === null) {
|
|
25803
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25804
|
+
}
|
|
25805
|
+
// verify the required parameter 'body' is set
|
|
25806
|
+
if (body === undefined || body === null) {
|
|
25807
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25808
|
+
}
|
|
25809
|
+
|
|
25810
|
+
return this.apiClient.callApi(
|
|
25811
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
25812
|
+
'PATCH',
|
|
25813
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
25814
|
+
{ },
|
|
25815
|
+
{ },
|
|
25816
|
+
{ },
|
|
25817
|
+
body,
|
|
25818
|
+
['PureCloud OAuth'],
|
|
25819
|
+
['application/json'],
|
|
25820
|
+
['application/json']
|
|
25821
|
+
);
|
|
25822
|
+
}
|
|
25823
|
+
|
|
25824
|
+
/**
|
|
25825
|
+
* Update a variation for a document.
|
|
25826
|
+
*
|
|
25827
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
25828
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
25829
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
25830
|
+
* @param {Object} body
|
|
25831
|
+
*/
|
|
25832
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
25833
|
+
// verify the required parameter 'documentVariationId' is set
|
|
25834
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
25835
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25836
|
+
}
|
|
25837
|
+
// verify the required parameter 'documentId' is set
|
|
25838
|
+
if (documentId === undefined || documentId === null) {
|
|
25839
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25840
|
+
}
|
|
25841
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25842
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25843
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25844
|
+
}
|
|
25845
|
+
// verify the required parameter 'body' is set
|
|
25846
|
+
if (body === undefined || body === null) {
|
|
25847
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25848
|
+
}
|
|
25849
|
+
|
|
25850
|
+
return this.apiClient.callApi(
|
|
25851
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
25852
|
+
'PATCH',
|
|
25853
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
25854
|
+
{ },
|
|
25855
|
+
{ },
|
|
25856
|
+
{ },
|
|
25857
|
+
body,
|
|
25858
|
+
['PureCloud OAuth'],
|
|
25859
|
+
['application/json'],
|
|
25860
|
+
['application/json']
|
|
25861
|
+
);
|
|
25862
|
+
}
|
|
25863
|
+
|
|
25864
|
+
/**
|
|
25865
|
+
* Update search result.
|
|
25866
|
+
*
|
|
25867
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
25868
|
+
* @param {String} searchId Search Result ID
|
|
25869
|
+
* @param {Object} opts Optional parameters
|
|
25870
|
+
* @param {Object} opts.body
|
|
25871
|
+
*/
|
|
25872
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
25873
|
+
opts = opts || {};
|
|
25874
|
+
|
|
25875
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25876
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25877
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
25878
|
+
}
|
|
25879
|
+
// verify the required parameter 'searchId' is set
|
|
25880
|
+
if (searchId === undefined || searchId === null) {
|
|
25881
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
25882
|
+
}
|
|
25883
|
+
|
|
25884
|
+
return this.apiClient.callApi(
|
|
25885
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
25886
|
+
'PATCH',
|
|
25887
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
25888
|
+
{ },
|
|
25889
|
+
{ },
|
|
25890
|
+
{ },
|
|
25891
|
+
opts['body'],
|
|
25892
|
+
['PureCloud OAuth'],
|
|
25893
|
+
['application/json'],
|
|
25894
|
+
['application/json']
|
|
25895
|
+
);
|
|
25896
|
+
}
|
|
25897
|
+
|
|
25898
|
+
/**
|
|
25899
|
+
* Start import job
|
|
25900
|
+
*
|
|
25901
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25902
|
+
* @param {String} importJobId Import job ID
|
|
25903
|
+
* @param {Object} body
|
|
25904
|
+
*/
|
|
25905
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
25906
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25907
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25908
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25909
|
+
}
|
|
25910
|
+
// verify the required parameter 'importJobId' is set
|
|
25911
|
+
if (importJobId === undefined || importJobId === null) {
|
|
25912
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25913
|
+
}
|
|
25914
|
+
// verify the required parameter 'body' is set
|
|
25915
|
+
if (body === undefined || body === null) {
|
|
25916
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25917
|
+
}
|
|
25918
|
+
|
|
25919
|
+
return this.apiClient.callApi(
|
|
25920
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
25921
|
+
'PATCH',
|
|
25922
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
25923
|
+
{ },
|
|
25924
|
+
{ },
|
|
25925
|
+
{ },
|
|
25926
|
+
body,
|
|
25927
|
+
['PureCloud OAuth'],
|
|
25928
|
+
['application/json'],
|
|
25929
|
+
['application/json']
|
|
25930
|
+
);
|
|
25931
|
+
}
|
|
25932
|
+
|
|
25933
|
+
/**
|
|
25934
|
+
* Update label
|
|
25935
|
+
*
|
|
25936
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25937
|
+
* @param {String} labelId Label ID
|
|
25938
|
+
* @param {Object} body
|
|
25939
|
+
*/
|
|
25940
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
25941
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25942
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25943
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25944
|
+
}
|
|
25945
|
+
// verify the required parameter 'labelId' is set
|
|
25946
|
+
if (labelId === undefined || labelId === null) {
|
|
25947
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25948
|
+
}
|
|
25949
|
+
// verify the required parameter 'body' is set
|
|
25950
|
+
if (body === undefined || body === null) {
|
|
25951
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25952
|
+
}
|
|
25953
|
+
|
|
25954
|
+
return this.apiClient.callApi(
|
|
25955
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
25956
|
+
'PATCH',
|
|
25957
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
25958
|
+
{ },
|
|
25959
|
+
{ },
|
|
25960
|
+
{ },
|
|
25961
|
+
body,
|
|
25962
|
+
['PureCloud OAuth'],
|
|
25963
|
+
['application/json'],
|
|
25964
|
+
['application/json']
|
|
25965
|
+
);
|
|
25966
|
+
}
|
|
25967
|
+
|
|
24631
25968
|
/**
|
|
24632
25969
|
* Update category
|
|
24633
25970
|
*
|
|
@@ -24783,6 +26120,46 @@ class KnowledgeApi {
|
|
|
24783
26120
|
);
|
|
24784
26121
|
}
|
|
24785
26122
|
|
|
26123
|
+
/**
|
|
26124
|
+
* Update a Knowledge base unanswered phrase group
|
|
26125
|
+
*
|
|
26126
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26127
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
26128
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
26129
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
26130
|
+
*/
|
|
26131
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
26132
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26133
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26134
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26135
|
+
}
|
|
26136
|
+
// verify the required parameter 'groupId' is set
|
|
26137
|
+
if (groupId === undefined || groupId === null) {
|
|
26138
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26139
|
+
}
|
|
26140
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
26141
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
26142
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26143
|
+
}
|
|
26144
|
+
// verify the required parameter 'body' is set
|
|
26145
|
+
if (body === undefined || body === null) {
|
|
26146
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26147
|
+
}
|
|
26148
|
+
|
|
26149
|
+
return this.apiClient.callApi(
|
|
26150
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
26151
|
+
'PATCH',
|
|
26152
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
26153
|
+
{ },
|
|
26154
|
+
{ },
|
|
26155
|
+
{ },
|
|
26156
|
+
body,
|
|
26157
|
+
['PureCloud OAuth'],
|
|
26158
|
+
['application/json'],
|
|
26159
|
+
['application/json']
|
|
26160
|
+
);
|
|
26161
|
+
}
|
|
26162
|
+
|
|
24786
26163
|
/**
|
|
24787
26164
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
24788
26165
|
*
|
|
@@ -24808,6 +26185,369 @@ class KnowledgeApi {
|
|
|
24808
26185
|
);
|
|
24809
26186
|
}
|
|
24810
26187
|
|
|
26188
|
+
/**
|
|
26189
|
+
* Search the documents in a guest session.
|
|
26190
|
+
*
|
|
26191
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
26192
|
+
* @param {Object} opts Optional parameters
|
|
26193
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
26194
|
+
* @param {Object} opts.body
|
|
26195
|
+
*/
|
|
26196
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
26197
|
+
opts = opts || {};
|
|
26198
|
+
|
|
26199
|
+
// verify the required parameter 'sessionId' is set
|
|
26200
|
+
if (sessionId === undefined || sessionId === null) {
|
|
26201
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
26202
|
+
}
|
|
26203
|
+
|
|
26204
|
+
return this.apiClient.callApi(
|
|
26205
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
26206
|
+
'POST',
|
|
26207
|
+
{ 'sessionId': sessionId },
|
|
26208
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
26209
|
+
{ },
|
|
26210
|
+
{ },
|
|
26211
|
+
opts['body'],
|
|
26212
|
+
['PureCloud OAuth'],
|
|
26213
|
+
['application/json'],
|
|
26214
|
+
['application/json']
|
|
26215
|
+
);
|
|
26216
|
+
}
|
|
26217
|
+
|
|
26218
|
+
/**
|
|
26219
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
26220
|
+
*
|
|
26221
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
26222
|
+
* @param {Object} opts Optional parameters
|
|
26223
|
+
* @param {Object} opts.body
|
|
26224
|
+
*/
|
|
26225
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
26226
|
+
opts = opts || {};
|
|
26227
|
+
|
|
26228
|
+
// verify the required parameter 'sessionId' is set
|
|
26229
|
+
if (sessionId === undefined || sessionId === null) {
|
|
26230
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
26231
|
+
}
|
|
26232
|
+
|
|
26233
|
+
return this.apiClient.callApi(
|
|
26234
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
26235
|
+
'POST',
|
|
26236
|
+
{ 'sessionId': sessionId },
|
|
26237
|
+
{ },
|
|
26238
|
+
{ },
|
|
26239
|
+
{ },
|
|
26240
|
+
opts['body'],
|
|
26241
|
+
['PureCloud OAuth'],
|
|
26242
|
+
['application/json'],
|
|
26243
|
+
['application/json']
|
|
26244
|
+
);
|
|
26245
|
+
}
|
|
26246
|
+
|
|
26247
|
+
/**
|
|
26248
|
+
* Create guest session
|
|
26249
|
+
*
|
|
26250
|
+
* @param {Object} body
|
|
26251
|
+
*/
|
|
26252
|
+
postKnowledgeGuestSessions(body) {
|
|
26253
|
+
// verify the required parameter 'body' is set
|
|
26254
|
+
if (body === undefined || body === null) {
|
|
26255
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
26256
|
+
}
|
|
26257
|
+
|
|
26258
|
+
return this.apiClient.callApi(
|
|
26259
|
+
'/api/v2/knowledge/guest/sessions',
|
|
26260
|
+
'POST',
|
|
26261
|
+
{ },
|
|
26262
|
+
{ },
|
|
26263
|
+
{ },
|
|
26264
|
+
{ },
|
|
26265
|
+
body,
|
|
26266
|
+
['PureCloud OAuth'],
|
|
26267
|
+
['application/json'],
|
|
26268
|
+
['application/json']
|
|
26269
|
+
);
|
|
26270
|
+
}
|
|
26271
|
+
|
|
26272
|
+
/**
|
|
26273
|
+
* Create new category
|
|
26274
|
+
*
|
|
26275
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26276
|
+
* @param {Object} body
|
|
26277
|
+
*/
|
|
26278
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
26279
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26280
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26281
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
26282
|
+
}
|
|
26283
|
+
// verify the required parameter 'body' is set
|
|
26284
|
+
if (body === undefined || body === null) {
|
|
26285
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
26286
|
+
}
|
|
26287
|
+
|
|
26288
|
+
return this.apiClient.callApi(
|
|
26289
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
26290
|
+
'POST',
|
|
26291
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26292
|
+
{ },
|
|
26293
|
+
{ },
|
|
26294
|
+
{ },
|
|
26295
|
+
body,
|
|
26296
|
+
['PureCloud OAuth'],
|
|
26297
|
+
['application/json'],
|
|
26298
|
+
['application/json']
|
|
26299
|
+
);
|
|
26300
|
+
}
|
|
26301
|
+
|
|
26302
|
+
/**
|
|
26303
|
+
* Create a variation for a document.
|
|
26304
|
+
*
|
|
26305
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
26306
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
26307
|
+
* @param {Object} body
|
|
26308
|
+
*/
|
|
26309
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
26310
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26311
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26312
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26313
|
+
}
|
|
26314
|
+
// verify the required parameter 'documentId' is set
|
|
26315
|
+
if (documentId === undefined || documentId === null) {
|
|
26316
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26317
|
+
}
|
|
26318
|
+
// verify the required parameter 'body' is set
|
|
26319
|
+
if (body === undefined || body === null) {
|
|
26320
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26321
|
+
}
|
|
26322
|
+
|
|
26323
|
+
return this.apiClient.callApi(
|
|
26324
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
26325
|
+
'POST',
|
|
26326
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
26327
|
+
{ },
|
|
26328
|
+
{ },
|
|
26329
|
+
{ },
|
|
26330
|
+
body,
|
|
26331
|
+
['PureCloud OAuth'],
|
|
26332
|
+
['application/json'],
|
|
26333
|
+
['application/json']
|
|
26334
|
+
);
|
|
26335
|
+
}
|
|
26336
|
+
|
|
26337
|
+
/**
|
|
26338
|
+
* Creates or restores a document version.
|
|
26339
|
+
*
|
|
26340
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
26341
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
26342
|
+
* @param {Object} body
|
|
26343
|
+
*/
|
|
26344
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
26345
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26346
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26347
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26348
|
+
}
|
|
26349
|
+
// verify the required parameter 'documentId' is set
|
|
26350
|
+
if (documentId === undefined || documentId === null) {
|
|
26351
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26352
|
+
}
|
|
26353
|
+
// verify the required parameter 'body' is set
|
|
26354
|
+
if (body === undefined || body === null) {
|
|
26355
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26356
|
+
}
|
|
26357
|
+
|
|
26358
|
+
return this.apiClient.callApi(
|
|
26359
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
26360
|
+
'POST',
|
|
26361
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
26362
|
+
{ },
|
|
26363
|
+
{ },
|
|
26364
|
+
{ },
|
|
26365
|
+
body,
|
|
26366
|
+
['PureCloud OAuth'],
|
|
26367
|
+
['application/json'],
|
|
26368
|
+
['application/json']
|
|
26369
|
+
);
|
|
26370
|
+
}
|
|
26371
|
+
|
|
26372
|
+
/**
|
|
26373
|
+
* Create document.
|
|
26374
|
+
*
|
|
26375
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26376
|
+
* @param {Object} body
|
|
26377
|
+
*/
|
|
26378
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
26379
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26380
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26381
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
26382
|
+
}
|
|
26383
|
+
// verify the required parameter 'body' is set
|
|
26384
|
+
if (body === undefined || body === null) {
|
|
26385
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
26386
|
+
}
|
|
26387
|
+
|
|
26388
|
+
return this.apiClient.callApi(
|
|
26389
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
26390
|
+
'POST',
|
|
26391
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26392
|
+
{ },
|
|
26393
|
+
{ },
|
|
26394
|
+
{ },
|
|
26395
|
+
body,
|
|
26396
|
+
['PureCloud OAuth'],
|
|
26397
|
+
['application/json'],
|
|
26398
|
+
['application/json']
|
|
26399
|
+
);
|
|
26400
|
+
}
|
|
26401
|
+
|
|
26402
|
+
/**
|
|
26403
|
+
* Search the documents in a knowledge base.
|
|
26404
|
+
*
|
|
26405
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
26406
|
+
* @param {Object} opts Optional parameters
|
|
26407
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
26408
|
+
* @param {Object} opts.body
|
|
26409
|
+
*/
|
|
26410
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
26411
|
+
opts = opts || {};
|
|
26412
|
+
|
|
26413
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26414
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26415
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
26416
|
+
}
|
|
26417
|
+
|
|
26418
|
+
return this.apiClient.callApi(
|
|
26419
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
26420
|
+
'POST',
|
|
26421
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26422
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
26423
|
+
{ },
|
|
26424
|
+
{ },
|
|
26425
|
+
opts['body'],
|
|
26426
|
+
['PureCloud OAuth'],
|
|
26427
|
+
['application/json'],
|
|
26428
|
+
['application/json']
|
|
26429
|
+
);
|
|
26430
|
+
}
|
|
26431
|
+
|
|
26432
|
+
/**
|
|
26433
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
26434
|
+
*
|
|
26435
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
26436
|
+
* @param {Object} opts Optional parameters
|
|
26437
|
+
* @param {Object} opts.body
|
|
26438
|
+
*/
|
|
26439
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
26440
|
+
opts = opts || {};
|
|
26441
|
+
|
|
26442
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26443
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26444
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
26445
|
+
}
|
|
26446
|
+
|
|
26447
|
+
return this.apiClient.callApi(
|
|
26448
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
26449
|
+
'POST',
|
|
26450
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26451
|
+
{ },
|
|
26452
|
+
{ },
|
|
26453
|
+
{ },
|
|
26454
|
+
opts['body'],
|
|
26455
|
+
['PureCloud OAuth'],
|
|
26456
|
+
['application/json'],
|
|
26457
|
+
['application/json']
|
|
26458
|
+
);
|
|
26459
|
+
}
|
|
26460
|
+
|
|
26461
|
+
/**
|
|
26462
|
+
* Create export job
|
|
26463
|
+
*
|
|
26464
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26465
|
+
* @param {Object} body
|
|
26466
|
+
*/
|
|
26467
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
26468
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26469
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26470
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
26471
|
+
}
|
|
26472
|
+
// verify the required parameter 'body' is set
|
|
26473
|
+
if (body === undefined || body === null) {
|
|
26474
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
26475
|
+
}
|
|
26476
|
+
|
|
26477
|
+
return this.apiClient.callApi(
|
|
26478
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
26479
|
+
'POST',
|
|
26480
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26481
|
+
{ },
|
|
26482
|
+
{ },
|
|
26483
|
+
{ },
|
|
26484
|
+
body,
|
|
26485
|
+
['PureCloud OAuth'],
|
|
26486
|
+
['application/json'],
|
|
26487
|
+
['application/json']
|
|
26488
|
+
);
|
|
26489
|
+
}
|
|
26490
|
+
|
|
26491
|
+
/**
|
|
26492
|
+
* Create import job
|
|
26493
|
+
*
|
|
26494
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26495
|
+
* @param {Object} body
|
|
26496
|
+
*/
|
|
26497
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
26498
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26499
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26500
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
26501
|
+
}
|
|
26502
|
+
// verify the required parameter 'body' is set
|
|
26503
|
+
if (body === undefined || body === null) {
|
|
26504
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
26505
|
+
}
|
|
26506
|
+
|
|
26507
|
+
return this.apiClient.callApi(
|
|
26508
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
26509
|
+
'POST',
|
|
26510
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26511
|
+
{ },
|
|
26512
|
+
{ },
|
|
26513
|
+
{ },
|
|
26514
|
+
body,
|
|
26515
|
+
['PureCloud OAuth'],
|
|
26516
|
+
['application/json'],
|
|
26517
|
+
['application/json']
|
|
26518
|
+
);
|
|
26519
|
+
}
|
|
26520
|
+
|
|
26521
|
+
/**
|
|
26522
|
+
* Create new label
|
|
26523
|
+
*
|
|
26524
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26525
|
+
* @param {Object} body
|
|
26526
|
+
*/
|
|
26527
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
26528
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26529
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26530
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
26531
|
+
}
|
|
26532
|
+
// verify the required parameter 'body' is set
|
|
26533
|
+
if (body === undefined || body === null) {
|
|
26534
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
26535
|
+
}
|
|
26536
|
+
|
|
26537
|
+
return this.apiClient.callApi(
|
|
26538
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
26539
|
+
'POST',
|
|
26540
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26541
|
+
{ },
|
|
26542
|
+
{ },
|
|
26543
|
+
{ },
|
|
26544
|
+
body,
|
|
26545
|
+
['PureCloud OAuth'],
|
|
26546
|
+
['application/json'],
|
|
26547
|
+
['application/json']
|
|
26548
|
+
);
|
|
26549
|
+
}
|
|
26550
|
+
|
|
24811
26551
|
/**
|
|
24812
26552
|
* Create new category
|
|
24813
26553
|
*
|
|
@@ -25038,7 +26778,7 @@ class LanguageUnderstandingApi {
|
|
|
25038
26778
|
/**
|
|
25039
26779
|
* LanguageUnderstanding service.
|
|
25040
26780
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25041
|
-
* @version
|
|
26781
|
+
* @version 146.0.0
|
|
25042
26782
|
*/
|
|
25043
26783
|
|
|
25044
26784
|
/**
|
|
@@ -25942,7 +27682,7 @@ class LanguagesApi {
|
|
|
25942
27682
|
/**
|
|
25943
27683
|
* Languages service.
|
|
25944
27684
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25945
|
-
* @version
|
|
27685
|
+
* @version 146.0.0
|
|
25946
27686
|
*/
|
|
25947
27687
|
|
|
25948
27688
|
/**
|
|
@@ -26210,7 +27950,7 @@ class LearningApi {
|
|
|
26210
27950
|
/**
|
|
26211
27951
|
* Learning service.
|
|
26212
27952
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26213
|
-
* @version
|
|
27953
|
+
* @version 146.0.0
|
|
26214
27954
|
*/
|
|
26215
27955
|
|
|
26216
27956
|
/**
|
|
@@ -26563,6 +28303,31 @@ class LearningApi {
|
|
|
26563
28303
|
);
|
|
26564
28304
|
}
|
|
26565
28305
|
|
|
28306
|
+
/**
|
|
28307
|
+
* Get a specific Learning Module cover art using ID
|
|
28308
|
+
*
|
|
28309
|
+
* @param {String} coverArtId Key identifier for the cover art
|
|
28310
|
+
*/
|
|
28311
|
+
getLearningModulesCoverartCoverArtId(coverArtId) {
|
|
28312
|
+
// verify the required parameter 'coverArtId' is set
|
|
28313
|
+
if (coverArtId === undefined || coverArtId === null) {
|
|
28314
|
+
throw 'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';
|
|
28315
|
+
}
|
|
28316
|
+
|
|
28317
|
+
return this.apiClient.callApi(
|
|
28318
|
+
'/api/v2/learning/modules/coverart/{coverArtId}',
|
|
28319
|
+
'GET',
|
|
28320
|
+
{ 'coverArtId': coverArtId },
|
|
28321
|
+
{ },
|
|
28322
|
+
{ },
|
|
28323
|
+
{ },
|
|
28324
|
+
null,
|
|
28325
|
+
['PureCloud OAuth'],
|
|
28326
|
+
['application/json'],
|
|
28327
|
+
['application/json']
|
|
28328
|
+
);
|
|
28329
|
+
}
|
|
28330
|
+
|
|
26566
28331
|
/**
|
|
26567
28332
|
* Update Learning Assignment
|
|
26568
28333
|
*
|
|
@@ -26945,7 +28710,7 @@ class LicenseApi {
|
|
|
26945
28710
|
/**
|
|
26946
28711
|
* License service.
|
|
26947
28712
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26948
|
-
* @version
|
|
28713
|
+
* @version 146.0.0
|
|
26949
28714
|
*/
|
|
26950
28715
|
|
|
26951
28716
|
/**
|
|
@@ -27183,7 +28948,7 @@ class LocationsApi {
|
|
|
27183
28948
|
/**
|
|
27184
28949
|
* Locations service.
|
|
27185
28950
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27186
|
-
* @version
|
|
28951
|
+
* @version 146.0.0
|
|
27187
28952
|
*/
|
|
27188
28953
|
|
|
27189
28954
|
/**
|
|
@@ -27419,7 +29184,7 @@ class MessagingApi {
|
|
|
27419
29184
|
/**
|
|
27420
29185
|
* Messaging service.
|
|
27421
29186
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27422
|
-
* @version
|
|
29187
|
+
* @version 146.0.0
|
|
27423
29188
|
*/
|
|
27424
29189
|
|
|
27425
29190
|
/**
|
|
@@ -27570,7 +29335,7 @@ class MobileDevicesApi {
|
|
|
27570
29335
|
/**
|
|
27571
29336
|
* MobileDevices service.
|
|
27572
29337
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27573
|
-
* @version
|
|
29338
|
+
* @version 146.0.0
|
|
27574
29339
|
*/
|
|
27575
29340
|
|
|
27576
29341
|
/**
|
|
@@ -27721,7 +29486,7 @@ class NotificationsApi {
|
|
|
27721
29486
|
/**
|
|
27722
29487
|
* Notifications service.
|
|
27723
29488
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27724
|
-
* @version
|
|
29489
|
+
* @version 146.0.0
|
|
27725
29490
|
*/
|
|
27726
29491
|
|
|
27727
29492
|
/**
|
|
@@ -27946,7 +29711,7 @@ class OAuthApi {
|
|
|
27946
29711
|
/**
|
|
27947
29712
|
* OAuth service.
|
|
27948
29713
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27949
|
-
* @version
|
|
29714
|
+
* @version 146.0.0
|
|
27950
29715
|
*/
|
|
27951
29716
|
|
|
27952
29717
|
/**
|
|
@@ -28312,7 +30077,7 @@ class ObjectsApi {
|
|
|
28312
30077
|
/**
|
|
28313
30078
|
* Objects service.
|
|
28314
30079
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28315
|
-
* @version
|
|
30080
|
+
* @version 146.0.0
|
|
28316
30081
|
*/
|
|
28317
30082
|
|
|
28318
30083
|
/**
|
|
@@ -28583,7 +30348,7 @@ class OrganizationApi {
|
|
|
28583
30348
|
/**
|
|
28584
30349
|
* Organization service.
|
|
28585
30350
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28586
|
-
* @version
|
|
30351
|
+
* @version 146.0.0
|
|
28587
30352
|
*/
|
|
28588
30353
|
|
|
28589
30354
|
/**
|
|
@@ -28986,7 +30751,7 @@ class OrganizationAuthorizationApi {
|
|
|
28986
30751
|
/**
|
|
28987
30752
|
* OrganizationAuthorization service.
|
|
28988
30753
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28989
|
-
* @version
|
|
30754
|
+
* @version 146.0.0
|
|
28990
30755
|
*/
|
|
28991
30756
|
|
|
28992
30757
|
/**
|
|
@@ -29911,7 +31676,7 @@ class OutboundApi {
|
|
|
29911
31676
|
/**
|
|
29912
31677
|
* Outbound service.
|
|
29913
31678
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29914
|
-
* @version
|
|
31679
|
+
* @version 146.0.0
|
|
29915
31680
|
*/
|
|
29916
31681
|
|
|
29917
31682
|
/**
|
|
@@ -33166,7 +34931,7 @@ class PresenceApi {
|
|
|
33166
34931
|
/**
|
|
33167
34932
|
* Presence service.
|
|
33168
34933
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33169
|
-
* @version
|
|
34934
|
+
* @version 146.0.0
|
|
33170
34935
|
*/
|
|
33171
34936
|
|
|
33172
34937
|
/**
|
|
@@ -33488,7 +35253,7 @@ class QualityApi {
|
|
|
33488
35253
|
/**
|
|
33489
35254
|
* Quality service.
|
|
33490
35255
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
33491
|
-
* @version
|
|
35256
|
+
* @version 146.0.0
|
|
33492
35257
|
*/
|
|
33493
35258
|
|
|
33494
35259
|
/**
|
|
@@ -35066,7 +36831,7 @@ class RecordingApi {
|
|
|
35066
36831
|
/**
|
|
35067
36832
|
* Recording service.
|
|
35068
36833
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35069
|
-
* @version
|
|
36834
|
+
* @version 146.0.0
|
|
35070
36835
|
*/
|
|
35071
36836
|
|
|
35072
36837
|
/**
|
|
@@ -36719,7 +38484,7 @@ class ResponseManagementApi {
|
|
|
36719
38484
|
/**
|
|
36720
38485
|
* ResponseManagement service.
|
|
36721
38486
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
36722
|
-
* @version
|
|
38487
|
+
* @version 146.0.0
|
|
36723
38488
|
*/
|
|
36724
38489
|
|
|
36725
38490
|
/**
|
|
@@ -37203,7 +38968,7 @@ class RoutingApi {
|
|
|
37203
38968
|
/**
|
|
37204
38969
|
* Routing service.
|
|
37205
38970
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
37206
|
-
* @version
|
|
38971
|
+
* @version 146.0.0
|
|
37207
38972
|
*/
|
|
37208
38973
|
|
|
37209
38974
|
/**
|
|
@@ -37769,6 +39534,26 @@ class RoutingApi {
|
|
|
37769
39534
|
);
|
|
37770
39535
|
}
|
|
37771
39536
|
|
|
39537
|
+
/**
|
|
39538
|
+
* Get available media types
|
|
39539
|
+
*
|
|
39540
|
+
*/
|
|
39541
|
+
getRoutingAvailablemediatypes() {
|
|
39542
|
+
|
|
39543
|
+
return this.apiClient.callApi(
|
|
39544
|
+
'/api/v2/routing/availablemediatypes',
|
|
39545
|
+
'GET',
|
|
39546
|
+
{ },
|
|
39547
|
+
{ },
|
|
39548
|
+
{ },
|
|
39549
|
+
{ },
|
|
39550
|
+
null,
|
|
39551
|
+
['PureCloud OAuth'],
|
|
39552
|
+
['application/json'],
|
|
39553
|
+
['application/json']
|
|
39554
|
+
);
|
|
39555
|
+
}
|
|
39556
|
+
|
|
37772
39557
|
/**
|
|
37773
39558
|
* Get domain
|
|
37774
39559
|
*
|
|
@@ -40124,7 +41909,7 @@ class SCIMApi {
|
|
|
40124
41909
|
/**
|
|
40125
41910
|
* SCIM service.
|
|
40126
41911
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
40127
|
-
* @version
|
|
41912
|
+
* @version 146.0.0
|
|
40128
41913
|
*/
|
|
40129
41914
|
|
|
40130
41915
|
/**
|
|
@@ -41001,7 +42786,7 @@ class ScriptsApi {
|
|
|
41001
42786
|
/**
|
|
41002
42787
|
* Scripts service.
|
|
41003
42788
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
41004
|
-
* @version
|
|
42789
|
+
* @version 146.0.0
|
|
41005
42790
|
*/
|
|
41006
42791
|
|
|
41007
42792
|
/**
|
|
@@ -41420,7 +43205,7 @@ class SearchApi {
|
|
|
41420
43205
|
/**
|
|
41421
43206
|
* Search service.
|
|
41422
43207
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
41423
|
-
* @version
|
|
43208
|
+
* @version 146.0.0
|
|
41424
43209
|
*/
|
|
41425
43210
|
|
|
41426
43211
|
/**
|
|
@@ -41980,7 +43765,7 @@ class SpeechTextAnalyticsApi {
|
|
|
41980
43765
|
/**
|
|
41981
43766
|
* SpeechTextAnalytics service.
|
|
41982
43767
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
41983
|
-
* @version
|
|
43768
|
+
* @version 146.0.0
|
|
41984
43769
|
*/
|
|
41985
43770
|
|
|
41986
43771
|
/**
|
|
@@ -42834,7 +44619,7 @@ class StationsApi {
|
|
|
42834
44619
|
/**
|
|
42835
44620
|
* Stations service.
|
|
42836
44621
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
42837
|
-
* @version
|
|
44622
|
+
* @version 146.0.0
|
|
42838
44623
|
*/
|
|
42839
44624
|
|
|
42840
44625
|
/**
|
|
@@ -42981,7 +44766,7 @@ class SuggestApi {
|
|
|
42981
44766
|
/**
|
|
42982
44767
|
* Suggest service.
|
|
42983
44768
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
42984
|
-
* @version
|
|
44769
|
+
* @version 146.0.0
|
|
42985
44770
|
*/
|
|
42986
44771
|
|
|
42987
44772
|
/**
|
|
@@ -43120,7 +44905,7 @@ class TeamsApi {
|
|
|
43120
44905
|
/**
|
|
43121
44906
|
* Teams service.
|
|
43122
44907
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
43123
|
-
* @version
|
|
44908
|
+
* @version 146.0.0
|
|
43124
44909
|
*/
|
|
43125
44910
|
|
|
43126
44911
|
/**
|
|
@@ -43299,7 +45084,7 @@ class TelephonyApi {
|
|
|
43299
45084
|
/**
|
|
43300
45085
|
* Telephony service.
|
|
43301
45086
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
43302
|
-
* @version
|
|
45087
|
+
* @version 146.0.0
|
|
43303
45088
|
*/
|
|
43304
45089
|
|
|
43305
45090
|
/**
|
|
@@ -43407,7 +45192,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
43407
45192
|
/**
|
|
43408
45193
|
* TelephonyProvidersEdge service.
|
|
43409
45194
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
43410
|
-
* @version
|
|
45195
|
+
* @version 146.0.0
|
|
43411
45196
|
*/
|
|
43412
45197
|
|
|
43413
45198
|
/**
|
|
@@ -47040,7 +48825,7 @@ class TextbotsApi {
|
|
|
47040
48825
|
/**
|
|
47041
48826
|
* Textbots service.
|
|
47042
48827
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
47043
|
-
* @version
|
|
48828
|
+
* @version 146.0.0
|
|
47044
48829
|
*/
|
|
47045
48830
|
|
|
47046
48831
|
/**
|
|
@@ -47168,7 +48953,7 @@ class TokensApi {
|
|
|
47168
48953
|
/**
|
|
47169
48954
|
* Tokens service.
|
|
47170
48955
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
47171
|
-
* @version
|
|
48956
|
+
* @version 146.0.0
|
|
47172
48957
|
*/
|
|
47173
48958
|
|
|
47174
48959
|
/**
|
|
@@ -47274,7 +49059,7 @@ class UploadsApi {
|
|
|
47274
49059
|
/**
|
|
47275
49060
|
* Uploads service.
|
|
47276
49061
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
47277
|
-
* @version
|
|
49062
|
+
* @version 146.0.0
|
|
47278
49063
|
*/
|
|
47279
49064
|
|
|
47280
49065
|
/**
|
|
@@ -47344,6 +49129,31 @@ class UploadsApi {
|
|
|
47344
49129
|
);
|
|
47345
49130
|
}
|
|
47346
49131
|
|
|
49132
|
+
/**
|
|
49133
|
+
* Generates pre-signed URL to upload cover art for learning modules
|
|
49134
|
+
*
|
|
49135
|
+
* @param {Object} body query
|
|
49136
|
+
*/
|
|
49137
|
+
postUploadsLearningCoverart(body) {
|
|
49138
|
+
// verify the required parameter 'body' is set
|
|
49139
|
+
if (body === undefined || body === null) {
|
|
49140
|
+
throw 'Missing the required parameter "body" when calling postUploadsLearningCoverart';
|
|
49141
|
+
}
|
|
49142
|
+
|
|
49143
|
+
return this.apiClient.callApi(
|
|
49144
|
+
'/api/v2/uploads/learning/coverart',
|
|
49145
|
+
'POST',
|
|
49146
|
+
{ },
|
|
49147
|
+
{ },
|
|
49148
|
+
{ },
|
|
49149
|
+
{ },
|
|
49150
|
+
body,
|
|
49151
|
+
['PureCloud OAuth'],
|
|
49152
|
+
['application/json'],
|
|
49153
|
+
['application/json']
|
|
49154
|
+
);
|
|
49155
|
+
}
|
|
49156
|
+
|
|
47347
49157
|
/**
|
|
47348
49158
|
* Creates presigned url for uploading a public asset image
|
|
47349
49159
|
*
|
|
@@ -47425,7 +49235,7 @@ class UsageApi {
|
|
|
47425
49235
|
/**
|
|
47426
49236
|
* Usage service.
|
|
47427
49237
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
47428
|
-
* @version
|
|
49238
|
+
* @version 146.0.0
|
|
47429
49239
|
*/
|
|
47430
49240
|
|
|
47431
49241
|
/**
|
|
@@ -47496,7 +49306,7 @@ class UserRecordingsApi {
|
|
|
47496
49306
|
/**
|
|
47497
49307
|
* UserRecordings service.
|
|
47498
49308
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
47499
|
-
* @version
|
|
49309
|
+
* @version 146.0.0
|
|
47500
49310
|
*/
|
|
47501
49311
|
|
|
47502
49312
|
/**
|
|
@@ -47680,7 +49490,7 @@ class UsersApi {
|
|
|
47680
49490
|
/**
|
|
47681
49491
|
* Users service.
|
|
47682
49492
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
47683
|
-
* @version
|
|
49493
|
+
* @version 146.0.0
|
|
47684
49494
|
*/
|
|
47685
49495
|
|
|
47686
49496
|
/**
|
|
@@ -49543,7 +51353,7 @@ class UsersApi {
|
|
|
49543
51353
|
|
|
49544
51354
|
/**
|
|
49545
51355
|
* Create user
|
|
49546
|
-
*
|
|
51356
|
+
* 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.
|
|
49547
51357
|
* @param {Object} body User
|
|
49548
51358
|
*/
|
|
49549
51359
|
postUsers(body) {
|
|
@@ -49982,7 +51792,7 @@ class UtilitiesApi {
|
|
|
49982
51792
|
/**
|
|
49983
51793
|
* Utilities service.
|
|
49984
51794
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
49985
|
-
* @version
|
|
51795
|
+
* @version 146.0.0
|
|
49986
51796
|
*/
|
|
49987
51797
|
|
|
49988
51798
|
/**
|
|
@@ -50093,7 +51903,7 @@ class VoicemailApi {
|
|
|
50093
51903
|
/**
|
|
50094
51904
|
* Voicemail service.
|
|
50095
51905
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
50096
|
-
* @version
|
|
51906
|
+
* @version 146.0.0
|
|
50097
51907
|
*/
|
|
50098
51908
|
|
|
50099
51909
|
/**
|
|
@@ -50760,7 +52570,7 @@ class WebChatApi {
|
|
|
50760
52570
|
/**
|
|
50761
52571
|
* WebChat service.
|
|
50762
52572
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
50763
|
-
* @version
|
|
52573
|
+
* @version 146.0.0
|
|
50764
52574
|
*/
|
|
50765
52575
|
|
|
50766
52576
|
/**
|
|
@@ -51304,7 +53114,7 @@ class WebDeploymentsApi {
|
|
|
51304
53114
|
/**
|
|
51305
53115
|
* WebDeployments service.
|
|
51306
53116
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
51307
|
-
* @version
|
|
53117
|
+
* @version 146.0.0
|
|
51308
53118
|
*/
|
|
51309
53119
|
|
|
51310
53120
|
/**
|
|
@@ -51659,7 +53469,7 @@ class WebMessagingApi {
|
|
|
51659
53469
|
/**
|
|
51660
53470
|
* WebMessaging service.
|
|
51661
53471
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
51662
|
-
* @version
|
|
53472
|
+
* @version 146.0.0
|
|
51663
53473
|
*/
|
|
51664
53474
|
|
|
51665
53475
|
/**
|
|
@@ -51705,7 +53515,7 @@ class WidgetsApi {
|
|
|
51705
53515
|
/**
|
|
51706
53516
|
* Widgets service.
|
|
51707
53517
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
51708
|
-
* @version
|
|
53518
|
+
* @version 146.0.0
|
|
51709
53519
|
*/
|
|
51710
53520
|
|
|
51711
53521
|
/**
|
|
@@ -51851,7 +53661,7 @@ class WorkforceManagementApi {
|
|
|
51851
53661
|
/**
|
|
51852
53662
|
* WorkforceManagement service.
|
|
51853
53663
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
51854
|
-
* @version
|
|
53664
|
+
* @version 146.0.0
|
|
51855
53665
|
*/
|
|
51856
53666
|
|
|
51857
53667
|
/**
|
|
@@ -56127,7 +57937,7 @@ class WorkforceManagementApi {
|
|
|
56127
57937
|
* </pre>
|
|
56128
57938
|
* </p>
|
|
56129
57939
|
* @module purecloud-platform-client-v2/index
|
|
56130
|
-
* @version
|
|
57940
|
+
* @version 146.0.0
|
|
56131
57941
|
*/
|
|
56132
57942
|
class platformClient {
|
|
56133
57943
|
constructor() {
|