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
|
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
687
687
|
|
|
688
688
|
/**
|
|
689
689
|
* @module purecloud-platform-client-v2/ApiClient
|
|
690
|
-
* @version
|
|
690
|
+
* @version 222.0.0
|
|
691
691
|
*/
|
|
692
692
|
class ApiClient {
|
|
693
693
|
/**
|
|
@@ -2231,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2231
2231
|
/**
|
|
2232
2232
|
* AgentAssistants service.
|
|
2233
2233
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2234
|
-
* @version
|
|
2234
|
+
* @version 222.0.0
|
|
2235
2235
|
*/
|
|
2236
2236
|
|
|
2237
2237
|
/**
|
|
@@ -2607,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2607
2607
|
/**
|
|
2608
2608
|
* AgentCopilot service.
|
|
2609
2609
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2610
|
-
* @version
|
|
2610
|
+
* @version 222.0.0
|
|
2611
2611
|
*/
|
|
2612
2612
|
|
|
2613
2613
|
/**
|
|
@@ -2683,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2683
2683
|
/**
|
|
2684
2684
|
* AgentUI service.
|
|
2685
2685
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2686
|
-
* @version
|
|
2686
|
+
* @version 222.0.0
|
|
2687
2687
|
*/
|
|
2688
2688
|
|
|
2689
2689
|
/**
|
|
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2814
2814
|
/**
|
|
2815
2815
|
* Alerting service.
|
|
2816
2816
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2817
|
-
* @version
|
|
2817
|
+
* @version 222.0.0
|
|
2818
2818
|
*/
|
|
2819
2819
|
|
|
2820
2820
|
/**
|
|
@@ -3215,7 +3215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3215
3215
|
/**
|
|
3216
3216
|
* Analytics service.
|
|
3217
3217
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3218
|
-
* @version
|
|
3218
|
+
* @version 222.0.0
|
|
3219
3219
|
*/
|
|
3220
3220
|
|
|
3221
3221
|
/**
|
|
@@ -6036,7 +6036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6036
6036
|
/**
|
|
6037
6037
|
* Architect service.
|
|
6038
6038
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6039
|
-
* @version
|
|
6039
|
+
* @version 222.0.0
|
|
6040
6040
|
*/
|
|
6041
6041
|
|
|
6042
6042
|
/**
|
|
@@ -7070,7 +7070,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7070
7070
|
* Get an IVR IdentityResolutionConfig.
|
|
7071
7071
|
*
|
|
7072
7072
|
* @param {String} ivrId IVR id
|
|
7073
|
-
* getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7074
7073
|
*/
|
|
7075
7074
|
getArchitectIvrIdentityresolution(ivrId) {
|
|
7076
7075
|
// verify the required parameter 'ivrId' is set
|
|
@@ -7103,6 +7102,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7103
7102
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
7104
7103
|
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
7105
7104
|
* @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
|
|
7105
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7106
7106
|
*/
|
|
7107
7107
|
getArchitectIvrs(opts) {
|
|
7108
7108
|
opts = opts || {};
|
|
@@ -7112,7 +7112,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7112
7112
|
'/api/v2/architect/ivrs',
|
|
7113
7113
|
'GET',
|
|
7114
7114
|
{ },
|
|
7115
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
|
|
7115
|
+
{ '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') },
|
|
7116
7116
|
{ },
|
|
7117
7117
|
{ },
|
|
7118
7118
|
null,
|
|
@@ -8010,6 +8010,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8010
8010
|
* @param {Object} opts.secure Secure
|
|
8011
8011
|
* @param {Boolean} opts.deleted Include deleted (default to false)
|
|
8012
8012
|
* @param {Boolean} opts.includeSchemas Include variable schemas (default to false)
|
|
8013
|
+
* @param {Boolean} opts.virtualAgentEnabled Include/exclude virtual agent flows
|
|
8013
8014
|
* @param {String} opts.publishedAfter Published after
|
|
8014
8015
|
* @param {String} opts.publishedBefore Published before
|
|
8015
8016
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
@@ -8022,7 +8023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8022
8023
|
'/api/v2/flows',
|
|
8023
8024
|
'GET',
|
|
8024
8025
|
{ },
|
|
8025
|
-
{ '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') },
|
|
8026
|
+
{ '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') },
|
|
8026
8027
|
{ },
|
|
8027
8028
|
{ },
|
|
8028
8029
|
null,
|
|
@@ -9918,7 +9919,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9918
9919
|
*
|
|
9919
9920
|
* @param {String} ivrId IVR id
|
|
9920
9921
|
* @param {Object} body
|
|
9921
|
-
* putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9922
9922
|
*/
|
|
9923
9923
|
putArchitectIvrIdentityresolution(ivrId, body) {
|
|
9924
9924
|
// verify the required parameter 'ivrId' is set
|
|
@@ -10329,7 +10329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10329
10329
|
/**
|
|
10330
10330
|
* Audit service.
|
|
10331
10331
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10332
|
-
* @version
|
|
10332
|
+
* @version 222.0.0
|
|
10333
10333
|
*/
|
|
10334
10334
|
|
|
10335
10335
|
/**
|
|
@@ -10530,7 +10530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10530
10530
|
/**
|
|
10531
10531
|
* Authorization service.
|
|
10532
10532
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10533
|
-
* @version
|
|
10533
|
+
* @version 222.0.0
|
|
10534
10534
|
*/
|
|
10535
10535
|
|
|
10536
10536
|
/**
|
|
@@ -12245,7 +12245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12245
12245
|
/**
|
|
12246
12246
|
* Billing service.
|
|
12247
12247
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12248
|
-
* @version
|
|
12248
|
+
* @version 222.0.0
|
|
12249
12249
|
*/
|
|
12250
12250
|
|
|
12251
12251
|
/**
|
|
@@ -12260,6 +12260,182 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12260
12260
|
}
|
|
12261
12261
|
|
|
12262
12262
|
|
|
12263
|
+
/**
|
|
12264
|
+
* Get billing contract
|
|
12265
|
+
* Retrieve a single contract from the system.
|
|
12266
|
+
* @param {String} contractId The contract number.
|
|
12267
|
+
* getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12268
|
+
*/
|
|
12269
|
+
getBillingContract(contractId) {
|
|
12270
|
+
// verify the required parameter 'contractId' is set
|
|
12271
|
+
if (contractId === undefined || contractId === null) {
|
|
12272
|
+
throw 'Missing the required parameter "contractId" when calling getBillingContract';
|
|
12273
|
+
}
|
|
12274
|
+
|
|
12275
|
+
return this.apiClient.callApi(
|
|
12276
|
+
'/api/v2/billing/contracts/{contractId}',
|
|
12277
|
+
'GET',
|
|
12278
|
+
{ 'contractId': contractId },
|
|
12279
|
+
{ },
|
|
12280
|
+
{ },
|
|
12281
|
+
{ },
|
|
12282
|
+
null,
|
|
12283
|
+
['PureCloud OAuth'],
|
|
12284
|
+
['application/json'],
|
|
12285
|
+
['application/json']
|
|
12286
|
+
);
|
|
12287
|
+
}
|
|
12288
|
+
|
|
12289
|
+
/**
|
|
12290
|
+
* Get contract billing period
|
|
12291
|
+
* Fetch the billing information for a given Organization by billing period.
|
|
12292
|
+
* @param {String} contractId The contract number.
|
|
12293
|
+
* @param {String} billingPeriodId The Billing Period Id for the Org.
|
|
12294
|
+
* getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12295
|
+
*/
|
|
12296
|
+
getBillingContractBillingperiod(contractId, billingPeriodId) {
|
|
12297
|
+
// verify the required parameter 'contractId' is set
|
|
12298
|
+
if (contractId === undefined || contractId === null) {
|
|
12299
|
+
throw 'Missing the required parameter "contractId" when calling getBillingContractBillingperiod';
|
|
12300
|
+
}
|
|
12301
|
+
// verify the required parameter 'billingPeriodId' is set
|
|
12302
|
+
if (billingPeriodId === undefined || billingPeriodId === null) {
|
|
12303
|
+
throw 'Missing the required parameter "billingPeriodId" when calling getBillingContractBillingperiod';
|
|
12304
|
+
}
|
|
12305
|
+
|
|
12306
|
+
return this.apiClient.callApi(
|
|
12307
|
+
'/api/v2/billing/contracts/{contractId}/billingperiods/{billingPeriodId}',
|
|
12308
|
+
'GET',
|
|
12309
|
+
{ 'contractId': contractId,'billingPeriodId': billingPeriodId },
|
|
12310
|
+
{ },
|
|
12311
|
+
{ },
|
|
12312
|
+
{ },
|
|
12313
|
+
null,
|
|
12314
|
+
['PureCloud OAuth'],
|
|
12315
|
+
['application/json'],
|
|
12316
|
+
['application/json']
|
|
12317
|
+
);
|
|
12318
|
+
}
|
|
12319
|
+
|
|
12320
|
+
/**
|
|
12321
|
+
* Get billing contracts
|
|
12322
|
+
* Retrieve a list of contracts stored in the system.
|
|
12323
|
+
* @param {Object} opts Optional parameters
|
|
12324
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12325
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12326
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12327
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12328
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12329
|
+
* @param {Object} opts.status Filter by the status of contracts
|
|
12330
|
+
* @param {String} opts.externalNumber Filter by the unique external number.
|
|
12331
|
+
* getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12332
|
+
*/
|
|
12333
|
+
getBillingContracts(opts) {
|
|
12334
|
+
opts = opts || {};
|
|
12335
|
+
|
|
12336
|
+
|
|
12337
|
+
return this.apiClient.callApi(
|
|
12338
|
+
'/api/v2/billing/contracts',
|
|
12339
|
+
'GET',
|
|
12340
|
+
{ },
|
|
12341
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': opts['status'],'externalNumber': opts['externalNumber'] },
|
|
12342
|
+
{ },
|
|
12343
|
+
{ },
|
|
12344
|
+
null,
|
|
12345
|
+
['PureCloud OAuth'],
|
|
12346
|
+
['application/json'],
|
|
12347
|
+
['application/json']
|
|
12348
|
+
);
|
|
12349
|
+
}
|
|
12350
|
+
|
|
12351
|
+
/**
|
|
12352
|
+
* Get invoice document
|
|
12353
|
+
* Fetch the document for a specific invoice.
|
|
12354
|
+
* @param {String} invoiceId invoiceId
|
|
12355
|
+
* getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12356
|
+
*/
|
|
12357
|
+
getBillingContractsInvoiceDocument(invoiceId) {
|
|
12358
|
+
// verify the required parameter 'invoiceId' is set
|
|
12359
|
+
if (invoiceId === undefined || invoiceId === null) {
|
|
12360
|
+
throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceDocument';
|
|
12361
|
+
}
|
|
12362
|
+
|
|
12363
|
+
return this.apiClient.callApi(
|
|
12364
|
+
'/api/v2/billing/contracts/invoices/{invoiceId}/document',
|
|
12365
|
+
'GET',
|
|
12366
|
+
{ 'invoiceId': invoiceId },
|
|
12367
|
+
{ },
|
|
12368
|
+
{ },
|
|
12369
|
+
{ },
|
|
12370
|
+
null,
|
|
12371
|
+
['PureCloud OAuth'],
|
|
12372
|
+
['application/json'],
|
|
12373
|
+
['application/json']
|
|
12374
|
+
);
|
|
12375
|
+
}
|
|
12376
|
+
|
|
12377
|
+
/**
|
|
12378
|
+
* Get invoice lines
|
|
12379
|
+
* Fetch a list of all bills for the specified account.
|
|
12380
|
+
* @param {String} invoiceId invoiceId
|
|
12381
|
+
* @param {Object} opts Optional parameters
|
|
12382
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12383
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12384
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12385
|
+
* getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12386
|
+
*/
|
|
12387
|
+
getBillingContractsInvoiceLines(invoiceId, opts) {
|
|
12388
|
+
opts = opts || {};
|
|
12389
|
+
|
|
12390
|
+
// verify the required parameter 'invoiceId' is set
|
|
12391
|
+
if (invoiceId === undefined || invoiceId === null) {
|
|
12392
|
+
throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceLines';
|
|
12393
|
+
}
|
|
12394
|
+
|
|
12395
|
+
return this.apiClient.callApi(
|
|
12396
|
+
'/api/v2/billing/contracts/invoices/{invoiceId}/lines',
|
|
12397
|
+
'GET',
|
|
12398
|
+
{ 'invoiceId': invoiceId },
|
|
12399
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
12400
|
+
{ },
|
|
12401
|
+
{ },
|
|
12402
|
+
null,
|
|
12403
|
+
['PureCloud OAuth'],
|
|
12404
|
+
['application/json'],
|
|
12405
|
+
['application/json']
|
|
12406
|
+
);
|
|
12407
|
+
}
|
|
12408
|
+
|
|
12409
|
+
/**
|
|
12410
|
+
* Get invoices
|
|
12411
|
+
* Retrieve a list of invoices stored in the system.
|
|
12412
|
+
* @param {Object} opts Optional parameters
|
|
12413
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12414
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12415
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12416
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12417
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
12418
|
+
* @param {Object} opts.paymentStatus Payment Status
|
|
12419
|
+
* getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12420
|
+
*/
|
|
12421
|
+
getBillingContractsInvoices(opts) {
|
|
12422
|
+
opts = opts || {};
|
|
12423
|
+
|
|
12424
|
+
|
|
12425
|
+
return this.apiClient.callApi(
|
|
12426
|
+
'/api/v2/billing/contracts/invoices',
|
|
12427
|
+
'GET',
|
|
12428
|
+
{ },
|
|
12429
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'paymentStatus': opts['paymentStatus'] },
|
|
12430
|
+
{ },
|
|
12431
|
+
{ },
|
|
12432
|
+
null,
|
|
12433
|
+
['PureCloud OAuth'],
|
|
12434
|
+
['application/json'],
|
|
12435
|
+
['application/json']
|
|
12436
|
+
);
|
|
12437
|
+
}
|
|
12438
|
+
|
|
12263
12439
|
/**
|
|
12264
12440
|
* Get a report of the billable license usages
|
|
12265
12441
|
* 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.
|
|
@@ -12321,11 +12497,925 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12321
12497
|
|
|
12322
12498
|
}
|
|
12323
12499
|
|
|
12500
|
+
class BusinessRulesApi {
|
|
12501
|
+
/**
|
|
12502
|
+
* BusinessRules service.
|
|
12503
|
+
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12504
|
+
* @version 222.0.0
|
|
12505
|
+
*/
|
|
12506
|
+
|
|
12507
|
+
/**
|
|
12508
|
+
* Constructs a new BusinessRulesApi.
|
|
12509
|
+
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12510
|
+
* @class
|
|
12511
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
12512
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
12513
|
+
*/
|
|
12514
|
+
constructor(apiClient) {
|
|
12515
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
12516
|
+
}
|
|
12517
|
+
|
|
12518
|
+
|
|
12519
|
+
/**
|
|
12520
|
+
* Delete a decision table
|
|
12521
|
+
*
|
|
12522
|
+
* @param {String} tableId Table ID
|
|
12523
|
+
* @param {Object} opts Optional parameters
|
|
12524
|
+
* @param {Boolean} opts.forceDelete Force delete decision table (under certain conditions) (default to false)
|
|
12525
|
+
* deleteBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12526
|
+
*/
|
|
12527
|
+
deleteBusinessrulesDecisiontable(tableId, opts) {
|
|
12528
|
+
opts = opts || {};
|
|
12529
|
+
|
|
12530
|
+
// verify the required parameter 'tableId' is set
|
|
12531
|
+
if (tableId === undefined || tableId === null) {
|
|
12532
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontable';
|
|
12533
|
+
}
|
|
12534
|
+
|
|
12535
|
+
return this.apiClient.callApi(
|
|
12536
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12537
|
+
'DELETE',
|
|
12538
|
+
{ 'tableId': tableId },
|
|
12539
|
+
{ 'forceDelete': opts['forceDelete'] },
|
|
12540
|
+
{ },
|
|
12541
|
+
{ },
|
|
12542
|
+
null,
|
|
12543
|
+
['PureCloud OAuth'],
|
|
12544
|
+
['application/json'],
|
|
12545
|
+
['application/json']
|
|
12546
|
+
);
|
|
12547
|
+
}
|
|
12548
|
+
|
|
12549
|
+
/**
|
|
12550
|
+
* Delete a decision table version
|
|
12551
|
+
*
|
|
12552
|
+
* @param {String} tableId Table ID
|
|
12553
|
+
* @param {Number} tableVersion Table Version
|
|
12554
|
+
* deleteBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12555
|
+
*/
|
|
12556
|
+
deleteBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
12557
|
+
// verify the required parameter 'tableId' is set
|
|
12558
|
+
if (tableId === undefined || tableId === null) {
|
|
12559
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersion';
|
|
12560
|
+
}
|
|
12561
|
+
// verify the required parameter 'tableVersion' is set
|
|
12562
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12563
|
+
throw 'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersion';
|
|
12564
|
+
}
|
|
12565
|
+
|
|
12566
|
+
return this.apiClient.callApi(
|
|
12567
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
12568
|
+
'DELETE',
|
|
12569
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12570
|
+
{ },
|
|
12571
|
+
{ },
|
|
12572
|
+
{ },
|
|
12573
|
+
null,
|
|
12574
|
+
['PureCloud OAuth'],
|
|
12575
|
+
['application/json'],
|
|
12576
|
+
['application/json']
|
|
12577
|
+
);
|
|
12578
|
+
}
|
|
12579
|
+
|
|
12580
|
+
/**
|
|
12581
|
+
* Delete a decision table row
|
|
12582
|
+
*
|
|
12583
|
+
* @param {String} tableId Table ID
|
|
12584
|
+
* @param {Number} tableVersion Table Version
|
|
12585
|
+
* @param {String} rowId Row ID
|
|
12586
|
+
* deleteBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12587
|
+
*/
|
|
12588
|
+
deleteBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
12589
|
+
// verify the required parameter 'tableId' is set
|
|
12590
|
+
if (tableId === undefined || tableId === null) {
|
|
12591
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12592
|
+
}
|
|
12593
|
+
// verify the required parameter 'tableVersion' is set
|
|
12594
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12595
|
+
throw 'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12596
|
+
}
|
|
12597
|
+
// verify the required parameter 'rowId' is set
|
|
12598
|
+
if (rowId === undefined || rowId === null) {
|
|
12599
|
+
throw 'Missing the required parameter "rowId" when calling deleteBusinessrulesDecisiontableVersionRow';
|
|
12600
|
+
}
|
|
12601
|
+
|
|
12602
|
+
return this.apiClient.callApi(
|
|
12603
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
12604
|
+
'DELETE',
|
|
12605
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
12606
|
+
{ },
|
|
12607
|
+
{ },
|
|
12608
|
+
{ },
|
|
12609
|
+
null,
|
|
12610
|
+
['PureCloud OAuth'],
|
|
12611
|
+
['application/json'],
|
|
12612
|
+
['application/json']
|
|
12613
|
+
);
|
|
12614
|
+
}
|
|
12615
|
+
|
|
12616
|
+
/**
|
|
12617
|
+
* Delete a schema
|
|
12618
|
+
*
|
|
12619
|
+
* @param {String} schemaId Schema ID
|
|
12620
|
+
* deleteBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12621
|
+
*/
|
|
12622
|
+
deleteBusinessrulesSchema(schemaId) {
|
|
12623
|
+
// verify the required parameter 'schemaId' is set
|
|
12624
|
+
if (schemaId === undefined || schemaId === null) {
|
|
12625
|
+
throw 'Missing the required parameter "schemaId" when calling deleteBusinessrulesSchema';
|
|
12626
|
+
}
|
|
12627
|
+
|
|
12628
|
+
return this.apiClient.callApi(
|
|
12629
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
12630
|
+
'DELETE',
|
|
12631
|
+
{ 'schemaId': schemaId },
|
|
12632
|
+
{ },
|
|
12633
|
+
{ },
|
|
12634
|
+
{ },
|
|
12635
|
+
null,
|
|
12636
|
+
['PureCloud OAuth'],
|
|
12637
|
+
['application/json'],
|
|
12638
|
+
['application/json']
|
|
12639
|
+
);
|
|
12640
|
+
}
|
|
12641
|
+
|
|
12642
|
+
/**
|
|
12643
|
+
* Get a decision table
|
|
12644
|
+
*
|
|
12645
|
+
* @param {String} tableId Table ID
|
|
12646
|
+
* getBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12647
|
+
*/
|
|
12648
|
+
getBusinessrulesDecisiontable(tableId) {
|
|
12649
|
+
// verify the required parameter 'tableId' is set
|
|
12650
|
+
if (tableId === undefined || tableId === null) {
|
|
12651
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontable';
|
|
12652
|
+
}
|
|
12653
|
+
|
|
12654
|
+
return this.apiClient.callApi(
|
|
12655
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12656
|
+
'GET',
|
|
12657
|
+
{ 'tableId': tableId },
|
|
12658
|
+
{ },
|
|
12659
|
+
{ },
|
|
12660
|
+
{ },
|
|
12661
|
+
null,
|
|
12662
|
+
['PureCloud OAuth'],
|
|
12663
|
+
['application/json'],
|
|
12664
|
+
['application/json']
|
|
12665
|
+
);
|
|
12666
|
+
}
|
|
12667
|
+
|
|
12668
|
+
/**
|
|
12669
|
+
* Get a decision table version
|
|
12670
|
+
*
|
|
12671
|
+
* @param {String} tableId Table ID
|
|
12672
|
+
* @param {Number} tableVersion Table Version
|
|
12673
|
+
* getBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12674
|
+
*/
|
|
12675
|
+
getBusinessrulesDecisiontableVersion(tableId, tableVersion) {
|
|
12676
|
+
// verify the required parameter 'tableId' is set
|
|
12677
|
+
if (tableId === undefined || tableId === null) {
|
|
12678
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersion';
|
|
12679
|
+
}
|
|
12680
|
+
// verify the required parameter 'tableVersion' is set
|
|
12681
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12682
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersion';
|
|
12683
|
+
}
|
|
12684
|
+
|
|
12685
|
+
return this.apiClient.callApi(
|
|
12686
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
12687
|
+
'GET',
|
|
12688
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12689
|
+
{ },
|
|
12690
|
+
{ },
|
|
12691
|
+
{ },
|
|
12692
|
+
null,
|
|
12693
|
+
['PureCloud OAuth'],
|
|
12694
|
+
['application/json'],
|
|
12695
|
+
['application/json']
|
|
12696
|
+
);
|
|
12697
|
+
}
|
|
12698
|
+
|
|
12699
|
+
/**
|
|
12700
|
+
* Get a decision table row
|
|
12701
|
+
*
|
|
12702
|
+
* @param {String} tableId Table ID
|
|
12703
|
+
* @param {Number} tableVersion Table Version
|
|
12704
|
+
* @param {String} rowId Row ID
|
|
12705
|
+
* getBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12706
|
+
*/
|
|
12707
|
+
getBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId) {
|
|
12708
|
+
// verify the required parameter 'tableId' is set
|
|
12709
|
+
if (tableId === undefined || tableId === null) {
|
|
12710
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12711
|
+
}
|
|
12712
|
+
// verify the required parameter 'tableVersion' is set
|
|
12713
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12714
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12715
|
+
}
|
|
12716
|
+
// verify the required parameter 'rowId' is set
|
|
12717
|
+
if (rowId === undefined || rowId === null) {
|
|
12718
|
+
throw 'Missing the required parameter "rowId" when calling getBusinessrulesDecisiontableVersionRow';
|
|
12719
|
+
}
|
|
12720
|
+
|
|
12721
|
+
return this.apiClient.callApi(
|
|
12722
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
12723
|
+
'GET',
|
|
12724
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
12725
|
+
{ },
|
|
12726
|
+
{ },
|
|
12727
|
+
{ },
|
|
12728
|
+
null,
|
|
12729
|
+
['PureCloud OAuth'],
|
|
12730
|
+
['application/json'],
|
|
12731
|
+
['application/json']
|
|
12732
|
+
);
|
|
12733
|
+
}
|
|
12734
|
+
|
|
12735
|
+
/**
|
|
12736
|
+
* Get a list of decision table rows.
|
|
12737
|
+
*
|
|
12738
|
+
* @param {String} tableId Table ID
|
|
12739
|
+
* @param {Number} tableVersion Table Version
|
|
12740
|
+
* @param {Object} opts Optional parameters
|
|
12741
|
+
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
12742
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
12743
|
+
* getBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12744
|
+
*/
|
|
12745
|
+
getBusinessrulesDecisiontableVersionRows(tableId, tableVersion, opts) {
|
|
12746
|
+
opts = opts || {};
|
|
12747
|
+
|
|
12748
|
+
// verify the required parameter 'tableId' is set
|
|
12749
|
+
if (tableId === undefined || tableId === null) {
|
|
12750
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRows';
|
|
12751
|
+
}
|
|
12752
|
+
// verify the required parameter 'tableVersion' is set
|
|
12753
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12754
|
+
throw 'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRows';
|
|
12755
|
+
}
|
|
12756
|
+
|
|
12757
|
+
return this.apiClient.callApi(
|
|
12758
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows',
|
|
12759
|
+
'GET',
|
|
12760
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
12761
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
12762
|
+
{ },
|
|
12763
|
+
{ },
|
|
12764
|
+
null,
|
|
12765
|
+
['PureCloud OAuth'],
|
|
12766
|
+
['application/json'],
|
|
12767
|
+
['application/json']
|
|
12768
|
+
);
|
|
12769
|
+
}
|
|
12770
|
+
|
|
12771
|
+
/**
|
|
12772
|
+
* Get a list of decision table versions
|
|
12773
|
+
*
|
|
12774
|
+
* @param {String} tableId Table ID
|
|
12775
|
+
* @param {Object} opts Optional parameters
|
|
12776
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12777
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12778
|
+
* @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.
|
|
12779
|
+
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12780
|
+
*/
|
|
12781
|
+
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
12782
|
+
opts = opts || {};
|
|
12783
|
+
|
|
12784
|
+
// verify the required parameter 'tableId' is set
|
|
12785
|
+
if (tableId === undefined || tableId === null) {
|
|
12786
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersions';
|
|
12787
|
+
}
|
|
12788
|
+
|
|
12789
|
+
return this.apiClient.callApi(
|
|
12790
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
12791
|
+
'GET',
|
|
12792
|
+
{ 'tableId': tableId },
|
|
12793
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
12794
|
+
{ },
|
|
12795
|
+
{ },
|
|
12796
|
+
null,
|
|
12797
|
+
['PureCloud OAuth'],
|
|
12798
|
+
['application/json'],
|
|
12799
|
+
['application/json']
|
|
12800
|
+
);
|
|
12801
|
+
}
|
|
12802
|
+
|
|
12803
|
+
/**
|
|
12804
|
+
* Get a list of decision tables.
|
|
12805
|
+
*
|
|
12806
|
+
* @param {Object} opts Optional parameters
|
|
12807
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12808
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12809
|
+
* @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.
|
|
12810
|
+
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12811
|
+
*/
|
|
12812
|
+
getBusinessrulesDecisiontables(opts) {
|
|
12813
|
+
opts = opts || {};
|
|
12814
|
+
|
|
12815
|
+
|
|
12816
|
+
return this.apiClient.callApi(
|
|
12817
|
+
'/api/v2/businessrules/decisiontables',
|
|
12818
|
+
'GET',
|
|
12819
|
+
{ },
|
|
12820
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
12821
|
+
{ },
|
|
12822
|
+
{ },
|
|
12823
|
+
null,
|
|
12824
|
+
['PureCloud OAuth'],
|
|
12825
|
+
['application/json'],
|
|
12826
|
+
['application/json']
|
|
12827
|
+
);
|
|
12828
|
+
}
|
|
12829
|
+
|
|
12830
|
+
/**
|
|
12831
|
+
* Search for decision tables.
|
|
12832
|
+
*
|
|
12833
|
+
* @param {Object} opts Optional parameters
|
|
12834
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12835
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12836
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
12837
|
+
* @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.
|
|
12838
|
+
* @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.
|
|
12839
|
+
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12840
|
+
*/
|
|
12841
|
+
getBusinessrulesDecisiontablesSearch(opts) {
|
|
12842
|
+
opts = opts || {};
|
|
12843
|
+
|
|
12844
|
+
|
|
12845
|
+
return this.apiClient.callApi(
|
|
12846
|
+
'/api/v2/businessrules/decisiontables/search',
|
|
12847
|
+
'GET',
|
|
12848
|
+
{ },
|
|
12849
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'] },
|
|
12850
|
+
{ },
|
|
12851
|
+
{ },
|
|
12852
|
+
null,
|
|
12853
|
+
['PureCloud OAuth'],
|
|
12854
|
+
['application/json'],
|
|
12855
|
+
['application/json']
|
|
12856
|
+
);
|
|
12857
|
+
}
|
|
12858
|
+
|
|
12859
|
+
/**
|
|
12860
|
+
* Get a schema
|
|
12861
|
+
*
|
|
12862
|
+
* @param {String} schemaId Schema ID
|
|
12863
|
+
* getBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12864
|
+
*/
|
|
12865
|
+
getBusinessrulesSchema(schemaId) {
|
|
12866
|
+
// verify the required parameter 'schemaId' is set
|
|
12867
|
+
if (schemaId === undefined || schemaId === null) {
|
|
12868
|
+
throw 'Missing the required parameter "schemaId" when calling getBusinessrulesSchema';
|
|
12869
|
+
}
|
|
12870
|
+
|
|
12871
|
+
return this.apiClient.callApi(
|
|
12872
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
12873
|
+
'GET',
|
|
12874
|
+
{ 'schemaId': schemaId },
|
|
12875
|
+
{ },
|
|
12876
|
+
{ },
|
|
12877
|
+
{ },
|
|
12878
|
+
null,
|
|
12879
|
+
['PureCloud OAuth'],
|
|
12880
|
+
['application/json'],
|
|
12881
|
+
['application/json']
|
|
12882
|
+
);
|
|
12883
|
+
}
|
|
12884
|
+
|
|
12885
|
+
/**
|
|
12886
|
+
* Get a list of schemas.
|
|
12887
|
+
*
|
|
12888
|
+
* getBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12889
|
+
*/
|
|
12890
|
+
getBusinessrulesSchemas() {
|
|
12891
|
+
|
|
12892
|
+
return this.apiClient.callApi(
|
|
12893
|
+
'/api/v2/businessrules/schemas',
|
|
12894
|
+
'GET',
|
|
12895
|
+
{ },
|
|
12896
|
+
{ },
|
|
12897
|
+
{ },
|
|
12898
|
+
{ },
|
|
12899
|
+
null,
|
|
12900
|
+
['PureCloud OAuth'],
|
|
12901
|
+
['application/json'],
|
|
12902
|
+
['application/json']
|
|
12903
|
+
);
|
|
12904
|
+
}
|
|
12905
|
+
|
|
12906
|
+
/**
|
|
12907
|
+
* Get a specific named core type.
|
|
12908
|
+
*
|
|
12909
|
+
* @param {String} coreTypeName The core type's name
|
|
12910
|
+
* getBusinessrulesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12911
|
+
*/
|
|
12912
|
+
getBusinessrulesSchemasCoretype(coreTypeName) {
|
|
12913
|
+
// verify the required parameter 'coreTypeName' is set
|
|
12914
|
+
if (coreTypeName === undefined || coreTypeName === null) {
|
|
12915
|
+
throw 'Missing the required parameter "coreTypeName" when calling getBusinessrulesSchemasCoretype';
|
|
12916
|
+
}
|
|
12917
|
+
|
|
12918
|
+
return this.apiClient.callApi(
|
|
12919
|
+
'/api/v2/businessrules/schemas/coretypes/{coreTypeName}',
|
|
12920
|
+
'GET',
|
|
12921
|
+
{ 'coreTypeName': coreTypeName },
|
|
12922
|
+
{ },
|
|
12923
|
+
{ },
|
|
12924
|
+
{ },
|
|
12925
|
+
null,
|
|
12926
|
+
['PureCloud OAuth'],
|
|
12927
|
+
['application/json'],
|
|
12928
|
+
['application/json']
|
|
12929
|
+
);
|
|
12930
|
+
}
|
|
12931
|
+
|
|
12932
|
+
/**
|
|
12933
|
+
* Get the core types from which all schemas are built.
|
|
12934
|
+
*
|
|
12935
|
+
* getBusinessrulesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12936
|
+
*/
|
|
12937
|
+
getBusinessrulesSchemasCoretypes() {
|
|
12938
|
+
|
|
12939
|
+
return this.apiClient.callApi(
|
|
12940
|
+
'/api/v2/businessrules/schemas/coretypes',
|
|
12941
|
+
'GET',
|
|
12942
|
+
{ },
|
|
12943
|
+
{ },
|
|
12944
|
+
{ },
|
|
12945
|
+
{ },
|
|
12946
|
+
null,
|
|
12947
|
+
['PureCloud OAuth'],
|
|
12948
|
+
['application/json'],
|
|
12949
|
+
['application/json']
|
|
12950
|
+
);
|
|
12951
|
+
}
|
|
12952
|
+
|
|
12953
|
+
/**
|
|
12954
|
+
* Update a decision table
|
|
12955
|
+
*
|
|
12956
|
+
* @param {String} tableId Table ID
|
|
12957
|
+
* @param {Object} body Decision Table
|
|
12958
|
+
* patchBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12959
|
+
*/
|
|
12960
|
+
patchBusinessrulesDecisiontable(tableId, body) {
|
|
12961
|
+
// verify the required parameter 'tableId' is set
|
|
12962
|
+
if (tableId === undefined || tableId === null) {
|
|
12963
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontable';
|
|
12964
|
+
}
|
|
12965
|
+
// verify the required parameter 'body' is set
|
|
12966
|
+
if (body === undefined || body === null) {
|
|
12967
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontable';
|
|
12968
|
+
}
|
|
12969
|
+
|
|
12970
|
+
return this.apiClient.callApi(
|
|
12971
|
+
'/api/v2/businessrules/decisiontables/{tableId}',
|
|
12972
|
+
'PATCH',
|
|
12973
|
+
{ 'tableId': tableId },
|
|
12974
|
+
{ },
|
|
12975
|
+
{ },
|
|
12976
|
+
{ },
|
|
12977
|
+
body,
|
|
12978
|
+
['PureCloud OAuth'],
|
|
12979
|
+
['application/json'],
|
|
12980
|
+
['application/json']
|
|
12981
|
+
);
|
|
12982
|
+
}
|
|
12983
|
+
|
|
12984
|
+
/**
|
|
12985
|
+
* Update a decision table version
|
|
12986
|
+
*
|
|
12987
|
+
* @param {String} tableId Table ID
|
|
12988
|
+
* @param {Number} tableVersion Table Version
|
|
12989
|
+
* @param {Object} body Decision Table
|
|
12990
|
+
* patchBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12991
|
+
*/
|
|
12992
|
+
patchBusinessrulesDecisiontableVersion(tableId, tableVersion, body) {
|
|
12993
|
+
// verify the required parameter 'tableId' is set
|
|
12994
|
+
if (tableId === undefined || tableId === null) {
|
|
12995
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersion';
|
|
12996
|
+
}
|
|
12997
|
+
// verify the required parameter 'tableVersion' is set
|
|
12998
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
12999
|
+
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersion';
|
|
13000
|
+
}
|
|
13001
|
+
// verify the required parameter 'body' is set
|
|
13002
|
+
if (body === undefined || body === null) {
|
|
13003
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersion';
|
|
13004
|
+
}
|
|
13005
|
+
|
|
13006
|
+
return this.apiClient.callApi(
|
|
13007
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}',
|
|
13008
|
+
'PATCH',
|
|
13009
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13010
|
+
{ },
|
|
13011
|
+
{ },
|
|
13012
|
+
{ },
|
|
13013
|
+
body,
|
|
13014
|
+
['PureCloud OAuth'],
|
|
13015
|
+
['application/json'],
|
|
13016
|
+
['application/json']
|
|
13017
|
+
);
|
|
13018
|
+
}
|
|
13019
|
+
|
|
13020
|
+
/**
|
|
13021
|
+
* Update a decision table row
|
|
13022
|
+
*
|
|
13023
|
+
* @param {String} tableId Table ID
|
|
13024
|
+
* @param {Number} tableVersion Table Version
|
|
13025
|
+
* @param {String} rowId Row ID
|
|
13026
|
+
* @param {Object} body Update decision table row request
|
|
13027
|
+
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13028
|
+
*/
|
|
13029
|
+
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
13030
|
+
// verify the required parameter 'tableId' is set
|
|
13031
|
+
if (tableId === undefined || tableId === null) {
|
|
13032
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13033
|
+
}
|
|
13034
|
+
// verify the required parameter 'tableVersion' is set
|
|
13035
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13036
|
+
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13037
|
+
}
|
|
13038
|
+
// verify the required parameter 'rowId' is set
|
|
13039
|
+
if (rowId === undefined || rowId === null) {
|
|
13040
|
+
throw 'Missing the required parameter "rowId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13041
|
+
}
|
|
13042
|
+
// verify the required parameter 'body' is set
|
|
13043
|
+
if (body === undefined || body === null) {
|
|
13044
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13045
|
+
}
|
|
13046
|
+
|
|
13047
|
+
return this.apiClient.callApi(
|
|
13048
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
13049
|
+
'PATCH',
|
|
13050
|
+
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
13051
|
+
{ },
|
|
13052
|
+
{ },
|
|
13053
|
+
{ },
|
|
13054
|
+
body,
|
|
13055
|
+
['PureCloud OAuth'],
|
|
13056
|
+
['application/json'],
|
|
13057
|
+
['application/json']
|
|
13058
|
+
);
|
|
13059
|
+
}
|
|
13060
|
+
|
|
13061
|
+
/**
|
|
13062
|
+
* Execute a published decision table
|
|
13063
|
+
*
|
|
13064
|
+
* @param {String} tableId Table ID
|
|
13065
|
+
* @param {Object} body Decision Table
|
|
13066
|
+
* postBusinessrulesDecisiontableExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13067
|
+
*/
|
|
13068
|
+
postBusinessrulesDecisiontableExecute(tableId, body) {
|
|
13069
|
+
// verify the required parameter 'tableId' is set
|
|
13070
|
+
if (tableId === undefined || tableId === null) {
|
|
13071
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExecute';
|
|
13072
|
+
}
|
|
13073
|
+
// verify the required parameter 'body' is set
|
|
13074
|
+
if (body === undefined || body === null) {
|
|
13075
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExecute';
|
|
13076
|
+
}
|
|
13077
|
+
|
|
13078
|
+
return this.apiClient.callApi(
|
|
13079
|
+
'/api/v2/businessrules/decisiontables/{tableId}/execute',
|
|
13080
|
+
'POST',
|
|
13081
|
+
{ 'tableId': tableId },
|
|
13082
|
+
{ },
|
|
13083
|
+
{ },
|
|
13084
|
+
{ },
|
|
13085
|
+
body,
|
|
13086
|
+
['PureCloud OAuth'],
|
|
13087
|
+
['application/json'],
|
|
13088
|
+
['application/json']
|
|
13089
|
+
);
|
|
13090
|
+
}
|
|
13091
|
+
|
|
13092
|
+
/**
|
|
13093
|
+
* Copy a decision table version
|
|
13094
|
+
*
|
|
13095
|
+
* @param {String} tableId Table ID
|
|
13096
|
+
* @param {Number} tableVersion Table Version
|
|
13097
|
+
* @param {Object} body Decision Table
|
|
13098
|
+
* postBusinessrulesDecisiontableVersionCopy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13099
|
+
*/
|
|
13100
|
+
postBusinessrulesDecisiontableVersionCopy(tableId, tableVersion, body) {
|
|
13101
|
+
// verify the required parameter 'tableId' is set
|
|
13102
|
+
if (tableId === undefined || tableId === null) {
|
|
13103
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13104
|
+
}
|
|
13105
|
+
// verify the required parameter 'tableVersion' is set
|
|
13106
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13107
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13108
|
+
}
|
|
13109
|
+
// verify the required parameter 'body' is set
|
|
13110
|
+
if (body === undefined || body === null) {
|
|
13111
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionCopy';
|
|
13112
|
+
}
|
|
13113
|
+
|
|
13114
|
+
return this.apiClient.callApi(
|
|
13115
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/copy',
|
|
13116
|
+
'POST',
|
|
13117
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13118
|
+
{ },
|
|
13119
|
+
{ },
|
|
13120
|
+
{ },
|
|
13121
|
+
body,
|
|
13122
|
+
['PureCloud OAuth'],
|
|
13123
|
+
['application/json'],
|
|
13124
|
+
['application/json']
|
|
13125
|
+
);
|
|
13126
|
+
}
|
|
13127
|
+
|
|
13128
|
+
/**
|
|
13129
|
+
* Execute a decision table version
|
|
13130
|
+
*
|
|
13131
|
+
* @param {String} tableId Table ID
|
|
13132
|
+
* @param {Number} tableVersion Table Version
|
|
13133
|
+
* @param {Object} body Decision Table
|
|
13134
|
+
* postBusinessrulesDecisiontableVersionExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13135
|
+
*/
|
|
13136
|
+
postBusinessrulesDecisiontableVersionExecute(tableId, tableVersion, body) {
|
|
13137
|
+
// verify the required parameter 'tableId' is set
|
|
13138
|
+
if (tableId === undefined || tableId === null) {
|
|
13139
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13140
|
+
}
|
|
13141
|
+
// verify the required parameter 'tableVersion' is set
|
|
13142
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13143
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13144
|
+
}
|
|
13145
|
+
// verify the required parameter 'body' is set
|
|
13146
|
+
if (body === undefined || body === null) {
|
|
13147
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionExecute';
|
|
13148
|
+
}
|
|
13149
|
+
|
|
13150
|
+
return this.apiClient.callApi(
|
|
13151
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/execute',
|
|
13152
|
+
'POST',
|
|
13153
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13154
|
+
{ },
|
|
13155
|
+
{ },
|
|
13156
|
+
{ },
|
|
13157
|
+
body,
|
|
13158
|
+
['PureCloud OAuth'],
|
|
13159
|
+
['application/json'],
|
|
13160
|
+
['application/json']
|
|
13161
|
+
);
|
|
13162
|
+
}
|
|
13163
|
+
|
|
13164
|
+
/**
|
|
13165
|
+
* Create a decision table row
|
|
13166
|
+
*
|
|
13167
|
+
* @param {String} tableId Table ID
|
|
13168
|
+
* @param {Number} tableVersion Table Version
|
|
13169
|
+
* @param {Object} body Create decision table row request
|
|
13170
|
+
* postBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13171
|
+
*/
|
|
13172
|
+
postBusinessrulesDecisiontableVersionRows(tableId, tableVersion, body) {
|
|
13173
|
+
// verify the required parameter 'tableId' is set
|
|
13174
|
+
if (tableId === undefined || tableId === null) {
|
|
13175
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13176
|
+
}
|
|
13177
|
+
// verify the required parameter 'tableVersion' is set
|
|
13178
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13179
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13180
|
+
}
|
|
13181
|
+
// verify the required parameter 'body' is set
|
|
13182
|
+
if (body === undefined || body === null) {
|
|
13183
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRows';
|
|
13184
|
+
}
|
|
13185
|
+
|
|
13186
|
+
return this.apiClient.callApi(
|
|
13187
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows',
|
|
13188
|
+
'POST',
|
|
13189
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13190
|
+
{ },
|
|
13191
|
+
{ },
|
|
13192
|
+
{ },
|
|
13193
|
+
body,
|
|
13194
|
+
['PureCloud OAuth'],
|
|
13195
|
+
['application/json'],
|
|
13196
|
+
['application/json']
|
|
13197
|
+
);
|
|
13198
|
+
}
|
|
13199
|
+
|
|
13200
|
+
/**
|
|
13201
|
+
* Search for decision table rows
|
|
13202
|
+
*
|
|
13203
|
+
* @param {String} tableId Table ID
|
|
13204
|
+
* @param {Number} tableVersion Table Version
|
|
13205
|
+
* @param {Object} body Search decision table rows request
|
|
13206
|
+
* @param {Object} opts Optional parameters
|
|
13207
|
+
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
13208
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
13209
|
+
* postBusinessrulesDecisiontableVersionRowsSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13210
|
+
*/
|
|
13211
|
+
postBusinessrulesDecisiontableVersionRowsSearch(tableId, tableVersion, body, opts) {
|
|
13212
|
+
opts = opts || {};
|
|
13213
|
+
|
|
13214
|
+
// verify the required parameter 'tableId' is set
|
|
13215
|
+
if (tableId === undefined || tableId === null) {
|
|
13216
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13217
|
+
}
|
|
13218
|
+
// verify the required parameter 'tableVersion' is set
|
|
13219
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13220
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13221
|
+
}
|
|
13222
|
+
// verify the required parameter 'body' is set
|
|
13223
|
+
if (body === undefined || body === null) {
|
|
13224
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsSearch';
|
|
13225
|
+
}
|
|
13226
|
+
|
|
13227
|
+
return this.apiClient.callApi(
|
|
13228
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/search',
|
|
13229
|
+
'POST',
|
|
13230
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13231
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
13232
|
+
{ },
|
|
13233
|
+
{ },
|
|
13234
|
+
body,
|
|
13235
|
+
['PureCloud OAuth'],
|
|
13236
|
+
['application/json'],
|
|
13237
|
+
['application/json']
|
|
13238
|
+
);
|
|
13239
|
+
}
|
|
13240
|
+
|
|
13241
|
+
/**
|
|
13242
|
+
* Update the Business Rules Schema to the latest version for a given decision table version
|
|
13243
|
+
*
|
|
13244
|
+
* @param {String} tableId Table ID
|
|
13245
|
+
* @param {Number} tableVersion Table Version
|
|
13246
|
+
* postBusinessrulesDecisiontableVersionSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13247
|
+
*/
|
|
13248
|
+
postBusinessrulesDecisiontableVersionSync(tableId, tableVersion) {
|
|
13249
|
+
// verify the required parameter 'tableId' is set
|
|
13250
|
+
if (tableId === undefined || tableId === null) {
|
|
13251
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionSync';
|
|
13252
|
+
}
|
|
13253
|
+
// verify the required parameter 'tableVersion' is set
|
|
13254
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13255
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionSync';
|
|
13256
|
+
}
|
|
13257
|
+
|
|
13258
|
+
return this.apiClient.callApi(
|
|
13259
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/sync',
|
|
13260
|
+
'POST',
|
|
13261
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13262
|
+
{ },
|
|
13263
|
+
{ },
|
|
13264
|
+
{ },
|
|
13265
|
+
null,
|
|
13266
|
+
['PureCloud OAuth'],
|
|
13267
|
+
['application/json'],
|
|
13268
|
+
['application/json']
|
|
13269
|
+
);
|
|
13270
|
+
}
|
|
13271
|
+
|
|
13272
|
+
/**
|
|
13273
|
+
* Create a new decision table version
|
|
13274
|
+
*
|
|
13275
|
+
* @param {String} tableId Table ID
|
|
13276
|
+
* postBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13277
|
+
*/
|
|
13278
|
+
postBusinessrulesDecisiontableVersions(tableId) {
|
|
13279
|
+
// verify the required parameter 'tableId' is set
|
|
13280
|
+
if (tableId === undefined || tableId === null) {
|
|
13281
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersions';
|
|
13282
|
+
}
|
|
13283
|
+
|
|
13284
|
+
return this.apiClient.callApi(
|
|
13285
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
13286
|
+
'POST',
|
|
13287
|
+
{ 'tableId': tableId },
|
|
13288
|
+
{ },
|
|
13289
|
+
{ },
|
|
13290
|
+
{ },
|
|
13291
|
+
null,
|
|
13292
|
+
['PureCloud OAuth'],
|
|
13293
|
+
['application/json'],
|
|
13294
|
+
['application/json']
|
|
13295
|
+
);
|
|
13296
|
+
}
|
|
13297
|
+
|
|
13298
|
+
/**
|
|
13299
|
+
* Create a decision table
|
|
13300
|
+
*
|
|
13301
|
+
* @param {Object} body Decision Table
|
|
13302
|
+
* postBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13303
|
+
*/
|
|
13304
|
+
postBusinessrulesDecisiontables(body) {
|
|
13305
|
+
// verify the required parameter 'body' is set
|
|
13306
|
+
if (body === undefined || body === null) {
|
|
13307
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontables';
|
|
13308
|
+
}
|
|
13309
|
+
|
|
13310
|
+
return this.apiClient.callApi(
|
|
13311
|
+
'/api/v2/businessrules/decisiontables',
|
|
13312
|
+
'POST',
|
|
13313
|
+
{ },
|
|
13314
|
+
{ },
|
|
13315
|
+
{ },
|
|
13316
|
+
{ },
|
|
13317
|
+
body,
|
|
13318
|
+
['PureCloud OAuth'],
|
|
13319
|
+
['application/json'],
|
|
13320
|
+
['application/json']
|
|
13321
|
+
);
|
|
13322
|
+
}
|
|
13323
|
+
|
|
13324
|
+
/**
|
|
13325
|
+
* Create a schema
|
|
13326
|
+
*
|
|
13327
|
+
* @param {Object} body Schema
|
|
13328
|
+
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13329
|
+
*/
|
|
13330
|
+
postBusinessrulesSchemas(body) {
|
|
13331
|
+
// verify the required parameter 'body' is set
|
|
13332
|
+
if (body === undefined || body === null) {
|
|
13333
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesSchemas';
|
|
13334
|
+
}
|
|
13335
|
+
|
|
13336
|
+
return this.apiClient.callApi(
|
|
13337
|
+
'/api/v2/businessrules/schemas',
|
|
13338
|
+
'POST',
|
|
13339
|
+
{ },
|
|
13340
|
+
{ },
|
|
13341
|
+
{ },
|
|
13342
|
+
{ },
|
|
13343
|
+
body,
|
|
13344
|
+
['PureCloud OAuth'],
|
|
13345
|
+
['application/json'],
|
|
13346
|
+
['application/json']
|
|
13347
|
+
);
|
|
13348
|
+
}
|
|
13349
|
+
|
|
13350
|
+
/**
|
|
13351
|
+
* Publish a decision table version
|
|
13352
|
+
*
|
|
13353
|
+
* @param {String} tableId Table ID
|
|
13354
|
+
* @param {Number} tableVersion Table Version
|
|
13355
|
+
* putBusinessrulesDecisiontableVersionPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13356
|
+
*/
|
|
13357
|
+
putBusinessrulesDecisiontableVersionPublish(tableId, tableVersion) {
|
|
13358
|
+
// verify the required parameter 'tableId' is set
|
|
13359
|
+
if (tableId === undefined || tableId === null) {
|
|
13360
|
+
throw 'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionPublish';
|
|
13361
|
+
}
|
|
13362
|
+
// verify the required parameter 'tableVersion' is set
|
|
13363
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
13364
|
+
throw 'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionPublish';
|
|
13365
|
+
}
|
|
13366
|
+
|
|
13367
|
+
return this.apiClient.callApi(
|
|
13368
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/publish',
|
|
13369
|
+
'PUT',
|
|
13370
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
13371
|
+
{ },
|
|
13372
|
+
{ },
|
|
13373
|
+
{ },
|
|
13374
|
+
null,
|
|
13375
|
+
['PureCloud OAuth'],
|
|
13376
|
+
['application/json'],
|
|
13377
|
+
['application/json']
|
|
13378
|
+
);
|
|
13379
|
+
}
|
|
13380
|
+
|
|
13381
|
+
/**
|
|
13382
|
+
* Update a schema
|
|
13383
|
+
*
|
|
13384
|
+
* @param {String} schemaId Schema ID
|
|
13385
|
+
* @param {Object} body Data Schema
|
|
13386
|
+
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13387
|
+
*/
|
|
13388
|
+
putBusinessrulesSchema(schemaId, body) {
|
|
13389
|
+
// verify the required parameter 'schemaId' is set
|
|
13390
|
+
if (schemaId === undefined || schemaId === null) {
|
|
13391
|
+
throw 'Missing the required parameter "schemaId" when calling putBusinessrulesSchema';
|
|
13392
|
+
}
|
|
13393
|
+
// verify the required parameter 'body' is set
|
|
13394
|
+
if (body === undefined || body === null) {
|
|
13395
|
+
throw 'Missing the required parameter "body" when calling putBusinessrulesSchema';
|
|
13396
|
+
}
|
|
13397
|
+
|
|
13398
|
+
return this.apiClient.callApi(
|
|
13399
|
+
'/api/v2/businessrules/schemas/{schemaId}',
|
|
13400
|
+
'PUT',
|
|
13401
|
+
{ 'schemaId': schemaId },
|
|
13402
|
+
{ },
|
|
13403
|
+
{ },
|
|
13404
|
+
{ },
|
|
13405
|
+
body,
|
|
13406
|
+
['PureCloud OAuth'],
|
|
13407
|
+
['application/json'],
|
|
13408
|
+
['application/json']
|
|
13409
|
+
);
|
|
13410
|
+
}
|
|
13411
|
+
|
|
13412
|
+
}
|
|
13413
|
+
|
|
12324
13414
|
class CarrierServicesApi {
|
|
12325
13415
|
/**
|
|
12326
13416
|
* CarrierServices service.
|
|
12327
13417
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
12328
|
-
* @version
|
|
13418
|
+
* @version 222.0.0
|
|
12329
13419
|
*/
|
|
12330
13420
|
|
|
12331
13421
|
/**
|
|
@@ -12395,7 +13485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12395
13485
|
/**
|
|
12396
13486
|
* Chat service.
|
|
12397
13487
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
12398
|
-
* @version
|
|
13488
|
+
* @version 222.0.0
|
|
12399
13489
|
*/
|
|
12400
13490
|
|
|
12401
13491
|
/**
|
|
@@ -12705,8 +13795,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12705
13795
|
* Get room participants in a room
|
|
12706
13796
|
*
|
|
12707
13797
|
* @param {String} roomJid roomJid
|
|
13798
|
+
* @param {Object} opts Optional parameters
|
|
13799
|
+
* @param {Boolean} opts.notify Whether to get users to notify
|
|
12708
13800
|
*/
|
|
12709
|
-
getChatsRoomParticipants(roomJid) {
|
|
13801
|
+
getChatsRoomParticipants(roomJid, opts) {
|
|
13802
|
+
opts = opts || {};
|
|
13803
|
+
|
|
12710
13804
|
// verify the required parameter 'roomJid' is set
|
|
12711
13805
|
if (roomJid === undefined || roomJid === null) {
|
|
12712
13806
|
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
@@ -12716,7 +13810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12716
13810
|
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
12717
13811
|
'GET',
|
|
12718
13812
|
{ 'roomJid': roomJid },
|
|
12719
|
-
{
|
|
13813
|
+
{ 'notify': opts['notify'] },
|
|
12720
13814
|
{ },
|
|
12721
13815
|
{ },
|
|
12722
13816
|
null,
|
|
@@ -13324,7 +14418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13324
14418
|
/**
|
|
13325
14419
|
* Coaching service.
|
|
13326
14420
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
13327
|
-
* @version
|
|
14421
|
+
* @version 222.0.0
|
|
13328
14422
|
*/
|
|
13329
14423
|
|
|
13330
14424
|
/**
|
|
@@ -13901,7 +14995,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13901
14995
|
/**
|
|
13902
14996
|
* ContentManagement service.
|
|
13903
14997
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13904
|
-
* @version
|
|
14998
|
+
* @version 222.0.0
|
|
13905
14999
|
*/
|
|
13906
15000
|
|
|
13907
15001
|
/**
|
|
@@ -14982,7 +16076,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14982
16076
|
/**
|
|
14983
16077
|
* Conversations service.
|
|
14984
16078
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14985
|
-
* @version
|
|
16079
|
+
* @version 222.0.0
|
|
14986
16080
|
*/
|
|
14987
16081
|
|
|
14988
16082
|
/**
|
|
@@ -16912,7 +18006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16912
18006
|
*
|
|
16913
18007
|
* @param {String} messageId messageId
|
|
16914
18008
|
* @param {Object} opts Optional parameters
|
|
16915
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
18009
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
16916
18010
|
*/
|
|
16917
18011
|
getConversationsMessageDetails(messageId, opts) {
|
|
16918
18012
|
opts = opts || {};
|
|
@@ -16942,7 +18036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16942
18036
|
* @param {String} conversationId conversationId
|
|
16943
18037
|
* @param {String} messageId messageId
|
|
16944
18038
|
* @param {Object} opts Optional parameters
|
|
16945
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
18039
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
16946
18040
|
*/
|
|
16947
18041
|
getConversationsMessageMessage(conversationId, messageId, opts) {
|
|
16948
18042
|
opts = opts || {};
|
|
@@ -17184,11 +18278,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17184
18278
|
);
|
|
17185
18279
|
}
|
|
17186
18280
|
|
|
18281
|
+
/**
|
|
18282
|
+
* Get Apple messaging integration identity resolution settings
|
|
18283
|
+
*
|
|
18284
|
+
* @param {String} integrationId Integration ID
|
|
18285
|
+
* getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18286
|
+
*/
|
|
18287
|
+
getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) {
|
|
18288
|
+
// verify the required parameter 'integrationId' is set
|
|
18289
|
+
if (integrationId === undefined || integrationId === null) {
|
|
18290
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
18291
|
+
}
|
|
18292
|
+
|
|
18293
|
+
return this.apiClient.callApi(
|
|
18294
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}',
|
|
18295
|
+
'GET',
|
|
18296
|
+
{ 'integrationId': integrationId },
|
|
18297
|
+
{ },
|
|
18298
|
+
{ },
|
|
18299
|
+
{ },
|
|
18300
|
+
null,
|
|
18301
|
+
['PureCloud OAuth'],
|
|
18302
|
+
['application/json'],
|
|
18303
|
+
['application/json']
|
|
18304
|
+
);
|
|
18305
|
+
}
|
|
18306
|
+
|
|
17187
18307
|
/**
|
|
17188
18308
|
* Get Facebook messaging integration identity resolution settings
|
|
17189
18309
|
*
|
|
17190
18310
|
* @param {String} integrationId Integration ID
|
|
17191
|
-
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17192
18311
|
*/
|
|
17193
18312
|
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
17194
18313
|
// verify the required parameter 'integrationId' is set
|
|
@@ -17210,11 +18329,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17210
18329
|
);
|
|
17211
18330
|
}
|
|
17212
18331
|
|
|
18332
|
+
/**
|
|
18333
|
+
* Get an Instagram integration identity resolution settings
|
|
18334
|
+
*
|
|
18335
|
+
* @param {String} integrationId Integration ID
|
|
18336
|
+
*/
|
|
18337
|
+
getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId) {
|
|
18338
|
+
// verify the required parameter 'integrationId' is set
|
|
18339
|
+
if (integrationId === undefined || integrationId === null) {
|
|
18340
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
18341
|
+
}
|
|
18342
|
+
|
|
18343
|
+
return this.apiClient.callApi(
|
|
18344
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}',
|
|
18345
|
+
'GET',
|
|
18346
|
+
{ 'integrationId': integrationId },
|
|
18347
|
+
{ },
|
|
18348
|
+
{ },
|
|
18349
|
+
{ },
|
|
18350
|
+
null,
|
|
18351
|
+
['PureCloud OAuth'],
|
|
18352
|
+
['application/json'],
|
|
18353
|
+
['application/json']
|
|
18354
|
+
);
|
|
18355
|
+
}
|
|
18356
|
+
|
|
17213
18357
|
/**
|
|
17214
18358
|
* Get an open messaging integration Identity Resolution settings
|
|
17215
18359
|
*
|
|
17216
18360
|
* @param {String} integrationId Integration ID
|
|
17217
|
-
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17218
18361
|
*/
|
|
17219
18362
|
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
17220
18363
|
// verify the required parameter 'integrationId' is set
|
|
@@ -17240,7 +18383,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17240
18383
|
* Get a whatsApp integration Identity Resolution settings
|
|
17241
18384
|
*
|
|
17242
18385
|
* @param {String} integrationId Integration ID
|
|
17243
|
-
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17244
18386
|
*/
|
|
17245
18387
|
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
17246
18388
|
// verify the required parameter 'integrationId' is set
|
|
@@ -18070,6 +19212,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18070
19212
|
);
|
|
18071
19213
|
}
|
|
18072
19214
|
|
|
19215
|
+
/**
|
|
19216
|
+
* Update agent's engagement for the summary.
|
|
19217
|
+
*
|
|
19218
|
+
* @param {String} conversationId Conversation ID
|
|
19219
|
+
* @param {String} summaryId Summary ID
|
|
19220
|
+
* @param {Object} opts Optional parameters
|
|
19221
|
+
* @param {Object} opts.body
|
|
19222
|
+
*/
|
|
19223
|
+
patchConversationSummaryEngagements(conversationId, summaryId, opts) {
|
|
19224
|
+
opts = opts || {};
|
|
19225
|
+
|
|
19226
|
+
// verify the required parameter 'conversationId' is set
|
|
19227
|
+
if (conversationId === undefined || conversationId === null) {
|
|
19228
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryEngagements';
|
|
19229
|
+
}
|
|
19230
|
+
// verify the required parameter 'summaryId' is set
|
|
19231
|
+
if (summaryId === undefined || summaryId === null) {
|
|
19232
|
+
throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryEngagements';
|
|
19233
|
+
}
|
|
19234
|
+
|
|
19235
|
+
return this.apiClient.callApi(
|
|
19236
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/engagements',
|
|
19237
|
+
'PATCH',
|
|
19238
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
19239
|
+
{ },
|
|
19240
|
+
{ },
|
|
19241
|
+
{ },
|
|
19242
|
+
opts['body'],
|
|
19243
|
+
['PureCloud OAuth'],
|
|
19244
|
+
['application/json'],
|
|
19245
|
+
['application/json']
|
|
19246
|
+
);
|
|
19247
|
+
}
|
|
19248
|
+
|
|
18073
19249
|
/**
|
|
18074
19250
|
* Update the feedback for the summary.
|
|
18075
19251
|
*
|
|
@@ -18077,7 +19253,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18077
19253
|
* @param {String} summaryId Summary ID
|
|
18078
19254
|
* @param {Object} opts Optional parameters
|
|
18079
19255
|
* @param {Object} opts.body
|
|
18080
|
-
* patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18081
19256
|
*/
|
|
18082
19257
|
patchConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
18083
19258
|
opts = opts || {};
|
|
@@ -19267,7 +20442,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19267
20442
|
|
|
19268
20443
|
/**
|
|
19269
20444
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
19270
|
-
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the
|
|
20445
|
+
* 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.
|
|
19271
20446
|
* @param {String} integrationId Integration ID
|
|
19272
20447
|
* @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
|
|
19273
20448
|
*/
|
|
@@ -21116,12 +22291,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21116
22291
|
|
|
21117
22292
|
/**
|
|
21118
22293
|
* Send message
|
|
21119
|
-
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId,
|
|
22294
|
+
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate.
|
|
21120
22295
|
* @param {String} conversationId conversationId
|
|
21121
22296
|
* @param {String} communicationId communicationId
|
|
21122
22297
|
* @param {Object} body Message
|
|
21123
22298
|
* @param {Object} opts Optional parameters
|
|
21124
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
22299
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
21125
22300
|
*/
|
|
21126
22301
|
postConversationsMessageCommunicationMessages(conversationId, communicationId, body, opts) {
|
|
21127
22302
|
opts = opts || {};
|
|
@@ -21353,7 +22528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21353
22528
|
* 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"]
|
|
21354
22529
|
* @param {String} conversationId
|
|
21355
22530
|
* @param {Object} opts Optional parameters
|
|
21356
|
-
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media
|
|
22531
|
+
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
21357
22532
|
* @param {Array.<String>} opts.body messageIds
|
|
21358
22533
|
*/
|
|
21359
22534
|
postConversationsMessageMessagesBulk(conversationId, opts) {
|
|
@@ -22335,12 +23510,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22335
23510
|
);
|
|
22336
23511
|
}
|
|
22337
23512
|
|
|
23513
|
+
/**
|
|
23514
|
+
* Create an identity resolution settings for a Apple messaging integration
|
|
23515
|
+
*
|
|
23516
|
+
* @param {String} integrationId Integration ID
|
|
23517
|
+
* @param {Object} body IdentityResolutionConfig
|
|
23518
|
+
* putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23519
|
+
*/
|
|
23520
|
+
putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) {
|
|
23521
|
+
// verify the required parameter 'integrationId' is set
|
|
23522
|
+
if (integrationId === undefined || integrationId === null) {
|
|
23523
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
23524
|
+
}
|
|
23525
|
+
// verify the required parameter 'body' is set
|
|
23526
|
+
if (body === undefined || body === null) {
|
|
23527
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';
|
|
23528
|
+
}
|
|
23529
|
+
|
|
23530
|
+
return this.apiClient.callApi(
|
|
23531
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}',
|
|
23532
|
+
'PUT',
|
|
23533
|
+
{ 'integrationId': integrationId },
|
|
23534
|
+
{ },
|
|
23535
|
+
{ },
|
|
23536
|
+
{ },
|
|
23537
|
+
body,
|
|
23538
|
+
['PureCloud OAuth'],
|
|
23539
|
+
['application/json'],
|
|
23540
|
+
['application/json']
|
|
23541
|
+
);
|
|
23542
|
+
}
|
|
23543
|
+
|
|
22338
23544
|
/**
|
|
22339
23545
|
* Create an identity resolution settings for a Facebook messaging integration
|
|
22340
23546
|
*
|
|
22341
23547
|
* @param {String} integrationId Integration ID
|
|
22342
23548
|
* @param {Object} body IdentityResolutionConfig
|
|
22343
|
-
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22344
23549
|
*/
|
|
22345
23550
|
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
22346
23551
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22366,12 +23571,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22366
23571
|
);
|
|
22367
23572
|
}
|
|
22368
23573
|
|
|
23574
|
+
/**
|
|
23575
|
+
* Create identity resolution settings for an Instagram messaging integration
|
|
23576
|
+
*
|
|
23577
|
+
* @param {String} integrationId Integration ID
|
|
23578
|
+
* @param {Object} body IdentityResolutionConfig
|
|
23579
|
+
*/
|
|
23580
|
+
putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId(integrationId, body) {
|
|
23581
|
+
// verify the required parameter 'integrationId' is set
|
|
23582
|
+
if (integrationId === undefined || integrationId === null) {
|
|
23583
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
23584
|
+
}
|
|
23585
|
+
// verify the required parameter 'body' is set
|
|
23586
|
+
if (body === undefined || body === null) {
|
|
23587
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsInstagramIntegrationId';
|
|
23588
|
+
}
|
|
23589
|
+
|
|
23590
|
+
return this.apiClient.callApi(
|
|
23591
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}',
|
|
23592
|
+
'PUT',
|
|
23593
|
+
{ 'integrationId': integrationId },
|
|
23594
|
+
{ },
|
|
23595
|
+
{ },
|
|
23596
|
+
{ },
|
|
23597
|
+
body,
|
|
23598
|
+
['PureCloud OAuth'],
|
|
23599
|
+
['application/json'],
|
|
23600
|
+
['application/json']
|
|
23601
|
+
);
|
|
23602
|
+
}
|
|
23603
|
+
|
|
22369
23604
|
/**
|
|
22370
23605
|
* Update an open messaging integration Identity Resolution settings
|
|
22371
23606
|
*
|
|
22372
23607
|
* @param {String} integrationId Integration ID
|
|
22373
23608
|
* @param {Object} body
|
|
22374
|
-
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22375
23609
|
*/
|
|
22376
23610
|
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
22377
23611
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22402,7 +23636,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22402
23636
|
*
|
|
22403
23637
|
* @param {String} integrationId Integration ID
|
|
22404
23638
|
* @param {Object} body
|
|
22405
|
-
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22406
23639
|
*/
|
|
22407
23640
|
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
22408
23641
|
// verify the required parameter 'integrationId' is set
|
|
@@ -22600,7 +23833,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22600
23833
|
/**
|
|
22601
23834
|
* DataExtensions service.
|
|
22602
23835
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
22603
|
-
* @version
|
|
23836
|
+
* @version 222.0.0
|
|
22604
23837
|
*/
|
|
22605
23838
|
|
|
22606
23839
|
/**
|
|
@@ -22686,7 +23919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22686
23919
|
/**
|
|
22687
23920
|
* DataPrivacy service.
|
|
22688
23921
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
22689
|
-
* @version
|
|
23922
|
+
* @version 222.0.0
|
|
22690
23923
|
*/
|
|
22691
23924
|
|
|
22692
23925
|
/**
|
|
@@ -22856,7 +24089,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22856
24089
|
/**
|
|
22857
24090
|
* Downloads service.
|
|
22858
24091
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
22859
|
-
* @version
|
|
24092
|
+
* @version 222.0.0
|
|
22860
24093
|
*/
|
|
22861
24094
|
|
|
22862
24095
|
/**
|
|
@@ -22908,7 +24141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22908
24141
|
/**
|
|
22909
24142
|
* Emails service.
|
|
22910
24143
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
22911
|
-
* @version
|
|
24144
|
+
* @version 222.0.0
|
|
22912
24145
|
*/
|
|
22913
24146
|
|
|
22914
24147
|
/**
|
|
@@ -23037,7 +24270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23037
24270
|
/**
|
|
23038
24271
|
* EmployeeEngagement service.
|
|
23039
24272
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
23040
|
-
* @version
|
|
24273
|
+
* @version 222.0.0
|
|
23041
24274
|
*/
|
|
23042
24275
|
|
|
23043
24276
|
/**
|
|
@@ -23188,7 +24421,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23188
24421
|
/**
|
|
23189
24422
|
* Events service.
|
|
23190
24423
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
23191
|
-
* @version
|
|
24424
|
+
* @version 222.0.0
|
|
23192
24425
|
*/
|
|
23193
24426
|
|
|
23194
24427
|
/**
|
|
@@ -23284,7 +24517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23284
24517
|
/**
|
|
23285
24518
|
* ExternalContacts service.
|
|
23286
24519
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23287
|
-
* @version
|
|
24520
|
+
* @version 222.0.0
|
|
23288
24521
|
*/
|
|
23289
24522
|
|
|
23290
24523
|
/**
|
|
@@ -23920,7 +25153,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23920
25153
|
}
|
|
23921
25154
|
|
|
23922
25155
|
/**
|
|
23923
|
-
* Get
|
|
25156
|
+
* Get a specific named core type.
|
|
23924
25157
|
*
|
|
23925
25158
|
* @param {String} coreTypeName Name of the core type
|
|
23926
25159
|
*/
|
|
@@ -24313,7 +25546,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24313
25546
|
* List the identifiers for an external organization
|
|
24314
25547
|
*
|
|
24315
25548
|
* @param {String} externalOrganizationId External Organization ID
|
|
24316
|
-
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24317
25549
|
*/
|
|
24318
25550
|
getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
|
|
24319
25551
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -24565,7 +25797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24565
25797
|
}
|
|
24566
25798
|
|
|
24567
25799
|
/**
|
|
24568
|
-
* Get
|
|
25800
|
+
* Get a specific named core type.
|
|
24569
25801
|
*
|
|
24570
25802
|
* @param {String} coreTypeName Name of the core type
|
|
24571
25803
|
*/
|
|
@@ -24720,7 +25952,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24720
25952
|
* @param {Object} opts Optional parameters
|
|
24721
25953
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
24722
25954
|
* @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
|
|
24723
|
-
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24724
25955
|
*/
|
|
24725
25956
|
getExternalcontactsScanContactsDivisionviewsAll(opts) {
|
|
24726
25957
|
opts = opts || {};
|
|
@@ -24772,7 +26003,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24772
26003
|
* @param {Object} opts Optional parameters
|
|
24773
26004
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
24774
26005
|
* @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
|
|
24775
|
-
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24776
26006
|
*/
|
|
24777
26007
|
getExternalcontactsScanNotesDivisionviewsAll(opts) {
|
|
24778
26008
|
opts = opts || {};
|
|
@@ -24824,7 +26054,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24824
26054
|
* @param {Object} opts Optional parameters
|
|
24825
26055
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
24826
26056
|
* @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
|
|
24827
|
-
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24828
26057
|
*/
|
|
24829
26058
|
getExternalcontactsScanOrganizationsDivisionviewsAll(opts) {
|
|
24830
26059
|
opts = opts || {};
|
|
@@ -24876,7 +26105,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24876
26105
|
* @param {Object} opts Optional parameters
|
|
24877
26106
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
24878
26107
|
* @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
|
|
24879
|
-
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24880
26108
|
*/
|
|
24881
26109
|
getExternalcontactsScanRelationshipsDivisionviewsAll(opts) {
|
|
24882
26110
|
opts = opts || {};
|
|
@@ -24931,7 +26159,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24931
26159
|
*
|
|
24932
26160
|
* @param {String} externalOrganizationId External Organization ID
|
|
24933
26161
|
* @param {Object} body ClaimRequest
|
|
24934
|
-
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24935
26162
|
*/
|
|
24936
26163
|
patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
|
|
24937
26164
|
// verify the required parameter 'externalOrganizationId' is set
|
|
@@ -25011,7 +26238,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25011
26238
|
* Bulk fetch contacts across divisions
|
|
25012
26239
|
*
|
|
25013
26240
|
* @param {Object} body Contact ids
|
|
25014
|
-
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25015
26241
|
*/
|
|
25016
26242
|
postExternalcontactsBulkContactsDivisionviews(body) {
|
|
25017
26243
|
// verify the required parameter 'body' is set
|
|
@@ -25039,7 +26265,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25039
26265
|
* @param {Object} body Contact Enrich Requests
|
|
25040
26266
|
* @param {Object} opts Optional parameters
|
|
25041
26267
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25042
|
-
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25043
26268
|
*/
|
|
25044
26269
|
postExternalcontactsBulkContactsEnrich(body, opts) {
|
|
25045
26270
|
opts = opts || {};
|
|
@@ -25292,7 +26517,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25292
26517
|
* Bulk fetch organizations across divisions
|
|
25293
26518
|
*
|
|
25294
26519
|
* @param {Object} body Organizations ids
|
|
25295
|
-
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25296
26520
|
*/
|
|
25297
26521
|
postExternalcontactsBulkOrganizationsDivisionviews(body) {
|
|
25298
26522
|
// verify the required parameter 'body' is set
|
|
@@ -25320,7 +26544,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25320
26544
|
* @param {Object} body External Organization Enrich Requests
|
|
25321
26545
|
* @param {Object} opts Optional parameters
|
|
25322
26546
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25323
|
-
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25324
26547
|
*/
|
|
25325
26548
|
postExternalcontactsBulkOrganizationsEnrich(body, opts) {
|
|
25326
26549
|
opts = opts || {};
|
|
@@ -25580,7 +26803,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25580
26803
|
* @param {Object} body ContactEnrichRequest
|
|
25581
26804
|
* @param {Object} opts Optional parameters
|
|
25582
26805
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
25583
|
-
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25584
26806
|
*/
|
|
25585
26807
|
postExternalcontactsContactsEnrich(body, opts) {
|
|
25586
26808
|
opts = opts || {};
|
|
@@ -25633,7 +26855,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25633
26855
|
* Merge up to 25 contacts into a new contact record
|
|
25634
26856
|
* 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.
|
|
25635
26857
|
* @param {Object} body MergeRequest
|
|
25636
|
-
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25637
26858
|
*/
|
|
25638
26859
|
postExternalcontactsContactsMerge(body) {
|
|
25639
26860
|
// verify the required parameter 'body' is set
|
|
@@ -25741,7 +26962,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25741
26962
|
* @param {Object} identifier
|
|
25742
26963
|
* @param {Object} opts Optional parameters
|
|
25743
26964
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25744
|
-
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25745
26965
|
*/
|
|
25746
26966
|
postExternalcontactsIdentifierlookupContacts(identifier, opts) {
|
|
25747
26967
|
opts = opts || {};
|
|
@@ -25771,7 +26991,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25771
26991
|
* @param {Object} identifier
|
|
25772
26992
|
* @param {Object} opts Optional parameters
|
|
25773
26993
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
25774
|
-
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25775
26994
|
*/
|
|
25776
26995
|
postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
|
|
25777
26996
|
opts = opts || {};
|
|
@@ -26007,7 +27226,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26007
27226
|
* @param {Object} body ExternalOrgEnrichRequest
|
|
26008
27227
|
* @param {Object} opts Optional parameters
|
|
26009
27228
|
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
26010
|
-
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26011
27229
|
*/
|
|
26012
27230
|
postExternalcontactsOrganizationsEnrich(body, opts) {
|
|
26013
27231
|
opts = opts || {};
|
|
@@ -26487,7 +27705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26487
27705
|
/**
|
|
26488
27706
|
* Fax service.
|
|
26489
27707
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
26490
|
-
* @version
|
|
27708
|
+
* @version 222.0.0
|
|
26491
27709
|
*/
|
|
26492
27710
|
|
|
26493
27711
|
/**
|
|
@@ -26702,7 +27920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26702
27920
|
/**
|
|
26703
27921
|
* Flows service.
|
|
26704
27922
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
26705
|
-
* @version
|
|
27923
|
+
* @version 222.0.0
|
|
26706
27924
|
*/
|
|
26707
27925
|
|
|
26708
27926
|
/**
|
|
@@ -26885,7 +28103,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26885
28103
|
/**
|
|
26886
28104
|
* Gamification service.
|
|
26887
28105
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
26888
|
-
* @version
|
|
28106
|
+
* @version 222.0.0
|
|
26889
28107
|
*/
|
|
26890
28108
|
|
|
26891
28109
|
/**
|
|
@@ -29392,7 +30610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29392
30610
|
/**
|
|
29393
30611
|
* GeneralDataProtectionRegulation service.
|
|
29394
30612
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
29395
|
-
* @version
|
|
30613
|
+
* @version 222.0.0
|
|
29396
30614
|
*/
|
|
29397
30615
|
|
|
29398
30616
|
/**
|
|
@@ -29522,7 +30740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29522
30740
|
/**
|
|
29523
30741
|
* Geolocation service.
|
|
29524
30742
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
29525
|
-
* @version
|
|
30743
|
+
* @version 222.0.0
|
|
29526
30744
|
*/
|
|
29527
30745
|
|
|
29528
30746
|
/**
|
|
@@ -29653,7 +30871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29653
30871
|
/**
|
|
29654
30872
|
* Greetings service.
|
|
29655
30873
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
29656
|
-
* @version
|
|
30874
|
+
* @version 222.0.0
|
|
29657
30875
|
*/
|
|
29658
30876
|
|
|
29659
30877
|
/**
|
|
@@ -30108,7 +31326,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30108
31326
|
/**
|
|
30109
31327
|
* Groups service.
|
|
30110
31328
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
30111
|
-
* @version
|
|
31329
|
+
* @version 222.0.0
|
|
30112
31330
|
*/
|
|
30113
31331
|
|
|
30114
31332
|
/**
|
|
@@ -30627,7 +31845,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30627
31845
|
/**
|
|
30628
31846
|
* IdentityProvider service.
|
|
30629
31847
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
30630
|
-
* @version
|
|
31848
|
+
* @version 222.0.0
|
|
30631
31849
|
*/
|
|
30632
31850
|
|
|
30633
31851
|
/**
|
|
@@ -31488,7 +32706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31488
32706
|
/**
|
|
31489
32707
|
* InfrastructureAsCode service.
|
|
31490
32708
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
31491
|
-
* @version
|
|
32709
|
+
* @version 222.0.0
|
|
31492
32710
|
*/
|
|
31493
32711
|
|
|
31494
32712
|
/**
|
|
@@ -31655,7 +32873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31655
32873
|
/**
|
|
31656
32874
|
* Integrations service.
|
|
31657
32875
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
31658
|
-
* @version
|
|
32876
|
+
* @version 222.0.0
|
|
31659
32877
|
*/
|
|
31660
32878
|
|
|
31661
32879
|
/**
|
|
@@ -34124,7 +35342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34124
35342
|
/**
|
|
34125
35343
|
* Journey service.
|
|
34126
35344
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
34127
|
-
* @version
|
|
35345
|
+
* @version 222.0.0
|
|
34128
35346
|
*/
|
|
34129
35347
|
|
|
34130
35348
|
/**
|
|
@@ -36109,7 +37327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36109
37327
|
/**
|
|
36110
37328
|
* Knowledge service.
|
|
36111
37329
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
36112
|
-
* @version
|
|
37330
|
+
* @version 222.0.0
|
|
36113
37331
|
*/
|
|
36114
37332
|
|
|
36115
37333
|
/**
|
|
@@ -39982,7 +41200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39982
41200
|
/**
|
|
39983
41201
|
* LanguageUnderstanding service.
|
|
39984
41202
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
39985
|
-
* @version
|
|
41203
|
+
* @version 222.0.0
|
|
39986
41204
|
*/
|
|
39987
41205
|
|
|
39988
41206
|
/**
|
|
@@ -41015,7 +42233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41015
42233
|
/**
|
|
41016
42234
|
* Languages service.
|
|
41017
42235
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
41018
|
-
* @version
|
|
42236
|
+
* @version 222.0.0
|
|
41019
42237
|
*/
|
|
41020
42238
|
|
|
41021
42239
|
/**
|
|
@@ -41237,7 +42455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41237
42455
|
/**
|
|
41238
42456
|
* Learning service.
|
|
41239
42457
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
41240
|
-
* @version
|
|
42458
|
+
* @version 222.0.0
|
|
41241
42459
|
*/
|
|
41242
42460
|
|
|
41243
42461
|
/**
|
|
@@ -42266,7 +43484,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42266
43484
|
/**
|
|
42267
43485
|
* License service.
|
|
42268
43486
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
42269
|
-
* @version
|
|
43487
|
+
* @version 222.0.0
|
|
42270
43488
|
*/
|
|
42271
43489
|
|
|
42272
43490
|
/**
|
|
@@ -42504,7 +43722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42504
43722
|
/**
|
|
42505
43723
|
* Locations service.
|
|
42506
43724
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
42507
|
-
* @version
|
|
43725
|
+
* @version 222.0.0
|
|
42508
43726
|
*/
|
|
42509
43727
|
|
|
42510
43728
|
/**
|
|
@@ -42740,7 +43958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42740
43958
|
/**
|
|
42741
43959
|
* LogCapture service.
|
|
42742
43960
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
42743
|
-
* @version
|
|
43961
|
+
* @version 222.0.0
|
|
42744
43962
|
*/
|
|
42745
43963
|
|
|
42746
43964
|
/**
|
|
@@ -42940,7 +44158,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42940
44158
|
/**
|
|
42941
44159
|
* Messaging service.
|
|
42942
44160
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
42943
|
-
* @version
|
|
44161
|
+
* @version 222.0.0
|
|
42944
44162
|
*/
|
|
42945
44163
|
|
|
42946
44164
|
/**
|
|
@@ -43299,7 +44517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43299
44517
|
/**
|
|
43300
44518
|
* MobileDevices service.
|
|
43301
44519
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
43302
|
-
* @version
|
|
44520
|
+
* @version 222.0.0
|
|
43303
44521
|
*/
|
|
43304
44522
|
|
|
43305
44523
|
/**
|
|
@@ -43450,7 +44668,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43450
44668
|
/**
|
|
43451
44669
|
* Notifications service.
|
|
43452
44670
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
43453
|
-
* @version
|
|
44671
|
+
* @version 222.0.0
|
|
43454
44672
|
*/
|
|
43455
44673
|
|
|
43456
44674
|
/**
|
|
@@ -43683,7 +44901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43683
44901
|
/**
|
|
43684
44902
|
* OAuth service.
|
|
43685
44903
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
43686
|
-
* @version
|
|
44904
|
+
* @version 222.0.0
|
|
43687
44905
|
*/
|
|
43688
44906
|
|
|
43689
44907
|
/**
|
|
@@ -44049,7 +45267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44049
45267
|
/**
|
|
44050
45268
|
* Objects service.
|
|
44051
45269
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
44052
|
-
* @version
|
|
45270
|
+
* @version 222.0.0
|
|
44053
45271
|
*/
|
|
44054
45272
|
|
|
44055
45273
|
/**
|
|
@@ -44373,7 +45591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44373
45591
|
/**
|
|
44374
45592
|
* OperationalEvents service.
|
|
44375
45593
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
44376
|
-
* @version
|
|
45594
|
+
* @version 222.0.0
|
|
44377
45595
|
*/
|
|
44378
45596
|
|
|
44379
45597
|
/**
|
|
@@ -44490,7 +45708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44490
45708
|
/**
|
|
44491
45709
|
* Organization service.
|
|
44492
45710
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
44493
|
-
* @version
|
|
45711
|
+
* @version 222.0.0
|
|
44494
45712
|
*/
|
|
44495
45713
|
|
|
44496
45714
|
/**
|
|
@@ -44965,7 +46183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44965
46183
|
/**
|
|
44966
46184
|
* OrganizationAuthorization service.
|
|
44967
46185
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
44968
|
-
* @version
|
|
46186
|
+
* @version 222.0.0
|
|
44969
46187
|
*/
|
|
44970
46188
|
|
|
44971
46189
|
/**
|
|
@@ -46359,7 +47577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46359
47577
|
/**
|
|
46360
47578
|
* Outbound service.
|
|
46361
47579
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
46362
|
-
* @version
|
|
47580
|
+
* @version 222.0.0
|
|
46363
47581
|
*/
|
|
46364
47582
|
|
|
46365
47583
|
/**
|
|
@@ -50981,7 +52199,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50981
52199
|
/**
|
|
50982
52200
|
* Presence service.
|
|
50983
52201
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
50984
|
-
* @version
|
|
52202
|
+
* @version 222.0.0
|
|
50985
52203
|
*/
|
|
50986
52204
|
|
|
50987
52205
|
/**
|
|
@@ -51725,7 +52943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51725
52943
|
/**
|
|
51726
52944
|
* ProcessAutomation service.
|
|
51727
52945
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
51728
|
-
* @version
|
|
52946
|
+
* @version 222.0.0
|
|
51729
52947
|
*/
|
|
51730
52948
|
|
|
51731
52949
|
/**
|
|
@@ -51964,7 +53182,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51964
53182
|
/**
|
|
51965
53183
|
* Quality service.
|
|
51966
53184
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
51967
|
-
* @version
|
|
53185
|
+
* @version 222.0.0
|
|
51968
53186
|
*/
|
|
51969
53187
|
|
|
51970
53188
|
/**
|
|
@@ -53751,7 +54969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53751
54969
|
/**
|
|
53752
54970
|
* Recording service.
|
|
53753
54971
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
53754
|
-
* @version
|
|
54972
|
+
* @version 222.0.0
|
|
53755
54973
|
*/
|
|
53756
54974
|
|
|
53757
54975
|
/**
|
|
@@ -55356,7 +56574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55356
56574
|
/**
|
|
55357
56575
|
* ResponseManagement service.
|
|
55358
56576
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
55359
|
-
* @version
|
|
56577
|
+
* @version 222.0.0
|
|
55360
56578
|
*/
|
|
55361
56579
|
|
|
55362
56580
|
/**
|
|
@@ -55866,7 +57084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55866
57084
|
/**
|
|
55867
57085
|
* Routing service.
|
|
55868
57086
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
55869
|
-
* @version
|
|
57087
|
+
* @version 222.0.0
|
|
55870
57088
|
*/
|
|
55871
57089
|
|
|
55872
57090
|
/**
|
|
@@ -56682,8 +57900,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56682
57900
|
*
|
|
56683
57901
|
* @param {String} domainName email domain
|
|
56684
57902
|
* @param {String} routeId route ID
|
|
57903
|
+
* @param {Object} opts Optional parameters
|
|
57904
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
56685
57905
|
*/
|
|
56686
|
-
getRoutingEmailDomainRoute(domainName, routeId) {
|
|
57906
|
+
getRoutingEmailDomainRoute(domainName, routeId, opts) {
|
|
57907
|
+
opts = opts || {};
|
|
57908
|
+
|
|
56687
57909
|
// verify the required parameter 'domainName' is set
|
|
56688
57910
|
if (domainName === undefined || domainName === null) {
|
|
56689
57911
|
throw 'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoute';
|
|
@@ -56697,7 +57919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56697
57919
|
'/api/v2/routing/email/domains/{domainName}/routes/{routeId}',
|
|
56698
57920
|
'GET',
|
|
56699
57921
|
{ 'domainName': domainName,'routeId': routeId },
|
|
56700
|
-
{
|
|
57922
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
56701
57923
|
{ },
|
|
56702
57924
|
{ },
|
|
56703
57925
|
null,
|
|
@@ -56712,7 +57934,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56712
57934
|
*
|
|
56713
57935
|
* @param {String} domainName email domain
|
|
56714
57936
|
* @param {String} routeId route ID
|
|
56715
|
-
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56716
57937
|
*/
|
|
56717
57938
|
getRoutingEmailDomainRouteIdentityresolution(domainName, routeId) {
|
|
56718
57939
|
// verify the required parameter 'domainName' is set
|
|
@@ -56746,6 +57967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56746
57967
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
56747
57968
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
56748
57969
|
* @param {String} opts.pattern Filter routes by the route's pattern property
|
|
57970
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
56749
57971
|
*/
|
|
56750
57972
|
getRoutingEmailDomainRoutes(domainName, opts) {
|
|
56751
57973
|
opts = opts || {};
|
|
@@ -56759,7 +57981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56759
57981
|
'/api/v2/routing/email/domains/{domainName}/routes',
|
|
56760
57982
|
'GET',
|
|
56761
57983
|
{ 'domainName': domainName },
|
|
56762
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'pattern': opts['pattern'] },
|
|
57984
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'pattern': opts['pattern'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
56763
57985
|
{ },
|
|
56764
57986
|
{ },
|
|
56765
57987
|
null,
|
|
@@ -57159,8 +58381,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57159
58381
|
* Get details about this queue.
|
|
57160
58382
|
*
|
|
57161
58383
|
* @param {String} queueId Queue ID
|
|
58384
|
+
* @param {Object} opts Optional parameters
|
|
58385
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57162
58386
|
*/
|
|
57163
|
-
getRoutingQueue(queueId) {
|
|
58387
|
+
getRoutingQueue(queueId, opts) {
|
|
58388
|
+
opts = opts || {};
|
|
58389
|
+
|
|
57164
58390
|
// verify the required parameter 'queueId' is set
|
|
57165
58391
|
if (queueId === undefined || queueId === null) {
|
|
57166
58392
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueue';
|
|
@@ -57170,7 +58396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57170
58396
|
'/api/v2/routing/queues/{queueId}',
|
|
57171
58397
|
'GET',
|
|
57172
58398
|
{ 'queueId': queueId },
|
|
57173
|
-
{
|
|
58399
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
57174
58400
|
{ },
|
|
57175
58401
|
{ },
|
|
57176
58402
|
null,
|
|
@@ -57297,7 +58523,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57297
58523
|
* Get Queue IdentityResolution Settings.
|
|
57298
58524
|
*
|
|
57299
58525
|
* @param {String} queueId Queue ID
|
|
57300
|
-
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57301
58526
|
*/
|
|
57302
58527
|
getRoutingQueueIdentityresolution(queueId) {
|
|
57303
58528
|
// verify the required parameter 'queueId' is set
|
|
@@ -57476,6 +58701,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57476
58701
|
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
57477
58702
|
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
57478
58703
|
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
58704
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57479
58705
|
*/
|
|
57480
58706
|
getRoutingQueues(opts) {
|
|
57481
58707
|
opts = opts || {};
|
|
@@ -57485,7 +58711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57485
58711
|
'/api/v2/routing/queues',
|
|
57486
58712
|
'GET',
|
|
57487
58713
|
{ },
|
|
57488
|
-
{ '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'] },
|
|
58714
|
+
{ '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') },
|
|
57489
58715
|
{ },
|
|
57490
58716
|
{ },
|
|
57491
58717
|
null,
|
|
@@ -57895,7 +59121,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57895
59121
|
* Get a SMS identity resolution settings.
|
|
57896
59122
|
*
|
|
57897
59123
|
* @param {String} addressId Address ID
|
|
57898
|
-
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57899
59124
|
*/
|
|
57900
59125
|
getRoutingSmsIdentityresolutionPhonenumber(addressId) {
|
|
57901
59126
|
// verify the required parameter 'addressId' is set
|
|
@@ -57961,6 +59186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57961
59186
|
* @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)
|
|
57962
59187
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
57963
59188
|
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
59189
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
57964
59190
|
*/
|
|
57965
59191
|
getRoutingSmsPhonenumbers(opts) {
|
|
57966
59192
|
opts = opts || {};
|
|
@@ -57970,7 +59196,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57970
59196
|
'/api/v2/routing/sms/phonenumbers',
|
|
57971
59197
|
'GET',
|
|
57972
59198
|
{ },
|
|
57973
|
-
{ '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'] },
|
|
59199
|
+
{ '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') },
|
|
57974
59200
|
{ },
|
|
57975
59201
|
{ },
|
|
57976
59202
|
null,
|
|
@@ -59728,7 +60954,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59728
60954
|
* @param {String} domainName email domain
|
|
59729
60955
|
* @param {String} routeId route ID
|
|
59730
60956
|
* @param {Object} body
|
|
59731
|
-
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59732
60957
|
*/
|
|
59733
60958
|
putRoutingEmailDomainRouteIdentityresolution(domainName, routeId, body) {
|
|
59734
60959
|
// verify the required parameter 'domainName' is set
|
|
@@ -59848,7 +61073,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59848
61073
|
*
|
|
59849
61074
|
* @param {String} queueId Queue ID
|
|
59850
61075
|
* @param {Object} body
|
|
59851
|
-
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59852
61076
|
*/
|
|
59853
61077
|
putRoutingQueueIdentityresolution(queueId, body) {
|
|
59854
61078
|
// verify the required parameter 'queueId' is set
|
|
@@ -59929,7 +61153,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59929
61153
|
*
|
|
59930
61154
|
* @param {String} addressId Address ID
|
|
59931
61155
|
* @param {Object} body
|
|
59932
|
-
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
59933
61156
|
*/
|
|
59934
61157
|
putRoutingSmsIdentityresolutionPhonenumber(addressId, body) {
|
|
59935
61158
|
// verify the required parameter 'addressId' is set
|
|
@@ -60171,7 +61394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60171
61394
|
/**
|
|
60172
61395
|
* SCIM service.
|
|
60173
61396
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
60174
|
-
* @version
|
|
61397
|
+
* @version 222.0.0
|
|
60175
61398
|
*/
|
|
60176
61399
|
|
|
60177
61400
|
/**
|
|
@@ -61048,7 +62271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61048
62271
|
/**
|
|
61049
62272
|
* ScreenRecording service.
|
|
61050
62273
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
61051
|
-
* @version
|
|
62274
|
+
* @version 222.0.0
|
|
61052
62275
|
*/
|
|
61053
62276
|
|
|
61054
62277
|
/**
|
|
@@ -61093,7 +62316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61093
62316
|
/**
|
|
61094
62317
|
* Scripts service.
|
|
61095
62318
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
61096
|
-
* @version
|
|
62319
|
+
* @version 222.0.0
|
|
61097
62320
|
*/
|
|
61098
62321
|
|
|
61099
62322
|
/**
|
|
@@ -61569,7 +62792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61569
62792
|
/**
|
|
61570
62793
|
* Search service.
|
|
61571
62794
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
61572
|
-
* @version
|
|
62795
|
+
* @version 222.0.0
|
|
61573
62796
|
*/
|
|
61574
62797
|
|
|
61575
62798
|
/**
|
|
@@ -62312,7 +63535,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62312
63535
|
/**
|
|
62313
63536
|
* Settings service.
|
|
62314
63537
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
62315
|
-
* @version
|
|
63538
|
+
* @version 222.0.0
|
|
62316
63539
|
*/
|
|
62317
63540
|
|
|
62318
63541
|
/**
|
|
@@ -62347,6 +63570,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62347
63570
|
);
|
|
62348
63571
|
}
|
|
62349
63572
|
|
|
63573
|
+
/**
|
|
63574
|
+
* Delete settings
|
|
63575
|
+
*
|
|
63576
|
+
*/
|
|
63577
|
+
deleteExternalcontactsSettings() {
|
|
63578
|
+
|
|
63579
|
+
return this.apiClient.callApi(
|
|
63580
|
+
'/api/v2/externalcontacts/settings',
|
|
63581
|
+
'DELETE',
|
|
63582
|
+
{ },
|
|
63583
|
+
{ },
|
|
63584
|
+
{ },
|
|
63585
|
+
{ },
|
|
63586
|
+
null,
|
|
63587
|
+
['PureCloud OAuth'],
|
|
63588
|
+
['application/json'],
|
|
63589
|
+
['application/json']
|
|
63590
|
+
);
|
|
63591
|
+
}
|
|
63592
|
+
|
|
62350
63593
|
/**
|
|
62351
63594
|
* Delete agent auto answer settings
|
|
62352
63595
|
*
|
|
@@ -62412,6 +63655,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62412
63655
|
);
|
|
62413
63656
|
}
|
|
62414
63657
|
|
|
63658
|
+
/**
|
|
63659
|
+
* Get settings
|
|
63660
|
+
*
|
|
63661
|
+
*/
|
|
63662
|
+
getExternalcontactsSettings() {
|
|
63663
|
+
|
|
63664
|
+
return this.apiClient.callApi(
|
|
63665
|
+
'/api/v2/externalcontacts/settings',
|
|
63666
|
+
'GET',
|
|
63667
|
+
{ },
|
|
63668
|
+
{ },
|
|
63669
|
+
{ },
|
|
63670
|
+
{ },
|
|
63671
|
+
null,
|
|
63672
|
+
['PureCloud OAuth'],
|
|
63673
|
+
['application/json'],
|
|
63674
|
+
['application/json']
|
|
63675
|
+
);
|
|
63676
|
+
}
|
|
63677
|
+
|
|
62415
63678
|
/**
|
|
62416
63679
|
* Get the execution history enabled setting.
|
|
62417
63680
|
* Get the execution history enabled setting.
|
|
@@ -62560,6 +63823,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62560
63823
|
);
|
|
62561
63824
|
}
|
|
62562
63825
|
|
|
63826
|
+
/**
|
|
63827
|
+
* Set settings
|
|
63828
|
+
*
|
|
63829
|
+
* @param {Object} opts Optional parameters
|
|
63830
|
+
* @param {Object} opts.body
|
|
63831
|
+
*/
|
|
63832
|
+
putExternalcontactsSettings(opts) {
|
|
63833
|
+
opts = opts || {};
|
|
63834
|
+
|
|
63835
|
+
|
|
63836
|
+
return this.apiClient.callApi(
|
|
63837
|
+
'/api/v2/externalcontacts/settings',
|
|
63838
|
+
'PUT',
|
|
63839
|
+
{ },
|
|
63840
|
+
{ },
|
|
63841
|
+
{ },
|
|
63842
|
+
{ },
|
|
63843
|
+
opts['body'],
|
|
63844
|
+
['PureCloud OAuth'],
|
|
63845
|
+
['application/json'],
|
|
63846
|
+
['application/json']
|
|
63847
|
+
);
|
|
63848
|
+
}
|
|
63849
|
+
|
|
62563
63850
|
/**
|
|
62564
63851
|
* Set agent auto answer settings
|
|
62565
63852
|
*
|
|
@@ -62596,7 +63883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62596
63883
|
/**
|
|
62597
63884
|
* SocialMedia service.
|
|
62598
63885
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
62599
|
-
* @version
|
|
63886
|
+
* @version 222.0.0
|
|
62600
63887
|
*/
|
|
62601
63888
|
|
|
62602
63889
|
/**
|
|
@@ -63884,7 +65171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63884
65171
|
/**
|
|
63885
65172
|
* SpeechTextAnalytics service.
|
|
63886
65173
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
63887
|
-
* @version
|
|
65174
|
+
* @version 222.0.0
|
|
63888
65175
|
*/
|
|
63889
65176
|
|
|
63890
65177
|
/**
|
|
@@ -64786,7 +66073,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64786
66073
|
* @param {Object} opts Optional parameters
|
|
64787
66074
|
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
64788
66075
|
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
64789
|
-
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64790
66076
|
*/
|
|
64791
66077
|
getSpeechandtextanalyticsTranslationsLanguageConversation(languageId, conversationId, opts) {
|
|
64792
66078
|
opts = opts || {};
|
|
@@ -64817,7 +66103,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64817
66103
|
/**
|
|
64818
66104
|
* Get supported translation languages
|
|
64819
66105
|
*
|
|
64820
|
-
* getSpeechandtextanalyticsTranslationsLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64821
66106
|
*/
|
|
64822
66107
|
getSpeechandtextanalyticsTranslationsLanguages() {
|
|
64823
66108
|
|
|
@@ -65325,7 +66610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65325
66610
|
/**
|
|
65326
66611
|
* Stations service.
|
|
65327
66612
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
65328
|
-
* @version
|
|
66613
|
+
* @version 222.0.0
|
|
65329
66614
|
*/
|
|
65330
66615
|
|
|
65331
66616
|
/**
|
|
@@ -65427,7 +66712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65427
66712
|
/**
|
|
65428
66713
|
* Suggest service.
|
|
65429
66714
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
65430
|
-
* @version
|
|
66715
|
+
* @version 222.0.0
|
|
65431
66716
|
*/
|
|
65432
66717
|
|
|
65433
66718
|
/**
|
|
@@ -65566,7 +66851,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65566
66851
|
/**
|
|
65567
66852
|
* TaskManagement service.
|
|
65568
66853
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
65569
|
-
* @version
|
|
66854
|
+
* @version 222.0.0
|
|
65570
66855
|
*/
|
|
65571
66856
|
|
|
65572
66857
|
/**
|
|
@@ -66436,7 +67721,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66436
67721
|
}
|
|
66437
67722
|
|
|
66438
67723
|
/**
|
|
66439
|
-
* Get
|
|
67724
|
+
* Get a specific named core type.
|
|
66440
67725
|
*
|
|
66441
67726
|
* @param {String} coreTypeName Name of the core type
|
|
66442
67727
|
*/
|
|
@@ -67728,7 +69013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67728
69013
|
/**
|
|
67729
69014
|
* Teams service.
|
|
67730
69015
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
67731
|
-
* @version
|
|
69016
|
+
* @version 222.0.0
|
|
67732
69017
|
*/
|
|
67733
69018
|
|
|
67734
69019
|
/**
|
|
@@ -68033,7 +69318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68033
69318
|
/**
|
|
68034
69319
|
* Telephony service.
|
|
68035
69320
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
68036
|
-
* @version
|
|
69321
|
+
* @version 222.0.0
|
|
68037
69322
|
*/
|
|
68038
69323
|
|
|
68039
69324
|
/**
|
|
@@ -68215,7 +69500,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68215
69500
|
/**
|
|
68216
69501
|
* TelephonyProvidersEdge service.
|
|
68217
69502
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
68218
|
-
* @version
|
|
69503
|
+
* @version 222.0.0
|
|
68219
69504
|
*/
|
|
68220
69505
|
|
|
68221
69506
|
/**
|
|
@@ -71667,7 +72952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71667
72952
|
/**
|
|
71668
72953
|
* Textbots service.
|
|
71669
72954
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
71670
|
-
* @version
|
|
72955
|
+
* @version 222.0.0
|
|
71671
72956
|
*/
|
|
71672
72957
|
|
|
71673
72958
|
/**
|
|
@@ -71689,6 +72974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71689
72974
|
* @param {Array.<String>} opts.botType Bot types
|
|
71690
72975
|
* @param {String} opts.botName Bot name
|
|
71691
72976
|
* @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
|
|
72977
|
+
* @param {Boolean} opts.virtualAgentEnabled Include or exclude virtual agent flows, only applies to GenesysBotFlows or GenesysDigitalBotFlows
|
|
71692
72978
|
* @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
|
|
71693
72979
|
*/
|
|
71694
72980
|
getTextbotsBotsSearch(opts) {
|
|
@@ -71699,7 +72985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71699
72985
|
'/api/v2/textbots/bots/search',
|
|
71700
72986
|
'GET',
|
|
71701
72987
|
{ },
|
|
71702
|
-
{ 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
|
|
72988
|
+
{ 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'virtualAgentEnabled': opts['virtualAgentEnabled'],'pageSize': opts['pageSize'] },
|
|
71703
72989
|
{ },
|
|
71704
72990
|
{ },
|
|
71705
72991
|
null,
|
|
@@ -71795,7 +73081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71795
73081
|
/**
|
|
71796
73082
|
* Tokens service.
|
|
71797
73083
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
71798
|
-
* @version
|
|
73084
|
+
* @version 222.0.0
|
|
71799
73085
|
*/
|
|
71800
73086
|
|
|
71801
73087
|
/**
|
|
@@ -71949,7 +73235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71949
73235
|
/**
|
|
71950
73236
|
* Uploads service.
|
|
71951
73237
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
71952
|
-
* @version
|
|
73238
|
+
* @version 222.0.0
|
|
71953
73239
|
*/
|
|
71954
73240
|
|
|
71955
73241
|
/**
|
|
@@ -72240,7 +73526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72240
73526
|
/**
|
|
72241
73527
|
* Usage service.
|
|
72242
73528
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
72243
|
-
* @version
|
|
73529
|
+
* @version 222.0.0
|
|
72244
73530
|
*/
|
|
72245
73531
|
|
|
72246
73532
|
/**
|
|
@@ -72455,7 +73741,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72455
73741
|
/**
|
|
72456
73742
|
* UserRecordings service.
|
|
72457
73743
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
72458
|
-
* @version
|
|
73744
|
+
* @version 222.0.0
|
|
72459
73745
|
*/
|
|
72460
73746
|
|
|
72461
73747
|
/**
|
|
@@ -72670,7 +73956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72670
73956
|
/**
|
|
72671
73957
|
* Users service.
|
|
72672
73958
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
72673
|
-
* @version
|
|
73959
|
+
* @version 222.0.0
|
|
72674
73960
|
*/
|
|
72675
73961
|
|
|
72676
73962
|
/**
|
|
@@ -75623,7 +76909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75623
76909
|
/**
|
|
75624
76910
|
* Utilities service.
|
|
75625
76911
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
75626
|
-
* @version
|
|
76912
|
+
* @version 222.0.0
|
|
75627
76913
|
*/
|
|
75628
76914
|
|
|
75629
76915
|
/**
|
|
@@ -75734,7 +77020,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75734
77020
|
/**
|
|
75735
77021
|
* Voicemail service.
|
|
75736
77022
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
75737
|
-
* @version
|
|
77023
|
+
* @version 222.0.0
|
|
75738
77024
|
*/
|
|
75739
77025
|
|
|
75740
77026
|
/**
|
|
@@ -76456,7 +77742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76456
77742
|
/**
|
|
76457
77743
|
* WebChat service.
|
|
76458
77744
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
76459
|
-
* @version
|
|
77745
|
+
* @version 222.0.0
|
|
76460
77746
|
*/
|
|
76461
77747
|
|
|
76462
77748
|
/**
|
|
@@ -77016,7 +78302,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77016
78302
|
/**
|
|
77017
78303
|
* WebDeployments service.
|
|
77018
78304
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
77019
|
-
* @version
|
|
78305
|
+
* @version 222.0.0
|
|
77020
78306
|
*/
|
|
77021
78307
|
|
|
77022
78308
|
/**
|
|
@@ -77333,7 +78619,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77333
78619
|
* Get a deployment identity resolution setting.
|
|
77334
78620
|
*
|
|
77335
78621
|
* @param {String} deploymentId The deployment ID
|
|
77336
|
-
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
77337
78622
|
*/
|
|
77338
78623
|
getWebdeploymentsDeploymentIdentityresolution(deploymentId) {
|
|
77339
78624
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -77568,7 +78853,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77568
78853
|
*
|
|
77569
78854
|
* @param {String} deploymentId The deployment ID
|
|
77570
78855
|
* @param {Object} body
|
|
77571
|
-
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
77572
78856
|
*/
|
|
77573
78857
|
putWebdeploymentsDeploymentIdentityresolution(deploymentId, body) {
|
|
77574
78858
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -77600,7 +78884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77600
78884
|
/**
|
|
77601
78885
|
* WebMessaging service.
|
|
77602
78886
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
77603
|
-
* @version
|
|
78887
|
+
* @version 222.0.0
|
|
77604
78888
|
*/
|
|
77605
78889
|
|
|
77606
78890
|
/**
|
|
@@ -77646,7 +78930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77646
78930
|
/**
|
|
77647
78931
|
* Widgets service.
|
|
77648
78932
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
77649
|
-
* @version
|
|
78933
|
+
* @version 222.0.0
|
|
77650
78934
|
*/
|
|
77651
78935
|
|
|
77652
78936
|
/**
|
|
@@ -77797,7 +79081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77797
79081
|
/**
|
|
77798
79082
|
* WorkforceManagement service.
|
|
77799
79083
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
77800
|
-
* @version
|
|
79084
|
+
* @version 222.0.0
|
|
77801
79085
|
*/
|
|
77802
79086
|
|
|
77803
79087
|
/**
|
|
@@ -80996,6 +82280,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80996
82280
|
* @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
|
|
80997
82281
|
* @param {Object} opts Optional parameters
|
|
80998
82282
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
82283
|
+
* @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)
|
|
80999
82284
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
81000
82285
|
*/
|
|
81001
82286
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
@@ -81014,7 +82299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81014
82299
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
|
|
81015
82300
|
'GET',
|
|
81016
82301
|
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
81017
|
-
{ 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
|
|
82302
|
+
{ 'evaluateMatches': opts['evaluateMatches'],'includeCrossWeekShifts': opts['includeCrossWeekShifts'],'forceDownloadService': opts['forceDownloadService'] },
|
|
81018
82303
|
{ },
|
|
81019
82304
|
{ },
|
|
81020
82305
|
null,
|
|
@@ -85192,7 +86477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85192
86477
|
* </pre>
|
|
85193
86478
|
* </p>
|
|
85194
86479
|
* @module purecloud-platform-client-v2/index
|
|
85195
|
-
* @version
|
|
86480
|
+
* @version 222.0.0
|
|
85196
86481
|
*/
|
|
85197
86482
|
class platformClient {
|
|
85198
86483
|
constructor() {
|
|
@@ -85251,6 +86536,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85251
86536
|
* @property {module:purecloud-platform-client-v2/api/BillingApi}
|
|
85252
86537
|
*/
|
|
85253
86538
|
this.BillingApi = BillingApi;
|
|
86539
|
+
/**
|
|
86540
|
+
* The BusinessRulesApi service constructor.
|
|
86541
|
+
* @property {module:purecloud-platform-client-v2/api/BusinessRulesApi}
|
|
86542
|
+
*/
|
|
86543
|
+
this.BusinessRulesApi = BusinessRulesApi;
|
|
85254
86544
|
/**
|
|
85255
86545
|
* The CarrierServicesApi service constructor.
|
|
85256
86546
|
* @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
|