purecloud-platform-client-v2 208.0.0 → 210.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1514 -138
- package/dist/web-amd/purecloud-platform-client-v2.js +1514 -138
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +516 -150
- package/dist/web-cjs/purecloud-platform-client-v2.js +697 -259
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +3829 -3147
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- 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 +1 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +175 -0
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +240 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -9
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
- 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 +52 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +5 -3
- 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 +29 -25
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +910 -0
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +11 -19
- package/src/purecloud-platform-client-v2/index.js +13 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -515,10 +515,10 @@ indexes===true?renderKey([key],index,dots):indexes===null?key:key+'[]',convertVa
|
|
|
515
515
|
*
|
|
516
516
|
* @param {string} url The base of the url (e.g., http://www.google.com)
|
|
517
517
|
* @param {object} [params] The params to be appended
|
|
518
|
-
* @param {?object} options
|
|
518
|
+
* @param {?(object|Function)} options
|
|
519
519
|
*
|
|
520
520
|
* @returns {string} The formatted url
|
|
521
|
-
*/function buildURL(url,params,options){/*eslint no-param-reassign:0*/if(!params){return url;}var _encode=options&&options.encode||encode;var serializeFn=options&&options.serialize;var serializedParams;if(serializeFn){serializedParams=serializeFn(params,options);}else{serializedParams=utils$1.isURLSearchParams(params)?params.toString():new AxiosURLSearchParams(params,options).toString(_encode);}if(serializedParams){var hashmarkIndex=url.indexOf("#");if(hashmarkIndex!==-1){url=url.slice(0,hashmarkIndex);}url+=(url.indexOf('?')===-1?'?':'&')+serializedParams;}return url;}var InterceptorManager=/*#__PURE__*/function(){function InterceptorManager(){_classCallCheck(this,InterceptorManager);this.handlers=[];}/**
|
|
521
|
+
*/function buildURL(url,params,options){/*eslint no-param-reassign:0*/if(!params){return url;}var _encode=options&&options.encode||encode;if(utils$1.isFunction(options)){options={serialize:options};}var serializeFn=options&&options.serialize;var serializedParams;if(serializeFn){serializedParams=serializeFn(params,options);}else{serializedParams=utils$1.isURLSearchParams(params)?params.toString():new AxiosURLSearchParams(params,options).toString(_encode);}if(serializedParams){var hashmarkIndex=url.indexOf("#");if(hashmarkIndex!==-1){url=url.slice(0,hashmarkIndex);}url+=(url.indexOf('?')===-1?'?':'&')+serializedParams;}return url;}var InterceptorManager=/*#__PURE__*/function(){function InterceptorManager(){_classCallCheck(this,InterceptorManager);this.handlers=[];}/**
|
|
522
522
|
* Add a new interceptor to the stack
|
|
523
523
|
*
|
|
524
524
|
* @param {Function} fulfilled The function to handle `then` for a `Promise`
|
|
@@ -654,22 +654,7 @@ AxiosError.call(this,message==null?'canceled':message,AxiosError.ERR_CANCELED,co
|
|
|
654
654
|
* @param {Function} fn
|
|
655
655
|
* @param {Number} freq
|
|
656
656
|
* @return {Function}
|
|
657
|
-
*/function throttle(fn,freq){var timestamp=0;var threshold=1000/freq;var lastArgs;var timer;var invoke=function invoke(args){var now=arguments.length>1&&arguments[1]!==undefined?arguments[1]:Date.now();timestamp=now;lastArgs=null;if(timer){clearTimeout(timer);timer=null;}fn.apply(null,args);};var throttled=function throttled(){var now=Date.now();var passed=now-timestamp;for(var _len3=arguments.length,args=new Array(_len3),_key4=0;_key4<_len3;_key4++){args[_key4]=arguments[_key4];}if(passed>=threshold){invoke(args,now);}else{lastArgs=args;if(!timer){timer=setTimeout(function(){timer=null;invoke(lastArgs);},threshold-passed);}}};var flush=function flush(){return lastArgs&&invoke(lastArgs);};return[throttled,flush];}var progressEventReducer=function progressEventReducer(listener,isDownloadStream){var freq=arguments.length>2&&arguments[2]!==undefined?arguments[2]:3;var bytesNotified=0;var _speedometer=speedometer(50,250);return throttle(function(e){var loaded=e.loaded;var total=e.lengthComputable?e.total:undefined;var progressBytes=loaded-bytesNotified;var rate=_speedometer(progressBytes);var inRange=loaded<=total;bytesNotified=loaded;var data=_defineProperty({loaded:loaded,total:total,progress:total?loaded/total:undefined,bytes:progressBytes,rate:rate?rate:undefined,estimated:rate&&total&&inRange?(total-loaded)/rate:undefined,event:e,lengthComputable:total!=null},isDownloadStream?'download':'upload',true);listener(data);},freq);};var progressEventDecorator=function progressEventDecorator(total,throttled){var lengthComputable=total!=null;return[function(loaded){return throttled[0]({lengthComputable:lengthComputable,total:total,loaded:loaded});},throttled[1]];};var asyncDecorator=function asyncDecorator(fn){return function(){for(var _len4=arguments.length,args=new Array(_len4),_key5=0;_key5<_len4;_key5++){args[_key5]=arguments[_key5];}return utils$1.asap(function(){return fn.apply(void 0,args);});};};var isURLSameOrigin=platform.hasStandardBrowserEnv
|
|
658
|
-
// whether the request URL is of the same origin as current location.
|
|
659
|
-
function standardBrowserEnv(){var msie=platform.navigator&&/(msie|trident)/i.test(platform.navigator.userAgent);var urlParsingNode=document.createElement('a');var originURL;/**
|
|
660
|
-
* Parse a URL to discover its components
|
|
661
|
-
*
|
|
662
|
-
* @param {String} url The URL to be parsed
|
|
663
|
-
* @returns {Object}
|
|
664
|
-
*/function resolveURL(url){var href=url;if(msie){// IE needs attribute set twice to normalize properties
|
|
665
|
-
urlParsingNode.setAttribute('href',href);href=urlParsingNode.href;}urlParsingNode.setAttribute('href',href);// urlParsingNode provides the UrlUtils interface - http://url.spec.whatwg.org/#urlutils
|
|
666
|
-
return{href:urlParsingNode.href,protocol:urlParsingNode.protocol?urlParsingNode.protocol.replace(/:$/,''):'',host:urlParsingNode.host,search:urlParsingNode.search?urlParsingNode.search.replace(/^\?/,''):'',hash:urlParsingNode.hash?urlParsingNode.hash.replace(/^#/,''):'',hostname:urlParsingNode.hostname,port:urlParsingNode.port,pathname:urlParsingNode.pathname.charAt(0)==='/'?urlParsingNode.pathname:'/'+urlParsingNode.pathname};}originURL=resolveURL(window.location.href);/**
|
|
667
|
-
* Determine if a URL shares the same origin as the current location
|
|
668
|
-
*
|
|
669
|
-
* @param {String} requestURL The URL to test
|
|
670
|
-
* @returns {boolean} True if URL shares the same origin, otherwise false
|
|
671
|
-
*/return function isURLSameOrigin(requestURL){var parsed=utils$1.isString(requestURL)?resolveURL(requestURL):requestURL;return parsed.protocol===originURL.protocol&&parsed.host===originURL.host;};}():// Non standard browser envs (web workers, react-native) lack needed support.
|
|
672
|
-
function nonStandardBrowserEnv(){return function isURLSameOrigin(){return true;};}();var cookies=platform.hasStandardBrowserEnv?// Standard browser envs support document.cookie
|
|
657
|
+
*/function throttle(fn,freq){var timestamp=0;var threshold=1000/freq;var lastArgs;var timer;var invoke=function invoke(args){var now=arguments.length>1&&arguments[1]!==undefined?arguments[1]:Date.now();timestamp=now;lastArgs=null;if(timer){clearTimeout(timer);timer=null;}fn.apply(null,args);};var throttled=function throttled(){var now=Date.now();var passed=now-timestamp;for(var _len3=arguments.length,args=new Array(_len3),_key4=0;_key4<_len3;_key4++){args[_key4]=arguments[_key4];}if(passed>=threshold){invoke(args,now);}else{lastArgs=args;if(!timer){timer=setTimeout(function(){timer=null;invoke(lastArgs);},threshold-passed);}}};var flush=function flush(){return lastArgs&&invoke(lastArgs);};return[throttled,flush];}var progressEventReducer=function progressEventReducer(listener,isDownloadStream){var freq=arguments.length>2&&arguments[2]!==undefined?arguments[2]:3;var bytesNotified=0;var _speedometer=speedometer(50,250);return throttle(function(e){var loaded=e.loaded;var total=e.lengthComputable?e.total:undefined;var progressBytes=loaded-bytesNotified;var rate=_speedometer(progressBytes);var inRange=loaded<=total;bytesNotified=loaded;var data=_defineProperty({loaded:loaded,total:total,progress:total?loaded/total:undefined,bytes:progressBytes,rate:rate?rate:undefined,estimated:rate&&total&&inRange?(total-loaded)/rate:undefined,event:e,lengthComputable:total!=null},isDownloadStream?'download':'upload',true);listener(data);},freq);};var progressEventDecorator=function progressEventDecorator(total,throttled){var lengthComputable=total!=null;return[function(loaded){return throttled[0]({lengthComputable:lengthComputable,total:total,loaded:loaded});},throttled[1]];};var asyncDecorator=function asyncDecorator(fn){return function(){for(var _len4=arguments.length,args=new Array(_len4),_key5=0;_key5<_len4;_key5++){args[_key5]=arguments[_key5];}return utils$1.asap(function(){return fn.apply(void 0,args);});};};var isURLSameOrigin=platform.hasStandardBrowserEnv?function(origin,isMSIE){return function(url){url=new URL(url,platform.origin);return origin.protocol===url.protocol&&origin.host===url.host&&(isMSIE||origin.port===url.port);};}(new URL(platform.origin),platform.navigator&&/(msie|trident)/i.test(platform.navigator.userAgent)):function(){return true;};var cookies=platform.hasStandardBrowserEnv?// Standard browser envs support document.cookie
|
|
673
658
|
{write:function write(name,value,expires,path,domain,secure){var cookie=[name+'='+encodeURIComponent(value)];utils$1.isNumber(expires)&&cookie.push('expires='+new Date(expires).toGMTString());utils$1.isString(path)&&cookie.push('path='+path);utils$1.isString(domain)&&cookie.push('domain='+domain);secure===true&&cookie.push('secure');document.cookie=cookie.join('; ');},read:function read(name){var match=document.cookie.match(new RegExp('(^|;\\s*)('+name+')=([^;]*)'));return match?decodeURIComponent(match[3]):null;},remove:function remove(name){this.write(name,'',Date.now()-86400000);}}:// Non-standard browser env (web workers, react-native) lack needed support.
|
|
674
659
|
{write:function write(){},read:function read(){return null;},remove:function remove(){}};/**
|
|
675
660
|
* Determines whether the specified URL is absolute
|
|
@@ -705,11 +690,11 @@ return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);}/**
|
|
|
705
690
|
*
|
|
706
691
|
* @returns {Object} New object resulting from merging config2 to config1
|
|
707
692
|
*/function mergeConfig(config1,config2){// eslint-disable-next-line no-param-reassign
|
|
708
|
-
config2=config2||{};var config={};function getMergedValue(target,source,caseless){if(utils$1.isPlainObject(target)&&utils$1.isPlainObject(source)){return utils$1.merge.call({caseless:caseless},target,source);}else if(utils$1.isPlainObject(source)){return utils$1.merge({},source);}else if(utils$1.isArray(source)){return source.slice();}return source;}// eslint-disable-next-line consistent-return
|
|
709
|
-
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
|
|
693
|
+
config2=config2||{};var config={};function getMergedValue(target,source,prop,caseless){if(utils$1.isPlainObject(target)&&utils$1.isPlainObject(source)){return utils$1.merge.call({caseless:caseless},target,source);}else if(utils$1.isPlainObject(source)){return utils$1.merge({},source);}else if(utils$1.isArray(source)){return source.slice();}return source;}// eslint-disable-next-line consistent-return
|
|
694
|
+
function mergeDeepProperties(a,b,prop,caseless){if(!utils$1.isUndefined(b)){return getMergedValue(a,b,prop,caseless);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a,prop,caseless);}}// eslint-disable-next-line consistent-return
|
|
710
695
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
711
696
|
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
|
|
712
|
-
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 resolveConfig=function resolveConfig(config){var newConfig=mergeConfig({},config);var data=newConfig.data,withXSRFToken=newConfig.withXSRFToken,xsrfHeaderName=newConfig.xsrfHeaderName,xsrfCookieName=newConfig.xsrfCookieName,headers=newConfig.headers,auth=newConfig.auth;newConfig.headers=headers=AxiosHeaders$1.from(headers);newConfig.url=buildURL(buildFullPath(newConfig.baseURL,newConfig.url),config.params,config.paramsSerializer);// HTTP basic authentication
|
|
697
|
+
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,prop){return mergeDeepProperties(headersToObject(a),headersToObject(b),prop,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 resolveConfig=function resolveConfig(config){var newConfig=mergeConfig({},config);var data=newConfig.data,withXSRFToken=newConfig.withXSRFToken,xsrfHeaderName=newConfig.xsrfHeaderName,xsrfCookieName=newConfig.xsrfCookieName,headers=newConfig.headers,auth=newConfig.auth;newConfig.headers=headers=AxiosHeaders$1.from(headers);newConfig.url=buildURL(buildFullPath(newConfig.baseURL,newConfig.url),config.params,config.paramsSerializer);// HTTP basic authentication
|
|
713
698
|
if(auth){headers.set('Authorization','Basic '+btoa((auth.username||'')+':'+(auth.password?unescape(encodeURIComponent(auth.password)):'')));}var contentType;if(utils$1.isFormData(data)){if(platform.hasStandardBrowserEnv||platform.hasStandardBrowserWebWorkerEnv){headers.setContentType(undefined);// Let the browser set it
|
|
714
699
|
}else if((contentType=headers.getContentType())!==false){// fix semicolon duplication issue for ReactNative FormData implementation
|
|
715
700
|
var _ref11=contentType?contentType.split(';').map(function(token){return token.trim();}).filter(Boolean):[],_ref12=_toArray(_ref11),type=_ref12[0],tokens=_ref12.slice(1);headers.setContentType([type||'multipart/form-data'].concat(_toConsumableArray(tokens)).join('; '));}}// Add xsrf header
|
|
@@ -765,7 +750,7 @@ isCredentialsSupported="credentials"in Request.prototype;request=new Request(url
|
|
|
765
750
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
766
751
|
config.data=transformData.call(config,config.transformRequest);if(['post','put','patch'].indexOf(config.method)!==-1){config.headers.setContentType('application/x-www-form-urlencoded',false);}var adapter=adapters.getAdapter(config.adapter||defaults$1.adapter);return adapter(config).then(function onAdapterResolution(response){throwIfCancellationRequested(config);// Transform response data
|
|
767
752
|
response.data=transformData.call(config,config.transformResponse,response);response.headers=AxiosHeaders$1.from(response.headers);return response;},function onAdapterRejection(reason){if(!isCancel(reason)){throwIfCancellationRequested(config);// Transform response data
|
|
768
|
-
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var VERSION="1.7.
|
|
753
|
+
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var VERSION="1.7.9";var validators$1={};// eslint-disable-next-line func-names
|
|
769
754
|
['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={};/**
|
|
770
755
|
* Transitional option validator
|
|
771
756
|
*
|
|
@@ -776,7 +761,8 @@ if(reason&&reason.response){reason.response.data=transformData.call(config,confi
|
|
|
776
761
|
* @returns {function}
|
|
777
762
|
*/validators$1.transitional=function transitional(validator,version,message){function formatMessage(opt,desc){return'[Axios v'+VERSION+'] Transitional option \''+opt+'\''+desc+(message?'. '+message:'');}// eslint-disable-next-line func-names
|
|
778
763
|
return function(value,opt,opts){if(validator===false){throw new AxiosError(formatMessage(opt,' has been removed'+(version?' in '+version:'')),AxiosError.ERR_DEPRECATED);}if(version&&!deprecatedWarnings[opt]){deprecatedWarnings[opt]=true;// eslint-disable-next-line no-console
|
|
779
|
-
console.warn(formatMessage(opt,' has been deprecated since v'+version+' and will be removed in the near future'));}return validator?validator(value,opt,opts):true;};}
|
|
764
|
+
console.warn(formatMessage(opt,' has been deprecated since v'+version+' and will be removed in the near future'));}return validator?validator(value,opt,opts):true;};};validators$1.spelling=function spelling(correctSpelling){return function(value,opt){// eslint-disable-next-line no-console
|
|
765
|
+
console.warn("".concat(opt," is likely a misspelling of ").concat(correctSpelling));return true;};};/**
|
|
780
766
|
* Assert object's properties type
|
|
781
767
|
*
|
|
782
768
|
* @param {object} options
|
|
@@ -797,11 +783,11 @@ console.warn(formatMessage(opt,' has been deprecated since v'+version+' and will
|
|
|
797
783
|
* @param {?Object} config
|
|
798
784
|
*
|
|
799
785
|
* @returns {Promise} The Promise to be fulfilled
|
|
800
|
-
*/return _createClass(Axios,[{key:"request",value:(function(){var _request2=_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee8(configOrUrl,config){var dummy,stack;return _regeneratorRuntime().wrap(function _callee8$(_context9){while(1)switch(_context9.prev=_context9.next){case 0:_context9.prev=0;_context9.next=3;return this._request(configOrUrl,config);case 3:return _context9.abrupt("return",_context9.sent);case 6:_context9.prev=6;_context9.t0=_context9["catch"](0);if(_context9.t0 instanceof Error){Error.captureStackTrace?Error.captureStackTrace(dummy
|
|
786
|
+
*/return _createClass(Axios,[{key:"request",value:(function(){var _request2=_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee8(configOrUrl,config){var dummy,stack;return _regeneratorRuntime().wrap(function _callee8$(_context9){while(1)switch(_context9.prev=_context9.next){case 0:_context9.prev=0;_context9.next=3;return this._request(configOrUrl,config);case 3:return _context9.abrupt("return",_context9.sent);case 6:_context9.prev=6;_context9.t0=_context9["catch"](0);if(_context9.t0 instanceof Error){dummy={};Error.captureStackTrace?Error.captureStackTrace(dummy):dummy=new Error();// slice off the Error: ... line
|
|
801
787
|
stack=dummy.stack?dummy.stack.replace(/^.+\n/,''):'';try{if(!_context9.t0.stack){_context9.t0.stack=stack;// match without the 2 top stack lines
|
|
802
788
|
}else if(stack&&!String(_context9.t0.stack).endsWith(stack.replace(/^.+\n.+\n/,''))){_context9.t0.stack+='\n'+stack;}}catch(e){// ignore the case where "stack" is an un-writable property
|
|
803
789
|
}}throw _context9.t0;case 10:case"end":return _context9.stop();}},_callee8,this,[[0,6]]);}));function request(_x9,_x10){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
|
|
804
|
-
if(typeof configOrUrl==='string'){config=config||{};config.url=configOrUrl;}else{config=configOrUrl||{};}config=mergeConfig(this.defaults,config);var _config2=config,transitional=_config2.transitional,paramsSerializer=_config2.paramsSerializer,headers=_config2.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);}}
|
|
790
|
+
if(typeof configOrUrl==='string'){config=config||{};config.url=configOrUrl;}else{config=configOrUrl||{};}config=mergeConfig(this.defaults,config);var _config2=config,transitional=_config2.transitional,paramsSerializer=_config2.paramsSerializer,headers=_config2.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);}}validator.assertOptions(config,{baseUrl:validators.spelling('baseURL'),withXsrfToken:validators.spelling('withXSRFToken')},true);// Set config.method
|
|
805
791
|
config.method=(config.method||this.defaults.method||'get').toLowerCase();// Flatten headers
|
|
806
792
|
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
|
|
807
793
|
var requestInterceptorChain=[];var synchronousRequestInterceptors=true;this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor){if(typeof interceptor.runWhen==='function'&&interceptor.runWhen(config)===false){return;}synchronousRequestInterceptors=synchronousRequestInterceptors&&interceptor.synchronous;requestInterceptorChain.unshift(interceptor.fulfilled,interceptor.rejected);});var responseInterceptorChain=[];this.interceptors.response.forEach(function pushResponseInterceptors(interceptor){responseInterceptorChain.push(interceptor.fulfilled,interceptor.rejected);});var promise;var i=0;var len;if(!synchronousRequestInterceptors){var chain=[dispatchRequest.bind(this),undefined];chain.unshift.apply(chain,requestInterceptorChain);chain.push.apply(chain,responseInterceptorChain);len=chain.length;promise=Promise.resolve(config);while(i<len){promise=promise.then(chain[i++],chain[i++]);}return promise;}len=requestInterceptorChain.length;var newConfig=config;i=0;while(i<len){var onFulfilled=requestInterceptorChain[i++];var onRejected=requestInterceptorChain[i++];try{newConfig=onFulfilled(newConfig);}catch(error){onRejected.call(this,error);break;}}try{promise=dispatchRequest.call(this,newConfig);}catch(error){return Promise.reject(error);}i=0;len=responseInterceptorChain.length;while(i<len){promise=promise.then(responseInterceptorChain[i++],responseInterceptorChain[i++]);}return promise;}},{key:"getUri",value:function getUri(config){config=mergeConfig(this.defaults,config);var fullPath=buildFullPath(config.baseURL,config.url);return buildURL(fullPath,config.params,config.paramsSerializer);}}]);}();// Provide aliases for supported request methods
|
|
@@ -891,7 +877,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
891
877
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
892
878
|
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:"getConfUrl",value:function getConfUrl(pathType,regionUrl){if(!this.gateway)return regionUrl;if(!this.gateway.host)return regionUrl;var url=this.gateway.protocol+'://'+this.gateway.host;if(this.gateway.port>-1)url=url+':'+this.gateway.port.toString();if(pathType==='login'){if(this.gateway.path_params_login){if(this.gateway.path_params_login.startsWith('/'))url=url+this.gateway.path_params_login;else url=url+'/'+this.gateway.path_params_login;}}else{if(this.gateway.path_params_api){if(this.gateway.path_params_api.startsWith('/'))url=url+this.gateway.path_params_api;else url=url+'/'+this.gateway.path_params_api;}}return url;}},{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];}}}]);}();/**
|
|
893
879
|
* @module purecloud-platform-client-v2/ApiClient
|
|
894
|
-
* @version
|
|
880
|
+
* @version 210.0.0
|
|
895
881
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
896
882
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
897
883
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1213,7 +1199,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1213
1199
|
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);});}});}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1214
1200
|
* AgentAssistants service.
|
|
1215
1201
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1216
|
-
* @version
|
|
1202
|
+
* @version 210.0.0
|
|
1217
1203
|
*//**
|
|
1218
1204
|
* Constructs a new AgentAssistantsApi.
|
|
1219
1205
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1314,7 +1300,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1314
1300
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantQueue';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/queues/{queueId}','PUT',{'assistantId':assistantId,'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
1315
1301
|
* AgentCopilot service.
|
|
1316
1302
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1317
|
-
* @version
|
|
1303
|
+
* @version 210.0.0
|
|
1318
1304
|
*//**
|
|
1319
1305
|
* Constructs a new AgentCopilotApi.
|
|
1320
1306
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1336,7 +1322,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1336
1322
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','PUT',{'assistantId':assistantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
1337
1323
|
* AgentUI service.
|
|
1338
1324
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1339
|
-
* @version
|
|
1325
|
+
* @version 210.0.0
|
|
1340
1326
|
*//**
|
|
1341
1327
|
* Constructs a new AgentUIApi.
|
|
1342
1328
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1370,7 +1356,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1370
1356
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1371
1357
|
* Alerting service.
|
|
1372
1358
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1373
|
-
* @version
|
|
1359
|
+
* @version 210.0.0
|
|
1374
1360
|
*//**
|
|
1375
1361
|
* Constructs a new AlertingApi.
|
|
1376
1362
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1527,7 +1513,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1527
1513
|
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']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
1528
1514
|
* Analytics service.
|
|
1529
1515
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1530
|
-
* @version
|
|
1516
|
+
* @version 210.0.0
|
|
1531
1517
|
*//**
|
|
1532
1518
|
* Constructs a new AnalyticsApi.
|
|
1533
1519
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1574,7 +1560,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
1574
1560
|
*/},{key:"getAnalyticsAgentcopilotsAggregatesJobResults",value:function getAnalyticsAgentcopilotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1575
1561
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1576
1562
|
* Get Reporting Turns (division aware).
|
|
1577
|
-
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1563
|
+
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1578
1564
|
* @param {String} botFlowId ID of the bot flow.
|
|
1579
1565
|
* @param {Object} opts Optional parameters
|
|
1580
1566
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -1587,7 +1573,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
1587
1573
|
*/},{key:"getAnalyticsBotflowDivisionsReportingturns",value:function getAnalyticsBotflowDivisionsReportingturns(botFlowId,opts){opts=opts||{};// verify the required parameter 'botFlowId' is set
|
|
1588
1574
|
if(botFlowId===undefined||botFlowId===null){throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowDivisionsReportingturns';}return this.apiClient.callApi('/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns','GET',{'botFlowId':botFlowId},{'after':opts['after'],'pageSize':opts['pageSize'],'interval':opts['interval'],'actionId':opts['actionId'],'sessionId':opts['sessionId'],'language':opts['language'],'askActionResults':opts['askActionResults']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1589
1575
|
* Get Reporting Turns.
|
|
1590
|
-
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1576
|
+
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1591
1577
|
* @param {String} botFlowId ID of the bot flow.
|
|
1592
1578
|
* @param {Object} opts Optional parameters
|
|
1593
1579
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -1601,7 +1587,7 @@ if(botFlowId===undefined||botFlowId===null){throw'Missing the required parameter
|
|
|
1601
1587
|
*/},{key:"getAnalyticsBotflowReportingturns",value:function getAnalyticsBotflowReportingturns(botFlowId,opts){opts=opts||{};// verify the required parameter 'botFlowId' is set
|
|
1602
1588
|
if(botFlowId===undefined||botFlowId===null){throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowReportingturns';}return this.apiClient.callApi('/api/v2/analytics/botflows/{botFlowId}/reportingturns','GET',{'botFlowId':botFlowId},{'after':opts['after'],'pageSize':opts['pageSize'],'interval':opts['interval'],'actionId':opts['actionId'],'sessionId':opts['sessionId'],'language':opts['language'],'askActionResults':opts['askActionResults']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1603
1589
|
* Get Bot Flow Sessions.
|
|
1604
|
-
* Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1590
|
+
* Returns the bot flow sessions in reverse chronological order from the date they were created. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. The nextUri value in the response is already URL encoded (so it doesnt need to be encoded again). Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1605
1591
|
* @param {String} botFlowId ID of the bot flow.
|
|
1606
1592
|
* @param {Object} opts Optional parameters
|
|
1607
1593
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -2149,7 +2135,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2149
2135
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
2150
2136
|
* Architect service.
|
|
2151
2137
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2152
|
-
* @version
|
|
2138
|
+
* @version 210.0.0
|
|
2153
2139
|
*//**
|
|
2154
2140
|
* Constructs a new ArchitectApi.
|
|
2155
2141
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3241,7 +3227,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3241
3227
|
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']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3242
3228
|
* Audit service.
|
|
3243
3229
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3244
|
-
* @version
|
|
3230
|
+
* @version 210.0.0
|
|
3245
3231
|
*//**
|
|
3246
3232
|
* Constructs a new AuditApi.
|
|
3247
3233
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3291,7 +3277,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3291
3277
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
3292
3278
|
* Authorization service.
|
|
3293
3279
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3294
|
-
* @version
|
|
3280
|
+
* @version 210.0.0
|
|
3295
3281
|
*//**
|
|
3296
3282
|
* Constructs a new AuthorizationApi.
|
|
3297
3283
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3614,7 +3600,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3614
3600
|
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']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
3615
3601
|
* Billing service.
|
|
3616
3602
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3617
|
-
* @version
|
|
3603
|
+
* @version 210.0.0
|
|
3618
3604
|
*//**
|
|
3619
3605
|
* Constructs a new BillingApi.
|
|
3620
3606
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3638,7 +3624,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3638
3624
|
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']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3639
3625
|
* CarrierServices service.
|
|
3640
3626
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3641
|
-
* @version
|
|
3627
|
+
* @version 210.0.0
|
|
3642
3628
|
*//**
|
|
3643
3629
|
* Constructs a new CarrierServicesApi.
|
|
3644
3630
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3658,7 +3644,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3658
3644
|
*/},{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']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
3659
3645
|
* Chat service.
|
|
3660
3646
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3661
|
-
* @version
|
|
3647
|
+
* @version 210.0.0
|
|
3662
3648
|
*//**
|
|
3663
3649
|
* Constructs a new ChatApi.
|
|
3664
3650
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3883,7 +3869,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3883
3869
|
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']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
3884
3870
|
* Coaching service.
|
|
3885
3871
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3886
|
-
* @version
|
|
3872
|
+
* @version 210.0.0
|
|
3887
3873
|
*//**
|
|
3888
3874
|
* Constructs a new CoachingApi.
|
|
3889
3875
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4036,7 +4022,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4036
4022
|
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']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
4037
4023
|
* ContentManagement service.
|
|
4038
4024
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4039
|
-
* @version
|
|
4025
|
+
* @version 210.0.0
|
|
4040
4026
|
*//**
|
|
4041
4027
|
* Constructs a new ContentManagementApi.
|
|
4042
4028
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4318,7 +4304,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4318
4304
|
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']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
4319
4305
|
* Conversations service.
|
|
4320
4306
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4321
|
-
* @version
|
|
4307
|
+
* @version 210.0.0
|
|
4322
4308
|
*//**
|
|
4323
4309
|
* Constructs a new ConversationsApi.
|
|
4324
4310
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -4502,7 +4488,6 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
4502
4488
|
* Get the summaries of the conversation.
|
|
4503
4489
|
*
|
|
4504
4490
|
* @param {String} conversationId Conversation ID
|
|
4505
|
-
* getConversationSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4506
4491
|
*/},{key:"getConversationSummaries",value:function getConversationSummaries(conversationId){// verify the required parameter 'conversationId' is set
|
|
4507
4492
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationSummaries';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/summaries','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4508
4493
|
* Get active conversations for the logged in user
|
|
@@ -6047,7 +6032,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6047
6032
|
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']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
6048
6033
|
* DataExtensions service.
|
|
6049
6034
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6050
|
-
* @version
|
|
6035
|
+
* @version 210.0.0
|
|
6051
6036
|
*//**
|
|
6052
6037
|
* Constructs a new DataExtensionsApi.
|
|
6053
6038
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6065,10 +6050,50 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6065
6050
|
*/},{key:"getDataextensionsCoretypes",value:function getDataextensionsCoretypes(){return this.apiClient.callApi('/api/v2/dataextensions/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6066
6051
|
* Get quantitative limits on schemas
|
|
6067
6052
|
*
|
|
6068
|
-
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var
|
|
6053
|
+
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataPrivacyApi=/*#__PURE__*/function(){/**
|
|
6054
|
+
* DataPrivacy service.
|
|
6055
|
+
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
6056
|
+
* @version 210.0.0
|
|
6057
|
+
*//**
|
|
6058
|
+
* Constructs a new DataPrivacyApi.
|
|
6059
|
+
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
6060
|
+
* @class
|
|
6061
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
6062
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
6063
|
+
*/function DataPrivacyApi(apiClient){_classCallCheck(this,DataPrivacyApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
6064
|
+
* Delete a masking rule.
|
|
6065
|
+
*
|
|
6066
|
+
* @param {String} ruleId ruleId
|
|
6067
|
+
*/return _createClass(DataPrivacyApi,[{key:"deleteDataprivacyMaskingrule",value:function deleteDataprivacyMaskingrule(ruleId){// verify the required parameter 'ruleId' is set
|
|
6068
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling deleteDataprivacyMaskingrule';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/{ruleId}','DELETE',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6069
|
+
* Fetch details about a masking rule.
|
|
6070
|
+
*
|
|
6071
|
+
* @param {String} ruleId ruleId
|
|
6072
|
+
*/},{key:"getDataprivacyMaskingrule",value:function getDataprivacyMaskingrule(ruleId){// verify the required parameter 'ruleId' is set
|
|
6073
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling getDataprivacyMaskingrule';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/{ruleId}','GET',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6074
|
+
* Retrieve the list of masking rules.
|
|
6075
|
+
*
|
|
6076
|
+
*/},{key:"getDataprivacyMaskingrules",value:function getDataprivacyMaskingrules(){return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6077
|
+
* Update information about a masking rule.
|
|
6078
|
+
*
|
|
6079
|
+
* @param {String} ruleId ruleId
|
|
6080
|
+
* @param {Object} opts Optional parameters
|
|
6081
|
+
* @param {Object} opts.body
|
|
6082
|
+
*/},{key:"patchDataprivacyMaskingrule",value:function patchDataprivacyMaskingrule(ruleId,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
6083
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchDataprivacyMaskingrule';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/{ruleId}','PATCH',{'ruleId':ruleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6084
|
+
* Create a new masking rule resource.
|
|
6085
|
+
*
|
|
6086
|
+
* @param {Object} body Details for creating masking rule resource
|
|
6087
|
+
*/},{key:"postDataprivacyMaskingrules",value:function postDataprivacyMaskingrules(body){// verify the required parameter 'body' is set
|
|
6088
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDataprivacyMaskingrules';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6089
|
+
* Validate masking before creating.
|
|
6090
|
+
*
|
|
6091
|
+
* @param {Object} body Text to be masked
|
|
6092
|
+
*/},{key:"postDataprivacyMaskingrulesValidate",value:function postDataprivacyMaskingrulesValidate(body){// verify the required parameter 'body' is set
|
|
6093
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
6069
6094
|
* Downloads service.
|
|
6070
6095
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6071
|
-
* @version
|
|
6096
|
+
* @version 210.0.0
|
|
6072
6097
|
*//**
|
|
6073
6098
|
* Constructs a new DownloadsApi.
|
|
6074
6099
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6087,7 +6112,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6087
6112
|
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']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
6088
6113
|
* Emails service.
|
|
6089
6114
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6090
|
-
* @version
|
|
6115
|
+
* @version 210.0.0
|
|
6091
6116
|
*//**
|
|
6092
6117
|
* Constructs a new EmailsApi.
|
|
6093
6118
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6105,7 +6130,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6105
6130
|
*/},{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']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
6106
6131
|
* EmployeeEngagement service.
|
|
6107
6132
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6108
|
-
* @version
|
|
6133
|
+
* @version 210.0.0
|
|
6109
6134
|
*//**
|
|
6110
6135
|
* Constructs a new EmployeeEngagementApi.
|
|
6111
6136
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6143,7 +6168,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6143
6168
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
6144
6169
|
* Events service.
|
|
6145
6170
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6146
|
-
* @version
|
|
6171
|
+
* @version 210.0.0
|
|
6147
6172
|
*//**
|
|
6148
6173
|
* Constructs a new EventsApi.
|
|
6149
6174
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6168,7 +6193,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6168
6193
|
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']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
6169
6194
|
* ExternalContacts service.
|
|
6170
6195
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6171
|
-
* @version
|
|
6196
|
+
* @version 210.0.0
|
|
6172
6197
|
*//**
|
|
6173
6198
|
* Constructs a new ExternalContactsApi.
|
|
6174
6199
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6203,6 +6228,11 @@ if(externalSourceId===undefined||externalSourceId===null){throw'Missing the requ
|
|
|
6203
6228
|
* @param {String} settingsId Settings id
|
|
6204
6229
|
*/},{key:"deleteExternalcontactsImportCsvSetting",value:function deleteExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6205
6230
|
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','DELETE',{'settingsId':settingsId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6231
|
+
* Delete Settings
|
|
6232
|
+
*
|
|
6233
|
+
* @param {String} settingsId Settings id
|
|
6234
|
+
*/},{key:"deleteExternalcontactsImportSetting",value:function deleteExternalcontactsImportSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6235
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/settings/{settingsId}','DELETE',{'settingsId':settingsId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6206
6236
|
* Delete an external organization
|
|
6207
6237
|
*
|
|
6208
6238
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6336,6 +6366,32 @@ if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "
|
|
|
6336
6366
|
* @param {String} uploadId Upload id
|
|
6337
6367
|
*/},{key:"getExternalcontactsImportCsvUploadPreview",value:function getExternalcontactsImportCsvUploadPreview(uploadId){// verify the required parameter 'uploadId' is set
|
|
6338
6368
|
if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview','GET',{'uploadId':uploadId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6369
|
+
* Get job based on id
|
|
6370
|
+
*
|
|
6371
|
+
* @param {String} jobId Job id
|
|
6372
|
+
*/},{key:"getExternalcontactsImportJob",value:function getExternalcontactsImportJob(jobId){// verify the required parameter 'jobId' is set
|
|
6373
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';}return this.apiClient.callApi('/api/v2/externalcontacts/import/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6374
|
+
* List jobs for organization
|
|
6375
|
+
*
|
|
6376
|
+
* @param {Object} opts Optional parameters
|
|
6377
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
6378
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
6379
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
6380
|
+
* @param {Object} opts.jobStatus Search term to filter by jobStatus
|
|
6381
|
+
*/},{key:"getExternalcontactsImportJobs",value:function getExternalcontactsImportJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/import/jobs','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'jobStatus':opts['jobStatus']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6382
|
+
* Get setting based on id
|
|
6383
|
+
*
|
|
6384
|
+
* @param {String} settingsId Settings id
|
|
6385
|
+
*/},{key:"getExternalcontactsImportSetting",value:function getExternalcontactsImportSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6386
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling getExternalcontactsImportSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/settings/{settingsId}','GET',{'settingsId':settingsId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6387
|
+
* List settings for organization
|
|
6388
|
+
*
|
|
6389
|
+
* @param {Object} opts Optional parameters
|
|
6390
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
6391
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
6392
|
+
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
6393
|
+
* @param {String} opts.name Search term to filter by settings name
|
|
6394
|
+
*/},{key:"getExternalcontactsImportSettings",value:function getExternalcontactsImportSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/import/settings','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6339
6395
|
* Fetch an external organization
|
|
6340
6396
|
*
|
|
6341
6397
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6594,6 +6650,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6594
6650
|
* @param {Object} body UploadRequest
|
|
6595
6651
|
*/},{key:"postExternalcontactsImportCsvUploads",value:function postExternalcontactsImportCsvUploads(body){// verify the required parameter 'body' is set
|
|
6596
6652
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6653
|
+
* Create a new job
|
|
6654
|
+
*
|
|
6655
|
+
* @param {Object} body Job
|
|
6656
|
+
*/},{key:"postExternalcontactsImportJobs",value:function postExternalcontactsImportJobs(body){// verify the required parameter 'body' is set
|
|
6657
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportJobs';}return this.apiClient.callApi('/api/v2/externalcontacts/import/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6658
|
+
* Create a new settings
|
|
6659
|
+
*
|
|
6660
|
+
* @param {Object} body Setting
|
|
6661
|
+
*/},{key:"postExternalcontactsImportSettings",value:function postExternalcontactsImportSettings(body){// verify the required parameter 'body' is set
|
|
6662
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportSettings';}return this.apiClient.callApi('/api/v2/externalcontacts/import/settings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6597
6663
|
* Merge two contacts into a new contact record
|
|
6598
6664
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
6599
6665
|
* @param {Object} body MergeRequest
|
|
@@ -6665,6 +6731,20 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6665
6731
|
*/},{key:"putExternalcontactsImportCsvSetting",value:function putExternalcontactsImportCsvSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
6666
6732
|
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';}// verify the required parameter 'body' is set
|
|
6667
6733
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','PUT',{'settingsId':settingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6734
|
+
* Update Job's workflow status
|
|
6735
|
+
*
|
|
6736
|
+
* @param {String} jobId Job id
|
|
6737
|
+
* @param {Object} body Status of the Job's workflow
|
|
6738
|
+
*/},{key:"putExternalcontactsImportJob",value:function putExternalcontactsImportJob(jobId,body){// verify the required parameter 'jobId' is set
|
|
6739
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling putExternalcontactsImportJob';}// verify the required parameter 'body' is set
|
|
6740
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsImportJob';}return this.apiClient.callApi('/api/v2/externalcontacts/import/jobs/{jobId}','PUT',{'jobId':jobId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6741
|
+
* Update settings
|
|
6742
|
+
*
|
|
6743
|
+
* @param {String} settingsId Settings id
|
|
6744
|
+
* @param {Object} body Setting
|
|
6745
|
+
*/},{key:"putExternalcontactsImportSetting",value:function putExternalcontactsImportSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
6746
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportSetting';}// verify the required parameter 'body' is set
|
|
6747
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsImportSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/settings/{settingsId}','PUT',{'settingsId':settingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6668
6748
|
* Update an external organization
|
|
6669
6749
|
*
|
|
6670
6750
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6704,7 +6784,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6704
6784
|
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']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
6705
6785
|
* Fax service.
|
|
6706
6786
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6707
|
-
* @version
|
|
6787
|
+
* @version 210.0.0
|
|
6708
6788
|
*//**
|
|
6709
6789
|
* Constructs a new FaxApi.
|
|
6710
6790
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6753,7 +6833,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6753
6833
|
*/},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
6754
6834
|
* Flows service.
|
|
6755
6835
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6756
|
-
* @version
|
|
6836
|
+
* @version 210.0.0
|
|
6757
6837
|
*//**
|
|
6758
6838
|
* Constructs a new FlowsApi.
|
|
6759
6839
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6801,7 +6881,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6801
6881
|
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']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
6802
6882
|
* Gamification service.
|
|
6803
6883
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6804
|
-
* @version
|
|
6884
|
+
* @version 210.0.0
|
|
6805
6885
|
*//**
|
|
6806
6886
|
* Constructs a new GamificationApi.
|
|
6807
6887
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7341,7 +7421,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7341
7421
|
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']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
7342
7422
|
* GeneralDataProtectionRegulation service.
|
|
7343
7423
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7344
|
-
* @version
|
|
7424
|
+
* @version 210.0.0
|
|
7345
7425
|
*//**
|
|
7346
7426
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7347
7427
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7376,7 +7456,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7376
7456
|
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']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
7377
7457
|
* Geolocation service.
|
|
7378
7458
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7379
|
-
* @version
|
|
7459
|
+
* @version 210.0.0
|
|
7380
7460
|
*//**
|
|
7381
7461
|
* Constructs a new GeolocationApi.
|
|
7382
7462
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7410,7 +7490,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7410
7490
|
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']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
7411
7491
|
* Greetings service.
|
|
7412
7492
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7413
|
-
* @version
|
|
7493
|
+
* @version 210.0.0
|
|
7414
7494
|
*//**
|
|
7415
7495
|
* Constructs a new GreetingsApi.
|
|
7416
7496
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7517,7 +7597,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7517
7597
|
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']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
7518
7598
|
* Groups service.
|
|
7519
7599
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7520
|
-
* @version
|
|
7600
|
+
* @version 210.0.0
|
|
7521
7601
|
*//**
|
|
7522
7602
|
* Constructs a new GroupsApi.
|
|
7523
7603
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7650,7 +7730,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7650
7730
|
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']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
7651
7731
|
* IdentityProvider service.
|
|
7652
7732
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7653
|
-
* @version
|
|
7733
|
+
* @version 210.0.0
|
|
7654
7734
|
*//**
|
|
7655
7735
|
* Constructs a new IdentityProviderApi.
|
|
7656
7736
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7806,7 +7886,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7806
7886
|
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']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
7807
7887
|
* InfrastructureAsCode service.
|
|
7808
7888
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7809
|
-
* @version
|
|
7889
|
+
* @version 210.0.0
|
|
7810
7890
|
*//**
|
|
7811
7891
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7812
7892
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7860,7 +7940,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7860
7940
|
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']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
7861
7941
|
* Integrations service.
|
|
7862
7942
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7863
|
-
* @version
|
|
7943
|
+
* @version 210.0.0
|
|
7864
7944
|
*//**
|
|
7865
7945
|
* Constructs a new IntegrationsApi.
|
|
7866
7946
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8495,7 +8575,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8495
8575
|
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']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
8496
8576
|
* Journey service.
|
|
8497
8577
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8498
|
-
* @version
|
|
8578
|
+
* @version 210.0.0
|
|
8499
8579
|
*//**
|
|
8500
8580
|
* Constructs a new JourneyApi.
|
|
8501
8581
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8536,7 +8616,7 @@ if(segmentId===undefined||segmentId===null){throw'Missing the required parameter
|
|
|
8536
8616
|
*/},{key:"deleteJourneyView",value:function deleteJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
8537
8617
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling deleteJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','DELETE',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8538
8618
|
* Delete the Schedule of a JourneyView
|
|
8539
|
-
*
|
|
8619
|
+
*
|
|
8540
8620
|
* @param {String} viewId Journey View Id
|
|
8541
8621
|
*/},{key:"deleteJourneyViewSchedules",value:function deleteJourneyViewSchedules(viewId){// verify the required parameter 'viewId' is set
|
|
8542
8622
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','DELETE',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8706,7 +8786,7 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
8706
8786
|
*/},{key:"getJourneyView",value:function getJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
8707
8787
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','GET',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8708
8788
|
* Get the Schedule for a JourneyView
|
|
8709
|
-
*
|
|
8789
|
+
*
|
|
8710
8790
|
* @param {String} viewId Journey View Id
|
|
8711
8791
|
*/},{key:"getJourneyViewSchedules",value:function getJourneyViewSchedules(viewId){// verify the required parameter 'viewId' is set
|
|
8712
8792
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','GET',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8738,7 +8818,7 @@ if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the
|
|
|
8738
8818
|
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartVersion' is set
|
|
8739
8819
|
if(chartVersion===undefined||chartVersion===null){throw'Missing the required parameter "chartVersion" when calling getJourneyViewVersionChartVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'chartId':chartId,'chartVersion':chartVersion},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8740
8820
|
* Get the job for a journey view version.
|
|
8741
|
-
*
|
|
8821
|
+
*
|
|
8742
8822
|
* @param {String} viewId Journey View Id
|
|
8743
8823
|
* @param {String} journeyVersionId Journey View Version
|
|
8744
8824
|
* @param {String} jobId JobId
|
|
@@ -8747,7 +8827,7 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
8747
8827
|
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
8748
8828
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8749
8829
|
* Get the result of a job for a journey view version.
|
|
8750
|
-
*
|
|
8830
|
+
*
|
|
8751
8831
|
* @param {String} viewId JourneyViewResult id
|
|
8752
8832
|
* @param {String} journeyViewVersion Journey View Version
|
|
8753
8833
|
* @param {String} jobId Id of the executing job
|
|
@@ -8767,7 +8847,7 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
8767
8847
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'chartId' is set
|
|
8768
8848
|
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionJobResultsChart';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId,'chartId':chartId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8769
8849
|
* Get the latest job of a journey view version.
|
|
8770
|
-
*
|
|
8850
|
+
*
|
|
8771
8851
|
* @param {String} viewId Journey View Id
|
|
8772
8852
|
* @param {String} journeyVersionId Journey View Version
|
|
8773
8853
|
*/},{key:"getJourneyViewVersionJobsLatest",value:function getJourneyViewVersionJobsLatest(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
@@ -8840,7 +8920,7 @@ if(outcomeId===undefined||outcomeId===null){throw'Missing the required parameter
|
|
|
8840
8920
|
*/},{key:"patchJourneySegment",value:function patchJourneySegment(segmentId,opts){opts=opts||{};// verify the required parameter 'segmentId' is set
|
|
8841
8921
|
if(segmentId===undefined||segmentId===null){throw'Missing the required parameter "segmentId" when calling patchJourneySegment';}return this.apiClient.callApi('/api/v2/journey/segments/{segmentId}','PATCH',{'segmentId':segmentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8842
8922
|
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
8843
|
-
*
|
|
8923
|
+
*
|
|
8844
8924
|
* @param {String} viewId Journey View Id
|
|
8845
8925
|
* @param {String} journeyVersionId Journey View Version
|
|
8846
8926
|
* @param {String} jobId JobId
|
|
@@ -8931,7 +9011,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8931
9011
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling postJourneyViewSchedules';}// verify the required parameter 'body' is set
|
|
8932
9012
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','POST',{'viewId':viewId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8933
9013
|
* Submit a job request for a journey view version.
|
|
8934
|
-
*
|
|
9014
|
+
*
|
|
8935
9015
|
* @param {String} viewId Journey View Id
|
|
8936
9016
|
* @param {String} journeyVersionId Journey View Version
|
|
8937
9017
|
*/},{key:"postJourneyViewVersionJobs",value:function postJourneyViewVersionJobs(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
@@ -8955,7 +9035,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8955
9035
|
* @param {Array.<Object>} opts.body
|
|
8956
9036
|
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8957
9037
|
* Update the Schedule for a JourneyView
|
|
8958
|
-
*
|
|
9038
|
+
*
|
|
8959
9039
|
* @param {String} viewId Journey View Id
|
|
8960
9040
|
* @param {Object} body journeyViewSchedule
|
|
8961
9041
|
*/},{key:"putJourneyViewSchedules",value:function putJourneyViewSchedules(viewId,body){// verify the required parameter 'viewId' is set
|
|
@@ -8972,7 +9052,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
8972
9052
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','PUT',{'viewId':viewId,'versionId':versionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
8973
9053
|
* Knowledge service.
|
|
8974
9054
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8975
|
-
* @version
|
|
9055
|
+
* @version 210.0.0
|
|
8976
9056
|
*//**
|
|
8977
9057
|
* Constructs a new KnowledgeApi.
|
|
8978
9058
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -9113,8 +9193,10 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
9113
9193
|
* Get sync options available for a knowledge-connect integration
|
|
9114
9194
|
*
|
|
9115
9195
|
* @param {String} integrationId Integration ID
|
|
9116
|
-
|
|
9117
|
-
|
|
9196
|
+
* @param {Object} opts Optional parameters
|
|
9197
|
+
* @param {Array.<String>} opts.knowledgeBaseIds Narrowing down filtering option results by knowledge base.
|
|
9198
|
+
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
9199
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';}return this.apiClient.callApi('/api/v2/knowledge/integrations/{integrationId}/options','GET',{'integrationId':integrationId},{'knowledgeBaseIds':this.apiClient.buildCollectionParam(opts['knowledgeBaseIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9118
9200
|
* Get knowledge base
|
|
9119
9201
|
*
|
|
9120
9202
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -10040,7 +10122,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
10040
10122
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','PUT',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
10041
10123
|
* LanguageUnderstanding service.
|
|
10042
10124
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
10043
|
-
* @version
|
|
10125
|
+
* @version 210.0.0
|
|
10044
10126
|
*//**
|
|
10045
10127
|
* Constructs a new LanguageUnderstandingApi.
|
|
10046
10128
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10300,7 +10382,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10300
10382
|
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']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
10301
10383
|
* Languages service.
|
|
10302
10384
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10303
|
-
* @version
|
|
10385
|
+
* @version 210.0.0
|
|
10304
10386
|
*//**
|
|
10305
10387
|
* Constructs a new LanguagesApi.
|
|
10306
10388
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10355,7 +10437,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10355
10437
|
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']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
10356
10438
|
* Learning service.
|
|
10357
10439
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10358
|
-
* @version
|
|
10440
|
+
* @version 210.0.0
|
|
10359
10441
|
*//**
|
|
10360
10442
|
* Constructs a new LearningApi.
|
|
10361
10443
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10626,7 +10708,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10626
10708
|
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']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
10627
10709
|
* License service.
|
|
10628
10710
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10629
|
-
* @version
|
|
10711
|
+
* @version 210.0.0
|
|
10630
10712
|
*//**
|
|
10631
10713
|
* Constructs a new LicenseApi.
|
|
10632
10714
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10680,7 +10762,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10680
10762
|
*/},{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']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
10681
10763
|
* Locations service.
|
|
10682
10764
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10683
|
-
* @version
|
|
10765
|
+
* @version 210.0.0
|
|
10684
10766
|
*//**
|
|
10685
10767
|
* Constructs a new LocationsApi.
|
|
10686
10768
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10739,7 +10821,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10739
10821
|
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']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
10740
10822
|
* LogCapture service.
|
|
10741
10823
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10742
|
-
* @version
|
|
10824
|
+
* @version 210.0.0
|
|
10743
10825
|
*//**
|
|
10744
10826
|
* Constructs a new LogCaptureApi.
|
|
10745
10827
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10789,7 +10871,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10789
10871
|
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']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
10790
10872
|
* Messaging service.
|
|
10791
10873
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10792
|
-
* @version
|
|
10874
|
+
* @version 210.0.0
|
|
10793
10875
|
*//**
|
|
10794
10876
|
* Constructs a new MessagingApi.
|
|
10795
10877
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10879,7 +10961,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10879
10961
|
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']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
10880
10962
|
* MobileDevices service.
|
|
10881
10963
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10882
|
-
* @version
|
|
10964
|
+
* @version 210.0.0
|
|
10883
10965
|
*//**
|
|
10884
10966
|
* Constructs a new MobileDevicesApi.
|
|
10885
10967
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10918,7 +11000,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10918
11000
|
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']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
10919
11001
|
* Notifications service.
|
|
10920
11002
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10921
|
-
* @version
|
|
11003
|
+
* @version 210.0.0
|
|
10922
11004
|
*//**
|
|
10923
11005
|
* Constructs a new NotificationsApi.
|
|
10924
11006
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10975,7 +11057,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10975
11057
|
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']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
10976
11058
|
* OAuth service.
|
|
10977
11059
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10978
|
-
* @version
|
|
11060
|
+
* @version 210.0.0
|
|
10979
11061
|
*//**
|
|
10980
11062
|
* Constructs a new OAuthApi.
|
|
10981
11063
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -11060,7 +11142,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11060
11142
|
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']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
11061
11143
|
* Objects service.
|
|
11062
11144
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
11063
|
-
* @version
|
|
11145
|
+
* @version 210.0.0
|
|
11064
11146
|
*//**
|
|
11065
11147
|
* Constructs a new ObjectsApi.
|
|
11066
11148
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -11131,7 +11213,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11131
11213
|
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']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
11132
11214
|
* OperationalEvents service.
|
|
11133
11215
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
11134
|
-
* @version
|
|
11216
|
+
* @version 210.0.0
|
|
11135
11217
|
*//**
|
|
11136
11218
|
* Constructs a new OperationalEventsApi.
|
|
11137
11219
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11146,10 +11228,23 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11146
11228
|
if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';}return this.apiClient.callApi('/api/v2/usage/events/definitions/{eventDefinitionId}','GET',{'eventDefinitionId':eventDefinitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11147
11229
|
* Get all operational event definitions
|
|
11148
11230
|
*
|
|
11149
|
-
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
11231
|
+
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11232
|
+
* Get aggregates for operational events in a timeframe.
|
|
11233
|
+
*
|
|
11234
|
+
* @param {Object} opts Optional parameters
|
|
11235
|
+
* @param {Object} opts.body
|
|
11236
|
+
*/},{key:"postUsageEventsAggregatesQuery",value:function postUsageEventsAggregatesQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/usage/events/aggregates/query','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11237
|
+
* Query operational events in a timeframe.
|
|
11238
|
+
*
|
|
11239
|
+
* @param {Object} opts Optional parameters
|
|
11240
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11241
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11242
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11243
|
+
* @param {Object} opts.body
|
|
11244
|
+
*/},{key:"postUsageEventsQuery",value:function postUsageEventsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/usage/events/query','POST',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
11150
11245
|
* Organization service.
|
|
11151
11246
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11152
|
-
* @version
|
|
11247
|
+
* @version 210.0.0
|
|
11153
11248
|
*//**
|
|
11154
11249
|
* Constructs a new OrganizationApi.
|
|
11155
11250
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11274,7 +11369,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11274
11369
|
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']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
11275
11370
|
* OrganizationAuthorization service.
|
|
11276
11371
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11277
|
-
* @version
|
|
11372
|
+
* @version 210.0.0
|
|
11278
11373
|
*//**
|
|
11279
11374
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11280
11375
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11608,7 +11703,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11608
11703
|
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']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
11609
11704
|
* Outbound service.
|
|
11610
11705
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11611
|
-
* @version
|
|
11706
|
+
* @version 210.0.0
|
|
11612
11707
|
*//**
|
|
11613
11708
|
* Constructs a new OutboundApi.
|
|
11614
11709
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12715,7 +12810,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12715
12810
|
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']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
12716
12811
|
* Presence service.
|
|
12717
12812
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12718
|
-
* @version
|
|
12813
|
+
* @version 210.0.0
|
|
12719
12814
|
*//**
|
|
12720
12815
|
* Constructs a new PresenceApi.
|
|
12721
12816
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12888,7 +12983,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12888
12983
|
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']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
12889
12984
|
* ProcessAutomation service.
|
|
12890
12985
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12891
|
-
* @version
|
|
12986
|
+
* @version 210.0.0
|
|
12892
12987
|
*//**
|
|
12893
12988
|
* Constructs a new ProcessAutomationApi.
|
|
12894
12989
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12951,7 +13046,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12951
13046
|
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']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
12952
13047
|
* Quality service.
|
|
12953
13048
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12954
|
-
* @version
|
|
13049
|
+
* @version 210.0.0
|
|
12955
13050
|
*//**
|
|
12956
13051
|
* Constructs a new QualityApi.
|
|
12957
13052
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13036,7 +13131,8 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13036
13131
|
* @param {String} opts.group group id
|
|
13037
13132
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
13038
13133
|
* @param {String} opts.formContextId shared id between form versions
|
|
13039
|
-
|
|
13134
|
+
* @param {Object} opts.userState 'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states. (default to Legacy)
|
|
13135
|
+
*/},{key:"getQualityAgentsActivity",value:function getQualityAgentsActivity(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/agents/activity','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'startTime':opts['startTime'],'endTime':opts['endTime'],'agentUserId':this.apiClient.buildCollectionParam(opts['agentUserId'],'multi'),'evaluatorUserId':opts['evaluatorUserId'],'name':opts['name'],'group':opts['group'],'agentTeamId':opts['agentTeamId'],'formContextId':opts['formContextId'],'userState':opts['userState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13040
13136
|
* Get a calibration by id. Requires either calibrator id or conversation id
|
|
13041
13137
|
*
|
|
13042
13138
|
* @param {String} calibrationId Calibration ID
|
|
@@ -13110,7 +13206,8 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
13110
13206
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.
|
|
13111
13207
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
13112
13208
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
13113
|
-
|
|
13209
|
+
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
13210
|
+
*/},{key:"getQualityEvaluationsQuery",value:function getQualityEvaluationsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/evaluations/query','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'previousPage':opts['previousPage'],'conversationId':opts['conversationId'],'agentUserId':opts['agentUserId'],'agentTeamId':opts['agentTeamId'],'evaluatorUserId':opts['evaluatorUserId'],'assigneeUserId':opts['assigneeUserId'],'queueId':opts['queueId'],'startTime':opts['startTime'],'endTime':opts['endTime'],'formContextId':opts['formContextId'],'evaluationState':this.apiClient.buildCollectionParam(opts['evaluationState'],'multi'),'isReleased':opts['isReleased'],'agentHasRead':opts['agentHasRead'],'expandAnswerTotalScores':opts['expandAnswerTotalScores'],'maximum':opts['maximum'],'sortOrder':opts['sortOrder'],'includeDeletedUsers':opts['includeDeletedUsers']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13114
13211
|
* Get an evaluator activity
|
|
13115
13212
|
*
|
|
13116
13213
|
* @param {Object} opts Optional parameters
|
|
@@ -13428,7 +13525,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13428
13525
|
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']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
13429
13526
|
* Recording service.
|
|
13430
13527
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13431
|
-
* @version
|
|
13528
|
+
* @version 210.0.0
|
|
13432
13529
|
*//**
|
|
13433
13530
|
* Constructs a new RecordingApi.
|
|
13434
13531
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13840,7 +13937,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13840
13937
|
*/},{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']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
13841
13938
|
* ResponseManagement service.
|
|
13842
13939
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13843
|
-
* @version
|
|
13940
|
+
* @version 210.0.0
|
|
13844
13941
|
*//**
|
|
13845
13942
|
* Constructs a new ResponseManagementApi.
|
|
13846
13943
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13961,7 +14058,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13961
14058
|
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']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
13962
14059
|
* Routing service.
|
|
13963
14060
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13964
|
-
* @version
|
|
14061
|
+
* @version 210.0.0
|
|
13965
14062
|
*//**
|
|
13966
14063
|
* Constructs a new RoutingApi.
|
|
13967
14064
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14053,9 +14150,9 @@ if(skillGroupId===undefined||skillGroupId===null){throw'Missing the required par
|
|
|
14053
14150
|
if(addressId===undefined||addressId===null){throw'Missing the required parameter "addressId" when calling deleteRoutingSmsAddress';}return this.apiClient.callApi('/api/v2/routing/sms/addresses/{addressId}','DELETE',{'addressId':addressId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14054
14151
|
* Delete a phone number provisioned for SMS.
|
|
14055
14152
|
*
|
|
14056
|
-
* @param {String}
|
|
14057
|
-
*/},{key:"deleteRoutingSmsPhonenumber",value:function deleteRoutingSmsPhonenumber(
|
|
14058
|
-
if(
|
|
14153
|
+
* @param {String} phoneNumberId phone number
|
|
14154
|
+
*/},{key:"deleteRoutingSmsPhonenumber",value:function deleteRoutingSmsPhonenumber(phoneNumberId){// verify the required parameter 'phoneNumberId' is set
|
|
14155
|
+
if(phoneNumberId===undefined||phoneNumberId===null){throw'Missing the required parameter "phoneNumberId" when calling deleteRoutingSmsPhonenumber';}return this.apiClient.callApi('/api/v2/routing/sms/phonenumbers/{phoneNumberId}','DELETE',{'phoneNumberId':phoneNumberId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14059
14156
|
* Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
|
|
14060
14157
|
*
|
|
14061
14158
|
* @param {String} userId User ID
|
|
@@ -14278,10 +14375,12 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
14278
14375
|
* Get Estimated Wait Time
|
|
14279
14376
|
*
|
|
14280
14377
|
* @param {String} queueId queueId
|
|
14281
|
-
* @param {
|
|
14282
|
-
|
|
14378
|
+
* @param {Object} mediaType mediaType
|
|
14379
|
+
* @param {Object} opts Optional parameters
|
|
14380
|
+
* @param {String} opts.labelId Unique id that represents the interaction label used with media type for EWT calculation
|
|
14381
|
+
*/},{key:"getRoutingQueueMediatypeEstimatedwaittime",value:function getRoutingQueueMediatypeEstimatedwaittime(queueId,mediaType,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
14283
14382
|
if(queueId===undefined||queueId===null){throw'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';}// verify the required parameter 'mediaType' is set
|
|
14284
|
-
if(mediaType===undefined||mediaType===null){throw'Missing the required parameter "mediaType" when calling getRoutingQueueMediatypeEstimatedwaittime';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime','GET',{'queueId':queueId,'mediaType':mediaType},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14383
|
+
if(mediaType===undefined||mediaType===null){throw'Missing the required parameter "mediaType" when calling getRoutingQueueMediatypeEstimatedwaittime';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime','GET',{'queueId':queueId,'mediaType':mediaType},{'labelId':opts['labelId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14285
14384
|
* Get the members of this queue.
|
|
14286
14385
|
*
|
|
14287
14386
|
* @param {String} queueId Queue ID
|
|
@@ -14443,11 +14542,11 @@ if(countryCode===undefined||countryCode===null){throw'Missing the required param
|
|
|
14443
14542
|
if(phoneNumberType===undefined||phoneNumberType===null){throw'Missing the required parameter "phoneNumberType" when calling getRoutingSmsAvailablephonenumbers';}return this.apiClient.callApi('/api/v2/routing/sms/availablephonenumbers','GET',{},{'countryCode':countryCode,'region':opts['region'],'city':opts['city'],'areaCode':opts['areaCode'],'phoneNumberType':phoneNumberType,'pattern':opts['pattern'],'addressRequirement':opts['addressRequirement']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14444
14543
|
* Get a phone number provisioned for SMS.
|
|
14445
14544
|
*
|
|
14446
|
-
* @param {String}
|
|
14545
|
+
* @param {String} phoneNumberId phone number
|
|
14447
14546
|
* @param {Object} opts Optional parameters
|
|
14448
14547
|
* @param {Object} opts.expand Expand response with additional information
|
|
14449
|
-
*/},{key:"getRoutingSmsPhonenumber",value:function getRoutingSmsPhonenumber(
|
|
14450
|
-
if(
|
|
14548
|
+
*/},{key:"getRoutingSmsPhonenumber",value:function getRoutingSmsPhonenumber(phoneNumberId,opts){opts=opts||{};// verify the required parameter 'phoneNumberId' is set
|
|
14549
|
+
if(phoneNumberId===undefined||phoneNumberId===null){throw'Missing the required parameter "phoneNumberId" when calling getRoutingSmsPhonenumber';}return this.apiClient.callApi('/api/v2/routing/sms/phonenumbers/{phoneNumberId}','GET',{'phoneNumberId':phoneNumberId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14451
14550
|
* Get a list of provisioned phone numbers.
|
|
14452
14551
|
*
|
|
14453
14552
|
* @param {Object} opts Optional parameters
|
|
@@ -14909,11 +15008,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14909
15008
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingSettingsTranscription';}return this.apiClient.callApi('/api/v2/routing/settings/transcription','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14910
15009
|
* Update a phone number provisioned for SMS.
|
|
14911
15010
|
*
|
|
14912
|
-
* @param {String}
|
|
15011
|
+
* @param {String} phoneNumberId phone number
|
|
14913
15012
|
* @param {Object} body SmsPhoneNumber
|
|
14914
|
-
*/},{key:"putRoutingSmsPhonenumber",value:function putRoutingSmsPhonenumber(
|
|
14915
|
-
if(
|
|
14916
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingSmsPhonenumber';}return this.apiClient.callApi('/api/v2/routing/sms/phonenumbers/{
|
|
15013
|
+
*/},{key:"putRoutingSmsPhonenumber",value:function putRoutingSmsPhonenumber(phoneNumberId,body){// verify the required parameter 'phoneNumberId' is set
|
|
15014
|
+
if(phoneNumberId===undefined||phoneNumberId===null){throw'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';}// verify the required parameter 'body' is set
|
|
15015
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingSmsPhonenumber';}return this.apiClient.callApi('/api/v2/routing/sms/phonenumbers/{phoneNumberId}','PUT',{'phoneNumberId':phoneNumberId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14917
15016
|
* Update the user's Direct Routing Backup settings.
|
|
14918
15017
|
*
|
|
14919
15018
|
* @param {String} userId User ID
|
|
@@ -14965,7 +15064,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14965
15064
|
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']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
14966
15065
|
* SCIM service.
|
|
14967
15066
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14968
|
-
* @version
|
|
15067
|
+
* @version 210.0.0
|
|
14969
15068
|
*//**
|
|
14970
15069
|
* Constructs a new SCIMApi.
|
|
14971
15070
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15190,7 +15289,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15190
15289
|
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']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
15191
15290
|
* ScreenRecording service.
|
|
15192
15291
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15193
|
-
* @version
|
|
15292
|
+
* @version 210.0.0
|
|
15194
15293
|
*//**
|
|
15195
15294
|
* Constructs a new ScreenRecordingApi.
|
|
15196
15295
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15205,7 +15304,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15205
15304
|
*/return _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']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
15206
15305
|
* Scripts service.
|
|
15207
15306
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15208
|
-
* @version
|
|
15307
|
+
* @version 210.0.0
|
|
15209
15308
|
*//**
|
|
15210
15309
|
* Constructs a new ScriptsApi.
|
|
15211
15310
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15341,7 +15440,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15341
15440
|
*/},{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']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
15342
15441
|
* Search service.
|
|
15343
15442
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15344
|
-
* @version
|
|
15443
|
+
* @version 210.0.0
|
|
15345
15444
|
*//**
|
|
15346
15445
|
* Constructs a new SearchApi.
|
|
15347
15446
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15513,7 +15612,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15513
15612
|
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']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
15514
15613
|
* Settings service.
|
|
15515
15614
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15516
|
-
* @version
|
|
15615
|
+
* @version 210.0.0
|
|
15517
15616
|
*//**
|
|
15518
15617
|
* Constructs a new SettingsApi.
|
|
15519
15618
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15560,10 +15659,275 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15560
15659
|
* @param {Object} body AutoAnswerSettings
|
|
15561
15660
|
*/},{key:"putUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId,body){// verify the required parameter 'agentId' is set
|
|
15562
15661
|
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}// verify the required parameter 'body' is set
|
|
15563
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var
|
|
15662
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SocialMediaApi=/*#__PURE__*/function(){/**
|
|
15663
|
+
* SocialMedia service.
|
|
15664
|
+
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
15665
|
+
* @version 210.0.0
|
|
15666
|
+
*//**
|
|
15667
|
+
* Constructs a new SocialMediaApi.
|
|
15668
|
+
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
15669
|
+
* @class
|
|
15670
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
15671
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
15672
|
+
*/function SocialMediaApi(apiClient){_classCallCheck(this,SocialMediaApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
15673
|
+
* Delete a social topic.
|
|
15674
|
+
*
|
|
15675
|
+
* @param {String} topicId topicId
|
|
15676
|
+
* @param {Object} opts Optional parameters
|
|
15677
|
+
* @param {Boolean} opts.hardDelete Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default.
|
|
15678
|
+
* deleteSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15679
|
+
*/return _createClass(SocialMediaApi,[{key:"deleteSocialmediaTopic",value:function deleteSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15680
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopic';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}','DELETE',{'topicId':topicId},{'hardDelete':opts['hardDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15681
|
+
* Delete a Facebook data ingestion rule.
|
|
15682
|
+
*
|
|
15683
|
+
* @param {String} topicId topicId
|
|
15684
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15685
|
+
* @param {Object} opts Optional parameters
|
|
15686
|
+
* @param {Boolean} opts.hardDelete Determines whether a Facebook data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
15687
|
+
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15688
|
+
*/},{key:"deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15689
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15690
|
+
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','DELETE',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{'hardDelete':opts['hardDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15691
|
+
* Delete a open data ingestion rule.
|
|
15692
|
+
*
|
|
15693
|
+
* @param {String} topicId topicId
|
|
15694
|
+
* @param {String} openId openId
|
|
15695
|
+
* @param {Object} opts Optional parameters
|
|
15696
|
+
* @param {Boolean} opts.hardDelete Determines whether a open data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
15697
|
+
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15698
|
+
*/},{key:"deleteSocialmediaTopicDataingestionrulesOpenOpenId",value:function deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId,openId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15699
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';}// verify the required parameter 'openId' is set
|
|
15700
|
+
if(openId===undefined||openId===null){throw'Missing the required parameter "openId" when calling deleteSocialmediaTopicDataingestionrulesOpenOpenId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}','DELETE',{'topicId':topicId,'openId':openId},{'hardDelete':opts['hardDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15701
|
+
* Delete a X (formally Twitter) data ingestion rule.
|
|
15702
|
+
*
|
|
15703
|
+
* @param {String} topicId topicId
|
|
15704
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
15705
|
+
* @param {Object} opts Optional parameters
|
|
15706
|
+
* @param {Boolean} opts.hardDelete Determines whether a X (formally Twitter) data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
15707
|
+
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15708
|
+
*/},{key:"deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15709
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
15710
|
+
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','DELETE',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{'hardDelete':opts['hardDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15711
|
+
* Get a single social topic.
|
|
15712
|
+
*
|
|
15713
|
+
* @param {String} topicId topicId
|
|
15714
|
+
* @param {Object} opts Optional parameters
|
|
15715
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15716
|
+
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15717
|
+
*/},{key:"getSocialmediaTopic",value:function getSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15718
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopic';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}','GET',{'topicId':topicId},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15719
|
+
* Get a single Facebook data ingestion rule.
|
|
15720
|
+
*
|
|
15721
|
+
* @param {String} topicId topicId
|
|
15722
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15723
|
+
* @param {Object} opts Optional parameters
|
|
15724
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15725
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15726
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15727
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15728
|
+
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','GET',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15729
|
+
* Get a single Facebook data ingestion rule version.
|
|
15730
|
+
*
|
|
15731
|
+
* @param {String} topicId topicId
|
|
15732
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15733
|
+
* @param {String} dataIngestionRuleVersion version
|
|
15734
|
+
* @param {Object} opts Optional parameters
|
|
15735
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
15736
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15737
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId,facebookIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15738
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15739
|
+
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
15740
|
+
if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}','GET',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId,'dataIngestionRuleVersion':dataIngestionRuleVersion},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15741
|
+
* Get the Facebook data ingestion rule versions.
|
|
15742
|
+
*
|
|
15743
|
+
* @param {String} topicId topicId
|
|
15744
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15745
|
+
* @param {Object} opts Optional parameters
|
|
15746
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15747
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15748
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15749
|
+
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15750
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15751
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15752
|
+
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions','GET',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15753
|
+
* Get a single open data ingestion rule.
|
|
15754
|
+
*
|
|
15755
|
+
* @param {String} topicId topicId
|
|
15756
|
+
* @param {String} openId openId
|
|
15757
|
+
* @param {Object} opts Optional parameters
|
|
15758
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15759
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15760
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesOpenOpenId",value:function getSocialmediaTopicDataingestionrulesOpenOpenId(topicId,openId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15761
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';}// verify the required parameter 'openId' is set
|
|
15762
|
+
if(openId===undefined||openId===null){throw'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}','GET',{'topicId':topicId,'openId':openId},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15763
|
+
* Get a single Open data ingestion rule version.
|
|
15764
|
+
*
|
|
15765
|
+
* @param {String} topicId topicId
|
|
15766
|
+
* @param {String} openId openId
|
|
15767
|
+
* @param {String} dataIngestionRuleVersion version
|
|
15768
|
+
* @param {Object} opts Optional parameters
|
|
15769
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
15770
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15771
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesOpenOpenIdVersion",value:function getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId,openId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15772
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';}// verify the required parameter 'openId' is set
|
|
15773
|
+
if(openId===undefined||openId===null){throw'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
15774
|
+
if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersion';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}','GET',{'topicId':topicId,'openId':openId,'dataIngestionRuleVersion':dataIngestionRuleVersion},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15775
|
+
* Get the Open data ingestion rule versions.
|
|
15776
|
+
*
|
|
15777
|
+
* @param {String} topicId topicId
|
|
15778
|
+
* @param {String} openId openId
|
|
15779
|
+
* @param {Object} opts Optional parameters
|
|
15780
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15781
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15782
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15783
|
+
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15784
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesOpenOpenIdVersions",value:function getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId,openId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15785
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';}// verify the required parameter 'openId' is set
|
|
15786
|
+
if(openId===undefined||openId===null){throw'Missing the required parameter "openId" when calling getSocialmediaTopicDataingestionrulesOpenOpenIdVersions';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions','GET',{'topicId':topicId,'openId':openId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15787
|
+
* Get a single X (formally Twitter) data ingestion rule.
|
|
15788
|
+
*
|
|
15789
|
+
* @param {String} topicId topicId
|
|
15790
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
15791
|
+
* @param {Object} opts Optional parameters
|
|
15792
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15793
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15794
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15795
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
15796
|
+
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','GET',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15797
|
+
* Get a single X (formally Twitter) data ingestion rule version.
|
|
15798
|
+
*
|
|
15799
|
+
* @param {String} topicId topicId
|
|
15800
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
15801
|
+
* @param {String} dataIngestionRuleVersion version
|
|
15802
|
+
* @param {Object} opts Optional parameters
|
|
15803
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
15804
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15805
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId,twitterIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15806
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
15807
|
+
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
15808
|
+
if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'Missing the required parameter "dataIngestionRuleVersion" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}','GET',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId,'dataIngestionRuleVersion':dataIngestionRuleVersion},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15809
|
+
* Get the Open data ingestion rule versions.
|
|
15810
|
+
*
|
|
15811
|
+
* @param {String} topicId topicId
|
|
15812
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
15813
|
+
* @param {Object} opts Optional parameters
|
|
15814
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15815
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15816
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15817
|
+
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15818
|
+
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15819
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
15820
|
+
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions','GET',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15821
|
+
* Retrieve all social topics.
|
|
15822
|
+
*
|
|
15823
|
+
* @param {Object} opts Optional parameters
|
|
15824
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15825
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15826
|
+
* @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
|
|
15827
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15828
|
+
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15829
|
+
*/},{key:"getSocialmediaTopics",value:function getSocialmediaTopics(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/socialmedia/topics','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'divisionIds':this.apiClient.buildCollectionParam(opts['divisionIds'],'multi'),'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15830
|
+
* Update a social topic.
|
|
15831
|
+
*
|
|
15832
|
+
* @param {String} topicId topicId
|
|
15833
|
+
* @param {Object} opts Optional parameters
|
|
15834
|
+
* @param {Object} opts.body
|
|
15835
|
+
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15836
|
+
*/},{key:"patchSocialmediaTopic",value:function patchSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15837
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopic';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}','PATCH',{'topicId':topicId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15838
|
+
* Update the status of a Facebook data ingestion rule.
|
|
15839
|
+
*
|
|
15840
|
+
* @param {String} topicId topicId
|
|
15841
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15842
|
+
* @param {Object} opts Optional parameters
|
|
15843
|
+
* @param {Object} opts.body
|
|
15844
|
+
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15845
|
+
*/},{key:"patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15846
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15847
|
+
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','PATCH',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15848
|
+
* Update the status of a open data ingestion rule.
|
|
15849
|
+
*
|
|
15850
|
+
* @param {String} topicId topicId
|
|
15851
|
+
* @param {String} openId openId
|
|
15852
|
+
* @param {Object} opts Optional parameters
|
|
15853
|
+
* @param {Object} opts.body
|
|
15854
|
+
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15855
|
+
*/},{key:"patchSocialmediaTopicDataingestionrulesOpenOpenId",value:function patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId,openId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15856
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';}// verify the required parameter 'openId' is set
|
|
15857
|
+
if(openId===undefined||openId===null){throw'Missing the required parameter "openId" when calling patchSocialmediaTopicDataingestionrulesOpenOpenId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}','PATCH',{'topicId':topicId,'openId':openId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15858
|
+
* Update the status of a X (formally Twitter) data ingestion rule.
|
|
15859
|
+
*
|
|
15860
|
+
* @param {String} topicId topicId
|
|
15861
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
15862
|
+
* @param {Object} opts Optional parameters
|
|
15863
|
+
* @param {Object} opts.body
|
|
15864
|
+
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15865
|
+
*/},{key:"patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15866
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
15867
|
+
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PATCH',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15868
|
+
* Create an Facebook data ingestion rule.
|
|
15869
|
+
*
|
|
15870
|
+
* @param {String} topicId topicId
|
|
15871
|
+
* @param {Object} opts Optional parameters
|
|
15872
|
+
* @param {Object} opts.body
|
|
15873
|
+
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15874
|
+
*/},{key:"postSocialmediaTopicDataingestionrulesFacebook",value:function postSocialmediaTopicDataingestionrulesFacebook(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15875
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesFacebook';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook','POST',{'topicId':topicId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15876
|
+
* Create an open data ingestion rule.
|
|
15877
|
+
*
|
|
15878
|
+
* @param {String} topicId topicId
|
|
15879
|
+
* @param {Object} opts Optional parameters
|
|
15880
|
+
* @param {Object} opts.body
|
|
15881
|
+
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15882
|
+
*/},{key:"postSocialmediaTopicDataingestionrulesOpen",value:function postSocialmediaTopicDataingestionrulesOpen(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15883
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpen';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open','POST',{'topicId':topicId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15884
|
+
* Create an twitter data ingestion rule.
|
|
15885
|
+
*
|
|
15886
|
+
* @param {String} topicId topicId
|
|
15887
|
+
* @param {Object} opts Optional parameters
|
|
15888
|
+
* @param {Object} opts.body
|
|
15889
|
+
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15890
|
+
*/},{key:"postSocialmediaTopicDataingestionrulesTwitter",value:function postSocialmediaTopicDataingestionrulesTwitter(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15891
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesTwitter';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter','POST',{'topicId':topicId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15892
|
+
* Create a social topic.
|
|
15893
|
+
*
|
|
15894
|
+
* @param {Object} opts Optional parameters
|
|
15895
|
+
* @param {Object} opts.body
|
|
15896
|
+
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15897
|
+
*/},{key:"postSocialmediaTopics",value:function postSocialmediaTopics(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/socialmedia/topics','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15898
|
+
* Update the Facebook data ingestion rule.
|
|
15899
|
+
*
|
|
15900
|
+
* @param {String} topicId topicId
|
|
15901
|
+
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15902
|
+
* @param {Object} opts Optional parameters
|
|
15903
|
+
* @param {Object} opts.body
|
|
15904
|
+
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15905
|
+
*/},{key:"putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15906
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15907
|
+
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','PUT',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15908
|
+
* Update the open data ingestion rule.
|
|
15909
|
+
*
|
|
15910
|
+
* @param {String} topicId topicId
|
|
15911
|
+
* @param {String} openId openId
|
|
15912
|
+
* @param {Object} opts Optional parameters
|
|
15913
|
+
* @param {Object} opts.body
|
|
15914
|
+
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15915
|
+
*/},{key:"putSocialmediaTopicDataingestionrulesOpenOpenId",value:function putSocialmediaTopicDataingestionrulesOpenOpenId(topicId,openId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15916
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';}// verify the required parameter 'openId' is set
|
|
15917
|
+
if(openId===undefined||openId===null){throw'Missing the required parameter "openId" when calling putSocialmediaTopicDataingestionrulesOpenOpenId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}','PUT',{'topicId':topicId,'openId':openId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15918
|
+
* Update the X (formally Twitter) data ingestion rule.
|
|
15919
|
+
*
|
|
15920
|
+
* @param {String} topicId topicId
|
|
15921
|
+
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
15922
|
+
* @param {Object} opts Optional parameters
|
|
15923
|
+
* @param {Object} opts.body
|
|
15924
|
+
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15925
|
+
*/},{key:"putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15926
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
15927
|
+
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PUT',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
15564
15928
|
* SpeechTextAnalytics service.
|
|
15565
15929
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
15566
|
-
* @version
|
|
15930
|
+
* @version 210.0.0
|
|
15567
15931
|
*//**
|
|
15568
15932
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
15569
15933
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -15862,7 +16226,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15862
16226
|
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']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
15863
16227
|
* Stations service.
|
|
15864
16228
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
15865
|
-
* @version
|
|
16229
|
+
* @version 210.0.0
|
|
15866
16230
|
*//**
|
|
15867
16231
|
* Constructs a new StationsApi.
|
|
15868
16232
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15894,7 +16258,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15894
16258
|
*/},{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']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
15895
16259
|
* Suggest service.
|
|
15896
16260
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15897
|
-
* @version
|
|
16261
|
+
* @version 210.0.0
|
|
15898
16262
|
*//**
|
|
15899
16263
|
* Constructs a new SuggestApi.
|
|
15900
16264
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15934,7 +16298,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15934
16298
|
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']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
15935
16299
|
* TaskManagement service.
|
|
15936
16300
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15937
|
-
* @version
|
|
16301
|
+
* @version 210.0.0
|
|
15938
16302
|
*//**
|
|
15939
16303
|
* Constructs a new TaskManagementApi.
|
|
15940
16304
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -16340,7 +16704,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
16340
16704
|
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']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
16341
16705
|
* Teams service.
|
|
16342
16706
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
16343
|
-
* @version
|
|
16707
|
+
* @version 210.0.0
|
|
16344
16708
|
*//**
|
|
16345
16709
|
* Constructs a new TeamsApi.
|
|
16346
16710
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -16420,7 +16784,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16420
16784
|
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']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
16421
16785
|
* Telephony service.
|
|
16422
16786
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
16423
|
-
* @version
|
|
16787
|
+
* @version 210.0.0
|
|
16424
16788
|
*//**
|
|
16425
16789
|
* Constructs a new TelephonyApi.
|
|
16426
16790
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -16467,7 +16831,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
16467
16831
|
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']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
16468
16832
|
* TelephonyProvidersEdge service.
|
|
16469
16833
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
16470
|
-
* @version
|
|
16834
|
+
* @version 210.0.0
|
|
16471
16835
|
*//**
|
|
16472
16836
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
16473
16837
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -17302,7 +17666,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
17302
17666
|
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']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
17303
17667
|
* Textbots service.
|
|
17304
17668
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
17305
|
-
* @version
|
|
17669
|
+
* @version 210.0.0
|
|
17306
17670
|
*//**
|
|
17307
17671
|
* Constructs a new TextbotsApi.
|
|
17308
17672
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -17337,7 +17701,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
17337
17701
|
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']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
17338
17702
|
* Tokens service.
|
|
17339
17703
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
17340
|
-
* @version
|
|
17704
|
+
* @version 210.0.0
|
|
17341
17705
|
*//**
|
|
17342
17706
|
* Constructs a new TokensApi.
|
|
17343
17707
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -17371,7 +17735,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17371
17735
|
*/},{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']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
17372
17736
|
* Uploads service.
|
|
17373
17737
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
17374
|
-
* @version
|
|
17738
|
+
* @version 210.0.0
|
|
17375
17739
|
*//**
|
|
17376
17740
|
* Constructs a new UploadsApi.
|
|
17377
17741
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -17437,7 +17801,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17437
17801
|
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']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
17438
17802
|
* Usage service.
|
|
17439
17803
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
17440
|
-
* @version
|
|
17804
|
+
* @version 210.0.0
|
|
17441
17805
|
*//**
|
|
17442
17806
|
* Constructs a new UsageApi.
|
|
17443
17807
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -17491,7 +17855,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17491
17855
|
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']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
17492
17856
|
* UserRecordings service.
|
|
17493
17857
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
17494
|
-
* @version
|
|
17858
|
+
* @version 210.0.0
|
|
17495
17859
|
*//**
|
|
17496
17860
|
* Constructs a new UserRecordingsApi.
|
|
17497
17861
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -17548,7 +17912,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
17548
17912
|
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']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
17549
17913
|
* Users service.
|
|
17550
17914
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
17551
|
-
* @version
|
|
17915
|
+
* @version 210.0.0
|
|
17552
17916
|
*//**
|
|
17553
17917
|
* Constructs a new UsersApi.
|
|
17554
17918
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -18245,7 +18609,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
18245
18609
|
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']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
18246
18610
|
* Utilities service.
|
|
18247
18611
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
18248
|
-
* @version
|
|
18612
|
+
* @version 210.0.0
|
|
18249
18613
|
*//**
|
|
18250
18614
|
* Constructs a new UtilitiesApi.
|
|
18251
18615
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -18272,7 +18636,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18272
18636
|
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']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
18273
18637
|
* Voicemail service.
|
|
18274
18638
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
18275
|
-
* @version
|
|
18639
|
+
* @version 210.0.0
|
|
18276
18640
|
*//**
|
|
18277
18641
|
* Constructs a new VoicemailApi.
|
|
18278
18642
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -18434,7 +18798,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18434
18798
|
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']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
18435
18799
|
* WebChat service.
|
|
18436
18800
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
18437
|
-
* @version
|
|
18801
|
+
* @version 210.0.0
|
|
18438
18802
|
*//**
|
|
18439
18803
|
* Constructs a new WebChatApi.
|
|
18440
18804
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -18569,7 +18933,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18569
18933
|
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']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
18570
18934
|
* WebDeployments service.
|
|
18571
18935
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
18572
|
-
* @version
|
|
18936
|
+
* @version 210.0.0
|
|
18573
18937
|
*//**
|
|
18574
18938
|
* Constructs a new WebDeploymentsApi.
|
|
18575
18939
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -18690,7 +19054,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18690
19054
|
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']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
18691
19055
|
* WebMessaging service.
|
|
18692
19056
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
18693
|
-
* @version
|
|
19057
|
+
* @version 210.0.0
|
|
18694
19058
|
*//**
|
|
18695
19059
|
* Constructs a new WebMessagingApi.
|
|
18696
19060
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -18706,7 +19070,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
18706
19070
|
*/return _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']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
18707
19071
|
* Widgets service.
|
|
18708
19072
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
18709
|
-
* @version
|
|
19073
|
+
* @version 210.0.0
|
|
18710
19074
|
*//**
|
|
18711
19075
|
* Constructs a new WidgetsApi.
|
|
18712
19076
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -18741,7 +19105,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18741
19105
|
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']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
18742
19106
|
* WorkforceManagement service.
|
|
18743
19107
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
18744
|
-
* @version
|
|
19108
|
+
* @version 210.0.0
|
|
18745
19109
|
*//**
|
|
18746
19110
|
* Constructs a new WorkforceManagementApi.
|
|
18747
19111
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -19428,11 +19792,9 @@ if(timeOffRequestId===undefined||timeOffRequestId===null){throw'Missing the requ
|
|
|
19428
19792
|
*
|
|
19429
19793
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
19430
19794
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
19431
|
-
|
|
19432
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
19433
|
-
*/},{key:"getWorkforcemanagementManagementunitUserTimeoffrequests",value:function getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId,userId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
19795
|
+
*/},{key:"getWorkforcemanagementManagementunitUserTimeoffrequests",value:function getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId,userId){// verify the required parameter 'managementUnitId' is set
|
|
19434
19796
|
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';}// verify the required parameter 'userId' is set
|
|
19435
|
-
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests','GET',{'managementUnitId':managementUnitId,'userId':userId},{
|
|
19797
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests','GET',{'managementUnitId':managementUnitId,'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19436
19798
|
* Get users in the management unit
|
|
19437
19799
|
*
|
|
19438
19800
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -19466,7 +19828,7 @@ if(weekId===undefined||weekId===null){throw'Missing the required parameter "week
|
|
|
19466
19828
|
* Gets all the shift trades for a given week
|
|
19467
19829
|
*
|
|
19468
19830
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
19469
|
-
* @param {String} weekDateId The start date of the
|
|
19831
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
19470
19832
|
* @param {Object} opts Optional parameters
|
|
19471
19833
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
19472
19834
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -19551,9 +19913,7 @@ if(timeOffRequestId===undefined||timeOffRequestId===null){throw'Missing the requ
|
|
|
19551
19913
|
if(timeOffRequestId===undefined||timeOffRequestId===null){throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';}return this.apiClient.callApi('/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions','GET',{'timeOffRequestId':timeOffRequestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19552
19914
|
* Get a list of time off requests for the current user
|
|
19553
19915
|
*
|
|
19554
|
-
|
|
19555
|
-
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
19556
|
-
*/},{key:"getWorkforcemanagementTimeoffrequests",value:function getWorkforcemanagementTimeoffrequests(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/timeoffrequests','GET',{},{'recentlyReviewed':opts['recentlyReviewed']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19916
|
+
*/},{key:"getWorkforcemanagementTimeoffrequests",value:function getWorkforcemanagementTimeoffrequests(){return this.apiClient.callApi('/api/v2/workforcemanagement/timeoffrequests','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19557
19917
|
* Get work plan bid ranks for a user
|
|
19558
19918
|
*
|
|
19559
19919
|
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
@@ -19765,7 +20125,7 @@ if(timeOffRequestId===undefined||timeOffRequestId===null){throw'Missing the requ
|
|
|
19765
20125
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
19766
20126
|
*
|
|
19767
20127
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
19768
|
-
* @param {String} weekDateId The start date of the
|
|
20128
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
19769
20129
|
* @param {String} tradeId The ID of the shift trade to update
|
|
19770
20130
|
* @param {Object} body body
|
|
19771
20131
|
*/},{key:"patchWorkforcemanagementManagementunitWeekShifttrade",value:function patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId,weekDateId,tradeId,body){// verify the required parameter 'managementUnitId' is set
|
|
@@ -20332,7 +20692,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20332
20692
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
20333
20693
|
*
|
|
20334
20694
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
20335
|
-
* @param {String} weekDateId The start date of the
|
|
20695
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
20336
20696
|
* @param {String} tradeId The ID of the shift trade to update
|
|
20337
20697
|
* @param {Object} body body
|
|
20338
20698
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradeMatch",value:function postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId,weekDateId,tradeId,body){// verify the required parameter 'managementUnitId' is set
|
|
@@ -20343,7 +20703,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20343
20703
|
* Adds a shift trade
|
|
20344
20704
|
*
|
|
20345
20705
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
20346
|
-
* @param {String} weekDateId The start date of the
|
|
20706
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
20347
20707
|
* @param {Object} body body
|
|
20348
20708
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttrades",value:function postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,body){// verify the required parameter 'managementUnitId' is set
|
|
20349
20709
|
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
@@ -20352,7 +20712,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20352
20712
|
* Searches for potential shift trade matches for the current agent
|
|
20353
20713
|
*
|
|
20354
20714
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
20355
|
-
* @param {String} weekDateId The start date of the
|
|
20715
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
20356
20716
|
* @param {Object} body body
|
|
20357
20717
|
* @param {Object} opts Optional parameters
|
|
20358
20718
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
@@ -20363,7 +20723,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20363
20723
|
* Updates the state of a batch of shift trades
|
|
20364
20724
|
* Admin functionality is not supported with "mine".
|
|
20365
20725
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
20366
|
-
* @param {String} weekDateId The start date of the
|
|
20726
|
+
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
20367
20727
|
* @param {Object} body body
|
|
20368
20728
|
* @param {Object} opts Optional parameters
|
|
20369
20729
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -20522,7 +20882,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
20522
20882
|
* </pre>
|
|
20523
20883
|
* </p>
|
|
20524
20884
|
* @module purecloud-platform-client-v2/index
|
|
20525
|
-
* @version
|
|
20885
|
+
* @version 210.0.0
|
|
20526
20886
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
20527
20887
|
* The ApiClient constructor.
|
|
20528
20888
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -20575,6 +20935,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
20575
20935
|
* The DataExtensionsApi service constructor.
|
|
20576
20936
|
* @property {module:purecloud-platform-client-v2/api/DataExtensionsApi}
|
|
20577
20937
|
*/this.DataExtensionsApi=DataExtensionsApi;/**
|
|
20938
|
+
* The DataPrivacyApi service constructor.
|
|
20939
|
+
* @property {module:purecloud-platform-client-v2/api/DataPrivacyApi}
|
|
20940
|
+
*/this.DataPrivacyApi=DataPrivacyApi;/**
|
|
20578
20941
|
* The DownloadsApi service constructor.
|
|
20579
20942
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
20580
20943
|
*/this.DownloadsApi=DownloadsApi;/**
|
|
@@ -20704,6 +21067,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
20704
21067
|
* The SettingsApi service constructor.
|
|
20705
21068
|
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
20706
21069
|
*/this.SettingsApi=SettingsApi;/**
|
|
21070
|
+
* The SocialMediaApi service constructor.
|
|
21071
|
+
* @property {module:purecloud-platform-client-v2/api/SocialMediaApi}
|
|
21072
|
+
*/this.SocialMediaApi=SocialMediaApi;/**
|
|
20707
21073
|
* The SpeechTextAnalyticsApi service constructor.
|
|
20708
21074
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|
|
20709
21075
|
*/this.SpeechTextAnalyticsApi=SpeechTextAnalyticsApi;/**
|