All Implemented Interfaces:

@Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") 
public class ApiClient
extends JavaTimeFormatter

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public String`	`basePath`
`public CloseableHttpClient`	`httpClient`
`public ObjectMapper`	`objectMapper`
`public Map<String, Authentication>`	`authentications`
`public int`	`statusCode`
`public Map<String, List<String>>`	`responseHeaders`
`public DateFormat`	`dateFormat`

Constructor Summary

Constructors
Constructor	Description
`ApiClient(CloseableHttpClient httpClient)`
`ApiClient()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getBasePath()`
`ApiClient`	`setBasePath(String basePath)`	Sets the base path.
`CloseableHttpClient`	`getHttpClient()`
`ApiClient`	`setHttpClient(CloseableHttpClient httpClient)`	Sets the HTTP client.
`ObjectMapper`	`getObjectMapper()`	Returns the current object mapper used for JSON serialization/deserialization.
`ApiClient`	`setObjectMapper(ObjectMapper objectMapper)`	Sets the object mapper.
`Map<String, Authentication>`	`getAuthentications()`	Get authentications (key: authentication name, value: authentication).
`int`	`getStatusCode()`	Gets the status code of the previous request
`Map<String, List<String>>`	`getResponseHeaders()`	Gets the response headers of the previous request
`DateFormat`	`getDateFormat()`	Get the date format used to parse/format date parameters.
`ApiClient`	`setDateFormat(DateFormat dateFormat)`	Set the date format used to parse/format date parameters.
`static DateFormat`	`buildDefaultDateFormat()`
`List<ServerConfiguration>`	`getServers()`
`ApiClient`	`setServers(List<ServerConfiguration> servers)`	Sets the server.
`Integer`	`getServerIndex()`
`ApiClient`	`setServerIndex(Integer serverIndex)`	Sets the server index.
`Map<String, String>`	`getServerVariables()`
`ApiClient`	`setServerVariables(Map<String, String> serverVariables)`	Sets the server variables.
`Authentication`	`getAuthentication(String authName)`	Get authentication for the given name.
`String`	`getTempFolderPath()`	The path of temporary folder used to store downloaded files from endpoints with file response.
`ApiClient`	`setApiKey(String apiKey)`	Helper method to set API key value for the first API key authentication.
`ApiClient`	`setApiKeyPrefix(String apiKeyPrefix)`	Helper method to set API key prefix for the first API key authentication.
`ApiClient`	`setUserAgent(String userAgent)`	Set the User-Agent header's value (by adding to the default header map).
`ApiClient`	`setTempFolderPath(String tempFolderPath)`	Set temp folder path
`ApiClient`	`addDefaultHeader(String key, String value)`	Add a default header.
`ApiClient`	`addDefaultCookie(String key, String value)`	Add a default cookie.
`boolean`	`isDebugging()`	Check that whether debugging is enabled for this API client.
`int`	`getConnectTimeout()`	Connect timeout (in milliseconds).
`ApiClient`	`setConnectTimeout(int connectionTimeout)`	Set the connect timeout (in milliseconds).
`Date`	`parseDate(String str)`	Parse the given string into Date object.
`String`	`formatDate(Date date)`	Format the given Date object into string.
`String`	`parameterToString(Object param)`	Format the given parameter object into string.
`List<Pair>`	`parameterToPair(String name, Object value)`	Formats the specified query parameter to a list containing a single `Pair` object.
`List<Pair>`	`parameterToPairs(String collectionFormat, String name, Collection value)`	Formats the specified collection query parameters to a list of `Pair` objects.
`boolean`	`isJsonMime(String mime)`	Check if the given MIME is a JSON MIME.
`String`	`selectHeaderAccept(Array<String> accepts)`	Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
`String`	`selectHeaderContentType(Array<String> contentTypes)`	Select the Content-Type header's value from the given array: if JSON exists in the given array, use it; otherwise use the first one of the array.
`String`	`escapeString(String str)`	Escape the given string to be used as URL query value.
`HttpEntity`	`serialize(Object obj, Map<String, Object> formParams, ContentType contentType)`	Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).
`<T> T`	`deserialize(CloseableHttpResponse response, TypeReference<T> valueType)`	Deserialize response body to Java object according to the Content-Type.
`<T> T`	`invokeAPI(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, String urlQueryDeepObject, Object body, Map<String, String> headerParams, Map<String, String> cookieParams, Map<String, Object> formParams, String accept, String contentType, Array<String> authNames, TypeReference<T> returnType)`	Invoke API by sending HTTP request with the given options.
`ApiClient`	`setDebugging(boolean debugging)`	Enable/disable debugging for this API client.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApiClient
```
ApiClient(CloseableHttpClient httpClient)
```
  - ApiClient
```
ApiClient()
```
- Method Detail
  - getBasePath
```
 String getBasePath()
```
  - setBasePath
```
 ApiClient setBasePath(String basePath)
```
    Sets the base path.
    
    Parameters:
    
    basePath - base path
    
    Returns:
    
    API client
  - getHttpClient
```
 CloseableHttpClient getHttpClient()
