ApiClient (docusign-esign-java 2.9.0-beta-1 API)

java.lang.Object
- com.docusign.esign.client.ApiClient

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-03-06T16:42:36.211-08:00")
public class ApiClient
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEMO_REST_BASEPATH` sandbox/demo base path
`static String`	`PRODUCTION_REST_BASEPATH` live/production base path
`static String`	`STAGE_REST_BASEPATH` stage base path

Constructor Summary

Constructors
Constructor and Description
`ApiClient()`
`ApiClient(String basePath)`
`ApiClient(String oAuthBasePath, String authName)` Basic constructor for single auth name
`ApiClient(String oAuthBasePath, String[] authNames)`
`ApiClient(String oAuthBasePath, String authName, String clientId, String secret)` Helper constructor for OAuth2

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAuthorization(String authName, Authentication auth)`
`ApiClient`	`addDefaultHeader(String key, String value)` Add a default header.
`void`	`configureAuthorizationFlow(String clientId, String clientSecret, String redirectURI)` Helper method to configure the OAuth accessCode/implicit flow parameters
`void`	`configureJWTAuthorizationFlow(String publicKeyFilename, String privateKeyFilename, String oAuthBasePath, String clientId, String userId, long expiresIn)` Deprecated. As of release 2.7.0, replaced by `#requestJWTUserToken()` and `#requestJWTApplicationToken()`
`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.
`OAuth.OAuthToken`	`generateAccessToken(String clientId, String clientSecret, String code)`
`String`	`getAccessToken()`
`Authentication`	`getAuthentication(String authName)` Get authentication for the given name.
`Map<String,Authentication>`	`getAuthentications()` Get authentications (key: authentication name, value: authentication).
`org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder`	`getAuthorizationEndPoint()` Helper method to configure authorization endpoint of the first oauth found in the authentications (there should be only one)
`String`	`getAuthorizationUri()`
`URI`	`getAuthorizationUri(String clientId, List<String> scopes, String redirectUri, String responseType)` Helper method to configure the OAuth accessCode/implicit flow parameters
`URI`	`getAuthorizationUri(String clientId, List<String> scopes, String redirectUri, String responseType, String state)` Helper method to configure the OAuth accessCode/implicit flow parameters
`String`	`getBasePath()`
`int`	`getConnectTimeout()` Connect timeout (in milliseconds).
`DateFormat`	`getDateFormat()` Get the date format used to parse/format date parameters.
`String`	`getJWTUri(String clientId, String redirectURI, String oAuthBasePath)` Helper method to build the OAuth JWT grant uri (used once to get a user consent for impersonation)
`int`	`getReadTimeout()` Read timeout (in milliseconds).
`Map<String,List<String>>`	`getResponseHeaders()` Gets the response headers of the previous request
`int`	`getStatusCode()` Gets the status code of the previous request
`org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder`	`getTokenEndPoint()` Helper method to configure the token endpoint of the first oauth found in the authentications (there should be only one)
`OAuth.UserInfo`	`getUserInfo(String accessToken)`
`<T> T`	`invokeAPI(String path, String method, List<Pair> queryParams, Object body, Map<String,String> headerParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, com.sun.jersey.api.client.GenericType<T> returnType)` Invoke API by sending HTTP request with the given options.
`boolean`	`isDebugging()` Check that whether debugging is enabled for this API client.
`boolean`	`isJsonMime(String mime)` Check if the given MIME is a JSON MIME.
`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.
`void`	`registerAccessTokenListener(AccessTokenListener accessTokenListener)` Configures a listener which is notified when a new access token is received.
`OAuth.OAuthToken`	`requestJWTApplicationToken(String clientId, List<String> scopes, byte[] rsaPrivateKey, long expiresIn)` RESERVED FOR PARTNERS Request JWT Application Token Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
`OAuth.OAuthToken`	`requestJWTUserToken(String clientId, String userId, List<String> scopes, byte[] rsaPrivateKey, long expiresIn)` Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
`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.
`Object`	`serialize(Object obj, String contentType, Map<String,Object> formParams)` Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).
`void`	`setAccessToken(String accessToken, Long expiresIn)` Helper method to preset the OAuth access token of the first OAuth found in the apiAuthorizations (there should be only one)
`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`	`setConnectTimeout(int connectionTimeout)` Set the connect timeout (in milliseconds).
`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.
`ApiClient`	`setOAuthBasePath(String oAuthBasePath)` Sets the OAuth base path.
`void`	`setPassword(String password)` Helper method to set password for the first HTTP basic authentication.
`ApiClient`	`setReadTimeout(int readTimeout)` Set the read timeout (in milliseconds).
`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.
`void`	`updateAccessToken()`

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

- Field Detail
  - PRODUCTION_REST_BASEPATH
```
public static final String PRODUCTION_REST_BASEPATH
```
    live/production base path
    
    See Also:
    Constant Field Values
  - DEMO_REST_BASEPATH
```
public static final String DEMO_REST_BASEPATH
```
    sandbox/demo base path
    
    See Also:
    Constant Field Values
  - STAGE_REST_BASEPATH
```
public static final String STAGE_REST_BASEPATH
```
    stage base path
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ApiClient
```
public ApiClient()
```
  - ApiClient
```
public ApiClient(String basePath)
```
  - ApiClient
```
public ApiClient(String oAuthBasePath,
         String[] authNames)
