purecloud-platform-client-v2 233.0.0 → 235.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.
Files changed (93) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +503 -1079
  3. package/dist/web-amd/purecloud-platform-client-v2.js +503 -1079
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +233 -409
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +233 -409
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +475 -382
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +45 -1
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -30
  22. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CoachingApi.js +51 -1
  25. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +42 -8
  27. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GamificationApi.js +46 -1
  37. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +61 -880
  46. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LearningApi.js +51 -1
  49. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
  61. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -107
  64. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/RoutingApi.js +156 -1
  67. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -31
  71. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +7 -3
  73. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
  90. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +3 -2
  93. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class KnowledgeApi {
5
5
  /**
6
6
  * Knowledge service.
7
7
  * @module purecloud-platform-client-v2/api/KnowledgeApi
8
- * @version 233.0.0
8
+ * @version 235.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -230,114 +230,6 @@ class KnowledgeApi {
230
230
  );
231
231
  }
232
232
 
233
- /**
234
- * Delete category
235
- *
236
- * @param {String} categoryId Category ID
237
- * @param {String} knowledgeBaseId Knowledge base ID
238
- * @param {Object} languageCode Language code, format: iso2-LOCALE
239
- * @deprecated
240
- */
241
- deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
242
- // verify the required parameter 'categoryId' is set
243
- if (categoryId === undefined || categoryId === null || categoryId === '') {
244
- throw 'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
245
- }
246
- // verify the required parameter 'knowledgeBaseId' is set
247
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
248
- throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
249
- }
250
- // verify the required parameter 'languageCode' is set
251
- if (languageCode === undefined || languageCode === null || languageCode === '') {
252
- throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageCategory';
253
- }
254
-
255
- return this.apiClient.callApi(
256
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
257
- 'DELETE',
258
- { 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
259
- { },
260
- { },
261
- { },
262
- null,
263
- ['PureCloud OAuth'],
264
- ['application/json'],
265
- ['application/json']
266
- );
267
- }
268
-
269
- /**
270
- * Delete document
271
- *
272
- * @param {String} documentId Document ID
273
- * @param {String} knowledgeBaseId Knowledge base ID
274
- * @param {Object} languageCode Language code, format: iso2-LOCALE
275
- * @deprecated
276
- */
277
- deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
278
- // verify the required parameter 'documentId' is set
279
- if (documentId === undefined || documentId === null || documentId === '') {
280
- throw 'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
281
- }
282
- // verify the required parameter 'knowledgeBaseId' is set
283
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
284
- throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
285
- }
286
- // verify the required parameter 'languageCode' is set
287
- if (languageCode === undefined || languageCode === null || languageCode === '') {
288
- throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocument';
289
- }
290
-
291
- return this.apiClient.callApi(
292
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
293
- 'DELETE',
294
- { 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
295
- { },
296
- { },
297
- { },
298
- null,
299
- ['PureCloud OAuth'],
300
- ['application/json'],
301
- ['application/json']
302
- );
303
- }
304
-
305
- /**
306
- * Delete import operation
307
- *
308
- * @param {String} knowledgeBaseId Knowledge base ID
309
- * @param {Object} languageCode Language code, format: iso2-LOCALE
310
- * @param {String} importId Import ID
311
- * @deprecated
312
- */
313
- deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
314
- // verify the required parameter 'knowledgeBaseId' is set
315
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
316
- throw 'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
317
- }
318
- // verify the required parameter 'languageCode' is set
319
- if (languageCode === undefined || languageCode === null || languageCode === '') {
320
- throw 'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
321
- }
322
- // verify the required parameter 'importId' is set
323
- if (importId === undefined || importId === null || importId === '') {
324
- throw 'Missing the required parameter "importId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';
325
- }
326
-
327
- return this.apiClient.callApi(
328
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
329
- 'DELETE',
330
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
331
- { },
332
- { },
333
- { },
334
- null,
335
- ['PureCloud OAuth'],
336
- ['application/json'],
337
- ['application/json']
338
- );
339
- }
340
-
341
233
  /**
342
234
  * Delete Salesforce Knowledge integration source
343
235
  *
@@ -1161,312 +1053,6 @@ class KnowledgeApi {
1161
1053
  );
1162
1054
  }
1163
1055
 
1164
- /**
1165
- * Get categories
1166
- *
1167
- * @param {String} knowledgeBaseId Knowledge base ID
1168
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1169
- * @param {Object} opts Optional parameters
1170
- * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
1171
- * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
1172
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
1173
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
1174
- * @param {String} opts.name Filter to return the categories that starts with the given category name.
1175
- * @deprecated
1176
- */
1177
- getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
1178
- opts = opts || {};
1179
-
1180
- // verify the required parameter 'knowledgeBaseId' is set
1181
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1182
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategories';
1183
- }
1184
- // verify the required parameter 'languageCode' is set
1185
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1186
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategories';
1187
- }
1188
-
1189
- return this.apiClient.callApi(
1190
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories',
1191
- 'GET',
1192
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1193
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
1194
- { },
1195
- { },
1196
- null,
1197
- ['PureCloud OAuth'],
1198
- ['application/json'],
1199
- ['application/json']
1200
- );
1201
- }
1202
-
1203
- /**
1204
- * Get category
1205
- *
1206
- * @param {String} categoryId Category ID
1207
- * @param {String} knowledgeBaseId Knowledge base ID
1208
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1209
- * @deprecated
1210
- */
1211
- getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
1212
- // verify the required parameter 'categoryId' is set
1213
- if (categoryId === undefined || categoryId === null || categoryId === '') {
1214
- throw 'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseLanguageCategory';
1215
- }
1216
- // verify the required parameter 'knowledgeBaseId' is set
1217
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1218
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategory';
1219
- }
1220
- // verify the required parameter 'languageCode' is set
1221
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1222
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategory';
1223
- }
1224
-
1225
- return this.apiClient.callApi(
1226
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
1227
- 'GET',
1228
- { 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1229
- { },
1230
- { },
1231
- { },
1232
- null,
1233
- ['PureCloud OAuth'],
1234
- ['application/json'],
1235
- ['application/json']
1236
- );
1237
- }
1238
-
1239
- /**
1240
- * Get document
1241
- *
1242
- * @param {String} documentId Document ID
1243
- * @param {String} knowledgeBaseId Knowledge base ID
1244
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1245
- * @deprecated
1246
- */
1247
- getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
1248
- // verify the required parameter 'documentId' is set
1249
- if (documentId === undefined || documentId === null || documentId === '') {
1250
- throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocument';
1251
- }
1252
- // verify the required parameter 'knowledgeBaseId' is set
1253
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1254
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocument';
1255
- }
1256
- // verify the required parameter 'languageCode' is set
1257
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1258
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocument';
1259
- }
1260
-
1261
- return this.apiClient.callApi(
1262
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
1263
- 'GET',
1264
- { 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1265
- { },
1266
- { },
1267
- { },
1268
- null,
1269
- ['PureCloud OAuth'],
1270
- ['application/json'],
1271
- ['application/json']
1272
- );
1273
- }
1274
-
1275
- /**
1276
- * Get document content upload status
1277
- *
1278
- * @param {String} documentId Document ID
1279
- * @param {String} knowledgeBaseId Knowledge base ID
1280
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1281
- * @param {String} uploadId UploadId
1282
- * @deprecated
1283
- */
1284
- getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
1285
- // verify the required parameter 'documentId' is set
1286
- if (documentId === undefined || documentId === null || documentId === '') {
1287
- throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1288
- }
1289
- // verify the required parameter 'knowledgeBaseId' is set
1290
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1291
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1292
- }
1293
- // verify the required parameter 'languageCode' is set
1294
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1295
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1296
- }
1297
- // verify the required parameter 'uploadId' is set
1298
- if (uploadId === undefined || uploadId === null || uploadId === '') {
1299
- throw 'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';
1300
- }
1301
-
1302
- return this.apiClient.callApi(
1303
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}',
1304
- 'GET',
1305
- { 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'uploadId': uploadId },
1306
- { },
1307
- { },
1308
- { },
1309
- null,
1310
- ['PureCloud OAuth'],
1311
- ['application/json'],
1312
- ['application/json']
1313
- );
1314
- }
1315
-
1316
- /**
1317
- * Get documents
1318
- *
1319
- * @param {String} knowledgeBaseId Knowledge base ID
1320
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1321
- * @param {Object} opts Optional parameters
1322
- * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
1323
- * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
1324
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
1325
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
1326
- * @param {String} opts.categories Filter by categories ids, comma separated values expected.
1327
- * @param {String} opts.title Filter by document title.
1328
- * @param {Object} opts.sortBy Sort by.
1329
- * @param {Object} opts.sortOrder Sort Order.
1330
- * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
1331
- * @deprecated
1332
- */
1333
- getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
1334
- opts = opts || {};
1335
-
1336
- // verify the required parameter 'knowledgeBaseId' is set
1337
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1338
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocuments';
1339
- }
1340
- // verify the required parameter 'languageCode' is set
1341
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1342
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocuments';
1343
- }
1344
-
1345
- return this.apiClient.callApi(
1346
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
1347
- 'GET',
1348
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1349
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
1350
- { },
1351
- { },
1352
- null,
1353
- ['PureCloud OAuth'],
1354
- ['application/json'],
1355
- ['application/json']
1356
- );
1357
- }
1358
-
1359
- /**
1360
- * Get import operation report
1361
- *
1362
- * @param {String} knowledgeBaseId Knowledge base ID
1363
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1364
- * @param {String} importId Import ID
1365
- * @deprecated
1366
- */
1367
- getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
1368
- // verify the required parameter 'knowledgeBaseId' is set
1369
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1370
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
1371
- }
1372
- // verify the required parameter 'languageCode' is set
1373
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1374
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
1375
- }
1376
- // verify the required parameter 'importId' is set
1377
- if (importId === undefined || importId === null || importId === '') {
1378
- throw 'Missing the required parameter "importId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';
1379
- }
1380
-
1381
- return this.apiClient.callApi(
1382
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
1383
- 'GET',
1384
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
1385
- { },
1386
- { },
1387
- { },
1388
- null,
1389
- ['PureCloud OAuth'],
1390
- ['application/json'],
1391
- ['application/json']
1392
- );
1393
- }
1394
-
1395
- /**
1396
- * Get training detail
1397
- *
1398
- * @param {String} knowledgeBaseId Knowledge base ID
1399
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1400
- * @param {String} trainingId Training ID
1401
- * @deprecated
1402
- */
1403
- getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
1404
- // verify the required parameter 'knowledgeBaseId' is set
1405
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1406
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTraining';
1407
- }
1408
- // verify the required parameter 'languageCode' is set
1409
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1410
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTraining';
1411
- }
1412
- // verify the required parameter 'trainingId' is set
1413
- if (trainingId === undefined || trainingId === null || trainingId === '') {
1414
- throw 'Missing the required parameter "trainingId" when calling getKnowledgeKnowledgebaseLanguageTraining';
1415
- }
1416
-
1417
- return this.apiClient.callApi(
1418
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}',
1419
- 'GET',
1420
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'trainingId': trainingId },
1421
- { },
1422
- { },
1423
- { },
1424
- null,
1425
- ['PureCloud OAuth'],
1426
- ['application/json'],
1427
- ['application/json']
1428
- );
1429
- }
1430
-
1431
- /**
1432
- * Get all trainings information for a knowledgebase
1433
- *
1434
- * @param {String} knowledgeBaseId Knowledge base ID
1435
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1436
- * @param {Object} opts Optional parameters
1437
- * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
1438
- * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
1439
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
1440
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
1441
- * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
1442
- * @deprecated
1443
- */
1444
- getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
1445
- opts = opts || {};
1446
-
1447
- // verify the required parameter 'knowledgeBaseId' is set
1448
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
1449
- throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTrainings';
1450
- }
1451
- // verify the required parameter 'languageCode' is set
1452
- if (languageCode === undefined || languageCode === null || languageCode === '') {
1453
- throw 'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTrainings';
1454
- }
1455
-
1456
- return this.apiClient.callApi(
1457
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
1458
- 'GET',
1459
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1460
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
1461
- { },
1462
- { },
1463
- null,
1464
- ['PureCloud OAuth'],
1465
- ['application/json'],
1466
- ['application/json']
1467
- );
1468
- }
1469
-
1470
1056
  /**
1471
1057
  * Get operations
1472
1058
  *
@@ -2013,166 +1599,22 @@ class KnowledgeApi {
2013
1599
  throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
2014
1600
  }
2015
1601
  // verify the required parameter 'documentId' is set
2016
- if (documentId === undefined || documentId === null || documentId === '') {
2017
- throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
2018
- }
2019
- // verify the required parameter 'feedbackId' is set
2020
- if (feedbackId === undefined || feedbackId === null || feedbackId === '') {
2021
- throw 'Missing the required parameter "feedbackId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
2022
- }
2023
-
2024
- return this.apiClient.callApi(
2025
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
2026
- 'PATCH',
2027
- { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
2028
- { },
2029
- { },
2030
- { },
2031
- opts['body'],
2032
- ['PureCloud OAuth'],
2033
- ['application/json'],
2034
- ['application/json']
2035
- );
2036
- }
2037
-
2038
- /**
2039
- * Update a variation for a document.
2040
- *
2041
- * @param {String} documentVariationId Globally unique identifier for a document variation.
2042
- * @param {String} documentId Globally unique identifier for a document.
2043
- * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
2044
- * @param {Object} body
2045
- */
2046
- patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
2047
- // verify the required parameter 'documentVariationId' is set
2048
- if (documentVariationId === undefined || documentVariationId === null || documentVariationId === '') {
2049
- throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
2050
- }
2051
- // verify the required parameter 'documentId' is set
2052
- if (documentId === undefined || documentId === null || documentId === '') {
2053
- throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
2054
- }
2055
- // verify the required parameter 'knowledgeBaseId' is set
2056
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2057
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
2058
- }
2059
- // verify the required parameter 'body' is set
2060
- if (body === undefined || body === null) {
2061
- throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
2062
- }
2063
-
2064
- return this.apiClient.callApi(
2065
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
2066
- 'PATCH',
2067
- { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
2068
- { },
2069
- { },
2070
- { },
2071
- body,
2072
- ['PureCloud OAuth'],
2073
- ['application/json'],
2074
- ['application/json']
2075
- );
2076
- }
2077
-
2078
- /**
2079
- * Update search result.
2080
- *
2081
- * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
2082
- * @param {String} searchId Search Result ID
2083
- * @param {Object} opts Optional parameters
2084
- * @param {Object} opts.body
2085
- */
2086
- patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
2087
- opts = opts || {};
2088
-
2089
- // verify the required parameter 'knowledgeBaseId' is set
2090
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2091
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
2092
- }
2093
- // verify the required parameter 'searchId' is set
2094
- if (searchId === undefined || searchId === null || searchId === '') {
2095
- throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
2096
- }
2097
-
2098
- return this.apiClient.callApi(
2099
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
2100
- 'PATCH',
2101
- { 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
2102
- { },
2103
- { },
2104
- { },
2105
- opts['body'],
2106
- ['PureCloud OAuth'],
2107
- ['application/json'],
2108
- ['application/json']
2109
- );
2110
- }
2111
-
2112
- /**
2113
- * Start import job
2114
- *
2115
- * @param {String} knowledgeBaseId Knowledge base ID
2116
- * @param {String} importJobId Import job ID
2117
- * @param {Object} body
2118
- */
2119
- patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
2120
- // verify the required parameter 'knowledgeBaseId' is set
2121
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2122
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
2123
- }
2124
- // verify the required parameter 'importJobId' is set
2125
- if (importJobId === undefined || importJobId === null || importJobId === '') {
2126
- throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
2127
- }
2128
- // verify the required parameter 'body' is set
2129
- if (body === undefined || body === null) {
2130
- throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
2131
- }
2132
-
2133
- return this.apiClient.callApi(
2134
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
2135
- 'PATCH',
2136
- { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
2137
- { },
2138
- { },
2139
- { },
2140
- body,
2141
- ['PureCloud OAuth'],
2142
- ['application/json'],
2143
- ['application/json']
2144
- );
2145
- }
2146
-
2147
- /**
2148
- * Update label
2149
- *
2150
- * @param {String} knowledgeBaseId Knowledge base ID
2151
- * @param {String} labelId Label ID
2152
- * @param {Object} body
2153
- */
2154
- patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
2155
- // verify the required parameter 'knowledgeBaseId' is set
2156
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2157
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
2158
- }
2159
- // verify the required parameter 'labelId' is set
2160
- if (labelId === undefined || labelId === null || labelId === '') {
2161
- throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
1602
+ if (documentId === undefined || documentId === null || documentId === '') {
1603
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
2162
1604
  }
2163
- // verify the required parameter 'body' is set
2164
- if (body === undefined || body === null) {
2165
- throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
1605
+ // verify the required parameter 'feedbackId' is set
1606
+ if (feedbackId === undefined || feedbackId === null || feedbackId === '') {
1607
+ throw 'Missing the required parameter "feedbackId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
2166
1608
  }
2167
1609
 
2168
1610
  return this.apiClient.callApi(
2169
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
1611
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
2170
1612
  'PATCH',
2171
- { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
1613
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
2172
1614
  { },
2173
1615
  { },
2174
1616
  { },
2175
- body,
1617
+ opts['body'],
2176
1618
  ['PureCloud OAuth'],
2177
1619
  ['application/json'],
2178
1620
  ['application/json']
@@ -2180,36 +1622,35 @@ class KnowledgeApi {
2180
1622
  }
2181
1623
 
2182
1624
  /**
2183
- * Update category
1625
+ * Update a variation for a document.
2184
1626
  *
2185
- * @param {String} categoryId Category ID
2186
- * @param {String} knowledgeBaseId Knowledge base ID
2187
- * @param {Object} languageCode Language code, format: iso2-LOCALE
1627
+ * @param {String} documentVariationId Globally unique identifier for a document variation.
1628
+ * @param {String} documentId Globally unique identifier for a document.
1629
+ * @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
2188
1630
  * @param {Object} body
2189
- * @deprecated
2190
1631
  */
2191
- patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
2192
- // verify the required parameter 'categoryId' is set
2193
- if (categoryId === undefined || categoryId === null || categoryId === '') {
2194
- throw 'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseLanguageCategory';
1632
+ patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body) {
1633
+ // verify the required parameter 'documentVariationId' is set
1634
+ if (documentVariationId === undefined || documentVariationId === null || documentVariationId === '') {
1635
+ throw 'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
1636
+ }
1637
+ // verify the required parameter 'documentId' is set
1638
+ if (documentId === undefined || documentId === null || documentId === '') {
1639
+ throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
2195
1640
  }
2196
1641
  // verify the required parameter 'knowledgeBaseId' is set
2197
1642
  if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2198
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageCategory';
2199
- }
2200
- // verify the required parameter 'languageCode' is set
2201
- if (languageCode === undefined || languageCode === null || languageCode === '') {
2202
- throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageCategory';
1643
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';
2203
1644
  }
2204
1645
  // verify the required parameter 'body' is set
2205
1646
  if (body === undefined || body === null) {
2206
- throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageCategory';
1647
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';
2207
1648
  }
2208
1649
 
2209
1650
  return this.apiClient.callApi(
2210
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}',
1651
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}',
2211
1652
  'PATCH',
2212
- { 'categoryId': categoryId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1653
+ { 'documentVariationId': documentVariationId,'documentId': documentId,'knowledgeBaseId': knowledgeBaseId },
2213
1654
  { },
2214
1655
  { },
2215
1656
  { },
@@ -2221,40 +1662,33 @@ class KnowledgeApi {
2221
1662
  }
2222
1663
 
2223
1664
  /**
2224
- * Update document
1665
+ * Update search result.
2225
1666
  *
2226
- * @param {String} documentId Document ID
2227
- * @param {String} knowledgeBaseId Knowledge base ID
2228
- * @param {Object} languageCode Language code, format: iso2-LOCALE
2229
- * @param {Object} body
2230
- * @deprecated
1667
+ * @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
1668
+ * @param {String} searchId Search Result ID
1669
+ * @param {Object} opts Optional parameters
1670
+ * @param {Object} opts.body
2231
1671
  */
2232
- patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
2233
- // verify the required parameter 'documentId' is set
2234
- if (documentId === undefined || documentId === null || documentId === '') {
2235
- throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseLanguageDocument';
2236
- }
1672
+ patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, opts) {
1673
+ opts = opts || {};
1674
+
2237
1675
  // verify the required parameter 'knowledgeBaseId' is set
2238
1676
  if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2239
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocument';
2240
- }
2241
- // verify the required parameter 'languageCode' is set
2242
- if (languageCode === undefined || languageCode === null || languageCode === '') {
2243
- throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocument';
1677
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
2244
1678
  }
2245
- // verify the required parameter 'body' is set
2246
- if (body === undefined || body === null) {
2247
- throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocument';
1679
+ // verify the required parameter 'searchId' is set
1680
+ if (searchId === undefined || searchId === null || searchId === '') {
1681
+ throw 'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';
2248
1682
  }
2249
1683
 
2250
1684
  return this.apiClient.callApi(
2251
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}',
1685
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}',
2252
1686
  'PATCH',
2253
- { 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1687
+ { 'knowledgeBaseId': knowledgeBaseId,'searchId': searchId },
2254
1688
  { },
2255
1689
  { },
2256
1690
  { },
2257
- body,
1691
+ opts['body'],
2258
1692
  ['PureCloud OAuth'],
2259
1693
  ['application/json'],
2260
1694
  ['application/json']
@@ -2262,31 +1696,30 @@ class KnowledgeApi {
2262
1696
  }
2263
1697
 
2264
1698
  /**
2265
- * Update documents collection
1699
+ * Start import job
2266
1700
  *
2267
1701
  * @param {String} knowledgeBaseId Knowledge base ID
2268
- * @param {Object} languageCode Language code, format: iso2-LOCALE
2269
- * @param {Array.<Object>} body
2270
- * @deprecated
1702
+ * @param {String} importJobId Import job ID
1703
+ * @param {Object} body
2271
1704
  */
2272
- patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
1705
+ patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body) {
2273
1706
  // verify the required parameter 'knowledgeBaseId' is set
2274
1707
  if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2275
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
1708
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';
2276
1709
  }
2277
- // verify the required parameter 'languageCode' is set
2278
- if (languageCode === undefined || languageCode === null || languageCode === '') {
2279
- throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
1710
+ // verify the required parameter 'importJobId' is set
1711
+ if (importJobId === undefined || importJobId === null || importJobId === '') {
1712
+ throw 'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';
2280
1713
  }
2281
1714
  // verify the required parameter 'body' is set
2282
1715
  if (body === undefined || body === null) {
2283
- throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocuments';
1716
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';
2284
1717
  }
2285
1718
 
2286
1719
  return this.apiClient.callApi(
2287
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
1720
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
2288
1721
  'PATCH',
2289
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
1722
+ { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
2290
1723
  { },
2291
1724
  { },
2292
1725
  { },
@@ -2298,36 +1731,30 @@ class KnowledgeApi {
2298
1731
  }
2299
1732
 
2300
1733
  /**
2301
- * Start import operation
1734
+ * Update label
2302
1735
  *
2303
1736
  * @param {String} knowledgeBaseId Knowledge base ID
2304
- * @param {Object} languageCode Language code, format: iso2-LOCALE
2305
- * @param {String} importId Import ID
1737
+ * @param {String} labelId Label ID
2306
1738
  * @param {Object} body
2307
- * @deprecated
2308
1739
  */
2309
- patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
1740
+ patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body) {
2310
1741
  // verify the required parameter 'knowledgeBaseId' is set
2311
1742
  if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
2312
- throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
2313
- }
2314
- // verify the required parameter 'languageCode' is set
2315
- if (languageCode === undefined || languageCode === null || languageCode === '') {
2316
- throw 'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
1743
+ throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';
2317
1744
  }
2318
- // verify the required parameter 'importId' is set
2319
- if (importId === undefined || importId === null || importId === '') {
2320
- throw 'Missing the required parameter "importId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
1745
+ // verify the required parameter 'labelId' is set
1746
+ if (labelId === undefined || labelId === null || labelId === '') {
1747
+ throw 'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';
2321
1748
  }
2322
1749
  // verify the required parameter 'body' is set
2323
1750
  if (body === undefined || body === null) {
2324
- throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';
1751
+ throw 'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';
2325
1752
  }
2326
1753
 
2327
1754
  return this.apiClient.callApi(
2328
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}',
1755
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}',
2329
1756
  'PATCH',
2330
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'importId': importId },
1757
+ { 'knowledgeBaseId': knowledgeBaseId,'labelId': labelId },
2331
1758
  { },
2332
1759
  { },
2333
1760
  { },
@@ -3307,222 +2734,6 @@ class KnowledgeApi {
3307
2734
  );
3308
2735
  }
3309
2736
 
3310
- /**
3311
- * Create new category
3312
- *
3313
- * @param {String} knowledgeBaseId Knowledge base ID
3314
- * @param {Object} languageCode Language code, format: iso2-LOCALE
3315
- * @param {Object} body
3316
- * @deprecated
3317
- */
3318
- postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
3319
- // verify the required parameter 'knowledgeBaseId' is set
3320
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
3321
- throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageCategories';
3322
- }
3323
- // verify the required parameter 'languageCode' is set
3324
- if (languageCode === undefined || languageCode === null || languageCode === '') {
3325
- throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageCategories';
3326
- }
3327
- // verify the required parameter 'body' is set
3328
- if (body === undefined || body === null) {
3329
- throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageCategories';
3330
- }
3331
-
3332
- return this.apiClient.callApi(
3333
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories',
3334
- 'POST',
3335
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
3336
- { },
3337
- { },
3338
- { },
3339
- body,
3340
- ['PureCloud OAuth'],
3341
- ['application/json'],
3342
- ['application/json']
3343
- );
3344
- }
3345
-
3346
- /**
3347
- * Upload Article Content
3348
- *
3349
- * @param {String} documentId Document ID
3350
- * @param {String} knowledgeBaseId Knowledge base ID
3351
- * @param {Object} languageCode Language code, format: iso2-LOCALE
3352
- * @param {Object} body
3353
- * @deprecated
3354
- */
3355
- postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
3356
- // verify the required parameter 'documentId' is set
3357
- if (documentId === undefined || documentId === null || documentId === '') {
3358
- throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
3359
- }
3360
- // verify the required parameter 'knowledgeBaseId' is set
3361
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
3362
- throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
3363
- }
3364
- // verify the required parameter 'languageCode' is set
3365
- if (languageCode === undefined || languageCode === null || languageCode === '') {
3366
- throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
3367
- }
3368
- // verify the required parameter 'body' is set
3369
- if (body === undefined || body === null) {
3370
- throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';
3371
- }
3372
-
3373
- return this.apiClient.callApi(
3374
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads',
3375
- 'POST',
3376
- { 'documentId': documentId,'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
3377
- { },
3378
- { },
3379
- { },
3380
- body,
3381
- ['PureCloud OAuth'],
3382
- ['application/json'],
3383
- ['application/json']
3384
- );
3385
- }
3386
-
3387
- /**
3388
- * Create document
3389
- *
3390
- * @param {String} knowledgeBaseId Knowledge base ID
3391
- * @param {Object} languageCode Language code, format: iso2-LOCALE
3392
- * @param {Object} body
3393
- * @deprecated
3394
- */
3395
- postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
3396
- // verify the required parameter 'knowledgeBaseId' is set
3397
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
3398
- throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocuments';
3399
- }
3400
- // verify the required parameter 'languageCode' is set
3401
- if (languageCode === undefined || languageCode === null || languageCode === '') {
3402
- throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocuments';
3403
- }
3404
- // verify the required parameter 'body' is set
3405
- if (body === undefined || body === null) {
3406
- throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocuments';
3407
- }
3408
-
3409
- return this.apiClient.callApi(
3410
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
3411
- 'POST',
3412
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
3413
- { },
3414
- { },
3415
- { },
3416
- body,
3417
- ['PureCloud OAuth'],
3418
- ['application/json'],
3419
- ['application/json']
3420
- );
3421
- }
3422
-
3423
- /**
3424
- * Create import operation
3425
- *
3426
- * @param {String} knowledgeBaseId Knowledge base ID
3427
- * @param {Object} languageCode Language code, format: iso2-LOCALE
3428
- * @param {Object} body
3429
- * @deprecated
3430
- */
3431
- postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
3432
- // verify the required parameter 'knowledgeBaseId' is set
3433
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
3434
- throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
3435
- }
3436
- // verify the required parameter 'languageCode' is set
3437
- if (languageCode === undefined || languageCode === null || languageCode === '') {
3438
- throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
3439
- }
3440
- // verify the required parameter 'body' is set
3441
- if (body === undefined || body === null) {
3442
- throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';
3443
- }
3444
-
3445
- return this.apiClient.callApi(
3446
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports',
3447
- 'POST',
3448
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
3449
- { },
3450
- { },
3451
- { },
3452
- body,
3453
- ['PureCloud OAuth'],
3454
- ['application/json'],
3455
- ['application/json']
3456
- );
3457
- }
3458
-
3459
- /**
3460
- * Promote trained documents from draft state to active.
3461
- *
3462
- * @param {String} knowledgeBaseId Knowledge base ID
3463
- * @param {Object} languageCode Language code, format: iso2-LOCALE
3464
- * @param {String} trainingId Training ID
3465
- * @deprecated
3466
- */
3467
- postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
3468
- // verify the required parameter 'knowledgeBaseId' is set
3469
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
3470
- throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
3471
- }
3472
- // verify the required parameter 'languageCode' is set
3473
- if (languageCode === undefined || languageCode === null || languageCode === '') {
3474
- throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
3475
- }
3476
- // verify the required parameter 'trainingId' is set
3477
- if (trainingId === undefined || trainingId === null || trainingId === '') {
3478
- throw 'Missing the required parameter "trainingId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';
3479
- }
3480
-
3481
- return this.apiClient.callApi(
3482
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote',
3483
- 'POST',
3484
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode,'trainingId': trainingId },
3485
- { },
3486
- { },
3487
- { },
3488
- null,
3489
- ['PureCloud OAuth'],
3490
- ['application/json'],
3491
- ['application/json']
3492
- );
3493
- }
3494
-
3495
- /**
3496
- * Trigger training
3497
- *
3498
- * @param {String} knowledgeBaseId Knowledge base ID
3499
- * @param {Object} languageCode Language code, format: iso2-LOCALE
3500
- * @deprecated
3501
- */
3502
- postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
3503
- // verify the required parameter 'knowledgeBaseId' is set
3504
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
3505
- throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainings';
3506
- }
3507
- // verify the required parameter 'languageCode' is set
3508
- if (languageCode === undefined || languageCode === null || languageCode === '') {
3509
- throw 'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainings';
3510
- }
3511
-
3512
- return this.apiClient.callApi(
3513
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
3514
- 'POST',
3515
- { 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
3516
- { },
3517
- { },
3518
- { },
3519
- null,
3520
- ['PureCloud OAuth'],
3521
- ['application/json'],
3522
- ['application/json']
3523
- );
3524
- }
3525
-
3526
2737
  /**
3527
2738
  * Import the parsed articles
3528
2739
  *
@@ -3588,36 +2799,6 @@ class KnowledgeApi {
3588
2799
  );
3589
2800
  }
3590
2801
 
3591
- /**
3592
- * Search Documents
3593
- *
3594
- * @param {String} knowledgeBaseId Knowledge base ID
3595
- * @param {Object} opts Optional parameters
3596
- * @param {Object} opts.body
3597
- * @deprecated
3598
- */
3599
- postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
3600
- opts = opts || {};
3601
-
3602
- // verify the required parameter 'knowledgeBaseId' is set
3603
- if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
3604
- throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';
3605
- }
3606
-
3607
- return this.apiClient.callApi(
3608
- '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search',
3609
- 'POST',
3610
- { 'knowledgeBaseId': knowledgeBaseId },
3611
- { },
3612
- { },
3613
- { },
3614
- opts['body'],
3615
- ['PureCloud OAuth'],
3616
- ['application/json'],
3617
- ['application/json']
3618
- );
3619
- }
3620
-
3621
2802
  /**
3622
2803
  * Create Salesforce Knowledge integration source
3623
2804
  *