```
  - setHttpClient
```
 ApiClient setHttpClient(CloseableHttpClient httpClient)
```
    Sets the HTTP client.
    
    Parameters:
    
    httpClient - HTTP client
    
    Returns:
    
    API client
  - getObjectMapper
```
 ObjectMapper getObjectMapper()
```
    Returns the current object mapper used for JSON serialization/deserialization.
    Note: If you make changes to the object mapper, remember to set it back via setObjectMapper in order to trigger HTTP client rebuilding.
    
    Returns:
    
    Object mapper
  - setObjectMapper
```
 ApiClient setObjectMapper(ObjectMapper objectMapper)
```
    Sets the object mapper.
    
    Parameters:
    
    objectMapper - object mapper
    
    Returns:
    
    API client
  - getAuthentications
```
 Map<String, Authentication> getAuthentications()
```
    Get authentications (key: authentication name, value: authentication).
    
    Returns:
    
    Map of authentication
  - getStatusCode
```
 int getStatusCode()
```
    Gets the status code of the previous request
    
    Returns:
    
    Status code
  - getResponseHeaders
```
 Map<String, List<String>> getResponseHeaders()
```
    Gets the response headers of the previous request
    
    Returns:
    
    Response headers
  - getDateFormat
```
 DateFormat getDateFormat()
```
    Get the date format used to parse/format date parameters.
    
    Returns:
    
    Date format
  - setDateFormat
```
 ApiClient setDateFormat(DateFormat dateFormat)
```
    Set the date format used to parse/format date parameters.
    
    Parameters:
    
    dateFormat - Date format
    
    Returns:
    
    API client
  - buildDefaultDateFormat
```
 static DateFormat buildDefaultDateFormat()
```
  - getServers
```
 List<ServerConfiguration> getServers()
```
  - setServers
```
 ApiClient setServers(List<ServerConfiguration> servers)
```
    Sets the server.
    
    Parameters:
    
    servers - a list of server configuration
    
    Returns:
    
    API client
  - getServerIndex
```
 Integer getServerIndex()
```
  - setServerIndex
```
 ApiClient setServerIndex(Integer serverIndex)
```
    Sets the server index.
    
    Parameters:
    
    serverIndex - server index
    
    Returns:
    
    API client
  - getServerVariables
```
 Map<String, String> getServerVariables()
```
  - setServerVariables
```
 ApiClient setServerVariables(Map<String, String> serverVariables)
```
    Sets the server variables.
    
    Parameters:
    
    serverVariables - server variables
    
    Returns:
    
    API client
  - getAuthentication
```
 Authentication getAuthentication(String authName)
```
    Get authentication for the given name.
    
    Parameters:
    
    authName - The authentication name
    
    Returns:
    
    The authentication, null if not found
  - getTempFolderPath
```
 String getTempFolderPath()
```
    The path of temporary folder used to store downloaded files from endpoints with file response. The default value is null, i.e. using the system's default temporary folder.
    
    Returns:
    
    Temp folder path
  - setApiKey
```
 ApiClient setApiKey(String apiKey)
```
    Helper method to set API key value for the first API key authentication.
    
    Parameters:
    
    apiKey - the API key
    
    Returns:
    
    API client
  - setApiKeyPrefix
```
 ApiClient setApiKeyPrefix(String apiKeyPrefix)
```
    Helper method to set API key prefix for the first API key authentication.
    
    Parameters:
    
    apiKeyPrefix - API key prefix
    
    Returns:
    
    API client
  - setUserAgent
```
 ApiClient setUserAgent(String userAgent)
```
    Set the User-Agent header's value (by adding to the default header map).
    
    Parameters:
    
    userAgent - User agent
    
    Returns:
    
    API client
  - setTempFolderPath
```
 ApiClient setTempFolderPath(String tempFolderPath)
```
    Set temp folder path
    
    Parameters:
    
    tempFolderPath - Temp folder path
    
    Returns:
    
    API client
  - addDefaultHeader
```
 ApiClient addDefaultHeader(String key, String value)
```
    Add a default header.
    
    Parameters:
    
    key - The header's key
    
    value - The header's value
    
    Returns:
    
    API client
  - addDefaultCookie
```
 ApiClient addDefaultCookie(String key, String value)
```
    Add a default cookie.
    
    Parameters:
    
    key - The cookie's key
    
    value - The cookie's value
    
    Returns:
    
    API client
  - isDebugging
```
 boolean isDebugging()
```
    Check that whether debugging is enabled for this API client.
    
    Returns:
    
    True if debugging is on
  - getConnectTimeout
```
 int getConnectTimeout()
```
    Connect timeout (in milliseconds).
    
    Returns:
    
    Connection timeout
  - setConnectTimeout
```
 ApiClient setConnectTimeout(int connectionTimeout)
```
    Set the connect timeout (in milliseconds). A value of 0 means no timeout, otherwise values must be between 1 and MAX_VALUE.
    
    Parameters:
    
    connectionTimeout - Connection timeout in milliseconds
    
    Returns:
    
    API client
  - parseDate
```
 Date parseDate(String str)