```
  - ApiClient
```
public ApiClient(String oAuthBasePath,
         String authName)
```
    Basic constructor for single auth name
    
    Parameters:
    authName -
  - ApiClient
```
public ApiClient(String oAuthBasePath,
         String authName,
         String clientId,
         String secret)
```
    Helper constructor for OAuth2
    
    Parameters:
    oAuthBasePath - The API base path
    authName - the authentication method name ("oauth" or "api_key")
    clientId - OAuth2 Client ID
    secret - OAuth2 Client secret
- Method Detail
  - 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
  - addAuthorization
```
public void addAuthorization(String authName,
                    Authentication auth)
```
  - 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.
  - setUserAgent
```
public ApiClient setUserAgent(String userAgent)
```
    Set the User-Agent header's value (by adding to the default header map).
  - updateAccessToken
```
public void updateAccessToken()
```
  - setAccessToken
```
public void setAccessToken(String accessToken,
                  Long expiresIn)
```
    Helper method to preset the OAuth access token of the first OAuth found in the apiAuthorizations (there should be only one)
    
    Parameters:
    accessToken - OAuth access token
    expiresIn - Validity period of the access token in seconds
  - getAccessToken
```
public String getAccessToken()
```
  - 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
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Connect timeout (in milliseconds).
  - setConnectTimeout
```
public ApiClient setConnectTimeout(int connectionTimeout)
```
    Set the connect timeout (in milliseconds). A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE.
  - getReadTimeout
```
public int getReadTimeout()
```
    Read timeout (in milliseconds).
  - setReadTimeout
```
public ApiClient setReadTimeout(int readTimeout)
```
    Set the read timeout (in milliseconds). A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE.
  - 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.
  - getTokenEndPoint
```
public org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder getTokenEndPoint()
```
    Helper method to configure the token endpoint of the first oauth found in the authentications (there should be only one)
    
    Returns:
  - getAuthorizationEndPoint
```
public org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder getAuthorizationEndPoint()
```
    Helper method to configure authorization endpoint of the first oauth found in the authentications (there should be only one)
    
    Returns:
  - configureAuthorizationFlow
```
public void configureAuthorizationFlow(String clientId,
                              String clientSecret,
                              String redirectURI)
```
    Helper method to configure the OAuth accessCode/implicit flow parameters
    
    Parameters:
    clientId - OAuth2 client ID
    clientSecret - OAuth2 client secret
    redirectURI - OAuth2 redirect uri
  - getAuthorizationUri
```
public String getAuthorizationUri()
                           throws org.apache.oltu.oauth2.common.exception.OAuthSystemException
```
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException
  - getAuthorizationUri
```
public URI getAuthorizationUri(String clientId,
                      List<String> scopes,
                      String redirectUri,
                      String responseType,
                      String state)
                        throws IllegalArgumentException,
                               javax.ws.rs.core.UriBuilderException
