Class: TemplateService
Defined in: service/TemplateService.ts:124
Backwards-compatible class form. New code should call templateService(client).
Constructors
Constructor
new TemplateService(
client):TemplateService
Defined in: service/TemplateService.ts:126
Parameters
client
Returns
TemplateService
Methods
addAttachmentToEmailTemplate()
addAttachmentToEmailTemplate(
variables):Promise<EmailTemplate>
Defined in: service/TemplateService.ts:171
Adds an attachment to email template
Parameters
variables
EmailTemplateAddAttachmentVariables
Attachment input data
Returns
Promise<EmailTemplate>
createDocumentTemplate()
createDocumentTemplate(
input):Promise<DocumentTemplate>
Defined in: service/TemplateService.ts:146
Creates a new document template
Parameters
input
Document template creation input
Returns
Promise<DocumentTemplate>
createEmailTemplate()
createEmailTemplate(
input):Promise<EmailTemplate>
Defined in: service/TemplateService.ts:161
Creates a new email template
Parameters
input
Email template creation input
Returns
Promise<EmailTemplate>
getDocumentTemplate()
getDocumentTemplate(
id):Promise<DocumentTemplate>
Defined in: service/TemplateService.ts:131
Retrieves a specific document template
Parameters
id
string
Document template ID
Returns
Promise<DocumentTemplate>
getEmailTemplate()
getEmailTemplate(
id):Promise<EmailTemplate>
Defined in: service/TemplateService.ts:136
Retrieves a specific email template
Parameters
id
string
Email template ID
Returns
Promise<EmailTemplate>
getTemplates()
getTemplates(
input?):Promise<TemplateResponse>
Defined in: service/TemplateService.ts:141
Fetches a list of templates with search criteria
Parameters
input?
Template search input parameters
Returns
Promise<TemplateResponse>
removeAttachmentFromEmailTemplate()
removeAttachmentFromEmailTemplate(
variables):Promise<EmailTemplate>
Defined in: service/TemplateService.ts:176
Removes an attachment from email template
Parameters
variables
EmailTemplateRemoveAttachmentVariables
Attachment removal input data
Returns
Promise<EmailTemplate>
renderDocumentTemplateToPDF()
renderDocumentTemplateToPDF(
variables):Promise<Base64File>
Defined in: service/TemplateService.ts:156
Renders a document template to PDF
Parameters
variables
DocumentTemplateRenderToPDFVariables
Template render input data
Returns
Promise<Base64File>
updateDocumentTemplate()
updateDocumentTemplate(
variables):Promise<DocumentTemplate>
Defined in: service/TemplateService.ts:151
Updates an existing document template
Parameters
variables
DocumentTemplateUpdateVariables
Document template update input
Returns
Promise<DocumentTemplate>
updateEmailTemplate()
updateEmailTemplate(
variables):Promise<EmailTemplate>
Defined in: service/TemplateService.ts:166
Updates an existing email template
Parameters
variables
Email template update input
Returns
Promise<EmailTemplate>