Package com.hellosign.openapi.api

Class AccountApi

java.lang.Object

com.hellosign.openapi.api.AccountApi

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

Constructor Summary

Constructors

Constructor	Description
AccountApi()
AccountApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AccountCreateResponse	accountCreate(AccountCreateRequest accountCreateRequest)	Create Account Creates a new HelloSign Account that is associated with the specified `email_address`.
ApiResponse<AccountCreateResponse>	accountCreateWithHttpInfo(AccountCreateRequest accountCreateRequest)	Create Account Creates a new HelloSign Account that is associated with the specified `email_address`.
AccountGetResponse	accountGet(java.lang.String accountId)	Get Account Returns the properties and settings of your Account.
ApiResponse<AccountGetResponse>	accountGetWithHttpInfo(java.lang.String accountId)	Get Account Returns the properties and settings of your Account.
AccountGetResponse	accountUpdate(AccountUpdateRequest accountUpdateRequest)	Update Account Updates the properties and settings of your Account.
ApiResponse<AccountGetResponse>	accountUpdateWithHttpInfo(AccountUpdateRequest accountUpdateRequest)	Update Account Updates the properties and settings of your Account.
AccountVerifyResponse	accountVerify(AccountVerifyRequest accountVerifyRequest)	Verify Account Verifies whether an HelloSign Account exists for the given email address.
ApiResponse<AccountVerifyResponse>	accountVerifyWithHttpInfo(AccountVerifyRequest accountVerifyRequest)	Verify Account Verifies whether an HelloSign Account exists for the given email address.
ApiClient	getApiClient()	Get the API client
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

AccountApi

public AccountApi()

AccountApi

public AccountApi(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

accountCreate

public AccountCreateResponse accountCreate(AccountCreateRequest accountCreateRequest)
                                    throws ApiException

Create Account Creates a new HelloSign Account that is associated with the specified `email_address`.

Parameters:

accountCreateRequest - (required)

Returns:

AccountCreateResponse

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 -
4XX	failed_operation	-

accountCreateWithHttpInfo

public ApiResponse<AccountCreateResponse> accountCreateWithHttpInfo(AccountCreateRequest accountCreateRequest)
                                                             throws ApiException

Create Account Creates a new HelloSign Account that is associated with the specified `email_address`.

Parameters:

accountCreateRequest - (required)

Returns:

ApiResponse<AccountCreateResponse>

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 -
4XX	failed_operation	-

accountGet

public AccountGetResponse accountGet(java.lang.String accountId)
                              throws ApiException

Get Account Returns the properties and settings of your Account.

Parameters:

accountId - The ID of the Account (optional)

Returns:

AccountGetResponse

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 -
4XX	failed_operation	-

accountGetWithHttpInfo

public ApiResponse<AccountGetResponse> accountGetWithHttpInfo(java.lang.String accountId)
                                                       throws ApiException

Get Account Returns the properties and settings of your Account.

Parameters:

accountId - The ID of the Account (optional)

Returns:

ApiResponse<AccountGetResponse>

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 -
4XX	failed_operation	-

accountUpdate

public AccountGetResponse accountUpdate(AccountUpdateRequest accountUpdateRequest)
                                 throws ApiException

Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.

Parameters:

accountUpdateRequest - (required)

Returns:

AccountGetResponse

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 -
4XX	failed_operation	-

accountUpdateWithHttpInfo

public ApiResponse<AccountGetResponse> accountUpdateWithHttpInfo(AccountUpdateRequest accountUpdateRequest)
                                                          throws ApiException

Update Account Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.

Parameters:

accountUpdateRequest - (required)

Returns:

ApiResponse<AccountGetResponse>

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 -
4XX	failed_operation	-

accountVerify

public AccountVerifyResponse accountVerify(AccountVerifyRequest accountVerifyRequest)
                                    throws ApiException

Verify Account Verifies whether an HelloSign Account exists for the given email address.

Parameters:

accountVerifyRequest - (required)

Returns:

AccountVerifyResponse

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 -
4XX	failed_operation	-

accountVerifyWithHttpInfo

public ApiResponse<AccountVerifyResponse> accountVerifyWithHttpInfo(AccountVerifyRequest accountVerifyRequest)
                                                             throws ApiException

Verify Account Verifies whether an HelloSign Account exists for the given email address.

Parameters:

accountVerifyRequest - (required)

Returns:

ApiResponse<AccountVerifyResponse>

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 -
4XX	failed_operation	-