purecloud-platform-client-v2 144.0.0 → 147.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 +2337 -305
- package/dist/web-amd/purecloud-platform-client-v2.js +2337 -305
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +2337 -305
- package/dist/web-cjs/purecloud-platform-client-v2.js +2337 -305
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1133 -49
- 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 +46 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +211 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +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 +1779 -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 +135 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +21 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +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 +32 -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 +30 -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 147.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 147.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 147.0.0
|
|
3669
3669
|
*/
|
|
3670
3670
|
|
|
3671
3671
|
/**
|
|
@@ -3911,6 +3911,26 @@ class AnalyticsApi {
|
|
|
3911
3911
|
);
|
|
3912
3912
|
}
|
|
3913
3913
|
|
|
3914
|
+
/**
|
|
3915
|
+
* Get analytics data retention setting
|
|
3916
|
+
*
|
|
3917
|
+
*/
|
|
3918
|
+
getAnalyticsDataretentionSettings() {
|
|
3919
|
+
|
|
3920
|
+
return this.apiClient.callApi(
|
|
3921
|
+
'/api/v2/analytics/dataretention/settings',
|
|
3922
|
+
'GET',
|
|
3923
|
+
{ },
|
|
3924
|
+
{ },
|
|
3925
|
+
{ },
|
|
3926
|
+
{ },
|
|
3927
|
+
null,
|
|
3928
|
+
['PureCloud OAuth'],
|
|
3929
|
+
['application/json'],
|
|
3930
|
+
['application/json']
|
|
3931
|
+
);
|
|
3932
|
+
}
|
|
3933
|
+
|
|
3914
3934
|
/**
|
|
3915
3935
|
* Get all view export requests for a user
|
|
3916
3936
|
*
|
|
@@ -4811,6 +4831,31 @@ class AnalyticsApi {
|
|
|
4811
4831
|
);
|
|
4812
4832
|
}
|
|
4813
4833
|
|
|
4834
|
+
/**
|
|
4835
|
+
* Update analytics data retention setting
|
|
4836
|
+
*
|
|
4837
|
+
* @param {Object} body retentionDays
|
|
4838
|
+
*/
|
|
4839
|
+
putAnalyticsDataretentionSettings(body) {
|
|
4840
|
+
// verify the required parameter 'body' is set
|
|
4841
|
+
if (body === undefined || body === null) {
|
|
4842
|
+
throw 'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';
|
|
4843
|
+
}
|
|
4844
|
+
|
|
4845
|
+
return this.apiClient.callApi(
|
|
4846
|
+
'/api/v2/analytics/dataretention/settings',
|
|
4847
|
+
'PUT',
|
|
4848
|
+
{ },
|
|
4849
|
+
{ },
|
|
4850
|
+
{ },
|
|
4851
|
+
{ },
|
|
4852
|
+
body,
|
|
4853
|
+
['PureCloud OAuth'],
|
|
4854
|
+
['application/json'],
|
|
4855
|
+
['application/json']
|
|
4856
|
+
);
|
|
4857
|
+
}
|
|
4858
|
+
|
|
4814
4859
|
/**
|
|
4815
4860
|
* Update a scheduled report job.
|
|
4816
4861
|
*
|
|
@@ -4847,7 +4892,7 @@ class ArchitectApi {
|
|
|
4847
4892
|
/**
|
|
4848
4893
|
* Architect service.
|
|
4849
4894
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4850
|
-
* @version
|
|
4895
|
+
* @version 147.0.0
|
|
4851
4896
|
*/
|
|
4852
4897
|
|
|
4853
4898
|
/**
|
|
@@ -5605,6 +5650,7 @@ class ArchitectApi {
|
|
|
5605
5650
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
5606
5651
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5607
5652
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
5653
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
5608
5654
|
*/
|
|
5609
5655
|
getArchitectIvrs(opts) {
|
|
5610
5656
|
opts = opts || {};
|
|
@@ -5614,7 +5660,7 @@ class ArchitectApi {
|
|
|
5614
5660
|
'/api/v2/architect/ivrs',
|
|
5615
5661
|
'GET',
|
|
5616
5662
|
{ },
|
|
5617
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
5663
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
5618
5664
|
{ },
|
|
5619
5665
|
{ },
|
|
5620
5666
|
null,
|
|
@@ -7892,7 +7938,7 @@ class AuditApi {
|
|
|
7892
7938
|
/**
|
|
7893
7939
|
* Audit service.
|
|
7894
7940
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7895
|
-
* @version
|
|
7941
|
+
* @version 147.0.0
|
|
7896
7942
|
*/
|
|
7897
7943
|
|
|
7898
7944
|
/**
|
|
@@ -8063,7 +8109,7 @@ class AuthorizationApi {
|
|
|
8063
8109
|
/**
|
|
8064
8110
|
* Authorization service.
|
|
8065
8111
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8066
|
-
* @version
|
|
8112
|
+
* @version 147.0.0
|
|
8067
8113
|
*/
|
|
8068
8114
|
|
|
8069
8115
|
/**
|
|
@@ -9246,7 +9292,7 @@ class BillingApi {
|
|
|
9246
9292
|
/**
|
|
9247
9293
|
* Billing service.
|
|
9248
9294
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9249
|
-
* @version
|
|
9295
|
+
* @version 147.0.0
|
|
9250
9296
|
*/
|
|
9251
9297
|
|
|
9252
9298
|
/**
|
|
@@ -9326,7 +9372,7 @@ class ChatApi {
|
|
|
9326
9372
|
/**
|
|
9327
9373
|
* Chat service.
|
|
9328
9374
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9329
|
-
* @version
|
|
9375
|
+
* @version 147.0.0
|
|
9330
9376
|
*/
|
|
9331
9377
|
|
|
9332
9378
|
/**
|
|
@@ -9417,7 +9463,7 @@ class CoachingApi {
|
|
|
9417
9463
|
/**
|
|
9418
9464
|
* Coaching service.
|
|
9419
9465
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9420
|
-
* @version
|
|
9466
|
+
* @version 147.0.0
|
|
9421
9467
|
*/
|
|
9422
9468
|
|
|
9423
9469
|
/**
|
|
@@ -9994,7 +10040,7 @@ class ContentManagementApi {
|
|
|
9994
10040
|
/**
|
|
9995
10041
|
* ContentManagement service.
|
|
9996
10042
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9997
|
-
* @version
|
|
10043
|
+
* @version 147.0.0
|
|
9998
10044
|
*/
|
|
9999
10045
|
|
|
10000
10046
|
/**
|
|
@@ -11134,7 +11180,7 @@ class ConversationsApi {
|
|
|
11134
11180
|
/**
|
|
11135
11181
|
* Conversations service.
|
|
11136
11182
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11137
|
-
* @version
|
|
11183
|
+
* @version 147.0.0
|
|
11138
11184
|
*/
|
|
11139
11185
|
|
|
11140
11186
|
/**
|
|
@@ -11727,6 +11773,31 @@ class ConversationsApi {
|
|
|
11727
11773
|
);
|
|
11728
11774
|
}
|
|
11729
11775
|
|
|
11776
|
+
/**
|
|
11777
|
+
* Get the secure attributes on a conversation.
|
|
11778
|
+
*
|
|
11779
|
+
* @param {String} conversationId conversation ID
|
|
11780
|
+
*/
|
|
11781
|
+
getConversationSecureattributes(conversationId) {
|
|
11782
|
+
// verify the required parameter 'conversationId' is set
|
|
11783
|
+
if (conversationId === undefined || conversationId === null) {
|
|
11784
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
|
|
11785
|
+
}
|
|
11786
|
+
|
|
11787
|
+
return this.apiClient.callApi(
|
|
11788
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
11789
|
+
'GET',
|
|
11790
|
+
{ 'conversationId': conversationId },
|
|
11791
|
+
{ },
|
|
11792
|
+
{ },
|
|
11793
|
+
{ },
|
|
11794
|
+
null,
|
|
11795
|
+
['PureCloud OAuth'],
|
|
11796
|
+
['application/json'],
|
|
11797
|
+
['application/json']
|
|
11798
|
+
);
|
|
11799
|
+
}
|
|
11800
|
+
|
|
11730
11801
|
/**
|
|
11731
11802
|
* Get active conversations for the logged in user
|
|
11732
11803
|
*
|
|
@@ -12510,6 +12581,51 @@ class ConversationsApi {
|
|
|
12510
12581
|
);
|
|
12511
12582
|
}
|
|
12512
12583
|
|
|
12584
|
+
/**
|
|
12585
|
+
* Get the encryption key configurations
|
|
12586
|
+
*
|
|
12587
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
12588
|
+
*/
|
|
12589
|
+
getConversationsKeyconfiguration(keyconfigurationsId) {
|
|
12590
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
12591
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
12592
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
|
|
12593
|
+
}
|
|
12594
|
+
|
|
12595
|
+
return this.apiClient.callApi(
|
|
12596
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
12597
|
+
'GET',
|
|
12598
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
12599
|
+
{ },
|
|
12600
|
+
{ },
|
|
12601
|
+
{ },
|
|
12602
|
+
null,
|
|
12603
|
+
['PureCloud OAuth'],
|
|
12604
|
+
['application/json'],
|
|
12605
|
+
['application/json']
|
|
12606
|
+
);
|
|
12607
|
+
}
|
|
12608
|
+
|
|
12609
|
+
/**
|
|
12610
|
+
* Get a list of key configurations data
|
|
12611
|
+
*
|
|
12612
|
+
*/
|
|
12613
|
+
getConversationsKeyconfigurations() {
|
|
12614
|
+
|
|
12615
|
+
return this.apiClient.callApi(
|
|
12616
|
+
'/api/v2/conversations/keyconfigurations',
|
|
12617
|
+
'GET',
|
|
12618
|
+
{ },
|
|
12619
|
+
{ },
|
|
12620
|
+
{ },
|
|
12621
|
+
{ },
|
|
12622
|
+
null,
|
|
12623
|
+
['PureCloud OAuth'],
|
|
12624
|
+
['application/json'],
|
|
12625
|
+
['application/json']
|
|
12626
|
+
);
|
|
12627
|
+
}
|
|
12628
|
+
|
|
12513
12629
|
/**
|
|
12514
12630
|
* Get message conversation
|
|
12515
12631
|
*
|
|
@@ -13226,6 +13342,36 @@ class ConversationsApi {
|
|
|
13226
13342
|
);
|
|
13227
13343
|
}
|
|
13228
13344
|
|
|
13345
|
+
/**
|
|
13346
|
+
* Update the secure attributes on a conversation.
|
|
13347
|
+
*
|
|
13348
|
+
* @param {String} conversationId conversation ID
|
|
13349
|
+
* @param {Object} body Conversation Secure Attributes
|
|
13350
|
+
*/
|
|
13351
|
+
patchConversationSecureattributes(conversationId, body) {
|
|
13352
|
+
// verify the required parameter 'conversationId' is set
|
|
13353
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13354
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
|
|
13355
|
+
}
|
|
13356
|
+
// verify the required parameter 'body' is set
|
|
13357
|
+
if (body === undefined || body === null) {
|
|
13358
|
+
throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
|
|
13359
|
+
}
|
|
13360
|
+
|
|
13361
|
+
return this.apiClient.callApi(
|
|
13362
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
13363
|
+
'PATCH',
|
|
13364
|
+
{ 'conversationId': conversationId },
|
|
13365
|
+
{ },
|
|
13366
|
+
{ },
|
|
13367
|
+
{ },
|
|
13368
|
+
body,
|
|
13369
|
+
['PureCloud OAuth'],
|
|
13370
|
+
['application/json'],
|
|
13371
|
+
['application/json']
|
|
13372
|
+
);
|
|
13373
|
+
}
|
|
13374
|
+
|
|
13229
13375
|
/**
|
|
13230
13376
|
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
13231
13377
|
*
|
|
@@ -15228,6 +15374,56 @@ class ConversationsApi {
|
|
|
15228
15374
|
);
|
|
15229
15375
|
}
|
|
15230
15376
|
|
|
15377
|
+
/**
|
|
15378
|
+
* Setup configurations for encryption key creation
|
|
15379
|
+
*
|
|
15380
|
+
* @param {Object} body Encryption Configuration
|
|
15381
|
+
*/
|
|
15382
|
+
postConversationsKeyconfigurations(body) {
|
|
15383
|
+
// verify the required parameter 'body' is set
|
|
15384
|
+
if (body === undefined || body === null) {
|
|
15385
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
|
|
15386
|
+
}
|
|
15387
|
+
|
|
15388
|
+
return this.apiClient.callApi(
|
|
15389
|
+
'/api/v2/conversations/keyconfigurations',
|
|
15390
|
+
'POST',
|
|
15391
|
+
{ },
|
|
15392
|
+
{ },
|
|
15393
|
+
{ },
|
|
15394
|
+
{ },
|
|
15395
|
+
body,
|
|
15396
|
+
['PureCloud OAuth'],
|
|
15397
|
+
['application/json'],
|
|
15398
|
+
['application/json']
|
|
15399
|
+
);
|
|
15400
|
+
}
|
|
15401
|
+
|
|
15402
|
+
/**
|
|
15403
|
+
* Validate encryption key configurations without saving it
|
|
15404
|
+
*
|
|
15405
|
+
* @param {Object} body Encryption Configuration
|
|
15406
|
+
*/
|
|
15407
|
+
postConversationsKeyconfigurationsValidate(body) {
|
|
15408
|
+
// verify the required parameter 'body' is set
|
|
15409
|
+
if (body === undefined || body === null) {
|
|
15410
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
|
|
15411
|
+
}
|
|
15412
|
+
|
|
15413
|
+
return this.apiClient.callApi(
|
|
15414
|
+
'/api/v2/conversations/keyconfigurations/validate',
|
|
15415
|
+
'POST',
|
|
15416
|
+
{ },
|
|
15417
|
+
{ },
|
|
15418
|
+
{ },
|
|
15419
|
+
{ },
|
|
15420
|
+
body,
|
|
15421
|
+
['PureCloud OAuth'],
|
|
15422
|
+
['application/json'],
|
|
15423
|
+
['application/json']
|
|
15424
|
+
);
|
|
15425
|
+
}
|
|
15426
|
+
|
|
15231
15427
|
/**
|
|
15232
15428
|
* Send message
|
|
15233
15429
|
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.
|
|
@@ -15612,6 +15808,36 @@ class ConversationsApi {
|
|
|
15612
15808
|
);
|
|
15613
15809
|
}
|
|
15614
15810
|
|
|
15811
|
+
/**
|
|
15812
|
+
* Set the secure attributes on a conversation.
|
|
15813
|
+
*
|
|
15814
|
+
* @param {String} conversationId conversation ID
|
|
15815
|
+
* @param {Object} body Conversation Secure Attributes
|
|
15816
|
+
*/
|
|
15817
|
+
putConversationSecureattributes(conversationId, body) {
|
|
15818
|
+
// verify the required parameter 'conversationId' is set
|
|
15819
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15820
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
|
|
15821
|
+
}
|
|
15822
|
+
// verify the required parameter 'body' is set
|
|
15823
|
+
if (body === undefined || body === null) {
|
|
15824
|
+
throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
|
|
15825
|
+
}
|
|
15826
|
+
|
|
15827
|
+
return this.apiClient.callApi(
|
|
15828
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
15829
|
+
'PUT',
|
|
15830
|
+
{ 'conversationId': conversationId },
|
|
15831
|
+
{ },
|
|
15832
|
+
{ },
|
|
15833
|
+
{ },
|
|
15834
|
+
body,
|
|
15835
|
+
['PureCloud OAuth'],
|
|
15836
|
+
['application/json'],
|
|
15837
|
+
['application/json']
|
|
15838
|
+
);
|
|
15839
|
+
}
|
|
15840
|
+
|
|
15615
15841
|
/**
|
|
15616
15842
|
* Update the tags on a conversation.
|
|
15617
15843
|
*
|
|
@@ -15862,6 +16088,36 @@ class ConversationsApi {
|
|
|
15862
16088
|
);
|
|
15863
16089
|
}
|
|
15864
16090
|
|
|
16091
|
+
/**
|
|
16092
|
+
* Update the encryption key configurations
|
|
16093
|
+
*
|
|
16094
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
16095
|
+
* @param {Object} body Encryption key configuration metadata
|
|
16096
|
+
*/
|
|
16097
|
+
putConversationsKeyconfiguration(keyconfigurationsId, body) {
|
|
16098
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
16099
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
16100
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
|
|
16101
|
+
}
|
|
16102
|
+
// verify the required parameter 'body' is set
|
|
16103
|
+
if (body === undefined || body === null) {
|
|
16104
|
+
throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
|
|
16105
|
+
}
|
|
16106
|
+
|
|
16107
|
+
return this.apiClient.callApi(
|
|
16108
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
16109
|
+
'PUT',
|
|
16110
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
16111
|
+
{ },
|
|
16112
|
+
{ },
|
|
16113
|
+
{ },
|
|
16114
|
+
body,
|
|
16115
|
+
['PureCloud OAuth'],
|
|
16116
|
+
['application/json'],
|
|
16117
|
+
['application/json']
|
|
16118
|
+
);
|
|
16119
|
+
}
|
|
16120
|
+
|
|
15865
16121
|
/**
|
|
15866
16122
|
* Update a conversation by setting its recording state
|
|
15867
16123
|
*
|
|
@@ -16068,7 +16324,7 @@ class DataExtensionsApi {
|
|
|
16068
16324
|
/**
|
|
16069
16325
|
* DataExtensions service.
|
|
16070
16326
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16071
|
-
* @version
|
|
16327
|
+
* @version 147.0.0
|
|
16072
16328
|
*/
|
|
16073
16329
|
|
|
16074
16330
|
/**
|
|
@@ -16154,7 +16410,7 @@ class ExternalContactsApi {
|
|
|
16154
16410
|
/**
|
|
16155
16411
|
* ExternalContacts service.
|
|
16156
16412
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16157
|
-
* @version
|
|
16413
|
+
* @version 147.0.0
|
|
16158
16414
|
*/
|
|
16159
16415
|
|
|
16160
16416
|
/**
|
|
@@ -17897,7 +18153,7 @@ class FaxApi {
|
|
|
17897
18153
|
/**
|
|
17898
18154
|
* Fax service.
|
|
17899
18155
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17900
|
-
* @version
|
|
18156
|
+
* @version 147.0.0
|
|
17901
18157
|
*/
|
|
17902
18158
|
|
|
17903
18159
|
/**
|
|
@@ -18068,7 +18324,7 @@ class FlowsApi {
|
|
|
18068
18324
|
/**
|
|
18069
18325
|
* Flows service.
|
|
18070
18326
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18071
|
-
* @version
|
|
18327
|
+
* @version 147.0.0
|
|
18072
18328
|
*/
|
|
18073
18329
|
|
|
18074
18330
|
/**
|
|
@@ -18139,7 +18395,7 @@ class GamificationApi {
|
|
|
18139
18395
|
/**
|
|
18140
18396
|
* Gamification service.
|
|
18141
18397
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18142
|
-
* @version
|
|
18398
|
+
* @version 147.0.0
|
|
18143
18399
|
*/
|
|
18144
18400
|
|
|
18145
18401
|
/**
|
|
@@ -19870,7 +20126,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19870
20126
|
/**
|
|
19871
20127
|
* GeneralDataProtectionRegulation service.
|
|
19872
20128
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19873
|
-
* @version
|
|
20129
|
+
* @version 147.0.0
|
|
19874
20130
|
*/
|
|
19875
20131
|
|
|
19876
20132
|
/**
|
|
@@ -20000,7 +20256,7 @@ class GeolocationApi {
|
|
|
20000
20256
|
/**
|
|
20001
20257
|
* Geolocation service.
|
|
20002
20258
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20003
|
-
* @version
|
|
20259
|
+
* @version 147.0.0
|
|
20004
20260
|
*/
|
|
20005
20261
|
|
|
20006
20262
|
/**
|
|
@@ -20131,7 +20387,7 @@ class GreetingsApi {
|
|
|
20131
20387
|
/**
|
|
20132
20388
|
* Greetings service.
|
|
20133
20389
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20134
|
-
* @version
|
|
20390
|
+
* @version 147.0.0
|
|
20135
20391
|
*/
|
|
20136
20392
|
|
|
20137
20393
|
/**
|
|
@@ -20586,7 +20842,7 @@ class GroupsApi {
|
|
|
20586
20842
|
/**
|
|
20587
20843
|
* Groups service.
|
|
20588
20844
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20589
|
-
* @version
|
|
20845
|
+
* @version 147.0.0
|
|
20590
20846
|
*/
|
|
20591
20847
|
|
|
20592
20848
|
/**
|
|
@@ -20991,7 +21247,7 @@ class IdentityProviderApi {
|
|
|
20991
21247
|
/**
|
|
20992
21248
|
* IdentityProvider service.
|
|
20993
21249
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20994
|
-
* @version
|
|
21250
|
+
* @version 147.0.0
|
|
20995
21251
|
*/
|
|
20996
21252
|
|
|
20997
21253
|
/**
|
|
@@ -21747,7 +22003,7 @@ class IntegrationsApi {
|
|
|
21747
22003
|
/**
|
|
21748
22004
|
* Integrations service.
|
|
21749
22005
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21750
|
-
* @version
|
|
22006
|
+
* @version 147.0.0
|
|
21751
22007
|
*/
|
|
21752
22008
|
|
|
21753
22009
|
/**
|
|
@@ -23424,7 +23680,7 @@ class JourneyApi {
|
|
|
23424
23680
|
/**
|
|
23425
23681
|
* Journey service.
|
|
23426
23682
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23427
|
-
* @version
|
|
23683
|
+
* @version 147.0.0
|
|
23428
23684
|
*/
|
|
23429
23685
|
|
|
23430
23686
|
/**
|
|
@@ -24135,7 +24391,7 @@ class KnowledgeApi {
|
|
|
24135
24391
|
/**
|
|
24136
24392
|
* Knowledge service.
|
|
24137
24393
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24138
|
-
* @version
|
|
24394
|
+
* @version 147.0.0
|
|
24139
24395
|
*/
|
|
24140
24396
|
|
|
24141
24397
|
/**
|
|
@@ -24175,6 +24431,191 @@ class KnowledgeApi {
|
|
|
24175
24431
|
);
|
|
24176
24432
|
}
|
|
24177
24433
|
|
|
24434
|
+
/**
|
|
24435
|
+
* Delete category
|
|
24436
|
+
*
|
|
24437
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24438
|
+
* @param {String} categoryId Category ID
|
|
24439
|
+
*/
|
|
24440
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
24441
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24442
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24443
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
24444
|
+
}
|
|
24445
|
+
// verify the required parameter 'categoryId' is set
|
|
24446
|
+
if (categoryId === undefined || categoryId === null) {
|
|
24447
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
24448
|
+
}
|
|
24449
|
+
|
|
24450
|
+
return this.apiClient.callApi(
|
|
24451
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
24452
|
+
'DELETE',
|
|
24453
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
24454
|
+
{ },
|
|
24455
|
+
{ },
|
|
24456
|
+
{ },
|
|
24457
|
+
null,
|
|
24458
|
+
['PureCloud OAuth'],
|
|
24459
|
+
['application/json'],
|
|
24460
|
+
['application/json']
|
|
24461
|
+
);
|
|
24462
|
+
}
|
|
24463
|
+
|
|
24464
|
+
/**
|
|
24465
|
+
* Delete document.
|
|
24466
|
+
*
|
|
24467
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
24468
|
+
* @param {String} documentId Document ID.
|
|
24469
|
+
*/
|
|
24470
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
24471
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24472
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24473
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
24474
|
+
}
|
|
24475
|
+
// verify the required parameter 'documentId' is set
|
|
24476
|
+
if (documentId === undefined || documentId === null) {
|
|
24477
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
24478
|
+
}
|
|
24479
|
+
|
|
24480
|
+
return this.apiClient.callApi(
|
|
24481
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
24482
|
+
'DELETE',
|
|
24483
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24484
|
+
{ },
|
|
24485
|
+
{ },
|
|
24486
|
+
{ },
|
|
24487
|
+
null,
|
|
24488
|
+
['PureCloud OAuth'],
|
|
24489
|
+
['application/json'],
|
|
24490
|
+
['application/json']
|
|
24491
|
+
);
|
|
24492
|
+
}
|
|
24493
|
+
|
|
24494
|
+
/**
|
|
24495
|
+
* Delete a variation for a document.
|
|
24496
|
+
*
|
|
24497
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
24498
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
24499
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
24500
|
+
*/
|
|
24501
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
24502
|
+
// verify the required parameter 'documentVariationId' is set
|
|
24503
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
24504
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24505
|
+
}
|
|
24506
|
+
// verify the required parameter 'documentId' is set
|
|
24507
|
+
if (documentId === undefined || documentId === null) {
|
|
24508
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24509
|
+
}
|
|
24510
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24511
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24512
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
24513
|
+
}
|
|
24514
|
+
|
|
24515
|
+
return this.apiClient.callApi(
|
|
24516
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
24517
|
+
'DELETE',
|
|
24518
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
24519
|
+
{ },
|
|
24520
|
+
{ },
|
|
24521
|
+
{ },
|
|
24522
|
+
null,
|
|
24523
|
+
['PureCloud OAuth'],
|
|
24524
|
+
['application/json'],
|
|
24525
|
+
['application/json']
|
|
24526
|
+
);
|
|
24527
|
+
}
|
|
24528
|
+
|
|
24529
|
+
/**
|
|
24530
|
+
* Delete export job
|
|
24531
|
+
*
|
|
24532
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24533
|
+
* @param {String} exportJobId Export job ID
|
|
24534
|
+
*/
|
|
24535
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
24536
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24537
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24538
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
24539
|
+
}
|
|
24540
|
+
// verify the required parameter 'exportJobId' is set
|
|
24541
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
24542
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
24543
|
+
}
|
|
24544
|
+
|
|
24545
|
+
return this.apiClient.callApi(
|
|
24546
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
24547
|
+
'DELETE',
|
|
24548
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
24549
|
+
{ },
|
|
24550
|
+
{ },
|
|
24551
|
+
{ },
|
|
24552
|
+
null,
|
|
24553
|
+
['PureCloud OAuth'],
|
|
24554
|
+
['application/json'],
|
|
24555
|
+
['application/json']
|
|
24556
|
+
);
|
|
24557
|
+
}
|
|
24558
|
+
|
|
24559
|
+
/**
|
|
24560
|
+
* Delete import job
|
|
24561
|
+
*
|
|
24562
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24563
|
+
* @param {String} importJobId Import job ID
|
|
24564
|
+
*/
|
|
24565
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
24566
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24567
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24568
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
24569
|
+
}
|
|
24570
|
+
// verify the required parameter 'importJobId' is set
|
|
24571
|
+
if (importJobId === undefined || importJobId === null) {
|
|
24572
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
24573
|
+
}
|
|
24574
|
+
|
|
24575
|
+
return this.apiClient.callApi(
|
|
24576
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
24577
|
+
'DELETE',
|
|
24578
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
24579
|
+
{ },
|
|
24580
|
+
{ },
|
|
24581
|
+
{ },
|
|
24582
|
+
null,
|
|
24583
|
+
['PureCloud OAuth'],
|
|
24584
|
+
['application/json'],
|
|
24585
|
+
['application/json']
|
|
24586
|
+
);
|
|
24587
|
+
}
|
|
24588
|
+
|
|
24589
|
+
/**
|
|
24590
|
+
* Delete label
|
|
24591
|
+
*
|
|
24592
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24593
|
+
* @param {String} labelId Label ID
|
|
24594
|
+
*/
|
|
24595
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
24596
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24597
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24598
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
24599
|
+
}
|
|
24600
|
+
// verify the required parameter 'labelId' is set
|
|
24601
|
+
if (labelId === undefined || labelId === null) {
|
|
24602
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
24603
|
+
}
|
|
24604
|
+
|
|
24605
|
+
return this.apiClient.callApi(
|
|
24606
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
24607
|
+
'DELETE',
|
|
24608
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
24609
|
+
{ },
|
|
24610
|
+
{ },
|
|
24611
|
+
{ },
|
|
24612
|
+
null,
|
|
24613
|
+
['PureCloud OAuth'],
|
|
24614
|
+
['application/json'],
|
|
24615
|
+
['application/json']
|
|
24616
|
+
);
|
|
24617
|
+
}
|
|
24618
|
+
|
|
24178
24619
|
/**
|
|
24179
24620
|
* Delete category
|
|
24180
24621
|
*
|
|
@@ -24280,6 +24721,104 @@ class KnowledgeApi {
|
|
|
24280
24721
|
);
|
|
24281
24722
|
}
|
|
24282
24723
|
|
|
24724
|
+
/**
|
|
24725
|
+
* Get categories
|
|
24726
|
+
*
|
|
24727
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24728
|
+
* @param {Object} opts Optional parameters
|
|
24729
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24730
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24731
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24732
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
24733
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
24734
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
24735
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
24736
|
+
* @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.
|
|
24737
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
24738
|
+
*/
|
|
24739
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
24740
|
+
opts = opts || {};
|
|
24741
|
+
|
|
24742
|
+
// verify the required parameter 'sessionId' is set
|
|
24743
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24744
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
24745
|
+
}
|
|
24746
|
+
|
|
24747
|
+
return this.apiClient.callApi(
|
|
24748
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
24749
|
+
'GET',
|
|
24750
|
+
{ 'sessionId': sessionId },
|
|
24751
|
+
{ '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'] },
|
|
24752
|
+
{ },
|
|
24753
|
+
{ },
|
|
24754
|
+
null,
|
|
24755
|
+
['PureCloud OAuth'],
|
|
24756
|
+
['application/json'],
|
|
24757
|
+
['application/json']
|
|
24758
|
+
);
|
|
24759
|
+
}
|
|
24760
|
+
|
|
24761
|
+
/**
|
|
24762
|
+
* Get a knowledge document by ID.
|
|
24763
|
+
*
|
|
24764
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24765
|
+
* @param {String} documentId Document ID
|
|
24766
|
+
*/
|
|
24767
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
24768
|
+
// verify the required parameter 'sessionId' is set
|
|
24769
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24770
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
24771
|
+
}
|
|
24772
|
+
// verify the required parameter 'documentId' is set
|
|
24773
|
+
if (documentId === undefined || documentId === null) {
|
|
24774
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
24775
|
+
}
|
|
24776
|
+
|
|
24777
|
+
return this.apiClient.callApi(
|
|
24778
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
24779
|
+
'GET',
|
|
24780
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
24781
|
+
{ },
|
|
24782
|
+
{ },
|
|
24783
|
+
{ },
|
|
24784
|
+
null,
|
|
24785
|
+
['PureCloud OAuth'],
|
|
24786
|
+
['application/json'],
|
|
24787
|
+
['application/json']
|
|
24788
|
+
);
|
|
24789
|
+
}
|
|
24790
|
+
|
|
24791
|
+
/**
|
|
24792
|
+
* Get documents.
|
|
24793
|
+
*
|
|
24794
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
24795
|
+
* @param {Object} opts Optional parameters
|
|
24796
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
24797
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
24798
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24799
|
+
*/
|
|
24800
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
24801
|
+
opts = opts || {};
|
|
24802
|
+
|
|
24803
|
+
// verify the required parameter 'sessionId' is set
|
|
24804
|
+
if (sessionId === undefined || sessionId === null) {
|
|
24805
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
24806
|
+
}
|
|
24807
|
+
|
|
24808
|
+
return this.apiClient.callApi(
|
|
24809
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
24810
|
+
'GET',
|
|
24811
|
+
{ 'sessionId': sessionId },
|
|
24812
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
24813
|
+
{ },
|
|
24814
|
+
{ },
|
|
24815
|
+
null,
|
|
24816
|
+
['PureCloud OAuth'],
|
|
24817
|
+
['application/json'],
|
|
24818
|
+
['application/json']
|
|
24819
|
+
);
|
|
24820
|
+
}
|
|
24821
|
+
|
|
24283
24822
|
/**
|
|
24284
24823
|
* Get knowledge base
|
|
24285
24824
|
*
|
|
@@ -24305,6 +24844,502 @@ class KnowledgeApi {
|
|
|
24305
24844
|
);
|
|
24306
24845
|
}
|
|
24307
24846
|
|
|
24847
|
+
/**
|
|
24848
|
+
* Get categories
|
|
24849
|
+
*
|
|
24850
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24851
|
+
* @param {Object} opts Optional parameters
|
|
24852
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24853
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24854
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24855
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
24856
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
24857
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
24858
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
24859
|
+
* @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.
|
|
24860
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
24861
|
+
*/
|
|
24862
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
24863
|
+
opts = opts || {};
|
|
24864
|
+
|
|
24865
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24866
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24867
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
24868
|
+
}
|
|
24869
|
+
|
|
24870
|
+
return this.apiClient.callApi(
|
|
24871
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
24872
|
+
'GET',
|
|
24873
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
24874
|
+
{ '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'] },
|
|
24875
|
+
{ },
|
|
24876
|
+
{ },
|
|
24877
|
+
null,
|
|
24878
|
+
['PureCloud OAuth'],
|
|
24879
|
+
['application/json'],
|
|
24880
|
+
['application/json']
|
|
24881
|
+
);
|
|
24882
|
+
}
|
|
24883
|
+
|
|
24884
|
+
/**
|
|
24885
|
+
* Get category
|
|
24886
|
+
*
|
|
24887
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24888
|
+
* @param {String} categoryId Category ID
|
|
24889
|
+
*/
|
|
24890
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
24891
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24892
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24893
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
24894
|
+
}
|
|
24895
|
+
// verify the required parameter 'categoryId' is set
|
|
24896
|
+
if (categoryId === undefined || categoryId === null) {
|
|
24897
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
24898
|
+
}
|
|
24899
|
+
|
|
24900
|
+
return this.apiClient.callApi(
|
|
24901
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
24902
|
+
'GET',
|
|
24903
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
24904
|
+
{ },
|
|
24905
|
+
{ },
|
|
24906
|
+
{ },
|
|
24907
|
+
null,
|
|
24908
|
+
['PureCloud OAuth'],
|
|
24909
|
+
['application/json'],
|
|
24910
|
+
['application/json']
|
|
24911
|
+
);
|
|
24912
|
+
}
|
|
24913
|
+
|
|
24914
|
+
/**
|
|
24915
|
+
* Get document.
|
|
24916
|
+
*
|
|
24917
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
24918
|
+
* @param {String} documentId Document ID.
|
|
24919
|
+
* @param {Object} opts Optional parameters
|
|
24920
|
+
* @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.
|
|
24921
|
+
* @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.
|
|
24922
|
+
*/
|
|
24923
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
24924
|
+
opts = opts || {};
|
|
24925
|
+
|
|
24926
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24927
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24928
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
24929
|
+
}
|
|
24930
|
+
// verify the required parameter 'documentId' is set
|
|
24931
|
+
if (documentId === undefined || documentId === null) {
|
|
24932
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
24933
|
+
}
|
|
24934
|
+
|
|
24935
|
+
return this.apiClient.callApi(
|
|
24936
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
24937
|
+
'GET',
|
|
24938
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
24939
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
24940
|
+
{ },
|
|
24941
|
+
{ },
|
|
24942
|
+
null,
|
|
24943
|
+
['PureCloud OAuth'],
|
|
24944
|
+
['application/json'],
|
|
24945
|
+
['application/json']
|
|
24946
|
+
);
|
|
24947
|
+
}
|
|
24948
|
+
|
|
24949
|
+
/**
|
|
24950
|
+
* Get a variation for a document.
|
|
24951
|
+
*
|
|
24952
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
24953
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
24954
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
24955
|
+
* @param {Object} opts Optional parameters
|
|
24956
|
+
* @param {Object} opts.documentState The state of the document.
|
|
24957
|
+
*/
|
|
24958
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
24959
|
+
opts = opts || {};
|
|
24960
|
+
|
|
24961
|
+
// verify the required parameter 'documentVariationId' is set
|
|
24962
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
24963
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24964
|
+
}
|
|
24965
|
+
// verify the required parameter 'documentId' is set
|
|
24966
|
+
if (documentId === undefined || documentId === null) {
|
|
24967
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24968
|
+
}
|
|
24969
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
24970
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
24971
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
24972
|
+
}
|
|
24973
|
+
|
|
24974
|
+
return this.apiClient.callApi(
|
|
24975
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
24976
|
+
'GET',
|
|
24977
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
24978
|
+
{ 'documentState': opts['documentState'] },
|
|
24979
|
+
{ },
|
|
24980
|
+
{ },
|
|
24981
|
+
null,
|
|
24982
|
+
['PureCloud OAuth'],
|
|
24983
|
+
['application/json'],
|
|
24984
|
+
['application/json']
|
|
24985
|
+
);
|
|
24986
|
+
}
|
|
24987
|
+
|
|
24988
|
+
/**
|
|
24989
|
+
* Get variations for a document.
|
|
24990
|
+
*
|
|
24991
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
24992
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
24993
|
+
* @param {Object} opts Optional parameters
|
|
24994
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24995
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24996
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24997
|
+
* @param {Object} opts.documentState The state of the document.
|
|
24998
|
+
*/
|
|
24999
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
25000
|
+
opts = opts || {};
|
|
25001
|
+
|
|
25002
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25003
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25004
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
25005
|
+
}
|
|
25006
|
+
// verify the required parameter 'documentId' is set
|
|
25007
|
+
if (documentId === undefined || documentId === null) {
|
|
25008
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
25009
|
+
}
|
|
25010
|
+
|
|
25011
|
+
return this.apiClient.callApi(
|
|
25012
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
25013
|
+
'GET',
|
|
25014
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
25015
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
25016
|
+
{ },
|
|
25017
|
+
{ },
|
|
25018
|
+
null,
|
|
25019
|
+
['PureCloud OAuth'],
|
|
25020
|
+
['application/json'],
|
|
25021
|
+
['application/json']
|
|
25022
|
+
);
|
|
25023
|
+
}
|
|
25024
|
+
|
|
25025
|
+
/**
|
|
25026
|
+
* Get document version.
|
|
25027
|
+
*
|
|
25028
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25029
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25030
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
25031
|
+
* @param {Object} opts Optional parameters
|
|
25032
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
25033
|
+
*/
|
|
25034
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
25035
|
+
opts = opts || {};
|
|
25036
|
+
|
|
25037
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25038
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25039
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
25040
|
+
}
|
|
25041
|
+
// verify the required parameter 'documentId' is set
|
|
25042
|
+
if (documentId === undefined || documentId === null) {
|
|
25043
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
25044
|
+
}
|
|
25045
|
+
// verify the required parameter 'versionId' is set
|
|
25046
|
+
if (versionId === undefined || versionId === null) {
|
|
25047
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
25048
|
+
}
|
|
25049
|
+
|
|
25050
|
+
return this.apiClient.callApi(
|
|
25051
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
25052
|
+
'GET',
|
|
25053
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
25054
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25055
|
+
{ },
|
|
25056
|
+
{ },
|
|
25057
|
+
null,
|
|
25058
|
+
['PureCloud OAuth'],
|
|
25059
|
+
['application/json'],
|
|
25060
|
+
['application/json']
|
|
25061
|
+
);
|
|
25062
|
+
}
|
|
25063
|
+
|
|
25064
|
+
/**
|
|
25065
|
+
* Get variation for the given document version.
|
|
25066
|
+
*
|
|
25067
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25068
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25069
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
25070
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
25071
|
+
*/
|
|
25072
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
25073
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25074
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25075
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25076
|
+
}
|
|
25077
|
+
// verify the required parameter 'documentId' is set
|
|
25078
|
+
if (documentId === undefined || documentId === null) {
|
|
25079
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25080
|
+
}
|
|
25081
|
+
// verify the required parameter 'versionId' is set
|
|
25082
|
+
if (versionId === undefined || versionId === null) {
|
|
25083
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25084
|
+
}
|
|
25085
|
+
// verify the required parameter 'variationId' is set
|
|
25086
|
+
if (variationId === undefined || variationId === null) {
|
|
25087
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
25088
|
+
}
|
|
25089
|
+
|
|
25090
|
+
return this.apiClient.callApi(
|
|
25091
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
25092
|
+
'GET',
|
|
25093
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
25094
|
+
{ },
|
|
25095
|
+
{ },
|
|
25096
|
+
{ },
|
|
25097
|
+
null,
|
|
25098
|
+
['PureCloud OAuth'],
|
|
25099
|
+
['application/json'],
|
|
25100
|
+
['application/json']
|
|
25101
|
+
);
|
|
25102
|
+
}
|
|
25103
|
+
|
|
25104
|
+
/**
|
|
25105
|
+
* Get variations for the given document version.
|
|
25106
|
+
*
|
|
25107
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25108
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25109
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
25110
|
+
* @param {Object} opts Optional parameters
|
|
25111
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25112
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25113
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25114
|
+
*/
|
|
25115
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
25116
|
+
opts = opts || {};
|
|
25117
|
+
|
|
25118
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25119
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25120
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25121
|
+
}
|
|
25122
|
+
// verify the required parameter 'documentId' is set
|
|
25123
|
+
if (documentId === undefined || documentId === null) {
|
|
25124
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25125
|
+
}
|
|
25126
|
+
// verify the required parameter 'versionId' is set
|
|
25127
|
+
if (versionId === undefined || versionId === null) {
|
|
25128
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
25129
|
+
}
|
|
25130
|
+
|
|
25131
|
+
return this.apiClient.callApi(
|
|
25132
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
25133
|
+
'GET',
|
|
25134
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
25135
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
25136
|
+
{ },
|
|
25137
|
+
{ },
|
|
25138
|
+
null,
|
|
25139
|
+
['PureCloud OAuth'],
|
|
25140
|
+
['application/json'],
|
|
25141
|
+
['application/json']
|
|
25142
|
+
);
|
|
25143
|
+
}
|
|
25144
|
+
|
|
25145
|
+
/**
|
|
25146
|
+
* Get document versions.
|
|
25147
|
+
*
|
|
25148
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
25149
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
25150
|
+
* @param {Object} opts Optional parameters
|
|
25151
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25152
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25153
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25154
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
25155
|
+
*/
|
|
25156
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
25157
|
+
opts = opts || {};
|
|
25158
|
+
|
|
25159
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25160
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25161
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
25162
|
+
}
|
|
25163
|
+
// verify the required parameter 'documentId' is set
|
|
25164
|
+
if (documentId === undefined || documentId === null) {
|
|
25165
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
25166
|
+
}
|
|
25167
|
+
|
|
25168
|
+
return this.apiClient.callApi(
|
|
25169
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
25170
|
+
'GET',
|
|
25171
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
25172
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
25173
|
+
{ },
|
|
25174
|
+
{ },
|
|
25175
|
+
null,
|
|
25176
|
+
['PureCloud OAuth'],
|
|
25177
|
+
['application/json'],
|
|
25178
|
+
['application/json']
|
|
25179
|
+
);
|
|
25180
|
+
}
|
|
25181
|
+
|
|
25182
|
+
/**
|
|
25183
|
+
* Get documents.
|
|
25184
|
+
*
|
|
25185
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25186
|
+
* @param {Object} opts Optional parameters
|
|
25187
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25188
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25189
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25190
|
+
* @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
|
|
25191
|
+
* @param {Array.<String>} opts.documentId Retrieves the specified documents, comma separated values expected.
|
|
25192
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
25193
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
25194
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
25195
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
25196
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
25197
|
+
*/
|
|
25198
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
25199
|
+
opts = opts || {};
|
|
25200
|
+
|
|
25201
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25202
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25203
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
25204
|
+
}
|
|
25205
|
+
|
|
25206
|
+
return this.apiClient.callApi(
|
|
25207
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
25208
|
+
'GET',
|
|
25209
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25210
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'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') },
|
|
25211
|
+
{ },
|
|
25212
|
+
{ },
|
|
25213
|
+
null,
|
|
25214
|
+
['PureCloud OAuth'],
|
|
25215
|
+
['application/json'],
|
|
25216
|
+
['application/json']
|
|
25217
|
+
);
|
|
25218
|
+
}
|
|
25219
|
+
|
|
25220
|
+
/**
|
|
25221
|
+
* Get export job report
|
|
25222
|
+
*
|
|
25223
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25224
|
+
* @param {String} exportJobId Export job ID
|
|
25225
|
+
*/
|
|
25226
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
25227
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25228
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25229
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
25230
|
+
}
|
|
25231
|
+
// verify the required parameter 'exportJobId' is set
|
|
25232
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
25233
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
25234
|
+
}
|
|
25235
|
+
|
|
25236
|
+
return this.apiClient.callApi(
|
|
25237
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
25238
|
+
'GET',
|
|
25239
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
25240
|
+
{ },
|
|
25241
|
+
{ },
|
|
25242
|
+
{ },
|
|
25243
|
+
null,
|
|
25244
|
+
['PureCloud OAuth'],
|
|
25245
|
+
['application/json'],
|
|
25246
|
+
['application/json']
|
|
25247
|
+
);
|
|
25248
|
+
}
|
|
25249
|
+
|
|
25250
|
+
/**
|
|
25251
|
+
* Get import job report
|
|
25252
|
+
*
|
|
25253
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25254
|
+
* @param {String} importJobId Import job ID
|
|
25255
|
+
*/
|
|
25256
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
25257
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25258
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25259
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
25260
|
+
}
|
|
25261
|
+
// verify the required parameter 'importJobId' is set
|
|
25262
|
+
if (importJobId === undefined || importJobId === null) {
|
|
25263
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
25264
|
+
}
|
|
25265
|
+
|
|
25266
|
+
return this.apiClient.callApi(
|
|
25267
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
25268
|
+
'GET',
|
|
25269
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
25270
|
+
{ },
|
|
25271
|
+
{ },
|
|
25272
|
+
{ },
|
|
25273
|
+
null,
|
|
25274
|
+
['PureCloud OAuth'],
|
|
25275
|
+
['application/json'],
|
|
25276
|
+
['application/json']
|
|
25277
|
+
);
|
|
25278
|
+
}
|
|
25279
|
+
|
|
25280
|
+
/**
|
|
25281
|
+
* Get label
|
|
25282
|
+
*
|
|
25283
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25284
|
+
* @param {String} labelId Label ID
|
|
25285
|
+
*/
|
|
25286
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
25287
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25288
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25289
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
25290
|
+
}
|
|
25291
|
+
// verify the required parameter 'labelId' is set
|
|
25292
|
+
if (labelId === undefined || labelId === null) {
|
|
25293
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
25294
|
+
}
|
|
25295
|
+
|
|
25296
|
+
return this.apiClient.callApi(
|
|
25297
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
25298
|
+
'GET',
|
|
25299
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
25300
|
+
{ },
|
|
25301
|
+
{ },
|
|
25302
|
+
{ },
|
|
25303
|
+
null,
|
|
25304
|
+
['PureCloud OAuth'],
|
|
25305
|
+
['application/json'],
|
|
25306
|
+
['application/json']
|
|
25307
|
+
);
|
|
25308
|
+
}
|
|
25309
|
+
|
|
25310
|
+
/**
|
|
25311
|
+
* Get labels
|
|
25312
|
+
*
|
|
25313
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25314
|
+
* @param {Object} opts Optional parameters
|
|
25315
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25316
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25317
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25318
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
25319
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
25320
|
+
*/
|
|
25321
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
25322
|
+
opts = opts || {};
|
|
25323
|
+
|
|
25324
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25325
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25326
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
25327
|
+
}
|
|
25328
|
+
|
|
25329
|
+
return this.apiClient.callApi(
|
|
25330
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
25331
|
+
'GET',
|
|
25332
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25333
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
25334
|
+
{ },
|
|
25335
|
+
{ },
|
|
25336
|
+
null,
|
|
25337
|
+
['PureCloud OAuth'],
|
|
25338
|
+
['application/json'],
|
|
25339
|
+
['application/json']
|
|
25340
|
+
);
|
|
25341
|
+
}
|
|
25342
|
+
|
|
24308
25343
|
/**
|
|
24309
25344
|
* Get categories
|
|
24310
25345
|
*
|
|
@@ -24563,6 +25598,108 @@ class KnowledgeApi {
|
|
|
24563
25598
|
);
|
|
24564
25599
|
}
|
|
24565
25600
|
|
|
25601
|
+
/**
|
|
25602
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
25603
|
+
*
|
|
25604
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25605
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
25606
|
+
* @param {Object} opts Optional parameters
|
|
25607
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25608
|
+
*/
|
|
25609
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
25610
|
+
opts = opts || {};
|
|
25611
|
+
|
|
25612
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25613
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25614
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
25615
|
+
}
|
|
25616
|
+
// verify the required parameter 'groupId' is set
|
|
25617
|
+
if (groupId === undefined || groupId === null) {
|
|
25618
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
25619
|
+
}
|
|
25620
|
+
|
|
25621
|
+
return this.apiClient.callApi(
|
|
25622
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
25623
|
+
'GET',
|
|
25624
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
25625
|
+
{ 'app': opts['app'] },
|
|
25626
|
+
{ },
|
|
25627
|
+
{ },
|
|
25628
|
+
null,
|
|
25629
|
+
['PureCloud OAuth'],
|
|
25630
|
+
['application/json'],
|
|
25631
|
+
['application/json']
|
|
25632
|
+
);
|
|
25633
|
+
}
|
|
25634
|
+
|
|
25635
|
+
/**
|
|
25636
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
25637
|
+
*
|
|
25638
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25639
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
25640
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
25641
|
+
* @param {Object} opts Optional parameters
|
|
25642
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25643
|
+
*/
|
|
25644
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
25645
|
+
opts = opts || {};
|
|
25646
|
+
|
|
25647
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25648
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25649
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25650
|
+
}
|
|
25651
|
+
// verify the required parameter 'groupId' is set
|
|
25652
|
+
if (groupId === undefined || groupId === null) {
|
|
25653
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25654
|
+
}
|
|
25655
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
25656
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
25657
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
25658
|
+
}
|
|
25659
|
+
|
|
25660
|
+
return this.apiClient.callApi(
|
|
25661
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
25662
|
+
'GET',
|
|
25663
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
25664
|
+
{ 'app': opts['app'] },
|
|
25665
|
+
{ },
|
|
25666
|
+
{ },
|
|
25667
|
+
null,
|
|
25668
|
+
['PureCloud OAuth'],
|
|
25669
|
+
['application/json'],
|
|
25670
|
+
['application/json']
|
|
25671
|
+
);
|
|
25672
|
+
}
|
|
25673
|
+
|
|
25674
|
+
/**
|
|
25675
|
+
* Get knowledge base unanswered groups
|
|
25676
|
+
*
|
|
25677
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25678
|
+
* @param {Object} opts Optional parameters
|
|
25679
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
25680
|
+
*/
|
|
25681
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
25682
|
+
opts = opts || {};
|
|
25683
|
+
|
|
25684
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25685
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25686
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
25687
|
+
}
|
|
25688
|
+
|
|
25689
|
+
return this.apiClient.callApi(
|
|
25690
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
25691
|
+
'GET',
|
|
25692
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
25693
|
+
{ 'app': opts['app'] },
|
|
25694
|
+
{ },
|
|
25695
|
+
{ },
|
|
25696
|
+
null,
|
|
25697
|
+
['PureCloud OAuth'],
|
|
25698
|
+
['application/json'],
|
|
25699
|
+
['application/json']
|
|
25700
|
+
);
|
|
25701
|
+
}
|
|
25702
|
+
|
|
24566
25703
|
/**
|
|
24567
25704
|
* Get knowledge bases
|
|
24568
25705
|
*
|
|
@@ -24595,6 +25732,41 @@ class KnowledgeApi {
|
|
|
24595
25732
|
);
|
|
24596
25733
|
}
|
|
24597
25734
|
|
|
25735
|
+
/**
|
|
25736
|
+
* Update search result.
|
|
25737
|
+
*
|
|
25738
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
25739
|
+
* @param {String} searchId Search Result ID
|
|
25740
|
+
* @param {Object} body
|
|
25741
|
+
*/
|
|
25742
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
25743
|
+
// verify the required parameter 'sessionId' is set
|
|
25744
|
+
if (sessionId === undefined || sessionId === null) {
|
|
25745
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25746
|
+
}
|
|
25747
|
+
// verify the required parameter 'searchId' is set
|
|
25748
|
+
if (searchId === undefined || searchId === null) {
|
|
25749
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25750
|
+
}
|
|
25751
|
+
// verify the required parameter 'body' is set
|
|
25752
|
+
if (body === undefined || body === null) {
|
|
25753
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
25754
|
+
}
|
|
25755
|
+
|
|
25756
|
+
return this.apiClient.callApi(
|
|
25757
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
25758
|
+
'PATCH',
|
|
25759
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
25760
|
+
{ },
|
|
25761
|
+
{ },
|
|
25762
|
+
{ },
|
|
25763
|
+
body,
|
|
25764
|
+
['PureCloud OAuth'],
|
|
25765
|
+
['application/json'],
|
|
25766
|
+
['application/json']
|
|
25767
|
+
);
|
|
25768
|
+
}
|
|
25769
|
+
|
|
24598
25770
|
/**
|
|
24599
25771
|
* Update knowledge base
|
|
24600
25772
|
*
|
|
@@ -24625,6 +25797,220 @@ class KnowledgeApi {
|
|
|
24625
25797
|
);
|
|
24626
25798
|
}
|
|
24627
25799
|
|
|
25800
|
+
/**
|
|
25801
|
+
* Update category
|
|
25802
|
+
*
|
|
25803
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25804
|
+
* @param {String} categoryId Category ID
|
|
25805
|
+
* @param {Object} body
|
|
25806
|
+
*/
|
|
25807
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
25808
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25809
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25810
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25811
|
+
}
|
|
25812
|
+
// verify the required parameter 'categoryId' is set
|
|
25813
|
+
if (categoryId === undefined || categoryId === null) {
|
|
25814
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25815
|
+
}
|
|
25816
|
+
// verify the required parameter 'body' is set
|
|
25817
|
+
if (body === undefined || body === null) {
|
|
25818
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
25819
|
+
}
|
|
25820
|
+
|
|
25821
|
+
return this.apiClient.callApi(
|
|
25822
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
25823
|
+
'PATCH',
|
|
25824
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
25825
|
+
{ },
|
|
25826
|
+
{ },
|
|
25827
|
+
{ },
|
|
25828
|
+
body,
|
|
25829
|
+
['PureCloud OAuth'],
|
|
25830
|
+
['application/json'],
|
|
25831
|
+
['application/json']
|
|
25832
|
+
);
|
|
25833
|
+
}
|
|
25834
|
+
|
|
25835
|
+
/**
|
|
25836
|
+
* Update document.
|
|
25837
|
+
*
|
|
25838
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
25839
|
+
* @param {String} documentId Document ID.
|
|
25840
|
+
* @param {Object} body
|
|
25841
|
+
*/
|
|
25842
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
25843
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25844
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25845
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25846
|
+
}
|
|
25847
|
+
// verify the required parameter 'documentId' is set
|
|
25848
|
+
if (documentId === undefined || documentId === null) {
|
|
25849
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25850
|
+
}
|
|
25851
|
+
// verify the required parameter 'body' is set
|
|
25852
|
+
if (body === undefined || body === null) {
|
|
25853
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
25854
|
+
}
|
|
25855
|
+
|
|
25856
|
+
return this.apiClient.callApi(
|
|
25857
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
25858
|
+
'PATCH',
|
|
25859
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
25860
|
+
{ },
|
|
25861
|
+
{ },
|
|
25862
|
+
{ },
|
|
25863
|
+
body,
|
|
25864
|
+
['PureCloud OAuth'],
|
|
25865
|
+
['application/json'],
|
|
25866
|
+
['application/json']
|
|
25867
|
+
);
|
|
25868
|
+
}
|
|
25869
|
+
|
|
25870
|
+
/**
|
|
25871
|
+
* Update a variation for a document.
|
|
25872
|
+
*
|
|
25873
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
25874
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
25875
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
25876
|
+
* @param {Object} body
|
|
25877
|
+
*/
|
|
25878
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
25879
|
+
// verify the required parameter 'documentVariationId' is set
|
|
25880
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
25881
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25882
|
+
}
|
|
25883
|
+
// verify the required parameter 'documentId' is set
|
|
25884
|
+
if (documentId === undefined || documentId === null) {
|
|
25885
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25886
|
+
}
|
|
25887
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25888
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25889
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25890
|
+
}
|
|
25891
|
+
// verify the required parameter 'body' is set
|
|
25892
|
+
if (body === undefined || body === null) {
|
|
25893
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
25894
|
+
}
|
|
25895
|
+
|
|
25896
|
+
return this.apiClient.callApi(
|
|
25897
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
25898
|
+
'PATCH',
|
|
25899
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
25900
|
+
{ },
|
|
25901
|
+
{ },
|
|
25902
|
+
{ },
|
|
25903
|
+
body,
|
|
25904
|
+
['PureCloud OAuth'],
|
|
25905
|
+
['application/json'],
|
|
25906
|
+
['application/json']
|
|
25907
|
+
);
|
|
25908
|
+
}
|
|
25909
|
+
|
|
25910
|
+
/**
|
|
25911
|
+
* Update search result.
|
|
25912
|
+
*
|
|
25913
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
25914
|
+
* @param {String} searchId Search Result ID
|
|
25915
|
+
* @param {Object} opts Optional parameters
|
|
25916
|
+
* @param {Object} opts.body
|
|
25917
|
+
*/
|
|
25918
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
25919
|
+
opts = opts || {};
|
|
25920
|
+
|
|
25921
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25922
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25923
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
25924
|
+
}
|
|
25925
|
+
// verify the required parameter 'searchId' is set
|
|
25926
|
+
if (searchId === undefined || searchId === null) {
|
|
25927
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
25928
|
+
}
|
|
25929
|
+
|
|
25930
|
+
return this.apiClient.callApi(
|
|
25931
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
25932
|
+
'PATCH',
|
|
25933
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
25934
|
+
{ },
|
|
25935
|
+
{ },
|
|
25936
|
+
{ },
|
|
25937
|
+
opts['body'],
|
|
25938
|
+
['PureCloud OAuth'],
|
|
25939
|
+
['application/json'],
|
|
25940
|
+
['application/json']
|
|
25941
|
+
);
|
|
25942
|
+
}
|
|
25943
|
+
|
|
25944
|
+
/**
|
|
25945
|
+
* Start import job
|
|
25946
|
+
*
|
|
25947
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25948
|
+
* @param {String} importJobId Import job ID
|
|
25949
|
+
* @param {Object} body
|
|
25950
|
+
*/
|
|
25951
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
25952
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25953
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25954
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25955
|
+
}
|
|
25956
|
+
// verify the required parameter 'importJobId' is set
|
|
25957
|
+
if (importJobId === undefined || importJobId === null) {
|
|
25958
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25959
|
+
}
|
|
25960
|
+
// verify the required parameter 'body' is set
|
|
25961
|
+
if (body === undefined || body === null) {
|
|
25962
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
25963
|
+
}
|
|
25964
|
+
|
|
25965
|
+
return this.apiClient.callApi(
|
|
25966
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
25967
|
+
'PATCH',
|
|
25968
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
25969
|
+
{ },
|
|
25970
|
+
{ },
|
|
25971
|
+
{ },
|
|
25972
|
+
body,
|
|
25973
|
+
['PureCloud OAuth'],
|
|
25974
|
+
['application/json'],
|
|
25975
|
+
['application/json']
|
|
25976
|
+
);
|
|
25977
|
+
}
|
|
25978
|
+
|
|
25979
|
+
/**
|
|
25980
|
+
* Update label
|
|
25981
|
+
*
|
|
25982
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25983
|
+
* @param {String} labelId Label ID
|
|
25984
|
+
* @param {Object} body
|
|
25985
|
+
*/
|
|
25986
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
25987
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
25988
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
25989
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25990
|
+
}
|
|
25991
|
+
// verify the required parameter 'labelId' is set
|
|
25992
|
+
if (labelId === undefined || labelId === null) {
|
|
25993
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25994
|
+
}
|
|
25995
|
+
// verify the required parameter 'body' is set
|
|
25996
|
+
if (body === undefined || body === null) {
|
|
25997
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
25998
|
+
}
|
|
25999
|
+
|
|
26000
|
+
return this.apiClient.callApi(
|
|
26001
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
26002
|
+
'PATCH',
|
|
26003
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
26004
|
+
{ },
|
|
26005
|
+
{ },
|
|
26006
|
+
{ },
|
|
26007
|
+
body,
|
|
26008
|
+
['PureCloud OAuth'],
|
|
26009
|
+
['application/json'],
|
|
26010
|
+
['application/json']
|
|
26011
|
+
);
|
|
26012
|
+
}
|
|
26013
|
+
|
|
24628
26014
|
/**
|
|
24629
26015
|
* Update category
|
|
24630
26016
|
*
|
|
@@ -24780,6 +26166,46 @@ class KnowledgeApi {
|
|
|
24780
26166
|
);
|
|
24781
26167
|
}
|
|
24782
26168
|
|
|
26169
|
+
/**
|
|
26170
|
+
* Update a Knowledge base unanswered phrase group
|
|
26171
|
+
*
|
|
26172
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26173
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
26174
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
26175
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
26176
|
+
*/
|
|
26177
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
26178
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26179
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26180
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26181
|
+
}
|
|
26182
|
+
// verify the required parameter 'groupId' is set
|
|
26183
|
+
if (groupId === undefined || groupId === null) {
|
|
26184
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26185
|
+
}
|
|
26186
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
26187
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
26188
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26189
|
+
}
|
|
26190
|
+
// verify the required parameter 'body' is set
|
|
26191
|
+
if (body === undefined || body === null) {
|
|
26192
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
26193
|
+
}
|
|
26194
|
+
|
|
26195
|
+
return this.apiClient.callApi(
|
|
26196
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
26197
|
+
'PATCH',
|
|
26198
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
26199
|
+
{ },
|
|
26200
|
+
{ },
|
|
26201
|
+
{ },
|
|
26202
|
+
body,
|
|
26203
|
+
['PureCloud OAuth'],
|
|
26204
|
+
['application/json'],
|
|
26205
|
+
['application/json']
|
|
26206
|
+
);
|
|
26207
|
+
}
|
|
26208
|
+
|
|
24783
26209
|
/**
|
|
24784
26210
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
24785
26211
|
*
|
|
@@ -24805,6 +26231,369 @@ class KnowledgeApi {
|
|
|
24805
26231
|
);
|
|
24806
26232
|
}
|
|
24807
26233
|
|
|
26234
|
+
/**
|
|
26235
|
+
* Search the documents in a guest session.
|
|
26236
|
+
*
|
|
26237
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
26238
|
+
* @param {Object} opts Optional parameters
|
|
26239
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
26240
|
+
* @param {Object} opts.body
|
|
26241
|
+
*/
|
|
26242
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
26243
|
+
opts = opts || {};
|
|
26244
|
+
|
|
26245
|
+
// verify the required parameter 'sessionId' is set
|
|
26246
|
+
if (sessionId === undefined || sessionId === null) {
|
|
26247
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
26248
|
+
}
|
|
26249
|
+
|
|
26250
|
+
return this.apiClient.callApi(
|
|
26251
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
26252
|
+
'POST',
|
|
26253
|
+
{ 'sessionId': sessionId },
|
|
26254
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
26255
|
+
{ },
|
|
26256
|
+
{ },
|
|
26257
|
+
opts['body'],
|
|
26258
|
+
['PureCloud OAuth'],
|
|
26259
|
+
['application/json'],
|
|
26260
|
+
['application/json']
|
|
26261
|
+
);
|
|
26262
|
+
}
|
|
26263
|
+
|
|
26264
|
+
/**
|
|
26265
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
26266
|
+
*
|
|
26267
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
26268
|
+
* @param {Object} opts Optional parameters
|
|
26269
|
+
* @param {Object} opts.body
|
|
26270
|
+
*/
|
|
26271
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
26272
|
+
opts = opts || {};
|
|
26273
|
+
|
|
26274
|
+
// verify the required parameter 'sessionId' is set
|
|
26275
|
+
if (sessionId === undefined || sessionId === null) {
|
|
26276
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
26277
|
+
}
|
|
26278
|
+
|
|
26279
|
+
return this.apiClient.callApi(
|
|
26280
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
26281
|
+
'POST',
|
|
26282
|
+
{ 'sessionId': sessionId },
|
|
26283
|
+
{ },
|
|
26284
|
+
{ },
|
|
26285
|
+
{ },
|
|
26286
|
+
opts['body'],
|
|
26287
|
+
['PureCloud OAuth'],
|
|
26288
|
+
['application/json'],
|
|
26289
|
+
['application/json']
|
|
26290
|
+
);
|
|
26291
|
+
}
|
|
26292
|
+
|
|
26293
|
+
/**
|
|
26294
|
+
* Create guest session
|
|
26295
|
+
*
|
|
26296
|
+
* @param {Object} body
|
|
26297
|
+
*/
|
|
26298
|
+
postKnowledgeGuestSessions(body) {
|
|
26299
|
+
// verify the required parameter 'body' is set
|
|
26300
|
+
if (body === undefined || body === null) {
|
|
26301
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
26302
|
+
}
|
|
26303
|
+
|
|
26304
|
+
return this.apiClient.callApi(
|
|
26305
|
+
'/api/v2/knowledge/guest/sessions',
|
|
26306
|
+
'POST',
|
|
26307
|
+
{ },
|
|
26308
|
+
{ },
|
|
26309
|
+
{ },
|
|
26310
|
+
{ },
|
|
26311
|
+
body,
|
|
26312
|
+
['PureCloud OAuth'],
|
|
26313
|
+
['application/json'],
|
|
26314
|
+
['application/json']
|
|
26315
|
+
);
|
|
26316
|
+
}
|
|
26317
|
+
|
|
26318
|
+
/**
|
|
26319
|
+
* Create new category
|
|
26320
|
+
*
|
|
26321
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26322
|
+
* @param {Object} body
|
|
26323
|
+
*/
|
|
26324
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
26325
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26326
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26327
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
26328
|
+
}
|
|
26329
|
+
// verify the required parameter 'body' is set
|
|
26330
|
+
if (body === undefined || body === null) {
|
|
26331
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
26332
|
+
}
|
|
26333
|
+
|
|
26334
|
+
return this.apiClient.callApi(
|
|
26335
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
26336
|
+
'POST',
|
|
26337
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26338
|
+
{ },
|
|
26339
|
+
{ },
|
|
26340
|
+
{ },
|
|
26341
|
+
body,
|
|
26342
|
+
['PureCloud OAuth'],
|
|
26343
|
+
['application/json'],
|
|
26344
|
+
['application/json']
|
|
26345
|
+
);
|
|
26346
|
+
}
|
|
26347
|
+
|
|
26348
|
+
/**
|
|
26349
|
+
* Create a variation for a document.
|
|
26350
|
+
*
|
|
26351
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
26352
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
26353
|
+
* @param {Object} body
|
|
26354
|
+
*/
|
|
26355
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
26356
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26357
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26358
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26359
|
+
}
|
|
26360
|
+
// verify the required parameter 'documentId' is set
|
|
26361
|
+
if (documentId === undefined || documentId === null) {
|
|
26362
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26363
|
+
}
|
|
26364
|
+
// verify the required parameter 'body' is set
|
|
26365
|
+
if (body === undefined || body === null) {
|
|
26366
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
26367
|
+
}
|
|
26368
|
+
|
|
26369
|
+
return this.apiClient.callApi(
|
|
26370
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
26371
|
+
'POST',
|
|
26372
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
26373
|
+
{ },
|
|
26374
|
+
{ },
|
|
26375
|
+
{ },
|
|
26376
|
+
body,
|
|
26377
|
+
['PureCloud OAuth'],
|
|
26378
|
+
['application/json'],
|
|
26379
|
+
['application/json']
|
|
26380
|
+
);
|
|
26381
|
+
}
|
|
26382
|
+
|
|
26383
|
+
/**
|
|
26384
|
+
* Creates or restores a document version.
|
|
26385
|
+
*
|
|
26386
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
26387
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
26388
|
+
* @param {Object} body
|
|
26389
|
+
*/
|
|
26390
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
26391
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26392
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26393
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26394
|
+
}
|
|
26395
|
+
// verify the required parameter 'documentId' is set
|
|
26396
|
+
if (documentId === undefined || documentId === null) {
|
|
26397
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26398
|
+
}
|
|
26399
|
+
// verify the required parameter 'body' is set
|
|
26400
|
+
if (body === undefined || body === null) {
|
|
26401
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
26402
|
+
}
|
|
26403
|
+
|
|
26404
|
+
return this.apiClient.callApi(
|
|
26405
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
26406
|
+
'POST',
|
|
26407
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
26408
|
+
{ },
|
|
26409
|
+
{ },
|
|
26410
|
+
{ },
|
|
26411
|
+
body,
|
|
26412
|
+
['PureCloud OAuth'],
|
|
26413
|
+
['application/json'],
|
|
26414
|
+
['application/json']
|
|
26415
|
+
);
|
|
26416
|
+
}
|
|
26417
|
+
|
|
26418
|
+
/**
|
|
26419
|
+
* Create document.
|
|
26420
|
+
*
|
|
26421
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26422
|
+
* @param {Object} body
|
|
26423
|
+
*/
|
|
26424
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
26425
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26426
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26427
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
26428
|
+
}
|
|
26429
|
+
// verify the required parameter 'body' is set
|
|
26430
|
+
if (body === undefined || body === null) {
|
|
26431
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
26432
|
+
}
|
|
26433
|
+
|
|
26434
|
+
return this.apiClient.callApi(
|
|
26435
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
26436
|
+
'POST',
|
|
26437
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26438
|
+
{ },
|
|
26439
|
+
{ },
|
|
26440
|
+
{ },
|
|
26441
|
+
body,
|
|
26442
|
+
['PureCloud OAuth'],
|
|
26443
|
+
['application/json'],
|
|
26444
|
+
['application/json']
|
|
26445
|
+
);
|
|
26446
|
+
}
|
|
26447
|
+
|
|
26448
|
+
/**
|
|
26449
|
+
* Search the documents in a knowledge base.
|
|
26450
|
+
*
|
|
26451
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
26452
|
+
* @param {Object} opts Optional parameters
|
|
26453
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
26454
|
+
* @param {Object} opts.body
|
|
26455
|
+
*/
|
|
26456
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
26457
|
+
opts = opts || {};
|
|
26458
|
+
|
|
26459
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26460
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26461
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
26462
|
+
}
|
|
26463
|
+
|
|
26464
|
+
return this.apiClient.callApi(
|
|
26465
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
26466
|
+
'POST',
|
|
26467
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26468
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
26469
|
+
{ },
|
|
26470
|
+
{ },
|
|
26471
|
+
opts['body'],
|
|
26472
|
+
['PureCloud OAuth'],
|
|
26473
|
+
['application/json'],
|
|
26474
|
+
['application/json']
|
|
26475
|
+
);
|
|
26476
|
+
}
|
|
26477
|
+
|
|
26478
|
+
/**
|
|
26479
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
26480
|
+
*
|
|
26481
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
26482
|
+
* @param {Object} opts Optional parameters
|
|
26483
|
+
* @param {Object} opts.body
|
|
26484
|
+
*/
|
|
26485
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
26486
|
+
opts = opts || {};
|
|
26487
|
+
|
|
26488
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26489
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26490
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
26491
|
+
}
|
|
26492
|
+
|
|
26493
|
+
return this.apiClient.callApi(
|
|
26494
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
26495
|
+
'POST',
|
|
26496
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26497
|
+
{ },
|
|
26498
|
+
{ },
|
|
26499
|
+
{ },
|
|
26500
|
+
opts['body'],
|
|
26501
|
+
['PureCloud OAuth'],
|
|
26502
|
+
['application/json'],
|
|
26503
|
+
['application/json']
|
|
26504
|
+
);
|
|
26505
|
+
}
|
|
26506
|
+
|
|
26507
|
+
/**
|
|
26508
|
+
* Create export job
|
|
26509
|
+
*
|
|
26510
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26511
|
+
* @param {Object} body
|
|
26512
|
+
*/
|
|
26513
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
26514
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26515
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26516
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
26517
|
+
}
|
|
26518
|
+
// verify the required parameter 'body' is set
|
|
26519
|
+
if (body === undefined || body === null) {
|
|
26520
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
26521
|
+
}
|
|
26522
|
+
|
|
26523
|
+
return this.apiClient.callApi(
|
|
26524
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
26525
|
+
'POST',
|
|
26526
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26527
|
+
{ },
|
|
26528
|
+
{ },
|
|
26529
|
+
{ },
|
|
26530
|
+
body,
|
|
26531
|
+
['PureCloud OAuth'],
|
|
26532
|
+
['application/json'],
|
|
26533
|
+
['application/json']
|
|
26534
|
+
);
|
|
26535
|
+
}
|
|
26536
|
+
|
|
26537
|
+
/**
|
|
26538
|
+
* Create import job
|
|
26539
|
+
*
|
|
26540
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26541
|
+
* @param {Object} body
|
|
26542
|
+
*/
|
|
26543
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
26544
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26545
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26546
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
26547
|
+
}
|
|
26548
|
+
// verify the required parameter 'body' is set
|
|
26549
|
+
if (body === undefined || body === null) {
|
|
26550
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
26551
|
+
}
|
|
26552
|
+
|
|
26553
|
+
return this.apiClient.callApi(
|
|
26554
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
26555
|
+
'POST',
|
|
26556
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26557
|
+
{ },
|
|
26558
|
+
{ },
|
|
26559
|
+
{ },
|
|
26560
|
+
body,
|
|
26561
|
+
['PureCloud OAuth'],
|
|
26562
|
+
['application/json'],
|
|
26563
|
+
['application/json']
|
|
26564
|
+
);
|
|
26565
|
+
}
|
|
26566
|
+
|
|
26567
|
+
/**
|
|
26568
|
+
* Create new label
|
|
26569
|
+
*
|
|
26570
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26571
|
+
* @param {Object} body
|
|
26572
|
+
*/
|
|
26573
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
26574
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
26575
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
26576
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
26577
|
+
}
|
|
26578
|
+
// verify the required parameter 'body' is set
|
|
26579
|
+
if (body === undefined || body === null) {
|
|
26580
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
26581
|
+
}
|
|
26582
|
+
|
|
26583
|
+
return this.apiClient.callApi(
|
|
26584
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
26585
|
+
'POST',
|
|
26586
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
26587
|
+
{ },
|
|
26588
|
+
{ },
|
|
26589
|
+
{ },
|
|
26590
|
+
body,
|
|
26591
|
+
['PureCloud OAuth'],
|
|
26592
|
+
['application/json'],
|
|
26593
|
+
['application/json']
|
|
26594
|
+
);
|
|
26595
|
+
}
|
|
26596
|
+
|
|
24808
26597
|
/**
|
|
24809
26598
|
* Create new category
|
|
24810
26599
|
*
|
|
@@ -25035,7 +26824,7 @@ class LanguageUnderstandingApi {
|
|
|
25035
26824
|
/**
|
|
25036
26825
|
* LanguageUnderstanding service.
|
|
25037
26826
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
25038
|
-
* @version
|
|
26827
|
+
* @version 147.0.0
|
|
25039
26828
|
*/
|
|
25040
26829
|
|
|
25041
26830
|
/**
|
|
@@ -25939,7 +27728,7 @@ class LanguagesApi {
|
|
|
25939
27728
|
/**
|
|
25940
27729
|
* Languages service.
|
|
25941
27730
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25942
|
-
* @version
|
|
27731
|
+
* @version 147.0.0
|
|
25943
27732
|
*/
|
|
25944
27733
|
|
|
25945
27734
|
/**
|
|
@@ -26207,7 +27996,7 @@ class LearningApi {
|
|
|
26207
27996
|
/**
|
|
26208
27997
|
* Learning service.
|
|
26209
27998
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
26210
|
-
* @version
|
|
27999
|
+
* @version 147.0.0
|
|
26211
28000
|
*/
|
|
26212
28001
|
|
|
26213
28002
|
/**
|
|
@@ -26967,7 +28756,7 @@ class LicenseApi {
|
|
|
26967
28756
|
/**
|
|
26968
28757
|
* License service.
|
|
26969
28758
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26970
|
-
* @version
|
|
28759
|
+
* @version 147.0.0
|
|
26971
28760
|
*/
|
|
26972
28761
|
|
|
26973
28762
|
/**
|
|
@@ -27205,7 +28994,7 @@ class LocationsApi {
|
|
|
27205
28994
|
/**
|
|
27206
28995
|
* Locations service.
|
|
27207
28996
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
27208
|
-
* @version
|
|
28997
|
+
* @version 147.0.0
|
|
27209
28998
|
*/
|
|
27210
28999
|
|
|
27211
29000
|
/**
|
|
@@ -27441,7 +29230,7 @@ class MessagingApi {
|
|
|
27441
29230
|
/**
|
|
27442
29231
|
* Messaging service.
|
|
27443
29232
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27444
|
-
* @version
|
|
29233
|
+
* @version 147.0.0
|
|
27445
29234
|
*/
|
|
27446
29235
|
|
|
27447
29236
|
/**
|
|
@@ -27592,7 +29381,7 @@ class MobileDevicesApi {
|
|
|
27592
29381
|
/**
|
|
27593
29382
|
* MobileDevices service.
|
|
27594
29383
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27595
|
-
* @version
|
|
29384
|
+
* @version 147.0.0
|
|
27596
29385
|
*/
|
|
27597
29386
|
|
|
27598
29387
|
/**
|
|
@@ -27743,7 +29532,7 @@ class NotificationsApi {
|
|
|
27743
29532
|
/**
|
|
27744
29533
|
* Notifications service.
|
|
27745
29534
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27746
|
-
* @version
|
|
29535
|
+
* @version 147.0.0
|
|
27747
29536
|
*/
|
|
27748
29537
|
|
|
27749
29538
|
/**
|
|
@@ -27968,7 +29757,7 @@ class OAuthApi {
|
|
|
27968
29757
|
/**
|
|
27969
29758
|
* OAuth service.
|
|
27970
29759
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27971
|
-
* @version
|
|
29760
|
+
* @version 147.0.0
|
|
27972
29761
|
*/
|
|
27973
29762
|
|
|
27974
29763
|
/**
|
|
@@ -28334,7 +30123,7 @@ class ObjectsApi {
|
|
|
28334
30123
|
/**
|
|
28335
30124
|
* Objects service.
|
|
28336
30125
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
28337
|
-
* @version
|
|
30126
|
+
* @version 147.0.0
|
|
28338
30127
|
*/
|
|
28339
30128
|
|
|
28340
30129
|
/**
|
|
@@ -28605,7 +30394,7 @@ class OrganizationApi {
|
|
|
28605
30394
|
/**
|
|
28606
30395
|
* Organization service.
|
|
28607
30396
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28608
|
-
* @version
|
|
30397
|
+
* @version 147.0.0
|
|
28609
30398
|
*/
|
|
28610
30399
|
|
|
28611
30400
|
/**
|
|
@@ -29008,7 +30797,7 @@ class OrganizationAuthorizationApi {
|
|
|
29008
30797
|
/**
|
|
29009
30798
|
* OrganizationAuthorization service.
|
|
29010
30799
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
29011
|
-
* @version
|
|
30800
|
+
* @version 147.0.0
|
|
29012
30801
|
*/
|
|
29013
30802
|
|
|
29014
30803
|
/**
|
|
@@ -29933,7 +31722,7 @@ class OutboundApi {
|
|
|
29933
31722
|
/**
|
|
29934
31723
|
* Outbound service.
|
|
29935
31724
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29936
|
-
* @version
|
|
31725
|
+
* @version 147.0.0
|
|
29937
31726
|
*/
|
|
29938
31727
|
|
|
29939
31728
|
/**
|
|
@@ -30233,6 +32022,31 @@ class OutboundApi {
|
|
|
30233
32022
|
);
|
|
30234
32023
|
}
|
|
30235
32024
|
|
|
32025
|
+
/**
|
|
32026
|
+
* Delete an Outbound Digital Rule Set
|
|
32027
|
+
*
|
|
32028
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
32029
|
+
*/
|
|
32030
|
+
deleteOutboundDigitalruleset(digitalRuleSetId) {
|
|
32031
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
32032
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
32033
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
|
|
32034
|
+
}
|
|
32035
|
+
|
|
32036
|
+
return this.apiClient.callApi(
|
|
32037
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
32038
|
+
'DELETE',
|
|
32039
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
32040
|
+
{ },
|
|
32041
|
+
{ },
|
|
32042
|
+
{ },
|
|
32043
|
+
null,
|
|
32044
|
+
['PureCloud OAuth'],
|
|
32045
|
+
['application/json'],
|
|
32046
|
+
['application/json']
|
|
32047
|
+
);
|
|
32048
|
+
}
|
|
32049
|
+
|
|
30236
32050
|
/**
|
|
30237
32051
|
* Delete dialer DNC list
|
|
30238
32052
|
*
|
|
@@ -31270,6 +33084,60 @@ class OutboundApi {
|
|
|
31270
33084
|
);
|
|
31271
33085
|
}
|
|
31272
33086
|
|
|
33087
|
+
/**
|
|
33088
|
+
* Get an Outbound Digital Rule Set
|
|
33089
|
+
*
|
|
33090
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
33091
|
+
*/
|
|
33092
|
+
getOutboundDigitalruleset(digitalRuleSetId) {
|
|
33093
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
33094
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
33095
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
|
|
33096
|
+
}
|
|
33097
|
+
|
|
33098
|
+
return this.apiClient.callApi(
|
|
33099
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
33100
|
+
'GET',
|
|
33101
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
33102
|
+
{ },
|
|
33103
|
+
{ },
|
|
33104
|
+
{ },
|
|
33105
|
+
null,
|
|
33106
|
+
['PureCloud OAuth'],
|
|
33107
|
+
['application/json'],
|
|
33108
|
+
['application/json']
|
|
33109
|
+
);
|
|
33110
|
+
}
|
|
33111
|
+
|
|
33112
|
+
/**
|
|
33113
|
+
* Query a list of Outbound Digital Rule Sets
|
|
33114
|
+
*
|
|
33115
|
+
* @param {Object} opts Optional parameters
|
|
33116
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
33117
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33118
|
+
* @param {Object} opts.sortBy The field to sort by (default to name)
|
|
33119
|
+
* @param {Object} opts.sortOrder The direction to sort (default to ascending)
|
|
33120
|
+
* @param {String} opts.name Name
|
|
33121
|
+
* @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
|
|
33122
|
+
*/
|
|
33123
|
+
getOutboundDigitalrulesets(opts) {
|
|
33124
|
+
opts = opts || {};
|
|
33125
|
+
|
|
33126
|
+
|
|
33127
|
+
return this.apiClient.callApi(
|
|
33128
|
+
'/api/v2/outbound/digitalrulesets',
|
|
33129
|
+
'GET',
|
|
33130
|
+
{ },
|
|
33131
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
33132
|
+
{ },
|
|
33133
|
+
{ },
|
|
33134
|
+
null,
|
|
33135
|
+
['PureCloud OAuth'],
|
|
33136
|
+
['application/json'],
|
|
33137
|
+
['application/json']
|
|
33138
|
+
);
|
|
33139
|
+
}
|
|
33140
|
+
|
|
31273
33141
|
/**
|
|
31274
33142
|
* Get dialer DNC list
|
|
31275
33143
|
*
|
|
@@ -32453,6 +34321,31 @@ class OutboundApi {
|
|
|
32453
34321
|
);
|
|
32454
34322
|
}
|
|
32455
34323
|
|
|
34324
|
+
/**
|
|
34325
|
+
* Create an Outbound Digital Rule Set
|
|
34326
|
+
*
|
|
34327
|
+
* @param {Object} body Digital Rule Set
|
|
34328
|
+
*/
|
|
34329
|
+
postOutboundDigitalrulesets(body) {
|
|
34330
|
+
// verify the required parameter 'body' is set
|
|
34331
|
+
if (body === undefined || body === null) {
|
|
34332
|
+
throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
|
|
34333
|
+
}
|
|
34334
|
+
|
|
34335
|
+
return this.apiClient.callApi(
|
|
34336
|
+
'/api/v2/outbound/digitalrulesets',
|
|
34337
|
+
'POST',
|
|
34338
|
+
{ },
|
|
34339
|
+
{ },
|
|
34340
|
+
{ },
|
|
34341
|
+
{ },
|
|
34342
|
+
body,
|
|
34343
|
+
['PureCloud OAuth'],
|
|
34344
|
+
['application/json'],
|
|
34345
|
+
['application/json']
|
|
34346
|
+
);
|
|
34347
|
+
}
|
|
34348
|
+
|
|
32456
34349
|
/**
|
|
32457
34350
|
* Initiate the export of a dnc list.
|
|
32458
34351
|
* Returns 200 if received OK.
|
|
@@ -32917,6 +34810,36 @@ class OutboundApi {
|
|
|
32917
34810
|
);
|
|
32918
34811
|
}
|
|
32919
34812
|
|
|
34813
|
+
/**
|
|
34814
|
+
* Update an Outbound Digital Rule Set
|
|
34815
|
+
*
|
|
34816
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
34817
|
+
* @param {Object} body Digital Rule Set
|
|
34818
|
+
*/
|
|
34819
|
+
putOutboundDigitalruleset(digitalRuleSetId, body) {
|
|
34820
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
34821
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
34822
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
|
|
34823
|
+
}
|
|
34824
|
+
// verify the required parameter 'body' is set
|
|
34825
|
+
if (body === undefined || body === null) {
|
|
34826
|
+
throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
|
|
34827
|
+
}
|
|
34828
|
+
|
|
34829
|
+
return this.apiClient.callApi(
|
|
34830
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
34831
|
+
'PUT',
|
|
34832
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
34833
|
+
{ },
|
|
34834
|
+
{ },
|
|
34835
|
+
{ },
|
|
34836
|
+
body,
|
|
34837
|
+
['PureCloud OAuth'],
|
|
34838
|
+
['application/json'],
|
|
34839
|
+
['application/json']
|
|
34840
|
+
);
|
|
34841
|
+
}
|
|
34842
|
+
|
|
32920
34843
|
/**
|
|
32921
34844
|
* Update dialer DNC list
|
|
32922
34845
|
*
|
|
@@ -33188,7 +35111,7 @@ class PresenceApi {
|
|
|
33188
35111
|
/**
|
|
33189
35112
|
* Presence service.
|
|
33190
35113
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
33191
|
-
* @version
|
|
35114
|
+
* @version 147.0.0
|
|
33192
35115
|
*/
|
|
33193
35116
|
|
|
33194
35117
|
/**
|
|
@@ -33510,7 +35433,7 @@ class QualityApi {
|
|
|
33510
35433
|
/**
|
|
33511
35434
|
* Quality service.
|
|
33512
35435
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
33513
|
-
* @version
|
|
35436
|
+
* @version 147.0.0
|
|
33514
35437
|
*/
|
|
33515
35438
|
|
|
33516
35439
|
/**
|
|
@@ -34020,7 +35943,7 @@ class QualityApi {
|
|
|
34020
35943
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
34021
35944
|
* @param {String} opts.nextPage next page token
|
|
34022
35945
|
* @param {String} opts.previousPage Previous page token
|
|
34023
|
-
* @param {
|
|
35946
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
34024
35947
|
* @param {String} opts.name Name
|
|
34025
35948
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
34026
35949
|
*/
|
|
@@ -34107,7 +36030,7 @@ class QualityApi {
|
|
|
34107
36030
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
34108
36031
|
* @param {String} opts.nextPage next page token
|
|
34109
36032
|
* @param {String} opts.previousPage Previous page token
|
|
34110
|
-
* @param {
|
|
36033
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
34111
36034
|
* @param {String} opts.name Name
|
|
34112
36035
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
34113
36036
|
*/
|
|
@@ -34218,7 +36141,7 @@ class QualityApi {
|
|
|
34218
36141
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
34219
36142
|
* @param {String} opts.nextPage next page token
|
|
34220
36143
|
* @param {String} opts.previousPage Previous page token
|
|
34221
|
-
* @param {
|
|
36144
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
34222
36145
|
* @param {String} opts.name Name
|
|
34223
36146
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
34224
36147
|
*/
|
|
@@ -35088,7 +37011,7 @@ class RecordingApi {
|
|
|
35088
37011
|
/**
|
|
35089
37012
|
* Recording service.
|
|
35090
37013
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
35091
|
-
* @version
|
|
37014
|
+
* @version 147.0.0
|
|
35092
37015
|
*/
|
|
35093
37016
|
|
|
35094
37017
|
/**
|
|
@@ -35613,12 +37536,249 @@ class RecordingApi {
|
|
|
35613
37536
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
35614
37537
|
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
35615
37538
|
*/
|
|
35616
|
-
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
37539
|
+
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
37540
|
+
opts = opts || {};
|
|
37541
|
+
|
|
37542
|
+
|
|
37543
|
+
return this.apiClient.callApi(
|
|
37544
|
+
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
37545
|
+
'GET',
|
|
37546
|
+
{ },
|
|
37547
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
37548
|
+
{ },
|
|
37549
|
+
{ },
|
|
37550
|
+
null,
|
|
37551
|
+
['PureCloud OAuth'],
|
|
37552
|
+
['application/json'],
|
|
37553
|
+
['application/json']
|
|
37554
|
+
);
|
|
37555
|
+
}
|
|
37556
|
+
|
|
37557
|
+
/**
|
|
37558
|
+
* Get a media retention policy
|
|
37559
|
+
*
|
|
37560
|
+
* @param {String} policyId Policy ID
|
|
37561
|
+
*/
|
|
37562
|
+
getRecordingCrossplatformMediaretentionpolicy(policyId) {
|
|
37563
|
+
// verify the required parameter 'policyId' is set
|
|
37564
|
+
if (policyId === undefined || policyId === null) {
|
|
37565
|
+
throw 'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';
|
|
37566
|
+
}
|
|
37567
|
+
|
|
37568
|
+
return this.apiClient.callApi(
|
|
37569
|
+
'/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}',
|
|
37570
|
+
'GET',
|
|
37571
|
+
{ 'policyId': policyId },
|
|
37572
|
+
{ },
|
|
37573
|
+
{ },
|
|
37574
|
+
{ },
|
|
37575
|
+
null,
|
|
37576
|
+
['PureCloud OAuth'],
|
|
37577
|
+
['application/json'],
|
|
37578
|
+
['application/json']
|
|
37579
|
+
);
|
|
37580
|
+
}
|
|
37581
|
+
|
|
37582
|
+
/**
|
|
37583
|
+
* Get the status of the job associated with the job id.
|
|
37584
|
+
*
|
|
37585
|
+
* @param {String} jobId jobId
|
|
37586
|
+
*/
|
|
37587
|
+
getRecordingJob(jobId) {
|
|
37588
|
+
// verify the required parameter 'jobId' is set
|
|
37589
|
+
if (jobId === undefined || jobId === null) {
|
|
37590
|
+
throw 'Missing the required parameter "jobId" when calling getRecordingJob';
|
|
37591
|
+
}
|
|
37592
|
+
|
|
37593
|
+
return this.apiClient.callApi(
|
|
37594
|
+
'/api/v2/recording/jobs/{jobId}',
|
|
37595
|
+
'GET',
|
|
37596
|
+
{ 'jobId': jobId },
|
|
37597
|
+
{ },
|
|
37598
|
+
{ },
|
|
37599
|
+
{ },
|
|
37600
|
+
null,
|
|
37601
|
+
['PureCloud OAuth'],
|
|
37602
|
+
['application/json'],
|
|
37603
|
+
['application/json']
|
|
37604
|
+
);
|
|
37605
|
+
}
|
|
37606
|
+
|
|
37607
|
+
/**
|
|
37608
|
+
* Get IDs of recordings that the bulk job failed for
|
|
37609
|
+
*
|
|
37610
|
+
* @param {String} jobId jobId
|
|
37611
|
+
* @param {Object} opts Optional parameters
|
|
37612
|
+
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
37613
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37614
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
37615
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
37616
|
+
*/
|
|
37617
|
+
getRecordingJobFailedrecordings(jobId, opts) {
|
|
37618
|
+
opts = opts || {};
|
|
37619
|
+
|
|
37620
|
+
// verify the required parameter 'jobId' is set
|
|
37621
|
+
if (jobId === undefined || jobId === null) {
|
|
37622
|
+
throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
|
|
37623
|
+
}
|
|
37624
|
+
|
|
37625
|
+
return this.apiClient.callApi(
|
|
37626
|
+
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
37627
|
+
'GET',
|
|
37628
|
+
{ 'jobId': jobId },
|
|
37629
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
37630
|
+
{ },
|
|
37631
|
+
{ },
|
|
37632
|
+
null,
|
|
37633
|
+
['PureCloud OAuth'],
|
|
37634
|
+
['application/json'],
|
|
37635
|
+
['application/json']
|
|
37636
|
+
);
|
|
37637
|
+
}
|
|
37638
|
+
|
|
37639
|
+
/**
|
|
37640
|
+
* Get the status of all jobs within the user's organization
|
|
37641
|
+
*
|
|
37642
|
+
* @param {Object} opts Optional parameters
|
|
37643
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
37644
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37645
|
+
* @param {Object} opts.sortBy Sort by (default to userId)
|
|
37646
|
+
* @param {Object} opts.state Filter by state
|
|
37647
|
+
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
37648
|
+
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
37649
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
37650
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
37651
|
+
*/
|
|
37652
|
+
getRecordingJobs(opts) {
|
|
37653
|
+
opts = opts || {};
|
|
37654
|
+
|
|
37655
|
+
|
|
37656
|
+
return this.apiClient.callApi(
|
|
37657
|
+
'/api/v2/recording/jobs',
|
|
37658
|
+
'GET',
|
|
37659
|
+
{ },
|
|
37660
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
37661
|
+
{ },
|
|
37662
|
+
{ },
|
|
37663
|
+
null,
|
|
37664
|
+
['PureCloud OAuth'],
|
|
37665
|
+
['application/json'],
|
|
37666
|
+
['application/json']
|
|
37667
|
+
);
|
|
37668
|
+
}
|
|
37669
|
+
|
|
37670
|
+
/**
|
|
37671
|
+
* Get the encryption key configurations
|
|
37672
|
+
*
|
|
37673
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
37674
|
+
*/
|
|
37675
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
37676
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
37677
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
37678
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
37679
|
+
}
|
|
37680
|
+
|
|
37681
|
+
return this.apiClient.callApi(
|
|
37682
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
37683
|
+
'GET',
|
|
37684
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
37685
|
+
{ },
|
|
37686
|
+
{ },
|
|
37687
|
+
{ },
|
|
37688
|
+
null,
|
|
37689
|
+
['PureCloud OAuth'],
|
|
37690
|
+
['application/json'],
|
|
37691
|
+
['application/json']
|
|
37692
|
+
);
|
|
37693
|
+
}
|
|
37694
|
+
|
|
37695
|
+
/**
|
|
37696
|
+
* Get a list of key configurations data
|
|
37697
|
+
*
|
|
37698
|
+
*/
|
|
37699
|
+
getRecordingKeyconfigurations() {
|
|
37700
|
+
|
|
37701
|
+
return this.apiClient.callApi(
|
|
37702
|
+
'/api/v2/recording/keyconfigurations',
|
|
37703
|
+
'GET',
|
|
37704
|
+
{ },
|
|
37705
|
+
{ },
|
|
37706
|
+
{ },
|
|
37707
|
+
{ },
|
|
37708
|
+
null,
|
|
37709
|
+
['PureCloud OAuth'],
|
|
37710
|
+
['application/json'],
|
|
37711
|
+
['application/json']
|
|
37712
|
+
);
|
|
37713
|
+
}
|
|
37714
|
+
|
|
37715
|
+
/**
|
|
37716
|
+
* Get the local encryption settings
|
|
37717
|
+
*
|
|
37718
|
+
* @param {String} settingsId Settings Id
|
|
37719
|
+
*/
|
|
37720
|
+
getRecordingLocalkeysSetting(settingsId) {
|
|
37721
|
+
// verify the required parameter 'settingsId' is set
|
|
37722
|
+
if (settingsId === undefined || settingsId === null) {
|
|
37723
|
+
throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
|
|
37724
|
+
}
|
|
37725
|
+
|
|
37726
|
+
return this.apiClient.callApi(
|
|
37727
|
+
'/api/v2/recording/localkeys/settings/{settingsId}',
|
|
37728
|
+
'GET',
|
|
37729
|
+
{ 'settingsId': settingsId },
|
|
37730
|
+
{ },
|
|
37731
|
+
{ },
|
|
37732
|
+
{ },
|
|
37733
|
+
null,
|
|
37734
|
+
['PureCloud OAuth'],
|
|
37735
|
+
['application/json'],
|
|
37736
|
+
['application/json']
|
|
37737
|
+
);
|
|
37738
|
+
}
|
|
37739
|
+
|
|
37740
|
+
/**
|
|
37741
|
+
* gets a list local key settings data
|
|
37742
|
+
*
|
|
37743
|
+
*/
|
|
37744
|
+
getRecordingLocalkeysSettings() {
|
|
37745
|
+
|
|
37746
|
+
return this.apiClient.callApi(
|
|
37747
|
+
'/api/v2/recording/localkeys/settings',
|
|
37748
|
+
'GET',
|
|
37749
|
+
{ },
|
|
37750
|
+
{ },
|
|
37751
|
+
{ },
|
|
37752
|
+
{ },
|
|
37753
|
+
null,
|
|
37754
|
+
['PureCloud OAuth'],
|
|
37755
|
+
['application/json'],
|
|
37756
|
+
['application/json']
|
|
37757
|
+
);
|
|
37758
|
+
}
|
|
37759
|
+
|
|
37760
|
+
/**
|
|
37761
|
+
* Gets media retention policy list with query options to filter on name and enabled.
|
|
37762
|
+
* for a less verbose response, add summary=true to this endpoint
|
|
37763
|
+
* @param {Object} opts Optional parameters
|
|
37764
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
37765
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
37766
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
37767
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
37768
|
+
* @param {String} opts.nextPage next page token
|
|
37769
|
+
* @param {String} opts.previousPage Previous page token
|
|
37770
|
+
* @param {String} opts.name the policy name - used for filtering results in searches.
|
|
37771
|
+
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
37772
|
+
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
37773
|
+
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
37774
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
37775
|
+
*/
|
|
37776
|
+
getRecordingMediaretentionpolicies(opts) {
|
|
35617
37777
|
opts = opts || {};
|
|
35618
37778
|
|
|
35619
37779
|
|
|
35620
37780
|
return this.apiClient.callApi(
|
|
35621
|
-
'/api/v2/recording/
|
|
37781
|
+
'/api/v2/recording/mediaretentionpolicies',
|
|
35622
37782
|
'GET',
|
|
35623
37783
|
{ },
|
|
35624
37784
|
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
@@ -35636,14 +37796,14 @@ class RecordingApi {
|
|
|
35636
37796
|
*
|
|
35637
37797
|
* @param {String} policyId Policy ID
|
|
35638
37798
|
*/
|
|
35639
|
-
|
|
37799
|
+
getRecordingMediaretentionpolicy(policyId) {
|
|
35640
37800
|
// verify the required parameter 'policyId' is set
|
|
35641
37801
|
if (policyId === undefined || policyId === null) {
|
|
35642
|
-
throw 'Missing the required parameter "policyId" when calling
|
|
37802
|
+
throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
|
|
35643
37803
|
}
|
|
35644
37804
|
|
|
35645
37805
|
return this.apiClient.callApi(
|
|
35646
|
-
'/api/v2/recording/
|
|
37806
|
+
'/api/v2/recording/mediaretentionpolicies/{policyId}',
|
|
35647
37807
|
'GET',
|
|
35648
37808
|
{ 'policyId': policyId },
|
|
35649
37809
|
{ },
|
|
@@ -35657,154 +37817,21 @@ class RecordingApi {
|
|
|
35657
37817
|
}
|
|
35658
37818
|
|
|
35659
37819
|
/**
|
|
35660
|
-
* Get
|
|
35661
|
-
*
|
|
35662
|
-
* @param {String} jobId jobId
|
|
35663
|
-
*/
|
|
35664
|
-
getRecordingJob(jobId) {
|
|
35665
|
-
// verify the required parameter 'jobId' is set
|
|
35666
|
-
if (jobId === undefined || jobId === null) {
|
|
35667
|
-
throw 'Missing the required parameter "jobId" when calling getRecordingJob';
|
|
35668
|
-
}
|
|
35669
|
-
|
|
35670
|
-
return this.apiClient.callApi(
|
|
35671
|
-
'/api/v2/recording/jobs/{jobId}',
|
|
35672
|
-
'GET',
|
|
35673
|
-
{ 'jobId': jobId },
|
|
35674
|
-
{ },
|
|
35675
|
-
{ },
|
|
35676
|
-
{ },
|
|
35677
|
-
null,
|
|
35678
|
-
['PureCloud OAuth'],
|
|
35679
|
-
['application/json'],
|
|
35680
|
-
['application/json']
|
|
35681
|
-
);
|
|
35682
|
-
}
|
|
35683
|
-
|
|
35684
|
-
/**
|
|
35685
|
-
* Get IDs of recordings that the bulk job failed for
|
|
35686
|
-
*
|
|
35687
|
-
* @param {String} jobId jobId
|
|
35688
|
-
* @param {Object} opts Optional parameters
|
|
35689
|
-
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
35690
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
35691
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
35692
|
-
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
35693
|
-
*/
|
|
35694
|
-
getRecordingJobFailedrecordings(jobId, opts) {
|
|
35695
|
-
opts = opts || {};
|
|
35696
|
-
|
|
35697
|
-
// verify the required parameter 'jobId' is set
|
|
35698
|
-
if (jobId === undefined || jobId === null) {
|
|
35699
|
-
throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
|
|
35700
|
-
}
|
|
35701
|
-
|
|
35702
|
-
return this.apiClient.callApi(
|
|
35703
|
-
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
35704
|
-
'GET',
|
|
35705
|
-
{ 'jobId': jobId },
|
|
35706
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
35707
|
-
{ },
|
|
35708
|
-
{ },
|
|
35709
|
-
null,
|
|
35710
|
-
['PureCloud OAuth'],
|
|
35711
|
-
['application/json'],
|
|
35712
|
-
['application/json']
|
|
35713
|
-
);
|
|
35714
|
-
}
|
|
35715
|
-
|
|
35716
|
-
/**
|
|
35717
|
-
* Get the status of all jobs within the user's organization
|
|
37820
|
+
* Get encryption key list
|
|
35718
37821
|
*
|
|
35719
37822
|
* @param {Object} opts Optional parameters
|
|
35720
37823
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
35721
37824
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
35722
|
-
* @param {Object} opts.sortBy Sort by (default to userId)
|
|
35723
|
-
* @param {Object} opts.state Filter by state
|
|
35724
|
-
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
35725
|
-
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
35726
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
35727
|
-
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
35728
37825
|
*/
|
|
35729
|
-
|
|
37826
|
+
getRecordingRecordingkeys(opts) {
|
|
35730
37827
|
opts = opts || {};
|
|
35731
37828
|
|
|
35732
37829
|
|
|
35733
37830
|
return this.apiClient.callApi(
|
|
35734
|
-
'/api/v2/recording/
|
|
35735
|
-
'GET',
|
|
35736
|
-
{ },
|
|
35737
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
35738
|
-
{ },
|
|
35739
|
-
{ },
|
|
35740
|
-
null,
|
|
35741
|
-
['PureCloud OAuth'],
|
|
35742
|
-
['application/json'],
|
|
35743
|
-
['application/json']
|
|
35744
|
-
);
|
|
35745
|
-
}
|
|
35746
|
-
|
|
35747
|
-
/**
|
|
35748
|
-
* Get the encryption key configurations
|
|
35749
|
-
*
|
|
35750
|
-
* @param {String} keyConfigurationId Key Configurations Id
|
|
35751
|
-
*/
|
|
35752
|
-
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
35753
|
-
// verify the required parameter 'keyConfigurationId' is set
|
|
35754
|
-
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
35755
|
-
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
35756
|
-
}
|
|
35757
|
-
|
|
35758
|
-
return this.apiClient.callApi(
|
|
35759
|
-
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
35760
|
-
'GET',
|
|
35761
|
-
{ 'keyConfigurationId': keyConfigurationId },
|
|
35762
|
-
{ },
|
|
35763
|
-
{ },
|
|
35764
|
-
{ },
|
|
35765
|
-
null,
|
|
35766
|
-
['PureCloud OAuth'],
|
|
35767
|
-
['application/json'],
|
|
35768
|
-
['application/json']
|
|
35769
|
-
);
|
|
35770
|
-
}
|
|
35771
|
-
|
|
35772
|
-
/**
|
|
35773
|
-
* Get a list of key configurations data
|
|
35774
|
-
*
|
|
35775
|
-
*/
|
|
35776
|
-
getRecordingKeyconfigurations() {
|
|
35777
|
-
|
|
35778
|
-
return this.apiClient.callApi(
|
|
35779
|
-
'/api/v2/recording/keyconfigurations',
|
|
35780
|
-
'GET',
|
|
35781
|
-
{ },
|
|
35782
|
-
{ },
|
|
35783
|
-
{ },
|
|
35784
|
-
{ },
|
|
35785
|
-
null,
|
|
35786
|
-
['PureCloud OAuth'],
|
|
35787
|
-
['application/json'],
|
|
35788
|
-
['application/json']
|
|
35789
|
-
);
|
|
35790
|
-
}
|
|
35791
|
-
|
|
35792
|
-
/**
|
|
35793
|
-
* Get the local encryption settings
|
|
35794
|
-
*
|
|
35795
|
-
* @param {String} settingsId Settings Id
|
|
35796
|
-
*/
|
|
35797
|
-
getRecordingLocalkeysSetting(settingsId) {
|
|
35798
|
-
// verify the required parameter 'settingsId' is set
|
|
35799
|
-
if (settingsId === undefined || settingsId === null) {
|
|
35800
|
-
throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
|
|
35801
|
-
}
|
|
35802
|
-
|
|
35803
|
-
return this.apiClient.callApi(
|
|
35804
|
-
'/api/v2/recording/localkeys/settings/{settingsId}',
|
|
37831
|
+
'/api/v2/recording/recordingkeys',
|
|
35805
37832
|
'GET',
|
|
35806
|
-
{ 'settingsId': settingsId },
|
|
35807
37833
|
{ },
|
|
37834
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
35808
37835
|
{ },
|
|
35809
37836
|
{ },
|
|
35810
37837
|
null,
|
|
@@ -35815,74 +37842,15 @@ class RecordingApi {
|
|
|
35815
37842
|
}
|
|
35816
37843
|
|
|
35817
37844
|
/**
|
|
35818
|
-
*
|
|
37845
|
+
* Get key rotation schedule
|
|
35819
37846
|
*
|
|
35820
37847
|
*/
|
|
35821
|
-
|
|
35822
|
-
|
|
35823
|
-
return this.apiClient.callApi(
|
|
35824
|
-
'/api/v2/recording/localkeys/settings',
|
|
35825
|
-
'GET',
|
|
35826
|
-
{ },
|
|
35827
|
-
{ },
|
|
35828
|
-
{ },
|
|
35829
|
-
{ },
|
|
35830
|
-
null,
|
|
35831
|
-
['PureCloud OAuth'],
|
|
35832
|
-
['application/json'],
|
|
35833
|
-
['application/json']
|
|
35834
|
-
);
|
|
35835
|
-
}
|
|
35836
|
-
|
|
35837
|
-
/**
|
|
35838
|
-
* Gets media retention policy list with query options to filter on name and enabled.
|
|
35839
|
-
* for a less verbose response, add summary=true to this endpoint
|
|
35840
|
-
* @param {Object} opts Optional parameters
|
|
35841
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
35842
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
35843
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
35844
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
35845
|
-
* @param {String} opts.nextPage next page token
|
|
35846
|
-
* @param {String} opts.previousPage Previous page token
|
|
35847
|
-
* @param {String} opts.name the policy name - used for filtering results in searches.
|
|
35848
|
-
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
35849
|
-
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
35850
|
-
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
35851
|
-
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
35852
|
-
*/
|
|
35853
|
-
getRecordingMediaretentionpolicies(opts) {
|
|
35854
|
-
opts = opts || {};
|
|
35855
|
-
|
|
37848
|
+
getRecordingRecordingkeysRotationschedule() {
|
|
35856
37849
|
|
|
35857
37850
|
return this.apiClient.callApi(
|
|
35858
|
-
'/api/v2/recording/
|
|
37851
|
+
'/api/v2/recording/recordingkeys/rotationschedule',
|
|
35859
37852
|
'GET',
|
|
35860
37853
|
{ },
|
|
35861
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
35862
|
-
{ },
|
|
35863
|
-
{ },
|
|
35864
|
-
null,
|
|
35865
|
-
['PureCloud OAuth'],
|
|
35866
|
-
['application/json'],
|
|
35867
|
-
['application/json']
|
|
35868
|
-
);
|
|
35869
|
-
}
|
|
35870
|
-
|
|
35871
|
-
/**
|
|
35872
|
-
* Get a media retention policy
|
|
35873
|
-
*
|
|
35874
|
-
* @param {String} policyId Policy ID
|
|
35875
|
-
*/
|
|
35876
|
-
getRecordingMediaretentionpolicy(policyId) {
|
|
35877
|
-
// verify the required parameter 'policyId' is set
|
|
35878
|
-
if (policyId === undefined || policyId === null) {
|
|
35879
|
-
throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
|
|
35880
|
-
}
|
|
35881
|
-
|
|
35882
|
-
return this.apiClient.callApi(
|
|
35883
|
-
'/api/v2/recording/mediaretentionpolicies/{policyId}',
|
|
35884
|
-
'GET',
|
|
35885
|
-
{ 'policyId': policyId },
|
|
35886
37854
|
{ },
|
|
35887
37855
|
{ },
|
|
35888
37856
|
{ },
|
|
@@ -35894,41 +37862,20 @@ class RecordingApi {
|
|
|
35894
37862
|
}
|
|
35895
37863
|
|
|
35896
37864
|
/**
|
|
35897
|
-
* Get
|
|
37865
|
+
* Get the Recording Settings for the Organization
|
|
35898
37866
|
*
|
|
35899
37867
|
* @param {Object} opts Optional parameters
|
|
35900
|
-
* @param {
|
|
35901
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37868
|
+
* @param {Boolean} opts.createDefault If no settings are found, a new one is created with default values (default to false)
|
|
35902
37869
|
*/
|
|
35903
|
-
|
|
37870
|
+
getRecordingSettings(opts) {
|
|
35904
37871
|
opts = opts || {};
|
|
35905
37872
|
|
|
35906
37873
|
|
|
35907
37874
|
return this.apiClient.callApi(
|
|
35908
|
-
'/api/v2/recording/
|
|
35909
|
-
'GET',
|
|
35910
|
-
{ },
|
|
35911
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
35912
|
-
{ },
|
|
35913
|
-
{ },
|
|
35914
|
-
null,
|
|
35915
|
-
['PureCloud OAuth'],
|
|
35916
|
-
['application/json'],
|
|
35917
|
-
['application/json']
|
|
35918
|
-
);
|
|
35919
|
-
}
|
|
35920
|
-
|
|
35921
|
-
/**
|
|
35922
|
-
* Get key rotation schedule
|
|
35923
|
-
*
|
|
35924
|
-
*/
|
|
35925
|
-
getRecordingRecordingkeysRotationschedule() {
|
|
35926
|
-
|
|
35927
|
-
return this.apiClient.callApi(
|
|
35928
|
-
'/api/v2/recording/recordingkeys/rotationschedule',
|
|
37875
|
+
'/api/v2/recording/settings',
|
|
35929
37876
|
'GET',
|
|
35930
37877
|
{ },
|
|
35931
|
-
{
|
|
37878
|
+
{ 'createDefault': opts['createDefault'] },
|
|
35932
37879
|
{ },
|
|
35933
37880
|
{ },
|
|
35934
37881
|
null,
|
|
@@ -35939,20 +37886,26 @@ class RecordingApi {
|
|
|
35939
37886
|
}
|
|
35940
37887
|
|
|
35941
37888
|
/**
|
|
35942
|
-
*
|
|
37889
|
+
* Query for recording retention data
|
|
35943
37890
|
*
|
|
37891
|
+
* @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
|
|
35944
37892
|
* @param {Object} opts Optional parameters
|
|
35945
|
-
* @param {
|
|
37893
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
37894
|
+
* @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
|
|
35946
37895
|
*/
|
|
35947
|
-
|
|
37896
|
+
getRecordingsRetentionQuery(retentionThresholdDays, opts) {
|
|
35948
37897
|
opts = opts || {};
|
|
35949
37898
|
|
|
37899
|
+
// verify the required parameter 'retentionThresholdDays' is set
|
|
37900
|
+
if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
|
|
37901
|
+
throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
|
|
37902
|
+
}
|
|
35950
37903
|
|
|
35951
37904
|
return this.apiClient.callApi(
|
|
35952
|
-
'/api/v2/
|
|
37905
|
+
'/api/v2/recordings/retention/query',
|
|
35953
37906
|
'GET',
|
|
35954
37907
|
{ },
|
|
35955
|
-
{ '
|
|
37908
|
+
{ 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
|
|
35956
37909
|
{ },
|
|
35957
37910
|
{ },
|
|
35958
37911
|
null,
|
|
@@ -36741,7 +38694,7 @@ class ResponseManagementApi {
|
|
|
36741
38694
|
/**
|
|
36742
38695
|
* ResponseManagement service.
|
|
36743
38696
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
36744
|
-
* @version
|
|
38697
|
+
* @version 147.0.0
|
|
36745
38698
|
*/
|
|
36746
38699
|
|
|
36747
38700
|
/**
|
|
@@ -37225,7 +39178,7 @@ class RoutingApi {
|
|
|
37225
39178
|
/**
|
|
37226
39179
|
* Routing service.
|
|
37227
39180
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
37228
|
-
* @version
|
|
39181
|
+
* @version 147.0.0
|
|
37229
39182
|
*/
|
|
37230
39183
|
|
|
37231
39184
|
/**
|
|
@@ -37791,6 +39744,26 @@ class RoutingApi {
|
|
|
37791
39744
|
);
|
|
37792
39745
|
}
|
|
37793
39746
|
|
|
39747
|
+
/**
|
|
39748
|
+
* Get available media types
|
|
39749
|
+
*
|
|
39750
|
+
*/
|
|
39751
|
+
getRoutingAvailablemediatypes() {
|
|
39752
|
+
|
|
39753
|
+
return this.apiClient.callApi(
|
|
39754
|
+
'/api/v2/routing/availablemediatypes',
|
|
39755
|
+
'GET',
|
|
39756
|
+
{ },
|
|
39757
|
+
{ },
|
|
39758
|
+
{ },
|
|
39759
|
+
{ },
|
|
39760
|
+
null,
|
|
39761
|
+
['PureCloud OAuth'],
|
|
39762
|
+
['application/json'],
|
|
39763
|
+
['application/json']
|
|
39764
|
+
);
|
|
39765
|
+
}
|
|
39766
|
+
|
|
37794
39767
|
/**
|
|
37795
39768
|
* Get domain
|
|
37796
39769
|
*
|
|
@@ -40146,7 +42119,7 @@ class SCIMApi {
|
|
|
40146
42119
|
/**
|
|
40147
42120
|
* SCIM service.
|
|
40148
42121
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
40149
|
-
* @version
|
|
42122
|
+
* @version 147.0.0
|
|
40150
42123
|
*/
|
|
40151
42124
|
|
|
40152
42125
|
/**
|
|
@@ -41023,7 +42996,7 @@ class ScriptsApi {
|
|
|
41023
42996
|
/**
|
|
41024
42997
|
* Scripts service.
|
|
41025
42998
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
41026
|
-
* @version
|
|
42999
|
+
* @version 147.0.0
|
|
41027
43000
|
*/
|
|
41028
43001
|
|
|
41029
43002
|
/**
|
|
@@ -41442,7 +43415,7 @@ class SearchApi {
|
|
|
41442
43415
|
/**
|
|
41443
43416
|
* Search service.
|
|
41444
43417
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
41445
|
-
* @version
|
|
43418
|
+
* @version 147.0.0
|
|
41446
43419
|
*/
|
|
41447
43420
|
|
|
41448
43421
|
/**
|
|
@@ -42002,7 +43975,7 @@ class SpeechTextAnalyticsApi {
|
|
|
42002
43975
|
/**
|
|
42003
43976
|
* SpeechTextAnalytics service.
|
|
42004
43977
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
42005
|
-
* @version
|
|
43978
|
+
* @version 147.0.0
|
|
42006
43979
|
*/
|
|
42007
43980
|
|
|
42008
43981
|
/**
|
|
@@ -42856,7 +44829,7 @@ class StationsApi {
|
|
|
42856
44829
|
/**
|
|
42857
44830
|
* Stations service.
|
|
42858
44831
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
42859
|
-
* @version
|
|
44832
|
+
* @version 147.0.0
|
|
42860
44833
|
*/
|
|
42861
44834
|
|
|
42862
44835
|
/**
|
|
@@ -43003,7 +44976,7 @@ class SuggestApi {
|
|
|
43003
44976
|
/**
|
|
43004
44977
|
* Suggest service.
|
|
43005
44978
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
43006
|
-
* @version
|
|
44979
|
+
* @version 147.0.0
|
|
43007
44980
|
*/
|
|
43008
44981
|
|
|
43009
44982
|
/**
|
|
@@ -43142,7 +45115,7 @@ class TeamsApi {
|
|
|
43142
45115
|
/**
|
|
43143
45116
|
* Teams service.
|
|
43144
45117
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
43145
|
-
* @version
|
|
45118
|
+
* @version 147.0.0
|
|
43146
45119
|
*/
|
|
43147
45120
|
|
|
43148
45121
|
/**
|
|
@@ -43321,7 +45294,7 @@ class TelephonyApi {
|
|
|
43321
45294
|
/**
|
|
43322
45295
|
* Telephony service.
|
|
43323
45296
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
43324
|
-
* @version
|
|
45297
|
+
* @version 147.0.0
|
|
43325
45298
|
*/
|
|
43326
45299
|
|
|
43327
45300
|
/**
|
|
@@ -43429,7 +45402,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
43429
45402
|
/**
|
|
43430
45403
|
* TelephonyProvidersEdge service.
|
|
43431
45404
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
43432
|
-
* @version
|
|
45405
|
+
* @version 147.0.0
|
|
43433
45406
|
*/
|
|
43434
45407
|
|
|
43435
45408
|
/**
|
|
@@ -47062,7 +49035,7 @@ class TextbotsApi {
|
|
|
47062
49035
|
/**
|
|
47063
49036
|
* Textbots service.
|
|
47064
49037
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
47065
|
-
* @version
|
|
49038
|
+
* @version 147.0.0
|
|
47066
49039
|
*/
|
|
47067
49040
|
|
|
47068
49041
|
/**
|
|
@@ -47190,7 +49163,7 @@ class TokensApi {
|
|
|
47190
49163
|
/**
|
|
47191
49164
|
* Tokens service.
|
|
47192
49165
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
47193
|
-
* @version
|
|
49166
|
+
* @version 147.0.0
|
|
47194
49167
|
*/
|
|
47195
49168
|
|
|
47196
49169
|
/**
|
|
@@ -47296,7 +49269,7 @@ class UploadsApi {
|
|
|
47296
49269
|
/**
|
|
47297
49270
|
* Uploads service.
|
|
47298
49271
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
47299
|
-
* @version
|
|
49272
|
+
* @version 147.0.0
|
|
47300
49273
|
*/
|
|
47301
49274
|
|
|
47302
49275
|
/**
|
|
@@ -47472,7 +49445,7 @@ class UsageApi {
|
|
|
47472
49445
|
/**
|
|
47473
49446
|
* Usage service.
|
|
47474
49447
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
47475
|
-
* @version
|
|
49448
|
+
* @version 147.0.0
|
|
47476
49449
|
*/
|
|
47477
49450
|
|
|
47478
49451
|
/**
|
|
@@ -47543,7 +49516,7 @@ class UserRecordingsApi {
|
|
|
47543
49516
|
/**
|
|
47544
49517
|
* UserRecordings service.
|
|
47545
49518
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
47546
|
-
* @version
|
|
49519
|
+
* @version 147.0.0
|
|
47547
49520
|
*/
|
|
47548
49521
|
|
|
47549
49522
|
/**
|
|
@@ -47727,7 +49700,7 @@ class UsersApi {
|
|
|
47727
49700
|
/**
|
|
47728
49701
|
* Users service.
|
|
47729
49702
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
47730
|
-
* @version
|
|
49703
|
+
* @version 147.0.0
|
|
47731
49704
|
*/
|
|
47732
49705
|
|
|
47733
49706
|
/**
|
|
@@ -49469,6 +51442,36 @@ class UsersApi {
|
|
|
49469
51442
|
);
|
|
49470
51443
|
}
|
|
49471
51444
|
|
|
51445
|
+
/**
|
|
51446
|
+
* Create mapping between external identifier and user. Limit 100 per entity.
|
|
51447
|
+
* Authority Name and External key are case sensitive.
|
|
51448
|
+
* @param {String} userId User ID
|
|
51449
|
+
* @param {Object} body
|
|
51450
|
+
*/
|
|
51451
|
+
postUserExternalid(userId, body) {
|
|
51452
|
+
// verify the required parameter 'userId' is set
|
|
51453
|
+
if (userId === undefined || userId === null) {
|
|
51454
|
+
throw 'Missing the required parameter "userId" when calling postUserExternalid';
|
|
51455
|
+
}
|
|
51456
|
+
// verify the required parameter 'body' is set
|
|
51457
|
+
if (body === undefined || body === null) {
|
|
51458
|
+
throw 'Missing the required parameter "body" when calling postUserExternalid';
|
|
51459
|
+
}
|
|
51460
|
+
|
|
51461
|
+
return this.apiClient.callApi(
|
|
51462
|
+
'/api/v2/users/{userId}/externalid',
|
|
51463
|
+
'POST',
|
|
51464
|
+
{ 'userId': userId },
|
|
51465
|
+
{ },
|
|
51466
|
+
{ },
|
|
51467
|
+
{ },
|
|
51468
|
+
body,
|
|
51469
|
+
['PureCloud OAuth'],
|
|
51470
|
+
['application/json'],
|
|
51471
|
+
['application/json']
|
|
51472
|
+
);
|
|
51473
|
+
}
|
|
51474
|
+
|
|
49472
51475
|
/**
|
|
49473
51476
|
* Send an activation email to the user
|
|
49474
51477
|
*
|
|
@@ -49590,7 +51593,7 @@ class UsersApi {
|
|
|
49590
51593
|
|
|
49591
51594
|
/**
|
|
49592
51595
|
* Create user
|
|
49593
|
-
*
|
|
51596
|
+
* 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.
|
|
49594
51597
|
* @param {Object} body User
|
|
49595
51598
|
*/
|
|
49596
51599
|
postUsers(body) {
|
|
@@ -50029,7 +52032,7 @@ class UtilitiesApi {
|
|
|
50029
52032
|
/**
|
|
50030
52033
|
* Utilities service.
|
|
50031
52034
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
50032
|
-
* @version
|
|
52035
|
+
* @version 147.0.0
|
|
50033
52036
|
*/
|
|
50034
52037
|
|
|
50035
52038
|
/**
|
|
@@ -50140,7 +52143,7 @@ class VoicemailApi {
|
|
|
50140
52143
|
/**
|
|
50141
52144
|
* Voicemail service.
|
|
50142
52145
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
50143
|
-
* @version
|
|
52146
|
+
* @version 147.0.0
|
|
50144
52147
|
*/
|
|
50145
52148
|
|
|
50146
52149
|
/**
|
|
@@ -50807,7 +52810,7 @@ class WebChatApi {
|
|
|
50807
52810
|
/**
|
|
50808
52811
|
* WebChat service.
|
|
50809
52812
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
50810
|
-
* @version
|
|
52813
|
+
* @version 147.0.0
|
|
50811
52814
|
*/
|
|
50812
52815
|
|
|
50813
52816
|
/**
|
|
@@ -51351,7 +53354,7 @@ class WebDeploymentsApi {
|
|
|
51351
53354
|
/**
|
|
51352
53355
|
* WebDeployments service.
|
|
51353
53356
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
51354
|
-
* @version
|
|
53357
|
+
* @version 147.0.0
|
|
51355
53358
|
*/
|
|
51356
53359
|
|
|
51357
53360
|
/**
|
|
@@ -51545,6 +53548,35 @@ class WebDeploymentsApi {
|
|
|
51545
53548
|
);
|
|
51546
53549
|
}
|
|
51547
53550
|
|
|
53551
|
+
/**
|
|
53552
|
+
* Get active configuration for a given deployment
|
|
53553
|
+
*
|
|
53554
|
+
* @param {String} deploymentId The deployment ID
|
|
53555
|
+
* @param {Object} opts Optional parameters
|
|
53556
|
+
* @param {String} opts.type Get active configuration on a deployment
|
|
53557
|
+
*/
|
|
53558
|
+
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
53559
|
+
opts = opts || {};
|
|
53560
|
+
|
|
53561
|
+
// verify the required parameter 'deploymentId' is set
|
|
53562
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
53563
|
+
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';
|
|
53564
|
+
}
|
|
53565
|
+
|
|
53566
|
+
return this.apiClient.callApi(
|
|
53567
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
53568
|
+
'GET',
|
|
53569
|
+
{ 'deploymentId': deploymentId },
|
|
53570
|
+
{ 'type': opts['type'] },
|
|
53571
|
+
{ },
|
|
53572
|
+
{ },
|
|
53573
|
+
null,
|
|
53574
|
+
['PureCloud OAuth'],
|
|
53575
|
+
['application/json'],
|
|
53576
|
+
['application/json']
|
|
53577
|
+
);
|
|
53578
|
+
}
|
|
53579
|
+
|
|
51548
53580
|
/**
|
|
51549
53581
|
* Get deployments
|
|
51550
53582
|
*
|
|
@@ -51706,7 +53738,7 @@ class WebMessagingApi {
|
|
|
51706
53738
|
/**
|
|
51707
53739
|
* WebMessaging service.
|
|
51708
53740
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
51709
|
-
* @version
|
|
53741
|
+
* @version 147.0.0
|
|
51710
53742
|
*/
|
|
51711
53743
|
|
|
51712
53744
|
/**
|
|
@@ -51752,7 +53784,7 @@ class WidgetsApi {
|
|
|
51752
53784
|
/**
|
|
51753
53785
|
* Widgets service.
|
|
51754
53786
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
51755
|
-
* @version
|
|
53787
|
+
* @version 147.0.0
|
|
51756
53788
|
*/
|
|
51757
53789
|
|
|
51758
53790
|
/**
|
|
@@ -51898,7 +53930,7 @@ class WorkforceManagementApi {
|
|
|
51898
53930
|
/**
|
|
51899
53931
|
* WorkforceManagement service.
|
|
51900
53932
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
51901
|
-
* @version
|
|
53933
|
+
* @version 147.0.0
|
|
51902
53934
|
*/
|
|
51903
53935
|
|
|
51904
53936
|
/**
|
|
@@ -56174,7 +58206,7 @@ class WorkforceManagementApi {
|
|
|
56174
58206
|
* </pre>
|
|
56175
58207
|
* </p>
|
|
56176
58208
|
* @module purecloud-platform-client-v2/index
|
|
56177
|
-
* @version
|
|
58209
|
+
* @version 147.0.0
|
|
56178
58210
|
*/
|
|
56179
58211
|
class platformClient {
|
|
56180
58212
|
constructor() {
|