purecloud-platform-client-v2 206.0.0 → 207.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 +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.js +675 -129
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.js +236 -132
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +775 -270
- 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 +232 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -19
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -1
- 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
|
@@ -6157,18 +6157,30 @@ axios.Cancel=axios.CanceledError;// Expose all/spread
|
|
|
6157
6157
|
axios.all=function all(promises){return Promise.all(promises);};axios.spread=spread;// Expose isAxiosError
|
|
6158
6158
|
axios.isAxiosError=isAxiosError;// Expose mergeConfig
|
|
6159
6159
|
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:/**
|
|
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.gateway=undefined;this.logger=new Logger();this.setEnvironment();this.liveLoadConfig();}return _createClass(Configuration,[{key:"instance",get:/**
|
|
6161
6161
|
* Singleton getter
|
|
6162
6162
|
*/function get(){return Configuration.instance;}/**
|
|
6163
6163
|
* Singleton setter
|
|
6164
6164
|
*/,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();}
|
|
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;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
|
|
6166
|
+
this.logger.setLogger();}/**
|
|
6167
|
+
* @description Sets the gateway used by the session
|
|
6168
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
6169
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
6170
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
6171
|
+
* @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).
|
|
6172
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
6173
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
6174
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
6175
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
6176
|
+
*/},{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
|
|
6177
|
+
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
|
|
6178
|
+
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
6179
|
if(env)this.environment=env;else this.environment=this.host?this.host:'mypurecloud.com';// Strip trailing slash
|
|
6168
6180
|
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];}}}]);}();/**
|
|
6181
|
+
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
6182
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6171
|
-
* @version
|
|
6183
|
+
* @version 207.0.0
|
|
6172
6184
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6173
6185
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6174
6186
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6237,6 +6249,16 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
6237
6249
|
* @description Sets the environment used by the session
|
|
6238
6250
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
6239
6251
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
6252
|
+
* @description Sets the gateway used by the session
|
|
6253
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
6254
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
6255
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
6256
|
+
* @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).
|
|
6257
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
6258
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
6259
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
6260
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
6261
|
+
*/},{key:"setGateway",value:function setGateway(gateway){this.config.setGateway(gateway);}/**
|
|
6240
6262
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
6241
6263
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6242
6264
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
@@ -6252,35 +6274,35 @@ _this2._testTokenAccess().then(function(){if(!_this2.authData.state&&opts.state)
|
|
|
6252
6274
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
6253
6275
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6254
6276
|
* @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',"
|
|
6277
|
+
*/},{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
|
|
6278
|
+
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
|
|
6279
|
+
_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
6280
|
_this3.setAccessToken(response.data['access_token']);// Set expiry time
|
|
6259
6281
|
_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6260
6282
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
6261
|
-
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"
|
|
6283
|
+
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
6284
|
* @description Initiates the Saml2Bearerflow. Only available in node apps.
|
|
6263
6285
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6264
6286
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
6265
6287
|
* @param {string} orgName - The orgName of an OAuth Implicit Grant client
|
|
6266
6288
|
* @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
|
|
6289
|
+
*/},{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
6290
|
request.then(function(response){// Logging
|
|
6269
|
-
_this4.config.logger.log('trace',response.status,'POST',"
|
|
6291
|
+
_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
6292
|
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
6293
|
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
6272
|
-
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"
|
|
6294
|
+
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
6295
|
* @description Completes the PKCE Code Authorization.
|
|
6274
6296
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6275
6297
|
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
6276
6298
|
* @param {string} authCode - Authorization code
|
|
6277
6299
|
* @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:"
|
|
6300
|
+
*/},{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
6301
|
request.then(function(response){// Logging
|
|
6280
|
-
_this5.config.logger.log('trace',response.status,'POST',"
|
|
6302
|
+
_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
6303
|
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
6304
|
resolve(_this5.authData);})["catch"](function(error){// Log error
|
|
6283
|
-
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"
|
|
6305
|
+
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
6306
|
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
6285
6307
|
* @param {number} nChar - code length
|
|
6286
6308
|
*/},{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 +6368,15 @@ _this8._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/*
|
|
|
6346
6368
|
* @param {object} bodyParam - Input body data for authorization request
|
|
6347
6369
|
* @param {function} resolve - Promise resolve callback
|
|
6348
6370
|
* @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',"
|
|
6371
|
+
*/},{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
|
|
6372
|
+
_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
6373
|
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
6374
|
resolve(_this9.authData);})["catch"](function(error){// Log error
|
|
6353
|
-
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"
|
|
6375
|
+
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
6376
|
* @description Utility function to create the request for auth requests
|
|
6355
6377
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
6356
6378
|
* @param {object} data - data to url form encode
|
|
6357
|
-
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"
|
|
6379
|
+
*/},{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
6380
|
* @description Handles an expired access token. Only available in node apps.
|
|
6359
6381
|
* @param {string} statusCode - The status code of a request
|
|
6360
6382
|
*/},{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 +6415,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6393
6415
|
* @description Constructs a URL to the auth server
|
|
6394
6416
|
* @param {string} path - The path for the URL
|
|
6395
6417
|
* @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(
|
|
6418
|
+
*/},{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
6419
|
* Returns a string representation for an actual parameter.
|
|
6398
6420
|
* @param param The actual parameter.
|
|
6399
6421
|
* @returns {String} The string representation of <code>param</code>.
|
|
@@ -6412,7 +6434,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6412
6434
|
* @param {String} path The path to append to the base URL.
|
|
6413
6435
|
* @param {Object} pathParams The parameter values to append.
|
|
6414
6436
|
* @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;}/**
|
|
6437
|
+
*/},{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
6438
|
* Checks whether the given content type represents JSON.<br>
|
|
6417
6439
|
* JSON content type examples:<br>
|
|
6418
6440
|
* <ul>
|
|
@@ -6480,7 +6502,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6480
6502
|
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
6503
|
* AgentAssistants service.
|
|
6482
6504
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6483
|
-
* @version
|
|
6505
|
+
* @version 207.0.0
|
|
6484
6506
|
*//**
|
|
6485
6507
|
* Constructs a new AgentAssistantsApi.
|
|
6486
6508
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6581,7 +6603,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6581
6603
|
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
6604
|
* AgentCopilot service.
|
|
6583
6605
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6584
|
-
* @version
|
|
6606
|
+
* @version 207.0.0
|
|
6585
6607
|
*//**
|
|
6586
6608
|
* Constructs a new AgentCopilotApi.
|
|
6587
6609
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6603,7 +6625,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6603
6625
|
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
6626
|
* AgentUI service.
|
|
6605
6627
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6606
|
-
* @version
|
|
6628
|
+
* @version 207.0.0
|
|
6607
6629
|
*//**
|
|
6608
6630
|
* Constructs a new AgentUIApi.
|
|
6609
6631
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6637,7 +6659,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6637
6659
|
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
6660
|
* Alerting service.
|
|
6639
6661
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6640
|
-
* @version
|
|
6662
|
+
* @version 207.0.0
|
|
6641
6663
|
*//**
|
|
6642
6664
|
* Constructs a new AlertingApi.
|
|
6643
6665
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6794,7 +6816,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6794
6816
|
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
6817
|
* Analytics service.
|
|
6796
6818
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6797
|
-
* @version
|
|
6819
|
+
* @version 207.0.0
|
|
6798
6820
|
*//**
|
|
6799
6821
|
* Constructs a new AnalyticsApi.
|
|
6800
6822
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7018,7 +7040,8 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7018
7040
|
* @param {Number} opts.pageSize (default to 25)
|
|
7019
7041
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
7020
7042
|
* @param {Object} opts.state Only list users of this state
|
|
7021
|
-
|
|
7043
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
7044
|
+
*/},{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
7045
|
* Get all view export requests for a user
|
|
7023
7046
|
*
|
|
7024
7047
|
* @param {Object} opts Optional parameters
|
|
@@ -7052,9 +7075,10 @@ if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missin
|
|
|
7052
7075
|
* @param {Number} opts.pageSize (default to 50)
|
|
7053
7076
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
7054
7077
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
7078
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
7055
7079
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
7056
7080
|
*/},{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']);}/**
|
|
7081
|
+
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
7082
|
* Get status for async query for resolution aggregates
|
|
7059
7083
|
*
|
|
7060
7084
|
* @param {String} jobId jobId
|
|
@@ -7298,7 +7322,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7298
7322
|
* @param {Object} body query
|
|
7299
7323
|
*/},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7300
7324
|
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)
|
|
7325
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
7302
7326
|
*
|
|
7303
7327
|
* @param {Array.<String>} body List of userIds
|
|
7304
7328
|
*/},{key:"postAnalyticsReportingDashboardsUsersBulkRemove",value:function postAnalyticsReportingDashboardsUsersBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -7308,7 +7332,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7308
7332
|
* @param {Object} body ReportingExportJobRequest
|
|
7309
7333
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
7310
7334
|
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
|
|
7335
|
+
* Bulk soft delete dashboard configurations
|
|
7312
7336
|
*
|
|
7313
7337
|
* @param {Object} body
|
|
7314
7338
|
*/},{key:"postAnalyticsReportingSettingsDashboardsBulkRemove",value:function postAnalyticsReportingSettingsDashboardsBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -7352,7 +7376,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7352
7376
|
* Query for task management aggregates
|
|
7353
7377
|
*
|
|
7354
7378
|
* @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
7379
|
*/},{key:"postAnalyticsTaskmanagementAggregatesQuery",value:function postAnalyticsTaskmanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7357
7380
|
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
7381
|
* Query for team activity observations
|
|
@@ -7415,7 +7438,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7415
7438
|
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
7439
|
* Architect service.
|
|
7417
7440
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7418
|
-
* @version
|
|
7441
|
+
* @version 207.0.0
|
|
7419
7442
|
*//**
|
|
7420
7443
|
* Constructs a new ArchitectApi.
|
|
7421
7444
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -7905,7 +7928,7 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
7905
7928
|
*/},{key:"getFlowVersion",value:function getFlowVersion(flowId,versionId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
7906
7929
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowVersion';}// verify the required parameter 'versionId' is set
|
|
7907
7930
|
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
|
-
*
|
|
7931
|
+
* Get flow version configuration
|
|
7909
7932
|
*
|
|
7910
7933
|
* @param {String} flowId Flow ID
|
|
7911
7934
|
* @param {String} versionId Version ID
|
|
@@ -8507,7 +8530,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8507
8530
|
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
8531
|
* Audit service.
|
|
8509
8532
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8510
|
-
* @version
|
|
8533
|
+
* @version 207.0.0
|
|
8511
8534
|
*//**
|
|
8512
8535
|
* Constructs a new AuditApi.
|
|
8513
8536
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8557,7 +8580,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8557
8580
|
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
8581
|
* Authorization service.
|
|
8559
8582
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8560
|
-
* @version
|
|
8583
|
+
* @version 207.0.0
|
|
8561
8584
|
*//**
|
|
8562
8585
|
* Constructs a new AuthorizationApi.
|
|
8563
8586
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8880,7 +8903,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8880
8903
|
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
8904
|
* Billing service.
|
|
8882
8905
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8883
|
-
* @version
|
|
8906
|
+
* @version 207.0.0
|
|
8884
8907
|
*//**
|
|
8885
8908
|
* Constructs a new BillingApi.
|
|
8886
8909
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8904,7 +8927,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8904
8927
|
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
8928
|
* CarrierServices service.
|
|
8906
8929
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8907
|
-
* @version
|
|
8930
|
+
* @version 207.0.0
|
|
8908
8931
|
*//**
|
|
8909
8932
|
* Constructs a new CarrierServicesApi.
|
|
8910
8933
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8924,7 +8947,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8924
8947
|
*/},{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
8948
|
* Chat service.
|
|
8926
8949
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8927
|
-
* @version
|
|
8950
|
+
* @version 207.0.0
|
|
8928
8951
|
*//**
|
|
8929
8952
|
* Constructs a new ChatApi.
|
|
8930
8953
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9149,7 +9172,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9149
9172
|
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
9173
|
* Coaching service.
|
|
9151
9174
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9152
|
-
* @version
|
|
9175
|
+
* @version 207.0.0
|
|
9153
9176
|
*//**
|
|
9154
9177
|
* Constructs a new CoachingApi.
|
|
9155
9178
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9302,7 +9325,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9302
9325
|
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
9326
|
* ContentManagement service.
|
|
9304
9327
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9305
|
-
* @version
|
|
9328
|
+
* @version 207.0.0
|
|
9306
9329
|
*//**
|
|
9307
9330
|
* Constructs a new ContentManagementApi.
|
|
9308
9331
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9406,12 +9429,11 @@ if(shareId===undefined||shareId===null){throw'Missing the required parameter "sh
|
|
|
9406
9429
|
* 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
9430
|
* @param {String} sharedId Shared ID
|
|
9408
9431
|
* @param {Object} opts Optional parameters
|
|
9409
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
9410
9432
|
* @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
9433
|
* @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
9434
|
* @param {Object} opts.expand Expand some document fields
|
|
9413
9435
|
*/},{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},{'
|
|
9436
|
+
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
9437
|
* Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
9416
9438
|
* Failing to specify a filter will return 400.
|
|
9417
9439
|
* @param {Object} opts Optional parameters
|
|
@@ -9585,7 +9607,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9585
9607
|
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
9608
|
* Conversations service.
|
|
9587
9609
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9588
|
-
* @version
|
|
9610
|
+
* @version 207.0.0
|
|
9589
9611
|
*//**
|
|
9590
9612
|
* Constructs a new ConversationsApi.
|
|
9591
9613
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10724,9 +10746,10 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10724
10746
|
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'body' is set
|
|
10725
10747
|
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
10748
|
* Suggestion feedback.
|
|
10727
|
-
*
|
|
10749
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
10728
10750
|
* @param {String} conversationId Conversation ID
|
|
10729
10751
|
* @param {Object} body SuggestionFeedback
|
|
10752
|
+
* @deprecated
|
|
10730
10753
|
*/},{key:"postConversationSuggestionsFeedback",value:function postConversationSuggestionsFeedback(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
10731
10754
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';}// verify the required parameter 'body' is set
|
|
10732
10755
|
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 +11336,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11313
11336
|
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
11337
|
* DataExtensions service.
|
|
11315
11338
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11316
|
-
* @version
|
|
11339
|
+
* @version 207.0.0
|
|
11317
11340
|
*//**
|
|
11318
11341
|
* Constructs a new DataExtensionsApi.
|
|
11319
11342
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11334,7 +11357,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11334
11357
|
*/},{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
11358
|
* Downloads service.
|
|
11336
11359
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11337
|
-
* @version
|
|
11360
|
+
* @version 207.0.0
|
|
11338
11361
|
*//**
|
|
11339
11362
|
* Constructs a new DownloadsApi.
|
|
11340
11363
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11353,7 +11376,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11353
11376
|
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
11377
|
* Emails service.
|
|
11355
11378
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11356
|
-
* @version
|
|
11379
|
+
* @version 207.0.0
|
|
11357
11380
|
*//**
|
|
11358
11381
|
* Constructs a new EmailsApi.
|
|
11359
11382
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11371,7 +11394,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11371
11394
|
*/},{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
11395
|
* EmployeeEngagement service.
|
|
11373
11396
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11374
|
-
* @version
|
|
11397
|
+
* @version 207.0.0
|
|
11375
11398
|
*//**
|
|
11376
11399
|
* Constructs a new EmployeeEngagementApi.
|
|
11377
11400
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11409,7 +11432,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11409
11432
|
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
11433
|
* Events service.
|
|
11411
11434
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11412
|
-
* @version
|
|
11435
|
+
* @version 207.0.0
|
|
11413
11436
|
*//**
|
|
11414
11437
|
* Constructs a new EventsApi.
|
|
11415
11438
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11434,7 +11457,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11434
11457
|
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
11458
|
* ExternalContacts service.
|
|
11436
11459
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11437
|
-
* @version
|
|
11460
|
+
* @version 207.0.0
|
|
11438
11461
|
*//**
|
|
11439
11462
|
* Constructs a new ExternalContactsApi.
|
|
11440
11463
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11465,6 +11488,11 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
11465
11488
|
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11466
11489
|
*/},{key:"deleteExternalcontactsExternalsource",value:function deleteExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
11467
11490
|
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']);}/**
|
|
11491
|
+
* Delete settings for CSV import
|
|
11492
|
+
*
|
|
11493
|
+
* @param {String} settingsId Settings id
|
|
11494
|
+
*/},{key:"deleteExternalcontactsImportCsvSetting",value:function deleteExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
11495
|
+
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
11496
|
* Delete an external organization
|
|
11469
11497
|
*
|
|
11470
11498
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11578,6 +11606,28 @@ if(externalSourceId===undefined||externalSourceId===null){throw'Missing the requ
|
|
|
11578
11606
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
11579
11607
|
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11580
11608
|
*/},{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']);}/**
|
|
11609
|
+
* Get settings for CSV import
|
|
11610
|
+
*
|
|
11611
|
+
* @param {String} settingsId Settings id
|
|
11612
|
+
*/},{key:"getExternalcontactsImportCsvSetting",value:function getExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
11613
|
+
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']);}/**
|
|
11614
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
11615
|
+
*
|
|
11616
|
+
* @param {Object} opts Optional parameters
|
|
11617
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11618
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11619
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
11620
|
+
*/},{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']);}/**
|
|
11621
|
+
* Get details for CSV upload
|
|
11622
|
+
*
|
|
11623
|
+
* @param {String} uploadId Upload id
|
|
11624
|
+
*/},{key:"getExternalcontactsImportCsvUploadDetails",value:function getExternalcontactsImportCsvUploadDetails(uploadId){// verify the required parameter 'uploadId' is set
|
|
11625
|
+
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']);}/**
|
|
11626
|
+
* Get preview for CSV upload
|
|
11627
|
+
*
|
|
11628
|
+
* @param {String} uploadId Upload id
|
|
11629
|
+
*/},{key:"getExternalcontactsImportCsvUploadPreview",value:function getExternalcontactsImportCsvUploadPreview(uploadId){// verify the required parameter 'uploadId' is set
|
|
11630
|
+
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
11631
|
* Fetch an external organization
|
|
11582
11632
|
*
|
|
11583
11633
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11822,6 +11872,21 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11822
11872
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
11823
11873
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
11824
11874
|
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']);}/**
|
|
11875
|
+
* Create CSV import job
|
|
11876
|
+
*
|
|
11877
|
+
* @param {Object} body ImportRequest
|
|
11878
|
+
*/},{key:"postExternalcontactsImportCsvJobs",value:function postExternalcontactsImportCsvJobs(body){// verify the required parameter 'body' is set
|
|
11879
|
+
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']);}/**
|
|
11880
|
+
* Create settings for CSV import
|
|
11881
|
+
*
|
|
11882
|
+
* @param {Object} body Settings
|
|
11883
|
+
*/},{key:"postExternalcontactsImportCsvSettings",value:function postExternalcontactsImportCsvSettings(body){// verify the required parameter 'body' is set
|
|
11884
|
+
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']);}/**
|
|
11885
|
+
* Get url for CSV upload
|
|
11886
|
+
*
|
|
11887
|
+
* @param {Object} body UploadRequest
|
|
11888
|
+
*/},{key:"postExternalcontactsImportCsvUploads",value:function postExternalcontactsImportCsvUploads(body){// verify the required parameter 'body' is set
|
|
11889
|
+
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
11890
|
* Merge two contacts into a new contact record
|
|
11826
11891
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
11827
11892
|
* @param {Object} body MergeRequest
|
|
@@ -11887,6 +11952,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11887
11952
|
*/},{key:"putExternalcontactsExternalsource",value:function putExternalcontactsExternalsource(externalSourceId,body){// verify the required parameter 'externalSourceId' is set
|
|
11888
11953
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';}// verify the required parameter 'body' is set
|
|
11889
11954
|
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']);}/**
|
|
11955
|
+
* Update settings for CSV import
|
|
11956
|
+
*
|
|
11957
|
+
* @param {String} settingsId Settings id
|
|
11958
|
+
* @param {Object} body Settings
|
|
11959
|
+
*/},{key:"putExternalcontactsImportCsvSetting",value:function putExternalcontactsImportCsvSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
11960
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';}// verify the required parameter 'body' is set
|
|
11961
|
+
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
11962
|
* Update an external organization
|
|
11891
11963
|
*
|
|
11892
11964
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11926,7 +11998,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11926
11998
|
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
11999
|
* Fax service.
|
|
11928
12000
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11929
|
-
* @version
|
|
12001
|
+
* @version 207.0.0
|
|
11930
12002
|
*//**
|
|
11931
12003
|
* Constructs a new FaxApi.
|
|
11932
12004
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11975,7 +12047,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11975
12047
|
*/},{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
12048
|
* Flows service.
|
|
11977
12049
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11978
|
-
* @version
|
|
12050
|
+
* @version 207.0.0
|
|
11979
12051
|
*//**
|
|
11980
12052
|
* Constructs a new FlowsApi.
|
|
11981
12053
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12023,7 +12095,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12023
12095
|
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
12096
|
* Gamification service.
|
|
12025
12097
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12026
|
-
* @version
|
|
12098
|
+
* @version 207.0.0
|
|
12027
12099
|
*//**
|
|
12028
12100
|
* Constructs a new GamificationApi.
|
|
12029
12101
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12563,7 +12635,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12563
12635
|
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
12636
|
* GeneralDataProtectionRegulation service.
|
|
12565
12637
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12566
|
-
* @version
|
|
12638
|
+
* @version 207.0.0
|
|
12567
12639
|
*//**
|
|
12568
12640
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12569
12641
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12598,7 +12670,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12598
12670
|
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
12671
|
* Geolocation service.
|
|
12600
12672
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12601
|
-
* @version
|
|
12673
|
+
* @version 207.0.0
|
|
12602
12674
|
*//**
|
|
12603
12675
|
* Constructs a new GeolocationApi.
|
|
12604
12676
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12632,7 +12704,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12632
12704
|
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
12705
|
* Greetings service.
|
|
12634
12706
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12635
|
-
* @version
|
|
12707
|
+
* @version 207.0.0
|
|
12636
12708
|
*//**
|
|
12637
12709
|
* Constructs a new GreetingsApi.
|
|
12638
12710
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12739,7 +12811,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12739
12811
|
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
12812
|
* Groups service.
|
|
12741
12813
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12742
|
-
* @version
|
|
12814
|
+
* @version 207.0.0
|
|
12743
12815
|
*//**
|
|
12744
12816
|
* Constructs a new GroupsApi.
|
|
12745
12817
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12872,7 +12944,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12872
12944
|
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
12945
|
* IdentityProvider service.
|
|
12874
12946
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12875
|
-
* @version
|
|
12947
|
+
* @version 207.0.0
|
|
12876
12948
|
*//**
|
|
12877
12949
|
* Constructs a new IdentityProviderApi.
|
|
12878
12950
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13028,7 +13100,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13028
13100
|
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
13101
|
* InfrastructureAsCode service.
|
|
13030
13102
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13031
|
-
* @version
|
|
13103
|
+
* @version 207.0.0
|
|
13032
13104
|
*//**
|
|
13033
13105
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13034
13106
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13082,7 +13154,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13082
13154
|
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
13155
|
* Integrations service.
|
|
13084
13156
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13085
|
-
* @version
|
|
13157
|
+
* @version 207.0.0
|
|
13086
13158
|
*//**
|
|
13087
13159
|
* Constructs a new IntegrationsApi.
|
|
13088
13160
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13707,7 +13779,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13707
13779
|
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
13780
|
* Journey service.
|
|
13709
13781
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13710
|
-
* @version
|
|
13782
|
+
* @version 207.0.0
|
|
13711
13783
|
*//**
|
|
13712
13784
|
* Constructs a new JourneyApi.
|
|
13713
13785
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13987,12 +14059,10 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
13987
14059
|
* Get an Event Definition
|
|
13988
14060
|
*
|
|
13989
14061
|
* @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
14062
|
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
13992
14063
|
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
14064
|
* Get a list of Event Definitions
|
|
13994
14065
|
*
|
|
13995
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13996
14066
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13997
14067
|
* Get the jobs for an organization.
|
|
13998
14068
|
*
|
|
@@ -14144,7 +14214,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14144
14214
|
* True indicates a valid encoding
|
|
14145
14215
|
* @param {Object} opts Optional parameters
|
|
14146
14216
|
* @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
14217
|
*/},{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']);}/**
|
|
14149
14218
|
* Update a Journey View by ID and version
|
|
14150
14219
|
* does not create a new version
|
|
@@ -14157,7 +14226,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
14157
14226
|
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
14227
|
* Knowledge service.
|
|
14159
14228
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14160
|
-
* @version
|
|
14229
|
+
* @version 207.0.0
|
|
14161
14230
|
*//**
|
|
14162
14231
|
* Constructs a new KnowledgeApi.
|
|
14163
14232
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14248,7 +14317,6 @@ if(importId===undefined||importId===null){throw'Missing the required parameter "
|
|
|
14248
14317
|
*
|
|
14249
14318
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14250
14319
|
* @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
14320
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14253
14321
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14254
14322
|
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 +14324,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14256
14324
|
*
|
|
14257
14325
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14258
14326
|
* @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
14327
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14261
14328
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14262
14329
|
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 +14331,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14264
14331
|
*
|
|
14265
14332
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14266
14333
|
* @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
14334
|
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14269
14335
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14270
14336
|
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 +14367,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
14301
14367
|
* Get sync options available for a knowledge-connect integration
|
|
14302
14368
|
*
|
|
14303
14369
|
* @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
14370
|
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
14306
14371
|
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
14372
|
* Get knowledge base
|
|
@@ -14601,13 +14666,11 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
14601
14666
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
14602
14667
|
* @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
14668
|
* @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
14669
|
*/},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14606
14670
|
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
14671
|
* Get ids of operation creator users and oauth clients
|
|
14608
14672
|
*
|
|
14609
14673
|
* @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
14674
|
*/},{key:"getKnowledgeKnowledgebaseOperationsUsersQuery",value:function getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14612
14675
|
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
14676
|
* Get parse job report
|
|
@@ -14627,7 +14690,6 @@ if(parseJobId===undefined||parseJobId===null){throw'Missing the required paramet
|
|
|
14627
14690
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
14628
14691
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14629
14692
|
* @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
14693
|
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14632
14694
|
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
14695
|
* Get Salesforce Knowledge integration source
|
|
@@ -14636,7 +14698,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14636
14698
|
* @param {String} sourceId Source ID
|
|
14637
14699
|
* @param {Object} opts Optional parameters
|
|
14638
14700
|
* @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
14701
|
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14641
14702
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14642
14703
|
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 +14707,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14646
14707
|
* @param {String} sourceId Source ID
|
|
14647
14708
|
* @param {Object} opts Optional parameters
|
|
14648
14709
|
* @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
14710
|
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14651
14711
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14652
14712
|
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 +14714,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14654
14714
|
*
|
|
14655
14715
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14656
14716
|
* @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
14717
|
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14659
14718
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14660
14719
|
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 +14915,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14856
14915
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14857
14916
|
* @param {String} syncJobId Synchronization job ID
|
|
14858
14917
|
* @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
14918
|
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
14861
14919
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14862
14920
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
@@ -15170,7 +15228,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
15170
15228
|
*
|
|
15171
15229
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15172
15230
|
* @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
15231
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15175
15232
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
15176
15233
|
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 +15235,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15178
15235
|
*
|
|
15179
15236
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15180
15237
|
* @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
15238
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15183
15239
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15184
15240
|
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 +15242,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15186
15242
|
*
|
|
15187
15243
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15188
15244
|
* @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
15245
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15191
15246
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
15192
15247
|
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 +15249,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15194
15249
|
*
|
|
15195
15250
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15196
15251
|
* @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
15252
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15199
15253
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15200
15254
|
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 +15256,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15202
15256
|
*
|
|
15203
15257
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15204
15258
|
* @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
15259
|
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15207
15260
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
15208
15261
|
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 +15277,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15224
15277
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15225
15278
|
* @param {String} sourceId Source ID
|
|
15226
15279
|
* @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
15280
|
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15229
15281
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
15230
15282
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
@@ -15234,14 +15286,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15234
15286
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15235
15287
|
* @param {String} sourceId Source ID
|
|
15236
15288
|
* @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
15289
|
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15239
15290
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
15240
15291
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
15241
15292
|
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
15293
|
* LanguageUnderstanding service.
|
|
15243
15294
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15244
|
-
* @version
|
|
15295
|
+
* @version 207.0.0
|
|
15245
15296
|
*//**
|
|
15246
15297
|
* Constructs a new LanguageUnderstandingApi.
|
|
15247
15298
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -15501,7 +15552,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
15501
15552
|
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
15553
|
* Languages service.
|
|
15503
15554
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15504
|
-
* @version
|
|
15555
|
+
* @version 207.0.0
|
|
15505
15556
|
*//**
|
|
15506
15557
|
* Constructs a new LanguagesApi.
|
|
15507
15558
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15556,7 +15607,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15556
15607
|
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
15608
|
* Learning service.
|
|
15558
15609
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15559
|
-
* @version
|
|
15610
|
+
* @version 207.0.0
|
|
15560
15611
|
*//**
|
|
15561
15612
|
* Constructs a new LearningApi.
|
|
15562
15613
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15827,7 +15878,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15827
15878
|
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
15879
|
* License service.
|
|
15829
15880
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15830
|
-
* @version
|
|
15881
|
+
* @version 207.0.0
|
|
15831
15882
|
*//**
|
|
15832
15883
|
* Constructs a new LicenseApi.
|
|
15833
15884
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15881,7 +15932,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15881
15932
|
*/},{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
15933
|
* Locations service.
|
|
15883
15934
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15884
|
-
* @version
|
|
15935
|
+
* @version 207.0.0
|
|
15885
15936
|
*//**
|
|
15886
15937
|
* Constructs a new LocationsApi.
|
|
15887
15938
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15940,7 +15991,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15940
15991
|
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
15992
|
* LogCapture service.
|
|
15942
15993
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15943
|
-
* @version
|
|
15994
|
+
* @version 207.0.0
|
|
15944
15995
|
*//**
|
|
15945
15996
|
* Constructs a new LogCaptureApi.
|
|
15946
15997
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15990,7 +16041,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15990
16041
|
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
16042
|
* Messaging service.
|
|
15992
16043
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15993
|
-
* @version
|
|
16044
|
+
* @version 207.0.0
|
|
15994
16045
|
*//**
|
|
15995
16046
|
* Constructs a new MessagingApi.
|
|
15996
16047
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16080,7 +16131,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16080
16131
|
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
16132
|
* MobileDevices service.
|
|
16082
16133
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16083
|
-
* @version
|
|
16134
|
+
* @version 207.0.0
|
|
16084
16135
|
*//**
|
|
16085
16136
|
* Constructs a new MobileDevicesApi.
|
|
16086
16137
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16119,7 +16170,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16119
16170
|
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
16171
|
* Notifications service.
|
|
16121
16172
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16122
|
-
* @version
|
|
16173
|
+
* @version 207.0.0
|
|
16123
16174
|
*//**
|
|
16124
16175
|
* Constructs a new NotificationsApi.
|
|
16125
16176
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16176,7 +16227,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16176
16227
|
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
16228
|
* OAuth service.
|
|
16178
16229
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16179
|
-
* @version
|
|
16230
|
+
* @version 207.0.0
|
|
16180
16231
|
*//**
|
|
16181
16232
|
* Constructs a new OAuthApi.
|
|
16182
16233
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16261,7 +16312,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16261
16312
|
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
16313
|
* Objects service.
|
|
16263
16314
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16264
|
-
* @version
|
|
16315
|
+
* @version 207.0.0
|
|
16265
16316
|
*//**
|
|
16266
16317
|
* Constructs a new ObjectsApi.
|
|
16267
16318
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16332,7 +16383,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
16332
16383
|
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
16384
|
* OperationalEvents service.
|
|
16334
16385
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16335
|
-
* @version
|
|
16386
|
+
* @version 207.0.0
|
|
16336
16387
|
*//**
|
|
16337
16388
|
* Constructs a new OperationalEventsApi.
|
|
16338
16389
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16350,7 +16401,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
16350
16401
|
*/},{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
16402
|
* Organization service.
|
|
16352
16403
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16353
|
-
* @version
|
|
16404
|
+
* @version 207.0.0
|
|
16354
16405
|
*//**
|
|
16355
16406
|
* Constructs a new OrganizationApi.
|
|
16356
16407
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -16475,7 +16526,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16475
16526
|
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
16527
|
* OrganizationAuthorization service.
|
|
16477
16528
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
16478
|
-
* @version
|
|
16529
|
+
* @version 207.0.0
|
|
16479
16530
|
*//**
|
|
16480
16531
|
* Constructs a new OrganizationAuthorizationApi.
|
|
16481
16532
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16626,6 +16677,9 @@ if(trusteeOrgId===undefined||trusteeOrgId===null){throw'Missing the required par
|
|
|
16626
16677
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16627
16678
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16628
16679
|
*/},{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']);}/**
|
|
16680
|
+
* Get Customer Care organization ids.
|
|
16681
|
+
*
|
|
16682
|
+
*/},{key:"getOrgauthorizationTrusteesCare",value:function getOrgauthorizationTrusteesCare(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16629
16683
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
16630
16684
|
*
|
|
16631
16685
|
*/},{key:"getOrgauthorizationTrusteesDefault",value:function getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16716,6 +16770,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16716
16770
|
* @param {String} opts.sortOrder Sort order (default to descending)
|
|
16717
16771
|
*/},{key:"postOrgauthorizationTrusteesAudits",value:function postOrgauthorizationTrusteesAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
16718
16772
|
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']);}/**
|
|
16773
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
16774
|
+
*
|
|
16775
|
+
* @param {Object} opts Optional parameters
|
|
16776
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
16777
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
16778
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
16779
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
16780
|
+
*/},{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
16781
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
16720
16782
|
*
|
|
16721
16783
|
* @param {Object} opts Optional parameters
|
|
@@ -16798,7 +16860,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16798
16860
|
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
16861
|
* Outbound service.
|
|
16800
16862
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16801
|
-
* @version
|
|
16863
|
+
* @version 207.0.0
|
|
16802
16864
|
*//**
|
|
16803
16865
|
* Constructs a new OutboundApi.
|
|
16804
16866
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -17555,6 +17617,16 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
17555
17617
|
*/},{key:"postOutboundCampaignCallbackSchedule",value:function postOutboundCampaignCallbackSchedule(campaignId,body){// verify the required parameter 'campaignId' is set
|
|
17556
17618
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';}// verify the required parameter 'body' is set
|
|
17557
17619
|
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']);}/**
|
|
17620
|
+
* Start the campaign
|
|
17621
|
+
*
|
|
17622
|
+
* @param {String} campaignId Campaign ID
|
|
17623
|
+
*/},{key:"postOutboundCampaignStart",value:function postOutboundCampaignStart(campaignId){// verify the required parameter 'campaignId' is set
|
|
17624
|
+
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']);}/**
|
|
17625
|
+
* Stop the campaign
|
|
17626
|
+
*
|
|
17627
|
+
* @param {String} campaignId Campaign ID
|
|
17628
|
+
*/},{key:"postOutboundCampaignStop",value:function postOutboundCampaignStop(campaignId){// verify the required parameter 'campaignId' is set
|
|
17629
|
+
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
17630
|
* Create Campaign Rule
|
|
17559
17631
|
*
|
|
17560
17632
|
* @param {Object} body CampaignRule
|
|
@@ -17707,6 +17779,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17707
17779
|
* @param {Array.<Object>} body import template(s) to add
|
|
17708
17780
|
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
17709
17781
|
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']);}/**
|
|
17782
|
+
* Start the campaign
|
|
17783
|
+
* Documented permissions are applicable based on campaign type.
|
|
17784
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
17785
|
+
*/},{key:"postOutboundMessagingcampaignStart",value:function postOutboundMessagingcampaignStart(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
17786
|
+
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']);}/**
|
|
17787
|
+
* Stop the campaign
|
|
17788
|
+
* Documented permissions are applicable based on campaign type.
|
|
17789
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
17790
|
+
*/},{key:"postOutboundMessagingcampaignStop",value:function postOutboundMessagingcampaignStop(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
17791
|
+
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
17792
|
* Create a Messaging Campaign
|
|
17711
17793
|
*
|
|
17712
17794
|
* @param {Object} body Messaging Campaign
|
|
@@ -17885,7 +17967,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17885
17967
|
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
17968
|
* Presence service.
|
|
17887
17969
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17888
|
-
* @version
|
|
17970
|
+
* @version 207.0.0
|
|
17889
17971
|
*//**
|
|
17890
17972
|
* Constructs a new PresenceApi.
|
|
17891
17973
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18058,7 +18140,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18058
18140
|
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
18141
|
* ProcessAutomation service.
|
|
18060
18142
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18061
|
-
* @version
|
|
18143
|
+
* @version 207.0.0
|
|
18062
18144
|
*//**
|
|
18063
18145
|
* Constructs a new ProcessAutomationApi.
|
|
18064
18146
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18121,7 +18203,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18121
18203
|
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
18204
|
* Quality service.
|
|
18123
18205
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18124
|
-
* @version
|
|
18206
|
+
* @version 207.0.0
|
|
18125
18207
|
*//**
|
|
18126
18208
|
* Constructs a new QualityApi.
|
|
18127
18209
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -18598,7 +18680,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
18598
18680
|
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
18681
|
* Recording service.
|
|
18600
18682
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
18601
|
-
* @version
|
|
18683
|
+
* @version 207.0.0
|
|
18602
18684
|
*//**
|
|
18603
18685
|
* Constructs a new RecordingApi.
|
|
18604
18686
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -19010,7 +19092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19010
19092
|
*/},{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
19093
|
* ResponseManagement service.
|
|
19012
19094
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
19013
|
-
* @version
|
|
19095
|
+
* @version 207.0.0
|
|
19014
19096
|
*//**
|
|
19015
19097
|
* Constructs a new ResponseManagementApi.
|
|
19016
19098
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19131,7 +19213,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19131
19213
|
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
19214
|
* Routing service.
|
|
19133
19215
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19134
|
-
* @version
|
|
19216
|
+
* @version 207.0.0
|
|
19135
19217
|
*//**
|
|
19136
19218
|
* Constructs a new RoutingApi.
|
|
19137
19219
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20135,7 +20217,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20135
20217
|
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
20218
|
* SCIM service.
|
|
20137
20219
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
20138
|
-
* @version
|
|
20220
|
+
* @version 207.0.0
|
|
20139
20221
|
*//**
|
|
20140
20222
|
* Constructs a new SCIMApi.
|
|
20141
20223
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -20360,7 +20442,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20360
20442
|
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
20443
|
* ScreenRecording service.
|
|
20362
20444
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
20363
|
-
* @version
|
|
20445
|
+
* @version 207.0.0
|
|
20364
20446
|
*//**
|
|
20365
20447
|
* Constructs a new ScreenRecordingApi.
|
|
20366
20448
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -20375,7 +20457,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20375
20457
|
*/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
20458
|
* Scripts service.
|
|
20377
20459
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
20378
|
-
* @version
|
|
20460
|
+
* @version 207.0.0
|
|
20379
20461
|
*//**
|
|
20380
20462
|
* Constructs a new ScriptsApi.
|
|
20381
20463
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -20511,7 +20593,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
20511
20593
|
*/},{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
20594
|
* Search service.
|
|
20513
20595
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
20514
|
-
* @version
|
|
20596
|
+
* @version 207.0.0
|
|
20515
20597
|
*//**
|
|
20516
20598
|
* Constructs a new SearchApi.
|
|
20517
20599
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -20671,7 +20753,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20671
20753
|
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
20754
|
* Settings service.
|
|
20673
20755
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
20674
|
-
* @version
|
|
20756
|
+
* @version 207.0.0
|
|
20675
20757
|
*//**
|
|
20676
20758
|
* Constructs a new SettingsApi.
|
|
20677
20759
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -20721,7 +20803,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
20721
20803
|
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
20804
|
* SpeechTextAnalytics service.
|
|
20723
20805
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
20724
|
-
* @version
|
|
20806
|
+
* @version 207.0.0
|
|
20725
20807
|
*//**
|
|
20726
20808
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
20727
20809
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -21020,7 +21102,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21020
21102
|
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
21103
|
* Stations service.
|
|
21022
21104
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
21023
|
-
* @version
|
|
21105
|
+
* @version 207.0.0
|
|
21024
21106
|
*//**
|
|
21025
21107
|
* Constructs a new StationsApi.
|
|
21026
21108
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -21052,7 +21134,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
21052
21134
|
*/},{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
21135
|
* Suggest service.
|
|
21054
21136
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
21055
|
-
* @version
|
|
21137
|
+
* @version 207.0.0
|
|
21056
21138
|
*//**
|
|
21057
21139
|
* Constructs a new SuggestApi.
|
|
21058
21140
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -21092,7 +21174,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21092
21174
|
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
21175
|
* TaskManagement service.
|
|
21094
21176
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
21095
|
-
* @version
|
|
21177
|
+
* @version 207.0.0
|
|
21096
21178
|
*//**
|
|
21097
21179
|
* Constructs a new TaskManagementApi.
|
|
21098
21180
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -21498,7 +21580,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21498
21580
|
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
21581
|
* Teams service.
|
|
21500
21582
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
21501
|
-
* @version
|
|
21583
|
+
* @version 207.0.0
|
|
21502
21584
|
*//**
|
|
21503
21585
|
* Constructs a new TeamsApi.
|
|
21504
21586
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -21521,8 +21603,10 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
21521
21603
|
* Get team
|
|
21522
21604
|
*
|
|
21523
21605
|
* @param {String} teamId Team ID
|
|
21524
|
-
|
|
21525
|
-
|
|
21606
|
+
* @param {Object} opts Optional parameters
|
|
21607
|
+
* @param {Object} opts.expand Expand the division name
|
|
21608
|
+
*/},{key:"getTeam",value:function getTeam(teamId,opts){opts=opts||{};// verify the required parameter 'teamId' is set
|
|
21609
|
+
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
21610
|
* Get team membership
|
|
21527
21611
|
*
|
|
21528
21612
|
* @param {String} teamId Team ID
|
|
@@ -21576,7 +21660,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21576
21660
|
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
21661
|
* Telephony service.
|
|
21578
21662
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
21579
|
-
* @version
|
|
21663
|
+
* @version 207.0.0
|
|
21580
21664
|
*//**
|
|
21581
21665
|
* Constructs a new TelephonyApi.
|
|
21582
21666
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -21623,7 +21707,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
21623
21707
|
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
21708
|
* TelephonyProvidersEdge service.
|
|
21625
21709
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
21626
|
-
* @version
|
|
21710
|
+
* @version 207.0.0
|
|
21627
21711
|
*//**
|
|
21628
21712
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
21629
21713
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -22446,7 +22530,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
22446
22530
|
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
22531
|
* Textbots service.
|
|
22448
22532
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
22449
|
-
* @version
|
|
22533
|
+
* @version 207.0.0
|
|
22450
22534
|
*//**
|
|
22451
22535
|
* Constructs a new TextbotsApi.
|
|
22452
22536
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -22481,7 +22565,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
22481
22565
|
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
22566
|
* Tokens service.
|
|
22483
22567
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
22484
|
-
* @version
|
|
22568
|
+
* @version 207.0.0
|
|
22485
22569
|
*//**
|
|
22486
22570
|
* Constructs a new TokensApi.
|
|
22487
22571
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -22515,7 +22599,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22515
22599
|
*/},{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
22600
|
* Uploads service.
|
|
22517
22601
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
22518
|
-
* @version
|
|
22602
|
+
* @version 207.0.0
|
|
22519
22603
|
*//**
|
|
22520
22604
|
* Constructs a new UploadsApi.
|
|
22521
22605
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -22581,7 +22665,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22581
22665
|
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
22666
|
* Usage service.
|
|
22583
22667
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
22584
|
-
* @version
|
|
22668
|
+
* @version 207.0.0
|
|
22585
22669
|
*//**
|
|
22586
22670
|
* Constructs a new UsageApi.
|
|
22587
22671
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -22635,7 +22719,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22635
22719
|
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
22720
|
* UserRecordings service.
|
|
22637
22721
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
22638
|
-
* @version
|
|
22722
|
+
* @version 207.0.0
|
|
22639
22723
|
*//**
|
|
22640
22724
|
* Constructs a new UserRecordingsApi.
|
|
22641
22725
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -22692,7 +22776,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
22692
22776
|
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
22777
|
* Users service.
|
|
22694
22778
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
22695
|
-
* @version
|
|
22779
|
+
* @version 207.0.0
|
|
22696
22780
|
*//**
|
|
22697
22781
|
* Constructs a new UsersApi.
|
|
22698
22782
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -23017,6 +23101,13 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23017
23101
|
* @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
23102
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
23019
23103
|
*/},{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']);}/**
|
|
23104
|
+
* Get chats for a user
|
|
23105
|
+
*
|
|
23106
|
+
* @param {Object} opts Optional parameters
|
|
23107
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
23108
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
23109
|
+
* @param {String} opts.after The key to start after
|
|
23110
|
+
*/},{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
23111
|
* Get list of Development Activities
|
|
23021
23112
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
23022
23113
|
* @param {Object} opts Optional parameters
|
|
@@ -23382,7 +23473,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
23382
23473
|
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
23474
|
* Utilities service.
|
|
23384
23475
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
23385
|
-
* @version
|
|
23476
|
+
* @version 207.0.0
|
|
23386
23477
|
*//**
|
|
23387
23478
|
* Constructs a new UtilitiesApi.
|
|
23388
23479
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -23409,7 +23500,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23409
23500
|
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
23501
|
* Voicemail service.
|
|
23411
23502
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
23412
|
-
* @version
|
|
23503
|
+
* @version 207.0.0
|
|
23413
23504
|
*//**
|
|
23414
23505
|
* Constructs a new VoicemailApi.
|
|
23415
23506
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -23496,6 +23587,19 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
23496
23587
|
* @param {Array.<String>} opts.expand expand
|
|
23497
23588
|
*/},{key:"getVoicemailSearch",value:function getVoicemailSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
23498
23589
|
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']);}/**
|
|
23590
|
+
* Get a user's mailbox information
|
|
23591
|
+
*
|
|
23592
|
+
* @param {String} userId userId
|
|
23593
|
+
*/},{key:"getVoicemailUserMailbox",value:function getVoicemailUserMailbox(userId){// verify the required parameter 'userId' is set
|
|
23594
|
+
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']);}/**
|
|
23595
|
+
* List voicemail messages
|
|
23596
|
+
*
|
|
23597
|
+
* @param {String} userId User ID
|
|
23598
|
+
* @param {Object} opts Optional parameters
|
|
23599
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
23600
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
23601
|
+
*/},{key:"getVoicemailUserMessages",value:function getVoicemailUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
23602
|
+
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
23603
|
* Get a user's voicemail policy
|
|
23500
23604
|
*
|
|
23501
23605
|
* @param {String} userId User ID
|
|
@@ -23558,7 +23662,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23558
23662
|
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
23663
|
* WebChat service.
|
|
23560
23664
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
23561
|
-
* @version
|
|
23665
|
+
* @version 207.0.0
|
|
23562
23666
|
*//**
|
|
23563
23667
|
* Constructs a new WebChatApi.
|
|
23564
23668
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -23693,7 +23797,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23693
23797
|
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
23798
|
* WebDeployments service.
|
|
23695
23799
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
23696
|
-
* @version
|
|
23800
|
+
* @version 207.0.0
|
|
23697
23801
|
*//**
|
|
23698
23802
|
* Constructs a new WebDeploymentsApi.
|
|
23699
23803
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -23814,7 +23918,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23814
23918
|
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
23919
|
* WebMessaging service.
|
|
23816
23920
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
23817
|
-
* @version
|
|
23921
|
+
* @version 207.0.0
|
|
23818
23922
|
*//**
|
|
23819
23923
|
* Constructs a new WebMessagingApi.
|
|
23820
23924
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -23830,7 +23934,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
23830
23934
|
*/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
23935
|
* Widgets service.
|
|
23832
23936
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
23833
|
-
* @version
|
|
23937
|
+
* @version 207.0.0
|
|
23834
23938
|
*//**
|
|
23835
23939
|
* Constructs a new WidgetsApi.
|
|
23836
23940
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -23865,7 +23969,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23865
23969
|
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
23970
|
* WorkforceManagement service.
|
|
23867
23971
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
23868
|
-
* @version
|
|
23972
|
+
* @version 207.0.0
|
|
23869
23973
|
*//**
|
|
23870
23974
|
* Constructs a new WorkforceManagementApi.
|
|
23871
23975
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -25646,7 +25750,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
25646
25750
|
* </pre>
|
|
25647
25751
|
* </p>
|
|
25648
25752
|
* @module purecloud-platform-client-v2/index
|
|
25649
|
-
* @version
|
|
25753
|
+
* @version 207.0.0
|
|
25650
25754
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
25651
25755
|
* The ApiClient constructor.
|
|
25652
25756
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|