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
|
@@ -1992,10 +1992,11 @@ var $indexOf = callBindBasic([GetIntrinsic('%String.prototype.indexOf%')]);
|
|
|
1992
1992
|
|
|
1993
1993
|
/** @type {import('.')} */
|
|
1994
1994
|
module.exports = function callBoundIntrinsic(name, allowMissing) {
|
|
1995
|
-
|
|
1996
|
-
|
|
1995
|
+
/* eslint no-extra-parens: 0 */
|
|
1996
|
+
|
|
1997
|
+
var intrinsic = /** @type {(this: unknown, ...args: unknown[]) => unknown} */ (GetIntrinsic(name, !!allowMissing));
|
|
1997
1998
|
if (typeof intrinsic === 'function' && $indexOf(name, '.prototype.') > -1) {
|
|
1998
|
-
return callBindBasic([intrinsic]);
|
|
1999
|
+
return callBindBasic(/** @type {const} */ ([intrinsic]));
|
|
1999
2000
|
}
|
|
2000
2001
|
return intrinsic;
|
|
2001
2002
|
};
|
|
@@ -2282,6 +2283,7 @@ var INTRINSICS = {
|
|
|
2282
2283
|
'%Error%': $Error,
|
|
2283
2284
|
'%eval%': eval, // eslint-disable-line no-eval
|
|
2284
2285
|
'%EvalError%': $EvalError,
|
|
2286
|
+
'%Float16Array%': typeof Float16Array === 'undefined' ? undefined : Float16Array,
|
|
2285
2287
|
'%Float32Array%': typeof Float32Array === 'undefined' ? undefined : Float32Array,
|
|
2286
2288
|
'%Float64Array%': typeof Float64Array === 'undefined' ? undefined : Float64Array,
|
|
2287
2289
|
'%FinalizationRegistry%': typeof FinalizationRegistry === 'undefined' ? undefined : FinalizationRegistry,
|
|
@@ -5808,7 +5810,7 @@ return function(thing){return TypedArray&&thing instanceof TypedArray;};}(typeof
|
|
|
5808
5810
|
* Makes all methods read-only
|
|
5809
5811
|
* @param {Object} obj
|
|
5810
5812
|
*/var freezeMethods=function freezeMethods(obj){reduceDescriptors(obj,function(descriptor,name){// skip restricted props in strict mode
|
|
5811
|
-
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;}
|
|
5813
|
+
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;};/**
|
|
5812
5814
|
* If the thing is a FormData object, return true, otherwise return false.
|
|
5813
5815
|
*
|
|
5814
5816
|
* @param {unknown} thing - The thing to check.
|
|
@@ -5818,7 +5820,7 @@ if(isFunction(obj)&&['arguments','caller','callee'].indexOf(name)!==-1){return f
|
|
|
5818
5820
|
// https://github.com/DigitalBrainJS/AxiosPromise/blob/16deab13710ec09779922131f3fa5954320f83ab/lib/utils.js#L11-L34
|
|
5819
5821
|
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;// *********************
|
|
5820
5822
|
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
|
|
5821
|
-
reduceDescriptors:reduceDescriptors,freezeMethods:freezeMethods,toObjectSet:toObjectSet,toCamelCase:toCamelCase,noop:noop,toFiniteNumber:toFiniteNumber,findKey:findKey,global:_global,isContextDefined:isContextDefined,
|
|
5823
|
+
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)
|
|
5822
5824
|
// if there are two placeholders, than the two characters before it
|
|
5823
5825
|
// represent one byte
|
|
5824
5826
|
// if there is only one, then the three characters before it represent 2 bytes
|
|
@@ -6245,7 +6247,7 @@ return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);}/**
|
|
|
6245
6247
|
* @param {string} requestedURL Absolute or relative URL to combine
|
|
6246
6248
|
*
|
|
6247
6249
|
* @returns {string} The combined full path
|
|
6248
|
-
*/function buildFullPath(baseURL,requestedURL){if(baseURL
|
|
6250
|
+
*/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;};/**
|
|
6249
6251
|
* Config-specific merge-function which creates a new config-object
|
|
6250
6252
|
* by merging two configuration objects together.
|
|
6251
6253
|
*
|
|
@@ -6258,7 +6260,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,prop,cas
|
|
|
6258
6260
|
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
|
|
6259
6261
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
6260
6262
|
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
|
|
6261
|
-
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
|
|
6263
|
+
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
|
|
6262
6264
|
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
|
|
6263
6265
|
}else if((contentType=headers.getContentType())!==false){// fix semicolon duplication issue for ReactNative FormData implementation
|
|
6264
6266
|
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
|
|
@@ -6314,7 +6316,7 @@ isCredentialsSupported="credentials"in Request.prototype;request=new Request(url
|
|
|
6314
6316
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
6315
6317
|
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
|
|
6316
6318
|
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
|
|
6317
|
-
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.
|
|
6319
|
+
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
|
|
6318
6320
|
['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={};/**
|
|
6319
6321
|
* Transitional option validator
|
|
6320
6322
|
*
|
|
@@ -6351,10 +6353,11 @@ console.warn("".concat(opt," is likely a misspelling of ").concat(correctSpellin
|
|
|
6351
6353
|
stack=dummy.stack?dummy.stack.replace(/^.+\n/,''):'';try{if(!_context9.t0.stack){_context9.t0.stack=stack;// match without the 2 top stack lines
|
|
6352
6354
|
}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
|
|
6353
6355
|
}}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
|
|
6354
|
-
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);}}
|
|
6356
|
+
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
|
|
6357
|
+
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
|
|
6355
6358
|
config.method=(config.method||this.defaults.method||'get').toLowerCase();// Flatten headers
|
|
6356
6359
|
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
|
|
6357
|
-
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
|
|
6360
|
+
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
|
|
6358
6361
|
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;/**
|
|
6359
6362
|
* A `CancelToken` is an object that can be used to request cancellation of an operation.
|
|
6360
6363
|
*
|
|
@@ -6455,7 +6458,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6455
6458
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6456
6459
|
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];}}}]);}();/**
|
|
6457
6460
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6458
|
-
* @version
|
|
6461
|
+
* @version 218.0.0
|
|
6459
6462
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6460
6463
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6461
6464
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6798,7 +6801,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6798
6801
|
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(){/**
|
|
6799
6802
|
* AgentAssistants service.
|
|
6800
6803
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6801
|
-
* @version
|
|
6804
|
+
* @version 218.0.0
|
|
6802
6805
|
*//**
|
|
6803
6806
|
* Constructs a new AgentAssistantsApi.
|
|
6804
6807
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6899,7 +6902,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6899
6902
|
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(){/**
|
|
6900
6903
|
* AgentCopilot service.
|
|
6901
6904
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6902
|
-
* @version
|
|
6905
|
+
* @version 218.0.0
|
|
6903
6906
|
*//**
|
|
6904
6907
|
* Constructs a new AgentCopilotApi.
|
|
6905
6908
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6921,7 +6924,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6921
6924
|
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(){/**
|
|
6922
6925
|
* AgentUI service.
|
|
6923
6926
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6924
|
-
* @version
|
|
6927
|
+
* @version 218.0.0
|
|
6925
6928
|
*//**
|
|
6926
6929
|
* Constructs a new AgentUIApi.
|
|
6927
6930
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6955,7 +6958,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6955
6958
|
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(){/**
|
|
6956
6959
|
* Alerting service.
|
|
6957
6960
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6958
|
-
* @version
|
|
6961
|
+
* @version 218.0.0
|
|
6959
6962
|
*//**
|
|
6960
6963
|
* Constructs a new AlertingApi.
|
|
6961
6964
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6971,18 +6974,6 @@ if(alertId===undefined||alertId===null){throw'Missing the required parameter "al
|
|
|
6971
6974
|
* Delete all alerts for the user
|
|
6972
6975
|
*
|
|
6973
6976
|
*/},{key:"deleteAlertingAlertsAll",value:function deleteAlertingAlertsAll(){return this.apiClient.callApi('/api/v2/alerting/alerts/all','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6974
|
-
* Delete an interaction stats alert
|
|
6975
|
-
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
6976
|
-
* @param {String} alertId Alert ID
|
|
6977
|
-
* @deprecated
|
|
6978
|
-
*/},{key:"deleteAlertingInteractionstatsAlert",value:function deleteAlertingInteractionstatsAlert(alertId){// verify the required parameter 'alertId' is set
|
|
6979
|
-
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']);}/**
|
|
6980
|
-
* Delete an interaction stats rule
|
|
6981
|
-
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
6982
|
-
* @param {String} ruleId Rule ID
|
|
6983
|
-
* @deprecated
|
|
6984
|
-
*/},{key:"deleteAlertingInteractionstatsRule",value:function deleteAlertingInteractionstatsRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
6985
|
-
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']);}/**
|
|
6986
6977
|
* Delete a rule.
|
|
6987
6978
|
*
|
|
6988
6979
|
* @param {String} ruleId Rule Id
|
|
@@ -6993,42 +6984,6 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6993
6984
|
* @param {String} alertId Alert ID
|
|
6994
6985
|
*/},{key:"getAlertingAlert",value:function getAlertingAlert(alertId){// verify the required parameter 'alertId' is set
|
|
6995
6986
|
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']);}/**
|
|
6996
|
-
* Gets active alert count for a user
|
|
6997
|
-
* 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.
|
|
6998
|
-
* @deprecated
|
|
6999
|
-
*/},{key:"getAlertingAlertsActive",value:function getAlertingAlertsActive(){return this.apiClient.callApi('/api/v2/alerting/alerts/active','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7000
|
-
* Get an interaction stats alert
|
|
7001
|
-
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
7002
|
-
* @param {String} alertId Alert ID
|
|
7003
|
-
* @param {Object} opts Optional parameters
|
|
7004
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7005
|
-
* @deprecated
|
|
7006
|
-
*/},{key:"getAlertingInteractionstatsAlert",value:function getAlertingInteractionstatsAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
7007
|
-
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']);}/**
|
|
7008
|
-
* Get interaction stats alert list
|
|
7009
|
-
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
7010
|
-
* @param {Object} opts Optional parameters
|
|
7011
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7012
|
-
* @deprecated
|
|
7013
|
-
*/},{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']);}/**
|
|
7014
|
-
* Gets user unread count of interaction stats alerts
|
|
7015
|
-
* 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.
|
|
7016
|
-
* @deprecated
|
|
7017
|
-
*/},{key:"getAlertingInteractionstatsAlertsUnread",value:function getAlertingInteractionstatsAlertsUnread(){return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/unread','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7018
|
-
* Get an interaction stats rule
|
|
7019
|
-
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
7020
|
-
* @param {String} ruleId Rule ID
|
|
7021
|
-
* @param {Object} opts Optional parameters
|
|
7022
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7023
|
-
* @deprecated
|
|
7024
|
-
*/},{key:"getAlertingInteractionstatsRule",value:function getAlertingInteractionstatsRule(ruleId,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
7025
|
-
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']);}/**
|
|
7026
|
-
* Get an interaction stats rule list
|
|
7027
|
-
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
7028
|
-
* @param {Object} opts Optional parameters
|
|
7029
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7030
|
-
* @deprecated
|
|
7031
|
-
*/},{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']);}/**
|
|
7032
6987
|
* Get a rule.
|
|
7033
6988
|
*
|
|
7034
6989
|
* @param {String} ruleId Rule Id
|
|
@@ -7061,14 +7016,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7061
7016
|
* @param {Object} opts Optional parameters
|
|
7062
7017
|
* @param {Object} opts.body
|
|
7063
7018
|
*/},{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']);}/**
|
|
7064
|
-
* Create an interaction stats rule
|
|
7065
|
-
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
7066
|
-
* @param {Object} body AlertingRule
|
|
7067
|
-
* @param {Object} opts Optional parameters
|
|
7068
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7069
|
-
* @deprecated
|
|
7070
|
-
*/},{key:"postAlertingInteractionstatsRules",value:function postAlertingInteractionstatsRules(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
7071
|
-
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']);}/**
|
|
7072
7019
|
* Create a Rule.
|
|
7073
7020
|
*
|
|
7074
7021
|
* @param {Object} body rule to be created
|
|
@@ -7091,26 +7038,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7091
7038
|
* @param {Object} opts.body
|
|
7092
7039
|
*/},{key:"putAlertingAlert",value:function putAlertingAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
7093
7040
|
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']);}/**
|
|
7094
|
-
* Update an interaction stats alert read status
|
|
7095
|
-
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
7096
|
-
* @param {String} alertId Alert ID
|
|
7097
|
-
* @param {Object} body InteractionStatsAlert
|
|
7098
|
-
* @param {Object} opts Optional parameters
|
|
7099
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7100
|
-
* @deprecated
|
|
7101
|
-
*/},{key:"putAlertingInteractionstatsAlert",value:function putAlertingInteractionstatsAlert(alertId,body,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
7102
|
-
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';}// verify the required parameter 'body' is set
|
|
7103
|
-
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']);}/**
|
|
7104
|
-
* Update an interaction stats rule
|
|
7105
|
-
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
7106
|
-
* @param {String} ruleId Rule ID
|
|
7107
|
-
* @param {Object} body AlertingRule
|
|
7108
|
-
* @param {Object} opts Optional parameters
|
|
7109
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
7110
|
-
* @deprecated
|
|
7111
|
-
*/},{key:"putAlertingInteractionstatsRule",value:function putAlertingInteractionstatsRule(ruleId,body,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
7112
|
-
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';}// verify the required parameter 'body' is set
|
|
7113
|
-
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']);}/**
|
|
7114
7041
|
* Update a rule
|
|
7115
7042
|
*
|
|
7116
7043
|
* @param {String} ruleId Rule Id
|
|
@@ -7120,7 +7047,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
7120
7047
|
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(){/**
|
|
7121
7048
|
* Analytics service.
|
|
7122
7049
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7123
|
-
* @version
|
|
7050
|
+
* @version 218.0.0
|
|
7124
7051
|
*//**
|
|
7125
7052
|
* Constructs a new AnalyticsApi.
|
|
7126
7053
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7350,7 +7277,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7350
7277
|
* @param {Number} opts.pageSize (default to 25)
|
|
7351
7278
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
7352
7279
|
* @param {Object} opts.state Only list users of this state
|
|
7353
|
-
* @param {Boolean} opts.deletedOnly Only list deleted dashboards
|
|
7280
|
+
* @param {Boolean} opts.deletedOnly Only list users with deleted dashboards
|
|
7354
7281
|
*/},{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']);}/**
|
|
7355
7282
|
* Get all view export requests for a user
|
|
7356
7283
|
*
|
|
@@ -7791,7 +7718,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7791
7718
|
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(){/**
|
|
7792
7719
|
* Architect service.
|
|
7793
7720
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7794
|
-
* @version
|
|
7721
|
+
* @version 218.0.0
|
|
7795
7722
|
*//**
|
|
7796
7723
|
* Constructs a new ArchitectApi.
|
|
7797
7724
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8059,6 +7986,12 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
8059
7986
|
* @param {String} ivrId IVR id
|
|
8060
7987
|
*/},{key:"getArchitectIvr",value:function getArchitectIvr(ivrId){// verify the required parameter 'ivrId' is set
|
|
8061
7988
|
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']);}/**
|
|
7989
|
+
* Get an IVR IdentityResolutionConfig.
|
|
7990
|
+
*
|
|
7991
|
+
* @param {String} ivrId IVR id
|
|
7992
|
+
* getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7993
|
+
*/},{key:"getArchitectIvrIdentityresolution",value:function getArchitectIvrIdentityresolution(ivrId){// verify the required parameter 'ivrId' is set
|
|
7994
|
+
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']);}/**
|
|
8062
7995
|
* Get IVR configs.
|
|
8063
7996
|
*
|
|
8064
7997
|
* @param {Object} opts Optional parameters
|
|
@@ -8453,6 +8386,13 @@ if(datatableId===undefined||datatableId===null){throw'Missing the required param
|
|
|
8453
8386
|
* @param {String} flowExecutionId flow execution ID
|
|
8454
8387
|
*/},{key:"getFlowsExecution",value:function getFlowsExecution(flowExecutionId){// verify the required parameter 'flowExecutionId' is set
|
|
8455
8388
|
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']);}/**
|
|
8389
|
+
* Fetch Architect Export Job Status
|
|
8390
|
+
*
|
|
8391
|
+
* @param {String} jobId Job ID
|
|
8392
|
+
* @param {Object} opts Optional parameters
|
|
8393
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
8394
|
+
*/},{key:"getFlowsExportJob",value:function getFlowsExportJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8395
|
+
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']);}/**
|
|
8456
8396
|
* Start a process (job) to prepare a download of a singular flow execution data instance by Id
|
|
8457
8397
|
* 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.
|
|
8458
8398
|
* @param {String} instanceId Instance ID
|
|
@@ -8745,6 +8685,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8745
8685
|
* @param {Object} flowLaunchRequest
|
|
8746
8686
|
*/},{key:"postFlowsExecutions",value:function postFlowsExecutions(flowLaunchRequest){// verify the required parameter 'flowLaunchRequest' is set
|
|
8747
8687
|
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']);}/**
|
|
8688
|
+
* Register Architect Export Job
|
|
8689
|
+
*
|
|
8690
|
+
* @param {Object} body
|
|
8691
|
+
*/},{key:"postFlowsExportJobs",value:function postFlowsExportJobs(body){// verify the required parameter 'body' is set
|
|
8692
|
+
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']);}/**
|
|
8748
8693
|
* Start a process (job) that will prepare a list of execution data IDs for download.
|
|
8749
8694
|
* 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.
|
|
8750
8695
|
* @param {Object} body Requested Flow Ids
|
|
@@ -8787,6 +8732,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8787
8732
|
*/},{key:"putArchitectIvr",value:function putArchitectIvr(ivrId,body){// verify the required parameter 'ivrId' is set
|
|
8788
8733
|
if(ivrId===undefined||ivrId===null){throw'Missing the required parameter "ivrId" when calling putArchitectIvr';}// verify the required parameter 'body' is set
|
|
8789
8734
|
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']);}/**
|
|
8735
|
+
* Update an IVR IdentityResolutionConfig.
|
|
8736
|
+
*
|
|
8737
|
+
* @param {String} ivrId IVR id
|
|
8738
|
+
* @param {Object} body
|
|
8739
|
+
* putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8740
|
+
*/},{key:"putArchitectIvrIdentityresolution",value:function putArchitectIvrIdentityresolution(ivrId,body){// verify the required parameter 'ivrId' is set
|
|
8741
|
+
if(ivrId===undefined||ivrId===null){throw'Missing the required parameter "ivrId" when calling putArchitectIvrIdentityresolution';}// verify the required parameter 'body' is set
|
|
8742
|
+
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']);}/**
|
|
8790
8743
|
* Update specified user prompt
|
|
8791
8744
|
*
|
|
8792
8745
|
* @param {String} promptId Prompt ID
|
|
@@ -8883,7 +8836,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8883
8836
|
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(){/**
|
|
8884
8837
|
* Audit service.
|
|
8885
8838
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8886
|
-
* @version
|
|
8839
|
+
* @version 218.0.0
|
|
8887
8840
|
*//**
|
|
8888
8841
|
* Constructs a new AuditApi.
|
|
8889
8842
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8933,7 +8886,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8933
8886
|
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(){/**
|
|
8934
8887
|
* Authorization service.
|
|
8935
8888
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8936
|
-
* @version
|
|
8889
|
+
* @version 218.0.0
|
|
8937
8890
|
*//**
|
|
8938
8891
|
* Constructs a new AuthorizationApi.
|
|
8939
8892
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8945,7 +8898,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8945
8898
|
*
|
|
8946
8899
|
* @param {String} divisionId Division ID
|
|
8947
8900
|
* @param {Object} opts Optional parameters
|
|
8948
|
-
* @param {Boolean} opts.force Force delete this division
|
|
8901
|
+
* @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)
|
|
8949
8902
|
*/return _createClass(AuthorizationApi,[{key:"deleteAuthorizationDivision",value:function deleteAuthorizationDivision(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
8950
8903
|
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']);}/**
|
|
8951
8904
|
* Delete an access control policy
|
|
@@ -9193,10 +9146,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9193
9146
|
* Recreate a previously deleted division.
|
|
9194
9147
|
*
|
|
9195
9148
|
* @param {String} divisionId Division ID
|
|
9196
|
-
* @param {Object}
|
|
9197
|
-
|
|
9198
|
-
|
|
9199
|
-
if(
|
|
9149
|
+
* @param {Object} body Recreated division data
|
|
9150
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,body){// verify the required parameter 'divisionId' is set
|
|
9151
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';}// verify the required parameter 'body' is set
|
|
9152
|
+
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']);}/**
|
|
9200
9153
|
* Create a division.
|
|
9201
9154
|
*
|
|
9202
9155
|
* @param {Object} body Division
|
|
@@ -9353,7 +9306,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
9353
9306
|
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(){/**
|
|
9354
9307
|
* Billing service.
|
|
9355
9308
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9356
|
-
* @version
|
|
9309
|
+
* @version 218.0.0
|
|
9357
9310
|
*//**
|
|
9358
9311
|
* Constructs a new BillingApi.
|
|
9359
9312
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -9377,7 +9330,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
9377
9330
|
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(){/**
|
|
9378
9331
|
* CarrierServices service.
|
|
9379
9332
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9380
|
-
* @version
|
|
9333
|
+
* @version 218.0.0
|
|
9381
9334
|
*//**
|
|
9382
9335
|
* Constructs a new CarrierServicesApi.
|
|
9383
9336
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -9397,7 +9350,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
9397
9350
|
*/},{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(){/**
|
|
9398
9351
|
* Chat service.
|
|
9399
9352
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9400
|
-
* @version
|
|
9353
|
+
* @version 218.0.0
|
|
9401
9354
|
*//**
|
|
9402
9355
|
* Constructs a new ChatApi.
|
|
9403
9356
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9437,7 +9390,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
9437
9390
|
*
|
|
9438
9391
|
* @param {String} userId userId
|
|
9439
9392
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
9440
|
-
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9441
9393
|
*/},{key:"deleteChatsUserMessagesPin",value:function deleteChatsUserMessagesPin(userId,pinnedMessageId){// verify the required parameter 'userId' is set
|
|
9442
9394
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';}// verify the required parameter 'pinnedMessageId' is set
|
|
9443
9395
|
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']);}/**
|
|
@@ -9494,7 +9446,6 @@ if(threadId===undefined||threadId===null){throw'Missing the required parameter "
|
|
|
9494
9446
|
* Get information for a 1on1
|
|
9495
9447
|
*
|
|
9496
9448
|
* @param {String} userId userId
|
|
9497
|
-
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9498
9449
|
*/},{key:"getChatsUser",value:function getChatsUser(userId){// verify the required parameter 'userId' is set
|
|
9499
9450
|
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']);}/**
|
|
9500
9451
|
* Get messages by id(s) from a 1on1
|
|
@@ -9516,12 +9467,10 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9516
9467
|
* Get a user's chat settings
|
|
9517
9468
|
*
|
|
9518
9469
|
* @param {String} userId User ID
|
|
9519
|
-
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9520
9470
|
*/},{key:"getChatsUserSettings",value:function getChatsUserSettings(userId){// verify the required parameter 'userId' is set
|
|
9521
9471
|
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']);}/**
|
|
9522
9472
|
* Get a user's chat settings
|
|
9523
9473
|
*
|
|
9524
|
-
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9525
9474
|
*/},{key:"getChatsUsersMeSettings",value:function getChatsUsersMeSettings(){return this.apiClient.callApi('/api/v2/chats/users/me/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9526
9475
|
* Set properties for a room
|
|
9527
9476
|
*
|
|
@@ -9557,14 +9506,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9557
9506
|
*
|
|
9558
9507
|
* @param {String} userId User ID
|
|
9559
9508
|
* @param {Object} body
|
|
9560
|
-
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9561
9509
|
*/},{key:"patchChatsUserSettings",value:function patchChatsUserSettings(userId,body){// verify the required parameter 'userId' is set
|
|
9562
9510
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserSettings';}// verify the required parameter 'body' is set
|
|
9563
9511
|
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']);}/**
|
|
9564
9512
|
* Update a user's chat settings
|
|
9565
9513
|
*
|
|
9566
9514
|
* @param {Object} body
|
|
9567
|
-
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9568
9515
|
*/},{key:"patchChatsUsersMeSettings",value:function patchChatsUsersMeSettings(body){// verify the required parameter 'body' is set
|
|
9569
9516
|
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']);}/**
|
|
9570
9517
|
* Send a message to a room
|
|
@@ -9604,7 +9551,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9604
9551
|
*
|
|
9605
9552
|
* @param {String} userId userId
|
|
9606
9553
|
* @param {Object} body Pinned Message Ids
|
|
9607
|
-
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9608
9554
|
*/},{key:"postChatsUserMessagesPins",value:function postChatsUserMessagesPins(userId,body){// verify the required parameter 'userId' is set
|
|
9609
9555
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessagesPins';}// verify the required parameter 'body' is set
|
|
9610
9556
|
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']);}/**
|
|
@@ -9622,7 +9568,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9622
9568
|
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(){/**
|
|
9623
9569
|
* Coaching service.
|
|
9624
9570
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9625
|
-
* @version
|
|
9571
|
+
* @version 218.0.0
|
|
9626
9572
|
*//**
|
|
9627
9573
|
* Constructs a new CoachingApi.
|
|
9628
9574
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9775,7 +9721,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9775
9721
|
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(){/**
|
|
9776
9722
|
* ContentManagement service.
|
|
9777
9723
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9778
|
-
* @version
|
|
9724
|
+
* @version 218.0.0
|
|
9779
9725
|
*//**
|
|
9780
9726
|
* Constructs a new ContentManagementApi.
|
|
9781
9727
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -10057,7 +10003,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
10057
10003
|
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(){/**
|
|
10058
10004
|
* Conversations service.
|
|
10059
10005
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10060
|
-
* @version
|
|
10006
|
+
* @version 218.0.0
|
|
10061
10007
|
*//**
|
|
10062
10008
|
* Constructs a new ConversationsApi.
|
|
10063
10009
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10120,6 +10066,11 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
10120
10066
|
* @param {String} integrationId Integration ID
|
|
10121
10067
|
*/},{key:"deleteConversationsMessagingIntegrationsOpenIntegrationId",value:function deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10122
10068
|
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']);}/**
|
|
10069
|
+
* Delete Twitter messaging integration
|
|
10070
|
+
*
|
|
10071
|
+
* @param {String} integrationId Integration ID
|
|
10072
|
+
*/},{key:"deleteConversationsMessagingIntegrationsTwitterIntegrationId",value:function deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10073
|
+
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']);}/**
|
|
10123
10074
|
* Delete a WhatsApp messaging integration
|
|
10124
10075
|
*
|
|
10125
10076
|
* @param {String} integrationId Integration ID
|
|
@@ -10569,6 +10520,29 @@ if(cachedMediaItemId===undefined||cachedMediaItemId===null){throw'Missing the re
|
|
|
10569
10520
|
* Get a list of Facebook Permissions
|
|
10570
10521
|
*
|
|
10571
10522
|
*/},{key:"getConversationsMessagingFacebookPermissions",value:function getConversationsMessagingFacebookPermissions(){return this.apiClient.callApi('/api/v2/conversations/messaging/facebook/permissions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10523
|
+
* Get Facebook messaging integration identity resolution settings
|
|
10524
|
+
*
|
|
10525
|
+
* @param {String} integrationId Integration ID
|
|
10526
|
+
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10527
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10528
|
+
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']);}/**
|
|
10529
|
+
* Get an open messaging integration Identity Resolution settings
|
|
10530
|
+
*
|
|
10531
|
+
* @param {String} integrationId Integration ID
|
|
10532
|
+
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10533
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10534
|
+
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']);}/**
|
|
10535
|
+
* Get a whatsApp integration Identity Resolution settings
|
|
10536
|
+
*
|
|
10537
|
+
* @param {String} integrationId Integration ID
|
|
10538
|
+
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10539
|
+
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10540
|
+
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']);}/**
|
|
10541
|
+
* Get twitter oauth settings to patch an integration
|
|
10542
|
+
*
|
|
10543
|
+
* @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
|
|
10544
|
+
*/},{key:"getConversationsMessagingIntegrationTwitterOauthSettings",value:function getConversationsMessagingIntegrationTwitterOauthSettings(integrationId){// verify the required parameter 'integrationId' is set
|
|
10545
|
+
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']);}/**
|
|
10572
10546
|
* Get a list of Integrations
|
|
10573
10547
|
*
|
|
10574
10548
|
* @param {Object} opts Optional parameters
|
|
@@ -10626,6 +10600,25 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
10626
10600
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
10627
10601
|
*/},{key:"getConversationsMessagingIntegrationsOpenIntegrationId",value:function getConversationsMessagingIntegrationsOpenIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
10628
10602
|
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']);}/**
|
|
10603
|
+
* Get a list of Twitter Integrations
|
|
10604
|
+
*
|
|
10605
|
+
* @param {Object} opts Optional parameters
|
|
10606
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10607
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10608
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
10609
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
10610
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
10611
|
+
*/},{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']);}/**
|
|
10612
|
+
* Get Twitter messaging integration
|
|
10613
|
+
*
|
|
10614
|
+
* @param {String} integrationId Integration ID
|
|
10615
|
+
* @param {Object} opts Optional parameters
|
|
10616
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
10617
|
+
*/},{key:"getConversationsMessagingIntegrationsTwitterIntegrationId",value:function getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
10618
|
+
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']);}/**
|
|
10619
|
+
* Get twitter oauth settings
|
|
10620
|
+
*
|
|
10621
|
+
*/},{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']);}/**
|
|
10629
10622
|
* Get a list of WhatsApp Integrations
|
|
10630
10623
|
*
|
|
10631
10624
|
* @param {Object} opts Optional parameters
|
|
@@ -11042,6 +11035,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11042
11035
|
*/},{key:"patchConversationsMessagingIntegrationsOpenIntegrationId",value:function patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
11043
11036
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
11044
11037
|
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']);}/**
|
|
11038
|
+
* Update a Twitter messaging integration
|
|
11039
|
+
*
|
|
11040
|
+
* @param {String} integrationId Integration ID
|
|
11041
|
+
* @param {Object} body TwitterIntegrationUpdateRequest
|
|
11042
|
+
*/},{key:"patchConversationsMessagingIntegrationsTwitterIntegrationId",value:function patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
11043
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}// verify the required parameter 'body' is set
|
|
11044
|
+
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']);}/**
|
|
11045
11045
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
11046
11046
|
* 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
|
|
11047
11047
|
* @param {String} integrationId Integration ID
|
|
@@ -11610,6 +11610,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11610
11610
|
* @param {Object} body OpenIntegrationRequest
|
|
11611
11611
|
*/},{key:"postConversationsMessagingIntegrationsOpen",value:function postConversationsMessagingIntegrationsOpen(body){// verify the required parameter 'body' is set
|
|
11612
11612
|
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']);}/**
|
|
11613
|
+
* Create Twitter Integration
|
|
11614
|
+
*
|
|
11615
|
+
* @param {Object} body TwitterIntegrationRequest
|
|
11616
|
+
*/},{key:"postConversationsMessagingIntegrationsTwitter",value:function postConversationsMessagingIntegrationsTwitter(body){// verify the required parameter 'body' is set
|
|
11617
|
+
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']);}/**
|
|
11613
11618
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
11614
11619
|
* [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.
|
|
11615
11620
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
@@ -11659,6 +11664,14 @@ if(communicationId===undefined||communicationId===null){throw'Missing the requir
|
|
|
11659
11664
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
11660
11665
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
11661
11666
|
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']);}/**
|
|
11667
|
+
* Create an Agent-Type video conference and assign an agent to it
|
|
11668
|
+
*
|
|
11669
|
+
* @param {String} conversationId conversationId
|
|
11670
|
+
* @param {String} communicationId communicationId
|
|
11671
|
+
* postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11672
|
+
*/},{key:"postConversationsVideoAgentconferenceCommunication",value:function postConversationsVideoAgentconferenceCommunication(conversationId,communicationId){// verify the required parameter 'conversationId' is set
|
|
11673
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';}// verify the required parameter 'communicationId' is set
|
|
11674
|
+
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']);}/**
|
|
11662
11675
|
* Apply wrap-up for this conversation communication
|
|
11663
11676
|
*
|
|
11664
11677
|
* @param {String} conversationId conversationId
|
|
@@ -11731,9 +11744,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11731
11744
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';}// verify the required parameter 'body' is set
|
|
11732
11745
|
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']);}/**
|
|
11733
11746
|
* Update a conversation by setting its recording state
|
|
11734
|
-
*
|
|
11747
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
11735
11748
|
* @param {String} conversationId conversationId
|
|
11736
11749
|
* @param {Object} body SetRecordingState
|
|
11750
|
+
* @deprecated
|
|
11737
11751
|
*/},{key:"putConversationsCobrowsesessionRecordingstate",value:function putConversationsCobrowsesessionRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
11738
11752
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';}// verify the required parameter 'body' is set
|
|
11739
11753
|
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']);}/**
|
|
@@ -11765,6 +11779,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11765
11779
|
*/},{key:"putConversationsMessageRecordingstate",value:function putConversationsMessageRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
11766
11780
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';}// verify the required parameter 'body' is set
|
|
11767
11781
|
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']);}/**
|
|
11782
|
+
* Create an identity resolution settings for a Facebook messaging integration
|
|
11783
|
+
*
|
|
11784
|
+
* @param {String} integrationId Integration ID
|
|
11785
|
+
* @param {Object} body IdentityResolutionConfig
|
|
11786
|
+
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11787
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
11788
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';}// verify the required parameter 'body' is set
|
|
11789
|
+
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']);}/**
|
|
11790
|
+
* Update an open messaging integration Identity Resolution settings
|
|
11791
|
+
*
|
|
11792
|
+
* @param {String} integrationId Integration ID
|
|
11793
|
+
* @param {Object} body
|
|
11794
|
+
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11795
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
11796
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
11797
|
+
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']);}/**
|
|
11798
|
+
* Update a whatsApp integration Identity Resolution settings
|
|
11799
|
+
*
|
|
11800
|
+
* @param {String} integrationId Integration ID
|
|
11801
|
+
* @param {Object} body
|
|
11802
|
+
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11803
|
+
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
11804
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';}// verify the required parameter 'body' is set
|
|
11805
|
+
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']);}/**
|
|
11768
11806
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
11769
11807
|
* 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.
|
|
11770
11808
|
* @param {Object} body MessagingSetting
|
|
@@ -11804,7 +11842,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11804
11842
|
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(){/**
|
|
11805
11843
|
* DataExtensions service.
|
|
11806
11844
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11807
|
-
* @version
|
|
11845
|
+
* @version 218.0.0
|
|
11808
11846
|
*//**
|
|
11809
11847
|
* Constructs a new DataExtensionsApi.
|
|
11810
11848
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11825,7 +11863,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11825
11863
|
*/},{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(){/**
|
|
11826
11864
|
* DataPrivacy service.
|
|
11827
11865
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
11828
|
-
* @version
|
|
11866
|
+
* @version 218.0.0
|
|
11829
11867
|
*//**
|
|
11830
11868
|
* Constructs a new DataPrivacyApi.
|
|
11831
11869
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -11865,7 +11903,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11865
11903
|
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(){/**
|
|
11866
11904
|
* Downloads service.
|
|
11867
11905
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11868
|
-
* @version
|
|
11906
|
+
* @version 218.0.0
|
|
11869
11907
|
*//**
|
|
11870
11908
|
* Constructs a new DownloadsApi.
|
|
11871
11909
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11884,7 +11922,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11884
11922
|
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(){/**
|
|
11885
11923
|
* Emails service.
|
|
11886
11924
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11887
|
-
* @version
|
|
11925
|
+
* @version 218.0.0
|
|
11888
11926
|
*//**
|
|
11889
11927
|
* Constructs a new EmailsApi.
|
|
11890
11928
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11902,7 +11940,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11902
11940
|
*/},{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(){/**
|
|
11903
11941
|
* EmployeeEngagement service.
|
|
11904
11942
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11905
|
-
* @version
|
|
11943
|
+
* @version 218.0.0
|
|
11906
11944
|
*//**
|
|
11907
11945
|
* Constructs a new EmployeeEngagementApi.
|
|
11908
11946
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11940,7 +11978,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11940
11978
|
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(){/**
|
|
11941
11979
|
* Events service.
|
|
11942
11980
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11943
|
-
* @version
|
|
11981
|
+
* @version 218.0.0
|
|
11944
11982
|
*//**
|
|
11945
11983
|
* Constructs a new EventsApi.
|
|
11946
11984
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11965,7 +12003,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11965
12003
|
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(){/**
|
|
11966
12004
|
* ExternalContacts service.
|
|
11967
12005
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11968
|
-
* @version
|
|
12006
|
+
* @version 218.0.0
|
|
11969
12007
|
*//**
|
|
11970
12008
|
* Constructs a new ExternalContactsApi.
|
|
11971
12009
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -12082,7 +12120,20 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
12082
12120
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
12083
12121
|
* @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
|
|
12084
12122
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
12085
|
-
|
|
12123
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
12124
|
+
*/},{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']);}/**
|
|
12125
|
+
* Get export for exportId
|
|
12126
|
+
*
|
|
12127
|
+
* @param {String} exportId Export id
|
|
12128
|
+
*/},{key:"getExternalcontactsContactsExport",value:function getExternalcontactsContactsExport(exportId){// verify the required parameter 'exportId' is set
|
|
12129
|
+
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']);}/**
|
|
12130
|
+
* List exports for organization
|
|
12131
|
+
*
|
|
12132
|
+
* @param {Object} opts Optional parameters
|
|
12133
|
+
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
12134
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
12135
|
+
* @param {Number} opts.pageSize Number of entities to return
|
|
12136
|
+
*/},{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']);}/**
|
|
12086
12137
|
* Get a schema
|
|
12087
12138
|
*
|
|
12088
12139
|
* @param {String} schemaId Schema ID
|
|
@@ -12225,7 +12276,8 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
12225
12276
|
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
12226
12277
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
12227
12278
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
12228
|
-
|
|
12279
|
+
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
12280
|
+
*/},{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']);}/**
|
|
12229
12281
|
* Get a schema
|
|
12230
12282
|
*
|
|
12231
12283
|
* @param {String} schemaId Schema ID
|
|
@@ -12258,32 +12310,65 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
12258
12310
|
* @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
|
|
12259
12311
|
* @param {Object} opts Optional parameters
|
|
12260
12312
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
12313
|
+
* @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
|
|
12261
12314
|
*/},{key:"getExternalcontactsReversewhitepageslookup",value:function getExternalcontactsReversewhitepageslookup(lookupVal,opts){opts=opts||{};// verify the required parameter 'lookupVal' is set
|
|
12262
|
-
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']);}/**
|
|
12315
|
+
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']);}/**
|
|
12316
|
+
* Scan for external contacts using paging
|
|
12317
|
+
*
|
|
12318
|
+
* @param {Object} opts Optional parameters
|
|
12319
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
12320
|
+
* @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
|
|
12321
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
12322
|
+
*/},{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']);}/**
|
|
12263
12323
|
* Scan for external contacts using paging
|
|
12264
12324
|
*
|
|
12265
12325
|
* @param {Object} opts Optional parameters
|
|
12266
12326
|
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
12267
12327
|
* @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
|
|
12268
|
-
|
|
12328
|
+
* getExternalcontactsScanContactsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12329
|
+
*/},{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']);}/**
|
|
12269
12330
|
* Scan for notes using paging
|
|
12270
12331
|
*
|
|
12271
12332
|
* @param {Object} opts Optional parameters
|
|
12272
12333
|
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
12273
12334
|
* @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
|
|
12274
|
-
|
|
12335
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
12336
|
+
*/},{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']);}/**
|
|
12337
|
+
* Scan for notes using paging
|
|
12338
|
+
*
|
|
12339
|
+
* @param {Object} opts Optional parameters
|
|
12340
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
12341
|
+
* @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
|
|
12342
|
+
* getExternalcontactsScanNotesDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12343
|
+
*/},{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']);}/**
|
|
12344
|
+
* Scan for external organizations using paging
|
|
12345
|
+
*
|
|
12346
|
+
* @param {Object} opts Optional parameters
|
|
12347
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
12348
|
+
* @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
|
|
12349
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
12350
|
+
*/},{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']);}/**
|
|
12275
12351
|
* Scan for external organizations using paging
|
|
12276
12352
|
*
|
|
12277
12353
|
* @param {Object} opts Optional parameters
|
|
12278
12354
|
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
12279
12355
|
* @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
|
|
12280
|
-
|
|
12356
|
+
* getExternalcontactsScanOrganizationsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12357
|
+
*/},{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']);}/**
|
|
12281
12358
|
* Scan for relationships
|
|
12282
12359
|
*
|
|
12283
12360
|
* @param {Object} opts Optional parameters
|
|
12284
12361
|
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
12285
12362
|
* @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
|
|
12286
|
-
|
|
12363
|
+
* @param {String} opts.divisionId The division to scan over (default to *)
|
|
12364
|
+
*/},{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']);}/**
|
|
12365
|
+
* Scan for relationships
|
|
12366
|
+
*
|
|
12367
|
+
* @param {Object} opts Optional parameters
|
|
12368
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
12369
|
+
* @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
|
|
12370
|
+
* getExternalcontactsScanRelationshipsDivisionviewsAll is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12371
|
+
*/},{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']);}/**
|
|
12287
12372
|
* Claim or release identifiers for a contact
|
|
12288
12373
|
*
|
|
12289
12374
|
* @param {String} contactId ExternalContact ID
|
|
@@ -12301,6 +12386,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12301
12386
|
* @param {Object} body Contacts
|
|
12302
12387
|
*/},{key:"postExternalcontactsBulkContactsAdd",value:function postExternalcontactsBulkContactsAdd(body){// verify the required parameter 'body' is set
|
|
12303
12388
|
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']);}/**
|
|
12389
|
+
* Bulk fetch contacts across divisions
|
|
12390
|
+
*
|
|
12391
|
+
* @param {Object} body Contact ids
|
|
12392
|
+
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12393
|
+
*/},{key:"postExternalcontactsBulkContactsDivisionviews",value:function postExternalcontactsBulkContactsDivisionviews(body){// verify the required parameter 'body' is set
|
|
12394
|
+
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']);}/**
|
|
12304
12395
|
* Bulk remove contacts
|
|
12305
12396
|
*
|
|
12306
12397
|
* @param {Object} body Contact ids
|
|
@@ -12346,6 +12437,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12346
12437
|
* @param {Object} body Organizations
|
|
12347
12438
|
*/},{key:"postExternalcontactsBulkOrganizationsAdd",value:function postExternalcontactsBulkOrganizationsAdd(body){// verify the required parameter 'body' is set
|
|
12348
12439
|
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']);}/**
|
|
12440
|
+
* Bulk fetch organizations across divisions
|
|
12441
|
+
*
|
|
12442
|
+
* @param {Object} body Organizations ids
|
|
12443
|
+
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12444
|
+
*/},{key:"postExternalcontactsBulkOrganizationsDivisionviews",value:function postExternalcontactsBulkOrganizationsDivisionviews(body){// verify the required parameter 'body' is set
|
|
12445
|
+
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']);}/**
|
|
12349
12446
|
* Bulk remove organizations
|
|
12350
12447
|
*
|
|
12351
12448
|
* @param {Object} body Organization ids
|
|
@@ -12393,6 +12490,11 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
12393
12490
|
* @param {Object} body ExternalContact
|
|
12394
12491
|
*/},{key:"postExternalcontactsContacts",value:function postExternalcontactsContacts(body){// verify the required parameter 'body' is set
|
|
12395
12492
|
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']);}/**
|
|
12493
|
+
* Create bulk export
|
|
12494
|
+
*
|
|
12495
|
+
* @param {Object} body Export
|
|
12496
|
+
*/},{key:"postExternalcontactsContactsExports",value:function postExternalcontactsContactsExports(body){// verify the required parameter 'body' is set
|
|
12497
|
+
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']);}/**
|
|
12396
12498
|
* Create a schema
|
|
12397
12499
|
*
|
|
12398
12500
|
* @param {Object} body Schema
|
|
@@ -12560,7 +12662,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
12560
12662
|
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(){/**
|
|
12561
12663
|
* Fax service.
|
|
12562
12664
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
12563
|
-
* @version
|
|
12665
|
+
* @version 218.0.0
|
|
12564
12666
|
*//**
|
|
12565
12667
|
* Constructs a new FaxApi.
|
|
12566
12668
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -12609,7 +12711,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12609
12711
|
*/},{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(){/**
|
|
12610
12712
|
* Flows service.
|
|
12611
12713
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
12612
|
-
* @version
|
|
12714
|
+
* @version 218.0.0
|
|
12613
12715
|
*//**
|
|
12614
12716
|
* Constructs a new FlowsApi.
|
|
12615
12717
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12657,7 +12759,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12657
12759
|
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(){/**
|
|
12658
12760
|
* Gamification service.
|
|
12659
12761
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12660
|
-
* @version
|
|
12762
|
+
* @version 218.0.0
|
|
12661
12763
|
*//**
|
|
12662
12764
|
* Constructs a new GamificationApi.
|
|
12663
12765
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -13216,7 +13318,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13216
13318
|
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(){/**
|
|
13217
13319
|
* GeneralDataProtectionRegulation service.
|
|
13218
13320
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
13219
|
-
* @version
|
|
13321
|
+
* @version 218.0.0
|
|
13220
13322
|
*//**
|
|
13221
13323
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
13222
13324
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -13251,7 +13353,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
13251
13353
|
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(){/**
|
|
13252
13354
|
* Geolocation service.
|
|
13253
13355
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
13254
|
-
* @version
|
|
13356
|
+
* @version 218.0.0
|
|
13255
13357
|
*//**
|
|
13256
13358
|
* Constructs a new GeolocationApi.
|
|
13257
13359
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -13285,7 +13387,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
13285
13387
|
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(){/**
|
|
13286
13388
|
* Greetings service.
|
|
13287
13389
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
13288
|
-
* @version
|
|
13390
|
+
* @version 218.0.0
|
|
13289
13391
|
*//**
|
|
13290
13392
|
* Constructs a new GreetingsApi.
|
|
13291
13393
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -13392,7 +13494,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13392
13494
|
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(){/**
|
|
13393
13495
|
* Groups service.
|
|
13394
13496
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
13395
|
-
* @version
|
|
13497
|
+
* @version 218.0.0
|
|
13396
13498
|
*//**
|
|
13397
13499
|
* Constructs a new GroupsApi.
|
|
13398
13500
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -13525,7 +13627,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
13525
13627
|
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(){/**
|
|
13526
13628
|
* IdentityProvider service.
|
|
13527
13629
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
13528
|
-
* @version
|
|
13630
|
+
* @version 218.0.0
|
|
13529
13631
|
*//**
|
|
13530
13632
|
* Constructs a new IdentityProviderApi.
|
|
13531
13633
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13681,7 +13783,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13681
13783
|
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(){/**
|
|
13682
13784
|
* InfrastructureAsCode service.
|
|
13683
13785
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13684
|
-
* @version
|
|
13786
|
+
* @version 218.0.0
|
|
13685
13787
|
*//**
|
|
13686
13788
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13687
13789
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13735,7 +13837,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13735
13837
|
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(){/**
|
|
13736
13838
|
* Integrations service.
|
|
13737
13839
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13738
|
-
* @version
|
|
13840
|
+
* @version 218.0.0
|
|
13739
13841
|
*//**
|
|
13740
13842
|
* Constructs a new IntegrationsApi.
|
|
13741
13843
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13795,17 +13897,19 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
13795
13897
|
* @param {String} actionId actionId
|
|
13796
13898
|
* @param {Object} opts Optional parameters
|
|
13797
13899
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
13900
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
13798
13901
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
13799
13902
|
*/},{key:"getIntegrationsAction",value:function getIntegrationsAction(actionId,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
13800
|
-
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']);}/**
|
|
13903
|
+
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']);}/**
|
|
13801
13904
|
* Retrieve a Draft
|
|
13802
13905
|
*
|
|
13803
13906
|
* @param {String} actionId actionId
|
|
13804
13907
|
* @param {Object} opts Optional parameters
|
|
13805
13908
|
* @param {Object} opts.expand Indicates a field in the response which should be expanded.
|
|
13909
|
+
* @param {Object} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
13806
13910
|
* @param {Object} opts.includeConfig Return config in response. (default to false)
|
|
13807
13911
|
*/},{key:"getIntegrationsActionDraft",value:function getIntegrationsActionDraft(actionId,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
13808
|
-
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']);}/**
|
|
13912
|
+
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']);}/**
|
|
13809
13913
|
* Get draft function settings for Action
|
|
13810
13914
|
*
|
|
13811
13915
|
* @param {String} actionId actionId
|
|
@@ -14365,7 +14469,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
14365
14469
|
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(){/**
|
|
14366
14470
|
* Journey service.
|
|
14367
14471
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
14368
|
-
* @version
|
|
14472
|
+
* @version 218.0.0
|
|
14369
14473
|
*//**
|
|
14370
14474
|
* Constructs a new JourneyApi.
|
|
14371
14475
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -14845,7 +14949,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
14845
14949
|
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(){/**
|
|
14846
14950
|
* Knowledge service.
|
|
14847
14951
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14848
|
-
* @version
|
|
14952
|
+
* @version 218.0.0
|
|
14849
14953
|
*//**
|
|
14850
14954
|
* Constructs a new KnowledgeApi.
|
|
14851
14955
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -15219,7 +15323,6 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
15219
15323
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
15220
15324
|
* @param {String} uploadId UploadId
|
|
15221
15325
|
* @deprecated
|
|
15222
|
-
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15223
15326
|
*/},{key:"getKnowledgeKnowledgebaseLanguageDocumentUpload",value:function getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId,knowledgeBaseId,languageCode,uploadId){// verify the required parameter 'documentId' is set
|
|
15224
15327
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'knowledgeBaseId' is set
|
|
15225
15328
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'languageCode' is set
|
|
@@ -15302,7 +15405,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
15302
15405
|
* @param {String} parseJobId Parse job ID
|
|
15303
15406
|
* @param {Object} opts Optional parameters
|
|
15304
15407
|
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
15305
|
-
* getKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15306
15408
|
*/},{key:"getKnowledgeKnowledgebaseParseJob",value:function getKnowledgeKnowledgebaseParseJob(knowledgeBaseId,parseJobId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
15307
15409
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
15308
15410
|
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']);}/**
|
|
@@ -15377,7 +15479,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
15377
15479
|
*
|
|
15378
15480
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15379
15481
|
* @param {String} jobId Upload job ID
|
|
15380
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15381
15482
|
*/},{key:"getKnowledgeKnowledgebaseUploadsUrlsJob",value:function getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId,jobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15382
15483
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}// verify the required parameter 'jobId' is set
|
|
15383
15484
|
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']);}/**
|
|
@@ -15528,7 +15629,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15528
15629
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15529
15630
|
* @param {String} parseJobId Parse job ID
|
|
15530
15631
|
* @param {Object} body
|
|
15531
|
-
* patchKnowledgeKnowledgebaseParseJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15532
15632
|
*/},{key:"patchKnowledgeKnowledgebaseParseJob",value:function patchKnowledgeKnowledgebaseParseJob(knowledgeBaseId,parseJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15533
15633
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
15534
15634
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'body' is set
|
|
@@ -15689,7 +15789,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15689
15789
|
*
|
|
15690
15790
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15691
15791
|
* @param {Object} body
|
|
15692
|
-
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15693
15792
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsBulkRemove",value:function postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15694
15793
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';}// verify the required parameter 'body' is set
|
|
15695
15794
|
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']);}/**
|
|
@@ -15697,7 +15796,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15697
15796
|
*
|
|
15698
15797
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15699
15798
|
* @param {Object} body
|
|
15700
|
-
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15701
15799
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsBulkUpdate",value:function postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15702
15800
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';}// verify the required parameter 'body' is set
|
|
15703
15801
|
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']);}/**
|
|
@@ -15735,7 +15833,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
15735
15833
|
*
|
|
15736
15834
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15737
15835
|
* @param {Object} body
|
|
15738
|
-
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15739
15836
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd",value:function postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15740
15837
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';}// verify the required parameter 'body' is set
|
|
15741
15838
|
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']);}/**
|
|
@@ -15777,7 +15874,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15777
15874
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
15778
15875
|
* @param {Object} body
|
|
15779
15876
|
* @deprecated
|
|
15780
|
-
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15781
15877
|
*/},{key:"postKnowledgeKnowledgebaseLanguageDocumentUploads",value:function postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId,knowledgeBaseId,languageCode,body){// verify the required parameter 'documentId' is set
|
|
15782
15878
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'knowledgeBaseId' is set
|
|
15783
15879
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'languageCode' is set
|
|
@@ -15826,7 +15922,6 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
15826
15922
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15827
15923
|
* @param {String} parseJobId Parse job ID
|
|
15828
15924
|
* @param {Object} body
|
|
15829
|
-
* postKnowledgeKnowledgebaseParseJobImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15830
15925
|
*/},{key:"postKnowledgeKnowledgebaseParseJobImport",value:function postKnowledgeKnowledgebaseParseJobImport(knowledgeBaseId,parseJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15831
15926
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobImport';}// verify the required parameter 'parseJobId' is set
|
|
15832
15927
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling postKnowledgeKnowledgebaseParseJobImport';}// verify the required parameter 'body' is set
|
|
@@ -15835,7 +15930,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15835
15930
|
*
|
|
15836
15931
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15837
15932
|
* @param {Object} body
|
|
15838
|
-
* postKnowledgeKnowledgebaseParseJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15839
15933
|
*/},{key:"postKnowledgeKnowledgebaseParseJobs",value:function postKnowledgeKnowledgebaseParseJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15840
15934
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobs';}// verify the required parameter 'body' is set
|
|
15841
15935
|
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']);}/**
|
|
@@ -15858,9 +15952,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15858
15952
|
*
|
|
15859
15953
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15860
15954
|
* @param {String} sourceId Source ID
|
|
15861
|
-
|
|
15955
|
+
* @param {Object} opts Optional parameters
|
|
15956
|
+
* @param {Object} opts.body
|
|
15957
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
15862
15958
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15863
|
-
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},{},{},{},
|
|
15959
|
+
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']);}/**
|
|
15864
15960
|
* Create ServiceNow Knowledge integration source
|
|
15865
15961
|
*
|
|
15866
15962
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -15872,9 +15968,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15872
15968
|
*
|
|
15873
15969
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15874
15970
|
* @param {String} sourceId Source ID
|
|
15875
|
-
|
|
15971
|
+
* @param {Object} opts Optional parameters
|
|
15972
|
+
* @param {Object} opts.body
|
|
15973
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
15876
15974
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15877
|
-
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},{},{},{},
|
|
15975
|
+
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']);}/**
|
|
15878
15976
|
* Create synchronization job
|
|
15879
15977
|
*
|
|
15880
15978
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -15886,7 +15984,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15886
15984
|
*
|
|
15887
15985
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15888
15986
|
* @param {Object} body uploadRequest
|
|
15889
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15890
15987
|
*/},{key:"postKnowledgeKnowledgebaseUploadsUrlsJobs",value:function postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15891
15988
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';}// verify the required parameter 'body' is set
|
|
15892
15989
|
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']);}/**
|
|
@@ -15915,7 +16012,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15915
16012
|
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(){/**
|
|
15916
16013
|
* LanguageUnderstanding service.
|
|
15917
16014
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15918
|
-
* @version
|
|
16015
|
+
* @version 218.0.0
|
|
15919
16016
|
*//**
|
|
15920
16017
|
* Constructs a new LanguageUnderstandingApi.
|
|
15921
16018
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -16174,7 +16271,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
16174
16271
|
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(){/**
|
|
16175
16272
|
* Languages service.
|
|
16176
16273
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
16177
|
-
* @version
|
|
16274
|
+
* @version 218.0.0
|
|
16178
16275
|
*//**
|
|
16179
16276
|
* Constructs a new LanguagesApi.
|
|
16180
16277
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -16229,7 +16326,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16229
16326
|
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(){/**
|
|
16230
16327
|
* Learning service.
|
|
16231
16328
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
16232
|
-
* @version
|
|
16329
|
+
* @version 218.0.0
|
|
16233
16330
|
*//**
|
|
16234
16331
|
* Constructs a new LearningApi.
|
|
16235
16332
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -16500,7 +16597,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
16500
16597
|
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(){/**
|
|
16501
16598
|
* License service.
|
|
16502
16599
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
16503
|
-
* @version
|
|
16600
|
+
* @version 218.0.0
|
|
16504
16601
|
*//**
|
|
16505
16602
|
* Constructs a new LicenseApi.
|
|
16506
16603
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -16554,7 +16651,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
16554
16651
|
*/},{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(){/**
|
|
16555
16652
|
* Locations service.
|
|
16556
16653
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
16557
|
-
* @version
|
|
16654
|
+
* @version 218.0.0
|
|
16558
16655
|
*//**
|
|
16559
16656
|
* Constructs a new LocationsApi.
|
|
16560
16657
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -16613,7 +16710,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16613
16710
|
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(){/**
|
|
16614
16711
|
* LogCapture service.
|
|
16615
16712
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
16616
|
-
* @version
|
|
16713
|
+
* @version 218.0.0
|
|
16617
16714
|
*//**
|
|
16618
16715
|
* Constructs a new LogCaptureApi.
|
|
16619
16716
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -16663,7 +16760,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16663
16760
|
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(){/**
|
|
16664
16761
|
* Messaging service.
|
|
16665
16762
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
16666
|
-
* @version
|
|
16763
|
+
* @version 218.0.0
|
|
16667
16764
|
*//**
|
|
16668
16765
|
* Constructs a new MessagingApi.
|
|
16669
16766
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16753,7 +16850,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16753
16850
|
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(){/**
|
|
16754
16851
|
* MobileDevices service.
|
|
16755
16852
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16756
|
-
* @version
|
|
16853
|
+
* @version 218.0.0
|
|
16757
16854
|
*//**
|
|
16758
16855
|
* Constructs a new MobileDevicesApi.
|
|
16759
16856
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16792,7 +16889,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16792
16889
|
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(){/**
|
|
16793
16890
|
* Notifications service.
|
|
16794
16891
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16795
|
-
* @version
|
|
16892
|
+
* @version 218.0.0
|
|
16796
16893
|
*//**
|
|
16797
16894
|
* Constructs a new NotificationsApi.
|
|
16798
16895
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16849,7 +16946,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16849
16946
|
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(){/**
|
|
16850
16947
|
* OAuth service.
|
|
16851
16948
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16852
|
-
* @version
|
|
16949
|
+
* @version 218.0.0
|
|
16853
16950
|
*//**
|
|
16854
16951
|
* Constructs a new OAuthApi.
|
|
16855
16952
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16934,7 +17031,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16934
17031
|
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(){/**
|
|
16935
17032
|
* Objects service.
|
|
16936
17033
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16937
|
-
* @version
|
|
17034
|
+
* @version 218.0.0
|
|
16938
17035
|
*//**
|
|
16939
17036
|
* Constructs a new ObjectsApi.
|
|
16940
17037
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16946,7 +17043,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16946
17043
|
*
|
|
16947
17044
|
* @param {String} divisionId Division ID
|
|
16948
17045
|
* @param {Object} opts Optional parameters
|
|
16949
|
-
* @param {Boolean} opts.force Force delete this division
|
|
17046
|
+
* @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)
|
|
16950
17047
|
*/return _createClass(ObjectsApi,[{key:"deleteAuthorizationDivision",value:function deleteAuthorizationDivision(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
16951
17048
|
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']);}/**
|
|
16952
17049
|
* Returns an authorization division.
|
|
@@ -16987,10 +17084,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16987
17084
|
* Recreate a previously deleted division.
|
|
16988
17085
|
*
|
|
16989
17086
|
* @param {String} divisionId Division ID
|
|
16990
|
-
* @param {Object}
|
|
16991
|
-
|
|
16992
|
-
|
|
16993
|
-
if(
|
|
17087
|
+
* @param {Object} body Recreated division data
|
|
17088
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,body){// verify the required parameter 'divisionId' is set
|
|
17089
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';}// verify the required parameter 'body' is set
|
|
17090
|
+
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']);}/**
|
|
16994
17091
|
* Create a division.
|
|
16995
17092
|
*
|
|
16996
17093
|
* @param {Object} body Division
|
|
@@ -17005,7 +17102,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
17005
17102
|
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(){/**
|
|
17006
17103
|
* OperationalEvents service.
|
|
17007
17104
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
17008
|
-
* @version
|
|
17105
|
+
* @version 218.0.0
|
|
17009
17106
|
*//**
|
|
17010
17107
|
* Constructs a new OperationalEventsApi.
|
|
17011
17108
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -17036,7 +17133,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
17036
17133
|
*/},{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(){/**
|
|
17037
17134
|
* Organization service.
|
|
17038
17135
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
17039
|
-
* @version
|
|
17136
|
+
* @version 218.0.0
|
|
17040
17137
|
*//**
|
|
17041
17138
|
* Constructs a new OrganizationApi.
|
|
17042
17139
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -17086,31 +17183,11 @@ if(requestId===undefined||requestId===null){throw'Missing the required parameter
|
|
|
17086
17183
|
* @param {String} namespaceName The namespace to fetch limits for
|
|
17087
17184
|
*/},{key:"getOrganizationsLimitsNamespace",value:function getOrganizationsLimitsNamespace(namespaceName){// verify the required parameter 'namespaceName' is set
|
|
17088
17185
|
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']);}/**
|
|
17089
|
-
* 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.
|
|
17090
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
17091
|
-
* @param {String} namespaceName The namespace to get
|
|
17092
|
-
* @param {Object} opts Optional parameters
|
|
17093
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
17094
|
-
* @param {String} opts.entityId entity id of the count
|
|
17095
|
-
* @param {String} opts.userId userid of the count
|
|
17096
|
-
*/},{key:"getOrganizationsLimitsNamespaceCounts",value:function getOrganizationsLimitsNamespaceCounts(namespaceName,opts){opts=opts||{};// verify the required parameter 'namespaceName' is set
|
|
17097
|
-
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']);}/**
|
|
17098
17186
|
* Get the default limits in a namespace for an organization
|
|
17099
17187
|
*
|
|
17100
17188
|
* @param {String} namespaceName The namespace to fetch defaults limits for
|
|
17101
17189
|
*/},{key:"getOrganizationsLimitsNamespaceDefaults",value:function getOrganizationsLimitsNamespaceDefaults(namespaceName){// verify the required parameter 'namespaceName' is set
|
|
17102
17190
|
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']);}/**
|
|
17103
|
-
* 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.
|
|
17104
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
17105
|
-
* @param {String} namespaceName The namespace to get
|
|
17106
|
-
* @param {String} limitName The limit to get
|
|
17107
|
-
* @param {Object} opts Optional parameters
|
|
17108
|
-
* @param {String} opts.entityId entity id of the count
|
|
17109
|
-
* @param {String} opts.userId userid of the count
|
|
17110
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
17111
|
-
*/},{key:"getOrganizationsLimitsNamespaceLimitCounts",value:function getOrganizationsLimitsNamespaceLimitCounts(namespaceName,limitName,opts){opts=opts||{};// verify the required parameter 'namespaceName' is set
|
|
17112
|
-
if(namespaceName===undefined||namespaceName===null){throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';}// verify the required parameter 'limitName' is set
|
|
17113
|
-
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']);}/**
|
|
17114
17191
|
* Get the available limit namespaces
|
|
17115
17192
|
*
|
|
17116
17193
|
* @param {Object} opts Optional parameters
|
|
@@ -17161,7 +17238,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17161
17238
|
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(){/**
|
|
17162
17239
|
* OrganizationAuthorization service.
|
|
17163
17240
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
17164
|
-
* @version
|
|
17241
|
+
* @version 218.0.0
|
|
17165
17242
|
*//**
|
|
17166
17243
|
* Constructs a new OrganizationAuthorizationApi.
|
|
17167
17244
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -17495,7 +17572,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
17495
17572
|
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(){/**
|
|
17496
17573
|
* Outbound service.
|
|
17497
17574
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
17498
|
-
* @version
|
|
17575
|
+
* @version 218.0.0
|
|
17499
17576
|
*//**
|
|
17500
17577
|
* Constructs a new OutboundApi.
|
|
17501
17578
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -18226,8 +18303,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18226
18303
|
* Update the outbound settings for this organization
|
|
18227
18304
|
*
|
|
18228
18305
|
* @param {Object} body outboundSettings
|
|
18229
|
-
|
|
18230
|
-
|
|
18306
|
+
* @param {Object} opts Optional parameters
|
|
18307
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
18308
|
+
*/},{key:"patchOutboundSettings",value:function patchOutboundSettings(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
18309
|
+
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']);}/**
|
|
18231
18310
|
* Create attempt limits
|
|
18232
18311
|
*
|
|
18233
18312
|
* @param {Object} body AttemptLimits
|
|
@@ -18274,8 +18353,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18274
18353
|
* Create a campaign.
|
|
18275
18354
|
*
|
|
18276
18355
|
* @param {Object} body Campaign
|
|
18277
|
-
|
|
18278
|
-
|
|
18356
|
+
* @param {Object} opts Optional parameters
|
|
18357
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
18358
|
+
*/},{key:"postOutboundCampaigns",value:function postOutboundCampaigns(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
18359
|
+
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']);}/**
|
|
18279
18360
|
* Get progress for a list of campaigns
|
|
18280
18361
|
*
|
|
18281
18362
|
* @param {Array.<String>} body Campaign IDs
|
|
@@ -18473,9 +18554,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18473
18554
|
*
|
|
18474
18555
|
* @param {String} campaignId Campaign ID
|
|
18475
18556
|
* @param {Object} body Campaign
|
|
18476
|
-
|
|
18557
|
+
* @param {Object} opts Optional parameters
|
|
18558
|
+
* @param {Object} opts.useMaxCallsPerAgentDecimal Use maxCallsPerAgent with decimal precision
|
|
18559
|
+
*/},{key:"putOutboundCampaign",value:function putOutboundCampaign(campaignId,body,opts){opts=opts||{};// verify the required parameter 'campaignId' is set
|
|
18477
18560
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling putOutboundCampaign';}// verify the required parameter 'body' is set
|
|
18478
|
-
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']);}/**
|
|
18561
|
+
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']);}/**
|
|
18479
18562
|
* Send notification that an agent's state changed
|
|
18480
18563
|
* New agent state.
|
|
18481
18564
|
* @param {String} campaignId Campaign ID
|
|
@@ -18606,7 +18689,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18606
18689
|
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(){/**
|
|
18607
18690
|
* Presence service.
|
|
18608
18691
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
18609
|
-
* @version
|
|
18692
|
+
* @version 218.0.0
|
|
18610
18693
|
*//**
|
|
18611
18694
|
* Constructs a new PresenceApi.
|
|
18612
18695
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18779,7 +18862,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18779
18862
|
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(){/**
|
|
18780
18863
|
* ProcessAutomation service.
|
|
18781
18864
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18782
|
-
* @version
|
|
18865
|
+
* @version 218.0.0
|
|
18783
18866
|
*//**
|
|
18784
18867
|
* Constructs a new ProcessAutomationApi.
|
|
18785
18868
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18842,7 +18925,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18842
18925
|
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(){/**
|
|
18843
18926
|
* Quality service.
|
|
18844
18927
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18845
|
-
* @version
|
|
18928
|
+
* @version 218.0.0
|
|
18846
18929
|
*//**
|
|
18847
18930
|
* Constructs a new QualityApi.
|
|
18848
18931
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -19301,7 +19384,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19301
19384
|
*
|
|
19302
19385
|
* @param {String} formId Form ID
|
|
19303
19386
|
* @param {Object} body AI Scoring Settings
|
|
19304
|
-
* putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19305
19387
|
*/},{key:"putQualityFormsEvaluationAiscoringSettings",value:function putQualityFormsEvaluationAiscoringSettings(formId,body){// verify the required parameter 'formId' is set
|
|
19306
19388
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluationAiscoringSettings';}// verify the required parameter 'body' is set
|
|
19307
19389
|
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']);}/**
|
|
@@ -19321,7 +19403,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
19321
19403
|
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(){/**
|
|
19322
19404
|
* Recording service.
|
|
19323
19405
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
19324
|
-
* @version
|
|
19406
|
+
* @version 218.0.0
|
|
19325
19407
|
*//**
|
|
19326
19408
|
* Constructs a new RecordingApi.
|
|
19327
19409
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -19379,7 +19461,7 @@ if(policyId===undefined||policyId===null){throw'Missing the required parameter "
|
|
|
19379
19461
|
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
|
|
19380
19462
|
* @param {Object} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
19381
19463
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
19382
|
-
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
19464
|
+
* @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
|
|
19383
19465
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
19384
19466
|
*/},{key:"getConversationRecording",value:function getConversationRecording(conversationId,recordingId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
19385
19467
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationRecording';}// verify the required parameter 'recordingId' is set
|
|
@@ -19419,8 +19501,10 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
19419
19501
|
* @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)
|
|
19420
19502
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
19421
19503
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
19504
|
+
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
19505
|
+
* @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
|
|
19422
19506
|
*/},{key:"getConversationRecordings",value:function getConversationRecordings(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
19423
|
-
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']);}/**
|
|
19507
|
+
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']);}/**
|
|
19424
19508
|
* Gets a single orphan recording
|
|
19425
19509
|
*
|
|
19426
19510
|
* @param {String} orphanId Orphan ID
|
|
@@ -19559,13 +19643,6 @@ if(reportId===undefined||reportId===null){throw'Missing the required parameter "
|
|
|
19559
19643
|
* @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
|
|
19560
19644
|
*/},{key:"getRecordingsRetentionQuery",value:function getRecordingsRetentionQuery(retentionThresholdDays,opts){opts=opts||{};// verify the required parameter 'retentionThresholdDays' is set
|
|
19561
19645
|
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']);}/**
|
|
19562
|
-
* Retrieves a paged listing of screen recording sessions
|
|
19563
|
-
* Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details
|
|
19564
|
-
* @param {Object} opts Optional parameters
|
|
19565
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19566
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19567
|
-
* @deprecated
|
|
19568
|
-
*/},{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']);}/**
|
|
19569
19646
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
19570
19647
|
*
|
|
19571
19648
|
*/},{key:"getRecordingsScreensessionsDetails",value:function getRecordingsScreensessionsDetails(){return this.apiClient.callApi('/api/v2/recordings/screensessions/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -19725,7 +19802,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19725
19802
|
*/},{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(){/**
|
|
19726
19803
|
* ResponseManagement service.
|
|
19727
19804
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
19728
|
-
* @version
|
|
19805
|
+
* @version 218.0.0
|
|
19729
19806
|
*//**
|
|
19730
19807
|
* Constructs a new ResponseManagementApi.
|
|
19731
19808
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19846,7 +19923,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19846
19923
|
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(){/**
|
|
19847
19924
|
* Routing service.
|
|
19848
19925
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19849
|
-
* @version
|
|
19926
|
+
* @version 218.0.0
|
|
19850
19927
|
*//**
|
|
19851
19928
|
* Constructs a new RoutingApi.
|
|
19852
19929
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20030,6 +20107,14 @@ if(domainId===undefined||domainId===null){throw'Missing the required parameter "
|
|
|
20030
20107
|
*/},{key:"getRoutingEmailDomainRoute",value:function getRoutingEmailDomainRoute(domainName,routeId){// verify the required parameter 'domainName' is set
|
|
20031
20108
|
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoute';}// verify the required parameter 'routeId' is set
|
|
20032
20109
|
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']);}/**
|
|
20110
|
+
* Get a route identity resolution setting.
|
|
20111
|
+
*
|
|
20112
|
+
* @param {String} domainName email domain
|
|
20113
|
+
* @param {String} routeId route ID
|
|
20114
|
+
* getRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20115
|
+
*/},{key:"getRoutingEmailDomainRouteIdentityresolution",value:function getRoutingEmailDomainRouteIdentityresolution(domainName,routeId){// verify the required parameter 'domainName' is set
|
|
20116
|
+
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRouteIdentityresolution';}// verify the required parameter 'routeId' is set
|
|
20117
|
+
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']);}/**
|
|
20033
20118
|
* Get routes
|
|
20034
20119
|
*
|
|
20035
20120
|
* @param {String} domainName email domain
|
|
@@ -20160,6 +20245,12 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
20160
20245
|
* @param {String} opts.conversationId conversationId
|
|
20161
20246
|
*/},{key:"getRoutingQueueEstimatedwaittime",value:function getRoutingQueueEstimatedwaittime(queueId,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
20162
20247
|
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']);}/**
|
|
20248
|
+
* Get Queue IdentityResolution Settings.
|
|
20249
|
+
*
|
|
20250
|
+
* @param {String} queueId Queue ID
|
|
20251
|
+
* getRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20252
|
+
*/},{key:"getRoutingQueueIdentityresolution",value:function getRoutingQueueIdentityresolution(queueId){// verify the required parameter 'queueId' is set
|
|
20253
|
+
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']);}/**
|
|
20163
20254
|
* Get Estimated Wait Time
|
|
20164
20255
|
*
|
|
20165
20256
|
* @param {String} queueId queueId
|
|
@@ -20328,6 +20419,12 @@ if(addressId===undefined||addressId===null){throw'Missing the required parameter
|
|
|
20328
20419
|
*/},{key:"getRoutingSmsAvailablephonenumbers",value:function getRoutingSmsAvailablephonenumbers(countryCode,phoneNumberType,opts){opts=opts||{};// verify the required parameter 'countryCode' is set
|
|
20329
20420
|
if(countryCode===undefined||countryCode===null){throw'Missing the required parameter "countryCode" when calling getRoutingSmsAvailablephonenumbers';}// verify the required parameter 'phoneNumberType' is set
|
|
20330
20421
|
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']);}/**
|
|
20422
|
+
* Get a SMS identity resolution settings.
|
|
20423
|
+
*
|
|
20424
|
+
* @param {String} addressId Address ID
|
|
20425
|
+
* getRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20426
|
+
*/},{key:"getRoutingSmsIdentityresolutionPhonenumber",value:function getRoutingSmsIdentityresolutionPhonenumber(addressId){// verify the required parameter 'addressId' is set
|
|
20427
|
+
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']);}/**
|
|
20331
20428
|
* Get a phone number provisioned for SMS.
|
|
20332
20429
|
*
|
|
20333
20430
|
* @param {String} phoneNumberId phone number
|
|
@@ -20765,6 +20862,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20765
20862
|
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling putRoutingEmailDomainRoute';}// verify the required parameter 'routeId' is set
|
|
20766
20863
|
if(routeId===undefined||routeId===null){throw'Missing the required parameter "routeId" when calling putRoutingEmailDomainRoute';}// verify the required parameter 'body' is set
|
|
20767
20864
|
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']);}/**
|
|
20865
|
+
* Update identity resolution settings for a route.
|
|
20866
|
+
*
|
|
20867
|
+
* @param {String} domainName email domain
|
|
20868
|
+
* @param {String} routeId route ID
|
|
20869
|
+
* @param {Object} body
|
|
20870
|
+
* putRoutingEmailDomainRouteIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20871
|
+
*/},{key:"putRoutingEmailDomainRouteIdentityresolution",value:function putRoutingEmailDomainRouteIdentityresolution(domainName,routeId,body){// verify the required parameter 'domainName' is set
|
|
20872
|
+
if(domainName===undefined||domainName===null){throw'Missing the required parameter "domainName" when calling putRoutingEmailDomainRouteIdentityresolution';}// verify the required parameter 'routeId' is set
|
|
20873
|
+
if(routeId===undefined||routeId===null){throw'Missing the required parameter "routeId" when calling putRoutingEmailDomainRouteIdentityresolution';}// verify the required parameter 'body' is set
|
|
20874
|
+
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']);}/**
|
|
20768
20875
|
* Request an activation status (cname + dkim) update of an outbound domain
|
|
20769
20876
|
*
|
|
20770
20877
|
* @param {String} domainId domain ID
|
|
@@ -20784,6 +20891,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20784
20891
|
*/},{key:"putRoutingQueue",value:function putRoutingQueue(queueId,body){// verify the required parameter 'queueId' is set
|
|
20785
20892
|
if(queueId===undefined||queueId===null){throw'Missing the required parameter "queueId" when calling putRoutingQueue';}// verify the required parameter 'body' is set
|
|
20786
20893
|
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']);}/**
|
|
20894
|
+
* Update Queue IdentityResolution Settings.
|
|
20895
|
+
*
|
|
20896
|
+
* @param {String} queueId Queue ID
|
|
20897
|
+
* @param {Object} body
|
|
20898
|
+
* putRoutingQueueIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20899
|
+
*/},{key:"putRoutingQueueIdentityresolution",value:function putRoutingQueueIdentityresolution(queueId,body){// verify the required parameter 'queueId' is set
|
|
20900
|
+
if(queueId===undefined||queueId===null){throw'Missing the required parameter "queueId" when calling putRoutingQueueIdentityresolution';}// verify the required parameter 'body' is set
|
|
20901
|
+
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']);}/**
|
|
20787
20902
|
* Update an organization's routing settings
|
|
20788
20903
|
*
|
|
20789
20904
|
* @param {Object} body Organization Settings
|
|
@@ -20794,6 +20909,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20794
20909
|
* @param {Object} body Organization Settings
|
|
20795
20910
|
*/},{key:"putRoutingSettingsTranscription",value:function putRoutingSettingsTranscription(body){// verify the required parameter 'body' is set
|
|
20796
20911
|
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']);}/**
|
|
20912
|
+
* Update an SMS identity resolution settings.
|
|
20913
|
+
*
|
|
20914
|
+
* @param {String} addressId Address ID
|
|
20915
|
+
* @param {Object} body
|
|
20916
|
+
* putRoutingSmsIdentityresolutionPhonenumber is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20917
|
+
*/},{key:"putRoutingSmsIdentityresolutionPhonenumber",value:function putRoutingSmsIdentityresolutionPhonenumber(addressId,body){// verify the required parameter 'addressId' is set
|
|
20918
|
+
if(addressId===undefined||addressId===null){throw'Missing the required parameter "addressId" when calling putRoutingSmsIdentityresolutionPhonenumber';}// verify the required parameter 'body' is set
|
|
20919
|
+
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']);}/**
|
|
20797
20920
|
* Update the user's Direct Routing Backup settings.
|
|
20798
20921
|
*
|
|
20799
20922
|
* @param {String} userId User ID
|
|
@@ -20845,7 +20968,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20845
20968
|
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(){/**
|
|
20846
20969
|
* SCIM service.
|
|
20847
20970
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
20848
|
-
* @version
|
|
20971
|
+
* @version 218.0.0
|
|
20849
20972
|
*//**
|
|
20850
20973
|
* Constructs a new SCIMApi.
|
|
20851
20974
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -21070,7 +21193,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21070
21193
|
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(){/**
|
|
21071
21194
|
* ScreenRecording service.
|
|
21072
21195
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
21073
|
-
* @version
|
|
21196
|
+
* @version 218.0.0
|
|
21074
21197
|
*//**
|
|
21075
21198
|
* Constructs a new ScreenRecordingApi.
|
|
21076
21199
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -21085,7 +21208,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21085
21208
|
*/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(){/**
|
|
21086
21209
|
* Scripts service.
|
|
21087
21210
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
21088
|
-
* @version
|
|
21211
|
+
* @version 218.0.0
|
|
21089
21212
|
*//**
|
|
21090
21213
|
* Constructs a new ScriptsApi.
|
|
21091
21214
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -21221,7 +21344,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
21221
21344
|
*/},{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(){/**
|
|
21222
21345
|
* Search service.
|
|
21223
21346
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
21224
|
-
* @version
|
|
21347
|
+
* @version 218.0.0
|
|
21225
21348
|
*//**
|
|
21226
21349
|
* Constructs a new SearchApi.
|
|
21227
21350
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -21393,7 +21516,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21393
21516
|
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(){/**
|
|
21394
21517
|
* Settings service.
|
|
21395
21518
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
21396
|
-
* @version
|
|
21519
|
+
* @version 218.0.0
|
|
21397
21520
|
*//**
|
|
21398
21521
|
* Constructs a new SettingsApi.
|
|
21399
21522
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -21443,7 +21566,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
21443
21566
|
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(){/**
|
|
21444
21567
|
* SocialMedia service.
|
|
21445
21568
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
21446
|
-
* @version
|
|
21569
|
+
* @version 218.0.0
|
|
21447
21570
|
*//**
|
|
21448
21571
|
* Constructs a new SocialMediaApi.
|
|
21449
21572
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -21451,13 +21574,23 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21451
21574
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
21452
21575
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
21453
21576
|
*/function SocialMediaApi(apiClient){_classCallCheck(this,SocialMediaApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
21577
|
+
* Delete an escalation rule.
|
|
21578
|
+
*
|
|
21579
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
21580
|
+
*/return _createClass(SocialMediaApi,[{key:"deleteSocialmediaEscalationrule",value:function deleteSocialmediaEscalationrule(escalationRuleId){// verify the required parameter 'escalationRuleId' is set
|
|
21581
|
+
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']);}/**
|
|
21582
|
+
* Delete a social media message.
|
|
21583
|
+
*
|
|
21584
|
+
* @param {String} messageId messageId
|
|
21585
|
+
* deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21586
|
+
*/},{key:"deleteSocialmediaMessage",value:function deleteSocialmediaMessage(messageId){// verify the required parameter 'messageId' is set
|
|
21587
|
+
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']);}/**
|
|
21454
21588
|
* Delete a social topic.
|
|
21455
21589
|
*
|
|
21456
21590
|
* @param {String} topicId topicId
|
|
21457
21591
|
* @param {Object} opts Optional parameters
|
|
21458
21592
|
* @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.
|
|
21459
|
-
|
|
21460
|
-
*/return _createClass(SocialMediaApi,[{key:"deleteSocialmediaTopic",value:function deleteSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21593
|
+
*/},{key:"deleteSocialmediaTopic",value:function deleteSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21461
21594
|
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']);}/**
|
|
21462
21595
|
* Delete a Facebook data ingestion rule.
|
|
21463
21596
|
*
|
|
@@ -21465,7 +21598,6 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21465
21598
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21466
21599
|
* @param {Object} opts Optional parameters
|
|
21467
21600
|
* @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)
|
|
21468
|
-
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21469
21601
|
*/},{key:"deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21470
21602
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21471
21603
|
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']);}/**
|
|
@@ -21485,25 +21617,68 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21485
21617
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21486
21618
|
* @param {Object} opts Optional parameters
|
|
21487
21619
|
* @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)
|
|
21488
|
-
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21489
21620
|
*/},{key:"deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21490
21621
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21491
21622
|
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']);}/**
|
|
21623
|
+
* Get status for async query for social media aggregates
|
|
21624
|
+
*
|
|
21625
|
+
* @param {String} jobId jobId
|
|
21626
|
+
*/},{key:"getSocialmediaAnalyticsAggregatesJob",value:function getSocialmediaAnalyticsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
21627
|
+
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']);}/**
|
|
21628
|
+
* Fetch a page of results for an async social media query
|
|
21629
|
+
*
|
|
21630
|
+
* @param {String} jobId jobId
|
|
21631
|
+
* @param {Object} opts Optional parameters
|
|
21632
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
21633
|
+
*/},{key:"getSocialmediaAnalyticsAggregatesJobResults",value:function getSocialmediaAnalyticsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
21634
|
+
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']);}/**
|
|
21635
|
+
* Get status for async query for social media messages job
|
|
21636
|
+
*
|
|
21637
|
+
* @param {String} jobId jobId
|
|
21638
|
+
*/},{key:"getSocialmediaAnalyticsMessagesJob",value:function getSocialmediaAnalyticsMessagesJob(jobId){// verify the required parameter 'jobId' is set
|
|
21639
|
+
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']);}/**
|
|
21640
|
+
* Fetch a page of results for an async social media messages query
|
|
21641
|
+
*
|
|
21642
|
+
* @param {String} jobId jobId
|
|
21643
|
+
* @param {Object} opts Optional parameters
|
|
21644
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
21645
|
+
*/},{key:"getSocialmediaAnalyticsMessagesJobResults",value:function getSocialmediaAnalyticsMessagesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
21646
|
+
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']);}/**
|
|
21647
|
+
* Get a single escalation rule.
|
|
21648
|
+
*
|
|
21649
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
21650
|
+
*/},{key:"getSocialmediaEscalationrule",value:function getSocialmediaEscalationrule(escalationRuleId){// verify the required parameter 'escalationRuleId' is set
|
|
21651
|
+
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']);}/**
|
|
21652
|
+
* Retrieve all escalation rules for a division.
|
|
21653
|
+
*
|
|
21654
|
+
* @param {String} divisionId One division ID
|
|
21655
|
+
* @param {Object} opts Optional parameters
|
|
21656
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21657
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21658
|
+
*/},{key:"getSocialmediaEscalationrules",value:function getSocialmediaEscalationrules(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
21659
|
+
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']);}/**
|
|
21492
21660
|
* Get a single social topic.
|
|
21493
21661
|
*
|
|
21494
21662
|
* @param {String} topicId topicId
|
|
21495
21663
|
* @param {Object} opts Optional parameters
|
|
21496
21664
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21497
|
-
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21498
21665
|
*/},{key:"getSocialmediaTopic",value:function getSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21499
21666
|
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']);}/**
|
|
21667
|
+
* Retrieve all social topic data ingestion rules with pagination.
|
|
21668
|
+
*
|
|
21669
|
+
* @param {String} topicId topicId
|
|
21670
|
+
* @param {Object} opts Optional parameters
|
|
21671
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21672
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21673
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21674
|
+
*/},{key:"getSocialmediaTopicDataingestionrules",value:function getSocialmediaTopicDataingestionrules(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21675
|
+
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']);}/**
|
|
21500
21676
|
* Get a single Facebook data ingestion rule.
|
|
21501
21677
|
*
|
|
21502
21678
|
* @param {String} topicId topicId
|
|
21503
21679
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21504
21680
|
* @param {Object} opts Optional parameters
|
|
21505
21681
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21506
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21507
21682
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21508
21683
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21509
21684
|
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']);}/**
|
|
@@ -21514,7 +21689,6 @@ if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Mi
|
|
|
21514
21689
|
* @param {String} dataIngestionRuleVersion version
|
|
21515
21690
|
* @param {Object} opts Optional parameters
|
|
21516
21691
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
21517
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21518
21692
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId,facebookIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21519
21693
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21520
21694
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
@@ -21527,7 +21701,6 @@ if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'
|
|
|
21527
21701
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21528
21702
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21529
21703
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21530
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21531
21704
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21532
21705
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21533
21706
|
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']);}/**
|
|
@@ -21571,7 +21744,6 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21571
21744
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21572
21745
|
* @param {Object} opts Optional parameters
|
|
21573
21746
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21574
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21575
21747
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21576
21748
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21577
21749
|
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']);}/**
|
|
@@ -21582,7 +21754,6 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Miss
|
|
|
21582
21754
|
* @param {String} dataIngestionRuleVersion version
|
|
21583
21755
|
* @param {Object} opts Optional parameters
|
|
21584
21756
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
21585
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21586
21757
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId,twitterIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21587
21758
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21588
21759
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
@@ -21595,7 +21766,6 @@ if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'
|
|
|
21595
21766
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21596
21767
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21597
21768
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21598
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21599
21769
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21600
21770
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21601
21771
|
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']);}/**
|
|
@@ -21606,14 +21776,12 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Miss
|
|
|
21606
21776
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21607
21777
|
* @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.
|
|
21608
21778
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21609
|
-
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21610
21779
|
*/},{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']);}/**
|
|
21611
21780
|
* Update a social topic.
|
|
21612
21781
|
*
|
|
21613
21782
|
* @param {String} topicId topicId
|
|
21614
21783
|
* @param {Object} opts Optional parameters
|
|
21615
21784
|
* @param {Object} opts.body
|
|
21616
|
-
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21617
21785
|
*/},{key:"patchSocialmediaTopic",value:function patchSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21618
21786
|
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']);}/**
|
|
21619
21787
|
* Update the status of a Facebook data ingestion rule.
|
|
@@ -21622,7 +21790,6 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21622
21790
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21623
21791
|
* @param {Object} opts Optional parameters
|
|
21624
21792
|
* @param {Object} opts.body
|
|
21625
|
-
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21626
21793
|
*/},{key:"patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21627
21794
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21628
21795
|
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']);}/**
|
|
@@ -21642,16 +21809,36 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21642
21809
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21643
21810
|
* @param {Object} opts Optional parameters
|
|
21644
21811
|
* @param {Object} opts.body
|
|
21645
|
-
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21646
21812
|
*/},{key:"patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21647
21813
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21648
21814
|
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']);}/**
|
|
21815
|
+
* Query for social media aggregates asynchronously
|
|
21816
|
+
*
|
|
21817
|
+
* @param {Object} body query
|
|
21818
|
+
*/},{key:"postSocialmediaAnalyticsAggregatesJobs",value:function postSocialmediaAnalyticsAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
21819
|
+
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']);}/**
|
|
21820
|
+
* Query for social media messages asynchronously
|
|
21821
|
+
*
|
|
21822
|
+
* @param {Object} body query
|
|
21823
|
+
*/},{key:"postSocialmediaAnalyticsMessagesJobs",value:function postSocialmediaAnalyticsMessagesJobs(body){// verify the required parameter 'body' is set
|
|
21824
|
+
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']);}/**
|
|
21825
|
+
* Create an escalation rule.
|
|
21826
|
+
*
|
|
21827
|
+
* @param {Object} opts Optional parameters
|
|
21828
|
+
* @param {Object} opts.body
|
|
21829
|
+
*/},{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']);}/**
|
|
21830
|
+
* Escalate message to a conversation manually
|
|
21831
|
+
*
|
|
21832
|
+
* @param {String} divisionId One division ID
|
|
21833
|
+
* @param {Object} opts Optional parameters
|
|
21834
|
+
* @param {Object} opts.body
|
|
21835
|
+
*/},{key:"postSocialmediaEscalationsMessages",value:function postSocialmediaEscalationsMessages(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
21836
|
+
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']);}/**
|
|
21649
21837
|
* Create an Facebook data ingestion rule.
|
|
21650
21838
|
*
|
|
21651
21839
|
* @param {String} topicId topicId
|
|
21652
21840
|
* @param {Object} opts Optional parameters
|
|
21653
21841
|
* @param {Object} opts.body
|
|
21654
|
-
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21655
21842
|
*/},{key:"postSocialmediaTopicDataingestionrulesFacebook",value:function postSocialmediaTopicDataingestionrulesFacebook(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21656
21843
|
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']);}/**
|
|
21657
21844
|
* Create an open data ingestion rule.
|
|
@@ -21667,22 +21854,31 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21667
21854
|
* @param {String} topicId topicId
|
|
21668
21855
|
* @param {Object} opts Optional parameters
|
|
21669
21856
|
* @param {Object} opts.body
|
|
21670
|
-
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21671
21857
|
*/},{key:"postSocialmediaTopicDataingestionrulesTwitter",value:function postSocialmediaTopicDataingestionrulesTwitter(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21672
21858
|
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']);}/**
|
|
21673
21859
|
* Create a social topic.
|
|
21674
21860
|
*
|
|
21675
21861
|
* @param {Object} opts Optional parameters
|
|
21676
21862
|
* @param {Object} opts.body
|
|
21677
|
-
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21678
21863
|
*/},{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']);}/**
|
|
21864
|
+
* Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
|
|
21865
|
+
*
|
|
21866
|
+
* @param {Object} body TwitterDataHistoricalTweetRequest
|
|
21867
|
+
*/},{key:"postSocialmediaTwitterHistoricalTweets",value:function postSocialmediaTwitterHistoricalTweets(body){// verify the required parameter 'body' is set
|
|
21868
|
+
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']);}/**
|
|
21869
|
+
* Update the escalation rule.
|
|
21870
|
+
*
|
|
21871
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
21872
|
+
* @param {Object} opts Optional parameters
|
|
21873
|
+
* @param {Object} opts.body
|
|
21874
|
+
*/},{key:"putSocialmediaEscalationrule",value:function putSocialmediaEscalationrule(escalationRuleId,opts){opts=opts||{};// verify the required parameter 'escalationRuleId' is set
|
|
21875
|
+
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']);}/**
|
|
21679
21876
|
* Update the Facebook data ingestion rule.
|
|
21680
21877
|
*
|
|
21681
21878
|
* @param {String} topicId topicId
|
|
21682
21879
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21683
21880
|
* @param {Object} opts Optional parameters
|
|
21684
21881
|
* @param {Object} opts.body
|
|
21685
|
-
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21686
21882
|
*/},{key:"putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21687
21883
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21688
21884
|
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']);}/**
|
|
@@ -21702,13 +21898,12 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21702
21898
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21703
21899
|
* @param {Object} opts Optional parameters
|
|
21704
21900
|
* @param {Object} opts.body
|
|
21705
|
-
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21706
21901
|
*/},{key:"putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21707
21902
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21708
21903
|
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(){/**
|
|
21709
21904
|
* SpeechTextAnalytics service.
|
|
21710
21905
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
21711
|
-
* @version
|
|
21906
|
+
* @version 218.0.0
|
|
21712
21907
|
*//**
|
|
21713
21908
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
21714
21909
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -22031,7 +22226,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
22031
22226
|
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(){/**
|
|
22032
22227
|
* Stations service.
|
|
22033
22228
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
22034
|
-
* @version
|
|
22229
|
+
* @version 218.0.0
|
|
22035
22230
|
*//**
|
|
22036
22231
|
* Constructs a new StationsApi.
|
|
22037
22232
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -22063,7 +22258,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
22063
22258
|
*/},{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(){/**
|
|
22064
22259
|
* Suggest service.
|
|
22065
22260
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
22066
|
-
* @version
|
|
22261
|
+
* @version 218.0.0
|
|
22067
22262
|
*//**
|
|
22068
22263
|
* Constructs a new SuggestApi.
|
|
22069
22264
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -22103,7 +22298,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22103
22298
|
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(){/**
|
|
22104
22299
|
* TaskManagement service.
|
|
22105
22300
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
22106
|
-
* @version
|
|
22301
|
+
* @version 218.0.0
|
|
22107
22302
|
*//**
|
|
22108
22303
|
* Constructs a new TaskManagementApi.
|
|
22109
22304
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -22609,7 +22804,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
22609
22804
|
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(){/**
|
|
22610
22805
|
* Teams service.
|
|
22611
22806
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
22612
|
-
* @version
|
|
22807
|
+
* @version 218.0.0
|
|
22613
22808
|
*//**
|
|
22614
22809
|
* Constructs a new TeamsApi.
|
|
22615
22810
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -22689,7 +22884,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22689
22884
|
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(){/**
|
|
22690
22885
|
* Telephony service.
|
|
22691
22886
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
22692
|
-
* @version
|
|
22887
|
+
* @version 218.0.0
|
|
22693
22888
|
*//**
|
|
22694
22889
|
* Constructs a new TelephonyApi.
|
|
22695
22890
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -22736,7 +22931,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
22736
22931
|
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(){/**
|
|
22737
22932
|
* TelephonyProvidersEdge service.
|
|
22738
22933
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
22739
|
-
* @version
|
|
22934
|
+
* @version 218.0.0
|
|
22740
22935
|
*//**
|
|
22741
22936
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
22742
22937
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -23017,7 +23212,8 @@ if(extensionPoolId===undefined||extensionPoolId===null){throw'Missing the requir
|
|
|
23017
23212
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
23018
23213
|
* @param {String} opts.sortBy Sort by
|
|
23019
23214
|
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
23020
|
-
|
|
23215
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
23216
|
+
*/},{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']);}/**
|
|
23021
23217
|
* Get a pageable list of basic extension pool objects filterable by query parameters.
|
|
23022
23218
|
* 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.
|
|
23023
23219
|
* @param {Object} opts Optional parameters
|
|
@@ -23571,7 +23767,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
23571
23767
|
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(){/**
|
|
23572
23768
|
* Textbots service.
|
|
23573
23769
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
23574
|
-
* @version
|
|
23770
|
+
* @version 218.0.0
|
|
23575
23771
|
*//**
|
|
23576
23772
|
* Constructs a new TextbotsApi.
|
|
23577
23773
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -23606,7 +23802,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
23606
23802
|
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(){/**
|
|
23607
23803
|
* Tokens service.
|
|
23608
23804
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
23609
|
-
* @version
|
|
23805
|
+
* @version 218.0.0
|
|
23610
23806
|
*//**
|
|
23611
23807
|
* Constructs a new TokensApi.
|
|
23612
23808
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -23640,7 +23836,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23640
23836
|
*/},{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(){/**
|
|
23641
23837
|
* Uploads service.
|
|
23642
23838
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
23643
|
-
* @version
|
|
23839
|
+
* @version 218.0.0
|
|
23644
23840
|
*//**
|
|
23645
23841
|
* Constructs a new UploadsApi.
|
|
23646
23842
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -23652,7 +23848,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23652
23848
|
*
|
|
23653
23849
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23654
23850
|
* @param {String} jobId Upload job ID
|
|
23655
|
-
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23656
23851
|
*/return _createClass(UploadsApi,[{key:"getKnowledgeKnowledgebaseUploadsUrlsJob",value:function getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId,jobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
23657
23852
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}// verify the required parameter 'jobId' is set
|
|
23658
23853
|
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']);}/**
|
|
@@ -23672,7 +23867,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23672
23867
|
*
|
|
23673
23868
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23674
23869
|
* @param {Object} body uploadRequest
|
|
23675
|
-
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23676
23870
|
*/},{key:"postKnowledgeKnowledgebaseUploadsUrlsJobs",value:function postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
23677
23871
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';}// verify the required parameter 'body' is set
|
|
23678
23872
|
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']);}/**
|
|
@@ -23705,7 +23899,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23705
23899
|
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(){/**
|
|
23706
23900
|
* Usage service.
|
|
23707
23901
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
23708
|
-
* @version
|
|
23902
|
+
* @version 218.0.0
|
|
23709
23903
|
*//**
|
|
23710
23904
|
* Constructs a new UsageApi.
|
|
23711
23905
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -23759,7 +23953,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23759
23953
|
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(){/**
|
|
23760
23954
|
* UserRecordings service.
|
|
23761
23955
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
23762
|
-
* @version
|
|
23956
|
+
* @version 218.0.0
|
|
23763
23957
|
*//**
|
|
23764
23958
|
* Constructs a new UserRecordingsApi.
|
|
23765
23959
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -23816,7 +24010,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
23816
24010
|
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(){/**
|
|
23817
24011
|
* Users service.
|
|
23818
24012
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
23819
|
-
* @version
|
|
24013
|
+
* @version 218.0.0
|
|
23820
24014
|
*//**
|
|
23821
24015
|
* Constructs a new UsersApi.
|
|
23822
24016
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -24543,7 +24737,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
24543
24737
|
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(){/**
|
|
24544
24738
|
* Utilities service.
|
|
24545
24739
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
24546
|
-
* @version
|
|
24740
|
+
* @version 218.0.0
|
|
24547
24741
|
*//**
|
|
24548
24742
|
* Constructs a new UtilitiesApi.
|
|
24549
24743
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -24570,7 +24764,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24570
24764
|
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(){/**
|
|
24571
24765
|
* Voicemail service.
|
|
24572
24766
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
24573
|
-
* @version
|
|
24767
|
+
* @version 218.0.0
|
|
24574
24768
|
*//**
|
|
24575
24769
|
* Constructs a new VoicemailApi.
|
|
24576
24770
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -24732,7 +24926,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
24732
24926
|
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(){/**
|
|
24733
24927
|
* WebChat service.
|
|
24734
24928
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
24735
|
-
* @version
|
|
24929
|
+
* @version 218.0.0
|
|
24736
24930
|
*//**
|
|
24737
24931
|
* Constructs a new WebChatApi.
|
|
24738
24932
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -24747,9 +24941,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24747
24941
|
*/return _createClass(WebChatApi,[{key:"deleteWebchatDeployment",value:function deleteWebchatDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
24748
24942
|
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']);}/**
|
|
24749
24943
|
* Remove a member from a chat conversation
|
|
24750
|
-
*
|
|
24944
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24751
24945
|
* @param {String} conversationId conversationId
|
|
24752
24946
|
* @param {String} memberId memberId
|
|
24947
|
+
* @deprecated
|
|
24753
24948
|
*/},{key:"deleteWebchatGuestConversationMember",value:function deleteWebchatGuestConversationMember(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
24754
24949
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling deleteWebchatGuestConversationMember';}// verify the required parameter 'memberId' is set
|
|
24755
24950
|
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']);}/**
|
|
@@ -24775,41 +24970,46 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
24775
24970
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequest';}// verify the required parameter 'mediaRequestId' is set
|
|
24776
24971
|
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']);}/**
|
|
24777
24972
|
* Get all media requests to the guest in the conversation
|
|
24778
|
-
*
|
|
24973
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24779
24974
|
* @param {String} conversationId conversationId
|
|
24975
|
+
* @deprecated
|
|
24780
24976
|
*/},{key:"getWebchatGuestConversationMediarequests",value:function getWebchatGuestConversationMediarequests(conversationId){// verify the required parameter 'conversationId' is set
|
|
24781
24977
|
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']);}/**
|
|
24782
24978
|
* Get a web chat conversation member
|
|
24783
|
-
*
|
|
24979
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24784
24980
|
* @param {String} conversationId conversationId
|
|
24785
24981
|
* @param {String} memberId memberId
|
|
24982
|
+
* @deprecated
|
|
24786
24983
|
*/},{key:"getWebchatGuestConversationMember",value:function getWebchatGuestConversationMember(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
24787
24984
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMember';}// verify the required parameter 'memberId' is set
|
|
24788
24985
|
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']);}/**
|
|
24789
24986
|
* Get the members of a chat conversation.
|
|
24790
|
-
*
|
|
24987
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24791
24988
|
* @param {String} conversationId conversationId
|
|
24792
24989
|
* @param {Object} opts Optional parameters
|
|
24793
24990
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
24794
24991
|
* @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
|
|
24795
24992
|
* @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
|
|
24993
|
+
* @deprecated
|
|
24796
24994
|
*/},{key:"getWebchatGuestConversationMembers",value:function getWebchatGuestConversationMembers(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
24797
24995
|
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']);}/**
|
|
24798
24996
|
* Get a web chat conversation message
|
|
24799
|
-
*
|
|
24997
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24800
24998
|
* @param {String} conversationId conversationId
|
|
24801
24999
|
* @param {String} messageId messageId
|
|
25000
|
+
* @deprecated
|
|
24802
25001
|
*/},{key:"getWebchatGuestConversationMessage",value:function getWebchatGuestConversationMessage(conversationId,messageId){// verify the required parameter 'conversationId' is set
|
|
24803
25002
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessage';}// verify the required parameter 'messageId' is set
|
|
24804
25003
|
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']);}/**
|
|
24805
25004
|
* Get the messages of a chat conversation.
|
|
24806
|
-
*
|
|
25005
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24807
25006
|
* @param {String} conversationId conversationId
|
|
24808
25007
|
* @param {Object} opts Optional parameters
|
|
24809
25008
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
24810
25009
|
* @param {String} opts.before If available, get the messages chronologically before the id of this message
|
|
24811
25010
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
24812
25011
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
25012
|
+
* @deprecated
|
|
24813
25013
|
*/},{key:"getWebchatGuestConversationMessages",value:function getWebchatGuestConversationMessages(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
24814
25014
|
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']);}/**
|
|
24815
25015
|
* Get WebChat deployment settings
|
|
@@ -24832,24 +25032,27 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24832
25032
|
*/},{key:"postWebchatDeployments",value:function postWebchatDeployments(body){// verify the required parameter 'body' is set
|
|
24833
25033
|
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']);}/**
|
|
24834
25034
|
* Send a message in a chat conversation.
|
|
24835
|
-
*
|
|
25035
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24836
25036
|
* @param {String} conversationId conversationId
|
|
24837
25037
|
* @param {String} memberId memberId
|
|
24838
25038
|
* @param {Object} body Message
|
|
25039
|
+
* @deprecated
|
|
24839
25040
|
*/},{key:"postWebchatGuestConversationMemberMessages",value:function postWebchatGuestConversationMemberMessages(conversationId,memberId,body){// verify the required parameter 'conversationId' is set
|
|
24840
25041
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberMessages';}// verify the required parameter 'memberId' is set
|
|
24841
25042
|
if(memberId===undefined||memberId===null){throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberMessages';}// verify the required parameter 'body' is set
|
|
24842
25043
|
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']);}/**
|
|
24843
25044
|
* Send a typing-indicator in a chat conversation.
|
|
24844
|
-
*
|
|
25045
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24845
25046
|
* @param {String} conversationId conversationId
|
|
24846
25047
|
* @param {String} memberId memberId
|
|
25048
|
+
* @deprecated
|
|
24847
25049
|
*/},{key:"postWebchatGuestConversationMemberTyping",value:function postWebchatGuestConversationMemberTyping(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
24848
25050
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberTyping';}// verify the required parameter 'memberId' is set
|
|
24849
25051
|
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']);}/**
|
|
24850
25052
|
* Create an ACD chat conversation from an external customer.
|
|
24851
|
-
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.
|
|
25053
|
+
* 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.
|
|
24852
25054
|
* @param {Object} body CreateConversationRequest
|
|
25055
|
+
* @deprecated
|
|
24853
25056
|
*/},{key:"postWebchatGuestConversations",value:function postWebchatGuestConversations(body){// verify the required parameter 'body' is set
|
|
24854
25057
|
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']);}/**
|
|
24855
25058
|
* Update a WebChat deployment
|
|
@@ -24867,7 +25070,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24867
25070
|
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(){/**
|
|
24868
25071
|
* WebDeployments service.
|
|
24869
25072
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
24870
|
-
* @version
|
|
25073
|
+
* @version 218.0.0
|
|
24871
25074
|
*//**
|
|
24872
25075
|
* Constructs a new WebDeploymentsApi.
|
|
24873
25076
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -24942,6 +25145,12 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
24942
25145
|
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
24943
25146
|
*/},{key:"getWebdeploymentsDeploymentConfigurations",value:function getWebdeploymentsDeploymentConfigurations(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
24944
25147
|
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']);}/**
|
|
25148
|
+
* Get a deployment identity resolution setting.
|
|
25149
|
+
*
|
|
25150
|
+
* @param {String} deploymentId The deployment ID
|
|
25151
|
+
* getWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25152
|
+
*/},{key:"getWebdeploymentsDeploymentIdentityresolution",value:function getWebdeploymentsDeploymentIdentityresolution(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
25153
|
+
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']);}/**
|
|
24945
25154
|
* Get deployments
|
|
24946
25155
|
*
|
|
24947
25156
|
* @param {Object} opts Optional parameters
|
|
@@ -24985,10 +25194,18 @@ if(configurationVersion===undefined||configurationVersion===null){throw'Missing
|
|
|
24985
25194
|
* @param {Object} deployment
|
|
24986
25195
|
*/},{key:"putWebdeploymentsDeployment",value:function putWebdeploymentsDeployment(deploymentId,deployment){// verify the required parameter 'deploymentId' is set
|
|
24987
25196
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeployment';}// verify the required parameter 'deployment' is set
|
|
24988
|
-
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']);}
|
|
25197
|
+
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']);}/**
|
|
25198
|
+
* Update identity resolution settings for a deployment.
|
|
25199
|
+
*
|
|
25200
|
+
* @param {String} deploymentId The deployment ID
|
|
25201
|
+
* @param {Object} body
|
|
25202
|
+
* putWebdeploymentsDeploymentIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25203
|
+
*/},{key:"putWebdeploymentsDeploymentIdentityresolution",value:function putWebdeploymentsDeploymentIdentityresolution(deploymentId,body){// verify the required parameter 'deploymentId' is set
|
|
25204
|
+
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeploymentIdentityresolution';}// verify the required parameter 'body' is set
|
|
25205
|
+
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(){/**
|
|
24989
25206
|
* WebMessaging service.
|
|
24990
25207
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
24991
|
-
* @version
|
|
25208
|
+
* @version 218.0.0
|
|
24992
25209
|
*//**
|
|
24993
25210
|
* Constructs a new WebMessagingApi.
|
|
24994
25211
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -25004,7 +25221,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
25004
25221
|
*/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(){/**
|
|
25005
25222
|
* Widgets service.
|
|
25006
25223
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
25007
|
-
* @version
|
|
25224
|
+
* @version 218.0.0
|
|
25008
25225
|
*//**
|
|
25009
25226
|
* Constructs a new WidgetsApi.
|
|
25010
25227
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -25013,33 +25230,38 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
25013
25230
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
25014
25231
|
*/function WidgetsApi(apiClient){_classCallCheck(this,WidgetsApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
25015
25232
|
* Delete a Widget deployment
|
|
25016
|
-
*
|
|
25233
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25017
25234
|
* @param {String} deploymentId Widget Config Id
|
|
25235
|
+
* @deprecated
|
|
25018
25236
|
*/return _createClass(WidgetsApi,[{key:"deleteWidgetsDeployment",value:function deleteWidgetsDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
25019
25237
|
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']);}/**
|
|
25020
25238
|
* Get a Widget deployment
|
|
25021
|
-
*
|
|
25239
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25022
25240
|
* @param {String} deploymentId Widget Config Id
|
|
25241
|
+
* @deprecated
|
|
25023
25242
|
*/},{key:"getWidgetsDeployment",value:function getWidgetsDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
25024
25243
|
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']);}/**
|
|
25025
25244
|
* List Widget deployments
|
|
25026
|
-
*
|
|
25245
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25246
|
+
* @deprecated
|
|
25027
25247
|
*/},{key:"getWidgetsDeployments",value:function getWidgetsDeployments(){return this.apiClient.callApi('/api/v2/widgets/deployments','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
25028
25248
|
* Create Widget deployment
|
|
25029
|
-
*
|
|
25249
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25030
25250
|
* @param {Object} body Deployment
|
|
25251
|
+
* @deprecated
|
|
25031
25252
|
*/},{key:"postWidgetsDeployments",value:function postWidgetsDeployments(body){// verify the required parameter 'body' is set
|
|
25032
25253
|
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']);}/**
|
|
25033
25254
|
* Update a Widget deployment
|
|
25034
|
-
*
|
|
25255
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25035
25256
|
* @param {String} deploymentId Widget Config Id
|
|
25036
25257
|
* @param {Object} body Deployment
|
|
25258
|
+
* @deprecated
|
|
25037
25259
|
*/},{key:"putWidgetsDeployment",value:function putWidgetsDeployment(deploymentId,body){// verify the required parameter 'deploymentId' is set
|
|
25038
25260
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling putWidgetsDeployment';}// verify the required parameter 'body' is set
|
|
25039
25261
|
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(){/**
|
|
25040
25262
|
* WorkforceManagement service.
|
|
25041
25263
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
25042
|
-
* @version
|
|
25264
|
+
* @version 218.0.0
|
|
25043
25265
|
*//**
|
|
25044
25266
|
* Constructs a new WorkforceManagementApi.
|
|
25045
25267
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -26858,7 +27080,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
26858
27080
|
* </pre>
|
|
26859
27081
|
* </p>
|
|
26860
27082
|
* @module purecloud-platform-client-v2/index
|
|
26861
|
-
* @version
|
|
27083
|
+
* @version 218.0.0
|
|
26862
27084
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
26863
27085
|
* The ApiClient constructor.
|
|
26864
27086
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|