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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -868,18 +868,30 @@ axios.Cancel=axios.CanceledError;// Expose all/spread
|
|
|
868
868
|
axios.all=function all(promises){return Promise.all(promises);};axios.spread=spread;// Expose isAxiosError
|
|
869
869
|
axios.isAxiosError=isAxiosError;// Expose mergeConfig
|
|
870
870
|
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
|
|
871
|
-
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:/**
|
|
871
|
+
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:/**
|
|
872
872
|
* Singleton getter
|
|
873
873
|
*/function get(){return Configuration.instance;}/**
|
|
874
874
|
* Singleton setter
|
|
875
875
|
*/,set:function set(value){Configuration.instance=value;}},{key:"liveLoadConfig",value:function liveLoadConfig(){// If in browser, don't read config file, use default values
|
|
876
|
-
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
|
|
877
|
-
this.logger.setLogger();}
|
|
876
|
+
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
|
|
877
|
+
this.logger.setLogger();}/**
|
|
878
|
+
* @description Sets the gateway used by the session
|
|
879
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
880
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
881
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
882
|
+
* @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).
|
|
883
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
884
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
885
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
886
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
887
|
+
*/},{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
|
|
888
|
+
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
|
|
889
|
+
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
|
|
878
890
|
if(env)this.environment=env;else this.environment=this.host?this.host:'mypurecloud.com';// Strip trailing slash
|
|
879
891
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
880
|
-
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];}}}]);}();/**
|
|
892
|
+
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];}}}]);}();/**
|
|
881
893
|
* @module purecloud-platform-client-v2/ApiClient
|
|
882
|
-
* @version
|
|
894
|
+
* @version 207.0.0
|
|
883
895
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
884
896
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
885
897
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -948,6 +960,16 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
948
960
|
* @description Sets the environment used by the session
|
|
949
961
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
950
962
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
963
|
+
* @description Sets the gateway used by the session
|
|
964
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
965
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
966
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
967
|
+
* @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).
|
|
968
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
969
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
970
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
971
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
972
|
+
*/},{key:"setGateway",value:function setGateway(gateway){this.config.setGateway(gateway);}/**
|
|
951
973
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
952
974
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
953
975
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
@@ -963,35 +985,35 @@ _this2._testTokenAccess().then(function(){if(!_this2.authData.state&&opts.state)
|
|
|
963
985
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
964
986
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
965
987
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
966
|
-
*/},{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
|
|
967
|
-
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:"
|
|
968
|
-
_this3.config.logger.log('trace',response.status,'POST',"
|
|
988
|
+
*/},{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
|
|
989
|
+
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
|
|
990
|
+
_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
|
|
969
991
|
_this3.setAccessToken(response.data['access_token']);// Set expiry time
|
|
970
992
|
_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
971
993
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
972
|
-
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"
|
|
994
|
+
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);});});}/**
|
|
973
995
|
* @description Initiates the Saml2Bearerflow. Only available in node apps.
|
|
974
996
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
975
997
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
976
998
|
* @param {string} orgName - The orgName of an OAuth Implicit Grant client
|
|
977
999
|
* @param {string} assertion - The saml2bearer assertion
|
|
978
|
-
*/},{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
|
|
1000
|
+
*/},{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
|
|
979
1001
|
request.then(function(response){// Logging
|
|
980
|
-
_this4.config.logger.log('trace',response.status,'POST',"
|
|
1002
|
+
_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
|
|
981
1003
|
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
|
|
982
1004
|
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
983
|
-
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"
|
|
1005
|
+
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);});});}/**
|
|
984
1006
|
* @description Completes the PKCE Code Authorization.
|
|
985
1007
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
986
1008
|
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
987
1009
|
* @param {string} authCode - Authorization code
|
|
988
1010
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
989
|
-
*/},{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:"
|
|
1011
|
+
*/},{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
|
|
990
1012
|
request.then(function(response){// Logging
|
|
991
|
-
_this5.config.logger.log('trace',response.status,'POST',"
|
|
1013
|
+
_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
|
|
992
1014
|
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
|
|
993
1015
|
resolve(_this5.authData);})["catch"](function(error){// Log error
|
|
994
|
-
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"
|
|
1016
|
+
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);});});}/**
|
|
995
1017
|
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
996
1018
|
* @param {number} nChar - code length
|
|
997
1019
|
*/},{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
|
|
@@ -1057,15 +1079,15 @@ _this8._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/*
|
|
|
1057
1079
|
* @param {object} bodyParam - Input body data for authorization request
|
|
1058
1080
|
* @param {function} resolve - Promise resolve callback
|
|
1059
1081
|
* @param {function} reject - Promise reject callback
|
|
1060
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;request.then(function(response){// Logging
|
|
1061
|
-
_this9.config.logger.log('trace',response.status,'POST',"
|
|
1082
|
+
*/},{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
|
|
1083
|
+
_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
|
|
1062
1084
|
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
|
|
1063
1085
|
resolve(_this9.authData);})["catch"](function(error){// Log error
|
|
1064
|
-
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"
|
|
1086
|
+
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);});}/**
|
|
1065
1087
|
* @description Utility function to create the request for auth requests
|
|
1066
1088
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
1067
1089
|
* @param {object} data - data to url form encode
|
|
1068
|
-
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"
|
|
1090
|
+
*/},{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;}/**
|
|
1069
1091
|
* @description Handles an expired access token. Only available in node apps.
|
|
1070
1092
|
* @param {string} statusCode - The status code of a request
|
|
1071
1093
|
*/},{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
|
|
@@ -1104,7 +1126,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1104
1126
|
* @description Constructs a URL to the auth server
|
|
1105
1127
|
* @param {string} path - The path for the URL
|
|
1106
1128
|
* @param {object} query - An object of key/value pairs to use for querystring keys/values
|
|
1107
|
-
*/},{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(
|
|
1129
|
+
*/},{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,"?"));}/**
|
|
1108
1130
|
* Returns a string representation for an actual parameter.
|
|
1109
1131
|
* @param param The actual parameter.
|
|
1110
1132
|
* @returns {String} The string representation of <code>param</code>.
|
|
@@ -1123,7 +1145,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1123
1145
|
* @param {String} path The path to append to the base URL.
|
|
1124
1146
|
* @param {Object} pathParams The parameter values to append.
|
|
1125
1147
|
* @returns {String} The encoded path with parameter values substituted.
|
|
1126
|
-
*/},{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;}/**
|
|
1148
|
+
*/},{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;}/**
|
|
1127
1149
|
* Checks whether the given content type represents JSON.<br>
|
|
1128
1150
|
* JSON content type examples:<br>
|
|
1129
1151
|
* <ul>
|
|
@@ -1191,7 +1213,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1191
1213
|
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(){/**
|
|
1192
1214
|
* AgentAssistants service.
|
|
1193
1215
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1194
|
-
* @version
|
|
1216
|
+
* @version 207.0.0
|
|
1195
1217
|
*//**
|
|
1196
1218
|
* Constructs a new AgentAssistantsApi.
|
|
1197
1219
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1292,7 +1314,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1292
1314
|
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(){/**
|
|
1293
1315
|
* AgentCopilot service.
|
|
1294
1316
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1295
|
-
* @version
|
|
1317
|
+
* @version 207.0.0
|
|
1296
1318
|
*//**
|
|
1297
1319
|
* Constructs a new AgentCopilotApi.
|
|
1298
1320
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1314,7 +1336,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1314
1336
|
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(){/**
|
|
1315
1337
|
* AgentUI service.
|
|
1316
1338
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1317
|
-
* @version
|
|
1339
|
+
* @version 207.0.0
|
|
1318
1340
|
*//**
|
|
1319
1341
|
* Constructs a new AgentUIApi.
|
|
1320
1342
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1348,7 +1370,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1348
1370
|
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(){/**
|
|
1349
1371
|
* Alerting service.
|
|
1350
1372
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1351
|
-
* @version
|
|
1373
|
+
* @version 207.0.0
|
|
1352
1374
|
*//**
|
|
1353
1375
|
* Constructs a new AlertingApi.
|
|
1354
1376
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1505,7 +1527,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1505
1527
|
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(){/**
|
|
1506
1528
|
* Analytics service.
|
|
1507
1529
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1508
|
-
* @version
|
|
1530
|
+
* @version 207.0.0
|
|
1509
1531
|
*//**
|
|
1510
1532
|
* Constructs a new AnalyticsApi.
|
|
1511
1533
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1729,7 +1751,8 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
1729
1751
|
* @param {Number} opts.pageSize (default to 25)
|
|
1730
1752
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
1731
1753
|
* @param {Object} opts.state Only list users of this state
|
|
1732
|
-
|
|
1754
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
1755
|
+
*/},{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']);}/**
|
|
1733
1756
|
* Get all view export requests for a user
|
|
1734
1757
|
*
|
|
1735
1758
|
* @param {Object} opts Optional parameters
|
|
@@ -1763,9 +1786,10 @@ if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missin
|
|
|
1763
1786
|
* @param {Number} opts.pageSize (default to 50)
|
|
1764
1787
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
1765
1788
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
1789
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
1766
1790
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
1767
1791
|
*/},{key:"getAnalyticsReportingSettingsUserDashboards",value:function getAnalyticsReportingSettingsUserDashboards(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
1768
|
-
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']);}/**
|
|
1792
|
+
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']);}/**
|
|
1769
1793
|
* Get status for async query for resolution aggregates
|
|
1770
1794
|
*
|
|
1771
1795
|
* @param {String} jobId jobId
|
|
@@ -2009,7 +2033,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2009
2033
|
* @param {Object} body query
|
|
2010
2034
|
*/},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2011
2035
|
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']);}/**
|
|
2012
|
-
* Bulk delete dashboards owned by other user(s)
|
|
2036
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
2013
2037
|
*
|
|
2014
2038
|
* @param {Array.<String>} body List of userIds
|
|
2015
2039
|
*/},{key:"postAnalyticsReportingDashboardsUsersBulkRemove",value:function postAnalyticsReportingDashboardsUsersBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -2019,7 +2043,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2019
2043
|
* @param {Object} body ReportingExportJobRequest
|
|
2020
2044
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
2021
2045
|
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']);}/**
|
|
2022
|
-
* Bulk
|
|
2046
|
+
* Bulk soft delete dashboard configurations
|
|
2023
2047
|
*
|
|
2024
2048
|
* @param {Object} body
|
|
2025
2049
|
*/},{key:"postAnalyticsReportingSettingsDashboardsBulkRemove",value:function postAnalyticsReportingSettingsDashboardsBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -2063,7 +2087,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2063
2087
|
* Query for task management aggregates
|
|
2064
2088
|
*
|
|
2065
2089
|
* @param {Object} body query
|
|
2066
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2067
2090
|
*/},{key:"postAnalyticsTaskmanagementAggregatesQuery",value:function postAnalyticsTaskmanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2068
2091
|
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']);}/**
|
|
2069
2092
|
* Query for team activity observations
|
|
@@ -2126,7 +2149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2126
2149
|
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(){/**
|
|
2127
2150
|
* Architect service.
|
|
2128
2151
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2129
|
-
* @version
|
|
2152
|
+
* @version 207.0.0
|
|
2130
2153
|
*//**
|
|
2131
2154
|
* Constructs a new ArchitectApi.
|
|
2132
2155
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2616,7 +2639,7 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
2616
2639
|
*/},{key:"getFlowVersion",value:function getFlowVersion(flowId,versionId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
2617
2640
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowVersion';}// verify the required parameter 'versionId' is set
|
|
2618
2641
|
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']);}/**
|
|
2619
|
-
*
|
|
2642
|
+
* Get flow version configuration
|
|
2620
2643
|
*
|
|
2621
2644
|
* @param {String} flowId Flow ID
|
|
2622
2645
|
* @param {String} versionId Version ID
|
|
@@ -3218,7 +3241,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3218
3241
|
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(){/**
|
|
3219
3242
|
* Audit service.
|
|
3220
3243
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3221
|
-
* @version
|
|
3244
|
+
* @version 207.0.0
|
|
3222
3245
|
*//**
|
|
3223
3246
|
* Constructs a new AuditApi.
|
|
3224
3247
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3268,7 +3291,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3268
3291
|
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(){/**
|
|
3269
3292
|
* Authorization service.
|
|
3270
3293
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3271
|
-
* @version
|
|
3294
|
+
* @version 207.0.0
|
|
3272
3295
|
*//**
|
|
3273
3296
|
* Constructs a new AuthorizationApi.
|
|
3274
3297
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3591,7 +3614,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3591
3614
|
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(){/**
|
|
3592
3615
|
* Billing service.
|
|
3593
3616
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3594
|
-
* @version
|
|
3617
|
+
* @version 207.0.0
|
|
3595
3618
|
*//**
|
|
3596
3619
|
* Constructs a new BillingApi.
|
|
3597
3620
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3615,7 +3638,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3615
3638
|
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(){/**
|
|
3616
3639
|
* CarrierServices service.
|
|
3617
3640
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3618
|
-
* @version
|
|
3641
|
+
* @version 207.0.0
|
|
3619
3642
|
*//**
|
|
3620
3643
|
* Constructs a new CarrierServicesApi.
|
|
3621
3644
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3635,7 +3658,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3635
3658
|
*/},{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(){/**
|
|
3636
3659
|
* Chat service.
|
|
3637
3660
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3638
|
-
* @version
|
|
3661
|
+
* @version 207.0.0
|
|
3639
3662
|
*//**
|
|
3640
3663
|
* Constructs a new ChatApi.
|
|
3641
3664
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3860,7 +3883,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3860
3883
|
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(){/**
|
|
3861
3884
|
* Coaching service.
|
|
3862
3885
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3863
|
-
* @version
|
|
3886
|
+
* @version 207.0.0
|
|
3864
3887
|
*//**
|
|
3865
3888
|
* Constructs a new CoachingApi.
|
|
3866
3889
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4013,7 +4036,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4013
4036
|
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(){/**
|
|
4014
4037
|
* ContentManagement service.
|
|
4015
4038
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4016
|
-
* @version
|
|
4039
|
+
* @version 207.0.0
|
|
4017
4040
|
*//**
|
|
4018
4041
|
* Constructs a new ContentManagementApi.
|
|
4019
4042
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4117,12 +4140,11 @@ if(shareId===undefined||shareId===null){throw'Missing the required parameter "sh
|
|
|
4117
4140
|
* 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.
|
|
4118
4141
|
* @param {String} sharedId Shared ID
|
|
4119
4142
|
* @param {Object} opts Optional parameters
|
|
4120
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
4121
4143
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
4122
4144
|
* @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
|
|
4123
4145
|
* @param {Object} opts.expand Expand some document fields
|
|
4124
4146
|
*/},{key:"getContentmanagementSharedSharedId",value:function getContentmanagementSharedSharedId(sharedId,opts){opts=opts||{};// verify the required parameter 'sharedId' is set
|
|
4125
|
-
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},{'
|
|
4147
|
+
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']);}/**
|
|
4126
4148
|
* Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
4127
4149
|
* Failing to specify a filter will return 400.
|
|
4128
4150
|
* @param {Object} opts Optional parameters
|
|
@@ -4296,7 +4318,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4296
4318
|
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(){/**
|
|
4297
4319
|
* Conversations service.
|
|
4298
4320
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4299
|
-
* @version
|
|
4321
|
+
* @version 207.0.0
|
|
4300
4322
|
*//**
|
|
4301
4323
|
* Constructs a new ConversationsApi.
|
|
4302
4324
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5435,9 +5457,10 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5435
5457
|
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'body' is set
|
|
5436
5458
|
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']);}/**
|
|
5437
5459
|
* Suggestion feedback.
|
|
5438
|
-
*
|
|
5460
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
5439
5461
|
* @param {String} conversationId Conversation ID
|
|
5440
5462
|
* @param {Object} body SuggestionFeedback
|
|
5463
|
+
* @deprecated
|
|
5441
5464
|
*/},{key:"postConversationSuggestionsFeedback",value:function postConversationSuggestionsFeedback(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
5442
5465
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';}// verify the required parameter 'body' is set
|
|
5443
5466
|
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']);}/**
|
|
@@ -6024,7 +6047,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6024
6047
|
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(){/**
|
|
6025
6048
|
* DataExtensions service.
|
|
6026
6049
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6027
|
-
* @version
|
|
6050
|
+
* @version 207.0.0
|
|
6028
6051
|
*//**
|
|
6029
6052
|
* Constructs a new DataExtensionsApi.
|
|
6030
6053
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6045,7 +6068,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6045
6068
|
*/},{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(){/**
|
|
6046
6069
|
* Downloads service.
|
|
6047
6070
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6048
|
-
* @version
|
|
6071
|
+
* @version 207.0.0
|
|
6049
6072
|
*//**
|
|
6050
6073
|
* Constructs a new DownloadsApi.
|
|
6051
6074
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6064,7 +6087,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6064
6087
|
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(){/**
|
|
6065
6088
|
* Emails service.
|
|
6066
6089
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6067
|
-
* @version
|
|
6090
|
+
* @version 207.0.0
|
|
6068
6091
|
*//**
|
|
6069
6092
|
* Constructs a new EmailsApi.
|
|
6070
6093
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6082,7 +6105,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6082
6105
|
*/},{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(){/**
|
|
6083
6106
|
* EmployeeEngagement service.
|
|
6084
6107
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6085
|
-
* @version
|
|
6108
|
+
* @version 207.0.0
|
|
6086
6109
|
*//**
|
|
6087
6110
|
* Constructs a new EmployeeEngagementApi.
|
|
6088
6111
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6120,7 +6143,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6120
6143
|
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(){/**
|
|
6121
6144
|
* Events service.
|
|
6122
6145
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6123
|
-
* @version
|
|
6146
|
+
* @version 207.0.0
|
|
6124
6147
|
*//**
|
|
6125
6148
|
* Constructs a new EventsApi.
|
|
6126
6149
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6145,7 +6168,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6145
6168
|
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(){/**
|
|
6146
6169
|
* ExternalContacts service.
|
|
6147
6170
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6148
|
-
* @version
|
|
6171
|
+
* @version 207.0.0
|
|
6149
6172
|
*//**
|
|
6150
6173
|
* Constructs a new ExternalContactsApi.
|
|
6151
6174
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6176,6 +6199,11 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
6176
6199
|
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6177
6200
|
*/},{key:"deleteExternalcontactsExternalsource",value:function deleteExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
6178
6201
|
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']);}/**
|
|
6202
|
+
* Delete settings for CSV import
|
|
6203
|
+
*
|
|
6204
|
+
* @param {String} settingsId Settings id
|
|
6205
|
+
*/},{key:"deleteExternalcontactsImportCsvSetting",value:function deleteExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6206
|
+
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']);}/**
|
|
6179
6207
|
* Delete an external organization
|
|
6180
6208
|
*
|
|
6181
6209
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6289,6 +6317,28 @@ if(externalSourceId===undefined||externalSourceId===null){throw'Missing the requ
|
|
|
6289
6317
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
6290
6318
|
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6291
6319
|
*/},{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']);}/**
|
|
6320
|
+
* Get settings for CSV import
|
|
6321
|
+
*
|
|
6322
|
+
* @param {String} settingsId Settings id
|
|
6323
|
+
*/},{key:"getExternalcontactsImportCsvSetting",value:function getExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6324
|
+
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']);}/**
|
|
6325
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
6326
|
+
*
|
|
6327
|
+
* @param {Object} opts Optional parameters
|
|
6328
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
6329
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
6330
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
6331
|
+
*/},{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']);}/**
|
|
6332
|
+
* Get details for CSV upload
|
|
6333
|
+
*
|
|
6334
|
+
* @param {String} uploadId Upload id
|
|
6335
|
+
*/},{key:"getExternalcontactsImportCsvUploadDetails",value:function getExternalcontactsImportCsvUploadDetails(uploadId){// verify the required parameter 'uploadId' is set
|
|
6336
|
+
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']);}/**
|
|
6337
|
+
* Get preview for CSV upload
|
|
6338
|
+
*
|
|
6339
|
+
* @param {String} uploadId Upload id
|
|
6340
|
+
*/},{key:"getExternalcontactsImportCsvUploadPreview",value:function getExternalcontactsImportCsvUploadPreview(uploadId){// verify the required parameter 'uploadId' is set
|
|
6341
|
+
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']);}/**
|
|
6292
6342
|
* Fetch an external organization
|
|
6293
6343
|
*
|
|
6294
6344
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6533,6 +6583,21 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6533
6583
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
6534
6584
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
6535
6585
|
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']);}/**
|
|
6586
|
+
* Create CSV import job
|
|
6587
|
+
*
|
|
6588
|
+
* @param {Object} body ImportRequest
|
|
6589
|
+
*/},{key:"postExternalcontactsImportCsvJobs",value:function postExternalcontactsImportCsvJobs(body){// verify the required parameter 'body' is set
|
|
6590
|
+
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']);}/**
|
|
6591
|
+
* Create settings for CSV import
|
|
6592
|
+
*
|
|
6593
|
+
* @param {Object} body Settings
|
|
6594
|
+
*/},{key:"postExternalcontactsImportCsvSettings",value:function postExternalcontactsImportCsvSettings(body){// verify the required parameter 'body' is set
|
|
6595
|
+
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']);}/**
|
|
6596
|
+
* Get url for CSV upload
|
|
6597
|
+
*
|
|
6598
|
+
* @param {Object} body UploadRequest
|
|
6599
|
+
*/},{key:"postExternalcontactsImportCsvUploads",value:function postExternalcontactsImportCsvUploads(body){// verify the required parameter 'body' is set
|
|
6600
|
+
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']);}/**
|
|
6536
6601
|
* Merge two contacts into a new contact record
|
|
6537
6602
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
6538
6603
|
* @param {Object} body MergeRequest
|
|
@@ -6598,6 +6663,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6598
6663
|
*/},{key:"putExternalcontactsExternalsource",value:function putExternalcontactsExternalsource(externalSourceId,body){// verify the required parameter 'externalSourceId' is set
|
|
6599
6664
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';}// verify the required parameter 'body' is set
|
|
6600
6665
|
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']);}/**
|
|
6666
|
+
* Update settings for CSV import
|
|
6667
|
+
*
|
|
6668
|
+
* @param {String} settingsId Settings id
|
|
6669
|
+
* @param {Object} body Settings
|
|
6670
|
+
*/},{key:"putExternalcontactsImportCsvSetting",value:function putExternalcontactsImportCsvSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
6671
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';}// verify the required parameter 'body' is set
|
|
6672
|
+
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']);}/**
|
|
6601
6673
|
* Update an external organization
|
|
6602
6674
|
*
|
|
6603
6675
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6637,7 +6709,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6637
6709
|
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(){/**
|
|
6638
6710
|
* Fax service.
|
|
6639
6711
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6640
|
-
* @version
|
|
6712
|
+
* @version 207.0.0
|
|
6641
6713
|
*//**
|
|
6642
6714
|
* Constructs a new FaxApi.
|
|
6643
6715
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6686,7 +6758,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6686
6758
|
*/},{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(){/**
|
|
6687
6759
|
* Flows service.
|
|
6688
6760
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6689
|
-
* @version
|
|
6761
|
+
* @version 207.0.0
|
|
6690
6762
|
*//**
|
|
6691
6763
|
* Constructs a new FlowsApi.
|
|
6692
6764
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6734,7 +6806,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6734
6806
|
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(){/**
|
|
6735
6807
|
* Gamification service.
|
|
6736
6808
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6737
|
-
* @version
|
|
6809
|
+
* @version 207.0.0
|
|
6738
6810
|
*//**
|
|
6739
6811
|
* Constructs a new GamificationApi.
|
|
6740
6812
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7274,7 +7346,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7274
7346
|
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(){/**
|
|
7275
7347
|
* GeneralDataProtectionRegulation service.
|
|
7276
7348
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7277
|
-
* @version
|
|
7349
|
+
* @version 207.0.0
|
|
7278
7350
|
*//**
|
|
7279
7351
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7280
7352
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7309,7 +7381,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7309
7381
|
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(){/**
|
|
7310
7382
|
* Geolocation service.
|
|
7311
7383
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7312
|
-
* @version
|
|
7384
|
+
* @version 207.0.0
|
|
7313
7385
|
*//**
|
|
7314
7386
|
* Constructs a new GeolocationApi.
|
|
7315
7387
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7343,7 +7415,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7343
7415
|
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(){/**
|
|
7344
7416
|
* Greetings service.
|
|
7345
7417
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7346
|
-
* @version
|
|
7418
|
+
* @version 207.0.0
|
|
7347
7419
|
*//**
|
|
7348
7420
|
* Constructs a new GreetingsApi.
|
|
7349
7421
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7450,7 +7522,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7450
7522
|
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(){/**
|
|
7451
7523
|
* Groups service.
|
|
7452
7524
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7453
|
-
* @version
|
|
7525
|
+
* @version 207.0.0
|
|
7454
7526
|
*//**
|
|
7455
7527
|
* Constructs a new GroupsApi.
|
|
7456
7528
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7583,7 +7655,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7583
7655
|
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(){/**
|
|
7584
7656
|
* IdentityProvider service.
|
|
7585
7657
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7586
|
-
* @version
|
|
7658
|
+
* @version 207.0.0
|
|
7587
7659
|
*//**
|
|
7588
7660
|
* Constructs a new IdentityProviderApi.
|
|
7589
7661
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7739,7 +7811,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7739
7811
|
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(){/**
|
|
7740
7812
|
* InfrastructureAsCode service.
|
|
7741
7813
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7742
|
-
* @version
|
|
7814
|
+
* @version 207.0.0
|
|
7743
7815
|
*//**
|
|
7744
7816
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7745
7817
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7793,7 +7865,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7793
7865
|
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(){/**
|
|
7794
7866
|
* Integrations service.
|
|
7795
7867
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7796
|
-
* @version
|
|
7868
|
+
* @version 207.0.0
|
|
7797
7869
|
*//**
|
|
7798
7870
|
* Constructs a new IntegrationsApi.
|
|
7799
7871
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8418,7 +8490,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8418
8490
|
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(){/**
|
|
8419
8491
|
* Journey service.
|
|
8420
8492
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8421
|
-
* @version
|
|
8493
|
+
* @version 207.0.0
|
|
8422
8494
|
*//**
|
|
8423
8495
|
* Constructs a new JourneyApi.
|
|
8424
8496
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8698,12 +8770,10 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
8698
8770
|
* Get an Event Definition
|
|
8699
8771
|
*
|
|
8700
8772
|
* @param {String} eventDefinitionId Event Definition ID
|
|
8701
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8702
8773
|
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
8703
8774
|
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']);}/**
|
|
8704
8775
|
* Get a list of Event Definitions
|
|
8705
8776
|
*
|
|
8706
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8707
8777
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8708
8778
|
* Get the jobs for an organization.
|
|
8709
8779
|
*
|
|
@@ -8855,7 +8925,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8855
8925
|
* True indicates a valid encoding
|
|
8856
8926
|
* @param {Object} opts Optional parameters
|
|
8857
8927
|
* @param {Array.<Object>} opts.body
|
|
8858
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8859
8928
|
*/},{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']);}/**
|
|
8860
8929
|
* Update a Journey View by ID and version
|
|
8861
8930
|
* does not create a new version
|
|
@@ -8868,7 +8937,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
8868
8937
|
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(){/**
|
|
8869
8938
|
* Knowledge service.
|
|
8870
8939
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8871
|
-
* @version
|
|
8940
|
+
* @version 207.0.0
|
|
8872
8941
|
*//**
|
|
8873
8942
|
* Constructs a new KnowledgeApi.
|
|
8874
8943
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8959,7 +9028,6 @@ if(importId===undefined||importId===null){throw'Missing the required parameter "
|
|
|
8959
9028
|
*
|
|
8960
9029
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8961
9030
|
* @param {String} sourceId Source ID
|
|
8962
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8963
9031
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8964
9032
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
8965
9033
|
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']);}/**
|
|
@@ -8967,7 +9035,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
8967
9035
|
*
|
|
8968
9036
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8969
9037
|
* @param {String} sourceId Source ID
|
|
8970
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8971
9038
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8972
9039
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
8973
9040
|
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']);}/**
|
|
@@ -8975,7 +9042,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
8975
9042
|
*
|
|
8976
9043
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8977
9044
|
* @param {String} syncJobId Synchronization job ID
|
|
8978
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8979
9045
|
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8980
9046
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
8981
9047
|
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']);}/**
|
|
@@ -9012,7 +9078,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
9012
9078
|
* Get sync options available for a knowledge-connect integration
|
|
9013
9079
|
*
|
|
9014
9080
|
* @param {String} integrationId Integration ID
|
|
9015
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9016
9081
|
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
9017
9082
|
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']);}/**
|
|
9018
9083
|
* Get knowledge base
|
|
@@ -9312,13 +9377,11 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
9312
9377
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
9313
9378
|
* @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
|
|
9314
9379
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
9315
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9316
9380
|
*/},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9317
9381
|
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']);}/**
|
|
9318
9382
|
* Get ids of operation creator users and oauth clients
|
|
9319
9383
|
*
|
|
9320
9384
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9321
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9322
9385
|
*/},{key:"getKnowledgeKnowledgebaseOperationsUsersQuery",value:function getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9323
9386
|
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']);}/**
|
|
9324
9387
|
* Get parse job report
|
|
@@ -9338,7 +9401,6 @@ if(parseJobId===undefined||parseJobId===null){throw'Missing the required paramet
|
|
|
9338
9401
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
9339
9402
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9340
9403
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
9341
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9342
9404
|
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9343
9405
|
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']);}/**
|
|
9344
9406
|
* Get Salesforce Knowledge integration source
|
|
@@ -9347,7 +9409,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9347
9409
|
* @param {String} sourceId Source ID
|
|
9348
9410
|
* @param {Object} opts Optional parameters
|
|
9349
9411
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9350
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9351
9412
|
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9352
9413
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9353
9414
|
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']);}/**
|
|
@@ -9357,7 +9418,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9357
9418
|
* @param {String} sourceId Source ID
|
|
9358
9419
|
* @param {Object} opts Optional parameters
|
|
9359
9420
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9360
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9361
9421
|
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9362
9422
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9363
9423
|
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']);}/**
|
|
@@ -9365,7 +9425,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9365
9425
|
*
|
|
9366
9426
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9367
9427
|
* @param {String} syncJobId Synchronization job ID
|
|
9368
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9369
9428
|
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9370
9429
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9371
9430
|
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']);}/**
|
|
@@ -9567,7 +9626,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9567
9626
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9568
9627
|
* @param {String} syncJobId Synchronization job ID
|
|
9569
9628
|
* @param {Object} body
|
|
9570
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9571
9629
|
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9572
9630
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9573
9631
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
@@ -9881,7 +9939,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9881
9939
|
*
|
|
9882
9940
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9883
9941
|
* @param {Object} body
|
|
9884
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9885
9942
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9886
9943
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
9887
9944
|
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']);}/**
|
|
@@ -9889,7 +9946,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9889
9946
|
*
|
|
9890
9947
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9891
9948
|
* @param {String} sourceId Source ID
|
|
9892
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9893
9949
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9894
9950
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9895
9951
|
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']);}/**
|
|
@@ -9897,7 +9953,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9897
9953
|
*
|
|
9898
9954
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9899
9955
|
* @param {Object} body
|
|
9900
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9901
9956
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9902
9957
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
9903
9958
|
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']);}/**
|
|
@@ -9905,7 +9960,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9905
9960
|
*
|
|
9906
9961
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9907
9962
|
* @param {String} sourceId Source ID
|
|
9908
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9909
9963
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9910
9964
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9911
9965
|
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']);}/**
|
|
@@ -9913,7 +9967,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9913
9967
|
*
|
|
9914
9968
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9915
9969
|
* @param {Object} body
|
|
9916
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9917
9970
|
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9918
9971
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
9919
9972
|
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']);}/**
|
|
@@ -9935,7 +9988,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9935
9988
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9936
9989
|
* @param {String} sourceId Source ID
|
|
9937
9990
|
* @param {Object} body
|
|
9938
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9939
9991
|
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9940
9992
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9941
9993
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
@@ -9945,14 +9997,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9945
9997
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9946
9998
|
* @param {String} sourceId Source ID
|
|
9947
9999
|
* @param {Object} body
|
|
9948
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9949
10000
|
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9950
10001
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9951
10002
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
9952
10003
|
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(){/**
|
|
9953
10004
|
* LanguageUnderstanding service.
|
|
9954
10005
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9955
|
-
* @version
|
|
10006
|
+
* @version 207.0.0
|
|
9956
10007
|
*//**
|
|
9957
10008
|
* Constructs a new LanguageUnderstandingApi.
|
|
9958
10009
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10212,7 +10263,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10212
10263
|
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(){/**
|
|
10213
10264
|
* Languages service.
|
|
10214
10265
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10215
|
-
* @version
|
|
10266
|
+
* @version 207.0.0
|
|
10216
10267
|
*//**
|
|
10217
10268
|
* Constructs a new LanguagesApi.
|
|
10218
10269
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10267,7 +10318,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10267
10318
|
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(){/**
|
|
10268
10319
|
* Learning service.
|
|
10269
10320
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10270
|
-
* @version
|
|
10321
|
+
* @version 207.0.0
|
|
10271
10322
|
*//**
|
|
10272
10323
|
* Constructs a new LearningApi.
|
|
10273
10324
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10538,7 +10589,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10538
10589
|
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(){/**
|
|
10539
10590
|
* License service.
|
|
10540
10591
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10541
|
-
* @version
|
|
10592
|
+
* @version 207.0.0
|
|
10542
10593
|
*//**
|
|
10543
10594
|
* Constructs a new LicenseApi.
|
|
10544
10595
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10592,7 +10643,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10592
10643
|
*/},{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(){/**
|
|
10593
10644
|
* Locations service.
|
|
10594
10645
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10595
|
-
* @version
|
|
10646
|
+
* @version 207.0.0
|
|
10596
10647
|
*//**
|
|
10597
10648
|
* Constructs a new LocationsApi.
|
|
10598
10649
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10651,7 +10702,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10651
10702
|
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(){/**
|
|
10652
10703
|
* LogCapture service.
|
|
10653
10704
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10654
|
-
* @version
|
|
10705
|
+
* @version 207.0.0
|
|
10655
10706
|
*//**
|
|
10656
10707
|
* Constructs a new LogCaptureApi.
|
|
10657
10708
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10701,7 +10752,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10701
10752
|
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(){/**
|
|
10702
10753
|
* Messaging service.
|
|
10703
10754
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10704
|
-
* @version
|
|
10755
|
+
* @version 207.0.0
|
|
10705
10756
|
*//**
|
|
10706
10757
|
* Constructs a new MessagingApi.
|
|
10707
10758
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10791,7 +10842,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10791
10842
|
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(){/**
|
|
10792
10843
|
* MobileDevices service.
|
|
10793
10844
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10794
|
-
* @version
|
|
10845
|
+
* @version 207.0.0
|
|
10795
10846
|
*//**
|
|
10796
10847
|
* Constructs a new MobileDevicesApi.
|
|
10797
10848
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10830,7 +10881,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10830
10881
|
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(){/**
|
|
10831
10882
|
* Notifications service.
|
|
10832
10883
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10833
|
-
* @version
|
|
10884
|
+
* @version 207.0.0
|
|
10834
10885
|
*//**
|
|
10835
10886
|
* Constructs a new NotificationsApi.
|
|
10836
10887
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10887,7 +10938,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10887
10938
|
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(){/**
|
|
10888
10939
|
* OAuth service.
|
|
10889
10940
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10890
|
-
* @version
|
|
10941
|
+
* @version 207.0.0
|
|
10891
10942
|
*//**
|
|
10892
10943
|
* Constructs a new OAuthApi.
|
|
10893
10944
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10972,7 +11023,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10972
11023
|
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(){/**
|
|
10973
11024
|
* Objects service.
|
|
10974
11025
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10975
|
-
* @version
|
|
11026
|
+
* @version 207.0.0
|
|
10976
11027
|
*//**
|
|
10977
11028
|
* Constructs a new ObjectsApi.
|
|
10978
11029
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -11043,7 +11094,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11043
11094
|
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(){/**
|
|
11044
11095
|
* OperationalEvents service.
|
|
11045
11096
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
11046
|
-
* @version
|
|
11097
|
+
* @version 207.0.0
|
|
11047
11098
|
*//**
|
|
11048
11099
|
* Constructs a new OperationalEventsApi.
|
|
11049
11100
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11061,7 +11112,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
11061
11112
|
*/},{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(){/**
|
|
11062
11113
|
* Organization service.
|
|
11063
11114
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11064
|
-
* @version
|
|
11115
|
+
* @version 207.0.0
|
|
11065
11116
|
*//**
|
|
11066
11117
|
* Constructs a new OrganizationApi.
|
|
11067
11118
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11186,7 +11237,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11186
11237
|
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(){/**
|
|
11187
11238
|
* OrganizationAuthorization service.
|
|
11188
11239
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11189
|
-
* @version
|
|
11240
|
+
* @version 207.0.0
|
|
11190
11241
|
*//**
|
|
11191
11242
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11192
11243
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11337,6 +11388,9 @@ if(trusteeOrgId===undefined||trusteeOrgId===null){throw'Missing the required par
|
|
|
11337
11388
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11338
11389
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11339
11390
|
*/},{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']);}/**
|
|
11391
|
+
* Get Customer Care organization ids.
|
|
11392
|
+
*
|
|
11393
|
+
*/},{key:"getOrgauthorizationTrusteesCare",value:function getOrgauthorizationTrusteesCare(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11340
11394
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
11341
11395
|
*
|
|
11342
11396
|
*/},{key:"getOrgauthorizationTrusteesDefault",value:function getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -11427,6 +11481,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11427
11481
|
* @param {String} opts.sortOrder Sort order (default to descending)
|
|
11428
11482
|
*/},{key:"postOrgauthorizationTrusteesAudits",value:function postOrgauthorizationTrusteesAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11429
11483
|
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']);}/**
|
|
11484
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
11485
|
+
*
|
|
11486
|
+
* @param {Object} opts Optional parameters
|
|
11487
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
11488
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
11489
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
11490
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
11491
|
+
*/},{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']);}/**
|
|
11430
11492
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
11431
11493
|
*
|
|
11432
11494
|
* @param {Object} opts Optional parameters
|
|
@@ -11509,7 +11571,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11509
11571
|
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(){/**
|
|
11510
11572
|
* Outbound service.
|
|
11511
11573
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11512
|
-
* @version
|
|
11574
|
+
* @version 207.0.0
|
|
11513
11575
|
*//**
|
|
11514
11576
|
* Constructs a new OutboundApi.
|
|
11515
11577
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12266,6 +12328,16 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
12266
12328
|
*/},{key:"postOutboundCampaignCallbackSchedule",value:function postOutboundCampaignCallbackSchedule(campaignId,body){// verify the required parameter 'campaignId' is set
|
|
12267
12329
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';}// verify the required parameter 'body' is set
|
|
12268
12330
|
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']);}/**
|
|
12331
|
+
* Start the campaign
|
|
12332
|
+
*
|
|
12333
|
+
* @param {String} campaignId Campaign ID
|
|
12334
|
+
*/},{key:"postOutboundCampaignStart",value:function postOutboundCampaignStart(campaignId){// verify the required parameter 'campaignId' is set
|
|
12335
|
+
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']);}/**
|
|
12336
|
+
* Stop the campaign
|
|
12337
|
+
*
|
|
12338
|
+
* @param {String} campaignId Campaign ID
|
|
12339
|
+
*/},{key:"postOutboundCampaignStop",value:function postOutboundCampaignStop(campaignId){// verify the required parameter 'campaignId' is set
|
|
12340
|
+
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']);}/**
|
|
12269
12341
|
* Create Campaign Rule
|
|
12270
12342
|
*
|
|
12271
12343
|
* @param {Object} body CampaignRule
|
|
@@ -12418,6 +12490,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12418
12490
|
* @param {Array.<Object>} body import template(s) to add
|
|
12419
12491
|
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
12420
12492
|
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']);}/**
|
|
12493
|
+
* Start the campaign
|
|
12494
|
+
* Documented permissions are applicable based on campaign type.
|
|
12495
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
12496
|
+
*/},{key:"postOutboundMessagingcampaignStart",value:function postOutboundMessagingcampaignStart(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
12497
|
+
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']);}/**
|
|
12498
|
+
* Stop the campaign
|
|
12499
|
+
* Documented permissions are applicable based on campaign type.
|
|
12500
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
12501
|
+
*/},{key:"postOutboundMessagingcampaignStop",value:function postOutboundMessagingcampaignStop(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
12502
|
+
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']);}/**
|
|
12421
12503
|
* Create a Messaging Campaign
|
|
12422
12504
|
*
|
|
12423
12505
|
* @param {Object} body Messaging Campaign
|
|
@@ -12596,7 +12678,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12596
12678
|
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(){/**
|
|
12597
12679
|
* Presence service.
|
|
12598
12680
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12599
|
-
* @version
|
|
12681
|
+
* @version 207.0.0
|
|
12600
12682
|
*//**
|
|
12601
12683
|
* Constructs a new PresenceApi.
|
|
12602
12684
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12769,7 +12851,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12769
12851
|
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(){/**
|
|
12770
12852
|
* ProcessAutomation service.
|
|
12771
12853
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12772
|
-
* @version
|
|
12854
|
+
* @version 207.0.0
|
|
12773
12855
|
*//**
|
|
12774
12856
|
* Constructs a new ProcessAutomationApi.
|
|
12775
12857
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12832,7 +12914,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12832
12914
|
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(){/**
|
|
12833
12915
|
* Quality service.
|
|
12834
12916
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12835
|
-
* @version
|
|
12917
|
+
* @version 207.0.0
|
|
12836
12918
|
*//**
|
|
12837
12919
|
* Constructs a new QualityApi.
|
|
12838
12920
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13309,7 +13391,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13309
13391
|
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(){/**
|
|
13310
13392
|
* Recording service.
|
|
13311
13393
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13312
|
-
* @version
|
|
13394
|
+
* @version 207.0.0
|
|
13313
13395
|
*//**
|
|
13314
13396
|
* Constructs a new RecordingApi.
|
|
13315
13397
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13721,7 +13803,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13721
13803
|
*/},{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(){/**
|
|
13722
13804
|
* ResponseManagement service.
|
|
13723
13805
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13724
|
-
* @version
|
|
13806
|
+
* @version 207.0.0
|
|
13725
13807
|
*//**
|
|
13726
13808
|
* Constructs a new ResponseManagementApi.
|
|
13727
13809
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13842,7 +13924,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13842
13924
|
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(){/**
|
|
13843
13925
|
* Routing service.
|
|
13844
13926
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13845
|
-
* @version
|
|
13927
|
+
* @version 207.0.0
|
|
13846
13928
|
*//**
|
|
13847
13929
|
* Constructs a new RoutingApi.
|
|
13848
13930
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14846,7 +14928,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14846
14928
|
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(){/**
|
|
14847
14929
|
* SCIM service.
|
|
14848
14930
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14849
|
-
* @version
|
|
14931
|
+
* @version 207.0.0
|
|
14850
14932
|
*//**
|
|
14851
14933
|
* Constructs a new SCIMApi.
|
|
14852
14934
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15071,7 +15153,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15071
15153
|
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(){/**
|
|
15072
15154
|
* ScreenRecording service.
|
|
15073
15155
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15074
|
-
* @version
|
|
15156
|
+
* @version 207.0.0
|
|
15075
15157
|
*//**
|
|
15076
15158
|
* Constructs a new ScreenRecordingApi.
|
|
15077
15159
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15086,7 +15168,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15086
15168
|
*/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(){/**
|
|
15087
15169
|
* Scripts service.
|
|
15088
15170
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15089
|
-
* @version
|
|
15171
|
+
* @version 207.0.0
|
|
15090
15172
|
*//**
|
|
15091
15173
|
* Constructs a new ScriptsApi.
|
|
15092
15174
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15222,7 +15304,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15222
15304
|
*/},{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(){/**
|
|
15223
15305
|
* Search service.
|
|
15224
15306
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15225
|
-
* @version
|
|
15307
|
+
* @version 207.0.0
|
|
15226
15308
|
*//**
|
|
15227
15309
|
* Constructs a new SearchApi.
|
|
15228
15310
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15382,7 +15464,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15382
15464
|
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(){/**
|
|
15383
15465
|
* Settings service.
|
|
15384
15466
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15385
|
-
* @version
|
|
15467
|
+
* @version 207.0.0
|
|
15386
15468
|
*//**
|
|
15387
15469
|
* Constructs a new SettingsApi.
|
|
15388
15470
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15432,7 +15514,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
15432
15514
|
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(){/**
|
|
15433
15515
|
* SpeechTextAnalytics service.
|
|
15434
15516
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
15435
|
-
* @version
|
|
15517
|
+
* @version 207.0.0
|
|
15436
15518
|
*//**
|
|
15437
15519
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
15438
15520
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -15731,7 +15813,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15731
15813
|
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(){/**
|
|
15732
15814
|
* Stations service.
|
|
15733
15815
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
15734
|
-
* @version
|
|
15816
|
+
* @version 207.0.0
|
|
15735
15817
|
*//**
|
|
15736
15818
|
* Constructs a new StationsApi.
|
|
15737
15819
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15763,7 +15845,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15763
15845
|
*/},{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(){/**
|
|
15764
15846
|
* Suggest service.
|
|
15765
15847
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15766
|
-
* @version
|
|
15848
|
+
* @version 207.0.0
|
|
15767
15849
|
*//**
|
|
15768
15850
|
* Constructs a new SuggestApi.
|
|
15769
15851
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15803,7 +15885,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15803
15885
|
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(){/**
|
|
15804
15886
|
* TaskManagement service.
|
|
15805
15887
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15806
|
-
* @version
|
|
15888
|
+
* @version 207.0.0
|
|
15807
15889
|
*//**
|
|
15808
15890
|
* Constructs a new TaskManagementApi.
|
|
15809
15891
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -16209,7 +16291,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
16209
16291
|
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(){/**
|
|
16210
16292
|
* Teams service.
|
|
16211
16293
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
16212
|
-
* @version
|
|
16294
|
+
* @version 207.0.0
|
|
16213
16295
|
*//**
|
|
16214
16296
|
* Constructs a new TeamsApi.
|
|
16215
16297
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -16232,8 +16314,10 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
16232
16314
|
* Get team
|
|
16233
16315
|
*
|
|
16234
16316
|
* @param {String} teamId Team ID
|
|
16235
|
-
|
|
16236
|
-
|
|
16317
|
+
* @param {Object} opts Optional parameters
|
|
16318
|
+
* @param {Object} opts.expand Expand the division name
|
|
16319
|
+
*/},{key:"getTeam",value:function getTeam(teamId,opts){opts=opts||{};// verify the required parameter 'teamId' is set
|
|
16320
|
+
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']);}/**
|
|
16237
16321
|
* Get team membership
|
|
16238
16322
|
*
|
|
16239
16323
|
* @param {String} teamId Team ID
|
|
@@ -16287,7 +16371,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16287
16371
|
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(){/**
|
|
16288
16372
|
* Telephony service.
|
|
16289
16373
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
16290
|
-
* @version
|
|
16374
|
+
* @version 207.0.0
|
|
16291
16375
|
*//**
|
|
16292
16376
|
* Constructs a new TelephonyApi.
|
|
16293
16377
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -16334,7 +16418,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
16334
16418
|
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(){/**
|
|
16335
16419
|
* TelephonyProvidersEdge service.
|
|
16336
16420
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
16337
|
-
* @version
|
|
16421
|
+
* @version 207.0.0
|
|
16338
16422
|
*//**
|
|
16339
16423
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
16340
16424
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -17157,7 +17241,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
17157
17241
|
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(){/**
|
|
17158
17242
|
* Textbots service.
|
|
17159
17243
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
17160
|
-
* @version
|
|
17244
|
+
* @version 207.0.0
|
|
17161
17245
|
*//**
|
|
17162
17246
|
* Constructs a new TextbotsApi.
|
|
17163
17247
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -17192,7 +17276,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
17192
17276
|
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(){/**
|
|
17193
17277
|
* Tokens service.
|
|
17194
17278
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
17195
|
-
* @version
|
|
17279
|
+
* @version 207.0.0
|
|
17196
17280
|
*//**
|
|
17197
17281
|
* Constructs a new TokensApi.
|
|
17198
17282
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -17226,7 +17310,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17226
17310
|
*/},{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(){/**
|
|
17227
17311
|
* Uploads service.
|
|
17228
17312
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
17229
|
-
* @version
|
|
17313
|
+
* @version 207.0.0
|
|
17230
17314
|
*//**
|
|
17231
17315
|
* Constructs a new UploadsApi.
|
|
17232
17316
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -17292,7 +17376,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17292
17376
|
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(){/**
|
|
17293
17377
|
* Usage service.
|
|
17294
17378
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
17295
|
-
* @version
|
|
17379
|
+
* @version 207.0.0
|
|
17296
17380
|
*//**
|
|
17297
17381
|
* Constructs a new UsageApi.
|
|
17298
17382
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -17346,7 +17430,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17346
17430
|
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(){/**
|
|
17347
17431
|
* UserRecordings service.
|
|
17348
17432
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
17349
|
-
* @version
|
|
17433
|
+
* @version 207.0.0
|
|
17350
17434
|
*//**
|
|
17351
17435
|
* Constructs a new UserRecordingsApi.
|
|
17352
17436
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -17403,7 +17487,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
17403
17487
|
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(){/**
|
|
17404
17488
|
* Users service.
|
|
17405
17489
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
17406
|
-
* @version
|
|
17490
|
+
* @version 207.0.0
|
|
17407
17491
|
*//**
|
|
17408
17492
|
* Constructs a new UsersApi.
|
|
17409
17493
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -17728,6 +17812,13 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17728
17812
|
* @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.
|
|
17729
17813
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
17730
17814
|
*/},{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']);}/**
|
|
17815
|
+
* Get chats for a user
|
|
17816
|
+
*
|
|
17817
|
+
* @param {Object} opts Optional parameters
|
|
17818
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
17819
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
17820
|
+
* @param {String} opts.after The key to start after
|
|
17821
|
+
*/},{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']);}/**
|
|
17731
17822
|
* Get list of Development Activities
|
|
17732
17823
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
17733
17824
|
* @param {Object} opts Optional parameters
|
|
@@ -18093,7 +18184,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
18093
18184
|
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(){/**
|
|
18094
18185
|
* Utilities service.
|
|
18095
18186
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
18096
|
-
* @version
|
|
18187
|
+
* @version 207.0.0
|
|
18097
18188
|
*//**
|
|
18098
18189
|
* Constructs a new UtilitiesApi.
|
|
18099
18190
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -18120,7 +18211,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18120
18211
|
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(){/**
|
|
18121
18212
|
* Voicemail service.
|
|
18122
18213
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
18123
|
-
* @version
|
|
18214
|
+
* @version 207.0.0
|
|
18124
18215
|
*//**
|
|
18125
18216
|
* Constructs a new VoicemailApi.
|
|
18126
18217
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -18207,6 +18298,19 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
18207
18298
|
* @param {Array.<String>} opts.expand expand
|
|
18208
18299
|
*/},{key:"getVoicemailSearch",value:function getVoicemailSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
18209
18300
|
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']);}/**
|
|
18301
|
+
* Get a user's mailbox information
|
|
18302
|
+
*
|
|
18303
|
+
* @param {String} userId userId
|
|
18304
|
+
*/},{key:"getVoicemailUserMailbox",value:function getVoicemailUserMailbox(userId){// verify the required parameter 'userId' is set
|
|
18305
|
+
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']);}/**
|
|
18306
|
+
* List voicemail messages
|
|
18307
|
+
*
|
|
18308
|
+
* @param {String} userId User ID
|
|
18309
|
+
* @param {Object} opts Optional parameters
|
|
18310
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18311
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18312
|
+
*/},{key:"getVoicemailUserMessages",value:function getVoicemailUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
18313
|
+
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']);}/**
|
|
18210
18314
|
* Get a user's voicemail policy
|
|
18211
18315
|
*
|
|
18212
18316
|
* @param {String} userId User ID
|
|
@@ -18269,7 +18373,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18269
18373
|
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(){/**
|
|
18270
18374
|
* WebChat service.
|
|
18271
18375
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
18272
|
-
* @version
|
|
18376
|
+
* @version 207.0.0
|
|
18273
18377
|
*//**
|
|
18274
18378
|
* Constructs a new WebChatApi.
|
|
18275
18379
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -18404,7 +18508,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18404
18508
|
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(){/**
|
|
18405
18509
|
* WebDeployments service.
|
|
18406
18510
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
18407
|
-
* @version
|
|
18511
|
+
* @version 207.0.0
|
|
18408
18512
|
*//**
|
|
18409
18513
|
* Constructs a new WebDeploymentsApi.
|
|
18410
18514
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -18525,7 +18629,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18525
18629
|
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(){/**
|
|
18526
18630
|
* WebMessaging service.
|
|
18527
18631
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
18528
|
-
* @version
|
|
18632
|
+
* @version 207.0.0
|
|
18529
18633
|
*//**
|
|
18530
18634
|
* Constructs a new WebMessagingApi.
|
|
18531
18635
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -18541,7 +18645,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
18541
18645
|
*/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(){/**
|
|
18542
18646
|
* Widgets service.
|
|
18543
18647
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
18544
|
-
* @version
|
|
18648
|
+
* @version 207.0.0
|
|
18545
18649
|
*//**
|
|
18546
18650
|
* Constructs a new WidgetsApi.
|
|
18547
18651
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -18576,7 +18680,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18576
18680
|
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(){/**
|
|
18577
18681
|
* WorkforceManagement service.
|
|
18578
18682
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
18579
|
-
* @version
|
|
18683
|
+
* @version 207.0.0
|
|
18580
18684
|
*//**
|
|
18581
18685
|
* Constructs a new WorkforceManagementApi.
|
|
18582
18686
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -20357,7 +20461,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
20357
20461
|
* </pre>
|
|
20358
20462
|
* </p>
|
|
20359
20463
|
* @module purecloud-platform-client-v2/index
|
|
20360
|
-
* @version
|
|
20464
|
+
* @version 207.0.0
|
|
20361
20465
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
20362
20466
|
* The ApiClient constructor.
|
|
20363
20467
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|