purecloud-platform-client-v2 246.0.0 → 247.1.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +271 -88
- package/dist/web-amd/purecloud-platform-client-v2.js +271 -88
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +238 -132
- package/dist/web-cjs/purecloud-platform-client-v2.js +238 -132
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +310 -22
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +159 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +25 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 247.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -320,6 +320,31 @@ class KnowledgeApi {
|
|
|
320
320
|
);
|
|
321
321
|
}
|
|
322
322
|
|
|
323
|
+
/**
|
|
324
|
+
* Delete Knowledge setting.
|
|
325
|
+
*
|
|
326
|
+
* @param {String} knowledgeSettingId Knowledge Setting ID.
|
|
327
|
+
*/
|
|
328
|
+
deleteKnowledgeSetting(knowledgeSettingId) {
|
|
329
|
+
// verify the required parameter 'knowledgeSettingId' is set
|
|
330
|
+
if (knowledgeSettingId === undefined || knowledgeSettingId === null || knowledgeSettingId === '') {
|
|
331
|
+
throw 'Missing the required parameter "knowledgeSettingId" when calling deleteKnowledgeSetting';
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
return this.apiClient.callApi(
|
|
335
|
+
'/api/v2/knowledge/settings/{knowledgeSettingId}',
|
|
336
|
+
'DELETE',
|
|
337
|
+
{ 'knowledgeSettingId': knowledgeSettingId },
|
|
338
|
+
{ },
|
|
339
|
+
{ },
|
|
340
|
+
{ },
|
|
341
|
+
null,
|
|
342
|
+
['PureCloud OAuth'],
|
|
343
|
+
['application/json'],
|
|
344
|
+
['application/json']
|
|
345
|
+
);
|
|
346
|
+
}
|
|
347
|
+
|
|
323
348
|
/**
|
|
324
349
|
* Get categories
|
|
325
350
|
*
|
|
@@ -1447,6 +1472,61 @@ class KnowledgeApi {
|
|
|
1447
1472
|
);
|
|
1448
1473
|
}
|
|
1449
1474
|
|
|
1475
|
+
/**
|
|
1476
|
+
* Get Knowledge setting.
|
|
1477
|
+
*
|
|
1478
|
+
* @param {String} knowledgeSettingId Knowledge Setting ID.
|
|
1479
|
+
*/
|
|
1480
|
+
getKnowledgeSetting(knowledgeSettingId) {
|
|
1481
|
+
// verify the required parameter 'knowledgeSettingId' is set
|
|
1482
|
+
if (knowledgeSettingId === undefined || knowledgeSettingId === null || knowledgeSettingId === '') {
|
|
1483
|
+
throw 'Missing the required parameter "knowledgeSettingId" when calling getKnowledgeSetting';
|
|
1484
|
+
}
|
|
1485
|
+
|
|
1486
|
+
return this.apiClient.callApi(
|
|
1487
|
+
'/api/v2/knowledge/settings/{knowledgeSettingId}',
|
|
1488
|
+
'GET',
|
|
1489
|
+
{ 'knowledgeSettingId': knowledgeSettingId },
|
|
1490
|
+
{ },
|
|
1491
|
+
{ },
|
|
1492
|
+
{ },
|
|
1493
|
+
null,
|
|
1494
|
+
['PureCloud OAuth'],
|
|
1495
|
+
['application/json'],
|
|
1496
|
+
['application/json']
|
|
1497
|
+
);
|
|
1498
|
+
}
|
|
1499
|
+
|
|
1500
|
+
/**
|
|
1501
|
+
* Get Knowledge settings.
|
|
1502
|
+
*
|
|
1503
|
+
* @param {Object} opts Optional parameters
|
|
1504
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
1505
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1506
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
1507
|
+
* @param {String} opts.name Knowledge setting name to search upon.
|
|
1508
|
+
* @param {String} opts.sourceId Source ID to filter knowledge settings by.
|
|
1509
|
+
* @param {Object} opts.sortBy Field to sort the knowledge settings on.
|
|
1510
|
+
* @param {Object} opts.sortOrder Sorting order for knowledge settings.
|
|
1511
|
+
*/
|
|
1512
|
+
getKnowledgeSettings(opts) {
|
|
1513
|
+
opts = opts || {};
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
return this.apiClient.callApi(
|
|
1517
|
+
'/api/v2/knowledge/settings',
|
|
1518
|
+
'GET',
|
|
1519
|
+
{ },
|
|
1520
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'name': opts['name'],'sourceId': opts['sourceId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
1521
|
+
{ },
|
|
1522
|
+
{ },
|
|
1523
|
+
null,
|
|
1524
|
+
['PureCloud OAuth'],
|
|
1525
|
+
['application/json'],
|
|
1526
|
+
['application/json']
|
|
1527
|
+
);
|
|
1528
|
+
}
|
|
1529
|
+
|
|
1450
1530
|
/**
|
|
1451
1531
|
* Update search result.
|
|
1452
1532
|
*
|
|
@@ -1909,6 +1989,36 @@ class KnowledgeApi {
|
|
|
1909
1989
|
);
|
|
1910
1990
|
}
|
|
1911
1991
|
|
|
1992
|
+
/**
|
|
1993
|
+
* Update Knowledge setting.
|
|
1994
|
+
*
|
|
1995
|
+
* @param {String} knowledgeSettingId Knowledge Setting ID.
|
|
1996
|
+
* @param {Object} body
|
|
1997
|
+
*/
|
|
1998
|
+
patchKnowledgeSetting(knowledgeSettingId, body) {
|
|
1999
|
+
// verify the required parameter 'knowledgeSettingId' is set
|
|
2000
|
+
if (knowledgeSettingId === undefined || knowledgeSettingId === null || knowledgeSettingId === '') {
|
|
2001
|
+
throw 'Missing the required parameter "knowledgeSettingId" when calling patchKnowledgeSetting';
|
|
2002
|
+
}
|
|
2003
|
+
// verify the required parameter 'body' is set
|
|
2004
|
+
if (body === undefined || body === null) {
|
|
2005
|
+
throw 'Missing the required parameter "body" when calling patchKnowledgeSetting';
|
|
2006
|
+
}
|
|
2007
|
+
|
|
2008
|
+
return this.apiClient.callApi(
|
|
2009
|
+
'/api/v2/knowledge/settings/{knowledgeSettingId}',
|
|
2010
|
+
'PATCH',
|
|
2011
|
+
{ 'knowledgeSettingId': knowledgeSettingId },
|
|
2012
|
+
{ },
|
|
2013
|
+
{ },
|
|
2014
|
+
{ },
|
|
2015
|
+
body,
|
|
2016
|
+
['PureCloud OAuth'],
|
|
2017
|
+
['application/json'],
|
|
2018
|
+
['application/json']
|
|
2019
|
+
);
|
|
2020
|
+
}
|
|
2021
|
+
|
|
1912
2022
|
/**
|
|
1913
2023
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
1914
2024
|
*
|
|
@@ -3046,6 +3156,54 @@ class KnowledgeApi {
|
|
|
3046
3156
|
);
|
|
3047
3157
|
}
|
|
3048
3158
|
|
|
3159
|
+
/**
|
|
3160
|
+
* Get Knowledge Search Preview
|
|
3161
|
+
*
|
|
3162
|
+
* @param {Object} opts Optional parameters
|
|
3163
|
+
* @param {Object} opts.body
|
|
3164
|
+
*/
|
|
3165
|
+
postKnowledgeSearchPreview(opts) {
|
|
3166
|
+
opts = opts || {};
|
|
3167
|
+
|
|
3168
|
+
|
|
3169
|
+
return this.apiClient.callApi(
|
|
3170
|
+
'/api/v2/knowledge/search/preview',
|
|
3171
|
+
'POST',
|
|
3172
|
+
{ },
|
|
3173
|
+
{ },
|
|
3174
|
+
{ },
|
|
3175
|
+
{ },
|
|
3176
|
+
opts['body'],
|
|
3177
|
+
['PureCloud OAuth'],
|
|
3178
|
+
['application/json'],
|
|
3179
|
+
['application/json']
|
|
3180
|
+
);
|
|
3181
|
+
}
|
|
3182
|
+
|
|
3183
|
+
/**
|
|
3184
|
+
* Create Knowledge setting.
|
|
3185
|
+
*
|
|
3186
|
+
* @param {Object} opts Optional parameters
|
|
3187
|
+
* @param {Object} opts.body
|
|
3188
|
+
*/
|
|
3189
|
+
postKnowledgeSettings(opts) {
|
|
3190
|
+
opts = opts || {};
|
|
3191
|
+
|
|
3192
|
+
|
|
3193
|
+
return this.apiClient.callApi(
|
|
3194
|
+
'/api/v2/knowledge/settings',
|
|
3195
|
+
'POST',
|
|
3196
|
+
{ },
|
|
3197
|
+
{ },
|
|
3198
|
+
{ },
|
|
3199
|
+
{ },
|
|
3200
|
+
opts['body'],
|
|
3201
|
+
['PureCloud OAuth'],
|
|
3202
|
+
['application/json'],
|
|
3203
|
+
['application/json']
|
|
3204
|
+
);
|
|
3205
|
+
}
|
|
3206
|
+
|
|
3049
3207
|
/**
|
|
3050
3208
|
* Update Salesforce Knowledge integration source
|
|
3051
3209
|
*
|
|
@@ -5,7 +5,7 @@ class QualityApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Quality service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 247.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1453,6 +1453,7 @@ class QualityApi {
|
|
|
1453
1453
|
* @param {String} conversationId conversationId
|
|
1454
1454
|
* @param {Object} body evaluation
|
|
1455
1455
|
* @param {Object} opts Optional parameters
|
|
1456
|
+
* @param {String} opts.idempotencyKey Idempotency key for request deduplication
|
|
1456
1457
|
* @param {String} opts.expand evaluatorId
|
|
1457
1458
|
*/
|
|
1458
1459
|
postQualityConversationEvaluations(conversationId, body, opts) {
|
|
@@ -1472,7 +1473,7 @@ class QualityApi {
|
|
|
1472
1473
|
'POST',
|
|
1473
1474
|
{ 'conversationId': conversationId },
|
|
1474
1475
|
{ 'expand': opts['expand'] },
|
|
1475
|
-
{
|
|
1476
|
+
{ 'Idempotency-Key': opts['idempotencyKey'] },
|
|
1476
1477
|
{ },
|
|
1477
1478
|
body,
|
|
1478
1479
|
['PureCloud OAuth'],
|