purecloud-platform-client-v2 219.0.0 → 221.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 +4 -4
- package/dist/node/purecloud-platform-client-v2.js +1378 -144
- package/dist/web-amd/purecloud-platform-client-v2.js +1378 -144
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +495 -184
- package/dist/web-cjs/purecloud-platform-client-v2.js +495 -184
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1596 -766
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- 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 +4 -5
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +177 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +919 -0
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +7 -3
- 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 +71 -8
- 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 +4 -19
- 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/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +19 -14
- 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 +33 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +65 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -3
- 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 -10
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +3 -3
- 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/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 -3
- 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 +7 -1
|
@@ -690,7 +690,7 @@ class Configuration {
|
|
|
690
690
|
|
|
691
691
|
/**
|
|
692
692
|
* @module purecloud-platform-client-v2/ApiClient
|
|
693
|
-
* @version
|
|
693
|
+
* @version 221.0.0
|
|
694
694
|
*/
|
|
695
695
|
class ApiClient {
|
|
696
696
|
/**
|
|
@@ -785,7 +785,7 @@ class ApiClient {
|
|
|
785
785
|
/**
|
|
786
786
|
* The default HTTP timeout for all API calls.
|
|
787
787
|
* @type {Number}
|
|
788
|
-
* @default
|
|
788
|
+
* @default 16000
|
|
789
789
|
*/
|
|
790
790
|
this.timeout = 16000;
|
|
791
791
|
|
|
@@ -2234,7 +2234,7 @@ class AgentAssistantsApi {
|
|
|
2234
2234
|
/**
|
|
2235
2235
|
* AgentAssistants service.
|
|
2236
2236
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2237
|
-
* @version
|
|
2237
|
+
* @version 221.0.0
|
|
2238
2238
|
*/
|
|
2239
2239
|
|
|
2240
2240
|
/**
|
|
@@ -2610,7 +2610,7 @@ class AgentCopilotApi {
|
|
|
2610
2610
|
/**
|
|
2611
2611
|
* AgentCopilot service.
|
|
2612
2612
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2613
|
-
* @version
|
|
2613
|
+
* @version 221.0.0
|
|
2614
2614
|
*/
|
|
2615
2615
|
|
|
2616
2616
|
/**
|
|
@@ -2686,7 +2686,7 @@ class AgentUIApi {
|
|
|
2686
2686
|
/**
|
|
2687
2687
|
* AgentUI service.
|
|
2688
2688
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2689
|
-
* @version
|
|
2689
|
+
* @version 221.0.0
|
|
2690
2690
|
*/
|
|
2691
2691
|
|
|
2692
2692
|
/**
|
|
@@ -2817,7 +2817,7 @@ class AlertingApi {
|
|
|
2817
2817
|
/**
|
|
2818
2818
|
* Alerting service.
|
|
2819
2819
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2820
|
-
* @version
|
|
2820
|
+
* @version 221.0.0
|
|
2821
2821
|
*/
|
|
2822
2822
|
|
|
2823
2823
|
/**
|
|
@@ -3218,7 +3218,7 @@ class AnalyticsApi {
|
|
|
3218
3218
|
/**
|
|
3219
3219
|
* Analytics service.
|
|
3220
3220
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3221
|
-
* @version
|
|
3221
|
+
* @version 221.0.0
|
|
3222
3222
|
*/
|
|
3223
3223
|
|
|
3224
3224
|
/**
|
|
@@ -6039,7 +6039,7 @@ class ArchitectApi {
|
|
|
6039
6039
|
/**
|
|
6040
6040
|
* Architect service.
|
|
6041
6041
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6042
|
+
* @version 221.0.0
|
|
6043
6043
|
*/
|
|
6044
6044
|
|
|
6045
6045
|
/**
|
|
@@ -7073,7 +7073,6 @@ class ArchitectApi {
|
|
|
7073
7073
|
* Get an IVR IdentityResolutionConfig.
|
|
7074
7074
|
*
|
|
7075
7075
|
* @param {String} ivrId IVR id
|
|
7076
|
-
* getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7077
7076
|
*/
|
|
7078
7077
|
getArchitectIvrIdentityresolution(ivrId) {
|
|
7079
7078
|
// verify the required parameter 'ivrId' is set
|
|
@@ -7106,6 +7105,7 @@ class ArchitectApi {
|
|
|
7106
7105
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
7107
7106
|
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
7108
7107
|
* @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
|
|
7108
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7109
7109
|
*/
|
|
7110
7110
|
getArchitectIvrs(opts) {
|
|
7111
7111
|
opts = opts || {};
|
|
@@ -7115,7 +7115,7 @@ class ArchitectApi {
|
|
|
7115
7115
|
'/api/v2/architect/ivrs',
|
|
7116
7116
|
'GET',
|
|
7117
7117
|
{ },
|
|
7118
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
|
|
7118
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
7119
7119
|
{ },
|
|
7120
7120
|
{ },
|
|
7121
7121
|
null,
|
|
@@ -7434,7 +7434,7 @@ class ArchitectApi {
|
|
|
7434
7434
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7435
7435
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7436
7436
|
* @param {String} opts.sortBy Sort by (default to name)
|
|
7437
|
-
* @param {String} opts.sortOrder Sort order (default to
|
|
7437
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
7438
7438
|
* @param {String} opts.name Name of the Schedule to filter by.
|
|
7439
7439
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7440
7440
|
*/
|
|
@@ -9921,7 +9921,6 @@ class ArchitectApi {
|
|
|
9921
9921
|
*
|
|
9922
9922
|
* @param {String} ivrId IVR id
|
|
9923
9923
|
* @param {Object} body
|
|
9924
|
-
* putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9925
9924
|
*/
|
|
9926
9925
|
putArchitectIvrIdentityresolution(ivrId, body) {
|
|
9927
9926
|
// verify the required parameter 'ivrId' is set
|
|
@@ -10332,7 +10331,7 @@ class AuditApi {
|
|
|
10332
10331
|
/**
|
|
10333
10332
|
* Audit service.
|
|
10334
10333
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10335
|
-
* @version
|
|
10334
|
+
* @version 221.0.0
|
|
10336
10335
|
*/
|
|
10337
10336
|
|
|
10338
10337
|
/**
|
|
@@ -10533,7 +10532,7 @@ class AuthorizationApi {
|
|
|
10533
10532
|
/**
|
|
10534
10533
|
* Authorization service.
|
|
10535
10534
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10536
|
-
* @version
|
|
10535
|
+
* @version 221.0.0
|
|
10537
10536
|
*/
|
|
10538
10537
|
|
|
10539
10538
|
/**
|
|
@@ -12248,7 +12247,7 @@ class BillingApi {
|
|
|
12248
12247
|
/**
|
|
12249
12248
|
* Billing service.
|
|
12250
12249
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12251
|
-
* @version
|
|
12250
|
+
* @version 221.0.0
|
|
12252
12251
|
*/
|
|
12253
12252
|
|
|
12254
12253
|
/**
|
|
@@ -12263,6 +12262,182 @@ class BillingApi {
|
|
|
12263
12262
|
}
|
|
12264
12263
|
|
|
12265
12264
|
|
|
12265
|
+
/**
|
|
12266
|
+
* Get billing contract
|
|
12267
|
+
* Retrieve a single contract from the system.
|
|
12268
|
+
* @param {String} contractId The contract number.
|
|
12269
|
+
* getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12270
|
+
*/
|
|
12271
|
+
getBillingContract(contractId) {
|
|
12272
|
+
// verify the required parameter 'contractId' is set
|
|
12273
|
+
if (contractId === undefined || contractId === null) {
|
|
12274
|
+
throw 'Missing the required parameter "contractId" when calling getBillingContract';
|
|
12275
|
+
}
|
|
12276
|
+
|
|
12277
|
+
return this.apiClient.callApi(
|
|
12278
|
+
'/api/v2/billing/contracts/{contractId}',
|
|
12279
|
+
'GET',
|
|
12280
|
+
{ 'contractId': contractId },
|
|
12281
|
+
{ },
|
|
12282
|
+
{ },
|
|
12283
|
+
{ },
|
|
12284
|
+
null,
|
|
12285
|
+
['PureCloud OAuth'],
|
|
12286
|
+
['application/json'],
|
|
12287
|
+
['application/json']
|
|
12288
|
+
);
|
|
12289
|
+
}
|
|
12290
|
+
|
|
12291
|
+
/**
|
|
12292
|
+
* Get contract billing period
|
|
12293
|
+
* Fetch the billing information for a given Organization by billing period.
|
|
12294
|
+
* @param {String} contractId The contract number.
|
|
12295
|
+
* @param {String} billingPeriodId The Billing Period Id for the Org.
|
|
12296
|
+
* getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12297
|
+
*/
|
|
12298
|
+
getBillingContractBillingperiod(contractId, billingPeriodId) {
|
|
12299
|
+
// verify the required parameter 'contractId' is set
|
|
12300
|
+
if (contractId === undefined || contractId === null) {
|
|
12301
|
+
throw 'Missing the required parameter "contractId" when calling getBillingContractBillingperiod';
|
|
12302
|
+
}
|
|
12303
|
+
// verify the required parameter 'billingPeriodId' is set
|
|
12304
|
+
if (billingPeriodId === undefined || billingPeriodId === null) {
|
|
12305
|
+
throw 'Missing the required parameter "billingPeriodId" when calling getBillingContractBillingperiod';
|
|
12306
|
+
}
|
|
12307
|
+
|
|
12308
|
+
return this.apiClient.callApi(
|
|
12309
|
+
'/api/v2/billing/contracts/{contractId}/billingperiods/{billingPeriodId}',
|
|
12310
|
+
'GET',
|
|
12311
|
+
{ 'contractId': contractId,'billingPeriodId': billingPeriodId },
|
|
12312
|
+
{ },
|
|
12313
|
+
{ },
|
|
12314
|
+
{ },
|
|
12315
|
+
null,
|
|
12316
|
+
['PureCloud OAuth'],
|
|
12317
|
+
['application/json'],
|
|
12318
|
+
['application/json']
|
|
12319
|
+
);
|
|
12320
|
+
}
|
|
12321
|
+
|
|
12322
|
+
/**
|
|
12323
|
+
* Get billing contracts
|
|
12324
|
+
* Retrieve a list of contracts stored in the system.
|
|
12325
|
+
* @param {Object} opts Optional parameters
|
|
12326
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12327
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12328
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12329
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12330
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12331
|
+
* @param {Object} opts.status Filter by the status of contracts
|
|
12332
|
+
* @param {String} opts.externalNumber Filter by the unique external number.
|
|
12333
|
+
* getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12334
|
+
*/
|
|
12335
|
+
getBillingContracts(opts) {
|
|
12336
|
+
opts = opts || {};
|
|
12337
|
+
|
|
12338
|
+
|
|
12339
|
+
return this.apiClient.callApi(
|
|
12340
|
+
'/api/v2/billing/contracts',
|
|
12341
|
+
'GET',
|
|
12342
|
+
{ },
|
|
12343
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': opts['status'],'externalNumber': opts['externalNumber'] },
|
|
12344
|
+
{ },
|
|
12345
|
+
{ },
|
|
12346
|
+
null,
|
|
12347
|
+
['PureCloud OAuth'],
|
|
12348
|
+
['application/json'],
|
|
12349
|
+
['application/json']
|
|
12350
|
+
);
|
|
12351
|
+
}
|
|
12352
|
+
|
|
12353
|
+
/**
|
|
12354
|
+
* Get invoice document
|
|
12355
|
+
* Fetch the document for a specific invoice.
|
|
12356
|
+
* @param {String} invoiceId invoiceId
|
|
12357
|
+
* getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12358
|
+
*/
|
|
12359
|
+
getBillingContractsInvoiceDocument(invoiceId) {
|
|
12360
|
+
// verify the required parameter 'invoiceId' is set
|
|
12361
|
+
if (invoiceId === undefined || invoiceId === null) {
|
|
12362
|
+
throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceDocument';
|
|
12363
|
+
}
|
|
12364
|
+
|
|
12365
|
+
return this.apiClient.callApi(
|
|
12366
|
+
'/api/v2/billing/contracts/invoices/{invoiceId}/document',
|
|
12367
|
+
'GET',
|
|
12368
|
+
{ 'invoiceId': invoiceId },
|
|
12369
|
+
{ },
|
|
12370
|
+
{ },
|
|
12371
|
+
{ },
|
|
12372
|
+
null,
|
|
12373
|
+
['PureCloud OAuth'],
|
|
12374
|
+
['application/json'],
|
|
12375
|
+
['application/json']
|
|
12376
|
+
);
|
|
12377
|
+
}
|
|
12378
|
+
|
|
12379
|
+
/**
|
|
12380
|
+
* Get invoice lines
|
|
12381
|
+
* Fetch a list of all bills for the specified account.
|
|
12382
|
+
* @param {String} invoiceId invoiceId
|
|
12383
|
+
* @param {Object} opts Optional parameters
|
|
12384
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12385
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12386
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12387
|
+
* getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12388
|
+
*/
|
|
12389
|
+
getBillingContractsInvoiceLines(invoiceId, opts) {
|
|
12390
|
+
opts = opts || {};
|
|
12391
|
+
|
|
12392
|
+
// verify the required parameter 'invoiceId' is set
|
|
12393
|
+
if (invoiceId === undefined || invoiceId === null) {
|
|
12394
|
+
throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceLines';
|
|
12395
|
+
}
|
|
12396
|
+
|
|
12397
|
+
return this.apiClient.callApi(
|
|
12398
|
+
'/api/v2/billing/contracts/invoices/{invoiceId}/lines',
|
|
12399
|
+
'GET',
|
|
12400
|
+
{ 'invoiceId': invoiceId },
|
|
12401
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
12402
|
+
{ },
|
|
12403
|
+
{ },
|
|
12404
|
+
null,
|
|
12405
|
+
['PureCloud OAuth'],
|
|
12406
|
+
['application/json'],
|
|
12407
|
+
['application/json']
|
|
12408
|
+
);
|
|
12409
|
+
}
|
|
12410
|
+
|
|
12411
|
+
/**
|
|
12412
|
+
* Get invoices
|
|
12413
|
+
* Retrieve a list of invoices stored in the system.
|
|
12414
|
+
* @param {Object} opts Optional parameters
|
|
12415
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12416
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12417
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12418
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12419
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12420
|
+
* @param {Object} opts.paymentStatus Payment Status
|
|
12421
|
+
* getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12422
|
+
*/
|
|
12423
|
+
getBillingContractsInvoices(opts) {
|
|
12424
|
+
opts = opts || {};
|
|
12425
|
+
|
|
12426
|
+
|
|
12427
|
+
return this.apiClient.callApi(
|
|
12428
|
+
'/api/v2/billing/contracts/invoices',
|
|
12429
|
+
'GET',
|
|
12430
|
+
{ },
|
|
12431
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'paymentStatus': opts['paymentStatus'] },
|
|
12432
|
+
{ },
|
|
12433
|
+
{ },
|
|
12434
|
+
null,
|
|
12435
|
+
['PureCloud OAuth'],
|
|
12436
|
+
['application/json'],
|
|
12437
|
+
['application/json']
|
|
12438
|
+
);
|
|
12439
|
+
}
|
|
12440
|
+
|
|
12266
12441
|
/**
|
|
12267
12442
|
* Get a report of the billable license usages
|
|
12268
12443
|
* Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If responses status is InProgress, wait a few seconds, then try the same request again.
|
|
@@ -12324,11 +12499,925 @@ class BillingApi {
|
|
|
12324
12499
|
|
|
12325
12500
|
}
|
|
12326
12501
|
|
|
12502
|
+
class BusinessRulesApi {
|
|
12503
|
+
/**
|
|
12504
|
+
* BusinessRules service.
|
|
12505
|
+
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12506
|
+
* @version 221.0.0
|
|
12507
|
+
*/
|
|
12508
|
+
|
|
12509
|
+
/**
|
|
12510
|
+
* Constructs a new BusinessRulesApi.
|
|
12511
|
+
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12512
|
+
* @class
|
|
12513
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
12514
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
12515
|
+
*/
|
|
12516
|
+
constructor(apiClient) {
|
|
12517
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
12518
|
+
}
|
|
12519
|
+
|
|
12520
|
+
|
|
12521
|
+
/**
|
|
12522
|
+
* Delete a decision table
|
|
12523
|
+
*
|
|
12524
|
+
* @param {String} tableId Table ID
|
|
12525
|
+
* @param {Object} opts Optional parameters
|
|
12526
|
+
* @param {Boolean} opts.forceDelete Force delete decision table (under certain conditions) (default to false)
|
|
12527
|
+
* deleteBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12528
|
+
*/
|
|
12529
|
+
deleteBusinessrulesDecisiontable(tableId, opts) {
|
|
12530
|
+
opts = opts || {};
|
|
12531
|
+
|
|
12532
|
+
// verify the required parameter 'tableId' is set
|
|
12533
|
+
if (tableId === undefined || tableId === null) {
|
|
12534
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontable';
|
|
12535
|
+
}
|
|
12536
|
+
|
|
12537
|
+
return this.apiClient.callApi(
|
|
12538
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12539
|
+
'DELETE',
|
|
12540
|
+
{ 'tableId': tableId },
|
|
12541
|
+
{ 'forceDelete': opts['forceDelete'] },
|
|
12542
|
+
{ },
|
|
12543
|
+
{ },
|
|
12544
|
+
null,
|
|
12545
|
+
['PureCloud OAuth'],
|
|
12546
|
+
['application/json'],
|
|
12547
|
+
['application/json']
|
|
12548
|
+
);
|
|
12549
|
+
}
|
|
12550
|
+
|
|
12551
|
+
/**
|
|
12552
|
+
* Delete a decision table version
|
|
12553
|
+
*
|
|
12554
|
+
* @param {String} tableId Table ID
|
|
12555
|
+
* @param {Number} tableVersion Table Version
|
|
12556
|
+
* deleteBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12557
|
+
*/
|
|
12558
|
+
deleteBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
12559
|
+
// verify the required parameter 'tableId' is set
|
|
12560
|
+
if (tableId === undefined || tableId === null) {
|
|
12561
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersion';
|
|
12562
|
+
}
|
|
12563
|
+
// verify the required parameter 'tableVersion' is set
|
|
12564
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12565
|
+
throw 'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersion';
|
|
12566
|
+
}
|
|
12567
|
+
|
|
12568
|
+
return this.apiClient.callApi(
|
|
12569
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
12570
|
+
'DELETE',
|
|
12571
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12572
|
+
{ },
|
|
12573
|
+
{ },
|
|
12574
|
+
{ },
|
|
12575
|
+
null,
|
|
12576
|
+
['PureCloud OAuth'],
|
|
12577
|
+
['application/json'],
|
|
12578
|
+
['application/json']
|
|
12579
|
+
);
|
|
12580
|
+
}
|
|
12581
|
+
|
|
12582
|
+
/**
|
|
12583
|
+
* Delete a decision table row
|
|
12584
|
+
*
|
|
12585
|
+
* @param {String} tableId Table ID
|
|
12586
|
+
* @param {Number} tableVersion Table Version
|
|
12587
|
+
* @param {String} rowId Row ID
|
|
12588
|
+
* deleteBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12589
|
+
*/
|
|
12590
|
+
deleteBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
12591
|
+
// verify the required parameter 'tableId' is set
|
|
12592
|
+
if (tableId === undefined || tableId === null) {
|
|
12593
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12594
|
+
}
|
|
12595
|
+
// verify the required parameter 'tableVersion' is set
|
|
12596
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12597
|
+
throw 'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12598
|
+
}
|
|
12599
|
+
// verify the required parameter 'rowId' is set
|
|
12600
|
+
if (rowId === undefined || rowId === null) {
|
|
12601
|
+
throw 'Missing the required parameter "rowId" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12602
|
+
}
|
|
12603
|
+
|
|
12604
|
+
return this.apiClient.callApi(
|
|
12605
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
12606
|
+
'DELETE',
|
|
12607
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
12608
|
+
{ },
|
|
12609
|
+
{ },
|
|
12610
|
+
{ },
|
|
12611
|
+
null,
|
|
12612
|
+
['PureCloud OAuth'],
|
|
12613
|
+
['application/json'],
|
|
12614
|
+
['application/json']
|
|
12615
|
+
);
|
|
12616
|
+
}
|
|
12617
|
+
|
|
12618
|
+
/**
|
|
12619
|
+
* Delete a schema
|
|
12620
|
+
*
|
|
12621
|
+
* @param {String} schemaId Schema ID
|
|
12622
|
+
* deleteBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12623
|
+
*/
|
|
12624
|
+
deleteBusinessrulesSchema(schemaId) {
|
|
12625
|
+
// verify the required parameter 'schemaId' is set
|
|
12626
|
+
if (schemaId === undefined || schemaId === null) {
|
|
12627
|
+
throw 'Missing the required parameter "schemaId" when calling deleteBusinessrulesSchema';
|
|
12628
|
+
}
|
|
12629
|
+
|
|
12630
|
+
return this.apiClient.callApi(
|
|
12631
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
12632
|
+
'DELETE',
|
|
12633
|
+
{ 'schemaId': schemaId },
|
|
12634
|
+
{ },
|
|
12635
|
+
{ },
|
|
12636
|
+
{ },
|
|
12637
|
+
null,
|
|
12638
|
+
['PureCloud OAuth'],
|
|
12639
|
+
['application/json'],
|
|
12640
|
+
['application/json']
|
|
12641
|
+
);
|
|
12642
|
+
}
|
|
12643
|
+
|
|
12644
|
+
/**
|
|
12645
|
+
* Get a decision table
|
|
12646
|
+
*
|
|
12647
|
+
* @param {String} tableId Table ID
|
|
12648
|
+
* getBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12649
|
+
*/
|
|
12650
|
+
getBusinessrulesDecisiontable(tableId) {
|
|
12651
|
+
// verify the required parameter 'tableId' is set
|
|
12652
|
+
if (tableId === undefined || tableId === null) {
|
|
12653
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontable';
|
|
12654
|
+
}
|
|
12655
|
+
|
|
12656
|
+
return this.apiClient.callApi(
|
|
12657
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12658
|
+
'GET',
|
|
12659
|
+
{ 'tableId': tableId },
|
|
12660
|
+
{ },
|
|
12661
|
+
{ },
|
|
12662
|
+
{ },
|
|
12663
|
+
null,
|
|
12664
|
+
['PureCloud OAuth'],
|
|
12665
|
+
['application/json'],
|
|
12666
|
+
['application/json']
|
|
12667
|
+
);
|
|
12668
|
+
}
|
|
12669
|
+
|
|
12670
|
+
/**
|
|
12671
|
+
* Get a decision table version
|
|
12672
|
+
*
|
|
12673
|
+
* @param {String} tableId Table ID
|
|
12674
|
+
* @param {Number} tableVersion Table Version
|
|
12675
|
+
* getBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12676
|
+
*/
|
|
12677
|
+
getBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
12678
|
+
// verify the required parameter 'tableId' is set
|
|
12679
|
+
if (tableId === undefined || tableId === null) {
|
|
12680
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersion';
|
|
12681
|
+
}
|
|
12682
|
+
// verify the required parameter 'tableVersion' is set
|
|
12683
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12684
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersion';
|
|
12685
|
+
}
|
|
12686
|
+
|
|
12687
|
+
return this.apiClient.callApi(
|
|
12688
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
12689
|
+
'GET',
|
|
12690
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12691
|
+
{ },
|
|
12692
|
+
{ },
|
|
12693
|
+
{ },
|
|
12694
|
+
null,
|
|
12695
|
+
['PureCloud OAuth'],
|
|
12696
|
+
['application/json'],
|
|
12697
|
+
['application/json']
|
|
12698
|
+
);
|
|
12699
|
+
}
|
|
12700
|
+
|
|
12701
|
+
/**
|
|
12702
|
+
* Get a decision table row
|
|
12703
|
+
*
|
|
12704
|
+
* @param {String} tableId Table ID
|
|
12705
|
+
* @param {Number} tableVersion Table Version
|
|
12706
|
+
* @param {String} rowId Row ID
|
|
12707
|
+
* getBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12708
|
+
*/
|
|
12709
|
+
getBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
12710
|
+
// verify the required parameter 'tableId' is set
|
|
12711
|
+
if (tableId === undefined || tableId === null) {
|
|
12712
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12713
|
+
}
|
|
12714
|
+
// verify the required parameter 'tableVersion' is set
|
|
12715
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12716
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12717
|
+
}
|
|
12718
|
+
// verify the required parameter 'rowId' is set
|
|
12719
|
+
if (rowId === undefined || rowId === null) {
|
|
12720
|
+
throw 'Missing the required parameter "rowId" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12721
|
+
}
|
|
12722
|
+
|
|
12723
|
+
return this.apiClient.callApi(
|
|
12724
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
12725
|
+
'GET',
|
|
12726
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
12727
|
+
{ },
|
|
12728
|
+
{ },
|
|
12729
|
+
{ },
|
|
12730
|
+
null,
|
|
12731
|
+
['PureCloud OAuth'],
|
|
12732
|
+
['application/json'],
|
|
12733
|
+
['application/json']
|
|
12734
|
+
);
|
|
12735
|
+
}
|
|
12736
|
+
|
|
12737
|
+
/**
|
|
12738
|
+
* Get a list of decision table rows.
|
|
12739
|
+
*
|
|
12740
|
+
* @param {String} tableId Table ID
|
|
12741
|
+
* @param {Number} tableVersion Table Version
|
|
12742
|
+
* @param {Object} opts Optional parameters
|
|
12743
|
+
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
12744
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
12745
|
+
* getBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12746
|
+
*/
|
|
12747
|
+
getBusinessrulesDecisiontableVersionRows(tableId, tableVersion, opts) {
|
|
12748
|
+
opts = opts || {};
|
|
12749
|
+
|
|
12750
|
+
// verify the required parameter 'tableId' is set
|
|
12751
|
+
if (tableId === undefined || tableId === null) {
|
|
12752
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRows';
|
|
12753
|
+
}
|
|
12754
|
+
// verify the required parameter 'tableVersion' is set
|
|
12755
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12756
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRows';
|
|
12757
|
+
}
|
|
12758
|
+
|
|
12759
|
+
return this.apiClient.callApi(
|
|
12760
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows',
|
|
12761
|
+
'GET',
|
|
12762
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12763
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
12764
|
+
{ },
|
|
12765
|
+
{ },
|
|
12766
|
+
null,
|
|
12767
|
+
['PureCloud OAuth'],
|
|
12768
|
+
['application/json'],
|
|
12769
|
+
['application/json']
|
|
12770
|
+
);
|
|
12771
|
+
}
|
|
12772
|
+
|
|
12773
|
+
/**
|
|
12774
|
+
* Get a list of decision table versions
|
|
12775
|
+
*
|
|
12776
|
+
* @param {String} tableId Table ID
|
|
12777
|
+
* @param {Object} opts Optional parameters
|
|
12778
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12779
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12780
|
+
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
12781
|
+
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12782
|
+
*/
|
|
12783
|
+
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
12784
|
+
opts = opts || {};
|
|
12785
|
+
|
|
12786
|
+
// verify the required parameter 'tableId' is set
|
|
12787
|
+
if (tableId === undefined || tableId === null) {
|
|
12788
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersions';
|
|
12789
|
+
}
|
|
12790
|
+
|
|
12791
|
+
return this.apiClient.callApi(
|
|
12792
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
12793
|
+
'GET',
|
|
12794
|
+
{ 'tableId': tableId },
|
|
12795
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
12796
|
+
{ },
|
|
12797
|
+
{ },
|
|
12798
|
+
null,
|
|
12799
|
+
['PureCloud OAuth'],
|
|
12800
|
+
['application/json'],
|
|
12801
|
+
['application/json']
|
|
12802
|
+
);
|
|
12803
|
+
}
|
|
12804
|
+
|
|
12805
|
+
/**
|
|
12806
|
+
* Get a list of decision tables.
|
|
12807
|
+
*
|
|
12808
|
+
* @param {Object} opts Optional parameters
|
|
12809
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12810
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12811
|
+
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
12812
|
+
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12813
|
+
*/
|
|
12814
|
+
getBusinessrulesDecisiontables(opts) {
|
|
12815
|
+
opts = opts || {};
|
|
12816
|
+
|
|
12817
|
+
|
|
12818
|
+
return this.apiClient.callApi(
|
|
12819
|
+
'/api/v2/businessrules/decisiontables',
|
|
12820
|
+
'GET',
|
|
12821
|
+
{ },
|
|
12822
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
12823
|
+
{ },
|
|
12824
|
+
{ },
|
|
12825
|
+
null,
|
|
12826
|
+
['PureCloud OAuth'],
|
|
12827
|
+
['application/json'],
|
|
12828
|
+
['application/json']
|
|
12829
|
+
);
|
|
12830
|
+
}
|
|
12831
|
+
|
|
12832
|
+
/**
|
|
12833
|
+
* Search for decision tables.
|
|
12834
|
+
*
|
|
12835
|
+
* @param {Object} opts Optional parameters
|
|
12836
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12837
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12838
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12839
|
+
* @param {String} opts.schemaId Search for decision tables that use the schema with this ID. Cannot be combined with name search. Search results will not be paginated if used.
|
|
12840
|
+
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name. Cannot be combined with schema search. Search results will not be paginated if used.
|
|
12841
|
+
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12842
|
+
*/
|
|
12843
|
+
getBusinessrulesDecisiontablesSearch(opts) {
|
|
12844
|
+
opts = opts || {};
|
|
12845
|
+
|
|
12846
|
+
|
|
12847
|
+
return this.apiClient.callApi(
|
|
12848
|
+
'/api/v2/businessrules/decisiontables/search',
|
|
12849
|
+
'GET',
|
|
12850
|
+
{ },
|
|
12851
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'] },
|
|
12852
|
+
{ },
|
|
12853
|
+
{ },
|
|
12854
|
+
null,
|
|
12855
|
+
['PureCloud OAuth'],
|
|
12856
|
+
['application/json'],
|
|
12857
|
+
['application/json']
|
|
12858
|
+
);
|
|
12859
|
+
}
|
|
12860
|
+
|
|
12861
|
+
/**
|
|
12862
|
+
* Get a schema
|
|
12863
|
+
*
|
|
12864
|
+
* @param {String} schemaId Schema ID
|
|
12865
|
+
* getBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12866
|
+
*/
|
|
12867
|
+
getBusinessrulesSchema(schemaId) {
|
|
12868
|
+
// verify the required parameter 'schemaId' is set
|
|
12869
|
+
if (schemaId === undefined || schemaId === null) {
|
|
12870
|
+
throw 'Missing the required parameter "schemaId" when calling getBusinessrulesSchema';
|
|
12871
|
+
}
|
|
12872
|
+
|
|
12873
|
+
return this.apiClient.callApi(
|
|
12874
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
12875
|
+
'GET',
|
|
12876
|
+
{ 'schemaId': schemaId },
|
|
12877
|
+
{ },
|
|
12878
|
+
{ },
|
|
12879
|
+
{ },
|
|
12880
|
+
null,
|
|
12881
|
+
['PureCloud OAuth'],
|
|
12882
|
+
['application/json'],
|
|
12883
|
+
['application/json']
|
|
12884
|
+
);
|
|
12885
|
+
}
|
|
12886
|
+
|
|
12887
|
+
/**
|
|
12888
|
+
* Get a list of schemas.
|
|
12889
|
+
*
|
|
12890
|
+
* getBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12891
|
+
*/
|
|
12892
|
+
getBusinessrulesSchemas() {
|
|
12893
|
+
|
|
12894
|
+
return this.apiClient.callApi(
|
|
12895
|
+
'/api/v2/businessrules/schemas',
|
|
12896
|
+
'GET',
|
|
12897
|
+
{ },
|
|
12898
|
+
{ },
|
|
12899
|
+
{ },
|
|
12900
|
+
{ },
|
|
12901
|
+
null,
|
|
12902
|
+
['PureCloud OAuth'],
|
|
12903
|
+
['application/json'],
|
|
12904
|
+
['application/json']
|
|
12905
|
+
);
|
|
12906
|
+
}
|
|
12907
|
+
|
|
12908
|
+
/**
|
|
12909
|
+
* Get a specific named core type.
|
|
12910
|
+
*
|
|
12911
|
+
* @param {String} coreTypeName The core type's name
|
|
12912
|
+
* getBusinessrulesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12913
|
+
*/
|
|
12914
|
+
getBusinessrulesSchemasCoretype(coreTypeName) {
|
|
12915
|
+
// verify the required parameter 'coreTypeName' is set
|
|
12916
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
12917
|
+
throw 'Missing the required parameter "coreTypeName" when calling getBusinessrulesSchemasCoretype';
|
|
12918
|
+
}
|
|
12919
|
+
|
|
12920
|
+
return this.apiClient.callApi(
|
|
12921
|
+
'/api/v2/businessrules/schemas/coretypes/{coreTypeName}',
|
|
12922
|
+
'GET',
|
|
12923
|
+
{ 'coreTypeName': coreTypeName },
|
|
12924
|
+
{ },
|
|
12925
|
+
{ },
|
|
12926
|
+
{ },
|
|
12927
|
+
null,
|
|
12928
|
+
['PureCloud OAuth'],
|
|
12929
|
+
['application/json'],
|
|
12930
|
+
['application/json']
|
|
12931
|
+
);
|
|
12932
|
+
}
|
|
12933
|
+
|
|
12934
|
+
/**
|
|
12935
|
+
* Get the core types from which all schemas are built.
|
|
12936
|
+
*
|
|
12937
|
+
* getBusinessrulesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12938
|
+
*/
|
|
12939
|
+
getBusinessrulesSchemasCoretypes() {
|
|
12940
|
+
|
|
12941
|
+
return this.apiClient.callApi(
|
|
12942
|
+
'/api/v2/businessrules/schemas/coretypes',
|
|
12943
|
+
'GET',
|
|
12944
|
+
{ },
|
|
12945
|
+
{ },
|
|
12946
|
+
{ },
|
|
12947
|
+
{ },
|
|
12948
|
+
null,
|
|
12949
|
+
['PureCloud OAuth'],
|
|
12950
|
+
['application/json'],
|
|
12951
|
+
['application/json']
|
|
12952
|
+
);
|
|
12953
|
+
}
|
|
12954
|
+
|
|
12955
|
+
/**
|
|
12956
|
+
* Update a decision table
|
|
12957
|
+
*
|
|
12958
|
+
* @param {String} tableId Table ID
|
|
12959
|
+
* @param {Object} body Decision Table
|
|
12960
|
+
* patchBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12961
|
+
*/
|
|
12962
|
+
patchBusinessrulesDecisiontable(tableId, body) {
|
|
12963
|
+
// verify the required parameter 'tableId' is set
|
|
12964
|
+
if (tableId === undefined || tableId === null) {
|
|
12965
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontable';
|
|
12966
|
+
}
|
|
12967
|
+
// verify the required parameter 'body' is set
|
|
12968
|
+
if (body === undefined || body === null) {
|
|
12969
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontable';
|
|
12970
|
+
}
|
|
12971
|
+
|
|
12972
|
+
return this.apiClient.callApi(
|
|
12973
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12974
|
+
'PATCH',
|
|
12975
|
+
{ 'tableId': tableId },
|
|
12976
|
+
{ },
|
|
12977
|
+
{ },
|
|
12978
|
+
{ },
|
|
12979
|
+
body,
|
|
12980
|
+
['PureCloud OAuth'],
|
|
12981
|
+
['application/json'],
|
|
12982
|
+
['application/json']
|
|
12983
|
+
);
|
|
12984
|
+
}
|
|
12985
|
+
|
|
12986
|
+
/**
|
|
12987
|
+
* Update a decision table version
|
|
12988
|
+
*
|
|
12989
|
+
* @param {String} tableId Table ID
|
|
12990
|
+
* @param {Number} tableVersion Table Version
|
|
12991
|
+
* @param {Object} body Decision Table
|
|
12992
|
+
* patchBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12993
|
+
*/
|
|
12994
|
+
patchBusinessrulesDecisiontableVersion(tableId, tableVersion, body) {
|
|
12995
|
+
// verify the required parameter 'tableId' is set
|
|
12996
|
+
if (tableId === undefined || tableId === null) {
|
|
12997
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersion';
|
|
12998
|
+
}
|
|
12999
|
+
// verify the required parameter 'tableVersion' is set
|
|
13000
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13001
|
+
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersion';
|
|
13002
|
+
}
|
|
13003
|
+
// verify the required parameter 'body' is set
|
|
13004
|
+
if (body === undefined || body === null) {
|
|
13005
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersion';
|
|
13006
|
+
}
|
|
13007
|
+
|
|
13008
|
+
return this.apiClient.callApi(
|
|
13009
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
13010
|
+
'PATCH',
|
|
13011
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13012
|
+
{ },
|
|
13013
|
+
{ },
|
|
13014
|
+
{ },
|
|
13015
|
+
body,
|
|
13016
|
+
['PureCloud OAuth'],
|
|
13017
|
+
['application/json'],
|
|
13018
|
+
['application/json']
|
|
13019
|
+
);
|
|
13020
|
+
}
|
|
13021
|
+
|
|
13022
|
+
/**
|
|
13023
|
+
* Update a decision table row
|
|
13024
|
+
*
|
|
13025
|
+
* @param {String} tableId Table ID
|
|
13026
|
+
* @param {Number} tableVersion Table Version
|
|
13027
|
+
* @param {String} rowId Row ID
|
|
13028
|
+
* @param {Object} body Update decision table row request
|
|
13029
|
+
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13030
|
+
*/
|
|
13031
|
+
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
13032
|
+
// verify the required parameter 'tableId' is set
|
|
13033
|
+
if (tableId === undefined || tableId === null) {
|
|
13034
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13035
|
+
}
|
|
13036
|
+
// verify the required parameter 'tableVersion' is set
|
|
13037
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13038
|
+
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13039
|
+
}
|
|
13040
|
+
// verify the required parameter 'rowId' is set
|
|
13041
|
+
if (rowId === undefined || rowId === null) {
|
|
13042
|
+
throw 'Missing the required parameter "rowId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13043
|
+
}
|
|
13044
|
+
// verify the required parameter 'body' is set
|
|
13045
|
+
if (body === undefined || body === null) {
|
|
13046
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13047
|
+
}
|
|
13048
|
+
|
|
13049
|
+
return this.apiClient.callApi(
|
|
13050
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
13051
|
+
'PATCH',
|
|
13052
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
13053
|
+
{ },
|
|
13054
|
+
{ },
|
|
13055
|
+
{ },
|
|
13056
|
+
body,
|
|
13057
|
+
['PureCloud OAuth'],
|
|
13058
|
+
['application/json'],
|
|
13059
|
+
['application/json']
|
|
13060
|
+
);
|
|
13061
|
+
}
|
|
13062
|
+
|
|
13063
|
+
/**
|
|
13064
|
+
* Execute a published decision table
|
|
13065
|
+
*
|
|
13066
|
+
* @param {String} tableId Table ID
|
|
13067
|
+
* @param {Object} body Decision Table
|
|
13068
|
+
* postBusinessrulesDecisiontableExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13069
|
+
*/
|
|
13070
|
+
postBusinessrulesDecisiontableExecute(tableId, body) {
|
|
13071
|
+
// verify the required parameter 'tableId' is set
|
|
13072
|
+
if (tableId === undefined || tableId === null) {
|
|
13073
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExecute';
|
|
13074
|
+
}
|
|
13075
|
+
// verify the required parameter 'body' is set
|
|
13076
|
+
if (body === undefined || body === null) {
|
|
13077
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExecute';
|
|
13078
|
+
}
|
|
13079
|
+
|
|
13080
|
+
return this.apiClient.callApi(
|
|
13081
|
+
'/api/v2/businessrules/decisiontables/{tableId}/execute',
|
|
13082
|
+
'POST',
|
|
13083
|
+
{ 'tableId': tableId },
|
|
13084
|
+
{ },
|
|
13085
|
+
{ },
|
|
13086
|
+
{ },
|
|
13087
|
+
body,
|
|
13088
|
+
['PureCloud OAuth'],
|
|
13089
|
+
['application/json'],
|
|
13090
|
+
['application/json']
|
|
13091
|
+
);
|
|
13092
|
+
}
|
|
13093
|
+
|
|
13094
|
+
/**
|
|
13095
|
+
* Copy a decision table version
|
|
13096
|
+
*
|
|
13097
|
+
* @param {String} tableId Table ID
|
|
13098
|
+
* @param {Number} tableVersion Table Version
|
|
13099
|
+
* @param {Object} body Decision Table
|
|
13100
|
+
* postBusinessrulesDecisiontableVersionCopy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13101
|
+
*/
|
|
13102
|
+
postBusinessrulesDecisiontableVersionCopy(tableId, tableVersion, body) {
|
|
13103
|
+
// verify the required parameter 'tableId' is set
|
|
13104
|
+
if (tableId === undefined || tableId === null) {
|
|
13105
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13106
|
+
}
|
|
13107
|
+
// verify the required parameter 'tableVersion' is set
|
|
13108
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13109
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13110
|
+
}
|
|
13111
|
+
// verify the required parameter 'body' is set
|
|
13112
|
+
if (body === undefined || body === null) {
|
|
13113
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13114
|
+
}
|
|
13115
|
+
|
|
13116
|
+
return this.apiClient.callApi(
|
|
13117
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/copy',
|
|
13118
|
+
'POST',
|
|
13119
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13120
|
+
{ },
|
|
13121
|
+
{ },
|
|
13122
|
+
{ },
|
|
13123
|
+
body,
|
|
13124
|
+
['PureCloud OAuth'],
|
|
13125
|
+
['application/json'],
|
|
13126
|
+
['application/json']
|
|
13127
|
+
);
|
|
13128
|
+
}
|
|
13129
|
+
|
|
13130
|
+
/**
|
|
13131
|
+
* Execute a decision table version
|
|
13132
|
+
*
|
|
13133
|
+
* @param {String} tableId Table ID
|
|
13134
|
+
* @param {Number} tableVersion Table Version
|
|
13135
|
+
* @param {Object} body Decision Table
|
|
13136
|
+
* postBusinessrulesDecisiontableVersionExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13137
|
+
*/
|
|
13138
|
+
postBusinessrulesDecisiontableVersionExecute(tableId, tableVersion, body) {
|
|
13139
|
+
// verify the required parameter 'tableId' is set
|
|
13140
|
+
if (tableId === undefined || tableId === null) {
|
|
13141
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13142
|
+
}
|
|
13143
|
+
// verify the required parameter 'tableVersion' is set
|
|
13144
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13145
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13146
|
+
}
|
|
13147
|
+
// verify the required parameter 'body' is set
|
|
13148
|
+
if (body === undefined || body === null) {
|
|
13149
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13150
|
+
}
|
|
13151
|
+
|
|
13152
|
+
return this.apiClient.callApi(
|
|
13153
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/execute',
|
|
13154
|
+
'POST',
|
|
13155
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13156
|
+
{ },
|
|
13157
|
+
{ },
|
|
13158
|
+
{ },
|
|
13159
|
+
body,
|
|
13160
|
+
['PureCloud OAuth'],
|
|
13161
|
+
['application/json'],
|
|
13162
|
+
['application/json']
|
|
13163
|
+
);
|
|
13164
|
+
}
|
|
13165
|
+
|
|
13166
|
+
/**
|
|
13167
|
+
* Create a decision table row
|
|
13168
|
+
*
|
|
13169
|
+
* @param {String} tableId Table ID
|
|
13170
|
+
* @param {Number} tableVersion Table Version
|
|
13171
|
+
* @param {Object} body Create decision table row request
|
|
13172
|
+
* postBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13173
|
+
*/
|
|
13174
|
+
postBusinessrulesDecisiontableVersionRows(tableId, tableVersion, body) {
|
|
13175
|
+
// verify the required parameter 'tableId' is set
|
|
13176
|
+
if (tableId === undefined || tableId === null) {
|
|
13177
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13178
|
+
}
|
|
13179
|
+
// verify the required parameter 'tableVersion' is set
|
|
13180
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13181
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13182
|
+
}
|
|
13183
|
+
// verify the required parameter 'body' is set
|
|
13184
|
+
if (body === undefined || body === null) {
|
|
13185
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13186
|
+
}
|
|
13187
|
+
|
|
13188
|
+
return this.apiClient.callApi(
|
|
13189
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows',
|
|
13190
|
+
'POST',
|
|
13191
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13192
|
+
{ },
|
|
13193
|
+
{ },
|
|
13194
|
+
{ },
|
|
13195
|
+
body,
|
|
13196
|
+
['PureCloud OAuth'],
|
|
13197
|
+
['application/json'],
|
|
13198
|
+
['application/json']
|
|
13199
|
+
);
|
|
13200
|
+
}
|
|
13201
|
+
|
|
13202
|
+
/**
|
|
13203
|
+
* Search for decision table rows
|
|
13204
|
+
*
|
|
13205
|
+
* @param {String} tableId Table ID
|
|
13206
|
+
* @param {Number} tableVersion Table Version
|
|
13207
|
+
* @param {Object} body Search decision table rows request
|
|
13208
|
+
* @param {Object} opts Optional parameters
|
|
13209
|
+
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
13210
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
13211
|
+
* postBusinessrulesDecisiontableVersionRowsSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13212
|
+
*/
|
|
13213
|
+
postBusinessrulesDecisiontableVersionRowsSearch(tableId, tableVersion, body, opts) {
|
|
13214
|
+
opts = opts || {};
|
|
13215
|
+
|
|
13216
|
+
// verify the required parameter 'tableId' is set
|
|
13217
|
+
if (tableId === undefined || tableId === null) {
|
|
13218
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13219
|
+
}
|
|
13220
|
+
// verify the required parameter 'tableVersion' is set
|
|
13221
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13222
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13223
|
+
}
|
|
13224
|
+
// verify the required parameter 'body' is set
|
|
13225
|
+
if (body === undefined || body === null) {
|
|
13226
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13227
|
+
}
|
|
13228
|
+
|
|
13229
|
+
return this.apiClient.callApi(
|
|
13230
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/search',
|
|
13231
|
+
'POST',
|
|
13232
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13233
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
13234
|
+
{ },
|
|
13235
|
+
{ },
|
|
13236
|
+
body,
|
|
13237
|
+
['PureCloud OAuth'],
|
|
13238
|
+
['application/json'],
|
|
13239
|
+
['application/json']
|
|
13240
|
+
);
|
|
13241
|
+
}
|
|
13242
|
+
|
|
13243
|
+
/**
|
|
13244
|
+
* Update the Business Rules Schema to the latest version for a given decision table version
|
|
13245
|
+
*
|
|
13246
|
+
* @param {String} tableId Table ID
|
|
13247
|
+
* @param {Number} tableVersion Table Version
|
|
13248
|
+
* postBusinessrulesDecisiontableVersionSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13249
|
+
*/
|
|
13250
|
+
postBusinessrulesDecisiontableVersionSync(tableId, tableVersion) {
|
|
13251
|
+
// verify the required parameter 'tableId' is set
|
|
13252
|
+
if (tableId === undefined || tableId === null) {
|
|
13253
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionSync';
|
|
13254
|
+
}
|
|
13255
|
+
// verify the required parameter 'tableVersion' is set
|
|
13256
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13257
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionSync';
|
|
13258
|
+
}
|
|
13259
|
+
|
|
13260
|
+
return this.apiClient.callApi(
|
|
13261
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/sync',
|
|
13262
|
+
'POST',
|
|
13263
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13264
|
+
{ },
|
|
13265
|
+
{ },
|
|
13266
|
+
{ },
|
|
13267
|
+
null,
|
|
13268
|
+
['PureCloud OAuth'],
|
|
13269
|
+
['application/json'],
|
|
13270
|
+
['application/json']
|
|
13271
|
+
);
|
|
13272
|
+
}
|
|
13273
|
+
|
|
13274
|
+
/**
|
|
13275
|
+
* Create a new decision table version
|
|
13276
|
+
*
|
|
13277
|
+
* @param {String} tableId Table ID
|
|
13278
|
+
* postBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13279
|
+
*/
|
|
13280
|
+
postBusinessrulesDecisiontableVersions(tableId) {
|
|
13281
|
+
// verify the required parameter 'tableId' is set
|
|
13282
|
+
if (tableId === undefined || tableId === null) {
|
|
13283
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersions';
|
|
13284
|
+
}
|
|
13285
|
+
|
|
13286
|
+
return this.apiClient.callApi(
|
|
13287
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
13288
|
+
'POST',
|
|
13289
|
+
{ 'tableId': tableId },
|
|
13290
|
+
{ },
|
|
13291
|
+
{ },
|
|
13292
|
+
{ },
|
|
13293
|
+
null,
|
|
13294
|
+
['PureCloud OAuth'],
|
|
13295
|
+
['application/json'],
|
|
13296
|
+
['application/json']
|
|
13297
|
+
);
|
|
13298
|
+
}
|
|
13299
|
+
|
|
13300
|
+
/**
|
|
13301
|
+
* Create a decision table
|
|
13302
|
+
*
|
|
13303
|
+
* @param {Object} body Decision Table
|
|
13304
|
+
* postBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13305
|
+
*/
|
|
13306
|
+
postBusinessrulesDecisiontables(body) {
|
|
13307
|
+
// verify the required parameter 'body' is set
|
|
13308
|
+
if (body === undefined || body === null) {
|
|
13309
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontables';
|
|
13310
|
+
}
|
|
13311
|
+
|
|
13312
|
+
return this.apiClient.callApi(
|
|
13313
|
+
'/api/v2/businessrules/decisiontables',
|
|
13314
|
+
'POST',
|
|
13315
|
+
{ },
|
|
13316
|
+
{ },
|
|
13317
|
+
{ },
|
|
13318
|
+
{ },
|
|
13319
|
+
body,
|
|
13320
|
+
['PureCloud OAuth'],
|
|
13321
|
+
['application/json'],
|
|
13322
|
+
['application/json']
|
|
13323
|
+
);
|
|
13324
|
+
}
|
|
13325
|
+
|
|
13326
|
+
/**
|
|
13327
|
+
* Create a schema
|
|
13328
|
+
*
|
|
13329
|
+
* @param {Object} body Schema
|
|
13330
|
+
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13331
|
+
*/
|
|
13332
|
+
postBusinessrulesSchemas(body) {
|
|
13333
|
+
// verify the required parameter 'body' is set
|
|
13334
|
+
if (body === undefined || body === null) {
|
|
13335
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesSchemas';
|
|
13336
|
+
}
|
|
13337
|
+
|
|
13338
|
+
return this.apiClient.callApi(
|
|
13339
|
+
'/api/v2/businessrules/schemas',
|
|
13340
|
+
'POST',
|
|
13341
|
+
{ },
|
|
13342
|
+
{ },
|
|
13343
|
+
{ },
|
|
13344
|
+
{ },
|
|
13345
|
+
body,
|
|
13346
|
+
['PureCloud OAuth'],
|
|
13347
|
+
['application/json'],
|
|
13348
|
+
['application/json']
|
|
13349
|
+
);
|
|
13350
|
+
}
|
|
13351
|
+
|
|
13352
|
+
/**
|
|
13353
|
+
* Publish a decision table version
|
|
13354
|
+
*
|
|
13355
|
+
* @param {String} tableId Table ID
|
|
13356
|
+
* @param {Number} tableVersion Table Version
|
|
13357
|
+
* putBusinessrulesDecisiontableVersionPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13358
|
+
*/
|
|
13359
|
+
putBusinessrulesDecisiontableVersionPublish(tableId, tableVersion) {
|
|
13360
|
+
// verify the required parameter 'tableId' is set
|
|
13361
|
+
if (tableId === undefined || tableId === null) {
|
|
13362
|
+
throw 'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionPublish';
|
|
13363
|
+
}
|
|
13364
|
+
// verify the required parameter 'tableVersion' is set
|
|
13365
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13366
|
+
throw 'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionPublish';
|
|
13367
|
+
}
|
|
13368
|
+
|
|
13369
|
+
return this.apiClient.callApi(
|
|
13370
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/publish',
|
|
13371
|
+
'PUT',
|
|
13372
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13373
|
+
{ },
|
|
13374
|
+
{ },
|
|
13375
|
+
{ },
|
|
13376
|
+
null,
|
|
13377
|
+
['PureCloud OAuth'],
|
|
13378
|
+
['application/json'],
|
|
13379
|
+
['application/json']
|
|
13380
|
+
);
|
|
13381
|
+
}
|
|
13382
|
+
|
|
13383
|
+
/**
|
|
13384
|
+
* Update a schema
|
|
13385
|
+
*
|
|
13386
|
+
* @param {String} schemaId Schema ID
|
|
13387
|
+
* @param {Object} body Data Schema
|
|
13388
|
+
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13389
|
+
*/
|
|
13390
|
+
putBusinessrulesSchema(schemaId, body) {
|
|
13391
|
+
// verify the required parameter 'schemaId' is set
|
|
13392
|
+
if (schemaId === undefined || schemaId === null) {
|
|
13393
|
+
throw 'Missing the required parameter "schemaId" when calling putBusinessrulesSchema';
|
|
13394
|
+
}
|
|
13395
|
+
// verify the required parameter 'body' is set
|
|
13396
|
+
if (body === undefined || body === null) {
|
|
13397
|
+
throw 'Missing the required parameter "body" when calling putBusinessrulesSchema';
|
|
13398
|
+
}
|
|
13399
|
+
|
|
13400
|
+
return this.apiClient.callApi(
|
|
13401
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
13402
|
+
'PUT',
|
|
13403
|
+
{ 'schemaId': schemaId },
|
|
13404
|
+
{ },
|
|
13405
|
+
{ },
|
|
13406
|
+
{ },
|
|
13407
|
+
body,
|
|
13408
|
+
['PureCloud OAuth'],
|
|
13409
|
+
['application/json'],
|
|
13410
|
+
['application/json']
|
|
13411
|
+
);
|
|
13412
|
+
}
|
|
13413
|
+
|
|
13414
|
+
}
|
|
13415
|
+
|
|
12327
13416
|
class CarrierServicesApi {
|
|
12328
13417
|
/**
|
|
12329
13418
|
* CarrierServices service.
|
|
12330
13419
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12331
|
-
* @version
|
|
13420
|
+
* @version 221.0.0
|
|
12332
13421
|
*/
|
|
12333
13422
|
|
|
12334
13423
|
/**
|
|
@@ -12398,7 +13487,7 @@ class ChatApi {
|
|
|
12398
13487
|
/**
|
|
12399
13488
|
* Chat service.
|
|
12400
13489
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12401
|
-
* @version
|
|
13490
|
+
* @version 221.0.0
|
|
12402
13491
|
*/
|
|
12403
13492
|
|
|
12404
13493
|
/**
|
|
@@ -12708,8 +13797,12 @@ class ChatApi {
|
|
|
12708
13797
|
* Get room participants in a room
|
|
12709
13798
|
*
|
|
12710
13799
|
* @param {String} roomJid roomJid
|
|
13800
|
+
* @param {Object} opts Optional parameters
|
|
13801
|
+
* @param {Boolean} opts.notify Whether to get users to notify
|
|
12711
13802
|
*/
|
|
12712
|
-
getChatsRoomParticipants(roomJid) {
|
|
13803
|
+
getChatsRoomParticipants(roomJid, opts) {
|
|
13804
|
+
opts = opts || {};
|
|
13805
|
+
|
|
12713
13806
|
// verify the required parameter 'roomJid' is set
|
|
12714
13807
|
if (roomJid === undefined || roomJid === null) {
|
|
12715
13808
|
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
@@ -12719,7 +13812,7 @@ class ChatApi {
|
|
|
12719
13812
|
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
12720
13813
|
'GET',
|
|
12721
13814
|
{ 'roomJid': roomJid },
|
|
12722
|
-
{
|
|
13815
|
+
{ 'notify': opts['notify'] },
|
|
12723
13816
|
{ },
|
|
12724
13817
|
{ },
|
|
12725
13818
|
null,
|
|
@@ -13327,7 +14420,7 @@ class CoachingApi {
|
|
|
13327
14420
|
/**
|
|
13328
14421
|
* Coaching service.
|
|
13329
14422
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13330
|
-
* @version
|
|
14423
|
+
* @version 221.0.0
|
|
13331
14424
|
*/
|
|
13332
14425
|
|
|
13333
14426
|
/**
|
|
@@ -13904,7 +14997,7 @@ class ContentManagementApi {
|
|
|
13904
14997
|
/**
|
|
13905
14998
|
* ContentManagement service.
|
|
13906
14999
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13907
|
-
* @version
|
|
15000
|
+
* @version 221.0.0
|
|
13908
15001
|
*/
|
|
13909
15002
|
|
|
13910
15003
|
/**
|
|
@@ -14985,7 +16078,7 @@ class ConversationsApi {
|
|
|
14985
16078
|
/**
|
|
14986
16079
|
* Conversations service.
|
|
14987
16080
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14988
|
-
* @version
|
|
16081
|
+
* @version 221.0.0
|
|
14989
16082
|
*/
|
|
14990
16083
|
|
|
14991
16084
|
/**
|
|
@@ -17191,7 +18284,6 @@ class ConversationsApi {
|
|
|
17191
18284
|
* Get Facebook messaging integration identity resolution settings
|
|
17192
18285
|
*
|
|
17193
18286
|
* @param {String} integrationId Integration ID
|
|
17194
|
-
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17195
18287
|
*/
|
|
17196
18288
|
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
17197
18289
|
// verify the required parameter 'integrationId' is set
|
|
@@ -17217,7 +18309,6 @@ class ConversationsApi {
|
|
|
17217
18309
|
* Get an open messaging integration Identity Resolution settings
|
|
17218
18310
|
*
|
|
17219
18311
|
* @param {String} integrationId Integration ID
|
|
17220
|
-
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17221
18312
|
*/
|
|
17222
18313
|
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
17223
18314
|
// verify the required parameter 'integrationId' is set
|
|
@@ -17243,7 +18334,6 @@ class ConversationsApi {
|
|
|
17243
18334
|
* Get a whatsApp integration Identity Resolution settings
|
|
17244
18335
|
*
|
|
17245
18336
|
* @param {String} integrationId Integration ID
|
|
17246
|
-
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17247
18337
|
*/
|
|
17248
18338
|
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
17249
18339
|
// verify the required parameter 'integrationId' is set
|
|
@@ -18073,6 +19163,40 @@ class ConversationsApi {
|
|
|
18073
19163
|
);
|
|
18074
19164
|
}
|
|
18075
19165
|
|
|
19166
|
+
/**
|
|
19167
|
+
* Update agent's engagement for the summary.
|
|
19168
|
+
*
|
|
19169
|
+
* @param {String} conversationId Conversation ID
|
|
19170
|
+
* @param {String} summaryId Summary ID
|
|
19171
|
+
* @param {Object} opts Optional parameters
|
|
19172
|
+
* @param {Object} opts.body
|
|
19173
|
+
*/
|
|
19174
|
+
patchConversationSummaryEngagements(conversationId, summaryId, opts) {
|
|
19175
|
+
opts = opts || {};
|
|
19176
|
+
|
|
19177
|
+
// verify the required parameter 'conversationId' is set
|
|
19178
|
+
if (conversationId === undefined || conversationId === null) {
|
|
19179
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryEngagements';
|
|
19180
|
+
}
|
|
19181
|
+
// verify the required parameter 'summaryId' is set
|
|
19182
|
+
if (summaryId === undefined || summaryId === null) {
|
|
19183
|
+
throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryEngagements';
|
|
19184
|
+
}
|
|
19185
|
+
|
|
19186
|
+
return this.apiClient.callApi(
|
|
19187
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/engagements',
|
|
19188
|
+
'PATCH',
|
|
19189
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
19190
|
+
{ },
|
|
19191
|
+
{ },
|
|
19192
|
+
{ },
|
|
19193
|
+
opts['body'],
|
|
19194
|
+
['PureCloud OAuth'],
|
|
19195
|
+
['application/json'],
|
|
19196
|
+
['application/json']
|
|
19197
|
+
);
|
|
19198
|
+
}
|
|
19199
|
+
|
|
18076
19200
|
/**
|
|
18077
19201
|
* Update the feedback for the summary.
|
|
18078
19202
|
*
|
|
@@ -18080,7 +19204,6 @@ class ConversationsApi {
|
|
|
18080
19204
|
* @param {String} summaryId Summary ID
|
|
18081
19205
|
* @param {Object} opts Optional parameters
|
|
18082
19206
|
* @param {Object} opts.body
|
|
18083
|
-
* patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18084
19207
|
*/
|
|
18085
19208
|
patchConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
18086
19209
|
opts = opts || {};
|
|
@@ -21161,6 +22284,7 @@ class ConversationsApi {
|
|
|
21161
22284
|
* See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
|
|
21162
22285
|
* @param {String} conversationId conversationId
|
|
21163
22286
|
* @param {String} communicationId communicationId
|
|
22287
|
+
* @deprecated
|
|
21164
22288
|
*/
|
|
21165
22289
|
postConversationsMessageCommunicationMessagesMedia(conversationId, communicationId) {
|
|
21166
22290
|
// verify the required parameter 'conversationId' is set
|
|
@@ -21186,6 +22310,41 @@ class ConversationsApi {
|
|
|
21186
22310
|
);
|
|
21187
22311
|
}
|
|
21188
22312
|
|
|
22313
|
+
/**
|
|
22314
|
+
* Create a URL to upload a message media file
|
|
22315
|
+
* See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
|
|
22316
|
+
* @param {String} conversationId conversationId
|
|
22317
|
+
* @param {String} communicationId communicationId
|
|
22318
|
+
* @param {Object} body request
|
|
22319
|
+
*/
|
|
22320
|
+
postConversationsMessageCommunicationMessagesMediaUploads(conversationId, communicationId, body) {
|
|
22321
|
+
// verify the required parameter 'conversationId' is set
|
|
22322
|
+
if (conversationId === undefined || conversationId === null) {
|
|
22323
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
|
|
22324
|
+
}
|
|
22325
|
+
// verify the required parameter 'communicationId' is set
|
|
22326
|
+
if (communicationId === undefined || communicationId === null) {
|
|
22327
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
|
|
22328
|
+
}
|
|
22329
|
+
// verify the required parameter 'body' is set
|
|
22330
|
+
if (body === undefined || body === null) {
|
|
22331
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationMessagesMediaUploads';
|
|
22332
|
+
}
|
|
22333
|
+
|
|
22334
|
+
return this.apiClient.callApi(
|
|
22335
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/uploads',
|
|
22336
|
+
'POST',
|
|
22337
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
22338
|
+
{ },
|
|
22339
|
+
{ },
|
|
22340
|
+
{ },
|
|
22341
|
+
body,
|
|
22342
|
+
['PureCloud OAuth'],
|
|
22343
|
+
['application/json'],
|
|
22344
|
+
['application/json']
|
|
22345
|
+
);
|
|
22346
|
+
}
|
|
22347
|
+
|
|
21189
22348
|
/**
|
|
21190
22349
|
* Send message typing event
|
|
21191
22350
|
* Send message typing event for existing conversation/communication.
|
|
@@ -22307,7 +23466,6 @@ class ConversationsApi {
|
|
|
22307
23466
|
*
|
|
22308
23467
|
* @param {String} integrationId Integration ID
|
|
22309
23468
|
* @param {Object} body IdentityResolutionConfig
|
|
22310
|
-
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22311
23469
|
*/
|
|
22312
23470
|
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
22313
23471
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22338,7 +23496,6 @@ class ConversationsApi {
|
|
|
22338
23496
|
*
|
|
22339
23497
|
* @param {String} integrationId Integration ID
|
|
22340
23498
|
* @param {Object} body
|
|
22341
|
-
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22342
23499
|
*/
|
|
22343
23500
|
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
22344
23501
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22369,7 +23526,6 @@ class ConversationsApi {
|
|
|
22369
23526
|
*
|
|
22370
23527
|
* @param {String} integrationId Integration ID
|
|
22371
23528
|
* @param {Object} body
|
|
22372
|
-
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22373
23529
|
*/
|
|
22374
23530
|
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
22375
23531
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22567,7 +23723,7 @@ class DataExtensionsApi {
|
|
|
22567
23723
|
/**
|
|
22568
23724
|
* DataExtensions service.
|
|
22569
23725
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22570
|
-
* @version
|
|
23726
|
+
* @version 221.0.0
|
|
22571
23727
|
*/
|
|
22572
23728
|
|
|
22573
23729
|
/**
|
|
@@ -22653,7 +23809,7 @@ class DataPrivacyApi {
|
|
|
22653
23809
|
/**
|
|
22654
23810
|
* DataPrivacy service.
|
|
22655
23811
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22656
|
-
* @version
|
|
23812
|
+
* @version 221.0.0
|
|
22657
23813
|
*/
|
|
22658
23814
|
|
|
22659
23815
|
/**
|
|
@@ -22823,7 +23979,7 @@ class DownloadsApi {
|
|
|
22823
23979
|
/**
|
|
22824
23980
|
* Downloads service.
|
|
22825
23981
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22826
|
-
* @version
|
|
23982
|
+
* @version 221.0.0
|
|
22827
23983
|
*/
|
|
22828
23984
|
|
|
22829
23985
|
/**
|
|
@@ -22875,7 +24031,7 @@ class EmailsApi {
|
|
|
22875
24031
|
/**
|
|
22876
24032
|
* Emails service.
|
|
22877
24033
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22878
|
-
* @version
|
|
24034
|
+
* @version 221.0.0
|
|
22879
24035
|
*/
|
|
22880
24036
|
|
|
22881
24037
|
/**
|
|
@@ -23004,7 +24160,7 @@ class EmployeeEngagementApi {
|
|
|
23004
24160
|
/**
|
|
23005
24161
|
* EmployeeEngagement service.
|
|
23006
24162
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
23007
|
-
* @version
|
|
24163
|
+
* @version 221.0.0
|
|
23008
24164
|
*/
|
|
23009
24165
|
|
|
23010
24166
|
/**
|
|
@@ -23155,7 +24311,7 @@ class EventsApi {
|
|
|
23155
24311
|
/**
|
|
23156
24312
|
* Events service.
|
|
23157
24313
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23158
|
-
* @version
|
|
24314
|
+
* @version 221.0.0
|
|
23159
24315
|
*/
|
|
23160
24316
|
|
|
23161
24317
|
/**
|
|
@@ -23251,7 +24407,7 @@ class ExternalContactsApi {
|
|
|
23251
24407
|
/**
|
|
23252
24408
|
* ExternalContacts service.
|
|
23253
24409
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23254
|
-
* @version
|
|
24410
|
+
* @version 221.0.0
|
|
23255
24411
|
*/
|
|
23256
24412
|
|
|
23257
24413
|
/**
|
|
@@ -24280,7 +25436,6 @@ class ExternalContactsApi {
|
|
|
24280
25436
|
* List the identifiers for an external organization
|
|
24281
25437
|
*
|
|
24282
25438
|
* @param {String} externalOrganizationId External Organization ID
|
|
24283
|
-
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24284
25439
|
*/
|
|
24285
25440
|
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
24286
25441
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -24626,12 +25781,12 @@ class ExternalContactsApi {
|
|
|
24626
25781
|
}
|
|
24627
25782
|
|
|
24628
25783
|
/**
|
|
24629
|
-
* Look up contacts
|
|
25784
|
+
* Look up contacts based on an attribute. Maximum of 25 values returned.
|
|
24630
25785
|
*
|
|
24631
|
-
* @param {String} lookupVal User supplied value to lookup contacts
|
|
25786
|
+
* @param {String} lookupVal User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
24632
25787
|
* @param {Object} opts Optional parameters
|
|
24633
25788
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
24634
|
-
* @param {String} opts.divisionId Specifies which division to lookup contacts
|
|
25789
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts in, for the given lookup value (default to *)
|
|
24635
25790
|
*/
|
|
24636
25791
|
getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
|
|
24637
25792
|
opts = opts || {};
|
|
@@ -24687,7 +25842,6 @@ class ExternalContactsApi {
|
|
|
24687
25842
|
* @param {Object} opts Optional parameters
|
|
24688
25843
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24689
25844
|
* @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
|
|
24690
|
-
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24691
25845
|
*/
|
|
24692
25846
|
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
24693
25847
|
opts = opts || {};
|
|
@@ -24739,7 +25893,6 @@ class ExternalContactsApi {
|
|
|
24739
25893
|
* @param {Object} opts Optional parameters
|
|
24740
25894
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24741
25895
|
* @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
|
|
24742
|
-
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24743
25896
|
*/
|
|
24744
25897
|
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
24745
25898
|
opts = opts || {};
|
|
@@ -24791,7 +25944,6 @@ class ExternalContactsApi {
|
|
|
24791
25944
|
* @param {Object} opts Optional parameters
|
|
24792
25945
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24793
25946
|
* @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
|
|
24794
|
-
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24795
25947
|
*/
|
|
24796
25948
|
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
24797
25949
|
opts = opts || {};
|
|
@@ -24843,7 +25995,6 @@ class ExternalContactsApi {
|
|
|
24843
25995
|
* @param {Object} opts Optional parameters
|
|
24844
25996
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24845
25997
|
* @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
|
|
24846
|
-
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24847
25998
|
*/
|
|
24848
25999
|
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
24849
26000
|
opts = opts || {};
|
|
@@ -24898,7 +26049,6 @@ class ExternalContactsApi {
|
|
|
24898
26049
|
*
|
|
24899
26050
|
* @param {String} externalOrganizationId External Organization ID
|
|
24900
26051
|
* @param {Object} body ClaimRequest
|
|
24901
|
-
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24902
26052
|
*/
|
|
24903
26053
|
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
24904
26054
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -24978,7 +26128,6 @@ class ExternalContactsApi {
|
|
|
24978
26128
|
* Bulk fetch contacts across divisions
|
|
24979
26129
|
*
|
|
24980
26130
|
* @param {Object} body Contact ids
|
|
24981
|
-
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24982
26131
|
*/
|
|
24983
26132
|
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
24984
26133
|
// verify the required parameter 'body' is set
|
|
@@ -25006,7 +26155,6 @@ class ExternalContactsApi {
|
|
|
25006
26155
|
* @param {Object} body Contact Enrich Requests
|
|
25007
26156
|
* @param {Object} opts Optional parameters
|
|
25008
26157
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25009
|
-
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25010
26158
|
*/
|
|
25011
26159
|
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
25012
26160
|
opts = opts || {};
|
|
@@ -25259,7 +26407,6 @@ class ExternalContactsApi {
|
|
|
25259
26407
|
* Bulk fetch organizations across divisions
|
|
25260
26408
|
*
|
|
25261
26409
|
* @param {Object} body Organizations ids
|
|
25262
|
-
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25263
26410
|
*/
|
|
25264
26411
|
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
25265
26412
|
// verify the required parameter 'body' is set
|
|
@@ -25287,7 +26434,6 @@ class ExternalContactsApi {
|
|
|
25287
26434
|
* @param {Object} body External Organization Enrich Requests
|
|
25288
26435
|
* @param {Object} opts Optional parameters
|
|
25289
26436
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25290
|
-
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25291
26437
|
*/
|
|
25292
26438
|
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
25293
26439
|
opts = opts || {};
|
|
@@ -25547,7 +26693,6 @@ class ExternalContactsApi {
|
|
|
25547
26693
|
* @param {Object} body ContactEnrichRequest
|
|
25548
26694
|
* @param {Object} opts Optional parameters
|
|
25549
26695
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25550
|
-
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25551
26696
|
*/
|
|
25552
26697
|
postExternalcontactsContactsEnrich(body, opts) {
|
|
25553
26698
|
opts = opts || {};
|
|
@@ -25600,7 +26745,6 @@ class ExternalContactsApi {
|
|
|
25600
26745
|
* Merge up to 25 contacts into a new contact record
|
|
25601
26746
|
* Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
|
|
25602
26747
|
* @param {Object} body MergeRequest
|
|
25603
|
-
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25604
26748
|
*/
|
|
25605
26749
|
postExternalcontactsContactsMerge(body) {
|
|
25606
26750
|
// verify the required parameter 'body' is set
|
|
@@ -25708,7 +26852,6 @@ class ExternalContactsApi {
|
|
|
25708
26852
|
* @param {Object} identifier
|
|
25709
26853
|
* @param {Object} opts Optional parameters
|
|
25710
26854
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25711
|
-
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25712
26855
|
*/
|
|
25713
26856
|
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
25714
26857
|
opts = opts || {};
|
|
@@ -25738,7 +26881,6 @@ class ExternalContactsApi {
|
|
|
25738
26881
|
* @param {Object} identifier
|
|
25739
26882
|
* @param {Object} opts Optional parameters
|
|
25740
26883
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25741
|
-
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25742
26884
|
*/
|
|
25743
26885
|
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
25744
26886
|
opts = opts || {};
|
|
@@ -25974,7 +27116,6 @@ class ExternalContactsApi {
|
|
|
25974
27116
|
* @param {Object} body ExternalOrgEnrichRequest
|
|
25975
27117
|
* @param {Object} opts Optional parameters
|
|
25976
27118
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25977
|
-
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25978
27119
|
*/
|
|
25979
27120
|
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
25980
27121
|
opts = opts || {};
|
|
@@ -26454,7 +27595,7 @@ class FaxApi {
|
|
|
26454
27595
|
/**
|
|
26455
27596
|
* Fax service.
|
|
26456
27597
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
26457
|
-
* @version
|
|
27598
|
+
* @version 221.0.0
|
|
26458
27599
|
*/
|
|
26459
27600
|
|
|
26460
27601
|
/**
|
|
@@ -26669,7 +27810,7 @@ class FlowsApi {
|
|
|
26669
27810
|
/**
|
|
26670
27811
|
* Flows service.
|
|
26671
27812
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
26672
|
-
* @version
|
|
27813
|
+
* @version 221.0.0
|
|
26673
27814
|
*/
|
|
26674
27815
|
|
|
26675
27816
|
/**
|
|
@@ -26852,7 +27993,7 @@ class GamificationApi {
|
|
|
26852
27993
|
/**
|
|
26853
27994
|
* Gamification service.
|
|
26854
27995
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
26855
|
-
* @version
|
|
27996
|
+
* @version 221.0.0
|
|
26856
27997
|
*/
|
|
26857
27998
|
|
|
26858
27999
|
/**
|
|
@@ -29359,7 +30500,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
29359
30500
|
/**
|
|
29360
30501
|
* GeneralDataProtectionRegulation service.
|
|
29361
30502
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
29362
|
-
* @version
|
|
30503
|
+
* @version 221.0.0
|
|
29363
30504
|
*/
|
|
29364
30505
|
|
|
29365
30506
|
/**
|
|
@@ -29489,7 +30630,7 @@ class GeolocationApi {
|
|
|
29489
30630
|
/**
|
|
29490
30631
|
* Geolocation service.
|
|
29491
30632
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
29492
|
-
* @version
|
|
30633
|
+
* @version 221.0.0
|
|
29493
30634
|
*/
|
|
29494
30635
|
|
|
29495
30636
|
/**
|
|
@@ -29620,7 +30761,7 @@ class GreetingsApi {
|
|
|
29620
30761
|
/**
|
|
29621
30762
|
* Greetings service.
|
|
29622
30763
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
29623
|
-
* @version
|
|
30764
|
+
* @version 221.0.0
|
|
29624
30765
|
*/
|
|
29625
30766
|
|
|
29626
30767
|
/**
|
|
@@ -30075,7 +31216,7 @@ class GroupsApi {
|
|
|
30075
31216
|
/**
|
|
30076
31217
|
* Groups service.
|
|
30077
31218
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
30078
|
-
* @version
|
|
31219
|
+
* @version 221.0.0
|
|
30079
31220
|
*/
|
|
30080
31221
|
|
|
30081
31222
|
/**
|
|
@@ -30594,7 +31735,7 @@ class IdentityProviderApi {
|
|
|
30594
31735
|
/**
|
|
30595
31736
|
* IdentityProvider service.
|
|
30596
31737
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
30597
|
-
* @version
|
|
31738
|
+
* @version 221.0.0
|
|
30598
31739
|
*/
|
|
30599
31740
|
|
|
30600
31741
|
/**
|
|
@@ -31455,7 +32596,7 @@ class InfrastructureAsCodeApi {
|
|
|
31455
32596
|
/**
|
|
31456
32597
|
* InfrastructureAsCode service.
|
|
31457
32598
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
31458
|
-
* @version
|
|
32599
|
+
* @version 221.0.0
|
|
31459
32600
|
*/
|
|
31460
32601
|
|
|
31461
32602
|
/**
|
|
@@ -31622,7 +32763,7 @@ class IntegrationsApi {
|
|
|
31622
32763
|
/**
|
|
31623
32764
|
* Integrations service.
|
|
31624
32765
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
31625
|
-
* @version
|
|
32766
|
+
* @version 221.0.0
|
|
31626
32767
|
*/
|
|
31627
32768
|
|
|
31628
32769
|
/**
|
|
@@ -34091,7 +35232,7 @@ class JourneyApi {
|
|
|
34091
35232
|
/**
|
|
34092
35233
|
* Journey service.
|
|
34093
35234
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
34094
|
-
* @version
|
|
35235
|
+
* @version 221.0.0
|
|
34095
35236
|
*/
|
|
34096
35237
|
|
|
34097
35238
|
/**
|
|
@@ -36076,7 +37217,7 @@ class KnowledgeApi {
|
|
|
36076
37217
|
/**
|
|
36077
37218
|
* Knowledge service.
|
|
36078
37219
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
36079
|
-
* @version
|
|
37220
|
+
* @version 221.0.0
|
|
36080
37221
|
*/
|
|
36081
37222
|
|
|
36082
37223
|
/**
|
|
@@ -39949,7 +41090,7 @@ class LanguageUnderstandingApi {
|
|
|
39949
41090
|
/**
|
|
39950
41091
|
* LanguageUnderstanding service.
|
|
39951
41092
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
39952
|
-
* @version
|
|
41093
|
+
* @version 221.0.0
|
|
39953
41094
|
*/
|
|
39954
41095
|
|
|
39955
41096
|
/**
|
|
@@ -40982,7 +42123,7 @@ class LanguagesApi {
|
|
|
40982
42123
|
/**
|
|
40983
42124
|
* Languages service.
|
|
40984
42125
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
40985
|
-
* @version
|
|
42126
|
+
* @version 221.0.0
|
|
40986
42127
|
*/
|
|
40987
42128
|
|
|
40988
42129
|
/**
|
|
@@ -41204,7 +42345,7 @@ class LearningApi {
|
|
|
41204
42345
|
/**
|
|
41205
42346
|
* Learning service.
|
|
41206
42347
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
41207
|
-
* @version
|
|
42348
|
+
* @version 221.0.0
|
|
41208
42349
|
*/
|
|
41209
42350
|
|
|
41210
42351
|
/**
|
|
@@ -42233,7 +43374,7 @@ class LicenseApi {
|
|
|
42233
43374
|
/**
|
|
42234
43375
|
* License service.
|
|
42235
43376
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
42236
|
-
* @version
|
|
43377
|
+
* @version 221.0.0
|
|
42237
43378
|
*/
|
|
42238
43379
|
|
|
42239
43380
|
/**
|
|
@@ -42471,7 +43612,7 @@ class LocationsApi {
|
|
|
42471
43612
|
/**
|
|
42472
43613
|
* Locations service.
|
|
42473
43614
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
42474
|
-
* @version
|
|
43615
|
+
* @version 221.0.0
|
|
42475
43616
|
*/
|
|
42476
43617
|
|
|
42477
43618
|
/**
|
|
@@ -42707,7 +43848,7 @@ class LogCaptureApi {
|
|
|
42707
43848
|
/**
|
|
42708
43849
|
* LogCapture service.
|
|
42709
43850
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
42710
|
-
* @version
|
|
43851
|
+
* @version 221.0.0
|
|
42711
43852
|
*/
|
|
42712
43853
|
|
|
42713
43854
|
/**
|
|
@@ -42907,7 +44048,7 @@ class MessagingApi {
|
|
|
42907
44048
|
/**
|
|
42908
44049
|
* Messaging service.
|
|
42909
44050
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
42910
|
-
* @version
|
|
44051
|
+
* @version 221.0.0
|
|
42911
44052
|
*/
|
|
42912
44053
|
|
|
42913
44054
|
/**
|
|
@@ -43266,7 +44407,7 @@ class MobileDevicesApi {
|
|
|
43266
44407
|
/**
|
|
43267
44408
|
* MobileDevices service.
|
|
43268
44409
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
43269
|
-
* @version
|
|
44410
|
+
* @version 221.0.0
|
|
43270
44411
|
*/
|
|
43271
44412
|
|
|
43272
44413
|
/**
|
|
@@ -43417,7 +44558,7 @@ class NotificationsApi {
|
|
|
43417
44558
|
/**
|
|
43418
44559
|
* Notifications service.
|
|
43419
44560
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
43420
|
-
* @version
|
|
44561
|
+
* @version 221.0.0
|
|
43421
44562
|
*/
|
|
43422
44563
|
|
|
43423
44564
|
/**
|
|
@@ -43650,7 +44791,7 @@ class OAuthApi {
|
|
|
43650
44791
|
/**
|
|
43651
44792
|
* OAuth service.
|
|
43652
44793
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
43653
|
-
* @version
|
|
44794
|
+
* @version 221.0.0
|
|
43654
44795
|
*/
|
|
43655
44796
|
|
|
43656
44797
|
/**
|
|
@@ -44016,7 +45157,7 @@ class ObjectsApi {
|
|
|
44016
45157
|
/**
|
|
44017
45158
|
* Objects service.
|
|
44018
45159
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
44019
|
-
* @version
|
|
45160
|
+
* @version 221.0.0
|
|
44020
45161
|
*/
|
|
44021
45162
|
|
|
44022
45163
|
/**
|
|
@@ -44340,7 +45481,7 @@ class OperationalEventsApi {
|
|
|
44340
45481
|
/**
|
|
44341
45482
|
* OperationalEvents service.
|
|
44342
45483
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
44343
|
-
* @version
|
|
45484
|
+
* @version 221.0.0
|
|
44344
45485
|
*/
|
|
44345
45486
|
|
|
44346
45487
|
/**
|
|
@@ -44457,7 +45598,7 @@ class OrganizationApi {
|
|
|
44457
45598
|
/**
|
|
44458
45599
|
* Organization service.
|
|
44459
45600
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
44460
|
-
* @version
|
|
45601
|
+
* @version 221.0.0
|
|
44461
45602
|
*/
|
|
44462
45603
|
|
|
44463
45604
|
/**
|
|
@@ -44932,7 +46073,7 @@ class OrganizationAuthorizationApi {
|
|
|
44932
46073
|
/**
|
|
44933
46074
|
* OrganizationAuthorization service.
|
|
44934
46075
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
44935
|
-
* @version
|
|
46076
|
+
* @version 221.0.0
|
|
44936
46077
|
*/
|
|
44937
46078
|
|
|
44938
46079
|
/**
|
|
@@ -46326,7 +47467,7 @@ class OutboundApi {
|
|
|
46326
47467
|
/**
|
|
46327
47468
|
* Outbound service.
|
|
46328
47469
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
46329
|
-
* @version
|
|
47470
|
+
* @version 221.0.0
|
|
46330
47471
|
*/
|
|
46331
47472
|
|
|
46332
47473
|
/**
|
|
@@ -50948,7 +52089,7 @@ class PresenceApi {
|
|
|
50948
52089
|
/**
|
|
50949
52090
|
* Presence service.
|
|
50950
52091
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
50951
|
-
* @version
|
|
52092
|
+
* @version 221.0.0
|
|
50952
52093
|
*/
|
|
50953
52094
|
|
|
50954
52095
|
/**
|
|
@@ -51692,7 +52833,7 @@ class ProcessAutomationApi {
|
|
|
51692
52833
|
/**
|
|
51693
52834
|
* ProcessAutomation service.
|
|
51694
52835
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
51695
|
-
* @version
|
|
52836
|
+
* @version 221.0.0
|
|
51696
52837
|
*/
|
|
51697
52838
|
|
|
51698
52839
|
/**
|
|
@@ -51931,7 +53072,7 @@ class QualityApi {
|
|
|
51931
53072
|
/**
|
|
51932
53073
|
* Quality service.
|
|
51933
53074
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
51934
|
-
* @version
|
|
53075
|
+
* @version 221.0.0
|
|
51935
53076
|
*/
|
|
51936
53077
|
|
|
51937
53078
|
/**
|
|
@@ -53718,7 +54859,7 @@ class RecordingApi {
|
|
|
53718
54859
|
/**
|
|
53719
54860
|
* Recording service.
|
|
53720
54861
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
53721
|
-
* @version
|
|
54862
|
+
* @version 221.0.0
|
|
53722
54863
|
*/
|
|
53723
54864
|
|
|
53724
54865
|
/**
|
|
@@ -54320,7 +55461,7 @@ class RecordingApi {
|
|
|
54320
55461
|
* @param {Object} opts Optional parameters
|
|
54321
55462
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
54322
55463
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
54323
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
55464
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
54324
55465
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
54325
55466
|
*/
|
|
54326
55467
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
@@ -54355,7 +55496,7 @@ class RecordingApi {
|
|
|
54355
55496
|
* @param {Object} opts.state Filter by state
|
|
54356
55497
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
54357
55498
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
54358
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
55499
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
54359
55500
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
54360
55501
|
*/
|
|
54361
55502
|
getRecordingJobs(opts) {
|
|
@@ -55323,7 +56464,7 @@ class ResponseManagementApi {
|
|
|
55323
56464
|
/**
|
|
55324
56465
|
* ResponseManagement service.
|
|
55325
56466
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
55326
|
-
* @version
|
|
56467
|
+
* @version 221.0.0
|
|
55327
56468
|
*/
|
|
55328
56469
|
|
|
55329
56470
|
/**
|
|
@@ -55833,7 +56974,7 @@ class RoutingApi {
|
|
|
55833
56974
|
/**
|
|
55834
56975
|
* Routing service.
|
|
55835
56976
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
55836
|
-
* @version
|
|
56977
|
+
* @version 221.0.0
|
|
55837
56978
|
*/
|
|
55838
56979
|
|
|
55839
56980
|
/**
|
|
@@ -56649,8 +57790,12 @@ class RoutingApi {
|
|
|
56649
57790
|
*
|
|
56650
57791
|
* @param {String} domainName email domain
|
|
56651
57792
|
* @param {String} routeId route ID
|
|
57793
|
+
* @param {Object} opts Optional parameters
|
|
57794
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
56652
57795
|
*/
|
|
56653
|
-
getRoutingEmailDomainRoute(domainName, routeId) {
|
|
57796
|
+
getRoutingEmailDomainRoute(domainName, routeId, opts) {
|
|
57797
|
+
opts = opts || {};
|
|
57798
|
+
|
|
56654
57799
|
// verify the required parameter 'domainName' is set
|
|
56655
57800
|
if (domainName === undefined || domainName === null) {
|
|
56656
57801
|
throw 'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoute';
|
|
@@ -56664,7 +57809,7 @@ class RoutingApi {
|
|
|
56664
57809
|
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}',
|
|
56665
57810
|
'GET',
|
|
56666
57811
|
{ 'domainName': domainName,'routeId': routeId },
|
|
56667
|
-
{
|
|
57812
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
56668
57813
|
{ },
|
|
56669
57814
|
{ },
|
|
56670
57815
|
null,
|
|
@@ -56679,7 +57824,6 @@ class RoutingApi {
|
|
|
56679
57824
|
*
|
|
56680
57825
|
* @param {String} domainName email domain
|
|
56681
57826
|
* @param {String} routeId route ID
|
|
56682
|
-
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56683
57827
|
*/
|
|
56684
57828
|
getRoutingEmailDomainRouteIdentityresolution(domainName, routeId) {
|
|
56685
57829
|
// verify the required parameter 'domainName' is set
|
|
@@ -56713,6 +57857,7 @@ class RoutingApi {
|
|
|
56713
57857
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56714
57858
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56715
57859
|
* @param {String} opts.pattern Filter routes by the route's pattern property
|
|
57860
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
56716
57861
|
*/
|
|
56717
57862
|
getRoutingEmailDomainRoutes(domainName, opts) {
|
|
56718
57863
|
opts = opts || {};
|
|
@@ -56726,7 +57871,7 @@ class RoutingApi {
|
|
|
56726
57871
|
'/api/v2/routing/email/domains/{domainName}/routes',
|
|
56727
57872
|
'GET',
|
|
56728
57873
|
{ 'domainName': domainName },
|
|
56729
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'pattern': opts['pattern'] },
|
|
57874
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'pattern': opts['pattern'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
56730
57875
|
{ },
|
|
56731
57876
|
{ },
|
|
56732
57877
|
null,
|
|
@@ -57126,8 +58271,12 @@ class RoutingApi {
|
|
|
57126
58271
|
* Get details about this queue.
|
|
57127
58272
|
*
|
|
57128
58273
|
* @param {String} queueId Queue ID
|
|
58274
|
+
* @param {Object} opts Optional parameters
|
|
58275
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57129
58276
|
*/
|
|
57130
|
-
getRoutingQueue(queueId) {
|
|
58277
|
+
getRoutingQueue(queueId, opts) {
|
|
58278
|
+
opts = opts || {};
|
|
58279
|
+
|
|
57131
58280
|
// verify the required parameter 'queueId' is set
|
|
57132
58281
|
if (queueId === undefined || queueId === null) {
|
|
57133
58282
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueue';
|
|
@@ -57137,7 +58286,7 @@ class RoutingApi {
|
|
|
57137
58286
|
'/api/v2/routing/queues/{queueId}',
|
|
57138
58287
|
'GET',
|
|
57139
58288
|
{ 'queueId': queueId },
|
|
57140
|
-
{
|
|
58289
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
57141
58290
|
{ },
|
|
57142
58291
|
{ },
|
|
57143
58292
|
null,
|
|
@@ -57264,7 +58413,6 @@ class RoutingApi {
|
|
|
57264
58413
|
* Get Queue IdentityResolution Settings.
|
|
57265
58414
|
*
|
|
57266
58415
|
* @param {String} queueId Queue ID
|
|
57267
|
-
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57268
58416
|
*/
|
|
57269
58417
|
getRoutingQueueIdentityresolution(queueId) {
|
|
57270
58418
|
// verify the required parameter 'queueId' is set
|
|
@@ -57443,6 +58591,7 @@ class RoutingApi {
|
|
|
57443
58591
|
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
57444
58592
|
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
57445
58593
|
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
58594
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57446
58595
|
*/
|
|
57447
58596
|
getRoutingQueues(opts) {
|
|
57448
58597
|
opts = opts || {};
|
|
@@ -57452,7 +58601,7 @@ class RoutingApi {
|
|
|
57452
58601
|
'/api/v2/routing/queues',
|
|
57453
58602
|
'GET',
|
|
57454
58603
|
{ },
|
|
57455
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'cannedResponseLibraryId': opts['cannedResponseLibraryId'],'hasPeer': opts['hasPeer'] },
|
|
58604
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'cannedResponseLibraryId': opts['cannedResponseLibraryId'],'hasPeer': opts['hasPeer'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
57456
58605
|
{ },
|
|
57457
58606
|
{ },
|
|
57458
58607
|
null,
|
|
@@ -57862,7 +59011,6 @@ class RoutingApi {
|
|
|
57862
59011
|
* Get a SMS identity resolution settings.
|
|
57863
59012
|
*
|
|
57864
59013
|
* @param {String} addressId Address ID
|
|
57865
|
-
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57866
59014
|
*/
|
|
57867
59015
|
getRoutingSmsIdentityresolutionPhonenumber(addressId) {
|
|
57868
59016
|
// verify the required parameter 'addressId' is set
|
|
@@ -57928,6 +59076,7 @@ class RoutingApi {
|
|
|
57928
59076
|
* @param {String} opts.language A language tag (which is sometimes referred to as a locale identifier) to use to localize country field and sort operations (default to en-US)
|
|
57929
59077
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
57930
59078
|
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
59079
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57931
59080
|
*/
|
|
57932
59081
|
getRoutingSmsPhonenumbers(opts) {
|
|
57933
59082
|
opts = opts || {};
|
|
@@ -57937,7 +59086,7 @@ class RoutingApi {
|
|
|
57937
59086
|
'/api/v2/routing/sms/phonenumbers',
|
|
57938
59087
|
'GET',
|
|
57939
59088
|
{ },
|
|
57940
|
-
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'],'supportedContent.id': opts['supportedContentId'] },
|
|
59089
|
+
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'],'supportedContent.id': opts['supportedContentId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
57941
59090
|
{ },
|
|
57942
59091
|
{ },
|
|
57943
59092
|
null,
|
|
@@ -59695,7 +60844,6 @@ class RoutingApi {
|
|
|
59695
60844
|
* @param {String} domainName email domain
|
|
59696
60845
|
* @param {String} routeId route ID
|
|
59697
60846
|
* @param {Object} body
|
|
59698
|
-
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59699
60847
|
*/
|
|
59700
60848
|
putRoutingEmailDomainRouteIdentityresolution(domainName, routeId, body) {
|
|
59701
60849
|
// verify the required parameter 'domainName' is set
|
|
@@ -59815,7 +60963,6 @@ class RoutingApi {
|
|
|
59815
60963
|
*
|
|
59816
60964
|
* @param {String} queueId Queue ID
|
|
59817
60965
|
* @param {Object} body
|
|
59818
|
-
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59819
60966
|
*/
|
|
59820
60967
|
putRoutingQueueIdentityresolution(queueId, body) {
|
|
59821
60968
|
// verify the required parameter 'queueId' is set
|
|
@@ -59896,7 +61043,6 @@ class RoutingApi {
|
|
|
59896
61043
|
*
|
|
59897
61044
|
* @param {String} addressId Address ID
|
|
59898
61045
|
* @param {Object} body
|
|
59899
|
-
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59900
61046
|
*/
|
|
59901
61047
|
putRoutingSmsIdentityresolutionPhonenumber(addressId, body) {
|
|
59902
61048
|
// verify the required parameter 'addressId' is set
|
|
@@ -60138,7 +61284,7 @@ class SCIMApi {
|
|
|
60138
61284
|
/**
|
|
60139
61285
|
* SCIM service.
|
|
60140
61286
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
60141
|
-
* @version
|
|
61287
|
+
* @version 221.0.0
|
|
60142
61288
|
*/
|
|
60143
61289
|
|
|
60144
61290
|
/**
|
|
@@ -61015,7 +62161,7 @@ class ScreenRecordingApi {
|
|
|
61015
62161
|
/**
|
|
61016
62162
|
* ScreenRecording service.
|
|
61017
62163
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
61018
|
-
* @version
|
|
62164
|
+
* @version 221.0.0
|
|
61019
62165
|
*/
|
|
61020
62166
|
|
|
61021
62167
|
/**
|
|
@@ -61060,7 +62206,7 @@ class ScriptsApi {
|
|
|
61060
62206
|
/**
|
|
61061
62207
|
* Scripts service.
|
|
61062
62208
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
61063
|
-
* @version
|
|
62209
|
+
* @version 221.0.0
|
|
61064
62210
|
*/
|
|
61065
62211
|
|
|
61066
62212
|
/**
|
|
@@ -61260,6 +62406,38 @@ class ScriptsApi {
|
|
|
61260
62406
|
);
|
|
61261
62407
|
}
|
|
61262
62408
|
|
|
62409
|
+
/**
|
|
62410
|
+
* Get the published variables
|
|
62411
|
+
*
|
|
62412
|
+
* @param {String} scriptId Script ID
|
|
62413
|
+
* @param {Object} opts Optional parameters
|
|
62414
|
+
* @param {Object} opts.input input
|
|
62415
|
+
* @param {Object} opts.output output
|
|
62416
|
+
* @param {Object} opts.type type
|
|
62417
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
62418
|
+
*/
|
|
62419
|
+
getScriptsPublishedDivisionviewVariables(scriptId, opts) {
|
|
62420
|
+
opts = opts || {};
|
|
62421
|
+
|
|
62422
|
+
// verify the required parameter 'scriptId' is set
|
|
62423
|
+
if (scriptId === undefined || scriptId === null) {
|
|
62424
|
+
throw 'Missing the required parameter "scriptId" when calling getScriptsPublishedDivisionviewVariables';
|
|
62425
|
+
}
|
|
62426
|
+
|
|
62427
|
+
return this.apiClient.callApi(
|
|
62428
|
+
'/api/v2/scripts/published/divisionviews/{scriptId}/variables',
|
|
62429
|
+
'GET',
|
|
62430
|
+
{ 'scriptId': scriptId },
|
|
62431
|
+
{ 'input': opts['input'],'output': opts['output'],'type': opts['type'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
62432
|
+
{ },
|
|
62433
|
+
{ },
|
|
62434
|
+
null,
|
|
62435
|
+
['PureCloud OAuth'],
|
|
62436
|
+
['application/json'],
|
|
62437
|
+
['application/json']
|
|
62438
|
+
);
|
|
62439
|
+
}
|
|
62440
|
+
|
|
61263
62441
|
/**
|
|
61264
62442
|
* Get the published scripts metadata.
|
|
61265
62443
|
*
|
|
@@ -61504,7 +62682,7 @@ class SearchApi {
|
|
|
61504
62682
|
/**
|
|
61505
62683
|
* Search service.
|
|
61506
62684
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
61507
|
-
* @version
|
|
62685
|
+
* @version 221.0.0
|
|
61508
62686
|
*/
|
|
61509
62687
|
|
|
61510
62688
|
/**
|
|
@@ -62247,7 +63425,7 @@ class SettingsApi {
|
|
|
62247
63425
|
/**
|
|
62248
63426
|
* Settings service.
|
|
62249
63427
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
62250
|
-
* @version
|
|
63428
|
+
* @version 221.0.0
|
|
62251
63429
|
*/
|
|
62252
63430
|
|
|
62253
63431
|
/**
|
|
@@ -62282,6 +63460,26 @@ class SettingsApi {
|
|
|
62282
63460
|
);
|
|
62283
63461
|
}
|
|
62284
63462
|
|
|
63463
|
+
/**
|
|
63464
|
+
* Delete settings
|
|
63465
|
+
*
|
|
63466
|
+
*/
|
|
63467
|
+
deleteExternalcontactsSettings() {
|
|
63468
|
+
|
|
63469
|
+
return this.apiClient.callApi(
|
|
63470
|
+
'/api/v2/externalcontacts/settings',
|
|
63471
|
+
'DELETE',
|
|
63472
|
+
{ },
|
|
63473
|
+
{ },
|
|
63474
|
+
{ },
|
|
63475
|
+
{ },
|
|
63476
|
+
null,
|
|
63477
|
+
['PureCloud OAuth'],
|
|
63478
|
+
['application/json'],
|
|
63479
|
+
['application/json']
|
|
63480
|
+
);
|
|
63481
|
+
}
|
|
63482
|
+
|
|
62285
63483
|
/**
|
|
62286
63484
|
* Delete agent auto answer settings
|
|
62287
63485
|
*
|
|
@@ -62347,6 +63545,26 @@ class SettingsApi {
|
|
|
62347
63545
|
);
|
|
62348
63546
|
}
|
|
62349
63547
|
|
|
63548
|
+
/**
|
|
63549
|
+
* Get settings
|
|
63550
|
+
*
|
|
63551
|
+
*/
|
|
63552
|
+
getExternalcontactsSettings() {
|
|
63553
|
+
|
|
63554
|
+
return this.apiClient.callApi(
|
|
63555
|
+
'/api/v2/externalcontacts/settings',
|
|
63556
|
+
'GET',
|
|
63557
|
+
{ },
|
|
63558
|
+
{ },
|
|
63559
|
+
{ },
|
|
63560
|
+
{ },
|
|
63561
|
+
null,
|
|
63562
|
+
['PureCloud OAuth'],
|
|
63563
|
+
['application/json'],
|
|
63564
|
+
['application/json']
|
|
63565
|
+
);
|
|
63566
|
+
}
|
|
63567
|
+
|
|
62350
63568
|
/**
|
|
62351
63569
|
* Get the execution history enabled setting.
|
|
62352
63570
|
* Get the execution history enabled setting.
|
|
@@ -62495,6 +63713,30 @@ class SettingsApi {
|
|
|
62495
63713
|
);
|
|
62496
63714
|
}
|
|
62497
63715
|
|
|
63716
|
+
/**
|
|
63717
|
+
* Set settings
|
|
63718
|
+
*
|
|
63719
|
+
* @param {Object} opts Optional parameters
|
|
63720
|
+
* @param {Object} opts.body
|
|
63721
|
+
*/
|
|
63722
|
+
putExternalcontactsSettings(opts) {
|
|
63723
|
+
opts = opts || {};
|
|
63724
|
+
|
|
63725
|
+
|
|
63726
|
+
return this.apiClient.callApi(
|
|
63727
|
+
'/api/v2/externalcontacts/settings',
|
|
63728
|
+
'PUT',
|
|
63729
|
+
{ },
|
|
63730
|
+
{ },
|
|
63731
|
+
{ },
|
|
63732
|
+
{ },
|
|
63733
|
+
opts['body'],
|
|
63734
|
+
['PureCloud OAuth'],
|
|
63735
|
+
['application/json'],
|
|
63736
|
+
['application/json']
|
|
63737
|
+
);
|
|
63738
|
+
}
|
|
63739
|
+
|
|
62498
63740
|
/**
|
|
62499
63741
|
* Set agent auto answer settings
|
|
62500
63742
|
*
|
|
@@ -62531,7 +63773,7 @@ class SocialMediaApi {
|
|
|
62531
63773
|
/**
|
|
62532
63774
|
* SocialMedia service.
|
|
62533
63775
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
62534
|
-
* @version
|
|
63776
|
+
* @version 221.0.0
|
|
62535
63777
|
*/
|
|
62536
63778
|
|
|
62537
63779
|
/**
|
|
@@ -63819,7 +65061,7 @@ class SpeechTextAnalyticsApi {
|
|
|
63819
65061
|
/**
|
|
63820
65062
|
* SpeechTextAnalytics service.
|
|
63821
65063
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
63822
|
-
* @version
|
|
65064
|
+
* @version 221.0.0
|
|
63823
65065
|
*/
|
|
63824
65066
|
|
|
63825
65067
|
/**
|
|
@@ -64721,7 +65963,6 @@ class SpeechTextAnalyticsApi {
|
|
|
64721
65963
|
* @param {Object} opts Optional parameters
|
|
64722
65964
|
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
64723
65965
|
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
64724
|
-
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64725
65966
|
*/
|
|
64726
65967
|
getSpeechandtextanalyticsTranslationsLanguageConversation(languageId, conversationId, opts) {
|
|
64727
65968
|
opts = opts || {};
|
|
@@ -64752,7 +65993,6 @@ class SpeechTextAnalyticsApi {
|
|
|
64752
65993
|
/**
|
|
64753
65994
|
* Get supported translation languages
|
|
64754
65995
|
*
|
|
64755
|
-
* getSpeechandtextanalyticsTranslationsLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64756
65996
|
*/
|
|
64757
65997
|
getSpeechandtextanalyticsTranslationsLanguages() {
|
|
64758
65998
|
|
|
@@ -65260,7 +66500,7 @@ class StationsApi {
|
|
|
65260
66500
|
/**
|
|
65261
66501
|
* Stations service.
|
|
65262
66502
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
65263
|
-
* @version
|
|
66503
|
+
* @version 221.0.0
|
|
65264
66504
|
*/
|
|
65265
66505
|
|
|
65266
66506
|
/**
|
|
@@ -65362,7 +66602,7 @@ class SuggestApi {
|
|
|
65362
66602
|
/**
|
|
65363
66603
|
* Suggest service.
|
|
65364
66604
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
65365
|
-
* @version
|
|
66605
|
+
* @version 221.0.0
|
|
65366
66606
|
*/
|
|
65367
66607
|
|
|
65368
66608
|
/**
|
|
@@ -65501,7 +66741,7 @@ class TaskManagementApi {
|
|
|
65501
66741
|
/**
|
|
65502
66742
|
* TaskManagement service.
|
|
65503
66743
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
65504
|
-
* @version
|
|
66744
|
+
* @version 221.0.0
|
|
65505
66745
|
*/
|
|
65506
66746
|
|
|
65507
66747
|
/**
|
|
@@ -65819,7 +67059,6 @@ class TaskManagementApi {
|
|
|
65819
67059
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
65820
67060
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
65821
67061
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
65822
|
-
* getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65823
67062
|
*/
|
|
65824
67063
|
getTaskmanagementWorkbinHistory(workbinId, opts) {
|
|
65825
67064
|
opts = opts || {};
|
|
@@ -65848,7 +67087,6 @@ class TaskManagementApi {
|
|
|
65848
67087
|
*
|
|
65849
67088
|
* @param {String} workbinId Workbin ID
|
|
65850
67089
|
* @param {Number} entityVersion Workbin version
|
|
65851
|
-
* getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65852
67090
|
*/
|
|
65853
67091
|
getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
|
|
65854
67092
|
// verify the required parameter 'workbinId' is set
|
|
@@ -65882,7 +67120,6 @@ class TaskManagementApi {
|
|
|
65882
67120
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
65883
67121
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
65884
67122
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
65885
|
-
* getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65886
67123
|
*/
|
|
65887
67124
|
getTaskmanagementWorkbinVersions(workbinId, opts) {
|
|
65888
67125
|
opts = opts || {};
|
|
@@ -65943,7 +67180,6 @@ class TaskManagementApi {
|
|
|
65943
67180
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
65944
67181
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
65945
67182
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
65946
|
-
* getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65947
67183
|
*/
|
|
65948
67184
|
getTaskmanagementWorkitemHistory(workitemId, opts) {
|
|
65949
67185
|
opts = opts || {};
|
|
@@ -66009,7 +67245,6 @@ class TaskManagementApi {
|
|
|
66009
67245
|
*
|
|
66010
67246
|
* @param {String} workitemId Workitem ID
|
|
66011
67247
|
* @param {Number} entityVersion Workitem version
|
|
66012
|
-
* getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
66013
67248
|
*/
|
|
66014
67249
|
getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
|
|
66015
67250
|
// verify the required parameter 'workitemId' is set
|
|
@@ -66043,7 +67278,6 @@ class TaskManagementApi {
|
|
|
66043
67278
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
66044
67279
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
66045
67280
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
66046
|
-
* getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
66047
67281
|
*/
|
|
66048
67282
|
getTaskmanagementWorkitemVersions(workitemId, opts) {
|
|
66049
67283
|
opts = opts || {};
|
|
@@ -66659,7 +67893,6 @@ class TaskManagementApi {
|
|
|
66659
67893
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
66660
67894
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
66661
67895
|
* @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
|
|
66662
|
-
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
66663
67896
|
*/
|
|
66664
67897
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
66665
67898
|
opts = opts || {};
|
|
@@ -66743,7 +67976,6 @@ class TaskManagementApi {
|
|
|
66743
67976
|
*
|
|
66744
67977
|
* @param {String} worktypeId Worktype id
|
|
66745
67978
|
* @param {Number} entityVersion Worktype version
|
|
66746
|
-
* getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
66747
67979
|
*/
|
|
66748
67980
|
getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
|
|
66749
67981
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -66777,7 +68009,6 @@ class TaskManagementApi {
|
|
|
66777
68009
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
66778
68010
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
66779
68011
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
66780
|
-
* getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
66781
68012
|
*/
|
|
66782
68013
|
getTaskmanagementWorktypeVersions(worktypeId, opts) {
|
|
66783
68014
|
opts = opts || {};
|
|
@@ -67672,7 +68903,7 @@ class TeamsApi {
|
|
|
67672
68903
|
/**
|
|
67673
68904
|
* Teams service.
|
|
67674
68905
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
67675
|
-
* @version
|
|
68906
|
+
* @version 221.0.0
|
|
67676
68907
|
*/
|
|
67677
68908
|
|
|
67678
68909
|
/**
|
|
@@ -67977,7 +69208,7 @@ class TelephonyApi {
|
|
|
67977
69208
|
/**
|
|
67978
69209
|
* Telephony service.
|
|
67979
69210
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
67980
|
-
* @version
|
|
69211
|
+
* @version 221.0.0
|
|
67981
69212
|
*/
|
|
67982
69213
|
|
|
67983
69214
|
/**
|
|
@@ -68159,7 +69390,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
68159
69390
|
/**
|
|
68160
69391
|
* TelephonyProvidersEdge service.
|
|
68161
69392
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
68162
|
-
* @version
|
|
69393
|
+
* @version 221.0.0
|
|
68163
69394
|
*/
|
|
68164
69395
|
|
|
68165
69396
|
/**
|
|
@@ -71611,7 +72842,7 @@ class TextbotsApi {
|
|
|
71611
72842
|
/**
|
|
71612
72843
|
* Textbots service.
|
|
71613
72844
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
71614
|
-
* @version
|
|
72845
|
+
* @version 221.0.0
|
|
71615
72846
|
*/
|
|
71616
72847
|
|
|
71617
72848
|
/**
|
|
@@ -71632,8 +72863,8 @@ class TextbotsApi {
|
|
|
71632
72863
|
* @param {Object} opts Optional parameters
|
|
71633
72864
|
* @param {Array.<String>} opts.botType Bot types
|
|
71634
72865
|
* @param {String} opts.botName Bot name
|
|
71635
|
-
* @param {Array.<String>} opts.botId Bot IDs
|
|
71636
|
-
* @param {Number} opts.pageSize The maximum results to return (default to 25)
|
|
72866
|
+
* @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
|
|
72867
|
+
* @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
|
|
71637
72868
|
*/
|
|
71638
72869
|
getTextbotsBotsSearch(opts) {
|
|
71639
72870
|
opts = opts || {};
|
|
@@ -71739,7 +72970,7 @@ class TokensApi {
|
|
|
71739
72970
|
/**
|
|
71740
72971
|
* Tokens service.
|
|
71741
72972
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
71742
|
-
* @version
|
|
72973
|
+
* @version 221.0.0
|
|
71743
72974
|
*/
|
|
71744
72975
|
|
|
71745
72976
|
/**
|
|
@@ -71893,7 +73124,7 @@ class UploadsApi {
|
|
|
71893
73124
|
/**
|
|
71894
73125
|
* Uploads service.
|
|
71895
73126
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
71896
|
-
* @version
|
|
73127
|
+
* @version 221.0.0
|
|
71897
73128
|
*/
|
|
71898
73129
|
|
|
71899
73130
|
/**
|
|
@@ -72184,7 +73415,7 @@ class UsageApi {
|
|
|
72184
73415
|
/**
|
|
72185
73416
|
* Usage service.
|
|
72186
73417
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
72187
|
-
* @version
|
|
73418
|
+
* @version 221.0.0
|
|
72188
73419
|
*/
|
|
72189
73420
|
|
|
72190
73421
|
/**
|
|
@@ -72399,7 +73630,7 @@ class UserRecordingsApi {
|
|
|
72399
73630
|
/**
|
|
72400
73631
|
* UserRecordings service.
|
|
72401
73632
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
72402
|
-
* @version
|
|
73633
|
+
* @version 221.0.0
|
|
72403
73634
|
*/
|
|
72404
73635
|
|
|
72405
73636
|
/**
|
|
@@ -72614,7 +73845,7 @@ class UsersApi {
|
|
|
72614
73845
|
/**
|
|
72615
73846
|
* Users service.
|
|
72616
73847
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
72617
|
-
* @version
|
|
73848
|
+
* @version 221.0.0
|
|
72618
73849
|
*/
|
|
72619
73850
|
|
|
72620
73851
|
/**
|
|
@@ -75567,7 +76798,7 @@ class UtilitiesApi {
|
|
|
75567
76798
|
/**
|
|
75568
76799
|
* Utilities service.
|
|
75569
76800
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
75570
|
-
* @version
|
|
76801
|
+
* @version 221.0.0
|
|
75571
76802
|
*/
|
|
75572
76803
|
|
|
75573
76804
|
/**
|
|
@@ -75678,7 +76909,7 @@ class VoicemailApi {
|
|
|
75678
76909
|
/**
|
|
75679
76910
|
* Voicemail service.
|
|
75680
76911
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
75681
|
-
* @version
|
|
76912
|
+
* @version 221.0.0
|
|
75682
76913
|
*/
|
|
75683
76914
|
|
|
75684
76915
|
/**
|
|
@@ -76400,7 +77631,7 @@ class WebChatApi {
|
|
|
76400
77631
|
/**
|
|
76401
77632
|
* WebChat service.
|
|
76402
77633
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
76403
|
-
* @version
|
|
77634
|
+
* @version 221.0.0
|
|
76404
77635
|
*/
|
|
76405
77636
|
|
|
76406
77637
|
/**
|
|
@@ -76960,7 +78191,7 @@ class WebDeploymentsApi {
|
|
|
76960
78191
|
/**
|
|
76961
78192
|
* WebDeployments service.
|
|
76962
78193
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
76963
|
-
* @version
|
|
78194
|
+
* @version 221.0.0
|
|
76964
78195
|
*/
|
|
76965
78196
|
|
|
76966
78197
|
/**
|
|
@@ -77277,7 +78508,6 @@ class WebDeploymentsApi {
|
|
|
77277
78508
|
* Get a deployment identity resolution setting.
|
|
77278
78509
|
*
|
|
77279
78510
|
* @param {String} deploymentId The deployment ID
|
|
77280
|
-
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
77281
78511
|
*/
|
|
77282
78512
|
getWebdeploymentsDeploymentIdentityresolution(deploymentId) {
|
|
77283
78513
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -77512,7 +78742,6 @@ class WebDeploymentsApi {
|
|
|
77512
78742
|
*
|
|
77513
78743
|
* @param {String} deploymentId The deployment ID
|
|
77514
78744
|
* @param {Object} body
|
|
77515
|
-
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
77516
78745
|
*/
|
|
77517
78746
|
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body) {
|
|
77518
78747
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -77544,7 +78773,7 @@ class WebMessagingApi {
|
|
|
77544
78773
|
/**
|
|
77545
78774
|
* WebMessaging service.
|
|
77546
78775
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
77547
|
-
* @version
|
|
78776
|
+
* @version 221.0.0
|
|
77548
78777
|
*/
|
|
77549
78778
|
|
|
77550
78779
|
/**
|
|
@@ -77590,7 +78819,7 @@ class WidgetsApi {
|
|
|
77590
78819
|
/**
|
|
77591
78820
|
* Widgets service.
|
|
77592
78821
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
77593
|
-
* @version
|
|
78822
|
+
* @version 221.0.0
|
|
77594
78823
|
*/
|
|
77595
78824
|
|
|
77596
78825
|
/**
|
|
@@ -77741,7 +78970,7 @@ class WorkforceManagementApi {
|
|
|
77741
78970
|
/**
|
|
77742
78971
|
* WorkforceManagement service.
|
|
77743
78972
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
77744
|
-
* @version
|
|
78973
|
+
* @version 221.0.0
|
|
77745
78974
|
*/
|
|
77746
78975
|
|
|
77747
78976
|
/**
|
|
@@ -85136,7 +86365,7 @@ class WorkforceManagementApi {
|
|
|
85136
86365
|
* </pre>
|
|
85137
86366
|
* </p>
|
|
85138
86367
|
* @module purecloud-platform-client-v2/index
|
|
85139
|
-
* @version
|
|
86368
|
+
* @version 221.0.0
|
|
85140
86369
|
*/
|
|
85141
86370
|
class platformClient {
|
|
85142
86371
|
constructor() {
|
|
@@ -85195,6 +86424,11 @@ class platformClient {
|
|
|
85195
86424
|
* @property {module:purecloud-platform-client-v2/api/BillingApi}
|
|
85196
86425
|
*/
|
|
85197
86426
|
this.BillingApi = BillingApi;
|
|
86427
|
+
/**
|
|
86428
|
+
* The BusinessRulesApi service constructor.
|
|
86429
|
+
* @property {module:purecloud-platform-client-v2/api/BusinessRulesApi}
|
|
86430
|
+
*/
|
|
86431
|
+
this.BusinessRulesApi = BusinessRulesApi;
|
|
85198
86432
|
/**
|
|
85199
86433
|
* The CarrierServicesApi service constructor.
|
|
85200
86434
|
* @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
|