TemplateProvider
Defined in: packages/core/src/provider.ts:77
Interface for providers that support AlimTalk template management.
Methods
Section titled “Methods”createTemplate()
Section titled “createTemplate()”createTemplate(
input,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/core/src/provider.ts:81
Create a new template.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
deleteTemplate()
Section titled “deleteTemplate()”deleteTemplate(
code,ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/core/src/provider.ts:96
Delete a template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void, KMsgError>>
getTemplate()
Section titled “getTemplate()”getTemplate(
code,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/core/src/provider.ts:103
Get a template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
listTemplates()
Section titled “listTemplates()”listTemplates(
params?,ctx?):Promise<Result<Template[],KMsgError>>
Defined in: packages/core/src/provider.ts:110
List templates with optional filtering and pagination.
Parameters
Section titled “Parameters”params?
Section titled “params?”limit?
Section titled “limit?”number
number
status?
Section titled “status?”string
Returns
Section titled “Returns”Promise<Result<Template[], KMsgError>>
updateTemplate()
Section titled “updateTemplate()”updateTemplate(
code,patch,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/core/src/provider.ts:88
Update an existing template by code.
Parameters
Section titled “Parameters”string