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 Create an email template with variables for use with templated transactional emails.
okhttp3.Call	createTemplateAsync(CreateTemplateOptions createTemplateOptions, ApiCallback<TemplateDto> _callback) Create a Template (asynchronously) Create an email template with variables for use with templated transactional emails.
okhttp3.Call	createTemplateCall(CreateTemplateOptions createTemplateOptions, ApiCallback _callback) Build call for createTemplate
ApiResponse<TemplateDto>	createTemplateWithHttpInfo(CreateTemplateOptions createTemplateOptions) Create a Template Create an email template with variables for use with templated transactional emails.
void	deleteTemplate(UUID templateId) Delete email template Delete template
okhttp3.Call	deleteTemplateAsync(UUID templateId, ApiCallback<Void> _callback) Delete email template (asynchronously) Delete template
okhttp3.Call	deleteTemplateCall(UUID templateId, ApiCallback _callback) Build call for deleteTemplate
ApiResponse<Void>	deleteTemplateWithHttpInfo(UUID templateId) Delete email template Delete template
PageTemplateProjection	getAllTemplates(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) List templates Get all templates in paginated format
okhttp3.Call	getAllTemplatesAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageTemplateProjection> _callback) List templates (asynchronously) Get all templates in paginated format
okhttp3.Call	getAllTemplatesCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getAllTemplates
ApiResponse<PageTemplateProjection>	getAllTemplatesWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) List templates Get all templates in paginated format
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
TemplateDto	getTemplate(UUID templateId) Get template Get email template
okhttp3.Call	getTemplateAsync(UUID templateId, ApiCallback<TemplateDto> _callback) Get template (asynchronously) Get email template
okhttp3.Call	getTemplateCall(UUID templateId, ApiCallback _callback) Build call for getTemplate
String	getTemplatePreviewHtml(UUID templateId) Get template preview HTML Get email template preview with passed template variables in HTML format for browsers.
okhttp3.Call	getTemplatePreviewHtmlAsync(UUID templateId, ApiCallback<String> _callback) Get template preview HTML (asynchronously) Get email template preview with passed template variables in HTML format for browsers.
okhttp3.Call	getTemplatePreviewHtmlCall(UUID templateId, ApiCallback _callback) Build call for getTemplatePreviewHtml
ApiResponse<String>	getTemplatePreviewHtmlWithHttpInfo(UUID templateId) Get template preview HTML Get email template preview with passed template variables in HTML format for browsers.
TemplatePreview	getTemplatePreviewJson(UUID templateId) Get template preview Json Get email template preview with passed template variables in JSON format.
okhttp3.Call	getTemplatePreviewJsonAsync(UUID templateId, ApiCallback<TemplatePreview> _callback) Get template preview Json (asynchronously) Get email template preview with passed template variables in JSON format.
okhttp3.Call	getTemplatePreviewJsonCall(UUID templateId, ApiCallback _callback) Build call for getTemplatePreviewJson
ApiResponse<TemplatePreview>	getTemplatePreviewJsonWithHttpInfo(UUID templateId) Get template preview Json Get email template preview with passed template variables in JSON format.
List<TemplateProjection>	getTemplates() List templates Get all templates
okhttp3.Call	getTemplatesAsync(ApiCallback<List<TemplateProjection>> _callback) List templates (asynchronously) Get all templates
okhttp3.Call	getTemplatesCall(ApiCallback _callback) Build call for getTemplates
ApiResponse<List<TemplateProjection>>	getTemplatesWithHttpInfo() List templates Get all templates
ApiResponse<TemplateDto>	getTemplateWithHttpInfo(UUID templateId) Get template Get email template
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
TemplateDto	updateTemplate(UUID templateId, CreateTemplateOptions createTemplateOptions) Update template Update email template
okhttp3.Call	updateTemplateAsync(UUID templateId, CreateTemplateOptions createTemplateOptions, ApiCallback<TemplateDto> _callback) Update template (asynchronously) Update email template
okhttp3.Call	updateTemplateCall(UUID templateId, CreateTemplateOptions createTemplateOptions, ApiCallback _callback) Build call for updateTemplate
ApiResponse<TemplateDto>	updateTemplateWithHttpInfo(UUID templateId, CreateTemplateOptions createTemplateOptions) Update template Update email template

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)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createTemplateCall

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

Build call for createTemplate

Parameters:

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	-

createTemplate

public TemplateDto createTemplate(CreateTemplateOptions createTemplateOptions)
                           throws ApiException

Create a Template Create an email template with variables for use with templated transactional emails.

Parameters:

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	-

createTemplateWithHttpInfo

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

Create a Template Create an email template with variables for use with templated transactional emails.

Parameters:

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	-

createTemplateAsync

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

Create a Template (asynchronously) Create an email template with variables for use with templated transactional emails.

Parameters:

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	-

