com.docusign.esign.client

Class ApiClient

java.lang.Object

com.docusign.esign.client.ApiClient

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-14T16:41:01.888-08:00")
public class ApiClient
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiClient()

Method Summary

Methods

Modifier and Type	Method and Description
ApiClient	addDefaultHeader(String key, String value) Add a default header.
<T> T	deserialize(com.sun.jersey.api.client.ClientResponse response, TypeRef returnType) Deserialize response body to Java object according to the Content-Type.
String	escapeString(String str) Escape the given string to be used as URL query value.
String	formatDate(Date date) Format the given Date object into string.
Authentication	getAuthentication(String authName) Get authentication for the given name.
Map<String,Authentication>	getAuthentications() Get authentications (key: authentication name, value: authentication).
String	getBasePath()
DateFormat	getDateFormat() Get the date format used to parse/format date parameters.
JSON	getJSON() Gets the JSON instance to do JSON serialization and deserialization.
Map<String,List<String>>	getResponseHeaders() Gets the response headers of the previous request
int	getStatusCode() Gets the status code of the previous request
<T> T	invokeAPI(String path, String method, List<Pair> queryParams, Object body, byte[] binaryBody, Map<String,String> headerParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, TypeRef returnType) Invoke API by sending HTTP request with the given options.
byte[]	invokeBinaryAPI(String path, String method, List<Pair> queryParams, Object body, byte[] binaryBody, Map<String,String> headerParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames) Invoke API by sending HTTP request with the given options - return binary result
boolean	isDebugging() Check that whether debugging is enabled for this API client.
List<Pair>	parameterToPairs(String collectionFormat, String name, Object value)
String	parameterToString(Object param) Format the given parameter object into string.
Date	parseDate(String str) Parse the given string into Date object.
String	selectHeaderAccept(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(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	serialize(Object obj, String contentType) Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).
void	setAccessToken(String accessToken) Helper method to set access token for the first OAuth2 authentication.
void	setApiKey(String apiKey) Helper method to set API key value for the first API key authentication.
void	setApiKeyPrefix(String apiKeyPrefix) Helper method to set API key prefix for the first API key authentication.
ApiClient	setBasePath(String basePath)
ApiClient	setDateFormat(DateFormat dateFormat) Set the date format used to parse/format date parameters.
ApiClient	setDebugging(boolean debugging) Enable/disable debugging for this API client.
void	setPassword(String password) Helper method to set password for the first HTTP basic authentication.
ApiClient	setUserAgent(String userAgent) Set the User-Agent header's value (by adding to the default header map).
void	setUsername(String username) Helper method to set username for the first HTTP basic authentication.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiClient

public ApiClient()

Method Detail

getJSON

public JSON getJSON()

Gets the JSON instance to do JSON serialization and deserialization.

getBasePath

public String getBasePath()

setBasePath

public ApiClient setBasePath(String basePath)

getStatusCode

public int getStatusCode()

Gets the status code of the previous request

getResponseHeaders

public Map<String,List<String>> getResponseHeaders()

Gets the response headers of the previous request

getAuthentications

public Map<String,Authentication> getAuthentications()

Get authentications (key: authentication name, value: authentication).

getAuthentication

public Authentication getAuthentication(String authName)

Get authentication for the given name.

Parameters:

authName - The authentication name

Returns:

The authentication, null if not found

setUsername

public void setUsername(String username)

Helper method to set username for the first HTTP basic authentication.

setPassword

public void setPassword(String password)

Helper method to set password for the first HTTP basic authentication.

setApiKey

public void setApiKey(String apiKey)

Helper method to set API key value for the first API key authentication.

setApiKeyPrefix

public void setApiKeyPrefix(String apiKeyPrefix)

Helper method to set API key prefix for the first API key authentication.

setAccessToken

public void setAccessToken(String accessToken)

Helper method to set access token for the first OAuth2 authentication.

setUserAgent

public ApiClient setUserAgent(String userAgent)

Set the User-Agent header's value (by adding to the default header map).

addDefaultHeader

public ApiClient addDefaultHeader(String key,
                         String value)

Add a default header.

Parameters:

key - The header's key

value - The header's value

isDebugging

public boolean isDebugging()

Check that whether debugging is enabled for this API client.

setDebugging

public ApiClient setDebugging(boolean debugging)

Enable/disable debugging for this API client.

Parameters:

debugging - To enable (true) or disable (false) debugging

getDateFormat

public DateFormat getDateFormat()

Get the date format used to parse/format date parameters.

setDateFormat

public ApiClient setDateFormat(DateFormat dateFormat)

Set the date format used to parse/format date parameters.

parseDate

public Date parseDate(String str)

Parse the given string into Date object.

formatDate

public String formatDate(Date date)

Format the given Date object into string.

parameterToString

public String parameterToString(Object param)

Format the given parameter object into string.

parameterToPairs

public List<Pair> parameterToPairs(String collectionFormat,
                          String name,
                          Object value)

selectHeaderAccept

public String selectHeaderAccept(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

public String selectHeaderContentType(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, JSON will be used.

escapeString

public String escapeString(String str)

Escape the given string to be used as URL query value.

serialize

public String serialize(Object obj,
               String contentType)
                 throws ApiException

Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).

Throws:

ApiException

deserialize

public <T> T deserialize(com.sun.jersey.api.client.ClientResponse response,
                TypeRef returnType)
              throws ApiException

Deserialize response body to Java object according to the Content-Type.

Throws:

ApiException

invokeAPI

public <T> T invokeAPI(String path,
              String method,
              List<Pair> queryParams,
              Object body,
              byte[] binaryBody,
              Map<String,String> headerParams,
              Map<String,Object> formParams,
              String accept,
              String contentType,
              String[] authNames,
              TypeRef returnType)
            throws ApiException

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

body - The request body object - if it is not binary, otherwise null

binaryBody - The request body object - if it is binary, otherwise null

headerParams - The header parameters

formParams - The form parameters

accept - The request's Accept header

contentType - The request's Content-Type header

authNames - The authentications to apply

Returns:

The response body in type of string

Throws:

ApiException

invokeBinaryAPI

public byte[] invokeBinaryAPI(String path,
                     String method,
                     List<Pair> queryParams,
                     Object body,
                     byte[] binaryBody,
                     Map<String,String> headerParams,
                     Map<String,Object> formParams,
                     String accept,
                     String contentType,
                     String[] authNames)
                       throws ApiException

Invoke API by sending HTTP request with the given options - return binary result

Parameters:

path - The sub-path of the HTTP URL

method - The request method, one of "GET", "POST", "PUT", and "DELETE"

queryParams - The query parameters

body - The request body object - if it is not binary, otherwise null

binaryBody - The request body object - if it is binary, otherwise null

headerParams - The header parameters

formParams - The form parameters

accept - The request's Accept header

contentType - The request's Content-Type header

authNames - The authentications to apply

Returns:

The response body in type of string

Throws:

ApiException