purecloud-platform-client-v2 216.0.0 → 218.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 +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.js +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +502 -282
- package/dist/web-cjs/purecloud-platform-client-v2.js +507 -285
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +951 -292
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -305
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +112 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -8
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +387 -2
- 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 +243 -4
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +13 -16
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -68
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +19 -7
- 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 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -29
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +182 -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 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +403 -20
- 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 +3 -2
- 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 -3
- 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 +19 -10
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +58 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -244,7 +244,7 @@ return function(thing){return TypedArray&&thing instanceof TypedArray;};}(typeof
|
|
|
244
244
|
* Makes all methods read-only
|
|
245
245
|
* @param {Object} obj
|
|
246
246
|
*/var freezeMethods=function freezeMethods(obj){reduceDescriptors(obj,function(descriptor,name){// skip restricted props in strict mode
|
|
247
|
-
if(isFunction(obj)&&['arguments','caller','callee'].indexOf(name)!==-1){return false;}var value=obj[name];if(!isFunction(value))return;descriptor.enumerable=false;if('writable'in descriptor){descriptor.writable=false;return;}if(!descriptor.set){descriptor.set=function(){throw Error('Can not rewrite read-only method \''+name+'\'');};}});};var toObjectSet=function toObjectSet(arrayOrString,delimiter){var obj={};var define=function define(arr){arr.forEach(function(value){obj[value]=true;});};isArray$1(arrayOrString)?define(arrayOrString):define(String(arrayOrString).split(delimiter));return obj;};var noop=function noop(){};var toFiniteNumber=function toFiniteNumber(value,defaultValue){return value!=null&&Number.isFinite(value=+value)?value:defaultValue;}
|
|
247
|
+
if(isFunction(obj)&&['arguments','caller','callee'].indexOf(name)!==-1){return false;}var value=obj[name];if(!isFunction(value))return;descriptor.enumerable=false;if('writable'in descriptor){descriptor.writable=false;return;}if(!descriptor.set){descriptor.set=function(){throw Error('Can not rewrite read-only method \''+name+'\'');};}});};var toObjectSet=function toObjectSet(arrayOrString,delimiter){var obj={};var define=function define(arr){arr.forEach(function(value){obj[value]=true;});};isArray$1(arrayOrString)?define(arrayOrString):define(String(arrayOrString).split(delimiter));return obj;};var noop=function noop(){};var toFiniteNumber=function toFiniteNumber(value,defaultValue){return value!=null&&Number.isFinite(value=+value)?value:defaultValue;};/**
|
|
248
248
|
* If the thing is a FormData object, return true, otherwise return false.
|
|
249
249
|
*
|
|
250
250
|
* @param {unknown} thing - The thing to check.
|
|
@@ -254,7 +254,7 @@ if(isFunction(obj)&&['arguments','caller','callee'].indexOf(name)!==-1){return f
|
|
|
254
254
|
// https://github.com/DigitalBrainJS/AxiosPromise/blob/16deab13710ec09779922131f3fa5954320f83ab/lib/utils.js#L11-L34
|
|
255
255
|
var _setImmediate=function(setImmediateSupported,postMessageSupported){if(setImmediateSupported){return setImmediate;}return postMessageSupported?function(token,callbacks){_global.addEventListener("message",function(_ref7){var source=_ref7.source,data=_ref7.data;if(source===_global&&data===token){callbacks.length&&callbacks.shift()();}},false);return function(cb){callbacks.push(cb);_global.postMessage(token,"*");};}("axios@".concat(Math.random()),[]):function(cb){return setTimeout(cb);};}(typeof setImmediate==='function',isFunction(_global.postMessage));var asap=typeof queueMicrotask!=='undefined'?queueMicrotask.bind(_global):typeof process!=='undefined'&&nextTick||_setImmediate;// *********************
|
|
256
256
|
var utils$1={isArray:isArray$1,isArrayBuffer:isArrayBuffer,isBuffer:isBuffer$1,isFormData:isFormData,isArrayBufferView:isArrayBufferView,isString:isString,isNumber:isNumber,isBoolean:isBoolean,isObject:isObject,isPlainObject:isPlainObject,isReadableStream:isReadableStream,isRequest:isRequest,isResponse:isResponse,isHeaders:isHeaders,isUndefined:isUndefined,isDate:isDate,isFile:isFile,isBlob:isBlob,isRegExp:isRegExp,isFunction:isFunction,isStream:isStream,isURLSearchParams:isURLSearchParams,isTypedArray:isTypedArray,isFileList:isFileList,forEach:forEach,merge:merge,extend:extend,trim:trim,stripBOM:stripBOM,inherits:inherits,toFlatObject:toFlatObject,kindOf:kindOf,kindOfTest:kindOfTest,endsWith:endsWith,toArray:toArray,forEachEntry:forEachEntry,matchAll:matchAll,isHTMLForm:isHTMLForm,hasOwnProperty:hasOwnProperty,hasOwnProp:hasOwnProperty,// an alias to avoid ESLint no-prototype-builtins detection
|
|
257
|
-
reduceDescriptors:reduceDescriptors,freezeMethods:freezeMethods,toObjectSet:toObjectSet,toCamelCase:toCamelCase,noop:noop,toFiniteNumber:toFiniteNumber,findKey:findKey,global:_global,isContextDefined:isContextDefined,
|
|
257
|
+
reduceDescriptors:reduceDescriptors,freezeMethods:freezeMethods,toObjectSet:toObjectSet,toCamelCase:toCamelCase,noop:noop,toFiniteNumber:toFiniteNumber,findKey:findKey,global:_global,isContextDefined:isContextDefined,isSpecCompliantForm:isSpecCompliantForm,toJSONObject:toJSONObject,isAsyncFn:isAsyncFn,isThenable:isThenable,setImmediate:_setImmediate,asap:asap};var lookup=[];var revLookup=[];var Arr=typeof Uint8Array!=='undefined'?Uint8Array:Array;var inited=false;function init(){inited=true;var code='ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';for(var i=0,len=code.length;i<len;++i){lookup[i]=code[i];revLookup[code.charCodeAt(i)]=i;}revLookup['-'.charCodeAt(0)]=62;revLookup['_'.charCodeAt(0)]=63;}function toByteArray(b64){if(!inited){init();}var i,j,l,tmp,placeHolders,arr;var len=b64.length;if(len%4>0){throw new Error('Invalid string. Length must be a multiple of 4');}// the number of equal signs (place holders)
|
|
258
258
|
// if there are two placeholders, than the two characters before it
|
|
259
259
|
// represent one byte
|
|
260
260
|
// if there is only one, then the three characters before it represent 2 bytes
|
|
@@ -681,7 +681,7 @@ return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);}/**
|
|
|
681
681
|
* @param {string} requestedURL Absolute or relative URL to combine
|
|
682
682
|
*
|
|
683
683
|
* @returns {string} The combined full path
|
|
684
|
-
*/function buildFullPath(baseURL,requestedURL){if(baseURL
|
|
684
|
+
*/function buildFullPath(baseURL,requestedURL,allowAbsoluteUrls){var isRelativeUrl=!isAbsoluteURL(requestedURL);if(baseURL&&(isRelativeUrl||allowAbsoluteUrls==false)){return combineURLs(baseURL,requestedURL);}return requestedURL;}var headersToObject=function headersToObject(thing){return thing instanceof AxiosHeaders$1?_objectSpread({},thing):thing;};/**
|
|
685
685
|
* Config-specific merge-function which creates a new config-object
|
|
686
686
|
* by merging two configuration objects together.
|
|
687
687
|
*
|
|
@@ -694,7 +694,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,prop,cas
|
|
|
694
694
|
function mergeDeepProperties(a,b,prop,caseless){if(!utils$1.isUndefined(b)){return getMergedValue(a,b,prop,caseless);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a,prop,caseless);}}// eslint-disable-next-line consistent-return
|
|
695
695
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
696
696
|
function defaultToConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a);}}// eslint-disable-next-line consistent-return
|
|
697
|
-
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b,prop){return mergeDeepProperties(headersToObject(a),headersToObject(b),prop,true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var resolveConfig=function resolveConfig(config){var newConfig=mergeConfig({},config);var data=newConfig.data,withXSRFToken=newConfig.withXSRFToken,xsrfHeaderName=newConfig.xsrfHeaderName,xsrfCookieName=newConfig.xsrfCookieName,headers=newConfig.headers,auth=newConfig.auth;newConfig.headers=headers=AxiosHeaders$1.from(headers);newConfig.url=buildURL(buildFullPath(newConfig.baseURL,newConfig.url),config.params,config.paramsSerializer);// HTTP basic authentication
|
|
697
|
+
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b,prop){return mergeDeepProperties(headersToObject(a),headersToObject(b),prop,true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var resolveConfig=function resolveConfig(config){var newConfig=mergeConfig({},config);var data=newConfig.data,withXSRFToken=newConfig.withXSRFToken,xsrfHeaderName=newConfig.xsrfHeaderName,xsrfCookieName=newConfig.xsrfCookieName,headers=newConfig.headers,auth=newConfig.auth;newConfig.headers=headers=AxiosHeaders$1.from(headers);newConfig.url=buildURL(buildFullPath(newConfig.baseURL,newConfig.url,newConfig.allowAbsoluteUrls),config.params,config.paramsSerializer);// HTTP basic authentication
|
|
698
698
|
if(auth){headers.set('Authorization','Basic '+btoa((auth.username||'')+':'+(auth.password?unescape(encodeURIComponent(auth.password)):'')));}var contentType;if(utils$1.isFormData(data)){if(platform.hasStandardBrowserEnv||platform.hasStandardBrowserWebWorkerEnv){headers.setContentType(undefined);// Let the browser set it
|
|
699
699
|
}else if((contentType=headers.getContentType())!==false){// fix semicolon duplication issue for ReactNative FormData implementation
|
|
700
700
|
var _ref11=contentType?contentType.split(';').map(function(token){return token.trim();}).filter(Boolean):[],_ref12=_toArray(_ref11),type=_ref12[0],tokens=_ref12.slice(1);headers.setContentType([type||'multipart/form-data'].concat(_toConsumableArray(tokens)).join('; '));}}// Add xsrf header
|
|
@@ -750,7 +750,7 @@ isCredentialsSupported="credentials"in Request.prototype;request=new Request(url
|
|
|
750
750
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
751
751
|
config.data=transformData.call(config,config.transformRequest);if(['post','put','patch'].indexOf(config.method)!==-1){config.headers.setContentType('application/x-www-form-urlencoded',false);}var adapter=adapters.getAdapter(config.adapter||defaults$1.adapter);return adapter(config).then(function onAdapterResolution(response){throwIfCancellationRequested(config);// Transform response data
|
|
752
752
|
response.data=transformData.call(config,config.transformResponse,response);response.headers=AxiosHeaders$1.from(response.headers);return response;},function onAdapterRejection(reason){if(!isCancel(reason)){throwIfCancellationRequested(config);// Transform response data
|
|
753
|
-
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var VERSION="1.
|
|
753
|
+
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var VERSION="1.8.4";var validators$1={};// eslint-disable-next-line func-names
|
|
754
754
|
['object','boolean','number','function','string','symbol'].forEach(function(type,i){validators$1[type]=function validator(thing){return _typeof(thing)===type||'a'+(i<1?'n ':' ')+type;};});var deprecatedWarnings={};/**
|
|
755
755
|
* Transitional option validator
|
|
756
756
|
*
|
|
@@ -787,10 +787,11 @@ console.warn("".concat(opt," is likely a misspelling of ").concat(correctSpellin
|
|
|
787
787
|
stack=dummy.stack?dummy.stack.replace(/^.+\n/,''):'';try{if(!_context9.t0.stack){_context9.t0.stack=stack;// match without the 2 top stack lines
|
|
788
788
|
}else if(stack&&!String(_context9.t0.stack).endsWith(stack.replace(/^.+\n.+\n/,''))){_context9.t0.stack+='\n'+stack;}}catch(e){// ignore the case where "stack" is an un-writable property
|
|
789
789
|
}}throw _context9.t0;case 10:case"end":return _context9.stop();}},_callee8,this,[[0,6]]);}));function request(_x9,_x10){return _request2.apply(this,arguments);}return request;}())},{key:"_request",value:function _request(configOrUrl,config){/*eslint no-param-reassign:0*/// Allow for axios('example/url'[, config]) a la fetch API
|
|
790
|
-
if(typeof configOrUrl==='string'){config=config||{};config.url=configOrUrl;}else{config=configOrUrl||{};}config=mergeConfig(this.defaults,config);var _config2=config,transitional=_config2.transitional,paramsSerializer=_config2.paramsSerializer,headers=_config2.headers;if(transitional!==undefined){validator.assertOptions(transitional,{silentJSONParsing:validators.transitional(validators["boolean"]),forcedJSONParsing:validators.transitional(validators["boolean"]),clarifyTimeoutError:validators.transitional(validators["boolean"])},false);}if(paramsSerializer!=null){if(utils$1.isFunction(paramsSerializer)){config.paramsSerializer={serialize:paramsSerializer};}else{validator.assertOptions(paramsSerializer,{encode:validators["function"],serialize:validators["function"]},true);}}
|
|
790
|
+
if(typeof configOrUrl==='string'){config=config||{};config.url=configOrUrl;}else{config=configOrUrl||{};}config=mergeConfig(this.defaults,config);var _config2=config,transitional=_config2.transitional,paramsSerializer=_config2.paramsSerializer,headers=_config2.headers;if(transitional!==undefined){validator.assertOptions(transitional,{silentJSONParsing:validators.transitional(validators["boolean"]),forcedJSONParsing:validators.transitional(validators["boolean"]),clarifyTimeoutError:validators.transitional(validators["boolean"])},false);}if(paramsSerializer!=null){if(utils$1.isFunction(paramsSerializer)){config.paramsSerializer={serialize:paramsSerializer};}else{validator.assertOptions(paramsSerializer,{encode:validators["function"],serialize:validators["function"]},true);}}// Set config.allowAbsoluteUrls
|
|
791
|
+
if(config.allowAbsoluteUrls!==undefined);else if(this.defaults.allowAbsoluteUrls!==undefined){config.allowAbsoluteUrls=this.defaults.allowAbsoluteUrls;}else{config.allowAbsoluteUrls=true;}validator.assertOptions(config,{baseUrl:validators.spelling('baseURL'),withXsrfToken:validators.spelling('withXSRFToken')},true);// Set config.method
|
|
791
792
|
config.method=(config.method||this.defaults.method||'get').toLowerCase();// Flatten headers
|
|
792
793
|
var contextHeaders=headers&&utils$1.merge(headers.common,headers[config.method]);headers&&utils$1.forEach(['delete','get','head','post','put','patch','common'],function(method){delete headers[method];});config.headers=AxiosHeaders$1.concat(contextHeaders,headers);// filter out skipped interceptors
|
|
793
|
-
var requestInterceptorChain=[];var synchronousRequestInterceptors=true;this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor){if(typeof interceptor.runWhen==='function'&&interceptor.runWhen(config)===false){return;}synchronousRequestInterceptors=synchronousRequestInterceptors&&interceptor.synchronous;requestInterceptorChain.unshift(interceptor.fulfilled,interceptor.rejected);});var responseInterceptorChain=[];this.interceptors.response.forEach(function pushResponseInterceptors(interceptor){responseInterceptorChain.push(interceptor.fulfilled,interceptor.rejected);});var promise;var i=0;var len;if(!synchronousRequestInterceptors){var chain=[dispatchRequest.bind(this),undefined];chain.unshift.apply(chain,requestInterceptorChain);chain.push.apply(chain,responseInterceptorChain);len=chain.length;promise=Promise.resolve(config);while(i<len){promise=promise.then(chain[i++],chain[i++]);}return promise;}len=requestInterceptorChain.length;var newConfig=config;i=0;while(i<len){var onFulfilled=requestInterceptorChain[i++];var onRejected=requestInterceptorChain[i++];try{newConfig=onFulfilled(newConfig);}catch(error){onRejected.call(this,error);break;}}try{promise=dispatchRequest.call(this,newConfig);}catch(error){return Promise.reject(error);}i=0;len=responseInterceptorChain.length;while(i<len){promise=promise.then(responseInterceptorChain[i++],responseInterceptorChain[i++]);}return promise;}},{key:"getUri",value:function getUri(config){config=mergeConfig(this.defaults,config);var fullPath=buildFullPath(config.baseURL,config.url);return buildURL(fullPath,config.params,config.paramsSerializer);}}]);}();// Provide aliases for supported request methods
|
|
794
|
+
var requestInterceptorChain=[];var synchronousRequestInterceptors=true;this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor){if(typeof interceptor.runWhen==='function'&&interceptor.runWhen(config)===false){return;}synchronousRequestInterceptors=synchronousRequestInterceptors&&interceptor.synchronous;requestInterceptorChain.unshift(interceptor.fulfilled,interceptor.rejected);});var responseInterceptorChain=[];this.interceptors.response.forEach(function pushResponseInterceptors(interceptor){responseInterceptorChain.push(interceptor.fulfilled,interceptor.rejected);});var promise;var i=0;var len;if(!synchronousRequestInterceptors){var chain=[dispatchRequest.bind(this),undefined];chain.unshift.apply(chain,requestInterceptorChain);chain.push.apply(chain,responseInterceptorChain);len=chain.length;promise=Promise.resolve(config);while(i<len){promise=promise.then(chain[i++],chain[i++]);}return promise;}len=requestInterceptorChain.length;var newConfig=config;i=0;while(i<len){var onFulfilled=requestInterceptorChain[i++];var onRejected=requestInterceptorChain[i++];try{newConfig=onFulfilled(newConfig);}catch(error){onRejected.call(this,error);break;}}try{promise=dispatchRequest.call(this,newConfig);}catch(error){return Promise.reject(error);}i=0;len=responseInterceptorChain.length;while(i<len){promise=promise.then(responseInterceptorChain[i++],responseInterceptorChain[i++]);}return promise;}},{key:"getUri",value:function getUri(config){config=mergeConfig(this.defaults,config);var fullPath=buildFullPath(config.baseURL,config.url,config.allowAbsoluteUrls);return buildURL(fullPath,config.params,config.paramsSerializer);}}]);}();// Provide aliases for supported request methods
|
|
794
795
|
utils$1.forEach(['delete','get','head','options'],function forEachMethodNoData(method){/*eslint func-names:0*/Axios.prototype[method]=function(url,config){return this.request(mergeConfig(config||{},{method:method,url:url,data:(config||{}).data}));};});utils$1.forEach(['post','put','patch'],function forEachMethodWithData(method){/*eslint func-names:0*/function generateHTTPMethod(isForm){return function httpMethod(url,data,config){return this.request(mergeConfig(config||{},{method:method,headers:isForm?{'Content-Type':'multipart/form-data'}:{},url:url,data:data}));};}Axios.prototype[method]=generateHTTPMethod();Axios.prototype[method+'Form']=generateHTTPMethod(true);});var Axios$1=Axios;/**
|
|
795
796
|
* A `CancelToken` is an object that can be used to request cancellation of an operation.
|
|
796
797
|
*
|
|
@@ -891,7 +892,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
891
892
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
892
893
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfUrl",value:function getConfUrl(pathType,regionUrl){if(!this.gateway)return regionUrl;if(!this.gateway.host)return regionUrl;var url=this.gateway.protocol+'://'+this.gateway.host;if(this.gateway.port>-1)url=url+':'+this.gateway.port.toString();if(pathType==='login'){if(this.gateway.path_params_login){if(this.gateway.path_params_login.startsWith('/'))url=url+this.gateway.path_params_login;else url=url+'/'+this.gateway.path_params_login;}}else{if(this.gateway.path_params_api){if(this.gateway.path_params_api.startsWith('/'))url=url+this.gateway.path_params_api;else url=url+'/'+this.gateway.path_params_api;}}return url;}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/**
|
|
893
894
|
* @module purecloud-platform-client-v2/ApiClient
|
|
894
|
-
* @version
|
|
895
|
+
* @version 218.0.0
|
|
895
896
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
896
897
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
897
898
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1234,7 +1235,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1234
1235
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1235
1236
|
* AgentAssistants service.
|
|
1236
1237
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1237
|
-
* @version
|
|
1238
|
+
* @version 218.0.0
|
|
1238
1239
|
*//**
|
|
1239
1240
|
* Constructs a new AgentAssistantsApi.
|
|
1240
1241
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1335,7 +1336,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1335
1336
|
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(){/**
|
|
1336
1337
|
* AgentCopilot service.
|
|
1337
1338
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1338
|
-
* @version
|
|
1339
|
+
* @version 218.0.0
|
|
1339
1340
|
*//**
|
|
1340
1341
|
* Constructs a new AgentCopilotApi.
|
|
1341
1342
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1357,7 +1358,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1357
1358
|
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(){/**
|
|
1358
1359
|
* AgentUI service.
|
|
1359
1360
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1360
|
-
* @version
|
|
1361
|
+
* @version 218.0.0
|
|
1361
1362
|
*//**
|
|
1362
1363
|
* Constructs a new AgentUIApi.
|
|
1363
1364
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1391,7 +1392,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1391
1392
|
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(){/**
|
|
1392
1393
|
* Alerting service.
|
|
1393
1394
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1394
|
-
* @version
|
|
1395
|
+
* @version 218.0.0
|
|
1395
1396
|
*//**
|
|
1396
1397
|
* Constructs a new AlertingApi.
|
|
1397
1398
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1407,18 +1408,6 @@ if(alertId===undefined||alertId===null){throw'Missing the required parameter "al
|
|
|
1407
1408
|
* Delete all alerts for the user
|
|
1408
1409
|
*
|
|
1409
1410
|
*/},{key:"deleteAlertingAlertsAll",value:function deleteAlertingAlertsAll(){return this.apiClient.callApi('/api/v2/alerting/alerts/all','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1410
|
-
* Delete an interaction stats alert
|
|
1411
|
-
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
1412
|
-
* @param {String} alertId Alert ID
|
|
1413
|
-
* @deprecated
|
|
1414
|
-
*/},{key:"deleteAlertingInteractionstatsAlert",value:function deleteAlertingInteractionstatsAlert(alertId){// verify the required parameter 'alertId' is set
|
|
1415
|
-
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/{alertId}','DELETE',{'alertId':alertId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1416
|
-
* Delete an interaction stats rule
|
|
1417
|
-
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
1418
|
-
* @param {String} ruleId Rule ID
|
|
1419
|
-
* @deprecated
|
|
1420
|
-
*/},{key:"deleteAlertingInteractionstatsRule",value:function deleteAlertingInteractionstatsRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
1421
|
-
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules/{ruleId}','DELETE',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1422
1411
|
* Delete a rule.
|
|
1423
1412
|
*
|
|
1424
1413
|
* @param {String} ruleId Rule Id
|
|
@@ -1429,42 +1418,6 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1429
1418
|
* @param {String} alertId Alert ID
|
|
1430
1419
|
*/},{key:"getAlertingAlert",value:function getAlertingAlert(alertId){// verify the required parameter 'alertId' is set
|
|
1431
1420
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling getAlertingAlert';}return this.apiClient.callApi('/api/v2/alerting/alerts/{alertId}','GET',{'alertId':alertId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1432
|
-
* Gets active alert count for a user
|
|
1433
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and alertStatus to Active in the request body.
|
|
1434
|
-
* @deprecated
|
|
1435
|
-
*/},{key:"getAlertingAlertsActive",value:function getAlertingAlertsActive(){return this.apiClient.callApi('/api/v2/alerting/alerts/active','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1436
|
-
* Get an interaction stats alert
|
|
1437
|
-
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
1438
|
-
* @param {String} alertId Alert ID
|
|
1439
|
-
* @param {Object} opts Optional parameters
|
|
1440
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1441
|
-
* @deprecated
|
|
1442
|
-
*/},{key:"getAlertingInteractionstatsAlert",value:function getAlertingInteractionstatsAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
1443
|
-
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/{alertId}','GET',{'alertId':alertId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1444
|
-
* Get interaction stats alert list
|
|
1445
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
1446
|
-
* @param {Object} opts Optional parameters
|
|
1447
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1448
|
-
* @deprecated
|
|
1449
|
-
*/},{key:"getAlertingInteractionstatsAlerts",value:function getAlertingInteractionstatsAlerts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1450
|
-
* Gets user unread count of interaction stats alerts
|
|
1451
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and viewStatus to Unread in the request body.
|
|
1452
|
-
* @deprecated
|
|
1453
|
-
*/},{key:"getAlertingInteractionstatsAlertsUnread",value:function getAlertingInteractionstatsAlertsUnread(){return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/unread','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1454
|
-
* Get an interaction stats rule
|
|
1455
|
-
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
1456
|
-
* @param {String} ruleId Rule ID
|
|
1457
|
-
* @param {Object} opts Optional parameters
|
|
1458
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1459
|
-
* @deprecated
|
|
1460
|
-
*/},{key:"getAlertingInteractionstatsRule",value:function getAlertingInteractionstatsRule(ruleId,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
1461
|
-
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules/{ruleId}','GET',{'ruleId':ruleId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1462
|
-
* Get an interaction stats rule list
|
|
1463
|
-
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
1464
|
-
* @param {Object} opts Optional parameters
|
|
1465
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1466
|
-
* @deprecated
|
|
1467
|
-
*/},{key:"getAlertingInteractionstatsRules",value:function getAlertingInteractionstatsRules(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1468
1421
|
* Get a rule.
|
|
1469
1422
|
*
|
|
1470
1423
|
* @param {String} ruleId Rule Id
|
|
@@ -1497,14 +1450,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1497
1450
|
* @param {Object} opts Optional parameters
|
|
1498
1451
|
* @param {Object} opts.body
|
|
1499
1452
|
*/},{key:"postAlertingAlertsQuery",value:function postAlertingAlertsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/alerting/alerts/query','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1500
|
-
* Create an interaction stats rule
|
|
1501
|
-
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
1502
|
-
* @param {Object} body AlertingRule
|
|
1503
|
-
* @param {Object} opts Optional parameters
|
|
1504
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1505
|
-
* @deprecated
|
|
1506
|
-
*/},{key:"postAlertingInteractionstatsRules",value:function postAlertingInteractionstatsRules(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
1507
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1508
1453
|
* Create a Rule.
|
|
1509
1454
|
*
|
|
1510
1455
|
* @param {Object} body rule to be created
|
|
@@ -1527,26 +1472,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1527
1472
|
* @param {Object} opts.body
|
|
1528
1473
|
*/},{key:"putAlertingAlert",value:function putAlertingAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
1529
1474
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling putAlertingAlert';}return this.apiClient.callApi('/api/v2/alerting/alerts/{alertId}','PUT',{'alertId':alertId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1530
|
-
* Update an interaction stats alert read status
|
|
1531
|
-
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
1532
|
-
* @param {String} alertId Alert ID
|
|
1533
|
-
* @param {Object} body InteractionStatsAlert
|
|
1534
|
-
* @param {Object} opts Optional parameters
|
|
1535
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1536
|
-
* @deprecated
|
|
1537
|
-
*/},{key:"putAlertingInteractionstatsAlert",value:function putAlertingInteractionstatsAlert(alertId,body,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
1538
|
-
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';}// verify the required parameter 'body' is set
|
|
1539
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/{alertId}','PUT',{'alertId':alertId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1540
|
-
* Update an interaction stats rule
|
|
1541
|
-
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
1542
|
-
* @param {String} ruleId Rule ID
|
|
1543
|
-
* @param {Object} body AlertingRule
|
|
1544
|
-
* @param {Object} opts Optional parameters
|
|
1545
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1546
|
-
* @deprecated
|
|
1547
|
-
*/},{key:"putAlertingInteractionstatsRule",value:function putAlertingInteractionstatsRule(ruleId,body,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
1548
|
-
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';}// verify the required parameter 'body' is set
|
|
1549
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules/{ruleId}','PUT',{'ruleId':ruleId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1550
1475
|
* Update a rule
|
|
1551
1476
|
*
|
|
1552
1477
|
* @param {String} ruleId Rule Id
|
|
@@ -1556,7 +1481,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1556
1481
|
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(){/**
|
|
1557
1482
|
* Analytics service.
|
|
1558
1483
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1559
|
-
* @version
|
|
1484
|
+
* @version 218.0.0
|
|
1560
1485
|
*//**
|
|
1561
1486
|
* Constructs a new AnalyticsApi.
|
|
1562
1487
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1786,7 +1711,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
1786
1711
|
* @param {Number} opts.pageSize (default to 25)
|
|
1787
1712
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
1788
1713
|
* @param {Object} opts.state Only list users of this state
|
|
1789
|
-
* @param {Boolean} opts.deletedOnly Only list deleted dashboards
|
|
1714
|
+
* @param {Boolean} opts.deletedOnly Only list users with deleted dashboards
|
|
1790
1715
|
*/},{key:"getAnalyticsReportingDashboardsUsers",value:function getAnalyticsReportingDashboardsUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/analytics/reporting/dashboards/users','GET',{},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'state':opts['state'],'deletedOnly':opts['deletedOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1791
1716
|
* Get all view export requests for a user
|
|
1792
1717
|
*
|
|
@@ -2227,7 +2152,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2227
2152
|
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(){/**
|
|
2228
2153
|
* Architect service.
|
|
2229
2154
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2230
|
-
* @version
|
|
2155
|
+
* @version 218.0.0
|
|
2231
2156
|
*//**
|
|
2232
2157
|
* Constructs a new ArchitectApi.
|
|
2233
2158
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2495,6 +2420,12 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
2495
2420
|
* @param {String} ivrId IVR id
|
|
2496
2421
|
*/},{key:"getArchitectIvr",value:function getArchitectIvr(ivrId){// verify the required parameter 'ivrId' is set
|
|
2497
2422
|
if(ivrId===undefined||ivrId===null){throw'Missing the required parameter "ivrId" when calling getArchitectIvr';}return this.apiClient.callApi('/api/v2/architect/ivrs/{ivrId}','GET',{'ivrId':ivrId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2423
|
+
* Get an IVR IdentityResolutionConfig.
|
|
2424
|
+
*
|
|
2425
|
+
* @param {String} ivrId IVR id
|
|
2426
|
+
* getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2427
|
+
*/},{key:"getArchitectIvrIdentityresolution",value:function getArchitectIvrIdentityresolution(ivrId){// verify the required parameter 'ivrId' is set
|
|
2428
|
+
if(ivrId===undefined||ivrId===null){throw'Missing the required parameter "ivrId" when calling getArchitectIvrIdentityresolution';}return this.apiClient.callApi('/api/v2/architect/ivrs/{ivrId}/identityresolution','GET',{'ivrId':ivrId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2498
2429
|
* Get IVR configs.
|
|
2499
2430
|
*
|
|
2500
2431
|
* @param {Object} opts Optional parameters
|
|
@@ -2889,6 +2820,13 @@ if(datatableId===undefined||datatableId===null){throw'Missing the required param
|
|
|
2889
2820
|
* @param {String} flowExecutionId flow execution ID
|
|
2890
2821
|
*/},{key:"getFlowsExecution",value:function getFlowsExecution(flowExecutionId){// verify the required parameter 'flowExecutionId' is set
|
|
2891
2822
|
if(flowExecutionId===undefined||flowExecutionId===null){throw'Missing the required parameter "flowExecutionId" when calling getFlowsExecution';}return this.apiClient.callApi('/api/v2/flows/executions/{flowExecutionId}','GET',{'flowExecutionId':flowExecutionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2823
|
+
* Fetch Architect Export Job Status
|
|
2824
|
+
*
|
|
2825
|
+
* @param {String} jobId Job ID
|
|
2826
|
+
* @param {Object} opts Optional parameters
|
|
2827
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
2828
|
+
*/},{key:"getFlowsExportJob",value:function getFlowsExportJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2829
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getFlowsExportJob';}return this.apiClient.callApi('/api/v2/flows/export/jobs/{jobId}','GET',{'jobId':jobId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2892
2830
|
* Start a process (job) to prepare a download of a singular flow execution data instance by Id
|
|
2893
2831
|
* Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
|
|
2894
2832
|
* @param {String} instanceId Instance ID
|
|
@@ -3181,6 +3119,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3181
3119
|
* @param {Object} flowLaunchRequest
|
|
3182
3120
|
*/},{key:"postFlowsExecutions",value:function postFlowsExecutions(flowLaunchRequest){// verify the required parameter 'flowLaunchRequest' is set
|
|
3183
3121
|
if(flowLaunchRequest===undefined||flowLaunchRequest===null){throw'Missing the required parameter "flowLaunchRequest" when calling postFlowsExecutions';}return this.apiClient.callApi('/api/v2/flows/executions','POST',{},{},{},{},flowLaunchRequest,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3122
|
+
* Register Architect Export Job
|
|
3123
|
+
*
|
|
3124
|
+
* @param {Object} body
|
|
3125
|
+
*/},{key:"postFlowsExportJobs",value:function postFlowsExportJobs(body){// verify the required parameter 'body' is set
|
|
3126
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postFlowsExportJobs';}return this.apiClient.callApi('/api/v2/flows/export/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3184
3127
|
* Start a process (job) that will prepare a list of execution data IDs for download.
|
|
3185
3128
|
* Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
|
|
3186
3129
|
* @param {Object} body Requested Flow Ids
|
|
@@ -3223,6 +3166,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3223
3166
|
*/},{key:"putArchitectIvr",value:function putArchitectIvr(ivrId,body){// verify the required parameter 'ivrId' is set
|
|
3224
3167
|
if(ivrId===undefined||ivrId===null){throw'Missing the required parameter "ivrId" when calling putArchitectIvr';}// verify the required parameter 'body' is set
|
|
3225
3168
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putArchitectIvr';}return this.apiClient.callApi('/api/v2/architect/ivrs/{ivrId}','PUT',{'ivrId':ivrId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3169
|
+
* Update an IVR IdentityResolutionConfig.
|
|
3170
|
+
*
|
|
3171
|
+
* @param {String} ivrId IVR id
|
|
3172
|
+
* @param {Object} body
|
|
3173
|
+
* putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3174
|
+
*/},{key:"putArchitectIvrIdentityresolution",value:function putArchitectIvrIdentityresolution(ivrId,body){// verify the required parameter 'ivrId' is set
|
|
3175
|
+
if(ivrId===undefined||ivrId===null){throw'Missing the required parameter "ivrId" when calling putArchitectIvrIdentityresolution';}// verify the required parameter 'body' is set
|
|
3176
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putArchitectIvrIdentityresolution';}return this.apiClient.callApi('/api/v2/architect/ivrs/{ivrId}/identityresolution','PUT',{'ivrId':ivrId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3226
3177
|
* Update specified user prompt
|
|
3227
3178
|
*
|
|
3228
3179
|
* @param {String} promptId Prompt ID
|
|
@@ -3319,7 +3270,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3319
3270
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3320
3271
|
* Audit service.
|
|
3321
3272
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3322
|
-
* @version
|
|
3273
|
+
* @version 218.0.0
|
|
3323
3274
|
*//**
|
|
3324
3275
|
* Constructs a new AuditApi.
|
|
3325
3276
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3369,7 +3320,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3369
3320
|
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(){/**
|
|
3370
3321
|
* Authorization service.
|
|
3371
3322
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3372
|
-
* @version
|
|
3323
|
+
* @version 218.0.0
|
|
3373
3324
|
*//**
|
|
3374
3325
|
* Constructs a new AuthorizationApi.
|
|
3375
3326
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3381,7 +3332,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3381
3332
|
*
|
|
3382
3333
|
* @param {String} divisionId Division ID
|
|
3383
3334
|
* @param {Object} opts Optional parameters
|
|
3384
|
-
* @param {Boolean} opts.force Force delete this division
|
|
3335
|
+
* @param {Boolean} opts.force DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
|
|
3385
3336
|
*/return _createClass(AuthorizationApi,[{key:"deleteAuthorizationDivision",value:function deleteAuthorizationDivision(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
3386
3337
|
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling deleteAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','DELETE',{'divisionId':divisionId},{'force':opts['force']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3387
3338
|
* Delete an access control policy
|
|
@@ -3629,10 +3580,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3629
3580
|
* Recreate a previously deleted division.
|
|
3630
3581
|
*
|
|
3631
3582
|
* @param {String} divisionId Division ID
|
|
3632
|
-
* @param {Object}
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
if(
|
|
3583
|
+
* @param {Object} body Recreated division data
|
|
3584
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,body){// verify the required parameter 'divisionId' is set
|
|
3585
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';}// verify the required parameter 'body' is set
|
|
3586
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}/restore','POST',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3636
3587
|
* Create a division.
|
|
3637
3588
|
*
|
|
3638
3589
|
* @param {Object} body Division
|
|
@@ -3789,7 +3740,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3789
3740
|
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(){/**
|
|
3790
3741
|
* Billing service.
|
|
3791
3742
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3792
|
-
* @version
|
|
3743
|
+
* @version 218.0.0
|
|
3793
3744
|
*//**
|
|
3794
3745
|
* Constructs a new BillingApi.
|
|
3795
3746
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3813,7 +3764,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3813
3764
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3814
3765
|
* CarrierServices service.
|
|
3815
3766
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3816
|
-
* @version
|
|
3767
|
+
* @version 218.0.0
|
|
3817
3768
|
*//**
|
|
3818
3769
|
* Constructs a new CarrierServicesApi.
|
|
3819
3770
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3833,7 +3784,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3833
3784
|
*/},{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(){/**
|
|
3834
3785
|
* Chat service.
|
|
3835
3786
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3836
|
-
* @version
|
|
3787
|
+
* @version 218.0.0
|
|
3837
3788
|
*//**
|
|
3838
3789
|
* Constructs a new ChatApi.
|
|
3839
3790
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3873,7 +3824,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
3873
3824
|
*
|
|
3874
3825
|
* @param {String} userId userId
|
|
3875
3826
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
3876
|
-
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3877
3827
|
*/},{key:"deleteChatsUserMessagesPin",value:function deleteChatsUserMessagesPin(userId,pinnedMessageId){// verify the required parameter 'userId' is set
|
|
3878
3828
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';}// verify the required parameter 'pinnedMessageId' is set
|
|
3879
3829
|
if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}','DELETE',{'userId':userId,'pinnedMessageId':pinnedMessageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3930,7 +3880,6 @@ if(threadId===undefined||threadId===null){throw'Missing the required parameter "
|
|
|
3930
3880
|
* Get information for a 1on1
|
|
3931
3881
|
*
|
|
3932
3882
|
* @param {String} userId userId
|
|
3933
|
-
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3934
3883
|
*/},{key:"getChatsUser",value:function getChatsUser(userId){// verify the required parameter 'userId' is set
|
|
3935
3884
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUser';}return this.apiClient.callApi('/api/v2/chats/users/{userId}','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3936
3885
|
* Get messages by id(s) from a 1on1
|
|
@@ -3952,12 +3901,10 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
3952
3901
|
* Get a user's chat settings
|
|
3953
3902
|
*
|
|
3954
3903
|
* @param {String} userId User ID
|
|
3955
|
-
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3956
3904
|
*/},{key:"getChatsUserSettings",value:function getChatsUserSettings(userId){// verify the required parameter 'userId' is set
|
|
3957
3905
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserSettings';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/settings','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3958
3906
|
* Get a user's chat settings
|
|
3959
3907
|
*
|
|
3960
|
-
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3961
3908
|
*/},{key:"getChatsUsersMeSettings",value:function getChatsUsersMeSettings(){return this.apiClient.callApi('/api/v2/chats/users/me/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3962
3909
|
* Set properties for a room
|
|
3963
3910
|
*
|
|
@@ -3993,14 +3940,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3993
3940
|
*
|
|
3994
3941
|
* @param {String} userId User ID
|
|
3995
3942
|
* @param {Object} body
|
|
3996
|
-
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3997
3943
|
*/},{key:"patchChatsUserSettings",value:function patchChatsUserSettings(userId,body){// verify the required parameter 'userId' is set
|
|
3998
3944
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserSettings';}// verify the required parameter 'body' is set
|
|
3999
3945
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchChatsUserSettings';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/settings','PATCH',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4000
3946
|
* Update a user's chat settings
|
|
4001
3947
|
*
|
|
4002
3948
|
* @param {Object} body
|
|
4003
|
-
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4004
3949
|
*/},{key:"patchChatsUsersMeSettings",value:function patchChatsUsersMeSettings(body){// verify the required parameter 'body' is set
|
|
4005
3950
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchChatsUsersMeSettings';}return this.apiClient.callApi('/api/v2/chats/users/me/settings','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4006
3951
|
* Send a message to a room
|
|
@@ -4040,7 +3985,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4040
3985
|
*
|
|
4041
3986
|
* @param {String} userId userId
|
|
4042
3987
|
* @param {Object} body Pinned Message Ids
|
|
4043
|
-
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4044
3988
|
*/},{key:"postChatsUserMessagesPins",value:function postChatsUserMessagesPins(userId,body){// verify the required parameter 'userId' is set
|
|
4045
3989
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessagesPins';}// verify the required parameter 'body' is set
|
|
4046
3990
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsUserMessagesPins';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/pins','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4058,7 +4002,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4058
4002
|
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(){/**
|
|
4059
4003
|
* Coaching service.
|
|
4060
4004
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4061
|
-
* @version
|
|
4005
|
+
* @version 218.0.0
|
|
4062
4006
|
*//**
|
|
4063
4007
|
* Constructs a new CoachingApi.
|
|
4064
4008
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4211,7 +4155,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4211
4155
|
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(){/**
|
|
4212
4156
|
* ContentManagement service.
|
|
4213
4157
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4214
|
-
* @version
|
|
4158
|
+
* @version 218.0.0
|
|
4215
4159
|
*//**
|
|
4216
4160
|
* Constructs a new ContentManagementApi.
|
|
4217
4161
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4493,7 +4437,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4493
4437
|
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(){/**
|
|
4494
4438
|
* Conversations service.
|
|
4495
4439
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4496
|
-
* @version
|
|
4440
|
+
* @version 218.0.0
|
|
4497
4441
|
*//**
|
|
4498
4442
|
* Constructs a new ConversationsApi.
|
|
4499
4443
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -4556,6 +4500,11 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
4556
4500
|
* @param {String} integrationId Integration ID
|
|
4557
4501
|
*/},{key:"deleteConversationsMessagingIntegrationsOpenIntegrationId",value:function deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4558
4502
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4503
|
+
* Delete Twitter messaging integration
|
|
4504
|
+
*
|
|
4505
|
+
* @param {String} integrationId Integration ID
|
|
4506
|
+
*/},{key:"deleteConversationsMessagingIntegrationsTwitterIntegrationId",value:function deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4507
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4559
4508
|
* Delete a WhatsApp messaging integration
|
|
4560
4509
|
*
|
|
4561
4510
|
* @param {String} integrationId Integration ID
|
|
@@ -5005,6 +4954,29 @@ if(cachedMediaItemId===undefined||cachedMediaItemId===null){throw'Missing the re
|
|
|
5005
4954
|
* Get a list of Facebook Permissions
|
|
5006
4955
|
*
|
|
5007
4956
|
*/},{key:"getConversationsMessagingFacebookPermissions",value:function getConversationsMessagingFacebookPermissions(){return this.apiClient.callApi('/api/v2/conversations/messaging/facebook/permissions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4957
|
+
* Get Facebook messaging integration identity resolution settings
|
|
4958
|
+
*
|
|
4959
|
+
* @param {String} integrationId Integration ID
|
|
4960
|
+
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4961
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4962
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4963
|
+
* Get an open messaging integration Identity Resolution settings
|
|
4964
|
+
*
|
|
4965
|
+
* @param {String} integrationId Integration ID
|
|
4966
|
+
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4967
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4968
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4969
|
+
* Get a whatsApp integration Identity Resolution settings
|
|
4970
|
+
*
|
|
4971
|
+
* @param {String} integrationId Integration ID
|
|
4972
|
+
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4973
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4974
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4975
|
+
* Get twitter oauth settings to patch an integration
|
|
4976
|
+
*
|
|
4977
|
+
* @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
|
|
4978
|
+
*/},{key:"getConversationsMessagingIntegrationTwitterOauthSettings",value:function getConversationsMessagingIntegrationTwitterOauthSettings(integrationId){// verify the required parameter 'integrationId' is set
|
|
4979
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationTwitterOauthSettings';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5008
4980
|
* Get a list of Integrations
|
|
5009
4981
|
*
|
|
5010
4982
|
* @param {Object} opts Optional parameters
|
|
@@ -5062,6 +5034,25 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
5062
5034
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
5063
5035
|
*/},{key:"getConversationsMessagingIntegrationsOpenIntegrationId",value:function getConversationsMessagingIntegrationsOpenIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
5064
5036
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5037
|
+
* Get a list of Twitter Integrations
|
|
5038
|
+
*
|
|
5039
|
+
* @param {Object} opts Optional parameters
|
|
5040
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5041
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5042
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
5043
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
5044
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
5045
|
+
*/},{key:"getConversationsMessagingIntegrationsTwitter",value:function getConversationsMessagingIntegrationsTwitter(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':opts['expand'],'supportedContent.id':opts['supportedContentId'],'messagingSetting.id':opts['messagingSettingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5046
|
+
* Get Twitter messaging integration
|
|
5047
|
+
*
|
|
5048
|
+
* @param {String} integrationId Integration ID
|
|
5049
|
+
* @param {Object} opts Optional parameters
|
|
5050
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
5051
|
+
*/},{key:"getConversationsMessagingIntegrationsTwitterIntegrationId",value:function getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
5052
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5053
|
+
* Get twitter oauth settings
|
|
5054
|
+
*
|
|
5055
|
+
*/},{key:"getConversationsMessagingIntegrationsTwitterOauthSettings",value:function getConversationsMessagingIntegrationsTwitterOauthSettings(){return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/oauth/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5065
5056
|
* Get a list of WhatsApp Integrations
|
|
5066
5057
|
*
|
|
5067
5058
|
* @param {Object} opts Optional parameters
|
|
@@ -5478,6 +5469,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5478
5469
|
*/},{key:"patchConversationsMessagingIntegrationsOpenIntegrationId",value:function patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
5479
5470
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
5480
5471
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5472
|
+
* Update a Twitter messaging integration
|
|
5473
|
+
*
|
|
5474
|
+
* @param {String} integrationId Integration ID
|
|
5475
|
+
* @param {Object} body TwitterIntegrationUpdateRequest
|
|
5476
|
+
*/},{key:"patchConversationsMessagingIntegrationsTwitterIntegrationId",value:function patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
5477
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}// verify the required parameter 'body' is set
|
|
5478
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5481
5479
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
5482
5480
|
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
|
5483
5481
|
* @param {String} integrationId Integration ID
|
|
@@ -6046,6 +6044,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6046
6044
|
* @param {Object} body OpenIntegrationRequest
|
|
6047
6045
|
*/},{key:"postConversationsMessagingIntegrationsOpen",value:function postConversationsMessagingIntegrationsOpen(body){// verify the required parameter 'body' is set
|
|
6048
6046
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpen';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6047
|
+
* Create Twitter Integration
|
|
6048
|
+
*
|
|
6049
|
+
* @param {Object} body TwitterIntegrationRequest
|
|
6050
|
+
*/},{key:"postConversationsMessagingIntegrationsTwitter",value:function postConversationsMessagingIntegrationsTwitter(body){// verify the required parameter 'body' is set
|
|
6051
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6049
6052
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
6050
6053
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
6051
6054
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
@@ -6095,6 +6098,14 @@ if(communicationId===undefined||communicationId===null){throw'Missing the requir
|
|
|
6095
6098
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
6096
6099
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
6097
6100
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling postConversationsSocialParticipantCommunicationWrapup';}return this.apiClient.callApi('/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup','POST',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6101
|
+
* Create an Agent-Type video conference and assign an agent to it
|
|
6102
|
+
*
|
|
6103
|
+
* @param {String} conversationId conversationId
|
|
6104
|
+
* @param {String} communicationId communicationId
|
|
6105
|
+
* postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6106
|
+
*/},{key:"postConversationsVideoAgentconferenceCommunication",value:function postConversationsVideoAgentconferenceCommunication(conversationId,communicationId){// verify the required parameter 'conversationId' is set
|
|
6107
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';}// verify the required parameter 'communicationId' is set
|
|
6108
|
+
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling postConversationsVideoAgentconferenceCommunication';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/agentconference/communications/{communicationId}','POST',{'conversationId':conversationId,'communicationId':communicationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6098
6109
|
* Apply wrap-up for this conversation communication
|
|
6099
6110
|
*
|
|
6100
6111
|
* @param {String} conversationId conversationId
|
|
@@ -6167,9 +6178,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6167
6178
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';}// verify the required parameter 'body' is set
|
|
6168
6179
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsChatRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6169
6180
|
* Update a conversation by setting its recording state
|
|
6170
|
-
*
|
|
6181
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
6171
6182
|
* @param {String} conversationId conversationId
|
|
6172
6183
|
* @param {Object} body SetRecordingState
|
|
6184
|
+
* @deprecated
|
|
6173
6185
|
*/},{key:"putConversationsCobrowsesessionRecordingstate",value:function putConversationsCobrowsesessionRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
6174
6186
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';}// verify the required parameter 'body' is set
|
|
6175
6187
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -6201,6 +6213,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6201
6213
|
*/},{key:"putConversationsMessageRecordingstate",value:function putConversationsMessageRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
6202
6214
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';}// verify the required parameter 'body' is set
|
|
6203
6215
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6216
|
+
* Create an identity resolution settings for a Facebook messaging integration
|
|
6217
|
+
*
|
|
6218
|
+
* @param {String} integrationId Integration ID
|
|
6219
|
+
* @param {Object} body IdentityResolutionConfig
|
|
6220
|
+
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6221
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
6222
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';}// verify the required parameter 'body' is set
|
|
6223
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6224
|
+
* Update an open messaging integration Identity Resolution settings
|
|
6225
|
+
*
|
|
6226
|
+
* @param {String} integrationId Integration ID
|
|
6227
|
+
* @param {Object} body
|
|
6228
|
+
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6229
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
6230
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
6231
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6232
|
+
* Update a whatsApp integration Identity Resolution settings
|
|
6233
|
+
*
|
|
6234
|
+
* @param {String} integrationId Integration ID
|
|
6235
|
+
* @param {Object} body
|
|
6236
|
+
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6237
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
6238
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';}// verify the required parameter 'body' is set
|
|
6239
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6204
6240
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
6205
6241
|
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
6206
6242
|
* @param {Object} body MessagingSetting
|
|
@@ -6240,7 +6276,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6240
6276
|
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(){/**
|
|
6241
6277
|
* DataExtensions service.
|
|
6242
6278
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6243
|
-
* @version
|
|
6279
|
+
* @version 218.0.0
|
|
6244
6280
|
*//**
|
|
6245
6281
|
* Constructs a new DataExtensionsApi.
|
|
6246
6282
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6261,7 +6297,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6261
6297
|
*/},{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(){/**
|
|
6262
6298
|
* DataPrivacy service.
|
|
6263
6299
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
6264
|
-
* @version
|
|
6300
|
+
* @version 218.0.0
|
|
6265
6301
|
*//**
|
|
6266
6302
|
* Constructs a new DataPrivacyApi.
|
|
6267
6303
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -6301,7 +6337,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6301
6337
|
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(){/**
|
|
6302
6338
|
* Downloads service.
|
|
6303
6339
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6304
|
-
* @version
|
|
6340
|
+
* @version 218.0.0
|
|
6305
6341
|
*//**
|
|
6306
6342
|
* Constructs a new DownloadsApi.
|
|
6307
6343
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6320,7 +6356,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6320
6356
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
6321
6357
|
* Emails service.
|
|
6322
6358
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6323
|
-
* @version
|
|
6359
|
+
* @version 218.0.0
|
|
6324
6360
|
*//**
|
|
6325
6361
|
* Constructs a new EmailsApi.
|
|
6326
6362
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6338,7 +6374,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6338
6374
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
6339
6375
|
* EmployeeEngagement service.
|
|
6340
6376
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6341
|
-
* @version
|
|
6377
|
+
* @version 218.0.0
|
|
6342
6378
|
*//**
|
|
6343
6379
|
* Constructs a new EmployeeEngagementApi.
|
|
6344
6380
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6376,7 +6412,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6376
6412
|
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(){/**
|
|
6377
6413
|
* Events service.
|
|
6378
6414
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6379
|
-
* @version
|
|
6415
|
+
* @version 218.0.0
|
|
6380
6416
|
*//**
|
|
6381
6417
|
* Constructs a new EventsApi.
|
|
6382
6418
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6401,7 +6437,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6401
6437
|
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(){/**
|
|
6402
6438
|
* ExternalContacts service.
|
|
6403
6439
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6404
|
-
* @version
|
|
6440
|
+
* @version 218.0.0
|
|
6405
6441
|
*//**
|
|
6406
6442
|
* Constructs a new ExternalContactsApi.
|
|
6407
6443
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6518,7 +6554,20 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
6518
6554
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
6519
6555
|
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
6520
6556
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6521
|
-
|
|
6557
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
6558
|
+
*/},{key:"getExternalcontactsContacts",value:function getExternalcontactsContacts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/contacts','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'q':opts['q'],'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'divisionIds':this.apiClient.buildCollectionParam(opts['divisionIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6559
|
+
* Get export for exportId
|
|
6560
|
+
*
|
|
6561
|
+
* @param {String} exportId Export id
|
|
6562
|
+
*/},{key:"getExternalcontactsContactsExport",value:function getExternalcontactsContactsExport(exportId){// verify the required parameter 'exportId' is set
|
|
6563
|
+
if(exportId===undefined||exportId===null){throw'Missing the required parameter "exportId" when calling getExternalcontactsContactsExport';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/exports/{exportId}','GET',{'exportId':exportId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6564
|
+
* List exports for organization
|
|
6565
|
+
*
|
|
6566
|
+
* @param {Object} opts Optional parameters
|
|
6567
|
+
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
6568
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
6569
|
+
* @param {Number} opts.pageSize Number of entities to return
|
|
6570
|
+
*/},{key:"getExternalcontactsContactsExports",value:function getExternalcontactsContactsExports(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/contacts/exports','GET',{},{'divisionIds':this.apiClient.buildCollectionParam(opts['divisionIds'],'multi'),'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6522
6571
|
* Get a schema
|
|
6523
6572
|
*
|
|
6524
6573
|
* @param {String} schemaId Schema ID
|
|
@@ -6661,7 +6710,8 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
6661
6710
|
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
6662
6711
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6663
6712
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
6664
|
-
|
|
6713
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
6714
|
+
*/},{key:"getExternalcontactsOrganizations",value:function getExternalcontactsOrganizations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/organizations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'q':opts['q'],'trustorId':this.apiClient.buildCollectionParam(opts['trustorId'],'multi'),'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'includeTrustors':opts['includeTrustors'],'divisionIds':this.apiClient.buildCollectionParam(opts['divisionIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6665
6715
|
* Get a schema
|
|
6666
6716
|
*
|
|
6667
6717
|
* @param {String} schemaId Schema ID
|
|
@@ -6694,32 +6744,65 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6694
6744
|
* @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
6695
6745
|
* @param {Object} opts Optional parameters
|
|
6696
6746
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
6747
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
|
|
6697
6748
|
*/},{key:"getExternalcontactsReversewhitepageslookup",value:function getExternalcontactsReversewhitepageslookup(lookupVal,opts){opts=opts||{};// verify the required parameter 'lookupVal' is set
|
|
6698
|
-
if(lookupVal===undefined||lookupVal===null){throw'Missing the required parameter "lookupVal" when calling getExternalcontactsReversewhitepageslookup';}return this.apiClient.callApi('/api/v2/externalcontacts/reversewhitepageslookup','GET',{},{'lookupVal':lookupVal,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6749
|
+
if(lookupVal===undefined||lookupVal===null){throw'Missing the required parameter "lookupVal" when calling getExternalcontactsReversewhitepageslookup';}return this.apiClient.callApi('/api/v2/externalcontacts/reversewhitepageslookup','GET',{},{'lookupVal':lookupVal,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'divisionId':opts['divisionId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6750
|
+
* Scan for external contacts using paging
|
|
6751
|
+
*
|
|
6752
|
+
* @param {Object} opts Optional parameters
|
|
6753
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
6754
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6755
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
6756
|
+
*/},{key:"getExternalcontactsScanContacts",value:function getExternalcontactsScanContacts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/contacts','GET',{},{'limit':opts['limit'],'cursor':opts['cursor'],'divisionId':opts['divisionId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6699
6757
|
* Scan for external contacts using paging
|
|
6700
6758
|
*
|
|
6701
6759
|
* @param {Object} opts Optional parameters
|
|
6702
6760
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
6703
6761
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6704
|
-
|
|
6762
|
+
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6763
|
+
*/},{key:"getExternalcontactsScanContactsDivisionviewsAll",value:function getExternalcontactsScanContactsDivisionviewsAll(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/contacts/divisionviews/all','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6705
6764
|
* Scan for notes using paging
|
|
6706
6765
|
*
|
|
6707
6766
|
* @param {Object} opts Optional parameters
|
|
6708
6767
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
6709
6768
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6710
|
-
|
|
6769
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
6770
|
+
*/},{key:"getExternalcontactsScanNotes",value:function getExternalcontactsScanNotes(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/notes','GET',{},{'limit':opts['limit'],'cursor':opts['cursor'],'divisionId':opts['divisionId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6771
|
+
* Scan for notes using paging
|
|
6772
|
+
*
|
|
6773
|
+
* @param {Object} opts Optional parameters
|
|
6774
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
6775
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6776
|
+
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6777
|
+
*/},{key:"getExternalcontactsScanNotesDivisionviewsAll",value:function getExternalcontactsScanNotesDivisionviewsAll(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/notes/divisionviews/all','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6778
|
+
* Scan for external organizations using paging
|
|
6779
|
+
*
|
|
6780
|
+
* @param {Object} opts Optional parameters
|
|
6781
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
6782
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6783
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
6784
|
+
*/},{key:"getExternalcontactsScanOrganizations",value:function getExternalcontactsScanOrganizations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/organizations','GET',{},{'limit':opts['limit'],'cursor':opts['cursor'],'divisionId':opts['divisionId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6711
6785
|
* Scan for external organizations using paging
|
|
6712
6786
|
*
|
|
6713
6787
|
* @param {Object} opts Optional parameters
|
|
6714
6788
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
6715
6789
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6716
|
-
|
|
6790
|
+
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6791
|
+
*/},{key:"getExternalcontactsScanOrganizationsDivisionviewsAll",value:function getExternalcontactsScanOrganizationsDivisionviewsAll(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/organizations/divisionviews/all','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6717
6792
|
* Scan for relationships
|
|
6718
6793
|
*
|
|
6719
6794
|
* @param {Object} opts Optional parameters
|
|
6720
6795
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
6721
6796
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6722
|
-
|
|
6797
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
6798
|
+
*/},{key:"getExternalcontactsScanRelationships",value:function getExternalcontactsScanRelationships(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/relationships','GET',{},{'limit':opts['limit'],'cursor':opts['cursor'],'divisionId':opts['divisionId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6799
|
+
* Scan for relationships
|
|
6800
|
+
*
|
|
6801
|
+
* @param {Object} opts Optional parameters
|
|
6802
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
6803
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6804
|
+
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6805
|
+
*/},{key:"getExternalcontactsScanRelationshipsDivisionviewsAll",value:function getExternalcontactsScanRelationshipsDivisionviewsAll(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/relationships/divisionviews/all','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6723
6806
|
* Claim or release identifiers for a contact
|
|
6724
6807
|
*
|
|
6725
6808
|
* @param {String} contactId ExternalContact ID
|
|
@@ -6737,6 +6820,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6737
6820
|
* @param {Object} body Contacts
|
|
6738
6821
|
*/},{key:"postExternalcontactsBulkContactsAdd",value:function postExternalcontactsBulkContactsAdd(body){// verify the required parameter 'body' is set
|
|
6739
6822
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsAdd';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/contacts/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6823
|
+
* Bulk fetch contacts across divisions
|
|
6824
|
+
*
|
|
6825
|
+
* @param {Object} body Contact ids
|
|
6826
|
+
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6827
|
+
*/},{key:"postExternalcontactsBulkContactsDivisionviews",value:function postExternalcontactsBulkContactsDivisionviews(body){// verify the required parameter 'body' is set
|
|
6828
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/contacts/divisionviews','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6740
6829
|
* Bulk remove contacts
|
|
6741
6830
|
*
|
|
6742
6831
|
* @param {Object} body Contact ids
|
|
@@ -6782,6 +6871,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6782
6871
|
* @param {Object} body Organizations
|
|
6783
6872
|
*/},{key:"postExternalcontactsBulkOrganizationsAdd",value:function postExternalcontactsBulkOrganizationsAdd(body){// verify the required parameter 'body' is set
|
|
6784
6873
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsAdd';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/organizations/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6874
|
+
* Bulk fetch organizations across divisions
|
|
6875
|
+
*
|
|
6876
|
+
* @param {Object} body Organizations ids
|
|
6877
|
+
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6878
|
+
*/},{key:"postExternalcontactsBulkOrganizationsDivisionviews",value:function postExternalcontactsBulkOrganizationsDivisionviews(body){// verify the required parameter 'body' is set
|
|
6879
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/organizations/divisionviews','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6785
6880
|
* Bulk remove organizations
|
|
6786
6881
|
*
|
|
6787
6882
|
* @param {Object} body Organization ids
|
|
@@ -6829,6 +6924,11 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
6829
6924
|
* @param {Object} body ExternalContact
|
|
6830
6925
|
*/},{key:"postExternalcontactsContacts",value:function postExternalcontactsContacts(body){// verify the required parameter 'body' is set
|
|
6831
6926
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6927
|
+
* Create bulk export
|
|
6928
|
+
*
|
|
6929
|
+
* @param {Object} body Export
|
|
6930
|
+
*/},{key:"postExternalcontactsContactsExports",value:function postExternalcontactsContactsExports(body){// verify the required parameter 'body' is set
|
|
6931
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContactsExports';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/exports','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6832
6932
|
* Create a schema
|
|
6833
6933
|
*
|
|
6834
6934
|
* @param {Object} body Schema
|
|
@@ -6996,7 +7096,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6996
7096
|
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(){/**
|
|
6997
7097
|
* Fax service.
|
|
6998
7098
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6999
|
-
* @version
|
|
7099
|
+
* @version 218.0.0
|
|
7000
7100
|
*//**
|
|
7001
7101
|
* Constructs a new FaxApi.
|
|
7002
7102
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -7045,7 +7145,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7045
7145
|
*/},{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(){/**
|
|
7046
7146
|
* Flows service.
|
|
7047
7147
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
7048
|
-
* @version
|
|
7148
|
+
* @version 218.0.0
|
|
7049
7149
|
*//**
|
|
7050
7150
|
* Constructs a new FlowsApi.
|
|
7051
7151
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -7093,7 +7193,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7093
7193
|
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(){/**
|
|
7094
7194
|
* Gamification service.
|
|
7095
7195
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
7096
|
-
* @version
|
|
7196
|
+
* @version 218.0.0
|
|
7097
7197
|
*//**
|
|
7098
7198
|
* Constructs a new GamificationApi.
|
|
7099
7199
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7652,7 +7752,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7652
7752
|
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(){/**
|
|
7653
7753
|
* GeneralDataProtectionRegulation service.
|
|
7654
7754
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7655
|
-
* @version
|
|
7755
|
+
* @version 218.0.0
|
|
7656
7756
|
*//**
|
|
7657
7757
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7658
7758
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7687,7 +7787,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7687
7787
|
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(){/**
|
|
7688
7788
|
* Geolocation service.
|
|
7689
7789
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7690
|
-
* @version
|
|
7790
|
+
* @version 218.0.0
|
|
7691
7791
|
*//**
|
|
7692
7792
|
* Constructs a new GeolocationApi.
|
|
7693
7793
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7721,7 +7821,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7721
7821
|
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(){/**
|
|
7722
7822
|
* Greetings service.
|
|
7723
7823
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7724
|
-
* @version
|
|
7824
|
+
* @version 218.0.0
|
|
7725
7825
|
*//**
|
|
7726
7826
|
* Constructs a new GreetingsApi.
|
|
7727
7827
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7828,7 +7928,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7828
7928
|
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(){/**
|
|
7829
7929
|
* Groups service.
|
|
7830
7930
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7831
|
-
* @version
|
|
7931
|
+
* @version 218.0.0
|
|
7832
7932
|
*//**
|
|
7833
7933
|
* Constructs a new GroupsApi.
|
|
7834
7934
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7961,7 +8061,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7961
8061
|
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(){/**
|
|
7962
8062
|
* IdentityProvider service.
|
|
7963
8063
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7964
|
-
* @version
|
|
8064
|
+
* @version 218.0.0
|
|
7965
8065
|
*//**
|
|
7966
8066
|
* Constructs a new IdentityProviderApi.
|
|
7967
8067
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -8117,7 +8217,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8117
8217
|
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(){/**
|
|
8118
8218
|
* InfrastructureAsCode service.
|
|
8119
8219
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
8120
|
-
* @version
|
|
8220
|
+
* @version 218.0.0
|
|
8121
8221
|
*//**
|
|
8122
8222
|
* Constructs a new InfrastructureAsCodeApi.
|
|
8123
8223
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -8171,7 +8271,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
8171
8271
|
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(){/**
|
|
8172
8272
|
* Integrations service.
|
|
8173
8273
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8174
|
-
* @version
|
|
8274
|
+
* @version 218.0.0
|
|
8175
8275
|
*//**
|
|
8176
8276
|
* Constructs a new IntegrationsApi.
|
|
8177
8277
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8231,17 +8331,19 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
8231
8331
|
* @param {String} actionId actionId
|
|
8232
8332
|
* @param {Object} opts Optional parameters
|
|
8233
8333
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
8334
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
8234
8335
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
8235
8336
|
*/},{key:"getIntegrationsAction",value:function getIntegrationsAction(actionId,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
8236
|
-
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsAction';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}','GET',{'actionId':actionId},{'expand':opts['expand'],'includeConfig':opts['includeConfig']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8337
|
+
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsAction';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}','GET',{'actionId':actionId},{'expand':opts['expand'],'flatten':opts['flatten'],'includeConfig':opts['includeConfig']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8237
8338
|
* Retrieve a Draft
|
|
8238
8339
|
*
|
|
8239
8340
|
* @param {String} actionId actionId
|
|
8240
8341
|
* @param {Object} opts Optional parameters
|
|
8241
8342
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
8343
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
8242
8344
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
8243
8345
|
*/},{key:"getIntegrationsActionDraft",value:function getIntegrationsActionDraft(actionId,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
8244
|
-
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraft';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft','GET',{'actionId':actionId},{'expand':opts['expand'],'includeConfig':opts['includeConfig']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8346
|
+
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraft';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft','GET',{'actionId':actionId},{'expand':opts['expand'],'flatten':opts['flatten'],'includeConfig':opts['includeConfig']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8245
8347
|
* Get draft function settings for Action
|
|
8246
8348
|
*
|
|
8247
8349
|
* @param {String} actionId actionId
|
|
@@ -8801,7 +8903,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8801
8903
|
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(){/**
|
|
8802
8904
|
* Journey service.
|
|
8803
8905
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8804
|
-
* @version
|
|
8906
|
+
* @version 218.0.0
|
|
8805
8907
|
*//**
|
|
8806
8908
|
* Constructs a new JourneyApi.
|
|
8807
8909
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -9281,7 +9383,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
9281
9383
|
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(){/**
|
|
9282
9384
|
* Knowledge service.
|
|
9283
9385
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
9284
|
-
* @version
|
|
9386
|
+
* @version 218.0.0
|
|
9285
9387
|
*//**
|
|
9286
9388
|
* Constructs a new KnowledgeApi.
|
|
9287
9389
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -9655,7 +9757,6 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
9655
9757
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
9656
9758
|
* @param {String} uploadId UploadId
|
|
9657
9759
|
* @deprecated
|
|
9658
|
-
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9659
9760
|
*/},{key:"getKnowledgeKnowledgebaseLanguageDocumentUpload",value:function getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId,knowledgeBaseId,languageCode,uploadId){// verify the required parameter 'documentId' is set
|
|
9660
9761
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'knowledgeBaseId' is set
|
|
9661
9762
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'languageCode' is set
|
|
@@ -9738,7 +9839,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9738
9839
|
* @param {String} parseJobId Parse job ID
|
|
9739
9840
|
* @param {Object} opts Optional parameters
|
|
9740
9841
|
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
9741
|
-
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9742
9842
|
*/},{key:"getKnowledgeKnowledgebaseParseJob",value:function getKnowledgeKnowledgebaseParseJob(knowledgeBaseId,parseJobId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9743
9843
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
9744
9844
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling getKnowledgeKnowledgebaseParseJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'parseJobId':parseJobId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9813,7 +9913,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9813
9913
|
*
|
|
9814
9914
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9815
9915
|
* @param {String} jobId Upload job ID
|
|
9816
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9817
9916
|
*/},{key:"getKnowledgeKnowledgebaseUploadsUrlsJob",value:function getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId,jobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9818
9917
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}// verify the required parameter 'jobId' is set
|
|
9819
9918
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9964,7 +10063,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9964
10063
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9965
10064
|
* @param {String} parseJobId Parse job ID
|
|
9966
10065
|
* @param {Object} body
|
|
9967
|
-
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9968
10066
|
*/},{key:"patchKnowledgeKnowledgebaseParseJob",value:function patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId,parseJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9969
10067
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
9970
10068
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'body' is set
|
|
@@ -10125,7 +10223,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10125
10223
|
*
|
|
10126
10224
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10127
10225
|
* @param {Object} body
|
|
10128
|
-
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10129
10226
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsBulkRemove",value:function postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
10130
10227
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';}// verify the required parameter 'body' is set
|
|
10131
10228
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -10133,7 +10230,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10133
10230
|
*
|
|
10134
10231
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10135
10232
|
* @param {Object} body
|
|
10136
|
-
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10137
10233
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsBulkUpdate",value:function postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
10138
10234
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';}// verify the required parameter 'body' is set
|
|
10139
10235
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -10171,7 +10267,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
10171
10267
|
*
|
|
10172
10268
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10173
10269
|
* @param {Object} body
|
|
10174
|
-
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10175
10270
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd",value:function postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
10176
10271
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';}// verify the required parameter 'body' is set
|
|
10177
10272
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -10213,7 +10308,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10213
10308
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
10214
10309
|
* @param {Object} body
|
|
10215
10310
|
* @deprecated
|
|
10216
|
-
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10217
10311
|
*/},{key:"postKnowledgeKnowledgebaseLanguageDocumentUploads",value:function postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId,knowledgeBaseId,languageCode,body){// verify the required parameter 'documentId' is set
|
|
10218
10312
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'knowledgeBaseId' is set
|
|
10219
10313
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'languageCode' is set
|
|
@@ -10262,7 +10356,6 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
10262
10356
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10263
10357
|
* @param {String} parseJobId Parse job ID
|
|
10264
10358
|
* @param {Object} body
|
|
10265
|
-
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10266
10359
|
*/},{key:"postKnowledgeKnowledgebaseParseJobImport",value:function postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId,parseJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
10267
10360
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobImport';}// verify the required parameter 'parseJobId' is set
|
|
10268
10361
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling postKnowledgeKnowledgebaseParseJobImport';}// verify the required parameter 'body' is set
|
|
@@ -10271,7 +10364,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10271
10364
|
*
|
|
10272
10365
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10273
10366
|
* @param {Object} body
|
|
10274
|
-
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10275
10367
|
*/},{key:"postKnowledgeKnowledgebaseParseJobs",value:function postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
10276
10368
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobs';}// verify the required parameter 'body' is set
|
|
10277
10369
|
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']);}/**
|
|
@@ -10294,9 +10386,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10294
10386
|
*
|
|
10295
10387
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10296
10388
|
* @param {String} sourceId Source ID
|
|
10297
|
-
|
|
10389
|
+
* @param {Object} opts Optional parameters
|
|
10390
|
+
* @param {Object} opts.body
|
|
10391
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
10298
10392
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
10299
|
-
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},
|
|
10393
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10300
10394
|
* Create ServiceNow Knowledge integration source
|
|
10301
10395
|
*
|
|
10302
10396
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -10308,9 +10402,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10308
10402
|
*
|
|
10309
10403
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10310
10404
|
* @param {String} sourceId Source ID
|
|
10311
|
-
|
|
10405
|
+
* @param {Object} opts Optional parameters
|
|
10406
|
+
* @param {Object} opts.body
|
|
10407
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
10312
10408
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
10313
|
-
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},
|
|
10409
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10314
10410
|
* Create synchronization job
|
|
10315
10411
|
*
|
|
10316
10412
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -10322,7 +10418,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10322
10418
|
*
|
|
10323
10419
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
10324
10420
|
* @param {Object} body uploadRequest
|
|
10325
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10326
10421
|
*/},{key:"postKnowledgeKnowledgebaseUploadsUrlsJobs",value:function postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
10327
10422
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';}// verify the required parameter 'body' is set
|
|
10328
10423
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -10351,7 +10446,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
10351
10446
|
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(){/**
|
|
10352
10447
|
* LanguageUnderstanding service.
|
|
10353
10448
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
10354
|
-
* @version
|
|
10449
|
+
* @version 218.0.0
|
|
10355
10450
|
*//**
|
|
10356
10451
|
* Constructs a new LanguageUnderstandingApi.
|
|
10357
10452
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10610,7 +10705,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10610
10705
|
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(){/**
|
|
10611
10706
|
* Languages service.
|
|
10612
10707
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10613
|
-
* @version
|
|
10708
|
+
* @version 218.0.0
|
|
10614
10709
|
*//**
|
|
10615
10710
|
* Constructs a new LanguagesApi.
|
|
10616
10711
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10665,7 +10760,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10665
10760
|
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(){/**
|
|
10666
10761
|
* Learning service.
|
|
10667
10762
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10668
|
-
* @version
|
|
10763
|
+
* @version 218.0.0
|
|
10669
10764
|
*//**
|
|
10670
10765
|
* Constructs a new LearningApi.
|
|
10671
10766
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10936,7 +11031,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10936
11031
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
10937
11032
|
* License service.
|
|
10938
11033
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10939
|
-
* @version
|
|
11034
|
+
* @version 218.0.0
|
|
10940
11035
|
*//**
|
|
10941
11036
|
* Constructs a new LicenseApi.
|
|
10942
11037
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10990,7 +11085,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10990
11085
|
*/},{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(){/**
|
|
10991
11086
|
* Locations service.
|
|
10992
11087
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10993
|
-
* @version
|
|
11088
|
+
* @version 218.0.0
|
|
10994
11089
|
*//**
|
|
10995
11090
|
* Constructs a new LocationsApi.
|
|
10996
11091
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -11049,7 +11144,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11049
11144
|
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(){/**
|
|
11050
11145
|
* LogCapture service.
|
|
11051
11146
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
11052
|
-
* @version
|
|
11147
|
+
* @version 218.0.0
|
|
11053
11148
|
*//**
|
|
11054
11149
|
* Constructs a new LogCaptureApi.
|
|
11055
11150
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -11099,7 +11194,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
11099
11194
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
11100
11195
|
* Messaging service.
|
|
11101
11196
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
11102
|
-
* @version
|
|
11197
|
+
* @version 218.0.0
|
|
11103
11198
|
*//**
|
|
11104
11199
|
* Constructs a new MessagingApi.
|
|
11105
11200
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -11189,7 +11284,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11189
11284
|
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(){/**
|
|
11190
11285
|
* MobileDevices service.
|
|
11191
11286
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
11192
|
-
* @version
|
|
11287
|
+
* @version 218.0.0
|
|
11193
11288
|
*//**
|
|
11194
11289
|
* Constructs a new MobileDevicesApi.
|
|
11195
11290
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -11228,7 +11323,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11228
11323
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
11229
11324
|
* Notifications service.
|
|
11230
11325
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
11231
|
-
* @version
|
|
11326
|
+
* @version 218.0.0
|
|
11232
11327
|
*//**
|
|
11233
11328
|
* Constructs a new NotificationsApi.
|
|
11234
11329
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -11285,7 +11380,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
11285
11380
|
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(){/**
|
|
11286
11381
|
* OAuth service.
|
|
11287
11382
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
11288
|
-
* @version
|
|
11383
|
+
* @version 218.0.0
|
|
11289
11384
|
*//**
|
|
11290
11385
|
* Constructs a new OAuthApi.
|
|
11291
11386
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -11370,7 +11465,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11370
11465
|
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(){/**
|
|
11371
11466
|
* Objects service.
|
|
11372
11467
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
11373
|
-
* @version
|
|
11468
|
+
* @version 218.0.0
|
|
11374
11469
|
*//**
|
|
11375
11470
|
* Constructs a new ObjectsApi.
|
|
11376
11471
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -11382,7 +11477,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11382
11477
|
*
|
|
11383
11478
|
* @param {String} divisionId Division ID
|
|
11384
11479
|
* @param {Object} opts Optional parameters
|
|
11385
|
-
* @param {Boolean} opts.force Force delete this division
|
|
11480
|
+
* @param {Boolean} opts.force DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
|
|
11386
11481
|
*/return _createClass(ObjectsApi,[{key:"deleteAuthorizationDivision",value:function deleteAuthorizationDivision(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
11387
11482
|
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling deleteAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','DELETE',{'divisionId':divisionId},{'force':opts['force']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11388
11483
|
* Returns an authorization division.
|
|
@@ -11423,10 +11518,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11423
11518
|
* Recreate a previously deleted division.
|
|
11424
11519
|
*
|
|
11425
11520
|
* @param {String} divisionId Division ID
|
|
11426
|
-
* @param {Object}
|
|
11427
|
-
|
|
11428
|
-
|
|
11429
|
-
if(
|
|
11521
|
+
* @param {Object} body Recreated division data
|
|
11522
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,body){// verify the required parameter 'divisionId' is set
|
|
11523
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';}// verify the required parameter 'body' is set
|
|
11524
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}/restore','POST',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11430
11525
|
* Create a division.
|
|
11431
11526
|
*
|
|
11432
11527
|
* @param {Object} body Division
|
|
@@ -11441,7 +11536,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11441
11536
|
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(){/**
|
|
11442
11537
|
* OperationalEvents service.
|
|
11443
11538
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
11444
|
-
* @version
|
|
11539
|
+
* @version 218.0.0
|
|
11445
11540
|
*//**
|
|
11446
11541
|
* Constructs a new OperationalEventsApi.
|
|
11447
11542
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11472,7 +11567,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
11472
11567
|
*/},{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(){/**
|
|
11473
11568
|
* Organization service.
|
|
11474
11569
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11475
|
-
* @version
|
|
11570
|
+
* @version 218.0.0
|
|
11476
11571
|
*//**
|
|
11477
11572
|
* Constructs a new OrganizationApi.
|
|
11478
11573
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11522,31 +11617,11 @@ if(requestId===undefined||requestId===null){throw'Missing the required parameter
|
|
|
11522
11617
|
* @param {String} namespaceName The namespace to fetch limits for
|
|
11523
11618
|
*/},{key:"getOrganizationsLimitsNamespace",value:function getOrganizationsLimitsNamespace(namespaceName){// verify the required parameter 'namespaceName' is set
|
|
11524
11619
|
if(namespaceName===undefined||namespaceName===null){throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespace';}return this.apiClient.callApi('/api/v2/organizations/limits/namespaces/{namespaceName}','GET',{'namespaceName':namespaceName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11525
|
-
* Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
11526
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
11527
|
-
* @param {String} namespaceName The namespace to get
|
|
11528
|
-
* @param {Object} opts Optional parameters
|
|
11529
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
11530
|
-
* @param {String} opts.entityId entity id of the count
|
|
11531
|
-
* @param {String} opts.userId userid of the count
|
|
11532
|
-
*/},{key:"getOrganizationsLimitsNamespaceCounts",value:function getOrganizationsLimitsNamespaceCounts(namespaceName,opts){opts=opts||{};// verify the required parameter 'namespaceName' is set
|
|
11533
|
-
if(namespaceName===undefined||namespaceName===null){throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceCounts';}return this.apiClient.callApi('/api/v2/organizations/limits/namespaces/{namespaceName}/counts','GET',{'namespaceName':namespaceName},{'cursor':opts['cursor'],'entityId':opts['entityId'],'userId':opts['userId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11534
11620
|
* Get the default limits in a namespace for an organization
|
|
11535
11621
|
*
|
|
11536
11622
|
* @param {String} namespaceName The namespace to fetch defaults limits for
|
|
11537
11623
|
*/},{key:"getOrganizationsLimitsNamespaceDefaults",value:function getOrganizationsLimitsNamespaceDefaults(namespaceName){// verify the required parameter 'namespaceName' is set
|
|
11538
11624
|
if(namespaceName===undefined||namespaceName===null){throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceDefaults';}return this.apiClient.callApi('/api/v2/organizations/limits/namespaces/{namespaceName}/defaults','GET',{'namespaceName':namespaceName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11539
|
-
* Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.
|
|
11540
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
11541
|
-
* @param {String} namespaceName The namespace to get
|
|
11542
|
-
* @param {String} limitName The limit to get
|
|
11543
|
-
* @param {Object} opts Optional parameters
|
|
11544
|
-
* @param {String} opts.entityId entity id of the count
|
|
11545
|
-
* @param {String} opts.userId userid of the count
|
|
11546
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
11547
|
-
*/},{key:"getOrganizationsLimitsNamespaceLimitCounts",value:function getOrganizationsLimitsNamespaceLimitCounts(namespaceName,limitName,opts){opts=opts||{};// verify the required parameter 'namespaceName' is set
|
|
11548
|
-
if(namespaceName===undefined||namespaceName===null){throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';}// verify the required parameter 'limitName' is set
|
|
11549
|
-
if(limitName===undefined||limitName===null){throw'Missing the required parameter "limitName" when calling getOrganizationsLimitsNamespaceLimitCounts';}return this.apiClient.callApi('/api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts','GET',{'namespaceName':namespaceName,'limitName':limitName},{'entityId':opts['entityId'],'userId':opts['userId'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11550
11625
|
* Get the available limit namespaces
|
|
11551
11626
|
*
|
|
11552
11627
|
* @param {Object} opts Optional parameters
|
|
@@ -11597,7 +11672,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11597
11672
|
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(){/**
|
|
11598
11673
|
* OrganizationAuthorization service.
|
|
11599
11674
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11600
|
-
* @version
|
|
11675
|
+
* @version 218.0.0
|
|
11601
11676
|
*//**
|
|
11602
11677
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11603
11678
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11931,7 +12006,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11931
12006
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
11932
12007
|
* Outbound service.
|
|
11933
12008
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11934
|
-
* @version
|
|
12009
|
+
* @version 218.0.0
|
|
11935
12010
|
*//**
|
|
11936
12011
|
* Constructs a new OutboundApi.
|
|
11937
12012
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12662,8 +12737,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12662
12737
|
* Update the outbound settings for this organization
|
|
12663
12738
|
*
|
|
12664
12739
|
* @param {Object} body outboundSettings
|
|
12665
|
-
|
|
12666
|
-
|
|
12740
|
+
* @param {Object} opts Optional parameters
|
|
12741
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
12742
|
+
*/},{key:"patchOutboundSettings",value:function patchOutboundSettings(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
12743
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchOutboundSettings';}return this.apiClient.callApi('/api/v2/outbound/settings','PATCH',{},{'useMaxCallsPerAgentDecimal':opts['useMaxCallsPerAgentDecimal']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12667
12744
|
* Create attempt limits
|
|
12668
12745
|
*
|
|
12669
12746
|
* @param {Object} body AttemptLimits
|
|
@@ -12710,8 +12787,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12710
12787
|
* Create a campaign.
|
|
12711
12788
|
*
|
|
12712
12789
|
* @param {Object} body Campaign
|
|
12713
|
-
|
|
12714
|
-
|
|
12790
|
+
* @param {Object} opts Optional parameters
|
|
12791
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
12792
|
+
*/},{key:"postOutboundCampaigns",value:function postOutboundCampaigns(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
12793
|
+
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']);}/**
|
|
12715
12794
|
* Get progress for a list of campaigns
|
|
12716
12795
|
*
|
|
12717
12796
|
* @param {Array.<String>} body Campaign IDs
|
|
@@ -12909,9 +12988,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12909
12988
|
*
|
|
12910
12989
|
* @param {String} campaignId Campaign ID
|
|
12911
12990
|
* @param {Object} body Campaign
|
|
12912
|
-
|
|
12991
|
+
* @param {Object} opts Optional parameters
|
|
12992
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
12993
|
+
*/},{key:"putOutboundCampaign",value:function putOutboundCampaign(campaignId,body,opts){opts=opts||{};// verify the required parameter 'campaignId' is set
|
|
12913
12994
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling putOutboundCampaign';}// verify the required parameter 'body' is set
|
|
12914
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundCampaign';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}','PUT',{'campaignId':campaignId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12995
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundCampaign';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}','PUT',{'campaignId':campaignId},{'useMaxCallsPerAgentDecimal':opts['useMaxCallsPerAgentDecimal']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12915
12996
|
* Send notification that an agent's state changed
|
|
12916
12997
|
* New agent state.
|
|
12917
12998
|
* @param {String} campaignId Campaign ID
|
|
@@ -13042,7 +13123,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13042
13123
|
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(){/**
|
|
13043
13124
|
* Presence service.
|
|
13044
13125
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
13045
|
-
* @version
|
|
13126
|
+
* @version 218.0.0
|
|
13046
13127
|
*//**
|
|
13047
13128
|
* Constructs a new PresenceApi.
|
|
13048
13129
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -13215,7 +13296,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13215
13296
|
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(){/**
|
|
13216
13297
|
* ProcessAutomation service.
|
|
13217
13298
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
13218
|
-
* @version
|
|
13299
|
+
* @version 218.0.0
|
|
13219
13300
|
*//**
|
|
13220
13301
|
* Constructs a new ProcessAutomationApi.
|
|
13221
13302
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -13278,7 +13359,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
13278
13359
|
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(){/**
|
|
13279
13360
|
* Quality service.
|
|
13280
13361
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
13281
|
-
* @version
|
|
13362
|
+
* @version 218.0.0
|
|
13282
13363
|
*//**
|
|
13283
13364
|
* Constructs a new QualityApi.
|
|
13284
13365
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13737,7 +13818,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13737
13818
|
*
|
|
13738
13819
|
* @param {String} formId Form ID
|
|
13739
13820
|
* @param {Object} body AI Scoring Settings
|
|
13740
|
-
* putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13741
13821
|
*/},{key:"putQualityFormsEvaluationAiscoringSettings",value:function putQualityFormsEvaluationAiscoringSettings(formId,body){// verify the required parameter 'formId' is set
|
|
13742
13822
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluationAiscoringSettings';}// verify the required parameter 'body' is set
|
|
13743
13823
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityFormsEvaluationAiscoringSettings';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}/aiscoring/settings','PUT',{'formId':formId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -13757,7 +13837,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13757
13837
|
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(){/**
|
|
13758
13838
|
* Recording service.
|
|
13759
13839
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13760
|
-
* @version
|
|
13840
|
+
* @version 218.0.0
|
|
13761
13841
|
*//**
|
|
13762
13842
|
* Constructs a new RecordingApi.
|
|
13763
13843
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13815,7 +13895,7 @@ if(policyId===undefined||policyId===null){throw'Missing the required parameter "
|
|
|
13815
13895
|
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
|
|
13816
13896
|
* @param {Object} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
13817
13897
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
13818
|
-
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
13898
|
+
* @param {String} opts.locale The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
13819
13899
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
13820
13900
|
*/},{key:"getConversationRecording",value:function getConversationRecording(conversationId,recordingId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
13821
13901
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationRecording';}// verify the required parameter 'recordingId' is set
|
|
@@ -13855,8 +13935,10 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
13855
13935
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
13856
13936
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
13857
13937
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
13938
|
+
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
13939
|
+
* @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
|
|
13858
13940
|
*/},{key:"getConversationRecordings",value:function getConversationRecordings(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
13859
|
-
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationRecordings';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/recordings','GET',{'conversationId':conversationId},{'maxWaitMs':opts['maxWaitMs'],'formatId':opts['formatId'],'mediaFormats':this.apiClient.buildCollectionParam(opts['mediaFormats'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13941
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationRecordings';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/recordings','GET',{'conversationId':conversationId},{'maxWaitMs':opts['maxWaitMs'],'formatId':opts['formatId'],'mediaFormats':this.apiClient.buildCollectionParam(opts['mediaFormats'],'multi'),'locale':opts['locale'],'includePauseAnnotationsForScreenRecordings':opts['includePauseAnnotationsForScreenRecordings']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13860
13942
|
* Gets a single orphan recording
|
|
13861
13943
|
*
|
|
13862
13944
|
* @param {String} orphanId Orphan ID
|
|
@@ -13995,13 +14077,6 @@ if(reportId===undefined||reportId===null){throw'Missing the required parameter "
|
|
|
13995
14077
|
* @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
|
|
13996
14078
|
*/},{key:"getRecordingsRetentionQuery",value:function getRecordingsRetentionQuery(retentionThresholdDays,opts){opts=opts||{};// verify the required parameter 'retentionThresholdDays' is set
|
|
13997
14079
|
if(retentionThresholdDays===undefined||retentionThresholdDays===null){throw'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';}return this.apiClient.callApi('/api/v2/recordings/retention/query','GET',{},{'retentionThresholdDays':retentionThresholdDays,'cursor':opts['cursor'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13998
|
-
* Retrieves a paged listing of screen recording sessions
|
|
13999
|
-
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
14000
|
-
* @param {Object} opts Optional parameters
|
|
14001
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14002
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14003
|
-
* @deprecated
|
|
14004
|
-
*/},{key:"getRecordingsScreensessions",value:function getRecordingsScreensessions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/screensessions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14005
14080
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
14006
14081
|
*
|
|
14007
14082
|
*/},{key:"getRecordingsScreensessionsDetails",value:function getRecordingsScreensessionsDetails(){return this.apiClient.callApi('/api/v2/recordings/screensessions/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -14161,7 +14236,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14161
14236
|
*/},{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(){/**
|
|
14162
14237
|
* ResponseManagement service.
|
|
14163
14238
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
14164
|
-
* @version
|
|
14239
|
+
* @version 218.0.0
|
|
14165
14240
|
*//**
|
|
14166
14241
|
* Constructs a new ResponseManagementApi.
|
|
14167
14242
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -14282,7 +14357,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
14282
14357
|
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(){/**
|
|
14283
14358
|
* Routing service.
|
|
14284
14359
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
14285
|
-
* @version
|
|
14360
|
+
* @version 218.0.0
|
|
14286
14361
|
*//**
|
|
14287
14362
|
* Constructs a new RoutingApi.
|
|
14288
14363
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14466,6 +14541,14 @@ if(domainId===undefined||domainId===null){throw'Missing the required parameter "
|
|
|
14466
14541
|
*/},{key:"getRoutingEmailDomainRoute",value:function getRoutingEmailDomainRoute(domainName,routeId){// verify the required parameter 'domainName' is set
|
|
14467
14542
|
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoute';}// verify the required parameter 'routeId' is set
|
|
14468
14543
|
if(routeId===undefined||routeId===null){throw'Missing the required parameter "routeId" when calling getRoutingEmailDomainRoute';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainName}/routes/{routeId}','GET',{'domainName':domainName,'routeId':routeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14544
|
+
* Get a route identity resolution setting.
|
|
14545
|
+
*
|
|
14546
|
+
* @param {String} domainName email domain
|
|
14547
|
+
* @param {String} routeId route ID
|
|
14548
|
+
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14549
|
+
*/},{key:"getRoutingEmailDomainRouteIdentityresolution",value:function getRoutingEmailDomainRouteIdentityresolution(domainName,routeId){// verify the required parameter 'domainName' is set
|
|
14550
|
+
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRouteIdentityresolution';}// verify the required parameter 'routeId' is set
|
|
14551
|
+
if(routeId===undefined||routeId===null){throw'Missing the required parameter "routeId" when calling getRoutingEmailDomainRouteIdentityresolution';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution','GET',{'domainName':domainName,'routeId':routeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14469
14552
|
* Get routes
|
|
14470
14553
|
*
|
|
14471
14554
|
* @param {String} domainName email domain
|
|
@@ -14596,6 +14679,12 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
14596
14679
|
* @param {String} opts.conversationId conversationId
|
|
14597
14680
|
*/},{key:"getRoutingQueueEstimatedwaittime",value:function getRoutingQueueEstimatedwaittime(queueId,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
14598
14681
|
if(queueId===undefined||queueId===null){throw'Missing the required parameter "queueId" when calling getRoutingQueueEstimatedwaittime';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}/estimatedwaittime','GET',{'queueId':queueId},{'conversationId':opts['conversationId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14682
|
+
* Get Queue IdentityResolution Settings.
|
|
14683
|
+
*
|
|
14684
|
+
* @param {String} queueId Queue ID
|
|
14685
|
+
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14686
|
+
*/},{key:"getRoutingQueueIdentityresolution",value:function getRoutingQueueIdentityresolution(queueId){// verify the required parameter 'queueId' is set
|
|
14687
|
+
if(queueId===undefined||queueId===null){throw'Missing the required parameter "queueId" when calling getRoutingQueueIdentityresolution';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}/identityresolution','GET',{'queueId':queueId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14599
14688
|
* Get Estimated Wait Time
|
|
14600
14689
|
*
|
|
14601
14690
|
* @param {String} queueId queueId
|
|
@@ -14764,6 +14853,12 @@ if(addressId===undefined||addressId===null){throw'Missing the required parameter
|
|
|
14764
14853
|
*/},{key:"getRoutingSmsAvailablephonenumbers",value:function getRoutingSmsAvailablephonenumbers(countryCode,phoneNumberType,opts){opts=opts||{};// verify the required parameter 'countryCode' is set
|
|
14765
14854
|
if(countryCode===undefined||countryCode===null){throw'Missing the required parameter "countryCode" when calling getRoutingSmsAvailablephonenumbers';}// verify the required parameter 'phoneNumberType' is set
|
|
14766
14855
|
if(phoneNumberType===undefined||phoneNumberType===null){throw'Missing the required parameter "phoneNumberType" when calling getRoutingSmsAvailablephonenumbers';}return this.apiClient.callApi('/api/v2/routing/sms/availablephonenumbers','GET',{},{'countryCode':countryCode,'region':opts['region'],'city':opts['city'],'areaCode':opts['areaCode'],'phoneNumberType':phoneNumberType,'pattern':opts['pattern'],'addressRequirement':opts['addressRequirement']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14856
|
+
* Get a SMS identity resolution settings.
|
|
14857
|
+
*
|
|
14858
|
+
* @param {String} addressId Address ID
|
|
14859
|
+
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14860
|
+
*/},{key:"getRoutingSmsIdentityresolutionPhonenumber",value:function getRoutingSmsIdentityresolutionPhonenumber(addressId){// verify the required parameter 'addressId' is set
|
|
14861
|
+
if(addressId===undefined||addressId===null){throw'Missing the required parameter "addressId" when calling getRoutingSmsIdentityresolutionPhonenumber';}return this.apiClient.callApi('/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}','GET',{'addressId':addressId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14767
14862
|
* Get a phone number provisioned for SMS.
|
|
14768
14863
|
*
|
|
14769
14864
|
* @param {String} phoneNumberId phone number
|
|
@@ -15201,6 +15296,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15201
15296
|
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling putRoutingEmailDomainRoute';}// verify the required parameter 'routeId' is set
|
|
15202
15297
|
if(routeId===undefined||routeId===null){throw'Missing the required parameter "routeId" when calling putRoutingEmailDomainRoute';}// verify the required parameter 'body' is set
|
|
15203
15298
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingEmailDomainRoute';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainName}/routes/{routeId}','PUT',{'domainName':domainName,'routeId':routeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15299
|
+
* Update identity resolution settings for a route.
|
|
15300
|
+
*
|
|
15301
|
+
* @param {String} domainName email domain
|
|
15302
|
+
* @param {String} routeId route ID
|
|
15303
|
+
* @param {Object} body
|
|
15304
|
+
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15305
|
+
*/},{key:"putRoutingEmailDomainRouteIdentityresolution",value:function putRoutingEmailDomainRouteIdentityresolution(domainName,routeId,body){// verify the required parameter 'domainName' is set
|
|
15306
|
+
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling putRoutingEmailDomainRouteIdentityresolution';}// verify the required parameter 'routeId' is set
|
|
15307
|
+
if(routeId===undefined||routeId===null){throw'Missing the required parameter "routeId" when calling putRoutingEmailDomainRouteIdentityresolution';}// verify the required parameter 'body' is set
|
|
15308
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingEmailDomainRouteIdentityresolution';}return this.apiClient.callApi('/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution','PUT',{'domainName':domainName,'routeId':routeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15204
15309
|
* Request an activation status (cname + dkim) update of an outbound domain
|
|
15205
15310
|
*
|
|
15206
15311
|
* @param {String} domainId domain ID
|
|
@@ -15220,6 +15325,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15220
15325
|
*/},{key:"putRoutingQueue",value:function putRoutingQueue(queueId,body){// verify the required parameter 'queueId' is set
|
|
15221
15326
|
if(queueId===undefined||queueId===null){throw'Missing the required parameter "queueId" when calling putRoutingQueue';}// verify the required parameter 'body' is set
|
|
15222
15327
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingQueue';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}','PUT',{'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15328
|
+
* Update Queue IdentityResolution Settings.
|
|
15329
|
+
*
|
|
15330
|
+
* @param {String} queueId Queue ID
|
|
15331
|
+
* @param {Object} body
|
|
15332
|
+
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15333
|
+
*/},{key:"putRoutingQueueIdentityresolution",value:function putRoutingQueueIdentityresolution(queueId,body){// verify the required parameter 'queueId' is set
|
|
15334
|
+
if(queueId===undefined||queueId===null){throw'Missing the required parameter "queueId" when calling putRoutingQueueIdentityresolution';}// verify the required parameter 'body' is set
|
|
15335
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingQueueIdentityresolution';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}/identityresolution','PUT',{'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15223
15336
|
* Update an organization's routing settings
|
|
15224
15337
|
*
|
|
15225
15338
|
* @param {Object} body Organization Settings
|
|
@@ -15230,6 +15343,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15230
15343
|
* @param {Object} body Organization Settings
|
|
15231
15344
|
*/},{key:"putRoutingSettingsTranscription",value:function putRoutingSettingsTranscription(body){// verify the required parameter 'body' is set
|
|
15232
15345
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingSettingsTranscription';}return this.apiClient.callApi('/api/v2/routing/settings/transcription','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15346
|
+
* Update an SMS identity resolution settings.
|
|
15347
|
+
*
|
|
15348
|
+
* @param {String} addressId Address ID
|
|
15349
|
+
* @param {Object} body
|
|
15350
|
+
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15351
|
+
*/},{key:"putRoutingSmsIdentityresolutionPhonenumber",value:function putRoutingSmsIdentityresolutionPhonenumber(addressId,body){// verify the required parameter 'addressId' is set
|
|
15352
|
+
if(addressId===undefined||addressId===null){throw'Missing the required parameter "addressId" when calling putRoutingSmsIdentityresolutionPhonenumber';}// verify the required parameter 'body' is set
|
|
15353
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingSmsIdentityresolutionPhonenumber';}return this.apiClient.callApi('/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}','PUT',{'addressId':addressId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15233
15354
|
* Update the user's Direct Routing Backup settings.
|
|
15234
15355
|
*
|
|
15235
15356
|
* @param {String} userId User ID
|
|
@@ -15281,7 +15402,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15281
15402
|
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(){/**
|
|
15282
15403
|
* SCIM service.
|
|
15283
15404
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
15284
|
-
* @version
|
|
15405
|
+
* @version 218.0.0
|
|
15285
15406
|
*//**
|
|
15286
15407
|
* Constructs a new SCIMApi.
|
|
15287
15408
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15506,7 +15627,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15506
15627
|
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(){/**
|
|
15507
15628
|
* ScreenRecording service.
|
|
15508
15629
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15509
|
-
* @version
|
|
15630
|
+
* @version 218.0.0
|
|
15510
15631
|
*//**
|
|
15511
15632
|
* Constructs a new ScreenRecordingApi.
|
|
15512
15633
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15521,7 +15642,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15521
15642
|
*/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(){/**
|
|
15522
15643
|
* Scripts service.
|
|
15523
15644
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15524
|
-
* @version
|
|
15645
|
+
* @version 218.0.0
|
|
15525
15646
|
*//**
|
|
15526
15647
|
* Constructs a new ScriptsApi.
|
|
15527
15648
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15657,7 +15778,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15657
15778
|
*/},{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(){/**
|
|
15658
15779
|
* Search service.
|
|
15659
15780
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15660
|
-
* @version
|
|
15781
|
+
* @version 218.0.0
|
|
15661
15782
|
*//**
|
|
15662
15783
|
* Constructs a new SearchApi.
|
|
15663
15784
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15829,7 +15950,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15829
15950
|
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(){/**
|
|
15830
15951
|
* Settings service.
|
|
15831
15952
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15832
|
-
* @version
|
|
15953
|
+
* @version 218.0.0
|
|
15833
15954
|
*//**
|
|
15834
15955
|
* Constructs a new SettingsApi.
|
|
15835
15956
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15879,7 +16000,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
15879
16000
|
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(){/**
|
|
15880
16001
|
* SocialMedia service.
|
|
15881
16002
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
15882
|
-
* @version
|
|
16003
|
+
* @version 218.0.0
|
|
15883
16004
|
*//**
|
|
15884
16005
|
* Constructs a new SocialMediaApi.
|
|
15885
16006
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -15887,13 +16008,23 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15887
16008
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
15888
16009
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
15889
16010
|
*/function SocialMediaApi(apiClient){_classCallCheck(this,SocialMediaApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
16011
|
+
* Delete an escalation rule.
|
|
16012
|
+
*
|
|
16013
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
16014
|
+
*/return _createClass(SocialMediaApi,[{key:"deleteSocialmediaEscalationrule",value:function deleteSocialmediaEscalationrule(escalationRuleId){// verify the required parameter 'escalationRuleId' is set
|
|
16015
|
+
if(escalationRuleId===undefined||escalationRuleId===null){throw'Missing the required parameter "escalationRuleId" when calling deleteSocialmediaEscalationrule';}return this.apiClient.callApi('/api/v2/socialmedia/escalationrules/{escalationRuleId}','DELETE',{'escalationRuleId':escalationRuleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16016
|
+
* Delete a social media message.
|
|
16017
|
+
*
|
|
16018
|
+
* @param {String} messageId messageId
|
|
16019
|
+
* deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16020
|
+
*/},{key:"deleteSocialmediaMessage",value:function deleteSocialmediaMessage(messageId){// verify the required parameter 'messageId' is set
|
|
16021
|
+
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling deleteSocialmediaMessage';}return this.apiClient.callApi('/api/v2/socialmedia/messages/{messageId}','DELETE',{'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15890
16022
|
* Delete a social topic.
|
|
15891
16023
|
*
|
|
15892
16024
|
* @param {String} topicId topicId
|
|
15893
16025
|
* @param {Object} opts Optional parameters
|
|
15894
16026
|
* @param {Boolean} opts.hardDelete Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default.
|
|
15895
|
-
|
|
15896
|
-
*/return _createClass(SocialMediaApi,[{key:"deleteSocialmediaTopic",value:function deleteSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16027
|
+
*/},{key:"deleteSocialmediaTopic",value:function deleteSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15897
16028
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopic';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}','DELETE',{'topicId':topicId},{'hardDelete':opts['hardDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15898
16029
|
* Delete a Facebook data ingestion rule.
|
|
15899
16030
|
*
|
|
@@ -15901,7 +16032,6 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15901
16032
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15902
16033
|
* @param {Object} opts Optional parameters
|
|
15903
16034
|
* @param {Boolean} opts.hardDelete Determines whether a Facebook data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
15904
|
-
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15905
16035
|
*/},{key:"deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15906
16036
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15907
16037
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','DELETE',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{'hardDelete':opts['hardDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15921,25 +16051,68 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
15921
16051
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
15922
16052
|
* @param {Object} opts Optional parameters
|
|
15923
16053
|
* @param {Boolean} opts.hardDelete Determines whether a X (formally Twitter) data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
15924
|
-
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15925
16054
|
*/},{key:"deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15926
16055
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
15927
16056
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','DELETE',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{'hardDelete':opts['hardDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16057
|
+
* Get status for async query for social media aggregates
|
|
16058
|
+
*
|
|
16059
|
+
* @param {String} jobId jobId
|
|
16060
|
+
*/},{key:"getSocialmediaAnalyticsAggregatesJob",value:function getSocialmediaAnalyticsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
16061
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJob';}return this.apiClient.callApi('/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16062
|
+
* Fetch a page of results for an async social media query
|
|
16063
|
+
*
|
|
16064
|
+
* @param {String} jobId jobId
|
|
16065
|
+
* @param {Object} opts Optional parameters
|
|
16066
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
16067
|
+
*/},{key:"getSocialmediaAnalyticsAggregatesJobResults",value:function getSocialmediaAnalyticsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
16068
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16069
|
+
* Get status for async query for social media messages job
|
|
16070
|
+
*
|
|
16071
|
+
* @param {String} jobId jobId
|
|
16072
|
+
*/},{key:"getSocialmediaAnalyticsMessagesJob",value:function getSocialmediaAnalyticsMessagesJob(jobId){// verify the required parameter 'jobId' is set
|
|
16073
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJob';}return this.apiClient.callApi('/api/v2/socialmedia/analytics/messages/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16074
|
+
* Fetch a page of results for an async social media messages query
|
|
16075
|
+
*
|
|
16076
|
+
* @param {String} jobId jobId
|
|
16077
|
+
* @param {Object} opts Optional parameters
|
|
16078
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
16079
|
+
*/},{key:"getSocialmediaAnalyticsMessagesJobResults",value:function getSocialmediaAnalyticsMessagesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
16080
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getSocialmediaAnalyticsMessagesJobResults';}return this.apiClient.callApi('/api/v2/socialmedia/analytics/messages/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16081
|
+
* Get a single escalation rule.
|
|
16082
|
+
*
|
|
16083
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
16084
|
+
*/},{key:"getSocialmediaEscalationrule",value:function getSocialmediaEscalationrule(escalationRuleId){// verify the required parameter 'escalationRuleId' is set
|
|
16085
|
+
if(escalationRuleId===undefined||escalationRuleId===null){throw'Missing the required parameter "escalationRuleId" when calling getSocialmediaEscalationrule';}return this.apiClient.callApi('/api/v2/socialmedia/escalationrules/{escalationRuleId}','GET',{'escalationRuleId':escalationRuleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16086
|
+
* Retrieve all escalation rules for a division.
|
|
16087
|
+
*
|
|
16088
|
+
* @param {String} divisionId One division ID
|
|
16089
|
+
* @param {Object} opts Optional parameters
|
|
16090
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16091
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16092
|
+
*/},{key:"getSocialmediaEscalationrules",value:function getSocialmediaEscalationrules(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
16093
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling getSocialmediaEscalationrules';}return this.apiClient.callApi('/api/v2/socialmedia/escalationrules','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'divisionId':divisionId},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15928
16094
|
* Get a single social topic.
|
|
15929
16095
|
*
|
|
15930
16096
|
* @param {String} topicId topicId
|
|
15931
16097
|
* @param {Object} opts Optional parameters
|
|
15932
16098
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15933
|
-
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15934
16099
|
*/},{key:"getSocialmediaTopic",value:function getSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15935
16100
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopic';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}','GET',{'topicId':topicId},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16101
|
+
* Retrieve all social topic data ingestion rules with pagination.
|
|
16102
|
+
*
|
|
16103
|
+
* @param {String} topicId topicId
|
|
16104
|
+
* @param {Object} opts Optional parameters
|
|
16105
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16106
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16107
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
16108
|
+
*/},{key:"getSocialmediaTopicDataingestionrules",value:function getSocialmediaTopicDataingestionrules(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16109
|
+
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrules';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules','GET',{'topicId':topicId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15936
16110
|
* Get a single Facebook data ingestion rule.
|
|
15937
16111
|
*
|
|
15938
16112
|
* @param {String} topicId topicId
|
|
15939
16113
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
15940
16114
|
* @param {Object} opts Optional parameters
|
|
15941
16115
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15942
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15943
16116
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15944
16117
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15945
16118
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','GET',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15950,7 +16123,6 @@ if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Mi
|
|
|
15950
16123
|
* @param {String} dataIngestionRuleVersion version
|
|
15951
16124
|
* @param {Object} opts Optional parameters
|
|
15952
16125
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
15953
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15954
16126
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId,facebookIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15955
16127
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15956
16128
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
@@ -15963,7 +16135,6 @@ if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'
|
|
|
15963
16135
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15964
16136
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15965
16137
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
15966
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15967
16138
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
15968
16139
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
15969
16140
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions','GET',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16007,7 +16178,6 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
16007
16178
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
16008
16179
|
* @param {Object} opts Optional parameters
|
|
16009
16180
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
16010
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16011
16181
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16012
16182
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
16013
16183
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','GET',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16018,7 +16188,6 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Miss
|
|
|
16018
16188
|
* @param {String} dataIngestionRuleVersion version
|
|
16019
16189
|
* @param {Object} opts Optional parameters
|
|
16020
16190
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
16021
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16022
16191
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId,twitterIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16023
16192
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
16024
16193
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
@@ -16031,7 +16200,6 @@ if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'
|
|
|
16031
16200
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16032
16201
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16033
16202
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
16034
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16035
16203
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16036
16204
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
16037
16205
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions','GET',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16042,14 +16210,12 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Miss
|
|
|
16042
16210
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16043
16211
|
* @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
|
|
16044
16212
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
16045
|
-
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16046
16213
|
*/},{key:"getSocialmediaTopics",value:function getSocialmediaTopics(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/socialmedia/topics','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'divisionIds':this.apiClient.buildCollectionParam(opts['divisionIds'],'multi'),'includeDeleted':opts['includeDeleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16047
16214
|
* Update a social topic.
|
|
16048
16215
|
*
|
|
16049
16216
|
* @param {String} topicId topicId
|
|
16050
16217
|
* @param {Object} opts Optional parameters
|
|
16051
16218
|
* @param {Object} opts.body
|
|
16052
|
-
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16053
16219
|
*/},{key:"patchSocialmediaTopic",value:function patchSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16054
16220
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopic';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}','PATCH',{'topicId':topicId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16055
16221
|
* Update the status of a Facebook data ingestion rule.
|
|
@@ -16058,7 +16224,6 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16058
16224
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
16059
16225
|
* @param {Object} opts Optional parameters
|
|
16060
16226
|
* @param {Object} opts.body
|
|
16061
|
-
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16062
16227
|
*/},{key:"patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16063
16228
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
16064
16229
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','PATCH',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16078,16 +16243,36 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
16078
16243
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
16079
16244
|
* @param {Object} opts Optional parameters
|
|
16080
16245
|
* @param {Object} opts.body
|
|
16081
|
-
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16082
16246
|
*/},{key:"patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16083
16247
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
16084
16248
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PATCH',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16249
|
+
* Query for social media aggregates asynchronously
|
|
16250
|
+
*
|
|
16251
|
+
* @param {Object} body query
|
|
16252
|
+
*/},{key:"postSocialmediaAnalyticsAggregatesJobs",value:function postSocialmediaAnalyticsAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
16253
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSocialmediaAnalyticsAggregatesJobs';}return this.apiClient.callApi('/api/v2/socialmedia/analytics/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16254
|
+
* Query for social media messages asynchronously
|
|
16255
|
+
*
|
|
16256
|
+
* @param {Object} body query
|
|
16257
|
+
*/},{key:"postSocialmediaAnalyticsMessagesJobs",value:function postSocialmediaAnalyticsMessagesJobs(body){// verify the required parameter 'body' is set
|
|
16258
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSocialmediaAnalyticsMessagesJobs';}return this.apiClient.callApi('/api/v2/socialmedia/analytics/messages/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16259
|
+
* Create an escalation rule.
|
|
16260
|
+
*
|
|
16261
|
+
* @param {Object} opts Optional parameters
|
|
16262
|
+
* @param {Object} opts.body
|
|
16263
|
+
*/},{key:"postSocialmediaEscalationrules",value:function postSocialmediaEscalationrules(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/socialmedia/escalationrules','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16264
|
+
* Escalate message to a conversation manually
|
|
16265
|
+
*
|
|
16266
|
+
* @param {String} divisionId One division ID
|
|
16267
|
+
* @param {Object} opts Optional parameters
|
|
16268
|
+
* @param {Object} opts.body
|
|
16269
|
+
*/},{key:"postSocialmediaEscalationsMessages",value:function postSocialmediaEscalationsMessages(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
16270
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling postSocialmediaEscalationsMessages';}return this.apiClient.callApi('/api/v2/socialmedia/escalations/messages','POST',{},{'divisionId':divisionId},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16085
16271
|
* Create an Facebook data ingestion rule.
|
|
16086
16272
|
*
|
|
16087
16273
|
* @param {String} topicId topicId
|
|
16088
16274
|
* @param {Object} opts Optional parameters
|
|
16089
16275
|
* @param {Object} opts.body
|
|
16090
|
-
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16091
16276
|
*/},{key:"postSocialmediaTopicDataingestionrulesFacebook",value:function postSocialmediaTopicDataingestionrulesFacebook(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16092
16277
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesFacebook';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook','POST',{'topicId':topicId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16093
16278
|
* Create an open data ingestion rule.
|
|
@@ -16103,22 +16288,31 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16103
16288
|
* @param {String} topicId topicId
|
|
16104
16289
|
* @param {Object} opts Optional parameters
|
|
16105
16290
|
* @param {Object} opts.body
|
|
16106
|
-
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16107
16291
|
*/},{key:"postSocialmediaTopicDataingestionrulesTwitter",value:function postSocialmediaTopicDataingestionrulesTwitter(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16108
16292
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesTwitter';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter','POST',{'topicId':topicId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16109
16293
|
* Create a social topic.
|
|
16110
16294
|
*
|
|
16111
16295
|
* @param {Object} opts Optional parameters
|
|
16112
16296
|
* @param {Object} opts.body
|
|
16113
|
-
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16114
16297
|
*/},{key:"postSocialmediaTopics",value:function postSocialmediaTopics(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/socialmedia/topics','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16298
|
+
* Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
|
|
16299
|
+
*
|
|
16300
|
+
* @param {Object} body TwitterDataHistoricalTweetRequest
|
|
16301
|
+
*/},{key:"postSocialmediaTwitterHistoricalTweets",value:function postSocialmediaTwitterHistoricalTweets(body){// verify the required parameter 'body' is set
|
|
16302
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSocialmediaTwitterHistoricalTweets';}return this.apiClient.callApi('/api/v2/socialmedia/twitter/historical/tweets','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16303
|
+
* Update the escalation rule.
|
|
16304
|
+
*
|
|
16305
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
16306
|
+
* @param {Object} opts Optional parameters
|
|
16307
|
+
* @param {Object} opts.body
|
|
16308
|
+
*/},{key:"putSocialmediaEscalationrule",value:function putSocialmediaEscalationrule(escalationRuleId,opts){opts=opts||{};// verify the required parameter 'escalationRuleId' is set
|
|
16309
|
+
if(escalationRuleId===undefined||escalationRuleId===null){throw'Missing the required parameter "escalationRuleId" when calling putSocialmediaEscalationrule';}return this.apiClient.callApi('/api/v2/socialmedia/escalationrules/{escalationRuleId}','PUT',{'escalationRuleId':escalationRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16115
16310
|
* Update the Facebook data ingestion rule.
|
|
16116
16311
|
*
|
|
16117
16312
|
* @param {String} topicId topicId
|
|
16118
16313
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
16119
16314
|
* @param {Object} opts Optional parameters
|
|
16120
16315
|
* @param {Object} opts.body
|
|
16121
|
-
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16122
16316
|
*/},{key:"putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16123
16317
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
16124
16318
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}','PUT',{'topicId':topicId,'facebookIngestionRuleId':facebookIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16138,13 +16332,12 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
16138
16332
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
16139
16333
|
* @param {Object} opts Optional parameters
|
|
16140
16334
|
* @param {Object} opts.body
|
|
16141
|
-
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16142
16335
|
*/},{key:"putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
16143
16336
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
16144
16337
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PUT',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
16145
16338
|
* SpeechTextAnalytics service.
|
|
16146
16339
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
16147
|
-
* @version
|
|
16340
|
+
* @version 218.0.0
|
|
16148
16341
|
*//**
|
|
16149
16342
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
16150
16343
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -16467,7 +16660,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16467
16660
|
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(){/**
|
|
16468
16661
|
* Stations service.
|
|
16469
16662
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
16470
|
-
* @version
|
|
16663
|
+
* @version 218.0.0
|
|
16471
16664
|
*//**
|
|
16472
16665
|
* Constructs a new StationsApi.
|
|
16473
16666
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -16499,7 +16692,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
16499
16692
|
*/},{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(){/**
|
|
16500
16693
|
* Suggest service.
|
|
16501
16694
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
16502
|
-
* @version
|
|
16695
|
+
* @version 218.0.0
|
|
16503
16696
|
*//**
|
|
16504
16697
|
* Constructs a new SuggestApi.
|
|
16505
16698
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -16539,7 +16732,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16539
16732
|
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(){/**
|
|
16540
16733
|
* TaskManagement service.
|
|
16541
16734
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
16542
|
-
* @version
|
|
16735
|
+
* @version 218.0.0
|
|
16543
16736
|
*//**
|
|
16544
16737
|
* Constructs a new TaskManagementApi.
|
|
16545
16738
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -17045,7 +17238,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
17045
17238
|
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(){/**
|
|
17046
17239
|
* Teams service.
|
|
17047
17240
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
17048
|
-
* @version
|
|
17241
|
+
* @version 218.0.0
|
|
17049
17242
|
*//**
|
|
17050
17243
|
* Constructs a new TeamsApi.
|
|
17051
17244
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -17125,7 +17318,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17125
17318
|
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(){/**
|
|
17126
17319
|
* Telephony service.
|
|
17127
17320
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
17128
|
-
* @version
|
|
17321
|
+
* @version 218.0.0
|
|
17129
17322
|
*//**
|
|
17130
17323
|
* Constructs a new TelephonyApi.
|
|
17131
17324
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -17172,7 +17365,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
17172
17365
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
17173
17366
|
* TelephonyProvidersEdge service.
|
|
17174
17367
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
17175
|
-
* @version
|
|
17368
|
+
* @version 218.0.0
|
|
17176
17369
|
*//**
|
|
17177
17370
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
17178
17371
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -17453,7 +17646,8 @@ if(extensionPoolId===undefined||extensionPoolId===null){throw'Missing the requir
|
|
|
17453
17646
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17454
17647
|
* @param {String} opts.sortBy Sort by
|
|
17455
17648
|
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
17456
|
-
|
|
17649
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
17650
|
+
*/},{key:"getTelephonyProvidersEdgesExtensionpools",value:function getTelephonyProvidersEdgesExtensionpools(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges/extensionpools','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'number':opts['_number'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17457
17651
|
* Get a pageable list of basic extension pool objects filterable by query parameters.
|
|
17458
17652
|
* This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
17459
17653
|
* @param {Object} opts Optional parameters
|
|
@@ -18007,7 +18201,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
18007
18201
|
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(){/**
|
|
18008
18202
|
* Textbots service.
|
|
18009
18203
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
18010
|
-
* @version
|
|
18204
|
+
* @version 218.0.0
|
|
18011
18205
|
*//**
|
|
18012
18206
|
* Constructs a new TextbotsApi.
|
|
18013
18207
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -18042,7 +18236,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
18042
18236
|
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(){/**
|
|
18043
18237
|
* Tokens service.
|
|
18044
18238
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
18045
|
-
* @version
|
|
18239
|
+
* @version 218.0.0
|
|
18046
18240
|
*//**
|
|
18047
18241
|
* Constructs a new TokensApi.
|
|
18048
18242
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -18076,7 +18270,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18076
18270
|
*/},{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(){/**
|
|
18077
18271
|
* Uploads service.
|
|
18078
18272
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
18079
|
-
* @version
|
|
18273
|
+
* @version 218.0.0
|
|
18080
18274
|
*//**
|
|
18081
18275
|
* Constructs a new UploadsApi.
|
|
18082
18276
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -18088,7 +18282,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18088
18282
|
*
|
|
18089
18283
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
18090
18284
|
* @param {String} jobId Upload job ID
|
|
18091
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18092
18285
|
*/return _createClass(UploadsApi,[{key:"getKnowledgeKnowledgebaseUploadsUrlsJob",value:function getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId,jobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
18093
18286
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}// verify the required parameter 'jobId' is set
|
|
18094
18287
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -18108,7 +18301,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18108
18301
|
*
|
|
18109
18302
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
18110
18303
|
* @param {Object} body uploadRequest
|
|
18111
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18112
18304
|
*/},{key:"postKnowledgeKnowledgebaseUploadsUrlsJobs",value:function postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
18113
18305
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';}// verify the required parameter 'body' is set
|
|
18114
18306
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -18141,7 +18333,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18141
18333
|
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(){/**
|
|
18142
18334
|
* Usage service.
|
|
18143
18335
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
18144
|
-
* @version
|
|
18336
|
+
* @version 218.0.0
|
|
18145
18337
|
*//**
|
|
18146
18338
|
* Constructs a new UsageApi.
|
|
18147
18339
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -18195,7 +18387,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18195
18387
|
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(){/**
|
|
18196
18388
|
* UserRecordings service.
|
|
18197
18389
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
18198
|
-
* @version
|
|
18390
|
+
* @version 218.0.0
|
|
18199
18391
|
*//**
|
|
18200
18392
|
* Constructs a new UserRecordingsApi.
|
|
18201
18393
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -18252,7 +18444,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
18252
18444
|
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(){/**
|
|
18253
18445
|
* Users service.
|
|
18254
18446
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
18255
|
-
* @version
|
|
18447
|
+
* @version 218.0.0
|
|
18256
18448
|
*//**
|
|
18257
18449
|
* Constructs a new UsersApi.
|
|
18258
18450
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -18979,7 +19171,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
18979
19171
|
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(){/**
|
|
18980
19172
|
* Utilities service.
|
|
18981
19173
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
18982
|
-
* @version
|
|
19174
|
+
* @version 218.0.0
|
|
18983
19175
|
*//**
|
|
18984
19176
|
* Constructs a new UtilitiesApi.
|
|
18985
19177
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -19006,7 +19198,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19006
19198
|
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(){/**
|
|
19007
19199
|
* Voicemail service.
|
|
19008
19200
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
19009
|
-
* @version
|
|
19201
|
+
* @version 218.0.0
|
|
19010
19202
|
*//**
|
|
19011
19203
|
* Constructs a new VoicemailApi.
|
|
19012
19204
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -19168,7 +19360,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19168
19360
|
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(){/**
|
|
19169
19361
|
* WebChat service.
|
|
19170
19362
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
19171
|
-
* @version
|
|
19363
|
+
* @version 218.0.0
|
|
19172
19364
|
*//**
|
|
19173
19365
|
* Constructs a new WebChatApi.
|
|
19174
19366
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -19183,9 +19375,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19183
19375
|
*/return _createClass(WebChatApi,[{key:"deleteWebchatDeployment",value:function deleteWebchatDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
19184
19376
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling deleteWebchatDeployment';}return this.apiClient.callApi('/api/v2/webchat/deployments/{deploymentId}','DELETE',{'deploymentId':deploymentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19185
19377
|
* Remove a member from a chat conversation
|
|
19186
|
-
*
|
|
19378
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19187
19379
|
* @param {String} conversationId conversationId
|
|
19188
19380
|
* @param {String} memberId memberId
|
|
19381
|
+
* @deprecated
|
|
19189
19382
|
*/},{key:"deleteWebchatGuestConversationMember",value:function deleteWebchatGuestConversationMember(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
19190
19383
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling deleteWebchatGuestConversationMember';}// verify the required parameter 'memberId' is set
|
|
19191
19384
|
if(memberId===undefined||memberId===null){throw'Missing the required parameter "memberId" when calling deleteWebchatGuestConversationMember';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}','DELETE',{'conversationId':conversationId,'memberId':memberId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -19211,41 +19404,46 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
19211
19404
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequest';}// verify the required parameter 'mediaRequestId' is set
|
|
19212
19405
|
if(mediaRequestId===undefined||mediaRequestId===null){throw'Missing the required parameter "mediaRequestId" when calling getWebchatGuestConversationMediarequest';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}','GET',{'conversationId':conversationId,'mediaRequestId':mediaRequestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19213
19406
|
* Get all media requests to the guest in the conversation
|
|
19214
|
-
*
|
|
19407
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19215
19408
|
* @param {String} conversationId conversationId
|
|
19409
|
+
* @deprecated
|
|
19216
19410
|
*/},{key:"getWebchatGuestConversationMediarequests",value:function getWebchatGuestConversationMediarequests(conversationId){// verify the required parameter 'conversationId' is set
|
|
19217
19411
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequests';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/mediarequests','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19218
19412
|
* Get a web chat conversation member
|
|
19219
|
-
*
|
|
19413
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19220
19414
|
* @param {String} conversationId conversationId
|
|
19221
19415
|
* @param {String} memberId memberId
|
|
19416
|
+
* @deprecated
|
|
19222
19417
|
*/},{key:"getWebchatGuestConversationMember",value:function getWebchatGuestConversationMember(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
19223
19418
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMember';}// verify the required parameter 'memberId' is set
|
|
19224
19419
|
if(memberId===undefined||memberId===null){throw'Missing the required parameter "memberId" when calling getWebchatGuestConversationMember';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}','GET',{'conversationId':conversationId,'memberId':memberId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19225
19420
|
* Get the members of a chat conversation.
|
|
19226
|
-
*
|
|
19421
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19227
19422
|
* @param {String} conversationId conversationId
|
|
19228
19423
|
* @param {Object} opts Optional parameters
|
|
19229
19424
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
19230
19425
|
* @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
|
|
19231
19426
|
* @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
|
|
19427
|
+
* @deprecated
|
|
19232
19428
|
*/},{key:"getWebchatGuestConversationMembers",value:function getWebchatGuestConversationMembers(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
19233
19429
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMembers';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/members','GET',{'conversationId':conversationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'excludeDisconnectedMembers':opts['excludeDisconnectedMembers']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19234
19430
|
* Get a web chat conversation message
|
|
19235
|
-
*
|
|
19431
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19236
19432
|
* @param {String} conversationId conversationId
|
|
19237
19433
|
* @param {String} messageId messageId
|
|
19434
|
+
* @deprecated
|
|
19238
19435
|
*/},{key:"getWebchatGuestConversationMessage",value:function getWebchatGuestConversationMessage(conversationId,messageId){// verify the required parameter 'conversationId' is set
|
|
19239
19436
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessage';}// verify the required parameter 'messageId' is set
|
|
19240
19437
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling getWebchatGuestConversationMessage';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}','GET',{'conversationId':conversationId,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19241
19438
|
* Get the messages of a chat conversation.
|
|
19242
|
-
*
|
|
19439
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19243
19440
|
* @param {String} conversationId conversationId
|
|
19244
19441
|
* @param {Object} opts Optional parameters
|
|
19245
19442
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
19246
19443
|
* @param {String} opts.before If available, get the messages chronologically before the id of this message
|
|
19247
19444
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
19248
19445
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
19446
|
+
* @deprecated
|
|
19249
19447
|
*/},{key:"getWebchatGuestConversationMessages",value:function getWebchatGuestConversationMessages(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
19250
19448
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessages';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/messages','GET',{'conversationId':conversationId},{'after':opts['after'],'before':opts['before'],'sortOrder':opts['sortOrder'],'maxResults':opts['maxResults']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19251
19449
|
* Get WebChat deployment settings
|
|
@@ -19268,24 +19466,27 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19268
19466
|
*/},{key:"postWebchatDeployments",value:function postWebchatDeployments(body){// verify the required parameter 'body' is set
|
|
19269
19467
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWebchatDeployments';}return this.apiClient.callApi('/api/v2/webchat/deployments','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19270
19468
|
* Send a message in a chat conversation.
|
|
19271
|
-
*
|
|
19469
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19272
19470
|
* @param {String} conversationId conversationId
|
|
19273
19471
|
* @param {String} memberId memberId
|
|
19274
19472
|
* @param {Object} body Message
|
|
19473
|
+
* @deprecated
|
|
19275
19474
|
*/},{key:"postWebchatGuestConversationMemberMessages",value:function postWebchatGuestConversationMemberMessages(conversationId,memberId,body){// verify the required parameter 'conversationId' is set
|
|
19276
19475
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberMessages';}// verify the required parameter 'memberId' is set
|
|
19277
19476
|
if(memberId===undefined||memberId===null){throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberMessages';}// verify the required parameter 'body' is set
|
|
19278
19477
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWebchatGuestConversationMemberMessages';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages','POST',{'conversationId':conversationId,'memberId':memberId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19279
19478
|
* Send a typing-indicator in a chat conversation.
|
|
19280
|
-
*
|
|
19479
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
19281
19480
|
* @param {String} conversationId conversationId
|
|
19282
19481
|
* @param {String} memberId memberId
|
|
19482
|
+
* @deprecated
|
|
19283
19483
|
*/},{key:"postWebchatGuestConversationMemberTyping",value:function postWebchatGuestConversationMemberTyping(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
19284
19484
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberTyping';}// verify the required parameter 'memberId' is set
|
|
19285
19485
|
if(memberId===undefined||memberId===null){throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberTyping';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing','POST',{'conversationId':conversationId,'memberId':memberId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19286
19486
|
* Create an ACD chat conversation from an external customer.
|
|
19287
|
-
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.
|
|
19487
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the memberAuthToken field should include his JWT as generated by the POST /api/v2/signeddata resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the eventStreamUri field of the response; the conversation is not routed until the event stream is attached.
|
|
19288
19488
|
* @param {Object} body CreateConversationRequest
|
|
19489
|
+
* @deprecated
|
|
19289
19490
|
*/},{key:"postWebchatGuestConversations",value:function postWebchatGuestConversations(body){// verify the required parameter 'body' is set
|
|
19290
19491
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWebchatGuestConversations';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19291
19492
|
* Update a WebChat deployment
|
|
@@ -19303,7 +19504,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19303
19504
|
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(){/**
|
|
19304
19505
|
* WebDeployments service.
|
|
19305
19506
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
19306
|
-
* @version
|
|
19507
|
+
* @version 218.0.0
|
|
19307
19508
|
*//**
|
|
19308
19509
|
* Constructs a new WebDeploymentsApi.
|
|
19309
19510
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -19378,6 +19579,12 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
19378
19579
|
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
19379
19580
|
*/},{key:"getWebdeploymentsDeploymentConfigurations",value:function getWebdeploymentsDeploymentConfigurations(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
19380
19581
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}/configurations','GET',{'deploymentId':deploymentId},{'type':opts['type'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19582
|
+
* Get a deployment identity resolution setting.
|
|
19583
|
+
*
|
|
19584
|
+
* @param {String} deploymentId The deployment ID
|
|
19585
|
+
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19586
|
+
*/},{key:"getWebdeploymentsDeploymentIdentityresolution",value:function getWebdeploymentsDeploymentIdentityresolution(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
19587
|
+
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentIdentityresolution';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}/identityresolution','GET',{'deploymentId':deploymentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19381
19588
|
* Get deployments
|
|
19382
19589
|
*
|
|
19383
19590
|
* @param {Object} opts Optional parameters
|
|
@@ -19421,10 +19628,18 @@ if(configurationVersion===undefined||configurationVersion===null){throw'Missing
|
|
|
19421
19628
|
* @param {Object} deployment
|
|
19422
19629
|
*/},{key:"putWebdeploymentsDeployment",value:function putWebdeploymentsDeployment(deploymentId,deployment){// verify the required parameter 'deploymentId' is set
|
|
19423
19630
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeployment';}// verify the required parameter 'deployment' is set
|
|
19424
|
-
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
19631
|
+
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19632
|
+
* Update identity resolution settings for a deployment.
|
|
19633
|
+
*
|
|
19634
|
+
* @param {String} deploymentId The deployment ID
|
|
19635
|
+
* @param {Object} body
|
|
19636
|
+
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19637
|
+
*/},{key:"putWebdeploymentsDeploymentIdentityresolution",value:function putWebdeploymentsDeploymentIdentityresolution(deploymentId,body){// verify the required parameter 'deploymentId' is set
|
|
19638
|
+
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeploymentIdentityresolution';}// verify the required parameter 'body' is set
|
|
19639
|
+
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(){/**
|
|
19425
19640
|
* WebMessaging service.
|
|
19426
19641
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
19427
|
-
* @version
|
|
19642
|
+
* @version 218.0.0
|
|
19428
19643
|
*//**
|
|
19429
19644
|
* Constructs a new WebMessagingApi.
|
|
19430
19645
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -19440,7 +19655,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
19440
19655
|
*/return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
19441
19656
|
* Widgets service.
|
|
19442
19657
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
19443
|
-
* @version
|
|
19658
|
+
* @version 218.0.0
|
|
19444
19659
|
*//**
|
|
19445
19660
|
* Constructs a new WidgetsApi.
|
|
19446
19661
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -19449,33 +19664,38 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
19449
19664
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
19450
19665
|
*/function WidgetsApi(apiClient){_classCallCheck(this,WidgetsApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
19451
19666
|
* Delete a Widget deployment
|
|
19452
|
-
*
|
|
19667
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19453
19668
|
* @param {String} deploymentId Widget Config Id
|
|
19669
|
+
* @deprecated
|
|
19454
19670
|
*/return _createClass(WidgetsApi,[{key:"deleteWidgetsDeployment",value:function deleteWidgetsDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
19455
19671
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling deleteWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','DELETE',{'deploymentId':deploymentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19456
19672
|
* Get a Widget deployment
|
|
19457
|
-
*
|
|
19673
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19458
19674
|
* @param {String} deploymentId Widget Config Id
|
|
19675
|
+
* @deprecated
|
|
19459
19676
|
*/},{key:"getWidgetsDeployment",value:function getWidgetsDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
19460
19677
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling getWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','GET',{'deploymentId':deploymentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19461
19678
|
* List Widget deployments
|
|
19462
|
-
*
|
|
19679
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19680
|
+
* @deprecated
|
|
19463
19681
|
*/},{key:"getWidgetsDeployments",value:function getWidgetsDeployments(){return this.apiClient.callApi('/api/v2/widgets/deployments','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19464
19682
|
* Create Widget deployment
|
|
19465
|
-
*
|
|
19683
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19466
19684
|
* @param {Object} body Deployment
|
|
19685
|
+
* @deprecated
|
|
19467
19686
|
*/},{key:"postWidgetsDeployments",value:function postWidgetsDeployments(body){// verify the required parameter 'body' is set
|
|
19468
19687
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWidgetsDeployments';}return this.apiClient.callApi('/api/v2/widgets/deployments','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19469
19688
|
* Update a Widget deployment
|
|
19470
|
-
*
|
|
19689
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
19471
19690
|
* @param {String} deploymentId Widget Config Id
|
|
19472
19691
|
* @param {Object} body Deployment
|
|
19692
|
+
* @deprecated
|
|
19473
19693
|
*/},{key:"putWidgetsDeployment",value:function putWidgetsDeployment(deploymentId,body){// verify the required parameter 'deploymentId' is set
|
|
19474
19694
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling putWidgetsDeployment';}// verify the required parameter 'body' is set
|
|
19475
19695
|
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(){/**
|
|
19476
19696
|
* WorkforceManagement service.
|
|
19477
19697
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
19478
|
-
* @version
|
|
19698
|
+
* @version 218.0.0
|
|
19479
19699
|
*//**
|
|
19480
19700
|
* Constructs a new WorkforceManagementApi.
|
|
19481
19701
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -21294,7 +21514,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
21294
21514
|
* </pre>
|
|
21295
21515
|
* </p>
|
|
21296
21516
|
* @module purecloud-platform-client-v2/index
|
|
21297
|
-
* @version
|
|
21517
|
+
* @version 218.0.0
|
|
21298
21518
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
21299
21519
|
* The ApiClient constructor.
|
|
21300
21520
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|