Class TemplateControllerApi

Hierarchy

BaseAPI
- TemplateControllerApi

Constructors

constructor

new TemplateControllerApi(configuration?: Configuration): TemplateControllerApi
Parameters
- configuration: Configuration = ...
Returns TemplateControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createTemplate

createTemplate(requestParameters: CreateTemplateRequest, initOverrides?: RequestInit): Promise<TemplateDto>
Create an email template with variables for use with templated transactional emails. Create a Template
Parameters
- requestParameters: CreateTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<TemplateDto>

createTemplateRaw

createTemplateRaw(requestParameters: CreateTemplateRequest, initOverrides?: RequestInit): Promise<ApiResponse<TemplateDto>>
Create an email template with variables for use with templated transactional emails. Create a Template
Parameters
- requestParameters: CreateTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TemplateDto>>

deleteTemplate

deleteTemplate(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit): Promise<void>
Delete template Delete email template
Parameters
- requestParameters: DeleteTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteTemplateRaw

deleteTemplateRaw(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete template Delete email template
Parameters
- requestParameters: DeleteTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getAllTemplates

getAllTemplates(requestParameters: GetAllTemplatesRequest, initOverrides?: RequestInit): Promise<PageTemplateProjection>
Get all templates in paginated format List templates
Parameters
- requestParameters: GetAllTemplatesRequest
- Optional initOverrides: RequestInit
Returns Promise<PageTemplateProjection>

getAllTemplatesRaw

getAllTemplatesRaw(requestParameters: GetAllTemplatesRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageTemplateProjection>>
Get all templates in paginated format List templates
Parameters
- requestParameters: GetAllTemplatesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageTemplateProjection>>

getTemplate

getTemplate(requestParameters: GetTemplateRequest, initOverrides?: RequestInit): Promise<TemplateDto>
Get email template Get template
Parameters
- requestParameters: GetTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<TemplateDto>

getTemplatePreviewHtml

getTemplatePreviewHtml(requestParameters: GetTemplatePreviewHtmlRequest, initOverrides?: RequestInit): 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
- requestParameters: GetTemplatePreviewHtmlRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

getTemplatePreviewHtmlRaw

getTemplatePreviewHtmlRaw(requestParameters: GetTemplatePreviewHtmlRequest, initOverrides?: RequestInit): 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
- requestParameters: GetTemplatePreviewHtmlRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

getTemplatePreviewJson

getTemplatePreviewJson(requestParameters: GetTemplatePreviewJsonRequest, initOverrides?: RequestInit): Promise<TemplatePreview>
Get email template preview with passed template variables in JSON format. Pass template variables as query params. Get template preview Json
Parameters
- requestParameters: GetTemplatePreviewJsonRequest
- Optional initOverrides: RequestInit
Returns Promise<TemplatePreview>

getTemplatePreviewJsonRaw

getTemplatePreviewJsonRaw(requestParameters: GetTemplatePreviewJsonRequest, initOverrides?: RequestInit): 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
- requestParameters: GetTemplatePreviewJsonRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TemplatePreview>>

getTemplateRaw

getTemplateRaw(requestParameters: GetTemplateRequest, initOverrides?: RequestInit): Promise<ApiResponse<TemplateDto>>
Get email template Get template
Parameters
- requestParameters: GetTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TemplateDto>>

getTemplates

getTemplates(initOverrides?: RequestInit): Promise<TemplateProjection[]>
Get all templates List templates
Parameters
- Optional initOverrides: RequestInit
Returns Promise<TemplateProjection[]>

getTemplatesRaw

getTemplatesRaw(initOverrides?: RequestInit): Promise<ApiResponse<TemplateProjection[]>>
Get all templates List templates
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TemplateProjection[]>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

updateTemplate

updateTemplate(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit): Promise<TemplateDto>
Update email template Update template
Parameters
- requestParameters: UpdateTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<TemplateDto>

updateTemplateRaw

updateTemplateRaw(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit): Promise<ApiResponse<TemplateDto>>
Update email template Update template
Parameters
- requestParameters: UpdateTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TemplateDto>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware