Package com.bandwidth.sdk.api

Class PhoneNumberLookupApi

java.lang.Object

com.bandwidth.sdk.api.PhoneNumberLookupApi

public class PhoneNumberLookupApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PhoneNumberLookupApi()
PhoneNumberLookupApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CreateLookupResponse	createLookup(String accountId, LookupRequest lookupRequest)	Create Lookup Create a Phone Number Lookup Request.
okhttp3.Call	createLookupAsync(String accountId, LookupRequest lookupRequest, ApiCallback<CreateLookupResponse> _callback)	Create Lookup (asynchronously) Create a Phone Number Lookup Request.
okhttp3.Call	createLookupCall(String accountId, LookupRequest lookupRequest, ApiCallback _callback)	Build call for createLookup
ApiResponse<CreateLookupResponse>	createLookupWithHttpInfo(String accountId, LookupRequest lookupRequest)	Create Lookup Create a Phone Number Lookup Request.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
LookupStatus	getLookupStatus(String accountId, String requestId)	Get Lookup Request Status Get an existing Phone Number Lookup Request.
okhttp3.Call	getLookupStatusAsync(String accountId, String requestId, ApiCallback<LookupStatus> _callback)	Get Lookup Request Status (asynchronously) Get an existing Phone Number Lookup Request.
okhttp3.Call	getLookupStatusCall(String accountId, String requestId, ApiCallback _callback)	Build call for getLookupStatus
ApiResponse<LookupStatus>	getLookupStatusWithHttpInfo(String accountId, String requestId)	Get Lookup Request Status Get an existing Phone Number Lookup Request.
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

PhoneNumberLookupApi

public PhoneNumberLookupApi()

PhoneNumberLookupApi

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

createLookupCall

public okhttp3.Call createLookupCall(String accountId,
                                     LookupRequest lookupRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for createLookup

Parameters:

accountId - Your Bandwidth Account ID. (required)

lookupRequest - Phone number lookup request. (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
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
415	Unsupported Media Type	-
429	Too Many Requests	-
500	Internal Server Error	-

createLookup

public CreateLookupResponse createLookup(String accountId,
                                         LookupRequest lookupRequest)
                                  throws ApiException

Create Lookup Create a Phone Number Lookup Request.

Parameters:

accountId - Your Bandwidth Account ID. (required)

lookupRequest - Phone number lookup request. (required)

Returns:

CreateLookupResponse

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
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
415	Unsupported Media Type	-
429	Too Many Requests	-
500	Internal Server Error	-

createLookupWithHttpInfo

public ApiResponse<CreateLookupResponse> createLookupWithHttpInfo(String accountId,
                                                                  LookupRequest lookupRequest)
                                                           throws ApiException

Create Lookup Create a Phone Number Lookup Request.

Parameters:

accountId - Your Bandwidth Account ID. (required)

lookupRequest - Phone number lookup request. (required)

Returns:

ApiResponse<CreateLookupResponse>

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
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
415	Unsupported Media Type	-
429	Too Many Requests	-
500	Internal Server Error	-

createLookupAsync

public okhttp3.Call createLookupAsync(String accountId,
                                      LookupRequest lookupRequest,
                                      ApiCallback<CreateLookupResponse> _callback)
                               throws ApiException

Create Lookup (asynchronously) Create a Phone Number Lookup Request.

Parameters:

accountId - Your Bandwidth Account ID. (required)

lookupRequest - Phone number lookup request. (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
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
415	Unsupported Media Type	-
429	Too Many Requests	-
500	Internal Server Error	-

getLookupStatusCall

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

Build call for getLookupStatus

Parameters:

accountId - Your Bandwidth Account ID. (required)

requestId - The phone number lookup request ID from Bandwidth. (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	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
500	Internal Server Error	-

getLookupStatus

public LookupStatus getLookupStatus(String accountId,
                                    String requestId)
                             throws ApiException

Get Lookup Request Status Get an existing Phone Number Lookup Request.

Parameters:

accountId - Your Bandwidth Account ID. (required)

requestId - The phone number lookup request ID from Bandwidth. (required)

Returns:

LookupStatus

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	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
500	Internal Server Error	-

getLookupStatusWithHttpInfo

public ApiResponse<LookupStatus> getLookupStatusWithHttpInfo(String accountId,
                                                             String requestId)
                                                      throws ApiException

Get Lookup Request Status Get an existing Phone Number Lookup Request.

Parameters:

accountId - Your Bandwidth Account ID. (required)

requestId - The phone number lookup request ID from Bandwidth. (required)

Returns:

ApiResponse<LookupStatus>

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	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
500	Internal Server Error	-

getLookupStatusAsync

public okhttp3.Call getLookupStatusAsync(String accountId,
                                         String requestId,
                                         ApiCallback<LookupStatus> _callback)
                                  throws ApiException

Get Lookup Request Status (asynchronously) Get an existing Phone Number Lookup Request.

Parameters:

accountId - Your Bandwidth Account ID. (required)

requestId - The phone number lookup request ID from Bandwidth. (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	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-
500	Internal Server Error	-