purecloud-platform-client-v2 169.0.0 → 170.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 +6 -4
- package/dist/node/purecloud-platform-client-v2.js +25367 -20288
- package/dist/web-amd/purecloud-platform-client-v2.js +25367 -20288
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +25367 -20288
- package/dist/web-cjs/purecloud-platform-client-v2.js +25367 -20288
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +2519 -31
- 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 +1418 -227
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +142 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +526 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.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 +114 -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 +114 -4
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +363 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +224 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +200 -22
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
- 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 +6 -6
- 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 +8 -8
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +53 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +189 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +174 -10
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +199 -6
- 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 +80 -2
- 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/TaskManagementApi.js +1286 -0
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +32 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +34 -3
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +47 -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 +172 -7
- 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 +6 -6
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class KnowledgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Knowledge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -236,7 +236,7 @@ class KnowledgeApi {
|
|
|
236
236
|
* @param {String} categoryId Category ID
|
|
237
237
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
238
238
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
239
|
-
|
|
239
|
+
* @deprecated
|
|
240
240
|
*/
|
|
241
241
|
deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
242
242
|
// verify the required parameter 'categoryId' is set
|
|
@@ -272,7 +272,7 @@ class KnowledgeApi {
|
|
|
272
272
|
* @param {String} documentId Document ID
|
|
273
273
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
274
274
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
275
|
-
|
|
275
|
+
* @deprecated
|
|
276
276
|
*/
|
|
277
277
|
deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
278
278
|
// verify the required parameter 'documentId' is set
|
|
@@ -308,7 +308,7 @@ class KnowledgeApi {
|
|
|
308
308
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
309
309
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
310
310
|
* @param {String} importId Import ID
|
|
311
|
-
|
|
311
|
+
* @deprecated
|
|
312
312
|
*/
|
|
313
313
|
deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
314
314
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -810,6 +810,7 @@ class KnowledgeApi {
|
|
|
810
810
|
* @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
|
|
811
811
|
* @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
|
|
812
812
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
813
|
+
* @param {Array.<String>} opts.externalIds If specified, retrieves documents associated with external ids, comma separated values expected.
|
|
813
814
|
*/
|
|
814
815
|
getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
|
|
815
816
|
opts = opts || {};
|
|
@@ -823,7 +824,7 @@ class KnowledgeApi {
|
|
|
823
824
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
|
|
824
825
|
'GET',
|
|
825
826
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
826
|
-
{ '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') },
|
|
827
|
+
{ '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'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
|
|
827
828
|
{ },
|
|
828
829
|
{ },
|
|
829
830
|
null,
|
|
@@ -967,7 +968,7 @@ class KnowledgeApi {
|
|
|
967
968
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
968
969
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
969
970
|
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
970
|
-
|
|
971
|
+
* @deprecated
|
|
971
972
|
*/
|
|
972
973
|
getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
|
|
973
974
|
opts = opts || {};
|
|
@@ -1001,7 +1002,7 @@ class KnowledgeApi {
|
|
|
1001
1002
|
* @param {String} categoryId Category ID
|
|
1002
1003
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1003
1004
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1004
|
-
|
|
1005
|
+
* @deprecated
|
|
1005
1006
|
*/
|
|
1006
1007
|
getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
1007
1008
|
// verify the required parameter 'categoryId' is set
|
|
@@ -1037,7 +1038,7 @@ class KnowledgeApi {
|
|
|
1037
1038
|
* @param {String} documentId Document ID
|
|
1038
1039
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1039
1040
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1040
|
-
|
|
1041
|
+
* @deprecated
|
|
1041
1042
|
*/
|
|
1042
1043
|
getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
1043
1044
|
// verify the required parameter 'documentId' is set
|
|
@@ -1067,6 +1068,48 @@ class KnowledgeApi {
|
|
|
1067
1068
|
);
|
|
1068
1069
|
}
|
|
1069
1070
|
|
|
1071
|
+
/**
|
|
1072
|
+
* Get document content upload status
|
|
1073
|
+
*
|
|
1074
|
+
* @param {String} documentId Document ID
|
|
1075
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1076
|
+
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1077
|
+
* @param {String} uploadId UploadId
|
|
1078
|
+
* @deprecated
|
|
1079
|
+
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1080
|
+
*/
|
|
1081
|
+
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
1082
|
+
// verify the required parameter 'documentId' is set
|
|
1083
|
+
if (documentId === undefined || documentId === null) {
|
|
1084
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
1085
|
+
}
|
|
1086
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
1087
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
1088
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
1089
|
+
}
|
|
1090
|
+
// verify the required parameter 'languageCode' is set
|
|
1091
|
+
if (languageCode === undefined || languageCode === null) {
|
|
1092
|
+
throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
1093
|
+
}
|
|
1094
|
+
// verify the required parameter 'uploadId' is set
|
|
1095
|
+
if (uploadId === undefined || uploadId === null) {
|
|
1096
|
+
throw 'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
|
|
1097
|
+
}
|
|
1098
|
+
|
|
1099
|
+
return this.apiClient.callApi(
|
|
1100
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}',
|
|
1101
|
+
'GET',
|
|
1102
|
+
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'uploadId': uploadId },
|
|
1103
|
+
{ },
|
|
1104
|
+
{ },
|
|
1105
|
+
{ },
|
|
1106
|
+
null,
|
|
1107
|
+
['PureCloud OAuth'],
|
|
1108
|
+
['application/json'],
|
|
1109
|
+
['application/json']
|
|
1110
|
+
);
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1070
1113
|
/**
|
|
1071
1114
|
* Get documents
|
|
1072
1115
|
*
|
|
@@ -1082,7 +1125,7 @@ class KnowledgeApi {
|
|
|
1082
1125
|
* @param {Object} opts.sortBy Sort by.
|
|
1083
1126
|
* @param {Object} opts.sortOrder Sort Order.
|
|
1084
1127
|
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
1085
|
-
|
|
1128
|
+
* @deprecated
|
|
1086
1129
|
*/
|
|
1087
1130
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
1088
1131
|
opts = opts || {};
|
|
@@ -1116,7 +1159,7 @@ class KnowledgeApi {
|
|
|
1116
1159
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1117
1160
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1118
1161
|
* @param {String} importId Import ID
|
|
1119
|
-
|
|
1162
|
+
* @deprecated
|
|
1120
1163
|
*/
|
|
1121
1164
|
getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
1122
1165
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -1152,7 +1195,7 @@ class KnowledgeApi {
|
|
|
1152
1195
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1153
1196
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1154
1197
|
* @param {String} trainingId Training ID
|
|
1155
|
-
|
|
1198
|
+
* @deprecated
|
|
1156
1199
|
*/
|
|
1157
1200
|
getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
|
|
1158
1201
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -1193,7 +1236,7 @@ class KnowledgeApi {
|
|
|
1193
1236
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
1194
1237
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
1195
1238
|
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
1196
|
-
|
|
1239
|
+
* @deprecated
|
|
1197
1240
|
*/
|
|
1198
1241
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
1199
1242
|
opts = opts || {};
|
|
@@ -1641,7 +1684,7 @@ class KnowledgeApi {
|
|
|
1641
1684
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1642
1685
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1643
1686
|
* @param {Object} body
|
|
1644
|
-
|
|
1687
|
+
* @deprecated
|
|
1645
1688
|
*/
|
|
1646
1689
|
patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
|
|
1647
1690
|
// verify the required parameter 'categoryId' is set
|
|
@@ -1682,7 +1725,7 @@ class KnowledgeApi {
|
|
|
1682
1725
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1683
1726
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1684
1727
|
* @param {Object} body
|
|
1685
|
-
|
|
1728
|
+
* @deprecated
|
|
1686
1729
|
*/
|
|
1687
1730
|
patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
|
|
1688
1731
|
// verify the required parameter 'documentId' is set
|
|
@@ -1722,7 +1765,7 @@ class KnowledgeApi {
|
|
|
1722
1765
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1723
1766
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1724
1767
|
* @param {Array.<Object>} body
|
|
1725
|
-
|
|
1768
|
+
* @deprecated
|
|
1726
1769
|
*/
|
|
1727
1770
|
patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
1728
1771
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -1759,7 +1802,7 @@ class KnowledgeApi {
|
|
|
1759
1802
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1760
1803
|
* @param {String} importId Import ID
|
|
1761
1804
|
* @param {Object} body
|
|
1762
|
-
|
|
1805
|
+
* @deprecated
|
|
1763
1806
|
*/
|
|
1764
1807
|
patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
|
|
1765
1808
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2072,6 +2115,68 @@ class KnowledgeApi {
|
|
|
2072
2115
|
);
|
|
2073
2116
|
}
|
|
2074
2117
|
|
|
2118
|
+
/**
|
|
2119
|
+
* Bulk remove documents.
|
|
2120
|
+
*
|
|
2121
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2122
|
+
* @param {Object} body
|
|
2123
|
+
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2124
|
+
*/
|
|
2125
|
+
postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
|
|
2126
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
2127
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
2128
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';
|
|
2129
|
+
}
|
|
2130
|
+
// verify the required parameter 'body' is set
|
|
2131
|
+
if (body === undefined || body === null) {
|
|
2132
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';
|
|
2133
|
+
}
|
|
2134
|
+
|
|
2135
|
+
return this.apiClient.callApi(
|
|
2136
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove',
|
|
2137
|
+
'POST',
|
|
2138
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
2139
|
+
{ },
|
|
2140
|
+
{ },
|
|
2141
|
+
{ },
|
|
2142
|
+
body,
|
|
2143
|
+
['PureCloud OAuth'],
|
|
2144
|
+
['application/json'],
|
|
2145
|
+
['application/json']
|
|
2146
|
+
);
|
|
2147
|
+
}
|
|
2148
|
+
|
|
2149
|
+
/**
|
|
2150
|
+
* Bulk update documents.
|
|
2151
|
+
*
|
|
2152
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2153
|
+
* @param {Object} body
|
|
2154
|
+
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2155
|
+
*/
|
|
2156
|
+
postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
|
|
2157
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
2158
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
2159
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';
|
|
2160
|
+
}
|
|
2161
|
+
// verify the required parameter 'body' is set
|
|
2162
|
+
if (body === undefined || body === null) {
|
|
2163
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';
|
|
2164
|
+
}
|
|
2165
|
+
|
|
2166
|
+
return this.apiClient.callApi(
|
|
2167
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update',
|
|
2168
|
+
'POST',
|
|
2169
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
2170
|
+
{ },
|
|
2171
|
+
{ },
|
|
2172
|
+
{ },
|
|
2173
|
+
body,
|
|
2174
|
+
['PureCloud OAuth'],
|
|
2175
|
+
['application/json'],
|
|
2176
|
+
['application/json']
|
|
2177
|
+
);
|
|
2178
|
+
}
|
|
2179
|
+
|
|
2075
2180
|
/**
|
|
2076
2181
|
* Search the documents in a knowledge base.
|
|
2077
2182
|
*
|
|
@@ -2131,6 +2236,37 @@ class KnowledgeApi {
|
|
|
2131
2236
|
);
|
|
2132
2237
|
}
|
|
2133
2238
|
|
|
2239
|
+
/**
|
|
2240
|
+
* Bulk add document versions.
|
|
2241
|
+
*
|
|
2242
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2243
|
+
* @param {Object} body
|
|
2244
|
+
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2245
|
+
*/
|
|
2246
|
+
postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
|
|
2247
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
2248
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
2249
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';
|
|
2250
|
+
}
|
|
2251
|
+
// verify the required parameter 'body' is set
|
|
2252
|
+
if (body === undefined || body === null) {
|
|
2253
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';
|
|
2254
|
+
}
|
|
2255
|
+
|
|
2256
|
+
return this.apiClient.callApi(
|
|
2257
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add',
|
|
2258
|
+
'POST',
|
|
2259
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
2260
|
+
{ },
|
|
2261
|
+
{ },
|
|
2262
|
+
{ },
|
|
2263
|
+
body,
|
|
2264
|
+
['PureCloud OAuth'],
|
|
2265
|
+
['application/json'],
|
|
2266
|
+
['application/json']
|
|
2267
|
+
);
|
|
2268
|
+
}
|
|
2269
|
+
|
|
2134
2270
|
/**
|
|
2135
2271
|
* Create export job
|
|
2136
2272
|
*
|
|
@@ -2227,7 +2363,7 @@ class KnowledgeApi {
|
|
|
2227
2363
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2228
2364
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
2229
2365
|
* @param {Object} body
|
|
2230
|
-
|
|
2366
|
+
* @deprecated
|
|
2231
2367
|
*/
|
|
2232
2368
|
postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
|
|
2233
2369
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2257,13 +2393,55 @@ class KnowledgeApi {
|
|
|
2257
2393
|
);
|
|
2258
2394
|
}
|
|
2259
2395
|
|
|
2396
|
+
/**
|
|
2397
|
+
* Upload Article Content
|
|
2398
|
+
*
|
|
2399
|
+
* @param {String} documentId Document ID
|
|
2400
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2401
|
+
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
2402
|
+
* @param {Object} body
|
|
2403
|
+
* @deprecated
|
|
2404
|
+
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2405
|
+
*/
|
|
2406
|
+
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
2407
|
+
// verify the required parameter 'documentId' is set
|
|
2408
|
+
if (documentId === undefined || documentId === null) {
|
|
2409
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
2410
|
+
}
|
|
2411
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
2412
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
2413
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
2414
|
+
}
|
|
2415
|
+
// verify the required parameter 'languageCode' is set
|
|
2416
|
+
if (languageCode === undefined || languageCode === null) {
|
|
2417
|
+
throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
2418
|
+
}
|
|
2419
|
+
// verify the required parameter 'body' is set
|
|
2420
|
+
if (body === undefined || body === null) {
|
|
2421
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
|
|
2422
|
+
}
|
|
2423
|
+
|
|
2424
|
+
return this.apiClient.callApi(
|
|
2425
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads',
|
|
2426
|
+
'POST',
|
|
2427
|
+
{ 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
2428
|
+
{ },
|
|
2429
|
+
{ },
|
|
2430
|
+
{ },
|
|
2431
|
+
body,
|
|
2432
|
+
['PureCloud OAuth'],
|
|
2433
|
+
['application/json'],
|
|
2434
|
+
['application/json']
|
|
2435
|
+
);
|
|
2436
|
+
}
|
|
2437
|
+
|
|
2260
2438
|
/**
|
|
2261
2439
|
* Create document
|
|
2262
2440
|
*
|
|
2263
2441
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2264
2442
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
2265
2443
|
* @param {Object} body
|
|
2266
|
-
|
|
2444
|
+
* @deprecated
|
|
2267
2445
|
*/
|
|
2268
2446
|
postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
2269
2447
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2299,7 +2477,7 @@ class KnowledgeApi {
|
|
|
2299
2477
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2300
2478
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
2301
2479
|
* @param {Object} body
|
|
2302
|
-
|
|
2480
|
+
* @deprecated
|
|
2303
2481
|
*/
|
|
2304
2482
|
postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
|
|
2305
2483
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2335,7 +2513,7 @@ class KnowledgeApi {
|
|
|
2335
2513
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2336
2514
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
2337
2515
|
* @param {String} trainingId Training ID
|
|
2338
|
-
|
|
2516
|
+
* @deprecated
|
|
2339
2517
|
*/
|
|
2340
2518
|
postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
|
|
2341
2519
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2370,7 +2548,7 @@ class KnowledgeApi {
|
|
|
2370
2548
|
*
|
|
2371
2549
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2372
2550
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
2373
|
-
|
|
2551
|
+
* @deprecated
|
|
2374
2552
|
*/
|
|
2375
2553
|
postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
|
|
2376
2554
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2402,7 +2580,7 @@ class KnowledgeApi {
|
|
|
2402
2580
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2403
2581
|
* @param {Object} opts Optional parameters
|
|
2404
2582
|
* @param {Object} opts.body
|
|
2405
|
-
|
|
2583
|
+
* @deprecated
|
|
2406
2584
|
*/
|
|
2407
2585
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
2408
2586
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class LanguagesApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Languages service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class LanguagesApi {
|
|
|
24
24
|
* Delete Language (Deprecated)
|
|
25
25
|
* This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
|
|
26
26
|
* @param {String} languageId Language ID
|
|
27
|
-
|
|
27
|
+
* @deprecated
|
|
28
28
|
*/
|
|
29
29
|
deleteLanguage(languageId) {
|
|
30
30
|
// verify the required parameter 'languageId' is set
|
|
@@ -50,7 +50,7 @@ class LanguagesApi {
|
|
|
50
50
|
* Get Language (Deprecated)
|
|
51
51
|
* This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
|
|
52
52
|
* @param {String} languageId Language ID
|
|
53
|
-
|
|
53
|
+
* @deprecated
|
|
54
54
|
*/
|
|
55
55
|
getLanguage(languageId) {
|
|
56
56
|
// verify the required parameter 'languageId' is set
|
|
@@ -80,7 +80,7 @@ class LanguagesApi {
|
|
|
80
80
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
81
81
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
82
82
|
* @param {String} opts.name Name
|
|
83
|
-
|
|
83
|
+
* @deprecated
|
|
84
84
|
*/
|
|
85
85
|
getLanguages(opts) {
|
|
86
86
|
opts = opts || {};
|
|
@@ -199,7 +199,7 @@ class LanguagesApi {
|
|
|
199
199
|
* Create Language (Deprecated)
|
|
200
200
|
* This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
|
|
201
201
|
* @param {Object} body Language
|
|
202
|
-
|
|
202
|
+
* @deprecated
|
|
203
203
|
*/
|
|
204
204
|
postLanguages(body) {
|
|
205
205
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class MessagingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Messaging service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class MessagingApi {
|
|
|
24
24
|
* Delete a supported content profile
|
|
25
25
|
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
26
26
|
* @param {String} supportedContentId Supported Content ID
|
|
27
|
-
|
|
27
|
+
* @deprecated
|
|
28
28
|
*/
|
|
29
29
|
deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
30
30
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -52,7 +52,7 @@ class MessagingApi {
|
|
|
52
52
|
* @param {Object} opts Optional parameters
|
|
53
53
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
54
54
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
55
|
-
|
|
55
|
+
* @deprecated
|
|
56
56
|
*/
|
|
57
57
|
getMessagingSupportedcontent(opts) {
|
|
58
58
|
opts = opts || {};
|
|
@@ -76,7 +76,7 @@ class MessagingApi {
|
|
|
76
76
|
* Get a supported content profile
|
|
77
77
|
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
78
78
|
* @param {String} supportedContentId Supported Content ID
|
|
79
|
-
|
|
79
|
+
* @deprecated
|
|
80
80
|
*/
|
|
81
81
|
getMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
82
82
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -103,7 +103,7 @@ class MessagingApi {
|
|
|
103
103
|
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
104
104
|
* @param {String} supportedContentId Supported Content ID
|
|
105
105
|
* @param {Object} body SupportedContent
|
|
106
|
-
|
|
106
|
+
* @deprecated
|
|
107
107
|
*/
|
|
108
108
|
patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
|
|
109
109
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -133,7 +133,7 @@ class MessagingApi {
|
|
|
133
133
|
* Create a Supported Content profile
|
|
134
134
|
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
135
135
|
* @param {Object} body SupportedContent
|
|
136
|
-
|
|
136
|
+
* @deprecated
|
|
137
137
|
*/
|
|
138
138
|
postMessagingSupportedcontent(body) {
|
|
139
139
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class OrganizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Organization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class OrganizationApi {
|
|
|
24
24
|
* Fetch field config for an entity type
|
|
25
25
|
*
|
|
26
26
|
* @param {Object} type Field type
|
|
27
|
-
|
|
27
|
+
* @deprecated
|
|
28
28
|
*/
|
|
29
29
|
getFieldconfig(type) {
|
|
30
30
|
// verify the required parameter 'type' is set
|
|
@@ -69,7 +69,7 @@ class OrganizationApi {
|
|
|
69
69
|
/**
|
|
70
70
|
* Get the list of domains that will be allowed to embed PureCloud applications
|
|
71
71
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
72
|
-
|
|
72
|
+
* @deprecated
|
|
73
73
|
*/
|
|
74
74
|
getOrganizationsEmbeddedintegration() {
|
|
75
75
|
|
|
@@ -90,7 +90,7 @@ class OrganizationApi {
|
|
|
90
90
|
/**
|
|
91
91
|
* Get organization IP address whitelist settings
|
|
92
92
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
93
|
-
|
|
93
|
+
* @deprecated
|
|
94
94
|
*/
|
|
95
95
|
getOrganizationsIpaddressauthentication() {
|
|
96
96
|
|
|
@@ -279,7 +279,7 @@ class OrganizationApi {
|
|
|
279
279
|
/**
|
|
280
280
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
281
281
|
*
|
|
282
|
-
|
|
282
|
+
* @deprecated
|
|
283
283
|
*/
|
|
284
284
|
getOrganizationsWhitelist() {
|
|
285
285
|
|
|
@@ -356,7 +356,7 @@ class OrganizationApi {
|
|
|
356
356
|
* Update the list of domains that will be allowed to embed PureCloud applications
|
|
357
357
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
358
358
|
* @param {Object} body Whitelist settings
|
|
359
|
-
|
|
359
|
+
* @deprecated
|
|
360
360
|
*/
|
|
361
361
|
putOrganizationsEmbeddedintegration(body) {
|
|
362
362
|
// verify the required parameter 'body' is set
|
|
@@ -382,7 +382,7 @@ class OrganizationApi {
|
|
|
382
382
|
* Update organization IP address whitelist settings
|
|
383
383
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
384
384
|
* @param {Object} body IP address Whitelist settings
|
|
385
|
-
|
|
385
|
+
* @deprecated
|
|
386
386
|
*/
|
|
387
387
|
putOrganizationsIpaddressauthentication(body) {
|
|
388
388
|
// verify the required parameter 'body' is set
|
|
@@ -432,7 +432,7 @@ class OrganizationApi {
|
|
|
432
432
|
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
433
433
|
*
|
|
434
434
|
* @param {Object} body Whitelist settings
|
|
435
|
-
|
|
435
|
+
* @deprecated
|
|
436
436
|
*/
|
|
437
437
|
putOrganizationsWhitelist(body) {
|
|
438
438
|
// verify the required parameter 'body' is set
|