com.mailslurp.apis

Class PhoneControllerApi

java.lang.Object

com.mailslurp.apis.PhoneControllerApi

public class PhoneControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PhoneControllerApi()
PhoneControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EmergencyAddress	createEmergencyAddress(CreateEmergencyAddressOptions createEmergencyAddressOptions)
okhttp3.Call	createEmergencyAddressAsync(CreateEmergencyAddressOptions createEmergencyAddressOptions, ApiCallback<EmergencyAddress> _callback) (asynchronously)
okhttp3.Call	createEmergencyAddressCall(CreateEmergencyAddressOptions createEmergencyAddressOptions, ApiCallback _callback) Build call for createEmergencyAddress
ApiResponse<EmergencyAddress>	createEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions createEmergencyAddressOptions)
EmptyResponseDto	deleteEmergencyAddress(UUID addressId)
okhttp3.Call	deleteEmergencyAddressAsync(UUID addressId, ApiCallback<EmptyResponseDto> _callback) (asynchronously)
okhttp3.Call	deleteEmergencyAddressCall(UUID addressId, ApiCallback _callback) Build call for deleteEmergencyAddress
ApiResponse<EmptyResponseDto>	deleteEmergencyAddressWithHttpInfo(UUID addressId)
void	deletePhoneNumber(UUID phoneNumberId)
okhttp3.Call	deletePhoneNumberAsync(UUID phoneNumberId, ApiCallback<Void> _callback) (asynchronously)
okhttp3.Call	deletePhoneNumberCall(UUID phoneNumberId, ApiCallback _callback) Build call for deletePhoneNumber
ApiResponse<Void>	deletePhoneNumberWithHttpInfo(UUID phoneNumberId)
ApiClient	getApiClient()
String	getCustomBaseUrl()
EmergencyAddress	getEmergencyAddress(UUID addressId)
okhttp3.Call	getEmergencyAddressAsync(UUID addressId, ApiCallback<EmergencyAddress> _callback) (asynchronously)
okhttp3.Call	getEmergencyAddressCall(UUID addressId, ApiCallback _callback) Build call for getEmergencyAddress
List<EmergencyAddressDto>	getEmergencyAddresses()
okhttp3.Call	getEmergencyAddressesAsync(ApiCallback<List<EmergencyAddressDto>> _callback) (asynchronously)
okhttp3.Call	getEmergencyAddressesCall(ApiCallback _callback) Build call for getEmergencyAddresses
ApiResponse<List<EmergencyAddressDto>>	getEmergencyAddressesWithHttpInfo()
ApiResponse<EmergencyAddress>	getEmergencyAddressWithHttpInfo(UUID addressId)
int	getHostIndex()
PhoneNumberDto	getPhoneNumber(UUID phoneNumberId)
okhttp3.Call	getPhoneNumberAsync(UUID phoneNumberId, ApiCallback<PhoneNumberDto> _callback) (asynchronously)
okhttp3.Call	getPhoneNumberCall(UUID phoneNumberId, ApiCallback _callback) Build call for getPhoneNumber
PagePhoneNumberProjection	getPhoneNumbers(String phoneCountry, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
okhttp3.Call	getPhoneNumbersAsync(String phoneCountry, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PagePhoneNumberProjection> _callback) (asynchronously)
okhttp3.Call	getPhoneNumbersCall(String phoneCountry, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getPhoneNumbers
ApiResponse<PagePhoneNumberProjection>	getPhoneNumbersWithHttpInfo(String phoneCountry, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
ApiResponse<PhoneNumberDto>	getPhoneNumberWithHttpInfo(UUID phoneNumberId)
List<PhonePlanDto>	getPhonePlans()
okhttp3.Call	getPhonePlansAsync(ApiCallback<List<PhonePlanDto>> _callback) (asynchronously)
okhttp3.Call	getPhonePlansCall(ApiCallback _callback) Build call for getPhonePlans
ApiResponse<List<PhonePlanDto>>	getPhonePlansWithHttpInfo()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	testPhoneNumberSendSms(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, String xTestId)
okhttp3.Call	testPhoneNumberSendSmsAsync(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, String xTestId, ApiCallback<Void> _callback) (asynchronously)
okhttp3.Call	testPhoneNumberSendSmsCall(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, String xTestId, ApiCallback _callback) Build call for testPhoneNumberSendSms
ApiResponse<Void>	testPhoneNumberSendSmsWithHttpInfo(UUID phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, String xTestId)

Methods inherited from class java.lang.Object

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

Constructor Detail

PhoneControllerApi

public PhoneControllerApi()

PhoneControllerApi

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

createEmergencyAddressCall

public okhttp3.Call createEmergencyAddressCall(CreateEmergencyAddressOptions createEmergencyAddressOptions,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for createEmergencyAddress

Parameters:

createEmergencyAddressOptions - (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	-

createEmergencyAddress

public EmergencyAddress createEmergencyAddress(CreateEmergencyAddressOptions createEmergencyAddressOptions)
                                        throws ApiException

Parameters:

createEmergencyAddressOptions - (required)

Returns:

EmergencyAddress

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	-

createEmergencyAddressWithHttpInfo

public ApiResponse<EmergencyAddress> createEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions createEmergencyAddressOptions)
                                                                 throws ApiException

Parameters:

createEmergencyAddressOptions - (required)

Returns:

ApiResponse<EmergencyAddress>

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	-

createEmergencyAddressAsync

public okhttp3.Call createEmergencyAddressAsync(CreateEmergencyAddressOptions createEmergencyAddressOptions,
                                                ApiCallback<EmergencyAddress> _callback)
                                         throws ApiException

(asynchronously)

Parameters:

createEmergencyAddressOptions - (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	-

deleteEmergencyAddressCall

public okhttp3.Call deleteEmergencyAddressCall(UUID addressId,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for deleteEmergencyAddress

Parameters:

addressId - (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	-

deleteEmergencyAddress

public EmptyResponseDto deleteEmergencyAddress(UUID addressId)
                                        throws ApiException

Parameters:

addressId - (required)

Returns:

EmptyResponseDto

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	-

deleteEmergencyAddressWithHttpInfo

public ApiResponse<EmptyResponseDto> deleteEmergencyAddressWithHttpInfo(UUID addressId)
                                                                 throws ApiException

Parameters:

addressId - (required)

Returns:

ApiResponse<EmptyResponseDto>

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	-

deleteEmergencyAddressAsync

public okhttp3.Call deleteEmergencyAddressAsync(UUID addressId,
                                                ApiCallback<EmptyResponseDto> _callback)
                                         throws ApiException

(asynchronously)

Parameters:

addressId - (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	-

deletePhoneNumberCall

public okhttp3.Call deletePhoneNumberCall(UUID phoneNumberId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for deletePhoneNumber

Parameters:

phoneNumberId - (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
204	No Content	-

deletePhoneNumber

public void deletePhoneNumber(UUID phoneNumberId)
                       throws ApiException

Parameters:

phoneNumberId - (required)

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
204	No Content	-

deletePhoneNumberWithHttpInfo

public ApiResponse<Void> deletePhoneNumberWithHttpInfo(UUID phoneNumberId)
                                                throws ApiException

Parameters:

phoneNumberId - (required)

Returns:

ApiResponse<Void>

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
204	No Content	-

deletePhoneNumberAsync

public okhttp3.Call deletePhoneNumberAsync(UUID phoneNumberId,
                                           ApiCallback<Void> _callback)
                                    throws ApiException

(asynchronously)

Parameters:

phoneNumberId - (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
204	No Content	-

getEmergencyAddressCall

public okhttp3.Call getEmergencyAddressCall(UUID addressId,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getEmergencyAddress

Parameters:

addressId - (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	-

getEmergencyAddress

public EmergencyAddress getEmergencyAddress(UUID addressId)
                                     throws ApiException

Parameters:

addressId - (required)

Returns:

EmergencyAddress

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	-

getEmergencyAddressWithHttpInfo

public ApiResponse<EmergencyAddress> getEmergencyAddressWithHttpInfo(UUID addressId)
                                                              throws ApiException

Parameters:

addressId - (required)

Returns:

ApiResponse<EmergencyAddress>

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	-

getEmergencyAddressAsync

public okhttp3.Call getEmergencyAddressAsync(UUID addressId,
                                             ApiCallback<EmergencyAddress> _callback)
                                      throws ApiException

(asynchronously)

Parameters:

addressId - (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	-

getEmergencyAddressesCall

public okhttp3.Call getEmergencyAddressesCall(ApiCallback _callback)
                                       throws ApiException

Build call for getEmergencyAddresses

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	-

getEmergencyAddresses

public List<EmergencyAddressDto> getEmergencyAddresses()
                                                throws ApiException

Returns:

List<EmergencyAddressDto>

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	-

getEmergencyAddressesWithHttpInfo

public ApiResponse<List<EmergencyAddressDto>> getEmergencyAddressesWithHttpInfo()
                                                                         throws ApiException

Returns:

ApiResponse<List<EmergencyAddressDto>>

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	-

getEmergencyAddressesAsync

public okhttp3.Call getEmergencyAddressesAsync(ApiCallback<List<EmergencyAddressDto>> _callback)
                                        throws ApiException

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

getPhoneNumberCall

public okhttp3.Call getPhoneNumberCall(UUID phoneNumberId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getPhoneNumber

Parameters:

phoneNumberId - (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	-

getPhoneNumber

public PhoneNumberDto getPhoneNumber(UUID phoneNumberId)
                              throws ApiException

Parameters:

phoneNumberId - (required)

Returns:

PhoneNumberDto

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	-

getPhoneNumberWithHttpInfo

public ApiResponse<PhoneNumberDto> getPhoneNumberWithHttpInfo(UUID phoneNumberId)
                                                       throws ApiException

Parameters:

phoneNumberId - (required)

Returns:

ApiResponse<PhoneNumberDto>

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	-

getPhoneNumberAsync

public okhttp3.Call getPhoneNumberAsync(UUID phoneNumberId,
                                        ApiCallback<PhoneNumberDto> _callback)
                                 throws ApiException

(asynchronously)

Parameters:

phoneNumberId - (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	-

getPhoneNumbersCall

public okhttp3.Call getPhoneNumbersCall(String phoneCountry,
                                        Integer page,
                                        Integer size,
                                        String sort,
                                        OffsetDateTime since,
                                        OffsetDateTime before,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getPhoneNumbers

Parameters:

phoneCountry - Optional phone country (optional)

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_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	-

getPhoneNumbers

public PagePhoneNumberProjection getPhoneNumbers(String phoneCountry,
                                                 Integer page,
                                                 Integer size,
                                                 String sort,
                                                 OffsetDateTime since,
                                                 OffsetDateTime before)
                                          throws ApiException

Parameters:

phoneCountry - Optional phone country (optional)

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PagePhoneNumberProjection

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	-

getPhoneNumbersWithHttpInfo

public ApiResponse<PagePhoneNumberProjection> getPhoneNumbersWithHttpInfo(String phoneCountry,
                                                                          Integer page,
                                                                          Integer size,
                                                                          String sort,
                                                                          OffsetDateTime since,
                                                                          OffsetDateTime before)
                                                                   throws ApiException

Parameters:

phoneCountry - Optional phone country (optional)

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PagePhoneNumberProjection>

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	-

getPhoneNumbersAsync

public okhttp3.Call getPhoneNumbersAsync(String phoneCountry,
                                         Integer page,
                                         Integer size,
                                         String sort,
                                         OffsetDateTime since,
                                         OffsetDateTime before,
                                         ApiCallback<PagePhoneNumberProjection> _callback)
                                  throws ApiException

(asynchronously)

Parameters:

phoneCountry - Optional phone country (optional)

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_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	-

getPhonePlansCall

public okhttp3.Call getPhonePlansCall(ApiCallback _callback)
                               throws ApiException

Build call for getPhonePlans

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	-

getPhonePlans

public List<PhonePlanDto> getPhonePlans()
                                 throws ApiException

Returns:

List<PhonePlanDto>

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	-

getPhonePlansWithHttpInfo

public ApiResponse<List<PhonePlanDto>> getPhonePlansWithHttpInfo()
                                                          throws ApiException

Returns:

ApiResponse<List<PhonePlanDto>>

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	-

getPhonePlansAsync

public okhttp3.Call getPhonePlansAsync(ApiCallback<List<PhonePlanDto>> _callback)
                                throws ApiException

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

testPhoneNumberSendSmsCall

public okhttp3.Call testPhoneNumberSendSmsCall(UUID phoneNumberId,
                                               TestPhoneNumberOptions testPhoneNumberOptions,
                                               String xTestId,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for testPhoneNumberSendSms

Parameters:

phoneNumberId - (required)

testPhoneNumberOptions - (required)

xTestId - (optional)

_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	-

testPhoneNumberSendSms

public void testPhoneNumberSendSms(UUID phoneNumberId,
                                   TestPhoneNumberOptions testPhoneNumberOptions,
                                   String xTestId)
                            throws ApiException

Parameters:

phoneNumberId - (required)

testPhoneNumberOptions - (required)

xTestId - (optional)

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	-

testPhoneNumberSendSmsWithHttpInfo

public ApiResponse<Void> testPhoneNumberSendSmsWithHttpInfo(UUID phoneNumberId,
                                                            TestPhoneNumberOptions testPhoneNumberOptions,
                                                            String xTestId)
                                                     throws ApiException

Parameters:

phoneNumberId - (required)

testPhoneNumberOptions - (required)

xTestId - (optional)

Returns:

ApiResponse<Void>

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	-

testPhoneNumberSendSmsAsync

public okhttp3.Call testPhoneNumberSendSmsAsync(UUID phoneNumberId,
                                                TestPhoneNumberOptions testPhoneNumberOptions,
                                                String xTestId,
                                                ApiCallback<Void> _callback)
                                         throws ApiException

(asynchronously)

Parameters:

phoneNumberId - (required)

testPhoneNumberOptions - (required)

xTestId - (optional)

_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	-