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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 146.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3351,7 +3351,7 @@ class AlertingApi {
|
|
|
3351
3351
|
/**
|
|
3352
3352
|
* Alerting service.
|
|
3353
3353
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3354
|
-
* @version
|
|
3354
|
+
* @version 146.0.0
|
|
3355
3355
|
*/
|
|
3356
3356
|
|
|
3357
3357
|
/**
|
|
@@ -3665,7 +3665,7 @@ class AnalyticsApi {
|
|
|
3665
3665
|
/**
|
|
3666
3666
|
* Analytics service.
|
|
3667
3667
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3668
|
-
* @version
|
|
3668
|
+
* @version 146.0.0
|
|
3669
3669
|
*/
|
|
3670
3670
|
|
|
3671
3671
|
/**
|
|
@@ -4847,7 +4847,7 @@ class ArchitectApi {
|
|
|
4847
4847
|
/**
|
|
4848
4848
|
* Architect service.
|
|
4849
4849
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4850
|
-
* @version
|
|
4850
|
+
* @version 146.0.0
|
|
4851
4851
|
*/
|
|
4852
4852
|
|
|
4853
4853
|
/**
|
|
@@ -5605,6 +5605,7 @@ class ArchitectApi {
|
|
|
5605
5605
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
5606
5606
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5607
5607
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
5608
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
5608
5609
|
*/
|
|
5609
5610
|
getArchitectIvrs(opts) {
|
|
5610
5611
|
opts = opts || {};
|
|
@@ -5614,7 +5615,7 @@ class ArchitectApi {
|
|
|
5614
5615
|
'/api/v2/architect/ivrs',
|
|
5615
5616
|
'GET',
|
|
5616
5617
|
{ },
|
|
5617
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
5618
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
5618
5619
|
{ },
|
|
5619
5620
|
{ },
|
|
5620
5621
|
null,
|
|
@@ -7892,7 +7893,7 @@ class AuditApi {
|
|
|
7892
7893
|
/**
|
|
7893
7894
|
* Audit service.
|
|
7894
7895
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7895
|
-
* @version
|
|
7896
|
+
* @version 146.0.0
|
|
7896
7897
|
*/
|
|
7897
7898
|
|
|
7898
7899
|
/**
|
|
@@ -8063,7 +8064,7 @@ class AuthorizationApi {
|
|
|
8063
8064
|
/**
|
|
8064
8065
|
* Authorization service.
|
|
8065
8066
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8066
|
-
* @version
|
|
8067
|
+
* @version 146.0.0
|
|
8067
8068
|
*/
|
|
8068
8069
|
|
|
8069
8070
|
/**
|
|
@@ -9246,7 +9247,7 @@ class BillingApi {
|
|
|
9246
9247
|
/**
|
|
9247
9248
|
* Billing service.
|
|
9248
9249
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9249
|
-
* @version
|
|
9250
|
+
* @version 146.0.0
|
|
9250
9251
|
*/
|
|
9251
9252
|
|
|
9252
9253
|
/**
|
|
@@ -9326,7 +9327,7 @@ class ChatApi {
|
|
|
9326
9327
|
/**
|
|
9327
9328
|
* Chat service.
|
|
9328
9329
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9329
|
-
* @version
|
|
9330
|
+
* @version 146.0.0
|
|
9330
9331
|
*/
|
|
9331
9332
|
|
|
9332
9333
|
/**
|
|
@@ -9417,7 +9418,7 @@ class CoachingApi {
|
|
|
9417
9418
|
/**
|
|
9418
9419
|
* Coaching service.
|
|
9419
9420
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9420
|
-
* @version
|
|
9421
|
+
* @version 146.0.0
|
|
9421
9422
|
*/
|
|
9422
9423
|
|
|
9423
9424
|
/**
|
|
@@ -9994,7 +9995,7 @@ class ContentManagementApi {
|
|
|
9994
9995
|
/**
|
|
9995
9996
|
* ContentManagement service.
|
|
9996
9997
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9997
|
-
* @version
|
|
9998
|
+
* @version 146.0.0
|
|
9998
9999
|
*/
|
|
9999
10000
|
|
|
10000
10001
|
/**
|
|
@@ -11134,7 +11135,7 @@ class ConversationsApi {
|
|
|
11134
11135
|
/**
|
|
11135
11136
|
* Conversations service.
|
|
11136
11137
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11137
|
-
* @version
|
|
11138
|
+
* @version 146.0.0
|
|
11138
11139
|
*/
|
|
11139
11140
|
|
|
11140
11141
|
/**
|
|
@@ -16278,7 +16279,7 @@ class DataExtensionsApi {
|
|
|
16278
16279
|
/**
|
|
16279
16280
|
* DataExtensions service.
|
|
16280
16281
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16281
|
-
* @version
|
|
16282
|
+
* @version 146.0.0
|
|
16282
16283
|
*/
|
|
16283
16284
|
|
|
16284
16285
|
/**
|
|
@@ -16364,7 +16365,7 @@ class ExternalContactsApi {
|
|
|
16364
16365
|
/**
|
|
16365
16366
|
* ExternalContacts service.
|
|
16366
16367
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16367
|
-
* @version
|
|
16368
|
+
* @version 146.0.0
|
|
16368
16369
|
*/
|
|
16369
16370
|
|
|
16370
16371
|
/**
|
|
@@ -18107,7 +18108,7 @@ class FaxApi {
|
|
|
18107
18108
|
/**
|
|
18108
18109
|
* Fax service.
|
|
18109
18110
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
18110
|
-
* @version
|
|
18111
|
+
* @version 146.0.0
|
|
18111
18112
|
*/
|
|
18112
18113
|
|
|
18113
18114
|
/**
|
|
@@ -18278,7 +18279,7 @@ class FlowsApi {
|
|
|
18278
18279
|
/**
|
|
18279
18280
|
* Flows service.
|
|
18280
18281
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18281
|
-
* @version
|
|
18282
|
+
* @version 146.0.0
|
|
18282
18283
|
*/
|
|
18283
18284
|
|
|
18284
18285
|
/**
|
|
@@ -18349,7 +18350,7 @@ class GamificationApi {
|
|
|
18349
18350
|
/**
|
|
18350
18351
|
* Gamification service.
|
|
18351
18352
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18352
|
-
* @version
|
|
18353
|
+
* @version 146.0.0
|
|
18353
18354
|
*/
|
|
18354
18355
|
|
|
18355
18356
|
/**
|
|
@@ -20080,7 +20081,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
20080
20081
|
/**
|
|
20081
20082
|
* GeneralDataProtectionRegulation service.
|
|
20082
20083
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
20083
|
-
* @version
|
|
20084
|
+
* @version 146.0.0
|
|
20084
20085
|
*/
|
|
20085
20086
|
|
|
20086
20087
|
/**
|
|
@@ -20210,7 +20211,7 @@ class GeolocationApi {
|
|
|
20210
20211
|
/**
|
|
20211
20212
|
* Geolocation service.
|
|
20212
20213
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20213
|
-
* @version
|
|
20214
|
+
* @version 146.0.0
|
|
20214
20215
|
*/
|
|
20215
20216
|
|
|
20216
20217
|
/**
|
|
@@ -20341,7 +20342,7 @@ class GreetingsApi {
|
|
|
20341
20342
|
/**
|
|
20342
20343
|
* Greetings service.
|
|
20343
20344
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20344
|
-
* @version
|
|
20345
|
+
* @version 146.0.0
|
|
20345
20346
|
*/
|
|
20346
20347
|
|
|
20347
20348
|
/**
|
|
@@ -20796,7 +20797,7 @@ class GroupsApi {
|
|
|
20796
20797
|
/**
|
|
20797
20798
|
* Groups service.
|
|
20798
20799
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20799
|
-
* @version
|
|
20800
|
+
* @version 146.0.0
|
|
20800
20801
|
*/
|
|
20801
20802
|
|
|
20802
20803
|
/**
|
|
@@ -21201,7 +21202,7 @@ class IdentityProviderApi {
|
|
|
21201
21202
|
/**
|
|
21202
21203
|
* IdentityProvider service.
|
|
21203
21204
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21204
|
-
* @version
|
|
21205
|
+
* @version 146.0.0
|
|
21205
21206
|
*/
|
|
21206
21207
|
|
|
21207
21208
|
/**
|
|
@@ -21957,7 +21958,7 @@ class IntegrationsApi {
|
|
|
21957
21958
|
/**
|
|
21958
21959
|
* Integrations service.
|
|
21959
21960
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21960
|
-
* @version
|
|
21961
|
+
* @version 146.0.0
|
|
21961
21962
|
*/
|
|
21962
21963
|
|
|
21963
21964
|
/**
|
|
@@ -23634,7 +23635,7 @@ class JourneyApi {
|
|
|
23634
23635
|
/**
|
|
23635
23636
|
* Journey service.
|
|
23636
23637
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23637
|
-
* @version
|
|
23638
|
+
* @version 146.0.0
|
|
23638
23639
|
*/
|
|
23639
23640
|
|
|
23640
23641
|
/**
|
|
@@ -24345,7 +24346,7 @@ class KnowledgeApi {
|
|
|
24345
24346
|
/**
|
|
24346
24347
|
* Knowledge service.
|
|
24347
24348
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24348
|
-
* @version
|
|
24349
|
+
* @version 146.0.0
|
|
24349
24350
|
*/
|
|
24350
24351
|
|
|
24351
24352
|
/**
|
|
@@ -24385,6 +24386,191 @@ class KnowledgeApi {
|
|
|
24385
24386
|
);
|
|
24386
24387
|
}
|
|
24387
24388
|
|
|
24389
|
+
/**
|
|
24390
|
+
* Delete category
|
|
24391
|
+
*
|
|
24392
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24393
|
+
* @param {String} categoryId Category ID
|
|
24394
|
+
*/
|
|
24395
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
24396
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24397
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24398
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
24399
|
+
}
|
|
24400
|
+
// verify the required parameter 'categoryId' is set
|
|
24401
|
+
if (categoryId === undefined || categoryId === null) {
|
|
24402
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
24403
|
+
}
|
|
24404
|
+
|
|
24405
|
+
return this.apiClient.callApi(
|
|
24406
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
24407
|
+
'DELETE',
|
|
24408
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
24409
|
+
{ },
|
|
24410
|
+
{ },
|
|
24411
|
+
{ },
|
|
24412
|
+
null,
|
|
24413
|
+
['PureCloud OAuth'],
|
|
24414
|
+
['application/json'],
|
|
24415
|
+
['application/json']
|
|
24416
|
+
);
|
|
24417
|
+
}
|
|
24418
|
+
|
|
24419
|
+
/**
|
|
24420
|
+
* Delete document.
|
|
24421
|
+
*
|
|
24422
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
24423
|
+
* @param {String} documentId Document ID.
|
|
24424
|
+
*/
|
|
24425
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
24426
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24427
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24428
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
24429
|
+
}
|
|
24430
|
+
// verify the required parameter 'documentId' is set
|
|
24431
|
+
if (documentId === undefined || documentId === null) {
|
|
24432
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
24433
|
+
}
|
|
24434
|
+
|
|
24435
|
+
return this.apiClient.callApi(
|
|
24436
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
24437
|
+
'DELETE',
|
|
24438
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24439
|
+
{ },
|
|
24440
|
+
{ },
|
|
24441
|
+
{ },
|
|
24442
|
+
null,
|
|
24443
|
+
['PureCloud OAuth'],
|
|
24444
|
+
['application/json'],
|
|
24445
|
+
['application/json']
|
|
24446
|
+
);
|
|
24447
|
+
}
|
|
24448
|
+
|
|
24449
|
+
/**
|
|
24450
|
+
* Delete a variation for a document.
|
|
24451
|
+
*
|
|
24452
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
24453
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
24454
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
24455
|
+
*/
|
|
24456
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
24457
|
+
// verify the required parameter 'documentVariationId' is set
|
|
24458
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
24459
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24460
|
+
}
|
|
24461
|
+
// verify the required parameter 'documentId' is set
|
|
24462
|
+
if (documentId === undefined || documentId === null) {
|
|
24463
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24464
|
+
}
|
|
24465
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24466
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24467
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24468
|
+
}
|
|
24469
|
+
|
|
24470
|
+
return this.apiClient.callApi(
|
|
24471
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
24472
|
+
'DELETE',
|
|
24473
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
24474
|
+
{ },
|
|
24475
|
+
{ },
|
|
24476
|
+
{ },
|
|
24477
|
+
null,
|
|
24478
|
+
['PureCloud OAuth'],
|
|
24479
|
+
['application/json'],
|
|
24480
|
+
['application/json']
|
|
24481
|
+
);
|
|
24482
|
+
}
|
|
24483
|
+
|
|
24484
|
+
/**
|
|
24485
|
+
* Delete export job
|
|
24486
|
+
*
|
|
24487
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24488
|
+
* @param {String} exportJobId Export job ID
|
|
24489
|
+
*/
|
|
24490
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
24491
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24492
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24493
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
24494
|
+
}
|
|
24495
|
+
// verify the required parameter 'exportJobId' is set
|
|
24496
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
24497
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
24498
|
+
}
|
|
24499
|
+
|
|
24500
|
+
return this.apiClient.callApi(
|
|
24501
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
24502
|
+
'DELETE',
|
|
24503
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
24504
|
+
{ },
|
|
24505
|
+
{ },
|
|
24506
|
+
{ },
|
|
24507
|
+
null,
|
|
24508
|
+
['PureCloud OAuth'],
|
|
24509
|
+
['application/json'],
|
|
24510
|
+
['application/json']
|
|
24511
|
+
);
|
|
24512
|
+
}
|
|
24513
|
+
|
|
24514
|
+
/**
|
|
24515
|
+
* Delete import job
|
|
24516
|
+
*
|
|
24517
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24518
|
+
* @param {String} importJobId Import job ID
|
|
24519
|
+
*/
|
|
24520
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
24521
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24522
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24523
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
24524
|
+
}
|
|
24525
|
+
// verify the required parameter 'importJobId' is set
|
|
24526
|
+
if (importJobId === undefined || importJobId === null) {
|
|
24527
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
24528
|
+
}
|
|
24529
|
+
|
|
24530
|
+
return this.apiClient.callApi(
|
|
24531
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
24532
|
+
'DELETE',
|
|
24533
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
24534
|
+
{ },
|
|
24535
|
+
{ },
|
|
24536
|
+
{ },
|
|
24537
|
+
null,
|
|
24538
|
+
['PureCloud OAuth'],
|
|
24539
|
+
['application/json'],
|
|
24540
|
+
['application/json']
|
|
24541
|
+
);
|
|
24542
|
+
}
|
|
24543
|
+
|
|
24544
|
+
/**
|
|
24545
|
+
* Delete label
|
|
24546
|
+
*
|
|
24547
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24548
|
+
* @param {String} labelId Label ID
|
|
24549
|
+
*/
|
|
24550
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
24551
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24552
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24553
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
24554
|
+
}
|
|
24555
|
+
// verify the required parameter 'labelId' is set
|
|
24556
|
+
if (labelId === undefined || labelId === null) {
|
|
24557
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
24558
|
+
}
|
|
24559
|
+
|
|
24560
|
+
return this.apiClient.callApi(
|
|
24561
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
24562
|
+
'DELETE',
|
|
24563
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
24564
|
+
{ },
|
|
24565
|
+
{ },
|
|
24566
|
+
{ },
|
|
24567
|
+
null,
|
|
24568
|
+
['PureCloud OAuth'],
|
|
24569
|
+
['application/json'],
|
|
24570
|
+
['application/json']
|
|
24571
|
+
);
|
|
24572
|
+
}
|
|
24573
|
+
|
|
24388
24574
|
/**
|
|
24389
24575
|
* Delete category
|
|
24390
24576
|
*
|
|
@@ -24490,6 +24676,104 @@ class KnowledgeApi {
|
|
|
24490
24676
|
);
|
|
24491
24677
|
}
|
|
24492
24678
|
|
|
24679
|
+
/**
|
|
24680
|
+
* Get categories
|
|
24681
|
+
*
|
|
24682
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24683
|
+
* @param {Object} opts Optional parameters
|
|
24684
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24685
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24686
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24687
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
24688
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
24689
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
24690
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
24691
|
+
* @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
|
|
24692
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
24693
|
+
*/
|
|
24694
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
24695
|
+
opts = opts || {};
|
|
24696
|
+
|
|
24697
|
+
// verify the required parameter 'sessionId' is set
|
|
24698
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24699
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
24700
|
+
}
|
|
24701
|
+
|
|
24702
|
+
return this.apiClient.callApi(
|
|
24703
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
24704
|
+
'GET',
|
|
24705
|
+
{ 'sessionId': sessionId },
|
|
24706
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
24707
|
+
{ },
|
|
24708
|
+
{ },
|
|
24709
|
+
null,
|
|
24710
|
+
['PureCloud OAuth'],
|
|
24711
|
+
['application/json'],
|
|
24712
|
+
['application/json']
|
|
24713
|
+
);
|
|
24714
|
+
}
|
|
24715
|
+
|
|
24716
|
+
/**
|
|
24717
|
+
* Get a knowledge document by ID.
|
|
24718
|
+
*
|
|
24719
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24720
|
+
* @param {String} documentId Document ID
|
|
24721
|
+
*/
|
|
24722
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
24723
|
+
// verify the required parameter 'sessionId' is set
|
|
24724
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24725
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
24726
|
+
}
|
|
24727
|
+
// verify the required parameter 'documentId' is set
|
|
24728
|
+
if (documentId === undefined || documentId === null) {
|
|
24729
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
24730
|
+
}
|
|
24731
|
+
|
|
24732
|
+
return this.apiClient.callApi(
|
|
24733
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
24734
|
+
'GET',
|
|
24735
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
24736
|
+
{ },
|
|
24737
|
+
{ },
|
|
24738
|
+
{ },
|
|
24739
|
+
null,
|
|
24740
|
+
['PureCloud OAuth'],
|
|
24741
|
+
['application/json'],
|
|
24742
|
+
['application/json']
|
|
24743
|
+
);
|
|
24744
|
+
}
|
|
24745
|
+
|
|
24746
|
+
/**
|
|
24747
|
+
* Get documents.
|
|
24748
|
+
*
|
|
24749
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24750
|
+
* @param {Object} opts Optional parameters
|
|
24751
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
24752
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
24753
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24754
|
+
*/
|
|
24755
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
24756
|
+
opts = opts || {};
|
|
24757
|
+
|
|
24758
|
+
// verify the required parameter 'sessionId' is set
|
|
24759
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24760
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
24761
|
+
}
|
|
24762
|
+
|
|
24763
|
+
return this.apiClient.callApi(
|
|
24764
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
24765
|
+
'GET',
|
|
24766
|
+
{ 'sessionId': sessionId },
|
|
24767
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
24768
|
+
{ },
|
|
24769
|
+
{ },
|
|
24770
|
+
null,
|
|
24771
|
+
['PureCloud OAuth'],
|
|
24772
|
+
['application/json'],
|
|
24773
|
+
['application/json']
|
|
24774
|
+
);
|
|
24775
|
+
}
|
|
24776
|
+
|
|
24493
24777
|
/**
|
|
24494
24778
|
* Get knowledge base
|
|
24495
24779
|
*
|
|
@@ -24515,6 +24799,501 @@ class KnowledgeApi {
|
|
|
24515
24799
|
);
|
|
24516
24800
|
}
|
|
24517
24801
|
|
|
24802
|
+
/**
|
|
24803
|
+
* Get categories
|
|
24804
|
+
*
|
|
24805
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24806
|
+
* @param {Object} opts Optional parameters
|
|
24807
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24808
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24809
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24810
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
24811
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
24812
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
24813
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
24814
|
+
* @param {String} opts.expand The specified entity attribute will be filled. Supported value:Ancestors: every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.
|
|
24815
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
24816
|
+
*/
|
|
24817
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
24818
|
+
opts = opts || {};
|
|
24819
|
+
|
|
24820
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24821
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24822
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
24823
|
+
}
|
|
24824
|
+
|
|
24825
|
+
return this.apiClient.callApi(
|
|
24826
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
24827
|
+
'GET',
|
|
24828
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24829
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'parentId': opts['parentId'],'isRoot': opts['isRoot'],'name': opts['name'],'sortBy': opts['sortBy'],'expand': opts['expand'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
24830
|
+
{ },
|
|
24831
|
+
{ },
|
|
24832
|
+
null,
|
|
24833
|
+
['PureCloud OAuth'],
|
|
24834
|
+
['application/json'],
|
|
24835
|
+
['application/json']
|
|
24836
|
+
);
|
|
24837
|
+
}
|
|
24838
|
+
|
|
24839
|
+
/**
|
|
24840
|
+
* Get category
|
|
24841
|
+
*
|
|
24842
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24843
|
+
* @param {String} categoryId Category ID
|
|
24844
|
+
*/
|
|
24845
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
24846
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24847
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24848
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
24849
|
+
}
|
|
24850
|
+
// verify the required parameter 'categoryId' is set
|
|
24851
|
+
if (categoryId === undefined || categoryId === null) {
|
|
24852
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
24853
|
+
}
|
|
24854
|
+
|
|
24855
|
+
return this.apiClient.callApi(
|
|
24856
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
24857
|
+
'GET',
|
|
24858
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
24859
|
+
{ },
|
|
24860
|
+
{ },
|
|
24861
|
+
{ },
|
|
24862
|
+
null,
|
|
24863
|
+
['PureCloud OAuth'],
|
|
24864
|
+
['application/json'],
|
|
24865
|
+
['application/json']
|
|
24866
|
+
);
|
|
24867
|
+
}
|
|
24868
|
+
|
|
24869
|
+
/**
|
|
24870
|
+
* Get document.
|
|
24871
|
+
*
|
|
24872
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
24873
|
+
* @param {String} documentId Document ID.
|
|
24874
|
+
* @param {Object} opts Optional parameters
|
|
24875
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.
|
|
24876
|
+
* @param {Object} opts.state when state is Draft, draft version of the document is returned,otherwise by default published version is returned in the response.
|
|
24877
|
+
*/
|
|
24878
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
24879
|
+
opts = opts || {};
|
|
24880
|
+
|
|
24881
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24882
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24883
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
24884
|
+
}
|
|
24885
|
+
// verify the required parameter 'documentId' is set
|
|
24886
|
+
if (documentId === undefined || documentId === null) {
|
|
24887
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
24888
|
+
}
|
|
24889
|
+
|
|
24890
|
+
return this.apiClient.callApi(
|
|
24891
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
24892
|
+
'GET',
|
|
24893
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24894
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
24895
|
+
{ },
|
|
24896
|
+
{ },
|
|
24897
|
+
null,
|
|
24898
|
+
['PureCloud OAuth'],
|
|
24899
|
+
['application/json'],
|
|
24900
|
+
['application/json']
|
|
24901
|
+
);
|
|
24902
|
+
}
|
|
24903
|
+
|
|
24904
|
+
/**
|
|
24905
|
+
* Get a variation for a document.
|
|
24906
|
+
*
|
|
24907
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
24908
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
24909
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
24910
|
+
* @param {Object} opts Optional parameters
|
|
24911
|
+
* @param {Object} opts.documentState The state of the document.
|
|
24912
|
+
*/
|
|
24913
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
24914
|
+
opts = opts || {};
|
|
24915
|
+
|
|
24916
|
+
// verify the required parameter 'documentVariationId' is set
|
|
24917
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
24918
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24919
|
+
}
|
|
24920
|
+
// verify the required parameter 'documentId' is set
|
|
24921
|
+
if (documentId === undefined || documentId === null) {
|
|
24922
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24923
|
+
}
|
|
24924
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24925
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24926
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24927
|
+
}
|
|
24928
|
+
|
|
24929
|
+
return this.apiClient.callApi(
|
|
24930
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
24931
|
+
'GET',
|
|
24932
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
24933
|
+
{ 'documentState': opts['documentState'] },
|
|
24934
|
+
{ },
|
|
24935
|
+
{ },
|
|
24936
|
+
null,
|
|
24937
|
+
['PureCloud OAuth'],
|
|
24938
|
+
['application/json'],
|
|
24939
|
+
['application/json']
|
|
24940
|
+
);
|
|
24941
|
+
}
|
|
24942
|
+
|
|
24943
|
+
/**
|
|
24944
|
+
* Get variations for a document.
|
|
24945
|
+
*
|
|
24946
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24947
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24948
|
+
* @param {Object} opts Optional parameters
|
|
24949
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24950
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24951
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24952
|
+
* @param {Object} opts.documentState The state of the document.
|
|
24953
|
+
*/
|
|
24954
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
24955
|
+
opts = opts || {};
|
|
24956
|
+
|
|
24957
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24958
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24959
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
24960
|
+
}
|
|
24961
|
+
// verify the required parameter 'documentId' is set
|
|
24962
|
+
if (documentId === undefined || documentId === null) {
|
|
24963
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
24964
|
+
}
|
|
24965
|
+
|
|
24966
|
+
return this.apiClient.callApi(
|
|
24967
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
24968
|
+
'GET',
|
|
24969
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24970
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
24971
|
+
{ },
|
|
24972
|
+
{ },
|
|
24973
|
+
null,
|
|
24974
|
+
['PureCloud OAuth'],
|
|
24975
|
+
['application/json'],
|
|
24976
|
+
['application/json']
|
|
24977
|
+
);
|
|
24978
|
+
}
|
|
24979
|
+
|
|
24980
|
+
/**
|
|
24981
|
+
* Get document version.
|
|
24982
|
+
*
|
|
24983
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24984
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24985
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
24986
|
+
* @param {Object} opts Optional parameters
|
|
24987
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
24988
|
+
*/
|
|
24989
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
24990
|
+
opts = opts || {};
|
|
24991
|
+
|
|
24992
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24993
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24994
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
24995
|
+
}
|
|
24996
|
+
// verify the required parameter 'documentId' is set
|
|
24997
|
+
if (documentId === undefined || documentId === null) {
|
|
24998
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
24999
|
+
}
|
|
25000
|
+
// verify the required parameter 'versionId' is set
|
|
25001
|
+
if (versionId === undefined || versionId === null) {
|
|
25002
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
25003
|
+
}
|
|
25004
|
+
|
|
25005
|
+
return this.apiClient.callApi(
|
|
25006
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
25007
|
+
'GET',
|
|
25008
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
25009
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25010
|
+
{ },
|
|
25011
|
+
{ },
|
|
25012
|
+
null,
|
|
25013
|
+
['PureCloud OAuth'],
|
|
25014
|
+
['application/json'],
|
|
25015
|
+
['application/json']
|
|
25016
|
+
);
|
|
25017
|
+
}
|
|
25018
|
+
|
|
25019
|
+
/**
|
|
25020
|
+
* Get variation for the given document version.
|
|
25021
|
+
*
|
|
25022
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25023
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25024
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
25025
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
25026
|
+
*/
|
|
25027
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
25028
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25029
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25030
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25031
|
+
}
|
|
25032
|
+
// verify the required parameter 'documentId' is set
|
|
25033
|
+
if (documentId === undefined || documentId === null) {
|
|
25034
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25035
|
+
}
|
|
25036
|
+
// verify the required parameter 'versionId' is set
|
|
25037
|
+
if (versionId === undefined || versionId === null) {
|
|
25038
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25039
|
+
}
|
|
25040
|
+
// verify the required parameter 'variationId' is set
|
|
25041
|
+
if (variationId === undefined || variationId === null) {
|
|
25042
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25043
|
+
}
|
|
25044
|
+
|
|
25045
|
+
return this.apiClient.callApi(
|
|
25046
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
25047
|
+
'GET',
|
|
25048
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
25049
|
+
{ },
|
|
25050
|
+
{ },
|
|
25051
|
+
{ },
|
|
25052
|
+
null,
|
|
25053
|
+
['PureCloud OAuth'],
|
|
25054
|
+
['application/json'],
|
|
25055
|
+
['application/json']
|
|
25056
|
+
);
|
|
25057
|
+
}
|
|
25058
|
+
|
|
25059
|
+
/**
|
|
25060
|
+
* Get variations for the given document version.
|
|
25061
|
+
*
|
|
25062
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25063
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25064
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
25065
|
+
* @param {Object} opts Optional parameters
|
|
25066
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25067
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25068
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25069
|
+
*/
|
|
25070
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
25071
|
+
opts = opts || {};
|
|
25072
|
+
|
|
25073
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25074
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25075
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25076
|
+
}
|
|
25077
|
+
// verify the required parameter 'documentId' is set
|
|
25078
|
+
if (documentId === undefined || documentId === null) {
|
|
25079
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25080
|
+
}
|
|
25081
|
+
// verify the required parameter 'versionId' is set
|
|
25082
|
+
if (versionId === undefined || versionId === null) {
|
|
25083
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25084
|
+
}
|
|
25085
|
+
|
|
25086
|
+
return this.apiClient.callApi(
|
|
25087
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
25088
|
+
'GET',
|
|
25089
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
25090
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
25091
|
+
{ },
|
|
25092
|
+
{ },
|
|
25093
|
+
null,
|
|
25094
|
+
['PureCloud OAuth'],
|
|
25095
|
+
['application/json'],
|
|
25096
|
+
['application/json']
|
|
25097
|
+
);
|
|
25098
|
+
}
|
|
25099
|
+
|
|
25100
|
+
/**
|
|
25101
|
+
* Get document versions.
|
|
25102
|
+
*
|
|
25103
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25104
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25105
|
+
* @param {Object} opts Optional parameters
|
|
25106
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25107
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25108
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25109
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
25110
|
+
*/
|
|
25111
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
25112
|
+
opts = opts || {};
|
|
25113
|
+
|
|
25114
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25115
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25116
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
25117
|
+
}
|
|
25118
|
+
// verify the required parameter 'documentId' is set
|
|
25119
|
+
if (documentId === undefined || documentId === null) {
|
|
25120
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
25121
|
+
}
|
|
25122
|
+
|
|
25123
|
+
return this.apiClient.callApi(
|
|
25124
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
25125
|
+
'GET',
|
|
25126
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
25127
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25128
|
+
{ },
|
|
25129
|
+
{ },
|
|
25130
|
+
null,
|
|
25131
|
+
['PureCloud OAuth'],
|
|
25132
|
+
['application/json'],
|
|
25133
|
+
['application/json']
|
|
25134
|
+
);
|
|
25135
|
+
}
|
|
25136
|
+
|
|
25137
|
+
/**
|
|
25138
|
+
* Get documents.
|
|
25139
|
+
*
|
|
25140
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25141
|
+
* @param {Object} opts Optional parameters
|
|
25142
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25143
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25144
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25145
|
+
* @param {String} opts.interval Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
25146
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
25147
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
25148
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
25149
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
25150
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
25151
|
+
*/
|
|
25152
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
25153
|
+
opts = opts || {};
|
|
25154
|
+
|
|
25155
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25156
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25157
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
25158
|
+
}
|
|
25159
|
+
|
|
25160
|
+
return this.apiClient.callApi(
|
|
25161
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
25162
|
+
'GET',
|
|
25163
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25164
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25165
|
+
{ },
|
|
25166
|
+
{ },
|
|
25167
|
+
null,
|
|
25168
|
+
['PureCloud OAuth'],
|
|
25169
|
+
['application/json'],
|
|
25170
|
+
['application/json']
|
|
25171
|
+
);
|
|
25172
|
+
}
|
|
25173
|
+
|
|
25174
|
+
/**
|
|
25175
|
+
* Get export job report
|
|
25176
|
+
*
|
|
25177
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25178
|
+
* @param {String} exportJobId Export job ID
|
|
25179
|
+
*/
|
|
25180
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
25181
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25182
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25183
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
25184
|
+
}
|
|
25185
|
+
// verify the required parameter 'exportJobId' is set
|
|
25186
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
25187
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
25188
|
+
}
|
|
25189
|
+
|
|
25190
|
+
return this.apiClient.callApi(
|
|
25191
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
25192
|
+
'GET',
|
|
25193
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
25194
|
+
{ },
|
|
25195
|
+
{ },
|
|
25196
|
+
{ },
|
|
25197
|
+
null,
|
|
25198
|
+
['PureCloud OAuth'],
|
|
25199
|
+
['application/json'],
|
|
25200
|
+
['application/json']
|
|
25201
|
+
);
|
|
25202
|
+
}
|
|
25203
|
+
|
|
25204
|
+
/**
|
|
25205
|
+
* Get import job report
|
|
25206
|
+
*
|
|
25207
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25208
|
+
* @param {String} importJobId Import job ID
|
|
25209
|
+
*/
|
|
25210
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
25211
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25212
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25213
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
25214
|
+
}
|
|
25215
|
+
// verify the required parameter 'importJobId' is set
|
|
25216
|
+
if (importJobId === undefined || importJobId === null) {
|
|
25217
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
25218
|
+
}
|
|
25219
|
+
|
|
25220
|
+
return this.apiClient.callApi(
|
|
25221
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
25222
|
+
'GET',
|
|
25223
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
25224
|
+
{ },
|
|
25225
|
+
{ },
|
|
25226
|
+
{ },
|
|
25227
|
+
null,
|
|
25228
|
+
['PureCloud OAuth'],
|
|
25229
|
+
['application/json'],
|
|
25230
|
+
['application/json']
|
|
25231
|
+
);
|
|
25232
|
+
}
|
|
25233
|
+
|
|
25234
|
+
/**
|
|
25235
|
+
* Get label
|
|
25236
|
+
*
|
|
25237
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25238
|
+
* @param {String} labelId Label ID
|
|
25239
|
+
*/
|
|
25240
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
25241
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25242
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25243
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
25244
|
+
}
|
|
25245
|
+
// verify the required parameter 'labelId' is set
|
|
25246
|
+
if (labelId === undefined || labelId === null) {
|
|
25247
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
25248
|
+
}
|
|
25249
|
+
|
|
25250
|
+
return this.apiClient.callApi(
|
|
25251
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
25252
|
+
'GET',
|
|
25253
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
25254
|
+
{ },
|
|
25255
|
+
{ },
|
|
25256
|
+
{ },
|
|
25257
|
+
null,
|
|
25258
|
+
['PureCloud OAuth'],
|
|
25259
|
+
['application/json'],
|
|
25260
|
+
['application/json']
|
|
25261
|
+
);
|
|
25262
|
+
}
|
|
25263
|
+
|
|
25264
|
+
/**
|
|
25265
|
+
* Get labels
|
|
25266
|
+
*
|
|
25267
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25268
|
+
* @param {Object} opts Optional parameters
|
|
25269
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25270
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25271
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25272
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
25273
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
25274
|
+
*/
|
|
25275
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
25276
|
+
opts = opts || {};
|
|
25277
|
+
|
|
25278
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25279
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25280
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
25281
|
+
}
|
|
25282
|
+
|
|
25283
|
+
return this.apiClient.callApi(
|
|
25284
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
25285
|
+
'GET',
|
|
25286
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25287
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
25288
|
+
{ },
|
|
25289
|
+
{ },
|
|
25290
|
+
null,
|
|
25291
|
+
['PureCloud OAuth'],
|
|
25292
|
+
['application/json'],
|
|
25293
|
+
['application/json']
|
|
25294
|
+
);
|
|
25295
|
+
}
|
|
25296
|
+
|
|
24518
25297
|
/**
|
|
24519
25298
|
* Get categories
|
|
24520
25299
|
*
|
|
@@ -24773,6 +25552,108 @@ class KnowledgeApi {
|
|
|
24773
25552
|
);
|
|
24774
25553
|
}
|
|
24775
25554
|
|
|
25555
|
+
/**
|
|
25556
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
25557
|
+
*
|
|
25558
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25559
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
25560
|
+
* @param {Object} opts Optional parameters
|
|
25561
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25562
|
+
*/
|
|
25563
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
25564
|
+
opts = opts || {};
|
|
25565
|
+
|
|
25566
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25567
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25568
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
25569
|
+
}
|
|
25570
|
+
// verify the required parameter 'groupId' is set
|
|
25571
|
+
if (groupId === undefined || groupId === null) {
|
|
25572
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
25573
|
+
}
|
|
25574
|
+
|
|
25575
|
+
return this.apiClient.callApi(
|
|
25576
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
25577
|
+
'GET',
|
|
25578
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
25579
|
+
{ 'app': opts['app'] },
|
|
25580
|
+
{ },
|
|
25581
|
+
{ },
|
|
25582
|
+
null,
|
|
25583
|
+
['PureCloud OAuth'],
|
|
25584
|
+
['application/json'],
|
|
25585
|
+
['application/json']
|
|
25586
|
+
);
|
|
25587
|
+
}
|
|
25588
|
+
|
|
25589
|
+
/**
|
|
25590
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
25591
|
+
*
|
|
25592
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25593
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
25594
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
25595
|
+
* @param {Object} opts Optional parameters
|
|
25596
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25597
|
+
*/
|
|
25598
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
25599
|
+
opts = opts || {};
|
|
25600
|
+
|
|
25601
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25602
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25603
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25604
|
+
}
|
|
25605
|
+
// verify the required parameter 'groupId' is set
|
|
25606
|
+
if (groupId === undefined || groupId === null) {
|
|
25607
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25608
|
+
}
|
|
25609
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
25610
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
25611
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25612
|
+
}
|
|
25613
|
+
|
|
25614
|
+
return this.apiClient.callApi(
|
|
25615
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
25616
|
+
'GET',
|
|
25617
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
25618
|
+
{ 'app': opts['app'] },
|
|
25619
|
+
{ },
|
|
25620
|
+
{ },
|
|
25621
|
+
null,
|
|
25622
|
+
['PureCloud OAuth'],
|
|
25623
|
+
['application/json'],
|
|
25624
|
+
['application/json']
|
|
25625
|
+
);
|
|
25626
|
+
}
|
|
25627
|
+
|
|
25628
|
+
/**
|
|
25629
|
+
* Get knowledge base unanswered groups
|
|
25630
|
+
*
|
|
25631
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25632
|
+
* @param {Object} opts Optional parameters
|
|
25633
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25634
|
+
*/
|
|
25635
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
25636
|
+
opts = opts || {};
|
|
25637
|
+
|
|
25638
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25639
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25640
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
25641
|
+
}
|
|
25642
|
+
|
|
25643
|
+
return this.apiClient.callApi(
|
|
25644
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
25645
|
+
'GET',
|
|
25646
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25647
|
+
{ 'app': opts['app'] },
|
|
25648
|
+
{ },
|
|
25649
|
+
{ },
|
|
25650
|
+
null,
|
|
25651
|
+
['PureCloud OAuth'],
|
|
25652
|
+
['application/json'],
|
|
25653
|
+
['application/json']
|
|
25654
|
+
);
|
|
25655
|
+
}
|
|
25656
|
+
|
|
24776
25657
|
/**
|
|
24777
25658
|
* Get knowledge bases
|
|
24778
25659
|
*
|
|
@@ -24805,6 +25686,41 @@ class KnowledgeApi {
|
|
|
24805
25686
|
);
|
|
24806
25687
|
}
|
|
24807
25688
|
|
|
25689
|
+
/**
|
|
25690
|
+
* Update search result.
|
|
25691
|
+
*
|
|
25692
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
25693
|
+
* @param {String} searchId Search Result ID
|
|
25694
|
+
* @param {Object} body
|
|
25695
|
+
*/
|
|
25696
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
25697
|
+
// verify the required parameter 'sessionId' is set
|
|
25698
|
+
if (sessionId === undefined || sessionId === null) {
|
|
25699
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25700
|
+
}
|
|
25701
|
+
// verify the required parameter 'searchId' is set
|
|
25702
|
+
if (searchId === undefined || searchId === null) {
|
|
25703
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25704
|
+
}
|
|
25705
|
+
// verify the required parameter 'body' is set
|
|
25706
|
+
if (body === undefined || body === null) {
|
|
25707
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25708
|
+
}
|
|
25709
|
+
|
|
25710
|
+
return this.apiClient.callApi(
|
|
25711
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
25712
|
+
'PATCH',
|
|
25713
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
25714
|
+
{ },
|
|
25715
|
+
{ },
|
|
25716
|
+
{ },
|
|
25717
|
+
body,
|
|
25718
|
+
['PureCloud OAuth'],
|
|
25719
|
+
['application/json'],
|
|
25720
|
+
['application/json']
|
|
25721
|
+
);
|
|
25722
|
+
}
|
|
25723
|
+
|
|
24808
25724
|
/**
|
|
24809
25725
|
* Update knowledge base
|
|
24810
25726
|
*
|
|
@@ -24835,6 +25751,220 @@ class KnowledgeApi {
|
|
|
24835
25751
|
);
|
|
24836
25752
|
}
|
|
24837
25753
|
|
|
25754
|
+
/**
|
|
25755
|
+
* Update category
|
|
25756
|
+
*
|
|
25757
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25758
|
+
* @param {String} categoryId Category ID
|
|
25759
|
+
* @param {Object} body
|
|
25760
|
+
*/
|
|
25761
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
25762
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25763
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25764
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25765
|
+
}
|
|
25766
|
+
// verify the required parameter 'categoryId' is set
|
|
25767
|
+
if (categoryId === undefined || categoryId === null) {
|
|
25768
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25769
|
+
}
|
|
25770
|
+
// verify the required parameter 'body' is set
|
|
25771
|
+
if (body === undefined || body === null) {
|
|
25772
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25773
|
+
}
|
|
25774
|
+
|
|
25775
|
+
return this.apiClient.callApi(
|
|
25776
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
25777
|
+
'PATCH',
|
|
25778
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
25779
|
+
{ },
|
|
25780
|
+
{ },
|
|
25781
|
+
{ },
|
|
25782
|
+
body,
|
|
25783
|
+
['PureCloud OAuth'],
|
|
25784
|
+
['application/json'],
|
|
25785
|
+
['application/json']
|
|
25786
|
+
);
|
|
25787
|
+
}
|
|
25788
|
+
|
|
25789
|
+
/**
|
|
25790
|
+
* Update document.
|
|
25791
|
+
*
|
|
25792
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
25793
|
+
* @param {String} documentId Document ID.
|
|
25794
|
+
* @param {Object} body
|
|
25795
|
+
*/
|
|
25796
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
25797
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25798
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25799
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25800
|
+
}
|
|
25801
|
+
// verify the required parameter 'documentId' is set
|
|
25802
|
+
if (documentId === undefined || documentId === null) {
|
|
25803
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25804
|
+
}
|
|
25805
|
+
// verify the required parameter 'body' is set
|
|
25806
|
+
if (body === undefined || body === null) {
|
|
25807
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25808
|
+
}
|
|
25809
|
+
|
|
25810
|
+
return this.apiClient.callApi(
|
|
25811
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
25812
|
+
'PATCH',
|
|
25813
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
25814
|
+
{ },
|
|
25815
|
+
{ },
|
|
25816
|
+
{ },
|
|
25817
|
+
body,
|
|
25818
|
+
['PureCloud OAuth'],
|
|
25819
|
+
['application/json'],
|
|
25820
|
+
['application/json']
|
|
25821
|
+
);
|
|
25822
|
+
}
|
|
25823
|
+
|
|
25824
|
+
/**
|
|
25825
|
+
* Update a variation for a document.
|
|
25826
|
+
*
|
|
25827
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
25828
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
25829
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
25830
|
+
* @param {Object} body
|
|
25831
|
+
*/
|
|
25832
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
25833
|
+
// verify the required parameter 'documentVariationId' is set
|
|
25834
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
25835
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25836
|
+
}
|
|
25837
|
+
// verify the required parameter 'documentId' is set
|
|
25838
|
+
if (documentId === undefined || documentId === null) {
|
|
25839
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25840
|
+
}
|
|
25841
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25842
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25843
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25844
|
+
}
|
|
25845
|
+
// verify the required parameter 'body' is set
|
|
25846
|
+
if (body === undefined || body === null) {
|
|
25847
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25848
|
+
}
|
|
25849
|
+
|
|
25850
|
+
return this.apiClient.callApi(
|
|
25851
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
25852
|
+
'PATCH',
|
|
25853
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
25854
|
+
{ },
|
|
25855
|
+
{ },
|
|
25856
|
+
{ },
|
|
25857
|
+
body,
|
|
25858
|
+
['PureCloud OAuth'],
|
|
25859
|
+
['application/json'],
|
|
25860
|
+
['application/json']
|
|
25861
|
+
);
|
|
25862
|
+
}
|
|
25863
|
+
|
|
25864
|
+
/**
|
|
25865
|
+
* Update search result.
|
|
25866
|
+
*
|
|
25867
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
25868
|
+
* @param {String} searchId Search Result ID
|
|
25869
|
+
* @param {Object} opts Optional parameters
|
|
25870
|
+
* @param {Object} opts.body
|
|
25871
|
+
*/
|
|
25872
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
25873
|
+
opts = opts || {};
|
|
25874
|
+
|
|
25875
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25876
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25877
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
25878
|
+
}
|
|
25879
|
+
// verify the required parameter 'searchId' is set
|
|
25880
|
+
if (searchId === undefined || searchId === null) {
|
|
25881
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
25882
|
+
}
|
|
25883
|
+
|
|
25884
|
+
return this.apiClient.callApi(
|
|
25885
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
25886
|
+
'PATCH',
|
|
25887
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
25888
|
+
{ },
|
|
25889
|
+
{ },
|
|
25890
|
+
{ },
|
|
25891
|
+
opts['body'],
|
|
25892
|
+
['PureCloud OAuth'],
|
|
25893
|
+
['application/json'],
|
|
25894
|
+
['application/json']
|
|
25895
|
+
);
|
|
25896
|
+
}
|
|
25897
|
+
|
|
25898
|
+
/**
|
|
25899
|
+
* Start import job
|
|
25900
|
+
*
|
|
25901
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25902
|
+
* @param {String} importJobId Import job ID
|
|
25903
|
+
* @param {Object} body
|
|
25904
|
+
*/
|
|
25905
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
25906
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25907
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25908
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25909
|
+
}
|
|
25910
|
+
// verify the required parameter 'importJobId' is set
|
|
25911
|
+
if (importJobId === undefined || importJobId === null) {
|
|
25912
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25913
|
+
}
|
|
25914
|
+
// verify the required parameter 'body' is set
|
|
25915
|
+
if (body === undefined || body === null) {
|
|
25916
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25917
|
+
}
|
|
25918
|
+
|
|
25919
|
+
return this.apiClient.callApi(
|
|
25920
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
25921
|
+
'PATCH',
|
|
25922
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
25923
|
+
{ },
|
|
25924
|
+
{ },
|
|
25925
|
+
{ },
|
|
25926
|
+
body,
|
|
25927
|
+
['PureCloud OAuth'],
|
|
25928
|
+
['application/json'],
|
|
25929
|
+
['application/json']
|
|
25930
|
+
);
|
|
25931
|
+
}
|
|
25932
|
+
|
|
25933
|
+
/**
|
|
25934
|
+
* Update label
|
|
25935
|
+
*
|
|
25936
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25937
|
+
* @param {String} labelId Label ID
|
|
25938
|
+
* @param {Object} body
|
|
25939
|
+
*/
|
|
25940
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
25941
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25942
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25943
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25944
|
+
}
|
|
25945
|
+
// verify the required parameter 'labelId' is set
|
|
25946
|
+
if (labelId === undefined || labelId === null) {
|
|
25947
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25948
|
+
}
|
|
25949
|
+
// verify the required parameter 'body' is set
|
|
25950
|
+
if (body === undefined || body === null) {
|
|
25951
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25952
|
+
}
|
|
25953
|
+
|
|
25954
|
+
return this.apiClient.callApi(
|
|
25955
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
25956
|
+
'PATCH',
|
|
25957
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
25958
|
+
{ },
|
|
25959
|
+
{ },
|
|
25960
|
+
{ },
|
|
25961
|
+
body,
|
|
25962
|
+
['PureCloud OAuth'],
|
|
25963
|
+
['application/json'],
|
|
25964
|
+
['application/json']
|
|
25965
|
+
);
|
|
25966
|
+
}
|
|
25967
|
+
|
|
24838
25968
|
/**
|
|
24839
25969
|
* Update category
|
|
24840
25970
|
*
|
|
@@ -24990,6 +26120,46 @@ class KnowledgeApi {
|
|
|
24990
26120
|
);
|
|
24991
26121
|
}
|
|
24992
26122
|
|
|
26123
|
+
/**
|
|
26124
|
+
* Update a Knowledge base unanswered phrase group
|
|
26125
|
+
*
|
|
26126
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26127
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
26128
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
26129
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
26130
|
+
*/
|
|
26131
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
26132
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26133
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26134
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26135
|
+
}
|
|
26136
|
+
// verify the required parameter 'groupId' is set
|
|
26137
|
+
if (groupId === undefined || groupId === null) {
|
|
26138
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26139
|
+
}
|
|
26140
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
26141
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
26142
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26143
|
+
}
|
|
26144
|
+
// verify the required parameter 'body' is set
|
|
26145
|
+
if (body === undefined || body === null) {
|
|
26146
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26147
|
+
}
|
|
26148
|
+
|
|
26149
|
+
return this.apiClient.callApi(
|
|
26150
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
26151
|
+
'PATCH',
|
|
26152
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
26153
|
+
{ },
|
|
26154
|
+
{ },
|
|
26155
|
+
{ },
|
|
26156
|
+
body,
|
|
26157
|
+
['PureCloud OAuth'],
|
|
26158
|
+
['application/json'],
|
|
26159
|
+
['application/json']
|
|
26160
|
+
);
|
|
26161
|
+
}
|
|
26162
|
+
|
|
24993
26163
|
/**
|
|
24994
26164
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
24995
26165
|
*
|
|
@@ -25015,6 +26185,369 @@ class KnowledgeApi {
|
|
|
25015
26185
|
);
|
|
25016
26186
|
}
|
|
25017
26187
|
|
|
26188
|
+
/**
|
|
26189
|
+
* Search the documents in a guest session.
|
|
26190
|
+
*
|
|
26191
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
26192
|
+
* @param {Object} opts Optional parameters
|
|
26193
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
26194
|
+
* @param {Object} opts.body
|
|
26195
|
+
*/
|
|
26196
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
26197
|
+
opts = opts || {};
|
|
26198
|
+
|
|
26199
|
+
// verify the required parameter 'sessionId' is set
|
|
26200
|
+
if (sessionId === undefined || sessionId === null) {
|
|
26201
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
26202
|
+
}
|
|
26203
|
+
|
|
26204
|
+
return this.apiClient.callApi(
|
|
26205
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
26206
|
+
'POST',
|
|
26207
|
+
{ 'sessionId': sessionId },
|
|
26208
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
26209
|
+
{ },
|
|
26210
|
+
{ },
|
|
26211
|
+
opts['body'],
|
|
26212
|
+
['PureCloud OAuth'],
|
|
26213
|
+
['application/json'],
|
|
26214
|
+
['application/json']
|
|
26215
|
+
);
|
|
26216
|
+
}
|
|
26217
|
+
|
|
26218
|
+
/**
|
|
26219
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
26220
|
+
*
|
|
26221
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
26222
|
+
* @param {Object} opts Optional parameters
|
|
26223
|
+
* @param {Object} opts.body
|
|
26224
|
+
*/
|
|
26225
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
26226
|
+
opts = opts || {};
|
|
26227
|
+
|
|
26228
|
+
// verify the required parameter 'sessionId' is set
|
|
26229
|
+
if (sessionId === undefined || sessionId === null) {
|
|
26230
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
26231
|
+
}
|
|
26232
|
+
|
|
26233
|
+
return this.apiClient.callApi(
|
|
26234
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
26235
|
+
'POST',
|
|
26236
|
+
{ 'sessionId': sessionId },
|
|
26237
|
+
{ },
|
|
26238
|
+
{ },
|
|
26239
|
+
{ },
|
|
26240
|
+
opts['body'],
|
|
26241
|
+
['PureCloud OAuth'],
|
|
26242
|
+
['application/json'],
|
|
26243
|
+
['application/json']
|
|
26244
|
+
);
|
|
26245
|
+
}
|
|
26246
|
+
|
|
26247
|
+
/**
|
|
26248
|
+
* Create guest session
|
|
26249
|
+
*
|
|
26250
|
+
* @param {Object} body
|
|
26251
|
+
*/
|
|
26252
|
+
postKnowledgeGuestSessions(body) {
|
|
26253
|
+
// verify the required parameter 'body' is set
|
|
26254
|
+
if (body === undefined || body === null) {
|
|
26255
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
26256
|
+
}
|
|
26257
|
+
|
|
26258
|
+
return this.apiClient.callApi(
|
|
26259
|
+
'/api/v2/knowledge/guest/sessions',
|
|
26260
|
+
'POST',
|
|
26261
|
+
{ },
|
|
26262
|
+
{ },
|
|
26263
|
+
{ },
|
|
26264
|
+
{ },
|
|
26265
|
+
body,
|
|
26266
|
+
['PureCloud OAuth'],
|
|
26267
|
+
['application/json'],
|
|
26268
|
+
['application/json']
|
|
26269
|
+
);
|
|
26270
|
+
}
|
|
26271
|
+
|
|
26272
|
+
/**
|
|
26273
|
+
* Create new category
|
|
26274
|
+
*
|
|
26275
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26276
|
+
* @param {Object} body
|
|
26277
|
+
*/
|
|
26278
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
26279
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26280
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26281
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
26282
|
+
}
|
|
26283
|
+
// verify the required parameter 'body' is set
|
|
26284
|
+
if (body === undefined || body === null) {
|
|
26285
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
26286
|
+
}
|
|
26287
|
+
|
|
26288
|
+
return this.apiClient.callApi(
|
|
26289
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
26290
|
+
'POST',
|
|
26291
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26292
|
+
{ },
|
|
26293
|
+
{ },
|
|
26294
|
+
{ },
|
|
26295
|
+
body,
|
|
26296
|
+
['PureCloud OAuth'],
|
|
26297
|
+
['application/json'],
|
|
26298
|
+
['application/json']
|
|
26299
|
+
);
|
|
26300
|
+
}
|
|
26301
|
+
|
|
26302
|
+
/**
|
|
26303
|
+
* Create a variation for a document.
|
|
26304
|
+
*
|
|
26305
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
26306
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
26307
|
+
* @param {Object} body
|
|
26308
|
+
*/
|
|
26309
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
26310
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26311
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26312
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26313
|
+
}
|
|
26314
|
+
// verify the required parameter 'documentId' is set
|
|
26315
|
+
if (documentId === undefined || documentId === null) {
|
|
26316
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26317
|
+
}
|
|
26318
|
+
// verify the required parameter 'body' is set
|
|
26319
|
+
if (body === undefined || body === null) {
|
|
26320
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26321
|
+
}
|
|
26322
|
+
|
|
26323
|
+
return this.apiClient.callApi(
|
|
26324
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
26325
|
+
'POST',
|
|
26326
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
26327
|
+
{ },
|
|
26328
|
+
{ },
|
|
26329
|
+
{ },
|
|
26330
|
+
body,
|
|
26331
|
+
['PureCloud OAuth'],
|
|
26332
|
+
['application/json'],
|
|
26333
|
+
['application/json']
|
|
26334
|
+
);
|
|
26335
|
+
}
|
|
26336
|
+
|
|
26337
|
+
/**
|
|
26338
|
+
* Creates or restores a document version.
|
|
26339
|
+
*
|
|
26340
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
26341
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
26342
|
+
* @param {Object} body
|
|
26343
|
+
*/
|
|
26344
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
26345
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26346
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26347
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26348
|
+
}
|
|
26349
|
+
// verify the required parameter 'documentId' is set
|
|
26350
|
+
if (documentId === undefined || documentId === null) {
|
|
26351
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26352
|
+
}
|
|
26353
|
+
// verify the required parameter 'body' is set
|
|
26354
|
+
if (body === undefined || body === null) {
|
|
26355
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26356
|
+
}
|
|
26357
|
+
|
|
26358
|
+
return this.apiClient.callApi(
|
|
26359
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
26360
|
+
'POST',
|
|
26361
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
26362
|
+
{ },
|
|
26363
|
+
{ },
|
|
26364
|
+
{ },
|
|
26365
|
+
body,
|
|
26366
|
+
['PureCloud OAuth'],
|
|
26367
|
+
['application/json'],
|
|
26368
|
+
['application/json']
|
|
26369
|
+
);
|
|
26370
|
+
}
|
|
26371
|
+
|
|
26372
|
+
/**
|
|
26373
|
+
* Create document.
|
|
26374
|
+
*
|
|
26375
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26376
|
+
* @param {Object} body
|
|
26377
|
+
*/
|
|
26378
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
26379
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26380
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26381
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
26382
|
+
}
|
|
26383
|
+
// verify the required parameter 'body' is set
|
|
26384
|
+
if (body === undefined || body === null) {
|
|
26385
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
26386
|
+
}
|
|
26387
|
+
|
|
26388
|
+
return this.apiClient.callApi(
|
|
26389
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
26390
|
+
'POST',
|
|
26391
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26392
|
+
{ },
|
|
26393
|
+
{ },
|
|
26394
|
+
{ },
|
|
26395
|
+
body,
|
|
26396
|
+
['PureCloud OAuth'],
|
|
26397
|
+
['application/json'],
|
|
26398
|
+
['application/json']
|
|
26399
|
+
);
|
|
26400
|
+
}
|
|
26401
|
+
|
|
26402
|
+
/**
|
|
26403
|
+
* Search the documents in a knowledge base.
|
|
26404
|
+
*
|
|
26405
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
26406
|
+
* @param {Object} opts Optional parameters
|
|
26407
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
26408
|
+
* @param {Object} opts.body
|
|
26409
|
+
*/
|
|
26410
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
26411
|
+
opts = opts || {};
|
|
26412
|
+
|
|
26413
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26414
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26415
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
26416
|
+
}
|
|
26417
|
+
|
|
26418
|
+
return this.apiClient.callApi(
|
|
26419
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
26420
|
+
'POST',
|
|
26421
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26422
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
26423
|
+
{ },
|
|
26424
|
+
{ },
|
|
26425
|
+
opts['body'],
|
|
26426
|
+
['PureCloud OAuth'],
|
|
26427
|
+
['application/json'],
|
|
26428
|
+
['application/json']
|
|
26429
|
+
);
|
|
26430
|
+
}
|
|
26431
|
+
|
|
26432
|
+
/**
|
|
26433
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
26434
|
+
*
|
|
26435
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
26436
|
+
* @param {Object} opts Optional parameters
|
|
26437
|
+
* @param {Object} opts.body
|
|
26438
|
+
*/
|
|
26439
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
26440
|
+
opts = opts || {};
|
|
26441
|
+
|
|
26442
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26443
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26444
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
26445
|
+
}
|
|
26446
|
+
|
|
26447
|
+
return this.apiClient.callApi(
|
|
26448
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
26449
|
+
'POST',
|
|
26450
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26451
|
+
{ },
|
|
26452
|
+
{ },
|
|
26453
|
+
{ },
|
|
26454
|
+
opts['body'],
|
|
26455
|
+
['PureCloud OAuth'],
|
|
26456
|
+
['application/json'],
|
|
26457
|
+
['application/json']
|
|
26458
|
+
);
|
|
26459
|
+
}
|
|
26460
|
+
|
|
26461
|
+
/**
|
|
26462
|
+
* Create export job
|
|
26463
|
+
*
|
|
26464
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26465
|
+
* @param {Object} body
|
|
26466
|
+
*/
|
|
26467
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
26468
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26469
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26470
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
26471
|
+
}
|
|
26472
|
+
// verify the required parameter 'body' is set
|
|
26473
|
+
if (body === undefined || body === null) {
|
|
26474
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
26475
|
+
}
|
|
26476
|
+
|
|
26477
|
+
return this.apiClient.callApi(
|
|
26478
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
26479
|
+
'POST',
|
|
26480
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26481
|
+
{ },
|
|
26482
|
+
{ },
|
|
26483
|
+
{ },
|
|
26484
|
+
body,
|
|
26485
|
+
['PureCloud OAuth'],
|
|
26486
|
+
['application/json'],
|
|
26487
|
+
['application/json']
|
|
26488
|
+
);
|
|
26489
|
+
}
|
|
26490
|
+
|
|
26491
|
+
/**
|
|
26492
|
+
* Create import job
|
|
26493
|
+
*
|
|
26494
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26495
|
+
* @param {Object} body
|
|
26496
|
+
*/
|
|
26497
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
26498
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26499
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26500
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
26501
|
+
}
|
|
26502
|
+
// verify the required parameter 'body' is set
|
|
26503
|
+
if (body === undefined || body === null) {
|
|
26504
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
26505
|
+
}
|
|
26506
|
+
|
|
26507
|
+
return this.apiClient.callApi(
|
|
26508
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
26509
|
+
'POST',
|
|
26510
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26511
|
+
{ },
|
|
26512
|
+
{ },
|
|
26513
|
+
{ },
|
|
26514
|
+
body,
|
|
26515
|
+
['PureCloud OAuth'],
|
|
26516
|
+
['application/json'],
|
|
26517
|
+
['application/json']
|
|
26518
|
+
);
|
|
26519
|
+
}
|
|
26520
|
+
|
|
26521
|
+
/**
|
|
26522
|
+
* Create new label
|
|
26523
|
+
*
|
|
26524
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26525
|
+
* @param {Object} body
|
|
26526
|
+
*/
|
|
26527
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
26528
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26529
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26530
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
26531
|
+
}
|
|
26532
|
+
// verify the required parameter 'body' is set
|
|
26533
|
+
if (body === undefined || body === null) {
|
|
26534
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
26535
|
+
}
|
|
26536
|
+
|
|
26537
|
+
return this.apiClient.callApi(
|
|
26538
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
26539
|
+
'POST',
|
|
26540
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26541
|
+
{ },
|
|
26542
|
+
{ },
|
|
26543
|
+
{ },
|
|
26544
|
+
body,
|
|
26545
|
+
['PureCloud OAuth'],
|
|
26546
|
+
['application/json'],
|
|
26547
|
+
['application/json']
|
|
26548
|
+
);
|
|
26549
|
+
}
|
|
26550
|
+
|
|
25018
26551
|
/**
|
|
25019
26552
|
* Create new category
|
|
25020
26553
|
*
|
|
@@ -25245,7 +26778,7 @@ class LanguageUnderstandingApi {
|
|
|
25245
26778
|
/**
|
|
25246
26779
|
* LanguageUnderstanding service.
|
|
25247
26780
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25248
|
-
* @version
|
|
26781
|
+
* @version 146.0.0
|
|
25249
26782
|
*/
|
|
25250
26783
|
|
|
25251
26784
|
/**
|
|
@@ -26149,7 +27682,7 @@ class LanguagesApi {
|
|
|
26149
27682
|
/**
|
|
26150
27683
|
* Languages service.
|
|
26151
27684
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
26152
|
-
* @version
|
|
27685
|
+
* @version 146.0.0
|
|
26153
27686
|
*/
|
|
26154
27687
|
|
|
26155
27688
|
/**
|
|
@@ -26417,7 +27950,7 @@ class LearningApi {
|
|
|
26417
27950
|
/**
|
|
26418
27951
|
* Learning service.
|
|
26419
27952
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26420
|
-
* @version
|
|
27953
|
+
* @version 146.0.0
|
|
26421
27954
|
*/
|
|
26422
27955
|
|
|
26423
27956
|
/**
|
|
@@ -27177,7 +28710,7 @@ class LicenseApi {
|
|
|
27177
28710
|
/**
|
|
27178
28711
|
* License service.
|
|
27179
28712
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
27180
|
-
* @version
|
|
28713
|
+
* @version 146.0.0
|
|
27181
28714
|
*/
|
|
27182
28715
|
|
|
27183
28716
|
/**
|
|
@@ -27415,7 +28948,7 @@ class LocationsApi {
|
|
|
27415
28948
|
/**
|
|
27416
28949
|
* Locations service.
|
|
27417
28950
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27418
|
-
* @version
|
|
28951
|
+
* @version 146.0.0
|
|
27419
28952
|
*/
|
|
27420
28953
|
|
|
27421
28954
|
/**
|
|
@@ -27651,7 +29184,7 @@ class MessagingApi {
|
|
|
27651
29184
|
/**
|
|
27652
29185
|
* Messaging service.
|
|
27653
29186
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27654
|
-
* @version
|
|
29187
|
+
* @version 146.0.0
|
|
27655
29188
|
*/
|
|
27656
29189
|
|
|
27657
29190
|
/**
|
|
@@ -27802,7 +29335,7 @@ class MobileDevicesApi {
|
|
|
27802
29335
|
/**
|
|
27803
29336
|
* MobileDevices service.
|
|
27804
29337
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27805
|
-
* @version
|
|
29338
|
+
* @version 146.0.0
|
|
27806
29339
|
*/
|
|
27807
29340
|
|
|
27808
29341
|
/**
|
|
@@ -27953,7 +29486,7 @@ class NotificationsApi {
|
|
|
27953
29486
|
/**
|
|
27954
29487
|
* Notifications service.
|
|
27955
29488
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27956
|
-
* @version
|
|
29489
|
+
* @version 146.0.0
|
|
27957
29490
|
*/
|
|
27958
29491
|
|
|
27959
29492
|
/**
|
|
@@ -28178,7 +29711,7 @@ class OAuthApi {
|
|
|
28178
29711
|
/**
|
|
28179
29712
|
* OAuth service.
|
|
28180
29713
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
28181
|
-
* @version
|
|
29714
|
+
* @version 146.0.0
|
|
28182
29715
|
*/
|
|
28183
29716
|
|
|
28184
29717
|
/**
|
|
@@ -28544,7 +30077,7 @@ class ObjectsApi {
|
|
|
28544
30077
|
/**
|
|
28545
30078
|
* Objects service.
|
|
28546
30079
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28547
|
-
* @version
|
|
30080
|
+
* @version 146.0.0
|
|
28548
30081
|
*/
|
|
28549
30082
|
|
|
28550
30083
|
/**
|
|
@@ -28815,7 +30348,7 @@ class OrganizationApi {
|
|
|
28815
30348
|
/**
|
|
28816
30349
|
* Organization service.
|
|
28817
30350
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28818
|
-
* @version
|
|
30351
|
+
* @version 146.0.0
|
|
28819
30352
|
*/
|
|
28820
30353
|
|
|
28821
30354
|
/**
|
|
@@ -29218,7 +30751,7 @@ class OrganizationAuthorizationApi {
|
|
|
29218
30751
|
/**
|
|
29219
30752
|
* OrganizationAuthorization service.
|
|
29220
30753
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29221
|
-
* @version
|
|
30754
|
+
* @version 146.0.0
|
|
29222
30755
|
*/
|
|
29223
30756
|
|
|
29224
30757
|
/**
|
|
@@ -30143,7 +31676,7 @@ class OutboundApi {
|
|
|
30143
31676
|
/**
|
|
30144
31677
|
* Outbound service.
|
|
30145
31678
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
30146
|
-
* @version
|
|
31679
|
+
* @version 146.0.0
|
|
30147
31680
|
*/
|
|
30148
31681
|
|
|
30149
31682
|
/**
|
|
@@ -33398,7 +34931,7 @@ class PresenceApi {
|
|
|
33398
34931
|
/**
|
|
33399
34932
|
* Presence service.
|
|
33400
34933
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33401
|
-
* @version
|
|
34934
|
+
* @version 146.0.0
|
|
33402
34935
|
*/
|
|
33403
34936
|
|
|
33404
34937
|
/**
|
|
@@ -33720,7 +35253,7 @@ class QualityApi {
|
|
|
33720
35253
|
/**
|
|
33721
35254
|
* Quality service.
|
|
33722
35255
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
33723
|
-
* @version
|
|
35256
|
+
* @version 146.0.0
|
|
33724
35257
|
*/
|
|
33725
35258
|
|
|
33726
35259
|
/**
|
|
@@ -35298,7 +36831,7 @@ class RecordingApi {
|
|
|
35298
36831
|
/**
|
|
35299
36832
|
* Recording service.
|
|
35300
36833
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35301
|
-
* @version
|
|
36834
|
+
* @version 146.0.0
|
|
35302
36835
|
*/
|
|
35303
36836
|
|
|
35304
36837
|
/**
|
|
@@ -36951,7 +38484,7 @@ class ResponseManagementApi {
|
|
|
36951
38484
|
/**
|
|
36952
38485
|
* ResponseManagement service.
|
|
36953
38486
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
36954
|
-
* @version
|
|
38487
|
+
* @version 146.0.0
|
|
36955
38488
|
*/
|
|
36956
38489
|
|
|
36957
38490
|
/**
|
|
@@ -37435,7 +38968,7 @@ class RoutingApi {
|
|
|
37435
38968
|
/**
|
|
37436
38969
|
* Routing service.
|
|
37437
38970
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
37438
|
-
* @version
|
|
38971
|
+
* @version 146.0.0
|
|
37439
38972
|
*/
|
|
37440
38973
|
|
|
37441
38974
|
/**
|
|
@@ -40376,7 +41909,7 @@ class SCIMApi {
|
|
|
40376
41909
|
/**
|
|
40377
41910
|
* SCIM service.
|
|
40378
41911
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
40379
|
-
* @version
|
|
41912
|
+
* @version 146.0.0
|
|
40380
41913
|
*/
|
|
40381
41914
|
|
|
40382
41915
|
/**
|
|
@@ -41253,7 +42786,7 @@ class ScriptsApi {
|
|
|
41253
42786
|
/**
|
|
41254
42787
|
* Scripts service.
|
|
41255
42788
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
41256
|
-
* @version
|
|
42789
|
+
* @version 146.0.0
|
|
41257
42790
|
*/
|
|
41258
42791
|
|
|
41259
42792
|
/**
|
|
@@ -41672,7 +43205,7 @@ class SearchApi {
|
|
|
41672
43205
|
/**
|
|
41673
43206
|
* Search service.
|
|
41674
43207
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
41675
|
-
* @version
|
|
43208
|
+
* @version 146.0.0
|
|
41676
43209
|
*/
|
|
41677
43210
|
|
|
41678
43211
|
/**
|
|
@@ -42232,7 +43765,7 @@ class SpeechTextAnalyticsApi {
|
|
|
42232
43765
|
/**
|
|
42233
43766
|
* SpeechTextAnalytics service.
|
|
42234
43767
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
42235
|
-
* @version
|
|
43768
|
+
* @version 146.0.0
|
|
42236
43769
|
*/
|
|
42237
43770
|
|
|
42238
43771
|
/**
|
|
@@ -43086,7 +44619,7 @@ class StationsApi {
|
|
|
43086
44619
|
/**
|
|
43087
44620
|
* Stations service.
|
|
43088
44621
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
43089
|
-
* @version
|
|
44622
|
+
* @version 146.0.0
|
|
43090
44623
|
*/
|
|
43091
44624
|
|
|
43092
44625
|
/**
|
|
@@ -43233,7 +44766,7 @@ class SuggestApi {
|
|
|
43233
44766
|
/**
|
|
43234
44767
|
* Suggest service.
|
|
43235
44768
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
43236
|
-
* @version
|
|
44769
|
+
* @version 146.0.0
|
|
43237
44770
|
*/
|
|
43238
44771
|
|
|
43239
44772
|
/**
|
|
@@ -43372,7 +44905,7 @@ class TeamsApi {
|
|
|
43372
44905
|
/**
|
|
43373
44906
|
* Teams service.
|
|
43374
44907
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
43375
|
-
* @version
|
|
44908
|
+
* @version 146.0.0
|
|
43376
44909
|
*/
|
|
43377
44910
|
|
|
43378
44911
|
/**
|
|
@@ -43551,7 +45084,7 @@ class TelephonyApi {
|
|
|
43551
45084
|
/**
|
|
43552
45085
|
* Telephony service.
|
|
43553
45086
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
43554
|
-
* @version
|
|
45087
|
+
* @version 146.0.0
|
|
43555
45088
|
*/
|
|
43556
45089
|
|
|
43557
45090
|
/**
|
|
@@ -43659,7 +45192,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
43659
45192
|
/**
|
|
43660
45193
|
* TelephonyProvidersEdge service.
|
|
43661
45194
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
43662
|
-
* @version
|
|
45195
|
+
* @version 146.0.0
|
|
43663
45196
|
*/
|
|
43664
45197
|
|
|
43665
45198
|
/**
|
|
@@ -47292,7 +48825,7 @@ class TextbotsApi {
|
|
|
47292
48825
|
/**
|
|
47293
48826
|
* Textbots service.
|
|
47294
48827
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
47295
|
-
* @version
|
|
48828
|
+
* @version 146.0.0
|
|
47296
48829
|
*/
|
|
47297
48830
|
|
|
47298
48831
|
/**
|
|
@@ -47420,7 +48953,7 @@ class TokensApi {
|
|
|
47420
48953
|
/**
|
|
47421
48954
|
* Tokens service.
|
|
47422
48955
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
47423
|
-
* @version
|
|
48956
|
+
* @version 146.0.0
|
|
47424
48957
|
*/
|
|
47425
48958
|
|
|
47426
48959
|
/**
|
|
@@ -47526,7 +49059,7 @@ class UploadsApi {
|
|
|
47526
49059
|
/**
|
|
47527
49060
|
* Uploads service.
|
|
47528
49061
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
47529
|
-
* @version
|
|
49062
|
+
* @version 146.0.0
|
|
47530
49063
|
*/
|
|
47531
49064
|
|
|
47532
49065
|
/**
|
|
@@ -47702,7 +49235,7 @@ class UsageApi {
|
|
|
47702
49235
|
/**
|
|
47703
49236
|
* Usage service.
|
|
47704
49237
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
47705
|
-
* @version
|
|
49238
|
+
* @version 146.0.0
|
|
47706
49239
|
*/
|
|
47707
49240
|
|
|
47708
49241
|
/**
|
|
@@ -47773,7 +49306,7 @@ class UserRecordingsApi {
|
|
|
47773
49306
|
/**
|
|
47774
49307
|
* UserRecordings service.
|
|
47775
49308
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
47776
|
-
* @version
|
|
49309
|
+
* @version 146.0.0
|
|
47777
49310
|
*/
|
|
47778
49311
|
|
|
47779
49312
|
/**
|
|
@@ -47957,7 +49490,7 @@ class UsersApi {
|
|
|
47957
49490
|
/**
|
|
47958
49491
|
* Users service.
|
|
47959
49492
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
47960
|
-
* @version
|
|
49493
|
+
* @version 146.0.0
|
|
47961
49494
|
*/
|
|
47962
49495
|
|
|
47963
49496
|
/**
|
|
@@ -49820,7 +51353,7 @@ class UsersApi {
|
|
|
49820
51353
|
|
|
49821
51354
|
/**
|
|
49822
51355
|
* Create user
|
|
49823
|
-
*
|
|
51356
|
+
* If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
|
|
49824
51357
|
* @param {Object} body User
|
|
49825
51358
|
*/
|
|
49826
51359
|
postUsers(body) {
|
|
@@ -50259,7 +51792,7 @@ class UtilitiesApi {
|
|
|
50259
51792
|
/**
|
|
50260
51793
|
* Utilities service.
|
|
50261
51794
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
50262
|
-
* @version
|
|
51795
|
+
* @version 146.0.0
|
|
50263
51796
|
*/
|
|
50264
51797
|
|
|
50265
51798
|
/**
|
|
@@ -50370,7 +51903,7 @@ class VoicemailApi {
|
|
|
50370
51903
|
/**
|
|
50371
51904
|
* Voicemail service.
|
|
50372
51905
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
50373
|
-
* @version
|
|
51906
|
+
* @version 146.0.0
|
|
50374
51907
|
*/
|
|
50375
51908
|
|
|
50376
51909
|
/**
|
|
@@ -51037,7 +52570,7 @@ class WebChatApi {
|
|
|
51037
52570
|
/**
|
|
51038
52571
|
* WebChat service.
|
|
51039
52572
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
51040
|
-
* @version
|
|
52573
|
+
* @version 146.0.0
|
|
51041
52574
|
*/
|
|
51042
52575
|
|
|
51043
52576
|
/**
|
|
@@ -51581,7 +53114,7 @@ class WebDeploymentsApi {
|
|
|
51581
53114
|
/**
|
|
51582
53115
|
* WebDeployments service.
|
|
51583
53116
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
51584
|
-
* @version
|
|
53117
|
+
* @version 146.0.0
|
|
51585
53118
|
*/
|
|
51586
53119
|
|
|
51587
53120
|
/**
|
|
@@ -51936,7 +53469,7 @@ class WebMessagingApi {
|
|
|
51936
53469
|
/**
|
|
51937
53470
|
* WebMessaging service.
|
|
51938
53471
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
51939
|
-
* @version
|
|
53472
|
+
* @version 146.0.0
|
|
51940
53473
|
*/
|
|
51941
53474
|
|
|
51942
53475
|
/**
|
|
@@ -51982,7 +53515,7 @@ class WidgetsApi {
|
|
|
51982
53515
|
/**
|
|
51983
53516
|
* Widgets service.
|
|
51984
53517
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
51985
|
-
* @version
|
|
53518
|
+
* @version 146.0.0
|
|
51986
53519
|
*/
|
|
51987
53520
|
|
|
51988
53521
|
/**
|
|
@@ -52128,7 +53661,7 @@ class WorkforceManagementApi {
|
|
|
52128
53661
|
/**
|
|
52129
53662
|
* WorkforceManagement service.
|
|
52130
53663
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
52131
|
-
* @version
|
|
53664
|
+
* @version 146.0.0
|
|
52132
53665
|
*/
|
|
52133
53666
|
|
|
52134
53667
|
/**
|
|
@@ -56404,7 +57937,7 @@ class WorkforceManagementApi {
|
|
|
56404
57937
|
* </pre>
|
|
56405
57938
|
* </p>
|
|
56406
57939
|
* @module purecloud-platform-client-v2/index
|
|
56407
|
-
* @version
|
|
57940
|
+
* @version 146.0.0
|
|
56408
57941
|
*/
|
|
56409
57942
|
class platformClient {
|
|
56410
57943
|
constructor() {
|