com.mailslurp.apis

Class SmsControllerApi

java.lang.Object

com.mailslurp.apis.SmsControllerApi

public class SmsControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SmsControllerApi()
SmsControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteSmsMessage(UUID smsId) Delete SMS message.
okhttp3.Call	deleteSmsMessageAsync(UUID smsId, ApiCallback<Void> _callback) Delete SMS message.
okhttp3.Call	deleteSmsMessageCall(UUID smsId, ApiCallback _callback) Build call for deleteSmsMessage
void	deleteSmsMessages(UUID phoneNumberId) Delete all SMS messages Delete all SMS messages or all messages for a given phone number
okhttp3.Call	deleteSmsMessagesAsync(UUID phoneNumberId, ApiCallback<Void> _callback) Delete all SMS messages (asynchronously) Delete all SMS messages or all messages for a given phone number
okhttp3.Call	deleteSmsMessagesCall(UUID phoneNumberId, ApiCallback _callback) Build call for deleteSmsMessages
ApiResponse<Void>	deleteSmsMessagesWithHttpInfo(UUID phoneNumberId) Delete all SMS messages Delete all SMS messages or all messages for a given phone number
ApiResponse<Void>	deleteSmsMessageWithHttpInfo(UUID smsId) Delete SMS message.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
SmsDto	getSmsMessage(UUID smsId) Get SMS content including body.
okhttp3.Call	getSmsMessageAsync(UUID smsId, ApiCallback<SmsDto> _callback) Get SMS content including body.
okhttp3.Call	getSmsMessageCall(UUID smsId, ApiCallback _callback) Build call for getSmsMessage
PageSmsProjection	getSmsMessagesPaginated(UUID phoneNumber, Integer page, Integer size, String sort, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before) Get all SMS messages in all phone numbers in paginated form.
okhttp3.Call	getSmsMessagesPaginatedAsync(UUID phoneNumber, Integer page, Integer size, String sort, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageSmsProjection> _callback) Get all SMS messages in all phone numbers in paginated form.
okhttp3.Call	getSmsMessagesPaginatedCall(UUID phoneNumber, Integer page, Integer size, String sort, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getSmsMessagesPaginated
ApiResponse<PageSmsProjection>	getSmsMessagesPaginatedWithHttpInfo(UUID phoneNumber, Integer page, Integer size, String sort, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before) Get all SMS messages in all phone numbers in paginated form.
ApiResponse<SmsDto>	getSmsMessageWithHttpInfo(UUID smsId) Get SMS content including body.
UnreadCount	getUnreadSmsCount() Get unread SMS count Get number of SMS unread.
okhttp3.Call	getUnreadSmsCountAsync(ApiCallback<UnreadCount> _callback) Get unread SMS count (asynchronously) Get number of SMS unread.
okhttp3.Call	getUnreadSmsCountCall(ApiCallback _callback) Build call for getUnreadSmsCount
ApiResponse<UnreadCount>	getUnreadSmsCountWithHttpInfo() Get unread SMS count Get number of SMS unread.
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

SmsControllerApi

public SmsControllerApi()

SmsControllerApi

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

deleteSmsMessageCall

public okhttp3.Call deleteSmsMessageCall(UUID smsId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for deleteSmsMessage

Parameters:

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

deleteSmsMessage

public void deleteSmsMessage(UUID smsId)
                      throws ApiException

Delete SMS message. Delete an SMS message

Parameters:

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

deleteSmsMessageWithHttpInfo

public ApiResponse<Void> deleteSmsMessageWithHttpInfo(UUID smsId)
                                               throws ApiException

Delete SMS message. Delete an SMS message

Parameters:

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

deleteSmsMessageAsync

public okhttp3.Call deleteSmsMessageAsync(UUID smsId,
                                          ApiCallback<Void> _callback)
                                   throws ApiException

Delete SMS message. (asynchronously) Delete an SMS message

Parameters:

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

deleteSmsMessagesCall

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

Build call for deleteSmsMessages

Parameters:

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

deleteSmsMessages

public void deleteSmsMessages(UUID phoneNumberId)
                       throws ApiException

Delete all SMS messages Delete all SMS messages or all messages for a given phone number

Parameters:

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

deleteSmsMessagesWithHttpInfo

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

Delete all SMS messages Delete all SMS messages or all messages for a given phone number

Parameters:

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

deleteSmsMessagesAsync

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

Delete all SMS messages (asynchronously) Delete all SMS messages or all messages for a given phone number

Parameters:

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

getSmsMessageCall

public okhttp3.Call getSmsMessageCall(UUID smsId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getSmsMessage

Parameters:

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

getSmsMessage

public SmsDto getSmsMessage(UUID smsId)
                     throws ApiException

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

Parameters:

smsId - (required)

Returns:

SmsDto

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	-

getSmsMessageWithHttpInfo

public ApiResponse<SmsDto> getSmsMessageWithHttpInfo(UUID smsId)
                                              throws ApiException

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

Parameters:

smsId - (required)

Returns:

ApiResponse<SmsDto>

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	-

getSmsMessageAsync

public okhttp3.Call getSmsMessageAsync(UUID smsId,
                                       ApiCallback<SmsDto> _callback)
                                throws ApiException

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. (asynchronously) Returns a SMS summary object with content.

Parameters:

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

getSmsMessagesPaginatedCall

public okhttp3.Call getSmsMessagesPaginatedCall(UUID phoneNumber,
                                                Integer page,
                                                Integer size,
                                                String sort,
                                                Boolean unreadOnly,
                                                OffsetDateTime since,
                                                OffsetDateTime before,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for getSmsMessagesPaginated

Parameters:

phoneNumber - Optional receiving phone number to filter SMS messages for (optional)

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

size - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

since - Optional filter SMSs received after given date time (optional)

before - Optional filter SMSs received before given date time (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	-

getSmsMessagesPaginated

public PageSmsProjection getSmsMessagesPaginated(UUID phoneNumber,
                                                 Integer page,
                                                 Integer size,
                                                 String sort,
                                                 Boolean unreadOnly,
                                                 OffsetDateTime since,
                                                 OffsetDateTime before)
                                          throws ApiException

Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Parameters:

phoneNumber - Optional receiving phone number to filter SMS messages for (optional)

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

size - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

since - Optional filter SMSs received after given date time (optional)

before - Optional filter SMSs received before given date time (optional)

Returns:

PageSmsProjection

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	-

getSmsMessagesPaginatedWithHttpInfo

public ApiResponse<PageSmsProjection> getSmsMessagesPaginatedWithHttpInfo(UUID phoneNumber,
                                                                          Integer page,
                                                                          Integer size,
                                                                          String sort,
                                                                          Boolean unreadOnly,
                                                                          OffsetDateTime since,
                                                                          OffsetDateTime before)
                                                                   throws ApiException

Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Parameters:

phoneNumber - Optional receiving phone number to filter SMS messages for (optional)

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

size - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

since - Optional filter SMSs received after given date time (optional)

before - Optional filter SMSs received before given date time (optional)

Returns:

ApiResponse<PageSmsProjection>

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	-

getSmsMessagesPaginatedAsync

public okhttp3.Call getSmsMessagesPaginatedAsync(UUID phoneNumber,
                                                 Integer page,
                                                 Integer size,
                                                 String sort,
                                                 Boolean unreadOnly,
                                                 OffsetDateTime since,
                                                 OffsetDateTime before,
                                                 ApiCallback<PageSmsProjection> _callback)
                                          throws ApiException

Get all SMS messages in all phone numbers in paginated form. . (asynchronously) By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Parameters:

phoneNumber - Optional receiving phone number to filter SMS messages for (optional)

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

size - Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

since - Optional filter SMSs received after given date time (optional)

before - Optional filter SMSs received before given date time (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	-

getUnreadSmsCountCall

public okhttp3.Call getUnreadSmsCountCall(ApiCallback _callback)
                                   throws ApiException

Build call for getUnreadSmsCount

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	-

getUnreadSmsCount

public UnreadCount getUnreadSmsCount()
                              throws ApiException

Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Returns:

UnreadCount

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	-

getUnreadSmsCountWithHttpInfo

public ApiResponse<UnreadCount> getUnreadSmsCountWithHttpInfo()
                                                       throws ApiException

Get unread SMS count Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Returns:

ApiResponse<UnreadCount>

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	-

getUnreadSmsCountAsync

public okhttp3.Call getUnreadSmsCountAsync(ApiCallback<UnreadCount> _callback)
                                    throws ApiException

Get unread SMS count (asynchronously) Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

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	-