Package com.hellosign.openapi.api

Class ApiAppApi

java.lang.Object

com.hellosign.openapi.api.ApiAppApi

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

Constructor Summary

Constructors

Constructor	Description
ApiAppApi()
ApiAppApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiAppGetResponse	apiAppCreate(ApiAppCreateRequest apiAppCreateRequest)	Create API App Creates a new API App.
ApiResponse<ApiAppGetResponse>	apiAppCreateWithHttpInfo(ApiAppCreateRequest apiAppCreateRequest)	Create API App Creates a new API App.
void	apiAppDelete(java.lang.String clientId)	Delete API App Deletes an API App.
ApiResponse<java.lang.Void>	apiAppDeleteWithHttpInfo(java.lang.String clientId)	Delete API App Deletes an API App.
ApiAppGetResponse	apiAppGet(java.lang.String clientId)	Get API App Returns an object with information about an API App.
ApiResponse<ApiAppGetResponse>	apiAppGetWithHttpInfo(java.lang.String clientId)	Get API App Returns an object with information about an API App.
ApiAppListResponse	apiAppList(java.lang.Integer page, java.lang.Integer pageSize)	List API Apps Returns a list of API Apps that are accessible by you.
ApiResponse<ApiAppListResponse>	apiAppListWithHttpInfo(java.lang.Integer page, java.lang.Integer pageSize)	List API Apps Returns a list of API Apps that are accessible by you.
ApiAppGetResponse	apiAppUpdate(java.lang.String clientId, ApiAppUpdateRequest apiAppUpdateRequest)	Update API App Updates an existing API App.
ApiResponse<ApiAppGetResponse>	apiAppUpdateWithHttpInfo(java.lang.String clientId, ApiAppUpdateRequest apiAppUpdateRequest)	Update API App Updates an existing API App.
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

ApiAppApi

public ApiAppApi()

ApiAppApi

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

apiAppCreate

public ApiAppGetResponse apiAppCreate(ApiAppCreateRequest apiAppCreateRequest)
                               throws ApiException

Create API App Creates a new API App.

Parameters:

apiAppCreateRequest - (required)

Returns:

ApiAppGetResponse

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	-

apiAppCreateWithHttpInfo

public ApiResponse<ApiAppGetResponse> apiAppCreateWithHttpInfo(ApiAppCreateRequest apiAppCreateRequest)
                                                        throws ApiException

Create API App Creates a new API App.

Parameters:

apiAppCreateRequest - (required)

Returns:

ApiResponse<ApiAppGetResponse>

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	-

apiAppDelete

public void apiAppDelete(java.lang.String clientId)
                  throws ApiException

Delete API App Deletes an API App. Can only be invoked for apps you own.

Parameters:

clientId - The client id of the API App to delete. (required)

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
204	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

apiAppDeleteWithHttpInfo

public ApiResponse<java.lang.Void> apiAppDeleteWithHttpInfo(java.lang.String clientId)
                                                     throws ApiException

Delete API App Deletes an API App. Can only be invoked for apps you own.

Parameters:

clientId - The client id of the API App to delete. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
204	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

apiAppGet

public ApiAppGetResponse apiAppGet(java.lang.String clientId)
                            throws ApiException

Get API App Returns an object with information about an API App.

Parameters:

clientId - The client id of the API App to retrieve. (required)

Returns:

ApiAppGetResponse

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	-

apiAppGetWithHttpInfo

public ApiResponse<ApiAppGetResponse> apiAppGetWithHttpInfo(java.lang.String clientId)
                                                     throws ApiException

Get API App Returns an object with information about an API App.

Parameters:

clientId - The client id of the API App to retrieve. (required)

Returns:

ApiResponse<ApiAppGetResponse>

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	-

apiAppList

public ApiAppListResponse apiAppList(java.lang.Integer page,
                                     java.lang.Integer pageSize)
                              throws ApiException

List API Apps Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.

Parameters:

page - Which page number of the API App List to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)

Returns:

ApiAppListResponse

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	-

apiAppListWithHttpInfo

public ApiResponse<ApiAppListResponse> apiAppListWithHttpInfo(java.lang.Integer page,
                                                              java.lang.Integer pageSize)
                                                       throws ApiException

List API Apps Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.

Parameters:

page - Which page number of the API App List to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)

Returns:

ApiResponse<ApiAppListResponse>

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	-

apiAppUpdate

public ApiAppGetResponse apiAppUpdate(java.lang.String clientId,
                                      ApiAppUpdateRequest apiAppUpdateRequest)
                               throws ApiException

Update API App Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.

Parameters:

clientId - The client id of the API App to update. (required)

apiAppUpdateRequest - (required)

Returns:

ApiAppGetResponse

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	-

apiAppUpdateWithHttpInfo

public ApiResponse<ApiAppGetResponse> apiAppUpdateWithHttpInfo(java.lang.String clientId,
                                                               ApiAppUpdateRequest apiAppUpdateRequest)
                                                        throws ApiException

Update API App Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.

Parameters:

clientId - The client id of the API App to update. (required)

apiAppUpdateRequest - (required)

Returns:

ApiResponse<ApiAppGetResponse>

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	-