purecloud-platform-client-v2 216.0.0 → 218.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.js +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +502 -282
- package/dist/web-cjs/purecloud-platform-client-v2.js +507 -285
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +951 -292
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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 -305
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +112 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +9 -8
- 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 +1 -8
- 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 +387 -2
- 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 +243 -4
- 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 +5 -3
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +13 -16
- 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 +9 -8
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -68
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +19 -7
- 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 +1 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -29
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +182 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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 +403 -20
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
- 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 -3
- 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/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +58 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
- 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 ExternalContactsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ExternalContacts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 218.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -469,6 +469,7 @@ class ExternalContactsApi {
|
|
|
469
469
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
470
470
|
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
471
471
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
472
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
472
473
|
*/
|
|
473
474
|
getExternalcontactsContacts(opts) {
|
|
474
475
|
opts = opts || {};
|
|
@@ -478,7 +479,58 @@ class ExternalContactsApi {
|
|
|
478
479
|
'/api/v2/externalcontacts/contacts',
|
|
479
480
|
'GET',
|
|
480
481
|
{ },
|
|
481
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
482
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
483
|
+
{ },
|
|
484
|
+
{ },
|
|
485
|
+
null,
|
|
486
|
+
['PureCloud OAuth'],
|
|
487
|
+
['application/json'],
|
|
488
|
+
['application/json']
|
|
489
|
+
);
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Get export for exportId
|
|
494
|
+
*
|
|
495
|
+
* @param {String} exportId Export id
|
|
496
|
+
*/
|
|
497
|
+
getExternalcontactsContactsExport(exportId) {
|
|
498
|
+
// verify the required parameter 'exportId' is set
|
|
499
|
+
if (exportId === undefined || exportId === null) {
|
|
500
|
+
throw 'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
return this.apiClient.callApi(
|
|
504
|
+
'/api/v2/externalcontacts/contacts/exports/{exportId}',
|
|
505
|
+
'GET',
|
|
506
|
+
{ 'exportId': exportId },
|
|
507
|
+
{ },
|
|
508
|
+
{ },
|
|
509
|
+
{ },
|
|
510
|
+
null,
|
|
511
|
+
['PureCloud OAuth'],
|
|
512
|
+
['application/json'],
|
|
513
|
+
['application/json']
|
|
514
|
+
);
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* List exports for organization
|
|
519
|
+
*
|
|
520
|
+
* @param {Object} opts Optional parameters
|
|
521
|
+
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
522
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
523
|
+
* @param {Number} opts.pageSize Number of entities to return
|
|
524
|
+
*/
|
|
525
|
+
getExternalcontactsContactsExports(opts) {
|
|
526
|
+
opts = opts || {};
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
return this.apiClient.callApi(
|
|
530
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
531
|
+
'GET',
|
|
532
|
+
{ },
|
|
533
|
+
{ 'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
482
534
|
{ },
|
|
483
535
|
{ },
|
|
484
536
|
null,
|
|
@@ -1022,6 +1074,7 @@ class ExternalContactsApi {
|
|
|
1022
1074
|
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
1023
1075
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
1024
1076
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
1077
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
1025
1078
|
*/
|
|
1026
1079
|
getExternalcontactsOrganizations(opts) {
|
|
1027
1080
|
opts = opts || {};
|
|
@@ -1031,7 +1084,7 @@ class ExternalContactsApi {
|
|
|
1031
1084
|
'/api/v2/externalcontacts/organizations',
|
|
1032
1085
|
'GET',
|
|
1033
1086
|
{ },
|
|
1034
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'trustorId': this.apiClient.buildCollectionParam(opts['trustorId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'] },
|
|
1087
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'q': opts['q'],'trustorId': this.apiClient.buildCollectionParam(opts['trustorId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeTrustors': opts['includeTrustors'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
1035
1088
|
{ },
|
|
1036
1089
|
{ },
|
|
1037
1090
|
null,
|
|
@@ -1176,6 +1229,7 @@ class ExternalContactsApi {
|
|
|
1176
1229
|
* @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
1177
1230
|
* @param {Object} opts Optional parameters
|
|
1178
1231
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
1232
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
|
|
1179
1233
|
*/
|
|
1180
1234
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
1181
1235
|
opts = opts || {};
|
|
@@ -1189,7 +1243,7 @@ class ExternalContactsApi {
|
|
|
1189
1243
|
'/api/v2/externalcontacts/reversewhitepageslookup',
|
|
1190
1244
|
'GET',
|
|
1191
1245
|
{ },
|
|
1192
|
-
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1246
|
+
{ 'lookupVal': lookupVal,'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'divisionId': opts['divisionId'] },
|
|
1193
1247
|
{ },
|
|
1194
1248
|
{ },
|
|
1195
1249
|
null,
|
|
@@ -1205,6 +1259,7 @@ class ExternalContactsApi {
|
|
|
1205
1259
|
* @param {Object} opts Optional parameters
|
|
1206
1260
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
1207
1261
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1262
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1208
1263
|
*/
|
|
1209
1264
|
getExternalcontactsScanContacts(opts) {
|
|
1210
1265
|
opts = opts || {};
|
|
@@ -1214,6 +1269,32 @@ class ExternalContactsApi {
|
|
|
1214
1269
|
'/api/v2/externalcontacts/scan/contacts',
|
|
1215
1270
|
'GET',
|
|
1216
1271
|
{ },
|
|
1272
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1273
|
+
{ },
|
|
1274
|
+
{ },
|
|
1275
|
+
null,
|
|
1276
|
+
['PureCloud OAuth'],
|
|
1277
|
+
['application/json'],
|
|
1278
|
+
['application/json']
|
|
1279
|
+
);
|
|
1280
|
+
}
|
|
1281
|
+
|
|
1282
|
+
/**
|
|
1283
|
+
* Scan for external contacts using paging
|
|
1284
|
+
*
|
|
1285
|
+
* @param {Object} opts Optional parameters
|
|
1286
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
1287
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1288
|
+
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1289
|
+
*/
|
|
1290
|
+
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
1291
|
+
opts = opts || {};
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
return this.apiClient.callApi(
|
|
1295
|
+
'/api/v2/externalcontacts/scan/contacts/divisionviews/all',
|
|
1296
|
+
'GET',
|
|
1297
|
+
{ },
|
|
1217
1298
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1218
1299
|
{ },
|
|
1219
1300
|
{ },
|
|
@@ -1230,6 +1311,7 @@ class ExternalContactsApi {
|
|
|
1230
1311
|
* @param {Object} opts Optional parameters
|
|
1231
1312
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
1232
1313
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1314
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1233
1315
|
*/
|
|
1234
1316
|
getExternalcontactsScanNotes(opts) {
|
|
1235
1317
|
opts = opts || {};
|
|
@@ -1239,6 +1321,32 @@ class ExternalContactsApi {
|
|
|
1239
1321
|
'/api/v2/externalcontacts/scan/notes',
|
|
1240
1322
|
'GET',
|
|
1241
1323
|
{ },
|
|
1324
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1325
|
+
{ },
|
|
1326
|
+
{ },
|
|
1327
|
+
null,
|
|
1328
|
+
['PureCloud OAuth'],
|
|
1329
|
+
['application/json'],
|
|
1330
|
+
['application/json']
|
|
1331
|
+
);
|
|
1332
|
+
}
|
|
1333
|
+
|
|
1334
|
+
/**
|
|
1335
|
+
* Scan for notes using paging
|
|
1336
|
+
*
|
|
1337
|
+
* @param {Object} opts Optional parameters
|
|
1338
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
1339
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1340
|
+
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1341
|
+
*/
|
|
1342
|
+
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
1343
|
+
opts = opts || {};
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
return this.apiClient.callApi(
|
|
1347
|
+
'/api/v2/externalcontacts/scan/notes/divisionviews/all',
|
|
1348
|
+
'GET',
|
|
1349
|
+
{ },
|
|
1242
1350
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1243
1351
|
{ },
|
|
1244
1352
|
{ },
|
|
@@ -1255,6 +1363,7 @@ class ExternalContactsApi {
|
|
|
1255
1363
|
* @param {Object} opts Optional parameters
|
|
1256
1364
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
1257
1365
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1366
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1258
1367
|
*/
|
|
1259
1368
|
getExternalcontactsScanOrganizations(opts) {
|
|
1260
1369
|
opts = opts || {};
|
|
@@ -1264,6 +1373,32 @@ class ExternalContactsApi {
|
|
|
1264
1373
|
'/api/v2/externalcontacts/scan/organizations',
|
|
1265
1374
|
'GET',
|
|
1266
1375
|
{ },
|
|
1376
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1377
|
+
{ },
|
|
1378
|
+
{ },
|
|
1379
|
+
null,
|
|
1380
|
+
['PureCloud OAuth'],
|
|
1381
|
+
['application/json'],
|
|
1382
|
+
['application/json']
|
|
1383
|
+
);
|
|
1384
|
+
}
|
|
1385
|
+
|
|
1386
|
+
/**
|
|
1387
|
+
* Scan for external organizations using paging
|
|
1388
|
+
*
|
|
1389
|
+
* @param {Object} opts Optional parameters
|
|
1390
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
1391
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1392
|
+
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1393
|
+
*/
|
|
1394
|
+
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
1395
|
+
opts = opts || {};
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
return this.apiClient.callApi(
|
|
1399
|
+
'/api/v2/externalcontacts/scan/organizations/divisionviews/all',
|
|
1400
|
+
'GET',
|
|
1401
|
+
{ },
|
|
1267
1402
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1268
1403
|
{ },
|
|
1269
1404
|
{ },
|
|
@@ -1280,6 +1415,7 @@ class ExternalContactsApi {
|
|
|
1280
1415
|
* @param {Object} opts Optional parameters
|
|
1281
1416
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
1282
1417
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1418
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
1283
1419
|
*/
|
|
1284
1420
|
getExternalcontactsScanRelationships(opts) {
|
|
1285
1421
|
opts = opts || {};
|
|
@@ -1289,6 +1425,32 @@ class ExternalContactsApi {
|
|
|
1289
1425
|
'/api/v2/externalcontacts/scan/relationships',
|
|
1290
1426
|
'GET',
|
|
1291
1427
|
{ },
|
|
1428
|
+
{ 'limit': opts['limit'],'cursor': opts['cursor'],'divisionId': opts['divisionId'] },
|
|
1429
|
+
{ },
|
|
1430
|
+
{ },
|
|
1431
|
+
null,
|
|
1432
|
+
['PureCloud OAuth'],
|
|
1433
|
+
['application/json'],
|
|
1434
|
+
['application/json']
|
|
1435
|
+
);
|
|
1436
|
+
}
|
|
1437
|
+
|
|
1438
|
+
/**
|
|
1439
|
+
* Scan for relationships
|
|
1440
|
+
*
|
|
1441
|
+
* @param {Object} opts Optional parameters
|
|
1442
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
1443
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1444
|
+
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1445
|
+
*/
|
|
1446
|
+
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
1447
|
+
opts = opts || {};
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
return this.apiClient.callApi(
|
|
1451
|
+
'/api/v2/externalcontacts/scan/relationships/divisionviews/all',
|
|
1452
|
+
'GET',
|
|
1453
|
+
{ },
|
|
1292
1454
|
{ 'limit': opts['limit'],'cursor': opts['cursor'] },
|
|
1293
1455
|
{ },
|
|
1294
1456
|
{ },
|
|
@@ -1379,6 +1541,32 @@ class ExternalContactsApi {
|
|
|
1379
1541
|
);
|
|
1380
1542
|
}
|
|
1381
1543
|
|
|
1544
|
+
/**
|
|
1545
|
+
* Bulk fetch contacts across divisions
|
|
1546
|
+
*
|
|
1547
|
+
* @param {Object} body Contact ids
|
|
1548
|
+
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1549
|
+
*/
|
|
1550
|
+
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
1551
|
+
// verify the required parameter 'body' is set
|
|
1552
|
+
if (body === undefined || body === null) {
|
|
1553
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';
|
|
1554
|
+
}
|
|
1555
|
+
|
|
1556
|
+
return this.apiClient.callApi(
|
|
1557
|
+
'/api/v2/externalcontacts/bulk/contacts/divisionviews',
|
|
1558
|
+
'POST',
|
|
1559
|
+
{ },
|
|
1560
|
+
{ },
|
|
1561
|
+
{ },
|
|
1562
|
+
{ },
|
|
1563
|
+
body,
|
|
1564
|
+
['PureCloud OAuth'],
|
|
1565
|
+
['application/json'],
|
|
1566
|
+
['application/json']
|
|
1567
|
+
);
|
|
1568
|
+
}
|
|
1569
|
+
|
|
1382
1570
|
/**
|
|
1383
1571
|
* Bulk remove contacts
|
|
1384
1572
|
*
|
|
@@ -1604,6 +1792,32 @@ class ExternalContactsApi {
|
|
|
1604
1792
|
);
|
|
1605
1793
|
}
|
|
1606
1794
|
|
|
1795
|
+
/**
|
|
1796
|
+
* Bulk fetch organizations across divisions
|
|
1797
|
+
*
|
|
1798
|
+
* @param {Object} body Organizations ids
|
|
1799
|
+
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1800
|
+
*/
|
|
1801
|
+
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
1802
|
+
// verify the required parameter 'body' is set
|
|
1803
|
+
if (body === undefined || body === null) {
|
|
1804
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1807
|
+
return this.apiClient.callApi(
|
|
1808
|
+
'/api/v2/externalcontacts/bulk/organizations/divisionviews',
|
|
1809
|
+
'POST',
|
|
1810
|
+
{ },
|
|
1811
|
+
{ },
|
|
1812
|
+
{ },
|
|
1813
|
+
{ },
|
|
1814
|
+
body,
|
|
1815
|
+
['PureCloud OAuth'],
|
|
1816
|
+
['application/json'],
|
|
1817
|
+
['application/json']
|
|
1818
|
+
);
|
|
1819
|
+
}
|
|
1820
|
+
|
|
1607
1821
|
/**
|
|
1608
1822
|
* Bulk remove organizations
|
|
1609
1823
|
*
|
|
@@ -1834,6 +2048,31 @@ class ExternalContactsApi {
|
|
|
1834
2048
|
);
|
|
1835
2049
|
}
|
|
1836
2050
|
|
|
2051
|
+
/**
|
|
2052
|
+
* Create bulk export
|
|
2053
|
+
*
|
|
2054
|
+
* @param {Object} body Export
|
|
2055
|
+
*/
|
|
2056
|
+
postExternalcontactsContactsExports(body) {
|
|
2057
|
+
// verify the required parameter 'body' is set
|
|
2058
|
+
if (body === undefined || body === null) {
|
|
2059
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsContactsExports';
|
|
2060
|
+
}
|
|
2061
|
+
|
|
2062
|
+
return this.apiClient.callApi(
|
|
2063
|
+
'/api/v2/externalcontacts/contacts/exports',
|
|
2064
|
+
'POST',
|
|
2065
|
+
{ },
|
|
2066
|
+
{ },
|
|
2067
|
+
{ },
|
|
2068
|
+
{ },
|
|
2069
|
+
body,
|
|
2070
|
+
['PureCloud OAuth'],
|
|
2071
|
+
['application/json'],
|
|
2072
|
+
['application/json']
|
|
2073
|
+
);
|
|
2074
|
+
}
|
|
2075
|
+
|
|
1837
2076
|
/**
|
|
1838
2077
|
* Create a schema
|
|
1839
2078
|
*
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 218.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -214,6 +214,7 @@ class IntegrationsApi {
|
|
|
214
214
|
* @param {String} actionId actionId
|
|
215
215
|
* @param {Object} opts Optional parameters
|
|
216
216
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
217
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
217
218
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
218
219
|
*/
|
|
219
220
|
getIntegrationsAction(actionId, opts) {
|
|
@@ -228,7 +229,7 @@ class IntegrationsApi {
|
|
|
228
229
|
'/api/v2/integrations/actions/{actionId}',
|
|
229
230
|
'GET',
|
|
230
231
|
{ 'actionId': actionId },
|
|
231
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
232
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
232
233
|
{ },
|
|
233
234
|
{ },
|
|
234
235
|
null,
|
|
@@ -244,6 +245,7 @@ class IntegrationsApi {
|
|
|
244
245
|
* @param {String} actionId actionId
|
|
245
246
|
* @param {Object} opts Optional parameters
|
|
246
247
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
248
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
247
249
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
248
250
|
*/
|
|
249
251
|
getIntegrationsActionDraft(actionId, opts) {
|
|
@@ -258,7 +260,7 @@ class IntegrationsApi {
|
|
|
258
260
|
'/api/v2/integrations/actions/{actionId}/draft',
|
|
259
261
|
'GET',
|
|
260
262
|
{ 'actionId': actionId },
|
|
261
|
-
{ 'expand': opts['expand'],'includeConfig': opts['includeConfig'] },
|
|
263
|
+
{ 'expand': opts['expand'],'flatten': opts['flatten'],'includeConfig': opts['includeConfig'] },
|
|
262
264
|
{ },
|
|
263
265
|
{ },
|
|
264
266
|
null,
|
|
@@ -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 218.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1280,7 +1280,6 @@ class KnowledgeApi {
|
|
|
1280
1280
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
1281
1281
|
* @param {String} uploadId UploadId
|
|
1282
1282
|
* @deprecated
|
|
1283
|
-
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1284
1283
|
*/
|
|
1285
1284
|
getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
|
|
1286
1285
|
// verify the required parameter 'documentId' is set
|
|
@@ -1536,7 +1535,6 @@ class KnowledgeApi {
|
|
|
1536
1535
|
* @param {String} parseJobId Parse job ID
|
|
1537
1536
|
* @param {Object} opts Optional parameters
|
|
1538
1537
|
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
1539
|
-
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1540
1538
|
*/
|
|
1541
1539
|
getKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, opts) {
|
|
1542
1540
|
opts = opts || {};
|
|
@@ -1806,7 +1804,6 @@ class KnowledgeApi {
|
|
|
1806
1804
|
*
|
|
1807
1805
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1808
1806
|
* @param {String} jobId Upload job ID
|
|
1809
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1810
1807
|
*/
|
|
1811
1808
|
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
1812
1809
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2347,7 +2344,6 @@ class KnowledgeApi {
|
|
|
2347
2344
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2348
2345
|
* @param {String} parseJobId Parse job ID
|
|
2349
2346
|
* @param {Object} body
|
|
2350
|
-
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2351
2347
|
*/
|
|
2352
2348
|
patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId, parseJobId, body) {
|
|
2353
2349
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -2989,7 +2985,6 @@ class KnowledgeApi {
|
|
|
2989
2985
|
*
|
|
2990
2986
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
2991
2987
|
* @param {Object} body
|
|
2992
|
-
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2993
2988
|
*/
|
|
2994
2989
|
postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
|
|
2995
2990
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3020,7 +3015,6 @@ class KnowledgeApi {
|
|
|
3020
3015
|
*
|
|
3021
3016
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3022
3017
|
* @param {Object} body
|
|
3023
|
-
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3024
3018
|
*/
|
|
3025
3019
|
postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
|
|
3026
3020
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3169,7 +3163,6 @@ class KnowledgeApi {
|
|
|
3169
3163
|
*
|
|
3170
3164
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3171
3165
|
* @param {Object} body
|
|
3172
|
-
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3173
3166
|
*/
|
|
3174
3167
|
postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
|
|
3175
3168
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3329,7 +3322,6 @@ class KnowledgeApi {
|
|
|
3329
3322
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
3330
3323
|
* @param {Object} body
|
|
3331
3324
|
* @deprecated
|
|
3332
|
-
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3333
3325
|
*/
|
|
3334
3326
|
postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
|
|
3335
3327
|
// verify the required parameter 'documentId' is set
|
|
@@ -3508,7 +3500,6 @@ class KnowledgeApi {
|
|
|
3508
3500
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3509
3501
|
* @param {String} parseJobId Parse job ID
|
|
3510
3502
|
* @param {Object} body
|
|
3511
|
-
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3512
3503
|
*/
|
|
3513
3504
|
postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId, parseJobId, body) {
|
|
3514
3505
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3543,7 +3534,6 @@ class KnowledgeApi {
|
|
|
3543
3534
|
*
|
|
3544
3535
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3545
3536
|
* @param {Object} body
|
|
3546
|
-
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3547
3537
|
*/
|
|
3548
3538
|
postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId, body) {
|
|
3549
3539
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -3634,8 +3624,12 @@ class KnowledgeApi {
|
|
|
3634
3624
|
*
|
|
3635
3625
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3636
3626
|
* @param {String} sourceId Source ID
|
|
3627
|
+
* @param {Object} opts Optional parameters
|
|
3628
|
+
* @param {Object} opts.body
|
|
3637
3629
|
*/
|
|
3638
|
-
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId) {
|
|
3630
|
+
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
3631
|
+
opts = opts || {};
|
|
3632
|
+
|
|
3639
3633
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
3640
3634
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
3641
3635
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';
|
|
@@ -3652,7 +3646,7 @@ class KnowledgeApi {
|
|
|
3652
3646
|
{ },
|
|
3653
3647
|
{ },
|
|
3654
3648
|
{ },
|
|
3655
|
-
|
|
3649
|
+
opts['body'],
|
|
3656
3650
|
['PureCloud OAuth'],
|
|
3657
3651
|
['application/json'],
|
|
3658
3652
|
['application/json']
|
|
@@ -3694,8 +3688,12 @@ class KnowledgeApi {
|
|
|
3694
3688
|
*
|
|
3695
3689
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3696
3690
|
* @param {String} sourceId Source ID
|
|
3691
|
+
* @param {Object} opts Optional parameters
|
|
3692
|
+
* @param {Object} opts.body
|
|
3697
3693
|
*/
|
|
3698
|
-
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId) {
|
|
3694
|
+
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId, sourceId, opts) {
|
|
3695
|
+
opts = opts || {};
|
|
3696
|
+
|
|
3699
3697
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
3700
3698
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
3701
3699
|
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';
|
|
@@ -3712,7 +3710,7 @@ class KnowledgeApi {
|
|
|
3712
3710
|
{ },
|
|
3713
3711
|
{ },
|
|
3714
3712
|
{ },
|
|
3715
|
-
|
|
3713
|
+
opts['body'],
|
|
3716
3714
|
['PureCloud OAuth'],
|
|
3717
3715
|
['application/json'],
|
|
3718
3716
|
['application/json']
|
|
@@ -3754,7 +3752,6 @@ class KnowledgeApi {
|
|
|
3754
3752
|
*
|
|
3755
3753
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
3756
3754
|
* @param {Object} body uploadRequest
|
|
3757
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3758
3755
|
*/
|
|
3759
3756
|
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
3760
3757
|
// verify the required parameter 'knowledgeBaseId' is set
|