```
    Parse the given string into Date object.
    
    Parameters:
    
    str - String
    
    Returns:
    
    Date
  - formatDate
```
 String formatDate(Date date)
```
    Format the given Date object into string.
    
    Parameters:
    
    date - Date
    
    Returns:
    
    Date in string format
  - parameterToString
```
 String parameterToString(Object param)
```
    Format the given parameter object into string.
    
    Parameters:
    
    param - Object
    
    Returns:
    
    Object in string format
  - parameterToPair
```
 List<Pair> parameterToPair(String name, Object value)
```
    Formats the specified query parameter to a list containing a single Pair object. Note that value must not be a collection.
    
    Parameters:
    
    name - The name of the parameter.
    
    value - The value of the parameter.
    
    Returns:
    
    A list containing a single Pair object.
  - parameterToPairs
```
 List<Pair> parameterToPairs(String collectionFormat, String name, Collection value)
```
    Formats the specified collection query parameters to a list of Pair objects. Note that the values of each of the returned Pair objects are percent-encoded.
    
    Parameters:
    
    collectionFormat - The collection format of the parameter.
    
    name - The name of the parameter.
    
    value - The value of the parameter.
    
    Returns:
    
    A list of Pair objects.
  - isJsonMime
```
 boolean isJsonMime(String mime)
```
    Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
    
    Parameters:
    
    mime - MIME
    
    Returns:
    
    True if MIME type is boolean
  - selectHeaderAccept
```
 String selectHeaderAccept(Array<String> accepts)
```
    Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
    
    Parameters:
    
    accepts - The accepts array to select from
    
    Returns:
    
    The Accept header to use. If the given array is empty, null will be returned (not to set the Accept header explicitly).
  - selectHeaderContentType
```
 String selectHeaderContentType(Array<String> contentTypes)
```
    Select the Content-Type header's value from the given array: if JSON exists in the given array, use it; otherwise use the first one of the array.
    
    Parameters:
    
    contentTypes - The Content-Type array to select from
    
    Returns:
    
    The Content-Type header to use. If the given array is empty, or matches "any", JSON will be used.
  - escapeString
```
 String escapeString(String str)
```
    Escape the given string to be used as URL query value.
    
    Parameters:
    
    str - String
    
    Returns:
    
    Escaped string
  - serialize
```
 HttpEntity serialize(Object obj, Map<String, Object> formParams, ContentType contentType)
```
    Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).
    
    Parameters:
    
    obj - Object
    
    formParams - Form parameters
    
    contentType - Content type
    
    Returns:
    
    Object
  - deserialize
```
 <T> T deserialize(CloseableHttpResponse response, TypeReference<T> valueType)
```
    Deserialize response body to Java object according to the Content-Type.
    
    Parameters:
    
    response - Response
    
    valueType - Return type
    
    Returns:
    
    Deserialized object
  - invokeAPI
```
 <T> T invokeAPI(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, String urlQueryDeepObject, Object body, Map<String, String> headerParams, Map<String, String> cookieParams, Map<String, Object> formParams, String accept, String contentType, Array<String> authNames, TypeReference<T> returnType)
```
    Invoke API by sending HTTP request with the given options.
    
    Parameters:
    
    path - The sub-path of the HTTP URL
    
    method - The request method, one of "GET", "POST", "PUT", and "DELETE"
    
    queryParams - The query parameters
    
    collectionQueryParams - The collection query parameters
    
    urlQueryDeepObject - A URL query string for deep object parameters
    
    body - The request body object - if it is not binary, otherwise null
    
    headerParams - The header parameters
    
    cookieParams - The cookie parameters
    
    formParams - The form parameters
    
    accept - The request's Accept header
    
    contentType - The request's Content-Type header
    
    authNames - The authentications to apply
    
    returnType - Return type
    
    Returns:
    
    The response body in type of string
  - setDebugging
```
 ApiClient setDebugging(boolean debugging)
```
    Enable/disable debugging for this API client.
    
    Parameters:
    
    debugging - To enable (true) or disable (false) debugging
    
    Returns:
    
    API client

Class ApiClient

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiClient

ApiClient

Method Detail

getBasePath

setBasePath

getHttpClient

setHttpClient

getObjectMapper

setObjectMapper

getAuthentications

getStatusCode

getResponseHeaders

getDateFormat

setDateFormat

buildDefaultDateFormat

getServers

setServers

getServerIndex

setServerIndex

getServerVariables

setServerVariables

getAuthentication

getTempFolderPath

setApiKey

setApiKeyPrefix

setUserAgent

setTempFolderPath

addDefaultHeader

addDefaultCookie

isDebugging

getConnectTimeout

setConnectTimeout

parseDate

formatDate

parameterToString

parameterToPair

parameterToPairs

isJsonMime

selectHeaderAccept

selectHeaderContentType

escapeString

serialize

deserialize

invokeAPI

setDebugging