Skip to main content

Function: templateService()

templateService(client): object

Defined in: service/TemplateService.ts:26

Service for managing document and email templates

Parameters​

client​

GraphQLClient

Returns​

addAttachmentToEmailTemplate()​

addAttachmentToEmailTemplate(variables): Promise<EmailTemplate>

Adds an attachment to email template *

Parameters​

variables​

EmailTemplateAddAttachmentVariables

Attachment input data *

Returns​

Promise<EmailTemplate>

Promise<EmailTemplate> The updated email template

createDocumentTemplate()​

createDocumentTemplate(input): Promise&lt;DocumentTemplate>

Creates a new document template *

Parameters​

input​

DocumentTemplateCreateInput

Document template creation input *

Returns​

Promise&lt;DocumentTemplate>

Promise<DocumentTemplate> The created document template

createEmailTemplate()​

createEmailTemplate(input): Promise&lt;EmailTemplate>

Creates a new email template *

Parameters​

input​

EmailTemplateCreateInput

Email template creation input *

Returns​

Promise&lt;EmailTemplate>

Promise<EmailTemplate> The created email template

getDocumentTemplate()​

getDocumentTemplate(id): Promise&lt;DocumentTemplate>

Retrieves a specific document template *

Parameters​

id​

string

Document template ID *

Returns​

Promise&lt;DocumentTemplate>

Promise<DocumentTemplate> Document template data

getEmailTemplate()​

getEmailTemplate(id): Promise&lt;EmailTemplate>

Retrieves a specific email template *

Parameters​

id​

string

Email template ID *

Returns​

Promise&lt;EmailTemplate>

Promise<EmailTemplate> Email template data

getTemplates()​

getTemplates(input?): Promise&lt;TemplateResponse>

Fetches a list of templates with search criteria *

Parameters​

input?​

TemplateSearchInput

Template search input parameters *

Returns​

Promise&lt;TemplateResponse>

Promise<TemplateResponse> The templates response data

removeAttachmentFromEmailTemplate()​

removeAttachmentFromEmailTemplate(variables): Promise&lt;EmailTemplate>

Removes an attachment from email template *

Parameters​

variables​

EmailTemplateRemoveAttachmentVariables

Attachment removal input data *

Returns​

Promise&lt;EmailTemplate>

Promise<EmailTemplate> The updated email template

renderDocumentTemplateToPDF()​

renderDocumentTemplateToPDF(variables): Promise&lt;Base64File>

Renders a document template to PDF *

Parameters​

variables​

DocumentTemplateRenderToPDFVariables

Template render input data *

Returns​

Promise&lt;Base64File>

Promise<any> The PDF response

updateDocumentTemplate()​

updateDocumentTemplate(variables): Promise&lt;DocumentTemplate>

Updates an existing document template *

Parameters​

variables​

DocumentTemplateUpdateVariables

Document template update input *

Returns​

Promise&lt;DocumentTemplate>

Promise<DocumentTemplate> The updated document template

updateEmailTemplate()​

updateEmailTemplate(variables): Promise&lt;EmailTemplate>

Updates an existing email template *

Parameters​

variables​

EmailTemplateUpdateVariables

Email template update input *

Returns​

Promise&lt;EmailTemplate>

Promise<EmailTemplate> The updated email template