purecloud-platform-client-v2 220.0.0 → 222.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1428 -138
- package/dist/web-amd/purecloud-platform-client-v2.js +1428 -138
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +497 -168
- package/dist/web-cjs/purecloud-platform-client-v2.js +497 -168
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1041 -253
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +5 -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 +153 -14
- 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 +3 -18
- 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 +1 -1
- 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 +1 -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 +2 -2
- 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 -2
- 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 +3 -2
- 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 222.0.0
|
|
694
694
|
*/
|
|
695
695
|
class ApiClient {
|
|
696
696
|
/**
|
|
@@ -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 222.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 222.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 222.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 222.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 222.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 222.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,
|
|
@@ -8013,6 +8013,7 @@ class ArchitectApi {
|
|
|
8013
8013
|
* @param {Object} opts.secure Secure
|
|
8014
8014
|
* @param {Boolean} opts.deleted Include deleted (default to false)
|
|
8015
8015
|
* @param {Boolean} opts.includeSchemas Include variable schemas (default to false)
|
|
8016
|
+
* @param {Boolean} opts.virtualAgentEnabled Include/exclude virtual agent flows
|
|
8016
8017
|
* @param {String} opts.publishedAfter Published after
|
|
8017
8018
|
* @param {String} opts.publishedBefore Published before
|
|
8018
8019
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
@@ -8025,7 +8026,7 @@ class ArchitectApi {
|
|
|
8025
8026
|
'/api/v2/flows',
|
|
8026
8027
|
'GET',
|
|
8027
8028
|
{ },
|
|
8028
|
-
{ 'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'publishVersionId': opts['publishVersionId'],'editableBy': opts['editableBy'],'lockedBy': opts['lockedBy'],'lockedByClientId': opts['lockedByClientId'],'secure': opts['secure'],'deleted': opts['deleted'],'includeSchemas': opts['includeSchemas'],'publishedAfter': opts['publishedAfter'],'publishedBefore': opts['publishedBefore'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
8029
|
+
{ 'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'publishVersionId': opts['publishVersionId'],'editableBy': opts['editableBy'],'lockedBy': opts['lockedBy'],'lockedByClientId': opts['lockedByClientId'],'secure': opts['secure'],'deleted': opts['deleted'],'includeSchemas': opts['includeSchemas'],'virtualAgentEnabled': opts['virtualAgentEnabled'],'publishedAfter': opts['publishedAfter'],'publishedBefore': opts['publishedBefore'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
8029
8030
|
{ },
|
|
8030
8031
|
{ },
|
|
8031
8032
|
null,
|
|
@@ -9921,7 +9922,6 @@ class ArchitectApi {
|
|
|
9921
9922
|
*
|
|
9922
9923
|
* @param {String} ivrId IVR id
|
|
9923
9924
|
* @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
9925
|
*/
|
|
9926
9926
|
putArchitectIvrIdentityresolution(ivrId, body) {
|
|
9927
9927
|
// verify the required parameter 'ivrId' is set
|
|
@@ -10332,7 +10332,7 @@ class AuditApi {
|
|
|
10332
10332
|
/**
|
|
10333
10333
|
* Audit service.
|
|
10334
10334
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10335
|
-
* @version
|
|
10335
|
+
* @version 222.0.0
|
|
10336
10336
|
*/
|
|
10337
10337
|
|
|
10338
10338
|
/**
|
|
@@ -10533,7 +10533,7 @@ class AuthorizationApi {
|
|
|
10533
10533
|
/**
|
|
10534
10534
|
* Authorization service.
|
|
10535
10535
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10536
|
-
* @version
|
|
10536
|
+
* @version 222.0.0
|
|
10537
10537
|
*/
|
|
10538
10538
|
|
|
10539
10539
|
/**
|
|
@@ -12248,7 +12248,7 @@ class BillingApi {
|
|
|
12248
12248
|
/**
|
|
12249
12249
|
* Billing service.
|
|
12250
12250
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12251
|
-
* @version
|
|
12251
|
+
* @version 222.0.0
|
|
12252
12252
|
*/
|
|
12253
12253
|
|
|
12254
12254
|
/**
|
|
@@ -12263,6 +12263,182 @@ class BillingApi {
|
|
|
12263
12263
|
}
|
|
12264
12264
|
|
|
12265
12265
|
|
|
12266
|
+
/**
|
|
12267
|
+
* Get billing contract
|
|
12268
|
+
* Retrieve a single contract from the system.
|
|
12269
|
+
* @param {String} contractId The contract number.
|
|
12270
|
+
* getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12271
|
+
*/
|
|
12272
|
+
getBillingContract(contractId) {
|
|
12273
|
+
// verify the required parameter 'contractId' is set
|
|
12274
|
+
if (contractId === undefined || contractId === null) {
|
|
12275
|
+
throw 'Missing the required parameter "contractId" when calling getBillingContract';
|
|
12276
|
+
}
|
|
12277
|
+
|
|
12278
|
+
return this.apiClient.callApi(
|
|
12279
|
+
'/api/v2/billing/contracts/{contractId}',
|
|
12280
|
+
'GET',
|
|
12281
|
+
{ 'contractId': contractId },
|
|
12282
|
+
{ },
|
|
12283
|
+
{ },
|
|
12284
|
+
{ },
|
|
12285
|
+
null,
|
|
12286
|
+
['PureCloud OAuth'],
|
|
12287
|
+
['application/json'],
|
|
12288
|
+
['application/json']
|
|
12289
|
+
);
|
|
12290
|
+
}
|
|
12291
|
+
|
|
12292
|
+
/**
|
|
12293
|
+
* Get contract billing period
|
|
12294
|
+
* Fetch the billing information for a given Organization by billing period.
|
|
12295
|
+
* @param {String} contractId The contract number.
|
|
12296
|
+
* @param {String} billingPeriodId The Billing Period Id for the Org.
|
|
12297
|
+
* getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12298
|
+
*/
|
|
12299
|
+
getBillingContractBillingperiod(contractId, billingPeriodId) {
|
|
12300
|
+
// verify the required parameter 'contractId' is set
|
|
12301
|
+
if (contractId === undefined || contractId === null) {
|
|
12302
|
+
throw 'Missing the required parameter "contractId" when calling getBillingContractBillingperiod';
|
|
12303
|
+
}
|
|
12304
|
+
// verify the required parameter 'billingPeriodId' is set
|
|
12305
|
+
if (billingPeriodId === undefined || billingPeriodId === null) {
|
|
12306
|
+
throw 'Missing the required parameter "billingPeriodId" when calling getBillingContractBillingperiod';
|
|
12307
|
+
}
|
|
12308
|
+
|
|
12309
|
+
return this.apiClient.callApi(
|
|
12310
|
+
'/api/v2/billing/contracts/{contractId}/billingperiods/{billingPeriodId}',
|
|
12311
|
+
'GET',
|
|
12312
|
+
{ 'contractId': contractId,'billingPeriodId': billingPeriodId },
|
|
12313
|
+
{ },
|
|
12314
|
+
{ },
|
|
12315
|
+
{ },
|
|
12316
|
+
null,
|
|
12317
|
+
['PureCloud OAuth'],
|
|
12318
|
+
['application/json'],
|
|
12319
|
+
['application/json']
|
|
12320
|
+
);
|
|
12321
|
+
}
|
|
12322
|
+
|
|
12323
|
+
/**
|
|
12324
|
+
* Get billing contracts
|
|
12325
|
+
* Retrieve a list of contracts stored in the system.
|
|
12326
|
+
* @param {Object} opts Optional parameters
|
|
12327
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12328
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12329
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12330
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12331
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12332
|
+
* @param {Object} opts.status Filter by the status of contracts
|
|
12333
|
+
* @param {String} opts.externalNumber Filter by the unique external number.
|
|
12334
|
+
* getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12335
|
+
*/
|
|
12336
|
+
getBillingContracts(opts) {
|
|
12337
|
+
opts = opts || {};
|
|
12338
|
+
|
|
12339
|
+
|
|
12340
|
+
return this.apiClient.callApi(
|
|
12341
|
+
'/api/v2/billing/contracts',
|
|
12342
|
+
'GET',
|
|
12343
|
+
{ },
|
|
12344
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': opts['status'],'externalNumber': opts['externalNumber'] },
|
|
12345
|
+
{ },
|
|
12346
|
+
{ },
|
|
12347
|
+
null,
|
|
12348
|
+
['PureCloud OAuth'],
|
|
12349
|
+
['application/json'],
|
|
12350
|
+
['application/json']
|
|
12351
|
+
);
|
|
12352
|
+
}
|
|
12353
|
+
|
|
12354
|
+
/**
|
|
12355
|
+
* Get invoice document
|
|
12356
|
+
* Fetch the document for a specific invoice.
|
|
12357
|
+
* @param {String} invoiceId invoiceId
|
|
12358
|
+
* getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12359
|
+
*/
|
|
12360
|
+
getBillingContractsInvoiceDocument(invoiceId) {
|
|
12361
|
+
// verify the required parameter 'invoiceId' is set
|
|
12362
|
+
if (invoiceId === undefined || invoiceId === null) {
|
|
12363
|
+
throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceDocument';
|
|
12364
|
+
}
|
|
12365
|
+
|
|
12366
|
+
return this.apiClient.callApi(
|
|
12367
|
+
'/api/v2/billing/contracts/invoices/{invoiceId}/document',
|
|
12368
|
+
'GET',
|
|
12369
|
+
{ 'invoiceId': invoiceId },
|
|
12370
|
+
{ },
|
|
12371
|
+
{ },
|
|
12372
|
+
{ },
|
|
12373
|
+
null,
|
|
12374
|
+
['PureCloud OAuth'],
|
|
12375
|
+
['application/json'],
|
|
12376
|
+
['application/json']
|
|
12377
|
+
);
|
|
12378
|
+
}
|
|
12379
|
+
|
|
12380
|
+
/**
|
|
12381
|
+
* Get invoice lines
|
|
12382
|
+
* Fetch a list of all bills for the specified account.
|
|
12383
|
+
* @param {String} invoiceId invoiceId
|
|
12384
|
+
* @param {Object} opts Optional parameters
|
|
12385
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12386
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12387
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12388
|
+
* getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12389
|
+
*/
|
|
12390
|
+
getBillingContractsInvoiceLines(invoiceId, opts) {
|
|
12391
|
+
opts = opts || {};
|
|
12392
|
+
|
|
12393
|
+
// verify the required parameter 'invoiceId' is set
|
|
12394
|
+
if (invoiceId === undefined || invoiceId === null) {
|
|
12395
|
+
throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceLines';
|
|
12396
|
+
}
|
|
12397
|
+
|
|
12398
|
+
return this.apiClient.callApi(
|
|
12399
|
+
'/api/v2/billing/contracts/invoices/{invoiceId}/lines',
|
|
12400
|
+
'GET',
|
|
12401
|
+
{ 'invoiceId': invoiceId },
|
|
12402
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
12403
|
+
{ },
|
|
12404
|
+
{ },
|
|
12405
|
+
null,
|
|
12406
|
+
['PureCloud OAuth'],
|
|
12407
|
+
['application/json'],
|
|
12408
|
+
['application/json']
|
|
12409
|
+
);
|
|
12410
|
+
}
|
|
12411
|
+
|
|
12412
|
+
/**
|
|
12413
|
+
* Get invoices
|
|
12414
|
+
* Retrieve a list of invoices stored in the system.
|
|
12415
|
+
* @param {Object} opts Optional parameters
|
|
12416
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12417
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12418
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12419
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12420
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12421
|
+
* @param {Object} opts.paymentStatus Payment Status
|
|
12422
|
+
* getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12423
|
+
*/
|
|
12424
|
+
getBillingContractsInvoices(opts) {
|
|
12425
|
+
opts = opts || {};
|
|
12426
|
+
|
|
12427
|
+
|
|
12428
|
+
return this.apiClient.callApi(
|
|
12429
|
+
'/api/v2/billing/contracts/invoices',
|
|
12430
|
+
'GET',
|
|
12431
|
+
{ },
|
|
12432
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'paymentStatus': opts['paymentStatus'] },
|
|
12433
|
+
{ },
|
|
12434
|
+
{ },
|
|
12435
|
+
null,
|
|
12436
|
+
['PureCloud OAuth'],
|
|
12437
|
+
['application/json'],
|
|
12438
|
+
['application/json']
|
|
12439
|
+
);
|
|
12440
|
+
}
|
|
12441
|
+
|
|
12266
12442
|
/**
|
|
12267
12443
|
* Get a report of the billable license usages
|
|
12268
12444
|
* 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 +12500,925 @@ class BillingApi {
|
|
|
12324
12500
|
|
|
12325
12501
|
}
|
|
12326
12502
|
|
|
12503
|
+
class BusinessRulesApi {
|
|
12504
|
+
/**
|
|
12505
|
+
* BusinessRules service.
|
|
12506
|
+
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12507
|
+
* @version 222.0.0
|
|
12508
|
+
*/
|
|
12509
|
+
|
|
12510
|
+
/**
|
|
12511
|
+
* Constructs a new BusinessRulesApi.
|
|
12512
|
+
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12513
|
+
* @class
|
|
12514
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
12515
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
12516
|
+
*/
|
|
12517
|
+
constructor(apiClient) {
|
|
12518
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
12519
|
+
}
|
|
12520
|
+
|
|
12521
|
+
|
|
12522
|
+
/**
|
|
12523
|
+
* Delete a decision table
|
|
12524
|
+
*
|
|
12525
|
+
* @param {String} tableId Table ID
|
|
12526
|
+
* @param {Object} opts Optional parameters
|
|
12527
|
+
* @param {Boolean} opts.forceDelete Force delete decision table (under certain conditions) (default to false)
|
|
12528
|
+
* deleteBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12529
|
+
*/
|
|
12530
|
+
deleteBusinessrulesDecisiontable(tableId, opts) {
|
|
12531
|
+
opts = opts || {};
|
|
12532
|
+
|
|
12533
|
+
// verify the required parameter 'tableId' is set
|
|
12534
|
+
if (tableId === undefined || tableId === null) {
|
|
12535
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontable';
|
|
12536
|
+
}
|
|
12537
|
+
|
|
12538
|
+
return this.apiClient.callApi(
|
|
12539
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12540
|
+
'DELETE',
|
|
12541
|
+
{ 'tableId': tableId },
|
|
12542
|
+
{ 'forceDelete': opts['forceDelete'] },
|
|
12543
|
+
{ },
|
|
12544
|
+
{ },
|
|
12545
|
+
null,
|
|
12546
|
+
['PureCloud OAuth'],
|
|
12547
|
+
['application/json'],
|
|
12548
|
+
['application/json']
|
|
12549
|
+
);
|
|
12550
|
+
}
|
|
12551
|
+
|
|
12552
|
+
/**
|
|
12553
|
+
* Delete a decision table version
|
|
12554
|
+
*
|
|
12555
|
+
* @param {String} tableId Table ID
|
|
12556
|
+
* @param {Number} tableVersion Table Version
|
|
12557
|
+
* deleteBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12558
|
+
*/
|
|
12559
|
+
deleteBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
12560
|
+
// verify the required parameter 'tableId' is set
|
|
12561
|
+
if (tableId === undefined || tableId === null) {
|
|
12562
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersion';
|
|
12563
|
+
}
|
|
12564
|
+
// verify the required parameter 'tableVersion' is set
|
|
12565
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12566
|
+
throw 'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersion';
|
|
12567
|
+
}
|
|
12568
|
+
|
|
12569
|
+
return this.apiClient.callApi(
|
|
12570
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
12571
|
+
'DELETE',
|
|
12572
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12573
|
+
{ },
|
|
12574
|
+
{ },
|
|
12575
|
+
{ },
|
|
12576
|
+
null,
|
|
12577
|
+
['PureCloud OAuth'],
|
|
12578
|
+
['application/json'],
|
|
12579
|
+
['application/json']
|
|
12580
|
+
);
|
|
12581
|
+
}
|
|
12582
|
+
|
|
12583
|
+
/**
|
|
12584
|
+
* Delete a decision table row
|
|
12585
|
+
*
|
|
12586
|
+
* @param {String} tableId Table ID
|
|
12587
|
+
* @param {Number} tableVersion Table Version
|
|
12588
|
+
* @param {String} rowId Row ID
|
|
12589
|
+
* deleteBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12590
|
+
*/
|
|
12591
|
+
deleteBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
12592
|
+
// verify the required parameter 'tableId' is set
|
|
12593
|
+
if (tableId === undefined || tableId === null) {
|
|
12594
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12595
|
+
}
|
|
12596
|
+
// verify the required parameter 'tableVersion' is set
|
|
12597
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12598
|
+
throw 'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12599
|
+
}
|
|
12600
|
+
// verify the required parameter 'rowId' is set
|
|
12601
|
+
if (rowId === undefined || rowId === null) {
|
|
12602
|
+
throw 'Missing the required parameter "rowId" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12603
|
+
}
|
|
12604
|
+
|
|
12605
|
+
return this.apiClient.callApi(
|
|
12606
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
12607
|
+
'DELETE',
|
|
12608
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
12609
|
+
{ },
|
|
12610
|
+
{ },
|
|
12611
|
+
{ },
|
|
12612
|
+
null,
|
|
12613
|
+
['PureCloud OAuth'],
|
|
12614
|
+
['application/json'],
|
|
12615
|
+
['application/json']
|
|
12616
|
+
);
|
|
12617
|
+
}
|
|
12618
|
+
|
|
12619
|
+
/**
|
|
12620
|
+
* Delete a schema
|
|
12621
|
+
*
|
|
12622
|
+
* @param {String} schemaId Schema ID
|
|
12623
|
+
* deleteBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12624
|
+
*/
|
|
12625
|
+
deleteBusinessrulesSchema(schemaId) {
|
|
12626
|
+
// verify the required parameter 'schemaId' is set
|
|
12627
|
+
if (schemaId === undefined || schemaId === null) {
|
|
12628
|
+
throw 'Missing the required parameter "schemaId" when calling deleteBusinessrulesSchema';
|
|
12629
|
+
}
|
|
12630
|
+
|
|
12631
|
+
return this.apiClient.callApi(
|
|
12632
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
12633
|
+
'DELETE',
|
|
12634
|
+
{ 'schemaId': schemaId },
|
|
12635
|
+
{ },
|
|
12636
|
+
{ },
|
|
12637
|
+
{ },
|
|
12638
|
+
null,
|
|
12639
|
+
['PureCloud OAuth'],
|
|
12640
|
+
['application/json'],
|
|
12641
|
+
['application/json']
|
|
12642
|
+
);
|
|
12643
|
+
}
|
|
12644
|
+
|
|
12645
|
+
/**
|
|
12646
|
+
* Get a decision table
|
|
12647
|
+
*
|
|
12648
|
+
* @param {String} tableId Table ID
|
|
12649
|
+
* getBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12650
|
+
*/
|
|
12651
|
+
getBusinessrulesDecisiontable(tableId) {
|
|
12652
|
+
// verify the required parameter 'tableId' is set
|
|
12653
|
+
if (tableId === undefined || tableId === null) {
|
|
12654
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontable';
|
|
12655
|
+
}
|
|
12656
|
+
|
|
12657
|
+
return this.apiClient.callApi(
|
|
12658
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12659
|
+
'GET',
|
|
12660
|
+
{ 'tableId': tableId },
|
|
12661
|
+
{ },
|
|
12662
|
+
{ },
|
|
12663
|
+
{ },
|
|
12664
|
+
null,
|
|
12665
|
+
['PureCloud OAuth'],
|
|
12666
|
+
['application/json'],
|
|
12667
|
+
['application/json']
|
|
12668
|
+
);
|
|
12669
|
+
}
|
|
12670
|
+
|
|
12671
|
+
/**
|
|
12672
|
+
* Get a decision table version
|
|
12673
|
+
*
|
|
12674
|
+
* @param {String} tableId Table ID
|
|
12675
|
+
* @param {Number} tableVersion Table Version
|
|
12676
|
+
* getBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12677
|
+
*/
|
|
12678
|
+
getBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
12679
|
+
// verify the required parameter 'tableId' is set
|
|
12680
|
+
if (tableId === undefined || tableId === null) {
|
|
12681
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersion';
|
|
12682
|
+
}
|
|
12683
|
+
// verify the required parameter 'tableVersion' is set
|
|
12684
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12685
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersion';
|
|
12686
|
+
}
|
|
12687
|
+
|
|
12688
|
+
return this.apiClient.callApi(
|
|
12689
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
12690
|
+
'GET',
|
|
12691
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12692
|
+
{ },
|
|
12693
|
+
{ },
|
|
12694
|
+
{ },
|
|
12695
|
+
null,
|
|
12696
|
+
['PureCloud OAuth'],
|
|
12697
|
+
['application/json'],
|
|
12698
|
+
['application/json']
|
|
12699
|
+
);
|
|
12700
|
+
}
|
|
12701
|
+
|
|
12702
|
+
/**
|
|
12703
|
+
* Get a decision table row
|
|
12704
|
+
*
|
|
12705
|
+
* @param {String} tableId Table ID
|
|
12706
|
+
* @param {Number} tableVersion Table Version
|
|
12707
|
+
* @param {String} rowId Row ID
|
|
12708
|
+
* getBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12709
|
+
*/
|
|
12710
|
+
getBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
12711
|
+
// verify the required parameter 'tableId' is set
|
|
12712
|
+
if (tableId === undefined || tableId === null) {
|
|
12713
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12714
|
+
}
|
|
12715
|
+
// verify the required parameter 'tableVersion' is set
|
|
12716
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12717
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12718
|
+
}
|
|
12719
|
+
// verify the required parameter 'rowId' is set
|
|
12720
|
+
if (rowId === undefined || rowId === null) {
|
|
12721
|
+
throw 'Missing the required parameter "rowId" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12722
|
+
}
|
|
12723
|
+
|
|
12724
|
+
return this.apiClient.callApi(
|
|
12725
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
12726
|
+
'GET',
|
|
12727
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
12728
|
+
{ },
|
|
12729
|
+
{ },
|
|
12730
|
+
{ },
|
|
12731
|
+
null,
|
|
12732
|
+
['PureCloud OAuth'],
|
|
12733
|
+
['application/json'],
|
|
12734
|
+
['application/json']
|
|
12735
|
+
);
|
|
12736
|
+
}
|
|
12737
|
+
|
|
12738
|
+
/**
|
|
12739
|
+
* Get a list of decision table rows.
|
|
12740
|
+
*
|
|
12741
|
+
* @param {String} tableId Table ID
|
|
12742
|
+
* @param {Number} tableVersion Table Version
|
|
12743
|
+
* @param {Object} opts Optional parameters
|
|
12744
|
+
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
12745
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
12746
|
+
* getBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12747
|
+
*/
|
|
12748
|
+
getBusinessrulesDecisiontableVersionRows(tableId, tableVersion, opts) {
|
|
12749
|
+
opts = opts || {};
|
|
12750
|
+
|
|
12751
|
+
// verify the required parameter 'tableId' is set
|
|
12752
|
+
if (tableId === undefined || tableId === null) {
|
|
12753
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRows';
|
|
12754
|
+
}
|
|
12755
|
+
// verify the required parameter 'tableVersion' is set
|
|
12756
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12757
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRows';
|
|
12758
|
+
}
|
|
12759
|
+
|
|
12760
|
+
return this.apiClient.callApi(
|
|
12761
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows',
|
|
12762
|
+
'GET',
|
|
12763
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12764
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
12765
|
+
{ },
|
|
12766
|
+
{ },
|
|
12767
|
+
null,
|
|
12768
|
+
['PureCloud OAuth'],
|
|
12769
|
+
['application/json'],
|
|
12770
|
+
['application/json']
|
|
12771
|
+
);
|
|
12772
|
+
}
|
|
12773
|
+
|
|
12774
|
+
/**
|
|
12775
|
+
* Get a list of decision table versions
|
|
12776
|
+
*
|
|
12777
|
+
* @param {String} tableId Table ID
|
|
12778
|
+
* @param {Object} opts Optional parameters
|
|
12779
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12780
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12781
|
+
* @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.
|
|
12782
|
+
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12783
|
+
*/
|
|
12784
|
+
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
12785
|
+
opts = opts || {};
|
|
12786
|
+
|
|
12787
|
+
// verify the required parameter 'tableId' is set
|
|
12788
|
+
if (tableId === undefined || tableId === null) {
|
|
12789
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersions';
|
|
12790
|
+
}
|
|
12791
|
+
|
|
12792
|
+
return this.apiClient.callApi(
|
|
12793
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
12794
|
+
'GET',
|
|
12795
|
+
{ 'tableId': tableId },
|
|
12796
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
12797
|
+
{ },
|
|
12798
|
+
{ },
|
|
12799
|
+
null,
|
|
12800
|
+
['PureCloud OAuth'],
|
|
12801
|
+
['application/json'],
|
|
12802
|
+
['application/json']
|
|
12803
|
+
);
|
|
12804
|
+
}
|
|
12805
|
+
|
|
12806
|
+
/**
|
|
12807
|
+
* Get a list of decision tables.
|
|
12808
|
+
*
|
|
12809
|
+
* @param {Object} opts Optional parameters
|
|
12810
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12811
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12812
|
+
* @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.
|
|
12813
|
+
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12814
|
+
*/
|
|
12815
|
+
getBusinessrulesDecisiontables(opts) {
|
|
12816
|
+
opts = opts || {};
|
|
12817
|
+
|
|
12818
|
+
|
|
12819
|
+
return this.apiClient.callApi(
|
|
12820
|
+
'/api/v2/businessrules/decisiontables',
|
|
12821
|
+
'GET',
|
|
12822
|
+
{ },
|
|
12823
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
12824
|
+
{ },
|
|
12825
|
+
{ },
|
|
12826
|
+
null,
|
|
12827
|
+
['PureCloud OAuth'],
|
|
12828
|
+
['application/json'],
|
|
12829
|
+
['application/json']
|
|
12830
|
+
);
|
|
12831
|
+
}
|
|
12832
|
+
|
|
12833
|
+
/**
|
|
12834
|
+
* Search for decision tables.
|
|
12835
|
+
*
|
|
12836
|
+
* @param {Object} opts Optional parameters
|
|
12837
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12838
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12839
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12840
|
+
* @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.
|
|
12841
|
+
* @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.
|
|
12842
|
+
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12843
|
+
*/
|
|
12844
|
+
getBusinessrulesDecisiontablesSearch(opts) {
|
|
12845
|
+
opts = opts || {};
|
|
12846
|
+
|
|
12847
|
+
|
|
12848
|
+
return this.apiClient.callApi(
|
|
12849
|
+
'/api/v2/businessrules/decisiontables/search',
|
|
12850
|
+
'GET',
|
|
12851
|
+
{ },
|
|
12852
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'] },
|
|
12853
|
+
{ },
|
|
12854
|
+
{ },
|
|
12855
|
+
null,
|
|
12856
|
+
['PureCloud OAuth'],
|
|
12857
|
+
['application/json'],
|
|
12858
|
+
['application/json']
|
|
12859
|
+
);
|
|
12860
|
+
}
|
|
12861
|
+
|
|
12862
|
+
/**
|
|
12863
|
+
* Get a schema
|
|
12864
|
+
*
|
|
12865
|
+
* @param {String} schemaId Schema ID
|
|
12866
|
+
* getBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12867
|
+
*/
|
|
12868
|
+
getBusinessrulesSchema(schemaId) {
|
|
12869
|
+
// verify the required parameter 'schemaId' is set
|
|
12870
|
+
if (schemaId === undefined || schemaId === null) {
|
|
12871
|
+
throw 'Missing the required parameter "schemaId" when calling getBusinessrulesSchema';
|
|
12872
|
+
}
|
|
12873
|
+
|
|
12874
|
+
return this.apiClient.callApi(
|
|
12875
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
12876
|
+
'GET',
|
|
12877
|
+
{ 'schemaId': schemaId },
|
|
12878
|
+
{ },
|
|
12879
|
+
{ },
|
|
12880
|
+
{ },
|
|
12881
|
+
null,
|
|
12882
|
+
['PureCloud OAuth'],
|
|
12883
|
+
['application/json'],
|
|
12884
|
+
['application/json']
|
|
12885
|
+
);
|
|
12886
|
+
}
|
|
12887
|
+
|
|
12888
|
+
/**
|
|
12889
|
+
* Get a list of schemas.
|
|
12890
|
+
*
|
|
12891
|
+
* getBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12892
|
+
*/
|
|
12893
|
+
getBusinessrulesSchemas() {
|
|
12894
|
+
|
|
12895
|
+
return this.apiClient.callApi(
|
|
12896
|
+
'/api/v2/businessrules/schemas',
|
|
12897
|
+
'GET',
|
|
12898
|
+
{ },
|
|
12899
|
+
{ },
|
|
12900
|
+
{ },
|
|
12901
|
+
{ },
|
|
12902
|
+
null,
|
|
12903
|
+
['PureCloud OAuth'],
|
|
12904
|
+
['application/json'],
|
|
12905
|
+
['application/json']
|
|
12906
|
+
);
|
|
12907
|
+
}
|
|
12908
|
+
|
|
12909
|
+
/**
|
|
12910
|
+
* Get a specific named core type.
|
|
12911
|
+
*
|
|
12912
|
+
* @param {String} coreTypeName The core type's name
|
|
12913
|
+
* getBusinessrulesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12914
|
+
*/
|
|
12915
|
+
getBusinessrulesSchemasCoretype(coreTypeName) {
|
|
12916
|
+
// verify the required parameter 'coreTypeName' is set
|
|
12917
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
12918
|
+
throw 'Missing the required parameter "coreTypeName" when calling getBusinessrulesSchemasCoretype';
|
|
12919
|
+
}
|
|
12920
|
+
|
|
12921
|
+
return this.apiClient.callApi(
|
|
12922
|
+
'/api/v2/businessrules/schemas/coretypes/{coreTypeName}',
|
|
12923
|
+
'GET',
|
|
12924
|
+
{ 'coreTypeName': coreTypeName },
|
|
12925
|
+
{ },
|
|
12926
|
+
{ },
|
|
12927
|
+
{ },
|
|
12928
|
+
null,
|
|
12929
|
+
['PureCloud OAuth'],
|
|
12930
|
+
['application/json'],
|
|
12931
|
+
['application/json']
|
|
12932
|
+
);
|
|
12933
|
+
}
|
|
12934
|
+
|
|
12935
|
+
/**
|
|
12936
|
+
* Get the core types from which all schemas are built.
|
|
12937
|
+
*
|
|
12938
|
+
* getBusinessrulesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12939
|
+
*/
|
|
12940
|
+
getBusinessrulesSchemasCoretypes() {
|
|
12941
|
+
|
|
12942
|
+
return this.apiClient.callApi(
|
|
12943
|
+
'/api/v2/businessrules/schemas/coretypes',
|
|
12944
|
+
'GET',
|
|
12945
|
+
{ },
|
|
12946
|
+
{ },
|
|
12947
|
+
{ },
|
|
12948
|
+
{ },
|
|
12949
|
+
null,
|
|
12950
|
+
['PureCloud OAuth'],
|
|
12951
|
+
['application/json'],
|
|
12952
|
+
['application/json']
|
|
12953
|
+
);
|
|
12954
|
+
}
|
|
12955
|
+
|
|
12956
|
+
/**
|
|
12957
|
+
* Update a decision table
|
|
12958
|
+
*
|
|
12959
|
+
* @param {String} tableId Table ID
|
|
12960
|
+
* @param {Object} body Decision Table
|
|
12961
|
+
* patchBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12962
|
+
*/
|
|
12963
|
+
patchBusinessrulesDecisiontable(tableId, body) {
|
|
12964
|
+
// verify the required parameter 'tableId' is set
|
|
12965
|
+
if (tableId === undefined || tableId === null) {
|
|
12966
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontable';
|
|
12967
|
+
}
|
|
12968
|
+
// verify the required parameter 'body' is set
|
|
12969
|
+
if (body === undefined || body === null) {
|
|
12970
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontable';
|
|
12971
|
+
}
|
|
12972
|
+
|
|
12973
|
+
return this.apiClient.callApi(
|
|
12974
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12975
|
+
'PATCH',
|
|
12976
|
+
{ 'tableId': tableId },
|
|
12977
|
+
{ },
|
|
12978
|
+
{ },
|
|
12979
|
+
{ },
|
|
12980
|
+
body,
|
|
12981
|
+
['PureCloud OAuth'],
|
|
12982
|
+
['application/json'],
|
|
12983
|
+
['application/json']
|
|
12984
|
+
);
|
|
12985
|
+
}
|
|
12986
|
+
|
|
12987
|
+
/**
|
|
12988
|
+
* Update a decision table version
|
|
12989
|
+
*
|
|
12990
|
+
* @param {String} tableId Table ID
|
|
12991
|
+
* @param {Number} tableVersion Table Version
|
|
12992
|
+
* @param {Object} body Decision Table
|
|
12993
|
+
* patchBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12994
|
+
*/
|
|
12995
|
+
patchBusinessrulesDecisiontableVersion(tableId, tableVersion, body) {
|
|
12996
|
+
// verify the required parameter 'tableId' is set
|
|
12997
|
+
if (tableId === undefined || tableId === null) {
|
|
12998
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersion';
|
|
12999
|
+
}
|
|
13000
|
+
// verify the required parameter 'tableVersion' is set
|
|
13001
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13002
|
+
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersion';
|
|
13003
|
+
}
|
|
13004
|
+
// verify the required parameter 'body' is set
|
|
13005
|
+
if (body === undefined || body === null) {
|
|
13006
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersion';
|
|
13007
|
+
}
|
|
13008
|
+
|
|
13009
|
+
return this.apiClient.callApi(
|
|
13010
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
13011
|
+
'PATCH',
|
|
13012
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13013
|
+
{ },
|
|
13014
|
+
{ },
|
|
13015
|
+
{ },
|
|
13016
|
+
body,
|
|
13017
|
+
['PureCloud OAuth'],
|
|
13018
|
+
['application/json'],
|
|
13019
|
+
['application/json']
|
|
13020
|
+
);
|
|
13021
|
+
}
|
|
13022
|
+
|
|
13023
|
+
/**
|
|
13024
|
+
* Update a decision table row
|
|
13025
|
+
*
|
|
13026
|
+
* @param {String} tableId Table ID
|
|
13027
|
+
* @param {Number} tableVersion Table Version
|
|
13028
|
+
* @param {String} rowId Row ID
|
|
13029
|
+
* @param {Object} body Update decision table row request
|
|
13030
|
+
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13031
|
+
*/
|
|
13032
|
+
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
13033
|
+
// verify the required parameter 'tableId' is set
|
|
13034
|
+
if (tableId === undefined || tableId === null) {
|
|
13035
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13036
|
+
}
|
|
13037
|
+
// verify the required parameter 'tableVersion' is set
|
|
13038
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13039
|
+
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13040
|
+
}
|
|
13041
|
+
// verify the required parameter 'rowId' is set
|
|
13042
|
+
if (rowId === undefined || rowId === null) {
|
|
13043
|
+
throw 'Missing the required parameter "rowId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13044
|
+
}
|
|
13045
|
+
// verify the required parameter 'body' is set
|
|
13046
|
+
if (body === undefined || body === null) {
|
|
13047
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13048
|
+
}
|
|
13049
|
+
|
|
13050
|
+
return this.apiClient.callApi(
|
|
13051
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
13052
|
+
'PATCH',
|
|
13053
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
13054
|
+
{ },
|
|
13055
|
+
{ },
|
|
13056
|
+
{ },
|
|
13057
|
+
body,
|
|
13058
|
+
['PureCloud OAuth'],
|
|
13059
|
+
['application/json'],
|
|
13060
|
+
['application/json']
|
|
13061
|
+
);
|
|
13062
|
+
}
|
|
13063
|
+
|
|
13064
|
+
/**
|
|
13065
|
+
* Execute a published decision table
|
|
13066
|
+
*
|
|
13067
|
+
* @param {String} tableId Table ID
|
|
13068
|
+
* @param {Object} body Decision Table
|
|
13069
|
+
* postBusinessrulesDecisiontableExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13070
|
+
*/
|
|
13071
|
+
postBusinessrulesDecisiontableExecute(tableId, body) {
|
|
13072
|
+
// verify the required parameter 'tableId' is set
|
|
13073
|
+
if (tableId === undefined || tableId === null) {
|
|
13074
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExecute';
|
|
13075
|
+
}
|
|
13076
|
+
// verify the required parameter 'body' is set
|
|
13077
|
+
if (body === undefined || body === null) {
|
|
13078
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExecute';
|
|
13079
|
+
}
|
|
13080
|
+
|
|
13081
|
+
return this.apiClient.callApi(
|
|
13082
|
+
'/api/v2/businessrules/decisiontables/{tableId}/execute',
|
|
13083
|
+
'POST',
|
|
13084
|
+
{ 'tableId': tableId },
|
|
13085
|
+
{ },
|
|
13086
|
+
{ },
|
|
13087
|
+
{ },
|
|
13088
|
+
body,
|
|
13089
|
+
['PureCloud OAuth'],
|
|
13090
|
+
['application/json'],
|
|
13091
|
+
['application/json']
|
|
13092
|
+
);
|
|
13093
|
+
}
|
|
13094
|
+
|
|
13095
|
+
/**
|
|
13096
|
+
* Copy a decision table version
|
|
13097
|
+
*
|
|
13098
|
+
* @param {String} tableId Table ID
|
|
13099
|
+
* @param {Number} tableVersion Table Version
|
|
13100
|
+
* @param {Object} body Decision Table
|
|
13101
|
+
* postBusinessrulesDecisiontableVersionCopy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13102
|
+
*/
|
|
13103
|
+
postBusinessrulesDecisiontableVersionCopy(tableId, tableVersion, body) {
|
|
13104
|
+
// verify the required parameter 'tableId' is set
|
|
13105
|
+
if (tableId === undefined || tableId === null) {
|
|
13106
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13107
|
+
}
|
|
13108
|
+
// verify the required parameter 'tableVersion' is set
|
|
13109
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13110
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13111
|
+
}
|
|
13112
|
+
// verify the required parameter 'body' is set
|
|
13113
|
+
if (body === undefined || body === null) {
|
|
13114
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13115
|
+
}
|
|
13116
|
+
|
|
13117
|
+
return this.apiClient.callApi(
|
|
13118
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/copy',
|
|
13119
|
+
'POST',
|
|
13120
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13121
|
+
{ },
|
|
13122
|
+
{ },
|
|
13123
|
+
{ },
|
|
13124
|
+
body,
|
|
13125
|
+
['PureCloud OAuth'],
|
|
13126
|
+
['application/json'],
|
|
13127
|
+
['application/json']
|
|
13128
|
+
);
|
|
13129
|
+
}
|
|
13130
|
+
|
|
13131
|
+
/**
|
|
13132
|
+
* Execute a decision table version
|
|
13133
|
+
*
|
|
13134
|
+
* @param {String} tableId Table ID
|
|
13135
|
+
* @param {Number} tableVersion Table Version
|
|
13136
|
+
* @param {Object} body Decision Table
|
|
13137
|
+
* postBusinessrulesDecisiontableVersionExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13138
|
+
*/
|
|
13139
|
+
postBusinessrulesDecisiontableVersionExecute(tableId, tableVersion, body) {
|
|
13140
|
+
// verify the required parameter 'tableId' is set
|
|
13141
|
+
if (tableId === undefined || tableId === null) {
|
|
13142
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13143
|
+
}
|
|
13144
|
+
// verify the required parameter 'tableVersion' is set
|
|
13145
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13146
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13147
|
+
}
|
|
13148
|
+
// verify the required parameter 'body' is set
|
|
13149
|
+
if (body === undefined || body === null) {
|
|
13150
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13151
|
+
}
|
|
13152
|
+
|
|
13153
|
+
return this.apiClient.callApi(
|
|
13154
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/execute',
|
|
13155
|
+
'POST',
|
|
13156
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13157
|
+
{ },
|
|
13158
|
+
{ },
|
|
13159
|
+
{ },
|
|
13160
|
+
body,
|
|
13161
|
+
['PureCloud OAuth'],
|
|
13162
|
+
['application/json'],
|
|
13163
|
+
['application/json']
|
|
13164
|
+
);
|
|
13165
|
+
}
|
|
13166
|
+
|
|
13167
|
+
/**
|
|
13168
|
+
* Create a decision table row
|
|
13169
|
+
*
|
|
13170
|
+
* @param {String} tableId Table ID
|
|
13171
|
+
* @param {Number} tableVersion Table Version
|
|
13172
|
+
* @param {Object} body Create decision table row request
|
|
13173
|
+
* postBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13174
|
+
*/
|
|
13175
|
+
postBusinessrulesDecisiontableVersionRows(tableId, tableVersion, body) {
|
|
13176
|
+
// verify the required parameter 'tableId' is set
|
|
13177
|
+
if (tableId === undefined || tableId === null) {
|
|
13178
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13179
|
+
}
|
|
13180
|
+
// verify the required parameter 'tableVersion' is set
|
|
13181
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13182
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13183
|
+
}
|
|
13184
|
+
// verify the required parameter 'body' is set
|
|
13185
|
+
if (body === undefined || body === null) {
|
|
13186
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13187
|
+
}
|
|
13188
|
+
|
|
13189
|
+
return this.apiClient.callApi(
|
|
13190
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows',
|
|
13191
|
+
'POST',
|
|
13192
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13193
|
+
{ },
|
|
13194
|
+
{ },
|
|
13195
|
+
{ },
|
|
13196
|
+
body,
|
|
13197
|
+
['PureCloud OAuth'],
|
|
13198
|
+
['application/json'],
|
|
13199
|
+
['application/json']
|
|
13200
|
+
);
|
|
13201
|
+
}
|
|
13202
|
+
|
|
13203
|
+
/**
|
|
13204
|
+
* Search for decision table rows
|
|
13205
|
+
*
|
|
13206
|
+
* @param {String} tableId Table ID
|
|
13207
|
+
* @param {Number} tableVersion Table Version
|
|
13208
|
+
* @param {Object} body Search decision table rows request
|
|
13209
|
+
* @param {Object} opts Optional parameters
|
|
13210
|
+
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
13211
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
13212
|
+
* postBusinessrulesDecisiontableVersionRowsSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13213
|
+
*/
|
|
13214
|
+
postBusinessrulesDecisiontableVersionRowsSearch(tableId, tableVersion, body, opts) {
|
|
13215
|
+
opts = opts || {};
|
|
13216
|
+
|
|
13217
|
+
// verify the required parameter 'tableId' is set
|
|
13218
|
+
if (tableId === undefined || tableId === null) {
|
|
13219
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13220
|
+
}
|
|
13221
|
+
// verify the required parameter 'tableVersion' is set
|
|
13222
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13223
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13224
|
+
}
|
|
13225
|
+
// verify the required parameter 'body' is set
|
|
13226
|
+
if (body === undefined || body === null) {
|
|
13227
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13228
|
+
}
|
|
13229
|
+
|
|
13230
|
+
return this.apiClient.callApi(
|
|
13231
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/search',
|
|
13232
|
+
'POST',
|
|
13233
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13234
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
13235
|
+
{ },
|
|
13236
|
+
{ },
|
|
13237
|
+
body,
|
|
13238
|
+
['PureCloud OAuth'],
|
|
13239
|
+
['application/json'],
|
|
13240
|
+
['application/json']
|
|
13241
|
+
);
|
|
13242
|
+
}
|
|
13243
|
+
|
|
13244
|
+
/**
|
|
13245
|
+
* Update the Business Rules Schema to the latest version for a given decision table version
|
|
13246
|
+
*
|
|
13247
|
+
* @param {String} tableId Table ID
|
|
13248
|
+
* @param {Number} tableVersion Table Version
|
|
13249
|
+
* postBusinessrulesDecisiontableVersionSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13250
|
+
*/
|
|
13251
|
+
postBusinessrulesDecisiontableVersionSync(tableId, tableVersion) {
|
|
13252
|
+
// verify the required parameter 'tableId' is set
|
|
13253
|
+
if (tableId === undefined || tableId === null) {
|
|
13254
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionSync';
|
|
13255
|
+
}
|
|
13256
|
+
// verify the required parameter 'tableVersion' is set
|
|
13257
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13258
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionSync';
|
|
13259
|
+
}
|
|
13260
|
+
|
|
13261
|
+
return this.apiClient.callApi(
|
|
13262
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/sync',
|
|
13263
|
+
'POST',
|
|
13264
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13265
|
+
{ },
|
|
13266
|
+
{ },
|
|
13267
|
+
{ },
|
|
13268
|
+
null,
|
|
13269
|
+
['PureCloud OAuth'],
|
|
13270
|
+
['application/json'],
|
|
13271
|
+
['application/json']
|
|
13272
|
+
);
|
|
13273
|
+
}
|
|
13274
|
+
|
|
13275
|
+
/**
|
|
13276
|
+
* Create a new decision table version
|
|
13277
|
+
*
|
|
13278
|
+
* @param {String} tableId Table ID
|
|
13279
|
+
* postBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13280
|
+
*/
|
|
13281
|
+
postBusinessrulesDecisiontableVersions(tableId) {
|
|
13282
|
+
// verify the required parameter 'tableId' is set
|
|
13283
|
+
if (tableId === undefined || tableId === null) {
|
|
13284
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersions';
|
|
13285
|
+
}
|
|
13286
|
+
|
|
13287
|
+
return this.apiClient.callApi(
|
|
13288
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
13289
|
+
'POST',
|
|
13290
|
+
{ 'tableId': tableId },
|
|
13291
|
+
{ },
|
|
13292
|
+
{ },
|
|
13293
|
+
{ },
|
|
13294
|
+
null,
|
|
13295
|
+
['PureCloud OAuth'],
|
|
13296
|
+
['application/json'],
|
|
13297
|
+
['application/json']
|
|
13298
|
+
);
|
|
13299
|
+
}
|
|
13300
|
+
|
|
13301
|
+
/**
|
|
13302
|
+
* Create a decision table
|
|
13303
|
+
*
|
|
13304
|
+
* @param {Object} body Decision Table
|
|
13305
|
+
* postBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13306
|
+
*/
|
|
13307
|
+
postBusinessrulesDecisiontables(body) {
|
|
13308
|
+
// verify the required parameter 'body' is set
|
|
13309
|
+
if (body === undefined || body === null) {
|
|
13310
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontables';
|
|
13311
|
+
}
|
|
13312
|
+
|
|
13313
|
+
return this.apiClient.callApi(
|
|
13314
|
+
'/api/v2/businessrules/decisiontables',
|
|
13315
|
+
'POST',
|
|
13316
|
+
{ },
|
|
13317
|
+
{ },
|
|
13318
|
+
{ },
|
|
13319
|
+
{ },
|
|
13320
|
+
body,
|
|
13321
|
+
['PureCloud OAuth'],
|
|
13322
|
+
['application/json'],
|
|
13323
|
+
['application/json']
|
|
13324
|
+
);
|
|
13325
|
+
}
|
|
13326
|
+
|
|
13327
|
+
/**
|
|
13328
|
+
* Create a schema
|
|
13329
|
+
*
|
|
13330
|
+
* @param {Object} body Schema
|
|
13331
|
+
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13332
|
+
*/
|
|
13333
|
+
postBusinessrulesSchemas(body) {
|
|
13334
|
+
// verify the required parameter 'body' is set
|
|
13335
|
+
if (body === undefined || body === null) {
|
|
13336
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesSchemas';
|
|
13337
|
+
}
|
|
13338
|
+
|
|
13339
|
+
return this.apiClient.callApi(
|
|
13340
|
+
'/api/v2/businessrules/schemas',
|
|
13341
|
+
'POST',
|
|
13342
|
+
{ },
|
|
13343
|
+
{ },
|
|
13344
|
+
{ },
|
|
13345
|
+
{ },
|
|
13346
|
+
body,
|
|
13347
|
+
['PureCloud OAuth'],
|
|
13348
|
+
['application/json'],
|
|
13349
|
+
['application/json']
|
|
13350
|
+
);
|
|
13351
|
+
}
|
|
13352
|
+
|
|
13353
|
+
/**
|
|
13354
|
+
* Publish a decision table version
|
|
13355
|
+
*
|
|
13356
|
+
* @param {String} tableId Table ID
|
|
13357
|
+
* @param {Number} tableVersion Table Version
|
|
13358
|
+
* putBusinessrulesDecisiontableVersionPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13359
|
+
*/
|
|
13360
|
+
putBusinessrulesDecisiontableVersionPublish(tableId, tableVersion) {
|
|
13361
|
+
// verify the required parameter 'tableId' is set
|
|
13362
|
+
if (tableId === undefined || tableId === null) {
|
|
13363
|
+
throw 'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionPublish';
|
|
13364
|
+
}
|
|
13365
|
+
// verify the required parameter 'tableVersion' is set
|
|
13366
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13367
|
+
throw 'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionPublish';
|
|
13368
|
+
}
|
|
13369
|
+
|
|
13370
|
+
return this.apiClient.callApi(
|
|
13371
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/publish',
|
|
13372
|
+
'PUT',
|
|
13373
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13374
|
+
{ },
|
|
13375
|
+
{ },
|
|
13376
|
+
{ },
|
|
13377
|
+
null,
|
|
13378
|
+
['PureCloud OAuth'],
|
|
13379
|
+
['application/json'],
|
|
13380
|
+
['application/json']
|
|
13381
|
+
);
|
|
13382
|
+
}
|
|
13383
|
+
|
|
13384
|
+
/**
|
|
13385
|
+
* Update a schema
|
|
13386
|
+
*
|
|
13387
|
+
* @param {String} schemaId Schema ID
|
|
13388
|
+
* @param {Object} body Data Schema
|
|
13389
|
+
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13390
|
+
*/
|
|
13391
|
+
putBusinessrulesSchema(schemaId, body) {
|
|
13392
|
+
// verify the required parameter 'schemaId' is set
|
|
13393
|
+
if (schemaId === undefined || schemaId === null) {
|
|
13394
|
+
throw 'Missing the required parameter "schemaId" when calling putBusinessrulesSchema';
|
|
13395
|
+
}
|
|
13396
|
+
// verify the required parameter 'body' is set
|
|
13397
|
+
if (body === undefined || body === null) {
|
|
13398
|
+
throw 'Missing the required parameter "body" when calling putBusinessrulesSchema';
|
|
13399
|
+
}
|
|
13400
|
+
|
|
13401
|
+
return this.apiClient.callApi(
|
|
13402
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
13403
|
+
'PUT',
|
|
13404
|
+
{ 'schemaId': schemaId },
|
|
13405
|
+
{ },
|
|
13406
|
+
{ },
|
|
13407
|
+
{ },
|
|
13408
|
+
body,
|
|
13409
|
+
['PureCloud OAuth'],
|
|
13410
|
+
['application/json'],
|
|
13411
|
+
['application/json']
|
|
13412
|
+
);
|
|
13413
|
+
}
|
|
13414
|
+
|
|
13415
|
+
}
|
|
13416
|
+
|
|
12327
13417
|
class CarrierServicesApi {
|
|
12328
13418
|
/**
|
|
12329
13419
|
* CarrierServices service.
|
|
12330
13420
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12331
|
-
* @version
|
|
13421
|
+
* @version 222.0.0
|
|
12332
13422
|
*/
|
|
12333
13423
|
|
|
12334
13424
|
/**
|
|
@@ -12398,7 +13488,7 @@ class ChatApi {
|
|
|
12398
13488
|
/**
|
|
12399
13489
|
* Chat service.
|
|
12400
13490
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12401
|
-
* @version
|
|
13491
|
+
* @version 222.0.0
|
|
12402
13492
|
*/
|
|
12403
13493
|
|
|
12404
13494
|
/**
|
|
@@ -12708,8 +13798,12 @@ class ChatApi {
|
|
|
12708
13798
|
* Get room participants in a room
|
|
12709
13799
|
*
|
|
12710
13800
|
* @param {String} roomJid roomJid
|
|
13801
|
+
* @param {Object} opts Optional parameters
|
|
13802
|
+
* @param {Boolean} opts.notify Whether to get users to notify
|
|
12711
13803
|
*/
|
|
12712
|
-
getChatsRoomParticipants(roomJid) {
|
|
13804
|
+
getChatsRoomParticipants(roomJid, opts) {
|
|
13805
|
+
opts = opts || {};
|
|
13806
|
+
|
|
12713
13807
|
// verify the required parameter 'roomJid' is set
|
|
12714
13808
|
if (roomJid === undefined || roomJid === null) {
|
|
12715
13809
|
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
@@ -12719,7 +13813,7 @@ class ChatApi {
|
|
|
12719
13813
|
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
12720
13814
|
'GET',
|
|
12721
13815
|
{ 'roomJid': roomJid },
|
|
12722
|
-
{
|
|
13816
|
+
{ 'notify': opts['notify'] },
|
|
12723
13817
|
{ },
|
|
12724
13818
|
{ },
|
|
12725
13819
|
null,
|
|
@@ -13327,7 +14421,7 @@ class CoachingApi {
|
|
|
13327
14421
|
/**
|
|
13328
14422
|
* Coaching service.
|
|
13329
14423
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13330
|
-
* @version
|
|
14424
|
+
* @version 222.0.0
|
|
13331
14425
|
*/
|
|
13332
14426
|
|
|
13333
14427
|
/**
|
|
@@ -13904,7 +14998,7 @@ class ContentManagementApi {
|
|
|
13904
14998
|
/**
|
|
13905
14999
|
* ContentManagement service.
|
|
13906
15000
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13907
|
-
* @version
|
|
15001
|
+
* @version 222.0.0
|
|
13908
15002
|
*/
|
|
13909
15003
|
|
|
13910
15004
|
/**
|
|
@@ -14985,7 +16079,7 @@ class ConversationsApi {
|
|
|
14985
16079
|
/**
|
|
14986
16080
|
* Conversations service.
|
|
14987
16081
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14988
|
-
* @version
|
|
16082
|
+
* @version 222.0.0
|
|
14989
16083
|
*/
|
|
14990
16084
|
|
|
14991
16085
|
/**
|
|
@@ -16915,7 +18009,7 @@ class ConversationsApi {
|
|
|
16915
18009
|
*
|
|
16916
18010
|
* @param {String} messageId messageId
|
|
16917
18011
|
* @param {Object} opts Optional parameters
|
|
16918
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
18012
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
16919
18013
|
*/
|
|
16920
18014
|
getConversationsMessageDetails(messageId, opts) {
|
|
16921
18015
|
opts = opts || {};
|
|
@@ -16945,7 +18039,7 @@ class ConversationsApi {
|
|
|
16945
18039
|
* @param {String} conversationId conversationId
|
|
16946
18040
|
* @param {String} messageId messageId
|
|
16947
18041
|
* @param {Object} opts Optional parameters
|
|
16948
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
18042
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
16949
18043
|
*/
|
|
16950
18044
|
getConversationsMessageMessage(conversationId, messageId, opts) {
|
|
16951
18045
|
opts = opts || {};
|
|
@@ -17187,11 +18281,36 @@ class ConversationsApi {
|
|
|
17187
18281
|
);
|
|
17188
18282
|
}
|
|
17189
18283
|
|
|
18284
|
+
/**
|
|
18285
|
+
* Get Apple messaging integration identity resolution settings
|
|
18286
|
+
*
|
|
18287
|
+
* @param {String} integrationId Integration ID
|
|
18288
|
+
* getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18289
|
+
*/
|
|
18290
|
+
getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) {
|
|
18291
|
+
// verify the required parameter 'integrationId' is set
|
|
18292
|
+
if (integrationId === undefined || integrationId === null) {
|
|
18293
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
18294
|
+
}
|
|
18295
|
+
|
|
18296
|
+
return this.apiClient.callApi(
|
|
18297
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}',
|
|
18298
|
+
'GET',
|
|
18299
|
+
{ 'integrationId': integrationId },
|
|
18300
|
+
{ },
|
|
18301
|
+
{ },
|
|
18302
|
+
{ },
|
|
18303
|
+
null,
|
|
18304
|
+
['PureCloud OAuth'],
|
|
18305
|
+
['application/json'],
|
|
18306
|
+
['application/json']
|
|
18307
|
+
);
|
|
18308
|
+
}
|
|
18309
|
+
|
|
17190
18310
|
/**
|
|
17191
18311
|
* Get Facebook messaging integration identity resolution settings
|
|
17192
18312
|
*
|
|
17193
18313
|
* @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
18314
|
*/
|
|
17196
18315
|
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
17197
18316
|
// verify the required parameter 'integrationId' is set
|
|
@@ -17213,11 +18332,35 @@ class ConversationsApi {
|
|
|
17213
18332
|
);
|
|
17214
18333
|
}
|
|
17215
18334
|
|
|
18335
|
+
/**
|
|
18336
|
+
* Get an Instagram integration identity resolution settings
|
|
18337
|
+
*
|
|
18338
|
+
* @param {String} integrationId Integration ID
|
|
18339
|
+
*/
|
|
18340
|
+
getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId) {
|
|
18341
|
+
// verify the required parameter 'integrationId' is set
|
|
18342
|
+
if (integrationId === undefined || integrationId === null) {
|
|
18343
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
18344
|
+
}
|
|
18345
|
+
|
|
18346
|
+
return this.apiClient.callApi(
|
|
18347
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}',
|
|
18348
|
+
'GET',
|
|
18349
|
+
{ 'integrationId': integrationId },
|
|
18350
|
+
{ },
|
|
18351
|
+
{ },
|
|
18352
|
+
{ },
|
|
18353
|
+
null,
|
|
18354
|
+
['PureCloud OAuth'],
|
|
18355
|
+
['application/json'],
|
|
18356
|
+
['application/json']
|
|
18357
|
+
);
|
|
18358
|
+
}
|
|
18359
|
+
|
|
17216
18360
|
/**
|
|
17217
18361
|
* Get an open messaging integration Identity Resolution settings
|
|
17218
18362
|
*
|
|
17219
18363
|
* @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
18364
|
*/
|
|
17222
18365
|
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
17223
18366
|
// verify the required parameter 'integrationId' is set
|
|
@@ -17243,7 +18386,6 @@ class ConversationsApi {
|
|
|
17243
18386
|
* Get a whatsApp integration Identity Resolution settings
|
|
17244
18387
|
*
|
|
17245
18388
|
* @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
18389
|
*/
|
|
17248
18390
|
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
17249
18391
|
// verify the required parameter 'integrationId' is set
|
|
@@ -18073,6 +19215,40 @@ class ConversationsApi {
|
|
|
18073
19215
|
);
|
|
18074
19216
|
}
|
|
18075
19217
|
|
|
19218
|
+
/**
|
|
19219
|
+
* Update agent's engagement for the summary.
|
|
19220
|
+
*
|
|
19221
|
+
* @param {String} conversationId Conversation ID
|
|
19222
|
+
* @param {String} summaryId Summary ID
|
|
19223
|
+
* @param {Object} opts Optional parameters
|
|
19224
|
+
* @param {Object} opts.body
|
|
19225
|
+
*/
|
|
19226
|
+
patchConversationSummaryEngagements(conversationId, summaryId, opts) {
|
|
19227
|
+
opts = opts || {};
|
|
19228
|
+
|
|
19229
|
+
// verify the required parameter 'conversationId' is set
|
|
19230
|
+
if (conversationId === undefined || conversationId === null) {
|
|
19231
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryEngagements';
|
|
19232
|
+
}
|
|
19233
|
+
// verify the required parameter 'summaryId' is set
|
|
19234
|
+
if (summaryId === undefined || summaryId === null) {
|
|
19235
|
+
throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryEngagements';
|
|
19236
|
+
}
|
|
19237
|
+
|
|
19238
|
+
return this.apiClient.callApi(
|
|
19239
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/engagements',
|
|
19240
|
+
'PATCH',
|
|
19241
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
19242
|
+
{ },
|
|
19243
|
+
{ },
|
|
19244
|
+
{ },
|
|
19245
|
+
opts['body'],
|
|
19246
|
+
['PureCloud OAuth'],
|
|
19247
|
+
['application/json'],
|
|
19248
|
+
['application/json']
|
|
19249
|
+
);
|
|
19250
|
+
}
|
|
19251
|
+
|
|
18076
19252
|
/**
|
|
18077
19253
|
* Update the feedback for the summary.
|
|
18078
19254
|
*
|
|
@@ -18080,7 +19256,6 @@ class ConversationsApi {
|
|
|
18080
19256
|
* @param {String} summaryId Summary ID
|
|
18081
19257
|
* @param {Object} opts Optional parameters
|
|
18082
19258
|
* @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
19259
|
*/
|
|
18085
19260
|
patchConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
18086
19261
|
opts = opts || {};
|
|
@@ -19270,7 +20445,7 @@ class ConversationsApi {
|
|
|
19270
20445
|
|
|
19271
20446
|
/**
|
|
19272
20447
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
19273
|
-
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the
|
|
20448
|
+
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the GET call on the integration with a createStatus of Completed. You can then run a GET on the integration to check if its status has been updated to Active.
|
|
19274
20449
|
* @param {String} integrationId Integration ID
|
|
19275
20450
|
* @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
|
|
19276
20451
|
*/
|
|
@@ -21119,12 +22294,12 @@ class ConversationsApi {
|
|
|
21119
22294
|
|
|
21120
22295
|
/**
|
|
21121
22296
|
* Send message
|
|
21122
|
-
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId,
|
|
22297
|
+
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
|
|
21123
22298
|
* @param {String} conversationId conversationId
|
|
21124
22299
|
* @param {String} communicationId communicationId
|
|
21125
22300
|
* @param {Object} body Message
|
|
21126
22301
|
* @param {Object} opts Optional parameters
|
|
21127
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
22302
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
21128
22303
|
*/
|
|
21129
22304
|
postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) {
|
|
21130
22305
|
opts = opts || {};
|
|
@@ -21356,7 +22531,7 @@ class ConversationsApi {
|
|
|
21356
22531
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
21357
22532
|
* @param {String} conversationId
|
|
21358
22533
|
* @param {Object} opts Optional parameters
|
|
21359
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
22534
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
21360
22535
|
* @param {Array.<String>} opts.body messageIds
|
|
21361
22536
|
*/
|
|
21362
22537
|
postConversationsMessageMessagesBulk(conversationId, opts) {
|
|
@@ -22338,12 +23513,42 @@ class ConversationsApi {
|
|
|
22338
23513
|
);
|
|
22339
23514
|
}
|
|
22340
23515
|
|
|
23516
|
+
/**
|
|
23517
|
+
* Create an identity resolution settings for a Apple messaging integration
|
|
23518
|
+
*
|
|
23519
|
+
* @param {String} integrationId Integration ID
|
|
23520
|
+
* @param {Object} body IdentityResolutionConfig
|
|
23521
|
+
* putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23522
|
+
*/
|
|
23523
|
+
putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) {
|
|
23524
|
+
// verify the required parameter 'integrationId' is set
|
|
23525
|
+
if (integrationId === undefined || integrationId === null) {
|
|
23526
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
23527
|
+
}
|
|
23528
|
+
// verify the required parameter 'body' is set
|
|
23529
|
+
if (body === undefined || body === null) {
|
|
23530
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
23531
|
+
}
|
|
23532
|
+
|
|
23533
|
+
return this.apiClient.callApi(
|
|
23534
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}',
|
|
23535
|
+
'PUT',
|
|
23536
|
+
{ 'integrationId': integrationId },
|
|
23537
|
+
{ },
|
|
23538
|
+
{ },
|
|
23539
|
+
{ },
|
|
23540
|
+
body,
|
|
23541
|
+
['PureCloud OAuth'],
|
|
23542
|
+
['application/json'],
|
|
23543
|
+
['application/json']
|
|
23544
|
+
);
|
|
23545
|
+
}
|
|
23546
|
+
|
|
22341
23547
|
/**
|
|
22342
23548
|
* Create an identity resolution settings for a Facebook messaging integration
|
|
22343
23549
|
*
|
|
22344
23550
|
* @param {String} integrationId Integration ID
|
|
22345
23551
|
* @param {Object} body IdentityResolutionConfig
|
|
22346
|
-
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22347
23552
|
*/
|
|
22348
23553
|
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
22349
23554
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22369,12 +23574,41 @@ class ConversationsApi {
|
|
|
22369
23574
|
);
|
|
22370
23575
|
}
|
|
22371
23576
|
|
|
23577
|
+
/**
|
|
23578
|
+
* Create identity resolution settings for an Instagram messaging integration
|
|
23579
|
+
*
|
|
23580
|
+
* @param {String} integrationId Integration ID
|
|
23581
|
+
* @param {Object} body IdentityResolutionConfig
|
|
23582
|
+
*/
|
|
23583
|
+
putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId, body) {
|
|
23584
|
+
// verify the required parameter 'integrationId' is set
|
|
23585
|
+
if (integrationId === undefined || integrationId === null) {
|
|
23586
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
23587
|
+
}
|
|
23588
|
+
// verify the required parameter 'body' is set
|
|
23589
|
+
if (body === undefined || body === null) {
|
|
23590
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
23591
|
+
}
|
|
23592
|
+
|
|
23593
|
+
return this.apiClient.callApi(
|
|
23594
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}',
|
|
23595
|
+
'PUT',
|
|
23596
|
+
{ 'integrationId': integrationId },
|
|
23597
|
+
{ },
|
|
23598
|
+
{ },
|
|
23599
|
+
{ },
|
|
23600
|
+
body,
|
|
23601
|
+
['PureCloud OAuth'],
|
|
23602
|
+
['application/json'],
|
|
23603
|
+
['application/json']
|
|
23604
|
+
);
|
|
23605
|
+
}
|
|
23606
|
+
|
|
22372
23607
|
/**
|
|
22373
23608
|
* Update an open messaging integration Identity Resolution settings
|
|
22374
23609
|
*
|
|
22375
23610
|
* @param {String} integrationId Integration ID
|
|
22376
23611
|
* @param {Object} body
|
|
22377
|
-
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22378
23612
|
*/
|
|
22379
23613
|
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
22380
23614
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22405,7 +23639,6 @@ class ConversationsApi {
|
|
|
22405
23639
|
*
|
|
22406
23640
|
* @param {String} integrationId Integration ID
|
|
22407
23641
|
* @param {Object} body
|
|
22408
|
-
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22409
23642
|
*/
|
|
22410
23643
|
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
22411
23644
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22603,7 +23836,7 @@ class DataExtensionsApi {
|
|
|
22603
23836
|
/**
|
|
22604
23837
|
* DataExtensions service.
|
|
22605
23838
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22606
|
-
* @version
|
|
23839
|
+
* @version 222.0.0
|
|
22607
23840
|
*/
|
|
22608
23841
|
|
|
22609
23842
|
/**
|
|
@@ -22689,7 +23922,7 @@ class DataPrivacyApi {
|
|
|
22689
23922
|
/**
|
|
22690
23923
|
* DataPrivacy service.
|
|
22691
23924
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22692
|
-
* @version
|
|
23925
|
+
* @version 222.0.0
|
|
22693
23926
|
*/
|
|
22694
23927
|
|
|
22695
23928
|
/**
|
|
@@ -22859,7 +24092,7 @@ class DownloadsApi {
|
|
|
22859
24092
|
/**
|
|
22860
24093
|
* Downloads service.
|
|
22861
24094
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22862
|
-
* @version
|
|
24095
|
+
* @version 222.0.0
|
|
22863
24096
|
*/
|
|
22864
24097
|
|
|
22865
24098
|
/**
|
|
@@ -22911,7 +24144,7 @@ class EmailsApi {
|
|
|
22911
24144
|
/**
|
|
22912
24145
|
* Emails service.
|
|
22913
24146
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22914
|
-
* @version
|
|
24147
|
+
* @version 222.0.0
|
|
22915
24148
|
*/
|
|
22916
24149
|
|
|
22917
24150
|
/**
|
|
@@ -23040,7 +24273,7 @@ class EmployeeEngagementApi {
|
|
|
23040
24273
|
/**
|
|
23041
24274
|
* EmployeeEngagement service.
|
|
23042
24275
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
23043
|
-
* @version
|
|
24276
|
+
* @version 222.0.0
|
|
23044
24277
|
*/
|
|
23045
24278
|
|
|
23046
24279
|
/**
|
|
@@ -23191,7 +24424,7 @@ class EventsApi {
|
|
|
23191
24424
|
/**
|
|
23192
24425
|
* Events service.
|
|
23193
24426
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23194
|
-
* @version
|
|
24427
|
+
* @version 222.0.0
|
|
23195
24428
|
*/
|
|
23196
24429
|
|
|
23197
24430
|
/**
|
|
@@ -23287,7 +24520,7 @@ class ExternalContactsApi {
|
|
|
23287
24520
|
/**
|
|
23288
24521
|
* ExternalContacts service.
|
|
23289
24522
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23290
|
-
* @version
|
|
24523
|
+
* @version 222.0.0
|
|
23291
24524
|
*/
|
|
23292
24525
|
|
|
23293
24526
|
/**
|
|
@@ -23923,7 +25156,7 @@ class ExternalContactsApi {
|
|
|
23923
25156
|
}
|
|
23924
25157
|
|
|
23925
25158
|
/**
|
|
23926
|
-
* Get
|
|
25159
|
+
* Get a specific named core type.
|
|
23927
25160
|
*
|
|
23928
25161
|
* @param {String} coreTypeName Name of the core type
|
|
23929
25162
|
*/
|
|
@@ -24316,7 +25549,6 @@ class ExternalContactsApi {
|
|
|
24316
25549
|
* List the identifiers for an external organization
|
|
24317
25550
|
*
|
|
24318
25551
|
* @param {String} externalOrganizationId External Organization ID
|
|
24319
|
-
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24320
25552
|
*/
|
|
24321
25553
|
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
24322
25554
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -24568,7 +25800,7 @@ class ExternalContactsApi {
|
|
|
24568
25800
|
}
|
|
24569
25801
|
|
|
24570
25802
|
/**
|
|
24571
|
-
* Get
|
|
25803
|
+
* Get a specific named core type.
|
|
24572
25804
|
*
|
|
24573
25805
|
* @param {String} coreTypeName Name of the core type
|
|
24574
25806
|
*/
|
|
@@ -24723,7 +25955,6 @@ class ExternalContactsApi {
|
|
|
24723
25955
|
* @param {Object} opts Optional parameters
|
|
24724
25956
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24725
25957
|
* @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
|
|
24726
|
-
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24727
25958
|
*/
|
|
24728
25959
|
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
24729
25960
|
opts = opts || {};
|
|
@@ -24775,7 +26006,6 @@ class ExternalContactsApi {
|
|
|
24775
26006
|
* @param {Object} opts Optional parameters
|
|
24776
26007
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24777
26008
|
* @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
|
|
24778
|
-
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24779
26009
|
*/
|
|
24780
26010
|
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
24781
26011
|
opts = opts || {};
|
|
@@ -24827,7 +26057,6 @@ class ExternalContactsApi {
|
|
|
24827
26057
|
* @param {Object} opts Optional parameters
|
|
24828
26058
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24829
26059
|
* @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
|
|
24830
|
-
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24831
26060
|
*/
|
|
24832
26061
|
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
24833
26062
|
opts = opts || {};
|
|
@@ -24879,7 +26108,6 @@ class ExternalContactsApi {
|
|
|
24879
26108
|
* @param {Object} opts Optional parameters
|
|
24880
26109
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24881
26110
|
* @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
|
|
24882
|
-
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24883
26111
|
*/
|
|
24884
26112
|
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
24885
26113
|
opts = opts || {};
|
|
@@ -24934,7 +26162,6 @@ class ExternalContactsApi {
|
|
|
24934
26162
|
*
|
|
24935
26163
|
* @param {String} externalOrganizationId External Organization ID
|
|
24936
26164
|
* @param {Object} body ClaimRequest
|
|
24937
|
-
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24938
26165
|
*/
|
|
24939
26166
|
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
24940
26167
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -25014,7 +26241,6 @@ class ExternalContactsApi {
|
|
|
25014
26241
|
* Bulk fetch contacts across divisions
|
|
25015
26242
|
*
|
|
25016
26243
|
* @param {Object} body Contact ids
|
|
25017
|
-
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25018
26244
|
*/
|
|
25019
26245
|
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
25020
26246
|
// verify the required parameter 'body' is set
|
|
@@ -25042,7 +26268,6 @@ class ExternalContactsApi {
|
|
|
25042
26268
|
* @param {Object} body Contact Enrich Requests
|
|
25043
26269
|
* @param {Object} opts Optional parameters
|
|
25044
26270
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25045
|
-
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25046
26271
|
*/
|
|
25047
26272
|
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
25048
26273
|
opts = opts || {};
|
|
@@ -25295,7 +26520,6 @@ class ExternalContactsApi {
|
|
|
25295
26520
|
* Bulk fetch organizations across divisions
|
|
25296
26521
|
*
|
|
25297
26522
|
* @param {Object} body Organizations ids
|
|
25298
|
-
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25299
26523
|
*/
|
|
25300
26524
|
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
25301
26525
|
// verify the required parameter 'body' is set
|
|
@@ -25323,7 +26547,6 @@ class ExternalContactsApi {
|
|
|
25323
26547
|
* @param {Object} body External Organization Enrich Requests
|
|
25324
26548
|
* @param {Object} opts Optional parameters
|
|
25325
26549
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25326
|
-
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25327
26550
|
*/
|
|
25328
26551
|
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
25329
26552
|
opts = opts || {};
|
|
@@ -25583,7 +26806,6 @@ class ExternalContactsApi {
|
|
|
25583
26806
|
* @param {Object} body ContactEnrichRequest
|
|
25584
26807
|
* @param {Object} opts Optional parameters
|
|
25585
26808
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25586
|
-
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25587
26809
|
*/
|
|
25588
26810
|
postExternalcontactsContactsEnrich(body, opts) {
|
|
25589
26811
|
opts = opts || {};
|
|
@@ -25636,7 +26858,6 @@ class ExternalContactsApi {
|
|
|
25636
26858
|
* Merge up to 25 contacts into a new contact record
|
|
25637
26859
|
* 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.
|
|
25638
26860
|
* @param {Object} body MergeRequest
|
|
25639
|
-
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25640
26861
|
*/
|
|
25641
26862
|
postExternalcontactsContactsMerge(body) {
|
|
25642
26863
|
// verify the required parameter 'body' is set
|
|
@@ -25744,7 +26965,6 @@ class ExternalContactsApi {
|
|
|
25744
26965
|
* @param {Object} identifier
|
|
25745
26966
|
* @param {Object} opts Optional parameters
|
|
25746
26967
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25747
|
-
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25748
26968
|
*/
|
|
25749
26969
|
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
25750
26970
|
opts = opts || {};
|
|
@@ -25774,7 +26994,6 @@ class ExternalContactsApi {
|
|
|
25774
26994
|
* @param {Object} identifier
|
|
25775
26995
|
* @param {Object} opts Optional parameters
|
|
25776
26996
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25777
|
-
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25778
26997
|
*/
|
|
25779
26998
|
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
25780
26999
|
opts = opts || {};
|
|
@@ -26010,7 +27229,6 @@ class ExternalContactsApi {
|
|
|
26010
27229
|
* @param {Object} body ExternalOrgEnrichRequest
|
|
26011
27230
|
* @param {Object} opts Optional parameters
|
|
26012
27231
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
26013
|
-
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26014
27232
|
*/
|
|
26015
27233
|
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
26016
27234
|
opts = opts || {};
|
|
@@ -26490,7 +27708,7 @@ class FaxApi {
|
|
|
26490
27708
|
/**
|
|
26491
27709
|
* Fax service.
|
|
26492
27710
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
26493
|
-
* @version
|
|
27711
|
+
* @version 222.0.0
|
|
26494
27712
|
*/
|
|
26495
27713
|
|
|
26496
27714
|
/**
|
|
@@ -26705,7 +27923,7 @@ class FlowsApi {
|
|
|
26705
27923
|
/**
|
|
26706
27924
|
* Flows service.
|
|
26707
27925
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
26708
|
-
* @version
|
|
27926
|
+
* @version 222.0.0
|
|
26709
27927
|
*/
|
|
26710
27928
|
|
|
26711
27929
|
/**
|
|
@@ -26888,7 +28106,7 @@ class GamificationApi {
|
|
|
26888
28106
|
/**
|
|
26889
28107
|
* Gamification service.
|
|
26890
28108
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
26891
|
-
* @version
|
|
28109
|
+
* @version 222.0.0
|
|
26892
28110
|
*/
|
|
26893
28111
|
|
|
26894
28112
|
/**
|
|
@@ -29395,7 +30613,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
29395
30613
|
/**
|
|
29396
30614
|
* GeneralDataProtectionRegulation service.
|
|
29397
30615
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
29398
|
-
* @version
|
|
30616
|
+
* @version 222.0.0
|
|
29399
30617
|
*/
|
|
29400
30618
|
|
|
29401
30619
|
/**
|
|
@@ -29525,7 +30743,7 @@ class GeolocationApi {
|
|
|
29525
30743
|
/**
|
|
29526
30744
|
* Geolocation service.
|
|
29527
30745
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
29528
|
-
* @version
|
|
30746
|
+
* @version 222.0.0
|
|
29529
30747
|
*/
|
|
29530
30748
|
|
|
29531
30749
|
/**
|
|
@@ -29656,7 +30874,7 @@ class GreetingsApi {
|
|
|
29656
30874
|
/**
|
|
29657
30875
|
* Greetings service.
|
|
29658
30876
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
29659
|
-
* @version
|
|
30877
|
+
* @version 222.0.0
|
|
29660
30878
|
*/
|
|
29661
30879
|
|
|
29662
30880
|
/**
|
|
@@ -30111,7 +31329,7 @@ class GroupsApi {
|
|
|
30111
31329
|
/**
|
|
30112
31330
|
* Groups service.
|
|
30113
31331
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
30114
|
-
* @version
|
|
31332
|
+
* @version 222.0.0
|
|
30115
31333
|
*/
|
|
30116
31334
|
|
|
30117
31335
|
/**
|
|
@@ -30630,7 +31848,7 @@ class IdentityProviderApi {
|
|
|
30630
31848
|
/**
|
|
30631
31849
|
* IdentityProvider service.
|
|
30632
31850
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
30633
|
-
* @version
|
|
31851
|
+
* @version 222.0.0
|
|
30634
31852
|
*/
|
|
30635
31853
|
|
|
30636
31854
|
/**
|
|
@@ -31491,7 +32709,7 @@ class InfrastructureAsCodeApi {
|
|
|
31491
32709
|
/**
|
|
31492
32710
|
* InfrastructureAsCode service.
|
|
31493
32711
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
31494
|
-
* @version
|
|
32712
|
+
* @version 222.0.0
|
|
31495
32713
|
*/
|
|
31496
32714
|
|
|
31497
32715
|
/**
|
|
@@ -31658,7 +32876,7 @@ class IntegrationsApi {
|
|
|
31658
32876
|
/**
|
|
31659
32877
|
* Integrations service.
|
|
31660
32878
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
31661
|
-
* @version
|
|
32879
|
+
* @version 222.0.0
|
|
31662
32880
|
*/
|
|
31663
32881
|
|
|
31664
32882
|
/**
|
|
@@ -34127,7 +35345,7 @@ class JourneyApi {
|
|
|
34127
35345
|
/**
|
|
34128
35346
|
* Journey service.
|
|
34129
35347
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
34130
|
-
* @version
|
|
35348
|
+
* @version 222.0.0
|
|
34131
35349
|
*/
|
|
34132
35350
|
|
|
34133
35351
|
/**
|
|
@@ -36112,7 +37330,7 @@ class KnowledgeApi {
|
|
|
36112
37330
|
/**
|
|
36113
37331
|
* Knowledge service.
|
|
36114
37332
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
36115
|
-
* @version
|
|
37333
|
+
* @version 222.0.0
|
|
36116
37334
|
*/
|
|
36117
37335
|
|
|
36118
37336
|
/**
|
|
@@ -39985,7 +41203,7 @@ class LanguageUnderstandingApi {
|
|
|
39985
41203
|
/**
|
|
39986
41204
|
* LanguageUnderstanding service.
|
|
39987
41205
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
39988
|
-
* @version
|
|
41206
|
+
* @version 222.0.0
|
|
39989
41207
|
*/
|
|
39990
41208
|
|
|
39991
41209
|
/**
|
|
@@ -41018,7 +42236,7 @@ class LanguagesApi {
|
|
|
41018
42236
|
/**
|
|
41019
42237
|
* Languages service.
|
|
41020
42238
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
41021
|
-
* @version
|
|
42239
|
+
* @version 222.0.0
|
|
41022
42240
|
*/
|
|
41023
42241
|
|
|
41024
42242
|
/**
|
|
@@ -41240,7 +42458,7 @@ class LearningApi {
|
|
|
41240
42458
|
/**
|
|
41241
42459
|
* Learning service.
|
|
41242
42460
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
41243
|
-
* @version
|
|
42461
|
+
* @version 222.0.0
|
|
41244
42462
|
*/
|
|
41245
42463
|
|
|
41246
42464
|
/**
|
|
@@ -42269,7 +43487,7 @@ class LicenseApi {
|
|
|
42269
43487
|
/**
|
|
42270
43488
|
* License service.
|
|
42271
43489
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
42272
|
-
* @version
|
|
43490
|
+
* @version 222.0.0
|
|
42273
43491
|
*/
|
|
42274
43492
|
|
|
42275
43493
|
/**
|
|
@@ -42507,7 +43725,7 @@ class LocationsApi {
|
|
|
42507
43725
|
/**
|
|
42508
43726
|
* Locations service.
|
|
42509
43727
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
42510
|
-
* @version
|
|
43728
|
+
* @version 222.0.0
|
|
42511
43729
|
*/
|
|
42512
43730
|
|
|
42513
43731
|
/**
|
|
@@ -42743,7 +43961,7 @@ class LogCaptureApi {
|
|
|
42743
43961
|
/**
|
|
42744
43962
|
* LogCapture service.
|
|
42745
43963
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
42746
|
-
* @version
|
|
43964
|
+
* @version 222.0.0
|
|
42747
43965
|
*/
|
|
42748
43966
|
|
|
42749
43967
|
/**
|
|
@@ -42943,7 +44161,7 @@ class MessagingApi {
|
|
|
42943
44161
|
/**
|
|
42944
44162
|
* Messaging service.
|
|
42945
44163
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
42946
|
-
* @version
|
|
44164
|
+
* @version 222.0.0
|
|
42947
44165
|
*/
|
|
42948
44166
|
|
|
42949
44167
|
/**
|
|
@@ -43302,7 +44520,7 @@ class MobileDevicesApi {
|
|
|
43302
44520
|
/**
|
|
43303
44521
|
* MobileDevices service.
|
|
43304
44522
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
43305
|
-
* @version
|
|
44523
|
+
* @version 222.0.0
|
|
43306
44524
|
*/
|
|
43307
44525
|
|
|
43308
44526
|
/**
|
|
@@ -43453,7 +44671,7 @@ class NotificationsApi {
|
|
|
43453
44671
|
/**
|
|
43454
44672
|
* Notifications service.
|
|
43455
44673
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
43456
|
-
* @version
|
|
44674
|
+
* @version 222.0.0
|
|
43457
44675
|
*/
|
|
43458
44676
|
|
|
43459
44677
|
/**
|
|
@@ -43686,7 +44904,7 @@ class OAuthApi {
|
|
|
43686
44904
|
/**
|
|
43687
44905
|
* OAuth service.
|
|
43688
44906
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
43689
|
-
* @version
|
|
44907
|
+
* @version 222.0.0
|
|
43690
44908
|
*/
|
|
43691
44909
|
|
|
43692
44910
|
/**
|
|
@@ -44052,7 +45270,7 @@ class ObjectsApi {
|
|
|
44052
45270
|
/**
|
|
44053
45271
|
* Objects service.
|
|
44054
45272
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
44055
|
-
* @version
|
|
45273
|
+
* @version 222.0.0
|
|
44056
45274
|
*/
|
|
44057
45275
|
|
|
44058
45276
|
/**
|
|
@@ -44376,7 +45594,7 @@ class OperationalEventsApi {
|
|
|
44376
45594
|
/**
|
|
44377
45595
|
* OperationalEvents service.
|
|
44378
45596
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
44379
|
-
* @version
|
|
45597
|
+
* @version 222.0.0
|
|
44380
45598
|
*/
|
|
44381
45599
|
|
|
44382
45600
|
/**
|
|
@@ -44493,7 +45711,7 @@ class OrganizationApi {
|
|
|
44493
45711
|
/**
|
|
44494
45712
|
* Organization service.
|
|
44495
45713
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
44496
|
-
* @version
|
|
45714
|
+
* @version 222.0.0
|
|
44497
45715
|
*/
|
|
44498
45716
|
|
|
44499
45717
|
/**
|
|
@@ -44968,7 +46186,7 @@ class OrganizationAuthorizationApi {
|
|
|
44968
46186
|
/**
|
|
44969
46187
|
* OrganizationAuthorization service.
|
|
44970
46188
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
44971
|
-
* @version
|
|
46189
|
+
* @version 222.0.0
|
|
44972
46190
|
*/
|
|
44973
46191
|
|
|
44974
46192
|
/**
|
|
@@ -46362,7 +47580,7 @@ class OutboundApi {
|
|
|
46362
47580
|
/**
|
|
46363
47581
|
* Outbound service.
|
|
46364
47582
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
46365
|
-
* @version
|
|
47583
|
+
* @version 222.0.0
|
|
46366
47584
|
*/
|
|
46367
47585
|
|
|
46368
47586
|
/**
|
|
@@ -50984,7 +52202,7 @@ class PresenceApi {
|
|
|
50984
52202
|
/**
|
|
50985
52203
|
* Presence service.
|
|
50986
52204
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
50987
|
-
* @version
|
|
52205
|
+
* @version 222.0.0
|
|
50988
52206
|
*/
|
|
50989
52207
|
|
|
50990
52208
|
/**
|
|
@@ -51728,7 +52946,7 @@ class ProcessAutomationApi {
|
|
|
51728
52946
|
/**
|
|
51729
52947
|
* ProcessAutomation service.
|
|
51730
52948
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
51731
|
-
* @version
|
|
52949
|
+
* @version 222.0.0
|
|
51732
52950
|
*/
|
|
51733
52951
|
|
|
51734
52952
|
/**
|
|
@@ -51967,7 +53185,7 @@ class QualityApi {
|
|
|
51967
53185
|
/**
|
|
51968
53186
|
* Quality service.
|
|
51969
53187
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
51970
|
-
* @version
|
|
53188
|
+
* @version 222.0.0
|
|
51971
53189
|
*/
|
|
51972
53190
|
|
|
51973
53191
|
/**
|
|
@@ -53754,7 +54972,7 @@ class RecordingApi {
|
|
|
53754
54972
|
/**
|
|
53755
54973
|
* Recording service.
|
|
53756
54974
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
53757
|
-
* @version
|
|
54975
|
+
* @version 222.0.0
|
|
53758
54976
|
*/
|
|
53759
54977
|
|
|
53760
54978
|
/**
|
|
@@ -55359,7 +56577,7 @@ class ResponseManagementApi {
|
|
|
55359
56577
|
/**
|
|
55360
56578
|
* ResponseManagement service.
|
|
55361
56579
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
55362
|
-
* @version
|
|
56580
|
+
* @version 222.0.0
|
|
55363
56581
|
*/
|
|
55364
56582
|
|
|
55365
56583
|
/**
|
|
@@ -55869,7 +57087,7 @@ class RoutingApi {
|
|
|
55869
57087
|
/**
|
|
55870
57088
|
* Routing service.
|
|
55871
57089
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
55872
|
-
* @version
|
|
57090
|
+
* @version 222.0.0
|
|
55873
57091
|
*/
|
|
55874
57092
|
|
|
55875
57093
|
/**
|
|
@@ -56685,8 +57903,12 @@ class RoutingApi {
|
|
|
56685
57903
|
*
|
|
56686
57904
|
* @param {String} domainName email domain
|
|
56687
57905
|
* @param {String} routeId route ID
|
|
57906
|
+
* @param {Object} opts Optional parameters
|
|
57907
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
56688
57908
|
*/
|
|
56689
|
-
getRoutingEmailDomainRoute(domainName, routeId) {
|
|
57909
|
+
getRoutingEmailDomainRoute(domainName, routeId, opts) {
|
|
57910
|
+
opts = opts || {};
|
|
57911
|
+
|
|
56690
57912
|
// verify the required parameter 'domainName' is set
|
|
56691
57913
|
if (domainName === undefined || domainName === null) {
|
|
56692
57914
|
throw 'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoute';
|
|
@@ -56700,7 +57922,7 @@ class RoutingApi {
|
|
|
56700
57922
|
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}',
|
|
56701
57923
|
'GET',
|
|
56702
57924
|
{ 'domainName': domainName,'routeId': routeId },
|
|
56703
|
-
{
|
|
57925
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
56704
57926
|
{ },
|
|
56705
57927
|
{ },
|
|
56706
57928
|
null,
|
|
@@ -56715,7 +57937,6 @@ class RoutingApi {
|
|
|
56715
57937
|
*
|
|
56716
57938
|
* @param {String} domainName email domain
|
|
56717
57939
|
* @param {String} routeId route ID
|
|
56718
|
-
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56719
57940
|
*/
|
|
56720
57941
|
getRoutingEmailDomainRouteIdentityresolution(domainName, routeId) {
|
|
56721
57942
|
// verify the required parameter 'domainName' is set
|
|
@@ -56749,6 +57970,7 @@ class RoutingApi {
|
|
|
56749
57970
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56750
57971
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56751
57972
|
* @param {String} opts.pattern Filter routes by the route's pattern property
|
|
57973
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
56752
57974
|
*/
|
|
56753
57975
|
getRoutingEmailDomainRoutes(domainName, opts) {
|
|
56754
57976
|
opts = opts || {};
|
|
@@ -56762,7 +57984,7 @@ class RoutingApi {
|
|
|
56762
57984
|
'/api/v2/routing/email/domains/{domainName}/routes',
|
|
56763
57985
|
'GET',
|
|
56764
57986
|
{ 'domainName': domainName },
|
|
56765
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'pattern': opts['pattern'] },
|
|
57987
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'pattern': opts['pattern'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
56766
57988
|
{ },
|
|
56767
57989
|
{ },
|
|
56768
57990
|
null,
|
|
@@ -57162,8 +58384,12 @@ class RoutingApi {
|
|
|
57162
58384
|
* Get details about this queue.
|
|
57163
58385
|
*
|
|
57164
58386
|
* @param {String} queueId Queue ID
|
|
58387
|
+
* @param {Object} opts Optional parameters
|
|
58388
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57165
58389
|
*/
|
|
57166
|
-
getRoutingQueue(queueId) {
|
|
58390
|
+
getRoutingQueue(queueId, opts) {
|
|
58391
|
+
opts = opts || {};
|
|
58392
|
+
|
|
57167
58393
|
// verify the required parameter 'queueId' is set
|
|
57168
58394
|
if (queueId === undefined || queueId === null) {
|
|
57169
58395
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueue';
|
|
@@ -57173,7 +58399,7 @@ class RoutingApi {
|
|
|
57173
58399
|
'/api/v2/routing/queues/{queueId}',
|
|
57174
58400
|
'GET',
|
|
57175
58401
|
{ 'queueId': queueId },
|
|
57176
|
-
{
|
|
58402
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
57177
58403
|
{ },
|
|
57178
58404
|
{ },
|
|
57179
58405
|
null,
|
|
@@ -57300,7 +58526,6 @@ class RoutingApi {
|
|
|
57300
58526
|
* Get Queue IdentityResolution Settings.
|
|
57301
58527
|
*
|
|
57302
58528
|
* @param {String} queueId Queue ID
|
|
57303
|
-
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57304
58529
|
*/
|
|
57305
58530
|
getRoutingQueueIdentityresolution(queueId) {
|
|
57306
58531
|
// verify the required parameter 'queueId' is set
|
|
@@ -57479,6 +58704,7 @@ class RoutingApi {
|
|
|
57479
58704
|
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
57480
58705
|
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
57481
58706
|
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
58707
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57482
58708
|
*/
|
|
57483
58709
|
getRoutingQueues(opts) {
|
|
57484
58710
|
opts = opts || {};
|
|
@@ -57488,7 +58714,7 @@ class RoutingApi {
|
|
|
57488
58714
|
'/api/v2/routing/queues',
|
|
57489
58715
|
'GET',
|
|
57490
58716
|
{ },
|
|
57491
|
-
{ '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'] },
|
|
58717
|
+
{ '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') },
|
|
57492
58718
|
{ },
|
|
57493
58719
|
{ },
|
|
57494
58720
|
null,
|
|
@@ -57898,7 +59124,6 @@ class RoutingApi {
|
|
|
57898
59124
|
* Get a SMS identity resolution settings.
|
|
57899
59125
|
*
|
|
57900
59126
|
* @param {String} addressId Address ID
|
|
57901
|
-
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57902
59127
|
*/
|
|
57903
59128
|
getRoutingSmsIdentityresolutionPhonenumber(addressId) {
|
|
57904
59129
|
// verify the required parameter 'addressId' is set
|
|
@@ -57964,6 +59189,7 @@ class RoutingApi {
|
|
|
57964
59189
|
* @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)
|
|
57965
59190
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
57966
59191
|
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
59192
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57967
59193
|
*/
|
|
57968
59194
|
getRoutingSmsPhonenumbers(opts) {
|
|
57969
59195
|
opts = opts || {};
|
|
@@ -57973,7 +59199,7 @@ class RoutingApi {
|
|
|
57973
59199
|
'/api/v2/routing/sms/phonenumbers',
|
|
57974
59200
|
'GET',
|
|
57975
59201
|
{ },
|
|
57976
|
-
{ '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'] },
|
|
59202
|
+
{ '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') },
|
|
57977
59203
|
{ },
|
|
57978
59204
|
{ },
|
|
57979
59205
|
null,
|
|
@@ -59731,7 +60957,6 @@ class RoutingApi {
|
|
|
59731
60957
|
* @param {String} domainName email domain
|
|
59732
60958
|
* @param {String} routeId route ID
|
|
59733
60959
|
* @param {Object} body
|
|
59734
|
-
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59735
60960
|
*/
|
|
59736
60961
|
putRoutingEmailDomainRouteIdentityresolution(domainName, routeId, body) {
|
|
59737
60962
|
// verify the required parameter 'domainName' is set
|
|
@@ -59851,7 +61076,6 @@ class RoutingApi {
|
|
|
59851
61076
|
*
|
|
59852
61077
|
* @param {String} queueId Queue ID
|
|
59853
61078
|
* @param {Object} body
|
|
59854
|
-
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59855
61079
|
*/
|
|
59856
61080
|
putRoutingQueueIdentityresolution(queueId, body) {
|
|
59857
61081
|
// verify the required parameter 'queueId' is set
|
|
@@ -59932,7 +61156,6 @@ class RoutingApi {
|
|
|
59932
61156
|
*
|
|
59933
61157
|
* @param {String} addressId Address ID
|
|
59934
61158
|
* @param {Object} body
|
|
59935
|
-
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59936
61159
|
*/
|
|
59937
61160
|
putRoutingSmsIdentityresolutionPhonenumber(addressId, body) {
|
|
59938
61161
|
// verify the required parameter 'addressId' is set
|
|
@@ -60174,7 +61397,7 @@ class SCIMApi {
|
|
|
60174
61397
|
/**
|
|
60175
61398
|
* SCIM service.
|
|
60176
61399
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
60177
|
-
* @version
|
|
61400
|
+
* @version 222.0.0
|
|
60178
61401
|
*/
|
|
60179
61402
|
|
|
60180
61403
|
/**
|
|
@@ -61051,7 +62274,7 @@ class ScreenRecordingApi {
|
|
|
61051
62274
|
/**
|
|
61052
62275
|
* ScreenRecording service.
|
|
61053
62276
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
61054
|
-
* @version
|
|
62277
|
+
* @version 222.0.0
|
|
61055
62278
|
*/
|
|
61056
62279
|
|
|
61057
62280
|
/**
|
|
@@ -61096,7 +62319,7 @@ class ScriptsApi {
|
|
|
61096
62319
|
/**
|
|
61097
62320
|
* Scripts service.
|
|
61098
62321
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
61099
|
-
* @version
|
|
62322
|
+
* @version 222.0.0
|
|
61100
62323
|
*/
|
|
61101
62324
|
|
|
61102
62325
|
/**
|
|
@@ -61572,7 +62795,7 @@ class SearchApi {
|
|
|
61572
62795
|
/**
|
|
61573
62796
|
* Search service.
|
|
61574
62797
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
61575
|
-
* @version
|
|
62798
|
+
* @version 222.0.0
|
|
61576
62799
|
*/
|
|
61577
62800
|
|
|
61578
62801
|
/**
|
|
@@ -62315,7 +63538,7 @@ class SettingsApi {
|
|
|
62315
63538
|
/**
|
|
62316
63539
|
* Settings service.
|
|
62317
63540
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
62318
|
-
* @version
|
|
63541
|
+
* @version 222.0.0
|
|
62319
63542
|
*/
|
|
62320
63543
|
|
|
62321
63544
|
/**
|
|
@@ -62350,6 +63573,26 @@ class SettingsApi {
|
|
|
62350
63573
|
);
|
|
62351
63574
|
}
|
|
62352
63575
|
|
|
63576
|
+
/**
|
|
63577
|
+
* Delete settings
|
|
63578
|
+
*
|
|
63579
|
+
*/
|
|
63580
|
+
deleteExternalcontactsSettings() {
|
|
63581
|
+
|
|
63582
|
+
return this.apiClient.callApi(
|
|
63583
|
+
'/api/v2/externalcontacts/settings',
|
|
63584
|
+
'DELETE',
|
|
63585
|
+
{ },
|
|
63586
|
+
{ },
|
|
63587
|
+
{ },
|
|
63588
|
+
{ },
|
|
63589
|
+
null,
|
|
63590
|
+
['PureCloud OAuth'],
|
|
63591
|
+
['application/json'],
|
|
63592
|
+
['application/json']
|
|
63593
|
+
);
|
|
63594
|
+
}
|
|
63595
|
+
|
|
62353
63596
|
/**
|
|
62354
63597
|
* Delete agent auto answer settings
|
|
62355
63598
|
*
|
|
@@ -62415,6 +63658,26 @@ class SettingsApi {
|
|
|
62415
63658
|
);
|
|
62416
63659
|
}
|
|
62417
63660
|
|
|
63661
|
+
/**
|
|
63662
|
+
* Get settings
|
|
63663
|
+
*
|
|
63664
|
+
*/
|
|
63665
|
+
getExternalcontactsSettings() {
|
|
63666
|
+
|
|
63667
|
+
return this.apiClient.callApi(
|
|
63668
|
+
'/api/v2/externalcontacts/settings',
|
|
63669
|
+
'GET',
|
|
63670
|
+
{ },
|
|
63671
|
+
{ },
|
|
63672
|
+
{ },
|
|
63673
|
+
{ },
|
|
63674
|
+
null,
|
|
63675
|
+
['PureCloud OAuth'],
|
|
63676
|
+
['application/json'],
|
|
63677
|
+
['application/json']
|
|
63678
|
+
);
|
|
63679
|
+
}
|
|
63680
|
+
|
|
62418
63681
|
/**
|
|
62419
63682
|
* Get the execution history enabled setting.
|
|
62420
63683
|
* Get the execution history enabled setting.
|
|
@@ -62563,6 +63826,30 @@ class SettingsApi {
|
|
|
62563
63826
|
);
|
|
62564
63827
|
}
|
|
62565
63828
|
|
|
63829
|
+
/**
|
|
63830
|
+
* Set settings
|
|
63831
|
+
*
|
|
63832
|
+
* @param {Object} opts Optional parameters
|
|
63833
|
+
* @param {Object} opts.body
|
|
63834
|
+
*/
|
|
63835
|
+
putExternalcontactsSettings(opts) {
|
|
63836
|
+
opts = opts || {};
|
|
63837
|
+
|
|
63838
|
+
|
|
63839
|
+
return this.apiClient.callApi(
|
|
63840
|
+
'/api/v2/externalcontacts/settings',
|
|
63841
|
+
'PUT',
|
|
63842
|
+
{ },
|
|
63843
|
+
{ },
|
|
63844
|
+
{ },
|
|
63845
|
+
{ },
|
|
63846
|
+
opts['body'],
|
|
63847
|
+
['PureCloud OAuth'],
|
|
63848
|
+
['application/json'],
|
|
63849
|
+
['application/json']
|
|
63850
|
+
);
|
|
63851
|
+
}
|
|
63852
|
+
|
|
62566
63853
|
/**
|
|
62567
63854
|
* Set agent auto answer settings
|
|
62568
63855
|
*
|
|
@@ -62599,7 +63886,7 @@ class SocialMediaApi {
|
|
|
62599
63886
|
/**
|
|
62600
63887
|
* SocialMedia service.
|
|
62601
63888
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
62602
|
-
* @version
|
|
63889
|
+
* @version 222.0.0
|
|
62603
63890
|
*/
|
|
62604
63891
|
|
|
62605
63892
|
/**
|
|
@@ -63887,7 +65174,7 @@ class SpeechTextAnalyticsApi {
|
|
|
63887
65174
|
/**
|
|
63888
65175
|
* SpeechTextAnalytics service.
|
|
63889
65176
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
63890
|
-
* @version
|
|
65177
|
+
* @version 222.0.0
|
|
63891
65178
|
*/
|
|
63892
65179
|
|
|
63893
65180
|
/**
|
|
@@ -64789,7 +66076,6 @@ class SpeechTextAnalyticsApi {
|
|
|
64789
66076
|
* @param {Object} opts Optional parameters
|
|
64790
66077
|
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
64791
66078
|
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
64792
|
-
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64793
66079
|
*/
|
|
64794
66080
|
getSpeechandtextanalyticsTranslationsLanguageConversation(languageId, conversationId, opts) {
|
|
64795
66081
|
opts = opts || {};
|
|
@@ -64820,7 +66106,6 @@ class SpeechTextAnalyticsApi {
|
|
|
64820
66106
|
/**
|
|
64821
66107
|
* Get supported translation languages
|
|
64822
66108
|
*
|
|
64823
|
-
* getSpeechandtextanalyticsTranslationsLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64824
66109
|
*/
|
|
64825
66110
|
getSpeechandtextanalyticsTranslationsLanguages() {
|
|
64826
66111
|
|
|
@@ -65328,7 +66613,7 @@ class StationsApi {
|
|
|
65328
66613
|
/**
|
|
65329
66614
|
* Stations service.
|
|
65330
66615
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
65331
|
-
* @version
|
|
66616
|
+
* @version 222.0.0
|
|
65332
66617
|
*/
|
|
65333
66618
|
|
|
65334
66619
|
/**
|
|
@@ -65430,7 +66715,7 @@ class SuggestApi {
|
|
|
65430
66715
|
/**
|
|
65431
66716
|
* Suggest service.
|
|
65432
66717
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
65433
|
-
* @version
|
|
66718
|
+
* @version 222.0.0
|
|
65434
66719
|
*/
|
|
65435
66720
|
|
|
65436
66721
|
/**
|
|
@@ -65569,7 +66854,7 @@ class TaskManagementApi {
|
|
|
65569
66854
|
/**
|
|
65570
66855
|
* TaskManagement service.
|
|
65571
66856
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
65572
|
-
* @version
|
|
66857
|
+
* @version 222.0.0
|
|
65573
66858
|
*/
|
|
65574
66859
|
|
|
65575
66860
|
/**
|
|
@@ -66439,7 +67724,7 @@ class TaskManagementApi {
|
|
|
66439
67724
|
}
|
|
66440
67725
|
|
|
66441
67726
|
/**
|
|
66442
|
-
* Get
|
|
67727
|
+
* Get a specific named core type.
|
|
66443
67728
|
*
|
|
66444
67729
|
* @param {String} coreTypeName Name of the core type
|
|
66445
67730
|
*/
|
|
@@ -67731,7 +69016,7 @@ class TeamsApi {
|
|
|
67731
69016
|
/**
|
|
67732
69017
|
* Teams service.
|
|
67733
69018
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
67734
|
-
* @version
|
|
69019
|
+
* @version 222.0.0
|
|
67735
69020
|
*/
|
|
67736
69021
|
|
|
67737
69022
|
/**
|
|
@@ -68036,7 +69321,7 @@ class TelephonyApi {
|
|
|
68036
69321
|
/**
|
|
68037
69322
|
* Telephony service.
|
|
68038
69323
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
68039
|
-
* @version
|
|
69324
|
+
* @version 222.0.0
|
|
68040
69325
|
*/
|
|
68041
69326
|
|
|
68042
69327
|
/**
|
|
@@ -68218,7 +69503,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
68218
69503
|
/**
|
|
68219
69504
|
* TelephonyProvidersEdge service.
|
|
68220
69505
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
68221
|
-
* @version
|
|
69506
|
+
* @version 222.0.0
|
|
68222
69507
|
*/
|
|
68223
69508
|
|
|
68224
69509
|
/**
|
|
@@ -71670,7 +72955,7 @@ class TextbotsApi {
|
|
|
71670
72955
|
/**
|
|
71671
72956
|
* Textbots service.
|
|
71672
72957
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
71673
|
-
* @version
|
|
72958
|
+
* @version 222.0.0
|
|
71674
72959
|
*/
|
|
71675
72960
|
|
|
71676
72961
|
/**
|
|
@@ -71692,6 +72977,7 @@ class TextbotsApi {
|
|
|
71692
72977
|
* @param {Array.<String>} opts.botType Bot types
|
|
71693
72978
|
* @param {String} opts.botName Bot name
|
|
71694
72979
|
* @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
|
|
72980
|
+
* @param {Boolean} opts.virtualAgentEnabled Include or exclude virtual agent flows, only applies to GenesysBotFlows or GenesysDigitalBotFlows
|
|
71695
72981
|
* @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
|
|
71696
72982
|
*/
|
|
71697
72983
|
getTextbotsBotsSearch(opts) {
|
|
@@ -71702,7 +72988,7 @@ class TextbotsApi {
|
|
|
71702
72988
|
'/api/v2/textbots/bots/search',
|
|
71703
72989
|
'GET',
|
|
71704
72990
|
{ },
|
|
71705
|
-
{ 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
|
|
72991
|
+
{ 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'virtualAgentEnabled': opts['virtualAgentEnabled'],'pageSize': opts['pageSize'] },
|
|
71706
72992
|
{ },
|
|
71707
72993
|
{ },
|
|
71708
72994
|
null,
|
|
@@ -71798,7 +73084,7 @@ class TokensApi {
|
|
|
71798
73084
|
/**
|
|
71799
73085
|
* Tokens service.
|
|
71800
73086
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
71801
|
-
* @version
|
|
73087
|
+
* @version 222.0.0
|
|
71802
73088
|
*/
|
|
71803
73089
|
|
|
71804
73090
|
/**
|
|
@@ -71952,7 +73238,7 @@ class UploadsApi {
|
|
|
71952
73238
|
/**
|
|
71953
73239
|
* Uploads service.
|
|
71954
73240
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
71955
|
-
* @version
|
|
73241
|
+
* @version 222.0.0
|
|
71956
73242
|
*/
|
|
71957
73243
|
|
|
71958
73244
|
/**
|
|
@@ -72243,7 +73529,7 @@ class UsageApi {
|
|
|
72243
73529
|
/**
|
|
72244
73530
|
* Usage service.
|
|
72245
73531
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
72246
|
-
* @version
|
|
73532
|
+
* @version 222.0.0
|
|
72247
73533
|
*/
|
|
72248
73534
|
|
|
72249
73535
|
/**
|
|
@@ -72458,7 +73744,7 @@ class UserRecordingsApi {
|
|
|
72458
73744
|
/**
|
|
72459
73745
|
* UserRecordings service.
|
|
72460
73746
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
72461
|
-
* @version
|
|
73747
|
+
* @version 222.0.0
|
|
72462
73748
|
*/
|
|
72463
73749
|
|
|
72464
73750
|
/**
|
|
@@ -72673,7 +73959,7 @@ class UsersApi {
|
|
|
72673
73959
|
/**
|
|
72674
73960
|
* Users service.
|
|
72675
73961
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
72676
|
-
* @version
|
|
73962
|
+
* @version 222.0.0
|
|
72677
73963
|
*/
|
|
72678
73964
|
|
|
72679
73965
|
/**
|
|
@@ -75626,7 +76912,7 @@ class UtilitiesApi {
|
|
|
75626
76912
|
/**
|
|
75627
76913
|
* Utilities service.
|
|
75628
76914
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
75629
|
-
* @version
|
|
76915
|
+
* @version 222.0.0
|
|
75630
76916
|
*/
|
|
75631
76917
|
|
|
75632
76918
|
/**
|
|
@@ -75737,7 +77023,7 @@ class VoicemailApi {
|
|
|
75737
77023
|
/**
|
|
75738
77024
|
* Voicemail service.
|
|
75739
77025
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
75740
|
-
* @version
|
|
77026
|
+
* @version 222.0.0
|
|
75741
77027
|
*/
|
|
75742
77028
|
|
|
75743
77029
|
/**
|
|
@@ -76459,7 +77745,7 @@ class WebChatApi {
|
|
|
76459
77745
|
/**
|
|
76460
77746
|
* WebChat service.
|
|
76461
77747
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
76462
|
-
* @version
|
|
77748
|
+
* @version 222.0.0
|
|
76463
77749
|
*/
|
|
76464
77750
|
|
|
76465
77751
|
/**
|
|
@@ -77019,7 +78305,7 @@ class WebDeploymentsApi {
|
|
|
77019
78305
|
/**
|
|
77020
78306
|
* WebDeployments service.
|
|
77021
78307
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
77022
|
-
* @version
|
|
78308
|
+
* @version 222.0.0
|
|
77023
78309
|
*/
|
|
77024
78310
|
|
|
77025
78311
|
/**
|
|
@@ -77336,7 +78622,6 @@ class WebDeploymentsApi {
|
|
|
77336
78622
|
* Get a deployment identity resolution setting.
|
|
77337
78623
|
*
|
|
77338
78624
|
* @param {String} deploymentId The deployment ID
|
|
77339
|
-
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
77340
78625
|
*/
|
|
77341
78626
|
getWebdeploymentsDeploymentIdentityresolution(deploymentId) {
|
|
77342
78627
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -77571,7 +78856,6 @@ class WebDeploymentsApi {
|
|
|
77571
78856
|
*
|
|
77572
78857
|
* @param {String} deploymentId The deployment ID
|
|
77573
78858
|
* @param {Object} body
|
|
77574
|
-
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
77575
78859
|
*/
|
|
77576
78860
|
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body) {
|
|
77577
78861
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -77603,7 +78887,7 @@ class WebMessagingApi {
|
|
|
77603
78887
|
/**
|
|
77604
78888
|
* WebMessaging service.
|
|
77605
78889
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
77606
|
-
* @version
|
|
78890
|
+
* @version 222.0.0
|
|
77607
78891
|
*/
|
|
77608
78892
|
|
|
77609
78893
|
/**
|
|
@@ -77649,7 +78933,7 @@ class WidgetsApi {
|
|
|
77649
78933
|
/**
|
|
77650
78934
|
* Widgets service.
|
|
77651
78935
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
77652
|
-
* @version
|
|
78936
|
+
* @version 222.0.0
|
|
77653
78937
|
*/
|
|
77654
78938
|
|
|
77655
78939
|
/**
|
|
@@ -77800,7 +79084,7 @@ class WorkforceManagementApi {
|
|
|
77800
79084
|
/**
|
|
77801
79085
|
* WorkforceManagement service.
|
|
77802
79086
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
77803
|
-
* @version
|
|
79087
|
+
* @version 222.0.0
|
|
77804
79088
|
*/
|
|
77805
79089
|
|
|
77806
79090
|
/**
|
|
@@ -80999,6 +82283,7 @@ class WorkforceManagementApi {
|
|
|
80999
82283
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
81000
82284
|
* @param {Object} opts Optional parameters
|
|
81001
82285
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
82286
|
+
* @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
|
|
81002
82287
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
81003
82288
|
*/
|
|
81004
82289
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
@@ -81017,7 +82302,7 @@ class WorkforceManagementApi {
|
|
|
81017
82302
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
|
|
81018
82303
|
'GET',
|
|
81019
82304
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
81020
|
-
{ 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
|
|
82305
|
+
{ 'evaluateMatches': opts['evaluateMatches'],'includeCrossWeekShifts': opts['includeCrossWeekShifts'],'forceDownloadService': opts['forceDownloadService'] },
|
|
81021
82306
|
{ },
|
|
81022
82307
|
{ },
|
|
81023
82308
|
null,
|
|
@@ -85195,7 +86480,7 @@ class WorkforceManagementApi {
|
|
|
85195
86480
|
* </pre>
|
|
85196
86481
|
* </p>
|
|
85197
86482
|
* @module purecloud-platform-client-v2/index
|
|
85198
|
-
* @version
|
|
86483
|
+
* @version 222.0.0
|
|
85199
86484
|
*/
|
|
85200
86485
|
class platformClient {
|
|
85201
86486
|
constructor() {
|
|
@@ -85254,6 +86539,11 @@ class platformClient {
|
|
|
85254
86539
|
* @property {module:purecloud-platform-client-v2/api/BillingApi}
|
|
85255
86540
|
*/
|
|
85256
86541
|
this.BillingApi = BillingApi;
|
|
86542
|
+
/**
|
|
86543
|
+
* The BusinessRulesApi service constructor.
|
|
86544
|
+
* @property {module:purecloud-platform-client-v2/api/BusinessRulesApi}
|
|
86545
|
+
*/
|
|
86546
|
+
this.BusinessRulesApi = BusinessRulesApi;
|
|
85257
86547
|
/**
|
|
85258
86548
|
* The CarrierServicesApi service constructor.
|
|
85259
86549
|
* @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
|