Package com.boldsign.api

Class PlanApi

java.lang.Object

com.boldsign.api.PlanApi

public class PlanApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PlanApi()
PlanApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BillingViewModel	apiCreditsCount()	Gets the Api credits details.
okhttp3.Call	apiCreditsCountAsync(ApiCallback<BillingViewModel> _callback)	Gets the Api credits details.
okhttp3.Call	apiCreditsCountCall(ApiCallback _callback)	Build call for apiCreditsCount
ApiResponse<BillingViewModel>	apiCreditsCountWithHttpInfo()	Gets the Api credits details.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanApi

public PlanApi()

PlanApi

public PlanApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

apiCreditsCountCall

public okhttp3.Call apiCreditsCountCall(ApiCallback _callback)
                                 throws ApiException

Build call for apiCreditsCount

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-

apiCreditsCount

public BillingViewModel apiCreditsCount()
                                 throws ApiException

Gets the Api credits details.

Returns:

BillingViewModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-

apiCreditsCountWithHttpInfo

public ApiResponse<BillingViewModel> apiCreditsCountWithHttpInfo()
                                                          throws ApiException

Gets the Api credits details.

Returns:

ApiResponse<BillingViewModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-

apiCreditsCountAsync

public okhttp3.Call apiCreditsCountAsync(ApiCallback<BillingViewModel> _callback)
                                  throws ApiException

Gets the Api credits details. (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-