purecloud-platform-client-v2 233.0.0 → 235.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 +503 -1079
- package/dist/web-amd/purecloud-platform-client-v2.js +503 -1079
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +233 -409
- package/dist/web-cjs/purecloud-platform-client-v2.js +233 -409
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +475 -382
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +45 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +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/BusinessRulesApi.js +1 -30
- 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 +51 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +42 -8
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +61 -880
- 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 +51 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -107
- 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 +156 -1
- 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 -31
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +7 -3
- 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 +2 -2
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -16,7 +16,13 @@ function Item(fun,array){this.fun=fun;this.array=array;}Item.prototype.run=funct
|
|
|
16
16
|
var versions={};var release={};var config={};function noop$1(){}var on=noop$1;var addListener=noop$1;var once=noop$1;var off=noop$1;var removeListener=noop$1;var removeAllListeners=noop$1;var emit=noop$1;function binding(name){throw new Error('process.binding is not supported');}function cwd(){return'/';}function chdir(dir){throw new Error('process.chdir is not supported');}function umask(){return 0;}// from https://github.com/kumavis/browser-process-hrtime/blob/master/index.js
|
|
17
17
|
var performance=global$1.performance||{};var performanceNow=performance.now||performance.mozNow||performance.msNow||performance.oNow||performance.webkitNow||function(){return new Date().getTime();};// generate timestamp or delta
|
|
18
18
|
// see http://nodejs.org/api/process.html#process_process_hrtime
|
|
19
|
-
function hrtime(previousTimestamp){var clocktime=performanceNow.call(performance)*1e-3;var seconds=Math.floor(clocktime);var nanoseconds=Math.floor(clocktime%1*1e9);if(previousTimestamp){seconds=seconds-previousTimestamp[0];nanoseconds=nanoseconds-previousTimestamp[1];if(nanoseconds<0){seconds--;nanoseconds+=1e9;}}return[seconds,nanoseconds];}var startTime=new Date();function uptime(){var currentTime=new Date();var dif=currentTime-startTime;return dif/1000;}var process={nextTick:nextTick,title:title,browser:browser,env:env,argv:argv,version:version,versions:versions,on:on,addListener:addListener,once:once,off:off,removeListener:removeListener,removeAllListeners:removeAllListeners,emit:emit,binding:binding,cwd:cwd,chdir:chdir,umask:umask,hrtime:hrtime,platform:platform$2,release:release,config:config,uptime:uptime}
|
|
19
|
+
function hrtime(previousTimestamp){var clocktime=performanceNow.call(performance)*1e-3;var seconds=Math.floor(clocktime);var nanoseconds=Math.floor(clocktime%1*1e9);if(previousTimestamp){seconds=seconds-previousTimestamp[0];nanoseconds=nanoseconds-previousTimestamp[1];if(nanoseconds<0){seconds--;nanoseconds+=1e9;}}return[seconds,nanoseconds];}var startTime=new Date();function uptime(){var currentTime=new Date();var dif=currentTime-startTime;return dif/1000;}var process={nextTick:nextTick,title:title,browser:browser,env:env,argv:argv,version:version,versions:versions,on:on,addListener:addListener,once:once,off:off,removeListener:removeListener,removeAllListeners:removeAllListeners,emit:emit,binding:binding,cwd:cwd,chdir:chdir,umask:umask,hrtime:hrtime,platform:platform$2,release:release,config:config,uptime:uptime};/**
|
|
20
|
+
* Create a bound version of a function with a specified `this` context
|
|
21
|
+
*
|
|
22
|
+
* @param {Function} fn - The function to bind
|
|
23
|
+
* @param {*} thisArg - The value to be passed as the `this` parameter
|
|
24
|
+
* @returns {Function} A new function that will call the original function with the specified `this` context
|
|
25
|
+
*/function bind(fn,thisArg){return function wrap(){return fn.apply(thisArg,arguments);};}// utils is a library of generic helper functions non-specific to axios
|
|
20
26
|
var toString$1=Object.prototype.toString;var getPrototypeOf=Object.getPrototypeOf;var iterator=Symbol.iterator,toStringTag=Symbol.toStringTag;var kindOf=function(cache){return function(thing){var str=toString$1.call(thing);return cache[str]||(cache[str]=str.slice(8,-1).toLowerCase());};}(Object.create(null));var kindOfTest=function kindOfTest(type){type=type.toLowerCase();return function(thing){return kindOf(thing)===type;};};var typeOfTest=function typeOfTest(type){return function(thing){return _typeof(thing)===type;};};/**
|
|
21
27
|
* Determine if a value is an Array
|
|
22
28
|
*
|
|
@@ -542,7 +548,7 @@ indexes===true?renderKey([key],index,dots):indexes===null?key:key+'[]',convertVa
|
|
|
542
548
|
*
|
|
543
549
|
* @param {Number} id The ID that was returned by `use`
|
|
544
550
|
*
|
|
545
|
-
* @returns {
|
|
551
|
+
* @returns {void}
|
|
546
552
|
*/},{key:"eject",value:function eject(id){if(this.handlers[id]){this.handlers[id]=null;}}/**
|
|
547
553
|
* Clear all interceptors from the stack
|
|
548
554
|
*
|
|
@@ -667,7 +673,7 @@ AxiosError.call(this,message==null?'canceled':message,AxiosError.ERR_CANCELED,co
|
|
|
667
673
|
* @param {Number} freq
|
|
668
674
|
* @return {Function}
|
|
669
675
|
*/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(void 0,_toConsumableArray(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
|
|
670
|
-
{write:function write(name,value,expires,path,domain,secure){var cookie=[name
|
|
676
|
+
{write:function write(name,value,expires,path,domain,secure,sameSite){if(typeof document==='undefined')return;var cookie=["".concat(name,"=").concat(encodeURIComponent(value))];if(utils$1.isNumber(expires)){cookie.push("expires=".concat(new Date(expires).toUTCString()));}if(utils$1.isString(path)){cookie.push("path=".concat(path));}if(utils$1.isString(domain)){cookie.push("domain=".concat(domain));}if(secure===true){cookie.push('secure');}if(utils$1.isString(sameSite)){cookie.push("SameSite=".concat(sameSite));}document.cookie=cookie.join('; ');},read:function read(name){if(typeof document==='undefined')return null;var match=document.cookie.match(new RegExp('(?:^|; )'+name+'=([^;]*)'));return match?decodeURIComponent(match[1]):null;},remove:function remove(name){this.write(name,'',Date.now()-86400000,'/');}}:// Non-standard browser env (web workers, react-native) lack needed support.
|
|
671
677
|
{write:function write(){},read:function read(){return null;},remove:function remove(){}};/**
|
|
672
678
|
* Determines whether the specified URL is absolute
|
|
673
679
|
*
|
|
@@ -747,8 +753,44 @@ if(onUploadProgress&&request.upload){var _progressEventReducer3=progressEventRed
|
|
|
747
753
|
onCanceled=function onCanceled(cancel){if(!request){return;}reject(!cancel||cancel.type?new CanceledError(null,config,request):cancel);request.abort();request=null;};_config.cancelToken&&_config.cancelToken.subscribe(onCanceled);if(_config.signal){_config.signal.aborted?onCanceled():_config.signal.addEventListener('abort',onCanceled);}}var protocol=parseProtocol(_config.url);if(protocol&&platform.protocols.indexOf(protocol)===-1){reject(new AxiosError('Unsupported protocol '+protocol+':',AxiosError.ERR_BAD_REQUEST,config));return;}// Send the request
|
|
748
754
|
request.send(requestData||null);});};var composeSignals=function composeSignals(signals,timeout){var _signals=signals=signals?signals.filter(Boolean):[],length=_signals.length;if(timeout||length){var controller=new AbortController();var aborted;var onabort=function onabort(reason){if(!aborted){aborted=true;unsubscribe();var err=reason instanceof Error?reason:this.reason;controller.abort(err instanceof AxiosError?err:new CanceledError(err instanceof Error?err.message:err));}};var timer=timeout&&setTimeout(function(){timer=null;onabort(new AxiosError("timeout ".concat(timeout," of ms exceeded"),AxiosError.ETIMEDOUT));},timeout);var unsubscribe=function unsubscribe(){if(signals){timer&&clearTimeout(timer);timer=null;signals.forEach(function(signal){signal.unsubscribe?signal.unsubscribe(onabort):signal.removeEventListener('abort',onabort);});signals=null;}};signals.forEach(function(signal){return signal.addEventListener('abort',onabort);});var signal=controller.signal;signal.unsubscribe=function(){return utils$1.asap(unsubscribe);};return signal;}};var composeSignals$1=composeSignals;var streamChunk=/*#__PURE__*/_regenerator().m(function streamChunk(chunk,chunkSize){var len,pos,end;return _regenerator().w(function(_context){while(1)switch(_context.n){case 0:len=chunk.byteLength;if(!(!chunkSize||len<chunkSize)){_context.n=2;break;}_context.n=1;return chunk;case 1:return _context.a(2);case 2:pos=0;case 3:if(!(pos<len)){_context.n=5;break;}end=pos+chunkSize;_context.n=4;return chunk.slice(pos,end);case 4:pos=end;_context.n=3;break;case 5:return _context.a(2);}},streamChunk);});var readBytes=/*#__PURE__*/function(){var _ref=_wrapAsyncGenerator(/*#__PURE__*/_regenerator().m(function _callee(iterable,chunkSize){var _iteratorAbruptCompletion,_didIteratorError,_iteratorError,_iterator2,_step,chunk,_t;return _regenerator().w(function(_context2){while(1)switch(_context2.p=_context2.n){case 0:_iteratorAbruptCompletion=false;_didIteratorError=false;_context2.p=1;_iterator2=_asyncIterator(readStream(iterable));case 2:_context2.n=3;return _awaitAsyncGenerator(_iterator2.next());case 3:if(!(_iteratorAbruptCompletion=!(_step=_context2.v).done)){_context2.n=5;break;}chunk=_step.value;return _context2.d(_regeneratorValues(_asyncGeneratorDelegate(_asyncIterator(streamChunk(chunk,chunkSize)),_awaitAsyncGenerator)),4);case 4:_iteratorAbruptCompletion=false;_context2.n=2;break;case 5:_context2.n=7;break;case 6:_context2.p=6;_t=_context2.v;_didIteratorError=true;_iteratorError=_t;case 7:_context2.p=7;_context2.p=8;if(!(_iteratorAbruptCompletion&&_iterator2["return"]!=null)){_context2.n=9;break;}_context2.n=9;return _awaitAsyncGenerator(_iterator2["return"]());case 9:_context2.p=9;if(!_didIteratorError){_context2.n=10;break;}throw _iteratorError;case 10:return _context2.f(9);case 11:return _context2.f(7);case 12:return _context2.a(2);}},_callee,null,[[8,,9,11],[1,6,7,12]]);}));return function readBytes(_x,_x2){return _ref.apply(this,arguments);};}();var readStream=/*#__PURE__*/function(){var _ref2=_wrapAsyncGenerator(/*#__PURE__*/_regenerator().m(function _callee2(stream){var reader,_yield$_awaitAsyncGen,done,value;return _regenerator().w(function(_context3){while(1)switch(_context3.p=_context3.n){case 0:if(!stream[Symbol.asyncIterator]){_context3.n=2;break;}return _context3.d(_regeneratorValues(_asyncGeneratorDelegate(_asyncIterator(stream),_awaitAsyncGenerator)),1);case 1:return _context3.a(2);case 2:reader=stream.getReader();_context3.p=3;case 4:_context3.n=5;return _awaitAsyncGenerator(reader.read());case 5:_yield$_awaitAsyncGen=_context3.v;done=_yield$_awaitAsyncGen.done;value=_yield$_awaitAsyncGen.value;if(!done){_context3.n=6;break;}return _context3.a(3,8);case 6:_context3.n=7;return value;case 7:_context3.n=4;break;case 8:_context3.p=8;_context3.n=9;return _awaitAsyncGenerator(reader.cancel());case 9:return _context3.f(8);case 10:return _context3.a(2);}},_callee2,null,[[3,,8,10]]);}));return function readStream(_x3){return _ref2.apply(this,arguments);};}();var trackStream=function trackStream(stream,chunkSize,onProgress,onFinish){var iterator=readBytes(stream,chunkSize);var bytes=0;var done;var _onFinish=function _onFinish(e){if(!done){done=true;onFinish&&onFinish(e);}};return new ReadableStream({pull:function pull(controller){return _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(){var _yield$iterator$next,_done,value,len,loadedBytes,_t2;return _regenerator().w(function(_context4){while(1)switch(_context4.p=_context4.n){case 0:_context4.p=0;_context4.n=1;return iterator.next();case 1:_yield$iterator$next=_context4.v;_done=_yield$iterator$next.done;value=_yield$iterator$next.value;if(!_done){_context4.n=2;break;}_onFinish();controller.close();return _context4.a(2);case 2:len=value.byteLength;if(onProgress){loadedBytes=bytes+=len;onProgress(loadedBytes);}controller.enqueue(new Uint8Array(value));_context4.n=4;break;case 3:_context4.p=3;_t2=_context4.v;_onFinish(_t2);throw _t2;case 4:return _context4.a(2);}},_callee3,null,[[0,3]]);}))();},cancel:function cancel(reason){_onFinish(reason);return iterator["return"]();}},{highWaterMark:2});};var DEFAULT_CHUNK_SIZE=64*1024;var isFunction=utils$1.isFunction;var globalFetchAPI=function(_ref11){var Request=_ref11.Request,Response=_ref11.Response;return{Request:Request,Response:Response};}(utils$1.global);var _utils$1$global=utils$1.global,ReadableStream$1=_utils$1$global.ReadableStream,TextEncoder$1=_utils$1$global.TextEncoder;var test=function test(fn){try{for(var _len5=arguments.length,args=new Array(_len5>1?_len5-1:0),_key6=1;_key6<_len5;_key6++){args[_key6-1]=arguments[_key6];}return!!fn.apply(void 0,args);}catch(e){return false;}};var factory=function factory(env){env=utils$1.merge.call({skipUndefined:true},globalFetchAPI,env);var _env=env,envFetch=_env.fetch,Request=_env.Request,Response=_env.Response;var isFetchSupported=envFetch?isFunction(envFetch):typeof fetch==='function';var isRequestSupported=isFunction(Request);var isResponseSupported=isFunction(Response);if(!isFetchSupported){return false;}var isReadableStreamSupported=isFetchSupported&&isFunction(ReadableStream$1);var encodeText=isFetchSupported&&(typeof TextEncoder$1==='function'?function(encoder){return function(str){return encoder.encode(str);};}(new TextEncoder$1()):(/*#__PURE__*/function(){var _ref12=_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4(str){var _t3,_t4;return _regenerator().w(function(_context5){while(1)switch(_context5.n){case 0:_t3=Uint8Array;_context5.n=1;return new Request(str).arrayBuffer();case 1:_t4=_context5.v;return _context5.a(2,new _t3(_t4));}},_callee4);}));return function(_x4){return _ref12.apply(this,arguments);};}()));var supportsRequestStream=isRequestSupported&&isReadableStreamSupported&&test(function(){var duplexAccessed=false;var hasContentType=new Request(platform.origin,{body:new ReadableStream$1(),method:'POST',get duplex(){duplexAccessed=true;return'half';}}).headers.has('Content-Type');return duplexAccessed&&!hasContentType;});var supportsResponseStream=isResponseSupported&&isReadableStreamSupported&&test(function(){return utils$1.isReadableStream(new Response('').body);});var resolvers={stream:supportsResponseStream&&function(res){return res.body;}};isFetchSupported&&function(){['text','arrayBuffer','blob','formData','stream'].forEach(function(type){!resolvers[type]&&(resolvers[type]=function(res,config){var method=res&&res[type];if(method){return method.call(res);}throw new AxiosError("Response type '".concat(type,"' is not supported"),AxiosError.ERR_NOT_SUPPORT,config);});});}();var getBodyLength=/*#__PURE__*/function(){var _ref13=_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(body){var _request;return _regenerator().w(function(_context6){while(1)switch(_context6.n){case 0:if(!(body==null)){_context6.n=1;break;}return _context6.a(2,0);case 1:if(!utils$1.isBlob(body)){_context6.n=2;break;}return _context6.a(2,body.size);case 2:if(!utils$1.isSpecCompliantForm(body)){_context6.n=4;break;}_request=new Request(platform.origin,{method:'POST',body:body});_context6.n=3;return _request.arrayBuffer();case 3:return _context6.a(2,_context6.v.byteLength);case 4:if(!(utils$1.isArrayBufferView(body)||utils$1.isArrayBuffer(body))){_context6.n=5;break;}return _context6.a(2,body.byteLength);case 5:if(utils$1.isURLSearchParams(body)){body=body+'';}if(!utils$1.isString(body)){_context6.n=7;break;}_context6.n=6;return encodeText(body);case 6:return _context6.a(2,_context6.v.byteLength);case 7:return _context6.a(2);}},_callee5);}));return function getBodyLength(_x5){return _ref13.apply(this,arguments);};}();var resolveBodyLength=/*#__PURE__*/function(){var _ref14=_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(headers,body){var length;return _regenerator().w(function(_context7){while(1)switch(_context7.n){case 0:length=utils$1.toFiniteNumber(headers.getContentLength());return _context7.a(2,length==null?getBodyLength(body):length);}},_callee6);}));return function resolveBodyLength(_x6,_x7){return _ref14.apply(this,arguments);};}();return/*#__PURE__*/function(){var _ref15=_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee7(config){var _resolveConfig,url,method,data,signal,cancelToken,timeout,onDownloadProgress,onUploadProgress,responseType,headers,_resolveConfig$withCr,withCredentials,fetchOptions,_fetch,composedSignal,request,unsubscribe,requestContentLength,_request,contentTypeHeader,_progressEventDecorat,_progressEventDecorat2,onProgress,flush,isCredentialsSupported,resolvedOptions,response,isStreamResponse,options,responseContentLength,_ref16,_ref17,_onProgress,_flush,responseData,_t5,_t6,_t7;return _regenerator().w(function(_context8){while(1)switch(_context8.p=_context8.n){case 0:_resolveConfig=resolveConfig(config),url=_resolveConfig.url,method=_resolveConfig.method,data=_resolveConfig.data,signal=_resolveConfig.signal,cancelToken=_resolveConfig.cancelToken,timeout=_resolveConfig.timeout,onDownloadProgress=_resolveConfig.onDownloadProgress,onUploadProgress=_resolveConfig.onUploadProgress,responseType=_resolveConfig.responseType,headers=_resolveConfig.headers,_resolveConfig$withCr=_resolveConfig.withCredentials,withCredentials=_resolveConfig$withCr===void 0?'same-origin':_resolveConfig$withCr,fetchOptions=_resolveConfig.fetchOptions;_fetch=envFetch||fetch;responseType=responseType?(responseType+'').toLowerCase():'text';composedSignal=composeSignals$1([signal,cancelToken&&cancelToken.toAbortSignal()],timeout);request=null;unsubscribe=composedSignal&&composedSignal.unsubscribe&&function(){composedSignal.unsubscribe();};_context8.p=1;_t5=onUploadProgress&&supportsRequestStream&&method!=='get'&&method!=='head';if(!_t5){_context8.n=3;break;}_context8.n=2;return resolveBodyLength(headers,data);case 2:_t6=requestContentLength=_context8.v;_t5=_t6!==0;case 3:if(!_t5){_context8.n=4;break;}_request=new Request(url,{method:'POST',body:data,duplex:"half"});if(utils$1.isFormData(data)&&(contentTypeHeader=_request.headers.get('content-type'))){headers.setContentType(contentTypeHeader);}if(_request.body){_progressEventDecorat=progressEventDecorator(requestContentLength,progressEventReducer(asyncDecorator(onUploadProgress))),_progressEventDecorat2=_slicedToArray(_progressEventDecorat,2),onProgress=_progressEventDecorat2[0],flush=_progressEventDecorat2[1];data=trackStream(_request.body,DEFAULT_CHUNK_SIZE,onProgress,flush);}case 4:if(!utils$1.isString(withCredentials)){withCredentials=withCredentials?'include':'omit';}// Cloudflare Workers throws when credentials are defined
|
|
749
755
|
// see https://github.com/cloudflare/workerd/issues/902
|
|
750
|
-
isCredentialsSupported=isRequestSupported&&"credentials"in Request.prototype;resolvedOptions=_objectSpread(_objectSpread({},fetchOptions),{},{signal:composedSignal,method:method.toUpperCase(),headers:headers.normalize().toJSON(),body:data,duplex:"half",credentials:isCredentialsSupported?withCredentials:undefined});request=isRequestSupported&&new Request(url,resolvedOptions);_context8.n=5;return isRequestSupported?_fetch(request,fetchOptions):_fetch(url,resolvedOptions);case 5:response=_context8.v;isStreamResponse=supportsResponseStream&&(responseType==='stream'||responseType==='response');if(supportsResponseStream&&(onDownloadProgress||isStreamResponse&&unsubscribe)){options={};['status','statusText','headers'].forEach(function(prop){options[prop]=response[prop];});responseContentLength=utils$1.toFiniteNumber(response.headers.get('content-length'));_ref16=onDownloadProgress&&progressEventDecorator(responseContentLength,progressEventReducer(asyncDecorator(onDownloadProgress),true))||[],_ref17=_slicedToArray(_ref16,2),_onProgress=_ref17[0],_flush=_ref17[1];response=new Response(trackStream(response.body,DEFAULT_CHUNK_SIZE,_onProgress,function(){_flush&&_flush();unsubscribe&&unsubscribe();}),options);}responseType=responseType||'text';_context8.n=6;return resolvers[utils$1.findKey(resolvers,responseType)||'text'](response,config);case 6:responseData=_context8.v;!isStreamResponse&&unsubscribe&&unsubscribe();_context8.n=7;return new Promise(function(resolve,reject){settle(resolve,reject,{data:responseData,headers:AxiosHeaders$1.from(response.headers),status:response.status,statusText:response.statusText,config:config,request:request});});case 7:return _context8.a(2,_context8.v);case 8:_context8.p=8;_t7=_context8.v;unsubscribe&&unsubscribe();if(!(_t7&&_t7.name==='TypeError'&&/Load failed|fetch/i.test(_t7.message))){_context8.n=9;break;}throw Object.assign(new AxiosError('Network Error',AxiosError.ERR_NETWORK,config,request),{cause:_t7.cause||_t7});case 9:throw AxiosError.from(_t7,_t7&&_t7.code,config,request);case 10:return _context8.a(2);}},_callee7,null,[[1,8]]);}));return function(_x8){return _ref15.apply(this,arguments);};}();};var seedCache=new Map();var getFetch=function getFetch(config){var env=config
|
|
751
|
-
|
|
756
|
+
isCredentialsSupported=isRequestSupported&&"credentials"in Request.prototype;resolvedOptions=_objectSpread(_objectSpread({},fetchOptions),{},{signal:composedSignal,method:method.toUpperCase(),headers:headers.normalize().toJSON(),body:data,duplex:"half",credentials:isCredentialsSupported?withCredentials:undefined});request=isRequestSupported&&new Request(url,resolvedOptions);_context8.n=5;return isRequestSupported?_fetch(request,fetchOptions):_fetch(url,resolvedOptions);case 5:response=_context8.v;isStreamResponse=supportsResponseStream&&(responseType==='stream'||responseType==='response');if(supportsResponseStream&&(onDownloadProgress||isStreamResponse&&unsubscribe)){options={};['status','statusText','headers'].forEach(function(prop){options[prop]=response[prop];});responseContentLength=utils$1.toFiniteNumber(response.headers.get('content-length'));_ref16=onDownloadProgress&&progressEventDecorator(responseContentLength,progressEventReducer(asyncDecorator(onDownloadProgress),true))||[],_ref17=_slicedToArray(_ref16,2),_onProgress=_ref17[0],_flush=_ref17[1];response=new Response(trackStream(response.body,DEFAULT_CHUNK_SIZE,_onProgress,function(){_flush&&_flush();unsubscribe&&unsubscribe();}),options);}responseType=responseType||'text';_context8.n=6;return resolvers[utils$1.findKey(resolvers,responseType)||'text'](response,config);case 6:responseData=_context8.v;!isStreamResponse&&unsubscribe&&unsubscribe();_context8.n=7;return new Promise(function(resolve,reject){settle(resolve,reject,{data:responseData,headers:AxiosHeaders$1.from(response.headers),status:response.status,statusText:response.statusText,config:config,request:request});});case 7:return _context8.a(2,_context8.v);case 8:_context8.p=8;_t7=_context8.v;unsubscribe&&unsubscribe();if(!(_t7&&_t7.name==='TypeError'&&/Load failed|fetch/i.test(_t7.message))){_context8.n=9;break;}throw Object.assign(new AxiosError('Network Error',AxiosError.ERR_NETWORK,config,request),{cause:_t7.cause||_t7});case 9:throw AxiosError.from(_t7,_t7&&_t7.code,config,request);case 10:return _context8.a(2);}},_callee7,null,[[1,8]]);}));return function(_x8){return _ref15.apply(this,arguments);};}();};var seedCache=new Map();var getFetch=function getFetch(config){var env=config&&config.env||{};var fetch=env.fetch,Request=env.Request,Response=env.Response;var seeds=[Request,Response,fetch];var len=seeds.length,i=len,seed,target,map=seedCache;while(i--){seed=seeds[i];target=map.get(seed);target===undefined&&map.set(seed,target=i?new Map():factory(env));map=target;}return target;};getFetch();/**
|
|
757
|
+
* Known adapters mapping.
|
|
758
|
+
* Provides environment-specific adapters for Axios:
|
|
759
|
+
* - `http` for Node.js
|
|
760
|
+
* - `xhr` for browsers
|
|
761
|
+
* - `fetch` for fetch API-based requests
|
|
762
|
+
*
|
|
763
|
+
* @type {Object<string, Function|Object>}
|
|
764
|
+
*/var knownAdapters={http:httpAdapter,xhr:xhrAdapter,fetch:{get:getFetch}};// Assign adapter names for easier debugging and identification
|
|
765
|
+
utils$1.forEach(knownAdapters,function(fn,value){if(fn){try{Object.defineProperty(fn,'name',{value:value});}catch(e){// eslint-disable-next-line no-empty
|
|
766
|
+
}Object.defineProperty(fn,'adapterName',{value:value});}});/**
|
|
767
|
+
* Render a rejection reason string for unknown or unsupported adapters
|
|
768
|
+
*
|
|
769
|
+
* @param {string} reason
|
|
770
|
+
* @returns {string}
|
|
771
|
+
*/var renderReason=function renderReason(reason){return"- ".concat(reason);};/**
|
|
772
|
+
* Check if the adapter is resolved (function, null, or false)
|
|
773
|
+
*
|
|
774
|
+
* @param {Function|null|false} adapter
|
|
775
|
+
* @returns {boolean}
|
|
776
|
+
*/var isResolvedHandle=function isResolvedHandle(adapter){return utils$1.isFunction(adapter)||adapter===null||adapter===false;};/**
|
|
777
|
+
* Get the first suitable adapter from the provided list.
|
|
778
|
+
* Tries each adapter in order until a supported one is found.
|
|
779
|
+
* Throws an AxiosError if no adapter is suitable.
|
|
780
|
+
*
|
|
781
|
+
* @param {Array<string|Function>|string|Function} adapters - Adapter(s) by name or function.
|
|
782
|
+
* @param {Object} config - Axios request configuration
|
|
783
|
+
* @throws {AxiosError} If no suitable adapter is available
|
|
784
|
+
* @returns {Function} The resolved adapter function
|
|
785
|
+
*/function getAdapter(adapters,config){adapters=utils$1.isArray(adapters)?adapters:[adapters];var _adapters=adapters,length=_adapters.length;var nameOrAdapter;var adapter;var rejectedReasons={};for(var i=0;i<length;i++){nameOrAdapter=adapters[i];var id=void 0;adapter=nameOrAdapter;if(!isResolvedHandle(nameOrAdapter)){adapter=knownAdapters[(id=String(nameOrAdapter)).toLowerCase()];if(adapter===undefined){throw new AxiosError("Unknown adapter '".concat(id,"'"));}}if(adapter&&(utils$1.isFunction(adapter)||(adapter=adapter.get(config)))){break;}rejectedReasons[id||'#'+i]=adapter;}if(!adapter){var reasons=Object.entries(rejectedReasons).map(function(_ref18){var _ref19=_slicedToArray(_ref18,2),id=_ref19[0],state=_ref19[1];return"adapter ".concat(id," ")+(state===false?'is not supported by the environment':'is not available in the build');});var s=length?reasons.length>1?'since :\n'+reasons.map(renderReason).join('\n'):' '+renderReason(reasons[0]):'as no adapter specified';throw new AxiosError("There is no suitable adapter to dispatch the request "+s,'ERR_NOT_SUPPORT');}return adapter;}/**
|
|
786
|
+
* Exports Axios adapters and utility to resolve an adapter
|
|
787
|
+
*/var adapters={/**
|
|
788
|
+
* Resolve an adapter from a list of adapter names or functions.
|
|
789
|
+
* @type {Function}
|
|
790
|
+
*/getAdapter:getAdapter,/**
|
|
791
|
+
* Exposes all known adapters
|
|
792
|
+
* @type {Object<string, Function|Object>}
|
|
793
|
+
*/adapters:knownAdapters};/**
|
|
752
794
|
* Throws a `CanceledError` if cancellation has been requested.
|
|
753
795
|
*
|
|
754
796
|
* @param {Object} config The config that is to be used for the request
|
|
@@ -763,7 +805,7 @@ isCredentialsSupported=isRequestSupported&&"credentials"in Request.prototype;res
|
|
|
763
805
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
764
806
|
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,config);return adapter(config).then(function onAdapterResolution(response){throwIfCancellationRequested(config);// Transform response data
|
|
765
807
|
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
|
|
766
|
-
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.
|
|
808
|
+
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.13.2";var validators$1={};// eslint-disable-next-line func-names
|
|
767
809
|
['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={};/**
|
|
768
810
|
* Transitional option validator
|
|
769
811
|
*
|
|
@@ -850,7 +892,7 @@ return;}token.reason=new CanceledError(message,config,request);resolvePromise(to
|
|
|
850
892
|
* @param {*} payload The value to test
|
|
851
893
|
*
|
|
852
894
|
* @returns {boolean} True if the payload is an error thrown by Axios, otherwise false
|
|
853
|
-
*/function isAxiosError(payload){return utils$1.isObject(payload)&&payload.isAxiosError===true;}var HttpStatusCode={Continue:100,SwitchingProtocols:101,Processing:102,EarlyHints:103,Ok:200,Created:201,Accepted:202,NonAuthoritativeInformation:203,NoContent:204,ResetContent:205,PartialContent:206,MultiStatus:207,AlreadyReported:208,ImUsed:226,MultipleChoices:300,MovedPermanently:301,Found:302,SeeOther:303,NotModified:304,UseProxy:305,Unused:306,TemporaryRedirect:307,PermanentRedirect:308,BadRequest:400,Unauthorized:401,PaymentRequired:402,Forbidden:403,NotFound:404,MethodNotAllowed:405,NotAcceptable:406,ProxyAuthenticationRequired:407,RequestTimeout:408,Conflict:409,Gone:410,LengthRequired:411,PreconditionFailed:412,PayloadTooLarge:413,UriTooLong:414,UnsupportedMediaType:415,RangeNotSatisfiable:416,ExpectationFailed:417,ImATeapot:418,MisdirectedRequest:421,UnprocessableEntity:422,Locked:423,FailedDependency:424,TooEarly:425,UpgradeRequired:426,PreconditionRequired:428,TooManyRequests:429,RequestHeaderFieldsTooLarge:431,UnavailableForLegalReasons:451,InternalServerError:500,NotImplemented:501,BadGateway:502,ServiceUnavailable:503,GatewayTimeout:504,HttpVersionNotSupported:505,VariantAlsoNegotiates:506,InsufficientStorage:507,LoopDetected:508,NotExtended:510,NetworkAuthenticationRequired:511};Object.entries(HttpStatusCode).forEach(function(_ref20){var _ref21=_slicedToArray(_ref20,2),key=_ref21[0],value=_ref21[1];HttpStatusCode[value]=key;});var HttpStatusCode$1=HttpStatusCode;/**
|
|
895
|
+
*/function isAxiosError(payload){return utils$1.isObject(payload)&&payload.isAxiosError===true;}var HttpStatusCode={Continue:100,SwitchingProtocols:101,Processing:102,EarlyHints:103,Ok:200,Created:201,Accepted:202,NonAuthoritativeInformation:203,NoContent:204,ResetContent:205,PartialContent:206,MultiStatus:207,AlreadyReported:208,ImUsed:226,MultipleChoices:300,MovedPermanently:301,Found:302,SeeOther:303,NotModified:304,UseProxy:305,Unused:306,TemporaryRedirect:307,PermanentRedirect:308,BadRequest:400,Unauthorized:401,PaymentRequired:402,Forbidden:403,NotFound:404,MethodNotAllowed:405,NotAcceptable:406,ProxyAuthenticationRequired:407,RequestTimeout:408,Conflict:409,Gone:410,LengthRequired:411,PreconditionFailed:412,PayloadTooLarge:413,UriTooLong:414,UnsupportedMediaType:415,RangeNotSatisfiable:416,ExpectationFailed:417,ImATeapot:418,MisdirectedRequest:421,UnprocessableEntity:422,Locked:423,FailedDependency:424,TooEarly:425,UpgradeRequired:426,PreconditionRequired:428,TooManyRequests:429,RequestHeaderFieldsTooLarge:431,UnavailableForLegalReasons:451,InternalServerError:500,NotImplemented:501,BadGateway:502,ServiceUnavailable:503,GatewayTimeout:504,HttpVersionNotSupported:505,VariantAlsoNegotiates:506,InsufficientStorage:507,LoopDetected:508,NotExtended:510,NetworkAuthenticationRequired:511,WebServerIsDown:521,ConnectionTimedOut:522,OriginIsUnreachable:523,TimeoutOccurred:524,SslHandshakeFailed:525,InvalidSslCertificate:526};Object.entries(HttpStatusCode).forEach(function(_ref20){var _ref21=_slicedToArray(_ref20,2),key=_ref21[0],value=_ref21[1];HttpStatusCode[value]=key;});var HttpStatusCode$1=HttpStatusCode;/**
|
|
854
896
|
* Create an instance of Axios
|
|
855
897
|
*
|
|
856
898
|
* @param {Object} defaultConfig The default config for the instance
|
|
@@ -911,7 +953,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
911
953
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
912
954
|
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];}}}]);}();/**
|
|
913
955
|
* @module purecloud-platform-client-v2/ApiClient
|
|
914
|
-
* @version
|
|
956
|
+
* @version 235.0.0
|
|
915
957
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
916
958
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
917
959
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -980,6 +1022,16 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
980
1022
|
* @description Sets the environment used by the session
|
|
981
1023
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
982
1024
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
1025
|
+
* @description Sets the optional http headers used by the client
|
|
1026
|
+
* @param {object} newHeaders - default headers to be used
|
|
1027
|
+
*/},{key:"setDefaultHeaders",value:function setDefaultHeaders(newHeaders){if(!newHeaders||!(_typeof(newHeaders)==='object')){throw new Error("default headers must be a map");}this.defaultHeaders=newHeaders;}/**
|
|
1028
|
+
* @description Gets the default http headers used by the client
|
|
1029
|
+
*/},{key:"getDefaultHeaders",value:function getDefaultHeaders(){return this.defaultHeaders;}/**
|
|
1030
|
+
* @description Sets the optional Genesys-App http header used by the client
|
|
1031
|
+
* @param {string} headerValue - value for the Genesys-App header
|
|
1032
|
+
*/},{key:"setGenesysAppHeader",value:function setGenesysAppHeader(headerValue){if(!headerValue||!(typeof headerValue==='string'))throw new Error("headerValue must be a non empty string");if(!this.defaultHeaders){this.defaultHeaders={"Genesys-App":headerValue};}else{this.defaultHeaders["Genesys-App"]=headerValue;}}/**
|
|
1033
|
+
* @description Gets the Genesys-App http header used by the client
|
|
1034
|
+
*/},{key:"getGenesysAppHeader",value:function getGenesysAppHeader(){if(this.defaultHeaders&&this.defaultHeaders["Genesys-App"]){return this.defaultHeaders["Genesys-App"];}else{return null;}}/**
|
|
983
1035
|
* @description Sets the dynamic HttpClient used by the client
|
|
984
1036
|
* @param {object} httpClient - HttpClient to be injected
|
|
985
1037
|
*/},{key:"setHttpClient",value:function setHttpClient(httpClient){if(!(httpClient instanceof AbstractHttpClient)){throw new Error("httpclient must be an instance of AbstractHttpClient. See DefaultltHttpClient for a prototype");}this.httpClient=httpClient;}/**
|
|
@@ -1257,7 +1309,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1257
1309
|
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 AIStudioApi=/*#__PURE__*/function(){/**
|
|
1258
1310
|
* AIStudio service.
|
|
1259
1311
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
1260
|
-
* @version
|
|
1312
|
+
* @version 235.0.0
|
|
1261
1313
|
*//**
|
|
1262
1314
|
* Constructs a new AIStudioApi.
|
|
1263
1315
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -1408,7 +1460,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1408
1460
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsSummariesSetting';}return this.apiClient.callApi('/api/v2/conversations/summaries/settings/{summarySettingId}','PUT',{'summarySettingId':summarySettingId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1409
1461
|
* AgentAssistants service.
|
|
1410
1462
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1411
|
-
* @version
|
|
1463
|
+
* @version 235.0.0
|
|
1412
1464
|
*//**
|
|
1413
1465
|
* Constructs a new AgentAssistantsApi.
|
|
1414
1466
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1539,7 +1591,7 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
1539
1591
|
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(){/**
|
|
1540
1592
|
* AgentCopilot service.
|
|
1541
1593
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1542
|
-
* @version
|
|
1594
|
+
* @version 235.0.0
|
|
1543
1595
|
*//**
|
|
1544
1596
|
* Constructs a new AgentCopilotApi.
|
|
1545
1597
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1566,7 +1618,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1566
1618
|
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(){/**
|
|
1567
1619
|
* AgentUI service.
|
|
1568
1620
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1569
|
-
* @version
|
|
1621
|
+
* @version 235.0.0
|
|
1570
1622
|
*//**
|
|
1571
1623
|
* Constructs a new AgentUIApi.
|
|
1572
1624
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1600,7 +1652,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
1600
1652
|
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(){/**
|
|
1601
1653
|
* Alerting service.
|
|
1602
1654
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1603
|
-
* @version
|
|
1655
|
+
* @version 235.0.0
|
|
1604
1656
|
*//**
|
|
1605
1657
|
* Constructs a new AlertingApi.
|
|
1606
1658
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1689,7 +1741,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
1689
1741
|
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(){/**
|
|
1690
1742
|
* Analytics service.
|
|
1691
1743
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1692
|
-
* @version
|
|
1744
|
+
* @version 235.0.0
|
|
1693
1745
|
*//**
|
|
1694
1746
|
* Constructs a new AnalyticsApi.
|
|
1695
1747
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2465,7 +2517,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2465
2517
|
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(){/**
|
|
2466
2518
|
* Architect service.
|
|
2467
2519
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2468
|
-
* @version
|
|
2520
|
+
* @version 235.0.0
|
|
2469
2521
|
*//**
|
|
2470
2522
|
* Constructs a new ArchitectApi.
|
|
2471
2523
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3599,7 +3651,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
3599
3651
|
if(flowOutcomeId===undefined||flowOutcomeId===null||flowOutcomeId===''){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(){/**
|
|
3600
3652
|
* Audit service.
|
|
3601
3653
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3602
|
-
* @version
|
|
3654
|
+
* @version 235.0.0
|
|
3603
3655
|
*//**
|
|
3604
3656
|
* Constructs a new AuditApi.
|
|
3605
3657
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3649,7 +3701,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3649
3701
|
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(){/**
|
|
3650
3702
|
* Authorization service.
|
|
3651
3703
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3652
|
-
* @version
|
|
3704
|
+
* @version 235.0.0
|
|
3653
3705
|
*//**
|
|
3654
3706
|
* Constructs a new AuthorizationApi.
|
|
3655
3707
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -4084,7 +4136,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
4084
4136
|
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(){/**
|
|
4085
4137
|
* Billing service.
|
|
4086
4138
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
4087
|
-
* @version
|
|
4139
|
+
* @version 235.0.0
|
|
4088
4140
|
*//**
|
|
4089
4141
|
* Constructs a new BillingApi.
|
|
4090
4142
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -4161,7 +4213,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
4161
4213
|
if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){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 BusinessRulesApi=/*#__PURE__*/function(){/**
|
|
4162
4214
|
* BusinessRules service.
|
|
4163
4215
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
4164
|
-
* @version
|
|
4216
|
+
* @version 235.0.0
|
|
4165
4217
|
*//**
|
|
4166
4218
|
* Constructs a new BusinessRulesApi.
|
|
4167
4219
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -4174,14 +4226,12 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
4174
4226
|
* @param {String} tableId Table ID
|
|
4175
4227
|
* @param {Object} opts Optional parameters
|
|
4176
4228
|
* @param {Boolean} opts.forceDelete Force delete decision table (under certain conditions) (default to false)
|
|
4177
|
-
* deleteBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4178
4229
|
*/return _createClass(BusinessRulesApi,[{key:"deleteBusinessrulesDecisiontable",value:function deleteBusinessrulesDecisiontable(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
4179
4230
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontable';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}','DELETE',{'tableId':tableId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4180
4231
|
* Delete a decision table version
|
|
4181
4232
|
*
|
|
4182
4233
|
* @param {String} tableId Table ID
|
|
4183
4234
|
* @param {Number} tableVersion Table Version
|
|
4184
|
-
* deleteBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4185
4235
|
*/},{key:"deleteBusinessrulesDecisiontableVersion",value:function deleteBusinessrulesDecisiontableVersion(tableId,tableVersion){// verify the required parameter 'tableId' is set
|
|
4186
4236
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersion';}// verify the required parameter 'tableVersion' is set
|
|
4187
4237
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersion';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}','DELETE',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4190,7 +4240,6 @@ if(tableVersion===undefined||tableVersion===null){throw'Missing the required par
|
|
|
4190
4240
|
* @param {String} tableId Table ID
|
|
4191
4241
|
* @param {Number} tableVersion Table Version
|
|
4192
4242
|
* @param {String} rowId Row ID
|
|
4193
|
-
* deleteBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4194
4243
|
*/},{key:"deleteBusinessrulesDecisiontableVersionRow",value:function deleteBusinessrulesDecisiontableVersionRow(tableId,tableVersion,rowId){// verify the required parameter 'tableId' is set
|
|
4195
4244
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableVersionRow';}// verify the required parameter 'tableVersion' is set
|
|
4196
4245
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling deleteBusinessrulesDecisiontableVersionRow';}// verify the required parameter 'rowId' is set
|
|
@@ -4198,20 +4247,17 @@ if(rowId===undefined||rowId===null||rowId===''){throw'Missing the required param
|
|
|
4198
4247
|
* Delete a schema
|
|
4199
4248
|
*
|
|
4200
4249
|
* @param {String} schemaId Schema ID
|
|
4201
|
-
* deleteBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4202
4250
|
*/},{key:"deleteBusinessrulesSchema",value:function deleteBusinessrulesSchema(schemaId){// verify the required parameter 'schemaId' is set
|
|
4203
4251
|
if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the required parameter "schemaId" when calling deleteBusinessrulesSchema';}return this.apiClient.callApi('/api/v2/businessrules/schemas/{schemaId}','DELETE',{'schemaId':schemaId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4204
4252
|
* Get a decision table
|
|
4205
4253
|
*
|
|
4206
4254
|
* @param {String} tableId Table ID
|
|
4207
|
-
* getBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4208
4255
|
*/},{key:"getBusinessrulesDecisiontable",value:function getBusinessrulesDecisiontable(tableId){// verify the required parameter 'tableId' is set
|
|
4209
4256
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontable';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}','GET',{'tableId':tableId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4210
4257
|
* Get a decision table version
|
|
4211
4258
|
*
|
|
4212
4259
|
* @param {String} tableId Table ID
|
|
4213
4260
|
* @param {Number} tableVersion Table Version
|
|
4214
|
-
* getBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4215
4261
|
*/},{key:"getBusinessrulesDecisiontableVersion",value:function getBusinessrulesDecisiontableVersion(tableId,tableVersion){// verify the required parameter 'tableId' is set
|
|
4216
4262
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersion';}// verify the required parameter 'tableVersion' is set
|
|
4217
4263
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersion';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}','GET',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4220,7 +4266,6 @@ if(tableVersion===undefined||tableVersion===null){throw'Missing the required par
|
|
|
4220
4266
|
* @param {String} tableId Table ID
|
|
4221
4267
|
* @param {Number} tableVersion Table Version
|
|
4222
4268
|
* @param {String} rowId Row ID
|
|
4223
|
-
* getBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4224
4269
|
*/},{key:"getBusinessrulesDecisiontableVersionRow",value:function getBusinessrulesDecisiontableVersionRow(tableId,tableVersion,rowId){// verify the required parameter 'tableId' is set
|
|
4225
4270
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRow';}// verify the required parameter 'tableVersion' is set
|
|
4226
4271
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRow';}// verify the required parameter 'rowId' is set
|
|
@@ -4232,7 +4277,6 @@ if(rowId===undefined||rowId===null||rowId===''){throw'Missing the required param
|
|
|
4232
4277
|
* @param {Object} opts Optional parameters
|
|
4233
4278
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
4234
4279
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
4235
|
-
* getBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4236
4280
|
*/},{key:"getBusinessrulesDecisiontableVersionRows",value:function getBusinessrulesDecisiontableVersionRows(tableId,tableVersion,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
4237
4281
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersionRows';}// verify the required parameter 'tableVersion' is set
|
|
4238
4282
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling getBusinessrulesDecisiontableVersionRows';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows','GET',{'tableId':tableId,'tableVersion':tableVersion},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4242,7 +4286,6 @@ if(tableVersion===undefined||tableVersion===null){throw'Missing the required par
|
|
|
4242
4286
|
* @param {Object} opts Optional parameters
|
|
4243
4287
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
4244
4288
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
4245
|
-
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4246
4289
|
*/},{key:"getBusinessrulesDecisiontableVersions",value:function getBusinessrulesDecisiontableVersions(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
4247
4290
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableVersions';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions','GET',{'tableId':tableId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4248
4291
|
* Get a list of decision tables.
|
|
@@ -4252,7 +4295,6 @@ if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required
|
|
|
4252
4295
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
4253
4296
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
4254
4297
|
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name.
|
|
4255
|
-
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4256
4298
|
*/},{key:"getBusinessrulesDecisiontables",value:function getBusinessrulesDecisiontables(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/businessrules/decisiontables','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'divisionIds':this.apiClient.buildCollectionParam(opts['divisionIds'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4257
4299
|
* Search for decision tables.
|
|
4258
4300
|
*
|
|
@@ -4264,33 +4306,27 @@ if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required
|
|
|
4264
4306
|
* @param {Boolean} opts.withPublishedVersion Filters results to only decision tables that have at least one version in Published status
|
|
4265
4307
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
4266
4308
|
* @param {Array.<String>} opts.ids Decision table IDs to search for
|
|
4267
|
-
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4268
4309
|
*/},{key:"getBusinessrulesDecisiontablesSearch",value:function getBusinessrulesDecisiontablesSearch(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/businessrules/decisiontables/search','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'schemaId':opts['schemaId'],'name':opts['name'],'withPublishedVersion':opts['withPublishedVersion'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4269
4310
|
* Get a schema
|
|
4270
4311
|
*
|
|
4271
4312
|
* @param {String} schemaId Schema ID
|
|
4272
|
-
* getBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4273
4313
|
*/},{key:"getBusinessrulesSchema",value:function getBusinessrulesSchema(schemaId){// verify the required parameter 'schemaId' is set
|
|
4274
4314
|
if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the required parameter "schemaId" when calling getBusinessrulesSchema';}return this.apiClient.callApi('/api/v2/businessrules/schemas/{schemaId}','GET',{'schemaId':schemaId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4275
4315
|
* Get a list of schemas.
|
|
4276
4316
|
*
|
|
4277
|
-
* getBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4278
4317
|
*/},{key:"getBusinessrulesSchemas",value:function getBusinessrulesSchemas(){return this.apiClient.callApi('/api/v2/businessrules/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4279
4318
|
* Get a specific named core type.
|
|
4280
4319
|
*
|
|
4281
4320
|
* @param {String} coreTypeName The core type's name
|
|
4282
|
-
* getBusinessrulesSchemasCoretype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4283
4321
|
*/},{key:"getBusinessrulesSchemasCoretype",value:function getBusinessrulesSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
4284
4322
|
if(coreTypeName===undefined||coreTypeName===null||coreTypeName===''){throw'Missing the required parameter "coreTypeName" when calling getBusinessrulesSchemasCoretype';}return this.apiClient.callApi('/api/v2/businessrules/schemas/coretypes/{coreTypeName}','GET',{'coreTypeName':coreTypeName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4285
4323
|
* Get the core types from which all schemas are built.
|
|
4286
4324
|
*
|
|
4287
|
-
* getBusinessrulesSchemasCoretypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4288
4325
|
*/},{key:"getBusinessrulesSchemasCoretypes",value:function getBusinessrulesSchemasCoretypes(){return this.apiClient.callApi('/api/v2/businessrules/schemas/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4289
4326
|
* Update a decision table
|
|
4290
4327
|
*
|
|
4291
4328
|
* @param {String} tableId Table ID
|
|
4292
4329
|
* @param {Object} body Decision Table
|
|
4293
|
-
* patchBusinessrulesDecisiontable is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4294
4330
|
*/},{key:"patchBusinessrulesDecisiontable",value:function patchBusinessrulesDecisiontable(tableId,body){// verify the required parameter 'tableId' is set
|
|
4295
4331
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontable';}// verify the required parameter 'body' is set
|
|
4296
4332
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchBusinessrulesDecisiontable';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}','PATCH',{'tableId':tableId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4299,7 +4335,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4299
4335
|
* @param {String} tableId Table ID
|
|
4300
4336
|
* @param {Number} tableVersion Table Version
|
|
4301
4337
|
* @param {Object} body Decision Table
|
|
4302
|
-
* patchBusinessrulesDecisiontableVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4303
4338
|
*/},{key:"patchBusinessrulesDecisiontableVersion",value:function patchBusinessrulesDecisiontableVersion(tableId,tableVersion,body){// verify the required parameter 'tableId' is set
|
|
4304
4339
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersion';}// verify the required parameter 'tableVersion' is set
|
|
4305
4340
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersion';}// verify the required parameter 'body' is set
|
|
@@ -4308,7 +4343,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4308
4343
|
*
|
|
4309
4344
|
* @param {String} tableId Table ID
|
|
4310
4345
|
* @param {Object} body Decision Table
|
|
4311
|
-
* postBusinessrulesDecisiontableExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4312
4346
|
*/},{key:"postBusinessrulesDecisiontableExecute",value:function postBusinessrulesDecisiontableExecute(tableId,body){// verify the required parameter 'tableId' is set
|
|
4313
4347
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExecute';}// verify the required parameter 'body' is set
|
|
4314
4348
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExecute';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/execute','POST',{'tableId':tableId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4317,7 +4351,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4317
4351
|
* @param {String} tableId Table ID
|
|
4318
4352
|
* @param {Number} tableVersion Table Version
|
|
4319
4353
|
* @param {Object} body Decision Table
|
|
4320
|
-
* postBusinessrulesDecisiontableVersionCopy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4321
4354
|
*/},{key:"postBusinessrulesDecisiontableVersionCopy",value:function postBusinessrulesDecisiontableVersionCopy(tableId,tableVersion,body){// verify the required parameter 'tableId' is set
|
|
4322
4355
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionCopy';}// verify the required parameter 'tableVersion' is set
|
|
4323
4356
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionCopy';}// verify the required parameter 'body' is set
|
|
@@ -4327,7 +4360,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4327
4360
|
* @param {String} tableId Table ID
|
|
4328
4361
|
* @param {Number} tableVersion Table Version
|
|
4329
4362
|
* @param {Object} body Decision Table
|
|
4330
|
-
* postBusinessrulesDecisiontableVersionExecute is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4331
4363
|
*/},{key:"postBusinessrulesDecisiontableVersionExecute",value:function postBusinessrulesDecisiontableVersionExecute(tableId,tableVersion,body){// verify the required parameter 'tableId' is set
|
|
4332
4364
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionExecute';}// verify the required parameter 'tableVersion' is set
|
|
4333
4365
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionExecute';}// verify the required parameter 'body' is set
|
|
@@ -4337,7 +4369,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4337
4369
|
* @param {String} tableId Table ID
|
|
4338
4370
|
* @param {Number} tableVersion Table Version
|
|
4339
4371
|
* @param {Object} body Create decision table row request
|
|
4340
|
-
* postBusinessrulesDecisiontableVersionRows is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4341
4372
|
*/},{key:"postBusinessrulesDecisiontableVersionRows",value:function postBusinessrulesDecisiontableVersionRows(tableId,tableVersion,body){// verify the required parameter 'tableId' is set
|
|
4342
4373
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRows';}// verify the required parameter 'tableVersion' is set
|
|
4343
4374
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRows';}// verify the required parameter 'body' is set
|
|
@@ -4350,7 +4381,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4350
4381
|
* @param {Object} opts Optional parameters
|
|
4351
4382
|
* @param {String} opts.pageNumber Page number of the entities to return. Defaults to 1.
|
|
4352
4383
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. Defaults to 25.
|
|
4353
|
-
* postBusinessrulesDecisiontableVersionRowsSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4354
4384
|
*/},{key:"postBusinessrulesDecisiontableVersionRowsSearch",value:function postBusinessrulesDecisiontableVersionRowsSearch(tableId,tableVersion,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
4355
4385
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsSearch';}// verify the required parameter 'tableVersion' is set
|
|
4356
4386
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsSearch';}// verify the required parameter 'body' is set
|
|
@@ -4359,33 +4389,28 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4359
4389
|
*
|
|
4360
4390
|
* @param {String} tableId Table ID
|
|
4361
4391
|
* @param {Number} tableVersion Table Version
|
|
4362
|
-
* postBusinessrulesDecisiontableVersionSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4363
4392
|
*/},{key:"postBusinessrulesDecisiontableVersionSync",value:function postBusinessrulesDecisiontableVersionSync(tableId,tableVersion){// verify the required parameter 'tableId' is set
|
|
4364
4393
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionSync';}// verify the required parameter 'tableVersion' is set
|
|
4365
4394
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionSync';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/sync','POST',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4366
4395
|
* Create a new decision table version
|
|
4367
4396
|
*
|
|
4368
4397
|
* @param {String} tableId Table ID
|
|
4369
|
-
* postBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4370
4398
|
*/},{key:"postBusinessrulesDecisiontableVersions",value:function postBusinessrulesDecisiontableVersions(tableId){// verify the required parameter 'tableId' is set
|
|
4371
4399
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersions';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions','POST',{'tableId':tableId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4372
4400
|
* Create a decision table
|
|
4373
4401
|
*
|
|
4374
4402
|
* @param {Object} body Decision Table
|
|
4375
|
-
* postBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4376
4403
|
*/},{key:"postBusinessrulesDecisiontables",value:function postBusinessrulesDecisiontables(body){// verify the required parameter 'body' is set
|
|
4377
4404
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontables';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4378
4405
|
* Create a schema
|
|
4379
4406
|
*
|
|
4380
4407
|
* @param {Object} body Business Rules Schema Create Request
|
|
4381
|
-
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4382
4408
|
*/},{key:"postBusinessrulesSchemas",value:function postBusinessrulesSchemas(body){// verify the required parameter 'body' is set
|
|
4383
4409
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesSchemas';}return this.apiClient.callApi('/api/v2/businessrules/schemas','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4384
4410
|
* Publish a decision table version
|
|
4385
4411
|
*
|
|
4386
4412
|
* @param {String} tableId Table ID
|
|
4387
4413
|
* @param {Number} tableVersion Table Version
|
|
4388
|
-
* putBusinessrulesDecisiontableVersionPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4389
4414
|
*/},{key:"putBusinessrulesDecisiontableVersionPublish",value:function putBusinessrulesDecisiontableVersionPublish(tableId,tableVersion){// verify the required parameter 'tableId' is set
|
|
4390
4415
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionPublish';}// verify the required parameter 'tableVersion' is set
|
|
4391
4416
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionPublish';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/publish','PUT',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4395,7 +4420,6 @@ if(tableVersion===undefined||tableVersion===null){throw'Missing the required par
|
|
|
4395
4420
|
* @param {Number} tableVersion Table Version
|
|
4396
4421
|
* @param {String} rowId Row ID
|
|
4397
4422
|
* @param {Object} body Full update decision table row request
|
|
4398
|
-
* putBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4399
4423
|
*/},{key:"putBusinessrulesDecisiontableVersionRow",value:function putBusinessrulesDecisiontableVersionRow(tableId,tableVersion,rowId,body){// verify the required parameter 'tableId' is set
|
|
4400
4424
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling putBusinessrulesDecisiontableVersionRow';}// verify the required parameter 'tableVersion' is set
|
|
4401
4425
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling putBusinessrulesDecisiontableVersionRow';}// verify the required parameter 'rowId' is set
|
|
@@ -4405,13 +4429,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4405
4429
|
*
|
|
4406
4430
|
* @param {String} schemaId Schema ID
|
|
4407
4431
|
* @param {Object} body Business Rules Schema Update Request
|
|
4408
|
-
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4409
4432
|
*/},{key:"putBusinessrulesSchema",value:function putBusinessrulesSchema(schemaId,body){// verify the required parameter 'schemaId' is set
|
|
4410
4433
|
if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the required parameter "schemaId" when calling putBusinessrulesSchema';}// verify the required parameter 'body' is set
|
|
4411
4434
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putBusinessrulesSchema';}return this.apiClient.callApi('/api/v2/businessrules/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
4412
4435
|
* CarrierServices service.
|
|
4413
4436
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
4414
|
-
* @version
|
|
4437
|
+
* @version 235.0.0
|
|
4415
4438
|
*//**
|
|
4416
4439
|
* Constructs a new CarrierServicesApi.
|
|
4417
4440
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -4431,7 +4454,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
4431
4454
|
*/},{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(){/**
|
|
4432
4455
|
* Chat service.
|
|
4433
4456
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
4434
|
-
* @version
|
|
4457
|
+
* @version 235.0.0
|
|
4435
4458
|
*//**
|
|
4436
4459
|
* Constructs a new ChatApi.
|
|
4437
4460
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -4662,7 +4685,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4662
4685
|
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(){/**
|
|
4663
4686
|
* Coaching service.
|
|
4664
4687
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4665
|
-
* @version
|
|
4688
|
+
* @version 235.0.0
|
|
4666
4689
|
*//**
|
|
4667
4690
|
* Constructs a new CoachingApi.
|
|
4668
4691
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4754,6 +4777,11 @@ if(notificationId===undefined||notificationId===null||notificationId===''){throw
|
|
|
4754
4777
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
4755
4778
|
* @param {Array.<String>} opts.expand Indicates a field in the response which should be expanded.
|
|
4756
4779
|
*/},{key:"getCoachingNotifications",value:function getCoachingNotifications(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/coaching/notifications','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4780
|
+
* Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
|
|
4781
|
+
*
|
|
4782
|
+
* @param {String} jobId The ID of job
|
|
4783
|
+
*/},{key:"getCoachingScheduleslotsJob",value:function getCoachingScheduleslotsJob(jobId){// verify the required parameter 'jobId' is set
|
|
4784
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getCoachingScheduleslotsJob';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4757
4785
|
* Update an existing appointment
|
|
4758
4786
|
* Permission not required if you are the creator or facilitator of the appointment
|
|
4759
4787
|
* @param {String} appointmentId The ID of the coaching appointment.
|
|
@@ -4808,6 +4836,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4808
4836
|
* @param {Object} body Aggregate Request
|
|
4809
4837
|
*/},{key:"postCoachingAppointmentsAggregatesQuery",value:function postCoachingAppointmentsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
4810
4838
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingAppointmentsAggregatesQuery';}return this.apiClient.callApi('/api/v2/coaching/appointments/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4839
|
+
* Start job to retrieve the slots where a coaching appointment can be scheduled.
|
|
4840
|
+
*
|
|
4841
|
+
* @param {Object} body The slots search request
|
|
4842
|
+
*/},{key:"postCoachingScheduleslotsJobs",value:function postCoachingScheduleslotsJobs(body){// verify the required parameter 'body' is set
|
|
4843
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsJobs';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4811
4844
|
* Get list of possible slots where a coaching appointment can be scheduled.
|
|
4812
4845
|
*
|
|
4813
4846
|
* @param {Object} body The slot search request
|
|
@@ -4815,7 +4848,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4815
4848
|
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(){/**
|
|
4816
4849
|
* ContentManagement service.
|
|
4817
4850
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4818
|
-
* @version
|
|
4851
|
+
* @version 235.0.0
|
|
4819
4852
|
*//**
|
|
4820
4853
|
* Constructs a new ContentManagementApi.
|
|
4821
4854
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -5097,7 +5130,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
5097
5130
|
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(){/**
|
|
5098
5131
|
* Conversations service.
|
|
5099
5132
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
5100
|
-
* @version
|
|
5133
|
+
* @version 235.0.0
|
|
5101
5134
|
*//**
|
|
5102
5135
|
* Constructs a new ConversationsApi.
|
|
5103
5136
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5249,7 +5282,6 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
5249
5282
|
* @param {String} conversationId conversationId
|
|
5250
5283
|
* @param {String} communicationId communicationId
|
|
5251
5284
|
* @param {String} messageId messageId
|
|
5252
|
-
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5253
5285
|
*/},{key:"getConversationCommunicationInternalmessage",value:function getConversationCommunicationInternalmessage(conversationId,communicationId,messageId){// verify the required parameter 'conversationId' is set
|
|
5254
5286
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessage';}// verify the required parameter 'communicationId' is set
|
|
5255
5287
|
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessage';}// verify the required parameter 'messageId' is set
|
|
@@ -5261,7 +5293,6 @@ if(messageId===undefined||messageId===null||messageId===''){throw'Missing the re
|
|
|
5261
5293
|
* @param {Object} opts Optional parameters
|
|
5262
5294
|
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (default to 25)
|
|
5263
5295
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5264
|
-
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5265
5296
|
*/},{key:"getConversationCommunicationInternalmessages",value:function getConversationCommunicationInternalmessages(conversationId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
5266
5297
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessages';}// verify the required parameter 'communicationId' is set
|
|
5267
5298
|
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessages';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages','GET',{'conversationId':conversationId,'communicationId':communicationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5568,12 +5599,10 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
5568
5599
|
* Get internal message conversation
|
|
5569
5600
|
*
|
|
5570
5601
|
* @param {String} conversationId conversationId
|
|
5571
|
-
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5572
5602
|
*/},{key:"getConversationsInternalmessage",value:function getConversationsInternalmessage(conversationId){// verify the required parameter 'conversationId' is set
|
|
5573
5603
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationsInternalmessage';}return this.apiClient.callApi('/api/v2/conversations/internalmessages/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5574
5604
|
* Get active internal message conversations for the logged in user
|
|
5575
5605
|
*
|
|
5576
|
-
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5577
5606
|
*/},{key:"getConversationsInternalmessages",value:function getConversationsInternalmessages(){return this.apiClient.callApi('/api/v2/conversations/internalmessages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5578
5607
|
* Get the encryption key configurations
|
|
5579
5608
|
*
|
|
@@ -6013,6 +6042,17 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6013
6042
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantConsult';}// verify the required parameter 'participantId' is set
|
|
6014
6043
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantConsult';}// verify the required parameter 'body' is set
|
|
6015
6044
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsCallParticipantConsult';}return this.apiClient.callApi('/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult','PATCH',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6045
|
+
* Update conversation participant on behalf of a user
|
|
6046
|
+
*
|
|
6047
|
+
* @param {String} conversationId conversationId
|
|
6048
|
+
* @param {String} participantId participantId
|
|
6049
|
+
* @param {String} userId userId
|
|
6050
|
+
* @param {Object} body Participant request
|
|
6051
|
+
*/},{key:"patchConversationsCallParticipantUserUserId",value:function patchConversationsCallParticipantUserUserId(conversationId,participantId,userId,body){// verify the required parameter 'conversationId' is set
|
|
6052
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantUserUserId';}// verify the required parameter 'participantId' is set
|
|
6053
|
+
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantUserUserId';}// verify the required parameter 'userId' is set
|
|
6054
|
+
if(userId===undefined||userId===null||userId===''){throw'Missing the required parameter "userId" when calling patchConversationsCallParticipantUserUserId';}// verify the required parameter 'body' is set
|
|
6055
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsCallParticipantUserUserId';}return this.apiClient.callApi('/api/v2/conversations/calls/{conversationId}/participants/{participantId}/user/{userId}','PATCH',{'conversationId':conversationId,'participantId':participantId,'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6016
6056
|
* Update a conversation by disconnecting all of the participants
|
|
6017
6057
|
*
|
|
6018
6058
|
* @param {String} conversationId conversationId
|
|
@@ -6350,7 +6390,6 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
6350
6390
|
* @param {String} conversationId conversationId
|
|
6351
6391
|
* @param {String} communicationId communicationId
|
|
6352
6392
|
* @param {Object} body Message
|
|
6353
|
-
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6354
6393
|
*/},{key:"postConversationCommunicationInternalmessages",value:function postConversationCommunicationInternalmessages(conversationId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
6355
6394
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationInternalmessages';}// verify the required parameter 'communicationId' is set
|
|
6356
6395
|
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationInternalmessages';}// verify the required parameter 'body' is set
|
|
@@ -6383,7 +6422,6 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
6383
6422
|
* @param {String} conversationId conversation ID
|
|
6384
6423
|
* @param {String} participantId participant ID
|
|
6385
6424
|
* @param {Object} body Confer request
|
|
6386
|
-
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6387
6425
|
*/},{key:"postConversationParticipantInternalmessagesUsersCommunications",value:function postConversationParticipantInternalmessagesUsersCommunications(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6388
6426
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'participantId' is set
|
|
6389
6427
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'body' is set
|
|
@@ -6862,7 +6900,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6862
6900
|
if(integrationId===undefined||integrationId===null||integrationId===''){throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenStructuredResponse';}// verify the required parameter 'body' is set
|
|
6863
6901
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenStructuredResponse';}return this.apiClient.callApi('/api/v2/conversations/messages/{integrationId}/inbound/open/structured/response','POST',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6864
6902
|
* Get messages in batch
|
|
6865
|
-
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
6903
|
+
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]. The max messages you can request in the body is 1,000. Best practice is to limit to only the messages you need in each request, rather than request large batches by default.
|
|
6866
6904
|
* @param {String} conversationId
|
|
6867
6905
|
* @param {Object} opts Optional parameters
|
|
6868
6906
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, media) (default to false)
|
|
@@ -7184,7 +7222,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
7184
7222
|
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(){/**
|
|
7185
7223
|
* DataExtensions service.
|
|
7186
7224
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
7187
|
-
* @version
|
|
7225
|
+
* @version 235.0.0
|
|
7188
7226
|
*//**
|
|
7189
7227
|
* Constructs a new DataExtensionsApi.
|
|
7190
7228
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -7205,7 +7243,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
7205
7243
|
*/},{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(){/**
|
|
7206
7244
|
* DataPrivacy service.
|
|
7207
7245
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
7208
|
-
* @version
|
|
7246
|
+
* @version 235.0.0
|
|
7209
7247
|
*//**
|
|
7210
7248
|
* Constructs a new DataPrivacyApi.
|
|
7211
7249
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -7245,7 +7283,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7245
7283
|
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(){/**
|
|
7246
7284
|
* Downloads service.
|
|
7247
7285
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
7248
|
-
* @version
|
|
7286
|
+
* @version 235.0.0
|
|
7249
7287
|
*//**
|
|
7250
7288
|
* Constructs a new DownloadsApi.
|
|
7251
7289
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -7264,7 +7302,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7264
7302
|
if(downloadId===undefined||downloadId===null||downloadId===''){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(){/**
|
|
7265
7303
|
* Emails service.
|
|
7266
7304
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
7267
|
-
* @version
|
|
7305
|
+
* @version 235.0.0
|
|
7268
7306
|
*//**
|
|
7269
7307
|
* Constructs a new EmailsApi.
|
|
7270
7308
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -7293,7 +7331,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
7293
7331
|
*/},{key:"patchEmailsSettingsThreading",value:function patchEmailsSettingsThreading(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings/threading','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
7294
7332
|
* EmployeeEngagement service.
|
|
7295
7333
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
7296
|
-
* @version
|
|
7334
|
+
* @version 235.0.0
|
|
7297
7335
|
*//**
|
|
7298
7336
|
* Constructs a new EmployeeEngagementApi.
|
|
7299
7337
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -7331,7 +7369,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7331
7369
|
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(){/**
|
|
7332
7370
|
* Events service.
|
|
7333
7371
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
7334
|
-
* @version
|
|
7372
|
+
* @version 235.0.0
|
|
7335
7373
|
*//**
|
|
7336
7374
|
* Constructs a new EventsApi.
|
|
7337
7375
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -7356,7 +7394,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7356
7394
|
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(){/**
|
|
7357
7395
|
* ExternalContacts service.
|
|
7358
7396
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
7359
|
-
* @version
|
|
7397
|
+
* @version 235.0.0
|
|
7360
7398
|
*//**
|
|
7361
7399
|
* Constructs a new ExternalContactsApi.
|
|
7362
7400
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -8106,7 +8144,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
8106
8144
|
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(){/**
|
|
8107
8145
|
* Fax service.
|
|
8108
8146
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
8109
|
-
* @version
|
|
8147
|
+
* @version 235.0.0
|
|
8110
8148
|
*//**
|
|
8111
8149
|
* Constructs a new FaxApi.
|
|
8112
8150
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -8155,7 +8193,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8155
8193
|
*/},{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(){/**
|
|
8156
8194
|
* Flows service.
|
|
8157
8195
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
8158
|
-
* @version
|
|
8196
|
+
* @version 235.0.0
|
|
8159
8197
|
*//**
|
|
8160
8198
|
* Constructs a new FlowsApi.
|
|
8161
8199
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -8209,7 +8247,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8209
8247
|
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(){/**
|
|
8210
8248
|
* Gamification service.
|
|
8211
8249
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8212
|
-
* @version
|
|
8250
|
+
* @version 235.0.0
|
|
8213
8251
|
*//**
|
|
8214
8252
|
* Constructs a new GamificationApi.
|
|
8215
8253
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -8371,6 +8409,20 @@ if(comparativePeriodStartWorkday===undefined||comparativePeriodStartWorkday===nu
|
|
|
8371
8409
|
if(comparativePeriodEndWorkday===undefined||comparativePeriodEndWorkday===null){throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';}// verify the required parameter 'primaryPeriodStartWorkday' is set
|
|
8372
8410
|
if(primaryPeriodStartWorkday===undefined||primaryPeriodStartWorkday===null){throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';}// verify the required parameter 'primaryPeriodEndWorkday' is set
|
|
8373
8411
|
if(primaryPeriodEndWorkday===undefined||primaryPeriodEndWorkday===null){throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';}return this.apiClient.callApi('/api/v2/gamification/insights/groups/trends/all','GET',{},{'filterType':filterType,'filterId':filterId,'granularity':granularity,'comparativePeriodStartWorkday':comparativePeriodStartWorkday,'comparativePeriodEndWorkday':comparativePeriodEndWorkday,'primaryPeriodStartWorkday':primaryPeriodStartWorkday,'primaryPeriodEndWorkday':primaryPeriodEndWorkday},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8412
|
+
* Query managers in a profile during a period of time
|
|
8413
|
+
*
|
|
8414
|
+
* @param {Object} filterType Filter type for the query request.
|
|
8415
|
+
* @param {String} filterId ID for the filter type.
|
|
8416
|
+
* @param {Object} granularity Granularity
|
|
8417
|
+
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
8418
|
+
* @param {Object} opts Optional parameters
|
|
8419
|
+
* @param {Number} opts.pageSize Page size (default to 100)
|
|
8420
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
8421
|
+
*/},{key:"getGamificationInsightsManagers",value:function getGamificationInsightsManagers(filterType,filterId,granularity,startWorkday,opts){opts=opts||{};// verify the required parameter 'filterType' is set
|
|
8422
|
+
if(filterType===undefined||filterType===null){throw'Missing the required parameter "filterType" when calling getGamificationInsightsManagers';}// verify the required parameter 'filterId' is set
|
|
8423
|
+
if(filterId===undefined||filterId===null){throw'Missing the required parameter "filterId" when calling getGamificationInsightsManagers';}// verify the required parameter 'granularity' is set
|
|
8424
|
+
if(granularity===undefined||granularity===null){throw'Missing the required parameter "granularity" when calling getGamificationInsightsManagers';}// verify the required parameter 'startWorkday' is set
|
|
8425
|
+
if(startWorkday===undefined||startWorkday===null){throw'Missing the required parameter "startWorkday" when calling getGamificationInsightsManagers';}return this.apiClient.callApi('/api/v2/gamification/insights/managers','GET',{},{'filterType':filterType,'filterId':filterId,'granularity':granularity,'startWorkday':startWorkday,'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8374
8426
|
* Query users in a profile during a period of time
|
|
8375
8427
|
*
|
|
8376
8428
|
* @param {Object} filterType Filter type for the query request.
|
|
@@ -8866,7 +8918,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8866
8918
|
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(){/**
|
|
8867
8919
|
* GeneralDataProtectionRegulation service.
|
|
8868
8920
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
8869
|
-
* @version
|
|
8921
|
+
* @version 235.0.0
|
|
8870
8922
|
*//**
|
|
8871
8923
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
8872
8924
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -8901,7 +8953,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
8901
8953
|
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(){/**
|
|
8902
8954
|
* Geolocation service.
|
|
8903
8955
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
8904
|
-
* @version
|
|
8956
|
+
* @version 235.0.0
|
|
8905
8957
|
*//**
|
|
8906
8958
|
* Constructs a new GeolocationApi.
|
|
8907
8959
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -8935,7 +8987,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
8935
8987
|
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(){/**
|
|
8936
8988
|
* Greetings service.
|
|
8937
8989
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
8938
|
-
* @version
|
|
8990
|
+
* @version 235.0.0
|
|
8939
8991
|
*//**
|
|
8940
8992
|
* Constructs a new GreetingsApi.
|
|
8941
8993
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -9063,7 +9115,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
9063
9115
|
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(){/**
|
|
9064
9116
|
* Groups service.
|
|
9065
9117
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
9066
|
-
* @version
|
|
9118
|
+
* @version 235.0.0
|
|
9067
9119
|
*//**
|
|
9068
9120
|
* Constructs a new GroupsApi.
|
|
9069
9121
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -9196,7 +9248,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
9196
9248
|
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(){/**
|
|
9197
9249
|
* IdentityProvider service.
|
|
9198
9250
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
9199
|
-
* @version
|
|
9251
|
+
* @version 235.0.0
|
|
9200
9252
|
*//**
|
|
9201
9253
|
* Constructs a new IdentityProviderApi.
|
|
9202
9254
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -9352,7 +9404,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9352
9404
|
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(){/**
|
|
9353
9405
|
* InfrastructureAsCode service.
|
|
9354
9406
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
9355
|
-
* @version
|
|
9407
|
+
* @version 235.0.0
|
|
9356
9408
|
*//**
|
|
9357
9409
|
* Constructs a new InfrastructureAsCodeApi.
|
|
9358
9410
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -9406,7 +9458,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
9406
9458
|
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(){/**
|
|
9407
9459
|
* Integrations service.
|
|
9408
9460
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
9409
|
-
* @version
|
|
9461
|
+
* @version 235.0.0
|
|
9410
9462
|
*//**
|
|
9411
9463
|
* Constructs a new IntegrationsApi.
|
|
9412
9464
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -10096,7 +10148,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
10096
10148
|
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(){/**
|
|
10097
10149
|
* Journey service.
|
|
10098
10150
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
10099
|
-
* @version
|
|
10151
|
+
* @version 235.0.0
|
|
10100
10152
|
*//**
|
|
10101
10153
|
* Constructs a new JourneyApi.
|
|
10102
10154
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -10605,7 +10657,7 @@ if(versionId===undefined||versionId===null||versionId===''){throw'Missing the re
|
|
|
10605
10657
|
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(){/**
|
|
10606
10658
|
* Knowledge service.
|
|
10607
10659
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
10608
|
-
* @version
|
|
10660
|
+
* @version 235.0.0
|
|
10609
10661
|
*//**
|
|
10610
10662
|
* Constructs a new KnowledgeApi.
|
|
10611
10663
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -10662,36 +10714,6 @@ if(importJobId===undefined||importJobId===null||importJobId===''){throw'Missing
|
|
|
10662
10714
|
*/},{key:"deleteKnowledgeKnowledgebaseLabel",value:function deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId,labelId){// verify the required parameter 'knowledgeBaseId' is set
|
|
10663
10715
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';}// verify the required parameter 'labelId' is set
|
|
10664
10716
|
if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'labelId':labelId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10665
|
-
* Delete category
|
|
10666
|
-
*
|
|
10667
|
-
* @param {String} categoryId Category ID
|
|
10668
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10669
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10670
|
-
* @deprecated
|
|
10671
|
-
*/},{key:"deleteKnowledgeKnowledgebaseLanguageCategory",value:function deleteKnowledgeKnowledgebaseLanguageCategory(categoryId,knowledgeBaseId,languageCode){// verify the required parameter 'categoryId' is set
|
|
10672
|
-
if(categoryId===undefined||categoryId===null||categoryId===''){throw'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';}// verify the required parameter 'knowledgeBaseId' is set
|
|
10673
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';}// verify the required parameter 'languageCode' is set
|
|
10674
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageCategory';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}','DELETE',{'categoryId':categoryId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10675
|
-
* Delete document
|
|
10676
|
-
*
|
|
10677
|
-
* @param {String} documentId Document ID
|
|
10678
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10679
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10680
|
-
* @deprecated
|
|
10681
|
-
*/},{key:"deleteKnowledgeKnowledgebaseLanguageDocument",value:function deleteKnowledgeKnowledgebaseLanguageDocument(documentId,knowledgeBaseId,languageCode){// verify the required parameter 'documentId' is set
|
|
10682
|
-
if(documentId===undefined||documentId===null||documentId===''){throw'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';}// verify the required parameter 'knowledgeBaseId' is set
|
|
10683
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';}// verify the required parameter 'languageCode' is set
|
|
10684
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocument';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}','DELETE',{'documentId':documentId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10685
|
-
* Delete import operation
|
|
10686
|
-
*
|
|
10687
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10688
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10689
|
-
* @param {String} importId Import ID
|
|
10690
|
-
* @deprecated
|
|
10691
|
-
*/},{key:"deleteKnowledgeKnowledgebaseLanguageDocumentsImport",value:function deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId,languageCode,importId){// verify the required parameter 'knowledgeBaseId' is set
|
|
10692
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'languageCode' is set
|
|
10693
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'importId' is set
|
|
10694
|
-
if(importId===undefined||importId===null||importId===''){throw'Missing the required parameter "importId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode,'importId':importId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10695
10717
|
* Delete Salesforce Knowledge integration source
|
|
10696
10718
|
*
|
|
10697
10719
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -10938,104 +10960,6 @@ if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required
|
|
|
10938
10960
|
* @param {Boolean} opts.includeDocumentCount If specified, retrieves the number of documents related to label.
|
|
10939
10961
|
*/},{key:"getKnowledgeKnowledgebaseLabels",value:function getKnowledgeKnowledgebaseLabels(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
10940
10962
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'name':opts['name'],'includeDocumentCount':opts['includeDocumentCount']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10941
|
-
* Get categories
|
|
10942
|
-
*
|
|
10943
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10944
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10945
|
-
* @param {Object} opts Optional parameters
|
|
10946
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
10947
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10948
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
10949
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
10950
|
-
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
10951
|
-
* @deprecated
|
|
10952
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageCategories",value:function getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId,languageCode,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
10953
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategories';}// verify the required parameter 'languageCode' is set
|
|
10954
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategories';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories','GET',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{'before':opts['before'],'after':opts['after'],'limit':opts['limit'],'pageSize':opts['pageSize'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10955
|
-
* Get category
|
|
10956
|
-
*
|
|
10957
|
-
* @param {String} categoryId Category ID
|
|
10958
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10959
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10960
|
-
* @deprecated
|
|
10961
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageCategory",value:function getKnowledgeKnowledgebaseLanguageCategory(categoryId,knowledgeBaseId,languageCode){// verify the required parameter 'categoryId' is set
|
|
10962
|
-
if(categoryId===undefined||categoryId===null||categoryId===''){throw'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseLanguageCategory';}// verify the required parameter 'knowledgeBaseId' is set
|
|
10963
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategory';}// verify the required parameter 'languageCode' is set
|
|
10964
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategory';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}','GET',{'categoryId':categoryId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10965
|
-
* Get document
|
|
10966
|
-
*
|
|
10967
|
-
* @param {String} documentId Document ID
|
|
10968
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10969
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10970
|
-
* @deprecated
|
|
10971
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageDocument",value:function getKnowledgeKnowledgebaseLanguageDocument(documentId,knowledgeBaseId,languageCode){// verify the required parameter 'documentId' is set
|
|
10972
|
-
if(documentId===undefined||documentId===null||documentId===''){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocument';}// verify the required parameter 'knowledgeBaseId' is set
|
|
10973
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocument';}// verify the required parameter 'languageCode' is set
|
|
10974
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocument';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}','GET',{'documentId':documentId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10975
|
-
* Get document content upload status
|
|
10976
|
-
*
|
|
10977
|
-
* @param {String} documentId Document ID
|
|
10978
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10979
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10980
|
-
* @param {String} uploadId UploadId
|
|
10981
|
-
* @deprecated
|
|
10982
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageDocumentUpload",value:function getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId,knowledgeBaseId,languageCode,uploadId){// verify the required parameter 'documentId' is set
|
|
10983
|
-
if(documentId===undefined||documentId===null||documentId===''){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'knowledgeBaseId' is set
|
|
10984
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'languageCode' is set
|
|
10985
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'uploadId' is set
|
|
10986
|
-
if(uploadId===undefined||uploadId===null||uploadId===''){throw'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}','GET',{'documentId':documentId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode,'uploadId':uploadId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10987
|
-
* Get documents
|
|
10988
|
-
*
|
|
10989
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10990
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10991
|
-
* @param {Object} opts Optional parameters
|
|
10992
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
10993
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
10994
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
10995
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
10996
|
-
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
10997
|
-
* @param {String} opts.title Filter by document title.
|
|
10998
|
-
* @param {Object} opts.sortBy Sort by.
|
|
10999
|
-
* @param {Object} opts.sortOrder Sort Order.
|
|
11000
|
-
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
11001
|
-
* @deprecated
|
|
11002
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageDocuments",value:function getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId,languageCode,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
11003
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocuments';}// verify the required parameter 'languageCode' is set
|
|
11004
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocuments';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents','GET',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{'before':opts['before'],'after':opts['after'],'limit':opts['limit'],'pageSize':opts['pageSize'],'categories':opts['categories'],'title':opts['title'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'documentIds':this.apiClient.buildCollectionParam(opts['documentIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11005
|
-
* Get import operation report
|
|
11006
|
-
*
|
|
11007
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11008
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11009
|
-
* @param {String} importId Import ID
|
|
11010
|
-
* @deprecated
|
|
11011
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageDocumentsImport",value:function getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId,languageCode,importId){// verify the required parameter 'knowledgeBaseId' is set
|
|
11012
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'languageCode' is set
|
|
11013
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'importId' is set
|
|
11014
|
-
if(importId===undefined||importId===null||importId===''){throw'Missing the required parameter "importId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}','GET',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode,'importId':importId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11015
|
-
* Get training detail
|
|
11016
|
-
*
|
|
11017
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11018
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11019
|
-
* @param {String} trainingId Training ID
|
|
11020
|
-
* @deprecated
|
|
11021
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageTraining",value:function getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId,languageCode,trainingId){// verify the required parameter 'knowledgeBaseId' is set
|
|
11022
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTraining';}// verify the required parameter 'languageCode' is set
|
|
11023
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTraining';}// verify the required parameter 'trainingId' is set
|
|
11024
|
-
if(trainingId===undefined||trainingId===null||trainingId===''){throw'Missing the required parameter "trainingId" when calling getKnowledgeKnowledgebaseLanguageTraining';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}','GET',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode,'trainingId':trainingId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11025
|
-
* Get all trainings information for a knowledgebase
|
|
11026
|
-
*
|
|
11027
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11028
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11029
|
-
* @param {Object} opts Optional parameters
|
|
11030
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11031
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11032
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
11033
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11034
|
-
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
11035
|
-
* @deprecated
|
|
11036
|
-
*/},{key:"getKnowledgeKnowledgebaseLanguageTrainings",value:function getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId,languageCode,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
11037
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTrainings';}// verify the required parameter 'languageCode' is set
|
|
11038
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTrainings';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings','GET',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{'before':opts['before'],'after':opts['after'],'limit':opts['limit'],'pageSize':opts['pageSize'],'knowledgeDocumentsState':opts['knowledgeDocumentsState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11039
10963
|
* Get operations
|
|
11040
10964
|
*
|
|
11041
10965
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -11234,52 +11158,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11234
11158
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';}// verify the required parameter 'labelId' is set
|
|
11235
11159
|
if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';}// verify the required parameter 'body' is set
|
|
11236
11160
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}','PATCH',{'knowledgeBaseId':knowledgeBaseId,'labelId':labelId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11237
|
-
* Update category
|
|
11238
|
-
*
|
|
11239
|
-
* @param {String} categoryId Category ID
|
|
11240
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11241
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11242
|
-
* @param {Object} body
|
|
11243
|
-
* @deprecated
|
|
11244
|
-
*/},{key:"patchKnowledgeKnowledgebaseLanguageCategory",value:function patchKnowledgeKnowledgebaseLanguageCategory(categoryId,knowledgeBaseId,languageCode,body){// verify the required parameter 'categoryId' is set
|
|
11245
|
-
if(categoryId===undefined||categoryId===null||categoryId===''){throw'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseLanguageCategory';}// verify the required parameter 'knowledgeBaseId' is set
|
|
11246
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageCategory';}// verify the required parameter 'languageCode' is set
|
|
11247
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageCategory';}// verify the required parameter 'body' is set
|
|
11248
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageCategory';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}','PATCH',{'categoryId':categoryId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11249
|
-
* Update document
|
|
11250
|
-
*
|
|
11251
|
-
* @param {String} documentId Document ID
|
|
11252
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11253
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11254
|
-
* @param {Object} body
|
|
11255
|
-
* @deprecated
|
|
11256
|
-
*/},{key:"patchKnowledgeKnowledgebaseLanguageDocument",value:function patchKnowledgeKnowledgebaseLanguageDocument(documentId,knowledgeBaseId,languageCode,body){// verify the required parameter 'documentId' is set
|
|
11257
|
-
if(documentId===undefined||documentId===null||documentId===''){throw'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseLanguageDocument';}// verify the required parameter 'knowledgeBaseId' is set
|
|
11258
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocument';}// verify the required parameter 'languageCode' is set
|
|
11259
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocument';}// verify the required parameter 'body' is set
|
|
11260
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocument';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}','PATCH',{'documentId':documentId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11261
|
-
* Update documents collection
|
|
11262
|
-
*
|
|
11263
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11264
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11265
|
-
* @param {Array.<Object>} body
|
|
11266
|
-
* @deprecated
|
|
11267
|
-
*/},{key:"patchKnowledgeKnowledgebaseLanguageDocuments",value:function patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId,languageCode,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
11268
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocuments';}// verify the required parameter 'languageCode' is set
|
|
11269
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocuments';}// verify the required parameter 'body' is set
|
|
11270
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocuments';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents','PATCH',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11271
|
-
* Start import operation
|
|
11272
|
-
*
|
|
11273
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11274
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11275
|
-
* @param {String} importId Import ID
|
|
11276
|
-
* @param {Object} body
|
|
11277
|
-
* @deprecated
|
|
11278
|
-
*/},{key:"patchKnowledgeKnowledgebaseLanguageDocumentsImport",value:function patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId,languageCode,importId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
11279
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'languageCode' is set
|
|
11280
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'importId' is set
|
|
11281
|
-
if(importId===undefined||importId===null||importId===''){throw'Missing the required parameter "importId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'body' is set
|
|
11282
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}','PATCH',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode,'importId':importId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11283
11161
|
* Send update to the parse operation
|
|
11284
11162
|
*
|
|
11285
11163
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -11520,66 +11398,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11520
11398
|
*/},{key:"postKnowledgeKnowledgebaseLabels",value:function postKnowledgeKnowledgebaseLabels(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
11521
11399
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';}// verify the required parameter 'body' is set
|
|
11522
11400
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11523
|
-
* Create new category
|
|
11524
|
-
*
|
|
11525
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11526
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11527
|
-
* @param {Object} body
|
|
11528
|
-
* @deprecated
|
|
11529
|
-
*/},{key:"postKnowledgeKnowledgebaseLanguageCategories",value:function postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId,languageCode,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
11530
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageCategories';}// verify the required parameter 'languageCode' is set
|
|
11531
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageCategories';}// verify the required parameter 'body' is set
|
|
11532
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageCategories';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories','POST',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11533
|
-
* Upload Article Content
|
|
11534
|
-
*
|
|
11535
|
-
* @param {String} documentId Document ID
|
|
11536
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11537
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11538
|
-
* @param {Object} body
|
|
11539
|
-
* @deprecated
|
|
11540
|
-
*/},{key:"postKnowledgeKnowledgebaseLanguageDocumentUploads",value:function postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId,knowledgeBaseId,languageCode,body){// verify the required parameter 'documentId' is set
|
|
11541
|
-
if(documentId===undefined||documentId===null||documentId===''){throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'knowledgeBaseId' is set
|
|
11542
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'languageCode' is set
|
|
11543
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'body' is set
|
|
11544
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads','POST',{'documentId':documentId,'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11545
|
-
* Create document
|
|
11546
|
-
*
|
|
11547
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11548
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11549
|
-
* @param {Object} body
|
|
11550
|
-
* @deprecated
|
|
11551
|
-
*/},{key:"postKnowledgeKnowledgebaseLanguageDocuments",value:function postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId,languageCode,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
11552
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocuments';}// verify the required parameter 'languageCode' is set
|
|
11553
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocuments';}// verify the required parameter 'body' is set
|
|
11554
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocuments';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents','POST',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11555
|
-
* Create import operation
|
|
11556
|
-
*
|
|
11557
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11558
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11559
|
-
* @param {Object} body
|
|
11560
|
-
* @deprecated
|
|
11561
|
-
*/},{key:"postKnowledgeKnowledgebaseLanguageDocumentsImports",value:function postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId,languageCode,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
11562
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';}// verify the required parameter 'languageCode' is set
|
|
11563
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';}// verify the required parameter 'body' is set
|
|
11564
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports','POST',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11565
|
-
* Promote trained documents from draft state to active.
|
|
11566
|
-
*
|
|
11567
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11568
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11569
|
-
* @param {String} trainingId Training ID
|
|
11570
|
-
* @deprecated
|
|
11571
|
-
*/},{key:"postKnowledgeKnowledgebaseLanguageTrainingPromote",value:function postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId,languageCode,trainingId){// verify the required parameter 'knowledgeBaseId' is set
|
|
11572
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';}// verify the required parameter 'languageCode' is set
|
|
11573
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';}// verify the required parameter 'trainingId' is set
|
|
11574
|
-
if(trainingId===undefined||trainingId===null||trainingId===''){throw'Missing the required parameter "trainingId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote','POST',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode,'trainingId':trainingId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11575
|
-
* Trigger training
|
|
11576
|
-
*
|
|
11577
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11578
|
-
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
11579
|
-
* @deprecated
|
|
11580
|
-
*/},{key:"postKnowledgeKnowledgebaseLanguageTrainings",value:function postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId,languageCode){// verify the required parameter 'knowledgeBaseId' is set
|
|
11581
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainings';}// verify the required parameter 'languageCode' is set
|
|
11582
|
-
if(languageCode===undefined||languageCode===null||languageCode===''){throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainings';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings','POST',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11583
11401
|
* Import the parsed articles
|
|
11584
11402
|
*
|
|
11585
11403
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -11596,14 +11414,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11596
11414
|
*/},{key:"postKnowledgeKnowledgebaseParseJobs",value:function postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
11597
11415
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobs';}// verify the required parameter 'body' is set
|
|
11598
11416
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobs';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11599
|
-
* Search Documents
|
|
11600
|
-
*
|
|
11601
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
11602
|
-
* @param {Object} opts Optional parameters
|
|
11603
|
-
* @param {Object} opts.body
|
|
11604
|
-
* @deprecated
|
|
11605
|
-
*/},{key:"postKnowledgeKnowledgebaseSearch",value:function postKnowledgeKnowledgebaseSearch(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
11606
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11607
11417
|
* Create Salesforce Knowledge integration source
|
|
11608
11418
|
*
|
|
11609
11419
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -11675,7 +11485,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
11675
11485
|
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(){/**
|
|
11676
11486
|
* LanguageUnderstanding service.
|
|
11677
11487
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
11678
|
-
* @version
|
|
11488
|
+
* @version 235.0.0
|
|
11679
11489
|
*//**
|
|
11680
11490
|
* Constructs a new LanguageUnderstandingApi.
|
|
11681
11491
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -11984,7 +11794,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
11984
11794
|
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(){/**
|
|
11985
11795
|
* Languages service.
|
|
11986
11796
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
11987
|
-
* @version
|
|
11797
|
+
* @version 235.0.0
|
|
11988
11798
|
*//**
|
|
11989
11799
|
* Constructs a new LanguagesApi.
|
|
11990
11800
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -12039,7 +11849,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12039
11849
|
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(){/**
|
|
12040
11850
|
* Learning service.
|
|
12041
11851
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
12042
|
-
* @version
|
|
11852
|
+
* @version 235.0.0
|
|
12043
11853
|
*//**
|
|
12044
11854
|
* Constructs a new LearningApi.
|
|
12045
11855
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -12177,6 +11987,11 @@ if(userIds===undefined||userIds===null){throw'Missing the required parameter "us
|
|
|
12177
11987
|
* @param {String} coverArtId Key identifier for the cover art
|
|
12178
11988
|
*/},{key:"getLearningModulesCoverartCoverArtId",value:function getLearningModulesCoverartCoverArtId(coverArtId){// verify the required parameter 'coverArtId' is set
|
|
12179
11989
|
if(coverArtId===undefined||coverArtId===null||coverArtId===''){throw'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';}return this.apiClient.callApi('/api/v2/learning/modules/coverart/{coverArtId}','GET',{'coverArtId':coverArtId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11990
|
+
* Retrieve the status of the job for the slots where a learning activity can be scheduled.
|
|
11991
|
+
*
|
|
11992
|
+
* @param {String} jobId The ID of the job
|
|
11993
|
+
*/},{key:"getLearningScheduleslotsJob",value:function getLearningScheduleslotsJob(jobId){// verify the required parameter 'jobId' is set
|
|
11994
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getLearningScheduleslotsJob';}return this.apiClient.callApi('/api/v2/learning/scheduleslots/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12180
11995
|
* Get Learning SCORM Result
|
|
12181
11996
|
*
|
|
12182
11997
|
* @param {String} scormId The ID of the SCORM package
|
|
@@ -12277,6 +12092,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12277
12092
|
if(pageSize===undefined||pageSize===null){throw'Missing the required parameter "pageSize" when calling postLearningRulesQuery';}// verify the required parameter 'pageNumber' is set
|
|
12278
12093
|
if(pageNumber===undefined||pageNumber===null){throw'Missing the required parameter "pageNumber" when calling postLearningRulesQuery';}// verify the required parameter 'body' is set
|
|
12279
12094
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLearningRulesQuery';}return this.apiClient.callApi('/api/v2/learning/rules/query','POST',{},{'pageSize':pageSize,'pageNumber':pageNumber},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12095
|
+
* Start job to retrieve slots where a learning activity can be scheduled.
|
|
12096
|
+
*
|
|
12097
|
+
* @param {Object} body The slots search request
|
|
12098
|
+
*/},{key:"postLearningScheduleslotsJobs",value:function postLearningScheduleslotsJobs(body){// verify the required parameter 'body' is set
|
|
12099
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLearningScheduleslotsJobs';}return this.apiClient.callApi('/api/v2/learning/scheduleslots/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12280
12100
|
* Get list of possible slots where a learning activity can be scheduled.
|
|
12281
12101
|
*
|
|
12282
12102
|
* @param {Object} body The slot search request
|
|
@@ -12312,7 +12132,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
12312
12132
|
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},{'assign':opts['assign']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
12313
12133
|
* License service.
|
|
12314
12134
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
12315
|
-
* @version
|
|
12135
|
+
* @version 235.0.0
|
|
12316
12136
|
*//**
|
|
12317
12137
|
* Constructs a new LicenseApi.
|
|
12318
12138
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -12366,7 +12186,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
12366
12186
|
*/},{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(){/**
|
|
12367
12187
|
* Locations service.
|
|
12368
12188
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
12369
|
-
* @version
|
|
12189
|
+
* @version 235.0.0
|
|
12370
12190
|
*//**
|
|
12371
12191
|
* Constructs a new LocationsApi.
|
|
12372
12192
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -12425,7 +12245,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12425
12245
|
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(){/**
|
|
12426
12246
|
* LogCapture service.
|
|
12427
12247
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
12428
|
-
* @version
|
|
12248
|
+
* @version 235.0.0
|
|
12429
12249
|
*//**
|
|
12430
12250
|
* Constructs a new LogCaptureApi.
|
|
12431
12251
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -12474,7 +12294,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12474
12294
|
if(userId===undefined||userId===null||userId===''){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(){/**
|
|
12475
12295
|
* Messaging service.
|
|
12476
12296
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
12477
|
-
* @version
|
|
12297
|
+
* @version 235.0.0
|
|
12478
12298
|
*//**
|
|
12479
12299
|
* Constructs a new MessagingApi.
|
|
12480
12300
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -12564,7 +12384,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12564
12384
|
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(){/**
|
|
12565
12385
|
* MobileDevices service.
|
|
12566
12386
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
12567
|
-
* @version
|
|
12387
|
+
* @version 235.0.0
|
|
12568
12388
|
*//**
|
|
12569
12389
|
* Constructs a new MobileDevicesApi.
|
|
12570
12390
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -12603,7 +12423,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12603
12423
|
if(deviceId===undefined||deviceId===null||deviceId===''){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(){/**
|
|
12604
12424
|
* Notifications service.
|
|
12605
12425
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
12606
|
-
* @version
|
|
12426
|
+
* @version 235.0.0
|
|
12607
12427
|
*//**
|
|
12608
12428
|
* Constructs a new NotificationsApi.
|
|
12609
12429
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -12660,7 +12480,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
12660
12480
|
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(){/**
|
|
12661
12481
|
* OAuth service.
|
|
12662
12482
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
12663
|
-
* @version
|
|
12483
|
+
* @version 235.0.0
|
|
12664
12484
|
*//**
|
|
12665
12485
|
* Constructs a new OAuthApi.
|
|
12666
12486
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -12745,7 +12565,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
12745
12565
|
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(){/**
|
|
12746
12566
|
* Objects service.
|
|
12747
12567
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
12748
|
-
* @version
|
|
12568
|
+
* @version 235.0.0
|
|
12749
12569
|
*//**
|
|
12750
12570
|
* Constructs a new ObjectsApi.
|
|
12751
12571
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -12831,7 +12651,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
12831
12651
|
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(){/**
|
|
12832
12652
|
* OperationalEvents service.
|
|
12833
12653
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
12834
|
-
* @version
|
|
12654
|
+
* @version 235.0.0
|
|
12835
12655
|
*//**
|
|
12836
12656
|
* Constructs a new OperationalEventsApi.
|
|
12837
12657
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -12862,7 +12682,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
12862
12682
|
*/},{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(){/**
|
|
12863
12683
|
* Organization service.
|
|
12864
12684
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
12865
|
-
* @version
|
|
12685
|
+
* @version 235.0.0
|
|
12866
12686
|
*//**
|
|
12867
12687
|
* Constructs a new OrganizationApi.
|
|
12868
12688
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -12967,7 +12787,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12967
12787
|
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(){/**
|
|
12968
12788
|
* OrganizationAuthorization service.
|
|
12969
12789
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
12970
|
-
* @version
|
|
12790
|
+
* @version 235.0.0
|
|
12971
12791
|
*//**
|
|
12972
12792
|
* Constructs a new OrganizationAuthorizationApi.
|
|
12973
12793
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -13301,7 +13121,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
13301
13121
|
if(trusteeUserId===undefined||trusteeUserId===null||trusteeUserId===''){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(){/**
|
|
13302
13122
|
* Outbound service.
|
|
13303
13123
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
13304
|
-
* @version
|
|
13124
|
+
* @version 235.0.0
|
|
13305
13125
|
*//**
|
|
13306
13126
|
* Constructs a new OutboundApi.
|
|
13307
13127
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -14113,6 +13933,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14113
13933
|
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
14114
13934
|
*/},{key:"postOutboundCampaigns",value:function postOutboundCampaigns(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
14115
13935
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundCampaigns';}return this.apiClient.callApi('/api/v2/outbound/campaigns','POST',{},{'useMaxCallsPerAgentDecimal':opts['useMaxCallsPerAgentDecimal']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13936
|
+
* Get performance data for a list of campaigns
|
|
13937
|
+
*
|
|
13938
|
+
* @param {Array.<String>} body Campaign IDs. Maximum of 50 IDs allowed.
|
|
13939
|
+
*/},{key:"postOutboundCampaignsPerformanceQuery",value:function postOutboundCampaignsPerformanceQuery(body){// verify the required parameter 'body' is set
|
|
13940
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundCampaignsPerformanceQuery';}return this.apiClient.callApi('/api/v2/outbound/campaigns/performance/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14116
13941
|
* Get progress for a list of campaigns
|
|
14117
13942
|
*
|
|
14118
13943
|
* @param {Array.<String>} body Campaign IDs
|
|
@@ -14452,7 +14277,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14452
14277
|
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(){/**
|
|
14453
14278
|
* Presence service.
|
|
14454
14279
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
14455
|
-
* @version
|
|
14280
|
+
* @version 235.0.0
|
|
14456
14281
|
*//**
|
|
14457
14282
|
* Constructs a new PresenceApi.
|
|
14458
14283
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -14625,7 +14450,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14625
14450
|
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(){/**
|
|
14626
14451
|
* ProcessAutomation service.
|
|
14627
14452
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
14628
|
-
* @version
|
|
14453
|
+
* @version 235.0.0
|
|
14629
14454
|
*//**
|
|
14630
14455
|
* Constructs a new ProcessAutomationApi.
|
|
14631
14456
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -14688,7 +14513,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
14688
14513
|
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(){/**
|
|
14689
14514
|
* Quality service.
|
|
14690
14515
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
14691
|
-
* @version
|
|
14516
|
+
* @version 235.0.0
|
|
14692
14517
|
*//**
|
|
14693
14518
|
* Constructs a new QualityApi.
|
|
14694
14519
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -15002,20 +14827,6 @@ if(formId===undefined||formId===null||formId===''){throw'Missing the required pa
|
|
|
15002
14827
|
* @param {String} opts.name Name
|
|
15003
14828
|
* @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
|
|
15004
14829
|
*/},{key:"getQualityPublishedformsEvaluations",value:function getQualityPublishedformsEvaluations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/publishedforms/evaluations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'onlyLatestPerContext':opts['onlyLatestPerContext']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15005
|
-
* Get the most recent published version of an evaluation form across any division.
|
|
15006
|
-
*
|
|
15007
|
-
* @param {String} evaluationFormId Evaluation Form ID
|
|
15008
|
-
* getQualityPublishedformsEvaluationsDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15009
|
-
*/},{key:"getQualityPublishedformsEvaluationsDivisionview",value:function getQualityPublishedformsEvaluationsDivisionview(evaluationFormId){// verify the required parameter 'evaluationFormId' is set
|
|
15010
|
-
if(evaluationFormId===undefined||evaluationFormId===null||evaluationFormId===''){throw'Missing the required parameter "evaluationFormId" when calling getQualityPublishedformsEvaluationsDivisionview';}return this.apiClient.callApi('/api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}','GET',{'evaluationFormId':evaluationFormId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15011
|
-
* Get the published evaluation forms across any division.
|
|
15012
|
-
*
|
|
15013
|
-
* @param {Object} opts Optional parameters
|
|
15014
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15015
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15016
|
-
* @param {String} opts.name Name
|
|
15017
|
-
* getQualityPublishedformsEvaluationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15018
|
-
*/},{key:"getQualityPublishedformsEvaluationsDivisionviews",value:function getQualityPublishedformsEvaluationsDivisionviews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/publishedforms/evaluations/divisionviews','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15019
14830
|
* Get the most recent published version of a survey form.
|
|
15020
14831
|
*
|
|
15021
14832
|
* @param {String} formId Form ID
|
|
@@ -15029,20 +14840,6 @@ if(formId===undefined||formId===null||formId===''){throw'Missing the required pa
|
|
|
15029
14840
|
* @param {String} opts.name Name
|
|
15030
14841
|
* @param {Boolean} opts.onlyLatestEnabledPerContext onlyLatestEnabledPerContext (default to false)
|
|
15031
14842
|
*/},{key:"getQualityPublishedformsSurveys",value:function getQualityPublishedformsSurveys(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/publishedforms/surveys','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'onlyLatestEnabledPerContext':opts['onlyLatestEnabledPerContext']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15032
|
-
* Get the most recent published version of an enabled survey form across any division.
|
|
15033
|
-
*
|
|
15034
|
-
* @param {String} surveyFormId Survey Form ID
|
|
15035
|
-
* getQualityPublishedformsSurveysDivisionview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15036
|
-
*/},{key:"getQualityPublishedformsSurveysDivisionview",value:function getQualityPublishedformsSurveysDivisionview(surveyFormId){// verify the required parameter 'surveyFormId' is set
|
|
15037
|
-
if(surveyFormId===undefined||surveyFormId===null||surveyFormId===''){throw'Missing the required parameter "surveyFormId" when calling getQualityPublishedformsSurveysDivisionview';}return this.apiClient.callApi('/api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}','GET',{'surveyFormId':surveyFormId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15038
|
-
* Get the published and enabled survey forms across any division.
|
|
15039
|
-
*
|
|
15040
|
-
* @param {Object} opts Optional parameters
|
|
15041
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15042
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15043
|
-
* @param {String} opts.name Name
|
|
15044
|
-
* getQualityPublishedformsSurveysDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15045
|
-
*/},{key:"getQualityPublishedformsSurveysDivisionviews",value:function getQualityPublishedformsSurveysDivisionviews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/publishedforms/surveys/divisionviews','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15046
14843
|
* Get a survey for a conversation
|
|
15047
14844
|
*
|
|
15048
14845
|
* @param {String} surveyId surveyId
|
|
@@ -15206,7 +15003,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
15206
15003
|
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(){/**
|
|
15207
15004
|
* Recording service.
|
|
15208
15005
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
15209
|
-
* @version
|
|
15006
|
+
* @version 235.0.0
|
|
15210
15007
|
*//**
|
|
15211
15008
|
* Constructs a new RecordingApi.
|
|
15212
15009
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -15605,7 +15402,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15605
15402
|
*/},{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(){/**
|
|
15606
15403
|
* ResponseManagement service.
|
|
15607
15404
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
15608
|
-
* @version
|
|
15405
|
+
* @version 235.0.0
|
|
15609
15406
|
*//**
|
|
15610
15407
|
* Constructs a new ResponseManagementApi.
|
|
15611
15408
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -15726,7 +15523,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
15726
15523
|
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(){/**
|
|
15727
15524
|
* Routing service.
|
|
15728
15525
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
15729
|
-
* @version
|
|
15526
|
+
* @version 235.0.0
|
|
15730
15527
|
*//**
|
|
15731
15528
|
* Constructs a new RoutingApi.
|
|
15732
15529
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -15905,6 +15702,16 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
15905
15702
|
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
15906
15703
|
*/},{key:"getRoutingEmailDomain",value:function getRoutingEmailDomain(domainId,opts){opts=opts||{};// verify the required parameter 'domainId' is set
|
|
15907
15704
|
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling getRoutingEmailDomain';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}','GET',{'domainId':domainId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15705
|
+
* Get domain dkim settings
|
|
15706
|
+
*
|
|
15707
|
+
* @param {String} domainId domain ID
|
|
15708
|
+
*/},{key:"getRoutingEmailDomainDkim",value:function getRoutingEmailDomainDkim(domainId){// verify the required parameter 'domainId' is set
|
|
15709
|
+
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling getRoutingEmailDomainDkim';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}/dkim','GET',{'domainId':domainId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15710
|
+
* Get domain mail from settings
|
|
15711
|
+
*
|
|
15712
|
+
* @param {String} domainId domain ID
|
|
15713
|
+
*/},{key:"getRoutingEmailDomainMailfrom",value:function getRoutingEmailDomainMailfrom(domainId){// verify the required parameter 'domainId' is set
|
|
15714
|
+
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling getRoutingEmailDomainMailfrom';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}/mailfrom','GET',{'domainId':domainId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15908
15715
|
* Get a route
|
|
15909
15716
|
*
|
|
15910
15717
|
* @param {String} domainName email domain
|
|
@@ -15931,6 +15738,11 @@ if(routeId===undefined||routeId===null||routeId===''){throw'Missing the required
|
|
|
15931
15738
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
15932
15739
|
*/},{key:"getRoutingEmailDomainRoutes",value:function getRoutingEmailDomainRoutes(domainName,opts){opts=opts||{};// verify the required parameter 'domainName' is set
|
|
15933
15740
|
if(domainName===undefined||domainName===null||domainName===''){throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoutes';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainName}/routes','GET',{'domainName':domainName},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'pattern':opts['pattern'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15741
|
+
* Get domain verification settings
|
|
15742
|
+
*
|
|
15743
|
+
* @param {String} domainId domain ID
|
|
15744
|
+
*/},{key:"getRoutingEmailDomainVerification",value:function getRoutingEmailDomainVerification(domainId){// verify the required parameter 'domainId' is set
|
|
15745
|
+
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling getRoutingEmailDomainVerification';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}/verification','GET',{'domainId':domainId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15934
15746
|
* Get domains
|
|
15935
15747
|
*
|
|
15936
15748
|
* @param {Object} opts Optional parameters
|
|
@@ -16530,6 +16342,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16530
16342
|
* @param {Object} opts Optional parameters
|
|
16531
16343
|
* @param {Object} opts.body
|
|
16532
16344
|
*/},{key:"postRoutingAssessmentsJobs",value:function postRoutingAssessmentsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/assessments/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16345
|
+
* Restart domain dkim
|
|
16346
|
+
*
|
|
16347
|
+
* @param {String} domainId domain ID
|
|
16348
|
+
*/},{key:"postRoutingEmailDomainDkim",value:function postRoutingEmailDomainDkim(domainId){// verify the required parameter 'domainId' is set
|
|
16349
|
+
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling postRoutingEmailDomainDkim';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}/dkim','POST',{'domainId':domainId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16350
|
+
* Set domain mail from settings
|
|
16351
|
+
*
|
|
16352
|
+
* @param {String} domainId domain ID
|
|
16353
|
+
* @param {Object} body Mail From Settings
|
|
16354
|
+
*/},{key:"postRoutingEmailDomainMailfrom",value:function postRoutingEmailDomainMailfrom(domainId,body){// verify the required parameter 'domainId' is set
|
|
16355
|
+
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling postRoutingEmailDomainMailfrom';}// verify the required parameter 'body' is set
|
|
16356
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingEmailDomainMailfrom';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}/mailfrom','POST',{'domainId':domainId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16533
16357
|
* Create a route
|
|
16534
16358
|
*
|
|
16535
16359
|
* @param {String} domainName email domain
|
|
@@ -16544,6 +16368,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16544
16368
|
* @param {Object} opts.body TestMessage
|
|
16545
16369
|
*/},{key:"postRoutingEmailDomainTestconnection",value:function postRoutingEmailDomainTestconnection(domainId,opts){opts=opts||{};// verify the required parameter 'domainId' is set
|
|
16546
16370
|
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling postRoutingEmailDomainTestconnection';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}/testconnection','POST',{'domainId':domainId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16371
|
+
* Restart domain verification
|
|
16372
|
+
*
|
|
16373
|
+
* @param {String} domainId domain ID
|
|
16374
|
+
*/},{key:"postRoutingEmailDomainVerification",value:function postRoutingEmailDomainVerification(domainId){// verify the required parameter 'domainId' is set
|
|
16375
|
+
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling postRoutingEmailDomainVerification';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainId}/verification','POST',{'domainId':domainId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16547
16376
|
* Create a domain
|
|
16548
16377
|
*
|
|
16549
16378
|
* @param {Object} body Domain
|
|
@@ -16785,7 +16614,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16785
16614
|
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(){/**
|
|
16786
16615
|
* SCIM service.
|
|
16787
16616
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
16788
|
-
* @version
|
|
16617
|
+
* @version 235.0.0
|
|
16789
16618
|
*//**
|
|
16790
16619
|
* Constructs a new SCIMApi.
|
|
16791
16620
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -17010,7 +16839,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
17010
16839
|
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(){/**
|
|
17011
16840
|
* ScreenRecording service.
|
|
17012
16841
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
17013
|
-
* @version
|
|
16842
|
+
* @version 235.0.0
|
|
17014
16843
|
*//**
|
|
17015
16844
|
* Constructs a new ScreenRecordingApi.
|
|
17016
16845
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -17025,7 +16854,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17025
16854
|
*/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(){/**
|
|
17026
16855
|
* Scripts service.
|
|
17027
16856
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
17028
|
-
* @version
|
|
16857
|
+
* @version 235.0.0
|
|
17029
16858
|
*//**
|
|
17030
16859
|
* Constructs a new ScriptsApi.
|
|
17031
16860
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -17171,7 +17000,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
17171
17000
|
*/},{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(){/**
|
|
17172
17001
|
* Search service.
|
|
17173
17002
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
17174
|
-
* @version
|
|
17003
|
+
* @version 235.0.0
|
|
17175
17004
|
*//**
|
|
17176
17005
|
* Constructs a new SearchApi.
|
|
17177
17006
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -17267,14 +17096,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17267
17096
|
* @param {Object} body Search request options
|
|
17268
17097
|
*/},{key:"postGroupsSearch",value:function postGroupsSearch(body){// verify the required parameter 'body' is set
|
|
17269
17098
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGroupsSearch';}return this.apiClient.callApi('/api/v2/groups/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17270
|
-
* Search Documents
|
|
17271
|
-
*
|
|
17272
|
-
* @param {String} knowledgeBaseId Knowledge base ID
|
|
17273
|
-
* @param {Object} opts Optional parameters
|
|
17274
|
-
* @param {Object} opts.body
|
|
17275
|
-
* @deprecated
|
|
17276
|
-
*/},{key:"postKnowledgeKnowledgebaseSearch",value:function postKnowledgeKnowledgebaseSearch(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
17277
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17278
17099
|
* Search locations
|
|
17279
17100
|
*
|
|
17280
17101
|
* @param {Object} body Search request options
|
|
@@ -17338,7 +17159,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17338
17159
|
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(){/**
|
|
17339
17160
|
* Settings service.
|
|
17340
17161
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
17341
|
-
* @version
|
|
17162
|
+
* @version 235.0.0
|
|
17342
17163
|
*//**
|
|
17343
17164
|
* Constructs a new SettingsApi.
|
|
17344
17165
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -17410,7 +17231,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
17410
17231
|
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(){/**
|
|
17411
17232
|
* SocialMedia service.
|
|
17412
17233
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
17413
|
-
* @version
|
|
17234
|
+
* @version 235.0.0
|
|
17414
17235
|
*//**
|
|
17415
17236
|
* Constructs a new SocialMediaApi.
|
|
17416
17237
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -17499,8 +17320,10 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
17499
17320
|
* Get a single escalation rule.
|
|
17500
17321
|
*
|
|
17501
17322
|
* @param {String} escalationRuleId escalationRuleId
|
|
17502
|
-
|
|
17503
|
-
|
|
17323
|
+
* @param {Object} opts Optional parameters
|
|
17324
|
+
* @param {Object} opts.expand which fields, if any, to expand
|
|
17325
|
+
*/},{key:"getSocialmediaEscalationrule",value:function getSocialmediaEscalationrule(escalationRuleId,opts){opts=opts||{};// verify the required parameter 'escalationRuleId' is set
|
|
17326
|
+
if(escalationRuleId===undefined||escalationRuleId===null||escalationRuleId===''){throw'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';}return this.apiClient.callApi('/api/v2/socialmedia/escalationrules/{escalationRuleId}','GET',{'escalationRuleId':escalationRuleId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17504
17327
|
* Retrieve all escalation rules for a division.
|
|
17505
17328
|
*
|
|
17506
17329
|
* @param {String} divisionId One division ID
|
|
@@ -17823,7 +17646,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
17823
17646
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null||twitterIngestionRuleId===''){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(){/**
|
|
17824
17647
|
* SpeechTextAnalytics service.
|
|
17825
17648
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
17826
|
-
* @version
|
|
17649
|
+
* @version 235.0.0
|
|
17827
17650
|
*//**
|
|
17828
17651
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
17829
17652
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -18193,7 +18016,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
18193
18016
|
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(){/**
|
|
18194
18017
|
* Stations service.
|
|
18195
18018
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
18196
|
-
* @version
|
|
18019
|
+
* @version 235.0.0
|
|
18197
18020
|
*//**
|
|
18198
18021
|
* Constructs a new StationsApi.
|
|
18199
18022
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -18225,7 +18048,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
18225
18048
|
*/},{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(){/**
|
|
18226
18049
|
* Suggest service.
|
|
18227
18050
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
18228
|
-
* @version
|
|
18051
|
+
* @version 235.0.0
|
|
18229
18052
|
*//**
|
|
18230
18053
|
* Constructs a new SuggestApi.
|
|
18231
18054
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -18265,7 +18088,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18265
18088
|
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(){/**
|
|
18266
18089
|
* TaskManagement service.
|
|
18267
18090
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
18268
|
-
* @version
|
|
18091
|
+
* @version 235.0.0
|
|
18269
18092
|
*//**
|
|
18270
18093
|
* Constructs a new TaskManagementApi.
|
|
18271
18094
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -18773,7 +18596,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
18773
18596
|
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(){/**
|
|
18774
18597
|
* Teams service.
|
|
18775
18598
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
18776
|
-
* @version
|
|
18599
|
+
* @version 235.0.0
|
|
18777
18600
|
*//**
|
|
18778
18601
|
* Constructs a new TeamsApi.
|
|
18779
18602
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -18853,7 +18676,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18853
18676
|
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(){/**
|
|
18854
18677
|
* Telephony service.
|
|
18855
18678
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
18856
|
-
* @version
|
|
18679
|
+
* @version 235.0.0
|
|
18857
18680
|
*//**
|
|
18858
18681
|
* Constructs a new TelephonyApi.
|
|
18859
18682
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -18924,7 +18747,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18924
18747
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyAgentsGreetingsMe';}return this.apiClient.callApi('/api/v2/telephony/agents/greetings/me','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
18925
18748
|
* TelephonyProvidersEdge service.
|
|
18926
18749
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
18927
|
-
* @version
|
|
18750
|
+
* @version 235.0.0
|
|
18928
18751
|
*//**
|
|
18929
18752
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
18930
18753
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -19772,7 +19595,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
19772
19595
|
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(){/**
|
|
19773
19596
|
* Textbots service.
|
|
19774
19597
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
19775
|
-
* @version
|
|
19598
|
+
* @version 235.0.0
|
|
19776
19599
|
*//**
|
|
19777
19600
|
* Constructs a new TextbotsApi.
|
|
19778
19601
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -19808,7 +19631,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
19808
19631
|
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(){/**
|
|
19809
19632
|
* Tokens service.
|
|
19810
19633
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
19811
|
-
* @version
|
|
19634
|
+
* @version 235.0.0
|
|
19812
19635
|
*//**
|
|
19813
19636
|
* Constructs a new TokensApi.
|
|
19814
19637
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -19842,7 +19665,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
19842
19665
|
*/},{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(){/**
|
|
19843
19666
|
* Uploads service.
|
|
19844
19667
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
19845
|
-
* @version
|
|
19668
|
+
* @version 235.0.0
|
|
19846
19669
|
*//**
|
|
19847
19670
|
* Constructs a new UploadsApi.
|
|
19848
19671
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -19910,7 +19733,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19910
19733
|
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(){/**
|
|
19911
19734
|
* Usage service.
|
|
19912
19735
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
19913
|
-
* @version
|
|
19736
|
+
* @version 235.0.0
|
|
19914
19737
|
*//**
|
|
19915
19738
|
* Constructs a new UsageApi.
|
|
19916
19739
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -19994,7 +19817,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19994
19817
|
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(){/**
|
|
19995
19818
|
* UserRecordings service.
|
|
19996
19819
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
19997
|
-
* @version
|
|
19820
|
+
* @version 235.0.0
|
|
19998
19821
|
*//**
|
|
19999
19822
|
* Constructs a new UserRecordingsApi.
|
|
20000
19823
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -20042,7 +19865,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
20042
19865
|
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(){/**
|
|
20043
19866
|
* Users service.
|
|
20044
19867
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
20045
|
-
* @version
|
|
19868
|
+
* @version 235.0.0
|
|
20046
19869
|
*//**
|
|
20047
19870
|
* Constructs a new UsersApi.
|
|
20048
19871
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -20786,7 +20609,7 @@ if(verifierId===undefined||verifierId===null||verifierId===''){throw'Missing the
|
|
|
20786
20609
|
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(){/**
|
|
20787
20610
|
* Utilities service.
|
|
20788
20611
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
20789
|
-
* @version
|
|
20612
|
+
* @version 235.0.0
|
|
20790
20613
|
*//**
|
|
20791
20614
|
* Constructs a new UtilitiesApi.
|
|
20792
20615
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -20813,7 +20636,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20813
20636
|
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(){/**
|
|
20814
20637
|
* Voicemail service.
|
|
20815
20638
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
20816
|
-
* @version
|
|
20639
|
+
* @version 235.0.0
|
|
20817
20640
|
*//**
|
|
20818
20641
|
* Constructs a new VoicemailApi.
|
|
20819
20642
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -20975,7 +20798,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
20975
20798
|
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(){/**
|
|
20976
20799
|
* WebChat service.
|
|
20977
20800
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
20978
|
-
* @version
|
|
20801
|
+
* @version 235.0.0
|
|
20979
20802
|
*//**
|
|
20980
20803
|
* Constructs a new WebChatApi.
|
|
20981
20804
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -21122,7 +20945,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21122
20945
|
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(){/**
|
|
21123
20946
|
* WebDeployments service.
|
|
21124
20947
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
21125
|
-
* @version
|
|
20948
|
+
* @version 235.0.0
|
|
21126
20949
|
*//**
|
|
21127
20950
|
* Constructs a new WebDeploymentsApi.
|
|
21128
20951
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -21222,7 +21045,7 @@ if(configurationVersion===undefined||configurationVersion===null){throw'Missing
|
|
|
21222
21045
|
* @param {Object} deployment
|
|
21223
21046
|
*/},{key:"postWebdeploymentsDeployments",value:function postWebdeploymentsDeployments(deployment){// verify the required parameter 'deployment' is set
|
|
21224
21047
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling postWebdeploymentsDeployments';}return this.apiClient.callApi('/api/v2/webdeployments/deployments','POST',{},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21225
|
-
* Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.
|
|
21048
|
+
* Exchange an oAuth code (obtained using the Authorization Code Flow or Implicit flow) for a JWT that can be used by webdeployments.
|
|
21226
21049
|
*
|
|
21227
21050
|
* @param {Object} body webDeploymentsOAuthExchangeRequest
|
|
21228
21051
|
*/},{key:"postWebdeploymentsTokenOauthcodegrantjwtexchange",value:function postWebdeploymentsTokenOauthcodegrantjwtexchange(body){// verify the required parameter 'body' is set
|
|
@@ -21255,7 +21078,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21255
21078
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}/identityresolution','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
21256
21079
|
* WebMessaging service.
|
|
21257
21080
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
21258
|
-
* @version
|
|
21081
|
+
* @version 235.0.0
|
|
21259
21082
|
*//**
|
|
21260
21083
|
* Constructs a new WebMessagingApi.
|
|
21261
21084
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -21296,7 +21119,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
21296
21119
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';}return this.apiClient.callApi('/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}','POST',{'deploymentId':deploymentId,'tokenId':tokenId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
21297
21120
|
* Widgets service.
|
|
21298
21121
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
21299
|
-
* @version
|
|
21122
|
+
* @version 235.0.0
|
|
21300
21123
|
*//**
|
|
21301
21124
|
* Constructs a new WidgetsApi.
|
|
21302
21125
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -21336,7 +21159,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21336
21159
|
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(){/**
|
|
21337
21160
|
* WorkforceManagement service.
|
|
21338
21161
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
21339
|
-
* @version
|
|
21162
|
+
* @version 235.0.0
|
|
21340
21163
|
*//**
|
|
21341
21164
|
* Constructs a new WorkforceManagementApi.
|
|
21342
21165
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -21919,10 +21742,11 @@ if(forecastId===undefined||forecastId===null||forecastId===''){throw'Missing the
|
|
|
21919
21742
|
* @param {String} forecastId The ID of the forecast
|
|
21920
21743
|
* @param {Object} opts Optional parameters
|
|
21921
21744
|
* @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
|
|
21745
|
+
* @param {Array.<String>} opts.expand Expand to include minimum staffing values in (staffing requirement response or applied to base staffing requirement values)
|
|
21922
21746
|
*/},{key:"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement",value:function getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId,weekDateId,forecastId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
21923
21747
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'weekDateId' is set
|
|
21924
21748
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'forecastId' is set
|
|
21925
|
-
if(forecastId===undefined||forecastId===null||forecastId===''){throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement','GET',{'businessUnitId':businessUnitId,'weekDateId':weekDateId,'forecastId':forecastId},{'weekNumbers':this.apiClient.buildCollectionParam(opts['weekNumbers'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21749
|
+
if(forecastId===undefined||forecastId===null||forecastId===''){throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement','GET',{'businessUnitId':businessUnitId,'weekDateId':weekDateId,'forecastId':forecastId},{'weekNumbers':this.apiClient.buildCollectionParam(opts['weekNumbers'],'multi'),'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21926
21750
|
* Get short term forecasts
|
|
21927
21751
|
* Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
21928
21752
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
@@ -23296,7 +23120,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23296
23120
|
* </pre>
|
|
23297
23121
|
* </p>
|
|
23298
23122
|
* @module purecloud-platform-client-v2/index
|
|
23299
|
-
* @version
|
|
23123
|
+
* @version 235.0.0
|
|
23300
23124
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23301
23125
|
* The ApiClient constructor.
|
|
23302
23126
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|