Skip to main content

TemplateApiClient

Accessed via client.templates().

Methods​

create​

create(request: TemplateRequest): Promise<Record<string, any>>

update​

update(templateId: string, request: TemplateRequest): Promise<Record<string, any>>

get​

get(templateId: string): Promise<Record<string, any>>

list​

list(page: number, size: number): Promise<Record<string, any>>

delete​

delete(templateId: string): Promise<void>

preview​

preview(templateId: string, variables: Record<string, any>): Promise<Record<string, string>>

previewRaw​

previewRaw(rawTemplateHtml: string, variables: Record<string, any>): Promise<Record<string, string>>

Renders arbitrary HTML through the template engine without persisting it.

TemplateRequestBuilder​

MethodDescription
name(name: string)Template name. Required.
subject(subject: string)Default subject line. Required.
content(content: string)Template body. Required.
build()Returns a TemplateRequest. Throws if name, subject, or content is missing/blank.