WebstoreTemplatePreviewDto

Represents a template compiled and ready to render.

compatibilityModeenumRequired

Specifies the dialect a webstore template is written in.

Possible enum values

invalid
No compatibility mode specified. This value is typically used as a default or uninitialized state.
paynow
A native PayNow template.
tebex
A template written for Tebex, rendered through a compatibility layer so it works without changes.

compiledWebstoreTemplateCompiledFileDto[]Required

The template's files after compilation, including any that failed to compile.

content_typestringRequired

The MIME type of the file.

file_namestringRequired

The name of the file within the template.

compiledstringOptional

The compiled output of the file, or null when compilation failed.

errorstringOptional

The error compilation raised, or null when the file compiled successfully.

compiled_atstringRequired

The date and time the template was compiled.

schemaWebstoreTemplateSchemaDtoOptional

Represents a template's schema, declared by its author: who maintains it, how it receives updates and the settings a store can configure without editing the template's files.

authorstringRequired

The name of the template's author.

configWebstoreTemplateSchemaSectionDto[]Required

The sections of settings the template exposes, in display order.

headerstringRequired

The heading shown above the section.

optionsWebstoreTemplateSchemaOptionDto[]Required

The settings in the section, in display order.

→ WebstoreTemplateSchemaOptionDto

support_emailstringOptional

The email address to contact for support with the template, or null when none is given.

support_urlstringOptional

The URL to visit for support with the template, or null when none is given.

updatesWebstoreTemplateSchemaUpdatesDtoOptional

Represents how a template receives updates from its author.

github_branchstringRequired

The branch of the repository updates are pulled from.

supportedbooleanRequired

Indicates whether the template can be updated in place.

version_check_supportedbooleanRequired

Indicates whether the newest available version can be looked up before updating.

github_tokenstringOptional

The token used to read a private repository, or null when the repository is public.

github_urlstringOptional

The URL of the GitHub repository updates are pulled from, or null when updates do not come from GitHub.

versionstringOptional

The version of the template currently installed, or null when the template does not declare one.

Example

{
  "compatibilityMode": "invalid",
  "compiled": [
    {
      "content_type": "string",
      "file_name": "string",
      "compiled": "string",
      "error": "string"
    }
  ],
  "compiled_at": "2024-01-01T00:00:00Z",
  "schema": {
    "author": "string",
    "config": [
      {
        "header": "string",
        "options": [
          {
            "id": "string",
            "name": "string",
            "nested_options": [
              {}
            ],
            "type": "string",
            "values": [
              "string"
            ],
            "default": {},
            "description": "string",
            "max": 0,
            "min": 0,
            "multiline": true,
            "numeric": true
          }
        ]
      }
    ],
    "support_email": "string",
    "support_url": "string",
    "updates": {
      "github_branch": "string",
      "supported": true,
      "version_check_supported": true,
      "github_token": "string",
      "github_url": "string",
      "version": "string"
    }
  }
}