```
    Helper method to configure the OAuth accessCode/implicit flow parameters
    
    Parameters:
    clientId - OAuth2 client ID: Identifies the client making the request. Client applications may be scoped to a limited set of system access.
    scopes - the list of requested scopes. Values include OAuth.Scope_SIGNATURE, OAuth.Scope_EXTENDED, OAuth.Scope_IMPERSONATION. You can also pass any advanced scope.
    redirectUri - this determines where to deliver the response containing the authorization code or access token.
    responseType - determines the response type of the authorization request.
    Note: these response types are mutually exclusive for a client application. A public/native client application may only request a response type of "token"; a private/trusted client application may only request a response type of "code".
    state - Allows for arbitrary state that may be useful to your application. The value in this parameter will be round-tripped along with the response so you can make sure it didn't change.
    
    Throws:
    
    IllegalArgumentException
    
    javax.ws.rs.core.UriBuilderException
  - getAuthorizationUri
```
public URI getAuthorizationUri(String clientId,
                      List<String> scopes,
                      String redirectUri,
                      String responseType)
                        throws IllegalArgumentException,
                               javax.ws.rs.core.UriBuilderException
```
    Helper method to configure the OAuth accessCode/implicit flow parameters
    
    Parameters:
    clientId - OAuth2 client ID: Identifies the client making the request. Client applications may be scoped to a limited set of system access.
    scopes - the list of requested scopes. Values include OAuth.Scope_SIGNATURE, OAuth.Scope_EXTENDED, OAuth.Scope_IMPERSONATION. You can also pass any advanced scope.
    redirectUri - this determines where to deliver the response containing the authorization code or access token.
    responseType - determines the response type of the authorization request.
    Note: these response types are mutually exclusive for a client application. A public/native client application may only request a response type of "token"; a private/trusted client application may only request a response type of "code".
    
    Throws:
    
    IllegalArgumentException
    
    javax.ws.rs.core.UriBuilderException
  - setOAuthBasePath
```
public ApiClient setOAuthBasePath(String oAuthBasePath)
```
    Sets the OAuth base path. Values include OAuth#PRODUCTION_BASEPATH, OAuth#DEMO_BASEPATH and custom (e.g. "account-s.docusign.com")
    
    Parameters:
    oAuthBasePath - the new value for the OAuth base path
    
    Returns:
    this instance of the ApiClient updated with the new OAuth base path
  - generateAccessToken
```
public OAuth.OAuthToken generateAccessToken(String clientId,
                                   String clientSecret,
                                   String code)
                                     throws ApiException,
                                            IOException
```
    Parameters:
    clientId - OAuth2 client ID: Identifies the client making the request. Client applications may be scoped to a limited set of system access.
    clientSecret - the secret key you generated when you set up the integration in DocuSign Admin console.
    code - The authorization code that you received from the getAuthorizationUri callback.
    
    Returns:
    OAuth.OAuthToken object.
    
    Throws:
    
    ApiException - if the HTTP call status is different than 2xx.
    
    IOException - if there is a problem while parsing the reponse object.
    See Also:
    OAuth.OAuthToken
  - getUserInfo
```
public OAuth.UserInfo getUserInfo(String accessToken)
                           throws IllegalArgumentException,
                                  ApiException
```
    Parameters:
    accessToken - the bearer token to use to authenticate for this call.
    
    Returns:
    OAuth UserInfo model
    
    Throws:
    
    ApiException - if the HTTP call status is different than 2xx.
    
    IllegalArgumentException
    See Also:
    OAuth.UserInfo
  - registerAccessTokenListener
```
public void registerAccessTokenListener(AccessTokenListener accessTokenListener)
```
    Configures a listener which is notified when a new access token is received.
    
    Parameters:
    accessTokenListener -
  - getJWTUri
```
public String getJWTUri(String clientId,
               String redirectURI,
               String oAuthBasePath)
```
    Helper method to build the OAuth JWT grant uri (used once to get a user consent for impersonation)
    
    Parameters:
    clientId - OAuth2 client ID
    redirectURI - OAuth2 redirect uri
    
    Returns:
    the OAuth JWT grant uri as a String
  - configureJWTAuthorizationFlow
```
@Deprecated
public void configureJWTAuthorizationFlow(String publicKeyFilename,
                                            String privateKeyFilename,
                                            String oAuthBasePath,
                                            String clientId,
                                            String userId,
                                            long expiresIn)
                                   throws IOException,
                                          ApiException
```
    Deprecated. As of release 2.7.0, replaced by #requestJWTUserToken() and #requestJWTApplicationToken()
    
    Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
    
    Parameters:
    publicKeyFilename - the filename of the RSA public key
    privateKeyFilename - the filename of the RSA private key
    oAuthBasePath - DocuSign OAuth base path (account-d.docusign.com for the developer sandbox and account.docusign.com for the production platform)
    clientId - DocuSign OAuth Client Id (AKA Integrator Key)
    userId - DocuSign user Id to be impersonated (This is a UUID)
    expiresIn - number of seconds remaining before the JWT assertion is considered as invalid
    
    Throws:
    
    IOException - if there is an issue with either the public or private file
    
    ApiException - if there is an error while exchanging the JWT with an access token
  - requestJWTUserToken
```
public OAuth.OAuthToken requestJWTUserToken(String clientId,
                                   String userId,
                                   List<String> scopes,
                                   byte[] rsaPrivateKey,
                                   long expiresIn)
                                     throws IllegalArgumentException,
                                            IOException,
                                            ApiException
```
    Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
    
    Parameters:
    clientId - DocuSign OAuth Client Id (AKA Integrator Key)
    userId - DocuSign user Id to be impersonated (This is a UUID)
    scopes - the list of requested scopes. Values include OAuth.Scope_SIGNATURE, OAuth.Scope_EXTENDED, OAuth.Scope_IMPERSONATION. You can also pass any advanced scope.
    rsaPrivateKey - the byte contents of the RSA private key
    expiresIn - number of seconds remaining before the JWT assertion is considered as invalid
    
    Returns:
    OAuth.OAuthToken object.
    
    Throws:
    
    IllegalArgumentException - if one of the arguments is invalid
    
    IOException - if there is an issue with either the public or private file
    
    ApiException - if there is an error while exchanging the JWT with an access token
  - requestJWTApplicationToken
```
public OAuth.OAuthToken requestJWTApplicationToken(String clientId,
                                          List<String> scopes,
                                          byte[] rsaPrivateKey,
                                          long expiresIn)
                                            throws IllegalArgumentException,
                                                   IOException,
                                                   ApiException
```
    RESERVED FOR PARTNERS Request JWT Application Token Configures the current instance of ApiClient with a fresh OAuth JWT access token from DocuSign
    
    Parameters:
    clientId - DocuSign OAuth Client Id (AKA Integrator Key)
    scopes - the list of requested scopes. Values include OAuth.Scope_SIGNATURE, OAuth.Scope_EXTENDED, OAuth.Scope_IMPERSONATION. You can also pass any advanced scope.
    rsaPrivateKey - the byte contents of the RSA private key
    expiresIn - number of seconds remaining before the JWT assertion is considered as invalid
    
    Returns:
    OAuth.OAuthToken object.
    
    Throws:
    
    IllegalArgumentException - if one of the arguments is invalid
    
    IOException - if there is an issue with either the public or private file
    
    ApiException - if there is an error while exchanging the JWT with an access token
  - 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)
```
  - isJsonMime
```
public boolean isJsonMime(String mime)
```
    Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON
  - 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 Object serialize(Object obj,
               String contentType,
               Map<String,Object> formParams)
                 throws ApiException
```
    Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).
    
    Throws:
    
    ApiException
  - invokeAPI
```
public <T> T invokeAPI(String path,
              String method,
              List<Pair> queryParams,
              Object body,
              Map<String,String> headerParams,
              Map<String,Object> formParams,
              String accept,
              String contentType,
              String[] authNames,
              com.sun.jersey.api.client.GenericType<T> 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
    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

Class ApiClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRODUCTION_REST_BASEPATH

DEMO_REST_BASEPATH

STAGE_REST_BASEPATH

Constructor Detail

ApiClient

ApiClient

ApiClient

ApiClient

ApiClient

Method Detail

getBasePath

setBasePath

getStatusCode

getResponseHeaders

getAuthentications

getAuthentication

addAuthorization

setUsername

setPassword

setApiKey

setApiKeyPrefix

setUserAgent

updateAccessToken

setAccessToken

getAccessToken

addDefaultHeader

isDebugging

setDebugging

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

getDateFormat

setDateFormat

getTokenEndPoint

getAuthorizationEndPoint

configureAuthorizationFlow

getAuthorizationUri

getAuthorizationUri

getAuthorizationUri

setOAuthBasePath

generateAccessToken

getUserInfo

registerAccessTokenListener

getJWTUri

configureJWTAuthorizationFlow

requestJWTUserToken

requestJWTApplicationToken

parseDate

formatDate

parameterToString

parameterToPairs

isJsonMime

selectHeaderAccept

selectHeaderContentType

escapeString

serialize

invokeAPI