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
|
@@ -9307,7 +9307,7 @@ class Configuration {
|
|
|
9307
9307
|
|
|
9308
9308
|
/**
|
|
9309
9309
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9310
|
-
* @version
|
|
9310
|
+
* @version 146.0.0
|
|
9311
9311
|
*/
|
|
9312
9312
|
class ApiClient {
|
|
9313
9313
|
/**
|
|
@@ -10379,7 +10379,7 @@ class AlertingApi {
|
|
|
10379
10379
|
/**
|
|
10380
10380
|
* Alerting service.
|
|
10381
10381
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10382
|
-
* @version
|
|
10382
|
+
* @version 146.0.0
|
|
10383
10383
|
*/
|
|
10384
10384
|
|
|
10385
10385
|
/**
|
|
@@ -10693,7 +10693,7 @@ class AnalyticsApi {
|
|
|
10693
10693
|
/**
|
|
10694
10694
|
* Analytics service.
|
|
10695
10695
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10696
|
-
* @version
|
|
10696
|
+
* @version 146.0.0
|
|
10697
10697
|
*/
|
|
10698
10698
|
|
|
10699
10699
|
/**
|
|
@@ -11875,7 +11875,7 @@ class ArchitectApi {
|
|
|
11875
11875
|
/**
|
|
11876
11876
|
* Architect service.
|
|
11877
11877
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
11878
|
-
* @version
|
|
11878
|
+
* @version 146.0.0
|
|
11879
11879
|
*/
|
|
11880
11880
|
|
|
11881
11881
|
/**
|
|
@@ -12633,6 +12633,7 @@ class ArchitectApi {
|
|
|
12633
12633
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
12634
12634
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
12635
12635
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
12636
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
12636
12637
|
*/
|
|
12637
12638
|
getArchitectIvrs(opts) {
|
|
12638
12639
|
opts = opts || {};
|
|
@@ -12642,7 +12643,7 @@ class ArchitectApi {
|
|
|
12642
12643
|
'/api/v2/architect/ivrs',
|
|
12643
12644
|
'GET',
|
|
12644
12645
|
{ },
|
|
12645
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
12646
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
12646
12647
|
{ },
|
|
12647
12648
|
{ },
|
|
12648
12649
|
null,
|
|
@@ -14920,7 +14921,7 @@ class AuditApi {
|
|
|
14920
14921
|
/**
|
|
14921
14922
|
* Audit service.
|
|
14922
14923
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14923
|
-
* @version
|
|
14924
|
+
* @version 146.0.0
|
|
14924
14925
|
*/
|
|
14925
14926
|
|
|
14926
14927
|
/**
|
|
@@ -15091,7 +15092,7 @@ class AuthorizationApi {
|
|
|
15091
15092
|
/**
|
|
15092
15093
|
* Authorization service.
|
|
15093
15094
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15094
|
-
* @version
|
|
15095
|
+
* @version 146.0.0
|
|
15095
15096
|
*/
|
|
15096
15097
|
|
|
15097
15098
|
/**
|
|
@@ -16274,7 +16275,7 @@ class BillingApi {
|
|
|
16274
16275
|
/**
|
|
16275
16276
|
* Billing service.
|
|
16276
16277
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16277
|
-
* @version
|
|
16278
|
+
* @version 146.0.0
|
|
16278
16279
|
*/
|
|
16279
16280
|
|
|
16280
16281
|
/**
|
|
@@ -16354,7 +16355,7 @@ class ChatApi {
|
|
|
16354
16355
|
/**
|
|
16355
16356
|
* Chat service.
|
|
16356
16357
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16357
|
-
* @version
|
|
16358
|
+
* @version 146.0.0
|
|
16358
16359
|
*/
|
|
16359
16360
|
|
|
16360
16361
|
/**
|
|
@@ -16445,7 +16446,7 @@ class CoachingApi {
|
|
|
16445
16446
|
/**
|
|
16446
16447
|
* Coaching service.
|
|
16447
16448
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16448
|
-
* @version
|
|
16449
|
+
* @version 146.0.0
|
|
16449
16450
|
*/
|
|
16450
16451
|
|
|
16451
16452
|
/**
|
|
@@ -17022,7 +17023,7 @@ class ContentManagementApi {
|
|
|
17022
17023
|
/**
|
|
17023
17024
|
* ContentManagement service.
|
|
17024
17025
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17025
|
-
* @version
|
|
17026
|
+
* @version 146.0.0
|
|
17026
17027
|
*/
|
|
17027
17028
|
|
|
17028
17029
|
/**
|
|
@@ -18162,7 +18163,7 @@ class ConversationsApi {
|
|
|
18162
18163
|
/**
|
|
18163
18164
|
* Conversations service.
|
|
18164
18165
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18165
|
-
* @version
|
|
18166
|
+
* @version 146.0.0
|
|
18166
18167
|
*/
|
|
18167
18168
|
|
|
18168
18169
|
/**
|
|
@@ -23306,7 +23307,7 @@ class DataExtensionsApi {
|
|
|
23306
23307
|
/**
|
|
23307
23308
|
* DataExtensions service.
|
|
23308
23309
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23309
|
-
* @version
|
|
23310
|
+
* @version 146.0.0
|
|
23310
23311
|
*/
|
|
23311
23312
|
|
|
23312
23313
|
/**
|
|
@@ -23392,7 +23393,7 @@ class ExternalContactsApi {
|
|
|
23392
23393
|
/**
|
|
23393
23394
|
* ExternalContacts service.
|
|
23394
23395
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23395
|
-
* @version
|
|
23396
|
+
* @version 146.0.0
|
|
23396
23397
|
*/
|
|
23397
23398
|
|
|
23398
23399
|
/**
|
|
@@ -25135,7 +25136,7 @@ class FaxApi {
|
|
|
25135
25136
|
/**
|
|
25136
25137
|
* Fax service.
|
|
25137
25138
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
25138
|
-
* @version
|
|
25139
|
+
* @version 146.0.0
|
|
25139
25140
|
*/
|
|
25140
25141
|
|
|
25141
25142
|
/**
|
|
@@ -25306,7 +25307,7 @@ class FlowsApi {
|
|
|
25306
25307
|
/**
|
|
25307
25308
|
* Flows service.
|
|
25308
25309
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25309
|
-
* @version
|
|
25310
|
+
* @version 146.0.0
|
|
25310
25311
|
*/
|
|
25311
25312
|
|
|
25312
25313
|
/**
|
|
@@ -25377,7 +25378,7 @@ class GamificationApi {
|
|
|
25377
25378
|
/**
|
|
25378
25379
|
* Gamification service.
|
|
25379
25380
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25380
|
-
* @version
|
|
25381
|
+
* @version 146.0.0
|
|
25381
25382
|
*/
|
|
25382
25383
|
|
|
25383
25384
|
/**
|
|
@@ -27108,7 +27109,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
27108
27109
|
/**
|
|
27109
27110
|
* GeneralDataProtectionRegulation service.
|
|
27110
27111
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
27111
|
-
* @version
|
|
27112
|
+
* @version 146.0.0
|
|
27112
27113
|
*/
|
|
27113
27114
|
|
|
27114
27115
|
/**
|
|
@@ -27238,7 +27239,7 @@ class GeolocationApi {
|
|
|
27238
27239
|
/**
|
|
27239
27240
|
* Geolocation service.
|
|
27240
27241
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27241
|
-
* @version
|
|
27242
|
+
* @version 146.0.0
|
|
27242
27243
|
*/
|
|
27243
27244
|
|
|
27244
27245
|
/**
|
|
@@ -27369,7 +27370,7 @@ class GreetingsApi {
|
|
|
27369
27370
|
/**
|
|
27370
27371
|
* Greetings service.
|
|
27371
27372
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27372
|
-
* @version
|
|
27373
|
+
* @version 146.0.0
|
|
27373
27374
|
*/
|
|
27374
27375
|
|
|
27375
27376
|
/**
|
|
@@ -27824,7 +27825,7 @@ class GroupsApi {
|
|
|
27824
27825
|
/**
|
|
27825
27826
|
* Groups service.
|
|
27826
27827
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27827
|
-
* @version
|
|
27828
|
+
* @version 146.0.0
|
|
27828
27829
|
*/
|
|
27829
27830
|
|
|
27830
27831
|
/**
|
|
@@ -28229,7 +28230,7 @@ class IdentityProviderApi {
|
|
|
28229
28230
|
/**
|
|
28230
28231
|
* IdentityProvider service.
|
|
28231
28232
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28232
|
-
* @version
|
|
28233
|
+
* @version 146.0.0
|
|
28233
28234
|
*/
|
|
28234
28235
|
|
|
28235
28236
|
/**
|
|
@@ -28985,7 +28986,7 @@ class IntegrationsApi {
|
|
|
28985
28986
|
/**
|
|
28986
28987
|
* Integrations service.
|
|
28987
28988
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28988
|
-
* @version
|
|
28989
|
+
* @version 146.0.0
|
|
28989
28990
|
*/
|
|
28990
28991
|
|
|
28991
28992
|
/**
|
|
@@ -30662,7 +30663,7 @@ class JourneyApi {
|
|
|
30662
30663
|
/**
|
|
30663
30664
|
* Journey service.
|
|
30664
30665
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30665
|
-
* @version
|
|
30666
|
+
* @version 146.0.0
|
|
30666
30667
|
*/
|
|
30667
30668
|
|
|
30668
30669
|
/**
|
|
@@ -31373,7 +31374,7 @@ class KnowledgeApi {
|
|
|
31373
31374
|
/**
|
|
31374
31375
|
* Knowledge service.
|
|
31375
31376
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31376
|
-
* @version
|
|
31377
|
+
* @version 146.0.0
|
|
31377
31378
|
*/
|
|
31378
31379
|
|
|
31379
31380
|
/**
|
|
@@ -31413,6 +31414,191 @@ class KnowledgeApi {
|
|
|
31413
31414
|
);
|
|
31414
31415
|
}
|
|
31415
31416
|
|
|
31417
|
+
/**
|
|
31418
|
+
* Delete category
|
|
31419
|
+
*
|
|
31420
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31421
|
+
* @param {String} categoryId Category ID
|
|
31422
|
+
*/
|
|
31423
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
31424
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31425
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31426
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
31427
|
+
}
|
|
31428
|
+
// verify the required parameter 'categoryId' is set
|
|
31429
|
+
if (categoryId === undefined || categoryId === null) {
|
|
31430
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
31431
|
+
}
|
|
31432
|
+
|
|
31433
|
+
return this.apiClient.callApi(
|
|
31434
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
31435
|
+
'DELETE',
|
|
31436
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
31437
|
+
{ },
|
|
31438
|
+
{ },
|
|
31439
|
+
{ },
|
|
31440
|
+
null,
|
|
31441
|
+
['PureCloud OAuth'],
|
|
31442
|
+
['application/json'],
|
|
31443
|
+
['application/json']
|
|
31444
|
+
);
|
|
31445
|
+
}
|
|
31446
|
+
|
|
31447
|
+
/**
|
|
31448
|
+
* Delete document.
|
|
31449
|
+
*
|
|
31450
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31451
|
+
* @param {String} documentId Document ID.
|
|
31452
|
+
*/
|
|
31453
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
31454
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31455
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31456
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
31457
|
+
}
|
|
31458
|
+
// verify the required parameter 'documentId' is set
|
|
31459
|
+
if (documentId === undefined || documentId === null) {
|
|
31460
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
31461
|
+
}
|
|
31462
|
+
|
|
31463
|
+
return this.apiClient.callApi(
|
|
31464
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
31465
|
+
'DELETE',
|
|
31466
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31467
|
+
{ },
|
|
31468
|
+
{ },
|
|
31469
|
+
{ },
|
|
31470
|
+
null,
|
|
31471
|
+
['PureCloud OAuth'],
|
|
31472
|
+
['application/json'],
|
|
31473
|
+
['application/json']
|
|
31474
|
+
);
|
|
31475
|
+
}
|
|
31476
|
+
|
|
31477
|
+
/**
|
|
31478
|
+
* Delete a variation for a document.
|
|
31479
|
+
*
|
|
31480
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
31481
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
31482
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
31483
|
+
*/
|
|
31484
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
31485
|
+
// verify the required parameter 'documentVariationId' is set
|
|
31486
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
31487
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
31488
|
+
}
|
|
31489
|
+
// verify the required parameter 'documentId' is set
|
|
31490
|
+
if (documentId === undefined || documentId === null) {
|
|
31491
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
31492
|
+
}
|
|
31493
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31494
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31495
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
31496
|
+
}
|
|
31497
|
+
|
|
31498
|
+
return this.apiClient.callApi(
|
|
31499
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
31500
|
+
'DELETE',
|
|
31501
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
31502
|
+
{ },
|
|
31503
|
+
{ },
|
|
31504
|
+
{ },
|
|
31505
|
+
null,
|
|
31506
|
+
['PureCloud OAuth'],
|
|
31507
|
+
['application/json'],
|
|
31508
|
+
['application/json']
|
|
31509
|
+
);
|
|
31510
|
+
}
|
|
31511
|
+
|
|
31512
|
+
/**
|
|
31513
|
+
* Delete export job
|
|
31514
|
+
*
|
|
31515
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31516
|
+
* @param {String} exportJobId Export job ID
|
|
31517
|
+
*/
|
|
31518
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
31519
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31520
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31521
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
31522
|
+
}
|
|
31523
|
+
// verify the required parameter 'exportJobId' is set
|
|
31524
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
31525
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
31526
|
+
}
|
|
31527
|
+
|
|
31528
|
+
return this.apiClient.callApi(
|
|
31529
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
31530
|
+
'DELETE',
|
|
31531
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
31532
|
+
{ },
|
|
31533
|
+
{ },
|
|
31534
|
+
{ },
|
|
31535
|
+
null,
|
|
31536
|
+
['PureCloud OAuth'],
|
|
31537
|
+
['application/json'],
|
|
31538
|
+
['application/json']
|
|
31539
|
+
);
|
|
31540
|
+
}
|
|
31541
|
+
|
|
31542
|
+
/**
|
|
31543
|
+
* Delete import job
|
|
31544
|
+
*
|
|
31545
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31546
|
+
* @param {String} importJobId Import job ID
|
|
31547
|
+
*/
|
|
31548
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
31549
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31550
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31551
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
31552
|
+
}
|
|
31553
|
+
// verify the required parameter 'importJobId' is set
|
|
31554
|
+
if (importJobId === undefined || importJobId === null) {
|
|
31555
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
31556
|
+
}
|
|
31557
|
+
|
|
31558
|
+
return this.apiClient.callApi(
|
|
31559
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
31560
|
+
'DELETE',
|
|
31561
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
31562
|
+
{ },
|
|
31563
|
+
{ },
|
|
31564
|
+
{ },
|
|
31565
|
+
null,
|
|
31566
|
+
['PureCloud OAuth'],
|
|
31567
|
+
['application/json'],
|
|
31568
|
+
['application/json']
|
|
31569
|
+
);
|
|
31570
|
+
}
|
|
31571
|
+
|
|
31572
|
+
/**
|
|
31573
|
+
* Delete label
|
|
31574
|
+
*
|
|
31575
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31576
|
+
* @param {String} labelId Label ID
|
|
31577
|
+
*/
|
|
31578
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
31579
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31580
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31581
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
31582
|
+
}
|
|
31583
|
+
// verify the required parameter 'labelId' is set
|
|
31584
|
+
if (labelId === undefined || labelId === null) {
|
|
31585
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
31586
|
+
}
|
|
31587
|
+
|
|
31588
|
+
return this.apiClient.callApi(
|
|
31589
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
31590
|
+
'DELETE',
|
|
31591
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
31592
|
+
{ },
|
|
31593
|
+
{ },
|
|
31594
|
+
{ },
|
|
31595
|
+
null,
|
|
31596
|
+
['PureCloud OAuth'],
|
|
31597
|
+
['application/json'],
|
|
31598
|
+
['application/json']
|
|
31599
|
+
);
|
|
31600
|
+
}
|
|
31601
|
+
|
|
31416
31602
|
/**
|
|
31417
31603
|
* Delete category
|
|
31418
31604
|
*
|
|
@@ -31518,6 +31704,104 @@ class KnowledgeApi {
|
|
|
31518
31704
|
);
|
|
31519
31705
|
}
|
|
31520
31706
|
|
|
31707
|
+
/**
|
|
31708
|
+
* Get categories
|
|
31709
|
+
*
|
|
31710
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
31711
|
+
* @param {Object} opts Optional parameters
|
|
31712
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31713
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31714
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31715
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
31716
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
31717
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
31718
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
31719
|
+
* @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.
|
|
31720
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
31721
|
+
*/
|
|
31722
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
31723
|
+
opts = opts || {};
|
|
31724
|
+
|
|
31725
|
+
// verify the required parameter 'sessionId' is set
|
|
31726
|
+
if (sessionId === undefined || sessionId === null) {
|
|
31727
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
31728
|
+
}
|
|
31729
|
+
|
|
31730
|
+
return this.apiClient.callApi(
|
|
31731
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
31732
|
+
'GET',
|
|
31733
|
+
{ 'sessionId': sessionId },
|
|
31734
|
+
{ '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'] },
|
|
31735
|
+
{ },
|
|
31736
|
+
{ },
|
|
31737
|
+
null,
|
|
31738
|
+
['PureCloud OAuth'],
|
|
31739
|
+
['application/json'],
|
|
31740
|
+
['application/json']
|
|
31741
|
+
);
|
|
31742
|
+
}
|
|
31743
|
+
|
|
31744
|
+
/**
|
|
31745
|
+
* Get a knowledge document by ID.
|
|
31746
|
+
*
|
|
31747
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
31748
|
+
* @param {String} documentId Document ID
|
|
31749
|
+
*/
|
|
31750
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
31751
|
+
// verify the required parameter 'sessionId' is set
|
|
31752
|
+
if (sessionId === undefined || sessionId === null) {
|
|
31753
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
31754
|
+
}
|
|
31755
|
+
// verify the required parameter 'documentId' is set
|
|
31756
|
+
if (documentId === undefined || documentId === null) {
|
|
31757
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
31758
|
+
}
|
|
31759
|
+
|
|
31760
|
+
return this.apiClient.callApi(
|
|
31761
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
31762
|
+
'GET',
|
|
31763
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
31764
|
+
{ },
|
|
31765
|
+
{ },
|
|
31766
|
+
{ },
|
|
31767
|
+
null,
|
|
31768
|
+
['PureCloud OAuth'],
|
|
31769
|
+
['application/json'],
|
|
31770
|
+
['application/json']
|
|
31771
|
+
);
|
|
31772
|
+
}
|
|
31773
|
+
|
|
31774
|
+
/**
|
|
31775
|
+
* Get documents.
|
|
31776
|
+
*
|
|
31777
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
31778
|
+
* @param {Object} opts Optional parameters
|
|
31779
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
31780
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
31781
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31782
|
+
*/
|
|
31783
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
31784
|
+
opts = opts || {};
|
|
31785
|
+
|
|
31786
|
+
// verify the required parameter 'sessionId' is set
|
|
31787
|
+
if (sessionId === undefined || sessionId === null) {
|
|
31788
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
31789
|
+
}
|
|
31790
|
+
|
|
31791
|
+
return this.apiClient.callApi(
|
|
31792
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
31793
|
+
'GET',
|
|
31794
|
+
{ 'sessionId': sessionId },
|
|
31795
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
31796
|
+
{ },
|
|
31797
|
+
{ },
|
|
31798
|
+
null,
|
|
31799
|
+
['PureCloud OAuth'],
|
|
31800
|
+
['application/json'],
|
|
31801
|
+
['application/json']
|
|
31802
|
+
);
|
|
31803
|
+
}
|
|
31804
|
+
|
|
31521
31805
|
/**
|
|
31522
31806
|
* Get knowledge base
|
|
31523
31807
|
*
|
|
@@ -31543,6 +31827,501 @@ class KnowledgeApi {
|
|
|
31543
31827
|
);
|
|
31544
31828
|
}
|
|
31545
31829
|
|
|
31830
|
+
/**
|
|
31831
|
+
* Get categories
|
|
31832
|
+
*
|
|
31833
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31834
|
+
* @param {Object} opts Optional parameters
|
|
31835
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31836
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31837
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31838
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
31839
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
31840
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
31841
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
31842
|
+
* @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.
|
|
31843
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
31844
|
+
*/
|
|
31845
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
31846
|
+
opts = opts || {};
|
|
31847
|
+
|
|
31848
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31849
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31850
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
31851
|
+
}
|
|
31852
|
+
|
|
31853
|
+
return this.apiClient.callApi(
|
|
31854
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
31855
|
+
'GET',
|
|
31856
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
31857
|
+
{ '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'] },
|
|
31858
|
+
{ },
|
|
31859
|
+
{ },
|
|
31860
|
+
null,
|
|
31861
|
+
['PureCloud OAuth'],
|
|
31862
|
+
['application/json'],
|
|
31863
|
+
['application/json']
|
|
31864
|
+
);
|
|
31865
|
+
}
|
|
31866
|
+
|
|
31867
|
+
/**
|
|
31868
|
+
* Get category
|
|
31869
|
+
*
|
|
31870
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31871
|
+
* @param {String} categoryId Category ID
|
|
31872
|
+
*/
|
|
31873
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
31874
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31875
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31876
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
31877
|
+
}
|
|
31878
|
+
// verify the required parameter 'categoryId' is set
|
|
31879
|
+
if (categoryId === undefined || categoryId === null) {
|
|
31880
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
31881
|
+
}
|
|
31882
|
+
|
|
31883
|
+
return this.apiClient.callApi(
|
|
31884
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
31885
|
+
'GET',
|
|
31886
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
31887
|
+
{ },
|
|
31888
|
+
{ },
|
|
31889
|
+
{ },
|
|
31890
|
+
null,
|
|
31891
|
+
['PureCloud OAuth'],
|
|
31892
|
+
['application/json'],
|
|
31893
|
+
['application/json']
|
|
31894
|
+
);
|
|
31895
|
+
}
|
|
31896
|
+
|
|
31897
|
+
/**
|
|
31898
|
+
* Get document.
|
|
31899
|
+
*
|
|
31900
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31901
|
+
* @param {String} documentId Document ID.
|
|
31902
|
+
* @param {Object} opts Optional parameters
|
|
31903
|
+
* @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.
|
|
31904
|
+
* @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.
|
|
31905
|
+
*/
|
|
31906
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
31907
|
+
opts = opts || {};
|
|
31908
|
+
|
|
31909
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31910
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31911
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
31912
|
+
}
|
|
31913
|
+
// verify the required parameter 'documentId' is set
|
|
31914
|
+
if (documentId === undefined || documentId === null) {
|
|
31915
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
31916
|
+
}
|
|
31917
|
+
|
|
31918
|
+
return this.apiClient.callApi(
|
|
31919
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
31920
|
+
'GET',
|
|
31921
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31922
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
31923
|
+
{ },
|
|
31924
|
+
{ },
|
|
31925
|
+
null,
|
|
31926
|
+
['PureCloud OAuth'],
|
|
31927
|
+
['application/json'],
|
|
31928
|
+
['application/json']
|
|
31929
|
+
);
|
|
31930
|
+
}
|
|
31931
|
+
|
|
31932
|
+
/**
|
|
31933
|
+
* Get a variation for a document.
|
|
31934
|
+
*
|
|
31935
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
31936
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
31937
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
31938
|
+
* @param {Object} opts Optional parameters
|
|
31939
|
+
* @param {Object} opts.documentState The state of the document.
|
|
31940
|
+
*/
|
|
31941
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
31942
|
+
opts = opts || {};
|
|
31943
|
+
|
|
31944
|
+
// verify the required parameter 'documentVariationId' is set
|
|
31945
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
31946
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
31947
|
+
}
|
|
31948
|
+
// verify the required parameter 'documentId' is set
|
|
31949
|
+
if (documentId === undefined || documentId === null) {
|
|
31950
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
31951
|
+
}
|
|
31952
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31953
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31954
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
31955
|
+
}
|
|
31956
|
+
|
|
31957
|
+
return this.apiClient.callApi(
|
|
31958
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
31959
|
+
'GET',
|
|
31960
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
31961
|
+
{ 'documentState': opts['documentState'] },
|
|
31962
|
+
{ },
|
|
31963
|
+
{ },
|
|
31964
|
+
null,
|
|
31965
|
+
['PureCloud OAuth'],
|
|
31966
|
+
['application/json'],
|
|
31967
|
+
['application/json']
|
|
31968
|
+
);
|
|
31969
|
+
}
|
|
31970
|
+
|
|
31971
|
+
/**
|
|
31972
|
+
* Get variations for a document.
|
|
31973
|
+
*
|
|
31974
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
31975
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
31976
|
+
* @param {Object} opts Optional parameters
|
|
31977
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31978
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31979
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31980
|
+
* @param {Object} opts.documentState The state of the document.
|
|
31981
|
+
*/
|
|
31982
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
31983
|
+
opts = opts || {};
|
|
31984
|
+
|
|
31985
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31986
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31987
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
31988
|
+
}
|
|
31989
|
+
// verify the required parameter 'documentId' is set
|
|
31990
|
+
if (documentId === undefined || documentId === null) {
|
|
31991
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
31992
|
+
}
|
|
31993
|
+
|
|
31994
|
+
return this.apiClient.callApi(
|
|
31995
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
31996
|
+
'GET',
|
|
31997
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31998
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
31999
|
+
{ },
|
|
32000
|
+
{ },
|
|
32001
|
+
null,
|
|
32002
|
+
['PureCloud OAuth'],
|
|
32003
|
+
['application/json'],
|
|
32004
|
+
['application/json']
|
|
32005
|
+
);
|
|
32006
|
+
}
|
|
32007
|
+
|
|
32008
|
+
/**
|
|
32009
|
+
* Get document version.
|
|
32010
|
+
*
|
|
32011
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32012
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32013
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
32014
|
+
* @param {Object} opts Optional parameters
|
|
32015
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
32016
|
+
*/
|
|
32017
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
32018
|
+
opts = opts || {};
|
|
32019
|
+
|
|
32020
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32021
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32022
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
32023
|
+
}
|
|
32024
|
+
// verify the required parameter 'documentId' is set
|
|
32025
|
+
if (documentId === undefined || documentId === null) {
|
|
32026
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
32027
|
+
}
|
|
32028
|
+
// verify the required parameter 'versionId' is set
|
|
32029
|
+
if (versionId === undefined || versionId === null) {
|
|
32030
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
32031
|
+
}
|
|
32032
|
+
|
|
32033
|
+
return this.apiClient.callApi(
|
|
32034
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
32035
|
+
'GET',
|
|
32036
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
32037
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
32038
|
+
{ },
|
|
32039
|
+
{ },
|
|
32040
|
+
null,
|
|
32041
|
+
['PureCloud OAuth'],
|
|
32042
|
+
['application/json'],
|
|
32043
|
+
['application/json']
|
|
32044
|
+
);
|
|
32045
|
+
}
|
|
32046
|
+
|
|
32047
|
+
/**
|
|
32048
|
+
* Get variation for the given document version.
|
|
32049
|
+
*
|
|
32050
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32051
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32052
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
32053
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
32054
|
+
*/
|
|
32055
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
32056
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32057
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32058
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32059
|
+
}
|
|
32060
|
+
// verify the required parameter 'documentId' is set
|
|
32061
|
+
if (documentId === undefined || documentId === null) {
|
|
32062
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32063
|
+
}
|
|
32064
|
+
// verify the required parameter 'versionId' is set
|
|
32065
|
+
if (versionId === undefined || versionId === null) {
|
|
32066
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32067
|
+
}
|
|
32068
|
+
// verify the required parameter 'variationId' is set
|
|
32069
|
+
if (variationId === undefined || variationId === null) {
|
|
32070
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32071
|
+
}
|
|
32072
|
+
|
|
32073
|
+
return this.apiClient.callApi(
|
|
32074
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
32075
|
+
'GET',
|
|
32076
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
32077
|
+
{ },
|
|
32078
|
+
{ },
|
|
32079
|
+
{ },
|
|
32080
|
+
null,
|
|
32081
|
+
['PureCloud OAuth'],
|
|
32082
|
+
['application/json'],
|
|
32083
|
+
['application/json']
|
|
32084
|
+
);
|
|
32085
|
+
}
|
|
32086
|
+
|
|
32087
|
+
/**
|
|
32088
|
+
* Get variations for the given document version.
|
|
32089
|
+
*
|
|
32090
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32091
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32092
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
32093
|
+
* @param {Object} opts Optional parameters
|
|
32094
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32095
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32096
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32097
|
+
*/
|
|
32098
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
32099
|
+
opts = opts || {};
|
|
32100
|
+
|
|
32101
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32102
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32103
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
32104
|
+
}
|
|
32105
|
+
// verify the required parameter 'documentId' is set
|
|
32106
|
+
if (documentId === undefined || documentId === null) {
|
|
32107
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
32108
|
+
}
|
|
32109
|
+
// verify the required parameter 'versionId' is set
|
|
32110
|
+
if (versionId === undefined || versionId === null) {
|
|
32111
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
32112
|
+
}
|
|
32113
|
+
|
|
32114
|
+
return this.apiClient.callApi(
|
|
32115
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
32116
|
+
'GET',
|
|
32117
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
32118
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
32119
|
+
{ },
|
|
32120
|
+
{ },
|
|
32121
|
+
null,
|
|
32122
|
+
['PureCloud OAuth'],
|
|
32123
|
+
['application/json'],
|
|
32124
|
+
['application/json']
|
|
32125
|
+
);
|
|
32126
|
+
}
|
|
32127
|
+
|
|
32128
|
+
/**
|
|
32129
|
+
* Get document versions.
|
|
32130
|
+
*
|
|
32131
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32132
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32133
|
+
* @param {Object} opts Optional parameters
|
|
32134
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32135
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32136
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32137
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
32138
|
+
*/
|
|
32139
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
32140
|
+
opts = opts || {};
|
|
32141
|
+
|
|
32142
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32143
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32144
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
32145
|
+
}
|
|
32146
|
+
// verify the required parameter 'documentId' is set
|
|
32147
|
+
if (documentId === undefined || documentId === null) {
|
|
32148
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
32149
|
+
}
|
|
32150
|
+
|
|
32151
|
+
return this.apiClient.callApi(
|
|
32152
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
32153
|
+
'GET',
|
|
32154
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32155
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
32156
|
+
{ },
|
|
32157
|
+
{ },
|
|
32158
|
+
null,
|
|
32159
|
+
['PureCloud OAuth'],
|
|
32160
|
+
['application/json'],
|
|
32161
|
+
['application/json']
|
|
32162
|
+
);
|
|
32163
|
+
}
|
|
32164
|
+
|
|
32165
|
+
/**
|
|
32166
|
+
* Get documents.
|
|
32167
|
+
*
|
|
32168
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32169
|
+
* @param {Object} opts Optional parameters
|
|
32170
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32171
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32172
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32173
|
+
* @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
|
|
32174
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
32175
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
32176
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
32177
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
32178
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
32179
|
+
*/
|
|
32180
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
32181
|
+
opts = opts || {};
|
|
32182
|
+
|
|
32183
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32184
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32185
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
32186
|
+
}
|
|
32187
|
+
|
|
32188
|
+
return this.apiClient.callApi(
|
|
32189
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
32190
|
+
'GET',
|
|
32191
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32192
|
+
{ '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') },
|
|
32193
|
+
{ },
|
|
32194
|
+
{ },
|
|
32195
|
+
null,
|
|
32196
|
+
['PureCloud OAuth'],
|
|
32197
|
+
['application/json'],
|
|
32198
|
+
['application/json']
|
|
32199
|
+
);
|
|
32200
|
+
}
|
|
32201
|
+
|
|
32202
|
+
/**
|
|
32203
|
+
* Get export job report
|
|
32204
|
+
*
|
|
32205
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32206
|
+
* @param {String} exportJobId Export job ID
|
|
32207
|
+
*/
|
|
32208
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
32209
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32210
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32211
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
32212
|
+
}
|
|
32213
|
+
// verify the required parameter 'exportJobId' is set
|
|
32214
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
32215
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
32216
|
+
}
|
|
32217
|
+
|
|
32218
|
+
return this.apiClient.callApi(
|
|
32219
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
32220
|
+
'GET',
|
|
32221
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
32222
|
+
{ },
|
|
32223
|
+
{ },
|
|
32224
|
+
{ },
|
|
32225
|
+
null,
|
|
32226
|
+
['PureCloud OAuth'],
|
|
32227
|
+
['application/json'],
|
|
32228
|
+
['application/json']
|
|
32229
|
+
);
|
|
32230
|
+
}
|
|
32231
|
+
|
|
32232
|
+
/**
|
|
32233
|
+
* Get import job report
|
|
32234
|
+
*
|
|
32235
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32236
|
+
* @param {String} importJobId Import job ID
|
|
32237
|
+
*/
|
|
32238
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
32239
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32240
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32241
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
32242
|
+
}
|
|
32243
|
+
// verify the required parameter 'importJobId' is set
|
|
32244
|
+
if (importJobId === undefined || importJobId === null) {
|
|
32245
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
32246
|
+
}
|
|
32247
|
+
|
|
32248
|
+
return this.apiClient.callApi(
|
|
32249
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
32250
|
+
'GET',
|
|
32251
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
32252
|
+
{ },
|
|
32253
|
+
{ },
|
|
32254
|
+
{ },
|
|
32255
|
+
null,
|
|
32256
|
+
['PureCloud OAuth'],
|
|
32257
|
+
['application/json'],
|
|
32258
|
+
['application/json']
|
|
32259
|
+
);
|
|
32260
|
+
}
|
|
32261
|
+
|
|
32262
|
+
/**
|
|
32263
|
+
* Get label
|
|
32264
|
+
*
|
|
32265
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32266
|
+
* @param {String} labelId Label ID
|
|
32267
|
+
*/
|
|
32268
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
32269
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32270
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32271
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
32272
|
+
}
|
|
32273
|
+
// verify the required parameter 'labelId' is set
|
|
32274
|
+
if (labelId === undefined || labelId === null) {
|
|
32275
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
32276
|
+
}
|
|
32277
|
+
|
|
32278
|
+
return this.apiClient.callApi(
|
|
32279
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
32280
|
+
'GET',
|
|
32281
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
32282
|
+
{ },
|
|
32283
|
+
{ },
|
|
32284
|
+
{ },
|
|
32285
|
+
null,
|
|
32286
|
+
['PureCloud OAuth'],
|
|
32287
|
+
['application/json'],
|
|
32288
|
+
['application/json']
|
|
32289
|
+
);
|
|
32290
|
+
}
|
|
32291
|
+
|
|
32292
|
+
/**
|
|
32293
|
+
* Get labels
|
|
32294
|
+
*
|
|
32295
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32296
|
+
* @param {Object} opts Optional parameters
|
|
32297
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32298
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32299
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32300
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
32301
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
32302
|
+
*/
|
|
32303
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
32304
|
+
opts = opts || {};
|
|
32305
|
+
|
|
32306
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32307
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32308
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
32309
|
+
}
|
|
32310
|
+
|
|
32311
|
+
return this.apiClient.callApi(
|
|
32312
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
32313
|
+
'GET',
|
|
32314
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32315
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
32316
|
+
{ },
|
|
32317
|
+
{ },
|
|
32318
|
+
null,
|
|
32319
|
+
['PureCloud OAuth'],
|
|
32320
|
+
['application/json'],
|
|
32321
|
+
['application/json']
|
|
32322
|
+
);
|
|
32323
|
+
}
|
|
32324
|
+
|
|
31546
32325
|
/**
|
|
31547
32326
|
* Get categories
|
|
31548
32327
|
*
|
|
@@ -31801,6 +32580,108 @@ class KnowledgeApi {
|
|
|
31801
32580
|
);
|
|
31802
32581
|
}
|
|
31803
32582
|
|
|
32583
|
+
/**
|
|
32584
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
32585
|
+
*
|
|
32586
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32587
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
32588
|
+
* @param {Object} opts Optional parameters
|
|
32589
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
32590
|
+
*/
|
|
32591
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
32592
|
+
opts = opts || {};
|
|
32593
|
+
|
|
32594
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32595
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32596
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
32597
|
+
}
|
|
32598
|
+
// verify the required parameter 'groupId' is set
|
|
32599
|
+
if (groupId === undefined || groupId === null) {
|
|
32600
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
32601
|
+
}
|
|
32602
|
+
|
|
32603
|
+
return this.apiClient.callApi(
|
|
32604
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
32605
|
+
'GET',
|
|
32606
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
32607
|
+
{ 'app': opts['app'] },
|
|
32608
|
+
{ },
|
|
32609
|
+
{ },
|
|
32610
|
+
null,
|
|
32611
|
+
['PureCloud OAuth'],
|
|
32612
|
+
['application/json'],
|
|
32613
|
+
['application/json']
|
|
32614
|
+
);
|
|
32615
|
+
}
|
|
32616
|
+
|
|
32617
|
+
/**
|
|
32618
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
32619
|
+
*
|
|
32620
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32621
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
32622
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
32623
|
+
* @param {Object} opts Optional parameters
|
|
32624
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
32625
|
+
*/
|
|
32626
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
32627
|
+
opts = opts || {};
|
|
32628
|
+
|
|
32629
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32630
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32631
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
32632
|
+
}
|
|
32633
|
+
// verify the required parameter 'groupId' is set
|
|
32634
|
+
if (groupId === undefined || groupId === null) {
|
|
32635
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
32636
|
+
}
|
|
32637
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
32638
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
32639
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
32640
|
+
}
|
|
32641
|
+
|
|
32642
|
+
return this.apiClient.callApi(
|
|
32643
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
32644
|
+
'GET',
|
|
32645
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
32646
|
+
{ 'app': opts['app'] },
|
|
32647
|
+
{ },
|
|
32648
|
+
{ },
|
|
32649
|
+
null,
|
|
32650
|
+
['PureCloud OAuth'],
|
|
32651
|
+
['application/json'],
|
|
32652
|
+
['application/json']
|
|
32653
|
+
);
|
|
32654
|
+
}
|
|
32655
|
+
|
|
32656
|
+
/**
|
|
32657
|
+
* Get knowledge base unanswered groups
|
|
32658
|
+
*
|
|
32659
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32660
|
+
* @param {Object} opts Optional parameters
|
|
32661
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
32662
|
+
*/
|
|
32663
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
32664
|
+
opts = opts || {};
|
|
32665
|
+
|
|
32666
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32667
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32668
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
32669
|
+
}
|
|
32670
|
+
|
|
32671
|
+
return this.apiClient.callApi(
|
|
32672
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
32673
|
+
'GET',
|
|
32674
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32675
|
+
{ 'app': opts['app'] },
|
|
32676
|
+
{ },
|
|
32677
|
+
{ },
|
|
32678
|
+
null,
|
|
32679
|
+
['PureCloud OAuth'],
|
|
32680
|
+
['application/json'],
|
|
32681
|
+
['application/json']
|
|
32682
|
+
);
|
|
32683
|
+
}
|
|
32684
|
+
|
|
31804
32685
|
/**
|
|
31805
32686
|
* Get knowledge bases
|
|
31806
32687
|
*
|
|
@@ -31833,6 +32714,41 @@ class KnowledgeApi {
|
|
|
31833
32714
|
);
|
|
31834
32715
|
}
|
|
31835
32716
|
|
|
32717
|
+
/**
|
|
32718
|
+
* Update search result.
|
|
32719
|
+
*
|
|
32720
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
32721
|
+
* @param {String} searchId Search Result ID
|
|
32722
|
+
* @param {Object} body
|
|
32723
|
+
*/
|
|
32724
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
32725
|
+
// verify the required parameter 'sessionId' is set
|
|
32726
|
+
if (sessionId === undefined || sessionId === null) {
|
|
32727
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
32728
|
+
}
|
|
32729
|
+
// verify the required parameter 'searchId' is set
|
|
32730
|
+
if (searchId === undefined || searchId === null) {
|
|
32731
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
32732
|
+
}
|
|
32733
|
+
// verify the required parameter 'body' is set
|
|
32734
|
+
if (body === undefined || body === null) {
|
|
32735
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
32736
|
+
}
|
|
32737
|
+
|
|
32738
|
+
return this.apiClient.callApi(
|
|
32739
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
32740
|
+
'PATCH',
|
|
32741
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
32742
|
+
{ },
|
|
32743
|
+
{ },
|
|
32744
|
+
{ },
|
|
32745
|
+
body,
|
|
32746
|
+
['PureCloud OAuth'],
|
|
32747
|
+
['application/json'],
|
|
32748
|
+
['application/json']
|
|
32749
|
+
);
|
|
32750
|
+
}
|
|
32751
|
+
|
|
31836
32752
|
/**
|
|
31837
32753
|
* Update knowledge base
|
|
31838
32754
|
*
|
|
@@ -31863,6 +32779,220 @@ class KnowledgeApi {
|
|
|
31863
32779
|
);
|
|
31864
32780
|
}
|
|
31865
32781
|
|
|
32782
|
+
/**
|
|
32783
|
+
* Update category
|
|
32784
|
+
*
|
|
32785
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32786
|
+
* @param {String} categoryId Category ID
|
|
32787
|
+
* @param {Object} body
|
|
32788
|
+
*/
|
|
32789
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
32790
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32791
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32792
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
32793
|
+
}
|
|
32794
|
+
// verify the required parameter 'categoryId' is set
|
|
32795
|
+
if (categoryId === undefined || categoryId === null) {
|
|
32796
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
32797
|
+
}
|
|
32798
|
+
// verify the required parameter 'body' is set
|
|
32799
|
+
if (body === undefined || body === null) {
|
|
32800
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
32801
|
+
}
|
|
32802
|
+
|
|
32803
|
+
return this.apiClient.callApi(
|
|
32804
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
32805
|
+
'PATCH',
|
|
32806
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
32807
|
+
{ },
|
|
32808
|
+
{ },
|
|
32809
|
+
{ },
|
|
32810
|
+
body,
|
|
32811
|
+
['PureCloud OAuth'],
|
|
32812
|
+
['application/json'],
|
|
32813
|
+
['application/json']
|
|
32814
|
+
);
|
|
32815
|
+
}
|
|
32816
|
+
|
|
32817
|
+
/**
|
|
32818
|
+
* Update document.
|
|
32819
|
+
*
|
|
32820
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
32821
|
+
* @param {String} documentId Document ID.
|
|
32822
|
+
* @param {Object} body
|
|
32823
|
+
*/
|
|
32824
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
32825
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32826
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32827
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
32828
|
+
}
|
|
32829
|
+
// verify the required parameter 'documentId' is set
|
|
32830
|
+
if (documentId === undefined || documentId === null) {
|
|
32831
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
32832
|
+
}
|
|
32833
|
+
// verify the required parameter 'body' is set
|
|
32834
|
+
if (body === undefined || body === null) {
|
|
32835
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
32836
|
+
}
|
|
32837
|
+
|
|
32838
|
+
return this.apiClient.callApi(
|
|
32839
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
32840
|
+
'PATCH',
|
|
32841
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32842
|
+
{ },
|
|
32843
|
+
{ },
|
|
32844
|
+
{ },
|
|
32845
|
+
body,
|
|
32846
|
+
['PureCloud OAuth'],
|
|
32847
|
+
['application/json'],
|
|
32848
|
+
['application/json']
|
|
32849
|
+
);
|
|
32850
|
+
}
|
|
32851
|
+
|
|
32852
|
+
/**
|
|
32853
|
+
* Update a variation for a document.
|
|
32854
|
+
*
|
|
32855
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
32856
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
32857
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
32858
|
+
* @param {Object} body
|
|
32859
|
+
*/
|
|
32860
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
32861
|
+
// verify the required parameter 'documentVariationId' is set
|
|
32862
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
32863
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32864
|
+
}
|
|
32865
|
+
// verify the required parameter 'documentId' is set
|
|
32866
|
+
if (documentId === undefined || documentId === null) {
|
|
32867
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32868
|
+
}
|
|
32869
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32870
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32871
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32872
|
+
}
|
|
32873
|
+
// verify the required parameter 'body' is set
|
|
32874
|
+
if (body === undefined || body === null) {
|
|
32875
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32876
|
+
}
|
|
32877
|
+
|
|
32878
|
+
return this.apiClient.callApi(
|
|
32879
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
32880
|
+
'PATCH',
|
|
32881
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
32882
|
+
{ },
|
|
32883
|
+
{ },
|
|
32884
|
+
{ },
|
|
32885
|
+
body,
|
|
32886
|
+
['PureCloud OAuth'],
|
|
32887
|
+
['application/json'],
|
|
32888
|
+
['application/json']
|
|
32889
|
+
);
|
|
32890
|
+
}
|
|
32891
|
+
|
|
32892
|
+
/**
|
|
32893
|
+
* Update search result.
|
|
32894
|
+
*
|
|
32895
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
32896
|
+
* @param {String} searchId Search Result ID
|
|
32897
|
+
* @param {Object} opts Optional parameters
|
|
32898
|
+
* @param {Object} opts.body
|
|
32899
|
+
*/
|
|
32900
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
32901
|
+
opts = opts || {};
|
|
32902
|
+
|
|
32903
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32904
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32905
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
32906
|
+
}
|
|
32907
|
+
// verify the required parameter 'searchId' is set
|
|
32908
|
+
if (searchId === undefined || searchId === null) {
|
|
32909
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
32910
|
+
}
|
|
32911
|
+
|
|
32912
|
+
return this.apiClient.callApi(
|
|
32913
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
32914
|
+
'PATCH',
|
|
32915
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
32916
|
+
{ },
|
|
32917
|
+
{ },
|
|
32918
|
+
{ },
|
|
32919
|
+
opts['body'],
|
|
32920
|
+
['PureCloud OAuth'],
|
|
32921
|
+
['application/json'],
|
|
32922
|
+
['application/json']
|
|
32923
|
+
);
|
|
32924
|
+
}
|
|
32925
|
+
|
|
32926
|
+
/**
|
|
32927
|
+
* Start import job
|
|
32928
|
+
*
|
|
32929
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32930
|
+
* @param {String} importJobId Import job ID
|
|
32931
|
+
* @param {Object} body
|
|
32932
|
+
*/
|
|
32933
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
32934
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32935
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32936
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
32937
|
+
}
|
|
32938
|
+
// verify the required parameter 'importJobId' is set
|
|
32939
|
+
if (importJobId === undefined || importJobId === null) {
|
|
32940
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
32941
|
+
}
|
|
32942
|
+
// verify the required parameter 'body' is set
|
|
32943
|
+
if (body === undefined || body === null) {
|
|
32944
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
32945
|
+
}
|
|
32946
|
+
|
|
32947
|
+
return this.apiClient.callApi(
|
|
32948
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
32949
|
+
'PATCH',
|
|
32950
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
32951
|
+
{ },
|
|
32952
|
+
{ },
|
|
32953
|
+
{ },
|
|
32954
|
+
body,
|
|
32955
|
+
['PureCloud OAuth'],
|
|
32956
|
+
['application/json'],
|
|
32957
|
+
['application/json']
|
|
32958
|
+
);
|
|
32959
|
+
}
|
|
32960
|
+
|
|
32961
|
+
/**
|
|
32962
|
+
* Update label
|
|
32963
|
+
*
|
|
32964
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32965
|
+
* @param {String} labelId Label ID
|
|
32966
|
+
* @param {Object} body
|
|
32967
|
+
*/
|
|
32968
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
32969
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32970
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32971
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
32972
|
+
}
|
|
32973
|
+
// verify the required parameter 'labelId' is set
|
|
32974
|
+
if (labelId === undefined || labelId === null) {
|
|
32975
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
32976
|
+
}
|
|
32977
|
+
// verify the required parameter 'body' is set
|
|
32978
|
+
if (body === undefined || body === null) {
|
|
32979
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
32980
|
+
}
|
|
32981
|
+
|
|
32982
|
+
return this.apiClient.callApi(
|
|
32983
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
32984
|
+
'PATCH',
|
|
32985
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
32986
|
+
{ },
|
|
32987
|
+
{ },
|
|
32988
|
+
{ },
|
|
32989
|
+
body,
|
|
32990
|
+
['PureCloud OAuth'],
|
|
32991
|
+
['application/json'],
|
|
32992
|
+
['application/json']
|
|
32993
|
+
);
|
|
32994
|
+
}
|
|
32995
|
+
|
|
31866
32996
|
/**
|
|
31867
32997
|
* Update category
|
|
31868
32998
|
*
|
|
@@ -32018,6 +33148,46 @@ class KnowledgeApi {
|
|
|
32018
33148
|
);
|
|
32019
33149
|
}
|
|
32020
33150
|
|
|
33151
|
+
/**
|
|
33152
|
+
* Update a Knowledge base unanswered phrase group
|
|
33153
|
+
*
|
|
33154
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33155
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
33156
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
33157
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
33158
|
+
*/
|
|
33159
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
33160
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33161
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33162
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33163
|
+
}
|
|
33164
|
+
// verify the required parameter 'groupId' is set
|
|
33165
|
+
if (groupId === undefined || groupId === null) {
|
|
33166
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33167
|
+
}
|
|
33168
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
33169
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
33170
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33171
|
+
}
|
|
33172
|
+
// verify the required parameter 'body' is set
|
|
33173
|
+
if (body === undefined || body === null) {
|
|
33174
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33175
|
+
}
|
|
33176
|
+
|
|
33177
|
+
return this.apiClient.callApi(
|
|
33178
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
33179
|
+
'PATCH',
|
|
33180
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
33181
|
+
{ },
|
|
33182
|
+
{ },
|
|
33183
|
+
{ },
|
|
33184
|
+
body,
|
|
33185
|
+
['PureCloud OAuth'],
|
|
33186
|
+
['application/json'],
|
|
33187
|
+
['application/json']
|
|
33188
|
+
);
|
|
33189
|
+
}
|
|
33190
|
+
|
|
32021
33191
|
/**
|
|
32022
33192
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
32023
33193
|
*
|
|
@@ -32043,6 +33213,369 @@ class KnowledgeApi {
|
|
|
32043
33213
|
);
|
|
32044
33214
|
}
|
|
32045
33215
|
|
|
33216
|
+
/**
|
|
33217
|
+
* Search the documents in a guest session.
|
|
33218
|
+
*
|
|
33219
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
33220
|
+
* @param {Object} opts Optional parameters
|
|
33221
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
33222
|
+
* @param {Object} opts.body
|
|
33223
|
+
*/
|
|
33224
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
33225
|
+
opts = opts || {};
|
|
33226
|
+
|
|
33227
|
+
// verify the required parameter 'sessionId' is set
|
|
33228
|
+
if (sessionId === undefined || sessionId === null) {
|
|
33229
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
33230
|
+
}
|
|
33231
|
+
|
|
33232
|
+
return this.apiClient.callApi(
|
|
33233
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
33234
|
+
'POST',
|
|
33235
|
+
{ 'sessionId': sessionId },
|
|
33236
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33237
|
+
{ },
|
|
33238
|
+
{ },
|
|
33239
|
+
opts['body'],
|
|
33240
|
+
['PureCloud OAuth'],
|
|
33241
|
+
['application/json'],
|
|
33242
|
+
['application/json']
|
|
33243
|
+
);
|
|
33244
|
+
}
|
|
33245
|
+
|
|
33246
|
+
/**
|
|
33247
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
33248
|
+
*
|
|
33249
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
33250
|
+
* @param {Object} opts Optional parameters
|
|
33251
|
+
* @param {Object} opts.body
|
|
33252
|
+
*/
|
|
33253
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
33254
|
+
opts = opts || {};
|
|
33255
|
+
|
|
33256
|
+
// verify the required parameter 'sessionId' is set
|
|
33257
|
+
if (sessionId === undefined || sessionId === null) {
|
|
33258
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
33259
|
+
}
|
|
33260
|
+
|
|
33261
|
+
return this.apiClient.callApi(
|
|
33262
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
33263
|
+
'POST',
|
|
33264
|
+
{ 'sessionId': sessionId },
|
|
33265
|
+
{ },
|
|
33266
|
+
{ },
|
|
33267
|
+
{ },
|
|
33268
|
+
opts['body'],
|
|
33269
|
+
['PureCloud OAuth'],
|
|
33270
|
+
['application/json'],
|
|
33271
|
+
['application/json']
|
|
33272
|
+
);
|
|
33273
|
+
}
|
|
33274
|
+
|
|
33275
|
+
/**
|
|
33276
|
+
* Create guest session
|
|
33277
|
+
*
|
|
33278
|
+
* @param {Object} body
|
|
33279
|
+
*/
|
|
33280
|
+
postKnowledgeGuestSessions(body) {
|
|
33281
|
+
// verify the required parameter 'body' is set
|
|
33282
|
+
if (body === undefined || body === null) {
|
|
33283
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
33284
|
+
}
|
|
33285
|
+
|
|
33286
|
+
return this.apiClient.callApi(
|
|
33287
|
+
'/api/v2/knowledge/guest/sessions',
|
|
33288
|
+
'POST',
|
|
33289
|
+
{ },
|
|
33290
|
+
{ },
|
|
33291
|
+
{ },
|
|
33292
|
+
{ },
|
|
33293
|
+
body,
|
|
33294
|
+
['PureCloud OAuth'],
|
|
33295
|
+
['application/json'],
|
|
33296
|
+
['application/json']
|
|
33297
|
+
);
|
|
33298
|
+
}
|
|
33299
|
+
|
|
33300
|
+
/**
|
|
33301
|
+
* Create new category
|
|
33302
|
+
*
|
|
33303
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33304
|
+
* @param {Object} body
|
|
33305
|
+
*/
|
|
33306
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
33307
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33308
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33309
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
33310
|
+
}
|
|
33311
|
+
// verify the required parameter 'body' is set
|
|
33312
|
+
if (body === undefined || body === null) {
|
|
33313
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
33314
|
+
}
|
|
33315
|
+
|
|
33316
|
+
return this.apiClient.callApi(
|
|
33317
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
33318
|
+
'POST',
|
|
33319
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33320
|
+
{ },
|
|
33321
|
+
{ },
|
|
33322
|
+
{ },
|
|
33323
|
+
body,
|
|
33324
|
+
['PureCloud OAuth'],
|
|
33325
|
+
['application/json'],
|
|
33326
|
+
['application/json']
|
|
33327
|
+
);
|
|
33328
|
+
}
|
|
33329
|
+
|
|
33330
|
+
/**
|
|
33331
|
+
* Create a variation for a document.
|
|
33332
|
+
*
|
|
33333
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
33334
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
33335
|
+
* @param {Object} body
|
|
33336
|
+
*/
|
|
33337
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
33338
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33339
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33340
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
33341
|
+
}
|
|
33342
|
+
// verify the required parameter 'documentId' is set
|
|
33343
|
+
if (documentId === undefined || documentId === null) {
|
|
33344
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
33345
|
+
}
|
|
33346
|
+
// verify the required parameter 'body' is set
|
|
33347
|
+
if (body === undefined || body === null) {
|
|
33348
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
33349
|
+
}
|
|
33350
|
+
|
|
33351
|
+
return this.apiClient.callApi(
|
|
33352
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
33353
|
+
'POST',
|
|
33354
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33355
|
+
{ },
|
|
33356
|
+
{ },
|
|
33357
|
+
{ },
|
|
33358
|
+
body,
|
|
33359
|
+
['PureCloud OAuth'],
|
|
33360
|
+
['application/json'],
|
|
33361
|
+
['application/json']
|
|
33362
|
+
);
|
|
33363
|
+
}
|
|
33364
|
+
|
|
33365
|
+
/**
|
|
33366
|
+
* Creates or restores a document version.
|
|
33367
|
+
*
|
|
33368
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
33369
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
33370
|
+
* @param {Object} body
|
|
33371
|
+
*/
|
|
33372
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
33373
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33374
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33375
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
33376
|
+
}
|
|
33377
|
+
// verify the required parameter 'documentId' is set
|
|
33378
|
+
if (documentId === undefined || documentId === null) {
|
|
33379
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
33380
|
+
}
|
|
33381
|
+
// verify the required parameter 'body' is set
|
|
33382
|
+
if (body === undefined || body === null) {
|
|
33383
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
33384
|
+
}
|
|
33385
|
+
|
|
33386
|
+
return this.apiClient.callApi(
|
|
33387
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
33388
|
+
'POST',
|
|
33389
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33390
|
+
{ },
|
|
33391
|
+
{ },
|
|
33392
|
+
{ },
|
|
33393
|
+
body,
|
|
33394
|
+
['PureCloud OAuth'],
|
|
33395
|
+
['application/json'],
|
|
33396
|
+
['application/json']
|
|
33397
|
+
);
|
|
33398
|
+
}
|
|
33399
|
+
|
|
33400
|
+
/**
|
|
33401
|
+
* Create document.
|
|
33402
|
+
*
|
|
33403
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33404
|
+
* @param {Object} body
|
|
33405
|
+
*/
|
|
33406
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
33407
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33408
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33409
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
33410
|
+
}
|
|
33411
|
+
// verify the required parameter 'body' is set
|
|
33412
|
+
if (body === undefined || body === null) {
|
|
33413
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
33414
|
+
}
|
|
33415
|
+
|
|
33416
|
+
return this.apiClient.callApi(
|
|
33417
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
33418
|
+
'POST',
|
|
33419
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33420
|
+
{ },
|
|
33421
|
+
{ },
|
|
33422
|
+
{ },
|
|
33423
|
+
body,
|
|
33424
|
+
['PureCloud OAuth'],
|
|
33425
|
+
['application/json'],
|
|
33426
|
+
['application/json']
|
|
33427
|
+
);
|
|
33428
|
+
}
|
|
33429
|
+
|
|
33430
|
+
/**
|
|
33431
|
+
* Search the documents in a knowledge base.
|
|
33432
|
+
*
|
|
33433
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
33434
|
+
* @param {Object} opts Optional parameters
|
|
33435
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
33436
|
+
* @param {Object} opts.body
|
|
33437
|
+
*/
|
|
33438
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
33439
|
+
opts = opts || {};
|
|
33440
|
+
|
|
33441
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33442
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33443
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
33444
|
+
}
|
|
33445
|
+
|
|
33446
|
+
return this.apiClient.callApi(
|
|
33447
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
33448
|
+
'POST',
|
|
33449
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33450
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33451
|
+
{ },
|
|
33452
|
+
{ },
|
|
33453
|
+
opts['body'],
|
|
33454
|
+
['PureCloud OAuth'],
|
|
33455
|
+
['application/json'],
|
|
33456
|
+
['application/json']
|
|
33457
|
+
);
|
|
33458
|
+
}
|
|
33459
|
+
|
|
33460
|
+
/**
|
|
33461
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
33462
|
+
*
|
|
33463
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
33464
|
+
* @param {Object} opts Optional parameters
|
|
33465
|
+
* @param {Object} opts.body
|
|
33466
|
+
*/
|
|
33467
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
33468
|
+
opts = opts || {};
|
|
33469
|
+
|
|
33470
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33471
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33472
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
33473
|
+
}
|
|
33474
|
+
|
|
33475
|
+
return this.apiClient.callApi(
|
|
33476
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
33477
|
+
'POST',
|
|
33478
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33479
|
+
{ },
|
|
33480
|
+
{ },
|
|
33481
|
+
{ },
|
|
33482
|
+
opts['body'],
|
|
33483
|
+
['PureCloud OAuth'],
|
|
33484
|
+
['application/json'],
|
|
33485
|
+
['application/json']
|
|
33486
|
+
);
|
|
33487
|
+
}
|
|
33488
|
+
|
|
33489
|
+
/**
|
|
33490
|
+
* Create export job
|
|
33491
|
+
*
|
|
33492
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33493
|
+
* @param {Object} body
|
|
33494
|
+
*/
|
|
33495
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
33496
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33497
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33498
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
33499
|
+
}
|
|
33500
|
+
// verify the required parameter 'body' is set
|
|
33501
|
+
if (body === undefined || body === null) {
|
|
33502
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
33503
|
+
}
|
|
33504
|
+
|
|
33505
|
+
return this.apiClient.callApi(
|
|
33506
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
33507
|
+
'POST',
|
|
33508
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33509
|
+
{ },
|
|
33510
|
+
{ },
|
|
33511
|
+
{ },
|
|
33512
|
+
body,
|
|
33513
|
+
['PureCloud OAuth'],
|
|
33514
|
+
['application/json'],
|
|
33515
|
+
['application/json']
|
|
33516
|
+
);
|
|
33517
|
+
}
|
|
33518
|
+
|
|
33519
|
+
/**
|
|
33520
|
+
* Create import job
|
|
33521
|
+
*
|
|
33522
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33523
|
+
* @param {Object} body
|
|
33524
|
+
*/
|
|
33525
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
33526
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33527
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33528
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
33529
|
+
}
|
|
33530
|
+
// verify the required parameter 'body' is set
|
|
33531
|
+
if (body === undefined || body === null) {
|
|
33532
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
33533
|
+
}
|
|
33534
|
+
|
|
33535
|
+
return this.apiClient.callApi(
|
|
33536
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
33537
|
+
'POST',
|
|
33538
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33539
|
+
{ },
|
|
33540
|
+
{ },
|
|
33541
|
+
{ },
|
|
33542
|
+
body,
|
|
33543
|
+
['PureCloud OAuth'],
|
|
33544
|
+
['application/json'],
|
|
33545
|
+
['application/json']
|
|
33546
|
+
);
|
|
33547
|
+
}
|
|
33548
|
+
|
|
33549
|
+
/**
|
|
33550
|
+
* Create new label
|
|
33551
|
+
*
|
|
33552
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33553
|
+
* @param {Object} body
|
|
33554
|
+
*/
|
|
33555
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
33556
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33557
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33558
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
33559
|
+
}
|
|
33560
|
+
// verify the required parameter 'body' is set
|
|
33561
|
+
if (body === undefined || body === null) {
|
|
33562
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
33563
|
+
}
|
|
33564
|
+
|
|
33565
|
+
return this.apiClient.callApi(
|
|
33566
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
33567
|
+
'POST',
|
|
33568
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33569
|
+
{ },
|
|
33570
|
+
{ },
|
|
33571
|
+
{ },
|
|
33572
|
+
body,
|
|
33573
|
+
['PureCloud OAuth'],
|
|
33574
|
+
['application/json'],
|
|
33575
|
+
['application/json']
|
|
33576
|
+
);
|
|
33577
|
+
}
|
|
33578
|
+
|
|
32046
33579
|
/**
|
|
32047
33580
|
* Create new category
|
|
32048
33581
|
*
|
|
@@ -32273,7 +33806,7 @@ class LanguageUnderstandingApi {
|
|
|
32273
33806
|
/**
|
|
32274
33807
|
* LanguageUnderstanding service.
|
|
32275
33808
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32276
|
-
* @version
|
|
33809
|
+
* @version 146.0.0
|
|
32277
33810
|
*/
|
|
32278
33811
|
|
|
32279
33812
|
/**
|
|
@@ -33177,7 +34710,7 @@ class LanguagesApi {
|
|
|
33177
34710
|
/**
|
|
33178
34711
|
* Languages service.
|
|
33179
34712
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33180
|
-
* @version
|
|
34713
|
+
* @version 146.0.0
|
|
33181
34714
|
*/
|
|
33182
34715
|
|
|
33183
34716
|
/**
|
|
@@ -33445,7 +34978,7 @@ class LearningApi {
|
|
|
33445
34978
|
/**
|
|
33446
34979
|
* Learning service.
|
|
33447
34980
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33448
|
-
* @version
|
|
34981
|
+
* @version 146.0.0
|
|
33449
34982
|
*/
|
|
33450
34983
|
|
|
33451
34984
|
/**
|
|
@@ -34205,7 +35738,7 @@ class LicenseApi {
|
|
|
34205
35738
|
/**
|
|
34206
35739
|
* License service.
|
|
34207
35740
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34208
|
-
* @version
|
|
35741
|
+
* @version 146.0.0
|
|
34209
35742
|
*/
|
|
34210
35743
|
|
|
34211
35744
|
/**
|
|
@@ -34443,7 +35976,7 @@ class LocationsApi {
|
|
|
34443
35976
|
/**
|
|
34444
35977
|
* Locations service.
|
|
34445
35978
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34446
|
-
* @version
|
|
35979
|
+
* @version 146.0.0
|
|
34447
35980
|
*/
|
|
34448
35981
|
|
|
34449
35982
|
/**
|
|
@@ -34679,7 +36212,7 @@ class MessagingApi {
|
|
|
34679
36212
|
/**
|
|
34680
36213
|
* Messaging service.
|
|
34681
36214
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34682
|
-
* @version
|
|
36215
|
+
* @version 146.0.0
|
|
34683
36216
|
*/
|
|
34684
36217
|
|
|
34685
36218
|
/**
|
|
@@ -34830,7 +36363,7 @@ class MobileDevicesApi {
|
|
|
34830
36363
|
/**
|
|
34831
36364
|
* MobileDevices service.
|
|
34832
36365
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34833
|
-
* @version
|
|
36366
|
+
* @version 146.0.0
|
|
34834
36367
|
*/
|
|
34835
36368
|
|
|
34836
36369
|
/**
|
|
@@ -34981,7 +36514,7 @@ class NotificationsApi {
|
|
|
34981
36514
|
/**
|
|
34982
36515
|
* Notifications service.
|
|
34983
36516
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34984
|
-
* @version
|
|
36517
|
+
* @version 146.0.0
|
|
34985
36518
|
*/
|
|
34986
36519
|
|
|
34987
36520
|
/**
|
|
@@ -35206,7 +36739,7 @@ class OAuthApi {
|
|
|
35206
36739
|
/**
|
|
35207
36740
|
* OAuth service.
|
|
35208
36741
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35209
|
-
* @version
|
|
36742
|
+
* @version 146.0.0
|
|
35210
36743
|
*/
|
|
35211
36744
|
|
|
35212
36745
|
/**
|
|
@@ -35572,7 +37105,7 @@ class ObjectsApi {
|
|
|
35572
37105
|
/**
|
|
35573
37106
|
* Objects service.
|
|
35574
37107
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
35575
|
-
* @version
|
|
37108
|
+
* @version 146.0.0
|
|
35576
37109
|
*/
|
|
35577
37110
|
|
|
35578
37111
|
/**
|
|
@@ -35843,7 +37376,7 @@ class OrganizationApi {
|
|
|
35843
37376
|
/**
|
|
35844
37377
|
* Organization service.
|
|
35845
37378
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35846
|
-
* @version
|
|
37379
|
+
* @version 146.0.0
|
|
35847
37380
|
*/
|
|
35848
37381
|
|
|
35849
37382
|
/**
|
|
@@ -36246,7 +37779,7 @@ class OrganizationAuthorizationApi {
|
|
|
36246
37779
|
/**
|
|
36247
37780
|
* OrganizationAuthorization service.
|
|
36248
37781
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36249
|
-
* @version
|
|
37782
|
+
* @version 146.0.0
|
|
36250
37783
|
*/
|
|
36251
37784
|
|
|
36252
37785
|
/**
|
|
@@ -37171,7 +38704,7 @@ class OutboundApi {
|
|
|
37171
38704
|
/**
|
|
37172
38705
|
* Outbound service.
|
|
37173
38706
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
37174
|
-
* @version
|
|
38707
|
+
* @version 146.0.0
|
|
37175
38708
|
*/
|
|
37176
38709
|
|
|
37177
38710
|
/**
|
|
@@ -40426,7 +41959,7 @@ class PresenceApi {
|
|
|
40426
41959
|
/**
|
|
40427
41960
|
* Presence service.
|
|
40428
41961
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
40429
|
-
* @version
|
|
41962
|
+
* @version 146.0.0
|
|
40430
41963
|
*/
|
|
40431
41964
|
|
|
40432
41965
|
/**
|
|
@@ -40748,7 +42281,7 @@ class QualityApi {
|
|
|
40748
42281
|
/**
|
|
40749
42282
|
* Quality service.
|
|
40750
42283
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40751
|
-
* @version
|
|
42284
|
+
* @version 146.0.0
|
|
40752
42285
|
*/
|
|
40753
42286
|
|
|
40754
42287
|
/**
|
|
@@ -42326,7 +43859,7 @@ class RecordingApi {
|
|
|
42326
43859
|
/**
|
|
42327
43860
|
* Recording service.
|
|
42328
43861
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
42329
|
-
* @version
|
|
43862
|
+
* @version 146.0.0
|
|
42330
43863
|
*/
|
|
42331
43864
|
|
|
42332
43865
|
/**
|
|
@@ -43979,7 +45512,7 @@ class ResponseManagementApi {
|
|
|
43979
45512
|
/**
|
|
43980
45513
|
* ResponseManagement service.
|
|
43981
45514
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
43982
|
-
* @version
|
|
45515
|
+
* @version 146.0.0
|
|
43983
45516
|
*/
|
|
43984
45517
|
|
|
43985
45518
|
/**
|
|
@@ -44463,7 +45996,7 @@ class RoutingApi {
|
|
|
44463
45996
|
/**
|
|
44464
45997
|
* Routing service.
|
|
44465
45998
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
44466
|
-
* @version
|
|
45999
|
+
* @version 146.0.0
|
|
44467
46000
|
*/
|
|
44468
46001
|
|
|
44469
46002
|
/**
|
|
@@ -47404,7 +48937,7 @@ class SCIMApi {
|
|
|
47404
48937
|
/**
|
|
47405
48938
|
* SCIM service.
|
|
47406
48939
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
47407
|
-
* @version
|
|
48940
|
+
* @version 146.0.0
|
|
47408
48941
|
*/
|
|
47409
48942
|
|
|
47410
48943
|
/**
|
|
@@ -48281,7 +49814,7 @@ class ScriptsApi {
|
|
|
48281
49814
|
/**
|
|
48282
49815
|
* Scripts service.
|
|
48283
49816
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
48284
|
-
* @version
|
|
49817
|
+
* @version 146.0.0
|
|
48285
49818
|
*/
|
|
48286
49819
|
|
|
48287
49820
|
/**
|
|
@@ -48700,7 +50233,7 @@ class SearchApi {
|
|
|
48700
50233
|
/**
|
|
48701
50234
|
* Search service.
|
|
48702
50235
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
48703
|
-
* @version
|
|
50236
|
+
* @version 146.0.0
|
|
48704
50237
|
*/
|
|
48705
50238
|
|
|
48706
50239
|
/**
|
|
@@ -49260,7 +50793,7 @@ class SpeechTextAnalyticsApi {
|
|
|
49260
50793
|
/**
|
|
49261
50794
|
* SpeechTextAnalytics service.
|
|
49262
50795
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
49263
|
-
* @version
|
|
50796
|
+
* @version 146.0.0
|
|
49264
50797
|
*/
|
|
49265
50798
|
|
|
49266
50799
|
/**
|
|
@@ -50114,7 +51647,7 @@ class StationsApi {
|
|
|
50114
51647
|
/**
|
|
50115
51648
|
* Stations service.
|
|
50116
51649
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
50117
|
-
* @version
|
|
51650
|
+
* @version 146.0.0
|
|
50118
51651
|
*/
|
|
50119
51652
|
|
|
50120
51653
|
/**
|
|
@@ -50261,7 +51794,7 @@ class SuggestApi {
|
|
|
50261
51794
|
/**
|
|
50262
51795
|
* Suggest service.
|
|
50263
51796
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
50264
|
-
* @version
|
|
51797
|
+
* @version 146.0.0
|
|
50265
51798
|
*/
|
|
50266
51799
|
|
|
50267
51800
|
/**
|
|
@@ -50400,7 +51933,7 @@ class TeamsApi {
|
|
|
50400
51933
|
/**
|
|
50401
51934
|
* Teams service.
|
|
50402
51935
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
50403
|
-
* @version
|
|
51936
|
+
* @version 146.0.0
|
|
50404
51937
|
*/
|
|
50405
51938
|
|
|
50406
51939
|
/**
|
|
@@ -50579,7 +52112,7 @@ class TelephonyApi {
|
|
|
50579
52112
|
/**
|
|
50580
52113
|
* Telephony service.
|
|
50581
52114
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
50582
|
-
* @version
|
|
52115
|
+
* @version 146.0.0
|
|
50583
52116
|
*/
|
|
50584
52117
|
|
|
50585
52118
|
/**
|
|
@@ -50687,7 +52220,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
50687
52220
|
/**
|
|
50688
52221
|
* TelephonyProvidersEdge service.
|
|
50689
52222
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
50690
|
-
* @version
|
|
52223
|
+
* @version 146.0.0
|
|
50691
52224
|
*/
|
|
50692
52225
|
|
|
50693
52226
|
/**
|
|
@@ -54320,7 +55853,7 @@ class TextbotsApi {
|
|
|
54320
55853
|
/**
|
|
54321
55854
|
* Textbots service.
|
|
54322
55855
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
54323
|
-
* @version
|
|
55856
|
+
* @version 146.0.0
|
|
54324
55857
|
*/
|
|
54325
55858
|
|
|
54326
55859
|
/**
|
|
@@ -54448,7 +55981,7 @@ class TokensApi {
|
|
|
54448
55981
|
/**
|
|
54449
55982
|
* Tokens service.
|
|
54450
55983
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
54451
|
-
* @version
|
|
55984
|
+
* @version 146.0.0
|
|
54452
55985
|
*/
|
|
54453
55986
|
|
|
54454
55987
|
/**
|
|
@@ -54554,7 +56087,7 @@ class UploadsApi {
|
|
|
54554
56087
|
/**
|
|
54555
56088
|
* Uploads service.
|
|
54556
56089
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
54557
|
-
* @version
|
|
56090
|
+
* @version 146.0.0
|
|
54558
56091
|
*/
|
|
54559
56092
|
|
|
54560
56093
|
/**
|
|
@@ -54730,7 +56263,7 @@ class UsageApi {
|
|
|
54730
56263
|
/**
|
|
54731
56264
|
* Usage service.
|
|
54732
56265
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
54733
|
-
* @version
|
|
56266
|
+
* @version 146.0.0
|
|
54734
56267
|
*/
|
|
54735
56268
|
|
|
54736
56269
|
/**
|
|
@@ -54801,7 +56334,7 @@ class UserRecordingsApi {
|
|
|
54801
56334
|
/**
|
|
54802
56335
|
* UserRecordings service.
|
|
54803
56336
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
54804
|
-
* @version
|
|
56337
|
+
* @version 146.0.0
|
|
54805
56338
|
*/
|
|
54806
56339
|
|
|
54807
56340
|
/**
|
|
@@ -54985,7 +56518,7 @@ class UsersApi {
|
|
|
54985
56518
|
/**
|
|
54986
56519
|
* Users service.
|
|
54987
56520
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
54988
|
-
* @version
|
|
56521
|
+
* @version 146.0.0
|
|
54989
56522
|
*/
|
|
54990
56523
|
|
|
54991
56524
|
/**
|
|
@@ -56848,7 +58381,7 @@ class UsersApi {
|
|
|
56848
58381
|
|
|
56849
58382
|
/**
|
|
56850
58383
|
* Create user
|
|
56851
|
-
*
|
|
58384
|
+
* 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.
|
|
56852
58385
|
* @param {Object} body User
|
|
56853
58386
|
*/
|
|
56854
58387
|
postUsers(body) {
|
|
@@ -57287,7 +58820,7 @@ class UtilitiesApi {
|
|
|
57287
58820
|
/**
|
|
57288
58821
|
* Utilities service.
|
|
57289
58822
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
57290
|
-
* @version
|
|
58823
|
+
* @version 146.0.0
|
|
57291
58824
|
*/
|
|
57292
58825
|
|
|
57293
58826
|
/**
|
|
@@ -57398,7 +58931,7 @@ class VoicemailApi {
|
|
|
57398
58931
|
/**
|
|
57399
58932
|
* Voicemail service.
|
|
57400
58933
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
57401
|
-
* @version
|
|
58934
|
+
* @version 146.0.0
|
|
57402
58935
|
*/
|
|
57403
58936
|
|
|
57404
58937
|
/**
|
|
@@ -58065,7 +59598,7 @@ class WebChatApi {
|
|
|
58065
59598
|
/**
|
|
58066
59599
|
* WebChat service.
|
|
58067
59600
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
58068
|
-
* @version
|
|
59601
|
+
* @version 146.0.0
|
|
58069
59602
|
*/
|
|
58070
59603
|
|
|
58071
59604
|
/**
|
|
@@ -58609,7 +60142,7 @@ class WebDeploymentsApi {
|
|
|
58609
60142
|
/**
|
|
58610
60143
|
* WebDeployments service.
|
|
58611
60144
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
58612
|
-
* @version
|
|
60145
|
+
* @version 146.0.0
|
|
58613
60146
|
*/
|
|
58614
60147
|
|
|
58615
60148
|
/**
|
|
@@ -58964,7 +60497,7 @@ class WebMessagingApi {
|
|
|
58964
60497
|
/**
|
|
58965
60498
|
* WebMessaging service.
|
|
58966
60499
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
58967
|
-
* @version
|
|
60500
|
+
* @version 146.0.0
|
|
58968
60501
|
*/
|
|
58969
60502
|
|
|
58970
60503
|
/**
|
|
@@ -59010,7 +60543,7 @@ class WidgetsApi {
|
|
|
59010
60543
|
/**
|
|
59011
60544
|
* Widgets service.
|
|
59012
60545
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
59013
|
-
* @version
|
|
60546
|
+
* @version 146.0.0
|
|
59014
60547
|
*/
|
|
59015
60548
|
|
|
59016
60549
|
/**
|
|
@@ -59156,7 +60689,7 @@ class WorkforceManagementApi {
|
|
|
59156
60689
|
/**
|
|
59157
60690
|
* WorkforceManagement service.
|
|
59158
60691
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
59159
|
-
* @version
|
|
60692
|
+
* @version 146.0.0
|
|
59160
60693
|
*/
|
|
59161
60694
|
|
|
59162
60695
|
/**
|
|
@@ -63432,7 +64965,7 @@ class WorkforceManagementApi {
|
|
|
63432
64965
|
* </pre>
|
|
63433
64966
|
* </p>
|
|
63434
64967
|
* @module purecloud-platform-client-v2/index
|
|
63435
|
-
* @version
|
|
64968
|
+
* @version 146.0.0
|
|
63436
64969
|
*/
|
|
63437
64970
|
class platformClient {
|
|
63438
64971
|
constructor() {
|