ClickSend.Api

Class NumberApi

java.lang.Object

ClickSend.Api.NumberApi

public class NumberApi
extends Object

Constructor Summary

Constructors

Constructor and Description
NumberApi()
NumberApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	numbersBuyByDedicatedNumberPost(String dedicatedNumber) Buy dedicated number Buy dedicated number
com.squareup.okhttp.Call	numbersBuyByDedicatedNumberPostAsync(String dedicatedNumber, ApiCallback<String> callback) Buy dedicated number (asynchronously) Buy dedicated number
com.squareup.okhttp.Call	numbersBuyByDedicatedNumberPostCall(String dedicatedNumber, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for numbersBuyByDedicatedNumberPost
ApiResponse<String>	numbersBuyByDedicatedNumberPostWithHttpInfo(String dedicatedNumber) Buy dedicated number Buy dedicated number
String	numbersGet(Integer page, Integer limit) Get all availible dedicated numbers Get all availible dedicated numbers
com.squareup.okhttp.Call	numbersGetAsync(Integer page, Integer limit, ApiCallback<String> callback) Get all availible dedicated numbers (asynchronously) Get all availible dedicated numbers
com.squareup.okhttp.Call	numbersGetCall(Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for numbersGet
ApiResponse<String>	numbersGetWithHttpInfo(Integer page, Integer limit) Get all availible dedicated numbers Get all availible dedicated numbers
String	numbersSearchByCountryGet(String country, String search, Integer searchType, Integer page, Integer limit) Get all dedicated numbers by country Get all dedicated numbers by country
com.squareup.okhttp.Call	numbersSearchByCountryGetAsync(String country, String search, Integer searchType, Integer page, Integer limit, ApiCallback<String> callback) Get all dedicated numbers by country (asynchronously) Get all dedicated numbers by country
com.squareup.okhttp.Call	numbersSearchByCountryGetCall(String country, String search, Integer searchType, Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for numbersSearchByCountryGet
ApiResponse<String>	numbersSearchByCountryGetWithHttpInfo(String country, String search, Integer searchType, Integer page, Integer limit) Get all dedicated numbers by country Get all dedicated numbers by country
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberApi

public NumberApi()

NumberApi

public NumberApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

numbersBuyByDedicatedNumberPostCall

public com.squareup.okhttp.Call numbersBuyByDedicatedNumberPostCall(String dedicatedNumber,
                                                                    ProgressResponseBody.ProgressListener progressListener,
                                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                             throws ApiException

Build call for numbersBuyByDedicatedNumberPost

Parameters:

dedicatedNumber - Phone number to purchase (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

numbersBuyByDedicatedNumberPost

public String numbersBuyByDedicatedNumberPost(String dedicatedNumber)
                                       throws ApiException

Buy dedicated number Buy dedicated number

Parameters:

dedicatedNumber - Phone number to purchase (required)

Returns:

String

Throws:

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

numbersBuyByDedicatedNumberPostWithHttpInfo

public ApiResponse<String> numbersBuyByDedicatedNumberPostWithHttpInfo(String dedicatedNumber)
                                                                throws ApiException

Buy dedicated number Buy dedicated number

Parameters:

dedicatedNumber - Phone number to purchase (required)

Returns:

ApiResponse<String>

Throws:

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

numbersBuyByDedicatedNumberPostAsync

public com.squareup.okhttp.Call numbersBuyByDedicatedNumberPostAsync(String dedicatedNumber,
                                                                     ApiCallback<String> callback)
                                                              throws ApiException

Buy dedicated number (asynchronously) Buy dedicated number

Parameters:

dedicatedNumber - Phone number to purchase (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

numbersGetCall

public com.squareup.okhttp.Call numbersGetCall(Integer page,
                                               Integer limit,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for numbersGet

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

numbersGet

public String numbersGet(Integer page,
                         Integer limit)
                  throws ApiException

Get all availible dedicated numbers Get all availible dedicated numbers

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

String

Throws:

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

numbersGetWithHttpInfo

public ApiResponse<String> numbersGetWithHttpInfo(Integer page,
                                                  Integer limit)
                                           throws ApiException

Get all availible dedicated numbers Get all availible dedicated numbers

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

ApiResponse<String>

Throws:

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

numbersGetAsync

public com.squareup.okhttp.Call numbersGetAsync(Integer page,
                                                Integer limit,
                                                ApiCallback<String> callback)
                                         throws ApiException

Get all availible dedicated numbers (asynchronously) Get all availible dedicated numbers

Parameters:

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

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

numbersSearchByCountryGetCall

public com.squareup.okhttp.Call numbersSearchByCountryGetCall(String country,
                                                              String search,
                                                              Integer searchType,
                                                              Integer page,
                                                              Integer limit,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for numbersSearchByCountryGet

Parameters:

country - Country code to search (required)

search - Your search pattern or query. (optional)

searchType - Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

numbersSearchByCountryGet

public String numbersSearchByCountryGet(String country,
                                        String search,
                                        Integer searchType,
                                        Integer page,
                                        Integer limit)
                                 throws ApiException

Get all dedicated numbers by country Get all dedicated numbers by country

Parameters:

country - Country code to search (required)

search - Your search pattern or query. (optional)

searchType - Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

String

Throws:

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

numbersSearchByCountryGetWithHttpInfo

public ApiResponse<String> numbersSearchByCountryGetWithHttpInfo(String country,
                                                                 String search,
                                                                 Integer searchType,
                                                                 Integer page,
                                                                 Integer limit)
                                                          throws ApiException

Get all dedicated numbers by country Get all dedicated numbers by country

Parameters:

country - Country code to search (required)

search - Your search pattern or query. (optional)

searchType - Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

ApiResponse<String>

Throws:

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

numbersSearchByCountryGetAsync

public com.squareup.okhttp.Call numbersSearchByCountryGetAsync(String country,
                                                               String search,
                                                               Integer searchType,
                                                               Integer page,
                                                               Integer limit,
                                                               ApiCallback<String> callback)
                                                        throws ApiException

Get all dedicated numbers by country (asynchronously) Get all dedicated numbers by country

Parameters:

country - Country code to search (required)

search - Your search pattern or query. (optional)

searchType - Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

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