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
|
@@ -9307,7 +9307,7 @@ class Configuration {
|
|
|
9307
9307
|
|
|
9308
9308
|
/**
|
|
9309
9309
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9310
|
-
* @version
|
|
9310
|
+
* @version 147.0.0
|
|
9311
9311
|
*/
|
|
9312
9312
|
class ApiClient {
|
|
9313
9313
|
/**
|
|
@@ -10379,7 +10379,7 @@ class AlertingApi {
|
|
|
10379
10379
|
/**
|
|
10380
10380
|
* Alerting service.
|
|
10381
10381
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10382
|
-
* @version
|
|
10382
|
+
* @version 147.0.0
|
|
10383
10383
|
*/
|
|
10384
10384
|
|
|
10385
10385
|
/**
|
|
@@ -10693,7 +10693,7 @@ class AnalyticsApi {
|
|
|
10693
10693
|
/**
|
|
10694
10694
|
* Analytics service.
|
|
10695
10695
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
10696
|
-
* @version
|
|
10696
|
+
* @version 147.0.0
|
|
10697
10697
|
*/
|
|
10698
10698
|
|
|
10699
10699
|
/**
|
|
@@ -10939,6 +10939,26 @@ class AnalyticsApi {
|
|
|
10939
10939
|
);
|
|
10940
10940
|
}
|
|
10941
10941
|
|
|
10942
|
+
/**
|
|
10943
|
+
* Get analytics data retention setting
|
|
10944
|
+
*
|
|
10945
|
+
*/
|
|
10946
|
+
getAnalyticsDataretentionSettings() {
|
|
10947
|
+
|
|
10948
|
+
return this.apiClient.callApi(
|
|
10949
|
+
'/api/v2/analytics/dataretention/settings',
|
|
10950
|
+
'GET',
|
|
10951
|
+
{ },
|
|
10952
|
+
{ },
|
|
10953
|
+
{ },
|
|
10954
|
+
{ },
|
|
10955
|
+
null,
|
|
10956
|
+
['PureCloud OAuth'],
|
|
10957
|
+
['application/json'],
|
|
10958
|
+
['application/json']
|
|
10959
|
+
);
|
|
10960
|
+
}
|
|
10961
|
+
|
|
10942
10962
|
/**
|
|
10943
10963
|
* Get all view export requests for a user
|
|
10944
10964
|
*
|
|
@@ -11839,6 +11859,31 @@ class AnalyticsApi {
|
|
|
11839
11859
|
);
|
|
11840
11860
|
}
|
|
11841
11861
|
|
|
11862
|
+
/**
|
|
11863
|
+
* Update analytics data retention setting
|
|
11864
|
+
*
|
|
11865
|
+
* @param {Object} body retentionDays
|
|
11866
|
+
*/
|
|
11867
|
+
putAnalyticsDataretentionSettings(body) {
|
|
11868
|
+
// verify the required parameter 'body' is set
|
|
11869
|
+
if (body === undefined || body === null) {
|
|
11870
|
+
throw 'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';
|
|
11871
|
+
}
|
|
11872
|
+
|
|
11873
|
+
return this.apiClient.callApi(
|
|
11874
|
+
'/api/v2/analytics/dataretention/settings',
|
|
11875
|
+
'PUT',
|
|
11876
|
+
{ },
|
|
11877
|
+
{ },
|
|
11878
|
+
{ },
|
|
11879
|
+
{ },
|
|
11880
|
+
body,
|
|
11881
|
+
['PureCloud OAuth'],
|
|
11882
|
+
['application/json'],
|
|
11883
|
+
['application/json']
|
|
11884
|
+
);
|
|
11885
|
+
}
|
|
11886
|
+
|
|
11842
11887
|
/**
|
|
11843
11888
|
* Update a scheduled report job.
|
|
11844
11889
|
*
|
|
@@ -11875,7 +11920,7 @@ class ArchitectApi {
|
|
|
11875
11920
|
/**
|
|
11876
11921
|
* Architect service.
|
|
11877
11922
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
11878
|
-
* @version
|
|
11923
|
+
* @version 147.0.0
|
|
11879
11924
|
*/
|
|
11880
11925
|
|
|
11881
11926
|
/**
|
|
@@ -12633,6 +12678,7 @@ class ArchitectApi {
|
|
|
12633
12678
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
12634
12679
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
12635
12680
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
12681
|
+
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
12636
12682
|
*/
|
|
12637
12683
|
getArchitectIvrs(opts) {
|
|
12638
12684
|
opts = opts || {};
|
|
@@ -12642,7 +12688,7 @@ class ArchitectApi {
|
|
|
12642
12688
|
'/api/v2/architect/ivrs',
|
|
12643
12689
|
'GET',
|
|
12644
12690
|
{ },
|
|
12645
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
12691
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
12646
12692
|
{ },
|
|
12647
12693
|
{ },
|
|
12648
12694
|
null,
|
|
@@ -14920,7 +14966,7 @@ class AuditApi {
|
|
|
14920
14966
|
/**
|
|
14921
14967
|
* Audit service.
|
|
14922
14968
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14923
|
-
* @version
|
|
14969
|
+
* @version 147.0.0
|
|
14924
14970
|
*/
|
|
14925
14971
|
|
|
14926
14972
|
/**
|
|
@@ -15091,7 +15137,7 @@ class AuthorizationApi {
|
|
|
15091
15137
|
/**
|
|
15092
15138
|
* Authorization service.
|
|
15093
15139
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15094
|
-
* @version
|
|
15140
|
+
* @version 147.0.0
|
|
15095
15141
|
*/
|
|
15096
15142
|
|
|
15097
15143
|
/**
|
|
@@ -16274,7 +16320,7 @@ class BillingApi {
|
|
|
16274
16320
|
/**
|
|
16275
16321
|
* Billing service.
|
|
16276
16322
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16277
|
-
* @version
|
|
16323
|
+
* @version 147.0.0
|
|
16278
16324
|
*/
|
|
16279
16325
|
|
|
16280
16326
|
/**
|
|
@@ -16354,7 +16400,7 @@ class ChatApi {
|
|
|
16354
16400
|
/**
|
|
16355
16401
|
* Chat service.
|
|
16356
16402
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16357
|
-
* @version
|
|
16403
|
+
* @version 147.0.0
|
|
16358
16404
|
*/
|
|
16359
16405
|
|
|
16360
16406
|
/**
|
|
@@ -16445,7 +16491,7 @@ class CoachingApi {
|
|
|
16445
16491
|
/**
|
|
16446
16492
|
* Coaching service.
|
|
16447
16493
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16448
|
-
* @version
|
|
16494
|
+
* @version 147.0.0
|
|
16449
16495
|
*/
|
|
16450
16496
|
|
|
16451
16497
|
/**
|
|
@@ -17022,7 +17068,7 @@ class ContentManagementApi {
|
|
|
17022
17068
|
/**
|
|
17023
17069
|
* ContentManagement service.
|
|
17024
17070
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17025
|
-
* @version
|
|
17071
|
+
* @version 147.0.0
|
|
17026
17072
|
*/
|
|
17027
17073
|
|
|
17028
17074
|
/**
|
|
@@ -18162,7 +18208,7 @@ class ConversationsApi {
|
|
|
18162
18208
|
/**
|
|
18163
18209
|
* Conversations service.
|
|
18164
18210
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18165
|
-
* @version
|
|
18211
|
+
* @version 147.0.0
|
|
18166
18212
|
*/
|
|
18167
18213
|
|
|
18168
18214
|
/**
|
|
@@ -18755,6 +18801,31 @@ class ConversationsApi {
|
|
|
18755
18801
|
);
|
|
18756
18802
|
}
|
|
18757
18803
|
|
|
18804
|
+
/**
|
|
18805
|
+
* Get the secure attributes on a conversation.
|
|
18806
|
+
*
|
|
18807
|
+
* @param {String} conversationId conversation ID
|
|
18808
|
+
*/
|
|
18809
|
+
getConversationSecureattributes(conversationId) {
|
|
18810
|
+
// verify the required parameter 'conversationId' is set
|
|
18811
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18812
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSecureattributes';
|
|
18813
|
+
}
|
|
18814
|
+
|
|
18815
|
+
return this.apiClient.callApi(
|
|
18816
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
18817
|
+
'GET',
|
|
18818
|
+
{ 'conversationId': conversationId },
|
|
18819
|
+
{ },
|
|
18820
|
+
{ },
|
|
18821
|
+
{ },
|
|
18822
|
+
null,
|
|
18823
|
+
['PureCloud OAuth'],
|
|
18824
|
+
['application/json'],
|
|
18825
|
+
['application/json']
|
|
18826
|
+
);
|
|
18827
|
+
}
|
|
18828
|
+
|
|
18758
18829
|
/**
|
|
18759
18830
|
* Get active conversations for the logged in user
|
|
18760
18831
|
*
|
|
@@ -19538,6 +19609,51 @@ class ConversationsApi {
|
|
|
19538
19609
|
);
|
|
19539
19610
|
}
|
|
19540
19611
|
|
|
19612
|
+
/**
|
|
19613
|
+
* Get the encryption key configurations
|
|
19614
|
+
*
|
|
19615
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
19616
|
+
*/
|
|
19617
|
+
getConversationsKeyconfiguration(keyconfigurationsId) {
|
|
19618
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
19619
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
19620
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';
|
|
19621
|
+
}
|
|
19622
|
+
|
|
19623
|
+
return this.apiClient.callApi(
|
|
19624
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
19625
|
+
'GET',
|
|
19626
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
19627
|
+
{ },
|
|
19628
|
+
{ },
|
|
19629
|
+
{ },
|
|
19630
|
+
null,
|
|
19631
|
+
['PureCloud OAuth'],
|
|
19632
|
+
['application/json'],
|
|
19633
|
+
['application/json']
|
|
19634
|
+
);
|
|
19635
|
+
}
|
|
19636
|
+
|
|
19637
|
+
/**
|
|
19638
|
+
* Get a list of key configurations data
|
|
19639
|
+
*
|
|
19640
|
+
*/
|
|
19641
|
+
getConversationsKeyconfigurations() {
|
|
19642
|
+
|
|
19643
|
+
return this.apiClient.callApi(
|
|
19644
|
+
'/api/v2/conversations/keyconfigurations',
|
|
19645
|
+
'GET',
|
|
19646
|
+
{ },
|
|
19647
|
+
{ },
|
|
19648
|
+
{ },
|
|
19649
|
+
{ },
|
|
19650
|
+
null,
|
|
19651
|
+
['PureCloud OAuth'],
|
|
19652
|
+
['application/json'],
|
|
19653
|
+
['application/json']
|
|
19654
|
+
);
|
|
19655
|
+
}
|
|
19656
|
+
|
|
19541
19657
|
/**
|
|
19542
19658
|
* Get message conversation
|
|
19543
19659
|
*
|
|
@@ -20254,6 +20370,36 @@ class ConversationsApi {
|
|
|
20254
20370
|
);
|
|
20255
20371
|
}
|
|
20256
20372
|
|
|
20373
|
+
/**
|
|
20374
|
+
* Update the secure attributes on a conversation.
|
|
20375
|
+
*
|
|
20376
|
+
* @param {String} conversationId conversation ID
|
|
20377
|
+
* @param {Object} body Conversation Secure Attributes
|
|
20378
|
+
*/
|
|
20379
|
+
patchConversationSecureattributes(conversationId, body) {
|
|
20380
|
+
// verify the required parameter 'conversationId' is set
|
|
20381
|
+
if (conversationId === undefined || conversationId === null) {
|
|
20382
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';
|
|
20383
|
+
}
|
|
20384
|
+
// verify the required parameter 'body' is set
|
|
20385
|
+
if (body === undefined || body === null) {
|
|
20386
|
+
throw 'Missing the required parameter "body" when calling patchConversationSecureattributes';
|
|
20387
|
+
}
|
|
20388
|
+
|
|
20389
|
+
return this.apiClient.callApi(
|
|
20390
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
20391
|
+
'PATCH',
|
|
20392
|
+
{ 'conversationId': conversationId },
|
|
20393
|
+
{ },
|
|
20394
|
+
{ },
|
|
20395
|
+
{ },
|
|
20396
|
+
body,
|
|
20397
|
+
['PureCloud OAuth'],
|
|
20398
|
+
['application/json'],
|
|
20399
|
+
['application/json']
|
|
20400
|
+
);
|
|
20401
|
+
}
|
|
20402
|
+
|
|
20257
20403
|
/**
|
|
20258
20404
|
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
20259
20405
|
*
|
|
@@ -22256,6 +22402,56 @@ class ConversationsApi {
|
|
|
22256
22402
|
);
|
|
22257
22403
|
}
|
|
22258
22404
|
|
|
22405
|
+
/**
|
|
22406
|
+
* Setup configurations for encryption key creation
|
|
22407
|
+
*
|
|
22408
|
+
* @param {Object} body Encryption Configuration
|
|
22409
|
+
*/
|
|
22410
|
+
postConversationsKeyconfigurations(body) {
|
|
22411
|
+
// verify the required parameter 'body' is set
|
|
22412
|
+
if (body === undefined || body === null) {
|
|
22413
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurations';
|
|
22414
|
+
}
|
|
22415
|
+
|
|
22416
|
+
return this.apiClient.callApi(
|
|
22417
|
+
'/api/v2/conversations/keyconfigurations',
|
|
22418
|
+
'POST',
|
|
22419
|
+
{ },
|
|
22420
|
+
{ },
|
|
22421
|
+
{ },
|
|
22422
|
+
{ },
|
|
22423
|
+
body,
|
|
22424
|
+
['PureCloud OAuth'],
|
|
22425
|
+
['application/json'],
|
|
22426
|
+
['application/json']
|
|
22427
|
+
);
|
|
22428
|
+
}
|
|
22429
|
+
|
|
22430
|
+
/**
|
|
22431
|
+
* Validate encryption key configurations without saving it
|
|
22432
|
+
*
|
|
22433
|
+
* @param {Object} body Encryption Configuration
|
|
22434
|
+
*/
|
|
22435
|
+
postConversationsKeyconfigurationsValidate(body) {
|
|
22436
|
+
// verify the required parameter 'body' is set
|
|
22437
|
+
if (body === undefined || body === null) {
|
|
22438
|
+
throw 'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';
|
|
22439
|
+
}
|
|
22440
|
+
|
|
22441
|
+
return this.apiClient.callApi(
|
|
22442
|
+
'/api/v2/conversations/keyconfigurations/validate',
|
|
22443
|
+
'POST',
|
|
22444
|
+
{ },
|
|
22445
|
+
{ },
|
|
22446
|
+
{ },
|
|
22447
|
+
{ },
|
|
22448
|
+
body,
|
|
22449
|
+
['PureCloud OAuth'],
|
|
22450
|
+
['application/json'],
|
|
22451
|
+
['application/json']
|
|
22452
|
+
);
|
|
22453
|
+
}
|
|
22454
|
+
|
|
22259
22455
|
/**
|
|
22260
22456
|
* Send message
|
|
22261
22457
|
* 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.
|
|
@@ -22640,6 +22836,36 @@ class ConversationsApi {
|
|
|
22640
22836
|
);
|
|
22641
22837
|
}
|
|
22642
22838
|
|
|
22839
|
+
/**
|
|
22840
|
+
* Set the secure attributes on a conversation.
|
|
22841
|
+
*
|
|
22842
|
+
* @param {String} conversationId conversation ID
|
|
22843
|
+
* @param {Object} body Conversation Secure Attributes
|
|
22844
|
+
*/
|
|
22845
|
+
putConversationSecureattributes(conversationId, body) {
|
|
22846
|
+
// verify the required parameter 'conversationId' is set
|
|
22847
|
+
if (conversationId === undefined || conversationId === null) {
|
|
22848
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationSecureattributes';
|
|
22849
|
+
}
|
|
22850
|
+
// verify the required parameter 'body' is set
|
|
22851
|
+
if (body === undefined || body === null) {
|
|
22852
|
+
throw 'Missing the required parameter "body" when calling putConversationSecureattributes';
|
|
22853
|
+
}
|
|
22854
|
+
|
|
22855
|
+
return this.apiClient.callApi(
|
|
22856
|
+
'/api/v2/conversations/{conversationId}/secureattributes',
|
|
22857
|
+
'PUT',
|
|
22858
|
+
{ 'conversationId': conversationId },
|
|
22859
|
+
{ },
|
|
22860
|
+
{ },
|
|
22861
|
+
{ },
|
|
22862
|
+
body,
|
|
22863
|
+
['PureCloud OAuth'],
|
|
22864
|
+
['application/json'],
|
|
22865
|
+
['application/json']
|
|
22866
|
+
);
|
|
22867
|
+
}
|
|
22868
|
+
|
|
22643
22869
|
/**
|
|
22644
22870
|
* Update the tags on a conversation.
|
|
22645
22871
|
*
|
|
@@ -22890,6 +23116,36 @@ class ConversationsApi {
|
|
|
22890
23116
|
);
|
|
22891
23117
|
}
|
|
22892
23118
|
|
|
23119
|
+
/**
|
|
23120
|
+
* Update the encryption key configurations
|
|
23121
|
+
*
|
|
23122
|
+
* @param {String} keyconfigurationsId Key Configurations Id
|
|
23123
|
+
* @param {Object} body Encryption key configuration metadata
|
|
23124
|
+
*/
|
|
23125
|
+
putConversationsKeyconfiguration(keyconfigurationsId, body) {
|
|
23126
|
+
// verify the required parameter 'keyconfigurationsId' is set
|
|
23127
|
+
if (keyconfigurationsId === undefined || keyconfigurationsId === null) {
|
|
23128
|
+
throw 'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';
|
|
23129
|
+
}
|
|
23130
|
+
// verify the required parameter 'body' is set
|
|
23131
|
+
if (body === undefined || body === null) {
|
|
23132
|
+
throw 'Missing the required parameter "body" when calling putConversationsKeyconfiguration';
|
|
23133
|
+
}
|
|
23134
|
+
|
|
23135
|
+
return this.apiClient.callApi(
|
|
23136
|
+
'/api/v2/conversations/keyconfigurations/{keyconfigurationsId}',
|
|
23137
|
+
'PUT',
|
|
23138
|
+
{ 'keyconfigurationsId': keyconfigurationsId },
|
|
23139
|
+
{ },
|
|
23140
|
+
{ },
|
|
23141
|
+
{ },
|
|
23142
|
+
body,
|
|
23143
|
+
['PureCloud OAuth'],
|
|
23144
|
+
['application/json'],
|
|
23145
|
+
['application/json']
|
|
23146
|
+
);
|
|
23147
|
+
}
|
|
23148
|
+
|
|
22893
23149
|
/**
|
|
22894
23150
|
* Update a conversation by setting its recording state
|
|
22895
23151
|
*
|
|
@@ -23096,7 +23352,7 @@ class DataExtensionsApi {
|
|
|
23096
23352
|
/**
|
|
23097
23353
|
* DataExtensions service.
|
|
23098
23354
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23099
|
-
* @version
|
|
23355
|
+
* @version 147.0.0
|
|
23100
23356
|
*/
|
|
23101
23357
|
|
|
23102
23358
|
/**
|
|
@@ -23182,7 +23438,7 @@ class ExternalContactsApi {
|
|
|
23182
23438
|
/**
|
|
23183
23439
|
* ExternalContacts service.
|
|
23184
23440
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23185
|
-
* @version
|
|
23441
|
+
* @version 147.0.0
|
|
23186
23442
|
*/
|
|
23187
23443
|
|
|
23188
23444
|
/**
|
|
@@ -24925,7 +25181,7 @@ class FaxApi {
|
|
|
24925
25181
|
/**
|
|
24926
25182
|
* Fax service.
|
|
24927
25183
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24928
|
-
* @version
|
|
25184
|
+
* @version 147.0.0
|
|
24929
25185
|
*/
|
|
24930
25186
|
|
|
24931
25187
|
/**
|
|
@@ -25096,7 +25352,7 @@ class FlowsApi {
|
|
|
25096
25352
|
/**
|
|
25097
25353
|
* Flows service.
|
|
25098
25354
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25099
|
-
* @version
|
|
25355
|
+
* @version 147.0.0
|
|
25100
25356
|
*/
|
|
25101
25357
|
|
|
25102
25358
|
/**
|
|
@@ -25167,7 +25423,7 @@ class GamificationApi {
|
|
|
25167
25423
|
/**
|
|
25168
25424
|
* Gamification service.
|
|
25169
25425
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25170
|
-
* @version
|
|
25426
|
+
* @version 147.0.0
|
|
25171
25427
|
*/
|
|
25172
25428
|
|
|
25173
25429
|
/**
|
|
@@ -26898,7 +27154,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26898
27154
|
/**
|
|
26899
27155
|
* GeneralDataProtectionRegulation service.
|
|
26900
27156
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26901
|
-
* @version
|
|
27157
|
+
* @version 147.0.0
|
|
26902
27158
|
*/
|
|
26903
27159
|
|
|
26904
27160
|
/**
|
|
@@ -27028,7 +27284,7 @@ class GeolocationApi {
|
|
|
27028
27284
|
/**
|
|
27029
27285
|
* Geolocation service.
|
|
27030
27286
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
27031
|
-
* @version
|
|
27287
|
+
* @version 147.0.0
|
|
27032
27288
|
*/
|
|
27033
27289
|
|
|
27034
27290
|
/**
|
|
@@ -27159,7 +27415,7 @@ class GreetingsApi {
|
|
|
27159
27415
|
/**
|
|
27160
27416
|
* Greetings service.
|
|
27161
27417
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
27162
|
-
* @version
|
|
27418
|
+
* @version 147.0.0
|
|
27163
27419
|
*/
|
|
27164
27420
|
|
|
27165
27421
|
/**
|
|
@@ -27614,7 +27870,7 @@ class GroupsApi {
|
|
|
27614
27870
|
/**
|
|
27615
27871
|
* Groups service.
|
|
27616
27872
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27617
|
-
* @version
|
|
27873
|
+
* @version 147.0.0
|
|
27618
27874
|
*/
|
|
27619
27875
|
|
|
27620
27876
|
/**
|
|
@@ -28019,7 +28275,7 @@ class IdentityProviderApi {
|
|
|
28019
28275
|
/**
|
|
28020
28276
|
* IdentityProvider service.
|
|
28021
28277
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
28022
|
-
* @version
|
|
28278
|
+
* @version 147.0.0
|
|
28023
28279
|
*/
|
|
28024
28280
|
|
|
28025
28281
|
/**
|
|
@@ -28775,7 +29031,7 @@ class IntegrationsApi {
|
|
|
28775
29031
|
/**
|
|
28776
29032
|
* Integrations service.
|
|
28777
29033
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28778
|
-
* @version
|
|
29034
|
+
* @version 147.0.0
|
|
28779
29035
|
*/
|
|
28780
29036
|
|
|
28781
29037
|
/**
|
|
@@ -30452,7 +30708,7 @@ class JourneyApi {
|
|
|
30452
30708
|
/**
|
|
30453
30709
|
* Journey service.
|
|
30454
30710
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30455
|
-
* @version
|
|
30711
|
+
* @version 147.0.0
|
|
30456
30712
|
*/
|
|
30457
30713
|
|
|
30458
30714
|
/**
|
|
@@ -31163,7 +31419,7 @@ class KnowledgeApi {
|
|
|
31163
31419
|
/**
|
|
31164
31420
|
* Knowledge service.
|
|
31165
31421
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31166
|
-
* @version
|
|
31422
|
+
* @version 147.0.0
|
|
31167
31423
|
*/
|
|
31168
31424
|
|
|
31169
31425
|
/**
|
|
@@ -31203,6 +31459,191 @@ class KnowledgeApi {
|
|
|
31203
31459
|
);
|
|
31204
31460
|
}
|
|
31205
31461
|
|
|
31462
|
+
/**
|
|
31463
|
+
* Delete category
|
|
31464
|
+
*
|
|
31465
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31466
|
+
* @param {String} categoryId Category ID
|
|
31467
|
+
*/
|
|
31468
|
+
deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
31469
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31470
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31471
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
31472
|
+
}
|
|
31473
|
+
// verify the required parameter 'categoryId' is set
|
|
31474
|
+
if (categoryId === undefined || categoryId === null) {
|
|
31475
|
+
throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';
|
|
31476
|
+
}
|
|
31477
|
+
|
|
31478
|
+
return this.apiClient.callApi(
|
|
31479
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
31480
|
+
'DELETE',
|
|
31481
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
31482
|
+
{ },
|
|
31483
|
+
{ },
|
|
31484
|
+
{ },
|
|
31485
|
+
null,
|
|
31486
|
+
['PureCloud OAuth'],
|
|
31487
|
+
['application/json'],
|
|
31488
|
+
['application/json']
|
|
31489
|
+
);
|
|
31490
|
+
}
|
|
31491
|
+
|
|
31492
|
+
/**
|
|
31493
|
+
* Delete document.
|
|
31494
|
+
*
|
|
31495
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31496
|
+
* @param {String} documentId Document ID.
|
|
31497
|
+
*/
|
|
31498
|
+
deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId) {
|
|
31499
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31500
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31501
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
31502
|
+
}
|
|
31503
|
+
// verify the required parameter 'documentId' is set
|
|
31504
|
+
if (documentId === undefined || documentId === null) {
|
|
31505
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';
|
|
31506
|
+
}
|
|
31507
|
+
|
|
31508
|
+
return this.apiClient.callApi(
|
|
31509
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
31510
|
+
'DELETE',
|
|
31511
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31512
|
+
{ },
|
|
31513
|
+
{ },
|
|
31514
|
+
{ },
|
|
31515
|
+
null,
|
|
31516
|
+
['PureCloud OAuth'],
|
|
31517
|
+
['application/json'],
|
|
31518
|
+
['application/json']
|
|
31519
|
+
);
|
|
31520
|
+
}
|
|
31521
|
+
|
|
31522
|
+
/**
|
|
31523
|
+
* Delete a variation for a document.
|
|
31524
|
+
*
|
|
31525
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
31526
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
31527
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
31528
|
+
*/
|
|
31529
|
+
deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId) {
|
|
31530
|
+
// verify the required parameter 'documentVariationId' is set
|
|
31531
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
31532
|
+
throw 'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
31533
|
+
}
|
|
31534
|
+
// verify the required parameter 'documentId' is set
|
|
31535
|
+
if (documentId === undefined || documentId === null) {
|
|
31536
|
+
throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
31537
|
+
}
|
|
31538
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31539
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31540
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';
|
|
31541
|
+
}
|
|
31542
|
+
|
|
31543
|
+
return this.apiClient.callApi(
|
|
31544
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
31545
|
+
'DELETE',
|
|
31546
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
31547
|
+
{ },
|
|
31548
|
+
{ },
|
|
31549
|
+
{ },
|
|
31550
|
+
null,
|
|
31551
|
+
['PureCloud OAuth'],
|
|
31552
|
+
['application/json'],
|
|
31553
|
+
['application/json']
|
|
31554
|
+
);
|
|
31555
|
+
}
|
|
31556
|
+
|
|
31557
|
+
/**
|
|
31558
|
+
* Delete export job
|
|
31559
|
+
*
|
|
31560
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31561
|
+
* @param {String} exportJobId Export job ID
|
|
31562
|
+
*/
|
|
31563
|
+
deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
31564
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31565
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31566
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
31567
|
+
}
|
|
31568
|
+
// verify the required parameter 'exportJobId' is set
|
|
31569
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
31570
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';
|
|
31571
|
+
}
|
|
31572
|
+
|
|
31573
|
+
return this.apiClient.callApi(
|
|
31574
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
31575
|
+
'DELETE',
|
|
31576
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
31577
|
+
{ },
|
|
31578
|
+
{ },
|
|
31579
|
+
{ },
|
|
31580
|
+
null,
|
|
31581
|
+
['PureCloud OAuth'],
|
|
31582
|
+
['application/json'],
|
|
31583
|
+
['application/json']
|
|
31584
|
+
);
|
|
31585
|
+
}
|
|
31586
|
+
|
|
31587
|
+
/**
|
|
31588
|
+
* Delete import job
|
|
31589
|
+
*
|
|
31590
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31591
|
+
* @param {String} importJobId Import job ID
|
|
31592
|
+
*/
|
|
31593
|
+
deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
31594
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31595
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31596
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
31597
|
+
}
|
|
31598
|
+
// verify the required parameter 'importJobId' is set
|
|
31599
|
+
if (importJobId === undefined || importJobId === null) {
|
|
31600
|
+
throw 'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';
|
|
31601
|
+
}
|
|
31602
|
+
|
|
31603
|
+
return this.apiClient.callApi(
|
|
31604
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
31605
|
+
'DELETE',
|
|
31606
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
31607
|
+
{ },
|
|
31608
|
+
{ },
|
|
31609
|
+
{ },
|
|
31610
|
+
null,
|
|
31611
|
+
['PureCloud OAuth'],
|
|
31612
|
+
['application/json'],
|
|
31613
|
+
['application/json']
|
|
31614
|
+
);
|
|
31615
|
+
}
|
|
31616
|
+
|
|
31617
|
+
/**
|
|
31618
|
+
* Delete label
|
|
31619
|
+
*
|
|
31620
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31621
|
+
* @param {String} labelId Label ID
|
|
31622
|
+
*/
|
|
31623
|
+
deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
31624
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31625
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31626
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
31627
|
+
}
|
|
31628
|
+
// verify the required parameter 'labelId' is set
|
|
31629
|
+
if (labelId === undefined || labelId === null) {
|
|
31630
|
+
throw 'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';
|
|
31631
|
+
}
|
|
31632
|
+
|
|
31633
|
+
return this.apiClient.callApi(
|
|
31634
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
31635
|
+
'DELETE',
|
|
31636
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
31637
|
+
{ },
|
|
31638
|
+
{ },
|
|
31639
|
+
{ },
|
|
31640
|
+
null,
|
|
31641
|
+
['PureCloud OAuth'],
|
|
31642
|
+
['application/json'],
|
|
31643
|
+
['application/json']
|
|
31644
|
+
);
|
|
31645
|
+
}
|
|
31646
|
+
|
|
31206
31647
|
/**
|
|
31207
31648
|
* Delete category
|
|
31208
31649
|
*
|
|
@@ -31308,6 +31749,104 @@ class KnowledgeApi {
|
|
|
31308
31749
|
);
|
|
31309
31750
|
}
|
|
31310
31751
|
|
|
31752
|
+
/**
|
|
31753
|
+
* Get categories
|
|
31754
|
+
*
|
|
31755
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
31756
|
+
* @param {Object} opts Optional parameters
|
|
31757
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31758
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31759
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31760
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
31761
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
31762
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
31763
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
31764
|
+
* @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.
|
|
31765
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
31766
|
+
*/
|
|
31767
|
+
getKnowledgeGuestSessionCategories(sessionId, opts) {
|
|
31768
|
+
opts = opts || {};
|
|
31769
|
+
|
|
31770
|
+
// verify the required parameter 'sessionId' is set
|
|
31771
|
+
if (sessionId === undefined || sessionId === null) {
|
|
31772
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';
|
|
31773
|
+
}
|
|
31774
|
+
|
|
31775
|
+
return this.apiClient.callApi(
|
|
31776
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/categories',
|
|
31777
|
+
'GET',
|
|
31778
|
+
{ 'sessionId': sessionId },
|
|
31779
|
+
{ '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'] },
|
|
31780
|
+
{ },
|
|
31781
|
+
{ },
|
|
31782
|
+
null,
|
|
31783
|
+
['PureCloud OAuth'],
|
|
31784
|
+
['application/json'],
|
|
31785
|
+
['application/json']
|
|
31786
|
+
);
|
|
31787
|
+
}
|
|
31788
|
+
|
|
31789
|
+
/**
|
|
31790
|
+
* Get a knowledge document by ID.
|
|
31791
|
+
*
|
|
31792
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
31793
|
+
* @param {String} documentId Document ID
|
|
31794
|
+
*/
|
|
31795
|
+
getKnowledgeGuestSessionDocument(sessionId, documentId) {
|
|
31796
|
+
// verify the required parameter 'sessionId' is set
|
|
31797
|
+
if (sessionId === undefined || sessionId === null) {
|
|
31798
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';
|
|
31799
|
+
}
|
|
31800
|
+
// verify the required parameter 'documentId' is set
|
|
31801
|
+
if (documentId === undefined || documentId === null) {
|
|
31802
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';
|
|
31803
|
+
}
|
|
31804
|
+
|
|
31805
|
+
return this.apiClient.callApi(
|
|
31806
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}',
|
|
31807
|
+
'GET',
|
|
31808
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
31809
|
+
{ },
|
|
31810
|
+
{ },
|
|
31811
|
+
{ },
|
|
31812
|
+
null,
|
|
31813
|
+
['PureCloud OAuth'],
|
|
31814
|
+
['application/json'],
|
|
31815
|
+
['application/json']
|
|
31816
|
+
);
|
|
31817
|
+
}
|
|
31818
|
+
|
|
31819
|
+
/**
|
|
31820
|
+
* Get documents.
|
|
31821
|
+
*
|
|
31822
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
31823
|
+
* @param {Object} opts Optional parameters
|
|
31824
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
31825
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
31826
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31827
|
+
*/
|
|
31828
|
+
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
31829
|
+
opts = opts || {};
|
|
31830
|
+
|
|
31831
|
+
// verify the required parameter 'sessionId' is set
|
|
31832
|
+
if (sessionId === undefined || sessionId === null) {
|
|
31833
|
+
throw 'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';
|
|
31834
|
+
}
|
|
31835
|
+
|
|
31836
|
+
return this.apiClient.callApi(
|
|
31837
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents',
|
|
31838
|
+
'GET',
|
|
31839
|
+
{ 'sessionId': sessionId },
|
|
31840
|
+
{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
|
|
31841
|
+
{ },
|
|
31842
|
+
{ },
|
|
31843
|
+
null,
|
|
31844
|
+
['PureCloud OAuth'],
|
|
31845
|
+
['application/json'],
|
|
31846
|
+
['application/json']
|
|
31847
|
+
);
|
|
31848
|
+
}
|
|
31849
|
+
|
|
31311
31850
|
/**
|
|
31312
31851
|
* Get knowledge base
|
|
31313
31852
|
*
|
|
@@ -31333,6 +31872,502 @@ class KnowledgeApi {
|
|
|
31333
31872
|
);
|
|
31334
31873
|
}
|
|
31335
31874
|
|
|
31875
|
+
/**
|
|
31876
|
+
* Get categories
|
|
31877
|
+
*
|
|
31878
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31879
|
+
* @param {Object} opts Optional parameters
|
|
31880
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31881
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31882
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31883
|
+
* @param {String} opts.parentId If specified, retrieves the children categories by parent category ID.
|
|
31884
|
+
* @param {Boolean} opts.isRoot If specified, retrieves only the root categories.
|
|
31885
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
31886
|
+
* @param {Object} opts.sortBy Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (default to Name)
|
|
31887
|
+
* @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.
|
|
31888
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to category.
|
|
31889
|
+
*/
|
|
31890
|
+
getKnowledgeKnowledgebaseCategories(knowledgeBaseId, opts) {
|
|
31891
|
+
opts = opts || {};
|
|
31892
|
+
|
|
31893
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31894
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31895
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';
|
|
31896
|
+
}
|
|
31897
|
+
|
|
31898
|
+
return this.apiClient.callApi(
|
|
31899
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
31900
|
+
'GET',
|
|
31901
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
31902
|
+
{ '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'] },
|
|
31903
|
+
{ },
|
|
31904
|
+
{ },
|
|
31905
|
+
null,
|
|
31906
|
+
['PureCloud OAuth'],
|
|
31907
|
+
['application/json'],
|
|
31908
|
+
['application/json']
|
|
31909
|
+
);
|
|
31910
|
+
}
|
|
31911
|
+
|
|
31912
|
+
/**
|
|
31913
|
+
* Get category
|
|
31914
|
+
*
|
|
31915
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
31916
|
+
* @param {String} categoryId Category ID
|
|
31917
|
+
*/
|
|
31918
|
+
getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId) {
|
|
31919
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31920
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31921
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';
|
|
31922
|
+
}
|
|
31923
|
+
// verify the required parameter 'categoryId' is set
|
|
31924
|
+
if (categoryId === undefined || categoryId === null) {
|
|
31925
|
+
throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';
|
|
31926
|
+
}
|
|
31927
|
+
|
|
31928
|
+
return this.apiClient.callApi(
|
|
31929
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
31930
|
+
'GET',
|
|
31931
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
31932
|
+
{ },
|
|
31933
|
+
{ },
|
|
31934
|
+
{ },
|
|
31935
|
+
null,
|
|
31936
|
+
['PureCloud OAuth'],
|
|
31937
|
+
['application/json'],
|
|
31938
|
+
['application/json']
|
|
31939
|
+
);
|
|
31940
|
+
}
|
|
31941
|
+
|
|
31942
|
+
/**
|
|
31943
|
+
* Get document.
|
|
31944
|
+
*
|
|
31945
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31946
|
+
* @param {String} documentId Document ID.
|
|
31947
|
+
* @param {Object} opts Optional parameters
|
|
31948
|
+
* @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.
|
|
31949
|
+
* @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.
|
|
31950
|
+
*/
|
|
31951
|
+
getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, opts) {
|
|
31952
|
+
opts = opts || {};
|
|
31953
|
+
|
|
31954
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31955
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31956
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';
|
|
31957
|
+
}
|
|
31958
|
+
// verify the required parameter 'documentId' is set
|
|
31959
|
+
if (documentId === undefined || documentId === null) {
|
|
31960
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';
|
|
31961
|
+
}
|
|
31962
|
+
|
|
31963
|
+
return this.apiClient.callApi(
|
|
31964
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
31965
|
+
'GET',
|
|
31966
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31967
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'state': opts['state'] },
|
|
31968
|
+
{ },
|
|
31969
|
+
{ },
|
|
31970
|
+
null,
|
|
31971
|
+
['PureCloud OAuth'],
|
|
31972
|
+
['application/json'],
|
|
31973
|
+
['application/json']
|
|
31974
|
+
);
|
|
31975
|
+
}
|
|
31976
|
+
|
|
31977
|
+
/**
|
|
31978
|
+
* Get a variation for a document.
|
|
31979
|
+
*
|
|
31980
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
31981
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
31982
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
31983
|
+
* @param {Object} opts Optional parameters
|
|
31984
|
+
* @param {Object} opts.documentState The state of the document.
|
|
31985
|
+
*/
|
|
31986
|
+
getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, opts) {
|
|
31987
|
+
opts = opts || {};
|
|
31988
|
+
|
|
31989
|
+
// verify the required parameter 'documentVariationId' is set
|
|
31990
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
31991
|
+
throw 'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
31992
|
+
}
|
|
31993
|
+
// verify the required parameter 'documentId' is set
|
|
31994
|
+
if (documentId === undefined || documentId === null) {
|
|
31995
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
31996
|
+
}
|
|
31997
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31998
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31999
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';
|
|
32000
|
+
}
|
|
32001
|
+
|
|
32002
|
+
return this.apiClient.callApi(
|
|
32003
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
32004
|
+
'GET',
|
|
32005
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
32006
|
+
{ 'documentState': opts['documentState'] },
|
|
32007
|
+
{ },
|
|
32008
|
+
{ },
|
|
32009
|
+
null,
|
|
32010
|
+
['PureCloud OAuth'],
|
|
32011
|
+
['application/json'],
|
|
32012
|
+
['application/json']
|
|
32013
|
+
);
|
|
32014
|
+
}
|
|
32015
|
+
|
|
32016
|
+
/**
|
|
32017
|
+
* Get variations for a document.
|
|
32018
|
+
*
|
|
32019
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32020
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32021
|
+
* @param {Object} opts Optional parameters
|
|
32022
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32023
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32024
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32025
|
+
* @param {Object} opts.documentState The state of the document.
|
|
32026
|
+
*/
|
|
32027
|
+
getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, opts) {
|
|
32028
|
+
opts = opts || {};
|
|
32029
|
+
|
|
32030
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32031
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32032
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
32033
|
+
}
|
|
32034
|
+
// verify the required parameter 'documentId' is set
|
|
32035
|
+
if (documentId === undefined || documentId === null) {
|
|
32036
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';
|
|
32037
|
+
}
|
|
32038
|
+
|
|
32039
|
+
return this.apiClient.callApi(
|
|
32040
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
32041
|
+
'GET',
|
|
32042
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32043
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'documentState': opts['documentState'] },
|
|
32044
|
+
{ },
|
|
32045
|
+
{ },
|
|
32046
|
+
null,
|
|
32047
|
+
['PureCloud OAuth'],
|
|
32048
|
+
['application/json'],
|
|
32049
|
+
['application/json']
|
|
32050
|
+
);
|
|
32051
|
+
}
|
|
32052
|
+
|
|
32053
|
+
/**
|
|
32054
|
+
* Get document version.
|
|
32055
|
+
*
|
|
32056
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32057
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32058
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
32059
|
+
* @param {Object} opts Optional parameters
|
|
32060
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
32061
|
+
*/
|
|
32062
|
+
getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, opts) {
|
|
32063
|
+
opts = opts || {};
|
|
32064
|
+
|
|
32065
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32066
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32067
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
32068
|
+
}
|
|
32069
|
+
// verify the required parameter 'documentId' is set
|
|
32070
|
+
if (documentId === undefined || documentId === null) {
|
|
32071
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
32072
|
+
}
|
|
32073
|
+
// verify the required parameter 'versionId' is set
|
|
32074
|
+
if (versionId === undefined || versionId === null) {
|
|
32075
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';
|
|
32076
|
+
}
|
|
32077
|
+
|
|
32078
|
+
return this.apiClient.callApi(
|
|
32079
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}',
|
|
32080
|
+
'GET',
|
|
32081
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
32082
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
32083
|
+
{ },
|
|
32084
|
+
{ },
|
|
32085
|
+
null,
|
|
32086
|
+
['PureCloud OAuth'],
|
|
32087
|
+
['application/json'],
|
|
32088
|
+
['application/json']
|
|
32089
|
+
);
|
|
32090
|
+
}
|
|
32091
|
+
|
|
32092
|
+
/**
|
|
32093
|
+
* Get variation for the given document version.
|
|
32094
|
+
*
|
|
32095
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32096
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32097
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
32098
|
+
* @param {String} variationId Globally unique identifier for the document version variation.
|
|
32099
|
+
*/
|
|
32100
|
+
getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId) {
|
|
32101
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32102
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32103
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32104
|
+
}
|
|
32105
|
+
// verify the required parameter 'documentId' is set
|
|
32106
|
+
if (documentId === undefined || documentId === null) {
|
|
32107
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32108
|
+
}
|
|
32109
|
+
// verify the required parameter 'versionId' is set
|
|
32110
|
+
if (versionId === undefined || versionId === null) {
|
|
32111
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32112
|
+
}
|
|
32113
|
+
// verify the required parameter 'variationId' is set
|
|
32114
|
+
if (variationId === undefined || variationId === null) {
|
|
32115
|
+
throw 'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';
|
|
32116
|
+
}
|
|
32117
|
+
|
|
32118
|
+
return this.apiClient.callApi(
|
|
32119
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}',
|
|
32120
|
+
'GET',
|
|
32121
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId,'variationId': variationId },
|
|
32122
|
+
{ },
|
|
32123
|
+
{ },
|
|
32124
|
+
{ },
|
|
32125
|
+
null,
|
|
32126
|
+
['PureCloud OAuth'],
|
|
32127
|
+
['application/json'],
|
|
32128
|
+
['application/json']
|
|
32129
|
+
);
|
|
32130
|
+
}
|
|
32131
|
+
|
|
32132
|
+
/**
|
|
32133
|
+
* Get variations for the given document version.
|
|
32134
|
+
*
|
|
32135
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32136
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32137
|
+
* @param {String} versionId Globally unique identifier for the document version.
|
|
32138
|
+
* @param {Object} opts Optional parameters
|
|
32139
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32140
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32141
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32142
|
+
*/
|
|
32143
|
+
getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, opts) {
|
|
32144
|
+
opts = opts || {};
|
|
32145
|
+
|
|
32146
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32147
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32148
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
32149
|
+
}
|
|
32150
|
+
// verify the required parameter 'documentId' is set
|
|
32151
|
+
if (documentId === undefined || documentId === null) {
|
|
32152
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
32153
|
+
}
|
|
32154
|
+
// verify the required parameter 'versionId' is set
|
|
32155
|
+
if (versionId === undefined || versionId === null) {
|
|
32156
|
+
throw 'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';
|
|
32157
|
+
}
|
|
32158
|
+
|
|
32159
|
+
return this.apiClient.callApi(
|
|
32160
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations',
|
|
32161
|
+
'GET',
|
|
32162
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'versionId': versionId },
|
|
32163
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
32164
|
+
{ },
|
|
32165
|
+
{ },
|
|
32166
|
+
null,
|
|
32167
|
+
['PureCloud OAuth'],
|
|
32168
|
+
['application/json'],
|
|
32169
|
+
['application/json']
|
|
32170
|
+
);
|
|
32171
|
+
}
|
|
32172
|
+
|
|
32173
|
+
/**
|
|
32174
|
+
* Get document versions.
|
|
32175
|
+
*
|
|
32176
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
32177
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
32178
|
+
* @param {Object} opts Optional parameters
|
|
32179
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32180
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32181
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32182
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
32183
|
+
*/
|
|
32184
|
+
getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, opts) {
|
|
32185
|
+
opts = opts || {};
|
|
32186
|
+
|
|
32187
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32188
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32189
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
32190
|
+
}
|
|
32191
|
+
// verify the required parameter 'documentId' is set
|
|
32192
|
+
if (documentId === undefined || documentId === null) {
|
|
32193
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';
|
|
32194
|
+
}
|
|
32195
|
+
|
|
32196
|
+
return this.apiClient.callApi(
|
|
32197
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
32198
|
+
'GET',
|
|
32199
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32200
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
32201
|
+
{ },
|
|
32202
|
+
{ },
|
|
32203
|
+
null,
|
|
32204
|
+
['PureCloud OAuth'],
|
|
32205
|
+
['application/json'],
|
|
32206
|
+
['application/json']
|
|
32207
|
+
);
|
|
32208
|
+
}
|
|
32209
|
+
|
|
32210
|
+
/**
|
|
32211
|
+
* Get documents.
|
|
32212
|
+
*
|
|
32213
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32214
|
+
* @param {Object} opts Optional parameters
|
|
32215
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32216
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32217
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32218
|
+
* @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
|
|
32219
|
+
* @param {Array.<String>} opts.documentId Retrieves the specified documents, comma separated values expected.
|
|
32220
|
+
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
32221
|
+
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
32222
|
+
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
32223
|
+
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
32224
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
32225
|
+
*/
|
|
32226
|
+
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
32227
|
+
opts = opts || {};
|
|
32228
|
+
|
|
32229
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32230
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32231
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';
|
|
32232
|
+
}
|
|
32233
|
+
|
|
32234
|
+
return this.apiClient.callApi(
|
|
32235
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
32236
|
+
'GET',
|
|
32237
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32238
|
+
{ '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') },
|
|
32239
|
+
{ },
|
|
32240
|
+
{ },
|
|
32241
|
+
null,
|
|
32242
|
+
['PureCloud OAuth'],
|
|
32243
|
+
['application/json'],
|
|
32244
|
+
['application/json']
|
|
32245
|
+
);
|
|
32246
|
+
}
|
|
32247
|
+
|
|
32248
|
+
/**
|
|
32249
|
+
* Get export job report
|
|
32250
|
+
*
|
|
32251
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32252
|
+
* @param {String} exportJobId Export job ID
|
|
32253
|
+
*/
|
|
32254
|
+
getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId) {
|
|
32255
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32256
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32257
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
32258
|
+
}
|
|
32259
|
+
// verify the required parameter 'exportJobId' is set
|
|
32260
|
+
if (exportJobId === undefined || exportJobId === null) {
|
|
32261
|
+
throw 'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';
|
|
32262
|
+
}
|
|
32263
|
+
|
|
32264
|
+
return this.apiClient.callApi(
|
|
32265
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}',
|
|
32266
|
+
'GET',
|
|
32267
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'exportJobId': exportJobId },
|
|
32268
|
+
{ },
|
|
32269
|
+
{ },
|
|
32270
|
+
{ },
|
|
32271
|
+
null,
|
|
32272
|
+
['PureCloud OAuth'],
|
|
32273
|
+
['application/json'],
|
|
32274
|
+
['application/json']
|
|
32275
|
+
);
|
|
32276
|
+
}
|
|
32277
|
+
|
|
32278
|
+
/**
|
|
32279
|
+
* Get import job report
|
|
32280
|
+
*
|
|
32281
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32282
|
+
* @param {String} importJobId Import job ID
|
|
32283
|
+
*/
|
|
32284
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
32285
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32286
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32287
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
32288
|
+
}
|
|
32289
|
+
// verify the required parameter 'importJobId' is set
|
|
32290
|
+
if (importJobId === undefined || importJobId === null) {
|
|
32291
|
+
throw 'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
32292
|
+
}
|
|
32293
|
+
|
|
32294
|
+
return this.apiClient.callApi(
|
|
32295
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
32296
|
+
'GET',
|
|
32297
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
32298
|
+
{ },
|
|
32299
|
+
{ },
|
|
32300
|
+
{ },
|
|
32301
|
+
null,
|
|
32302
|
+
['PureCloud OAuth'],
|
|
32303
|
+
['application/json'],
|
|
32304
|
+
['application/json']
|
|
32305
|
+
);
|
|
32306
|
+
}
|
|
32307
|
+
|
|
32308
|
+
/**
|
|
32309
|
+
* Get label
|
|
32310
|
+
*
|
|
32311
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32312
|
+
* @param {String} labelId Label ID
|
|
32313
|
+
*/
|
|
32314
|
+
getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId) {
|
|
32315
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32316
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32317
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';
|
|
32318
|
+
}
|
|
32319
|
+
// verify the required parameter 'labelId' is set
|
|
32320
|
+
if (labelId === undefined || labelId === null) {
|
|
32321
|
+
throw 'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';
|
|
32322
|
+
}
|
|
32323
|
+
|
|
32324
|
+
return this.apiClient.callApi(
|
|
32325
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
32326
|
+
'GET',
|
|
32327
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
32328
|
+
{ },
|
|
32329
|
+
{ },
|
|
32330
|
+
{ },
|
|
32331
|
+
null,
|
|
32332
|
+
['PureCloud OAuth'],
|
|
32333
|
+
['application/json'],
|
|
32334
|
+
['application/json']
|
|
32335
|
+
);
|
|
32336
|
+
}
|
|
32337
|
+
|
|
32338
|
+
/**
|
|
32339
|
+
* Get labels
|
|
32340
|
+
*
|
|
32341
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32342
|
+
* @param {Object} opts Optional parameters
|
|
32343
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
32344
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
32345
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
32346
|
+
* @param {String} opts.name Filter to return the labels that contains the given phrase in the name.
|
|
32347
|
+
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
32348
|
+
*/
|
|
32349
|
+
getKnowledgeKnowledgebaseLabels(knowledgeBaseId, opts) {
|
|
32350
|
+
opts = opts || {};
|
|
32351
|
+
|
|
32352
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32353
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32354
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';
|
|
32355
|
+
}
|
|
32356
|
+
|
|
32357
|
+
return this.apiClient.callApi(
|
|
32358
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
32359
|
+
'GET',
|
|
32360
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32361
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'includeDocumentCount': opts['includeDocumentCount'] },
|
|
32362
|
+
{ },
|
|
32363
|
+
{ },
|
|
32364
|
+
null,
|
|
32365
|
+
['PureCloud OAuth'],
|
|
32366
|
+
['application/json'],
|
|
32367
|
+
['application/json']
|
|
32368
|
+
);
|
|
32369
|
+
}
|
|
32370
|
+
|
|
31336
32371
|
/**
|
|
31337
32372
|
* Get categories
|
|
31338
32373
|
*
|
|
@@ -31591,6 +32626,108 @@ class KnowledgeApi {
|
|
|
31591
32626
|
);
|
|
31592
32627
|
}
|
|
31593
32628
|
|
|
32629
|
+
/**
|
|
32630
|
+
* Get knowledge base unanswered group for a particular groupId
|
|
32631
|
+
*
|
|
32632
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32633
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
32634
|
+
* @param {Object} opts Optional parameters
|
|
32635
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
32636
|
+
*/
|
|
32637
|
+
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
32638
|
+
opts = opts || {};
|
|
32639
|
+
|
|
32640
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32641
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32642
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
32643
|
+
}
|
|
32644
|
+
// verify the required parameter 'groupId' is set
|
|
32645
|
+
if (groupId === undefined || groupId === null) {
|
|
32646
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';
|
|
32647
|
+
}
|
|
32648
|
+
|
|
32649
|
+
return this.apiClient.callApi(
|
|
32650
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
32651
|
+
'GET',
|
|
32652
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
32653
|
+
{ 'app': opts['app'] },
|
|
32654
|
+
{ },
|
|
32655
|
+
{ },
|
|
32656
|
+
null,
|
|
32657
|
+
['PureCloud OAuth'],
|
|
32658
|
+
['application/json'],
|
|
32659
|
+
['application/json']
|
|
32660
|
+
);
|
|
32661
|
+
}
|
|
32662
|
+
|
|
32663
|
+
/**
|
|
32664
|
+
* Get knowledge base unanswered phrase group for a particular phraseGroupId
|
|
32665
|
+
*
|
|
32666
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32667
|
+
* @param {String} groupId The ID of the group to be retrieved.
|
|
32668
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
32669
|
+
* @param {Object} opts Optional parameters
|
|
32670
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
32671
|
+
*/
|
|
32672
|
+
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
32673
|
+
opts = opts || {};
|
|
32674
|
+
|
|
32675
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32676
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32677
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
32678
|
+
}
|
|
32679
|
+
// verify the required parameter 'groupId' is set
|
|
32680
|
+
if (groupId === undefined || groupId === null) {
|
|
32681
|
+
throw 'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
32682
|
+
}
|
|
32683
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
32684
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
32685
|
+
throw 'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
32686
|
+
}
|
|
32687
|
+
|
|
32688
|
+
return this.apiClient.callApi(
|
|
32689
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
32690
|
+
'GET',
|
|
32691
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
32692
|
+
{ 'app': opts['app'] },
|
|
32693
|
+
{ },
|
|
32694
|
+
{ },
|
|
32695
|
+
null,
|
|
32696
|
+
['PureCloud OAuth'],
|
|
32697
|
+
['application/json'],
|
|
32698
|
+
['application/json']
|
|
32699
|
+
);
|
|
32700
|
+
}
|
|
32701
|
+
|
|
32702
|
+
/**
|
|
32703
|
+
* Get knowledge base unanswered groups
|
|
32704
|
+
*
|
|
32705
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32706
|
+
* @param {Object} opts Optional parameters
|
|
32707
|
+
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
32708
|
+
*/
|
|
32709
|
+
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
32710
|
+
opts = opts || {};
|
|
32711
|
+
|
|
32712
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32713
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32714
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';
|
|
32715
|
+
}
|
|
32716
|
+
|
|
32717
|
+
return this.apiClient.callApi(
|
|
32718
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
32719
|
+
'GET',
|
|
32720
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
32721
|
+
{ 'app': opts['app'] },
|
|
32722
|
+
{ },
|
|
32723
|
+
{ },
|
|
32724
|
+
null,
|
|
32725
|
+
['PureCloud OAuth'],
|
|
32726
|
+
['application/json'],
|
|
32727
|
+
['application/json']
|
|
32728
|
+
);
|
|
32729
|
+
}
|
|
32730
|
+
|
|
31594
32731
|
/**
|
|
31595
32732
|
* Get knowledge bases
|
|
31596
32733
|
*
|
|
@@ -31623,6 +32760,41 @@ class KnowledgeApi {
|
|
|
31623
32760
|
);
|
|
31624
32761
|
}
|
|
31625
32762
|
|
|
32763
|
+
/**
|
|
32764
|
+
* Update search result.
|
|
32765
|
+
*
|
|
32766
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
32767
|
+
* @param {String} searchId Search Result ID
|
|
32768
|
+
* @param {Object} body
|
|
32769
|
+
*/
|
|
32770
|
+
patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body) {
|
|
32771
|
+
// verify the required parameter 'sessionId' is set
|
|
32772
|
+
if (sessionId === undefined || sessionId === null) {
|
|
32773
|
+
throw 'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
32774
|
+
}
|
|
32775
|
+
// verify the required parameter 'searchId' is set
|
|
32776
|
+
if (searchId === undefined || searchId === null) {
|
|
32777
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
32778
|
+
}
|
|
32779
|
+
// verify the required parameter 'body' is set
|
|
32780
|
+
if (body === undefined || body === null) {
|
|
32781
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';
|
|
32782
|
+
}
|
|
32783
|
+
|
|
32784
|
+
return this.apiClient.callApi(
|
|
32785
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}',
|
|
32786
|
+
'PATCH',
|
|
32787
|
+
{ 'sessionId': sessionId,'searchId': searchId },
|
|
32788
|
+
{ },
|
|
32789
|
+
{ },
|
|
32790
|
+
{ },
|
|
32791
|
+
body,
|
|
32792
|
+
['PureCloud OAuth'],
|
|
32793
|
+
['application/json'],
|
|
32794
|
+
['application/json']
|
|
32795
|
+
);
|
|
32796
|
+
}
|
|
32797
|
+
|
|
31626
32798
|
/**
|
|
31627
32799
|
* Update knowledge base
|
|
31628
32800
|
*
|
|
@@ -31653,6 +32825,220 @@ class KnowledgeApi {
|
|
|
31653
32825
|
);
|
|
31654
32826
|
}
|
|
31655
32827
|
|
|
32828
|
+
/**
|
|
32829
|
+
* Update category
|
|
32830
|
+
*
|
|
32831
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32832
|
+
* @param {String} categoryId Category ID
|
|
32833
|
+
* @param {Object} body
|
|
32834
|
+
*/
|
|
32835
|
+
patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body) {
|
|
32836
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32837
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32838
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
32839
|
+
}
|
|
32840
|
+
// verify the required parameter 'categoryId' is set
|
|
32841
|
+
if (categoryId === undefined || categoryId === null) {
|
|
32842
|
+
throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';
|
|
32843
|
+
}
|
|
32844
|
+
// verify the required parameter 'body' is set
|
|
32845
|
+
if (body === undefined || body === null) {
|
|
32846
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';
|
|
32847
|
+
}
|
|
32848
|
+
|
|
32849
|
+
return this.apiClient.callApi(
|
|
32850
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}',
|
|
32851
|
+
'PATCH',
|
|
32852
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'categoryId': categoryId },
|
|
32853
|
+
{ },
|
|
32854
|
+
{ },
|
|
32855
|
+
{ },
|
|
32856
|
+
body,
|
|
32857
|
+
['PureCloud OAuth'],
|
|
32858
|
+
['application/json'],
|
|
32859
|
+
['application/json']
|
|
32860
|
+
);
|
|
32861
|
+
}
|
|
32862
|
+
|
|
32863
|
+
/**
|
|
32864
|
+
* Update document.
|
|
32865
|
+
*
|
|
32866
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
32867
|
+
* @param {String} documentId Document ID.
|
|
32868
|
+
* @param {Object} body
|
|
32869
|
+
*/
|
|
32870
|
+
patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body) {
|
|
32871
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32872
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32873
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
32874
|
+
}
|
|
32875
|
+
// verify the required parameter 'documentId' is set
|
|
32876
|
+
if (documentId === undefined || documentId === null) {
|
|
32877
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';
|
|
32878
|
+
}
|
|
32879
|
+
// verify the required parameter 'body' is set
|
|
32880
|
+
if (body === undefined || body === null) {
|
|
32881
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';
|
|
32882
|
+
}
|
|
32883
|
+
|
|
32884
|
+
return this.apiClient.callApi(
|
|
32885
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}',
|
|
32886
|
+
'PATCH',
|
|
32887
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32888
|
+
{ },
|
|
32889
|
+
{ },
|
|
32890
|
+
{ },
|
|
32891
|
+
body,
|
|
32892
|
+
['PureCloud OAuth'],
|
|
32893
|
+
['application/json'],
|
|
32894
|
+
['application/json']
|
|
32895
|
+
);
|
|
32896
|
+
}
|
|
32897
|
+
|
|
32898
|
+
/**
|
|
32899
|
+
* Update a variation for a document.
|
|
32900
|
+
*
|
|
32901
|
+
* @param {String} documentVariationId Globally unique identifier for a document variation.
|
|
32902
|
+
* @param {String} documentId Globally unique identifier for a document.
|
|
32903
|
+
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
32904
|
+
* @param {Object} body
|
|
32905
|
+
*/
|
|
32906
|
+
patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
|
|
32907
|
+
// verify the required parameter 'documentVariationId' is set
|
|
32908
|
+
if (documentVariationId === undefined || documentVariationId === null) {
|
|
32909
|
+
throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32910
|
+
}
|
|
32911
|
+
// verify the required parameter 'documentId' is set
|
|
32912
|
+
if (documentId === undefined || documentId === null) {
|
|
32913
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32914
|
+
}
|
|
32915
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32916
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32917
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32918
|
+
}
|
|
32919
|
+
// verify the required parameter 'body' is set
|
|
32920
|
+
if (body === undefined || body === null) {
|
|
32921
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
|
|
32922
|
+
}
|
|
32923
|
+
|
|
32924
|
+
return this.apiClient.callApi(
|
|
32925
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
|
|
32926
|
+
'PATCH',
|
|
32927
|
+
{ 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
|
|
32928
|
+
{ },
|
|
32929
|
+
{ },
|
|
32930
|
+
{ },
|
|
32931
|
+
body,
|
|
32932
|
+
['PureCloud OAuth'],
|
|
32933
|
+
['application/json'],
|
|
32934
|
+
['application/json']
|
|
32935
|
+
);
|
|
32936
|
+
}
|
|
32937
|
+
|
|
32938
|
+
/**
|
|
32939
|
+
* Update search result.
|
|
32940
|
+
*
|
|
32941
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
32942
|
+
* @param {String} searchId Search Result ID
|
|
32943
|
+
* @param {Object} opts Optional parameters
|
|
32944
|
+
* @param {Object} opts.body
|
|
32945
|
+
*/
|
|
32946
|
+
patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
|
|
32947
|
+
opts = opts || {};
|
|
32948
|
+
|
|
32949
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32950
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32951
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
32952
|
+
}
|
|
32953
|
+
// verify the required parameter 'searchId' is set
|
|
32954
|
+
if (searchId === undefined || searchId === null) {
|
|
32955
|
+
throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
|
|
32956
|
+
}
|
|
32957
|
+
|
|
32958
|
+
return this.apiClient.callApi(
|
|
32959
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
|
|
32960
|
+
'PATCH',
|
|
32961
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
|
|
32962
|
+
{ },
|
|
32963
|
+
{ },
|
|
32964
|
+
{ },
|
|
32965
|
+
opts['body'],
|
|
32966
|
+
['PureCloud OAuth'],
|
|
32967
|
+
['application/json'],
|
|
32968
|
+
['application/json']
|
|
32969
|
+
);
|
|
32970
|
+
}
|
|
32971
|
+
|
|
32972
|
+
/**
|
|
32973
|
+
* Start import job
|
|
32974
|
+
*
|
|
32975
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
32976
|
+
* @param {String} importJobId Import job ID
|
|
32977
|
+
* @param {Object} body
|
|
32978
|
+
*/
|
|
32979
|
+
patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
|
|
32980
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32981
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32982
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
32983
|
+
}
|
|
32984
|
+
// verify the required parameter 'importJobId' is set
|
|
32985
|
+
if (importJobId === undefined || importJobId === null) {
|
|
32986
|
+
throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
32987
|
+
}
|
|
32988
|
+
// verify the required parameter 'body' is set
|
|
32989
|
+
if (body === undefined || body === null) {
|
|
32990
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
|
|
32991
|
+
}
|
|
32992
|
+
|
|
32993
|
+
return this.apiClient.callApi(
|
|
32994
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
32995
|
+
'PATCH',
|
|
32996
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
32997
|
+
{ },
|
|
32998
|
+
{ },
|
|
32999
|
+
{ },
|
|
33000
|
+
body,
|
|
33001
|
+
['PureCloud OAuth'],
|
|
33002
|
+
['application/json'],
|
|
33003
|
+
['application/json']
|
|
33004
|
+
);
|
|
33005
|
+
}
|
|
33006
|
+
|
|
33007
|
+
/**
|
|
33008
|
+
* Update label
|
|
33009
|
+
*
|
|
33010
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33011
|
+
* @param {String} labelId Label ID
|
|
33012
|
+
* @param {Object} body
|
|
33013
|
+
*/
|
|
33014
|
+
patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
|
|
33015
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33016
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33017
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
33018
|
+
}
|
|
33019
|
+
// verify the required parameter 'labelId' is set
|
|
33020
|
+
if (labelId === undefined || labelId === null) {
|
|
33021
|
+
throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
|
|
33022
|
+
}
|
|
33023
|
+
// verify the required parameter 'body' is set
|
|
33024
|
+
if (body === undefined || body === null) {
|
|
33025
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
|
|
33026
|
+
}
|
|
33027
|
+
|
|
33028
|
+
return this.apiClient.callApi(
|
|
33029
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
|
|
33030
|
+
'PATCH',
|
|
33031
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
|
|
33032
|
+
{ },
|
|
33033
|
+
{ },
|
|
33034
|
+
{ },
|
|
33035
|
+
body,
|
|
33036
|
+
['PureCloud OAuth'],
|
|
33037
|
+
['application/json'],
|
|
33038
|
+
['application/json']
|
|
33039
|
+
);
|
|
33040
|
+
}
|
|
33041
|
+
|
|
31656
33042
|
/**
|
|
31657
33043
|
* Update category
|
|
31658
33044
|
*
|
|
@@ -31808,6 +33194,46 @@ class KnowledgeApi {
|
|
|
31808
33194
|
);
|
|
31809
33195
|
}
|
|
31810
33196
|
|
|
33197
|
+
/**
|
|
33198
|
+
* Update a Knowledge base unanswered phrase group
|
|
33199
|
+
*
|
|
33200
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33201
|
+
* @param {String} groupId The ID of the group to be updated.
|
|
33202
|
+
* @param {String} phraseGroupId The ID of the phraseGroup to be updated.
|
|
33203
|
+
* @param {Object} body Request body of the update unanswered group endpoint.
|
|
33204
|
+
*/
|
|
33205
|
+
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body) {
|
|
33206
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33207
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33208
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33209
|
+
}
|
|
33210
|
+
// verify the required parameter 'groupId' is set
|
|
33211
|
+
if (groupId === undefined || groupId === null) {
|
|
33212
|
+
throw 'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33213
|
+
}
|
|
33214
|
+
// verify the required parameter 'phraseGroupId' is set
|
|
33215
|
+
if (phraseGroupId === undefined || phraseGroupId === null) {
|
|
33216
|
+
throw 'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33217
|
+
}
|
|
33218
|
+
// verify the required parameter 'body' is set
|
|
33219
|
+
if (body === undefined || body === null) {
|
|
33220
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';
|
|
33221
|
+
}
|
|
33222
|
+
|
|
33223
|
+
return this.apiClient.callApi(
|
|
33224
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
33225
|
+
'PATCH',
|
|
33226
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
33227
|
+
{ },
|
|
33228
|
+
{ },
|
|
33229
|
+
{ },
|
|
33230
|
+
body,
|
|
33231
|
+
['PureCloud OAuth'],
|
|
33232
|
+
['application/json'],
|
|
33233
|
+
['application/json']
|
|
33234
|
+
);
|
|
33235
|
+
}
|
|
33236
|
+
|
|
31811
33237
|
/**
|
|
31812
33238
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
31813
33239
|
*
|
|
@@ -31833,6 +33259,369 @@ class KnowledgeApi {
|
|
|
31833
33259
|
);
|
|
31834
33260
|
}
|
|
31835
33261
|
|
|
33262
|
+
/**
|
|
33263
|
+
* Search the documents in a guest session.
|
|
33264
|
+
*
|
|
33265
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
33266
|
+
* @param {Object} opts Optional parameters
|
|
33267
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
33268
|
+
* @param {Object} opts.body
|
|
33269
|
+
*/
|
|
33270
|
+
postKnowledgeGuestSessionDocumentsSearch(sessionId, opts) {
|
|
33271
|
+
opts = opts || {};
|
|
33272
|
+
|
|
33273
|
+
// verify the required parameter 'sessionId' is set
|
|
33274
|
+
if (sessionId === undefined || sessionId === null) {
|
|
33275
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';
|
|
33276
|
+
}
|
|
33277
|
+
|
|
33278
|
+
return this.apiClient.callApi(
|
|
33279
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search',
|
|
33280
|
+
'POST',
|
|
33281
|
+
{ 'sessionId': sessionId },
|
|
33282
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33283
|
+
{ },
|
|
33284
|
+
{ },
|
|
33285
|
+
opts['body'],
|
|
33286
|
+
['PureCloud OAuth'],
|
|
33287
|
+
['application/json'],
|
|
33288
|
+
['application/json']
|
|
33289
|
+
);
|
|
33290
|
+
}
|
|
33291
|
+
|
|
33292
|
+
/**
|
|
33293
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
33294
|
+
*
|
|
33295
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
33296
|
+
* @param {Object} opts Optional parameters
|
|
33297
|
+
* @param {Object} opts.body
|
|
33298
|
+
*/
|
|
33299
|
+
postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, opts) {
|
|
33300
|
+
opts = opts || {};
|
|
33301
|
+
|
|
33302
|
+
// verify the required parameter 'sessionId' is set
|
|
33303
|
+
if (sessionId === undefined || sessionId === null) {
|
|
33304
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';
|
|
33305
|
+
}
|
|
33306
|
+
|
|
33307
|
+
return this.apiClient.callApi(
|
|
33308
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions',
|
|
33309
|
+
'POST',
|
|
33310
|
+
{ 'sessionId': sessionId },
|
|
33311
|
+
{ },
|
|
33312
|
+
{ },
|
|
33313
|
+
{ },
|
|
33314
|
+
opts['body'],
|
|
33315
|
+
['PureCloud OAuth'],
|
|
33316
|
+
['application/json'],
|
|
33317
|
+
['application/json']
|
|
33318
|
+
);
|
|
33319
|
+
}
|
|
33320
|
+
|
|
33321
|
+
/**
|
|
33322
|
+
* Create guest session
|
|
33323
|
+
*
|
|
33324
|
+
* @param {Object} body
|
|
33325
|
+
*/
|
|
33326
|
+
postKnowledgeGuestSessions(body) {
|
|
33327
|
+
// verify the required parameter 'body' is set
|
|
33328
|
+
if (body === undefined || body === null) {
|
|
33329
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessions';
|
|
33330
|
+
}
|
|
33331
|
+
|
|
33332
|
+
return this.apiClient.callApi(
|
|
33333
|
+
'/api/v2/knowledge/guest/sessions',
|
|
33334
|
+
'POST',
|
|
33335
|
+
{ },
|
|
33336
|
+
{ },
|
|
33337
|
+
{ },
|
|
33338
|
+
{ },
|
|
33339
|
+
body,
|
|
33340
|
+
['PureCloud OAuth'],
|
|
33341
|
+
['application/json'],
|
|
33342
|
+
['application/json']
|
|
33343
|
+
);
|
|
33344
|
+
}
|
|
33345
|
+
|
|
33346
|
+
/**
|
|
33347
|
+
* Create new category
|
|
33348
|
+
*
|
|
33349
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33350
|
+
* @param {Object} body
|
|
33351
|
+
*/
|
|
33352
|
+
postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body) {
|
|
33353
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33354
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33355
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';
|
|
33356
|
+
}
|
|
33357
|
+
// verify the required parameter 'body' is set
|
|
33358
|
+
if (body === undefined || body === null) {
|
|
33359
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';
|
|
33360
|
+
}
|
|
33361
|
+
|
|
33362
|
+
return this.apiClient.callApi(
|
|
33363
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories',
|
|
33364
|
+
'POST',
|
|
33365
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33366
|
+
{ },
|
|
33367
|
+
{ },
|
|
33368
|
+
{ },
|
|
33369
|
+
body,
|
|
33370
|
+
['PureCloud OAuth'],
|
|
33371
|
+
['application/json'],
|
|
33372
|
+
['application/json']
|
|
33373
|
+
);
|
|
33374
|
+
}
|
|
33375
|
+
|
|
33376
|
+
/**
|
|
33377
|
+
* Create a variation for a document.
|
|
33378
|
+
*
|
|
33379
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
33380
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
33381
|
+
* @param {Object} body
|
|
33382
|
+
*/
|
|
33383
|
+
postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body) {
|
|
33384
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33385
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33386
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
33387
|
+
}
|
|
33388
|
+
// verify the required parameter 'documentId' is set
|
|
33389
|
+
if (documentId === undefined || documentId === null) {
|
|
33390
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
33391
|
+
}
|
|
33392
|
+
// verify the required parameter 'body' is set
|
|
33393
|
+
if (body === undefined || body === null) {
|
|
33394
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';
|
|
33395
|
+
}
|
|
33396
|
+
|
|
33397
|
+
return this.apiClient.callApi(
|
|
33398
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations',
|
|
33399
|
+
'POST',
|
|
33400
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33401
|
+
{ },
|
|
33402
|
+
{ },
|
|
33403
|
+
{ },
|
|
33404
|
+
body,
|
|
33405
|
+
['PureCloud OAuth'],
|
|
33406
|
+
['application/json'],
|
|
33407
|
+
['application/json']
|
|
33408
|
+
);
|
|
33409
|
+
}
|
|
33410
|
+
|
|
33411
|
+
/**
|
|
33412
|
+
* Creates or restores a document version.
|
|
33413
|
+
*
|
|
33414
|
+
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
33415
|
+
* @param {String} documentId Globally unique identifier for the document.
|
|
33416
|
+
* @param {Object} body
|
|
33417
|
+
*/
|
|
33418
|
+
postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body) {
|
|
33419
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33420
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33421
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
33422
|
+
}
|
|
33423
|
+
// verify the required parameter 'documentId' is set
|
|
33424
|
+
if (documentId === undefined || documentId === null) {
|
|
33425
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
33426
|
+
}
|
|
33427
|
+
// verify the required parameter 'body' is set
|
|
33428
|
+
if (body === undefined || body === null) {
|
|
33429
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';
|
|
33430
|
+
}
|
|
33431
|
+
|
|
33432
|
+
return this.apiClient.callApi(
|
|
33433
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions',
|
|
33434
|
+
'POST',
|
|
33435
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33436
|
+
{ },
|
|
33437
|
+
{ },
|
|
33438
|
+
{ },
|
|
33439
|
+
body,
|
|
33440
|
+
['PureCloud OAuth'],
|
|
33441
|
+
['application/json'],
|
|
33442
|
+
['application/json']
|
|
33443
|
+
);
|
|
33444
|
+
}
|
|
33445
|
+
|
|
33446
|
+
/**
|
|
33447
|
+
* Create document.
|
|
33448
|
+
*
|
|
33449
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33450
|
+
* @param {Object} body
|
|
33451
|
+
*/
|
|
33452
|
+
postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body) {
|
|
33453
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33454
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33455
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';
|
|
33456
|
+
}
|
|
33457
|
+
// verify the required parameter 'body' is set
|
|
33458
|
+
if (body === undefined || body === null) {
|
|
33459
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';
|
|
33460
|
+
}
|
|
33461
|
+
|
|
33462
|
+
return this.apiClient.callApi(
|
|
33463
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
33464
|
+
'POST',
|
|
33465
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33466
|
+
{ },
|
|
33467
|
+
{ },
|
|
33468
|
+
{ },
|
|
33469
|
+
body,
|
|
33470
|
+
['PureCloud OAuth'],
|
|
33471
|
+
['application/json'],
|
|
33472
|
+
['application/json']
|
|
33473
|
+
);
|
|
33474
|
+
}
|
|
33475
|
+
|
|
33476
|
+
/**
|
|
33477
|
+
* Search the documents in a knowledge base.
|
|
33478
|
+
*
|
|
33479
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
33480
|
+
* @param {Object} opts Optional parameters
|
|
33481
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
33482
|
+
* @param {Object} opts.body
|
|
33483
|
+
*/
|
|
33484
|
+
postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, opts) {
|
|
33485
|
+
opts = opts || {};
|
|
33486
|
+
|
|
33487
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33488
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33489
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';
|
|
33490
|
+
}
|
|
33491
|
+
|
|
33492
|
+
return this.apiClient.callApi(
|
|
33493
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search',
|
|
33494
|
+
'POST',
|
|
33495
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33496
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
33497
|
+
{ },
|
|
33498
|
+
{ },
|
|
33499
|
+
opts['body'],
|
|
33500
|
+
['PureCloud OAuth'],
|
|
33501
|
+
['application/json'],
|
|
33502
|
+
['application/json']
|
|
33503
|
+
);
|
|
33504
|
+
}
|
|
33505
|
+
|
|
33506
|
+
/**
|
|
33507
|
+
* Query the knowledge documents to provide suggestions for auto completion.
|
|
33508
|
+
*
|
|
33509
|
+
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
33510
|
+
* @param {Object} opts Optional parameters
|
|
33511
|
+
* @param {Object} opts.body
|
|
33512
|
+
*/
|
|
33513
|
+
postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, opts) {
|
|
33514
|
+
opts = opts || {};
|
|
33515
|
+
|
|
33516
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33517
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33518
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';
|
|
33519
|
+
}
|
|
33520
|
+
|
|
33521
|
+
return this.apiClient.callApi(
|
|
33522
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions',
|
|
33523
|
+
'POST',
|
|
33524
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33525
|
+
{ },
|
|
33526
|
+
{ },
|
|
33527
|
+
{ },
|
|
33528
|
+
opts['body'],
|
|
33529
|
+
['PureCloud OAuth'],
|
|
33530
|
+
['application/json'],
|
|
33531
|
+
['application/json']
|
|
33532
|
+
);
|
|
33533
|
+
}
|
|
33534
|
+
|
|
33535
|
+
/**
|
|
33536
|
+
* Create export job
|
|
33537
|
+
*
|
|
33538
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33539
|
+
* @param {Object} body
|
|
33540
|
+
*/
|
|
33541
|
+
postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body) {
|
|
33542
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33543
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33544
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
33545
|
+
}
|
|
33546
|
+
// verify the required parameter 'body' is set
|
|
33547
|
+
if (body === undefined || body === null) {
|
|
33548
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';
|
|
33549
|
+
}
|
|
33550
|
+
|
|
33551
|
+
return this.apiClient.callApi(
|
|
33552
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs',
|
|
33553
|
+
'POST',
|
|
33554
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33555
|
+
{ },
|
|
33556
|
+
{ },
|
|
33557
|
+
{ },
|
|
33558
|
+
body,
|
|
33559
|
+
['PureCloud OAuth'],
|
|
33560
|
+
['application/json'],
|
|
33561
|
+
['application/json']
|
|
33562
|
+
);
|
|
33563
|
+
}
|
|
33564
|
+
|
|
33565
|
+
/**
|
|
33566
|
+
* Create import job
|
|
33567
|
+
*
|
|
33568
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33569
|
+
* @param {Object} body
|
|
33570
|
+
*/
|
|
33571
|
+
postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body) {
|
|
33572
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33573
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33574
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
33575
|
+
}
|
|
33576
|
+
// verify the required parameter 'body' is set
|
|
33577
|
+
if (body === undefined || body === null) {
|
|
33578
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';
|
|
33579
|
+
}
|
|
33580
|
+
|
|
33581
|
+
return this.apiClient.callApi(
|
|
33582
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs',
|
|
33583
|
+
'POST',
|
|
33584
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33585
|
+
{ },
|
|
33586
|
+
{ },
|
|
33587
|
+
{ },
|
|
33588
|
+
body,
|
|
33589
|
+
['PureCloud OAuth'],
|
|
33590
|
+
['application/json'],
|
|
33591
|
+
['application/json']
|
|
33592
|
+
);
|
|
33593
|
+
}
|
|
33594
|
+
|
|
33595
|
+
/**
|
|
33596
|
+
* Create new label
|
|
33597
|
+
*
|
|
33598
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
33599
|
+
* @param {Object} body
|
|
33600
|
+
*/
|
|
33601
|
+
postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body) {
|
|
33602
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33603
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33604
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';
|
|
33605
|
+
}
|
|
33606
|
+
// verify the required parameter 'body' is set
|
|
33607
|
+
if (body === undefined || body === null) {
|
|
33608
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';
|
|
33609
|
+
}
|
|
33610
|
+
|
|
33611
|
+
return this.apiClient.callApi(
|
|
33612
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels',
|
|
33613
|
+
'POST',
|
|
33614
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
33615
|
+
{ },
|
|
33616
|
+
{ },
|
|
33617
|
+
{ },
|
|
33618
|
+
body,
|
|
33619
|
+
['PureCloud OAuth'],
|
|
33620
|
+
['application/json'],
|
|
33621
|
+
['application/json']
|
|
33622
|
+
);
|
|
33623
|
+
}
|
|
33624
|
+
|
|
31836
33625
|
/**
|
|
31837
33626
|
* Create new category
|
|
31838
33627
|
*
|
|
@@ -32063,7 +33852,7 @@ class LanguageUnderstandingApi {
|
|
|
32063
33852
|
/**
|
|
32064
33853
|
* LanguageUnderstanding service.
|
|
32065
33854
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32066
|
-
* @version
|
|
33855
|
+
* @version 147.0.0
|
|
32067
33856
|
*/
|
|
32068
33857
|
|
|
32069
33858
|
/**
|
|
@@ -32967,7 +34756,7 @@ class LanguagesApi {
|
|
|
32967
34756
|
/**
|
|
32968
34757
|
* Languages service.
|
|
32969
34758
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
32970
|
-
* @version
|
|
34759
|
+
* @version 147.0.0
|
|
32971
34760
|
*/
|
|
32972
34761
|
|
|
32973
34762
|
/**
|
|
@@ -33235,7 +35024,7 @@ class LearningApi {
|
|
|
33235
35024
|
/**
|
|
33236
35025
|
* Learning service.
|
|
33237
35026
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33238
|
-
* @version
|
|
35027
|
+
* @version 147.0.0
|
|
33239
35028
|
*/
|
|
33240
35029
|
|
|
33241
35030
|
/**
|
|
@@ -33995,7 +35784,7 @@ class LicenseApi {
|
|
|
33995
35784
|
/**
|
|
33996
35785
|
* License service.
|
|
33997
35786
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
33998
|
-
* @version
|
|
35787
|
+
* @version 147.0.0
|
|
33999
35788
|
*/
|
|
34000
35789
|
|
|
34001
35790
|
/**
|
|
@@ -34233,7 +36022,7 @@ class LocationsApi {
|
|
|
34233
36022
|
/**
|
|
34234
36023
|
* Locations service.
|
|
34235
36024
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34236
|
-
* @version
|
|
36025
|
+
* @version 147.0.0
|
|
34237
36026
|
*/
|
|
34238
36027
|
|
|
34239
36028
|
/**
|
|
@@ -34469,7 +36258,7 @@ class MessagingApi {
|
|
|
34469
36258
|
/**
|
|
34470
36259
|
* Messaging service.
|
|
34471
36260
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34472
|
-
* @version
|
|
36261
|
+
* @version 147.0.0
|
|
34473
36262
|
*/
|
|
34474
36263
|
|
|
34475
36264
|
/**
|
|
@@ -34620,7 +36409,7 @@ class MobileDevicesApi {
|
|
|
34620
36409
|
/**
|
|
34621
36410
|
* MobileDevices service.
|
|
34622
36411
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34623
|
-
* @version
|
|
36412
|
+
* @version 147.0.0
|
|
34624
36413
|
*/
|
|
34625
36414
|
|
|
34626
36415
|
/**
|
|
@@ -34771,7 +36560,7 @@ class NotificationsApi {
|
|
|
34771
36560
|
/**
|
|
34772
36561
|
* Notifications service.
|
|
34773
36562
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34774
|
-
* @version
|
|
36563
|
+
* @version 147.0.0
|
|
34775
36564
|
*/
|
|
34776
36565
|
|
|
34777
36566
|
/**
|
|
@@ -34996,7 +36785,7 @@ class OAuthApi {
|
|
|
34996
36785
|
/**
|
|
34997
36786
|
* OAuth service.
|
|
34998
36787
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
34999
|
-
* @version
|
|
36788
|
+
* @version 147.0.0
|
|
35000
36789
|
*/
|
|
35001
36790
|
|
|
35002
36791
|
/**
|
|
@@ -35362,7 +37151,7 @@ class ObjectsApi {
|
|
|
35362
37151
|
/**
|
|
35363
37152
|
* Objects service.
|
|
35364
37153
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
35365
|
-
* @version
|
|
37154
|
+
* @version 147.0.0
|
|
35366
37155
|
*/
|
|
35367
37156
|
|
|
35368
37157
|
/**
|
|
@@ -35633,7 +37422,7 @@ class OrganizationApi {
|
|
|
35633
37422
|
/**
|
|
35634
37423
|
* Organization service.
|
|
35635
37424
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35636
|
-
* @version
|
|
37425
|
+
* @version 147.0.0
|
|
35637
37426
|
*/
|
|
35638
37427
|
|
|
35639
37428
|
/**
|
|
@@ -36036,7 +37825,7 @@ class OrganizationAuthorizationApi {
|
|
|
36036
37825
|
/**
|
|
36037
37826
|
* OrganizationAuthorization service.
|
|
36038
37827
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36039
|
-
* @version
|
|
37828
|
+
* @version 147.0.0
|
|
36040
37829
|
*/
|
|
36041
37830
|
|
|
36042
37831
|
/**
|
|
@@ -36961,7 +38750,7 @@ class OutboundApi {
|
|
|
36961
38750
|
/**
|
|
36962
38751
|
* Outbound service.
|
|
36963
38752
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36964
|
-
* @version
|
|
38753
|
+
* @version 147.0.0
|
|
36965
38754
|
*/
|
|
36966
38755
|
|
|
36967
38756
|
/**
|
|
@@ -37261,6 +39050,31 @@ class OutboundApi {
|
|
|
37261
39050
|
);
|
|
37262
39051
|
}
|
|
37263
39052
|
|
|
39053
|
+
/**
|
|
39054
|
+
* Delete an Outbound Digital Rule Set
|
|
39055
|
+
*
|
|
39056
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
39057
|
+
*/
|
|
39058
|
+
deleteOutboundDigitalruleset(digitalRuleSetId) {
|
|
39059
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
39060
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
39061
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';
|
|
39062
|
+
}
|
|
39063
|
+
|
|
39064
|
+
return this.apiClient.callApi(
|
|
39065
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
39066
|
+
'DELETE',
|
|
39067
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
39068
|
+
{ },
|
|
39069
|
+
{ },
|
|
39070
|
+
{ },
|
|
39071
|
+
null,
|
|
39072
|
+
['PureCloud OAuth'],
|
|
39073
|
+
['application/json'],
|
|
39074
|
+
['application/json']
|
|
39075
|
+
);
|
|
39076
|
+
}
|
|
39077
|
+
|
|
37264
39078
|
/**
|
|
37265
39079
|
* Delete dialer DNC list
|
|
37266
39080
|
*
|
|
@@ -38298,6 +40112,60 @@ class OutboundApi {
|
|
|
38298
40112
|
);
|
|
38299
40113
|
}
|
|
38300
40114
|
|
|
40115
|
+
/**
|
|
40116
|
+
* Get an Outbound Digital Rule Set
|
|
40117
|
+
*
|
|
40118
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
40119
|
+
*/
|
|
40120
|
+
getOutboundDigitalruleset(digitalRuleSetId) {
|
|
40121
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
40122
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
40123
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';
|
|
40124
|
+
}
|
|
40125
|
+
|
|
40126
|
+
return this.apiClient.callApi(
|
|
40127
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
40128
|
+
'GET',
|
|
40129
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
40130
|
+
{ },
|
|
40131
|
+
{ },
|
|
40132
|
+
{ },
|
|
40133
|
+
null,
|
|
40134
|
+
['PureCloud OAuth'],
|
|
40135
|
+
['application/json'],
|
|
40136
|
+
['application/json']
|
|
40137
|
+
);
|
|
40138
|
+
}
|
|
40139
|
+
|
|
40140
|
+
/**
|
|
40141
|
+
* Query a list of Outbound Digital Rule Sets
|
|
40142
|
+
*
|
|
40143
|
+
* @param {Object} opts Optional parameters
|
|
40144
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
40145
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40146
|
+
* @param {Object} opts.sortBy The field to sort by (default to name)
|
|
40147
|
+
* @param {Object} opts.sortOrder The direction to sort (default to ascending)
|
|
40148
|
+
* @param {String} opts.name Name
|
|
40149
|
+
* @param {Array.<String>} opts.id A list of digital rule set ids to bulk fetch
|
|
40150
|
+
*/
|
|
40151
|
+
getOutboundDigitalrulesets(opts) {
|
|
40152
|
+
opts = opts || {};
|
|
40153
|
+
|
|
40154
|
+
|
|
40155
|
+
return this.apiClient.callApi(
|
|
40156
|
+
'/api/v2/outbound/digitalrulesets',
|
|
40157
|
+
'GET',
|
|
40158
|
+
{ },
|
|
40159
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
40160
|
+
{ },
|
|
40161
|
+
{ },
|
|
40162
|
+
null,
|
|
40163
|
+
['PureCloud OAuth'],
|
|
40164
|
+
['application/json'],
|
|
40165
|
+
['application/json']
|
|
40166
|
+
);
|
|
40167
|
+
}
|
|
40168
|
+
|
|
38301
40169
|
/**
|
|
38302
40170
|
* Get dialer DNC list
|
|
38303
40171
|
*
|
|
@@ -39481,6 +41349,31 @@ class OutboundApi {
|
|
|
39481
41349
|
);
|
|
39482
41350
|
}
|
|
39483
41351
|
|
|
41352
|
+
/**
|
|
41353
|
+
* Create an Outbound Digital Rule Set
|
|
41354
|
+
*
|
|
41355
|
+
* @param {Object} body Digital Rule Set
|
|
41356
|
+
*/
|
|
41357
|
+
postOutboundDigitalrulesets(body) {
|
|
41358
|
+
// verify the required parameter 'body' is set
|
|
41359
|
+
if (body === undefined || body === null) {
|
|
41360
|
+
throw 'Missing the required parameter "body" when calling postOutboundDigitalrulesets';
|
|
41361
|
+
}
|
|
41362
|
+
|
|
41363
|
+
return this.apiClient.callApi(
|
|
41364
|
+
'/api/v2/outbound/digitalrulesets',
|
|
41365
|
+
'POST',
|
|
41366
|
+
{ },
|
|
41367
|
+
{ },
|
|
41368
|
+
{ },
|
|
41369
|
+
{ },
|
|
41370
|
+
body,
|
|
41371
|
+
['PureCloud OAuth'],
|
|
41372
|
+
['application/json'],
|
|
41373
|
+
['application/json']
|
|
41374
|
+
);
|
|
41375
|
+
}
|
|
41376
|
+
|
|
39484
41377
|
/**
|
|
39485
41378
|
* Initiate the export of a dnc list.
|
|
39486
41379
|
* Returns 200 if received OK.
|
|
@@ -39945,6 +41838,36 @@ class OutboundApi {
|
|
|
39945
41838
|
);
|
|
39946
41839
|
}
|
|
39947
41840
|
|
|
41841
|
+
/**
|
|
41842
|
+
* Update an Outbound Digital Rule Set
|
|
41843
|
+
*
|
|
41844
|
+
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
41845
|
+
* @param {Object} body Digital Rule Set
|
|
41846
|
+
*/
|
|
41847
|
+
putOutboundDigitalruleset(digitalRuleSetId, body) {
|
|
41848
|
+
// verify the required parameter 'digitalRuleSetId' is set
|
|
41849
|
+
if (digitalRuleSetId === undefined || digitalRuleSetId === null) {
|
|
41850
|
+
throw 'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';
|
|
41851
|
+
}
|
|
41852
|
+
// verify the required parameter 'body' is set
|
|
41853
|
+
if (body === undefined || body === null) {
|
|
41854
|
+
throw 'Missing the required parameter "body" when calling putOutboundDigitalruleset';
|
|
41855
|
+
}
|
|
41856
|
+
|
|
41857
|
+
return this.apiClient.callApi(
|
|
41858
|
+
'/api/v2/outbound/digitalrulesets/{digitalRuleSetId}',
|
|
41859
|
+
'PUT',
|
|
41860
|
+
{ 'digitalRuleSetId': digitalRuleSetId },
|
|
41861
|
+
{ },
|
|
41862
|
+
{ },
|
|
41863
|
+
{ },
|
|
41864
|
+
body,
|
|
41865
|
+
['PureCloud OAuth'],
|
|
41866
|
+
['application/json'],
|
|
41867
|
+
['application/json']
|
|
41868
|
+
);
|
|
41869
|
+
}
|
|
41870
|
+
|
|
39948
41871
|
/**
|
|
39949
41872
|
* Update dialer DNC list
|
|
39950
41873
|
*
|
|
@@ -40216,7 +42139,7 @@ class PresenceApi {
|
|
|
40216
42139
|
/**
|
|
40217
42140
|
* Presence service.
|
|
40218
42141
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
40219
|
-
* @version
|
|
42142
|
+
* @version 147.0.0
|
|
40220
42143
|
*/
|
|
40221
42144
|
|
|
40222
42145
|
/**
|
|
@@ -40538,7 +42461,7 @@ class QualityApi {
|
|
|
40538
42461
|
/**
|
|
40539
42462
|
* Quality service.
|
|
40540
42463
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40541
|
-
* @version
|
|
42464
|
+
* @version 147.0.0
|
|
40542
42465
|
*/
|
|
40543
42466
|
|
|
40544
42467
|
/**
|
|
@@ -41048,7 +42971,7 @@ class QualityApi {
|
|
|
41048
42971
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
41049
42972
|
* @param {String} opts.nextPage next page token
|
|
41050
42973
|
* @param {String} opts.previousPage Previous page token
|
|
41051
|
-
* @param {
|
|
42974
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
41052
42975
|
* @param {String} opts.name Name
|
|
41053
42976
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
41054
42977
|
*/
|
|
@@ -41135,7 +43058,7 @@ class QualityApi {
|
|
|
41135
43058
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
41136
43059
|
* @param {String} opts.nextPage next page token
|
|
41137
43060
|
* @param {String} opts.previousPage Previous page token
|
|
41138
|
-
* @param {
|
|
43061
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
41139
43062
|
* @param {String} opts.name Name
|
|
41140
43063
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
41141
43064
|
*/
|
|
@@ -41246,7 +43169,7 @@ class QualityApi {
|
|
|
41246
43169
|
* @param {String} opts.sortBy variable name requested to sort by
|
|
41247
43170
|
* @param {String} opts.nextPage next page token
|
|
41248
43171
|
* @param {String} opts.previousPage Previous page token
|
|
41249
|
-
* @param {
|
|
43172
|
+
* @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
|
|
41250
43173
|
* @param {String} opts.name Name
|
|
41251
43174
|
* @param {String} opts.sortOrder Order to sort results, either asc or desc
|
|
41252
43175
|
*/
|
|
@@ -42116,7 +44039,7 @@ class RecordingApi {
|
|
|
42116
44039
|
/**
|
|
42117
44040
|
* Recording service.
|
|
42118
44041
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
42119
|
-
* @version
|
|
44042
|
+
* @version 147.0.0
|
|
42120
44043
|
*/
|
|
42121
44044
|
|
|
42122
44045
|
/**
|
|
@@ -42641,12 +44564,249 @@ class RecordingApi {
|
|
|
42641
44564
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
42642
44565
|
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
42643
44566
|
*/
|
|
42644
|
-
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
44567
|
+
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
44568
|
+
opts = opts || {};
|
|
44569
|
+
|
|
44570
|
+
|
|
44571
|
+
return this.apiClient.callApi(
|
|
44572
|
+
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
44573
|
+
'GET',
|
|
44574
|
+
{ },
|
|
44575
|
+
{ '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'] },
|
|
44576
|
+
{ },
|
|
44577
|
+
{ },
|
|
44578
|
+
null,
|
|
44579
|
+
['PureCloud OAuth'],
|
|
44580
|
+
['application/json'],
|
|
44581
|
+
['application/json']
|
|
44582
|
+
);
|
|
44583
|
+
}
|
|
44584
|
+
|
|
44585
|
+
/**
|
|
44586
|
+
* Get a media retention policy
|
|
44587
|
+
*
|
|
44588
|
+
* @param {String} policyId Policy ID
|
|
44589
|
+
*/
|
|
44590
|
+
getRecordingCrossplatformMediaretentionpolicy(policyId) {
|
|
44591
|
+
// verify the required parameter 'policyId' is set
|
|
44592
|
+
if (policyId === undefined || policyId === null) {
|
|
44593
|
+
throw 'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';
|
|
44594
|
+
}
|
|
44595
|
+
|
|
44596
|
+
return this.apiClient.callApi(
|
|
44597
|
+
'/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}',
|
|
44598
|
+
'GET',
|
|
44599
|
+
{ 'policyId': policyId },
|
|
44600
|
+
{ },
|
|
44601
|
+
{ },
|
|
44602
|
+
{ },
|
|
44603
|
+
null,
|
|
44604
|
+
['PureCloud OAuth'],
|
|
44605
|
+
['application/json'],
|
|
44606
|
+
['application/json']
|
|
44607
|
+
);
|
|
44608
|
+
}
|
|
44609
|
+
|
|
44610
|
+
/**
|
|
44611
|
+
* Get the status of the job associated with the job id.
|
|
44612
|
+
*
|
|
44613
|
+
* @param {String} jobId jobId
|
|
44614
|
+
*/
|
|
44615
|
+
getRecordingJob(jobId) {
|
|
44616
|
+
// verify the required parameter 'jobId' is set
|
|
44617
|
+
if (jobId === undefined || jobId === null) {
|
|
44618
|
+
throw 'Missing the required parameter "jobId" when calling getRecordingJob';
|
|
44619
|
+
}
|
|
44620
|
+
|
|
44621
|
+
return this.apiClient.callApi(
|
|
44622
|
+
'/api/v2/recording/jobs/{jobId}',
|
|
44623
|
+
'GET',
|
|
44624
|
+
{ 'jobId': jobId },
|
|
44625
|
+
{ },
|
|
44626
|
+
{ },
|
|
44627
|
+
{ },
|
|
44628
|
+
null,
|
|
44629
|
+
['PureCloud OAuth'],
|
|
44630
|
+
['application/json'],
|
|
44631
|
+
['application/json']
|
|
44632
|
+
);
|
|
44633
|
+
}
|
|
44634
|
+
|
|
44635
|
+
/**
|
|
44636
|
+
* Get IDs of recordings that the bulk job failed for
|
|
44637
|
+
*
|
|
44638
|
+
* @param {String} jobId jobId
|
|
44639
|
+
* @param {Object} opts Optional parameters
|
|
44640
|
+
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
44641
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
44642
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
44643
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
44644
|
+
*/
|
|
44645
|
+
getRecordingJobFailedrecordings(jobId, opts) {
|
|
44646
|
+
opts = opts || {};
|
|
44647
|
+
|
|
44648
|
+
// verify the required parameter 'jobId' is set
|
|
44649
|
+
if (jobId === undefined || jobId === null) {
|
|
44650
|
+
throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
|
|
44651
|
+
}
|
|
44652
|
+
|
|
44653
|
+
return this.apiClient.callApi(
|
|
44654
|
+
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
44655
|
+
'GET',
|
|
44656
|
+
{ 'jobId': jobId },
|
|
44657
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
44658
|
+
{ },
|
|
44659
|
+
{ },
|
|
44660
|
+
null,
|
|
44661
|
+
['PureCloud OAuth'],
|
|
44662
|
+
['application/json'],
|
|
44663
|
+
['application/json']
|
|
44664
|
+
);
|
|
44665
|
+
}
|
|
44666
|
+
|
|
44667
|
+
/**
|
|
44668
|
+
* Get the status of all jobs within the user's organization
|
|
44669
|
+
*
|
|
44670
|
+
* @param {Object} opts Optional parameters
|
|
44671
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
44672
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
44673
|
+
* @param {Object} opts.sortBy Sort by (default to userId)
|
|
44674
|
+
* @param {Object} opts.state Filter by state
|
|
44675
|
+
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
44676
|
+
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
44677
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
44678
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
44679
|
+
*/
|
|
44680
|
+
getRecordingJobs(opts) {
|
|
44681
|
+
opts = opts || {};
|
|
44682
|
+
|
|
44683
|
+
|
|
44684
|
+
return this.apiClient.callApi(
|
|
44685
|
+
'/api/v2/recording/jobs',
|
|
44686
|
+
'GET',
|
|
44687
|
+
{ },
|
|
44688
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
44689
|
+
{ },
|
|
44690
|
+
{ },
|
|
44691
|
+
null,
|
|
44692
|
+
['PureCloud OAuth'],
|
|
44693
|
+
['application/json'],
|
|
44694
|
+
['application/json']
|
|
44695
|
+
);
|
|
44696
|
+
}
|
|
44697
|
+
|
|
44698
|
+
/**
|
|
44699
|
+
* Get the encryption key configurations
|
|
44700
|
+
*
|
|
44701
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
44702
|
+
*/
|
|
44703
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
44704
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
44705
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
44706
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
44707
|
+
}
|
|
44708
|
+
|
|
44709
|
+
return this.apiClient.callApi(
|
|
44710
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
44711
|
+
'GET',
|
|
44712
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
44713
|
+
{ },
|
|
44714
|
+
{ },
|
|
44715
|
+
{ },
|
|
44716
|
+
null,
|
|
44717
|
+
['PureCloud OAuth'],
|
|
44718
|
+
['application/json'],
|
|
44719
|
+
['application/json']
|
|
44720
|
+
);
|
|
44721
|
+
}
|
|
44722
|
+
|
|
44723
|
+
/**
|
|
44724
|
+
* Get a list of key configurations data
|
|
44725
|
+
*
|
|
44726
|
+
*/
|
|
44727
|
+
getRecordingKeyconfigurations() {
|
|
44728
|
+
|
|
44729
|
+
return this.apiClient.callApi(
|
|
44730
|
+
'/api/v2/recording/keyconfigurations',
|
|
44731
|
+
'GET',
|
|
44732
|
+
{ },
|
|
44733
|
+
{ },
|
|
44734
|
+
{ },
|
|
44735
|
+
{ },
|
|
44736
|
+
null,
|
|
44737
|
+
['PureCloud OAuth'],
|
|
44738
|
+
['application/json'],
|
|
44739
|
+
['application/json']
|
|
44740
|
+
);
|
|
44741
|
+
}
|
|
44742
|
+
|
|
44743
|
+
/**
|
|
44744
|
+
* Get the local encryption settings
|
|
44745
|
+
*
|
|
44746
|
+
* @param {String} settingsId Settings Id
|
|
44747
|
+
*/
|
|
44748
|
+
getRecordingLocalkeysSetting(settingsId) {
|
|
44749
|
+
// verify the required parameter 'settingsId' is set
|
|
44750
|
+
if (settingsId === undefined || settingsId === null) {
|
|
44751
|
+
throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
|
|
44752
|
+
}
|
|
44753
|
+
|
|
44754
|
+
return this.apiClient.callApi(
|
|
44755
|
+
'/api/v2/recording/localkeys/settings/{settingsId}',
|
|
44756
|
+
'GET',
|
|
44757
|
+
{ 'settingsId': settingsId },
|
|
44758
|
+
{ },
|
|
44759
|
+
{ },
|
|
44760
|
+
{ },
|
|
44761
|
+
null,
|
|
44762
|
+
['PureCloud OAuth'],
|
|
44763
|
+
['application/json'],
|
|
44764
|
+
['application/json']
|
|
44765
|
+
);
|
|
44766
|
+
}
|
|
44767
|
+
|
|
44768
|
+
/**
|
|
44769
|
+
* gets a list local key settings data
|
|
44770
|
+
*
|
|
44771
|
+
*/
|
|
44772
|
+
getRecordingLocalkeysSettings() {
|
|
44773
|
+
|
|
44774
|
+
return this.apiClient.callApi(
|
|
44775
|
+
'/api/v2/recording/localkeys/settings',
|
|
44776
|
+
'GET',
|
|
44777
|
+
{ },
|
|
44778
|
+
{ },
|
|
44779
|
+
{ },
|
|
44780
|
+
{ },
|
|
44781
|
+
null,
|
|
44782
|
+
['PureCloud OAuth'],
|
|
44783
|
+
['application/json'],
|
|
44784
|
+
['application/json']
|
|
44785
|
+
);
|
|
44786
|
+
}
|
|
44787
|
+
|
|
44788
|
+
/**
|
|
44789
|
+
* Gets media retention policy list with query options to filter on name and enabled.
|
|
44790
|
+
* for a less verbose response, add summary=true to this endpoint
|
|
44791
|
+
* @param {Object} opts Optional parameters
|
|
44792
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
44793
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
44794
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
44795
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
44796
|
+
* @param {String} opts.nextPage next page token
|
|
44797
|
+
* @param {String} opts.previousPage Previous page token
|
|
44798
|
+
* @param {String} opts.name the policy name - used for filtering results in searches.
|
|
44799
|
+
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
44800
|
+
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
44801
|
+
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
44802
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
44803
|
+
*/
|
|
44804
|
+
getRecordingMediaretentionpolicies(opts) {
|
|
42645
44805
|
opts = opts || {};
|
|
42646
44806
|
|
|
42647
44807
|
|
|
42648
44808
|
return this.apiClient.callApi(
|
|
42649
|
-
'/api/v2/recording/
|
|
44809
|
+
'/api/v2/recording/mediaretentionpolicies',
|
|
42650
44810
|
'GET',
|
|
42651
44811
|
{ },
|
|
42652
44812
|
{ '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'] },
|
|
@@ -42664,14 +44824,14 @@ class RecordingApi {
|
|
|
42664
44824
|
*
|
|
42665
44825
|
* @param {String} policyId Policy ID
|
|
42666
44826
|
*/
|
|
42667
|
-
|
|
44827
|
+
getRecordingMediaretentionpolicy(policyId) {
|
|
42668
44828
|
// verify the required parameter 'policyId' is set
|
|
42669
44829
|
if (policyId === undefined || policyId === null) {
|
|
42670
|
-
throw 'Missing the required parameter "policyId" when calling
|
|
44830
|
+
throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
|
|
42671
44831
|
}
|
|
42672
44832
|
|
|
42673
44833
|
return this.apiClient.callApi(
|
|
42674
|
-
'/api/v2/recording/
|
|
44834
|
+
'/api/v2/recording/mediaretentionpolicies/{policyId}',
|
|
42675
44835
|
'GET',
|
|
42676
44836
|
{ 'policyId': policyId },
|
|
42677
44837
|
{ },
|
|
@@ -42685,154 +44845,21 @@ class RecordingApi {
|
|
|
42685
44845
|
}
|
|
42686
44846
|
|
|
42687
44847
|
/**
|
|
42688
|
-
* Get
|
|
42689
|
-
*
|
|
42690
|
-
* @param {String} jobId jobId
|
|
42691
|
-
*/
|
|
42692
|
-
getRecordingJob(jobId) {
|
|
42693
|
-
// verify the required parameter 'jobId' is set
|
|
42694
|
-
if (jobId === undefined || jobId === null) {
|
|
42695
|
-
throw 'Missing the required parameter "jobId" when calling getRecordingJob';
|
|
42696
|
-
}
|
|
42697
|
-
|
|
42698
|
-
return this.apiClient.callApi(
|
|
42699
|
-
'/api/v2/recording/jobs/{jobId}',
|
|
42700
|
-
'GET',
|
|
42701
|
-
{ 'jobId': jobId },
|
|
42702
|
-
{ },
|
|
42703
|
-
{ },
|
|
42704
|
-
{ },
|
|
42705
|
-
null,
|
|
42706
|
-
['PureCloud OAuth'],
|
|
42707
|
-
['application/json'],
|
|
42708
|
-
['application/json']
|
|
42709
|
-
);
|
|
42710
|
-
}
|
|
42711
|
-
|
|
42712
|
-
/**
|
|
42713
|
-
* Get IDs of recordings that the bulk job failed for
|
|
42714
|
-
*
|
|
42715
|
-
* @param {String} jobId jobId
|
|
42716
|
-
* @param {Object} opts Optional parameters
|
|
42717
|
-
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
42718
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
42719
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
42720
|
-
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
42721
|
-
*/
|
|
42722
|
-
getRecordingJobFailedrecordings(jobId, opts) {
|
|
42723
|
-
opts = opts || {};
|
|
42724
|
-
|
|
42725
|
-
// verify the required parameter 'jobId' is set
|
|
42726
|
-
if (jobId === undefined || jobId === null) {
|
|
42727
|
-
throw 'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';
|
|
42728
|
-
}
|
|
42729
|
-
|
|
42730
|
-
return this.apiClient.callApi(
|
|
42731
|
-
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
42732
|
-
'GET',
|
|
42733
|
-
{ 'jobId': jobId },
|
|
42734
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
42735
|
-
{ },
|
|
42736
|
-
{ },
|
|
42737
|
-
null,
|
|
42738
|
-
['PureCloud OAuth'],
|
|
42739
|
-
['application/json'],
|
|
42740
|
-
['application/json']
|
|
42741
|
-
);
|
|
42742
|
-
}
|
|
42743
|
-
|
|
42744
|
-
/**
|
|
42745
|
-
* Get the status of all jobs within the user's organization
|
|
44848
|
+
* Get encryption key list
|
|
42746
44849
|
*
|
|
42747
44850
|
* @param {Object} opts Optional parameters
|
|
42748
44851
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
42749
44852
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
42750
|
-
* @param {Object} opts.sortBy Sort by (default to userId)
|
|
42751
|
-
* @param {Object} opts.state Filter by state
|
|
42752
|
-
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
42753
|
-
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
42754
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
42755
|
-
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
42756
44853
|
*/
|
|
42757
|
-
|
|
44854
|
+
getRecordingRecordingkeys(opts) {
|
|
42758
44855
|
opts = opts || {};
|
|
42759
44856
|
|
|
42760
44857
|
|
|
42761
44858
|
return this.apiClient.callApi(
|
|
42762
|
-
'/api/v2/recording/
|
|
42763
|
-
'GET',
|
|
42764
|
-
{ },
|
|
42765
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
42766
|
-
{ },
|
|
42767
|
-
{ },
|
|
42768
|
-
null,
|
|
42769
|
-
['PureCloud OAuth'],
|
|
42770
|
-
['application/json'],
|
|
42771
|
-
['application/json']
|
|
42772
|
-
);
|
|
42773
|
-
}
|
|
42774
|
-
|
|
42775
|
-
/**
|
|
42776
|
-
* Get the encryption key configurations
|
|
42777
|
-
*
|
|
42778
|
-
* @param {String} keyConfigurationId Key Configurations Id
|
|
42779
|
-
*/
|
|
42780
|
-
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
42781
|
-
// verify the required parameter 'keyConfigurationId' is set
|
|
42782
|
-
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
42783
|
-
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
42784
|
-
}
|
|
42785
|
-
|
|
42786
|
-
return this.apiClient.callApi(
|
|
42787
|
-
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
42788
|
-
'GET',
|
|
42789
|
-
{ 'keyConfigurationId': keyConfigurationId },
|
|
42790
|
-
{ },
|
|
42791
|
-
{ },
|
|
42792
|
-
{ },
|
|
42793
|
-
null,
|
|
42794
|
-
['PureCloud OAuth'],
|
|
42795
|
-
['application/json'],
|
|
42796
|
-
['application/json']
|
|
42797
|
-
);
|
|
42798
|
-
}
|
|
42799
|
-
|
|
42800
|
-
/**
|
|
42801
|
-
* Get a list of key configurations data
|
|
42802
|
-
*
|
|
42803
|
-
*/
|
|
42804
|
-
getRecordingKeyconfigurations() {
|
|
42805
|
-
|
|
42806
|
-
return this.apiClient.callApi(
|
|
42807
|
-
'/api/v2/recording/keyconfigurations',
|
|
42808
|
-
'GET',
|
|
42809
|
-
{ },
|
|
42810
|
-
{ },
|
|
42811
|
-
{ },
|
|
42812
|
-
{ },
|
|
42813
|
-
null,
|
|
42814
|
-
['PureCloud OAuth'],
|
|
42815
|
-
['application/json'],
|
|
42816
|
-
['application/json']
|
|
42817
|
-
);
|
|
42818
|
-
}
|
|
42819
|
-
|
|
42820
|
-
/**
|
|
42821
|
-
* Get the local encryption settings
|
|
42822
|
-
*
|
|
42823
|
-
* @param {String} settingsId Settings Id
|
|
42824
|
-
*/
|
|
42825
|
-
getRecordingLocalkeysSetting(settingsId) {
|
|
42826
|
-
// verify the required parameter 'settingsId' is set
|
|
42827
|
-
if (settingsId === undefined || settingsId === null) {
|
|
42828
|
-
throw 'Missing the required parameter "settingsId" when calling getRecordingLocalkeysSetting';
|
|
42829
|
-
}
|
|
42830
|
-
|
|
42831
|
-
return this.apiClient.callApi(
|
|
42832
|
-
'/api/v2/recording/localkeys/settings/{settingsId}',
|
|
44859
|
+
'/api/v2/recording/recordingkeys',
|
|
42833
44860
|
'GET',
|
|
42834
|
-
{ 'settingsId': settingsId },
|
|
42835
44861
|
{ },
|
|
44862
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
42836
44863
|
{ },
|
|
42837
44864
|
{ },
|
|
42838
44865
|
null,
|
|
@@ -42843,74 +44870,15 @@ class RecordingApi {
|
|
|
42843
44870
|
}
|
|
42844
44871
|
|
|
42845
44872
|
/**
|
|
42846
|
-
*
|
|
44873
|
+
* Get key rotation schedule
|
|
42847
44874
|
*
|
|
42848
44875
|
*/
|
|
42849
|
-
|
|
42850
|
-
|
|
42851
|
-
return this.apiClient.callApi(
|
|
42852
|
-
'/api/v2/recording/localkeys/settings',
|
|
42853
|
-
'GET',
|
|
42854
|
-
{ },
|
|
42855
|
-
{ },
|
|
42856
|
-
{ },
|
|
42857
|
-
{ },
|
|
42858
|
-
null,
|
|
42859
|
-
['PureCloud OAuth'],
|
|
42860
|
-
['application/json'],
|
|
42861
|
-
['application/json']
|
|
42862
|
-
);
|
|
42863
|
-
}
|
|
42864
|
-
|
|
42865
|
-
/**
|
|
42866
|
-
* Gets media retention policy list with query options to filter on name and enabled.
|
|
42867
|
-
* for a less verbose response, add summary=true to this endpoint
|
|
42868
|
-
* @param {Object} opts Optional parameters
|
|
42869
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
42870
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
42871
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
42872
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
42873
|
-
* @param {String} opts.nextPage next page token
|
|
42874
|
-
* @param {String} opts.previousPage Previous page token
|
|
42875
|
-
* @param {String} opts.name the policy name - used for filtering results in searches.
|
|
42876
|
-
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
42877
|
-
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
42878
|
-
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
42879
|
-
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
42880
|
-
*/
|
|
42881
|
-
getRecordingMediaretentionpolicies(opts) {
|
|
42882
|
-
opts = opts || {};
|
|
42883
|
-
|
|
44876
|
+
getRecordingRecordingkeysRotationschedule() {
|
|
42884
44877
|
|
|
42885
44878
|
return this.apiClient.callApi(
|
|
42886
|
-
'/api/v2/recording/
|
|
44879
|
+
'/api/v2/recording/recordingkeys/rotationschedule',
|
|
42887
44880
|
'GET',
|
|
42888
44881
|
{ },
|
|
42889
|
-
{ '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'] },
|
|
42890
|
-
{ },
|
|
42891
|
-
{ },
|
|
42892
|
-
null,
|
|
42893
|
-
['PureCloud OAuth'],
|
|
42894
|
-
['application/json'],
|
|
42895
|
-
['application/json']
|
|
42896
|
-
);
|
|
42897
|
-
}
|
|
42898
|
-
|
|
42899
|
-
/**
|
|
42900
|
-
* Get a media retention policy
|
|
42901
|
-
*
|
|
42902
|
-
* @param {String} policyId Policy ID
|
|
42903
|
-
*/
|
|
42904
|
-
getRecordingMediaretentionpolicy(policyId) {
|
|
42905
|
-
// verify the required parameter 'policyId' is set
|
|
42906
|
-
if (policyId === undefined || policyId === null) {
|
|
42907
|
-
throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
|
|
42908
|
-
}
|
|
42909
|
-
|
|
42910
|
-
return this.apiClient.callApi(
|
|
42911
|
-
'/api/v2/recording/mediaretentionpolicies/{policyId}',
|
|
42912
|
-
'GET',
|
|
42913
|
-
{ 'policyId': policyId },
|
|
42914
44882
|
{ },
|
|
42915
44883
|
{ },
|
|
42916
44884
|
{ },
|
|
@@ -42922,41 +44890,20 @@ class RecordingApi {
|
|
|
42922
44890
|
}
|
|
42923
44891
|
|
|
42924
44892
|
/**
|
|
42925
|
-
* Get
|
|
44893
|
+
* Get the Recording Settings for the Organization
|
|
42926
44894
|
*
|
|
42927
44895
|
* @param {Object} opts Optional parameters
|
|
42928
|
-
* @param {
|
|
42929
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
44896
|
+
* @param {Boolean} opts.createDefault If no settings are found, a new one is created with default values (default to false)
|
|
42930
44897
|
*/
|
|
42931
|
-
|
|
44898
|
+
getRecordingSettings(opts) {
|
|
42932
44899
|
opts = opts || {};
|
|
42933
44900
|
|
|
42934
44901
|
|
|
42935
44902
|
return this.apiClient.callApi(
|
|
42936
|
-
'/api/v2/recording/
|
|
42937
|
-
'GET',
|
|
42938
|
-
{ },
|
|
42939
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
42940
|
-
{ },
|
|
42941
|
-
{ },
|
|
42942
|
-
null,
|
|
42943
|
-
['PureCloud OAuth'],
|
|
42944
|
-
['application/json'],
|
|
42945
|
-
['application/json']
|
|
42946
|
-
);
|
|
42947
|
-
}
|
|
42948
|
-
|
|
42949
|
-
/**
|
|
42950
|
-
* Get key rotation schedule
|
|
42951
|
-
*
|
|
42952
|
-
*/
|
|
42953
|
-
getRecordingRecordingkeysRotationschedule() {
|
|
42954
|
-
|
|
42955
|
-
return this.apiClient.callApi(
|
|
42956
|
-
'/api/v2/recording/recordingkeys/rotationschedule',
|
|
44903
|
+
'/api/v2/recording/settings',
|
|
42957
44904
|
'GET',
|
|
42958
44905
|
{ },
|
|
42959
|
-
{
|
|
44906
|
+
{ 'createDefault': opts['createDefault'] },
|
|
42960
44907
|
{ },
|
|
42961
44908
|
{ },
|
|
42962
44909
|
null,
|
|
@@ -42967,20 +44914,26 @@ class RecordingApi {
|
|
|
42967
44914
|
}
|
|
42968
44915
|
|
|
42969
44916
|
/**
|
|
42970
|
-
*
|
|
44917
|
+
* Query for recording retention data
|
|
42971
44918
|
*
|
|
44919
|
+
* @param {Number} retentionThresholdDays Fetch retention data for recordings retained for more days than the provided value.
|
|
42972
44920
|
* @param {Object} opts Optional parameters
|
|
42973
|
-
* @param {
|
|
44921
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
44922
|
+
* @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
|
|
42974
44923
|
*/
|
|
42975
|
-
|
|
44924
|
+
getRecordingsRetentionQuery(retentionThresholdDays, opts) {
|
|
42976
44925
|
opts = opts || {};
|
|
42977
44926
|
|
|
44927
|
+
// verify the required parameter 'retentionThresholdDays' is set
|
|
44928
|
+
if (retentionThresholdDays === undefined || retentionThresholdDays === null) {
|
|
44929
|
+
throw 'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';
|
|
44930
|
+
}
|
|
42978
44931
|
|
|
42979
44932
|
return this.apiClient.callApi(
|
|
42980
|
-
'/api/v2/
|
|
44933
|
+
'/api/v2/recordings/retention/query',
|
|
42981
44934
|
'GET',
|
|
42982
44935
|
{ },
|
|
42983
|
-
{ '
|
|
44936
|
+
{ 'retentionThresholdDays': retentionThresholdDays,'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
|
|
42984
44937
|
{ },
|
|
42985
44938
|
{ },
|
|
42986
44939
|
null,
|
|
@@ -43769,7 +45722,7 @@ class ResponseManagementApi {
|
|
|
43769
45722
|
/**
|
|
43770
45723
|
* ResponseManagement service.
|
|
43771
45724
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
43772
|
-
* @version
|
|
45725
|
+
* @version 147.0.0
|
|
43773
45726
|
*/
|
|
43774
45727
|
|
|
43775
45728
|
/**
|
|
@@ -44253,7 +46206,7 @@ class RoutingApi {
|
|
|
44253
46206
|
/**
|
|
44254
46207
|
* Routing service.
|
|
44255
46208
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
44256
|
-
* @version
|
|
46209
|
+
* @version 147.0.0
|
|
44257
46210
|
*/
|
|
44258
46211
|
|
|
44259
46212
|
/**
|
|
@@ -44819,6 +46772,26 @@ class RoutingApi {
|
|
|
44819
46772
|
);
|
|
44820
46773
|
}
|
|
44821
46774
|
|
|
46775
|
+
/**
|
|
46776
|
+
* Get available media types
|
|
46777
|
+
*
|
|
46778
|
+
*/
|
|
46779
|
+
getRoutingAvailablemediatypes() {
|
|
46780
|
+
|
|
46781
|
+
return this.apiClient.callApi(
|
|
46782
|
+
'/api/v2/routing/availablemediatypes',
|
|
46783
|
+
'GET',
|
|
46784
|
+
{ },
|
|
46785
|
+
{ },
|
|
46786
|
+
{ },
|
|
46787
|
+
{ },
|
|
46788
|
+
null,
|
|
46789
|
+
['PureCloud OAuth'],
|
|
46790
|
+
['application/json'],
|
|
46791
|
+
['application/json']
|
|
46792
|
+
);
|
|
46793
|
+
}
|
|
46794
|
+
|
|
44822
46795
|
/**
|
|
44823
46796
|
* Get domain
|
|
44824
46797
|
*
|
|
@@ -47174,7 +49147,7 @@ class SCIMApi {
|
|
|
47174
49147
|
/**
|
|
47175
49148
|
* SCIM service.
|
|
47176
49149
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
47177
|
-
* @version
|
|
49150
|
+
* @version 147.0.0
|
|
47178
49151
|
*/
|
|
47179
49152
|
|
|
47180
49153
|
/**
|
|
@@ -48051,7 +50024,7 @@ class ScriptsApi {
|
|
|
48051
50024
|
/**
|
|
48052
50025
|
* Scripts service.
|
|
48053
50026
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
48054
|
-
* @version
|
|
50027
|
+
* @version 147.0.0
|
|
48055
50028
|
*/
|
|
48056
50029
|
|
|
48057
50030
|
/**
|
|
@@ -48470,7 +50443,7 @@ class SearchApi {
|
|
|
48470
50443
|
/**
|
|
48471
50444
|
* Search service.
|
|
48472
50445
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
48473
|
-
* @version
|
|
50446
|
+
* @version 147.0.0
|
|
48474
50447
|
*/
|
|
48475
50448
|
|
|
48476
50449
|
/**
|
|
@@ -49030,7 +51003,7 @@ class SpeechTextAnalyticsApi {
|
|
|
49030
51003
|
/**
|
|
49031
51004
|
* SpeechTextAnalytics service.
|
|
49032
51005
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
49033
|
-
* @version
|
|
51006
|
+
* @version 147.0.0
|
|
49034
51007
|
*/
|
|
49035
51008
|
|
|
49036
51009
|
/**
|
|
@@ -49884,7 +51857,7 @@ class StationsApi {
|
|
|
49884
51857
|
/**
|
|
49885
51858
|
* Stations service.
|
|
49886
51859
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
49887
|
-
* @version
|
|
51860
|
+
* @version 147.0.0
|
|
49888
51861
|
*/
|
|
49889
51862
|
|
|
49890
51863
|
/**
|
|
@@ -50031,7 +52004,7 @@ class SuggestApi {
|
|
|
50031
52004
|
/**
|
|
50032
52005
|
* Suggest service.
|
|
50033
52006
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
50034
|
-
* @version
|
|
52007
|
+
* @version 147.0.0
|
|
50035
52008
|
*/
|
|
50036
52009
|
|
|
50037
52010
|
/**
|
|
@@ -50170,7 +52143,7 @@ class TeamsApi {
|
|
|
50170
52143
|
/**
|
|
50171
52144
|
* Teams service.
|
|
50172
52145
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
50173
|
-
* @version
|
|
52146
|
+
* @version 147.0.0
|
|
50174
52147
|
*/
|
|
50175
52148
|
|
|
50176
52149
|
/**
|
|
@@ -50349,7 +52322,7 @@ class TelephonyApi {
|
|
|
50349
52322
|
/**
|
|
50350
52323
|
* Telephony service.
|
|
50351
52324
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
50352
|
-
* @version
|
|
52325
|
+
* @version 147.0.0
|
|
50353
52326
|
*/
|
|
50354
52327
|
|
|
50355
52328
|
/**
|
|
@@ -50457,7 +52430,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
50457
52430
|
/**
|
|
50458
52431
|
* TelephonyProvidersEdge service.
|
|
50459
52432
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
50460
|
-
* @version
|
|
52433
|
+
* @version 147.0.0
|
|
50461
52434
|
*/
|
|
50462
52435
|
|
|
50463
52436
|
/**
|
|
@@ -54090,7 +56063,7 @@ class TextbotsApi {
|
|
|
54090
56063
|
/**
|
|
54091
56064
|
* Textbots service.
|
|
54092
56065
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
54093
|
-
* @version
|
|
56066
|
+
* @version 147.0.0
|
|
54094
56067
|
*/
|
|
54095
56068
|
|
|
54096
56069
|
/**
|
|
@@ -54218,7 +56191,7 @@ class TokensApi {
|
|
|
54218
56191
|
/**
|
|
54219
56192
|
* Tokens service.
|
|
54220
56193
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
54221
|
-
* @version
|
|
56194
|
+
* @version 147.0.0
|
|
54222
56195
|
*/
|
|
54223
56196
|
|
|
54224
56197
|
/**
|
|
@@ -54324,7 +56297,7 @@ class UploadsApi {
|
|
|
54324
56297
|
/**
|
|
54325
56298
|
* Uploads service.
|
|
54326
56299
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
54327
|
-
* @version
|
|
56300
|
+
* @version 147.0.0
|
|
54328
56301
|
*/
|
|
54329
56302
|
|
|
54330
56303
|
/**
|
|
@@ -54500,7 +56473,7 @@ class UsageApi {
|
|
|
54500
56473
|
/**
|
|
54501
56474
|
* Usage service.
|
|
54502
56475
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
54503
|
-
* @version
|
|
56476
|
+
* @version 147.0.0
|
|
54504
56477
|
*/
|
|
54505
56478
|
|
|
54506
56479
|
/**
|
|
@@ -54571,7 +56544,7 @@ class UserRecordingsApi {
|
|
|
54571
56544
|
/**
|
|
54572
56545
|
* UserRecordings service.
|
|
54573
56546
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
54574
|
-
* @version
|
|
56547
|
+
* @version 147.0.0
|
|
54575
56548
|
*/
|
|
54576
56549
|
|
|
54577
56550
|
/**
|
|
@@ -54755,7 +56728,7 @@ class UsersApi {
|
|
|
54755
56728
|
/**
|
|
54756
56729
|
* Users service.
|
|
54757
56730
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
54758
|
-
* @version
|
|
56731
|
+
* @version 147.0.0
|
|
54759
56732
|
*/
|
|
54760
56733
|
|
|
54761
56734
|
/**
|
|
@@ -56497,6 +58470,36 @@ class UsersApi {
|
|
|
56497
58470
|
);
|
|
56498
58471
|
}
|
|
56499
58472
|
|
|
58473
|
+
/**
|
|
58474
|
+
* Create mapping between external identifier and user. Limit 100 per entity.
|
|
58475
|
+
* Authority Name and External key are case sensitive.
|
|
58476
|
+
* @param {String} userId User ID
|
|
58477
|
+
* @param {Object} body
|
|
58478
|
+
*/
|
|
58479
|
+
postUserExternalid(userId, body) {
|
|
58480
|
+
// verify the required parameter 'userId' is set
|
|
58481
|
+
if (userId === undefined || userId === null) {
|
|
58482
|
+
throw 'Missing the required parameter "userId" when calling postUserExternalid';
|
|
58483
|
+
}
|
|
58484
|
+
// verify the required parameter 'body' is set
|
|
58485
|
+
if (body === undefined || body === null) {
|
|
58486
|
+
throw 'Missing the required parameter "body" when calling postUserExternalid';
|
|
58487
|
+
}
|
|
58488
|
+
|
|
58489
|
+
return this.apiClient.callApi(
|
|
58490
|
+
'/api/v2/users/{userId}/externalid',
|
|
58491
|
+
'POST',
|
|
58492
|
+
{ 'userId': userId },
|
|
58493
|
+
{ },
|
|
58494
|
+
{ },
|
|
58495
|
+
{ },
|
|
58496
|
+
body,
|
|
58497
|
+
['PureCloud OAuth'],
|
|
58498
|
+
['application/json'],
|
|
58499
|
+
['application/json']
|
|
58500
|
+
);
|
|
58501
|
+
}
|
|
58502
|
+
|
|
56500
58503
|
/**
|
|
56501
58504
|
* Send an activation email to the user
|
|
56502
58505
|
*
|
|
@@ -56618,7 +58621,7 @@ class UsersApi {
|
|
|
56618
58621
|
|
|
56619
58622
|
/**
|
|
56620
58623
|
* Create user
|
|
56621
|
-
*
|
|
58624
|
+
* 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.
|
|
56622
58625
|
* @param {Object} body User
|
|
56623
58626
|
*/
|
|
56624
58627
|
postUsers(body) {
|
|
@@ -57057,7 +59060,7 @@ class UtilitiesApi {
|
|
|
57057
59060
|
/**
|
|
57058
59061
|
* Utilities service.
|
|
57059
59062
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
57060
|
-
* @version
|
|
59063
|
+
* @version 147.0.0
|
|
57061
59064
|
*/
|
|
57062
59065
|
|
|
57063
59066
|
/**
|
|
@@ -57168,7 +59171,7 @@ class VoicemailApi {
|
|
|
57168
59171
|
/**
|
|
57169
59172
|
* Voicemail service.
|
|
57170
59173
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
57171
|
-
* @version
|
|
59174
|
+
* @version 147.0.0
|
|
57172
59175
|
*/
|
|
57173
59176
|
|
|
57174
59177
|
/**
|
|
@@ -57835,7 +59838,7 @@ class WebChatApi {
|
|
|
57835
59838
|
/**
|
|
57836
59839
|
* WebChat service.
|
|
57837
59840
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
57838
|
-
* @version
|
|
59841
|
+
* @version 147.0.0
|
|
57839
59842
|
*/
|
|
57840
59843
|
|
|
57841
59844
|
/**
|
|
@@ -58379,7 +60382,7 @@ class WebDeploymentsApi {
|
|
|
58379
60382
|
/**
|
|
58380
60383
|
* WebDeployments service.
|
|
58381
60384
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
58382
|
-
* @version
|
|
60385
|
+
* @version 147.0.0
|
|
58383
60386
|
*/
|
|
58384
60387
|
|
|
58385
60388
|
/**
|
|
@@ -58573,6 +60576,35 @@ class WebDeploymentsApi {
|
|
|
58573
60576
|
);
|
|
58574
60577
|
}
|
|
58575
60578
|
|
|
60579
|
+
/**
|
|
60580
|
+
* Get active configuration for a given deployment
|
|
60581
|
+
*
|
|
60582
|
+
* @param {String} deploymentId The deployment ID
|
|
60583
|
+
* @param {Object} opts Optional parameters
|
|
60584
|
+
* @param {String} opts.type Get active configuration on a deployment
|
|
60585
|
+
*/
|
|
60586
|
+
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
60587
|
+
opts = opts || {};
|
|
60588
|
+
|
|
60589
|
+
// verify the required parameter 'deploymentId' is set
|
|
60590
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
60591
|
+
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';
|
|
60592
|
+
}
|
|
60593
|
+
|
|
60594
|
+
return this.apiClient.callApi(
|
|
60595
|
+
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
60596
|
+
'GET',
|
|
60597
|
+
{ 'deploymentId': deploymentId },
|
|
60598
|
+
{ 'type': opts['type'] },
|
|
60599
|
+
{ },
|
|
60600
|
+
{ },
|
|
60601
|
+
null,
|
|
60602
|
+
['PureCloud OAuth'],
|
|
60603
|
+
['application/json'],
|
|
60604
|
+
['application/json']
|
|
60605
|
+
);
|
|
60606
|
+
}
|
|
60607
|
+
|
|
58576
60608
|
/**
|
|
58577
60609
|
* Get deployments
|
|
58578
60610
|
*
|
|
@@ -58734,7 +60766,7 @@ class WebMessagingApi {
|
|
|
58734
60766
|
/**
|
|
58735
60767
|
* WebMessaging service.
|
|
58736
60768
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
58737
|
-
* @version
|
|
60769
|
+
* @version 147.0.0
|
|
58738
60770
|
*/
|
|
58739
60771
|
|
|
58740
60772
|
/**
|
|
@@ -58780,7 +60812,7 @@ class WidgetsApi {
|
|
|
58780
60812
|
/**
|
|
58781
60813
|
* Widgets service.
|
|
58782
60814
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
58783
|
-
* @version
|
|
60815
|
+
* @version 147.0.0
|
|
58784
60816
|
*/
|
|
58785
60817
|
|
|
58786
60818
|
/**
|
|
@@ -58926,7 +60958,7 @@ class WorkforceManagementApi {
|
|
|
58926
60958
|
/**
|
|
58927
60959
|
* WorkforceManagement service.
|
|
58928
60960
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
58929
|
-
* @version
|
|
60961
|
+
* @version 147.0.0
|
|
58930
60962
|
*/
|
|
58931
60963
|
|
|
58932
60964
|
/**
|
|
@@ -63202,7 +65234,7 @@ class WorkforceManagementApi {
|
|
|
63202
65234
|
* </pre>
|
|
63203
65235
|
* </p>
|
|
63204
65236
|
* @module purecloud-platform-client-v2/index
|
|
63205
|
-
* @version
|
|
65237
|
+
* @version 147.0.0
|
|
63206
65238
|
*/
|
|
63207
65239
|
class platformClient {
|
|
63208
65240
|
constructor() {
|