AligoTemplateProvider
Defined in: packages/provider/src/aligo/provider.template.ts:23
Interface for providers that support AlimTalk template management.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AligoTemplateProvider(
config):AligoTemplateProvider
Defined in: packages/provider/src/aligo/provider.template.ts:32
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”AligoTemplateProvider
Properties
Section titled “Properties”
readonlyid:"aligo"="aligo"
Defined in: packages/provider/src/aligo/provider.template.ts:26
Methods
Section titled “Methods”createTemplate()
Section titled “createTemplate()”createTemplate(
input,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.template.ts:57
Create a new template.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.createTemplate
deleteTemplate()
Section titled “deleteTemplate()”deleteTemplate(
code,ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.template.ts:72
Delete a template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.deleteTemplate
getTemplate()
Section titled “getTemplate()”getTemplate(
code,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.template.ts:79
Get a template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
Implementation of
Section titled “Implementation of”listTemplates()
Section titled “listTemplates()”listTemplates(
params?,ctx?):Promise<Result<Template[],KMsgError>>
Defined in: packages/provider/src/aligo/provider.template.ts:86
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>>
Implementation of
Section titled “Implementation of”TemplateProvider.listTemplates
requestTemplateInspection()
Section titled “requestTemplateInspection()”requestTemplateInspection(
code,ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.template.ts:93
Request inspection for a template (submits for approval review).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateInspectionProvider.requestTemplateInspection
updateTemplate()
Section titled “updateTemplate()”updateTemplate(
code,patch,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.template.ts:64
Update an existing template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>