Skip to main content

DocumentTemplate

No description

type DocumentTemplate implements IBaseTemplate {
  id: String!
  contents: [LocalizedTemplateContent!]
  names(
    language: String
  ): [LocalizedString!]!
  content: String
  customQuery: String
  queryVariables: String
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdBy: Int
  lastModifiedBy: Int
  fileNames: [LocalizedString!]!
  isDefaultOrderPdf: Boolean!
  isDefaultQuotePdf: Boolean!
}

Fields

`DocumentTemplate.id` ● `String!` non-null scalar

A unique identifier for the template

`DocumentTemplate.contents` ● `[LocalizedTemplateContent!]` list object

Uploaded handlebars template content, per given language

`DocumentTemplate.names` ● `[LocalizedString!]!` non-null object

The name of the template per given language

`DocumentTemplate.names.language` ● `String` scalar

Filter for filtering LocalizedString entities by language

`DocumentTemplate.content` ● `String` scalar

The content of the template

`DocumentTemplate.customQuery` ● `String` scalar

GraphQL query to be executed before rendering the template to fetch additional data not in the original event payload.

`DocumentTemplate.queryVariables` ● `String` scalar

Variables that are use in the custom query, can use handlebars variables. Has to be a valid JSON string after rendering

`DocumentTemplate.createdAt` ● `DateTime!` non-null scalar

The creation date of this Template

`DocumentTemplate.lastModifiedAt` ● `DateTime!` non-null scalar

The last modified date of this Template

`DocumentTemplate.createdBy` ● `Int` scalar

ID of the user who created this Template

`DocumentTemplate.lastModifiedBy` ● `Int` scalar

ID of the user who last modified this Template

`DocumentTemplate.fileNames` ● `[LocalizedString!]!` non-null object

File name to use when rendering a document template per given language, supports handlebars variables

`DocumentTemplate.isDefaultOrderPdf` ● `Boolean!` non-null scalar

Indicates whether the template is used for default order PDF generation

`DocumentTemplate.isDefaultQuotePdf` ● `Boolean!` non-null scalar

Indicates whether the template is used for default quote PDF generation

Interfaces

`IBaseTemplate` interface

Returned By

documentTemplateCreate mutation ● documentTemplateUpdate mutation

Member Of

EmailTemplate object