com.mailslurp.apis

Class TemplateControllerApi

java.lang.Object

com.mailslurp.apis.TemplateControllerApi

public class TemplateControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TemplateControllerApi()
TemplateControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
TemplateDto	createTemplate(CreateTemplateOptions createTemplateOptions) Create a Template
okhttp3.Call	createTemplateAsync(CreateTemplateOptions createTemplateOptions, ApiCallback<TemplateDto> _callback) Create a Template (asynchronously)
okhttp3.Call	createTemplateCall(CreateTemplateOptions createTemplateOptions, ApiCallback _callback) Build call for createTemplate
ApiResponse<TemplateDto>	createTemplateWithHttpInfo(CreateTemplateOptions createTemplateOptions) Create a Template
void	deleteTemplate(UUID templateId) Delete Template
okhttp3.Call	deleteTemplateAsync(UUID templateId, ApiCallback<Void> _callback) Delete Template (asynchronously)
okhttp3.Call	deleteTemplateCall(UUID templateId, ApiCallback _callback) Build call for deleteTemplate
ApiResponse<Void>	deleteTemplateWithHttpInfo(UUID templateId) Delete Template
PageTemplateProjection	getAllTemplates(Integer page, Integer size, String sort) Get all Templates in paginated format
okhttp3.Call	getAllTemplatesAsync(Integer page, Integer size, String sort, ApiCallback<PageTemplateProjection> _callback) Get all Templates in paginated format (asynchronously)
okhttp3.Call	getAllTemplatesCall(Integer page, Integer size, String sort, ApiCallback _callback) Build call for getAllTemplates
ApiResponse<PageTemplateProjection>	getAllTemplatesWithHttpInfo(Integer page, Integer size, String sort) Get all Templates in paginated format
ApiClient	getApiClient()
TemplateDto	getTemplate(UUID templateId) Get Template
okhttp3.Call	getTemplateAsync(UUID templateId, ApiCallback<TemplateDto> _callback) Get Template (asynchronously)
okhttp3.Call	getTemplateCall(UUID templateId, ApiCallback _callback) Build call for getTemplate
List<TemplateProjection>	getTemplates() Get all Templates
okhttp3.Call	getTemplatesAsync(ApiCallback<List<TemplateProjection>> _callback) Get all Templates (asynchronously)
okhttp3.Call	getTemplatesCall(ApiCallback _callback) Build call for getTemplates
ApiResponse<List<TemplateProjection>>	getTemplatesWithHttpInfo() Get all Templates
ApiResponse<TemplateDto>	getTemplateWithHttpInfo(UUID templateId) Get Template
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateControllerApi

public TemplateControllerApi()

TemplateControllerApi

public TemplateControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createTemplateCall

public okhttp3.Call createTemplateCall(CreateTemplateOptions createTemplateOptions,
                                       ApiCallback _callback)
                                throws ApiException

Build call for createTemplate

Parameters:

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

createTemplate

public TemplateDto createTemplate(CreateTemplateOptions createTemplateOptions)
                           throws ApiException

Create a Template

Parameters:

createTemplateOptions - createTemplateOptions (required)

Returns:

TemplateDto

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	-

createTemplateWithHttpInfo

public ApiResponse<TemplateDto> createTemplateWithHttpInfo(CreateTemplateOptions createTemplateOptions)
                                                    throws ApiException

Create a Template

Parameters:

createTemplateOptions - createTemplateOptions (required)

Returns:

ApiResponse<TemplateDto>

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	-

createTemplateAsync

public okhttp3.Call createTemplateAsync(CreateTemplateOptions createTemplateOptions,
                                        ApiCallback<TemplateDto> _callback)
                                 throws ApiException

Create a Template (asynchronously)

Parameters:

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

deleteTemplateCall

public okhttp3.Call deleteTemplateCall(UUID templateId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for deleteTemplate

Parameters:

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

deleteTemplate

public void deleteTemplate(UUID templateId)
                    throws ApiException

Delete Template

Parameters:

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

deleteTemplateWithHttpInfo

public ApiResponse<Void> deleteTemplateWithHttpInfo(UUID templateId)
                                             throws ApiException

Delete Template

Parameters:

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

deleteTemplateAsync

public okhttp3.Call deleteTemplateAsync(UUID templateId,
                                        ApiCallback<Void> _callback)
                                 throws ApiException

Delete Template (asynchronously)

Parameters:

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

getAllTemplatesCall

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

Build call for getAllTemplates

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	-

getAllTemplates

public PageTemplateProjection getAllTemplates(Integer page,
                                              Integer size,
                                              String sort)
                                       throws ApiException

Get all Templates in paginated format

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:

PageTemplateProjection

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	-

getAllTemplatesWithHttpInfo

public ApiResponse<PageTemplateProjection> getAllTemplatesWithHttpInfo(Integer page,
                                                                       Integer size,
                                                                       String sort)
                                                                throws ApiException

Get all Templates in paginated format

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

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	-

getAllTemplatesAsync

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

Get all Templates in paginated format (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	-

getTemplateCall

public okhttp3.Call getTemplateCall(UUID templateId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getTemplate

Parameters:

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

getTemplate

public TemplateDto getTemplate(UUID templateId)
                        throws ApiException

Get Template

Parameters:

templateId - TemplateId (required)

Returns:

TemplateDto

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	-

getTemplateWithHttpInfo

public ApiResponse<TemplateDto> getTemplateWithHttpInfo(UUID templateId)
                                                 throws ApiException

Get Template

Parameters:

templateId - TemplateId (required)

Returns:

ApiResponse<TemplateDto>

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	-

getTemplateAsync

public okhttp3.Call getTemplateAsync(UUID templateId,
                                     ApiCallback<TemplateDto> _callback)
                              throws ApiException

Get Template (asynchronously)

Parameters:

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

getTemplatesCall

public okhttp3.Call getTemplatesCall(ApiCallback _callback)
                              throws ApiException

Build call for getTemplates

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	-

getTemplates

public List<TemplateProjection> getTemplates()
                                      throws ApiException

Get all Templates

Returns:

List<TemplateProjection>

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	-

getTemplatesWithHttpInfo

public ApiResponse<List<TemplateProjection>> getTemplatesWithHttpInfo()
                                                               throws ApiException

Get all Templates

Returns:

ApiResponse<List<TemplateProjection>>

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	-

getTemplatesAsync

public okhttp3.Call getTemplatesAsync(ApiCallback<List<TemplateProjection>> _callback)
                               throws ApiException

Get all Templates (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	-