purecloud-platform-client-v2 217.0.0 → 218.1.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 +1069 -209
- package/dist/web-amd/purecloud-platform-client-v2.js +1069 -209
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +342 -169
- package/dist/web-cjs/purecloud-platform-client-v2.js +342 -169
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +822 -79
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +61 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -4
- 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 +249 -1
- 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 +65 -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 +77 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -6
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -70
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
- 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 +4 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +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 +65 -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 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -6247,7 +6247,7 @@ return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);}/**
|
|
|
6247
6247
|
* @param {string} requestedURL Absolute or relative URL to combine
|
|
6248
6248
|
*
|
|
6249
6249
|
* @returns {string} The combined full path
|
|
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;};/**
|
|
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;};/**
|
|
6251
6251
|
* Config-specific merge-function which creates a new config-object
|
|
6252
6252
|
* by merging two configuration objects together.
|
|
6253
6253
|
*
|
|
@@ -6260,7 +6260,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,prop,cas
|
|
|
6260
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
|
|
6261
6261
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
6262
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
|
|
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),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
|
|
6264
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
|
|
6265
6265
|
}else if((contentType=headers.getContentType())!==false){// fix semicolon duplication issue for ReactNative FormData implementation
|
|
6266
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
|
|
@@ -6316,7 +6316,7 @@ isCredentialsSupported="credentials"in Request.prototype;request=new Request(url
|
|
|
6316
6316
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
6317
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
|
|
6318
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
|
|
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.
|
|
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
|
|
6320
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={};/**
|
|
6321
6321
|
* Transitional option validator
|
|
6322
6322
|
*
|
|
@@ -6458,7 +6458,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6458
6458
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6459
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];}}}]);}();/**
|
|
6460
6460
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6461
|
-
* @version
|
|
6461
|
+
* @version 218.1.0
|
|
6462
6462
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6463
6463
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6464
6464
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6801,7 +6801,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6801
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(){/**
|
|
6802
6802
|
* AgentAssistants service.
|
|
6803
6803
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6804
|
-
* @version
|
|
6804
|
+
* @version 218.1.0
|
|
6805
6805
|
*//**
|
|
6806
6806
|
* Constructs a new AgentAssistantsApi.
|
|
6807
6807
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6902,7 +6902,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6902
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(){/**
|
|
6903
6903
|
* AgentCopilot service.
|
|
6904
6904
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6905
|
-
* @version
|
|
6905
|
+
* @version 218.1.0
|
|
6906
6906
|
*//**
|
|
6907
6907
|
* Constructs a new AgentCopilotApi.
|
|
6908
6908
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6924,7 +6924,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6924
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(){/**
|
|
6925
6925
|
* AgentUI service.
|
|
6926
6926
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6927
|
-
* @version
|
|
6927
|
+
* @version 218.1.0
|
|
6928
6928
|
*//**
|
|
6929
6929
|
* Constructs a new AgentUIApi.
|
|
6930
6930
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6958,7 +6958,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6958
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(){/**
|
|
6959
6959
|
* Alerting service.
|
|
6960
6960
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6961
|
-
* @version
|
|
6961
|
+
* @version 218.1.0
|
|
6962
6962
|
*//**
|
|
6963
6963
|
* Constructs a new AlertingApi.
|
|
6964
6964
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -7047,7 +7047,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
7047
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(){/**
|
|
7048
7048
|
* Analytics service.
|
|
7049
7049
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7050
|
-
* @version
|
|
7050
|
+
* @version 218.1.0
|
|
7051
7051
|
*//**
|
|
7052
7052
|
* Constructs a new AnalyticsApi.
|
|
7053
7053
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7082,7 +7082,6 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7082
7082
|
* Get an agent and their active sessions by user ID
|
|
7083
7083
|
*
|
|
7084
7084
|
* @param {String} userId userId
|
|
7085
|
-
* getAnalyticsAgentStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7086
7085
|
*/},{key:"getAnalyticsAgentStatus",value:function getAnalyticsAgentStatus(userId){// verify the required parameter 'userId' is set
|
|
7087
7086
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getAnalyticsAgentStatus';}return this.apiClient.callApi('/api/v2/analytics/agents/{userId}/status','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7088
7087
|
* Get status for async query for agent copilot aggregates
|
|
@@ -7447,13 +7446,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7447
7446
|
* Count agents by segment type
|
|
7448
7447
|
*
|
|
7449
7448
|
* @param {Object} body query
|
|
7450
|
-
* postAnalyticsAgentsStatusCounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7451
7449
|
*/},{key:"postAnalyticsAgentsStatusCounts",value:function postAnalyticsAgentsStatusCounts(body){// verify the required parameter 'body' is set
|
|
7452
7450
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsAgentsStatusCounts';}return this.apiClient.callApi('/api/v2/analytics/agents/status/counts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7453
7451
|
* Retrieve the top 50 agents matching the query filters
|
|
7454
7452
|
*
|
|
7455
7453
|
* @param {Object} body query
|
|
7456
|
-
* postAnalyticsAgentsStatusQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7457
7454
|
*/},{key:"postAnalyticsAgentsStatusQuery",value:function postAnalyticsAgentsStatusQuery(body){// verify the required parameter 'body' is set
|
|
7458
7455
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsAgentsStatusQuery';}return this.apiClient.callApi('/api/v2/analytics/agents/status/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7459
7456
|
* Query for bot aggregates asynchronously
|
|
@@ -7718,7 +7715,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7718
7715
|
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(){/**
|
|
7719
7716
|
* Architect service.
|
|
7720
7717
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7721
|
-
* @version
|
|
7718
|
+
* @version 218.1.0
|
|
7722
7719
|
*//**
|
|
7723
7720
|
* Constructs a new ArchitectApi.
|
|
7724
7721
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8562,6 +8559,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8562
8559
|
* @param {String} promptId Prompt ID
|
|
8563
8560
|
*/},{key:"postArchitectPromptHistory",value:function postArchitectPromptHistory(promptId){// verify the required parameter 'promptId' is set
|
|
8564
8561
|
if(promptId===undefined||promptId===null){throw'Missing the required parameter "promptId" when calling postArchitectPromptHistory';}return this.apiClient.callApi('/api/v2/architect/prompts/{promptId}/history','POST',{'promptId':promptId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8562
|
+
* Creates a presigned URL for uploading a user prompt file
|
|
8563
|
+
*
|
|
8564
|
+
* @param {String} promptId Prompt ID
|
|
8565
|
+
* @param {String} languageCode Language
|
|
8566
|
+
*/},{key:"postArchitectPromptResourceUploads",value:function postArchitectPromptResourceUploads(promptId,languageCode){// verify the required parameter 'promptId' is set
|
|
8567
|
+
if(promptId===undefined||promptId===null){throw'Missing the required parameter "promptId" when calling postArchitectPromptResourceUploads';}// verify the required parameter 'languageCode' is set
|
|
8568
|
+
if(languageCode===undefined||languageCode===null){throw'Missing the required parameter "languageCode" when calling postArchitectPromptResourceUploads';}return this.apiClient.callApi('/api/v2/architect/prompts/{promptId}/resources/{languageCode}/uploads','POST',{'promptId':promptId,'languageCode':languageCode},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8565
8569
|
* Create a new user prompt resource
|
|
8566
8570
|
*
|
|
8567
8571
|
* @param {String} promptId Prompt ID
|
|
@@ -8589,6 +8593,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8589
8593
|
* @param {String} promptId promptId
|
|
8590
8594
|
*/},{key:"postArchitectSystempromptHistory",value:function postArchitectSystempromptHistory(promptId){// verify the required parameter 'promptId' is set
|
|
8591
8595
|
if(promptId===undefined||promptId===null){throw'Missing the required parameter "promptId" when calling postArchitectSystempromptHistory';}return this.apiClient.callApi('/api/v2/architect/systemprompts/{promptId}/history','POST',{'promptId':promptId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8596
|
+
* Creates a presigned URL for uploading a system prompt file
|
|
8597
|
+
*
|
|
8598
|
+
* @param {String} promptId Prompt ID
|
|
8599
|
+
* @param {String} languageCode Language
|
|
8600
|
+
*/},{key:"postArchitectSystempromptResourceUploads",value:function postArchitectSystempromptResourceUploads(promptId,languageCode){// verify the required parameter 'promptId' is set
|
|
8601
|
+
if(promptId===undefined||promptId===null){throw'Missing the required parameter "promptId" when calling postArchitectSystempromptResourceUploads';}// verify the required parameter 'languageCode' is set
|
|
8602
|
+
if(languageCode===undefined||languageCode===null){throw'Missing the required parameter "languageCode" when calling postArchitectSystempromptResourceUploads';}return this.apiClient.callApi('/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}/uploads','POST',{'promptId':promptId,'languageCode':languageCode},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8592
8603
|
* Create system prompt resource override.
|
|
8593
8604
|
*
|
|
8594
8605
|
* @param {String} promptId Prompt ID
|
|
@@ -8836,7 +8847,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8836
8847
|
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(){/**
|
|
8837
8848
|
* Audit service.
|
|
8838
8849
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8839
|
-
* @version
|
|
8850
|
+
* @version 218.1.0
|
|
8840
8851
|
*//**
|
|
8841
8852
|
* Constructs a new AuditApi.
|
|
8842
8853
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8886,7 +8897,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8886
8897
|
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(){/**
|
|
8887
8898
|
* Authorization service.
|
|
8888
8899
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8889
|
-
* @version
|
|
8900
|
+
* @version 218.1.0
|
|
8890
8901
|
*//**
|
|
8891
8902
|
* Constructs a new AuthorizationApi.
|
|
8892
8903
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -9306,7 +9317,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
9306
9317
|
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(){/**
|
|
9307
9318
|
* Billing service.
|
|
9308
9319
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9309
|
-
* @version
|
|
9320
|
+
* @version 218.1.0
|
|
9310
9321
|
*//**
|
|
9311
9322
|
* Constructs a new BillingApi.
|
|
9312
9323
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -9330,7 +9341,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
9330
9341
|
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(){/**
|
|
9331
9342
|
* CarrierServices service.
|
|
9332
9343
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9333
|
-
* @version
|
|
9344
|
+
* @version 218.1.0
|
|
9334
9345
|
*//**
|
|
9335
9346
|
* Constructs a new CarrierServicesApi.
|
|
9336
9347
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -9350,7 +9361,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
9350
9361
|
*/},{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(){/**
|
|
9351
9362
|
* Chat service.
|
|
9352
9363
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9353
|
-
* @version
|
|
9364
|
+
* @version 218.1.0
|
|
9354
9365
|
*//**
|
|
9355
9366
|
* Constructs a new ChatApi.
|
|
9356
9367
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9390,7 +9401,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
9390
9401
|
*
|
|
9391
9402
|
* @param {String} userId userId
|
|
9392
9403
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
9393
|
-
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9394
9404
|
*/},{key:"deleteChatsUserMessagesPin",value:function deleteChatsUserMessagesPin(userId,pinnedMessageId){// verify the required parameter 'userId' is set
|
|
9395
9405
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';}// verify the required parameter 'pinnedMessageId' is set
|
|
9396
9406
|
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']);}/**
|
|
@@ -9447,7 +9457,6 @@ if(threadId===undefined||threadId===null){throw'Missing the required parameter "
|
|
|
9447
9457
|
* Get information for a 1on1
|
|
9448
9458
|
*
|
|
9449
9459
|
* @param {String} userId userId
|
|
9450
|
-
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9451
9460
|
*/},{key:"getChatsUser",value:function getChatsUser(userId){// verify the required parameter 'userId' is set
|
|
9452
9461
|
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']);}/**
|
|
9453
9462
|
* Get messages by id(s) from a 1on1
|
|
@@ -9553,7 +9562,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9553
9562
|
*
|
|
9554
9563
|
* @param {String} userId userId
|
|
9555
9564
|
* @param {Object} body Pinned Message Ids
|
|
9556
|
-
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9557
9565
|
*/},{key:"postChatsUserMessagesPins",value:function postChatsUserMessagesPins(userId,body){// verify the required parameter 'userId' is set
|
|
9558
9566
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessagesPins';}// verify the required parameter 'body' is set
|
|
9559
9567
|
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']);}/**
|
|
@@ -9571,7 +9579,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9571
9579
|
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(){/**
|
|
9572
9580
|
* Coaching service.
|
|
9573
9581
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9574
|
-
* @version
|
|
9582
|
+
* @version 218.1.0
|
|
9575
9583
|
*//**
|
|
9576
9584
|
* Constructs a new CoachingApi.
|
|
9577
9585
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9724,7 +9732,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9724
9732
|
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(){/**
|
|
9725
9733
|
* ContentManagement service.
|
|
9726
9734
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9727
|
-
* @version
|
|
9735
|
+
* @version 218.1.0
|
|
9728
9736
|
*//**
|
|
9729
9737
|
* Constructs a new ContentManagementApi.
|
|
9730
9738
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -10006,7 +10014,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
10006
10014
|
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(){/**
|
|
10007
10015
|
* Conversations service.
|
|
10008
10016
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10009
|
-
* @version
|
|
10017
|
+
* @version 218.1.0
|
|
10010
10018
|
*//**
|
|
10011
10019
|
* Constructs a new ConversationsApi.
|
|
10012
10020
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10069,6 +10077,11 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
10069
10077
|
* @param {String} integrationId Integration ID
|
|
10070
10078
|
*/},{key:"deleteConversationsMessagingIntegrationsOpenIntegrationId",value:function deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10071
10079
|
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']);}/**
|
|
10080
|
+
* Delete Twitter messaging integration
|
|
10081
|
+
*
|
|
10082
|
+
* @param {String} integrationId Integration ID
|
|
10083
|
+
*/},{key:"deleteConversationsMessagingIntegrationsTwitterIntegrationId",value:function deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10084
|
+
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']);}/**
|
|
10072
10085
|
* Delete a WhatsApp messaging integration
|
|
10073
10086
|
*
|
|
10074
10087
|
* @param {String} integrationId Integration ID
|
|
@@ -10536,6 +10549,11 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
10536
10549
|
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10537
10550
|
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
10538
10551
|
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']);}/**
|
|
10552
|
+
* Get twitter oauth settings to patch an integration
|
|
10553
|
+
*
|
|
10554
|
+
* @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
|
|
10555
|
+
*/},{key:"getConversationsMessagingIntegrationTwitterOauthSettings",value:function getConversationsMessagingIntegrationTwitterOauthSettings(integrationId){// verify the required parameter 'integrationId' is set
|
|
10556
|
+
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']);}/**
|
|
10539
10557
|
* Get a list of Integrations
|
|
10540
10558
|
*
|
|
10541
10559
|
* @param {Object} opts Optional parameters
|
|
@@ -10593,6 +10611,25 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
10593
10611
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
10594
10612
|
*/},{key:"getConversationsMessagingIntegrationsOpenIntegrationId",value:function getConversationsMessagingIntegrationsOpenIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
10595
10613
|
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']);}/**
|
|
10614
|
+
* Get a list of Twitter Integrations
|
|
10615
|
+
*
|
|
10616
|
+
* @param {Object} opts Optional parameters
|
|
10617
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
10618
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10619
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
10620
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
10621
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
10622
|
+
*/},{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']);}/**
|
|
10623
|
+
* Get Twitter messaging integration
|
|
10624
|
+
*
|
|
10625
|
+
* @param {String} integrationId Integration ID
|
|
10626
|
+
* @param {Object} opts Optional parameters
|
|
10627
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
10628
|
+
*/},{key:"getConversationsMessagingIntegrationsTwitterIntegrationId",value:function getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
10629
|
+
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']);}/**
|
|
10630
|
+
* Get twitter oauth settings
|
|
10631
|
+
*
|
|
10632
|
+
*/},{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']);}/**
|
|
10596
10633
|
* Get a list of WhatsApp Integrations
|
|
10597
10634
|
*
|
|
10598
10635
|
* @param {Object} opts Optional parameters
|
|
@@ -10714,6 +10751,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10714
10751
|
*/},{key:"patchConversationSecureattributes",value:function patchConversationSecureattributes(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
10715
10752
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';}// verify the required parameter 'body' is set
|
|
10716
10753
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationSecureattributes';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/secureattributes','PATCH',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10754
|
+
* Update the feedback for the summary.
|
|
10755
|
+
*
|
|
10756
|
+
* @param {String} conversationId Conversation ID
|
|
10757
|
+
* @param {String} summaryId Summary ID
|
|
10758
|
+
* @param {Object} opts Optional parameters
|
|
10759
|
+
* @param {Object} opts.body
|
|
10760
|
+
* patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10761
|
+
*/},{key:"patchConversationSummaryFeedback",value:function patchConversationSummaryFeedback(conversationId,summaryId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10762
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationSummaryFeedback';}// verify the required parameter 'summaryId' is set
|
|
10763
|
+
if(summaryId===undefined||summaryId===null){throw'Missing the required parameter "summaryId" when calling patchConversationSummaryFeedback';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback','PATCH',{'conversationId':conversationId,'summaryId':summaryId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10717
10764
|
* Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
|
10718
10765
|
*
|
|
10719
10766
|
* @param {String} conversationId conversation ID
|
|
@@ -11009,6 +11056,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11009
11056
|
*/},{key:"patchConversationsMessagingIntegrationsOpenIntegrationId",value:function patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
11010
11057
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
11011
11058
|
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']);}/**
|
|
11059
|
+
* Update a Twitter messaging integration
|
|
11060
|
+
*
|
|
11061
|
+
* @param {String} integrationId Integration ID
|
|
11062
|
+
* @param {Object} body TwitterIntegrationUpdateRequest
|
|
11063
|
+
*/},{key:"patchConversationsMessagingIntegrationsTwitterIntegrationId",value:function patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
11064
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}// verify the required parameter 'body' is set
|
|
11065
|
+
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']);}/**
|
|
11012
11066
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
11013
11067
|
* 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
|
|
11014
11068
|
* @param {String} integrationId Integration ID
|
|
@@ -11577,6 +11631,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11577
11631
|
* @param {Object} body OpenIntegrationRequest
|
|
11578
11632
|
*/},{key:"postConversationsMessagingIntegrationsOpen",value:function postConversationsMessagingIntegrationsOpen(body){// verify the required parameter 'body' is set
|
|
11579
11633
|
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']);}/**
|
|
11634
|
+
* Create Twitter Integration
|
|
11635
|
+
*
|
|
11636
|
+
* @param {Object} body TwitterIntegrationRequest
|
|
11637
|
+
*/},{key:"postConversationsMessagingIntegrationsTwitter",value:function postConversationsMessagingIntegrationsTwitter(body){// verify the required parameter 'body' is set
|
|
11638
|
+
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']);}/**
|
|
11580
11639
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
11581
11640
|
* [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.
|
|
11582
11641
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
@@ -11626,6 +11685,14 @@ if(communicationId===undefined||communicationId===null){throw'Missing the requir
|
|
|
11626
11685
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
11627
11686
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
11628
11687
|
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']);}/**
|
|
11688
|
+
* Create an Agent-Type video conference and assign an agent to it
|
|
11689
|
+
*
|
|
11690
|
+
* @param {String} conversationId conversationId
|
|
11691
|
+
* @param {String} communicationId communicationId
|
|
11692
|
+
* postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11693
|
+
*/},{key:"postConversationsVideoAgentconferenceCommunication",value:function postConversationsVideoAgentconferenceCommunication(conversationId,communicationId){// verify the required parameter 'conversationId' is set
|
|
11694
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';}// verify the required parameter 'communicationId' is set
|
|
11695
|
+
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']);}/**
|
|
11629
11696
|
* Apply wrap-up for this conversation communication
|
|
11630
11697
|
*
|
|
11631
11698
|
* @param {String} conversationId conversationId
|
|
@@ -11796,7 +11863,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11796
11863
|
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(){/**
|
|
11797
11864
|
* DataExtensions service.
|
|
11798
11865
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11799
|
-
* @version
|
|
11866
|
+
* @version 218.1.0
|
|
11800
11867
|
*//**
|
|
11801
11868
|
* Constructs a new DataExtensionsApi.
|
|
11802
11869
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11817,7 +11884,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11817
11884
|
*/},{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(){/**
|
|
11818
11885
|
* DataPrivacy service.
|
|
11819
11886
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
11820
|
-
* @version
|
|
11887
|
+
* @version 218.1.0
|
|
11821
11888
|
*//**
|
|
11822
11889
|
* Constructs a new DataPrivacyApi.
|
|
11823
11890
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -11857,7 +11924,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11857
11924
|
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(){/**
|
|
11858
11925
|
* Downloads service.
|
|
11859
11926
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11860
|
-
* @version
|
|
11927
|
+
* @version 218.1.0
|
|
11861
11928
|
*//**
|
|
11862
11929
|
* Constructs a new DownloadsApi.
|
|
11863
11930
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11876,7 +11943,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11876
11943
|
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(){/**
|
|
11877
11944
|
* Emails service.
|
|
11878
11945
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11879
|
-
* @version
|
|
11946
|
+
* @version 218.1.0
|
|
11880
11947
|
*//**
|
|
11881
11948
|
* Constructs a new EmailsApi.
|
|
11882
11949
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11884,17 +11951,28 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11884
11951
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
11885
11952
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
11886
11953
|
*/function EmailsApi(apiClient){_classCallCheck(this,EmailsApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
11954
|
+
* Reset email threading settings to default
|
|
11955
|
+
*
|
|
11956
|
+
*/return _createClass(EmailsApi,[{key:"deleteEmailsSettingsThreading",value:function deleteEmailsSettingsThreading(){return this.apiClient.callApi('/api/v2/emails/settings/threading','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11887
11957
|
* Get email Contact Center settings
|
|
11888
11958
|
*
|
|
11889
|
-
*/
|
|
11959
|
+
*/},{key:"getEmailsSettings",value:function getEmailsSettings(){return this.apiClient.callApi('/api/v2/emails/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11960
|
+
* Get email threading settings
|
|
11961
|
+
*
|
|
11962
|
+
*/},{key:"getEmailsSettingsThreading",value:function getEmailsSettingsThreading(){return this.apiClient.callApi('/api/v2/emails/settings/threading','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11890
11963
|
* Patch email Contact Center settings
|
|
11891
11964
|
*
|
|
11892
11965
|
* @param {Object} opts Optional parameters
|
|
11893
11966
|
* @param {Object} opts.body
|
|
11894
|
-
*/},{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']);}
|
|
11967
|
+
*/},{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']);}/**
|
|
11968
|
+
* Patch email threading settings
|
|
11969
|
+
*
|
|
11970
|
+
* @param {Object} opts Optional parameters
|
|
11971
|
+
* @param {Object} opts.body
|
|
11972
|
+
*/},{key:"patchEmailsSettingsThreading",value:function patchEmailsSettingsThreading(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings/threading','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
11895
11973
|
* EmployeeEngagement service.
|
|
11896
11974
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11897
|
-
* @version
|
|
11975
|
+
* @version 218.1.0
|
|
11898
11976
|
*//**
|
|
11899
11977
|
* Constructs a new EmployeeEngagementApi.
|
|
11900
11978
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11932,7 +12010,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11932
12010
|
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(){/**
|
|
11933
12011
|
* Events service.
|
|
11934
12012
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11935
|
-
* @version
|
|
12013
|
+
* @version 218.1.0
|
|
11936
12014
|
*//**
|
|
11937
12015
|
* Constructs a new EventsApi.
|
|
11938
12016
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11957,7 +12035,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11957
12035
|
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(){/**
|
|
11958
12036
|
* ExternalContacts service.
|
|
11959
12037
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11960
|
-
* @version
|
|
12038
|
+
* @version 218.1.0
|
|
11961
12039
|
*//**
|
|
11962
12040
|
* Constructs a new ExternalContactsApi.
|
|
11963
12041
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -12076,6 +12154,18 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
12076
12154
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
12077
12155
|
* @param {Array.<String>} opts.divisionIds which divisions to search, up to 50
|
|
12078
12156
|
*/},{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']);}/**
|
|
12157
|
+
* Get export for exportId
|
|
12158
|
+
*
|
|
12159
|
+
* @param {String} exportId Export id
|
|
12160
|
+
*/},{key:"getExternalcontactsContactsExport",value:function getExternalcontactsContactsExport(exportId){// verify the required parameter 'exportId' is set
|
|
12161
|
+
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']);}/**
|
|
12162
|
+
* List exports for organization
|
|
12163
|
+
*
|
|
12164
|
+
* @param {Object} opts Optional parameters
|
|
12165
|
+
* @param {Array.<String>} opts.divisionIds Division IDs of entities
|
|
12166
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities
|
|
12167
|
+
* @param {Number} opts.pageSize Number of entities to return
|
|
12168
|
+
*/},{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']);}/**
|
|
12079
12169
|
* Get a schema
|
|
12080
12170
|
*
|
|
12081
12171
|
* @param {String} schemaId Schema ID
|
|
@@ -12432,6 +12522,11 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
12432
12522
|
* @param {Object} body ExternalContact
|
|
12433
12523
|
*/},{key:"postExternalcontactsContacts",value:function postExternalcontactsContacts(body){// verify the required parameter 'body' is set
|
|
12434
12524
|
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']);}/**
|
|
12525
|
+
* Create bulk export
|
|
12526
|
+
*
|
|
12527
|
+
* @param {Object} body Export
|
|
12528
|
+
*/},{key:"postExternalcontactsContactsExports",value:function postExternalcontactsContactsExports(body){// verify the required parameter 'body' is set
|
|
12529
|
+
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']);}/**
|
|
12435
12530
|
* Create a schema
|
|
12436
12531
|
*
|
|
12437
12532
|
* @param {Object} body Schema
|
|
@@ -12599,7 +12694,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
12599
12694
|
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(){/**
|
|
12600
12695
|
* Fax service.
|
|
12601
12696
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
12602
|
-
* @version
|
|
12697
|
+
* @version 218.1.0
|
|
12603
12698
|
*//**
|
|
12604
12699
|
* Constructs a new FaxApi.
|
|
12605
12700
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -12648,7 +12743,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12648
12743
|
*/},{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(){/**
|
|
12649
12744
|
* Flows service.
|
|
12650
12745
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
12651
|
-
* @version
|
|
12746
|
+
* @version 218.1.0
|
|
12652
12747
|
*//**
|
|
12653
12748
|
* Constructs a new FlowsApi.
|
|
12654
12749
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12696,7 +12791,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12696
12791
|
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(){/**
|
|
12697
12792
|
* Gamification service.
|
|
12698
12793
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12699
|
-
* @version
|
|
12794
|
+
* @version 218.1.0
|
|
12700
12795
|
*//**
|
|
12701
12796
|
* Constructs a new GamificationApi.
|
|
12702
12797
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -13255,7 +13350,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13255
13350
|
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(){/**
|
|
13256
13351
|
* GeneralDataProtectionRegulation service.
|
|
13257
13352
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
13258
|
-
* @version
|
|
13353
|
+
* @version 218.1.0
|
|
13259
13354
|
*//**
|
|
13260
13355
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
13261
13356
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -13290,7 +13385,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
13290
13385
|
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(){/**
|
|
13291
13386
|
* Geolocation service.
|
|
13292
13387
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
13293
|
-
* @version
|
|
13388
|
+
* @version 218.1.0
|
|
13294
13389
|
*//**
|
|
13295
13390
|
* Constructs a new GeolocationApi.
|
|
13296
13391
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -13324,7 +13419,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
13324
13419
|
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(){/**
|
|
13325
13420
|
* Greetings service.
|
|
13326
13421
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
13327
|
-
* @version
|
|
13422
|
+
* @version 218.1.0
|
|
13328
13423
|
*//**
|
|
13329
13424
|
* Constructs a new GreetingsApi.
|
|
13330
13425
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -13431,7 +13526,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13431
13526
|
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(){/**
|
|
13432
13527
|
* Groups service.
|
|
13433
13528
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
13434
|
-
* @version
|
|
13529
|
+
* @version 218.1.0
|
|
13435
13530
|
*//**
|
|
13436
13531
|
* Constructs a new GroupsApi.
|
|
13437
13532
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -13564,7 +13659,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
13564
13659
|
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(){/**
|
|
13565
13660
|
* IdentityProvider service.
|
|
13566
13661
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
13567
|
-
* @version
|
|
13662
|
+
* @version 218.1.0
|
|
13568
13663
|
*//**
|
|
13569
13664
|
* Constructs a new IdentityProviderApi.
|
|
13570
13665
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13720,7 +13815,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13720
13815
|
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(){/**
|
|
13721
13816
|
* InfrastructureAsCode service.
|
|
13722
13817
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13723
|
-
* @version
|
|
13818
|
+
* @version 218.1.0
|
|
13724
13819
|
*//**
|
|
13725
13820
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13726
13821
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13774,7 +13869,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13774
13869
|
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(){/**
|
|
13775
13870
|
* Integrations service.
|
|
13776
13871
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13777
|
-
* @version
|
|
13872
|
+
* @version 218.1.0
|
|
13778
13873
|
*//**
|
|
13779
13874
|
* Constructs a new IntegrationsApi.
|
|
13780
13875
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -14357,6 +14452,13 @@ if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing th
|
|
|
14357
14452
|
*/},{key:"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate",value:function postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId,settings){// verify the required parameter 'nuanceIntegrationId' is set
|
|
14358
14453
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';}// verify the required parameter 'settings' is set
|
|
14359
14454
|
if(settings===undefined||settings===null){throw'Missing the required parameter "settings" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate','POST',{'nuanceIntegrationId':nuanceIntegrationId},{},{},{},settings,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14455
|
+
* Invoke Webhook
|
|
14456
|
+
*
|
|
14457
|
+
* @param {String} tokenId The token of the webhook to be invoked
|
|
14458
|
+
* @param {Object.<String, {String: Object}>} body Webhook Invocation Payload
|
|
14459
|
+
*/},{key:"postIntegrationsWebhookEvents",value:function postIntegrationsWebhookEvents(tokenId,body){// verify the required parameter 'tokenId' is set
|
|
14460
|
+
if(tokenId===undefined||tokenId===null){throw'Missing the required parameter "tokenId" when calling postIntegrationsWebhookEvents';}// verify the required parameter 'body' is set
|
|
14461
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsWebhookEvents';}return this.apiClient.callApi('/api/v2/integrations/webhooks/{tokenId}/events','POST',{'tokenId':tokenId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14360
14462
|
* Update integration configuration.
|
|
14361
14463
|
*
|
|
14362
14464
|
* @param {String} integrationId Integration Id
|
|
@@ -14406,7 +14508,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
14406
14508
|
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(){/**
|
|
14407
14509
|
* Journey service.
|
|
14408
14510
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
14409
|
-
* @version
|
|
14511
|
+
* @version 218.1.0
|
|
14410
14512
|
*//**
|
|
14411
14513
|
* Constructs a new JourneyApi.
|
|
14412
14514
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -14886,7 +14988,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
14886
14988
|
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(){/**
|
|
14887
14989
|
* Knowledge service.
|
|
14888
14990
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14889
|
-
* @version
|
|
14991
|
+
* @version 218.1.0
|
|
14890
14992
|
*//**
|
|
14891
14993
|
* Constructs a new KnowledgeApi.
|
|
14892
14994
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -15260,7 +15362,6 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
15260
15362
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
15261
15363
|
* @param {String} uploadId UploadId
|
|
15262
15364
|
* @deprecated
|
|
15263
|
-
* getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15264
15365
|
*/},{key:"getKnowledgeKnowledgebaseLanguageDocumentUpload",value:function getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId,knowledgeBaseId,languageCode,uploadId){// verify the required parameter 'documentId' is set
|
|
15265
15366
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'knowledgeBaseId' is set
|
|
15266
15367
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';}// verify the required parameter 'languageCode' is set
|
|
@@ -15727,7 +15828,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15727
15828
|
*
|
|
15728
15829
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15729
15830
|
* @param {Object} body
|
|
15730
|
-
* postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15731
15831
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsBulkRemove",value:function postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15732
15832
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';}// verify the required parameter 'body' is set
|
|
15733
15833
|
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']);}/**
|
|
@@ -15735,7 +15835,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15735
15835
|
*
|
|
15736
15836
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15737
15837
|
* @param {Object} body
|
|
15738
|
-
* postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15739
15838
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsBulkUpdate",value:function postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15740
15839
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';}// verify the required parameter 'body' is set
|
|
15741
15840
|
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']);}/**
|
|
@@ -15773,7 +15872,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
15773
15872
|
*
|
|
15774
15873
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15775
15874
|
* @param {Object} body
|
|
15776
|
-
* postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15777
15875
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd",value:function postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15778
15876
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';}// verify the required parameter 'body' is set
|
|
15779
15877
|
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']);}/**
|
|
@@ -15815,7 +15913,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15815
15913
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
15816
15914
|
* @param {Object} body
|
|
15817
15915
|
* @deprecated
|
|
15818
|
-
* postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15819
15916
|
*/},{key:"postKnowledgeKnowledgebaseLanguageDocumentUploads",value:function postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId,knowledgeBaseId,languageCode,body){// verify the required parameter 'documentId' is set
|
|
15820
15917
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'knowledgeBaseId' is set
|
|
15821
15918
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';}// verify the required parameter 'languageCode' is set
|
|
@@ -15954,7 +16051,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15954
16051
|
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(){/**
|
|
15955
16052
|
* LanguageUnderstanding service.
|
|
15956
16053
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15957
|
-
* @version
|
|
16054
|
+
* @version 218.1.0
|
|
15958
16055
|
*//**
|
|
15959
16056
|
* Constructs a new LanguageUnderstandingApi.
|
|
15960
16057
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -16213,7 +16310,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
16213
16310
|
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(){/**
|
|
16214
16311
|
* Languages service.
|
|
16215
16312
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
16216
|
-
* @version
|
|
16313
|
+
* @version 218.1.0
|
|
16217
16314
|
*//**
|
|
16218
16315
|
* Constructs a new LanguagesApi.
|
|
16219
16316
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -16268,7 +16365,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16268
16365
|
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(){/**
|
|
16269
16366
|
* Learning service.
|
|
16270
16367
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
16271
|
-
* @version
|
|
16368
|
+
* @version 218.1.0
|
|
16272
16369
|
*//**
|
|
16273
16370
|
* Constructs a new LearningApi.
|
|
16274
16371
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -16539,7 +16636,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
16539
16636
|
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(){/**
|
|
16540
16637
|
* License service.
|
|
16541
16638
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
16542
|
-
* @version
|
|
16639
|
+
* @version 218.1.0
|
|
16543
16640
|
*//**
|
|
16544
16641
|
* Constructs a new LicenseApi.
|
|
16545
16642
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -16593,7 +16690,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
16593
16690
|
*/},{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(){/**
|
|
16594
16691
|
* Locations service.
|
|
16595
16692
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
16596
|
-
* @version
|
|
16693
|
+
* @version 218.1.0
|
|
16597
16694
|
*//**
|
|
16598
16695
|
* Constructs a new LocationsApi.
|
|
16599
16696
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -16652,7 +16749,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16652
16749
|
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(){/**
|
|
16653
16750
|
* LogCapture service.
|
|
16654
16751
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
16655
|
-
* @version
|
|
16752
|
+
* @version 218.1.0
|
|
16656
16753
|
*//**
|
|
16657
16754
|
* Constructs a new LogCaptureApi.
|
|
16658
16755
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -16702,7 +16799,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16702
16799
|
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(){/**
|
|
16703
16800
|
* Messaging service.
|
|
16704
16801
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
16705
|
-
* @version
|
|
16802
|
+
* @version 218.1.0
|
|
16706
16803
|
*//**
|
|
16707
16804
|
* Constructs a new MessagingApi.
|
|
16708
16805
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16792,7 +16889,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16792
16889
|
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(){/**
|
|
16793
16890
|
* MobileDevices service.
|
|
16794
16891
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16795
|
-
* @version
|
|
16892
|
+
* @version 218.1.0
|
|
16796
16893
|
*//**
|
|
16797
16894
|
* Constructs a new MobileDevicesApi.
|
|
16798
16895
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16831,7 +16928,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16831
16928
|
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(){/**
|
|
16832
16929
|
* Notifications service.
|
|
16833
16930
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16834
|
-
* @version
|
|
16931
|
+
* @version 218.1.0
|
|
16835
16932
|
*//**
|
|
16836
16933
|
* Constructs a new NotificationsApi.
|
|
16837
16934
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16888,7 +16985,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16888
16985
|
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(){/**
|
|
16889
16986
|
* OAuth service.
|
|
16890
16987
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16891
|
-
* @version
|
|
16988
|
+
* @version 218.1.0
|
|
16892
16989
|
*//**
|
|
16893
16990
|
* Constructs a new OAuthApi.
|
|
16894
16991
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16973,7 +17070,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16973
17070
|
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(){/**
|
|
16974
17071
|
* Objects service.
|
|
16975
17072
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16976
|
-
* @version
|
|
17073
|
+
* @version 218.1.0
|
|
16977
17074
|
*//**
|
|
16978
17075
|
* Constructs a new ObjectsApi.
|
|
16979
17076
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -17044,7 +17141,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
17044
17141
|
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(){/**
|
|
17045
17142
|
* OperationalEvents service.
|
|
17046
17143
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
17047
|
-
* @version
|
|
17144
|
+
* @version 218.1.0
|
|
17048
17145
|
*//**
|
|
17049
17146
|
* Constructs a new OperationalEventsApi.
|
|
17050
17147
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -17075,7 +17172,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
17075
17172
|
*/},{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(){/**
|
|
17076
17173
|
* Organization service.
|
|
17077
17174
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
17078
|
-
* @version
|
|
17175
|
+
* @version 218.1.0
|
|
17079
17176
|
*//**
|
|
17080
17177
|
* Constructs a new OrganizationApi.
|
|
17081
17178
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -17125,33 +17222,11 @@ if(requestId===undefined||requestId===null){throw'Missing the required parameter
|
|
|
17125
17222
|
* @param {String} namespaceName The namespace to fetch limits for
|
|
17126
17223
|
*/},{key:"getOrganizationsLimitsNamespace",value:function getOrganizationsLimitsNamespace(namespaceName){// verify the required parameter 'namespaceName' is set
|
|
17127
17224
|
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']);}/**
|
|
17128
|
-
* 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.
|
|
17129
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
17130
|
-
* @param {String} namespaceName The namespace to get
|
|
17131
|
-
* @param {Object} opts Optional parameters
|
|
17132
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
17133
|
-
* @param {String} opts.entityId entity id of the count
|
|
17134
|
-
* @param {String} opts.userId userid of the count
|
|
17135
|
-
* @deprecated
|
|
17136
|
-
*/},{key:"getOrganizationsLimitsNamespaceCounts",value:function getOrganizationsLimitsNamespaceCounts(namespaceName,opts){opts=opts||{};// verify the required parameter 'namespaceName' is set
|
|
17137
|
-
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']);}/**
|
|
17138
17225
|
* Get the default limits in a namespace for an organization
|
|
17139
17226
|
*
|
|
17140
17227
|
* @param {String} namespaceName The namespace to fetch defaults limits for
|
|
17141
17228
|
*/},{key:"getOrganizationsLimitsNamespaceDefaults",value:function getOrganizationsLimitsNamespaceDefaults(namespaceName){// verify the required parameter 'namespaceName' is set
|
|
17142
17229
|
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']);}/**
|
|
17143
|
-
* 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.
|
|
17144
|
-
* See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
17145
|
-
* @param {String} namespaceName The namespace to get
|
|
17146
|
-
* @param {String} limitName The limit to get
|
|
17147
|
-
* @param {Object} opts Optional parameters
|
|
17148
|
-
* @param {String} opts.entityId entity id of the count
|
|
17149
|
-
* @param {String} opts.userId userid of the count
|
|
17150
|
-
* @param {String} opts.cursor Cursor provided when retrieving the last page
|
|
17151
|
-
* @deprecated
|
|
17152
|
-
*/},{key:"getOrganizationsLimitsNamespaceLimitCounts",value:function getOrganizationsLimitsNamespaceLimitCounts(namespaceName,limitName,opts){opts=opts||{};// verify the required parameter 'namespaceName' is set
|
|
17153
|
-
if(namespaceName===undefined||namespaceName===null){throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceLimitCounts';}// verify the required parameter 'limitName' is set
|
|
17154
|
-
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']);}/**
|
|
17155
17230
|
* Get the available limit namespaces
|
|
17156
17231
|
*
|
|
17157
17232
|
* @param {Object} opts Optional parameters
|
|
@@ -17202,7 +17277,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17202
17277
|
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(){/**
|
|
17203
17278
|
* OrganizationAuthorization service.
|
|
17204
17279
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
17205
|
-
* @version
|
|
17280
|
+
* @version 218.1.0
|
|
17206
17281
|
*//**
|
|
17207
17282
|
* Constructs a new OrganizationAuthorizationApi.
|
|
17208
17283
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -17536,7 +17611,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
17536
17611
|
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(){/**
|
|
17537
17612
|
* Outbound service.
|
|
17538
17613
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
17539
|
-
* @version
|
|
17614
|
+
* @version 218.1.0
|
|
17540
17615
|
*//**
|
|
17541
17616
|
* Constructs a new OutboundApi.
|
|
17542
17617
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -18653,7 +18728,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18653
18728
|
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(){/**
|
|
18654
18729
|
* Presence service.
|
|
18655
18730
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
18656
|
-
* @version
|
|
18731
|
+
* @version 218.1.0
|
|
18657
18732
|
*//**
|
|
18658
18733
|
* Constructs a new PresenceApi.
|
|
18659
18734
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18664,8 +18739,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18664
18739
|
* Delete a Presence Definition
|
|
18665
18740
|
*
|
|
18666
18741
|
* @param {String} definitionId Presence Definition ID
|
|
18667
|
-
*/return _createClass(PresenceApi,[{key:"
|
|
18668
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
18742
|
+
*/return _createClass(PresenceApi,[{key:"deleteDivisionBasedPresenceDefinition",value:function deleteDivisionBasedPresenceDefinition(definitionId){// verify the required parameter 'definitionId' is set
|
|
18743
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling deleteDivisionBasedPresenceDefinition';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','DELETE',{'definitionId':definitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18669
18744
|
* Delete a Presence Source
|
|
18670
18745
|
*
|
|
18671
18746
|
* @param {String} sourceId Presence Source ID
|
|
@@ -18682,15 +18757,15 @@ if(presenceId===undefined||presenceId===null){throw'Missing the required paramet
|
|
|
18682
18757
|
* @param {String} definitionId Presence Definition ID
|
|
18683
18758
|
* @param {Object} opts Optional parameters
|
|
18684
18759
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
18685
|
-
*/},{key:"
|
|
18686
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
18760
|
+
*/},{key:"getDivisionBasedPresenceDefinition",value:function getDivisionBasedPresenceDefinition(definitionId,opts){opts=opts||{};// verify the required parameter 'definitionId' is set
|
|
18761
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling getDivisionBasedPresenceDefinition';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','GET',{'definitionId':definitionId},{'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18687
18762
|
* Get a list of Presence Definitions
|
|
18688
18763
|
*
|
|
18689
18764
|
* @param {Object} opts Optional parameters
|
|
18690
18765
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
18691
18766
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
18692
18767
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
18693
|
-
*/},{key:"
|
|
18768
|
+
*/},{key:"getDivisionBasedPresenceDefinitions",value:function getDivisionBasedPresenceDefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/presence/definitions','GET',{},{'deactivated':opts['deactivated'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18694
18769
|
* Get the presence settings
|
|
18695
18770
|
*
|
|
18696
18771
|
*/},{key:"getPresenceSettings",value:function getPresenceSettings(){return this.apiClient.callApi('/api/v2/presence/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -18772,8 +18847,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18772
18847
|
* Create a Presence Definition
|
|
18773
18848
|
*
|
|
18774
18849
|
* @param {Object} body The Presence Definition to create
|
|
18775
|
-
*/},{key:"
|
|
18776
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling
|
|
18850
|
+
*/},{key:"postDivisionBasedPresenceDefinitions",value:function postDivisionBasedPresenceDefinitions(body){// verify the required parameter 'body' is set
|
|
18851
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDivisionBasedPresenceDefinitions';}return this.apiClient.callApi('/api/v2/presence/definitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18777
18852
|
* Create a Presence Source
|
|
18778
18853
|
*
|
|
18779
18854
|
* @param {Object} body The Presence Source to create
|
|
@@ -18789,9 +18864,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18789
18864
|
*
|
|
18790
18865
|
* @param {String} definitionId Presence Definition ID
|
|
18791
18866
|
* @param {Object} body The updated Presence Definition
|
|
18792
|
-
*/},{key:"
|
|
18793
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
18794
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling
|
|
18867
|
+
*/},{key:"putDivisionBasedPresenceDefinition",value:function putDivisionBasedPresenceDefinition(definitionId,body){// verify the required parameter 'definitionId' is set
|
|
18868
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling putDivisionBasedPresenceDefinition';}// verify the required parameter 'body' is set
|
|
18869
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putDivisionBasedPresenceDefinition';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','PUT',{'definitionId':definitionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18795
18870
|
* Update the presence settings
|
|
18796
18871
|
*
|
|
18797
18872
|
* @param {Object} body Presence Settings
|
|
@@ -18826,7 +18901,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18826
18901
|
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(){/**
|
|
18827
18902
|
* ProcessAutomation service.
|
|
18828
18903
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18829
|
-
* @version
|
|
18904
|
+
* @version 218.1.0
|
|
18830
18905
|
*//**
|
|
18831
18906
|
* Constructs a new ProcessAutomationApi.
|
|
18832
18907
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18889,7 +18964,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18889
18964
|
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(){/**
|
|
18890
18965
|
* Quality service.
|
|
18891
18966
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18892
|
-
* @version
|
|
18967
|
+
* @version 218.1.0
|
|
18893
18968
|
*//**
|
|
18894
18969
|
* Constructs a new QualityApi.
|
|
18895
18970
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -19348,7 +19423,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19348
19423
|
*
|
|
19349
19424
|
* @param {String} formId Form ID
|
|
19350
19425
|
* @param {Object} body AI Scoring Settings
|
|
19351
|
-
* putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19352
19426
|
*/},{key:"putQualityFormsEvaluationAiscoringSettings",value:function putQualityFormsEvaluationAiscoringSettings(formId,body){// verify the required parameter 'formId' is set
|
|
19353
19427
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluationAiscoringSettings';}// verify the required parameter 'body' is set
|
|
19354
19428
|
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']);}/**
|
|
@@ -19368,7 +19442,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
19368
19442
|
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(){/**
|
|
19369
19443
|
* Recording service.
|
|
19370
19444
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
19371
|
-
* @version
|
|
19445
|
+
* @version 218.1.0
|
|
19372
19446
|
*//**
|
|
19373
19447
|
* Constructs a new RecordingApi.
|
|
19374
19448
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -19447,7 +19521,7 @@ if(annotationId===undefined||annotationId===null){throw'Missing the required par
|
|
|
19447
19521
|
*/},{key:"getConversationRecordingAnnotations",value:function getConversationRecordingAnnotations(conversationId,recordingId){// verify the required parameter 'conversationId' is set
|
|
19448
19522
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationRecordingAnnotations';}// verify the required parameter 'recordingId' is set
|
|
19449
19523
|
if(recordingId===undefined||recordingId===null){throw'Missing the required parameter "recordingId" when calling getConversationRecordingAnnotations';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations','GET',{'conversationId':conversationId,'recordingId':recordingId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19450
|
-
* Get recording metadata for a conversation. Does not return playable media
|
|
19524
|
+
* Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
|
|
19451
19525
|
*
|
|
19452
19526
|
* @param {String} conversationId Conversation ID
|
|
19453
19527
|
*/},{key:"getConversationRecordingmetadata",value:function getConversationRecordingmetadata(conversationId){// verify the required parameter 'conversationId' is set
|
|
@@ -19467,8 +19541,9 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
19467
19541
|
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
19468
19542
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
19469
19543
|
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
19544
|
+
* @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
|
|
19470
19545
|
*/},{key:"getConversationRecordings",value:function getConversationRecordings(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
19471
|
-
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']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19546
|
+
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']);}/**
|
|
19472
19547
|
* Gets a single orphan recording
|
|
19473
19548
|
*
|
|
19474
19549
|
* @param {String} orphanId Orphan ID
|
|
@@ -19766,7 +19841,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19766
19841
|
*/},{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(){/**
|
|
19767
19842
|
* ResponseManagement service.
|
|
19768
19843
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
19769
|
-
* @version
|
|
19844
|
+
* @version 218.1.0
|
|
19770
19845
|
*//**
|
|
19771
19846
|
* Constructs a new ResponseManagementApi.
|
|
19772
19847
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19887,7 +19962,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19887
19962
|
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(){/**
|
|
19888
19963
|
* Routing service.
|
|
19889
19964
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19890
|
-
* @version
|
|
19965
|
+
* @version 218.1.0
|
|
19891
19966
|
*//**
|
|
19892
19967
|
* Constructs a new RoutingApi.
|
|
19893
19968
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20932,7 +21007,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20932
21007
|
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(){/**
|
|
20933
21008
|
* SCIM service.
|
|
20934
21009
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
20935
|
-
* @version
|
|
21010
|
+
* @version 218.1.0
|
|
20936
21011
|
*//**
|
|
20937
21012
|
* Constructs a new SCIMApi.
|
|
20938
21013
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -21157,7 +21232,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21157
21232
|
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(){/**
|
|
21158
21233
|
* ScreenRecording service.
|
|
21159
21234
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
21160
|
-
* @version
|
|
21235
|
+
* @version 218.1.0
|
|
21161
21236
|
*//**
|
|
21162
21237
|
* Constructs a new ScreenRecordingApi.
|
|
21163
21238
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -21172,7 +21247,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21172
21247
|
*/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(){/**
|
|
21173
21248
|
* Scripts service.
|
|
21174
21249
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
21175
|
-
* @version
|
|
21250
|
+
* @version 218.1.0
|
|
21176
21251
|
*//**
|
|
21177
21252
|
* Constructs a new ScriptsApi.
|
|
21178
21253
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -21308,7 +21383,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
21308
21383
|
*/},{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(){/**
|
|
21309
21384
|
* Search service.
|
|
21310
21385
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
21311
|
-
* @version
|
|
21386
|
+
* @version 218.1.0
|
|
21312
21387
|
*//**
|
|
21313
21388
|
* Constructs a new SearchApi.
|
|
21314
21389
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -21480,7 +21555,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21480
21555
|
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(){/**
|
|
21481
21556
|
* Settings service.
|
|
21482
21557
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
21483
|
-
* @version
|
|
21558
|
+
* @version 218.1.0
|
|
21484
21559
|
*//**
|
|
21485
21560
|
* Constructs a new SettingsApi.
|
|
21486
21561
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -21488,14 +21563,20 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21488
21563
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
21489
21564
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
21490
21565
|
*/function SettingsApi(apiClient){_classCallCheck(this,SettingsApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
21566
|
+
* Reset email threading settings to default
|
|
21567
|
+
*
|
|
21568
|
+
*/return _createClass(SettingsApi,[{key:"deleteEmailsSettingsThreading",value:function deleteEmailsSettingsThreading(){return this.apiClient.callApi('/api/v2/emails/settings/threading','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21491
21569
|
* Delete agent auto answer settings
|
|
21492
21570
|
*
|
|
21493
21571
|
* @param {String} agentId The agent to apply the auto answer settings to
|
|
21494
|
-
*/
|
|
21572
|
+
*/},{key:"deleteUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId){// verify the required parameter 'agentId' is set
|
|
21495
21573
|
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','DELETE',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21496
21574
|
* Get email Contact Center settings
|
|
21497
21575
|
*
|
|
21498
21576
|
*/},{key:"getEmailsSettings",value:function getEmailsSettings(){return this.apiClient.callApi('/api/v2/emails/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21577
|
+
* Get email threading settings
|
|
21578
|
+
*
|
|
21579
|
+
*/},{key:"getEmailsSettingsThreading",value:function getEmailsSettingsThreading(){return this.apiClient.callApi('/api/v2/emails/settings/threading','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21499
21580
|
* Get the execution history enabled setting.
|
|
21500
21581
|
* Get the execution history enabled setting.
|
|
21501
21582
|
*/},{key:"getSettingsExecutiondata",value:function getSettingsExecutiondata(){return this.apiClient.callApi('/api/v2/settings/executiondata','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -21509,6 +21590,11 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
21509
21590
|
* @param {Object} opts Optional parameters
|
|
21510
21591
|
* @param {Object} opts.body
|
|
21511
21592
|
*/},{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']);}/**
|
|
21593
|
+
* Patch email threading settings
|
|
21594
|
+
*
|
|
21595
|
+
* @param {Object} opts Optional parameters
|
|
21596
|
+
* @param {Object} opts.body
|
|
21597
|
+
*/},{key:"patchEmailsSettingsThreading",value:function patchEmailsSettingsThreading(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings/threading','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21512
21598
|
* Edit the execution history on off setting.
|
|
21513
21599
|
* Edit the execution history on off setting.
|
|
21514
21600
|
* @param {Object} body New Execution Data Setting
|
|
@@ -21530,7 +21616,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
21530
21616
|
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(){/**
|
|
21531
21617
|
* SocialMedia service.
|
|
21532
21618
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
21533
|
-
* @version
|
|
21619
|
+
* @version 218.1.0
|
|
21534
21620
|
*//**
|
|
21535
21621
|
* Constructs a new SocialMediaApi.
|
|
21536
21622
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -21538,13 +21624,23 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21538
21624
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
21539
21625
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
21540
21626
|
*/function SocialMediaApi(apiClient){_classCallCheck(this,SocialMediaApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
21627
|
+
* Delete an escalation rule.
|
|
21628
|
+
*
|
|
21629
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
21630
|
+
*/return _createClass(SocialMediaApi,[{key:"deleteSocialmediaEscalationrule",value:function deleteSocialmediaEscalationrule(escalationRuleId){// verify the required parameter 'escalationRuleId' is set
|
|
21631
|
+
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']);}/**
|
|
21632
|
+
* Delete a social media message.
|
|
21633
|
+
*
|
|
21634
|
+
* @param {String} messageId messageId
|
|
21635
|
+
* deleteSocialmediaMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21636
|
+
*/},{key:"deleteSocialmediaMessage",value:function deleteSocialmediaMessage(messageId){// verify the required parameter 'messageId' is set
|
|
21637
|
+
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']);}/**
|
|
21541
21638
|
* Delete a social topic.
|
|
21542
21639
|
*
|
|
21543
21640
|
* @param {String} topicId topicId
|
|
21544
21641
|
* @param {Object} opts Optional parameters
|
|
21545
21642
|
* @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.
|
|
21546
|
-
|
|
21547
|
-
*/return _createClass(SocialMediaApi,[{key:"deleteSocialmediaTopic",value:function deleteSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21643
|
+
*/},{key:"deleteSocialmediaTopic",value:function deleteSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21548
21644
|
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']);}/**
|
|
21549
21645
|
* Delete a Facebook data ingestion rule.
|
|
21550
21646
|
*
|
|
@@ -21552,7 +21648,6 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21552
21648
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21553
21649
|
* @param {Object} opts Optional parameters
|
|
21554
21650
|
* @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)
|
|
21555
|
-
* deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21556
21651
|
*/},{key:"deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21557
21652
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21558
21653
|
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']);}/**
|
|
@@ -21572,25 +21667,68 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21572
21667
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21573
21668
|
* @param {Object} opts Optional parameters
|
|
21574
21669
|
* @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)
|
|
21575
|
-
* deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21576
21670
|
*/},{key:"deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21577
21671
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21578
21672
|
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']);}/**
|
|
21673
|
+
* Get status for async query for social media aggregates
|
|
21674
|
+
*
|
|
21675
|
+
* @param {String} jobId jobId
|
|
21676
|
+
*/},{key:"getSocialmediaAnalyticsAggregatesJob",value:function getSocialmediaAnalyticsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
21677
|
+
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']);}/**
|
|
21678
|
+
* Fetch a page of results for an async social media query
|
|
21679
|
+
*
|
|
21680
|
+
* @param {String} jobId jobId
|
|
21681
|
+
* @param {Object} opts Optional parameters
|
|
21682
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
21683
|
+
*/},{key:"getSocialmediaAnalyticsAggregatesJobResults",value:function getSocialmediaAnalyticsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
21684
|
+
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']);}/**
|
|
21685
|
+
* Get status for async query for social media messages job
|
|
21686
|
+
*
|
|
21687
|
+
* @param {String} jobId jobId
|
|
21688
|
+
*/},{key:"getSocialmediaAnalyticsMessagesJob",value:function getSocialmediaAnalyticsMessagesJob(jobId){// verify the required parameter 'jobId' is set
|
|
21689
|
+
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']);}/**
|
|
21690
|
+
* Fetch a page of results for an async social media messages query
|
|
21691
|
+
*
|
|
21692
|
+
* @param {String} jobId jobId
|
|
21693
|
+
* @param {Object} opts Optional parameters
|
|
21694
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
21695
|
+
*/},{key:"getSocialmediaAnalyticsMessagesJobResults",value:function getSocialmediaAnalyticsMessagesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
21696
|
+
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']);}/**
|
|
21697
|
+
* Get a single escalation rule.
|
|
21698
|
+
*
|
|
21699
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
21700
|
+
*/},{key:"getSocialmediaEscalationrule",value:function getSocialmediaEscalationrule(escalationRuleId){// verify the required parameter 'escalationRuleId' is set
|
|
21701
|
+
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']);}/**
|
|
21702
|
+
* Retrieve all escalation rules for a division.
|
|
21703
|
+
*
|
|
21704
|
+
* @param {String} divisionId One division ID
|
|
21705
|
+
* @param {Object} opts Optional parameters
|
|
21706
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21707
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21708
|
+
*/},{key:"getSocialmediaEscalationrules",value:function getSocialmediaEscalationrules(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
21709
|
+
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']);}/**
|
|
21579
21710
|
* Get a single social topic.
|
|
21580
21711
|
*
|
|
21581
21712
|
* @param {String} topicId topicId
|
|
21582
21713
|
* @param {Object} opts Optional parameters
|
|
21583
21714
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21584
|
-
* getSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21585
21715
|
*/},{key:"getSocialmediaTopic",value:function getSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21586
21716
|
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']);}/**
|
|
21717
|
+
* Retrieve all social topic data ingestion rules with pagination.
|
|
21718
|
+
*
|
|
21719
|
+
* @param {String} topicId topicId
|
|
21720
|
+
* @param {Object} opts Optional parameters
|
|
21721
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21722
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21723
|
+
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21724
|
+
*/},{key:"getSocialmediaTopicDataingestionrules",value:function getSocialmediaTopicDataingestionrules(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21725
|
+
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']);}/**
|
|
21587
21726
|
* Get a single Facebook data ingestion rule.
|
|
21588
21727
|
*
|
|
21589
21728
|
* @param {String} topicId topicId
|
|
21590
21729
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21591
21730
|
* @param {Object} opts Optional parameters
|
|
21592
21731
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21593
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21594
21732
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21595
21733
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21596
21734
|
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']);}/**
|
|
@@ -21601,7 +21739,6 @@ if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Mi
|
|
|
21601
21739
|
* @param {String} dataIngestionRuleVersion version
|
|
21602
21740
|
* @param {Object} opts Optional parameters
|
|
21603
21741
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
21604
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21605
21742
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId,facebookIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21606
21743
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21607
21744
|
if(facebookIngestionRuleId===undefined||facebookIngestionRuleId===null){throw'Missing the required parameter "facebookIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
@@ -21614,7 +21751,6 @@ if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'
|
|
|
21614
21751
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21615
21752
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21616
21753
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21617
|
-
* getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21618
21754
|
*/},{key:"getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21619
21755
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21620
21756
|
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']);}/**
|
|
@@ -21658,7 +21794,6 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21658
21794
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21659
21795
|
* @param {Object} opts Optional parameters
|
|
21660
21796
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21661
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21662
21797
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21663
21798
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21664
21799
|
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']);}/**
|
|
@@ -21669,7 +21804,6 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Miss
|
|
|
21669
21804
|
* @param {String} dataIngestionRuleVersion version
|
|
21670
21805
|
* @param {Object} opts Optional parameters
|
|
21671
21806
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
21672
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21673
21807
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion(topicId,twitterIngestionRuleId,dataIngestionRuleVersion,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21674
21808
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21675
21809
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion';}// verify the required parameter 'dataIngestionRuleVersion' is set
|
|
@@ -21682,7 +21816,6 @@ if(dataIngestionRuleVersion===undefined||dataIngestionRuleVersion===null){throw'
|
|
|
21682
21816
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21683
21817
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21684
21818
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21685
|
-
* getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21686
21819
|
*/},{key:"getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions",value:function getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21687
21820
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21688
21821
|
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']);}/**
|
|
@@ -21693,14 +21826,12 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Miss
|
|
|
21693
21826
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21694
21827
|
* @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.
|
|
21695
21828
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
21696
|
-
* getSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21697
21829
|
*/},{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']);}/**
|
|
21698
21830
|
* Update a social topic.
|
|
21699
21831
|
*
|
|
21700
21832
|
* @param {String} topicId topicId
|
|
21701
21833
|
* @param {Object} opts Optional parameters
|
|
21702
21834
|
* @param {Object} opts.body
|
|
21703
|
-
* patchSocialmediaTopic is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21704
21835
|
*/},{key:"patchSocialmediaTopic",value:function patchSocialmediaTopic(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21705
21836
|
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']);}/**
|
|
21706
21837
|
* Update the status of a Facebook data ingestion rule.
|
|
@@ -21709,7 +21840,6 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21709
21840
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21710
21841
|
* @param {Object} opts Optional parameters
|
|
21711
21842
|
* @param {Object} opts.body
|
|
21712
|
-
* patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21713
21843
|
*/},{key:"patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21714
21844
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21715
21845
|
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']);}/**
|
|
@@ -21729,16 +21859,36 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21729
21859
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21730
21860
|
* @param {Object} opts Optional parameters
|
|
21731
21861
|
* @param {Object} opts.body
|
|
21732
|
-
* patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21733
21862
|
*/},{key:"patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21734
21863
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling patchSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21735
21864
|
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']);}/**
|
|
21865
|
+
* Query for social media aggregates asynchronously
|
|
21866
|
+
*
|
|
21867
|
+
* @param {Object} body query
|
|
21868
|
+
*/},{key:"postSocialmediaAnalyticsAggregatesJobs",value:function postSocialmediaAnalyticsAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
21869
|
+
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']);}/**
|
|
21870
|
+
* Query for social media messages asynchronously
|
|
21871
|
+
*
|
|
21872
|
+
* @param {Object} body query
|
|
21873
|
+
*/},{key:"postSocialmediaAnalyticsMessagesJobs",value:function postSocialmediaAnalyticsMessagesJobs(body){// verify the required parameter 'body' is set
|
|
21874
|
+
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']);}/**
|
|
21875
|
+
* Create an escalation rule.
|
|
21876
|
+
*
|
|
21877
|
+
* @param {Object} opts Optional parameters
|
|
21878
|
+
* @param {Object} opts.body
|
|
21879
|
+
*/},{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']);}/**
|
|
21880
|
+
* Escalate message to a conversation manually
|
|
21881
|
+
*
|
|
21882
|
+
* @param {String} divisionId One division ID
|
|
21883
|
+
* @param {Object} opts Optional parameters
|
|
21884
|
+
* @param {Object} opts.body
|
|
21885
|
+
*/},{key:"postSocialmediaEscalationsMessages",value:function postSocialmediaEscalationsMessages(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
21886
|
+
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']);}/**
|
|
21736
21887
|
* Create an Facebook data ingestion rule.
|
|
21737
21888
|
*
|
|
21738
21889
|
* @param {String} topicId topicId
|
|
21739
21890
|
* @param {Object} opts Optional parameters
|
|
21740
21891
|
* @param {Object} opts.body
|
|
21741
|
-
* postSocialmediaTopicDataingestionrulesFacebook is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21742
21892
|
*/},{key:"postSocialmediaTopicDataingestionrulesFacebook",value:function postSocialmediaTopicDataingestionrulesFacebook(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21743
21893
|
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']);}/**
|
|
21744
21894
|
* Create an open data ingestion rule.
|
|
@@ -21754,22 +21904,31 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21754
21904
|
* @param {String} topicId topicId
|
|
21755
21905
|
* @param {Object} opts Optional parameters
|
|
21756
21906
|
* @param {Object} opts.body
|
|
21757
|
-
* postSocialmediaTopicDataingestionrulesTwitter is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21758
21907
|
*/},{key:"postSocialmediaTopicDataingestionrulesTwitter",value:function postSocialmediaTopicDataingestionrulesTwitter(topicId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21759
21908
|
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']);}/**
|
|
21760
21909
|
* Create a social topic.
|
|
21761
21910
|
*
|
|
21762
21911
|
* @param {Object} opts Optional parameters
|
|
21763
21912
|
* @param {Object} opts.body
|
|
21764
|
-
* postSocialmediaTopics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21765
21913
|
*/},{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']);}/**
|
|
21914
|
+
* Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization.
|
|
21915
|
+
*
|
|
21916
|
+
* @param {Object} body TwitterDataHistoricalTweetRequest
|
|
21917
|
+
*/},{key:"postSocialmediaTwitterHistoricalTweets",value:function postSocialmediaTwitterHistoricalTweets(body){// verify the required parameter 'body' is set
|
|
21918
|
+
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']);}/**
|
|
21919
|
+
* Update the escalation rule.
|
|
21920
|
+
*
|
|
21921
|
+
* @param {String} escalationRuleId escalationRuleId
|
|
21922
|
+
* @param {Object} opts Optional parameters
|
|
21923
|
+
* @param {Object} opts.body
|
|
21924
|
+
*/},{key:"putSocialmediaEscalationrule",value:function putSocialmediaEscalationrule(escalationRuleId,opts){opts=opts||{};// verify the required parameter 'escalationRuleId' is set
|
|
21925
|
+
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']);}/**
|
|
21766
21926
|
* Update the Facebook data ingestion rule.
|
|
21767
21927
|
*
|
|
21768
21928
|
* @param {String} topicId topicId
|
|
21769
21929
|
* @param {String} facebookIngestionRuleId facebookIngestionRuleId
|
|
21770
21930
|
* @param {Object} opts Optional parameters
|
|
21771
21931
|
* @param {Object} opts.body
|
|
21772
|
-
* putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21773
21932
|
*/},{key:"putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId,facebookIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21774
21933
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId';}// verify the required parameter 'facebookIngestionRuleId' is set
|
|
21775
21934
|
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']);}/**
|
|
@@ -21789,13 +21948,12 @@ if(openId===undefined||openId===null){throw'Missing the required parameter "open
|
|
|
21789
21948
|
* @param {String} twitterIngestionRuleId twitterIngestionRuleId
|
|
21790
21949
|
* @param {Object} opts Optional parameters
|
|
21791
21950
|
* @param {Object} opts.body
|
|
21792
|
-
* putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21793
21951
|
*/},{key:"putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId",value:function putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId(topicId,twitterIngestionRuleId,opts){opts=opts||{};// verify the required parameter 'topicId' is set
|
|
21794
21952
|
if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}// verify the required parameter 'twitterIngestionRuleId' is set
|
|
21795
21953
|
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(){/**
|
|
21796
21954
|
* SpeechTextAnalytics service.
|
|
21797
21955
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
21798
|
-
* @version
|
|
21956
|
+
* @version 218.1.0
|
|
21799
21957
|
*//**
|
|
21800
21958
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
21801
21959
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -22118,7 +22276,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
22118
22276
|
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(){/**
|
|
22119
22277
|
* Stations service.
|
|
22120
22278
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
22121
|
-
* @version
|
|
22279
|
+
* @version 218.1.0
|
|
22122
22280
|
*//**
|
|
22123
22281
|
* Constructs a new StationsApi.
|
|
22124
22282
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -22150,7 +22308,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
22150
22308
|
*/},{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(){/**
|
|
22151
22309
|
* Suggest service.
|
|
22152
22310
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
22153
|
-
* @version
|
|
22311
|
+
* @version 218.1.0
|
|
22154
22312
|
*//**
|
|
22155
22313
|
* Constructs a new SuggestApi.
|
|
22156
22314
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -22190,7 +22348,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22190
22348
|
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(){/**
|
|
22191
22349
|
* TaskManagement service.
|
|
22192
22350
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
22193
|
-
* @version
|
|
22351
|
+
* @version 218.1.0
|
|
22194
22352
|
*//**
|
|
22195
22353
|
* Constructs a new TaskManagementApi.
|
|
22196
22354
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -22696,7 +22854,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
22696
22854
|
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(){/**
|
|
22697
22855
|
* Teams service.
|
|
22698
22856
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
22699
|
-
* @version
|
|
22857
|
+
* @version 218.1.0
|
|
22700
22858
|
*//**
|
|
22701
22859
|
* Constructs a new TeamsApi.
|
|
22702
22860
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -22776,7 +22934,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22776
22934
|
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(){/**
|
|
22777
22935
|
* Telephony service.
|
|
22778
22936
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
22779
|
-
* @version
|
|
22937
|
+
* @version 218.1.0
|
|
22780
22938
|
*//**
|
|
22781
22939
|
* Constructs a new TelephonyApi.
|
|
22782
22940
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -22823,7 +22981,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
22823
22981
|
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(){/**
|
|
22824
22982
|
* TelephonyProvidersEdge service.
|
|
22825
22983
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
22826
|
-
* @version
|
|
22984
|
+
* @version 218.1.0
|
|
22827
22985
|
*//**
|
|
22828
22986
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
22829
22987
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -23104,7 +23262,8 @@ if(extensionPoolId===undefined||extensionPoolId===null){throw'Missing the requir
|
|
|
23104
23262
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
23105
23263
|
* @param {String} opts.sortBy Sort by
|
|
23106
23264
|
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
23107
|
-
|
|
23265
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
23266
|
+
*/},{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']);}/**
|
|
23108
23267
|
* Get a pageable list of basic extension pool objects filterable by query parameters.
|
|
23109
23268
|
* 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.
|
|
23110
23269
|
* @param {Object} opts Optional parameters
|
|
@@ -23658,7 +23817,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
23658
23817
|
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(){/**
|
|
23659
23818
|
* Textbots service.
|
|
23660
23819
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
23661
|
-
* @version
|
|
23820
|
+
* @version 218.1.0
|
|
23662
23821
|
*//**
|
|
23663
23822
|
* Constructs a new TextbotsApi.
|
|
23664
23823
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -23693,7 +23852,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
23693
23852
|
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(){/**
|
|
23694
23853
|
* Tokens service.
|
|
23695
23854
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
23696
|
-
* @version
|
|
23855
|
+
* @version 218.1.0
|
|
23697
23856
|
*//**
|
|
23698
23857
|
* Constructs a new TokensApi.
|
|
23699
23858
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -23727,7 +23886,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23727
23886
|
*/},{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(){/**
|
|
23728
23887
|
* Uploads service.
|
|
23729
23888
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
23730
|
-
* @version
|
|
23889
|
+
* @version 218.1.0
|
|
23731
23890
|
*//**
|
|
23732
23891
|
* Constructs a new UploadsApi.
|
|
23733
23892
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -23790,7 +23949,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23790
23949
|
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(){/**
|
|
23791
23950
|
* Usage service.
|
|
23792
23951
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
23793
|
-
* @version
|
|
23952
|
+
* @version 218.1.0
|
|
23794
23953
|
*//**
|
|
23795
23954
|
* Constructs a new UsageApi.
|
|
23796
23955
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -23844,7 +24003,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23844
24003
|
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(){/**
|
|
23845
24004
|
* UserRecordings service.
|
|
23846
24005
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
23847
|
-
* @version
|
|
24006
|
+
* @version 218.1.0
|
|
23848
24007
|
*//**
|
|
23849
24008
|
* Constructs a new UserRecordingsApi.
|
|
23850
24009
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -23901,7 +24060,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
23901
24060
|
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(){/**
|
|
23902
24061
|
* Users service.
|
|
23903
24062
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
23904
|
-
* @version
|
|
24063
|
+
* @version 218.1.0
|
|
23905
24064
|
*//**
|
|
23906
24065
|
* Constructs a new UsersApi.
|
|
23907
24066
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -24628,7 +24787,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
24628
24787
|
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(){/**
|
|
24629
24788
|
* Utilities service.
|
|
24630
24789
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
24631
|
-
* @version
|
|
24790
|
+
* @version 218.1.0
|
|
24632
24791
|
*//**
|
|
24633
24792
|
* Constructs a new UtilitiesApi.
|
|
24634
24793
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -24655,7 +24814,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24655
24814
|
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(){/**
|
|
24656
24815
|
* Voicemail service.
|
|
24657
24816
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
24658
|
-
* @version
|
|
24817
|
+
* @version 218.1.0
|
|
24659
24818
|
*//**
|
|
24660
24819
|
* Constructs a new VoicemailApi.
|
|
24661
24820
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -24817,7 +24976,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
24817
24976
|
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(){/**
|
|
24818
24977
|
* WebChat service.
|
|
24819
24978
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
24820
|
-
* @version
|
|
24979
|
+
* @version 218.1.0
|
|
24821
24980
|
*//**
|
|
24822
24981
|
* Constructs a new WebChatApi.
|
|
24823
24982
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -24832,9 +24991,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24832
24991
|
*/return _createClass(WebChatApi,[{key:"deleteWebchatDeployment",value:function deleteWebchatDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
24833
24992
|
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']);}/**
|
|
24834
24993
|
* Remove a member from a chat conversation
|
|
24835
|
-
*
|
|
24994
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24836
24995
|
* @param {String} conversationId conversationId
|
|
24837
24996
|
* @param {String} memberId memberId
|
|
24997
|
+
* @deprecated
|
|
24838
24998
|
*/},{key:"deleteWebchatGuestConversationMember",value:function deleteWebchatGuestConversationMember(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
24839
24999
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling deleteWebchatGuestConversationMember';}// verify the required parameter 'memberId' is set
|
|
24840
25000
|
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']);}/**
|
|
@@ -24860,41 +25020,46 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
24860
25020
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequest';}// verify the required parameter 'mediaRequestId' is set
|
|
24861
25021
|
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']);}/**
|
|
24862
25022
|
* Get all media requests to the guest in the conversation
|
|
24863
|
-
*
|
|
25023
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24864
25024
|
* @param {String} conversationId conversationId
|
|
25025
|
+
* @deprecated
|
|
24865
25026
|
*/},{key:"getWebchatGuestConversationMediarequests",value:function getWebchatGuestConversationMediarequests(conversationId){// verify the required parameter 'conversationId' is set
|
|
24866
25027
|
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']);}/**
|
|
24867
25028
|
* Get a web chat conversation member
|
|
24868
|
-
*
|
|
25029
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24869
25030
|
* @param {String} conversationId conversationId
|
|
24870
25031
|
* @param {String} memberId memberId
|
|
25032
|
+
* @deprecated
|
|
24871
25033
|
*/},{key:"getWebchatGuestConversationMember",value:function getWebchatGuestConversationMember(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
24872
25034
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMember';}// verify the required parameter 'memberId' is set
|
|
24873
25035
|
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']);}/**
|
|
24874
25036
|
* Get the members of a chat conversation.
|
|
24875
|
-
*
|
|
25037
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24876
25038
|
* @param {String} conversationId conversationId
|
|
24877
25039
|
* @param {Object} opts Optional parameters
|
|
24878
25040
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
24879
25041
|
* @param {Number} opts.pageNumber The page number to return, or omitted for the first page. (default to 1)
|
|
24880
25042
|
* @param {Boolean} opts.excludeDisconnectedMembers If true, the results will not contain members who have a DISCONNECTED state. (default to false)
|
|
25043
|
+
* @deprecated
|
|
24881
25044
|
*/},{key:"getWebchatGuestConversationMembers",value:function getWebchatGuestConversationMembers(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
24882
25045
|
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']);}/**
|
|
24883
25046
|
* Get a web chat conversation message
|
|
24884
|
-
*
|
|
25047
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24885
25048
|
* @param {String} conversationId conversationId
|
|
24886
25049
|
* @param {String} messageId messageId
|
|
25050
|
+
* @deprecated
|
|
24887
25051
|
*/},{key:"getWebchatGuestConversationMessage",value:function getWebchatGuestConversationMessage(conversationId,messageId){// verify the required parameter 'conversationId' is set
|
|
24888
25052
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessage';}// verify the required parameter 'messageId' is set
|
|
24889
25053
|
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']);}/**
|
|
24890
25054
|
* Get the messages of a chat conversation.
|
|
24891
|
-
*
|
|
25055
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24892
25056
|
* @param {String} conversationId conversationId
|
|
24893
25057
|
* @param {Object} opts Optional parameters
|
|
24894
25058
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
24895
25059
|
* @param {String} opts.before If available, get the messages chronologically before the id of this message
|
|
24896
25060
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
24897
25061
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
25062
|
+
* @deprecated
|
|
24898
25063
|
*/},{key:"getWebchatGuestConversationMessages",value:function getWebchatGuestConversationMessages(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
24899
25064
|
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']);}/**
|
|
24900
25065
|
* Get WebChat deployment settings
|
|
@@ -24917,24 +25082,27 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24917
25082
|
*/},{key:"postWebchatDeployments",value:function postWebchatDeployments(body){// verify the required parameter 'body' is set
|
|
24918
25083
|
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']);}/**
|
|
24919
25084
|
* Send a message in a chat conversation.
|
|
24920
|
-
*
|
|
25085
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24921
25086
|
* @param {String} conversationId conversationId
|
|
24922
25087
|
* @param {String} memberId memberId
|
|
24923
25088
|
* @param {Object} body Message
|
|
25089
|
+
* @deprecated
|
|
24924
25090
|
*/},{key:"postWebchatGuestConversationMemberMessages",value:function postWebchatGuestConversationMemberMessages(conversationId,memberId,body){// verify the required parameter 'conversationId' is set
|
|
24925
25091
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberMessages';}// verify the required parameter 'memberId' is set
|
|
24926
25092
|
if(memberId===undefined||memberId===null){throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberMessages';}// verify the required parameter 'body' is set
|
|
24927
25093
|
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']);}/**
|
|
24928
25094
|
* Send a typing-indicator in a chat conversation.
|
|
24929
|
-
*
|
|
25095
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
24930
25096
|
* @param {String} conversationId conversationId
|
|
24931
25097
|
* @param {String} memberId memberId
|
|
25098
|
+
* @deprecated
|
|
24932
25099
|
*/},{key:"postWebchatGuestConversationMemberTyping",value:function postWebchatGuestConversationMemberTyping(conversationId,memberId){// verify the required parameter 'conversationId' is set
|
|
24933
25100
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberTyping';}// verify the required parameter 'memberId' is set
|
|
24934
25101
|
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']);}/**
|
|
24935
25102
|
* Create an ACD chat conversation from an external customer.
|
|
24936
|
-
* This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.
|
|
25103
|
+
* 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.
|
|
24937
25104
|
* @param {Object} body CreateConversationRequest
|
|
25105
|
+
* @deprecated
|
|
24938
25106
|
*/},{key:"postWebchatGuestConversations",value:function postWebchatGuestConversations(body){// verify the required parameter 'body' is set
|
|
24939
25107
|
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']);}/**
|
|
24940
25108
|
* Update a WebChat deployment
|
|
@@ -24952,7 +25120,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24952
25120
|
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(){/**
|
|
24953
25121
|
* WebDeployments service.
|
|
24954
25122
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
24955
|
-
* @version
|
|
25123
|
+
* @version 218.1.0
|
|
24956
25124
|
*//**
|
|
24957
25125
|
* Constructs a new WebDeploymentsApi.
|
|
24958
25126
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -25087,7 +25255,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
25087
25255
|
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(){/**
|
|
25088
25256
|
* WebMessaging service.
|
|
25089
25257
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
25090
|
-
* @version
|
|
25258
|
+
* @version 218.1.0
|
|
25091
25259
|
*//**
|
|
25092
25260
|
* Constructs a new WebMessagingApi.
|
|
25093
25261
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -25103,7 +25271,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25103
25271
|
*/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(){/**
|
|
25104
25272
|
* Widgets service.
|
|
25105
25273
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
25106
|
-
* @version
|
|
25274
|
+
* @version 218.1.0
|
|
25107
25275
|
*//**
|
|
25108
25276
|
* Constructs a new WidgetsApi.
|
|
25109
25277
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -25112,33 +25280,38 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25112
25280
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
25113
25281
|
*/function WidgetsApi(apiClient){_classCallCheck(this,WidgetsApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
25114
25282
|
* Delete a Widget deployment
|
|
25115
|
-
*
|
|
25283
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25116
25284
|
* @param {String} deploymentId Widget Config Id
|
|
25285
|
+
* @deprecated
|
|
25117
25286
|
*/return _createClass(WidgetsApi,[{key:"deleteWidgetsDeployment",value:function deleteWidgetsDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
25118
25287
|
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']);}/**
|
|
25119
25288
|
* Get a Widget deployment
|
|
25120
|
-
*
|
|
25289
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25121
25290
|
* @param {String} deploymentId Widget Config Id
|
|
25291
|
+
* @deprecated
|
|
25122
25292
|
*/},{key:"getWidgetsDeployment",value:function getWidgetsDeployment(deploymentId){// verify the required parameter 'deploymentId' is set
|
|
25123
25293
|
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']);}/**
|
|
25124
25294
|
* List Widget deployments
|
|
25125
|
-
*
|
|
25295
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25296
|
+
* @deprecated
|
|
25126
25297
|
*/},{key:"getWidgetsDeployments",value:function getWidgetsDeployments(){return this.apiClient.callApi('/api/v2/widgets/deployments','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
25127
25298
|
* Create Widget deployment
|
|
25128
|
-
*
|
|
25299
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25129
25300
|
* @param {Object} body Deployment
|
|
25301
|
+
* @deprecated
|
|
25130
25302
|
*/},{key:"postWidgetsDeployments",value:function postWidgetsDeployments(body){// verify the required parameter 'body' is set
|
|
25131
25303
|
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']);}/**
|
|
25132
25304
|
* Update a Widget deployment
|
|
25133
|
-
*
|
|
25305
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
25134
25306
|
* @param {String} deploymentId Widget Config Id
|
|
25135
25307
|
* @param {Object} body Deployment
|
|
25308
|
+
* @deprecated
|
|
25136
25309
|
*/},{key:"putWidgetsDeployment",value:function putWidgetsDeployment(deploymentId,body){// verify the required parameter 'deploymentId' is set
|
|
25137
25310
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling putWidgetsDeployment';}// verify the required parameter 'body' is set
|
|
25138
25311
|
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(){/**
|
|
25139
25312
|
* WorkforceManagement service.
|
|
25140
25313
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
25141
|
-
* @version
|
|
25314
|
+
* @version 218.1.0
|
|
25142
25315
|
*//**
|
|
25143
25316
|
* Constructs a new WorkforceManagementApi.
|
|
25144
25317
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -26957,7 +27130,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
26957
27130
|
* </pre>
|
|
26958
27131
|
* </p>
|
|
26959
27132
|
* @module purecloud-platform-client-v2/index
|
|
26960
|
-
* @version
|
|
27133
|
+
* @version 218.1.0
|
|
26961
27134
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
26962
27135
|
* The ApiClient constructor.
|
|
26963
27136
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|