purecloud-platform-client-v2 206.0.0 → 208.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +100 -3
- package/dist/node/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +341 -176
- package/dist/web-cjs/purecloud-platform-client-v2.js +358 -179
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1646 -606
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- 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 +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +234 -8
- 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 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +136 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -21
- 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 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +48 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +12 -12
- 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 +55 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +4 -4
- 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 +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +55 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -2847,10 +2847,21 @@ var utilInspect = require('./util.inspect');
|
|
|
2847
2847
|
var inspectCustom = utilInspect.custom;
|
|
2848
2848
|
var inspectSymbol = isSymbol(inspectCustom) ? inspectCustom : null;
|
|
2849
2849
|
|
|
2850
|
+
var quotes = {
|
|
2851
|
+
__proto__: null,
|
|
2852
|
+
'double': '"',
|
|
2853
|
+
single: "'"
|
|
2854
|
+
};
|
|
2855
|
+
var quoteREs = {
|
|
2856
|
+
__proto__: null,
|
|
2857
|
+
'double': /(["\\])/g,
|
|
2858
|
+
single: /(['\\])/g
|
|
2859
|
+
};
|
|
2860
|
+
|
|
2850
2861
|
module.exports = function inspect_(obj, options, depth, seen) {
|
|
2851
2862
|
var opts = options || {};
|
|
2852
2863
|
|
|
2853
|
-
if (has(opts, 'quoteStyle') && (
|
|
2864
|
+
if (has(opts, 'quoteStyle') && !has(quotes, opts.quoteStyle)) {
|
|
2854
2865
|
throw new TypeError('option "quoteStyle" must be "single" or "double"');
|
|
2855
2866
|
}
|
|
2856
2867
|
if (
|
|
@@ -3045,7 +3056,8 @@ module.exports = function inspect_(obj, options, depth, seen) {
|
|
|
3045
3056
|
};
|
|
3046
3057
|
|
|
3047
3058
|
function wrapQuotes(s, defaultStyle, opts) {
|
|
3048
|
-
var
|
|
3059
|
+
var style = opts.quoteStyle || defaultStyle;
|
|
3060
|
+
var quoteChar = quotes[style];
|
|
3049
3061
|
return quoteChar + s + quoteChar;
|
|
3050
3062
|
}
|
|
3051
3063
|
|
|
@@ -3203,8 +3215,10 @@ function inspectString(str, opts) {
|
|
|
3203
3215
|
var trailer = '... ' + remaining + ' more character' + (remaining > 1 ? 's' : '');
|
|
3204
3216
|
return inspectString($slice.call(str, 0, opts.maxStringLength), opts) + trailer;
|
|
3205
3217
|
}
|
|
3218
|
+
var quoteRE = quoteREs[opts.quoteStyle || 'single'];
|
|
3219
|
+
quoteRE.lastIndex = 0;
|
|
3206
3220
|
// eslint-disable-next-line no-control-regex
|
|
3207
|
-
var s = $replace.call($replace.call(str,
|
|
3221
|
+
var s = $replace.call($replace.call(str, quoteRE, '\\$1'), /[\x00-\x1f]/g, lowbyte);
|
|
3208
3222
|
return wrapQuotes(s, 'single', opts);
|
|
3209
3223
|
}
|
|
3210
3224
|
|
|
@@ -6157,18 +6171,30 @@ axios.Cancel=axios.CanceledError;// Expose all/spread
|
|
|
6157
6171
|
axios.all=function all(promises){return Promise.all(promises);};axios.spread=spread;// Expose isAxiosError
|
|
6158
6172
|
axios.isAxiosError=isAxiosError;// Expose mergeConfig
|
|
6159
6173
|
axios.mergeConfig=mergeConfig;axios.AxiosHeaders=AxiosHeaders$1;axios.formToJSON=function(thing){return formDataToJSON(utils$1.isHTMLForm(thing)?new FormData(thing):thing);};axios.getAdapter=adapters.getAdapter;axios.HttpStatusCode=HttpStatusCode$1;axios["default"]=axios;// this module should only have a default export
|
|
6160
|
-
var axios$1=axios;var logLevelEnum={level:{LNone:'none',LError:'error',LDebug:'debug',LTrace:'trace'}};var logFormatEnum={formats:{JSON:'json',TEXT:'text'}};var Logger=/*#__PURE__*/function(){function Logger(){_classCallCheck(this,Logger);this.log_level=logLevelEnum.level.LNone;this.log_format=logFormatEnum.formats.TEXT;this.log_to_console=true;this.log_file_path;this.log_response_body=false;this.log_request_body=false;this.setLogger();}return _createClass(Logger,[{key:"logLevelEnum",get:function get(){return logLevelEnum;}},{key:"logFormatEnum",get:function get(){return logFormatEnum;}},{key:"setLogger",value:function setLogger(){}},{key:"log",value:function log(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var content=this.formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody);if(typeof window!=='undefined'){var shouldLog=this.calculateLogLevel(level);if(shouldLog>0&&this.log_to_console===true){if(this.log_format===this.logFormatEnum.formats.JSON){console.log(content);}else{console.log("".concat(level.toUpperCase(),": ").concat(content));}}}else{if(this.logger.transports.length>0)this.logger.log(level,content);}}},{key:"calculateLogLevel",value:function calculateLogLevel(level){switch(this.log_level){case this.logLevelEnum.level.LError:if(level!==this.logLevelEnum.level.LError){return-1;}return 1;case this.logLevelEnum.level.LDebug:if(level===this.logLevelEnum.level.LTrace){return-1;}return 1;case this.logLevelEnum.level.LTrace:return 1;default:return-1;}}},{key:"formatLog",value:function formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var result;var localRequestHeaders=requestHeaders?JSON.parse(JSON.stringify(requestHeaders)):null;var localResponseHeaders=responseHeaders?JSON.parse(JSON.stringify(responseHeaders)):null;var localRequestBody=requestBody?JSON.parse(JSON.stringify(requestBody)):null;var localResponseBody=responseBody?JSON.parse(JSON.stringify(responseBody)):null;if(requestHeaders)localRequestHeaders['Authorization']='[REDACTED]';if(!this.log_request_body)localRequestBody=undefined;if(!this.log_response_body)localResponseBody=undefined;if(this.log_format&&this.log_format===logFormatEnum.formats.JSON){result={level:level,date:new Date().toISOString(),method:method,url:decodeURIComponent(url),correlationId:localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'',statusCode:statusCode};if(localRequestHeaders)result.requestHeaders=localRequestHeaders;if(localResponseHeaders)result.responseHeaders=localResponseHeaders;if(localRequestBody)result.requestBody=localRequestBody;if(localResponseBody)result.responseBody=localResponseBody;}else{result="".concat(new Date().toISOString(),"\n=== REQUEST === \n").concat(this.formatValue('URL',decodeURIComponent(url))).concat(this.formatValue('Method',method)).concat(this.formatValue('Headers',this.formatHeaderString(localRequestHeaders))).concat(this.formatValue('Body',localRequestBody?JSON.stringify(localRequestBody,null,2):''),"\n=== RESPONSE ===\n").concat(this.formatValue('Status',statusCode)).concat(this.formatValue('Headers',this.formatHeaderString(localResponseHeaders))).concat(this.formatValue('CorrelationId',localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'')).concat(this.formatValue('Body',localResponseBody?JSON.stringify(localResponseBody,null,2):''));}return result;}},{key:"formatHeaderString",value:function formatHeaderString(headers){var headerString='';if(!headers)return headerString;for(var _i=0,_Object$entries=Object.entries(headers);_i<_Object$entries.length;_i++){var _Object$entries$_i=_slicedToArray(_Object$entries[_i],2),key=_Object$entries$_i[0],value=_Object$entries$_i[1];headerString+="\n\t".concat(key,": ").concat(value);}return headerString;}},{key:"formatValue",value:function formatValue(key,value){if(!value||value===''||value==='{}')return'';return"".concat(key,": ").concat(value,"\n");}},{key:"getLogLevel",value:function getLogLevel(level){switch(level){case'error':return logLevelEnum.level.LError;case'debug':return logLevelEnum.level.LDebug;case'trace':return logLevelEnum.level.LTrace;default:return logLevelEnum.level.LNone;}}},{key:"getLogFormat",value:function getLogFormat(format){switch(format){case'json':return logFormatEnum.formats.JSON;default:return logFormatEnum.formats.TEXT;}}}]);}();var Configuration=/*#__PURE__*/function(){function Configuration(){_classCallCheck(this,Configuration);if(!Configuration.instance){Configuration.instance=this;}if(typeof window!=='undefined'){this.configPath='';}else{var os=require('os');var path=require('path');this.configPath=path.join(os.homedir(),'.genesyscloudjavascript','config');}this.refresh_access_token=true;this.refresh_token_wait_max=10;this.live_reload_config=true;this.host;this.environment;this.basePath;this.authUrl;this.config;this.logger=new Logger();this.setEnvironment();this.liveLoadConfig();}return _createClass(Configuration,[{key:"instance",get:/**
|
|
6174
|
+
var axios$1=axios;var logLevelEnum={level:{LNone:'none',LError:'error',LDebug:'debug',LTrace:'trace'}};var logFormatEnum={formats:{JSON:'json',TEXT:'text'}};var Logger=/*#__PURE__*/function(){function Logger(){_classCallCheck(this,Logger);this.log_level=logLevelEnum.level.LNone;this.log_format=logFormatEnum.formats.TEXT;this.log_to_console=true;this.log_file_path;this.log_response_body=false;this.log_request_body=false;this.setLogger();}return _createClass(Logger,[{key:"logLevelEnum",get:function get(){return logLevelEnum;}},{key:"logFormatEnum",get:function get(){return logFormatEnum;}},{key:"setLogger",value:function setLogger(){}},{key:"log",value:function log(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var content=this.formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody);if(typeof window!=='undefined'){var shouldLog=this.calculateLogLevel(level);if(shouldLog>0&&this.log_to_console===true){if(this.log_format===this.logFormatEnum.formats.JSON){console.log(content);}else{console.log("".concat(level.toUpperCase(),": ").concat(content));}}}else{if(this.logger.transports.length>0)this.logger.log(level,content);}}},{key:"calculateLogLevel",value:function calculateLogLevel(level){switch(this.log_level){case this.logLevelEnum.level.LError:if(level!==this.logLevelEnum.level.LError){return-1;}return 1;case this.logLevelEnum.level.LDebug:if(level===this.logLevelEnum.level.LTrace){return-1;}return 1;case this.logLevelEnum.level.LTrace:return 1;default:return-1;}}},{key:"formatLog",value:function formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var result;var localRequestHeaders=requestHeaders?JSON.parse(JSON.stringify(requestHeaders)):null;var localResponseHeaders=responseHeaders?JSON.parse(JSON.stringify(responseHeaders)):null;var localRequestBody=requestBody?JSON.parse(JSON.stringify(requestBody)):null;var localResponseBody=responseBody?JSON.parse(JSON.stringify(responseBody)):null;if(requestHeaders)localRequestHeaders['Authorization']='[REDACTED]';if(!this.log_request_body)localRequestBody=undefined;if(!this.log_response_body)localResponseBody=undefined;if(this.log_format&&this.log_format===logFormatEnum.formats.JSON){result={level:level,date:new Date().toISOString(),method:method,url:decodeURIComponent(url),correlationId:localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'',statusCode:statusCode};if(localRequestHeaders)result.requestHeaders=localRequestHeaders;if(localResponseHeaders)result.responseHeaders=localResponseHeaders;if(localRequestBody)result.requestBody=localRequestBody;if(localResponseBody)result.responseBody=localResponseBody;}else{result="".concat(new Date().toISOString(),"\n=== REQUEST === \n").concat(this.formatValue('URL',decodeURIComponent(url))).concat(this.formatValue('Method',method)).concat(this.formatValue('Headers',this.formatHeaderString(localRequestHeaders))).concat(this.formatValue('Body',localRequestBody?JSON.stringify(localRequestBody,null,2):''),"\n=== RESPONSE ===\n").concat(this.formatValue('Status',statusCode)).concat(this.formatValue('Headers',this.formatHeaderString(localResponseHeaders))).concat(this.formatValue('CorrelationId',localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'')).concat(this.formatValue('Body',localResponseBody?JSON.stringify(localResponseBody,null,2):''));}return result;}},{key:"formatHeaderString",value:function formatHeaderString(headers){var headerString='';if(!headers)return headerString;for(var _i=0,_Object$entries=Object.entries(headers);_i<_Object$entries.length;_i++){var _Object$entries$_i=_slicedToArray(_Object$entries[_i],2),key=_Object$entries$_i[0],value=_Object$entries$_i[1];headerString+="\n\t".concat(key,": ").concat(value);}return headerString;}},{key:"formatValue",value:function formatValue(key,value){if(!value||value===''||value==='{}')return'';return"".concat(key,": ").concat(value,"\n");}},{key:"getLogLevel",value:function getLogLevel(level){switch(level){case'error':return logLevelEnum.level.LError;case'debug':return logLevelEnum.level.LDebug;case'trace':return logLevelEnum.level.LTrace;default:return logLevelEnum.level.LNone;}}},{key:"getLogFormat",value:function getLogFormat(format){switch(format){case'json':return logFormatEnum.formats.JSON;default:return logFormatEnum.formats.TEXT;}}}]);}();var Configuration=/*#__PURE__*/function(){function Configuration(){_classCallCheck(this,Configuration);if(!Configuration.instance){Configuration.instance=this;}if(typeof window!=='undefined'){this.configPath='';}else{var os=require('os');var path=require('path');this.configPath=path.join(os.homedir(),'.genesyscloudjavascript','config');}this.refresh_access_token=true;this.refresh_token_wait_max=10;this.live_reload_config=true;this.host;this.environment;this.basePath;this.authUrl;this.config;this.gateway=undefined;this.logger=new Logger();this.setEnvironment();this.liveLoadConfig();}return _createClass(Configuration,[{key:"instance",get:/**
|
|
6161
6175
|
* Singleton getter
|
|
6162
6176
|
*/function get(){return Configuration.instance;}/**
|
|
6163
6177
|
* Singleton setter
|
|
6164
6178
|
*/,set:function set(value){Configuration.instance=value;}},{key:"liveLoadConfig",value:function liveLoadConfig(){// If in browser, don't read config file, use default values
|
|
6165
|
-
this.configPath='';}},{key:"setConfigPath",value:function setConfigPath(path){if(path&&path!==this.configPath){this.configPath=path;this.liveLoadConfig();}}},{key:"updateConfigFromFile",value:function updateConfigFromFile(){}},{key:"updateConfigValues",value:function updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString('logging','log_level'));this.logger.log_format=this.logger.getLogFormat(this.getConfigString('logging','log_format'));this.logger.log_to_console=this.getConfigBoolean('logging','log_to_console')!==undefined?this.getConfigBoolean('logging','log_to_console'):this.logger.log_to_console;this.logger.log_file_path=this.getConfigString('logging','log_file_path')!==undefined?this.getConfigString('logging','log_file_path'):this.logger.log_file_path;this.logger.log_response_body=this.getConfigBoolean('logging','log_response_body')!==undefined?this.getConfigBoolean('logging','log_response_body'):this.logger.log_response_body;this.logger.log_request_body=this.getConfigBoolean('logging','log_request_body')!==undefined?this.getConfigBoolean('logging','log_request_body'):this.logger.log_request_body;this.refresh_access_token=this.getConfigBoolean('reauthentication','refresh_access_token')!==undefined?this.getConfigBoolean('reauthentication','refresh_access_token'):this.refresh_access_token;this.refresh_token_wait_max=this.getConfigInt('reauthentication','refresh_token_wait_max')!==undefined?this.getConfigInt('reauthentication','refresh_token_wait_max'):this.refresh_token_wait_max;this.live_reload_config=this.getConfigBoolean('general','live_reload_config')!==undefined?this.getConfigBoolean('general','live_reload_config'):this.live_reload_config;this.host=this.getConfigString('general','host')!==undefined?this.getConfigString('general','host'):this.host;this.setEnvironment();// Update logging configs
|
|
6166
|
-
this.logger.setLogger();}
|
|
6179
|
+
this.configPath='';}},{key:"setConfigPath",value:function setConfigPath(path){if(path&&path!==this.configPath){this.configPath=path;this.liveLoadConfig();}}},{key:"updateConfigFromFile",value:function updateConfigFromFile(){}},{key:"updateConfigValues",value:function updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString('logging','log_level'));this.logger.log_format=this.logger.getLogFormat(this.getConfigString('logging','log_format'));this.logger.log_to_console=this.getConfigBoolean('logging','log_to_console')!==undefined?this.getConfigBoolean('logging','log_to_console'):this.logger.log_to_console;this.logger.log_file_path=this.getConfigString('logging','log_file_path')!==undefined?this.getConfigString('logging','log_file_path'):this.logger.log_file_path;this.logger.log_response_body=this.getConfigBoolean('logging','log_response_body')!==undefined?this.getConfigBoolean('logging','log_response_body'):this.logger.log_response_body;this.logger.log_request_body=this.getConfigBoolean('logging','log_request_body')!==undefined?this.getConfigBoolean('logging','log_request_body'):this.logger.log_request_body;this.refresh_access_token=this.getConfigBoolean('reauthentication','refresh_access_token')!==undefined?this.getConfigBoolean('reauthentication','refresh_access_token'):this.refresh_access_token;this.refresh_token_wait_max=this.getConfigInt('reauthentication','refresh_token_wait_max')!==undefined?this.getConfigInt('reauthentication','refresh_token_wait_max'):this.refresh_token_wait_max;this.live_reload_config=this.getConfigBoolean('general','live_reload_config')!==undefined?this.getConfigBoolean('general','live_reload_config'):this.live_reload_config;this.host=this.getConfigString('general','host')!==undefined?this.getConfigString('general','host'):this.host;if(this.getConfigString('gateway','host')!==undefined){var gateway={host:this.getConfigString('gateway','host')};if(this.getConfigString('gateway','protocol')!==undefined)gateway.protocol=this.getConfigString('gateway','protocol');if(this.getConfigInt('gateway','port')!==undefined)gateway.port=this.getConfigInt('gateway','port');if(this.getConfigString('gateway','path_params_login')!==undefined)gateway.path_params_login=this.getConfigString('gateway','path_params_login');if(this.getConfigString('gateway','path_params_api')!==undefined)gateway.path_params_api=this.getConfigString('gateway','path_params_api');if(this.getConfigString('gateway','username')!==undefined)gateway.username=this.getConfigString('gateway','username');if(this.getConfigString('gateway','password')!==undefined)gateway.password=this.getConfigString('gateway','password');this.setGateway(gateway);}else{this.setGateway();}this.setEnvironment();// Update logging configs
|
|
6180
|
+
this.logger.setLogger();}/**
|
|
6181
|
+
* @description Sets the gateway used by the session
|
|
6182
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
6183
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
6184
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
6185
|
+
* @param {number} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater or equal to 0).
|
|
6186
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
6187
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
6188
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
6189
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
6190
|
+
*/},{key:"setGateway",value:function setGateway(gateway){if(gateway){this.gateway={host:''};if(gateway.protocol)this.gateway.protocol=gateway.protocol;else this.gateway.protocol='https';if(gateway.host)this.gateway.host=gateway.host;else this.gateway.host='';if(gateway.port&&gateway.port>-1)this.gateway.port=gateway.port;else this.gateway.port=-1;if(gateway.path_params_login){this.gateway.path_params_login=gateway.path_params_login;// Strip trailing slash
|
|
6191
|
+
this.gateway.path_params_login=this.gateway.path_params_login.replace(/\/+$/,'');}else this.gateway.path_params_login='';if(gateway.path_params_api){this.gateway.path_params_api=gateway.path_params_api;// Strip trailing slash
|
|
6192
|
+
this.gateway.path_params_api=this.gateway.path_params_api.replace(/\/+$/,'');}else this.gateway.path_params_api='';if(gateway.username)this.gateway.username=gateway.username;if(gateway.password)this.gateway.password=gateway.password;}else{this.gateway=undefined;}}},{key:"setEnvironment",value:function setEnvironment(env){// Default value
|
|
6167
6193
|
if(env)this.environment=env;else this.environment=this.host?this.host:'mypurecloud.com';// Strip trailing slash
|
|
6168
6194
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6169
|
-
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:"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];}}}]);}();/**
|
|
6195
|
+
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];}}}]);}();/**
|
|
6170
6196
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6171
|
-
* @version
|
|
6197
|
+
* @version 208.0.0
|
|
6172
6198
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6173
6199
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6174
6200
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6237,6 +6263,16 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
6237
6263
|
* @description Sets the environment used by the session
|
|
6238
6264
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
6239
6265
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
6266
|
+
* @description Sets the gateway used by the session
|
|
6267
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
6268
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
6269
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
6270
|
+
* @param {string} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater than 0).
|
|
6271
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
6272
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
6273
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
6274
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
6275
|
+
*/},{key:"setGateway",value:function setGateway(gateway){this.config.setGateway(gateway);}/**
|
|
6240
6276
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
6241
6277
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6242
6278
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
@@ -6252,35 +6288,35 @@ _this2._testTokenAccess().then(function(){if(!_this2.authData.state&&opts.state)
|
|
|
6252
6288
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
6253
6289
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6254
6290
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
6255
|
-
*/},{key:"loginClientCredentialsGrant",value:function loginClientCredentialsGrant(clientId,clientSecret){var _this3=this;this.clientId=clientId;var authHeader=Buffer.from("".concat(clientId,":").concat(clientSecret)).toString('base64');return new Promise(function(resolve,reject){// Block browsers from using client credentials
|
|
6256
|
-
if(typeof window!=='undefined'){reject(new Error('The client credentials grant is not supported in a browser.'));return;}var headers={'Authorization':"Basic ".concat(authHeader)};axios$1({method:"POST",url:"
|
|
6257
|
-
_this3.config.logger.log('trace',response.status,'POST',"
|
|
6291
|
+
*/},{key:"loginClientCredentialsGrant",value:function loginClientCredentialsGrant(clientId,clientSecret){var _this3=this;this.clientId=clientId;var authHeader=Buffer.from("".concat(clientId,":").concat(clientSecret)).toString('base64');var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){// Block browsers from using client credentials
|
|
6292
|
+
if(typeof window!=='undefined'){reject(new Error('The client credentials grant is not supported in a browser.'));return;}var headers={'Authorization':"Basic ".concat(authHeader)};axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:headers,data:'grant_type=client_credentials',httpsAgent:_this3.proxyAgent}).then(function(response){// Logging
|
|
6293
|
+
_this3.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,response.headers,{grant_type:'client_credentials'},undefined);_this3.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,undefined,{grant_type:'client_credentials'},undefined);// Save access token
|
|
6258
6294
|
_this3.setAccessToken(response.data['access_token']);// Set expiry time
|
|
6259
6295
|
_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6260
6296
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
6261
|
-
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"
|
|
6297
|
+
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,error.response.headers,{grant_type:'client_credentials'},error.response.data);}reject(error);});});}/**
|
|
6262
6298
|
* @description Initiates the Saml2Bearerflow. Only available in node apps.
|
|
6263
6299
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6264
6300
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
6265
6301
|
* @param {string} orgName - The orgName of an OAuth Implicit Grant client
|
|
6266
6302
|
* @param {string} assertion - The saml2bearer assertion
|
|
6267
|
-
*/},{key:"loginSaml2BearerGrant",value:function loginSaml2BearerGrant(clientId,clientSecret,orgName,assertion){var _this4=this;this.clientId=clientId;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The saml2bearer grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this4._formAuthRequest(encodedData,{grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion});request.proxy=_this4.proxy;var bodyParam={grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion};// Handle response
|
|
6303
|
+
*/},{key:"loginSaml2BearerGrant",value:function loginSaml2BearerGrant(clientId,clientSecret,orgName,assertion){var _this4=this;this.clientId=clientId;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The saml2bearer grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this4._formAuthRequest(encodedData,{grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion});request.proxy=_this4.proxy;var bodyParam={grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion};// Handle response
|
|
6268
6304
|
request.then(function(response){// Logging
|
|
6269
|
-
_this4.config.logger.log('trace',response.status,'POST',"
|
|
6305
|
+
_this4.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this4.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
6270
6306
|
var access_token=response.data.access_token;_this4.setAccessToken(access_token);_this4.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this4.authData.tokenExpiryTimeString=new Date(_this4.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6271
6307
|
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
6272
|
-
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"
|
|
6308
|
+
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
6273
6309
|
* @description Completes the PKCE Code Authorization.
|
|
6274
6310
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6275
6311
|
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
6276
6312
|
* @param {string} authCode - Authorization code
|
|
6277
6313
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6278
|
-
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this5=this;this.clientId=clientId;return new Promise(function(resolve,reject){var request=axios$1({method:"POST",url:"
|
|
6314
|
+
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this5=this;this.clientId=clientId;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){var request=axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:{'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify({grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri})});request.proxy=_this5.proxy;var bodyParam={grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri};// Handle response
|
|
6279
6315
|
request.then(function(response){// Logging
|
|
6280
|
-
_this5.config.logger.log('trace',response.status,'POST',"
|
|
6316
|
+
_this5.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this5.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
6281
6317
|
var access_token=response.data.access_token;_this5.setAccessToken(access_token);_this5.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this5.authData.tokenExpiryTimeString=new Date(_this5.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6282
6318
|
resolve(_this5.authData);})["catch"](function(error){// Log error
|
|
6283
|
-
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"
|
|
6319
|
+
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
6284
6320
|
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
6285
6321
|
* @param {number} nChar - code length
|
|
6286
6322
|
*/},{key:"generatePKCECodeVerifier",value:function generatePKCECodeVerifier(nChar){if(nChar<43||nChar>128){throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");}// Check for window
|
|
@@ -6346,15 +6382,15 @@ _this8._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/*
|
|
|
6346
6382
|
* @param {object} bodyParam - Input body data for authorization request
|
|
6347
6383
|
* @param {function} resolve - Promise resolve callback
|
|
6348
6384
|
* @param {function} reject - Promise reject callback
|
|
6349
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;request.then(function(response){// Logging
|
|
6350
|
-
_this9.config.logger.log('trace',response.status,'POST',"
|
|
6385
|
+
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));request.then(function(response){// Logging
|
|
6386
|
+
_this9.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this9.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
6351
6387
|
var access_token=response.data.access_token;var refresh_token=response.data.refresh_token;_this9.setAccessToken(access_token);_this9.authData.refreshToken=refresh_token;_this9.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this9.authData.tokenExpiryTimeString=new Date(_this9.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6352
6388
|
resolve(_this9.authData);})["catch"](function(error){// Log error
|
|
6353
|
-
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"
|
|
6389
|
+
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});}/**
|
|
6354
6390
|
* @description Utility function to create the request for auth requests
|
|
6355
6391
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
6356
6392
|
* @param {object} data - data to url form encode
|
|
6357
|
-
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"
|
|
6393
|
+
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));var request=axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:{'Authorization':'Basic '+encodedData,'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify(data)});return request;}/**
|
|
6358
6394
|
* @description Handles an expired access token. Only available in node apps.
|
|
6359
6395
|
* @param {string} statusCode - The status code of a request
|
|
6360
6396
|
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var _this10=this;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('This method is not supported in a browser.'));return;}if(!_this10.refreshInProgress){_this10.refreshInProgress=true;_this10.refreshCodeAuthorizationGrant(_this10.clientId,_this10.clientSecret,_this10.authData.refreshToken).then(function(){_this10.refreshInProgress=false;resolve();})["catch"](function(err){// Handle failure response
|
|
@@ -6393,7 +6429,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6393
6429
|
* @description Constructs a URL to the auth server
|
|
6394
6430
|
* @param {string} path - The path for the URL
|
|
6395
6431
|
* @param {object} query - An object of key/value pairs to use for querystring keys/values
|
|
6396
|
-
*/},{key:"_buildAuthUrl",value:function _buildAuthUrl(path,query){if(!query)query={};return Object.keys(query).reduce(function(url,key){return!query[key]?url:"".concat(url,"&").concat(key,"=").concat(query[key]);},"".concat(
|
|
6432
|
+
*/},{key:"_buildAuthUrl",value:function _buildAuthUrl(path,query){if(!query)query={};var loginBasePath=this.config.getConfUrl('login',this.config.authUrl);return Object.keys(query).reduce(function(url,key){return!query[key]?url:"".concat(url,"&").concat(key,"=").concat(query[key]);},"".concat(loginBasePath,"/").concat(path,"?"));}/**
|
|
6397
6433
|
* Returns a string representation for an actual parameter.
|
|
6398
6434
|
* @param param The actual parameter.
|
|
6399
6435
|
* @returns {String} The string representation of <code>param</code>.
|
|
@@ -6412,7 +6448,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6412
6448
|
* @param {String} path The path to append to the base URL.
|
|
6413
6449
|
* @param {Object} pathParams The parameter values to append.
|
|
6414
6450
|
* @returns {String} The encoded path with parameter values substituted.
|
|
6415
|
-
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this12=this;if(!path.match(/^\//)){path="/".concat(path);}var url=this.config.basePath+path;url=url.replace(/\{([\w-]+)\}/g,function(fullMatch,key){var value;if(pathParams.hasOwnProperty(key)){value=_this12.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
6451
|
+
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this12=this;if(!path.match(/^\//)){path="/".concat(path);}var url=this.config.getConfUrl('api',this.config.basePath)+path;url=url.replace(/\{([\w-]+)\}/g,function(fullMatch,key){var value;if(pathParams.hasOwnProperty(key)){value=_this12.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
6416
6452
|
* Checks whether the given content type represents JSON.<br>
|
|
6417
6453
|
* JSON content type examples:<br>
|
|
6418
6454
|
* <ul>
|
|
@@ -6480,7 +6516,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6480
6516
|
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(){/**
|
|
6481
6517
|
* AgentAssistants service.
|
|
6482
6518
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6483
|
-
* @version
|
|
6519
|
+
* @version 208.0.0
|
|
6484
6520
|
*//**
|
|
6485
6521
|
* Constructs a new AgentAssistantsApi.
|
|
6486
6522
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6581,7 +6617,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6581
6617
|
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(){/**
|
|
6582
6618
|
* AgentCopilot service.
|
|
6583
6619
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6584
|
-
* @version
|
|
6620
|
+
* @version 208.0.0
|
|
6585
6621
|
*//**
|
|
6586
6622
|
* Constructs a new AgentCopilotApi.
|
|
6587
6623
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6603,7 +6639,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6603
6639
|
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(){/**
|
|
6604
6640
|
* AgentUI service.
|
|
6605
6641
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6606
|
-
* @version
|
|
6642
|
+
* @version 208.0.0
|
|
6607
6643
|
*//**
|
|
6608
6644
|
* Constructs a new AgentUIApi.
|
|
6609
6645
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6637,7 +6673,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6637
6673
|
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(){/**
|
|
6638
6674
|
* Alerting service.
|
|
6639
6675
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6640
|
-
* @version
|
|
6676
|
+
* @version 208.0.0
|
|
6641
6677
|
*//**
|
|
6642
6678
|
* Constructs a new AlertingApi.
|
|
6643
6679
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6794,7 +6830,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6794
6830
|
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(){/**
|
|
6795
6831
|
* Analytics service.
|
|
6796
6832
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6797
|
-
* @version
|
|
6833
|
+
* @version 208.0.0
|
|
6798
6834
|
*//**
|
|
6799
6835
|
* Constructs a new AnalyticsApi.
|
|
6800
6836
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7018,7 +7054,8 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7018
7054
|
* @param {Number} opts.pageSize (default to 25)
|
|
7019
7055
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
7020
7056
|
* @param {Object} opts.state Only list users of this state
|
|
7021
|
-
|
|
7057
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
7058
|
+
*/},{key:"getAnalyticsReportingDashboardsUsers",value:function getAnalyticsReportingDashboardsUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/analytics/reporting/dashboards/users','GET',{},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'state':opts['state'],'deletedOnly':opts['deletedOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7022
7059
|
* Get all view export requests for a user
|
|
7023
7060
|
*
|
|
7024
7061
|
* @param {Object} opts Optional parameters
|
|
@@ -7052,9 +7089,10 @@ if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missin
|
|
|
7052
7089
|
* @param {Number} opts.pageSize (default to 50)
|
|
7053
7090
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
7054
7091
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
7092
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
7055
7093
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
7056
7094
|
*/},{key:"getAnalyticsReportingSettingsUserDashboards",value:function getAnalyticsReportingSettingsUserDashboards(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
7057
|
-
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/users/{userId}/dashboards','GET',{'userId':userId},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'publicOnly':opts['publicOnly'],'favoriteOnly':opts['favoriteOnly'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7095
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/users/{userId}/dashboards','GET',{'userId':userId},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'publicOnly':opts['publicOnly'],'favoriteOnly':opts['favoriteOnly'],'deletedOnly':opts['deletedOnly'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7058
7096
|
* Get status for async query for resolution aggregates
|
|
7059
7097
|
*
|
|
7060
7098
|
* @param {String} jobId jobId
|
|
@@ -7298,7 +7336,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7298
7336
|
* @param {Object} body query
|
|
7299
7337
|
*/},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7300
7338
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/ratelimits/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7301
|
-
* Bulk delete dashboards owned by other user(s)
|
|
7339
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
7302
7340
|
*
|
|
7303
7341
|
* @param {Array.<String>} body List of userIds
|
|
7304
7342
|
*/},{key:"postAnalyticsReportingDashboardsUsersBulkRemove",value:function postAnalyticsReportingDashboardsUsersBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -7308,7 +7346,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7308
7346
|
* @param {Object} body ReportingExportJobRequest
|
|
7309
7347
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
7310
7348
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsReportingExports';}return this.apiClient.callApi('/api/v2/analytics/reporting/exports','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7311
|
-
* Bulk
|
|
7349
|
+
* Bulk soft delete dashboard configurations
|
|
7312
7350
|
*
|
|
7313
7351
|
* @param {Object} body
|
|
7314
7352
|
*/},{key:"postAnalyticsReportingSettingsDashboardsBulkRemove",value:function postAnalyticsReportingSettingsDashboardsBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -7352,7 +7390,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7352
7390
|
* Query for task management aggregates
|
|
7353
7391
|
*
|
|
7354
7392
|
* @param {Object} body query
|
|
7355
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7356
7393
|
*/},{key:"postAnalyticsTaskmanagementAggregatesQuery",value:function postAnalyticsTaskmanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7357
7394
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/taskmanagement/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7358
7395
|
* Query for team activity observations
|
|
@@ -7415,7 +7452,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7415
7452
|
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(){/**
|
|
7416
7453
|
* Architect service.
|
|
7417
7454
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7418
|
-
* @version
|
|
7455
|
+
* @version 208.0.0
|
|
7419
7456
|
*//**
|
|
7420
7457
|
* Constructs a new ArchitectApi.
|
|
7421
7458
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -7905,7 +7942,7 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
7905
7942
|
*/},{key:"getFlowVersion",value:function getFlowVersion(flowId,versionId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
7906
7943
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowVersion';}// verify the required parameter 'versionId' is set
|
|
7907
7944
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getFlowVersion';}return this.apiClient.callApi('/api/v2/flows/{flowId}/versions/{versionId}','GET',{'flowId':flowId,'versionId':versionId},{'deleted':opts['deleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7908
|
-
*
|
|
7945
|
+
* Get flow version configuration
|
|
7909
7946
|
*
|
|
7910
7947
|
* @param {String} flowId Flow ID
|
|
7911
7948
|
* @param {String} versionId Version ID
|
|
@@ -8507,7 +8544,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8507
8544
|
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(){/**
|
|
8508
8545
|
* Audit service.
|
|
8509
8546
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8510
|
-
* @version
|
|
8547
|
+
* @version 208.0.0
|
|
8511
8548
|
*//**
|
|
8512
8549
|
* Constructs a new AuditApi.
|
|
8513
8550
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8557,7 +8594,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8557
8594
|
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(){/**
|
|
8558
8595
|
* Authorization service.
|
|
8559
8596
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8560
|
-
* @version
|
|
8597
|
+
* @version 208.0.0
|
|
8561
8598
|
*//**
|
|
8562
8599
|
* Constructs a new AuthorizationApi.
|
|
8563
8600
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8880,7 +8917,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8880
8917
|
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(){/**
|
|
8881
8918
|
* Billing service.
|
|
8882
8919
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8883
|
-
* @version
|
|
8920
|
+
* @version 208.0.0
|
|
8884
8921
|
*//**
|
|
8885
8922
|
* Constructs a new BillingApi.
|
|
8886
8923
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8904,7 +8941,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8904
8941
|
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(){/**
|
|
8905
8942
|
* CarrierServices service.
|
|
8906
8943
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8907
|
-
* @version
|
|
8944
|
+
* @version 208.0.0
|
|
8908
8945
|
*//**
|
|
8909
8946
|
* Constructs a new CarrierServicesApi.
|
|
8910
8947
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8924,7 +8961,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8924
8961
|
*/},{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(){/**
|
|
8925
8962
|
* Chat service.
|
|
8926
8963
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8927
|
-
* @version
|
|
8964
|
+
* @version 208.0.0
|
|
8928
8965
|
*//**
|
|
8929
8966
|
* Constructs a new ChatApi.
|
|
8930
8967
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9149,7 +9186,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9149
9186
|
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(){/**
|
|
9150
9187
|
* Coaching service.
|
|
9151
9188
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9152
|
-
* @version
|
|
9189
|
+
* @version 208.0.0
|
|
9153
9190
|
*//**
|
|
9154
9191
|
* Constructs a new CoachingApi.
|
|
9155
9192
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9302,7 +9339,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9302
9339
|
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(){/**
|
|
9303
9340
|
* ContentManagement service.
|
|
9304
9341
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9305
|
-
* @version
|
|
9342
|
+
* @version 208.0.0
|
|
9306
9343
|
*//**
|
|
9307
9344
|
* Constructs a new ContentManagementApi.
|
|
9308
9345
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9406,12 +9443,11 @@ if(shareId===undefined||shareId===null){throw'Missing the required parameter "sh
|
|
|
9406
9443
|
* This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
|
|
9407
9444
|
* @param {String} sharedId Shared ID
|
|
9408
9445
|
* @param {Object} opts Optional parameters
|
|
9409
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
9410
9446
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
9411
9447
|
* @param {String} opts.contentType The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
|
|
9412
9448
|
* @param {Object} opts.expand Expand some document fields
|
|
9413
9449
|
*/},{key:"getContentmanagementSharedSharedId",value:function getContentmanagementSharedSharedId(sharedId,opts){opts=opts||{};// verify the required parameter 'sharedId' is set
|
|
9414
|
-
if(sharedId===undefined||sharedId===null){throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';}return this.apiClient.callApi('/api/v2/contentmanagement/shared/{sharedId}','GET',{'sharedId':sharedId},{'
|
|
9450
|
+
if(sharedId===undefined||sharedId===null){throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';}return this.apiClient.callApi('/api/v2/contentmanagement/shared/{sharedId}','GET',{'sharedId':sharedId},{'disposition':opts['disposition'],'contentType':opts['contentType'],'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9415
9451
|
* Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
9416
9452
|
* Failing to specify a filter will return 400.
|
|
9417
9453
|
* @param {Object} opts Optional parameters
|
|
@@ -9585,7 +9621,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9585
9621
|
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(){/**
|
|
9586
9622
|
* Conversations service.
|
|
9587
9623
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9588
|
-
* @version
|
|
9624
|
+
* @version 208.0.0
|
|
9589
9625
|
*//**
|
|
9590
9626
|
* Constructs a new ConversationsApi.
|
|
9591
9627
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10724,9 +10760,10 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10724
10760
|
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'body' is set
|
|
10725
10761
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionEngagement';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement','POST',{'conversationId':conversationId,'suggestionId':suggestionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10726
10762
|
* Suggestion feedback.
|
|
10727
|
-
*
|
|
10763
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
10728
10764
|
* @param {String} conversationId Conversation ID
|
|
10729
10765
|
* @param {Object} body SuggestionFeedback
|
|
10766
|
+
* @deprecated
|
|
10730
10767
|
*/},{key:"postConversationSuggestionsFeedback",value:function postConversationSuggestionsFeedback(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
10731
10768
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';}// verify the required parameter 'body' is set
|
|
10732
10769
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/feedback','POST',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -11313,7 +11350,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11313
11350
|
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(){/**
|
|
11314
11351
|
* DataExtensions service.
|
|
11315
11352
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11316
|
-
* @version
|
|
11353
|
+
* @version 208.0.0
|
|
11317
11354
|
*//**
|
|
11318
11355
|
* Constructs a new DataExtensionsApi.
|
|
11319
11356
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11334,7 +11371,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11334
11371
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
11335
11372
|
* Downloads service.
|
|
11336
11373
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11337
|
-
* @version
|
|
11374
|
+
* @version 208.0.0
|
|
11338
11375
|
*//**
|
|
11339
11376
|
* Constructs a new DownloadsApi.
|
|
11340
11377
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11353,7 +11390,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11353
11390
|
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(){/**
|
|
11354
11391
|
* Emails service.
|
|
11355
11392
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11356
|
-
* @version
|
|
11393
|
+
* @version 208.0.0
|
|
11357
11394
|
*//**
|
|
11358
11395
|
* Constructs a new EmailsApi.
|
|
11359
11396
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11371,7 +11408,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11371
11408
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
11372
11409
|
* EmployeeEngagement service.
|
|
11373
11410
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11374
|
-
* @version
|
|
11411
|
+
* @version 208.0.0
|
|
11375
11412
|
*//**
|
|
11376
11413
|
* Constructs a new EmployeeEngagementApi.
|
|
11377
11414
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11409,7 +11446,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11409
11446
|
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(){/**
|
|
11410
11447
|
* Events service.
|
|
11411
11448
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11412
|
-
* @version
|
|
11449
|
+
* @version 208.0.0
|
|
11413
11450
|
*//**
|
|
11414
11451
|
* Constructs a new EventsApi.
|
|
11415
11452
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11434,7 +11471,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11434
11471
|
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(){/**
|
|
11435
11472
|
* ExternalContacts service.
|
|
11436
11473
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11437
|
-
* @version
|
|
11474
|
+
* @version 208.0.0
|
|
11438
11475
|
*//**
|
|
11439
11476
|
* Constructs a new ExternalContactsApi.
|
|
11440
11477
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11462,9 +11499,13 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
11462
11499
|
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
11463
11500
|
*
|
|
11464
11501
|
* @param {String} externalSourceId External Source ID
|
|
11465
|
-
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11466
11502
|
*/},{key:"deleteExternalcontactsExternalsource",value:function deleteExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
11467
11503
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling deleteExternalcontactsExternalsource';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources/{externalSourceId}','DELETE',{'externalSourceId':externalSourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11504
|
+
* Delete settings for CSV import
|
|
11505
|
+
*
|
|
11506
|
+
* @param {String} settingsId Settings id
|
|
11507
|
+
*/},{key:"deleteExternalcontactsImportCsvSetting",value:function deleteExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
11508
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','DELETE',{'settingsId':settingsId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11468
11509
|
* Delete an external organization
|
|
11469
11510
|
*
|
|
11470
11511
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11531,7 +11572,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
11531
11572
|
*
|
|
11532
11573
|
* @param {String} contactId ExternalContact ID
|
|
11533
11574
|
* @param {Object} opts Optional parameters
|
|
11534
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
11575
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
11535
11576
|
*/},{key:"getExternalcontactsContactUnresolved",value:function getExternalcontactsContactUnresolved(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
11536
11577
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}/unresolved','GET',{'contactId':contactId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11537
11578
|
* Search for external contacts
|
|
@@ -11566,7 +11607,6 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
11566
11607
|
* Fetch an External Source
|
|
11567
11608
|
*
|
|
11568
11609
|
* @param {String} externalSourceId External Source ID
|
|
11569
|
-
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11570
11610
|
*/},{key:"getExternalcontactsExternalsource",value:function getExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
11571
11611
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling getExternalcontactsExternalsource';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources/{externalSourceId}','GET',{'externalSourceId':externalSourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11572
11612
|
* Fetch a list of External Sources
|
|
@@ -11576,13 +11616,34 @@ if(externalSourceId===undefined||externalSourceId===null){throw'Missing the requ
|
|
|
11576
11616
|
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
11577
11617
|
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
11578
11618
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
11579
|
-
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11580
11619
|
*/},{key:"getExternalcontactsExternalsources",value:function getExternalcontactsExternalsources(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/externalsources','GET',{},{'cursor':opts['cursor'],'limit':opts['limit'],'name':opts['name'],'active':opts['active']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11620
|
+
* Get settings for CSV import
|
|
11621
|
+
*
|
|
11622
|
+
* @param {String} settingsId Settings id
|
|
11623
|
+
*/},{key:"getExternalcontactsImportCsvSetting",value:function getExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
11624
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','GET',{'settingsId':settingsId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11625
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
11626
|
+
*
|
|
11627
|
+
* @param {Object} opts Optional parameters
|
|
11628
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11629
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11630
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
11631
|
+
*/},{key:"getExternalcontactsImportCsvSettings",value:function getExternalcontactsImportCsvSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'externalSettingsId':opts['externalSettingsId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11632
|
+
* Get details for CSV upload
|
|
11633
|
+
*
|
|
11634
|
+
* @param {String} uploadId Upload id
|
|
11635
|
+
*/},{key:"getExternalcontactsImportCsvUploadDetails",value:function getExternalcontactsImportCsvUploadDetails(uploadId){// verify the required parameter 'uploadId' is set
|
|
11636
|
+
if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details','GET',{'uploadId':uploadId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11637
|
+
* Get preview for CSV upload
|
|
11638
|
+
*
|
|
11639
|
+
* @param {String} uploadId Upload id
|
|
11640
|
+
*/},{key:"getExternalcontactsImportCsvUploadPreview",value:function getExternalcontactsImportCsvUploadPreview(uploadId){// verify the required parameter 'uploadId' is set
|
|
11641
|
+
if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview','GET',{'uploadId':uploadId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11581
11642
|
* Fetch an external organization
|
|
11582
11643
|
*
|
|
11583
11644
|
* @param {String} externalOrganizationId External Organization ID
|
|
11584
11645
|
* @param {Object} opts Optional parameters
|
|
11585
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
11646
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
11586
11647
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
11587
11648
|
*/},{key:"getExternalcontactsOrganization",value:function getExternalcontactsOrganization(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
11588
11649
|
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganization';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}','GET',{'externalOrganizationId':externalOrganizationId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'includeTrustors':opts['includeTrustors']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -11812,7 +11873,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11812
11873
|
* Create an External Source
|
|
11813
11874
|
*
|
|
11814
11875
|
* @param {Object} body External Source
|
|
11815
|
-
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11816
11876
|
*/},{key:"postExternalcontactsExternalsources",value:function postExternalcontactsExternalsources(body){// verify the required parameter 'body' is set
|
|
11817
11877
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsExternalsources';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11818
11878
|
* Fetch a contact using an identifier type and value.
|
|
@@ -11822,6 +11882,21 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11822
11882
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
11823
11883
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
11824
11884
|
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11885
|
+
* Create CSV import job
|
|
11886
|
+
*
|
|
11887
|
+
* @param {Object} body ImportRequest
|
|
11888
|
+
*/},{key:"postExternalcontactsImportCsvJobs",value:function postExternalcontactsImportCsvJobs(body){// verify the required parameter 'body' is set
|
|
11889
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11890
|
+
* Create settings for CSV import
|
|
11891
|
+
*
|
|
11892
|
+
* @param {Object} body Settings
|
|
11893
|
+
*/},{key:"postExternalcontactsImportCsvSettings",value:function postExternalcontactsImportCsvSettings(body){// verify the required parameter 'body' is set
|
|
11894
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11895
|
+
* Get url for CSV upload
|
|
11896
|
+
*
|
|
11897
|
+
* @param {Object} body UploadRequest
|
|
11898
|
+
*/},{key:"postExternalcontactsImportCsvUploads",value:function postExternalcontactsImportCsvUploads(body){// verify the required parameter 'body' is set
|
|
11899
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11825
11900
|
* Merge two contacts into a new contact record
|
|
11826
11901
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
11827
11902
|
* @param {Object} body MergeRequest
|
|
@@ -11883,10 +11958,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11883
11958
|
*
|
|
11884
11959
|
* @param {String} externalSourceId External Source ID
|
|
11885
11960
|
* @param {Object} body External Source
|
|
11886
|
-
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11887
11961
|
*/},{key:"putExternalcontactsExternalsource",value:function putExternalcontactsExternalsource(externalSourceId,body){// verify the required parameter 'externalSourceId' is set
|
|
11888
11962
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';}// verify the required parameter 'body' is set
|
|
11889
11963
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsExternalsource';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources/{externalSourceId}','PUT',{'externalSourceId':externalSourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11964
|
+
* Update settings for CSV import
|
|
11965
|
+
*
|
|
11966
|
+
* @param {String} settingsId Settings id
|
|
11967
|
+
* @param {Object} body Settings
|
|
11968
|
+
*/},{key:"putExternalcontactsImportCsvSetting",value:function putExternalcontactsImportCsvSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
11969
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';}// verify the required parameter 'body' is set
|
|
11970
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','PUT',{'settingsId':settingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11890
11971
|
* Update an external organization
|
|
11891
11972
|
*
|
|
11892
11973
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11926,7 +12007,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11926
12007
|
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(){/**
|
|
11927
12008
|
* Fax service.
|
|
11928
12009
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11929
|
-
* @version
|
|
12010
|
+
* @version 208.0.0
|
|
11930
12011
|
*//**
|
|
11931
12012
|
* Constructs a new FaxApi.
|
|
11932
12013
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11975,7 +12056,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11975
12056
|
*/},{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(){/**
|
|
11976
12057
|
* Flows service.
|
|
11977
12058
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11978
|
-
* @version
|
|
12059
|
+
* @version 208.0.0
|
|
11979
12060
|
*//**
|
|
11980
12061
|
* Constructs a new FlowsApi.
|
|
11981
12062
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12023,7 +12104,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12023
12104
|
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(){/**
|
|
12024
12105
|
* Gamification service.
|
|
12025
12106
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12026
|
-
* @version
|
|
12107
|
+
* @version 208.0.0
|
|
12027
12108
|
*//**
|
|
12028
12109
|
* Constructs a new GamificationApi.
|
|
12029
12110
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12563,7 +12644,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12563
12644
|
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(){/**
|
|
12564
12645
|
* GeneralDataProtectionRegulation service.
|
|
12565
12646
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12566
|
-
* @version
|
|
12647
|
+
* @version 208.0.0
|
|
12567
12648
|
*//**
|
|
12568
12649
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12569
12650
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12598,7 +12679,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12598
12679
|
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(){/**
|
|
12599
12680
|
* Geolocation service.
|
|
12600
12681
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12601
|
-
* @version
|
|
12682
|
+
* @version 208.0.0
|
|
12602
12683
|
*//**
|
|
12603
12684
|
* Constructs a new GeolocationApi.
|
|
12604
12685
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12632,7 +12713,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12632
12713
|
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(){/**
|
|
12633
12714
|
* Greetings service.
|
|
12634
12715
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12635
|
-
* @version
|
|
12716
|
+
* @version 208.0.0
|
|
12636
12717
|
*//**
|
|
12637
12718
|
* Constructs a new GreetingsApi.
|
|
12638
12719
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12739,7 +12820,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12739
12820
|
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(){/**
|
|
12740
12821
|
* Groups service.
|
|
12741
12822
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12742
|
-
* @version
|
|
12823
|
+
* @version 208.0.0
|
|
12743
12824
|
*//**
|
|
12744
12825
|
* Constructs a new GroupsApi.
|
|
12745
12826
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12872,7 +12953,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12872
12953
|
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(){/**
|
|
12873
12954
|
* IdentityProvider service.
|
|
12874
12955
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12875
|
-
* @version
|
|
12956
|
+
* @version 208.0.0
|
|
12876
12957
|
*//**
|
|
12877
12958
|
* Constructs a new IdentityProviderApi.
|
|
12878
12959
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13028,7 +13109,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13028
13109
|
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(){/**
|
|
13029
13110
|
* InfrastructureAsCode service.
|
|
13030
13111
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13031
|
-
* @version
|
|
13112
|
+
* @version 208.0.0
|
|
13032
13113
|
*//**
|
|
13033
13114
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13034
13115
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13082,7 +13163,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13082
13163
|
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(){/**
|
|
13083
13164
|
* Integrations service.
|
|
13084
13165
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13085
|
-
* @version
|
|
13166
|
+
* @version 208.0.0
|
|
13086
13167
|
*//**
|
|
13087
13168
|
* Constructs a new IntegrationsApi.
|
|
13088
13169
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13163,9 +13244,11 @@ if(actionId===undefined||actionId===null){throw'Missing the required parameter "
|
|
|
13163
13244
|
*
|
|
13164
13245
|
* @param {String} actionId actionId
|
|
13165
13246
|
* @param {String} fileName Name of schema file to be retrieved for this draft.
|
|
13166
|
-
|
|
13247
|
+
* @param {Object} opts Optional parameters
|
|
13248
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
13249
|
+
*/},{key:"getIntegrationsActionDraftSchema",value:function getIntegrationsActionDraftSchema(actionId,fileName,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
13167
13250
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';}// verify the required parameter 'fileName' is set
|
|
13168
|
-
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13251
|
+
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{'flatten':opts['flatten']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13169
13252
|
* Retrieve templates for a Draft based on filename.
|
|
13170
13253
|
*
|
|
13171
13254
|
* @param {String} actionId actionId
|
|
@@ -13188,9 +13271,11 @@ if(actionId===undefined||actionId===null){throw'Missing the required parameter "
|
|
|
13188
13271
|
*
|
|
13189
13272
|
* @param {String} actionId actionId
|
|
13190
13273
|
* @param {String} fileName Name of schema file to be retrieved for this action.
|
|
13191
|
-
|
|
13274
|
+
* @param {Object} opts Optional parameters
|
|
13275
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
13276
|
+
*/},{key:"getIntegrationsActionSchema",value:function getIntegrationsActionSchema(actionId,fileName,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
13192
13277
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';}// verify the required parameter 'fileName' is set
|
|
13193
|
-
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13278
|
+
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{'flatten':opts['flatten']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13194
13279
|
* Retrieve text of templates for an action based on filename.
|
|
13195
13280
|
*
|
|
13196
13281
|
* @param {String} actionId actionId
|
|
@@ -13599,23 +13684,29 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13599
13684
|
*
|
|
13600
13685
|
* @param {String} actionId actionId
|
|
13601
13686
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
13602
|
-
|
|
13687
|
+
* @param {Object} opts Optional parameters
|
|
13688
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
13689
|
+
*/},{key:"postIntegrationsActionDraftTest",value:function postIntegrationsActionDraftTest(actionId,body,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
13603
13690
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';}// verify the required parameter 'body' is set
|
|
13604
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionDraftTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/test','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13691
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionDraftTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/test','POST',{'actionId':actionId},{'flatten':opts['flatten']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13605
13692
|
* Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
|
13606
13693
|
*
|
|
13607
13694
|
* @param {String} actionId actionId
|
|
13608
13695
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
13609
|
-
|
|
13696
|
+
* @param {Object} opts Optional parameters
|
|
13697
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
13698
|
+
*/},{key:"postIntegrationsActionExecute",value:function postIntegrationsActionExecute(actionId,body,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
13610
13699
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';}// verify the required parameter 'body' is set
|
|
13611
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionExecute';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/execute','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13700
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionExecute';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/execute','POST',{'actionId':actionId},{'flatten':opts['flatten']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13612
13701
|
* Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
|
13613
13702
|
*
|
|
13614
13703
|
* @param {String} actionId actionId
|
|
13615
13704
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
13616
|
-
|
|
13705
|
+
* @param {Object} opts Optional parameters
|
|
13706
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
13707
|
+
*/},{key:"postIntegrationsActionTest",value:function postIntegrationsActionTest(actionId,body,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
13617
13708
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionTest';}// verify the required parameter 'body' is set
|
|
13618
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/test','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13709
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/test','POST',{'actionId':actionId},{'flatten':opts['flatten']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13619
13710
|
* Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.
|
|
13620
13711
|
*
|
|
13621
13712
|
* @param {Object} body Input used to create Action.
|
|
@@ -13707,7 +13798,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13707
13798
|
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(){/**
|
|
13708
13799
|
* Journey service.
|
|
13709
13800
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13710
|
-
* @version
|
|
13801
|
+
* @version 208.0.0
|
|
13711
13802
|
*//**
|
|
13712
13803
|
* Constructs a new JourneyApi.
|
|
13713
13804
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13747,6 +13838,11 @@ if(segmentId===undefined||segmentId===null){throw'Missing the required parameter
|
|
|
13747
13838
|
* @param {String} viewId viewId
|
|
13748
13839
|
*/},{key:"deleteJourneyView",value:function deleteJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
13749
13840
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling deleteJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','DELETE',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13841
|
+
* Delete the Schedule of a JourneyView
|
|
13842
|
+
* used for long descriptions
|
|
13843
|
+
* @param {String} viewId Journey View Id
|
|
13844
|
+
*/},{key:"deleteJourneyViewSchedules",value:function deleteJourneyViewSchedules(viewId){// verify the required parameter 'viewId' is set
|
|
13845
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','DELETE',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13750
13846
|
* Get status for async query for journey aggregates
|
|
13751
13847
|
*
|
|
13752
13848
|
* @param {String} jobId jobId
|
|
@@ -13912,6 +14008,11 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
13912
14008
|
* @param {String} viewId viewId
|
|
13913
14009
|
*/},{key:"getJourneyView",value:function getJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
13914
14010
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','GET',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14011
|
+
* Get the Schedule for a JourneyView
|
|
14012
|
+
* used for long descriptions
|
|
14013
|
+
* @param {String} viewId Journey View Id
|
|
14014
|
+
*/},{key:"getJourneyViewSchedules",value:function getJourneyViewSchedules(viewId){// verify the required parameter 'viewId' is set
|
|
14015
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','GET',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13915
14016
|
* Get a Journey View by ID and version
|
|
13916
14017
|
*
|
|
13917
14018
|
* @param {String} viewId viewId
|
|
@@ -13987,12 +14088,10 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
13987
14088
|
* Get an Event Definition
|
|
13988
14089
|
*
|
|
13989
14090
|
* @param {String} eventDefinitionId Event Definition ID
|
|
13990
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13991
14091
|
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
13992
14092
|
if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}','GET',{'eventDefinitionId':eventDefinitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13993
14093
|
* Get a list of Event Definitions
|
|
13994
14094
|
*
|
|
13995
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13996
14095
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13997
14096
|
* Get the jobs for an organization.
|
|
13998
14097
|
*
|
|
@@ -14002,6 +14101,12 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
14002
14101
|
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
14003
14102
|
* @param {String} opts.statuses Job statuses to filter for
|
|
14004
14103
|
*/},{key:"getJourneyViewsJobs",value:function getJourneyViewsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/jobs','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'interval':opts['interval'],'statuses':opts['statuses']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14104
|
+
* Get the journey schedules for an organization.
|
|
14105
|
+
*
|
|
14106
|
+
* @param {Object} opts Optional parameters
|
|
14107
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
14108
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
14109
|
+
*/},{key:"getJourneyViewsSchedules",value:function getJourneyViewsSchedules(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/schedules','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14005
14110
|
* Update single action map.
|
|
14006
14111
|
*
|
|
14007
14112
|
* @param {String} actionMapId ID of the action map.
|
|
@@ -14121,6 +14226,13 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
14121
14226
|
* @param {Object} opts Optional parameters
|
|
14122
14227
|
* @param {Object} opts.body
|
|
14123
14228
|
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14229
|
+
* Add a new Schedule to a JourneyView
|
|
14230
|
+
*
|
|
14231
|
+
* @param {String} viewId Journey View Id
|
|
14232
|
+
* @param {Object} body journeyViewSchedule
|
|
14233
|
+
*/},{key:"postJourneyViewSchedules",value:function postJourneyViewSchedules(viewId,body){// verify the required parameter 'viewId' is set
|
|
14234
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling postJourneyViewSchedules';}// verify the required parameter 'body' is set
|
|
14235
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','POST',{'viewId':viewId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14124
14236
|
* Submit a job request for a journey view version.
|
|
14125
14237
|
* used for long descriptions
|
|
14126
14238
|
* @param {String} viewId Journey View Id
|
|
@@ -14144,8 +14256,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14144
14256
|
* True indicates a valid encoding
|
|
14145
14257
|
* @param {Object} opts Optional parameters
|
|
14146
14258
|
* @param {Array.<Object>} opts.body
|
|
14147
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14148
14259
|
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14260
|
+
* Update the Schedule for a JourneyView
|
|
14261
|
+
* used for long descriptions
|
|
14262
|
+
* @param {String} viewId Journey View Id
|
|
14263
|
+
* @param {Object} body journeyViewSchedule
|
|
14264
|
+
*/},{key:"putJourneyViewSchedules",value:function putJourneyViewSchedules(viewId,body){// verify the required parameter 'viewId' is set
|
|
14265
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling putJourneyViewSchedules';}// verify the required parameter 'body' is set
|
|
14266
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','PUT',{'viewId':viewId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14149
14267
|
* Update a Journey View by ID and version
|
|
14150
14268
|
* does not create a new version
|
|
14151
14269
|
* @param {String} viewId viewId
|
|
@@ -14157,7 +14275,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
14157
14275
|
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(){/**
|
|
14158
14276
|
* Knowledge service.
|
|
14159
14277
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14160
|
-
* @version
|
|
14278
|
+
* @version 208.0.0
|
|
14161
14279
|
*//**
|
|
14162
14280
|
* Constructs a new KnowledgeApi.
|
|
14163
14281
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14248,7 +14366,6 @@ if(importId===undefined||importId===null){throw'Missing the required parameter "
|
|
|
14248
14366
|
*
|
|
14249
14367
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14250
14368
|
* @param {String} sourceId Source ID
|
|
14251
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14252
14369
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14253
14370
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14254
14371
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -14256,7 +14373,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14256
14373
|
*
|
|
14257
14374
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14258
14375
|
* @param {String} sourceId Source ID
|
|
14259
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14260
14376
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14261
14377
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14262
14378
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -14264,7 +14380,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14264
14380
|
*
|
|
14265
14381
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14266
14382
|
* @param {String} syncJobId Synchronization job ID
|
|
14267
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14268
14383
|
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14269
14384
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14270
14385
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'syncJobId':syncJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -14301,7 +14416,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
14301
14416
|
* Get sync options available for a knowledge-connect integration
|
|
14302
14417
|
*
|
|
14303
14418
|
* @param {String} integrationId Integration ID
|
|
14304
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14305
14419
|
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
14306
14420
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';}return this.apiClient.callApi('/api/v2/knowledge/integrations/{integrationId}/options','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14307
14421
|
* Get knowledge base
|
|
@@ -14376,10 +14490,11 @@ if(feedbackId===undefined||feedbackId===null){throw'Missing the required paramet
|
|
|
14376
14490
|
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
14377
14491
|
* @param {Object} opts Optional parameters
|
|
14378
14492
|
* @param {Object} opts.documentState The state of the document.
|
|
14493
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14379
14494
|
*/},{key:"getKnowledgeKnowledgebaseDocumentVariation",value:function getKnowledgeKnowledgebaseDocumentVariation(documentVariationId,documentId,knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'documentVariationId' is set
|
|
14380
14495
|
if(documentVariationId===undefined||documentVariationId===null){throw'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';}// verify the required parameter 'documentId' is set
|
|
14381
14496
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';}// verify the required parameter 'knowledgeBaseId' is set
|
|
14382
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}','GET',{'documentVariationId':documentVariationId,'documentId':documentId,'knowledgeBaseId':knowledgeBaseId},{'documentState':opts['documentState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14497
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}','GET',{'documentVariationId':documentVariationId,'documentId':documentId,'knowledgeBaseId':knowledgeBaseId},{'documentState':opts['documentState'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14383
14498
|
* Get variations for a document.
|
|
14384
14499
|
*
|
|
14385
14500
|
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
@@ -14389,9 +14504,10 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14389
14504
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14390
14505
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14391
14506
|
* @param {Object} opts.documentState The state of the document.
|
|
14507
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14392
14508
|
*/},{key:"getKnowledgeKnowledgebaseDocumentVariations",value:function getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId,documentId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14393
14509
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';}// verify the required parameter 'documentId' is set
|
|
14394
|
-
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations','GET',{'knowledgeBaseId':knowledgeBaseId,'documentId':documentId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'documentState':opts['documentState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14510
|
+
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations','GET',{'knowledgeBaseId':knowledgeBaseId,'documentId':documentId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'documentState':opts['documentState'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14395
14511
|
* Get document version.
|
|
14396
14512
|
*
|
|
14397
14513
|
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
@@ -14601,13 +14717,11 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
14601
14717
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
14602
14718
|
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
14603
14719
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
14604
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14605
14720
|
*/},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14606
14721
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'userId':this.apiClient.buildCollectionParam(opts['userId'],'multi'),'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'interval':opts['interval'],'sourceId':this.apiClient.buildCollectionParam(opts['sourceId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14607
14722
|
* Get ids of operation creator users and oauth clients
|
|
14608
14723
|
*
|
|
14609
14724
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14610
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14611
14725
|
*/},{key:"getKnowledgeKnowledgebaseOperationsUsersQuery",value:function getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14612
14726
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query','GET',{'knowledgeBaseId':knowledgeBaseId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14613
14727
|
* Get parse job report
|
|
@@ -14627,7 +14741,6 @@ if(parseJobId===undefined||parseJobId===null){throw'Missing the required paramet
|
|
|
14627
14741
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
14628
14742
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14629
14743
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
14630
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14631
14744
|
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14632
14745
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSources';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources','GET',{'knowledgeBaseId':knowledgeBaseId},{'type':opts['type'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14633
14746
|
* Get Salesforce Knowledge integration source
|
|
@@ -14636,7 +14749,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14636
14749
|
* @param {String} sourceId Source ID
|
|
14637
14750
|
* @param {Object} opts Optional parameters
|
|
14638
14751
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14639
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14640
14752
|
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14641
14753
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14642
14754
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}','GET',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -14646,7 +14758,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14646
14758
|
* @param {String} sourceId Source ID
|
|
14647
14759
|
* @param {Object} opts Optional parameters
|
|
14648
14760
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14649
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14650
14761
|
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14651
14762
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14652
14763
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','GET',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -14654,7 +14765,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14654
14765
|
*
|
|
14655
14766
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14656
14767
|
* @param {String} syncJobId Synchronization job ID
|
|
14657
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14658
14768
|
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14659
14769
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14660
14770
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'syncJobId':syncJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -14856,7 +14966,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14856
14966
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14857
14967
|
* @param {String} syncJobId Synchronization job ID
|
|
14858
14968
|
* @param {Object} body
|
|
14859
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14860
14969
|
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
14861
14970
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14862
14971
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
@@ -15170,7 +15279,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
15170
15279
|
*
|
|
15171
15280
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15172
15281
|
* @param {Object} body
|
|
15173
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15174
15282
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15175
15283
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
15176
15284
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15178,7 +15286,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15178
15286
|
*
|
|
15179
15287
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15180
15288
|
* @param {String} sourceId Source ID
|
|
15181
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15182
15289
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15183
15290
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15184
15291
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15186,7 +15293,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15186
15293
|
*
|
|
15187
15294
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15188
15295
|
* @param {Object} body
|
|
15189
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15190
15296
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15191
15297
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
15192
15298
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSourcesServicenow';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15194,7 +15300,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15194
15300
|
*
|
|
15195
15301
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15196
15302
|
* @param {String} sourceId Source ID
|
|
15197
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15198
15303
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15199
15304
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15200
15305
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15202,7 +15307,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15202
15307
|
*
|
|
15203
15308
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15204
15309
|
* @param {Object} body
|
|
15205
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15206
15310
|
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15207
15311
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
15208
15312
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15224,7 +15328,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15224
15328
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15225
15329
|
* @param {String} sourceId Source ID
|
|
15226
15330
|
* @param {Object} body
|
|
15227
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15228
15331
|
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15229
15332
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
15230
15333
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
@@ -15234,14 +15337,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15234
15337
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15235
15338
|
* @param {String} sourceId Source ID
|
|
15236
15339
|
* @param {Object} body
|
|
15237
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15238
15340
|
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15239
15341
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
15240
15342
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
15241
15343
|
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(){/**
|
|
15242
15344
|
* LanguageUnderstanding service.
|
|
15243
15345
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15244
|
-
* @version
|
|
15346
|
+
* @version 208.0.0
|
|
15245
15347
|
*//**
|
|
15246
15348
|
* Constructs a new LanguageUnderstandingApi.
|
|
15247
15349
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -15501,7 +15603,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
15501
15603
|
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(){/**
|
|
15502
15604
|
* Languages service.
|
|
15503
15605
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15504
|
-
* @version
|
|
15606
|
+
* @version 208.0.0
|
|
15505
15607
|
*//**
|
|
15506
15608
|
* Constructs a new LanguagesApi.
|
|
15507
15609
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15556,7 +15658,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15556
15658
|
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(){/**
|
|
15557
15659
|
* Learning service.
|
|
15558
15660
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15559
|
-
* @version
|
|
15661
|
+
* @version 208.0.0
|
|
15560
15662
|
*//**
|
|
15561
15663
|
* Constructs a new LearningApi.
|
|
15562
15664
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15827,7 +15929,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15827
15929
|
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(){/**
|
|
15828
15930
|
* License service.
|
|
15829
15931
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15830
|
-
* @version
|
|
15932
|
+
* @version 208.0.0
|
|
15831
15933
|
*//**
|
|
15832
15934
|
* Constructs a new LicenseApi.
|
|
15833
15935
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15881,7 +15983,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15881
15983
|
*/},{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(){/**
|
|
15882
15984
|
* Locations service.
|
|
15883
15985
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15884
|
-
* @version
|
|
15986
|
+
* @version 208.0.0
|
|
15885
15987
|
*//**
|
|
15886
15988
|
* Constructs a new LocationsApi.
|
|
15887
15989
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15940,7 +16042,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15940
16042
|
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(){/**
|
|
15941
16043
|
* LogCapture service.
|
|
15942
16044
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15943
|
-
* @version
|
|
16045
|
+
* @version 208.0.0
|
|
15944
16046
|
*//**
|
|
15945
16047
|
* Constructs a new LogCaptureApi.
|
|
15946
16048
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15990,7 +16092,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15990
16092
|
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(){/**
|
|
15991
16093
|
* Messaging service.
|
|
15992
16094
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15993
|
-
* @version
|
|
16095
|
+
* @version 208.0.0
|
|
15994
16096
|
*//**
|
|
15995
16097
|
* Constructs a new MessagingApi.
|
|
15996
16098
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16080,7 +16182,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16080
16182
|
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(){/**
|
|
16081
16183
|
* MobileDevices service.
|
|
16082
16184
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16083
|
-
* @version
|
|
16185
|
+
* @version 208.0.0
|
|
16084
16186
|
*//**
|
|
16085
16187
|
* Constructs a new MobileDevicesApi.
|
|
16086
16188
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16119,7 +16221,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16119
16221
|
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(){/**
|
|
16120
16222
|
* Notifications service.
|
|
16121
16223
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16122
|
-
* @version
|
|
16224
|
+
* @version 208.0.0
|
|
16123
16225
|
*//**
|
|
16124
16226
|
* Constructs a new NotificationsApi.
|
|
16125
16227
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16176,7 +16278,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16176
16278
|
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(){/**
|
|
16177
16279
|
* OAuth service.
|
|
16178
16280
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16179
|
-
* @version
|
|
16281
|
+
* @version 208.0.0
|
|
16180
16282
|
*//**
|
|
16181
16283
|
* Constructs a new OAuthApi.
|
|
16182
16284
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16261,7 +16363,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16261
16363
|
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(){/**
|
|
16262
16364
|
* Objects service.
|
|
16263
16365
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16264
|
-
* @version
|
|
16366
|
+
* @version 208.0.0
|
|
16265
16367
|
*//**
|
|
16266
16368
|
* Constructs a new ObjectsApi.
|
|
16267
16369
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16332,7 +16434,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
16332
16434
|
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(){/**
|
|
16333
16435
|
* OperationalEvents service.
|
|
16334
16436
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16335
|
-
* @version
|
|
16437
|
+
* @version 208.0.0
|
|
16336
16438
|
*//**
|
|
16337
16439
|
* Constructs a new OperationalEventsApi.
|
|
16338
16440
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16350,7 +16452,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
16350
16452
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
16351
16453
|
* Organization service.
|
|
16352
16454
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16353
|
-
* @version
|
|
16455
|
+
* @version 208.0.0
|
|
16354
16456
|
*//**
|
|
16355
16457
|
* Constructs a new OrganizationApi.
|
|
16356
16458
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -16475,7 +16577,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16475
16577
|
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(){/**
|
|
16476
16578
|
* OrganizationAuthorization service.
|
|
16477
16579
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
16478
|
-
* @version
|
|
16580
|
+
* @version 208.0.0
|
|
16479
16581
|
*//**
|
|
16480
16582
|
* Constructs a new OrganizationAuthorizationApi.
|
|
16481
16583
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16626,6 +16728,9 @@ if(trusteeOrgId===undefined||trusteeOrgId===null){throw'Missing the required par
|
|
|
16626
16728
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16627
16729
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16628
16730
|
*/},{key:"getOrgauthorizationTrustees",value:function getOrgauthorizationTrustees(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/orgauthorization/trustees','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16731
|
+
* Get Customer Care organization ids.
|
|
16732
|
+
*
|
|
16733
|
+
*/},{key:"getOrgauthorizationTrusteesCare",value:function getOrgauthorizationTrusteesCare(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16629
16734
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
16630
16735
|
*
|
|
16631
16736
|
*/},{key:"getOrgauthorizationTrusteesDefault",value:function getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16716,6 +16821,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16716
16821
|
* @param {String} opts.sortOrder Sort order (default to descending)
|
|
16717
16822
|
*/},{key:"postOrgauthorizationTrusteesAudits",value:function postOrgauthorizationTrusteesAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
16718
16823
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteesAudits';}return this.apiClient.callApi('/api/v2/orgauthorization/trustees/audits','POST',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16824
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
16825
|
+
*
|
|
16826
|
+
* @param {Object} opts Optional parameters
|
|
16827
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
16828
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
16829
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
16830
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
16831
|
+
*/},{key:"postOrgauthorizationTrusteesCare",value:function postOrgauthorizationTrusteesCare(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','POST',{},{'assignDefaultRole':opts['assignDefaultRole'],'autoExpire':opts['autoExpire'],'assignFullAccess':opts['assignFullAccess'],'allowTrustedUserAccess':opts['allowTrustedUserAccess']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16719
16832
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
16720
16833
|
*
|
|
16721
16834
|
* @param {Object} opts Optional parameters
|
|
@@ -16798,7 +16911,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16798
16911
|
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(){/**
|
|
16799
16912
|
* Outbound service.
|
|
16800
16913
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16801
|
-
* @version
|
|
16914
|
+
* @version 208.0.0
|
|
16802
16915
|
*//**
|
|
16803
16916
|
* Constructs a new OutboundApi.
|
|
16804
16917
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -17555,6 +17668,16 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
17555
17668
|
*/},{key:"postOutboundCampaignCallbackSchedule",value:function postOutboundCampaignCallbackSchedule(campaignId,body){// verify the required parameter 'campaignId' is set
|
|
17556
17669
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';}// verify the required parameter 'body' is set
|
|
17557
17670
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundCampaignCallbackSchedule';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/callback/schedule','POST',{'campaignId':campaignId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17671
|
+
* Start the campaign
|
|
17672
|
+
*
|
|
17673
|
+
* @param {String} campaignId Campaign ID
|
|
17674
|
+
*/},{key:"postOutboundCampaignStart",value:function postOutboundCampaignStart(campaignId){// verify the required parameter 'campaignId' is set
|
|
17675
|
+
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/start','POST',{'campaignId':campaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17676
|
+
* Stop the campaign
|
|
17677
|
+
*
|
|
17678
|
+
* @param {String} campaignId Campaign ID
|
|
17679
|
+
*/},{key:"postOutboundCampaignStop",value:function postOutboundCampaignStop(campaignId){// verify the required parameter 'campaignId' is set
|
|
17680
|
+
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/stop','POST',{'campaignId':campaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17558
17681
|
* Create Campaign Rule
|
|
17559
17682
|
*
|
|
17560
17683
|
* @param {Object} body CampaignRule
|
|
@@ -17707,6 +17830,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17707
17830
|
* @param {Array.<Object>} body import template(s) to add
|
|
17708
17831
|
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
17709
17832
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';}return this.apiClient.callApi('/api/v2/outbound/importtemplates/bulk/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17833
|
+
* Start the campaign
|
|
17834
|
+
* Documented permissions are applicable based on campaign type.
|
|
17835
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
17836
|
+
*/},{key:"postOutboundMessagingcampaignStart",value:function postOutboundMessagingcampaignStart(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
17837
|
+
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start','POST',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17838
|
+
* Stop the campaign
|
|
17839
|
+
* Documented permissions are applicable based on campaign type.
|
|
17840
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
17841
|
+
*/},{key:"postOutboundMessagingcampaignStop",value:function postOutboundMessagingcampaignStop(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
17842
|
+
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop','POST',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17710
17843
|
* Create a Messaging Campaign
|
|
17711
17844
|
*
|
|
17712
17845
|
* @param {Object} body Messaging Campaign
|
|
@@ -17885,7 +18018,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17885
18018
|
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(){/**
|
|
17886
18019
|
* Presence service.
|
|
17887
18020
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17888
|
-
* @version
|
|
18021
|
+
* @version 208.0.0
|
|
17889
18022
|
*//**
|
|
17890
18023
|
* Constructs a new PresenceApi.
|
|
17891
18024
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18058,7 +18191,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18058
18191
|
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(){/**
|
|
18059
18192
|
* ProcessAutomation service.
|
|
18060
18193
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18061
|
-
* @version
|
|
18194
|
+
* @version 208.0.0
|
|
18062
18195
|
*//**
|
|
18063
18196
|
* Constructs a new ProcessAutomationApi.
|
|
18064
18197
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18121,7 +18254,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18121
18254
|
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(){/**
|
|
18122
18255
|
* Quality service.
|
|
18123
18256
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18124
|
-
* @version
|
|
18257
|
+
* @version 208.0.0
|
|
18125
18258
|
*//**
|
|
18126
18259
|
* Constructs a new QualityApi.
|
|
18127
18260
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -18598,7 +18731,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
18598
18731
|
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(){/**
|
|
18599
18732
|
* Recording service.
|
|
18600
18733
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
18601
|
-
* @version
|
|
18734
|
+
* @version 208.0.0
|
|
18602
18735
|
*//**
|
|
18603
18736
|
* Constructs a new RecordingApi.
|
|
18604
18737
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -19010,7 +19143,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19010
19143
|
*/},{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(){/**
|
|
19011
19144
|
* ResponseManagement service.
|
|
19012
19145
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
19013
|
-
* @version
|
|
19146
|
+
* @version 208.0.0
|
|
19014
19147
|
*//**
|
|
19015
19148
|
* Constructs a new ResponseManagementApi.
|
|
19016
19149
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19131,7 +19264,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19131
19264
|
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(){/**
|
|
19132
19265
|
* Routing service.
|
|
19133
19266
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19134
|
-
* @version
|
|
19267
|
+
* @version 208.0.0
|
|
19135
19268
|
*//**
|
|
19136
19269
|
* Constructs a new RoutingApi.
|
|
19137
19270
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -19259,14 +19392,14 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
19259
19392
|
* @param {String} codeId Wrapup Code ID
|
|
19260
19393
|
*/},{key:"deleteRoutingWrapupcode",value:function deleteRoutingWrapupcode(codeId){// verify the required parameter 'codeId' is set
|
|
19261
19394
|
if(codeId===undefined||codeId===null){throw'Missing the required parameter "codeId" when calling deleteRoutingWrapupcode';}return this.apiClient.callApi('/api/v2/routing/wrapupcodes/{codeId}','DELETE',{'codeId':codeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19262
|
-
* Remove routing language from user
|
|
19395
|
+
* Remove a routing language from a user
|
|
19263
19396
|
*
|
|
19264
19397
|
* @param {String} userId User ID
|
|
19265
19398
|
* @param {String} languageId languageId
|
|
19266
19399
|
*/},{key:"deleteUserRoutinglanguage",value:function deleteUserRoutinglanguage(userId,languageId){// verify the required parameter 'userId' is set
|
|
19267
19400
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
19268
19401
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','DELETE',{'userId':userId,'languageId':languageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19269
|
-
* Remove routing skill from user
|
|
19402
|
+
* Remove a routing skill from a user
|
|
19270
19403
|
*
|
|
19271
19404
|
* @param {String} userId User ID
|
|
19272
19405
|
* @param {String} skillId skillId
|
|
@@ -19726,7 +19859,7 @@ if(codeId===undefined||codeId===null){throw'Missing the required parameter "code
|
|
|
19726
19859
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
19727
19860
|
*/},{key:"getUserQueues",value:function getUserQueues(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
19728
19861
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getUserQueues';}return this.apiClient.callApi('/api/v2/users/{userId}/queues','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'joined':opts['joined'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19729
|
-
* List routing
|
|
19862
|
+
* List routing languages assigned to a user
|
|
19730
19863
|
*
|
|
19731
19864
|
* @param {String} userId User ID
|
|
19732
19865
|
* @param {Object} opts Optional parameters
|
|
@@ -19735,7 +19868,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19735
19868
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
19736
19869
|
*/},{key:"getUserRoutinglanguages",value:function getUserRoutinglanguages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
19737
19870
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19738
|
-
* List routing skills
|
|
19871
|
+
* List routing skills assigned to a user
|
|
19739
19872
|
*
|
|
19740
19873
|
* @param {String} userId User ID
|
|
19741
19874
|
* @param {Object} opts Optional parameters
|
|
@@ -19850,7 +19983,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19850
19983
|
*/},{key:"patchUserQueues",value:function patchUserQueues(userId,body,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
19851
19984
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserQueues';}// verify the required parameter 'body' is set
|
|
19852
19985
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserQueues';}return this.apiClient.callApi('/api/v2/users/{userId}/queues','PATCH',{'userId':userId},{'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19853
|
-
* Update routing language proficiency
|
|
19986
|
+
* Update an assigned routing language's proficiency
|
|
19854
19987
|
*
|
|
19855
19988
|
* @param {String} userId User ID
|
|
19856
19989
|
* @param {String} languageId languageId
|
|
@@ -19859,14 +19992,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19859
19992
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
19860
19993
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';}// verify the required parameter 'body' is set
|
|
19861
19994
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','PATCH',{'userId':userId,'languageId':languageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19862
|
-
*
|
|
19995
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
19863
19996
|
*
|
|
19864
19997
|
* @param {String} userId User ID
|
|
19865
19998
|
* @param {Array.<Object>} body Language
|
|
19866
19999
|
*/},{key:"patchUserRoutinglanguagesBulk",value:function patchUserRoutinglanguagesBulk(userId,body){// verify the required parameter 'userId' is set
|
|
19867
20000
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';}// verify the required parameter 'body' is set
|
|
19868
20001
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/bulk','PATCH',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19869
|
-
*
|
|
20002
|
+
* Assign multiple routing skills to a user
|
|
19870
20003
|
*
|
|
19871
20004
|
* @param {String} userId User ID
|
|
19872
20005
|
* @param {Array.<Object>} body Skill
|
|
@@ -20020,14 +20153,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20020
20153
|
* @param {Object} body WrapupCode
|
|
20021
20154
|
*/},{key:"postRoutingWrapupcodes",value:function postRoutingWrapupcodes(body){// verify the required parameter 'body' is set
|
|
20022
20155
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingWrapupcodes';}return this.apiClient.callApi('/api/v2/routing/wrapupcodes','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20023
|
-
*
|
|
20156
|
+
* Assign a routing language to a user
|
|
20024
20157
|
*
|
|
20025
20158
|
* @param {String} userId User ID
|
|
20026
20159
|
* @param {Object} body Language
|
|
20027
20160
|
*/},{key:"postUserRoutinglanguages",value:function postUserRoutinglanguages(userId,body){// verify the required parameter 'userId' is set
|
|
20028
20161
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';}// verify the required parameter 'body' is set
|
|
20029
20162
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20030
|
-
*
|
|
20163
|
+
* Assign a routing skill to a user
|
|
20031
20164
|
*
|
|
20032
20165
|
* @param {String} userId User ID
|
|
20033
20166
|
* @param {Object} body Skill
|
|
@@ -20117,7 +20250,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20117
20250
|
*/},{key:"putRoutingWrapupcode",value:function putRoutingWrapupcode(codeId,body){// verify the required parameter 'codeId' is set
|
|
20118
20251
|
if(codeId===undefined||codeId===null){throw'Missing the required parameter "codeId" when calling putRoutingWrapupcode';}// verify the required parameter 'body' is set
|
|
20119
20252
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingWrapupcode';}return this.apiClient.callApi('/api/v2/routing/wrapupcodes/{codeId}','PUT',{'codeId':codeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20120
|
-
* Update routing skill proficiency
|
|
20253
|
+
* Update an assigned routing skill's proficiency
|
|
20121
20254
|
*
|
|
20122
20255
|
* @param {String} userId User ID
|
|
20123
20256
|
* @param {String} skillId skillId
|
|
@@ -20126,7 +20259,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20126
20259
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling putUserRoutingskill';}// verify the required parameter 'skillId' is set
|
|
20127
20260
|
if(skillId===undefined||skillId===null){throw'Missing the required parameter "skillId" when calling putUserRoutingskill';}// verify the required parameter 'body' is set
|
|
20128
20261
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskill';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/{skillId}','PUT',{'userId':userId,'skillId':skillId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20129
|
-
*
|
|
20262
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
20130
20263
|
*
|
|
20131
20264
|
* @param {String} userId User ID
|
|
20132
20265
|
* @param {Array.<Object>} body Skill
|
|
@@ -20135,7 +20268,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20135
20268
|
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(){/**
|
|
20136
20269
|
* SCIM service.
|
|
20137
20270
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
20138
|
-
* @version
|
|
20271
|
+
* @version 208.0.0
|
|
20139
20272
|
*//**
|
|
20140
20273
|
* Constructs a new SCIMApi.
|
|
20141
20274
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -20360,7 +20493,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20360
20493
|
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(){/**
|
|
20361
20494
|
* ScreenRecording service.
|
|
20362
20495
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
20363
|
-
* @version
|
|
20496
|
+
* @version 208.0.0
|
|
20364
20497
|
*//**
|
|
20365
20498
|
* Constructs a new ScreenRecordingApi.
|
|
20366
20499
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -20375,7 +20508,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20375
20508
|
*/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(){/**
|
|
20376
20509
|
* Scripts service.
|
|
20377
20510
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
20378
|
-
* @version
|
|
20511
|
+
* @version 208.0.0
|
|
20379
20512
|
*//**
|
|
20380
20513
|
* Constructs a new ScriptsApi.
|
|
20381
20514
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -20511,7 +20644,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
20511
20644
|
*/},{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(){/**
|
|
20512
20645
|
* Search service.
|
|
20513
20646
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
20514
|
-
* @version
|
|
20647
|
+
* @version 208.0.0
|
|
20515
20648
|
*//**
|
|
20516
20649
|
* Constructs a new SearchApi.
|
|
20517
20650
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -20559,6 +20692,13 @@ if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when
|
|
|
20559
20692
|
* @param {Boolean} opts.profile profile (default to true)
|
|
20560
20693
|
*/},{key:"getSearchSuggest",value:function getSearchSuggest(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
20561
20694
|
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'profile':opts['profile']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20695
|
+
* Search sites using the q64 value returned from a previous search
|
|
20696
|
+
*
|
|
20697
|
+
* @param {String} q64 q64
|
|
20698
|
+
* @param {Object} opts Optional parameters
|
|
20699
|
+
* @param {Array.<String>} opts.expand expand
|
|
20700
|
+
*/},{key:"getTelephonyProvidersEdgesSitesSearch",value:function getTelephonyProvidersEdgesSitesSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
20701
|
+
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20562
20702
|
* Search users using the q64 value returned from a previous search
|
|
20563
20703
|
*
|
|
20564
20704
|
* @param {String} q64 q64
|
|
@@ -20642,6 +20782,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20642
20782
|
* @param {Object} body Search request options
|
|
20643
20783
|
*/},{key:"postTeamsSearch",value:function postTeamsSearch(body){// verify the required parameter 'body' is set
|
|
20644
20784
|
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']);}/**
|
|
20785
|
+
* Search sites
|
|
20786
|
+
*
|
|
20787
|
+
* @param {Object} body Search request options
|
|
20788
|
+
*/},{key:"postTelephonyProvidersEdgesSitesSearch",value:function postTelephonyProvidersEdgesSitesSearch(body){// verify the required parameter 'body' is set
|
|
20789
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20645
20790
|
* Search users
|
|
20646
20791
|
*
|
|
20647
20792
|
* @param {Object} body Search request options
|
|
@@ -20671,7 +20816,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20671
20816
|
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(){/**
|
|
20672
20817
|
* Settings service.
|
|
20673
20818
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
20674
|
-
* @version
|
|
20819
|
+
* @version 208.0.0
|
|
20675
20820
|
*//**
|
|
20676
20821
|
* Constructs a new SettingsApi.
|
|
20677
20822
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -20721,7 +20866,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
20721
20866
|
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 SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
20722
20867
|
* SpeechTextAnalytics service.
|
|
20723
20868
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
20724
|
-
* @version
|
|
20869
|
+
* @version 208.0.0
|
|
20725
20870
|
*//**
|
|
20726
20871
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
20727
20872
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20906,13 +21051,13 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20906
21051
|
* @param {String} jobId The id of the publish topics job
|
|
20907
21052
|
*/},{key:"getSpeechandtextanalyticsTopicsPublishjob",value:function getSpeechandtextanalyticsTopicsPublishjob(jobId){// verify the required parameter 'jobId' is set
|
|
20908
21053
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsPublishjob';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20909
|
-
* Translate
|
|
21054
|
+
* Translate a single interaction recording (or an email conversation)
|
|
20910
21055
|
*
|
|
20911
21056
|
* @param {String} languageId Target translation language
|
|
20912
21057
|
* @param {String} conversationId Conversation id
|
|
20913
21058
|
* @param {Object} opts Optional parameters
|
|
20914
|
-
* @param {String} opts.communicationId Communication id associated with the conversation
|
|
20915
|
-
* @param {String} opts.recordingId Recording id associated with the communication
|
|
21059
|
+
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
21060
|
+
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
20916
21061
|
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20917
21062
|
*/},{key:"getSpeechandtextanalyticsTranslationsLanguageConversation",value:function getSpeechandtextanalyticsTranslationsLanguageConversation(languageId,conversationId,opts){opts=opts||{};// verify the required parameter 'languageId' is set
|
|
20918
21063
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling getSpeechandtextanalyticsTranslationsLanguageConversation';}// verify the required parameter 'conversationId' is set
|
|
@@ -21020,7 +21165,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21020
21165
|
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(){/**
|
|
21021
21166
|
* Stations service.
|
|
21022
21167
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
21023
|
-
* @version
|
|
21168
|
+
* @version 208.0.0
|
|
21024
21169
|
*//**
|
|
21025
21170
|
* Constructs a new StationsApi.
|
|
21026
21171
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -21052,7 +21197,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
21052
21197
|
*/},{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(){/**
|
|
21053
21198
|
* Suggest service.
|
|
21054
21199
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
21055
|
-
* @version
|
|
21200
|
+
* @version 208.0.0
|
|
21056
21201
|
*//**
|
|
21057
21202
|
* Constructs a new SuggestApi.
|
|
21058
21203
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -21092,7 +21237,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21092
21237
|
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(){/**
|
|
21093
21238
|
* TaskManagement service.
|
|
21094
21239
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
21095
|
-
* @version
|
|
21240
|
+
* @version 208.0.0
|
|
21096
21241
|
*//**
|
|
21097
21242
|
* Constructs a new TaskManagementApi.
|
|
21098
21243
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -21498,7 +21643,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21498
21643
|
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(){/**
|
|
21499
21644
|
* Teams service.
|
|
21500
21645
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
21501
|
-
* @version
|
|
21646
|
+
* @version 208.0.0
|
|
21502
21647
|
*//**
|
|
21503
21648
|
* Constructs a new TeamsApi.
|
|
21504
21649
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -21521,8 +21666,10 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
21521
21666
|
* Get team
|
|
21522
21667
|
*
|
|
21523
21668
|
* @param {String} teamId Team ID
|
|
21524
|
-
|
|
21525
|
-
|
|
21669
|
+
* @param {Object} opts Optional parameters
|
|
21670
|
+
* @param {Object} opts.expand Expand the division name
|
|
21671
|
+
*/},{key:"getTeam",value:function getTeam(teamId,opts){opts=opts||{};// verify the required parameter 'teamId' is set
|
|
21672
|
+
if(teamId===undefined||teamId===null){throw'Missing the required parameter "teamId" when calling getTeam';}return this.apiClient.callApi('/api/v2/teams/{teamId}','GET',{'teamId':teamId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21526
21673
|
* Get team membership
|
|
21527
21674
|
*
|
|
21528
21675
|
* @param {String} teamId Team ID
|
|
@@ -21576,7 +21723,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21576
21723
|
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(){/**
|
|
21577
21724
|
* Telephony service.
|
|
21578
21725
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
21579
|
-
* @version
|
|
21726
|
+
* @version 208.0.0
|
|
21580
21727
|
*//**
|
|
21581
21728
|
* Constructs a new TelephonyApi.
|
|
21582
21729
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -21623,7 +21770,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
21623
21770
|
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(){/**
|
|
21624
21771
|
* TelephonyProvidersEdge service.
|
|
21625
21772
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
21626
|
-
* @version
|
|
21773
|
+
* @version 208.0.0
|
|
21627
21774
|
*//**
|
|
21628
21775
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
21629
21776
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -22115,6 +22262,13 @@ if(siteId===undefined||siteId===null){throw'Missing the required parameter "site
|
|
|
22115
22262
|
* @param {Boolean} opts.managed Filter by managed
|
|
22116
22263
|
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
22117
22264
|
*/},{key:"getTelephonyProvidersEdgesSites",value:function getTelephonyProvidersEdgesSites(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'location.id':opts['locationId'],'managed':opts['managed'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22265
|
+
* Search sites using the q64 value returned from a previous search
|
|
22266
|
+
*
|
|
22267
|
+
* @param {String} q64 q64
|
|
22268
|
+
* @param {Object} opts Optional parameters
|
|
22269
|
+
* @param {Array.<String>} opts.expand expand
|
|
22270
|
+
*/},{key:"getTelephonyProvidersEdgesSitesSearch",value:function getTelephonyProvidersEdgesSitesSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
22271
|
+
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22118
22272
|
* Get a list of Edge-compatible time zones
|
|
22119
22273
|
*
|
|
22120
22274
|
* @param {Object} opts Optional parameters
|
|
@@ -22330,6 +22484,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22330
22484
|
* @param {Object} body Site
|
|
22331
22485
|
*/},{key:"postTelephonyProvidersEdgesSites",value:function postTelephonyProvidersEdgesSites(body){// verify the required parameter 'body' is set
|
|
22332
22486
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSites';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22487
|
+
* Search sites
|
|
22488
|
+
*
|
|
22489
|
+
* @param {Object} body Search request options
|
|
22490
|
+
*/},{key:"postTelephonyProvidersEdgesSitesSearch",value:function postTelephonyProvidersEdgesSitesSearch(body){// verify the required parameter 'body' is set
|
|
22491
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22333
22492
|
* Create a Trunk Base Settings object
|
|
22334
22493
|
*
|
|
22335
22494
|
* @param {Object} body Trunk base settings
|
|
@@ -22446,7 +22605,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
22446
22605
|
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(){/**
|
|
22447
22606
|
* Textbots service.
|
|
22448
22607
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
22449
|
-
* @version
|
|
22608
|
+
* @version 208.0.0
|
|
22450
22609
|
*//**
|
|
22451
22610
|
* Constructs a new TextbotsApi.
|
|
22452
22611
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -22481,7 +22640,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
22481
22640
|
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(){/**
|
|
22482
22641
|
* Tokens service.
|
|
22483
22642
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
22484
|
-
* @version
|
|
22643
|
+
* @version 208.0.0
|
|
22485
22644
|
*//**
|
|
22486
22645
|
* Constructs a new TokensApi.
|
|
22487
22646
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -22515,7 +22674,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22515
22674
|
*/},{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(){/**
|
|
22516
22675
|
* Uploads service.
|
|
22517
22676
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
22518
|
-
* @version
|
|
22677
|
+
* @version 208.0.0
|
|
22519
22678
|
*//**
|
|
22520
22679
|
* Constructs a new UploadsApi.
|
|
22521
22680
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -22581,7 +22740,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22581
22740
|
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(){/**
|
|
22582
22741
|
* Usage service.
|
|
22583
22742
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
22584
|
-
* @version
|
|
22743
|
+
* @version 208.0.0
|
|
22585
22744
|
*//**
|
|
22586
22745
|
* Constructs a new UsageApi.
|
|
22587
22746
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -22635,7 +22794,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22635
22794
|
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(){/**
|
|
22636
22795
|
* UserRecordings service.
|
|
22637
22796
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
22638
|
-
* @version
|
|
22797
|
+
* @version 208.0.0
|
|
22639
22798
|
*//**
|
|
22640
22799
|
* Constructs a new UserRecordingsApi.
|
|
22641
22800
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -22692,7 +22851,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
22692
22851
|
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(){/**
|
|
22693
22852
|
* Users service.
|
|
22694
22853
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
22695
|
-
* @version
|
|
22854
|
+
* @version 208.0.0
|
|
22696
22855
|
*//**
|
|
22697
22856
|
* Constructs a new UsersApi.
|
|
22698
22857
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -22732,14 +22891,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22732
22891
|
* @param {String} userId User ID
|
|
22733
22892
|
*/},{key:"deleteUser",value:function deleteUser(userId){// verify the required parameter 'userId' is set
|
|
22734
22893
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteUser';}return this.apiClient.callApi('/api/v2/users/{userId}','DELETE',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22735
|
-
* Remove routing language from user
|
|
22894
|
+
* Remove a routing language from a user
|
|
22736
22895
|
*
|
|
22737
22896
|
* @param {String} userId User ID
|
|
22738
22897
|
* @param {String} languageId languageId
|
|
22739
22898
|
*/},{key:"deleteUserRoutinglanguage",value:function deleteUserRoutinglanguage(userId,languageId){// verify the required parameter 'userId' is set
|
|
22740
22899
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
22741
22900
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','DELETE',{'userId':userId,'languageId':languageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22742
|
-
* Remove routing skill from user
|
|
22901
|
+
* Remove a routing skill from a user
|
|
22743
22902
|
*
|
|
22744
22903
|
* @param {String} userId User ID
|
|
22745
22904
|
* @param {String} skillId skillId
|
|
@@ -22943,7 +23102,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22943
23102
|
* @param {String} subjectId User ID
|
|
22944
23103
|
*/},{key:"getUserRoles",value:function getUserRoles(subjectId){// verify the required parameter 'subjectId' is set
|
|
22945
23104
|
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling getUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','GET',{'subjectId':subjectId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22946
|
-
* List routing
|
|
23105
|
+
* List routing languages assigned to a user
|
|
22947
23106
|
*
|
|
22948
23107
|
* @param {String} userId User ID
|
|
22949
23108
|
* @param {Object} opts Optional parameters
|
|
@@ -22952,7 +23111,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
22952
23111
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
22953
23112
|
*/},{key:"getUserRoutinglanguages",value:function getUserRoutinglanguages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
22954
23113
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22955
|
-
* List routing skills
|
|
23114
|
+
* List routing skills assigned to a user
|
|
22956
23115
|
*
|
|
22957
23116
|
* @param {String} userId User ID
|
|
22958
23117
|
* @param {Object} opts Optional parameters
|
|
@@ -23017,6 +23176,13 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23017
23176
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
23018
23177
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
23019
23178
|
*/},{key:"getUsers",value:function getUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/users','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'jabberId':this.apiClient.buildCollectionParam(opts['jabberId'],'multi'),'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'integrationPresenceSource':opts['integrationPresenceSource'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23179
|
+
* Get chats for a user
|
|
23180
|
+
*
|
|
23181
|
+
* @param {Object} opts Optional parameters
|
|
23182
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
23183
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
23184
|
+
* @param {String} opts.after The key to start after
|
|
23185
|
+
*/},{key:"getUsersChatsMe",value:function getUsersChatsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/users/chats/me','GET',{},{'excludeClosed':opts['excludeClosed'],'includePresence':opts['includePresence'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23020
23186
|
* Get list of Development Activities
|
|
23021
23187
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
23022
23188
|
* @param {Object} opts Optional parameters
|
|
@@ -23110,7 +23276,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23110
23276
|
*/},{key:"patchUserQueues",value:function patchUserQueues(userId,body,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
23111
23277
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserQueues';}// verify the required parameter 'body' is set
|
|
23112
23278
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserQueues';}return this.apiClient.callApi('/api/v2/users/{userId}/queues','PATCH',{'userId':userId},{'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23113
|
-
* Update routing language proficiency
|
|
23279
|
+
* Update an assigned routing language's proficiency
|
|
23114
23280
|
*
|
|
23115
23281
|
* @param {String} userId User ID
|
|
23116
23282
|
* @param {String} languageId languageId
|
|
@@ -23119,14 +23285,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23119
23285
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
23120
23286
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';}// verify the required parameter 'body' is set
|
|
23121
23287
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','PATCH',{'userId':userId,'languageId':languageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23122
|
-
*
|
|
23288
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
23123
23289
|
*
|
|
23124
23290
|
* @param {String} userId User ID
|
|
23125
23291
|
* @param {Array.<Object>} body Language
|
|
23126
23292
|
*/},{key:"patchUserRoutinglanguagesBulk",value:function patchUserRoutinglanguagesBulk(userId,body){// verify the required parameter 'userId' is set
|
|
23127
23293
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';}// verify the required parameter 'body' is set
|
|
23128
23294
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/bulk','PATCH',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23129
|
-
*
|
|
23295
|
+
* Assign multiple routing skills to a user
|
|
23130
23296
|
*
|
|
23131
23297
|
* @param {String} userId User ID
|
|
23132
23298
|
* @param {Array.<Object>} body Skill
|
|
@@ -23229,14 +23395,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23229
23395
|
*/},{key:"postUserPassword",value:function postUserPassword(userId,body){// verify the required parameter 'userId' is set
|
|
23230
23396
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postUserPassword';}// verify the required parameter 'body' is set
|
|
23231
23397
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUserPassword';}return this.apiClient.callApi('/api/v2/users/{userId}/password','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23232
|
-
*
|
|
23398
|
+
* Assign a routing language to a user
|
|
23233
23399
|
*
|
|
23234
23400
|
* @param {String} userId User ID
|
|
23235
23401
|
* @param {Object} body Language
|
|
23236
23402
|
*/},{key:"postUserRoutinglanguages",value:function postUserRoutinglanguages(userId,body){// verify the required parameter 'userId' is set
|
|
23237
23403
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';}// verify the required parameter 'body' is set
|
|
23238
23404
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23239
|
-
*
|
|
23405
|
+
* Assign a routing skill to a user
|
|
23240
23406
|
*
|
|
23241
23407
|
* @param {String} userId User ID
|
|
23242
23408
|
* @param {Object} body Skill
|
|
@@ -23327,7 +23493,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23327
23493
|
*/},{key:"putUserRoles",value:function putUserRoles(subjectId,body){// verify the required parameter 'subjectId' is set
|
|
23328
23494
|
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling putUserRoles';}// verify the required parameter 'body' is set
|
|
23329
23495
|
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']);}/**
|
|
23330
|
-
* Update routing skill proficiency
|
|
23496
|
+
* Update an assigned routing skill's proficiency
|
|
23331
23497
|
*
|
|
23332
23498
|
* @param {String} userId User ID
|
|
23333
23499
|
* @param {String} skillId skillId
|
|
@@ -23336,7 +23502,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23336
23502
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling putUserRoutingskill';}// verify the required parameter 'skillId' is set
|
|
23337
23503
|
if(skillId===undefined||skillId===null){throw'Missing the required parameter "skillId" when calling putUserRoutingskill';}// verify the required parameter 'body' is set
|
|
23338
23504
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskill';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/{skillId}','PUT',{'userId':userId,'skillId':skillId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23339
|
-
*
|
|
23505
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
23340
23506
|
*
|
|
23341
23507
|
* @param {String} userId User ID
|
|
23342
23508
|
* @param {Array.<Object>} body Skill
|
|
@@ -23382,7 +23548,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
23382
23548
|
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(){/**
|
|
23383
23549
|
* Utilities service.
|
|
23384
23550
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
23385
|
-
* @version
|
|
23551
|
+
* @version 208.0.0
|
|
23386
23552
|
*//**
|
|
23387
23553
|
* Constructs a new UtilitiesApi.
|
|
23388
23554
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -23409,7 +23575,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23409
23575
|
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(){/**
|
|
23410
23576
|
* Voicemail service.
|
|
23411
23577
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
23412
|
-
* @version
|
|
23578
|
+
* @version 208.0.0
|
|
23413
23579
|
*//**
|
|
23414
23580
|
* Constructs a new VoicemailApi.
|
|
23415
23581
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -23496,6 +23662,19 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
23496
23662
|
* @param {Array.<String>} opts.expand expand
|
|
23497
23663
|
*/},{key:"getVoicemailSearch",value:function getVoicemailSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
23498
23664
|
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23665
|
+
* Get a user's mailbox information
|
|
23666
|
+
*
|
|
23667
|
+
* @param {String} userId userId
|
|
23668
|
+
*/},{key:"getVoicemailUserMailbox",value:function getVoicemailUserMailbox(userId){// verify the required parameter 'userId' is set
|
|
23669
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getVoicemailUserMailbox';}return this.apiClient.callApi('/api/v2/voicemail/users/{userId}/mailbox','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23670
|
+
* List voicemail messages
|
|
23671
|
+
*
|
|
23672
|
+
* @param {String} userId User ID
|
|
23673
|
+
* @param {Object} opts Optional parameters
|
|
23674
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
23675
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
23676
|
+
*/},{key:"getVoicemailUserMessages",value:function getVoicemailUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
23677
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getVoicemailUserMessages';}return this.apiClient.callApi('/api/v2/voicemail/users/{userId}/messages','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23499
23678
|
* Get a user's voicemail policy
|
|
23500
23679
|
*
|
|
23501
23680
|
* @param {String} userId User ID
|
|
@@ -23558,7 +23737,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23558
23737
|
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(){/**
|
|
23559
23738
|
* WebChat service.
|
|
23560
23739
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
23561
|
-
* @version
|
|
23740
|
+
* @version 208.0.0
|
|
23562
23741
|
*//**
|
|
23563
23742
|
* Constructs a new WebChatApi.
|
|
23564
23743
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -23693,7 +23872,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23693
23872
|
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(){/**
|
|
23694
23873
|
* WebDeployments service.
|
|
23695
23874
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
23696
|
-
* @version
|
|
23875
|
+
* @version 208.0.0
|
|
23697
23876
|
*//**
|
|
23698
23877
|
* Constructs a new WebDeploymentsApi.
|
|
23699
23878
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -23814,7 +23993,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23814
23993
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
23815
23994
|
* WebMessaging service.
|
|
23816
23995
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
23817
|
-
* @version
|
|
23996
|
+
* @version 208.0.0
|
|
23818
23997
|
*//**
|
|
23819
23998
|
* Constructs a new WebMessagingApi.
|
|
23820
23999
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -23830,7 +24009,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
23830
24009
|
*/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(){/**
|
|
23831
24010
|
* Widgets service.
|
|
23832
24011
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
23833
|
-
* @version
|
|
24012
|
+
* @version 208.0.0
|
|
23834
24013
|
*//**
|
|
23835
24014
|
* Constructs a new WidgetsApi.
|
|
23836
24015
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -23865,7 +24044,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23865
24044
|
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(){/**
|
|
23866
24045
|
* WorkforceManagement service.
|
|
23867
24046
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
23868
|
-
* @version
|
|
24047
|
+
* @version 208.0.0
|
|
23869
24048
|
*//**
|
|
23870
24049
|
* Constructs a new WorkforceManagementApi.
|
|
23871
24050
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -25646,7 +25825,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
25646
25825
|
* </pre>
|
|
25647
25826
|
* </p>
|
|
25648
25827
|
* @module purecloud-platform-client-v2/index
|
|
25649
|
-
* @version
|
|
25828
|
+
* @version 208.0.0
|
|
25650
25829
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
25651
25830
|
* The ApiClient constructor.
|
|
25652
25831
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|