Package com.bandwidth.sdk.api

Class StatisticsApi

java.lang.Object

com.bandwidth.sdk.api.StatisticsApi

public class StatisticsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
StatisticsApi()
StatisticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
AccountStatistics	getStatistics(String accountId)	Get Account Statistics Returns details about the current state of the account.
okhttp3.Call	getStatisticsAsync(String accountId, ApiCallback<AccountStatistics> _callback)	Get Account Statistics (asynchronously) Returns details about the current state of the account.
okhttp3.Call	getStatisticsCall(String accountId, ApiCallback _callback)	Build call for getStatistics
ApiResponse<AccountStatistics>	getStatisticsWithHttpInfo(String accountId)	Get Account Statistics Returns details about the current state of the account.
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

StatisticsApi

public StatisticsApi()

StatisticsApi

public StatisticsApi(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)

getStatisticsCall

public okhttp3.Call getStatisticsCall(String accountId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getStatistics

Parameters:

accountId - Your Bandwidth Account ID. (required)

_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	Statistics Found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getStatistics

public AccountStatistics getStatistics(String accountId)
                                throws ApiException

Get Account Statistics Returns details about the current state of the account.

Parameters:

accountId - Your Bandwidth Account ID. (required)

Returns:

AccountStatistics

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	Statistics Found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getStatisticsWithHttpInfo

public ApiResponse<AccountStatistics> getStatisticsWithHttpInfo(String accountId)
                                                         throws ApiException

Get Account Statistics Returns details about the current state of the account.

Parameters:

accountId - Your Bandwidth Account ID. (required)

Returns:

ApiResponse<AccountStatistics>

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	Statistics Found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-

getStatisticsAsync

public okhttp3.Call getStatisticsAsync(String accountId,
                                       ApiCallback<AccountStatistics> _callback)
                                throws ApiException

Get Account Statistics (asynchronously) Returns details about the current state of the account.

Parameters:

accountId - Your Bandwidth Account ID. (required)

_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	Statistics Found	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
405	Method Not Allowed	-
415	Unsupported Media Type	-
429	Too Many Requests	* Retry-After - When you should try your request again.
500	Internal Server Error	-