@lob/lob-typescript-sdk/dist/models/template-version.d.ts

Lob API wrapper

/**
 * Lob
 * The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
 *
 * The version of the OpenAPI document: 1.3.0
 * Contact: lob-openapi@lob.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { EngineHtml } from "./engine-html";
/**
 *
 * @export
 * @class TemplateVersion
 */
export declare class TemplateVersion {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `vrsn_`.
     * @type {string}
     * @memberof TemplateVersion
     */
    private "_id";
    get id(): string;
    set id(newValue: string);
    /**
     * An internal description that identifies this resource. Must be no longer than 255 characters.
     * @type {string}
     * @memberof TemplateVersion
     */
    "description"?: string | null;
    /**
     * An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back`  If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`.
     * @type {string}
     * @memberof TemplateVersion
     */
    "html": string;
    /**
     *
     * @type {EngineHtml}
     * @memberof TemplateVersion
     */
    "engine"?: EngineHtml | null;
    /**
     * Used by frontend, true if the template uses advanced features.
     * @type {boolean}
     * @memberof TemplateVersion
     */
    "suggest_json_editor"?: boolean;
    /**
     * Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named \'keys\', and its value is an array of strings.
     * @type {object}
     * @memberof TemplateVersion
     */
    "merge_variables"?: object;
    /**
     * A timestamp in ISO 8601 format of the date the resource was created.
     * @type {string}
     * @memberof TemplateVersion
     */
    "date_created"?: string;
    /**
     * A timestamp in ISO 8601 format of the date the resource was last modified.
     * @type {string}
     * @memberof TemplateVersion
     */
    "date_modified"?: string;
    /**
     * Only returned if the resource has been successfully deleted.
     * @type {boolean}
     * @memberof TemplateVersion
     */
    "deleted"?: boolean;
    /**
     * Value is resource type.
     * @type {string}
     * @memberof TemplateVersion
     */
    "object"?: TemplateVersionObjectEnum;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum TemplateVersionObjectEnum {
    Version = "version"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */