Package com.hellosign.openapi.api

Class OAuthApi

java.lang.Object

com.hellosign.openapi.api.OAuthApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class OAuthApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
OAuthApi()
OAuthApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client
OAuthTokenResponse	oauthTokenGenerate(OAuthTokenGenerateRequest oauthTokenGenerateRequest)	OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
ApiResponse<OAuthTokenResponse>	oauthTokenGenerateWithHttpInfo(OAuthTokenGenerateRequest oauthTokenGenerateRequest)	OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
OAuthTokenResponse	oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest)	OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons.
ApiResponse<OAuthTokenResponse>	oauthTokenRefreshWithHttpInfo(OAuthTokenRefreshRequest oauthTokenRefreshRequest)	OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons.
void	setApiClient(ApiClient apiClient)	Set the API client

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthApi

public OAuthApi()

OAuthApi

public OAuthApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client

Parameters:

apiClient - an instance of API client

oauthTokenGenerate

public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthTokenGenerateRequest)
                                      throws ApiException

OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.

Parameters:

oauthTokenGenerateRequest - (required)

Returns:

OAuthTokenResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -

oauthTokenGenerateWithHttpInfo

public ApiResponse<OAuthTokenResponse> oauthTokenGenerateWithHttpInfo(OAuthTokenGenerateRequest oauthTokenGenerateRequest)
                                                               throws ApiException

OAuth Token Generate Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.

Parameters:

oauthTokenGenerateRequest - (required)

Returns:

ApiResponse<OAuthTokenResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -

oauthTokenRefresh

public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest)
                                     throws ApiException

OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.

Parameters:

oauthTokenRefreshRequest - (required)

Returns:

OAuthTokenResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -

oauthTokenRefreshWithHttpInfo

public ApiResponse<OAuthTokenResponse> oauthTokenRefreshWithHttpInfo(OAuthTokenRefreshRequest oauthTokenRefreshRequest)
                                                              throws ApiException

OAuth Token Refresh Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.

Parameters:

oauthTokenRefreshRequest - (required)

Returns:

ApiResponse<OAuthTokenResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -