Skip to content

Class: TemplateControllerApi

Hierarchy

  • BaseAPI

    ↳ TemplateControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new TemplateControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

• Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createTemplate

▸ createTemplate(requestParameters, initOverrides?): Promise<TemplateDto>

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

Parameters

Name Type
requestParameters CreateTemplateRequest
initOverrides? RequestInit

Returns

Promise<TemplateDto>

createTemplateRaw

▸ createTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<TemplateDto>>

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

Parameters

Name Type
requestParameters CreateTemplateRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<TemplateDto>>

deleteTemplate

▸ deleteTemplate(requestParameters, initOverrides?): Promise<void>

Delete template Delete email template

Parameters

Name Type
requestParameters DeleteTemplateRequest
initOverrides? RequestInit

Returns

Promise<void>

deleteTemplateRaw

▸ deleteTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Delete template Delete email template

Parameters

Name Type
requestParameters DeleteTemplateRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

getAllTemplates

▸ getAllTemplates(requestParameters, initOverrides?): Promise<PageTemplateProjection>

Get all templates in paginated format List templates

Parameters

Name Type
requestParameters GetAllTemplatesRequest
initOverrides? RequestInit

Returns

Promise<PageTemplateProjection>

getAllTemplatesRaw

▸ getAllTemplatesRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageTemplateProjection>>

Get all templates in paginated format List templates

Parameters

Name Type
requestParameters GetAllTemplatesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageTemplateProjection>>

getTemplate

▸ getTemplate(requestParameters, initOverrides?): Promise<TemplateDto>

Get email template Get template

Parameters

Name Type
requestParameters GetTemplateRequest
initOverrides? RequestInit

Returns

Promise<TemplateDto>

getTemplatePreviewHtml

▸ getTemplatePreviewHtml(requestParameters, initOverrides?): Promise<string>

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

Parameters

Name Type
requestParameters GetTemplatePreviewHtmlRequest
initOverrides? RequestInit

Returns

Promise<string>

getTemplatePreviewHtmlRaw

▸ getTemplatePreviewHtmlRaw(requestParameters, initOverrides?): Promise<ApiResponse<string>>

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

Parameters

Name Type
requestParameters GetTemplatePreviewHtmlRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<string>>

getTemplatePreviewJson

▸ getTemplatePreviewJson(requestParameters, initOverrides?): Promise<TemplatePreview>

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

Parameters

Name Type
requestParameters GetTemplatePreviewJsonRequest
initOverrides? RequestInit

Returns

Promise<TemplatePreview>

getTemplatePreviewJsonRaw

▸ getTemplatePreviewJsonRaw(requestParameters, initOverrides?): Promise<ApiResponse<TemplatePreview>>

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

Parameters

Name Type
requestParameters GetTemplatePreviewJsonRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<TemplatePreview>>

getTemplateRaw

▸ getTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<TemplateDto>>

Get email template Get template

Parameters

Name Type
requestParameters GetTemplateRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<TemplateDto>>

getTemplates

▸ getTemplates(initOverrides?): Promise<TemplateProjection[]>

Get all templates List templates

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<TemplateProjection[]>

getTemplatesRaw

▸ getTemplatesRaw(initOverrides?): Promise<ApiResponse<TemplateProjection[]>>

Get all templates List templates

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<TemplateProjection[]>>

request

▸ Protected request(context, initOverrides?): Promise<Response>

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request

updateTemplate

▸ updateTemplate(requestParameters, initOverrides?): Promise<TemplateDto>

Update email template Update template

Parameters

Name Type
requestParameters UpdateTemplateRequest
initOverrides? RequestInit

Returns

Promise<TemplateDto>

updateTemplateRaw

▸ updateTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<TemplateDto>>

Update email template Update template

Parameters

Name Type
requestParameters UpdateTemplateRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<TemplateDto>>

withMiddleware

▸ withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware

withPostMiddleware

▸ withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware

withPreMiddleware

▸ withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware