com.mailslurp.apis

Class ContactControllerApi

java.lang.Object

com.mailslurp.apis.ContactControllerApi

public class ContactControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ContactControllerApi()
ContactControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ContactDto	createContact(CreateContactOptions createContactOptions) Create a contact
okhttp3.Call	createContactAsync(CreateContactOptions createContactOptions, ApiCallback<ContactDto> _callback) Create a contact (asynchronously)
okhttp3.Call	createContactCall(CreateContactOptions createContactOptions, ApiCallback _callback) Build call for createContact
ApiResponse<ContactDto>	createContactWithHttpInfo(CreateContactOptions createContactOptions) Create a contact
void	deleteContact(UUID contactId) Delete contact
okhttp3.Call	deleteContactAsync(UUID contactId, ApiCallback<Void> _callback) Delete contact (asynchronously)
okhttp3.Call	deleteContactCall(UUID contactId, ApiCallback _callback) Build call for deleteContact
ApiResponse<Void>	deleteContactWithHttpInfo(UUID contactId) Delete contact
PageContactProjection	getAllContacts(Integer page, Integer size, String sort) Get all contacts
okhttp3.Call	getAllContactsAsync(Integer page, Integer size, String sort, ApiCallback<PageContactProjection> _callback) Get all contacts (asynchronously)
okhttp3.Call	getAllContactsCall(Integer page, Integer size, String sort, ApiCallback _callback) Build call for getAllContacts
ApiResponse<PageContactProjection>	getAllContactsWithHttpInfo(Integer page, Integer size, String sort) Get all contacts
ApiClient	getApiClient()
ContactDto	getContact(UUID contactId) Get contact
okhttp3.Call	getContactAsync(UUID contactId, ApiCallback<ContactDto> _callback) Get contact (asynchronously)
okhttp3.Call	getContactCall(UUID contactId, ApiCallback _callback) Build call for getContact
List<ContactProjection>	getContacts() Get all contacts
okhttp3.Call	getContactsAsync(ApiCallback<List<ContactProjection>> _callback) Get all contacts (asynchronously)
okhttp3.Call	getContactsCall(ApiCallback _callback) Build call for getContacts
ApiResponse<List<ContactProjection>>	getContactsWithHttpInfo() Get all contacts
ApiResponse<ContactDto>	getContactWithHttpInfo(UUID contactId) Get contact
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactControllerApi

public ContactControllerApi()

ContactControllerApi

public ContactControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createContactCall

public okhttp3.Call createContactCall(CreateContactOptions createContactOptions,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createContact

Parameters:

createContactOptions - createContactOptions (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
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

createContact

public ContactDto createContact(CreateContactOptions createContactOptions)
                         throws ApiException

Create a contact

Parameters:

createContactOptions - createContactOptions (required)

Returns:

ContactDto

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
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

createContactWithHttpInfo

public ApiResponse<ContactDto> createContactWithHttpInfo(CreateContactOptions createContactOptions)
                                                  throws ApiException

Create a contact

Parameters:

createContactOptions - createContactOptions (required)

Returns:

ApiResponse<ContactDto>

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
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

createContactAsync

public okhttp3.Call createContactAsync(CreateContactOptions createContactOptions,
                                       ApiCallback<ContactDto> _callback)
                                throws ApiException

Create a contact (asynchronously)

Parameters:

createContactOptions - createContactOptions (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
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

deleteContactCall

public okhttp3.Call deleteContactCall(UUID contactId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteContact

Parameters:

contactId - contactId (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	-
401	Unauthorized	-
403	Forbidden	-

deleteContact

public void deleteContact(UUID contactId)
                   throws ApiException

Delete contact

Parameters:

contactId - contactId (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	-
401	Unauthorized	-
403	Forbidden	-

deleteContactWithHttpInfo

public ApiResponse<Void> deleteContactWithHttpInfo(UUID contactId)
                                            throws ApiException

Delete contact

Parameters:

contactId - contactId (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	-
401	Unauthorized	-
403	Forbidden	-

deleteContactAsync

public okhttp3.Call deleteContactAsync(UUID contactId,
                                       ApiCallback<Void> _callback)
                                throws ApiException

Delete contact (asynchronously)

Parameters:

contactId - contactId (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	-
401	Unauthorized	-
403	Forbidden	-

getAllContactsCall

public okhttp3.Call getAllContactsCall(Integer page,
                                       Integer size,
                                       String sort,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getAllContacts

Parameters:

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

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

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

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getAllContacts

public PageContactProjection getAllContacts(Integer page,
                                            Integer size,
                                            String sort)
                                     throws ApiException

Get all contacts

Parameters:

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

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

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

Returns:

PageContactProjection

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getAllContactsWithHttpInfo

public ApiResponse<PageContactProjection> getAllContactsWithHttpInfo(Integer page,
                                                                     Integer size,
                                                                     String sort)
                                                              throws ApiException

Get all contacts

Parameters:

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

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

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

Returns:

ApiResponse<PageContactProjection>

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getAllContactsAsync

public okhttp3.Call getAllContactsAsync(Integer page,
                                        Integer size,
                                        String sort,
                                        ApiCallback<PageContactProjection> _callback)
                                 throws ApiException

Get all contacts (asynchronously)

Parameters:

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

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

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

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContactCall

public okhttp3.Call getContactCall(UUID contactId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getContact

Parameters:

contactId - contactId (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContact

public ContactDto getContact(UUID contactId)
                      throws ApiException

Get contact

Parameters:

contactId - contactId (required)

Returns:

ContactDto

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContactWithHttpInfo

public ApiResponse<ContactDto> getContactWithHttpInfo(UUID contactId)
                                               throws ApiException

Get contact

Parameters:

contactId - contactId (required)

Returns:

ApiResponse<ContactDto>

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContactAsync

public okhttp3.Call getContactAsync(UUID contactId,
                                    ApiCallback<ContactDto> _callback)
                             throws ApiException

Get contact (asynchronously)

Parameters:

contactId - contactId (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContactsCall

public okhttp3.Call getContactsCall(ApiCallback _callback)
                             throws ApiException

Build call for getContacts

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContacts

public List<ContactProjection> getContacts()
                                    throws ApiException

Get all contacts

Returns:

List<ContactProjection>

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContactsWithHttpInfo

public ApiResponse<List<ContactProjection>> getContactsWithHttpInfo()
                                                             throws ApiException

Get all contacts

Returns:

ApiResponse<List<ContactProjection>>

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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getContactsAsync

public okhttp3.Call getContactsAsync(ApiCallback<List<ContactProjection>> _callback)
                              throws ApiException

Get all contacts (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-