TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:15

Constructors

Constructor

new TemplateBuilder(): TemplateBuilder

Returns

TemplateBuilder

Methods

appLinkButton()

appLinkButton(name, options): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:172

Add an app link button

Parameters

name

string

options

androidScheme?

string

androidUrl?

string

iosScheme?

string

iosUrl?

string

Returns

TemplateBuilder

---

botKeywordButton()

botKeywordButton(name): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:204

Add a bot keyword button

Parameters

name

string

Returns

TemplateBuilder

---

build()

build(): object

Defined in: packages/template/src/builder/template.builder.ts:374

Build the final template

Returns

object

buttons?

optional buttons?: object[]

category

category: TemplateCategory

code

code: string

content

content: string

id

id: string

metadata

metadata: object = TemplateMetadataSchema

metadata.approvedAt?

optional approvedAt?: Date

metadata.createdAt

createdAt: Date

metadata.rejectedAt?

optional rejectedAt?: Date

metadata.rejectionReason?

optional rejectionReason?: string

metadata.updatedAt

updatedAt: Date

metadata.usage

usage: object = TemplateUsageStatsSchema

metadata.usage.delivered

delivered: number

metadata.usage.failed

failed: number

metadata.usage.sent

sent: number

name

name: string

provider

provider: string

status

status: TemplateStatus

variables?

optional variables?: object[]

---

button()

button(button): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:224

Add a custom button

Parameters

button

linkAndroid?

string = ...

linkIos?

string = ...

linkMobile?

string = ...

linkPc?

string = ...

name

string = ...

schemeAndroid?

string = ...

schemeIos?

string = ...

type

"WL" | "AL" | "DS" | "BK" | "MD" = ...

Returns

TemplateBuilder

---

category()

category(category): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:68

Set template category

Parameters

category

TemplateCategory

Returns

TemplateBuilder

---

clearButtons()

clearButtons(): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:240

Clear all buttons

Returns

TemplateBuilder

---

clone()

clone(): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:347

Clone the current builder

Returns

TemplateBuilder

---

code()

code(code): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:38

Set template code (provider specific)

Parameters

code

string

Returns

TemplateBuilder

---

content()

content(content): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:46

Set template content with variables

Parameters

content

string

Returns

TemplateBuilder

---

deliveryButton()

deliveryButton(name): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:194

Add a delivery tracking button

Parameters

name

string

Returns

TemplateBuilder

---

messageDeliveryButton()

messageDeliveryButton(name): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:214

Add a message delivery button

Parameters

name

string

Returns

TemplateBuilder

---

metadata()

metadata(metadata): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:248

Set template metadata

Parameters

metadata

Partial<AlimTalkTemplate["metadata"]>

Returns

TemplateBuilder

---

name()

name(name): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:30

Set template name

Parameters

name

string

Returns

TemplateBuilder

---

preview()

preview(sampleVariables?): string

Defined in: packages/template/src/builder/template.builder.ts:291

Preview the template with sample variables

Parameters

sampleVariables?

Record<string, any> = {}

Returns

string

---

provider()

provider(provider): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:76

Set template provider

Parameters

provider

string

Returns

TemplateBuilder

---

reset()

reset(): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:357

Reset the builder to start fresh

Returns

TemplateBuilder

---

status()

status(status): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:84

Set template status

Parameters

status

TemplateStatus

Returns

TemplateBuilder

---

validate()

validate(): object

Defined in: packages/template/src/builder/template.builder.ts:266

Validate the current template

Returns

object

errors

errors: string[]

isValid

isValid: boolean

warnings

warnings: string[]

---

variable()

variable(name, type?, required?, options?): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:92

Add a variable definition

Parameters

name

string

type?

"string" | "number" | "date" | "custom"

required?

boolean = true

options?

description?

string

example?

string

format?

string

maxLength?

number

Returns

TemplateBuilder

---

variables()

variables(variables): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:126

Add multiple variables at once

Parameters

variables

object[]

Returns

TemplateBuilder

---

webLinkButton()

webLinkButton(name, mobileUrl?, pcUrl?): TemplateBuilder

Defined in: packages/template/src/builder/template.builder.ts:156

Add a web link button

Parameters

name

string

mobileUrl?

string

pcUrl?

string

Returns

TemplateBuilder