net.nextpulse.postmarkapp.api.server

Class TemplatesAPIApi

java.lang.Object

net.nextpulse.postmarkapp.api.server.TemplatesAPIApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T16:43:29.220+01:00")
public class TemplatesAPIApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TemplatesAPIApi()
TemplatesAPIApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
TemplateDetailResponse	deleteTemplate(String xPostmarkServerToken, Integer templateid) Delete a Template
ApiClient	getApiClient()
TemplateDetailResponse	getSingleTemplate(String xPostmarkServerToken, Integer templateid) Get a Template
TemplateListingResponse	listTemplates(String xPostmarkServerToken, BigDecimal count, BigDecimal offset) Get the Templates associated with this Server
SendEmailResponse	sendEmailWithTemplate(String xPostmarkServerToken, EmailWithTemplateRequest body) Send an email using a Template
void	setApiClient(ApiClient apiClient)
TemplateRecordResponse	templatesPost(String xPostmarkServerToken, CreateTemplateRequest body) Create a Template
TemplateValidationResponse	testTemplateContent(String xPostmarkServerToken, TemplateValidationRequest body) Test Template Content
TemplateRecordResponse	updateTemplate(String xPostmarkServerToken, Integer templateid, EditTemplateRequest body) Update a Template

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplatesAPIApi

public TemplatesAPIApi()

TemplatesAPIApi

public TemplatesAPIApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteTemplate

public TemplateDetailResponse deleteTemplate(String xPostmarkServerToken,
                                             Integer templateid)
                                      throws ApiException

Delete a Template

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

templateid - The ID for the Template you wish to delete. (required)

Returns:

TemplateDetailResponse

Throws:

ApiException - if fails to make API call

getSingleTemplate

public TemplateDetailResponse getSingleTemplate(String xPostmarkServerToken,
                                                Integer templateid)
                                         throws ApiException

Get a Template

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

templateid - The ID for the Template you wish to retrieve. (required)

Returns:

TemplateDetailResponse

Throws:

ApiException - if fails to make API call

listTemplates

public TemplateListingResponse listTemplates(String xPostmarkServerToken,
                                             BigDecimal count,
                                             BigDecimal offset)
                                      throws ApiException

Get the Templates associated with this Server

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

count - The number of Templates to return (required)

offset - The number of Templates to \"skip\" before returning results. (required)

Returns:

TemplateListingResponse

Throws:

ApiException - if fails to make API call

sendEmailWithTemplate

public SendEmailResponse sendEmailWithTemplate(String xPostmarkServerToken,
                                               EmailWithTemplateRequest body)
                                        throws ApiException

Send an email using a Template

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

body - (required)

Returns:

SendEmailResponse

Throws:

ApiException - if fails to make API call

templatesPost

public TemplateRecordResponse templatesPost(String xPostmarkServerToken,
                                            CreateTemplateRequest body)
                                     throws ApiException

Create a Template

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

body - (required)

Returns:

TemplateRecordResponse

Throws:

ApiException - if fails to make API call

testTemplateContent

public TemplateValidationResponse testTemplateContent(String xPostmarkServerToken,
                                                      TemplateValidationRequest body)
                                               throws ApiException

Test Template Content

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

body - (optional)

Returns:

TemplateValidationResponse

Throws:

ApiException - if fails to make API call

updateTemplate

public TemplateRecordResponse updateTemplate(String xPostmarkServerToken,
                                             Integer templateid,
                                             EditTemplateRequest body)
                                      throws ApiException

Update a Template

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

templateid - The ID for the Template you wish to update. (required)

body - (required)

Returns:

TemplateRecordResponse

Throws:

ApiException - if fails to make API call