purecloud-platform-client-v2 145.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 +1600 -67
- package/dist/web-amd/purecloud-platform-client-v2.js +1600 -67
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1600 -67
- package/dist/web-cjs/purecloud-platform-client-v2.js +1600 -67
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +743 -4
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +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 +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +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
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 146.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1481,7 +1481,7 @@ class AlertingApi {
|
|
|
1481
1481
|
/**
|
|
1482
1482
|
* Alerting service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 146.0.0
|
|
1485
1485
|
*/
|
|
1486
1486
|
|
|
1487
1487
|
/**
|
|
@@ -1795,7 +1795,7 @@ class AnalyticsApi {
|
|
|
1795
1795
|
/**
|
|
1796
1796
|
* Analytics service.
|
|
1797
1797
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1798
|
-
* @version
|
|
1798
|
+
* @version 146.0.0
|
|
1799
1799
|
*/
|
|
1800
1800
|
|
|
1801
1801
|
/**
|
|
@@ -2977,7 +2977,7 @@ class ArchitectApi {
|
|
|
2977
2977
|
/**
|
|
2978
2978
|
* Architect service.
|
|
2979
2979
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2980
|
-
* @version
|
|
2980
|
+
* @version 146.0.0
|
|
2981
2981
|
*/
|
|
2982
2982
|
|
|
2983
2983
|
/**
|
|
@@ -3735,6 +3735,7 @@ class ArchitectApi {
|
|
|
3735
3735
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
3736
3736
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
3737
3737
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
3738
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
3738
3739
|
*/
|
|
3739
3740
|
getArchitectIvrs(opts) {
|
|
3740
3741
|
opts = opts || {};
|
|
@@ -3744,7 +3745,7 @@ class ArchitectApi {
|
|
|
3744
3745
|
'/api/v2/architect/ivrs',
|
|
3745
3746
|
'GET',
|
|
3746
3747
|
{ },
|
|
3747
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
3748
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
3748
3749
|
{ },
|
|
3749
3750
|
{ },
|
|
3750
3751
|
null,
|
|
@@ -6022,7 +6023,7 @@ class AuditApi {
|
|
|
6022
6023
|
/**
|
|
6023
6024
|
* Audit service.
|
|
6024
6025
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6025
|
-
* @version
|
|
6026
|
+
* @version 146.0.0
|
|
6026
6027
|
*/
|
|
6027
6028
|
|
|
6028
6029
|
/**
|
|
@@ -6193,7 +6194,7 @@ class AuthorizationApi {
|
|
|
6193
6194
|
/**
|
|
6194
6195
|
* Authorization service.
|
|
6195
6196
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6196
|
-
* @version
|
|
6197
|
+
* @version 146.0.0
|
|
6197
6198
|
*/
|
|
6198
6199
|
|
|
6199
6200
|
/**
|
|
@@ -7376,7 +7377,7 @@ class BillingApi {
|
|
|
7376
7377
|
/**
|
|
7377
7378
|
* Billing service.
|
|
7378
7379
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7379
|
-
* @version
|
|
7380
|
+
* @version 146.0.0
|
|
7380
7381
|
*/
|
|
7381
7382
|
|
|
7382
7383
|
/**
|
|
@@ -7456,7 +7457,7 @@ class ChatApi {
|
|
|
7456
7457
|
/**
|
|
7457
7458
|
* Chat service.
|
|
7458
7459
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7459
|
-
* @version
|
|
7460
|
+
* @version 146.0.0
|
|
7460
7461
|
*/
|
|
7461
7462
|
|
|
7462
7463
|
/**
|
|
@@ -7547,7 +7548,7 @@ class CoachingApi {
|
|
|
7547
7548
|
/**
|
|
7548
7549
|
* Coaching service.
|
|
7549
7550
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7550
|
-
* @version
|
|
7551
|
+
* @version 146.0.0
|
|
7551
7552
|
*/
|
|
7552
7553
|
|
|
7553
7554
|
/**
|
|
@@ -8124,7 +8125,7 @@ class ContentManagementApi {
|
|
|
8124
8125
|
/**
|
|
8125
8126
|
* ContentManagement service.
|
|
8126
8127
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8127
|
-
* @version
|
|
8128
|
+
* @version 146.0.0
|
|
8128
8129
|
*/
|
|
8129
8130
|
|
|
8130
8131
|
/**
|
|
@@ -9264,7 +9265,7 @@ class ConversationsApi {
|
|
|
9264
9265
|
/**
|
|
9265
9266
|
* Conversations service.
|
|
9266
9267
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9267
|
-
* @version
|
|
9268
|
+
* @version 146.0.0
|
|
9268
9269
|
*/
|
|
9269
9270
|
|
|
9270
9271
|
/**
|
|
@@ -14408,7 +14409,7 @@ class DataExtensionsApi {
|
|
|
14408
14409
|
/**
|
|
14409
14410
|
* DataExtensions service.
|
|
14410
14411
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14411
|
-
* @version
|
|
14412
|
+
* @version 146.0.0
|
|
14412
14413
|
*/
|
|
14413
14414
|
|
|
14414
14415
|
/**
|
|
@@ -14494,7 +14495,7 @@ class ExternalContactsApi {
|
|
|
14494
14495
|
/**
|
|
14495
14496
|
* ExternalContacts service.
|
|
14496
14497
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14497
|
-
* @version
|
|
14498
|
+
* @version 146.0.0
|
|
14498
14499
|
*/
|
|
14499
14500
|
|
|
14500
14501
|
/**
|
|
@@ -16237,7 +16238,7 @@ class FaxApi {
|
|
|
16237
16238
|
/**
|
|
16238
16239
|
* Fax service.
|
|
16239
16240
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16240
|
-
* @version
|
|
16241
|
+
* @version 146.0.0
|
|
16241
16242
|
*/
|
|
16242
16243
|
|
|
16243
16244
|
/**
|
|
@@ -16408,7 +16409,7 @@ class FlowsApi {
|
|
|
16408
16409
|
/**
|
|
16409
16410
|
* Flows service.
|
|
16410
16411
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16411
|
-
* @version
|
|
16412
|
+
* @version 146.0.0
|
|
16412
16413
|
*/
|
|
16413
16414
|
|
|
16414
16415
|
/**
|
|
@@ -16479,7 +16480,7 @@ class GamificationApi {
|
|
|
16479
16480
|
/**
|
|
16480
16481
|
* Gamification service.
|
|
16481
16482
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16482
|
-
* @version
|
|
16483
|
+
* @version 146.0.0
|
|
16483
16484
|
*/
|
|
16484
16485
|
|
|
16485
16486
|
/**
|
|
@@ -18210,7 +18211,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
18210
18211
|
/**
|
|
18211
18212
|
* GeneralDataProtectionRegulation service.
|
|
18212
18213
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
18213
|
-
* @version
|
|
18214
|
+
* @version 146.0.0
|
|
18214
18215
|
*/
|
|
18215
18216
|
|
|
18216
18217
|
/**
|
|
@@ -18340,7 +18341,7 @@ class GeolocationApi {
|
|
|
18340
18341
|
/**
|
|
18341
18342
|
* Geolocation service.
|
|
18342
18343
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
18343
|
-
* @version
|
|
18344
|
+
* @version 146.0.0
|
|
18344
18345
|
*/
|
|
18345
18346
|
|
|
18346
18347
|
/**
|
|
@@ -18471,7 +18472,7 @@ class GreetingsApi {
|
|
|
18471
18472
|
/**
|
|
18472
18473
|
* Greetings service.
|
|
18473
18474
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
18474
|
-
* @version
|
|
18475
|
+
* @version 146.0.0
|
|
18475
18476
|
*/
|
|
18476
18477
|
|
|
18477
18478
|
/**
|
|
@@ -18926,7 +18927,7 @@ class GroupsApi {
|
|
|
18926
18927
|
/**
|
|
18927
18928
|
* Groups service.
|
|
18928
18929
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18929
|
-
* @version
|
|
18930
|
+
* @version 146.0.0
|
|
18930
18931
|
*/
|
|
18931
18932
|
|
|
18932
18933
|
/**
|
|
@@ -19331,7 +19332,7 @@ class IdentityProviderApi {
|
|
|
19331
19332
|
/**
|
|
19332
19333
|
* IdentityProvider service.
|
|
19333
19334
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
19334
|
-
* @version
|
|
19335
|
+
* @version 146.0.0
|
|
19335
19336
|
*/
|
|
19336
19337
|
|
|
19337
19338
|
/**
|
|
@@ -20087,7 +20088,7 @@ class IntegrationsApi {
|
|
|
20087
20088
|
/**
|
|
20088
20089
|
* Integrations service.
|
|
20089
20090
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
20090
|
-
* @version
|
|
20091
|
+
* @version 146.0.0
|
|
20091
20092
|
*/
|
|
20092
20093
|
|
|
20093
20094
|
/**
|
|
@@ -21764,7 +21765,7 @@ class JourneyApi {
|
|
|
21764
21765
|
/**
|
|
21765
21766
|
* Journey service.
|
|
21766
21767
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21767
|
-
* @version
|
|
21768
|
+
* @version 146.0.0
|
|
21768
21769
|
*/
|
|
21769
21770
|
|
|
21770
21771
|
/**
|
|
@@ -22475,7 +22476,7 @@ class KnowledgeApi {
|
|
|
22475
22476
|
/**
|
|
22476
22477
|
* Knowledge service.
|
|
22477
22478
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
22478
|
-
* @version
|
|
22479
|
+
* @version 146.0.0
|
|
22479
22480
|
*/
|
|
22480
22481
|
|
|
22481
22482
|
/**
|
|
@@ -22515,6 +22516,191 @@ class KnowledgeApi {
|
|
|
22515
22516
|
);
|
|
22516
22517
|
}
|
|
22517
22518
|
|
|
22519
|
+
/**
|
|
22520
|
+
* Delete category
|
|
22521
|
+
*
|
|
22522
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22523
|
+
* @param {String} categoryId Category ID
|
|
22524
|
+
*/
|
|
22525
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
22526
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22527
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22528
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
22529
|
+
}
|
|
22530
|
+
// verify the required parameter 'categoryId' is set
|
|
22531
|
+
if (categoryId === undefined || categoryId === null) {
|
|
22532
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
22533
|
+
}
|
|
22534
|
+
|
|
22535
|
+
return this.apiClient.callApi(
|
|
22536
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
22537
|
+
'DELETE',
|
|
22538
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
22539
|
+
{ },
|
|
22540
|
+
{ },
|
|
22541
|
+
{ },
|
|
22542
|
+
null,
|
|
22543
|
+
['PureCloud OAuth'],
|
|
22544
|
+
['application/json'],
|
|
22545
|
+
['application/json']
|
|
22546
|
+
);
|
|
22547
|
+
}
|
|
22548
|
+
|
|
22549
|
+
/**
|
|
22550
|
+
* Delete document.
|
|
22551
|
+
*
|
|
22552
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
22553
|
+
* @param {String} documentId Document ID.
|
|
22554
|
+
*/
|
|
22555
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
22556
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22557
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22558
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
22559
|
+
}
|
|
22560
|
+
// verify the required parameter 'documentId' is set
|
|
22561
|
+
if (documentId === undefined || documentId === null) {
|
|
22562
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
22563
|
+
}
|
|
22564
|
+
|
|
22565
|
+
return this.apiClient.callApi(
|
|
22566
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
22567
|
+
'DELETE',
|
|
22568
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
22569
|
+
{ },
|
|
22570
|
+
{ },
|
|
22571
|
+
{ },
|
|
22572
|
+
null,
|
|
22573
|
+
['PureCloud OAuth'],
|
|
22574
|
+
['application/json'],
|
|
22575
|
+
['application/json']
|
|
22576
|
+
);
|
|
22577
|
+
}
|
|
22578
|
+
|
|
22579
|
+
/**
|
|
22580
|
+
* Delete a variation for a document.
|
|
22581
|
+
*
|
|
22582
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
22583
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
22584
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
22585
|
+
*/
|
|
22586
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
22587
|
+
// verify the required parameter 'documentVariationId' is set
|
|
22588
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
22589
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22590
|
+
}
|
|
22591
|
+
// verify the required parameter 'documentId' is set
|
|
22592
|
+
if (documentId === undefined || documentId === null) {
|
|
22593
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22594
|
+
}
|
|
22595
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22596
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22597
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
22598
|
+
}
|
|
22599
|
+
|
|
22600
|
+
return this.apiClient.callApi(
|
|
22601
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
22602
|
+
'DELETE',
|
|
22603
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
22604
|
+
{ },
|
|
22605
|
+
{ },
|
|
22606
|
+
{ },
|
|
22607
|
+
null,
|
|
22608
|
+
['PureCloud OAuth'],
|
|
22609
|
+
['application/json'],
|
|
22610
|
+
['application/json']
|
|
22611
|
+
);
|
|
22612
|
+
}
|
|
22613
|
+
|
|
22614
|
+
/**
|
|
22615
|
+
* Delete export job
|
|
22616
|
+
*
|
|
22617
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22618
|
+
* @param {String} exportJobId Export job ID
|
|
22619
|
+
*/
|
|
22620
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
22621
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22622
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22623
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
22624
|
+
}
|
|
22625
|
+
// verify the required parameter 'exportJobId' is set
|
|
22626
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
22627
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
22628
|
+
}
|
|
22629
|
+
|
|
22630
|
+
return this.apiClient.callApi(
|
|
22631
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
22632
|
+
'DELETE',
|
|
22633
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
22634
|
+
{ },
|
|
22635
|
+
{ },
|
|
22636
|
+
{ },
|
|
22637
|
+
null,
|
|
22638
|
+
['PureCloud OAuth'],
|
|
22639
|
+
['application/json'],
|
|
22640
|
+
['application/json']
|
|
22641
|
+
);
|
|
22642
|
+
}
|
|
22643
|
+
|
|
22644
|
+
/**
|
|
22645
|
+
* Delete import job
|
|
22646
|
+
*
|
|
22647
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22648
|
+
* @param {String} importJobId Import job ID
|
|
22649
|
+
*/
|
|
22650
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
22651
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22652
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22653
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
22654
|
+
}
|
|
22655
|
+
// verify the required parameter 'importJobId' is set
|
|
22656
|
+
if (importJobId === undefined || importJobId === null) {
|
|
22657
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
22658
|
+
}
|
|
22659
|
+
|
|
22660
|
+
return this.apiClient.callApi(
|
|
22661
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
22662
|
+
'DELETE',
|
|
22663
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
22664
|
+
{ },
|
|
22665
|
+
{ },
|
|
22666
|
+
{ },
|
|
22667
|
+
null,
|
|
22668
|
+
['PureCloud OAuth'],
|
|
22669
|
+
['application/json'],
|
|
22670
|
+
['application/json']
|
|
22671
|
+
);
|
|
22672
|
+
}
|
|
22673
|
+
|
|
22674
|
+
/**
|
|
22675
|
+
* Delete label
|
|
22676
|
+
*
|
|
22677
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22678
|
+
* @param {String} labelId Label ID
|
|
22679
|
+
*/
|
|
22680
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
22681
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22682
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22683
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
22684
|
+
}
|
|
22685
|
+
// verify the required parameter 'labelId' is set
|
|
22686
|
+
if (labelId === undefined || labelId === null) {
|
|
22687
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
22688
|
+
}
|
|
22689
|
+
|
|
22690
|
+
return this.apiClient.callApi(
|
|
22691
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
22692
|
+
'DELETE',
|
|
22693
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
22694
|
+
{ },
|
|
22695
|
+
{ },
|
|
22696
|
+
{ },
|
|
22697
|
+
null,
|
|
22698
|
+
['PureCloud OAuth'],
|
|
22699
|
+
['application/json'],
|
|
22700
|
+
['application/json']
|
|
22701
|
+
);
|
|
22702
|
+
}
|
|
22703
|
+
|
|
22518
22704
|
/**
|
|
22519
22705
|
* Delete category
|
|
22520
22706
|
*
|
|
@@ -22620,6 +22806,104 @@ class KnowledgeApi {
|
|
|
22620
22806
|
);
|
|
22621
22807
|
}
|
|
22622
22808
|
|
|
22809
|
+
/**
|
|
22810
|
+
* Get categories
|
|
22811
|
+
*
|
|
22812
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22813
|
+
* @param {Object} opts Optional parameters
|
|
22814
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22815
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22816
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22817
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
22818
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
22819
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
22820
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
22821
|
+
* @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
|
|
22822
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
22823
|
+
*/
|
|
22824
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
22825
|
+
opts = opts || {};
|
|
22826
|
+
|
|
22827
|
+
// verify the required parameter 'sessionId' is set
|
|
22828
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22829
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
22830
|
+
}
|
|
22831
|
+
|
|
22832
|
+
return this.apiClient.callApi(
|
|
22833
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
22834
|
+
'GET',
|
|
22835
|
+
{ 'sessionId': sessionId },
|
|
22836
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
22837
|
+
{ },
|
|
22838
|
+
{ },
|
|
22839
|
+
null,
|
|
22840
|
+
['PureCloud OAuth'],
|
|
22841
|
+
['application/json'],
|
|
22842
|
+
['application/json']
|
|
22843
|
+
);
|
|
22844
|
+
}
|
|
22845
|
+
|
|
22846
|
+
/**
|
|
22847
|
+
* Get a knowledge document by ID.
|
|
22848
|
+
*
|
|
22849
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22850
|
+
* @param {String} documentId Document ID
|
|
22851
|
+
*/
|
|
22852
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
22853
|
+
// verify the required parameter 'sessionId' is set
|
|
22854
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22855
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
22856
|
+
}
|
|
22857
|
+
// verify the required parameter 'documentId' is set
|
|
22858
|
+
if (documentId === undefined || documentId === null) {
|
|
22859
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
22860
|
+
}
|
|
22861
|
+
|
|
22862
|
+
return this.apiClient.callApi(
|
|
22863
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
22864
|
+
'GET',
|
|
22865
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
22866
|
+
{ },
|
|
22867
|
+
{ },
|
|
22868
|
+
{ },
|
|
22869
|
+
null,
|
|
22870
|
+
['PureCloud OAuth'],
|
|
22871
|
+
['application/json'],
|
|
22872
|
+
['application/json']
|
|
22873
|
+
);
|
|
22874
|
+
}
|
|
22875
|
+
|
|
22876
|
+
/**
|
|
22877
|
+
* Get documents.
|
|
22878
|
+
*
|
|
22879
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
22880
|
+
* @param {Object} opts Optional parameters
|
|
22881
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
22882
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
22883
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22884
|
+
*/
|
|
22885
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
22886
|
+
opts = opts || {};
|
|
22887
|
+
|
|
22888
|
+
// verify the required parameter 'sessionId' is set
|
|
22889
|
+
if (sessionId === undefined || sessionId === null) {
|
|
22890
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
22891
|
+
}
|
|
22892
|
+
|
|
22893
|
+
return this.apiClient.callApi(
|
|
22894
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
22895
|
+
'GET',
|
|
22896
|
+
{ 'sessionId': sessionId },
|
|
22897
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
22898
|
+
{ },
|
|
22899
|
+
{ },
|
|
22900
|
+
null,
|
|
22901
|
+
['PureCloud OAuth'],
|
|
22902
|
+
['application/json'],
|
|
22903
|
+
['application/json']
|
|
22904
|
+
);
|
|
22905
|
+
}
|
|
22906
|
+
|
|
22623
22907
|
/**
|
|
22624
22908
|
* Get knowledge base
|
|
22625
22909
|
*
|
|
@@ -22645,6 +22929,501 @@ class KnowledgeApi {
|
|
|
22645
22929
|
);
|
|
22646
22930
|
}
|
|
22647
22931
|
|
|
22932
|
+
/**
|
|
22933
|
+
* Get categories
|
|
22934
|
+
*
|
|
22935
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22936
|
+
* @param {Object} opts Optional parameters
|
|
22937
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22938
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22939
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22940
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
22941
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
22942
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
22943
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
22944
|
+
* @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
|
|
22945
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
22946
|
+
*/
|
|
22947
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
22948
|
+
opts = opts || {};
|
|
22949
|
+
|
|
22950
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22951
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22952
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
22953
|
+
}
|
|
22954
|
+
|
|
22955
|
+
return this.apiClient.callApi(
|
|
22956
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
22957
|
+
'GET',
|
|
22958
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
22959
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
22960
|
+
{ },
|
|
22961
|
+
{ },
|
|
22962
|
+
null,
|
|
22963
|
+
['PureCloud OAuth'],
|
|
22964
|
+
['application/json'],
|
|
22965
|
+
['application/json']
|
|
22966
|
+
);
|
|
22967
|
+
}
|
|
22968
|
+
|
|
22969
|
+
/**
|
|
22970
|
+
* Get category
|
|
22971
|
+
*
|
|
22972
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
22973
|
+
* @param {String} categoryId Category ID
|
|
22974
|
+
*/
|
|
22975
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
22976
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
22977
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
22978
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
22979
|
+
}
|
|
22980
|
+
// verify the required parameter 'categoryId' is set
|
|
22981
|
+
if (categoryId === undefined || categoryId === null) {
|
|
22982
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
22983
|
+
}
|
|
22984
|
+
|
|
22985
|
+
return this.apiClient.callApi(
|
|
22986
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
22987
|
+
'GET',
|
|
22988
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
22989
|
+
{ },
|
|
22990
|
+
{ },
|
|
22991
|
+
{ },
|
|
22992
|
+
null,
|
|
22993
|
+
['PureCloud OAuth'],
|
|
22994
|
+
['application/json'],
|
|
22995
|
+
['application/json']
|
|
22996
|
+
);
|
|
22997
|
+
}
|
|
22998
|
+
|
|
22999
|
+
/**
|
|
23000
|
+
* Get document.
|
|
23001
|
+
*
|
|
23002
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23003
|
+
* @param {String} documentId Document ID.
|
|
23004
|
+
* @param {Object} opts Optional parameters
|
|
23005
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.
|
|
23006
|
+
* @param {Object} opts.state when state is Draft, draft version of the document is returned,otherwise by default published version is returned in the response.
|
|
23007
|
+
*/
|
|
23008
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
23009
|
+
opts = opts || {};
|
|
23010
|
+
|
|
23011
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23012
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23013
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
23014
|
+
}
|
|
23015
|
+
// verify the required parameter 'documentId' is set
|
|
23016
|
+
if (documentId === undefined || documentId === null) {
|
|
23017
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
23018
|
+
}
|
|
23019
|
+
|
|
23020
|
+
return this.apiClient.callApi(
|
|
23021
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
23022
|
+
'GET',
|
|
23023
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23024
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
23025
|
+
{ },
|
|
23026
|
+
{ },
|
|
23027
|
+
null,
|
|
23028
|
+
['PureCloud OAuth'],
|
|
23029
|
+
['application/json'],
|
|
23030
|
+
['application/json']
|
|
23031
|
+
);
|
|
23032
|
+
}
|
|
23033
|
+
|
|
23034
|
+
/**
|
|
23035
|
+
* Get a variation for a document.
|
|
23036
|
+
*
|
|
23037
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
23038
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
23039
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
23040
|
+
* @param {Object} opts Optional parameters
|
|
23041
|
+
* @param {Object} opts.documentState The state of the document.
|
|
23042
|
+
*/
|
|
23043
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
23044
|
+
opts = opts || {};
|
|
23045
|
+
|
|
23046
|
+
// verify the required parameter 'documentVariationId' is set
|
|
23047
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
23048
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23049
|
+
}
|
|
23050
|
+
// verify the required parameter 'documentId' is set
|
|
23051
|
+
if (documentId === undefined || documentId === null) {
|
|
23052
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23053
|
+
}
|
|
23054
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23055
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23056
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
23057
|
+
}
|
|
23058
|
+
|
|
23059
|
+
return this.apiClient.callApi(
|
|
23060
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
23061
|
+
'GET',
|
|
23062
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
23063
|
+
{ 'documentState': opts['documentState'] },
|
|
23064
|
+
{ },
|
|
23065
|
+
{ },
|
|
23066
|
+
null,
|
|
23067
|
+
['PureCloud OAuth'],
|
|
23068
|
+
['application/json'],
|
|
23069
|
+
['application/json']
|
|
23070
|
+
);
|
|
23071
|
+
}
|
|
23072
|
+
|
|
23073
|
+
/**
|
|
23074
|
+
* Get variations for a document.
|
|
23075
|
+
*
|
|
23076
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23077
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23078
|
+
* @param {Object} opts Optional parameters
|
|
23079
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23080
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23081
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23082
|
+
* @param {Object} opts.documentState The state of the document.
|
|
23083
|
+
*/
|
|
23084
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
23085
|
+
opts = opts || {};
|
|
23086
|
+
|
|
23087
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23088
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23089
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
23090
|
+
}
|
|
23091
|
+
// verify the required parameter 'documentId' is set
|
|
23092
|
+
if (documentId === undefined || documentId === null) {
|
|
23093
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
23094
|
+
}
|
|
23095
|
+
|
|
23096
|
+
return this.apiClient.callApi(
|
|
23097
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
23098
|
+
'GET',
|
|
23099
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23100
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
23101
|
+
{ },
|
|
23102
|
+
{ },
|
|
23103
|
+
null,
|
|
23104
|
+
['PureCloud OAuth'],
|
|
23105
|
+
['application/json'],
|
|
23106
|
+
['application/json']
|
|
23107
|
+
);
|
|
23108
|
+
}
|
|
23109
|
+
|
|
23110
|
+
/**
|
|
23111
|
+
* Get document version.
|
|
23112
|
+
*
|
|
23113
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23114
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23115
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23116
|
+
* @param {Object} opts Optional parameters
|
|
23117
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23118
|
+
*/
|
|
23119
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
23120
|
+
opts = opts || {};
|
|
23121
|
+
|
|
23122
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23123
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23124
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23125
|
+
}
|
|
23126
|
+
// verify the required parameter 'documentId' is set
|
|
23127
|
+
if (documentId === undefined || documentId === null) {
|
|
23128
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23129
|
+
}
|
|
23130
|
+
// verify the required parameter 'versionId' is set
|
|
23131
|
+
if (versionId === undefined || versionId === null) {
|
|
23132
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
23133
|
+
}
|
|
23134
|
+
|
|
23135
|
+
return this.apiClient.callApi(
|
|
23136
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
23137
|
+
'GET',
|
|
23138
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
23139
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23140
|
+
{ },
|
|
23141
|
+
{ },
|
|
23142
|
+
null,
|
|
23143
|
+
['PureCloud OAuth'],
|
|
23144
|
+
['application/json'],
|
|
23145
|
+
['application/json']
|
|
23146
|
+
);
|
|
23147
|
+
}
|
|
23148
|
+
|
|
23149
|
+
/**
|
|
23150
|
+
* Get variation for the given document version.
|
|
23151
|
+
*
|
|
23152
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23153
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23154
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23155
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
23156
|
+
*/
|
|
23157
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
23158
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23159
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23160
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23161
|
+
}
|
|
23162
|
+
// verify the required parameter 'documentId' is set
|
|
23163
|
+
if (documentId === undefined || documentId === null) {
|
|
23164
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23165
|
+
}
|
|
23166
|
+
// verify the required parameter 'versionId' is set
|
|
23167
|
+
if (versionId === undefined || versionId === null) {
|
|
23168
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23169
|
+
}
|
|
23170
|
+
// verify the required parameter 'variationId' is set
|
|
23171
|
+
if (variationId === undefined || variationId === null) {
|
|
23172
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
23173
|
+
}
|
|
23174
|
+
|
|
23175
|
+
return this.apiClient.callApi(
|
|
23176
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
23177
|
+
'GET',
|
|
23178
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
23179
|
+
{ },
|
|
23180
|
+
{ },
|
|
23181
|
+
{ },
|
|
23182
|
+
null,
|
|
23183
|
+
['PureCloud OAuth'],
|
|
23184
|
+
['application/json'],
|
|
23185
|
+
['application/json']
|
|
23186
|
+
);
|
|
23187
|
+
}
|
|
23188
|
+
|
|
23189
|
+
/**
|
|
23190
|
+
* Get variations for the given document version.
|
|
23191
|
+
*
|
|
23192
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23193
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23194
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
23195
|
+
* @param {Object} opts Optional parameters
|
|
23196
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23197
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23198
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23199
|
+
*/
|
|
23200
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
23201
|
+
opts = opts || {};
|
|
23202
|
+
|
|
23203
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23204
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23205
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23206
|
+
}
|
|
23207
|
+
// verify the required parameter 'documentId' is set
|
|
23208
|
+
if (documentId === undefined || documentId === null) {
|
|
23209
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23210
|
+
}
|
|
23211
|
+
// verify the required parameter 'versionId' is set
|
|
23212
|
+
if (versionId === undefined || versionId === null) {
|
|
23213
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
23214
|
+
}
|
|
23215
|
+
|
|
23216
|
+
return this.apiClient.callApi(
|
|
23217
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
23218
|
+
'GET',
|
|
23219
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
23220
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
23221
|
+
{ },
|
|
23222
|
+
{ },
|
|
23223
|
+
null,
|
|
23224
|
+
['PureCloud OAuth'],
|
|
23225
|
+
['application/json'],
|
|
23226
|
+
['application/json']
|
|
23227
|
+
);
|
|
23228
|
+
}
|
|
23229
|
+
|
|
23230
|
+
/**
|
|
23231
|
+
* Get document versions.
|
|
23232
|
+
*
|
|
23233
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
23234
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
23235
|
+
* @param {Object} opts Optional parameters
|
|
23236
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23237
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23238
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23239
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23240
|
+
*/
|
|
23241
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
23242
|
+
opts = opts || {};
|
|
23243
|
+
|
|
23244
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23245
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23246
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
23247
|
+
}
|
|
23248
|
+
// verify the required parameter 'documentId' is set
|
|
23249
|
+
if (documentId === undefined || documentId === null) {
|
|
23250
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
23251
|
+
}
|
|
23252
|
+
|
|
23253
|
+
return this.apiClient.callApi(
|
|
23254
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
23255
|
+
'GET',
|
|
23256
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23257
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23258
|
+
{ },
|
|
23259
|
+
{ },
|
|
23260
|
+
null,
|
|
23261
|
+
['PureCloud OAuth'],
|
|
23262
|
+
['application/json'],
|
|
23263
|
+
['application/json']
|
|
23264
|
+
);
|
|
23265
|
+
}
|
|
23266
|
+
|
|
23267
|
+
/**
|
|
23268
|
+
* Get documents.
|
|
23269
|
+
*
|
|
23270
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23271
|
+
* @param {Object} opts Optional parameters
|
|
23272
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23273
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23274
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23275
|
+
* @param {String} opts.interval Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
23276
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
23277
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
23278
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
23279
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
23280
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23281
|
+
*/
|
|
23282
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
23283
|
+
opts = opts || {};
|
|
23284
|
+
|
|
23285
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23286
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23287
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
23288
|
+
}
|
|
23289
|
+
|
|
23290
|
+
return this.apiClient.callApi(
|
|
23291
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
23292
|
+
'GET',
|
|
23293
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23294
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
23295
|
+
{ },
|
|
23296
|
+
{ },
|
|
23297
|
+
null,
|
|
23298
|
+
['PureCloud OAuth'],
|
|
23299
|
+
['application/json'],
|
|
23300
|
+
['application/json']
|
|
23301
|
+
);
|
|
23302
|
+
}
|
|
23303
|
+
|
|
23304
|
+
/**
|
|
23305
|
+
* Get export job report
|
|
23306
|
+
*
|
|
23307
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23308
|
+
* @param {String} exportJobId Export job ID
|
|
23309
|
+
*/
|
|
23310
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
23311
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23312
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23313
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
23314
|
+
}
|
|
23315
|
+
// verify the required parameter 'exportJobId' is set
|
|
23316
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
23317
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
23318
|
+
}
|
|
23319
|
+
|
|
23320
|
+
return this.apiClient.callApi(
|
|
23321
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
23322
|
+
'GET',
|
|
23323
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
23324
|
+
{ },
|
|
23325
|
+
{ },
|
|
23326
|
+
{ },
|
|
23327
|
+
null,
|
|
23328
|
+
['PureCloud OAuth'],
|
|
23329
|
+
['application/json'],
|
|
23330
|
+
['application/json']
|
|
23331
|
+
);
|
|
23332
|
+
}
|
|
23333
|
+
|
|
23334
|
+
/**
|
|
23335
|
+
* Get import job report
|
|
23336
|
+
*
|
|
23337
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23338
|
+
* @param {String} importJobId Import job ID
|
|
23339
|
+
*/
|
|
23340
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
23341
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23342
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23343
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
23344
|
+
}
|
|
23345
|
+
// verify the required parameter 'importJobId' is set
|
|
23346
|
+
if (importJobId === undefined || importJobId === null) {
|
|
23347
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
23348
|
+
}
|
|
23349
|
+
|
|
23350
|
+
return this.apiClient.callApi(
|
|
23351
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
23352
|
+
'GET',
|
|
23353
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
23354
|
+
{ },
|
|
23355
|
+
{ },
|
|
23356
|
+
{ },
|
|
23357
|
+
null,
|
|
23358
|
+
['PureCloud OAuth'],
|
|
23359
|
+
['application/json'],
|
|
23360
|
+
['application/json']
|
|
23361
|
+
);
|
|
23362
|
+
}
|
|
23363
|
+
|
|
23364
|
+
/**
|
|
23365
|
+
* Get label
|
|
23366
|
+
*
|
|
23367
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23368
|
+
* @param {String} labelId Label ID
|
|
23369
|
+
*/
|
|
23370
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
23371
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23372
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23373
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
23374
|
+
}
|
|
23375
|
+
// verify the required parameter 'labelId' is set
|
|
23376
|
+
if (labelId === undefined || labelId === null) {
|
|
23377
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
23378
|
+
}
|
|
23379
|
+
|
|
23380
|
+
return this.apiClient.callApi(
|
|
23381
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
23382
|
+
'GET',
|
|
23383
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
23384
|
+
{ },
|
|
23385
|
+
{ },
|
|
23386
|
+
{ },
|
|
23387
|
+
null,
|
|
23388
|
+
['PureCloud OAuth'],
|
|
23389
|
+
['application/json'],
|
|
23390
|
+
['application/json']
|
|
23391
|
+
);
|
|
23392
|
+
}
|
|
23393
|
+
|
|
23394
|
+
/**
|
|
23395
|
+
* Get labels
|
|
23396
|
+
*
|
|
23397
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23398
|
+
* @param {Object} opts Optional parameters
|
|
23399
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23400
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23401
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23402
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
23403
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
23404
|
+
*/
|
|
23405
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
23406
|
+
opts = opts || {};
|
|
23407
|
+
|
|
23408
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23409
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23410
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
23411
|
+
}
|
|
23412
|
+
|
|
23413
|
+
return this.apiClient.callApi(
|
|
23414
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
23415
|
+
'GET',
|
|
23416
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23417
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
23418
|
+
{ },
|
|
23419
|
+
{ },
|
|
23420
|
+
null,
|
|
23421
|
+
['PureCloud OAuth'],
|
|
23422
|
+
['application/json'],
|
|
23423
|
+
['application/json']
|
|
23424
|
+
);
|
|
23425
|
+
}
|
|
23426
|
+
|
|
22648
23427
|
/**
|
|
22649
23428
|
* Get categories
|
|
22650
23429
|
*
|
|
@@ -22903,6 +23682,108 @@ class KnowledgeApi {
|
|
|
22903
23682
|
);
|
|
22904
23683
|
}
|
|
22905
23684
|
|
|
23685
|
+
/**
|
|
23686
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
23687
|
+
*
|
|
23688
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23689
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
23690
|
+
* @param {Object} opts Optional parameters
|
|
23691
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23692
|
+
*/
|
|
23693
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
23694
|
+
opts = opts || {};
|
|
23695
|
+
|
|
23696
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23697
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23698
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
23699
|
+
}
|
|
23700
|
+
// verify the required parameter 'groupId' is set
|
|
23701
|
+
if (groupId === undefined || groupId === null) {
|
|
23702
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
23703
|
+
}
|
|
23704
|
+
|
|
23705
|
+
return this.apiClient.callApi(
|
|
23706
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
23707
|
+
'GET',
|
|
23708
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
23709
|
+
{ 'app': opts['app'] },
|
|
23710
|
+
{ },
|
|
23711
|
+
{ },
|
|
23712
|
+
null,
|
|
23713
|
+
['PureCloud OAuth'],
|
|
23714
|
+
['application/json'],
|
|
23715
|
+
['application/json']
|
|
23716
|
+
);
|
|
23717
|
+
}
|
|
23718
|
+
|
|
23719
|
+
/**
|
|
23720
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
23721
|
+
*
|
|
23722
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23723
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
23724
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
23725
|
+
* @param {Object} opts Optional parameters
|
|
23726
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23727
|
+
*/
|
|
23728
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
23729
|
+
opts = opts || {};
|
|
23730
|
+
|
|
23731
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23732
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23733
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23734
|
+
}
|
|
23735
|
+
// verify the required parameter 'groupId' is set
|
|
23736
|
+
if (groupId === undefined || groupId === null) {
|
|
23737
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23738
|
+
}
|
|
23739
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
23740
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
23741
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
23742
|
+
}
|
|
23743
|
+
|
|
23744
|
+
return this.apiClient.callApi(
|
|
23745
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
23746
|
+
'GET',
|
|
23747
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
23748
|
+
{ 'app': opts['app'] },
|
|
23749
|
+
{ },
|
|
23750
|
+
{ },
|
|
23751
|
+
null,
|
|
23752
|
+
['PureCloud OAuth'],
|
|
23753
|
+
['application/json'],
|
|
23754
|
+
['application/json']
|
|
23755
|
+
);
|
|
23756
|
+
}
|
|
23757
|
+
|
|
23758
|
+
/**
|
|
23759
|
+
* Get knowledge base unanswered groups
|
|
23760
|
+
*
|
|
23761
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23762
|
+
* @param {Object} opts Optional parameters
|
|
23763
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
23764
|
+
*/
|
|
23765
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
23766
|
+
opts = opts || {};
|
|
23767
|
+
|
|
23768
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23769
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23770
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
23771
|
+
}
|
|
23772
|
+
|
|
23773
|
+
return this.apiClient.callApi(
|
|
23774
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
23775
|
+
'GET',
|
|
23776
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
23777
|
+
{ 'app': opts['app'] },
|
|
23778
|
+
{ },
|
|
23779
|
+
{ },
|
|
23780
|
+
null,
|
|
23781
|
+
['PureCloud OAuth'],
|
|
23782
|
+
['application/json'],
|
|
23783
|
+
['application/json']
|
|
23784
|
+
);
|
|
23785
|
+
}
|
|
23786
|
+
|
|
22906
23787
|
/**
|
|
22907
23788
|
* Get knowledge bases
|
|
22908
23789
|
*
|
|
@@ -22935,6 +23816,41 @@ class KnowledgeApi {
|
|
|
22935
23816
|
);
|
|
22936
23817
|
}
|
|
22937
23818
|
|
|
23819
|
+
/**
|
|
23820
|
+
* Update search result.
|
|
23821
|
+
*
|
|
23822
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
23823
|
+
* @param {String} searchId Search Result ID
|
|
23824
|
+
* @param {Object} body
|
|
23825
|
+
*/
|
|
23826
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
23827
|
+
// verify the required parameter 'sessionId' is set
|
|
23828
|
+
if (sessionId === undefined || sessionId === null) {
|
|
23829
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23830
|
+
}
|
|
23831
|
+
// verify the required parameter 'searchId' is set
|
|
23832
|
+
if (searchId === undefined || searchId === null) {
|
|
23833
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23834
|
+
}
|
|
23835
|
+
// verify the required parameter 'body' is set
|
|
23836
|
+
if (body === undefined || body === null) {
|
|
23837
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
23838
|
+
}
|
|
23839
|
+
|
|
23840
|
+
return this.apiClient.callApi(
|
|
23841
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
23842
|
+
'PATCH',
|
|
23843
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
23844
|
+
{ },
|
|
23845
|
+
{ },
|
|
23846
|
+
{ },
|
|
23847
|
+
body,
|
|
23848
|
+
['PureCloud OAuth'],
|
|
23849
|
+
['application/json'],
|
|
23850
|
+
['application/json']
|
|
23851
|
+
);
|
|
23852
|
+
}
|
|
23853
|
+
|
|
22938
23854
|
/**
|
|
22939
23855
|
* Update knowledge base
|
|
22940
23856
|
*
|
|
@@ -22965,6 +23881,220 @@ class KnowledgeApi {
|
|
|
22965
23881
|
);
|
|
22966
23882
|
}
|
|
22967
23883
|
|
|
23884
|
+
/**
|
|
23885
|
+
* Update category
|
|
23886
|
+
*
|
|
23887
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23888
|
+
* @param {String} categoryId Category ID
|
|
23889
|
+
* @param {Object} body
|
|
23890
|
+
*/
|
|
23891
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
23892
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23893
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23894
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23895
|
+
}
|
|
23896
|
+
// verify the required parameter 'categoryId' is set
|
|
23897
|
+
if (categoryId === undefined || categoryId === null) {
|
|
23898
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23899
|
+
}
|
|
23900
|
+
// verify the required parameter 'body' is set
|
|
23901
|
+
if (body === undefined || body === null) {
|
|
23902
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
23903
|
+
}
|
|
23904
|
+
|
|
23905
|
+
return this.apiClient.callApi(
|
|
23906
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
23907
|
+
'PATCH',
|
|
23908
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
23909
|
+
{ },
|
|
23910
|
+
{ },
|
|
23911
|
+
{ },
|
|
23912
|
+
body,
|
|
23913
|
+
['PureCloud OAuth'],
|
|
23914
|
+
['application/json'],
|
|
23915
|
+
['application/json']
|
|
23916
|
+
);
|
|
23917
|
+
}
|
|
23918
|
+
|
|
23919
|
+
/**
|
|
23920
|
+
* Update document.
|
|
23921
|
+
*
|
|
23922
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
23923
|
+
* @param {String} documentId Document ID.
|
|
23924
|
+
* @param {Object} body
|
|
23925
|
+
*/
|
|
23926
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
23927
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23928
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23929
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23930
|
+
}
|
|
23931
|
+
// verify the required parameter 'documentId' is set
|
|
23932
|
+
if (documentId === undefined || documentId === null) {
|
|
23933
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23934
|
+
}
|
|
23935
|
+
// verify the required parameter 'body' is set
|
|
23936
|
+
if (body === undefined || body === null) {
|
|
23937
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
23938
|
+
}
|
|
23939
|
+
|
|
23940
|
+
return this.apiClient.callApi(
|
|
23941
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
23942
|
+
'PATCH',
|
|
23943
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
23944
|
+
{ },
|
|
23945
|
+
{ },
|
|
23946
|
+
{ },
|
|
23947
|
+
body,
|
|
23948
|
+
['PureCloud OAuth'],
|
|
23949
|
+
['application/json'],
|
|
23950
|
+
['application/json']
|
|
23951
|
+
);
|
|
23952
|
+
}
|
|
23953
|
+
|
|
23954
|
+
/**
|
|
23955
|
+
* Update a variation for a document.
|
|
23956
|
+
*
|
|
23957
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
23958
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
23959
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
23960
|
+
* @param {Object} body
|
|
23961
|
+
*/
|
|
23962
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
23963
|
+
// verify the required parameter 'documentVariationId' is set
|
|
23964
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
23965
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23966
|
+
}
|
|
23967
|
+
// verify the required parameter 'documentId' is set
|
|
23968
|
+
if (documentId === undefined || documentId === null) {
|
|
23969
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23970
|
+
}
|
|
23971
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
23972
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
23973
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23974
|
+
}
|
|
23975
|
+
// verify the required parameter 'body' is set
|
|
23976
|
+
if (body === undefined || body === null) {
|
|
23977
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
23978
|
+
}
|
|
23979
|
+
|
|
23980
|
+
return this.apiClient.callApi(
|
|
23981
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
23982
|
+
'PATCH',
|
|
23983
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
23984
|
+
{ },
|
|
23985
|
+
{ },
|
|
23986
|
+
{ },
|
|
23987
|
+
body,
|
|
23988
|
+
['PureCloud OAuth'],
|
|
23989
|
+
['application/json'],
|
|
23990
|
+
['application/json']
|
|
23991
|
+
);
|
|
23992
|
+
}
|
|
23993
|
+
|
|
23994
|
+
/**
|
|
23995
|
+
* Update search result.
|
|
23996
|
+
*
|
|
23997
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
23998
|
+
* @param {String} searchId Search Result ID
|
|
23999
|
+
* @param {Object} opts Optional parameters
|
|
24000
|
+
* @param {Object} opts.body
|
|
24001
|
+
*/
|
|
24002
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
24003
|
+
opts = opts || {};
|
|
24004
|
+
|
|
24005
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24006
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24007
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
24008
|
+
}
|
|
24009
|
+
// verify the required parameter 'searchId' is set
|
|
24010
|
+
if (searchId === undefined || searchId === null) {
|
|
24011
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
24012
|
+
}
|
|
24013
|
+
|
|
24014
|
+
return this.apiClient.callApi(
|
|
24015
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
24016
|
+
'PATCH',
|
|
24017
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
24018
|
+
{ },
|
|
24019
|
+
{ },
|
|
24020
|
+
{ },
|
|
24021
|
+
opts['body'],
|
|
24022
|
+
['PureCloud OAuth'],
|
|
24023
|
+
['application/json'],
|
|
24024
|
+
['application/json']
|
|
24025
|
+
);
|
|
24026
|
+
}
|
|
24027
|
+
|
|
24028
|
+
/**
|
|
24029
|
+
* Start import job
|
|
24030
|
+
*
|
|
24031
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24032
|
+
* @param {String} importJobId Import job ID
|
|
24033
|
+
* @param {Object} body
|
|
24034
|
+
*/
|
|
24035
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
24036
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24037
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24038
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24039
|
+
}
|
|
24040
|
+
// verify the required parameter 'importJobId' is set
|
|
24041
|
+
if (importJobId === undefined || importJobId === null) {
|
|
24042
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24043
|
+
}
|
|
24044
|
+
// verify the required parameter 'body' is set
|
|
24045
|
+
if (body === undefined || body === null) {
|
|
24046
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
24047
|
+
}
|
|
24048
|
+
|
|
24049
|
+
return this.apiClient.callApi(
|
|
24050
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
24051
|
+
'PATCH',
|
|
24052
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
24053
|
+
{ },
|
|
24054
|
+
{ },
|
|
24055
|
+
{ },
|
|
24056
|
+
body,
|
|
24057
|
+
['PureCloud OAuth'],
|
|
24058
|
+
['application/json'],
|
|
24059
|
+
['application/json']
|
|
24060
|
+
);
|
|
24061
|
+
}
|
|
24062
|
+
|
|
24063
|
+
/**
|
|
24064
|
+
* Update label
|
|
24065
|
+
*
|
|
24066
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24067
|
+
* @param {String} labelId Label ID
|
|
24068
|
+
* @param {Object} body
|
|
24069
|
+
*/
|
|
24070
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
24071
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24072
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24073
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24074
|
+
}
|
|
24075
|
+
// verify the required parameter 'labelId' is set
|
|
24076
|
+
if (labelId === undefined || labelId === null) {
|
|
24077
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24078
|
+
}
|
|
24079
|
+
// verify the required parameter 'body' is set
|
|
24080
|
+
if (body === undefined || body === null) {
|
|
24081
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
24082
|
+
}
|
|
24083
|
+
|
|
24084
|
+
return this.apiClient.callApi(
|
|
24085
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
24086
|
+
'PATCH',
|
|
24087
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
24088
|
+
{ },
|
|
24089
|
+
{ },
|
|
24090
|
+
{ },
|
|
24091
|
+
body,
|
|
24092
|
+
['PureCloud OAuth'],
|
|
24093
|
+
['application/json'],
|
|
24094
|
+
['application/json']
|
|
24095
|
+
);
|
|
24096
|
+
}
|
|
24097
|
+
|
|
22968
24098
|
/**
|
|
22969
24099
|
* Update category
|
|
22970
24100
|
*
|
|
@@ -23120,6 +24250,46 @@ class KnowledgeApi {
|
|
|
23120
24250
|
);
|
|
23121
24251
|
}
|
|
23122
24252
|
|
|
24253
|
+
/**
|
|
24254
|
+
* Update a Knowledge base unanswered phrase group
|
|
24255
|
+
*
|
|
24256
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24257
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
24258
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
24259
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
24260
|
+
*/
|
|
24261
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
24262
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24263
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24264
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24265
|
+
}
|
|
24266
|
+
// verify the required parameter 'groupId' is set
|
|
24267
|
+
if (groupId === undefined || groupId === null) {
|
|
24268
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24269
|
+
}
|
|
24270
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
24271
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
24272
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24273
|
+
}
|
|
24274
|
+
// verify the required parameter 'body' is set
|
|
24275
|
+
if (body === undefined || body === null) {
|
|
24276
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
24277
|
+
}
|
|
24278
|
+
|
|
24279
|
+
return this.apiClient.callApi(
|
|
24280
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
24281
|
+
'PATCH',
|
|
24282
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
24283
|
+
{ },
|
|
24284
|
+
{ },
|
|
24285
|
+
{ },
|
|
24286
|
+
body,
|
|
24287
|
+
['PureCloud OAuth'],
|
|
24288
|
+
['application/json'],
|
|
24289
|
+
['application/json']
|
|
24290
|
+
);
|
|
24291
|
+
}
|
|
24292
|
+
|
|
23123
24293
|
/**
|
|
23124
24294
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
23125
24295
|
*
|
|
@@ -23145,6 +24315,369 @@ class KnowledgeApi {
|
|
|
23145
24315
|
);
|
|
23146
24316
|
}
|
|
23147
24317
|
|
|
24318
|
+
/**
|
|
24319
|
+
* Search the documents in a guest session.
|
|
24320
|
+
*
|
|
24321
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24322
|
+
* @param {Object} opts Optional parameters
|
|
24323
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
24324
|
+
* @param {Object} opts.body
|
|
24325
|
+
*/
|
|
24326
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
24327
|
+
opts = opts || {};
|
|
24328
|
+
|
|
24329
|
+
// verify the required parameter 'sessionId' is set
|
|
24330
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24331
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
24332
|
+
}
|
|
24333
|
+
|
|
24334
|
+
return this.apiClient.callApi(
|
|
24335
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
24336
|
+
'POST',
|
|
24337
|
+
{ 'sessionId': sessionId },
|
|
24338
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24339
|
+
{ },
|
|
24340
|
+
{ },
|
|
24341
|
+
opts['body'],
|
|
24342
|
+
['PureCloud OAuth'],
|
|
24343
|
+
['application/json'],
|
|
24344
|
+
['application/json']
|
|
24345
|
+
);
|
|
24346
|
+
}
|
|
24347
|
+
|
|
24348
|
+
/**
|
|
24349
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
24350
|
+
*
|
|
24351
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24352
|
+
* @param {Object} opts Optional parameters
|
|
24353
|
+
* @param {Object} opts.body
|
|
24354
|
+
*/
|
|
24355
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
24356
|
+
opts = opts || {};
|
|
24357
|
+
|
|
24358
|
+
// verify the required parameter 'sessionId' is set
|
|
24359
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24360
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
24361
|
+
}
|
|
24362
|
+
|
|
24363
|
+
return this.apiClient.callApi(
|
|
24364
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
24365
|
+
'POST',
|
|
24366
|
+
{ 'sessionId': sessionId },
|
|
24367
|
+
{ },
|
|
24368
|
+
{ },
|
|
24369
|
+
{ },
|
|
24370
|
+
opts['body'],
|
|
24371
|
+
['PureCloud OAuth'],
|
|
24372
|
+
['application/json'],
|
|
24373
|
+
['application/json']
|
|
24374
|
+
);
|
|
24375
|
+
}
|
|
24376
|
+
|
|
24377
|
+
/**
|
|
24378
|
+
* Create guest session
|
|
24379
|
+
*
|
|
24380
|
+
* @param {Object} body
|
|
24381
|
+
*/
|
|
24382
|
+
postKnowledgeGuestSessions(body) {
|
|
24383
|
+
// verify the required parameter 'body' is set
|
|
24384
|
+
if (body === undefined || body === null) {
|
|
24385
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
24386
|
+
}
|
|
24387
|
+
|
|
24388
|
+
return this.apiClient.callApi(
|
|
24389
|
+
'/api/v2/knowledge/guest/sessions',
|
|
24390
|
+
'POST',
|
|
24391
|
+
{ },
|
|
24392
|
+
{ },
|
|
24393
|
+
{ },
|
|
24394
|
+
{ },
|
|
24395
|
+
body,
|
|
24396
|
+
['PureCloud OAuth'],
|
|
24397
|
+
['application/json'],
|
|
24398
|
+
['application/json']
|
|
24399
|
+
);
|
|
24400
|
+
}
|
|
24401
|
+
|
|
24402
|
+
/**
|
|
24403
|
+
* Create new category
|
|
24404
|
+
*
|
|
24405
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24406
|
+
* @param {Object} body
|
|
24407
|
+
*/
|
|
24408
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
24409
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24410
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24411
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
24412
|
+
}
|
|
24413
|
+
// verify the required parameter 'body' is set
|
|
24414
|
+
if (body === undefined || body === null) {
|
|
24415
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
24416
|
+
}
|
|
24417
|
+
|
|
24418
|
+
return this.apiClient.callApi(
|
|
24419
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
24420
|
+
'POST',
|
|
24421
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24422
|
+
{ },
|
|
24423
|
+
{ },
|
|
24424
|
+
{ },
|
|
24425
|
+
body,
|
|
24426
|
+
['PureCloud OAuth'],
|
|
24427
|
+
['application/json'],
|
|
24428
|
+
['application/json']
|
|
24429
|
+
);
|
|
24430
|
+
}
|
|
24431
|
+
|
|
24432
|
+
/**
|
|
24433
|
+
* Create a variation for a document.
|
|
24434
|
+
*
|
|
24435
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24436
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24437
|
+
* @param {Object} body
|
|
24438
|
+
*/
|
|
24439
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
24440
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24441
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24442
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24443
|
+
}
|
|
24444
|
+
// verify the required parameter 'documentId' is set
|
|
24445
|
+
if (documentId === undefined || documentId === null) {
|
|
24446
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24447
|
+
}
|
|
24448
|
+
// verify the required parameter 'body' is set
|
|
24449
|
+
if (body === undefined || body === null) {
|
|
24450
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
24451
|
+
}
|
|
24452
|
+
|
|
24453
|
+
return this.apiClient.callApi(
|
|
24454
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
24455
|
+
'POST',
|
|
24456
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24457
|
+
{ },
|
|
24458
|
+
{ },
|
|
24459
|
+
{ },
|
|
24460
|
+
body,
|
|
24461
|
+
['PureCloud OAuth'],
|
|
24462
|
+
['application/json'],
|
|
24463
|
+
['application/json']
|
|
24464
|
+
);
|
|
24465
|
+
}
|
|
24466
|
+
|
|
24467
|
+
/**
|
|
24468
|
+
* Creates or restores a document version.
|
|
24469
|
+
*
|
|
24470
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24471
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24472
|
+
* @param {Object} body
|
|
24473
|
+
*/
|
|
24474
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
24475
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24476
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24477
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24478
|
+
}
|
|
24479
|
+
// verify the required parameter 'documentId' is set
|
|
24480
|
+
if (documentId === undefined || documentId === null) {
|
|
24481
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24482
|
+
}
|
|
24483
|
+
// verify the required parameter 'body' is set
|
|
24484
|
+
if (body === undefined || body === null) {
|
|
24485
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
24486
|
+
}
|
|
24487
|
+
|
|
24488
|
+
return this.apiClient.callApi(
|
|
24489
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
24490
|
+
'POST',
|
|
24491
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24492
|
+
{ },
|
|
24493
|
+
{ },
|
|
24494
|
+
{ },
|
|
24495
|
+
body,
|
|
24496
|
+
['PureCloud OAuth'],
|
|
24497
|
+
['application/json'],
|
|
24498
|
+
['application/json']
|
|
24499
|
+
);
|
|
24500
|
+
}
|
|
24501
|
+
|
|
24502
|
+
/**
|
|
24503
|
+
* Create document.
|
|
24504
|
+
*
|
|
24505
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24506
|
+
* @param {Object} body
|
|
24507
|
+
*/
|
|
24508
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
24509
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24510
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24511
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
24512
|
+
}
|
|
24513
|
+
// verify the required parameter 'body' is set
|
|
24514
|
+
if (body === undefined || body === null) {
|
|
24515
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
24516
|
+
}
|
|
24517
|
+
|
|
24518
|
+
return this.apiClient.callApi(
|
|
24519
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
24520
|
+
'POST',
|
|
24521
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24522
|
+
{ },
|
|
24523
|
+
{ },
|
|
24524
|
+
{ },
|
|
24525
|
+
body,
|
|
24526
|
+
['PureCloud OAuth'],
|
|
24527
|
+
['application/json'],
|
|
24528
|
+
['application/json']
|
|
24529
|
+
);
|
|
24530
|
+
}
|
|
24531
|
+
|
|
24532
|
+
/**
|
|
24533
|
+
* Search the documents in a knowledge base.
|
|
24534
|
+
*
|
|
24535
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
24536
|
+
* @param {Object} opts Optional parameters
|
|
24537
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
24538
|
+
* @param {Object} opts.body
|
|
24539
|
+
*/
|
|
24540
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
24541
|
+
opts = opts || {};
|
|
24542
|
+
|
|
24543
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24544
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24545
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
24546
|
+
}
|
|
24547
|
+
|
|
24548
|
+
return this.apiClient.callApi(
|
|
24549
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
24550
|
+
'POST',
|
|
24551
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24552
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24553
|
+
{ },
|
|
24554
|
+
{ },
|
|
24555
|
+
opts['body'],
|
|
24556
|
+
['PureCloud OAuth'],
|
|
24557
|
+
['application/json'],
|
|
24558
|
+
['application/json']
|
|
24559
|
+
);
|
|
24560
|
+
}
|
|
24561
|
+
|
|
24562
|
+
/**
|
|
24563
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
24564
|
+
*
|
|
24565
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
24566
|
+
* @param {Object} opts Optional parameters
|
|
24567
|
+
* @param {Object} opts.body
|
|
24568
|
+
*/
|
|
24569
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
24570
|
+
opts = opts || {};
|
|
24571
|
+
|
|
24572
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24573
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24574
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
24575
|
+
}
|
|
24576
|
+
|
|
24577
|
+
return this.apiClient.callApi(
|
|
24578
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
24579
|
+
'POST',
|
|
24580
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24581
|
+
{ },
|
|
24582
|
+
{ },
|
|
24583
|
+
{ },
|
|
24584
|
+
opts['body'],
|
|
24585
|
+
['PureCloud OAuth'],
|
|
24586
|
+
['application/json'],
|
|
24587
|
+
['application/json']
|
|
24588
|
+
);
|
|
24589
|
+
}
|
|
24590
|
+
|
|
24591
|
+
/**
|
|
24592
|
+
* Create export job
|
|
24593
|
+
*
|
|
24594
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24595
|
+
* @param {Object} body
|
|
24596
|
+
*/
|
|
24597
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
24598
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24599
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24600
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
24601
|
+
}
|
|
24602
|
+
// verify the required parameter 'body' is set
|
|
24603
|
+
if (body === undefined || body === null) {
|
|
24604
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
24605
|
+
}
|
|
24606
|
+
|
|
24607
|
+
return this.apiClient.callApi(
|
|
24608
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
24609
|
+
'POST',
|
|
24610
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24611
|
+
{ },
|
|
24612
|
+
{ },
|
|
24613
|
+
{ },
|
|
24614
|
+
body,
|
|
24615
|
+
['PureCloud OAuth'],
|
|
24616
|
+
['application/json'],
|
|
24617
|
+
['application/json']
|
|
24618
|
+
);
|
|
24619
|
+
}
|
|
24620
|
+
|
|
24621
|
+
/**
|
|
24622
|
+
* Create import job
|
|
24623
|
+
*
|
|
24624
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24625
|
+
* @param {Object} body
|
|
24626
|
+
*/
|
|
24627
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
24628
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24629
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24630
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
24631
|
+
}
|
|
24632
|
+
// verify the required parameter 'body' is set
|
|
24633
|
+
if (body === undefined || body === null) {
|
|
24634
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
24635
|
+
}
|
|
24636
|
+
|
|
24637
|
+
return this.apiClient.callApi(
|
|
24638
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
24639
|
+
'POST',
|
|
24640
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24641
|
+
{ },
|
|
24642
|
+
{ },
|
|
24643
|
+
{ },
|
|
24644
|
+
body,
|
|
24645
|
+
['PureCloud OAuth'],
|
|
24646
|
+
['application/json'],
|
|
24647
|
+
['application/json']
|
|
24648
|
+
);
|
|
24649
|
+
}
|
|
24650
|
+
|
|
24651
|
+
/**
|
|
24652
|
+
* Create new label
|
|
24653
|
+
*
|
|
24654
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24655
|
+
* @param {Object} body
|
|
24656
|
+
*/
|
|
24657
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
24658
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24659
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24660
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
24661
|
+
}
|
|
24662
|
+
// verify the required parameter 'body' is set
|
|
24663
|
+
if (body === undefined || body === null) {
|
|
24664
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
24665
|
+
}
|
|
24666
|
+
|
|
24667
|
+
return this.apiClient.callApi(
|
|
24668
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
24669
|
+
'POST',
|
|
24670
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24671
|
+
{ },
|
|
24672
|
+
{ },
|
|
24673
|
+
{ },
|
|
24674
|
+
body,
|
|
24675
|
+
['PureCloud OAuth'],
|
|
24676
|
+
['application/json'],
|
|
24677
|
+
['application/json']
|
|
24678
|
+
);
|
|
24679
|
+
}
|
|
24680
|
+
|
|
23148
24681
|
/**
|
|
23149
24682
|
* Create new category
|
|
23150
24683
|
*
|
|
@@ -23375,7 +24908,7 @@ class LanguageUnderstandingApi {
|
|
|
23375
24908
|
/**
|
|
23376
24909
|
* LanguageUnderstanding service.
|
|
23377
24910
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
23378
|
-
* @version
|
|
24911
|
+
* @version 146.0.0
|
|
23379
24912
|
*/
|
|
23380
24913
|
|
|
23381
24914
|
/**
|
|
@@ -24279,7 +25812,7 @@ class LanguagesApi {
|
|
|
24279
25812
|
/**
|
|
24280
25813
|
* Languages service.
|
|
24281
25814
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24282
|
-
* @version
|
|
25815
|
+
* @version 146.0.0
|
|
24283
25816
|
*/
|
|
24284
25817
|
|
|
24285
25818
|
/**
|
|
@@ -24547,7 +26080,7 @@ class LearningApi {
|
|
|
24547
26080
|
/**
|
|
24548
26081
|
* Learning service.
|
|
24549
26082
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
24550
|
-
* @version
|
|
26083
|
+
* @version 146.0.0
|
|
24551
26084
|
*/
|
|
24552
26085
|
|
|
24553
26086
|
/**
|
|
@@ -25307,7 +26840,7 @@ class LicenseApi {
|
|
|
25307
26840
|
/**
|
|
25308
26841
|
* License service.
|
|
25309
26842
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
25310
|
-
* @version
|
|
26843
|
+
* @version 146.0.0
|
|
25311
26844
|
*/
|
|
25312
26845
|
|
|
25313
26846
|
/**
|
|
@@ -25545,7 +27078,7 @@ class LocationsApi {
|
|
|
25545
27078
|
/**
|
|
25546
27079
|
* Locations service.
|
|
25547
27080
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25548
|
-
* @version
|
|
27081
|
+
* @version 146.0.0
|
|
25549
27082
|
*/
|
|
25550
27083
|
|
|
25551
27084
|
/**
|
|
@@ -25781,7 +27314,7 @@ class MessagingApi {
|
|
|
25781
27314
|
/**
|
|
25782
27315
|
* Messaging service.
|
|
25783
27316
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
25784
|
-
* @version
|
|
27317
|
+
* @version 146.0.0
|
|
25785
27318
|
*/
|
|
25786
27319
|
|
|
25787
27320
|
/**
|
|
@@ -25932,7 +27465,7 @@ class MobileDevicesApi {
|
|
|
25932
27465
|
/**
|
|
25933
27466
|
* MobileDevices service.
|
|
25934
27467
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25935
|
-
* @version
|
|
27468
|
+
* @version 146.0.0
|
|
25936
27469
|
*/
|
|
25937
27470
|
|
|
25938
27471
|
/**
|
|
@@ -26083,7 +27616,7 @@ class NotificationsApi {
|
|
|
26083
27616
|
/**
|
|
26084
27617
|
* Notifications service.
|
|
26085
27618
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
26086
|
-
* @version
|
|
27619
|
+
* @version 146.0.0
|
|
26087
27620
|
*/
|
|
26088
27621
|
|
|
26089
27622
|
/**
|
|
@@ -26308,7 +27841,7 @@ class OAuthApi {
|
|
|
26308
27841
|
/**
|
|
26309
27842
|
* OAuth service.
|
|
26310
27843
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
26311
|
-
* @version
|
|
27844
|
+
* @version 146.0.0
|
|
26312
27845
|
*/
|
|
26313
27846
|
|
|
26314
27847
|
/**
|
|
@@ -26674,7 +28207,7 @@ class ObjectsApi {
|
|
|
26674
28207
|
/**
|
|
26675
28208
|
* Objects service.
|
|
26676
28209
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26677
|
-
* @version
|
|
28210
|
+
* @version 146.0.0
|
|
26678
28211
|
*/
|
|
26679
28212
|
|
|
26680
28213
|
/**
|
|
@@ -26945,7 +28478,7 @@ class OrganizationApi {
|
|
|
26945
28478
|
/**
|
|
26946
28479
|
* Organization service.
|
|
26947
28480
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26948
|
-
* @version
|
|
28481
|
+
* @version 146.0.0
|
|
26949
28482
|
*/
|
|
26950
28483
|
|
|
26951
28484
|
/**
|
|
@@ -27348,7 +28881,7 @@ class OrganizationAuthorizationApi {
|
|
|
27348
28881
|
/**
|
|
27349
28882
|
* OrganizationAuthorization service.
|
|
27350
28883
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
27351
|
-
* @version
|
|
28884
|
+
* @version 146.0.0
|
|
27352
28885
|
*/
|
|
27353
28886
|
|
|
27354
28887
|
/**
|
|
@@ -28273,7 +29806,7 @@ class OutboundApi {
|
|
|
28273
29806
|
/**
|
|
28274
29807
|
* Outbound service.
|
|
28275
29808
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
28276
|
-
* @version
|
|
29809
|
+
* @version 146.0.0
|
|
28277
29810
|
*/
|
|
28278
29811
|
|
|
28279
29812
|
/**
|
|
@@ -31528,7 +33061,7 @@ class PresenceApi {
|
|
|
31528
33061
|
/**
|
|
31529
33062
|
* Presence service.
|
|
31530
33063
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
31531
|
-
* @version
|
|
33064
|
+
* @version 146.0.0
|
|
31532
33065
|
*/
|
|
31533
33066
|
|
|
31534
33067
|
/**
|
|
@@ -31850,7 +33383,7 @@ class QualityApi {
|
|
|
31850
33383
|
/**
|
|
31851
33384
|
* Quality service.
|
|
31852
33385
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31853
|
-
* @version
|
|
33386
|
+
* @version 146.0.0
|
|
31854
33387
|
*/
|
|
31855
33388
|
|
|
31856
33389
|
/**
|
|
@@ -33428,7 +34961,7 @@ class RecordingApi {
|
|
|
33428
34961
|
/**
|
|
33429
34962
|
* Recording service.
|
|
33430
34963
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
33431
|
-
* @version
|
|
34964
|
+
* @version 146.0.0
|
|
33432
34965
|
*/
|
|
33433
34966
|
|
|
33434
34967
|
/**
|
|
@@ -35081,7 +36614,7 @@ class ResponseManagementApi {
|
|
|
35081
36614
|
/**
|
|
35082
36615
|
* ResponseManagement service.
|
|
35083
36616
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
35084
|
-
* @version
|
|
36617
|
+
* @version 146.0.0
|
|
35085
36618
|
*/
|
|
35086
36619
|
|
|
35087
36620
|
/**
|
|
@@ -35565,7 +37098,7 @@ class RoutingApi {
|
|
|
35565
37098
|
/**
|
|
35566
37099
|
* Routing service.
|
|
35567
37100
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
35568
|
-
* @version
|
|
37101
|
+
* @version 146.0.0
|
|
35569
37102
|
*/
|
|
35570
37103
|
|
|
35571
37104
|
/**
|
|
@@ -38506,7 +40039,7 @@ class SCIMApi {
|
|
|
38506
40039
|
/**
|
|
38507
40040
|
* SCIM service.
|
|
38508
40041
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
38509
|
-
* @version
|
|
40042
|
+
* @version 146.0.0
|
|
38510
40043
|
*/
|
|
38511
40044
|
|
|
38512
40045
|
/**
|
|
@@ -39383,7 +40916,7 @@ class ScriptsApi {
|
|
|
39383
40916
|
/**
|
|
39384
40917
|
* Scripts service.
|
|
39385
40918
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
39386
|
-
* @version
|
|
40919
|
+
* @version 146.0.0
|
|
39387
40920
|
*/
|
|
39388
40921
|
|
|
39389
40922
|
/**
|
|
@@ -39802,7 +41335,7 @@ class SearchApi {
|
|
|
39802
41335
|
/**
|
|
39803
41336
|
* Search service.
|
|
39804
41337
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39805
|
-
* @version
|
|
41338
|
+
* @version 146.0.0
|
|
39806
41339
|
*/
|
|
39807
41340
|
|
|
39808
41341
|
/**
|
|
@@ -40362,7 +41895,7 @@ class SpeechTextAnalyticsApi {
|
|
|
40362
41895
|
/**
|
|
40363
41896
|
* SpeechTextAnalytics service.
|
|
40364
41897
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
40365
|
-
* @version
|
|
41898
|
+
* @version 146.0.0
|
|
40366
41899
|
*/
|
|
40367
41900
|
|
|
40368
41901
|
/**
|
|
@@ -41216,7 +42749,7 @@ class StationsApi {
|
|
|
41216
42749
|
/**
|
|
41217
42750
|
* Stations service.
|
|
41218
42751
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
41219
|
-
* @version
|
|
42752
|
+
* @version 146.0.0
|
|
41220
42753
|
*/
|
|
41221
42754
|
|
|
41222
42755
|
/**
|
|
@@ -41363,7 +42896,7 @@ class SuggestApi {
|
|
|
41363
42896
|
/**
|
|
41364
42897
|
* Suggest service.
|
|
41365
42898
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
41366
|
-
* @version
|
|
42899
|
+
* @version 146.0.0
|
|
41367
42900
|
*/
|
|
41368
42901
|
|
|
41369
42902
|
/**
|
|
@@ -41502,7 +43035,7 @@ class TeamsApi {
|
|
|
41502
43035
|
/**
|
|
41503
43036
|
* Teams service.
|
|
41504
43037
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
41505
|
-
* @version
|
|
43038
|
+
* @version 146.0.0
|
|
41506
43039
|
*/
|
|
41507
43040
|
|
|
41508
43041
|
/**
|
|
@@ -41681,7 +43214,7 @@ class TelephonyApi {
|
|
|
41681
43214
|
/**
|
|
41682
43215
|
* Telephony service.
|
|
41683
43216
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
41684
|
-
* @version
|
|
43217
|
+
* @version 146.0.0
|
|
41685
43218
|
*/
|
|
41686
43219
|
|
|
41687
43220
|
/**
|
|
@@ -41789,7 +43322,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
41789
43322
|
/**
|
|
41790
43323
|
* TelephonyProvidersEdge service.
|
|
41791
43324
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
41792
|
-
* @version
|
|
43325
|
+
* @version 146.0.0
|
|
41793
43326
|
*/
|
|
41794
43327
|
|
|
41795
43328
|
/**
|
|
@@ -45422,7 +46955,7 @@ class TextbotsApi {
|
|
|
45422
46955
|
/**
|
|
45423
46956
|
* Textbots service.
|
|
45424
46957
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
45425
|
-
* @version
|
|
46958
|
+
* @version 146.0.0
|
|
45426
46959
|
*/
|
|
45427
46960
|
|
|
45428
46961
|
/**
|
|
@@ -45550,7 +47083,7 @@ class TokensApi {
|
|
|
45550
47083
|
/**
|
|
45551
47084
|
* Tokens service.
|
|
45552
47085
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
45553
|
-
* @version
|
|
47086
|
+
* @version 146.0.0
|
|
45554
47087
|
*/
|
|
45555
47088
|
|
|
45556
47089
|
/**
|
|
@@ -45656,7 +47189,7 @@ class UploadsApi {
|
|
|
45656
47189
|
/**
|
|
45657
47190
|
* Uploads service.
|
|
45658
47191
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
45659
|
-
* @version
|
|
47192
|
+
* @version 146.0.0
|
|
45660
47193
|
*/
|
|
45661
47194
|
|
|
45662
47195
|
/**
|
|
@@ -45832,7 +47365,7 @@ class UsageApi {
|
|
|
45832
47365
|
/**
|
|
45833
47366
|
* Usage service.
|
|
45834
47367
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
45835
|
-
* @version
|
|
47368
|
+
* @version 146.0.0
|
|
45836
47369
|
*/
|
|
45837
47370
|
|
|
45838
47371
|
/**
|
|
@@ -45903,7 +47436,7 @@ class UserRecordingsApi {
|
|
|
45903
47436
|
/**
|
|
45904
47437
|
* UserRecordings service.
|
|
45905
47438
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
45906
|
-
* @version
|
|
47439
|
+
* @version 146.0.0
|
|
45907
47440
|
*/
|
|
45908
47441
|
|
|
45909
47442
|
/**
|
|
@@ -46087,7 +47620,7 @@ class UsersApi {
|
|
|
46087
47620
|
/**
|
|
46088
47621
|
* Users service.
|
|
46089
47622
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
46090
|
-
* @version
|
|
47623
|
+
* @version 146.0.0
|
|
46091
47624
|
*/
|
|
46092
47625
|
|
|
46093
47626
|
/**
|
|
@@ -47950,7 +49483,7 @@ class UsersApi {
|
|
|
47950
49483
|
|
|
47951
49484
|
/**
|
|
47952
49485
|
* Create user
|
|
47953
|
-
*
|
|
49486
|
+
* If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
|
|
47954
49487
|
* @param {Object} body User
|
|
47955
49488
|
*/
|
|
47956
49489
|
postUsers(body) {
|
|
@@ -48389,7 +49922,7 @@ class UtilitiesApi {
|
|
|
48389
49922
|
/**
|
|
48390
49923
|
* Utilities service.
|
|
48391
49924
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
48392
|
-
* @version
|
|
49925
|
+
* @version 146.0.0
|
|
48393
49926
|
*/
|
|
48394
49927
|
|
|
48395
49928
|
/**
|
|
@@ -48500,7 +50033,7 @@ class VoicemailApi {
|
|
|
48500
50033
|
/**
|
|
48501
50034
|
* Voicemail service.
|
|
48502
50035
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
48503
|
-
* @version
|
|
50036
|
+
* @version 146.0.0
|
|
48504
50037
|
*/
|
|
48505
50038
|
|
|
48506
50039
|
/**
|
|
@@ -49167,7 +50700,7 @@ class WebChatApi {
|
|
|
49167
50700
|
/**
|
|
49168
50701
|
* WebChat service.
|
|
49169
50702
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
49170
|
-
* @version
|
|
50703
|
+
* @version 146.0.0
|
|
49171
50704
|
*/
|
|
49172
50705
|
|
|
49173
50706
|
/**
|
|
@@ -49711,7 +51244,7 @@ class WebDeploymentsApi {
|
|
|
49711
51244
|
/**
|
|
49712
51245
|
* WebDeployments service.
|
|
49713
51246
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
49714
|
-
* @version
|
|
51247
|
+
* @version 146.0.0
|
|
49715
51248
|
*/
|
|
49716
51249
|
|
|
49717
51250
|
/**
|
|
@@ -50066,7 +51599,7 @@ class WebMessagingApi {
|
|
|
50066
51599
|
/**
|
|
50067
51600
|
* WebMessaging service.
|
|
50068
51601
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
50069
|
-
* @version
|
|
51602
|
+
* @version 146.0.0
|
|
50070
51603
|
*/
|
|
50071
51604
|
|
|
50072
51605
|
/**
|
|
@@ -50112,7 +51645,7 @@ class WidgetsApi {
|
|
|
50112
51645
|
/**
|
|
50113
51646
|
* Widgets service.
|
|
50114
51647
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
50115
|
-
* @version
|
|
51648
|
+
* @version 146.0.0
|
|
50116
51649
|
*/
|
|
50117
51650
|
|
|
50118
51651
|
/**
|
|
@@ -50258,7 +51791,7 @@ class WorkforceManagementApi {
|
|
|
50258
51791
|
/**
|
|
50259
51792
|
* WorkforceManagement service.
|
|
50260
51793
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
50261
|
-
* @version
|
|
51794
|
+
* @version 146.0.0
|
|
50262
51795
|
*/
|
|
50263
51796
|
|
|
50264
51797
|
/**
|
|
@@ -54534,7 +56067,7 @@ class WorkforceManagementApi {
|
|
|
54534
56067
|
* </pre>
|
|
54535
56068
|
* </p>
|
|
54536
56069
|
* @module purecloud-platform-client-v2/index
|
|
54537
|
-
* @version
|
|
56070
|
+
* @version 146.0.0
|
|
54538
56071
|
*/
|
|
54539
56072
|
class platformClient {
|
|
54540
56073
|
constructor() {
|