purecloud-platform-client-v2 186.0.1 → 187.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 +717 -168
- package/dist/web-amd/purecloud-platform-client-v2.js +717 -168
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +271 -134
- package/dist/web-cjs/purecloud-platform-client-v2.js +271 -134
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +520 -94
- 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 +25 -7
- 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 +4 -22
- 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 +38 -3
- 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 +106 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +136 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -34
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +63 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +186 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +50 -0
- 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 -27
- 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 +32 -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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5667,7 +5667,7 @@ return utils$1.matchAll(/\w+|\[(\w*)]/g,name).map(function(match){return match[0
|
|
|
5667
5667
|
* @param {Function} encoder - A function that takes a value and returns a string.
|
|
5668
5668
|
*
|
|
5669
5669
|
* @returns {string} A stringified version of the rawValue.
|
|
5670
|
-
*/function stringifySafely(rawValue,parser,encoder){if(utils$1.isString(rawValue)){try{(parser||JSON.parse)(rawValue);return utils$1.trim(rawValue);}catch(e){if(e.name!=='SyntaxError'){throw e;}}}return(encoder||JSON.stringify)(rawValue);}var defaults={transitional:transitionalDefaults,adapter:['xhr','http'],transformRequest:[function transformRequest(data,headers){var contentType=headers.getContentType()||'';var hasJSONContentType=contentType.indexOf('application/json')>-1;var isObjectPayload=utils$1.isObject(data);if(isObjectPayload&&utils$1.isHTMLForm(data)){data=new FormData(data);}var isFormData=utils$1.isFormData(data);if(isFormData){
|
|
5670
|
+
*/function stringifySafely(rawValue,parser,encoder){if(utils$1.isString(rawValue)){try{(parser||JSON.parse)(rawValue);return utils$1.trim(rawValue);}catch(e){if(e.name!=='SyntaxError'){throw e;}}}return(encoder||JSON.stringify)(rawValue);}var defaults={transitional:transitionalDefaults,adapter:['xhr','http'],transformRequest:[function transformRequest(data,headers){var contentType=headers.getContentType()||'';var hasJSONContentType=contentType.indexOf('application/json')>-1;var isObjectPayload=utils$1.isObject(data);if(isObjectPayload&&utils$1.isHTMLForm(data)){data=new FormData(data);}var isFormData=utils$1.isFormData(data);if(isFormData){return hasJSONContentType?JSON.stringify(formDataToJSON(data)):data;}if(utils$1.isArrayBuffer(data)||utils$1.isBuffer(data)||utils$1.isStream(data)||utils$1.isFile(data)||utils$1.isBlob(data)){return data;}if(utils$1.isArrayBufferView(data)){return data.buffer;}if(utils$1.isURLSearchParams(data)){headers.setContentType('application/x-www-form-urlencoded;charset=utf-8',false);return data.toString();}var isFileList;if(isObjectPayload){if(contentType.indexOf('application/x-www-form-urlencoded')>-1){return toURLEncodedForm(data,this.formSerializer).toString();}if((isFileList=utils$1.isFileList(data))||contentType.indexOf('multipart/form-data')>-1){var _FormData=this.env&&this.env.FormData;return toFormData(isFileList?{'files[]':data}:data,_FormData&&new _FormData(),this.formSerializer);}}if(isObjectPayload||hasJSONContentType){headers.setContentType('application/json',false);return stringifySafely(data);}return data;}],transformResponse:[function transformResponse(data){var transitional=this.transitional||defaults.transitional;var forcedJSONParsing=transitional&&transitional.forcedJSONParsing;var JSONRequested=this.responseType==='json';if(data&&utils$1.isString(data)&&(forcedJSONParsing&&!this.responseType||JSONRequested)){var silentJSONParsing=transitional&&transitional.silentJSONParsing;var strictJSONParsing=!silentJSONParsing&&JSONRequested;try{return JSON.parse(data);}catch(e){if(strictJSONParsing){if(e.name==='SyntaxError'){throw AxiosError.from(e,AxiosError.ERR_BAD_RESPONSE,this,null,this.response);}throw e;}}}return data;}],/**
|
|
5671
5671
|
* A timeout in milliseconds to abort a request. If set to 0 (default) a
|
|
5672
5672
|
* timeout is not created.
|
|
5673
5673
|
*/timeout:0,xsrfCookieName:'XSRF-TOKEN',xsrfHeaderName:'X-XSRF-TOKEN',maxContentLength:-1,maxBodyLength:-1,env:{FormData:platform.classes.FormData,Blob:platform.classes.Blob},validateStatus:function validateStatus(status){return status>=200&&status<300;},headers:{common:{'Accept':'application/json, text/plain, */*','Content-Type':undefined}}};utils$1.forEach(['delete','get','head','post','put','patch'],function(method){defaults.headers[method]={};});var defaults$1=defaults;// RawAxiosHeaders whose duplicates are ignored by node
|
|
@@ -5822,7 +5822,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,caseless
|
|
|
5822
5822
|
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
|
|
5823
5823
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
5824
5824
|
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
|
|
5825
|
-
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.
|
|
5825
|
+
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.7";var validators$1={};// eslint-disable-next-line func-names
|
|
5826
5826
|
['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={};/**
|
|
5827
5827
|
* Transitional option validator
|
|
5828
5828
|
*
|
|
@@ -5854,9 +5854,9 @@ console.warn(formatMessage(opt,' has been deprecated since v'+version+' and will
|
|
|
5854
5854
|
* @param {?Object} config
|
|
5855
5855
|
*
|
|
5856
5856
|
* @returns {Promise} The Promise to be fulfilled
|
|
5857
|
-
*/_createClass(Axios,[{key:"request",value:(function(){var _request2=_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(configOrUrl,config){var dummy;return _regeneratorRuntime().wrap(function _callee$(_context){while(1)switch(_context.prev=_context.next){case 0:_context.prev=0;_context.next=3;return this._request(configOrUrl,config);case 3:return _context.abrupt("return",_context.sent);case 6:_context.prev=6;_context.t0=_context["catch"](0);
|
|
5858
|
-
dummy.stack
|
|
5859
|
-
if(
|
|
5857
|
+
*/_createClass(Axios,[{key:"request",value:(function(){var _request2=_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(configOrUrl,config){var dummy,stack;return _regeneratorRuntime().wrap(function _callee$(_context){while(1)switch(_context.prev=_context.next){case 0:_context.prev=0;_context.next=3;return this._request(configOrUrl,config);case 3:return _context.abrupt("return",_context.sent);case 6:_context.prev=6;_context.t0=_context["catch"](0);if(_context.t0 instanceof Error){Error.captureStackTrace?Error.captureStackTrace(dummy={}):dummy=new Error();// slice off the Error: ... line
|
|
5858
|
+
stack=dummy.stack?dummy.stack.replace(/^.+\n/,''):'';if(!_context.t0.stack){_context.t0.stack=stack;// match without the 2 top stack lines
|
|
5859
|
+
}else if(stack&&!String(_context.t0.stack).endsWith(stack.replace(/^.+\n.+\n/,''))){_context.t0.stack+='\n'+stack;}}throw _context.t0;case 10:case"end":return _context.stop();}},_callee,this,[[0,6]]);}));function request(_x,_x2){return _request2.apply(this,arguments);}return request;}())},{key:"_request",value:function _request(configOrUrl,config){/*eslint no-param-reassign:0*/ // Allow for axios('example/url'[, config]) a la fetch API
|
|
5860
5860
|
if(typeof configOrUrl==='string'){config=config||{};config.url=configOrUrl;}else{config=configOrUrl||{};}config=mergeConfig(this.defaults,config);var _config=config,transitional=_config.transitional,paramsSerializer=_config.paramsSerializer,headers=_config.headers;if(transitional!==undefined){validator.assertOptions(transitional,{silentJSONParsing:validators.transitional(validators["boolean"]),forcedJSONParsing:validators.transitional(validators["boolean"]),clarifyTimeoutError:validators.transitional(validators["boolean"])},false);}if(paramsSerializer!=null){if(utils$1.isFunction(paramsSerializer)){config.paramsSerializer={serialize:paramsSerializer};}else{validator.assertOptions(paramsSerializer,{encode:validators["function"],serialize:validators["function"]},true);}}// Set config.method
|
|
5861
5861
|
config.method=(config.method||this.defaults.method||'get').toLowerCase();// Flatten headers
|
|
5862
5862
|
var contextHeaders=headers&&utils$1.merge(headers.common,headers[config.method]);headers&&utils$1.forEach(['delete','get','head','post','put','patch','common'],function(method){delete headers[method];});config.headers=AxiosHeaders$1.concat(contextHeaders,headers);// filter out skipped interceptors
|
|
@@ -5935,7 +5935,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
5935
5935
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
5936
5936
|
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;}();/**
|
|
5937
5937
|
* @module purecloud-platform-client-v2/ApiClient
|
|
5938
|
-
* @version
|
|
5938
|
+
* @version 187.0.0
|
|
5939
5939
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
5940
5940
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
5941
5941
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6247,7 +6247,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6247
6247
|
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(){/**
|
|
6248
6248
|
* Alerting service.
|
|
6249
6249
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6250
|
-
* @version
|
|
6250
|
+
* @version 187.0.0
|
|
6251
6251
|
*/ /**
|
|
6252
6252
|
* Constructs a new AlertingApi.
|
|
6253
6253
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6404,7 +6404,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6404
6404
|
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(){/**
|
|
6405
6405
|
* Analytics service.
|
|
6406
6406
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6407
|
-
* @version
|
|
6407
|
+
* @version 187.0.0
|
|
6408
6408
|
*/ /**
|
|
6409
6409
|
* Constructs a new AnalyticsApi.
|
|
6410
6410
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7011,7 +7011,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
7011
7011
|
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(){/**
|
|
7012
7012
|
* Architect service.
|
|
7013
7013
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7014
|
-
* @version
|
|
7014
|
+
* @version 187.0.0
|
|
7015
7015
|
*/ /**
|
|
7016
7016
|
* Constructs a new ArchitectApi.
|
|
7017
7017
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -7303,8 +7303,12 @@ if(ivrId===undefined||ivrId===null){throw'Missing the required parameter "ivrId"
|
|
|
7303
7303
|
* Get specified user prompt
|
|
7304
7304
|
*
|
|
7305
7305
|
* @param {String} promptId Prompt ID
|
|
7306
|
-
|
|
7307
|
-
|
|
7306
|
+
* @param {Object} opts Optional parameters
|
|
7307
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
7308
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
7309
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
7310
|
+
*/},{key:"getArchitectPrompt",value:function getArchitectPrompt(promptId,opts){opts=opts||{};// verify the required parameter 'promptId' is set
|
|
7311
|
+
if(promptId===undefined||promptId===null){throw'Missing the required parameter "promptId" when calling getArchitectPrompt';}return this.apiClient.callApi('/api/v2/architect/prompts/{promptId}','GET',{'promptId':promptId},{'includeMediaUris':opts['includeMediaUris'],'includeResources':opts['includeResources'],'language':this.apiClient.buildCollectionParam(opts['language'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7308
7312
|
* Get generated prompt history
|
|
7309
7313
|
*
|
|
7310
7314
|
* @param {String} promptId Prompt ID
|
|
@@ -7343,7 +7347,10 @@ if(promptId===undefined||promptId===null){throw'Missing the required parameter "
|
|
|
7343
7347
|
* @param {String} opts.nameOrDescription Name or description
|
|
7344
7348
|
* @param {String} opts.sortBy Sort by (default to id)
|
|
7345
7349
|
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
7346
|
-
|
|
7350
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
7351
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
7352
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
7353
|
+
*/},{key:"getArchitectPrompts",value:function getArchitectPrompts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/architect/prompts','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':this.apiClient.buildCollectionParam(opts['name'],'multi'),'description':opts['description'],'nameOrDescription':opts['nameOrDescription'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'includeMediaUris':opts['includeMediaUris'],'includeResources':opts['includeResources'],'language':this.apiClient.buildCollectionParam(opts['language'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7347
7354
|
* Get a schedule by ID
|
|
7348
7355
|
*
|
|
7349
7356
|
* @param {String} scheduleId Schedule ID
|
|
@@ -7400,8 +7407,12 @@ if(scheduleGroupId===undefined||scheduleGroupId===null){throw'Missing the requir
|
|
|
7400
7407
|
* Get a system prompt
|
|
7401
7408
|
*
|
|
7402
7409
|
* @param {String} promptId promptId
|
|
7403
|
-
|
|
7404
|
-
|
|
7410
|
+
* @param {Object} opts Optional parameters
|
|
7411
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
7412
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
7413
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
7414
|
+
*/},{key:"getArchitectSystemprompt",value:function getArchitectSystemprompt(promptId,opts){opts=opts||{};// verify the required parameter 'promptId' is set
|
|
7415
|
+
if(promptId===undefined||promptId===null){throw'Missing the required parameter "promptId" when calling getArchitectSystemprompt';}return this.apiClient.callApi('/api/v2/architect/systemprompts/{promptId}','GET',{'promptId':promptId},{'includeMediaUris':opts['includeMediaUris'],'includeResources':opts['includeResources'],'language':this.apiClient.buildCollectionParam(opts['language'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7405
7416
|
* Get generated prompt history
|
|
7406
7417
|
*
|
|
7407
7418
|
* @param {String} promptId promptId
|
|
@@ -7442,7 +7453,10 @@ if(promptId===undefined||promptId===null){throw'Missing the required parameter "
|
|
|
7442
7453
|
* @param {String} opts.name Name
|
|
7443
7454
|
* @param {String} opts.description Description
|
|
7444
7455
|
* @param {String} opts.nameOrDescription Name or description
|
|
7445
|
-
|
|
7456
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
7457
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
7458
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
7459
|
+
*/},{key:"getArchitectSystemprompts",value:function getArchitectSystemprompts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/architect/systemprompts','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'description':opts['description'],'nameOrDescription':opts['nameOrDescription'],'includeMediaUris':opts['includeMediaUris'],'includeResources':opts['includeResources'],'language':this.apiClient.buildCollectionParam(opts['language'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7446
7460
|
* Get flow
|
|
7447
7461
|
*
|
|
7448
7462
|
* @param {String} flowId Flow ID
|
|
@@ -8043,7 +8057,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8043
8057
|
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(){/**
|
|
8044
8058
|
* Audit service.
|
|
8045
8059
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8046
|
-
* @version
|
|
8060
|
+
* @version 187.0.0
|
|
8047
8061
|
*/ /**
|
|
8048
8062
|
* Constructs a new AuditApi.
|
|
8049
8063
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8085,7 +8099,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8085
8099
|
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(){/**
|
|
8086
8100
|
* Authorization service.
|
|
8087
8101
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8088
|
-
* @version
|
|
8102
|
+
* @version 187.0.0
|
|
8089
8103
|
*/ /**
|
|
8090
8104
|
* Constructs a new AuthorizationApi.
|
|
8091
8105
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8395,7 +8409,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8395
8409
|
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(){/**
|
|
8396
8410
|
* Billing service.
|
|
8397
8411
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8398
|
-
* @version
|
|
8412
|
+
* @version 187.0.0
|
|
8399
8413
|
*/ /**
|
|
8400
8414
|
* Constructs a new BillingApi.
|
|
8401
8415
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8419,7 +8433,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8419
8433
|
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(){/**
|
|
8420
8434
|
* CarrierServices service.
|
|
8421
8435
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8422
|
-
* @version
|
|
8436
|
+
* @version 187.0.0
|
|
8423
8437
|
*/ /**
|
|
8424
8438
|
* Constructs a new CarrierServicesApi.
|
|
8425
8439
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8439,7 +8453,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8439
8453
|
*/},{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(){/**
|
|
8440
8454
|
* Chat service.
|
|
8441
8455
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8442
|
-
* @version
|
|
8456
|
+
* @version 187.0.0
|
|
8443
8457
|
*/ /**
|
|
8444
8458
|
* Constructs a new ChatApi.
|
|
8445
8459
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8503,18 +8517,12 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
8503
8517
|
*
|
|
8504
8518
|
* @param {String} roomJid roomJid
|
|
8505
8519
|
* @param {Object} opts Optional parameters
|
|
8506
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
8507
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
8508
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
8509
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
8510
|
-
* @param {String} opts.nextPage next page token
|
|
8511
|
-
* @param {String} opts.previousPage Previous page token
|
|
8512
8520
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8513
8521
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8514
8522
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8515
8523
|
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8516
8524
|
*/},{key:"getChatsRoomMessages",value:function getChatsRoomMessages(roomJid,opts){opts=opts||{};// verify the required parameter 'roomJid' is set
|
|
8517
|
-
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},{'
|
|
8525
|
+
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']);}/**
|
|
8518
8526
|
* Get Chat Settings.
|
|
8519
8527
|
*
|
|
8520
8528
|
*/},{key:"getChatsSettings",value:function getChatsSettings(){return this.apiClient.callApi('/api/v2/chats/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8522,18 +8530,12 @@ if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "ro
|
|
|
8522
8530
|
*
|
|
8523
8531
|
* @param {String} threadId threadId
|
|
8524
8532
|
* @param {Object} opts Optional parameters
|
|
8525
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
8526
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
8527
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
8528
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
8529
|
-
* @param {String} opts.nextPage next page token
|
|
8530
|
-
* @param {String} opts.previousPage Previous page token
|
|
8531
8533
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8532
8534
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8533
8535
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8534
8536
|
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8535
8537
|
*/},{key:"getChatsThreadMessages",value:function getChatsThreadMessages(threadId,opts){opts=opts||{};// verify the required parameter 'threadId' is set
|
|
8536
|
-
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},{'
|
|
8538
|
+
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']);}/**
|
|
8537
8539
|
* Get messages by id(s) from a 1on1
|
|
8538
8540
|
*
|
|
8539
8541
|
* @param {String} userId userId
|
|
@@ -8546,18 +8548,12 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
8546
8548
|
*
|
|
8547
8549
|
* @param {String} userId userId
|
|
8548
8550
|
* @param {Object} opts Optional parameters
|
|
8549
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
8550
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
8551
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
8552
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
8553
|
-
* @param {String} opts.nextPage next page token
|
|
8554
|
-
* @param {String} opts.previousPage Previous page token
|
|
8555
8551
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
8556
8552
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
8557
8553
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
8558
8554
|
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8559
8555
|
*/},{key:"getChatsUserMessages",value:function getChatsUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
8560
|
-
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},{'
|
|
8556
|
+
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']);}/**
|
|
8561
8557
|
* Get a user's chat settings
|
|
8562
8558
|
*
|
|
8563
8559
|
* @param {String} userId User ID
|
|
@@ -8650,7 +8646,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8650
8646
|
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(){/**
|
|
8651
8647
|
* Coaching service.
|
|
8652
8648
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8653
|
-
* @version
|
|
8649
|
+
* @version 187.0.0
|
|
8654
8650
|
*/ /**
|
|
8655
8651
|
* Constructs a new CoachingApi.
|
|
8656
8652
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -8803,7 +8799,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8803
8799
|
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(){/**
|
|
8804
8800
|
* ContentManagement service.
|
|
8805
8801
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8806
|
-
* @version
|
|
8802
|
+
* @version 187.0.0
|
|
8807
8803
|
*/ /**
|
|
8808
8804
|
* Constructs a new ContentManagementApi.
|
|
8809
8805
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9086,7 +9082,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9086
9082
|
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(){/**
|
|
9087
9083
|
* Conversations service.
|
|
9088
9084
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9089
|
-
* @version
|
|
9085
|
+
* @version 187.0.0
|
|
9090
9086
|
*/ /**
|
|
9091
9087
|
* Constructs a new ConversationsApi.
|
|
9092
9088
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10226,6 +10222,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10226
10222
|
*/},{key:"postConversationParticipantSecureivrsessions",value:function postConversationParticipantSecureivrsessions(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10227
10223
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationParticipantSecureivrsessions';}// verify the required parameter 'participantId' is set
|
|
10228
10224
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationParticipantSecureivrsessions';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10225
|
+
* Submit feedback for the summary.
|
|
10226
|
+
*
|
|
10227
|
+
* @param {String} conversationId Conversation ID
|
|
10228
|
+
* @param {String} summaryId Summary ID
|
|
10229
|
+
* @param {Object} opts Optional parameters
|
|
10230
|
+
* @param {Object} opts.body
|
|
10231
|
+
*/},{key:"postConversationSummaryFeedback",value:function postConversationSummaryFeedback(conversationId,summaryId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10232
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSummaryFeedback';}// verify the required parameter 'summaryId' is set
|
|
10233
|
+
if(summaryId===undefined||summaryId===null){throw'Missing the required parameter "summaryId" when calling postConversationSummaryFeedback';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback','POST',{'conversationId':conversationId,'summaryId':summaryId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10229
10234
|
* Place a new call as part of a callback conversation.
|
|
10230
10235
|
*
|
|
10231
10236
|
* @param {String} conversationId conversationId
|
|
@@ -10597,9 +10602,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10597
10602
|
* @param {Object} body InstagramIntegrationRequest
|
|
10598
10603
|
*/},{key:"postConversationsMessagingIntegrationsInstagram",value:function postConversationsMessagingIntegrationsInstagram(body){// verify the required parameter 'body' is set
|
|
10599
10604
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsInstagram';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/instagram','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10600
|
-
* Create a LINE messenger Integration
|
|
10601
|
-
*
|
|
10605
|
+
* Create a LINE messenger Integration (Deprecated)
|
|
10606
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
10602
10607
|
* @param {Object} body LineIntegrationRequest
|
|
10608
|
+
* @deprecated
|
|
10603
10609
|
*/},{key:"postConversationsMessagingIntegrationsLine",value:function postConversationsMessagingIntegrationsLine(body){// verify the required parameter 'body' is set
|
|
10604
10610
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/line','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10605
10611
|
* Create an Open messaging integration
|
|
@@ -10810,7 +10816,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10810
10816
|
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(){/**
|
|
10811
10817
|
* DataExtensions service.
|
|
10812
10818
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
10813
|
-
* @version
|
|
10819
|
+
* @version 187.0.0
|
|
10814
10820
|
*/ /**
|
|
10815
10821
|
* Constructs a new DataExtensionsApi.
|
|
10816
10822
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -10831,7 +10837,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10831
10837
|
*/},{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(){/**
|
|
10832
10838
|
* Downloads service.
|
|
10833
10839
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
10834
|
-
* @version
|
|
10840
|
+
* @version 187.0.0
|
|
10835
10841
|
*/ /**
|
|
10836
10842
|
* Constructs a new DownloadsApi.
|
|
10837
10843
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -10850,7 +10856,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10850
10856
|
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(){/**
|
|
10851
10857
|
* Emails service.
|
|
10852
10858
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
10853
|
-
* @version
|
|
10859
|
+
* @version 187.0.0
|
|
10854
10860
|
*/ /**
|
|
10855
10861
|
* Constructs a new EmailsApi.
|
|
10856
10862
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -10868,7 +10874,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
10868
10874
|
*/},{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(){/**
|
|
10869
10875
|
* Events service.
|
|
10870
10876
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
10871
|
-
* @version
|
|
10877
|
+
* @version 187.0.0
|
|
10872
10878
|
*/ /**
|
|
10873
10879
|
* Constructs a new EventsApi.
|
|
10874
10880
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -10893,7 +10899,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10893
10899
|
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(){/**
|
|
10894
10900
|
* ExternalContacts service.
|
|
10895
10901
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
10896
|
-
* @version
|
|
10902
|
+
* @version 187.0.0
|
|
10897
10903
|
*/ /**
|
|
10898
10904
|
* Constructs a new ExternalContactsApi.
|
|
10899
10905
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11348,7 +11354,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11348
11354
|
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(){/**
|
|
11349
11355
|
* Fax service.
|
|
11350
11356
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11351
|
-
* @version
|
|
11357
|
+
* @version 187.0.0
|
|
11352
11358
|
*/ /**
|
|
11353
11359
|
* Constructs a new FaxApi.
|
|
11354
11360
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11389,7 +11395,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11389
11395
|
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(){/**
|
|
11390
11396
|
* Flows service.
|
|
11391
11397
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11392
|
-
* @version
|
|
11398
|
+
* @version 187.0.0
|
|
11393
11399
|
*/ /**
|
|
11394
11400
|
* Constructs a new FlowsApi.
|
|
11395
11401
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11438,7 +11444,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11438
11444
|
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(){/**
|
|
11439
11445
|
* Gamification service.
|
|
11440
11446
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11441
|
-
* @version
|
|
11447
|
+
* @version 187.0.0
|
|
11442
11448
|
*/ /**
|
|
11443
11449
|
* Constructs a new GamificationApi.
|
|
11444
11450
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -11978,7 +11984,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11978
11984
|
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(){/**
|
|
11979
11985
|
* GeneralDataProtectionRegulation service.
|
|
11980
11986
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
11981
|
-
* @version
|
|
11987
|
+
* @version 187.0.0
|
|
11982
11988
|
*/ /**
|
|
11983
11989
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
11984
11990
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12013,7 +12019,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12013
12019
|
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(){/**
|
|
12014
12020
|
* Geolocation service.
|
|
12015
12021
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12016
|
-
* @version
|
|
12022
|
+
* @version 187.0.0
|
|
12017
12023
|
*/ /**
|
|
12018
12024
|
* Constructs a new GeolocationApi.
|
|
12019
12025
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12047,7 +12053,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12047
12053
|
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(){/**
|
|
12048
12054
|
* Greetings service.
|
|
12049
12055
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12050
|
-
* @version
|
|
12056
|
+
* @version 187.0.0
|
|
12051
12057
|
*/ /**
|
|
12052
12058
|
* Constructs a new GreetingsApi.
|
|
12053
12059
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12154,7 +12160,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12154
12160
|
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(){/**
|
|
12155
12161
|
* Groups service.
|
|
12156
12162
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12157
|
-
* @version
|
|
12163
|
+
* @version 187.0.0
|
|
12158
12164
|
*/ /**
|
|
12159
12165
|
* Constructs a new GroupsApi.
|
|
12160
12166
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12287,7 +12293,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12287
12293
|
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(){/**
|
|
12288
12294
|
* IdentityProvider service.
|
|
12289
12295
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12290
|
-
* @version
|
|
12296
|
+
* @version 187.0.0
|
|
12291
12297
|
*/ /**
|
|
12292
12298
|
* Constructs a new IdentityProviderApi.
|
|
12293
12299
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12295,9 +12301,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12295
12301
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
12296
12302
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
12297
12303
|
*/function IdentityProviderApi(apiClient){_classCallCheck(this,IdentityProviderApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
12304
|
+
* Delete Identity Provider
|
|
12305
|
+
*
|
|
12306
|
+
* @param {String} providerId Provider ID
|
|
12307
|
+
*/_createClass(IdentityProviderApi,[{key:"deleteIdentityprovider",value:function deleteIdentityprovider(providerId){// verify the required parameter 'providerId' is set
|
|
12308
|
+
if(providerId===undefined||providerId===null){throw'Missing the required parameter "providerId" when calling deleteIdentityprovider';}return this.apiClient.callApi('/api/v2/identityproviders/{providerId}','DELETE',{'providerId':providerId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12298
12309
|
* Delete ADFS Identity Provider
|
|
12299
12310
|
*
|
|
12300
|
-
*/
|
|
12311
|
+
*/},{key:"deleteIdentityprovidersAdfs",value:function deleteIdentityprovidersAdfs(){return this.apiClient.callApi('/api/v2/identityproviders/adfs','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12301
12312
|
* Delete Customer Interaction Center (CIC) Identity Provider
|
|
12302
12313
|
*
|
|
12303
12314
|
*/},{key:"deleteIdentityprovidersCic",value:function deleteIdentityprovidersCic(){return this.apiClient.callApi('/api/v2/identityproviders/cic','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -12328,6 +12339,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12328
12339
|
* Delete Salesforce Identity Provider
|
|
12329
12340
|
*
|
|
12330
12341
|
*/},{key:"deleteIdentityprovidersSalesforce",value:function deleteIdentityprovidersSalesforce(){return this.apiClient.callApi('/api/v2/identityproviders/salesforce','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12342
|
+
* Get Identity Provider
|
|
12343
|
+
*
|
|
12344
|
+
* @param {String} providerId Provider ID
|
|
12345
|
+
*/},{key:"getIdentityprovider",value:function getIdentityprovider(providerId){// verify the required parameter 'providerId' is set
|
|
12346
|
+
if(providerId===undefined||providerId===null){throw'Missing the required parameter "providerId" when calling getIdentityprovider';}return this.apiClient.callApi('/api/v2/identityproviders/{providerId}','GET',{'providerId':providerId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12331
12347
|
* The list of identity providers
|
|
12332
12348
|
*
|
|
12333
12349
|
*/},{key:"getIdentityproviders",value:function getIdentityproviders(){return this.apiClient.callApi('/api/v2/identityproviders','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -12364,6 +12380,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12364
12380
|
* Get Salesforce Identity Provider
|
|
12365
12381
|
*
|
|
12366
12382
|
*/},{key:"getIdentityprovidersSalesforce",value:function getIdentityprovidersSalesforce(){return this.apiClient.callApi('/api/v2/identityproviders/salesforce','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12383
|
+
* Create Identity Provider
|
|
12384
|
+
*
|
|
12385
|
+
* @param {Object} body Provider
|
|
12386
|
+
*/},{key:"postIdentityproviders",value:function postIdentityproviders(body){// verify the required parameter 'body' is set
|
|
12387
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIdentityproviders';}return this.apiClient.callApi('/api/v2/identityproviders','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12388
|
+
* Update Identity Provider
|
|
12389
|
+
*
|
|
12390
|
+
* @param {String} providerId Provider ID
|
|
12391
|
+
* @param {Object} body Provider
|
|
12392
|
+
*/},{key:"putIdentityprovider",value:function putIdentityprovider(providerId,body){// verify the required parameter 'providerId' is set
|
|
12393
|
+
if(providerId===undefined||providerId===null){throw'Missing the required parameter "providerId" when calling putIdentityprovider';}// verify the required parameter 'body' is set
|
|
12394
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovider';}return this.apiClient.callApi('/api/v2/identityproviders/{providerId}','PUT',{'providerId':providerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12367
12395
|
* Update/Create ADFS Identity Provider
|
|
12368
12396
|
*
|
|
12369
12397
|
* @param {Object} body Provider
|
|
@@ -12421,7 +12449,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12421
12449
|
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(){/**
|
|
12422
12450
|
* InfrastructureAsCode service.
|
|
12423
12451
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12424
|
-
* @version
|
|
12452
|
+
* @version 187.0.0
|
|
12425
12453
|
*/ /**
|
|
12426
12454
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12427
12455
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12475,7 +12503,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12475
12503
|
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(){/**
|
|
12476
12504
|
* Integrations service.
|
|
12477
12505
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12478
|
-
* @version
|
|
12506
|
+
* @version 187.0.0
|
|
12479
12507
|
*/ /**
|
|
12480
12508
|
* Constructs a new IntegrationsApi.
|
|
12481
12509
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -12546,6 +12574,12 @@ if(actionId===undefined||actionId===null){throw'Missing the required parameter "
|
|
|
12546
12574
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
12547
12575
|
*/},{key:"getIntegrationsActionDraft",value:function getIntegrationsActionDraft(actionId,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
12548
12576
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraft';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft','GET',{'actionId':actionId},{'expand':opts['expand'],'includeConfig':opts['includeConfig']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12577
|
+
* Get draft function settings for Action
|
|
12578
|
+
*
|
|
12579
|
+
* @param {String} actionId actionId
|
|
12580
|
+
* getIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12581
|
+
*/},{key:"getIntegrationsActionDraftFunction",value:function getIntegrationsActionDraftFunction(actionId){// verify the required parameter 'actionId' is set
|
|
12582
|
+
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftFunction';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/function','GET',{'actionId':actionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12549
12583
|
* Retrieve schema for a Draft based on filename.
|
|
12550
12584
|
*
|
|
12551
12585
|
* @param {String} actionId actionId
|
|
@@ -12565,6 +12599,12 @@ if(fileName===undefined||fileName===null){throw'Missing the required parameter "
|
|
|
12565
12599
|
* @param {String} actionId actionId
|
|
12566
12600
|
*/},{key:"getIntegrationsActionDraftValidation",value:function getIntegrationsActionDraftValidation(actionId){// verify the required parameter 'actionId' is set
|
|
12567
12601
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftValidation';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/validation','GET',{'actionId':actionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12602
|
+
* Get published function settings for Action
|
|
12603
|
+
*
|
|
12604
|
+
* @param {String} actionId actionId
|
|
12605
|
+
* getIntegrationsActionFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12606
|
+
*/},{key:"getIntegrationsActionFunction",value:function getIntegrationsActionFunction(actionId){// verify the required parameter 'actionId' is set
|
|
12607
|
+
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionFunction';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/function','GET',{'actionId':actionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12568
12608
|
* Retrieve schema for an action based on filename.
|
|
12569
12609
|
*
|
|
12570
12610
|
* @param {String} actionId actionId
|
|
@@ -12626,6 +12666,10 @@ if(fileName===undefined||fileName===null){throw'Missing the required parameter "
|
|
|
12626
12666
|
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
12627
12667
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
12628
12668
|
*/},{key:"getIntegrationsActionsDrafts",value:function getIntegrationsActionsDrafts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/actions/drafts','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'category':opts['category'],'name':opts['name'],'ids':opts['ids'],'secure':opts['secure'],'includeAuthActions':opts['includeAuthActions']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12669
|
+
* Get action function settings for Action
|
|
12670
|
+
*
|
|
12671
|
+
* getIntegrationsActionsFunctionsRuntimes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12672
|
+
*/},{key:"getIntegrationsActionsFunctionsRuntimes",value:function getIntegrationsActionsFunctionsRuntimes(){return this.apiClient.callApi('/api/v2/integrations/actions/functions/runtimes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12629
12673
|
* Get a specific botConnector bot, plus versions, for this integration
|
|
12630
12674
|
*
|
|
12631
12675
|
* @param {String} integrationId The integration ID for this group of bots
|
|
@@ -12887,6 +12931,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12887
12931
|
* @param {String} actionId actionId
|
|
12888
12932
|
*/},{key:"postIntegrationsActionDraft",value:function postIntegrationsActionDraft(actionId){// verify the required parameter 'actionId' is set
|
|
12889
12933
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraft';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft','POST',{'actionId':actionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12934
|
+
* Create upload presigned URL for draft function package file.
|
|
12935
|
+
*
|
|
12936
|
+
* @param {String} actionId actionId
|
|
12937
|
+
* @param {Object} body Input used to request URL upload.
|
|
12938
|
+
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12939
|
+
*/},{key:"postIntegrationsActionDraftFunctionUpload",value:function postIntegrationsActionDraftFunctionUpload(actionId,body){// verify the required parameter 'actionId' is set
|
|
12940
|
+
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';}// verify the required parameter 'body' is set
|
|
12941
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/function/upload','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12890
12942
|
* Publish a Draft and make it the active Action configuration
|
|
12891
12943
|
*
|
|
12892
12944
|
* @param {String} actionId actionId
|
|
@@ -12966,6 +13018,14 @@ if(settings===undefined||settings===null){throw'Missing the required parameter "
|
|
|
12966
13018
|
* @param {Object} opts.body Integration Configuration
|
|
12967
13019
|
*/},{key:"putIntegrationConfigCurrent",value:function putIntegrationConfigCurrent(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
12968
13020
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putIntegrationConfigCurrent';}return this.apiClient.callApi('/api/v2/integrations/{integrationId}/config/current','PUT',{'integrationId':integrationId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13021
|
+
* Update draft function settings.
|
|
13022
|
+
*
|
|
13023
|
+
* @param {String} actionId actionId
|
|
13024
|
+
* @param {Object} body Input used to update function settings.
|
|
13025
|
+
* putIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13026
|
+
*/},{key:"putIntegrationsActionDraftFunction",value:function putIntegrationsActionDraftFunction(actionId,body){// verify the required parameter 'actionId' is set
|
|
13027
|
+
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling putIntegrationsActionDraftFunction';}// verify the required parameter 'body' is set
|
|
13028
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsActionDraftFunction';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/function','PUT',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12969
13029
|
* Set a list of botConnector bots plus versions for this integration
|
|
12970
13030
|
*
|
|
12971
13031
|
* @param {String} integrationId The integration ID for this group of bots
|
|
@@ -13002,7 +13062,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13002
13062
|
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(){/**
|
|
13003
13063
|
* Journey service.
|
|
13004
13064
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13005
|
-
* @version
|
|
13065
|
+
* @version 187.0.0
|
|
13006
13066
|
*/ /**
|
|
13007
13067
|
* Constructs a new JourneyApi.
|
|
13008
13068
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13197,17 +13257,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
13197
13257
|
* @param {String} sessionId ID of the session.
|
|
13198
13258
|
*/},{key:"getJourneySessionOutcomescores",value:function getJourneySessionOutcomescores(sessionId){// verify the required parameter 'sessionId' is set
|
|
13199
13259
|
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getJourneySessionOutcomescores';}return this.apiClient.callApi('/api/v2/journey/sessions/{sessionId}/outcomescores','GET',{'sessionId':sessionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13200
|
-
* Retrieve segment assignments by session ID.
|
|
13201
|
-
*
|
|
13202
|
-
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
13203
|
-
* @param {Object} opts Optional parameters
|
|
13204
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
13205
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13206
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
13207
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
13208
|
-
* getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13209
|
-
*/},{key:"getJourneySessionSegments",value:function getJourneySessionSegments(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
13210
|
-
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getJourneySessionSegments';}return this.apiClient.callApi('/api/v2/journey/sessions/{sessionId}/segments','GET',{'sessionId':sessionId},{'pageSize':opts['pageSize'],'after':opts['after'],'segmentScope':opts['segmentScope'],'assignmentState':opts['assignmentState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13211
13260
|
* Update single action map.
|
|
13212
13261
|
*
|
|
13213
13262
|
* @param {String} actionMapId ID of the action map.
|
|
@@ -13306,7 +13355,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
13306
13355
|
*/},{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']);}}]);return JourneyApi;}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
13307
13356
|
* Knowledge service.
|
|
13308
13357
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13309
|
-
* @version
|
|
13358
|
+
* @version 187.0.0
|
|
13310
13359
|
*/ /**
|
|
13311
13360
|
* Constructs a new KnowledgeApi.
|
|
13312
13361
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -13708,6 +13757,26 @@ if(trainingId===undefined||trainingId===null){throw'Missing the required paramet
|
|
|
13708
13757
|
*/},{key:"getKnowledgeKnowledgebaseLanguageTrainings",value:function getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId,languageCode,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
13709
13758
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTrainings';}// verify the required parameter 'languageCode' is set
|
|
13710
13759
|
if(languageCode===undefined||languageCode===null){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTrainings';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings','GET',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{'before':opts['before'],'after':opts['after'],'limit':opts['limit'],'pageSize':opts['pageSize'],'knowledgeDocumentsState':opts['knowledgeDocumentsState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13760
|
+
* Get operations
|
|
13761
|
+
*
|
|
13762
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
13763
|
+
* @param {Object} opts Optional parameters
|
|
13764
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
13765
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13766
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
13767
|
+
* @param {Array.<String>} opts.userId If specified, retrieves operations associated with user ids, comma separated values expected.
|
|
13768
|
+
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
13769
|
+
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
13770
|
+
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
13771
|
+
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13772
|
+
*/},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
13773
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'userId':this.apiClient.buildCollectionParam(opts['userId'],'multi'),'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'interval':opts['interval']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13774
|
+
* Get ids of operation creator users and oauth clients
|
|
13775
|
+
*
|
|
13776
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
13777
|
+
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13778
|
+
*/},{key:"getKnowledgeKnowledgebaseOperationsUsersQuery",value:function getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId){// verify the required parameter 'knowledgeBaseId' is set
|
|
13779
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query','GET',{'knowledgeBaseId':knowledgeBaseId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13711
13780
|
* Get knowledge base unanswered group for a particular groupId
|
|
13712
13781
|
*
|
|
13713
13782
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -14103,7 +14172,7 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14103
14172
|
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(){/**
|
|
14104
14173
|
* LanguageUnderstanding service.
|
|
14105
14174
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14106
|
-
* @version
|
|
14175
|
+
* @version 187.0.0
|
|
14107
14176
|
*/ /**
|
|
14108
14177
|
* Constructs a new LanguageUnderstandingApi.
|
|
14109
14178
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14359,7 +14428,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14359
14428
|
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(){/**
|
|
14360
14429
|
* Languages service.
|
|
14361
14430
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14362
|
-
* @version
|
|
14431
|
+
* @version 187.0.0
|
|
14363
14432
|
*/ /**
|
|
14364
14433
|
* Constructs a new LanguagesApi.
|
|
14365
14434
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14414,7 +14483,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14414
14483
|
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(){/**
|
|
14415
14484
|
* Learning service.
|
|
14416
14485
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14417
|
-
* @version
|
|
14486
|
+
* @version 187.0.0
|
|
14418
14487
|
*/ /**
|
|
14419
14488
|
* Constructs a new LearningApi.
|
|
14420
14489
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -14644,7 +14713,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
14644
14713
|
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(){/**
|
|
14645
14714
|
* License service.
|
|
14646
14715
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
14647
|
-
* @version
|
|
14716
|
+
* @version 187.0.0
|
|
14648
14717
|
*/ /**
|
|
14649
14718
|
* Constructs a new LicenseApi.
|
|
14650
14719
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -14698,7 +14767,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
14698
14767
|
*/},{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(){/**
|
|
14699
14768
|
* Locations service.
|
|
14700
14769
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
14701
|
-
* @version
|
|
14770
|
+
* @version 187.0.0
|
|
14702
14771
|
*/ /**
|
|
14703
14772
|
* Constructs a new LocationsApi.
|
|
14704
14773
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -14757,7 +14826,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14757
14826
|
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(){/**
|
|
14758
14827
|
* LogCapture service.
|
|
14759
14828
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
14760
|
-
* @version
|
|
14829
|
+
* @version 187.0.0
|
|
14761
14830
|
*/ /**
|
|
14762
14831
|
* Constructs a new LogCaptureApi.
|
|
14763
14832
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -14807,7 +14876,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14807
14876
|
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(){/**
|
|
14808
14877
|
* Messaging service.
|
|
14809
14878
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
14810
|
-
* @version
|
|
14879
|
+
* @version 187.0.0
|
|
14811
14880
|
*/ /**
|
|
14812
14881
|
* Constructs a new MessagingApi.
|
|
14813
14882
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -14897,7 +14966,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14897
14966
|
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(){/**
|
|
14898
14967
|
* MobileDevices service.
|
|
14899
14968
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
14900
|
-
* @version
|
|
14969
|
+
* @version 187.0.0
|
|
14901
14970
|
*/ /**
|
|
14902
14971
|
* Constructs a new MobileDevicesApi.
|
|
14903
14972
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -14936,7 +15005,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14936
15005
|
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(){/**
|
|
14937
15006
|
* Notifications service.
|
|
14938
15007
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
14939
|
-
* @version
|
|
15008
|
+
* @version 187.0.0
|
|
14940
15009
|
*/ /**
|
|
14941
15010
|
* Constructs a new NotificationsApi.
|
|
14942
15011
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -14993,7 +15062,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
14993
15062
|
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(){/**
|
|
14994
15063
|
* OAuth service.
|
|
14995
15064
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
14996
|
-
* @version
|
|
15065
|
+
* @version 187.0.0
|
|
14997
15066
|
*/ /**
|
|
14998
15067
|
* Constructs a new OAuthApi.
|
|
14999
15068
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -15078,7 +15147,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
15078
15147
|
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(){/**
|
|
15079
15148
|
* Objects service.
|
|
15080
15149
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
15081
|
-
* @version
|
|
15150
|
+
* @version 187.0.0
|
|
15082
15151
|
*/ /**
|
|
15083
15152
|
* Constructs a new ObjectsApi.
|
|
15084
15153
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -15148,7 +15217,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15148
15217
|
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(){/**
|
|
15149
15218
|
* OperationalEvents service.
|
|
15150
15219
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15151
|
-
* @version
|
|
15220
|
+
* @version 187.0.0
|
|
15152
15221
|
*/ /**
|
|
15153
15222
|
* Constructs a new OperationalEventsApi.
|
|
15154
15223
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15166,7 +15235,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15166
15235
|
*/},{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(){/**
|
|
15167
15236
|
* Organization service.
|
|
15168
15237
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15169
|
-
* @version
|
|
15238
|
+
* @version 187.0.0
|
|
15170
15239
|
*/ /**
|
|
15171
15240
|
* Constructs a new OrganizationApi.
|
|
15172
15241
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15268,7 +15337,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15268
15337
|
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(){/**
|
|
15269
15338
|
* OrganizationAuthorization service.
|
|
15270
15339
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15271
|
-
* @version
|
|
15340
|
+
* @version 187.0.0
|
|
15272
15341
|
*/ /**
|
|
15273
15342
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15274
15343
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -15591,7 +15660,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
15591
15660
|
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(){/**
|
|
15592
15661
|
* Outbound service.
|
|
15593
15662
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
15594
|
-
* @version
|
|
15663
|
+
* @version 187.0.0
|
|
15595
15664
|
*/ /**
|
|
15596
15665
|
* Constructs a new OutboundApi.
|
|
15597
15666
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -15699,6 +15768,16 @@ if(dncListId===undefined||dncListId===null){throw'Missing the required parameter
|
|
|
15699
15768
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
15700
15769
|
*/},{key:"deleteOutboundDnclistPhonenumbers",value:function deleteOutboundDnclistPhonenumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
15701
15770
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/phonenumbers','DELETE',{'dncListId':dncListId},{'expiredOnly':opts['expiredOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15771
|
+
* Delete File Specification Template
|
|
15772
|
+
*
|
|
15773
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
15774
|
+
*/},{key:"deleteOutboundFilespecificationtemplate",value:function deleteOutboundFilespecificationtemplate(fileSpecificationTemplateId){// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
15775
|
+
if(fileSpecificationTemplateId===undefined||fileSpecificationTemplateId===null){throw'Missing the required parameter "fileSpecificationTemplateId" when calling deleteOutboundFilespecificationtemplate';}return this.apiClient.callApi('/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}','DELETE',{'fileSpecificationTemplateId':fileSpecificationTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15776
|
+
* Delete multiple file specification templates.
|
|
15777
|
+
*
|
|
15778
|
+
* @param {Array.<String>} id File Specification template id(s) to delete
|
|
15779
|
+
*/},{key:"deleteOutboundFilespecificationtemplatesBulk",value:function deleteOutboundFilespecificationtemplatesBulk(id){// verify the required parameter 'id' is set
|
|
15780
|
+
if(id===undefined||id===null){throw'Missing the required parameter "id" when calling deleteOutboundFilespecificationtemplatesBulk';}return this.apiClient.callApi('/api/v2/outbound/filespecificationtemplates/bulk','DELETE',{},{'id':this.apiClient.buildCollectionParam(id,'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15702
15781
|
* Delete Import Template
|
|
15703
15782
|
*
|
|
15704
15783
|
* @param {String} importTemplateId Import Template ID
|
|
@@ -16087,6 +16166,22 @@ if(eventId===undefined||eventId===null){throw'Missing the required parameter "ev
|
|
|
16087
16166
|
* @param {String} opts.sortBy Sort by
|
|
16088
16167
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
16089
16168
|
*/},{key:"getOutboundEvents",value:function getOutboundEvents(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/events','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'filterType':opts['filterType'],'category':opts['category'],'level':opts['level'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16169
|
+
* Get File Specification Template
|
|
16170
|
+
*
|
|
16171
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
16172
|
+
*/},{key:"getOutboundFilespecificationtemplate",value:function getOutboundFilespecificationtemplate(fileSpecificationTemplateId){// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
16173
|
+
if(fileSpecificationTemplateId===undefined||fileSpecificationTemplateId===null){throw'Missing the required parameter "fileSpecificationTemplateId" when calling getOutboundFilespecificationtemplate';}return this.apiClient.callApi('/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}','GET',{'fileSpecificationTemplateId':fileSpecificationTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16174
|
+
* Query File Specification Templates
|
|
16175
|
+
*
|
|
16176
|
+
* @param {Object} opts Optional parameters
|
|
16177
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
16178
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16179
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
16180
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
16181
|
+
* @param {String} opts.name Name
|
|
16182
|
+
* @param {String} opts.sortBy Sort by
|
|
16183
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
16184
|
+
*/},{key:"getOutboundFilespecificationtemplates",value:function getOutboundFilespecificationtemplates(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/filespecificationtemplates','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'allowEmptyResult':opts['allowEmptyResult'],'filterType':opts['filterType'],'name':opts['name'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16090
16185
|
* Get Import Template
|
|
16091
16186
|
*
|
|
16092
16187
|
* @param {String} importTemplateId Import Template ID
|
|
@@ -16359,6 +16454,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16359
16454
|
* @param {Array.<Object>} body contact list template(s) to add
|
|
16360
16455
|
*/},{key:"postOutboundContactlisttemplatesBulkAdd",value:function postOutboundContactlisttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
16361
16456
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates/bulk/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16457
|
+
* Get multiple contact list templates
|
|
16458
|
+
*
|
|
16459
|
+
* @param {Object} body contact list templates to get
|
|
16460
|
+
*/},{key:"postOutboundContactlisttemplatesBulkRetrieve",value:function postOutboundContactlisttemplatesBulkRetrieve(body){// verify the required parameter 'body' is set
|
|
16461
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkRetrieve';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates/bulk/retrieve','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16362
16462
|
* Add phone numbers to a Dialer DNC list.
|
|
16363
16463
|
*
|
|
16364
16464
|
* @param {String} conversationId Conversation ID
|
|
@@ -16395,6 +16495,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16395
16495
|
* @param {Object} body DncList
|
|
16396
16496
|
*/},{key:"postOutboundDnclists",value:function postOutboundDnclists(body){// verify the required parameter 'body' is set
|
|
16397
16497
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundDnclists';}return this.apiClient.callApi('/api/v2/outbound/dnclists','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16498
|
+
* Create File Specification Template
|
|
16499
|
+
*
|
|
16500
|
+
* @param {Object} body FileSpecificationTemplate
|
|
16501
|
+
*/},{key:"postOutboundFilespecificationtemplates",value:function postOutboundFilespecificationtemplates(body){// verify the required parameter 'body' is set
|
|
16502
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundFilespecificationtemplates';}return this.apiClient.callApi('/api/v2/outbound/filespecificationtemplates','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16398
16503
|
* Create Import Template
|
|
16399
16504
|
*
|
|
16400
16505
|
* @param {Object} body ImportTemplate
|
|
@@ -16513,6 +16618,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16513
16618
|
*/},{key:"putOutboundDnclist",value:function putOutboundDnclist(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
16514
16619
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling putOutboundDnclist';}// verify the required parameter 'body' is set
|
|
16515
16620
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundDnclist';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}','PUT',{'dncListId':dncListId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16621
|
+
* Update File Specification Template
|
|
16622
|
+
*
|
|
16623
|
+
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
16624
|
+
* @param {Object} body fileSpecificationTemplate
|
|
16625
|
+
*/},{key:"putOutboundFilespecificationtemplate",value:function putOutboundFilespecificationtemplate(fileSpecificationTemplateId,body){// verify the required parameter 'fileSpecificationTemplateId' is set
|
|
16626
|
+
if(fileSpecificationTemplateId===undefined||fileSpecificationTemplateId===null){throw'Missing the required parameter "fileSpecificationTemplateId" when calling putOutboundFilespecificationtemplate';}// verify the required parameter 'body' is set
|
|
16627
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundFilespecificationtemplate';}return this.apiClient.callApi('/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}','PUT',{'fileSpecificationTemplateId':fileSpecificationTemplateId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16516
16628
|
* Update Import Template
|
|
16517
16629
|
*
|
|
16518
16630
|
* @param {String} importTemplateId Import Template ID
|
|
@@ -16576,7 +16688,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16576
16688
|
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(){/**
|
|
16577
16689
|
* Presence service.
|
|
16578
16690
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
16579
|
-
* @version
|
|
16691
|
+
* @version 187.0.0
|
|
16580
16692
|
*/ /**
|
|
16581
16693
|
* Constructs a new PresenceApi.
|
|
16582
16694
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -16594,9 +16706,10 @@ if(definitionId===undefined||definitionId===null){throw'Missing the required par
|
|
|
16594
16706
|
* @param {String} sourceId Presence Source ID
|
|
16595
16707
|
*/},{key:"deletePresenceSource",value:function deletePresenceSource(sourceId){// verify the required parameter 'sourceId' is set
|
|
16596
16708
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling deletePresenceSource';}return this.apiClient.callApi('/api/v2/presence/sources/{sourceId}','DELETE',{'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16597
|
-
* Delete a Presence Definition
|
|
16709
|
+
* Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
|
|
16598
16710
|
*
|
|
16599
16711
|
* @param {String} presenceId Organization Presence ID
|
|
16712
|
+
* @deprecated
|
|
16600
16713
|
*/},{key:"deletePresencedefinition",value:function deletePresencedefinition(presenceId){// verify the required parameter 'presenceId' is set
|
|
16601
16714
|
if(presenceId===undefined||presenceId===null){throw'Missing the required parameter "presenceId" when calling deletePresencedefinition';}return this.apiClient.callApi('/api/v2/presencedefinitions/{presenceId}','DELETE',{'presenceId':presenceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16602
16715
|
* Get a Presence Definition
|
|
@@ -16631,20 +16744,22 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
16631
16744
|
* @param {String} userId user ID
|
|
16632
16745
|
*/},{key:"getPresenceUserPrimarysource",value:function getPresenceUserPrimarysource(userId){// verify the required parameter 'userId' is set
|
|
16633
16746
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getPresenceUserPrimarysource';}return this.apiClient.callApi('/api/v2/presence/users/{userId}/primarysource','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16634
|
-
* Get a Presence Definition
|
|
16747
|
+
* Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
|
|
16635
16748
|
*
|
|
16636
16749
|
* @param {String} presenceId Organization Presence ID
|
|
16637
16750
|
* @param {Object} opts Optional parameters
|
|
16638
16751
|
* @param {String} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
16752
|
+
* @deprecated
|
|
16639
16753
|
*/},{key:"getPresencedefinition",value:function getPresencedefinition(presenceId,opts){opts=opts||{};// verify the required parameter 'presenceId' is set
|
|
16640
16754
|
if(presenceId===undefined||presenceId===null){throw'Missing the required parameter "presenceId" when calling getPresencedefinition';}return this.apiClient.callApi('/api/v2/presencedefinitions/{presenceId}','GET',{'presenceId':presenceId},{'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16641
|
-
* Get an Organization's list of Presence Definitions
|
|
16755
|
+
* Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
|
|
16642
16756
|
*
|
|
16643
16757
|
* @param {Object} opts Optional parameters
|
|
16644
16758
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16645
16759
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16646
16760
|
* @param {String} opts.deleted Deleted query can be TRUE, FALSE or ALL (default to false)
|
|
16647
16761
|
* @param {String} opts.localeCode The locale code to fetch for each presence definition. Use ALL to fetch everything.
|
|
16762
|
+
* @deprecated
|
|
16648
16763
|
*/},{key:"getPresencedefinitions",value:function getPresencedefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/presencedefinitions','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'deleted':opts['deleted'],'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16649
16764
|
* Get the list of SystemPresences
|
|
16650
16765
|
*
|
|
@@ -16699,9 +16814,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16699
16814
|
* @param {Object} body The Presence Source to create
|
|
16700
16815
|
*/},{key:"postPresenceSources",value:function postPresenceSources(body){// verify the required parameter 'body' is set
|
|
16701
16816
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postPresenceSources';}return this.apiClient.callApi('/api/v2/presence/sources','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16702
|
-
* Create a Presence Definition
|
|
16817
|
+
* Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
|
|
16703
16818
|
*
|
|
16704
16819
|
* @param {Object} body The Presence Definition to create
|
|
16820
|
+
* @deprecated
|
|
16705
16821
|
*/},{key:"postPresencedefinitions",value:function postPresencedefinitions(body){// verify the required parameter 'body' is set
|
|
16706
16822
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postPresencedefinitions';}return this.apiClient.callApi('/api/v2/presencedefinitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16707
16823
|
* Update a Presence Definition
|
|
@@ -16730,10 +16846,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16730
16846
|
*/},{key:"putPresenceUserPrimarysource",value:function putPresenceUserPrimarysource(userId,body){// verify the required parameter 'userId' is set
|
|
16731
16847
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling putPresenceUserPrimarysource';}// verify the required parameter 'body' is set
|
|
16732
16848
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putPresenceUserPrimarysource';}return this.apiClient.callApi('/api/v2/presence/users/{userId}/primarysource','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16733
|
-
* Update a Presence Definition
|
|
16849
|
+
* Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
|
|
16734
16850
|
*
|
|
16735
16851
|
* @param {String} presenceId Organization Presence ID
|
|
16736
16852
|
* @param {Object} body The OrganizationPresence to update
|
|
16853
|
+
* @deprecated
|
|
16737
16854
|
*/},{key:"putPresencedefinition",value:function putPresencedefinition(presenceId,body){// verify the required parameter 'presenceId' is set
|
|
16738
16855
|
if(presenceId===undefined||presenceId===null){throw'Missing the required parameter "presenceId" when calling putPresencedefinition';}// verify the required parameter 'body' is set
|
|
16739
16856
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putPresencedefinition';}return this.apiClient.callApi('/api/v2/presencedefinitions/{presenceId}','PUT',{'presenceId':presenceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16744,7 +16861,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16744
16861
|
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(){/**
|
|
16745
16862
|
* ProcessAutomation service.
|
|
16746
16863
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
16747
|
-
* @version
|
|
16864
|
+
* @version 187.0.0
|
|
16748
16865
|
*/ /**
|
|
16749
16866
|
* Constructs a new ProcessAutomationApi.
|
|
16750
16867
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -16807,7 +16924,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
16807
16924
|
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(){/**
|
|
16808
16925
|
* Quality service.
|
|
16809
16926
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
16810
|
-
* @version
|
|
16927
|
+
* @version 187.0.0
|
|
16811
16928
|
*/ /**
|
|
16812
16929
|
* Constructs a new QualityApi.
|
|
16813
16930
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -17278,7 +17395,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17278
17395
|
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(){/**
|
|
17279
17396
|
* Recording service.
|
|
17280
17397
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17281
|
-
* @version
|
|
17398
|
+
* @version 187.0.0
|
|
17282
17399
|
*/ /**
|
|
17283
17400
|
* Constructs a new RecordingApi.
|
|
17284
17401
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -17685,7 +17802,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17685
17802
|
*/},{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(){/**
|
|
17686
17803
|
* ResponseManagement service.
|
|
17687
17804
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
17688
|
-
* @version
|
|
17805
|
+
* @version 187.0.0
|
|
17689
17806
|
*/ /**
|
|
17690
17807
|
* Constructs a new ResponseManagementApi.
|
|
17691
17808
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -17801,7 +17918,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
17801
17918
|
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(){/**
|
|
17802
17919
|
* Routing service.
|
|
17803
17920
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
17804
|
-
* @version
|
|
17921
|
+
* @version 187.0.0
|
|
17805
17922
|
*/ /**
|
|
17806
17923
|
* Constructs a new RoutingApi.
|
|
17807
17924
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -18769,7 +18886,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18769
18886
|
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(){/**
|
|
18770
18887
|
* SCIM service.
|
|
18771
18888
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
18772
|
-
* @version
|
|
18889
|
+
* @version 187.0.0
|
|
18773
18890
|
*/ /**
|
|
18774
18891
|
* Constructs a new SCIMApi.
|
|
18775
18892
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -18991,10 +19108,25 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18991
19108
|
* @param {String} opts.ifMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: 42. If the ETag is different from the version on the server, returns 400 with a scimType of invalidVers.
|
|
18992
19109
|
*/},{key:"putScimV2User",value:function putScimV2User(userId,body,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
18993
19110
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling putScimV2User';}// verify the required parameter 'body' is set
|
|
18994
|
-
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
|
|
19111
|
+
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(){/**
|
|
19112
|
+
* ScreenRecording service.
|
|
19113
|
+
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
19114
|
+
* @version 187.0.0
|
|
19115
|
+
*/ /**
|
|
19116
|
+
* Constructs a new ScreenRecordingApi.
|
|
19117
|
+
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
19118
|
+
* @class
|
|
19119
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
19120
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
19121
|
+
*/function ScreenRecordingApi(apiClient){_classCallCheck(this,ScreenRecordingApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
19122
|
+
* Sign identifying information for screen recording
|
|
19123
|
+
*
|
|
19124
|
+
* @param {Object} opts Optional parameters
|
|
19125
|
+
* @param {Object} opts.body
|
|
19126
|
+
*/_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(){/**
|
|
18995
19127
|
* Scripts service.
|
|
18996
19128
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
18997
|
-
* @version
|
|
19129
|
+
* @version 187.0.0
|
|
18998
19130
|
*/ /**
|
|
18999
19131
|
* Constructs a new ScriptsApi.
|
|
19000
19132
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -19130,7 +19262,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
19130
19262
|
*/},{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(){/**
|
|
19131
19263
|
* Search service.
|
|
19132
19264
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
19133
|
-
* @version
|
|
19265
|
+
* @version 187.0.0
|
|
19134
19266
|
*/ /**
|
|
19135
19267
|
* Constructs a new SearchApi.
|
|
19136
19268
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -19290,7 +19422,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19290
19422
|
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(){/**
|
|
19291
19423
|
* Settings service.
|
|
19292
19424
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
19293
|
-
* @version
|
|
19425
|
+
* @version 187.0.0
|
|
19294
19426
|
*/ /**
|
|
19295
19427
|
* Constructs a new SettingsApi.
|
|
19296
19428
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -19308,7 +19440,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19308
19440
|
*/},{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 SettingsApi;}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
19309
19441
|
* SpeechTextAnalytics service.
|
|
19310
19442
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
19311
|
-
* @version
|
|
19443
|
+
* @version 187.0.0
|
|
19312
19444
|
*/ /**
|
|
19313
19445
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
19314
19446
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -19551,7 +19683,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
19551
19683
|
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(){/**
|
|
19552
19684
|
* Stations service.
|
|
19553
19685
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
19554
|
-
* @version
|
|
19686
|
+
* @version 187.0.0
|
|
19555
19687
|
*/ /**
|
|
19556
19688
|
* Constructs a new StationsApi.
|
|
19557
19689
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -19583,7 +19715,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
19583
19715
|
*/},{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(){/**
|
|
19584
19716
|
* Suggest service.
|
|
19585
19717
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
19586
|
-
* @version
|
|
19718
|
+
* @version 187.0.0
|
|
19587
19719
|
*/ /**
|
|
19588
19720
|
* Constructs a new SuggestApi.
|
|
19589
19721
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -19623,7 +19755,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19623
19755
|
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(){/**
|
|
19624
19756
|
* TaskManagement service.
|
|
19625
19757
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
19626
|
-
* @version
|
|
19758
|
+
* @version 187.0.0
|
|
19627
19759
|
*/ /**
|
|
19628
19760
|
* Constructs a new TaskManagementApi.
|
|
19629
19761
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -19965,7 +20097,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
19965
20097
|
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(){/**
|
|
19966
20098
|
* Teams service.
|
|
19967
20099
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
19968
|
-
* @version
|
|
20100
|
+
* @version 187.0.0
|
|
19969
20101
|
*/ /**
|
|
19970
20102
|
* Constructs a new TeamsApi.
|
|
19971
20103
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -20044,7 +20176,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20044
20176
|
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(){/**
|
|
20045
20177
|
* Telephony service.
|
|
20046
20178
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
20047
|
-
* @version
|
|
20179
|
+
* @version 187.0.0
|
|
20048
20180
|
*/ /**
|
|
20049
20181
|
* Constructs a new TelephonyApi.
|
|
20050
20182
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -20091,7 +20223,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
20091
20223
|
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(){/**
|
|
20092
20224
|
* TelephonyProvidersEdge service.
|
|
20093
20225
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
20094
|
-
* @version
|
|
20226
|
+
* @version 187.0.0
|
|
20095
20227
|
*/ /**
|
|
20096
20228
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
20097
20229
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -20448,12 +20580,6 @@ if(communicationId===undefined||communicationId===null){throw'Missing the requir
|
|
|
20448
20580
|
* @param {String} edgeIds Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.
|
|
20449
20581
|
*/},{key:"getTelephonyProvidersEdgesMetrics",value:function getTelephonyProvidersEdgesMetrics(edgeIds){// verify the required parameter 'edgeIds' is set
|
|
20450
20582
|
if(edgeIds===undefined||edgeIds===null){throw'Missing the required parameter "edgeIds" when calling getTelephonyProvidersEdgesMetrics';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/metrics','GET',{},{'edgeIds':edgeIds},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20451
|
-
* Get outbound route
|
|
20452
|
-
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
20453
|
-
* @param {String} outboundRouteId Outbound route ID
|
|
20454
|
-
* @deprecated
|
|
20455
|
-
*/},{key:"getTelephonyProvidersEdgesOutboundroute",value:function getTelephonyProvidersEdgesOutboundroute(outboundRouteId){// verify the required parameter 'outboundRouteId' is set
|
|
20456
|
-
if(outboundRouteId===undefined||outboundRouteId===null){throw'Missing the required parameter "outboundRouteId" when calling getTelephonyProvidersEdgesOutboundroute';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}','GET',{'outboundRouteId':outboundRouteId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20457
20583
|
* Get outbound routes
|
|
20458
20584
|
*
|
|
20459
20585
|
* @param {Object} opts Optional parameters
|
|
@@ -20911,7 +21037,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
20911
21037
|
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(){/**
|
|
20912
21038
|
* Textbots service.
|
|
20913
21039
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
20914
|
-
* @version
|
|
21040
|
+
* @version 187.0.0
|
|
20915
21041
|
*/ /**
|
|
20916
21042
|
* Constructs a new TextbotsApi.
|
|
20917
21043
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -20946,7 +21072,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
20946
21072
|
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(){/**
|
|
20947
21073
|
* Tokens service.
|
|
20948
21074
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
20949
|
-
* @version
|
|
21075
|
+
* @version 187.0.0
|
|
20950
21076
|
*/ /**
|
|
20951
21077
|
* Constructs a new TokensApi.
|
|
20952
21078
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -20982,7 +21108,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20982
21108
|
*/},{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(){/**
|
|
20983
21109
|
* Uploads service.
|
|
20984
21110
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
20985
|
-
* @version
|
|
21111
|
+
* @version 187.0.0
|
|
20986
21112
|
*/ /**
|
|
20987
21113
|
* Constructs a new UploadsApi.
|
|
20988
21114
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -20990,10 +21116,18 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20990
21116
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20991
21117
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20992
21118
|
*/function UploadsApi(apiClient){_classCallCheck(this,UploadsApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
21119
|
+
* Create upload presigned URL for draft function package file.
|
|
21120
|
+
*
|
|
21121
|
+
* @param {String} actionId actionId
|
|
21122
|
+
* @param {Object} body Input used to request URL upload.
|
|
21123
|
+
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21124
|
+
*/_createClass(UploadsApi,[{key:"postIntegrationsActionDraftFunctionUpload",value:function postIntegrationsActionDraftFunctionUpload(actionId,body){// verify the required parameter 'actionId' is set
|
|
21125
|
+
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';}// verify the required parameter 'body' is set
|
|
21126
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/function/upload','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20993
21127
|
* Creates a presigned URL for uploading a knowledge import file with a set of documents
|
|
20994
21128
|
*
|
|
20995
21129
|
* @param {Object} body query
|
|
20996
|
-
*/
|
|
21130
|
+
*/},{key:"postKnowledgeDocumentuploads",value:function postKnowledgeDocumentuploads(body){// verify the required parameter 'body' is set
|
|
20997
21131
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeDocumentuploads';}return this.apiClient.callApi('/api/v2/knowledge/documentuploads','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20998
21132
|
* Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner
|
|
20999
21133
|
*
|
|
@@ -21024,7 +21158,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21024
21158
|
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(){/**
|
|
21025
21159
|
* Usage service.
|
|
21026
21160
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
21027
|
-
* @version
|
|
21161
|
+
* @version 187.0.0
|
|
21028
21162
|
*/ /**
|
|
21029
21163
|
* Constructs a new UsageApi.
|
|
21030
21164
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -21075,7 +21209,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21075
21209
|
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(){/**
|
|
21076
21210
|
* UserRecordings service.
|
|
21077
21211
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
21078
|
-
* @version
|
|
21212
|
+
* @version 187.0.0
|
|
21079
21213
|
*/ /**
|
|
21080
21214
|
* Constructs a new UserRecordingsApi.
|
|
21081
21215
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -21124,7 +21258,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
21124
21258
|
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(){/**
|
|
21125
21259
|
* Users service.
|
|
21126
21260
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
21127
|
-
* @version
|
|
21261
|
+
* @version 187.0.0
|
|
21128
21262
|
*/ /**
|
|
21129
21263
|
* Constructs a new UsersApi.
|
|
21130
21264
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -21783,7 +21917,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
21783
21917
|
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(){/**
|
|
21784
21918
|
* Utilities service.
|
|
21785
21919
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
21786
|
-
* @version
|
|
21920
|
+
* @version 187.0.0
|
|
21787
21921
|
*/ /**
|
|
21788
21922
|
* Constructs a new UtilitiesApi.
|
|
21789
21923
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -21810,7 +21944,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21810
21944
|
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(){/**
|
|
21811
21945
|
* Voicemail service.
|
|
21812
21946
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
21813
|
-
* @version
|
|
21947
|
+
* @version 187.0.0
|
|
21814
21948
|
*/ /**
|
|
21815
21949
|
* Constructs a new VoicemailApi.
|
|
21816
21950
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -21959,7 +22093,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21959
22093
|
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(){/**
|
|
21960
22094
|
* WebChat service.
|
|
21961
22095
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
21962
|
-
* @version
|
|
22096
|
+
* @version 187.0.0
|
|
21963
22097
|
*/ /**
|
|
21964
22098
|
* Constructs a new WebChatApi.
|
|
21965
22099
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -22092,7 +22226,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22092
22226
|
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(){/**
|
|
22093
22227
|
* WebDeployments service.
|
|
22094
22228
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
22095
|
-
* @version
|
|
22229
|
+
* @version 187.0.0
|
|
22096
22230
|
*/ /**
|
|
22097
22231
|
* Constructs a new WebDeploymentsApi.
|
|
22098
22232
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -22213,7 +22347,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22213
22347
|
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(){/**
|
|
22214
22348
|
* WebMessaging service.
|
|
22215
22349
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
22216
|
-
* @version
|
|
22350
|
+
* @version 187.0.0
|
|
22217
22351
|
*/ /**
|
|
22218
22352
|
* Constructs a new WebMessagingApi.
|
|
22219
22353
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -22229,7 +22363,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
22229
22363
|
*/_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(){/**
|
|
22230
22364
|
* Widgets service.
|
|
22231
22365
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
22232
|
-
* @version
|
|
22366
|
+
* @version 187.0.0
|
|
22233
22367
|
*/ /**
|
|
22234
22368
|
* Constructs a new WidgetsApi.
|
|
22235
22369
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -22264,7 +22398,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22264
22398
|
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(){/**
|
|
22265
22399
|
* WorkforceManagement service.
|
|
22266
22400
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
22267
|
-
* @version
|
|
22401
|
+
* @version 187.0.0
|
|
22268
22402
|
*/ /**
|
|
22269
22403
|
* Constructs a new WorkforceManagementApi.
|
|
22270
22404
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -23615,7 +23749,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
23615
23749
|
* </pre>
|
|
23616
23750
|
* </p>
|
|
23617
23751
|
* @module purecloud-platform-client-v2/index
|
|
23618
|
-
* @version
|
|
23752
|
+
* @version 187.0.0
|
|
23619
23753
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23620
23754
|
* The ApiClient constructor.
|
|
23621
23755
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -23773,6 +23907,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
23773
23907
|
* The SCIMApi service constructor.
|
|
23774
23908
|
* @property {module:purecloud-platform-client-v2/api/SCIMApi}
|
|
23775
23909
|
*/this.SCIMApi=SCIMApi;/**
|
|
23910
|
+
* The ScreenRecordingApi service constructor.
|
|
23911
|
+
* @property {module:purecloud-platform-client-v2/api/ScreenRecordingApi}
|
|
23912
|
+
*/this.ScreenRecordingApi=ScreenRecordingApi;/**
|
|
23776
23913
|
* The ScriptsApi service constructor.
|
|
23777
23914
|
* @property {module:purecloud-platform-client-v2/api/ScriptsApi}
|
|
23778
23915
|
*/this.ScriptsApi=ScriptsApi;/**
|