deleteTemplateCall

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

Build call for deleteTemplate

Parameters:

templateId - Template ID (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	-

deleteTemplate

public void deleteTemplate(UUID templateId)
                    throws ApiException

Delete email template Delete template

Parameters:

templateId - Template ID (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	-

deleteTemplateWithHttpInfo

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

Delete email template Delete template

Parameters:

templateId - Template ID (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	-

deleteTemplateAsync

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

Delete email template (asynchronously) Delete template

Parameters:

templateId - Template ID (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	-

getAllTemplatesCall

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

Build call for getAllTemplates

Parameters:

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

size - Optional page size in 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	-

getAllTemplates

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

List templates Get all templates in paginated format

Parameters:

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

size - Optional page size in 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:

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	-

getAllTemplatesWithHttpInfo

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

List templates Get all templates in paginated format

Parameters:

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

size - Optional page size in 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<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	-

getAllTemplatesAsync

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

List templates (asynchronously) Get all templates in paginated format

Parameters:

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

size - Optional page size in 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	-

getTemplateCall

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

Build call for getTemplate

Parameters:

templateId - Template ID (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	-

getTemplate

public TemplateDto getTemplate(UUID templateId)
                        throws ApiException

Get template Get email template

Parameters:

templateId - Template ID (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	-

getTemplateWithHttpInfo

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

Get template Get email template

Parameters:

templateId - Template ID (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	-

getTemplateAsync

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

Get template (asynchronously) Get email template

Parameters:

templateId - Template ID (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	-

getTemplatePreviewHtmlCall

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

Build call for getTemplatePreviewHtml

Parameters:

templateId - Template ID (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	-

getTemplatePreviewHtml

public String getTemplatePreviewHtml(UUID templateId)
                              throws ApiException

Get template preview HTML Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.

Parameters:

templateId - Template ID (required)

Returns:

String

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	-

getTemplatePreviewHtmlWithHttpInfo

public ApiResponse<String> getTemplatePreviewHtmlWithHttpInfo(UUID templateId)
                                                       throws ApiException

Get template preview HTML Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.

Parameters:

templateId - Template ID (required)

Returns:

ApiResponse<String>

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	-

getTemplatePreviewHtmlAsync

public okhttp3.Call getTemplatePreviewHtmlAsync(UUID templateId,
                                                ApiCallback<String> _callback)
                                         throws ApiException

Get template preview HTML (asynchronously) Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.

Parameters:

templateId - Template ID (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	-

getTemplatePreviewJsonCall

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

Build call for getTemplatePreviewJson

Parameters:

templateId - Template ID (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	-

getTemplatePreviewJson

public TemplatePreview getTemplatePreviewJson(UUID templateId)
                                       throws ApiException

Get template preview Json Get email template preview with passed template variables in JSON format. Pass template variables as query params.

Parameters:

templateId - Template ID (required)

Returns:

TemplatePreview

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	-

getTemplatePreviewJsonWithHttpInfo

public ApiResponse<TemplatePreview> getTemplatePreviewJsonWithHttpInfo(UUID templateId)
                                                                throws ApiException

Get template preview Json Get email template preview with passed template variables in JSON format. Pass template variables as query params.

Parameters:

templateId - Template ID (required)

Returns:

ApiResponse<TemplatePreview>

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	-

getTemplatePreviewJsonAsync

public okhttp3.Call getTemplatePreviewJsonAsync(UUID templateId,
                                                ApiCallback<TemplatePreview> _callback)
                                         throws ApiException

Get template preview Json (asynchronously) Get email template preview with passed template variables in JSON format. Pass template variables as query params.

Parameters:

templateId - Template ID (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	-

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	-

getTemplates

public List<TemplateProjection> getTemplates()
                                      throws ApiException

List templates 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	-

getTemplatesWithHttpInfo

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

List templates 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	-

getTemplatesAsync

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

List templates (asynchronously) Get all templates

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	-

updateTemplateCall

public okhttp3.Call updateTemplateCall(UUID templateId,
                                       CreateTemplateOptions createTemplateOptions,
                                       ApiCallback _callback)
                                throws ApiException

Build call for updateTemplate

Parameters:

templateId - Template ID (required)

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	-

updateTemplate

public TemplateDto updateTemplate(UUID templateId,
                                  CreateTemplateOptions createTemplateOptions)
                           throws ApiException

Update template Update email template

Parameters:

templateId - Template ID (required)

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	-

updateTemplateWithHttpInfo

public ApiResponse<TemplateDto> updateTemplateWithHttpInfo(UUID templateId,
                                                           CreateTemplateOptions createTemplateOptions)
                                                    throws ApiException

Update template Update email template

Parameters:

templateId - Template ID (required)

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	-

updateTemplateAsync

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

Update template (asynchronously) Update email template

Parameters:

templateId - Template ID (required)

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	-