purecloud-platform-client-v2 189.1.0 → 190.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.js +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +300 -112
- package/dist/web-cjs/purecloud-platform-client-v2.js +301 -115
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +822 -453
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +86 -20
- 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 +13 -8
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -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 +2 -2
- 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 +22 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -7
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +516 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5018,9 +5018,7 @@ var gOPD = require('gopd');
|
|
|
5018
5018
|
var $TypeError = require('es-errors/type');
|
|
5019
5019
|
var $floor = GetIntrinsic('%Math.floor%');
|
|
5020
5020
|
|
|
5021
|
-
/** @
|
|
5022
|
-
|
|
5023
|
-
/** @type {<T extends Func = Func>(fn: T, length: number, loose?: boolean) => T} */
|
|
5021
|
+
/** @type {import('.')} */
|
|
5024
5022
|
module.exports = function setFunctionLength(fn, length) {
|
|
5025
5023
|
if (typeof fn !== 'function') {
|
|
5026
5024
|
throw new $TypeError('`fn` is not a function');
|
|
@@ -5909,7 +5907,7 @@ request.send(requestData||null);});};var knownAdapters={http:httpAdapter,xhr:xhr
|
|
|
5909
5907
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
5910
5908
|
config.data=transformData.call(config,config.transformRequest);if(['post','put','patch'].indexOf(config.method)!==-1){config.headers.setContentType('application/x-www-form-urlencoded',false);}var adapter=adapters.getAdapter(config.adapter||defaults$1.adapter);return adapter(config).then(function onAdapterResolution(response){throwIfCancellationRequested(config);// Transform response data
|
|
5911
5909
|
response.data=transformData.call(config,config.transformResponse,response);response.headers=AxiosHeaders$1.from(response.headers);return response;},function onAdapterRejection(reason){if(!isCancel(reason)){throwIfCancellationRequested(config);// Transform response data
|
|
5912
|
-
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var headersToObject=function headersToObject(thing){return thing instanceof AxiosHeaders$1?thing
|
|
5910
|
+
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var headersToObject=function headersToObject(thing){return thing instanceof AxiosHeaders$1?_objectSpread({},thing):thing;};/**
|
|
5913
5911
|
* Config-specific merge-function which creates a new config-object
|
|
5914
5912
|
* by merging two configuration objects together.
|
|
5915
5913
|
*
|
|
@@ -5922,7 +5920,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,caseless
|
|
|
5922
5920
|
function mergeDeepProperties(a,b,caseless){if(!utils$1.isUndefined(b)){return getMergedValue(a,b,caseless);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a,caseless);}}// eslint-disable-next-line consistent-return
|
|
5923
5921
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
5924
5922
|
function defaultToConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a);}}// eslint-disable-next-line consistent-return
|
|
5925
|
-
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.
|
|
5923
|
+
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.8";var validators$1={};// eslint-disable-next-line func-names
|
|
5926
5924
|
['object','boolean','number','function','string','symbol'].forEach(function(type,i){validators$1[type]=function validator(thing){return _typeof(thing)===type||'a'+(i<1?'n ':' ')+type;};});var deprecatedWarnings={};/**
|
|
5927
5925
|
* Transitional option validator
|
|
5928
5926
|
*
|
|
@@ -6035,7 +6033,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6035
6033
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6036
6034
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);return Configuration;}();/**
|
|
6037
6035
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6038
|
-
* @version
|
|
6036
|
+
* @version 190.0.0
|
|
6039
6037
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6040
6038
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6041
6039
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6347,7 +6345,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6347
6345
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);return ApiClient;}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
6348
6346
|
* Alerting service.
|
|
6349
6347
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6350
|
-
* @version
|
|
6348
|
+
* @version 190.0.0
|
|
6351
6349
|
*/ /**
|
|
6352
6350
|
* Constructs a new AlertingApi.
|
|
6353
6351
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6504,7 +6502,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6504
6502
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AlertingApi;}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
6505
6503
|
* Analytics service.
|
|
6506
6504
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6507
|
-
* @version
|
|
6505
|
+
* @version 190.0.0
|
|
6508
6506
|
*/ /**
|
|
6509
6507
|
* Constructs a new AnalyticsApi.
|
|
6510
6508
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7114,7 +7112,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
7114
7112
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';}return this.apiClient.callApi('/api/v2/analytics/reporting/schedules/{scheduleId}','PUT',{'scheduleId':scheduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AnalyticsApi;}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
7115
7113
|
* Architect service.
|
|
7116
7114
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7117
|
-
* @version
|
|
7115
|
+
* @version 190.0.0
|
|
7118
7116
|
*/ /**
|
|
7119
7117
|
* Constructs a new ArchitectApi.
|
|
7120
7118
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8230,7 +8228,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8230
8228
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ArchitectApi;}();var AuditApi=/*#__PURE__*/function(){/**
|
|
8231
8229
|
* Audit service.
|
|
8232
8230
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8233
|
-
* @version
|
|
8231
|
+
* @version 190.0.0
|
|
8234
8232
|
*/ /**
|
|
8235
8233
|
* Constructs a new AuditApi.
|
|
8236
8234
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8272,7 +8270,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8272
8270
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtime';}return this.apiClient.callApi('/api/v2/audits/query/realtime','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AuditApi;}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
8273
8271
|
* Authorization service.
|
|
8274
8272
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8275
|
-
* @version
|
|
8273
|
+
* @version 190.0.0
|
|
8276
8274
|
*/ /**
|
|
8277
8275
|
* Constructs a new AuthorizationApi.
|
|
8278
8276
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8583,7 +8581,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8583
8581
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AuthorizationApi;}();var BillingApi=/*#__PURE__*/function(){/**
|
|
8584
8582
|
* Billing service.
|
|
8585
8583
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8586
|
-
* @version
|
|
8584
|
+
* @version 190.0.0
|
|
8587
8585
|
*/ /**
|
|
8588
8586
|
* Constructs a new BillingApi.
|
|
8589
8587
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8607,7 +8605,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8607
8605
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return BillingApi;}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
8608
8606
|
* CarrierServices service.
|
|
8609
8607
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8610
|
-
* @version
|
|
8608
|
+
* @version 190.0.0
|
|
8611
8609
|
*/ /**
|
|
8612
8610
|
* Constructs a new CarrierServicesApi.
|
|
8613
8611
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8627,7 +8625,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8627
8625
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return CarrierServicesApi;}();var ChatApi=/*#__PURE__*/function(){/**
|
|
8628
8626
|
* Chat service.
|
|
8629
8627
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8630
|
-
* @version
|
|
8628
|
+
* @version 190.0.0
|
|
8631
8629
|
*/ /**
|
|
8632
8630
|
* Constructs a new ChatApi.
|
|
8633
8631
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8639,7 +8637,6 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8639
8637
|
*
|
|
8640
8638
|
* @param {String} roomJid roomId
|
|
8641
8639
|
* @param {String} messageId messageId
|
|
8642
|
-
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8643
8640
|
*/_createClass(ChatApi,[{key:"deleteChatsRoomMessage",value:function deleteChatsRoomMessage(roomJid,messageId){// verify the required parameter 'roomJid' is set
|
|
8644
8641
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
8645
8642
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling deleteChatsRoomMessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/{messageId}','DELETE',{'roomJid':roomJid,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8647,7 +8644,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
8647
8644
|
*
|
|
8648
8645
|
* @param {String} roomJid roomJid
|
|
8649
8646
|
* @param {String} userId userId
|
|
8650
|
-
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8651
8647
|
*/},{key:"deleteChatsRoomParticipant",value:function deleteChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
8652
8648
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
8653
8649
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{userId}','DELETE',{'roomJid':roomJid,'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8655,7 +8651,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
8655
8651
|
*
|
|
8656
8652
|
* @param {String} roomJid roomJid
|
|
8657
8653
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
8658
|
-
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8659
8654
|
*/},{key:"deleteChatsRoomPinnedmessage",value:function deleteChatsRoomPinnedmessage(roomJid,pinnedMessageId){// verify the required parameter 'roomJid' is set
|
|
8660
8655
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';}// verify the required parameter 'pinnedMessageId' is set
|
|
8661
8656
|
if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomPinnedmessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/pinnedmessages/{pinnedMessageId}','DELETE',{'roomJid':roomJid,'pinnedMessageId':pinnedMessageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8663,27 +8658,23 @@ if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the requir
|
|
|
8663
8658
|
*
|
|
8664
8659
|
* @param {String} userId userId
|
|
8665
8660
|
* @param {String} messageId messageId
|
|
8666
|
-
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8667
8661
|
*/},{key:"deleteChatsUserMessage",value:function deleteChatsUserMessage(userId,messageId){// verify the required parameter 'userId' is set
|
|
8668
8662
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
8669
8663
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling deleteChatsUserMessage';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/{messageId}','DELETE',{'userId':userId,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8670
8664
|
* Get a message
|
|
8671
8665
|
*
|
|
8672
8666
|
* @param {String} messageId messageId
|
|
8673
|
-
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8674
8667
|
*/},{key:"getChatsMessage",value:function getChatsMessage(messageId){// verify the required parameter 'messageId' is set
|
|
8675
8668
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling getChatsMessage';}return this.apiClient.callApi('/api/v2/chats/messages/{messageId}','GET',{'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8676
8669
|
* Get a room
|
|
8677
8670
|
*
|
|
8678
8671
|
* @param {String} roomJid roomJid
|
|
8679
|
-
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8680
8672
|
*/},{key:"getChatsRoom",value:function getChatsRoom(roomJid){// verify the required parameter 'roomJid' is set
|
|
8681
8673
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoom';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}','GET',{'roomJid':roomJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8682
8674
|
* Get messages by id(s) from a room
|
|
8683
8675
|
*
|
|
8684
8676
|
* @param {String} roomJid roomJid
|
|
8685
8677
|
* @param {String} messageIds messageIds, comma separated
|
|
8686
|
-
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8687
8678
|
*/},{key:"getChatsRoomMessage",value:function getChatsRoomMessage(roomJid,messageIds){// verify the required parameter 'roomJid' is set
|
|
8688
8679
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomMessage';}// verify the required parameter 'messageIds' is set
|
|
8689
8680
|
if(messageIds===undefined||messageIds===null){throw'Missing the required parameter "messageIds" when calling getChatsRoomMessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/{messageIds}','GET',{'roomJid':roomJid,'messageIds':messageIds},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8694,9 +8685,20 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
8694
8685
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8695
8686
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8696
8687
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8697
|
-
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8698
8688
|
*/},{key:"getChatsRoomMessages",value:function getChatsRoomMessages(roomJid,opts){opts=opts||{};// verify the required parameter 'roomJid' is set
|
|
8699
8689
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomMessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages','GET',{'roomJid':roomJid},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8690
|
+
* Get a room participant
|
|
8691
|
+
*
|
|
8692
|
+
* @param {String} roomJid roomJid
|
|
8693
|
+
* @param {String} participantJid participantJid
|
|
8694
|
+
*/},{key:"getChatsRoomParticipant",value:function getChatsRoomParticipant(roomJid,participantJid){// verify the required parameter 'roomJid' is set
|
|
8695
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';}// verify the required parameter 'participantJid' is set
|
|
8696
|
+
if(participantJid===undefined||participantJid===null){throw'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{participantJid}','GET',{'roomJid':roomJid,'participantJid':participantJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8697
|
+
* Get room participants in a room
|
|
8698
|
+
*
|
|
8699
|
+
* @param {String} roomJid roomJid
|
|
8700
|
+
*/},{key:"getChatsRoomParticipants",value:function getChatsRoomParticipants(roomJid){// verify the required parameter 'roomJid' is set
|
|
8701
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants','GET',{'roomJid':roomJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8700
8702
|
* Get Chat Settings.
|
|
8701
8703
|
*
|
|
8702
8704
|
*/},{key:"getChatsSettings",value:function getChatsSettings(){return this.apiClient.callApi('/api/v2/chats/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8707,14 +8709,12 @@ if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "ro
|
|
|
8707
8709
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8708
8710
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8709
8711
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8710
|
-
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8711
8712
|
*/},{key:"getChatsThreadMessages",value:function getChatsThreadMessages(threadId,opts){opts=opts||{};// verify the required parameter 'threadId' is set
|
|
8712
8713
|
if(threadId===undefined||threadId===null){throw'Missing the required parameter "threadId" when calling getChatsThreadMessages';}return this.apiClient.callApi('/api/v2/chats/threads/{threadId}/messages','GET',{'threadId':threadId},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8713
8714
|
* Get messages by id(s) from a 1on1
|
|
8714
8715
|
*
|
|
8715
8716
|
* @param {String} userId userId
|
|
8716
8717
|
* @param {String} messageIds messageIds, comma separated
|
|
8717
|
-
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8718
8718
|
*/},{key:"getChatsUserMessage",value:function getChatsUserMessage(userId,messageIds){// verify the required parameter 'userId' is set
|
|
8719
8719
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserMessage';}// verify the required parameter 'messageIds' is set
|
|
8720
8720
|
if(messageIds===undefined||messageIds===null){throw'Missing the required parameter "messageIds" when calling getChatsUserMessage';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/{messageIds}','GET',{'userId':userId,'messageIds':messageIds},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8725,7 +8725,6 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
8725
8725
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8726
8726
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8727
8727
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8728
|
-
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8729
8728
|
*/},{key:"getChatsUserMessages",value:function getChatsUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
8730
8729
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserMessages';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages','GET',{'userId':userId},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8731
8730
|
* Get a user's chat settings
|
|
@@ -8738,7 +8737,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
8738
8737
|
*
|
|
8739
8738
|
* @param {String} roomJid roomJid
|
|
8740
8739
|
* @param {Object} body Room properties
|
|
8741
|
-
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8742
8740
|
*/},{key:"patchChatsRoom",value:function patchChatsRoom(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8743
8741
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling patchChatsRoom';}// verify the required parameter 'body' is set
|
|
8744
8742
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchChatsRoom';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}','PATCH',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8747,7 +8745,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8747
8745
|
* @param {String} roomJid roomId
|
|
8748
8746
|
* @param {String} messageId messageId
|
|
8749
8747
|
* @param {Object} body messageBody
|
|
8750
|
-
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8751
8748
|
*/},{key:"patchChatsRoomMessage",value:function patchChatsRoomMessage(roomJid,messageId,body){// verify the required parameter 'roomJid' is set
|
|
8752
8749
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling patchChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
8753
8750
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsRoomMessage';}// verify the required parameter 'body' is set
|
|
@@ -8762,7 +8759,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8762
8759
|
* @param {String} userId userId
|
|
8763
8760
|
* @param {String} messageId messageId
|
|
8764
8761
|
* @param {Object} body message body
|
|
8765
|
-
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8766
8762
|
*/},{key:"patchChatsUserMessage",value:function patchChatsUserMessage(userId,messageId,body){// verify the required parameter 'userId' is set
|
|
8767
8763
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
8768
8764
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsUserMessage';}// verify the required parameter 'body' is set
|
|
@@ -8779,7 +8775,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8779
8775
|
*
|
|
8780
8776
|
* @param {String} roomJid roomId
|
|
8781
8777
|
* @param {Object} body messageBody
|
|
8782
|
-
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8783
8778
|
*/},{key:"postChatsRoomMessages",value:function postChatsRoomMessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8784
8779
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomMessages';}// verify the required parameter 'body' is set
|
|
8785
8780
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRoomMessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages','POST',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8787,7 +8782,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8787
8782
|
*
|
|
8788
8783
|
* @param {String} roomJid roomJid
|
|
8789
8784
|
* @param {String} userId userId
|
|
8790
|
-
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8791
8785
|
*/},{key:"postChatsRoomParticipant",value:function postChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
8792
8786
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
8793
8787
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{userId}','POST',{'roomJid':roomJid,'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8795,24 +8789,28 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
8795
8789
|
*
|
|
8796
8790
|
* @param {String} roomJid roomJid
|
|
8797
8791
|
* @param {Object} body Pinned Message Ids
|
|
8798
|
-
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8799
8792
|
*/},{key:"postChatsRoomPinnedmessages",value:function postChatsRoomPinnedmessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
8800
8793
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';}// verify the required parameter 'body' is set
|
|
8801
8794
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRoomPinnedmessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/pinnedmessages','POST',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8802
8795
|
* Create an adhoc room
|
|
8803
8796
|
*
|
|
8804
8797
|
* @param {Object} body Room properties
|
|
8805
|
-
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8806
8798
|
*/},{key:"postChatsRooms",value:function postChatsRooms(body){// verify the required parameter 'body' is set
|
|
8807
8799
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRooms';}return this.apiClient.callApi('/api/v2/chats/rooms','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8808
8800
|
* Send a message to a user
|
|
8809
8801
|
*
|
|
8810
8802
|
* @param {String} userId userId
|
|
8811
8803
|
* @param {Object} body message body
|
|
8812
|
-
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8813
8804
|
*/},{key:"postChatsUserMessages",value:function postChatsUserMessages(userId,body){// verify the required parameter 'userId' is set
|
|
8814
8805
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessages';}// verify the required parameter 'body' is set
|
|
8815
8806
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsUserMessages';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8807
|
+
* Update reactions to a message
|
|
8808
|
+
*
|
|
8809
|
+
* @param {String} messageId messageId
|
|
8810
|
+
* @param {Object} body reactionUpdate
|
|
8811
|
+
*/},{key:"putChatsMessageReactions",value:function putChatsMessageReactions(messageId,body){// verify the required parameter 'messageId' is set
|
|
8812
|
+
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling putChatsMessageReactions';}// verify the required parameter 'body' is set
|
|
8813
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsMessageReactions';}return this.apiClient.callApi('/api/v2/chats/messages/{messageId}/reactions','PUT',{'messageId':messageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8816
8814
|
* Update Chat Settings.
|
|
8817
8815
|
*
|
|
8818
8816
|
* @param {Object} body Chat
|
|
@@ -8820,7 +8818,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8820
8818
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ChatApi;}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
8821
8819
|
* Coaching service.
|
|
8822
8820
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8823
|
-
* @version
|
|
8821
|
+
* @version 190.0.0
|
|
8824
8822
|
*/ /**
|
|
8825
8823
|
* Constructs a new CoachingApi.
|
|
8826
8824
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -8973,7 +8971,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8973
8971
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return CoachingApi;}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
8974
8972
|
* ContentManagement service.
|
|
8975
8973
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8976
|
-
* @version
|
|
8974
|
+
* @version 190.0.0
|
|
8977
8975
|
*/ /**
|
|
8978
8976
|
* Constructs a new ContentManagementApi.
|
|
8979
8977
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9256,7 +9254,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9256
9254
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ContentManagementApi;}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
9257
9255
|
* Conversations service.
|
|
9258
9256
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9259
|
-
* @version
|
|
9257
|
+
* @version 190.0.0
|
|
9260
9258
|
*/ /**
|
|
9261
9259
|
* Constructs a new ConversationsApi.
|
|
9262
9260
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -9326,8 +9324,9 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
9326
9324
|
*/},{key:"deleteConversationsMessagingIntegrationsOpenIntegrationId",value:function deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
9327
9325
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9328
9326
|
* Delete a Twitter messaging integration
|
|
9329
|
-
*
|
|
9327
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
9330
9328
|
* @param {String} integrationId Integration ID
|
|
9329
|
+
* @deprecated
|
|
9331
9330
|
*/},{key:"deleteConversationsMessagingIntegrationsTwitterIntegrationId",value:function deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
9332
9331
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9333
9332
|
* Delete a WhatsApp messaging integration
|
|
@@ -9818,20 +9817,22 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
9818
9817
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
9819
9818
|
*/},{key:"getConversationsMessagingIntegrationsOpenIntegrationId",value:function getConversationsMessagingIntegrationsOpenIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
9820
9819
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9821
|
-
* Get a list of Twitter Integrations
|
|
9822
|
-
*
|
|
9820
|
+
* Get a list of Twitter Integrations (Deprecated)
|
|
9821
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
9823
9822
|
* @param {Object} opts Optional parameters
|
|
9824
9823
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
9825
9824
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
9826
9825
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
9827
9826
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
9828
9827
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
9828
|
+
* @deprecated
|
|
9829
9829
|
*/},{key:"getConversationsMessagingIntegrationsTwitter",value:function getConversationsMessagingIntegrationsTwitter(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':opts['expand'],'supportedContent.id':opts['supportedContentId'],'messagingSetting.id':opts['messagingSettingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9830
|
-
* Get a Twitter messaging integration
|
|
9831
|
-
*
|
|
9830
|
+
* Get a Twitter messaging integration (Deprecated)
|
|
9831
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
9832
9832
|
* @param {String} integrationId Integration ID
|
|
9833
9833
|
* @param {Object} opts Optional parameters
|
|
9834
9834
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
9835
|
+
* @deprecated
|
|
9835
9836
|
*/},{key:"getConversationsMessagingIntegrationsTwitterIntegrationId",value:function getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
9836
9837
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9837
9838
|
* Get a list of WhatsApp Integrations
|
|
@@ -10234,9 +10235,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10234
10235
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
10235
10236
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10236
10237
|
* Update Twitter messaging integration
|
|
10237
|
-
*
|
|
10238
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
10238
10239
|
* @param {String} integrationId Integration ID
|
|
10239
10240
|
* @param {Object} body TwitterIntegrationRequest
|
|
10241
|
+
* @deprecated
|
|
10240
10242
|
*/},{key:"patchConversationsMessagingIntegrationsTwitterIntegrationId",value:function patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
10241
10243
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}// verify the required parameter 'body' is set
|
|
10242
10244
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -10784,8 +10786,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10784
10786
|
*/},{key:"postConversationsMessagingIntegrationsOpen",value:function postConversationsMessagingIntegrationsOpen(body){// verify the required parameter 'body' is set
|
|
10785
10787
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpen';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10786
10788
|
* Create a Twitter Integration
|
|
10787
|
-
*
|
|
10789
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
10788
10790
|
* @param {Object} body TwitterIntegrationRequest
|
|
10791
|
+
* @deprecated
|
|
10789
10792
|
*/},{key:"postConversationsMessagingIntegrationsTwitter",value:function postConversationsMessagingIntegrationsTwitter(body){// verify the required parameter 'body' is set
|
|
10790
10793
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10791
10794
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
@@ -10987,7 +10990,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10987
10990
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ConversationsApi;}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
10988
10991
|
* DataExtensions service.
|
|
10989
10992
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
10990
|
-
* @version
|
|
10993
|
+
* @version 190.0.0
|
|
10991
10994
|
*/ /**
|
|
10992
10995
|
* Constructs a new DataExtensionsApi.
|
|
10993
10996
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11008,7 +11011,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11008
11011
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DataExtensionsApi;}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
11009
11012
|
* Downloads service.
|
|
11010
11013
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11011
|
-
* @version
|
|
11014
|
+
* @version 190.0.0
|
|
11012
11015
|
*/ /**
|
|
11013
11016
|
* Constructs a new DownloadsApi.
|
|
11014
11017
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11027,7 +11030,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11027
11030
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DownloadsApi;}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
11028
11031
|
* Emails service.
|
|
11029
11032
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11030
|
-
* @version
|
|
11033
|
+
* @version 190.0.0
|
|
11031
11034
|
*/ /**
|
|
11032
11035
|
* Constructs a new EmailsApi.
|
|
11033
11036
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11045,7 +11048,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11045
11048
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return EmailsApi;}();var EventsApi=/*#__PURE__*/function(){/**
|
|
11046
11049
|
* Events service.
|
|
11047
11050
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11048
|
-
* @version
|
|
11051
|
+
* @version 190.0.0
|
|
11049
11052
|
*/ /**
|
|
11050
11053
|
* Constructs a new EventsApi.
|
|
11051
11054
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11070,7 +11073,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11070
11073
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return EventsApi;}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
11071
11074
|
* ExternalContacts service.
|
|
11072
11075
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11073
|
-
* @version
|
|
11076
|
+
* @version 190.0.0
|
|
11074
11077
|
*/ /**
|
|
11075
11078
|
* Constructs a new ExternalContactsApi.
|
|
11076
11079
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11525,7 +11528,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11525
11528
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ExternalContactsApi;}();var FaxApi=/*#__PURE__*/function(){/**
|
|
11526
11529
|
* Fax service.
|
|
11527
11530
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11528
|
-
* @version
|
|
11531
|
+
* @version 190.0.0
|
|
11529
11532
|
*/ /**
|
|
11530
11533
|
* Constructs a new FaxApi.
|
|
11531
11534
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11566,7 +11569,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11566
11569
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFaxDocument';}return this.apiClient.callApi('/api/v2/fax/documents/{documentId}','PUT',{'documentId':documentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return FaxApi;}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
11567
11570
|
* Flows service.
|
|
11568
11571
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11569
|
-
* @version
|
|
11572
|
+
* @version 190.0.0
|
|
11570
11573
|
*/ /**
|
|
11571
11574
|
* Constructs a new FlowsApi.
|
|
11572
11575
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11615,7 +11618,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11615
11618
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return FlowsApi;}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
11616
11619
|
* Gamification service.
|
|
11617
11620
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11618
|
-
* @version
|
|
11621
|
+
* @version 190.0.0
|
|
11619
11622
|
*/ /**
|
|
11620
11623
|
* Constructs a new GamificationApi.
|
|
11621
11624
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12155,7 +12158,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12155
12158
|
if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GamificationApi;}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
12156
12159
|
* GeneralDataProtectionRegulation service.
|
|
12157
12160
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12158
|
-
* @version
|
|
12161
|
+
* @version 190.0.0
|
|
12159
12162
|
*/ /**
|
|
12160
12163
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12161
12164
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12190,7 +12193,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12190
12193
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GeneralDataProtectionRegulationApi;}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
12191
12194
|
* Geolocation service.
|
|
12192
12195
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12193
|
-
* @version
|
|
12196
|
+
* @version 190.0.0
|
|
12194
12197
|
*/ /**
|
|
12195
12198
|
* Constructs a new GeolocationApi.
|
|
12196
12199
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12224,7 +12227,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12224
12227
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GeolocationApi;}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
12225
12228
|
* Greetings service.
|
|
12226
12229
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12227
|
-
* @version
|
|
12230
|
+
* @version 190.0.0
|
|
12228
12231
|
*/ /**
|
|
12229
12232
|
* Constructs a new GreetingsApi.
|
|
12230
12233
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12331,7 +12334,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12331
12334
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GreetingsApi;}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
12332
12335
|
* Groups service.
|
|
12333
12336
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12334
|
-
* @version
|
|
12337
|
+
* @version 190.0.0
|
|
12335
12338
|
*/ /**
|
|
12336
12339
|
* Constructs a new GroupsApi.
|
|
12337
12340
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12464,7 +12467,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12464
12467
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GroupsApi;}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
12465
12468
|
* IdentityProvider service.
|
|
12466
12469
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12467
|
-
* @version
|
|
12470
|
+
* @version 190.0.0
|
|
12468
12471
|
*/ /**
|
|
12469
12472
|
* Constructs a new IdentityProviderApi.
|
|
12470
12473
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12620,7 +12623,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12620
12623
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return IdentityProviderApi;}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
12621
12624
|
* InfrastructureAsCode service.
|
|
12622
12625
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12623
|
-
* @version
|
|
12626
|
+
* @version 190.0.0
|
|
12624
12627
|
*/ /**
|
|
12625
12628
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12626
12629
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12674,7 +12677,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12674
12677
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return InfrastructureAsCodeApi;}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
12675
12678
|
* Integrations service.
|
|
12676
12679
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12677
|
-
* @version
|
|
12680
|
+
* @version 190.0.0
|
|
12678
12681
|
*/ /**
|
|
12679
12682
|
* Constructs a new IntegrationsApi.
|
|
12680
12683
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13284,7 +13287,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13284
13287
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return IntegrationsApi;}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
13285
13288
|
* Journey service.
|
|
13286
13289
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13287
|
-
* @version
|
|
13290
|
+
* @version 190.0.0
|
|
13288
13291
|
*/ /**
|
|
13289
13292
|
* Constructs a new JourneyApi.
|
|
13290
13293
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13499,10 +13502,48 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
13499
13502
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
13500
13503
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
13501
13504
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','GET',{'viewId':viewId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13505
|
+
* Get the job for a journey view version.
|
|
13506
|
+
* used for long descriptions
|
|
13507
|
+
* @param {String} viewId Journey View Id
|
|
13508
|
+
* @param {String} journeyVersionId Journey View Version
|
|
13509
|
+
* @param {String} jobId JobId
|
|
13510
|
+
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13511
|
+
*/},{key:"getJourneyViewVersionJob",value:function getJourneyViewVersionJob(viewId,journeyVersionId,jobId){// verify the required parameter 'viewId' is set
|
|
13512
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';}// verify the required parameter 'journeyVersionId' is set
|
|
13513
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
13514
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13515
|
+
* Get the result of a job for a journey view version.
|
|
13516
|
+
* used for long descriptions
|
|
13517
|
+
* @param {String} viewId JourneyViewResult id
|
|
13518
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
13519
|
+
* @param {String} jobId Id of the executing job
|
|
13520
|
+
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13521
|
+
*/},{key:"getJourneyViewVersionJobResults",value:function getJourneyViewVersionJobResults(viewId,journeyViewVersion,jobId){// verify the required parameter 'viewId' is set
|
|
13522
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
13523
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
13524
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13525
|
+
* Get the latest job of a journey view version.
|
|
13526
|
+
* used for long descriptions
|
|
13527
|
+
* @param {String} viewId Journey View Id
|
|
13528
|
+
* @param {String} journeyVersionId Journey View Version
|
|
13529
|
+
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13530
|
+
*/},{key:"getJourneyViewVersionJobsLatest",value:function getJourneyViewVersionJobsLatest(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
13531
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';}// verify the required parameter 'journeyVersionId' is set
|
|
13532
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13502
13533
|
* Get a list of Journey Views
|
|
13503
13534
|
*
|
|
13504
13535
|
* getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13505
13536
|
*/},{key:"getJourneyViews",value:function getJourneyViews(){return this.apiClient.callApi('/api/v2/journey/views','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13537
|
+
* Get an Event Definition
|
|
13538
|
+
*
|
|
13539
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
13540
|
+
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13541
|
+
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
13542
|
+
if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}','GET',{'eventDefinitionId':eventDefinitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13543
|
+
* Get a list of Event Definitions
|
|
13544
|
+
*
|
|
13545
|
+
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13546
|
+
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13506
13547
|
* Update single action map.
|
|
13507
13548
|
*
|
|
13508
13549
|
* @param {String} actionMapId ID of the action map.
|
|
@@ -13605,6 +13646,14 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
13605
13646
|
* @param {Object} opts Optional parameters
|
|
13606
13647
|
* @param {Object} opts.body
|
|
13607
13648
|
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13649
|
+
* Submit a job request for a journey view version.
|
|
13650
|
+
* used for long descriptions
|
|
13651
|
+
* @param {String} viewId Journey View Id
|
|
13652
|
+
* @param {String} journeyVersionId Journey View Version
|
|
13653
|
+
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13654
|
+
*/},{key:"postJourneyViewVersionJobs",value:function postJourneyViewVersionJobs(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
13655
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';}// verify the required parameter 'journeyVersionId' is set
|
|
13656
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs','POST',{'viewId':viewId,'journeyVersionId':journeyVersionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13608
13657
|
* Update a Journey View by ID
|
|
13609
13658
|
* creates a new version
|
|
13610
13659
|
* @param {String} viewId viewId
|
|
@@ -13618,10 +13667,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13618
13667
|
* @param {Object} body JourneyView
|
|
13619
13668
|
* postJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13620
13669
|
*/},{key:"postJourneyViews",value:function postJourneyViews(body){// verify the required parameter 'body' is set
|
|
13621
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViews';}return this.apiClient.callApi('/api/v2/journey/views','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
13670
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViews';}return this.apiClient.callApi('/api/v2/journey/views','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13671
|
+
* Validate whether an encoding exist for a label/value combination.
|
|
13672
|
+
* True indicates a valid encoding
|
|
13673
|
+
* @param {Object} opts Optional parameters
|
|
13674
|
+
* @param {Array.<Object>} opts.body
|
|
13675
|
+
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13676
|
+
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return JourneyApi;}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
13622
13677
|
* Knowledge service.
|
|
13623
13678
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13624
|
-
* @version
|
|
13679
|
+
* @version 190.0.0
|
|
13625
13680
|
*/ /**
|
|
13626
13681
|
* Constructs a new KnowledgeApi.
|
|
13627
13682
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14533,7 +14588,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14533
14588
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return KnowledgeApi;}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
14534
14589
|
* LanguageUnderstanding service.
|
|
14535
14590
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14536
|
-
* @version
|
|
14591
|
+
* @version 190.0.0
|
|
14537
14592
|
*/ /**
|
|
14538
14593
|
* Constructs a new LanguageUnderstandingApi.
|
|
14539
14594
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14789,7 +14844,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14789
14844
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LanguageUnderstandingApi;}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
14790
14845
|
* Languages service.
|
|
14791
14846
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14792
|
-
* @version
|
|
14847
|
+
* @version 190.0.0
|
|
14793
14848
|
*/ /**
|
|
14794
14849
|
* Constructs a new LanguagesApi.
|
|
14795
14850
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14844,7 +14899,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14844
14899
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LanguagesApi;}();var LearningApi=/*#__PURE__*/function(){/**
|
|
14845
14900
|
* Learning service.
|
|
14846
14901
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14847
|
-
* @version
|
|
14902
|
+
* @version 190.0.0
|
|
14848
14903
|
*/ /**
|
|
14849
14904
|
* Constructs a new LearningApi.
|
|
14850
14905
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15074,7 +15129,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15074
15129
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LearningApi;}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
15075
15130
|
* License service.
|
|
15076
15131
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15077
|
-
* @version
|
|
15132
|
+
* @version 190.0.0
|
|
15078
15133
|
*/ /**
|
|
15079
15134
|
* Constructs a new LicenseApi.
|
|
15080
15135
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15128,7 +15183,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15128
15183
|
*/},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LicenseApi;}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
15129
15184
|
* Locations service.
|
|
15130
15185
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15131
|
-
* @version
|
|
15186
|
+
* @version 190.0.0
|
|
15132
15187
|
*/ /**
|
|
15133
15188
|
* Constructs a new LocationsApi.
|
|
15134
15189
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15187,7 +15242,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15187
15242
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LocationsApi;}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
15188
15243
|
* LogCapture service.
|
|
15189
15244
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15190
|
-
* @version
|
|
15245
|
+
* @version 190.0.0
|
|
15191
15246
|
*/ /**
|
|
15192
15247
|
* Constructs a new LogCaptureApi.
|
|
15193
15248
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15237,7 +15292,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15237
15292
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LogCaptureApi;}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
15238
15293
|
* Messaging service.
|
|
15239
15294
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15240
|
-
* @version
|
|
15295
|
+
* @version 190.0.0
|
|
15241
15296
|
*/ /**
|
|
15242
15297
|
* Constructs a new MessagingApi.
|
|
15243
15298
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -15327,7 +15382,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15327
15382
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return MessagingApi;}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
15328
15383
|
* MobileDevices service.
|
|
15329
15384
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
15330
|
-
* @version
|
|
15385
|
+
* @version 190.0.0
|
|
15331
15386
|
*/ /**
|
|
15332
15387
|
* Constructs a new MobileDevicesApi.
|
|
15333
15388
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -15366,7 +15421,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15366
15421
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return MobileDevicesApi;}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
15367
15422
|
* Notifications service.
|
|
15368
15423
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
15369
|
-
* @version
|
|
15424
|
+
* @version 190.0.0
|
|
15370
15425
|
*/ /**
|
|
15371
15426
|
* Constructs a new NotificationsApi.
|
|
15372
15427
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -15423,7 +15478,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
15423
15478
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return NotificationsApi;}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
15424
15479
|
* OAuth service.
|
|
15425
15480
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
15426
|
-
* @version
|
|
15481
|
+
* @version 190.0.0
|
|
15427
15482
|
*/ /**
|
|
15428
15483
|
* Constructs a new OAuthApi.
|
|
15429
15484
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -15508,7 +15563,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
15508
15563
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OAuthApi;}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
15509
15564
|
* Objects service.
|
|
15510
15565
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
15511
|
-
* @version
|
|
15566
|
+
* @version 190.0.0
|
|
15512
15567
|
*/ /**
|
|
15513
15568
|
* Constructs a new ObjectsApi.
|
|
15514
15569
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -15579,7 +15634,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15579
15634
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ObjectsApi;}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
15580
15635
|
* OperationalEvents service.
|
|
15581
15636
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15582
|
-
* @version
|
|
15637
|
+
* @version 190.0.0
|
|
15583
15638
|
*/ /**
|
|
15584
15639
|
* Constructs a new OperationalEventsApi.
|
|
15585
15640
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15597,7 +15652,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15597
15652
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OperationalEventsApi;}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
15598
15653
|
* Organization service.
|
|
15599
15654
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15600
|
-
* @version
|
|
15655
|
+
* @version 190.0.0
|
|
15601
15656
|
*/ /**
|
|
15602
15657
|
* Constructs a new OrganizationApi.
|
|
15603
15658
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15636,7 +15691,7 @@ if(requestId===undefined||requestId===null){throw'Missing the required parameter
|
|
|
15636
15691
|
* @param {Number} opts.pageSize Page Size (default to 25)
|
|
15637
15692
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
15638
15693
|
*/},{key:"getOrganizationsLimitsChangerequests",value:function getOrganizationsLimitsChangerequests(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/organizations/limits/changerequests','GET',{},{'after':opts['after'],'before':opts['before'],'status':opts['status'],'pageSize':opts['pageSize'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15639
|
-
* Get
|
|
15694
|
+
* Get limit documentation
|
|
15640
15695
|
*
|
|
15641
15696
|
*/},{key:"getOrganizationsLimitsDocs",value:function getOrganizationsLimitsDocs(){return this.apiClient.callApi('/api/v2/organizations/limits/docs','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15642
15697
|
* Get the effective limits in a namespace for an organization
|
|
@@ -15699,7 +15754,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15699
15754
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OrganizationApi;}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
15700
15755
|
* OrganizationAuthorization service.
|
|
15701
15756
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15702
|
-
* @version
|
|
15757
|
+
* @version 190.0.0
|
|
15703
15758
|
*/ /**
|
|
15704
15759
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15705
15760
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16022,7 +16077,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16022
16077
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OrganizationAuthorizationApi;}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
16023
16078
|
* Outbound service.
|
|
16024
16079
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16025
|
-
* @version
|
|
16080
|
+
* @version 190.0.0
|
|
16026
16081
|
*/ /**
|
|
16027
16082
|
* Constructs a new OutboundApi.
|
|
16028
16083
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -17060,7 +17115,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17060
17115
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OutboundApi;}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
17061
17116
|
* Presence service.
|
|
17062
17117
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17063
|
-
* @version
|
|
17118
|
+
* @version 190.0.0
|
|
17064
17119
|
*/ /**
|
|
17065
17120
|
* Constructs a new PresenceApi.
|
|
17066
17121
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -17233,7 +17288,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17233
17288
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return PresenceApi;}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
17234
17289
|
* ProcessAutomation service.
|
|
17235
17290
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
17236
|
-
* @version
|
|
17291
|
+
* @version 190.0.0
|
|
17237
17292
|
*/ /**
|
|
17238
17293
|
* Constructs a new ProcessAutomationApi.
|
|
17239
17294
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -17296,7 +17351,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
17296
17351
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ProcessAutomationApi;}();var QualityApi=/*#__PURE__*/function(){/**
|
|
17297
17352
|
* Quality service.
|
|
17298
17353
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
17299
|
-
* @version
|
|
17354
|
+
* @version 190.0.0
|
|
17300
17355
|
*/ /**
|
|
17301
17356
|
* Constructs a new QualityApi.
|
|
17302
17357
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -17767,7 +17822,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17767
17822
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return QualityApi;}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
17768
17823
|
* Recording service.
|
|
17769
17824
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17770
|
-
* @version
|
|
17825
|
+
* @version 190.0.0
|
|
17771
17826
|
*/ /**
|
|
17772
17827
|
* Constructs a new RecordingApi.
|
|
17773
17828
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -18011,6 +18066,10 @@ if(retentionThresholdDays===undefined||retentionThresholdDays===null){throw'Miss
|
|
|
18011
18066
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18012
18067
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18013
18068
|
*/},{key:"getRecordingsScreensessions",value:function getRecordingsScreensessions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/screensessions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18069
|
+
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
18070
|
+
*
|
|
18071
|
+
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18072
|
+
*/},{key:"getRecordingsScreensessionsDetails",value:function getRecordingsScreensessionsDetails(){return this.apiClient.callApi('/api/v2/recordings/screensessions/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18014
18073
|
* Patch a media retention policy
|
|
18015
18074
|
*
|
|
18016
18075
|
* @param {String} policyId Policy ID
|
|
@@ -18174,7 +18233,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18174
18233
|
*/},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return RecordingApi;}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
18175
18234
|
* ResponseManagement service.
|
|
18176
18235
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18177
|
-
* @version
|
|
18236
|
+
* @version 190.0.0
|
|
18178
18237
|
*/ /**
|
|
18179
18238
|
* Constructs a new ResponseManagementApi.
|
|
18180
18239
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -18290,7 +18349,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
18290
18349
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ResponseManagementApi;}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
18291
18350
|
* Routing service.
|
|
18292
18351
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
18293
|
-
* @version
|
|
18352
|
+
* @version 190.0.0
|
|
18294
18353
|
*/ /**
|
|
18295
18354
|
* Constructs a new RoutingApi.
|
|
18296
18355
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -18644,12 +18703,13 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
18644
18703
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18645
18704
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18646
18705
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
18647
|
-
* @param {String} opts.name
|
|
18648
|
-
* @param {Array.<String>} opts.id
|
|
18649
|
-
* @param {Array.<String>} opts.divisionId
|
|
18650
|
-
* @param {Array.<String>} opts.peerId
|
|
18651
|
-
* @param {
|
|
18652
|
-
|
|
18706
|
+
* @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
|
|
18707
|
+
* @param {Array.<String>} opts.id Include only queues with the specified ID(s)
|
|
18708
|
+
* @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
|
|
18709
|
+
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
18710
|
+
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
18711
|
+
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
18712
|
+
*/},{key:"getRoutingQueues",value:function getRoutingQueues(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/queues','GET',{},{'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']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18653
18713
|
* Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
|
|
18654
18714
|
*
|
|
18655
18715
|
* @param {Object} opts Optional parameters
|
|
@@ -19258,7 +19318,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19258
19318
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return RoutingApi;}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
19259
19319
|
* SCIM service.
|
|
19260
19320
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
19261
|
-
* @version
|
|
19321
|
+
* @version 190.0.0
|
|
19262
19322
|
*/ /**
|
|
19263
19323
|
* Constructs a new SCIMApi.
|
|
19264
19324
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -19483,7 +19543,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19483
19543
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);return SCIMApi;}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
19484
19544
|
* ScreenRecording service.
|
|
19485
19545
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
19486
|
-
* @version
|
|
19546
|
+
* @version 190.0.0
|
|
19487
19547
|
*/ /**
|
|
19488
19548
|
* Constructs a new ScreenRecordingApi.
|
|
19489
19549
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -19498,7 +19558,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19498
19558
|
*/_createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ScreenRecordingApi;}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
19499
19559
|
* Scripts service.
|
|
19500
19560
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
19501
|
-
* @version
|
|
19561
|
+
* @version 190.0.0
|
|
19502
19562
|
*/ /**
|
|
19503
19563
|
* Constructs a new ScriptsApi.
|
|
19504
19564
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -19634,7 +19694,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
19634
19694
|
*/},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ScriptsApi;}();var SearchApi=/*#__PURE__*/function(){/**
|
|
19635
19695
|
* Search service.
|
|
19636
19696
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
19637
|
-
* @version
|
|
19697
|
+
* @version 190.0.0
|
|
19638
19698
|
*/ /**
|
|
19639
19699
|
* Constructs a new SearchApi.
|
|
19640
19700
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -19794,7 +19854,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19794
19854
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SearchApi;}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
19795
19855
|
* Settings service.
|
|
19796
19856
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
19797
|
-
* @version
|
|
19857
|
+
* @version 190.0.0
|
|
19798
19858
|
*/ /**
|
|
19799
19859
|
* Constructs a new SettingsApi.
|
|
19800
19860
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -19822,7 +19882,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19822
19882
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SettingsApi;}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
19823
19883
|
* SpeechTextAnalytics service.
|
|
19824
19884
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
19825
|
-
* @version
|
|
19885
|
+
* @version 190.0.0
|
|
19826
19886
|
*/ /**
|
|
19827
19887
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
19828
19888
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20066,7 +20126,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20066
20126
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SpeechTextAnalyticsApi;}();var StationsApi=/*#__PURE__*/function(){/**
|
|
20067
20127
|
* Stations service.
|
|
20068
20128
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20069
|
-
* @version
|
|
20129
|
+
* @version 190.0.0
|
|
20070
20130
|
*/ /**
|
|
20071
20131
|
* Constructs a new StationsApi.
|
|
20072
20132
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -20098,7 +20158,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
20098
20158
|
*/},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return StationsApi;}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
20099
20159
|
* Suggest service.
|
|
20100
20160
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
20101
|
-
* @version
|
|
20161
|
+
* @version 190.0.0
|
|
20102
20162
|
*/ /**
|
|
20103
20163
|
* Constructs a new SuggestApi.
|
|
20104
20164
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -20138,7 +20198,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20138
20198
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SuggestApi;}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
20139
20199
|
* TaskManagement service.
|
|
20140
20200
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
20141
|
-
* @version
|
|
20201
|
+
* @version 190.0.0
|
|
20142
20202
|
*/ /**
|
|
20143
20203
|
* Constructs a new TaskManagementApi.
|
|
20144
20204
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -20486,7 +20546,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
20486
20546
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TaskManagementApi;}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
20487
20547
|
* Teams service.
|
|
20488
20548
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
20489
|
-
* @version
|
|
20549
|
+
* @version 190.0.0
|
|
20490
20550
|
*/ /**
|
|
20491
20551
|
* Constructs a new TeamsApi.
|
|
20492
20552
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -20565,7 +20625,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20565
20625
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TeamsApi;}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
20566
20626
|
* Telephony service.
|
|
20567
20627
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
20568
|
-
* @version
|
|
20628
|
+
* @version 190.0.0
|
|
20569
20629
|
*/ /**
|
|
20570
20630
|
* Constructs a new TelephonyApi.
|
|
20571
20631
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -20612,7 +20672,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
20612
20672
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TelephonyApi;}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
20613
20673
|
* TelephonyProvidersEdge service.
|
|
20614
20674
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
20615
|
-
* @version
|
|
20675
|
+
* @version 190.0.0
|
|
20616
20676
|
*/ /**
|
|
20617
20677
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
20618
20678
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -21426,7 +21486,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
21426
21486
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TelephonyProvidersEdgeApi;}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
21427
21487
|
* Textbots service.
|
|
21428
21488
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
21429
|
-
* @version
|
|
21489
|
+
* @version 190.0.0
|
|
21430
21490
|
*/ /**
|
|
21431
21491
|
* Constructs a new TextbotsApi.
|
|
21432
21492
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -21461,7 +21521,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
21461
21521
|
if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TextbotsApi;}();var TokensApi=/*#__PURE__*/function(){/**
|
|
21462
21522
|
* Tokens service.
|
|
21463
21523
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
21464
|
-
* @version
|
|
21524
|
+
* @version 190.0.0
|
|
21465
21525
|
*/ /**
|
|
21466
21526
|
* Constructs a new TokensApi.
|
|
21467
21527
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -21495,7 +21555,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21495
21555
|
*/},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TokensApi;}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
21496
21556
|
* Uploads service.
|
|
21497
21557
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
21498
|
-
* @version
|
|
21558
|
+
* @version 190.0.0
|
|
21499
21559
|
*/ /**
|
|
21500
21560
|
* Constructs a new UploadsApi.
|
|
21501
21561
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -21561,7 +21621,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21561
21621
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UploadsApi;}();var UsageApi=/*#__PURE__*/function(){/**
|
|
21562
21622
|
* Usage service.
|
|
21563
21623
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
21564
|
-
* @version
|
|
21624
|
+
* @version 190.0.0
|
|
21565
21625
|
*/ /**
|
|
21566
21626
|
* Constructs a new UsageApi.
|
|
21567
21627
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -21612,7 +21672,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21612
21672
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UsageApi;}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
21613
21673
|
* UserRecordings service.
|
|
21614
21674
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
21615
|
-
* @version
|
|
21675
|
+
* @version 190.0.0
|
|
21616
21676
|
*/ /**
|
|
21617
21677
|
* Constructs a new UserRecordingsApi.
|
|
21618
21678
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -21661,7 +21721,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
21661
21721
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UserRecordingsApi;}();var UsersApi=/*#__PURE__*/function(){/**
|
|
21662
21722
|
* Users service.
|
|
21663
21723
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
21664
|
-
* @version
|
|
21724
|
+
* @version 190.0.0
|
|
21665
21725
|
*/ /**
|
|
21666
21726
|
* Constructs a new UsersApi.
|
|
21667
21727
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -22320,7 +22380,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
22320
22380
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UsersApi;}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
22321
22381
|
* Utilities service.
|
|
22322
22382
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
22323
|
-
* @version
|
|
22383
|
+
* @version 190.0.0
|
|
22324
22384
|
*/ /**
|
|
22325
22385
|
* Constructs a new UtilitiesApi.
|
|
22326
22386
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -22347,7 +22407,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22347
22407
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UtilitiesApi;}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
22348
22408
|
* Voicemail service.
|
|
22349
22409
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
22350
|
-
* @version
|
|
22410
|
+
* @version 190.0.0
|
|
22351
22411
|
*/ /**
|
|
22352
22412
|
* Constructs a new VoicemailApi.
|
|
22353
22413
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -22496,7 +22556,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22496
22556
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return VoicemailApi;}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
22497
22557
|
* WebChat service.
|
|
22498
22558
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
22499
|
-
* @version
|
|
22559
|
+
* @version 190.0.0
|
|
22500
22560
|
*/ /**
|
|
22501
22561
|
* Constructs a new WebChatApi.
|
|
22502
22562
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -22629,7 +22689,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22629
22689
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebChatApi;}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
22630
22690
|
* WebDeployments service.
|
|
22631
22691
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
22632
|
-
* @version
|
|
22692
|
+
* @version 190.0.0
|
|
22633
22693
|
*/ /**
|
|
22634
22694
|
* Constructs a new WebDeploymentsApi.
|
|
22635
22695
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -22750,7 +22810,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22750
22810
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebDeploymentsApi;}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
22751
22811
|
* WebMessaging service.
|
|
22752
22812
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
22753
|
-
* @version
|
|
22813
|
+
* @version 190.0.0
|
|
22754
22814
|
*/ /**
|
|
22755
22815
|
* Constructs a new WebMessagingApi.
|
|
22756
22816
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -22766,7 +22826,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
22766
22826
|
*/_createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebMessagingApi;}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
22767
22827
|
* Widgets service.
|
|
22768
22828
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
22769
|
-
* @version
|
|
22829
|
+
* @version 190.0.0
|
|
22770
22830
|
*/ /**
|
|
22771
22831
|
* Constructs a new WidgetsApi.
|
|
22772
22832
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -22801,7 +22861,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22801
22861
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WidgetsApi;}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
22802
22862
|
* WorkforceManagement service.
|
|
22803
22863
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
22804
|
-
* @version
|
|
22864
|
+
* @version 190.0.0
|
|
22805
22865
|
*/ /**
|
|
22806
22866
|
* Constructs a new WorkforceManagementApi.
|
|
22807
22867
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -22842,6 +22902,27 @@ if(runId===undefined||runId===null){throw'Missing the required parameter "runId"
|
|
|
22842
22902
|
*/},{key:"deleteWorkforcemanagementBusinessunitServicegoaltemplate",value:function deleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId,serviceGoalTemplateId){// verify the required parameter 'businessUnitId' is set
|
|
22843
22903
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';}// verify the required parameter 'serviceGoalTemplateId' is set
|
|
22844
22904
|
if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missing the required parameter "serviceGoalTemplateId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}','DELETE',{'businessUnitId':businessUnitId,'serviceGoalTemplateId':serviceGoalTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22905
|
+
* Deletes a staffing group
|
|
22906
|
+
*
|
|
22907
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
22908
|
+
* @param {String} staffingGroupId The ID of the staffing group to delete
|
|
22909
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitStaffinggroup",value:function deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId){// verify the required parameter 'businessUnitId' is set
|
|
22910
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
22911
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','DELETE',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22912
|
+
* Deletes a time-off limit object
|
|
22913
|
+
*
|
|
22914
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
22915
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to delete
|
|
22916
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitTimeofflimit",value:function deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId,timeOffLimitId){// verify the required parameter 'businessUnitId' is set
|
|
22917
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';}// verify the required parameter 'timeOffLimitId' is set
|
|
22918
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}','DELETE',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22919
|
+
* Deletes a time-off plan
|
|
22920
|
+
*
|
|
22921
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
22922
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to delete
|
|
22923
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitTimeoffplan",value:function deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId){// verify the required parameter 'businessUnitId' is set
|
|
22924
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
22925
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','DELETE',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22845
22926
|
* Delete a schedule
|
|
22846
22927
|
*
|
|
22847
22928
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -23029,6 +23110,49 @@ if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missin
|
|
|
23029
23110
|
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
23030
23111
|
*/},{key:"getWorkforcemanagementBusinessunitServicegoaltemplates",value:function getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23031
23112
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates','GET',{'businessUnitId':businessUnitId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23113
|
+
* Gets a staffing group
|
|
23114
|
+
*
|
|
23115
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23116
|
+
* @param {String} staffingGroupId The ID of the staffing group to fetch
|
|
23117
|
+
*/},{key:"getWorkforcemanagementBusinessunitStaffinggroup",value:function getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId){// verify the required parameter 'businessUnitId' is set
|
|
23118
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
23119
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','GET',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23120
|
+
* Gets a list of staffing groups
|
|
23121
|
+
*
|
|
23122
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23123
|
+
* @param {Object} opts Optional parameters
|
|
23124
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
23125
|
+
*/},{key:"getWorkforcemanagementBusinessunitStaffinggroups",value:function getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23126
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23127
|
+
* Gets a time-off limit object
|
|
23128
|
+
* Returns properties of time-off limit object, but not daily values
|
|
23129
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23130
|
+
* @param {String} timeOffLimitId The ID of the time-off limit to fetch
|
|
23131
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeofflimit",value:function getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId,timeOffLimitId){// verify the required parameter 'businessUnitId' is set
|
|
23132
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';}// verify the required parameter 'timeOffLimitId' is set
|
|
23133
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}','GET',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23134
|
+
* Gets a list of time-off limit objects
|
|
23135
|
+
*
|
|
23136
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23137
|
+
* @param {Object} opts Optional parameters
|
|
23138
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
|
|
23139
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeofflimits",value:function getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23140
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23141
|
+
* Gets a time-off plan
|
|
23142
|
+
*
|
|
23143
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23144
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to fetch
|
|
23145
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplan",value:function getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId){// verify the required parameter 'businessUnitId' is set
|
|
23146
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
23147
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','GET',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23148
|
+
* Gets a list of time-off plans
|
|
23149
|
+
*
|
|
23150
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23151
|
+
* @param {Object} opts Optional parameters
|
|
23152
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
23153
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
23154
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplans",value:function getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23155
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23032
23156
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
23033
23157
|
*
|
|
23034
23158
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -23473,6 +23597,24 @@ if(runId===undefined||runId===null){throw'Missing the required parameter "runId"
|
|
|
23473
23597
|
*/},{key:"patchWorkforcemanagementBusinessunitServicegoaltemplate",value:function patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId,serviceGoalTemplateId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23474
23598
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';}// verify the required parameter 'serviceGoalTemplateId' is set
|
|
23475
23599
|
if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}','PATCH',{'businessUnitId':businessUnitId,'serviceGoalTemplateId':serviceGoalTemplateId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23600
|
+
* Updates a staffing group
|
|
23601
|
+
*
|
|
23602
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23603
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
23604
|
+
* @param {Object} opts Optional parameters
|
|
23605
|
+
* @param {Object} opts.body body
|
|
23606
|
+
*/},{key:"patchWorkforcemanagementBusinessunitStaffinggroup",value:function patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23607
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
23608
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','PATCH',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23609
|
+
* Updates a time-off plan
|
|
23610
|
+
*
|
|
23611
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23612
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
23613
|
+
* @param {Object} opts Optional parameters
|
|
23614
|
+
* @param {Object} opts.body body
|
|
23615
|
+
*/},{key:"patchWorkforcemanagementBusinessunitTimeoffplan",value:function patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23616
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
23617
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','PATCH',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23476
23618
|
* Update the requested management unit
|
|
23477
23619
|
*
|
|
23478
23620
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -23673,6 +23815,41 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
23673
23815
|
* @param {Object} opts.body body
|
|
23674
23816
|
*/},{key:"postWorkforcemanagementBusinessunitServicegoaltemplates",value:function postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23675
23817
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23818
|
+
* Creates a new staffing group
|
|
23819
|
+
*
|
|
23820
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23821
|
+
* @param {Object} opts Optional parameters
|
|
23822
|
+
* @param {Object} opts.body body
|
|
23823
|
+
*/},{key:"postWorkforcemanagementBusinessunitStaffinggroups",value:function postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23824
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23825
|
+
* Gets staffing group associations for a list of user IDs
|
|
23826
|
+
*
|
|
23827
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23828
|
+
* @param {Object} opts Optional parameters
|
|
23829
|
+
* @param {Object} opts.body body
|
|
23830
|
+
*/},{key:"postWorkforcemanagementBusinessunitStaffinggroupsQuery",value:function postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23831
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23832
|
+
* Creates a new time-off limit object
|
|
23833
|
+
*
|
|
23834
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23835
|
+
* @param {Object} opts Optional parameters
|
|
23836
|
+
* @param {Object} opts.body body
|
|
23837
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeofflimits",value:function postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23838
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23839
|
+
* Retrieves time-off limit related values based on a given set of filters.
|
|
23840
|
+
*
|
|
23841
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23842
|
+
* @param {Object} opts Optional parameters
|
|
23843
|
+
* @param {Object} opts.body body
|
|
23844
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery",value:function postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23845
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23846
|
+
* Creates a new time-off plan
|
|
23847
|
+
*
|
|
23848
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23849
|
+
* @param {Object} opts Optional parameters
|
|
23850
|
+
* @param {Object} opts.body body
|
|
23851
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeoffplans",value:function postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23852
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23676
23853
|
* Loads agent schedule data from the schedule. Used in combination with the metadata route
|
|
23677
23854
|
*
|
|
23678
23855
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -24116,6 +24293,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24116
24293
|
*/},{key:"putWorkforcemanagementAgentIntegrationsHris",value:function putWorkforcemanagementAgentIntegrationsHris(agentId,body){// verify the required parameter 'agentId' is set
|
|
24117
24294
|
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';}// verify the required parameter 'body' is set
|
|
24118
24295
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/{agentId}/integrations/hris','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
24296
|
+
* Sets daily values for a date range of time-off limit object
|
|
24297
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
24298
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
24299
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
24300
|
+
* @param {Object} opts Optional parameters
|
|
24301
|
+
* @param {Object} opts.body body
|
|
24302
|
+
*/},{key:"putWorkforcemanagementBusinessunitTimeofflimitValues",value:function putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId,timeOffLimitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
24303
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';}// verify the required parameter 'timeOffLimitId' is set
|
|
24304
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values','PUT',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
24119
24305
|
* Sets daily values for a date range of time off limit object
|
|
24120
24306
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
24121
24307
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -24153,7 +24339,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
24153
24339
|
* </pre>
|
|
24154
24340
|
* </p>
|
|
24155
24341
|
* @module purecloud-platform-client-v2/index
|
|
24156
|
-
* @version
|
|
24342
|
+
* @version 190.0.0
|
|
24157
24343
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
24158
24344
|
* The ApiClient constructor.
|
|
24159
24345
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|