/**
 * 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 * as Models from "./index";
import { LtrUseType } from "./ltr-use-type";
import { MailType } from "./mail-type";
import { QrCode } from "./qr-code";
/**
 *
 * @export
 * @class LetterEditable
 */
export declare class LetterEditable {
    constructor(input?: any);
    /**
     * An internal description that identifies this resource. Must be no longer than 255 characters.
     * @type {string}
     * @memberof LetterEditable
     */
    "description"?: string | null;
    /**
     * Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. \'{\"customer_id\" : \"NEWYORK2015\"}\' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
     * @type {{ [key: string]: string; }}
     * @memberof LetterEditable
     */
    "metadata"?: {
        [key: string]: string;
    };
    /**
     *
     * @type {MailType}
     * @memberof LetterEditable
     */
    "mail_type"?: MailType;
    /**
     * You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `\'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
     * @type {object}
     * @memberof LetterEditable
     */
    "merge_variables"?: object | null;
    /**
     * A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
     * @type {string}
     * @memberof LetterEditable
     */
    "send_date"?: string;
    /**
     * Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white.
     * @type {boolean}
     * @memberof LetterEditable
     */
    "color": boolean;
    /**
     * Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`.
     * @type {boolean}
     * @memberof LetterEditable
     */
    "double_sided"?: boolean;
    /**
     * Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template.   * `top_first_page` - (default) print address information at the top of your provided first page   * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page)   * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page   * `bottom_first_page` - print address information at the bottom of your provided first page
     * @type {string}
     * @memberof LetterEditable
     */
    "address_placement"?: LetterEditableAddressPlacementEnum;
    /**
     * indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes.  To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred.
     * @type {any}
     * @memberof LetterEditable
     */
    "return_envelope"?: string | boolean | null;
    /**
     * Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf).
     * @type {number}
     * @memberof LetterEditable
     */
    "perforated_page"?: number | null;
    /**
     *
     * @type {string}
     * @memberof LetterEditable
     */
    "custom_envelope"?: string | null;
    /**
     * Must either be an address ID or an inline object with correct address parameters.
     * @type {any}
     * @memberof LetterEditable
     */
    "to": string | Models.AddressEditable | null;
    /**
     * Must either be an address ID or an inline object with correct address parameters.
     * @type {any}
     * @memberof LetterEditable
     */
    "from": string | Models.AddressEditable | null;
    /**
     * PDF file containing the letter\'s formatting.
     * @type {string}
     * @memberof LetterEditable
     */
    "file": string;
    /**
     * Add an extra service to your letter:   * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet.   * `certified_return_receipt` - request an electronic copy of the recipient\'s signature to prove delivery of your certified letter   * `registered` - provides tracking and confirmation for international addresses
     * @type {string}
     * @memberof LetterEditable
     */
    "extra_service"?: LetterEditableExtraServiceEnum;
    /**
     * A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information.
     * @type {Array<string>}
     * @memberof LetterEditable
     */
    "cards"?: Array<string> | null;
    /**
     * An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.
     * @type {string}
     * @memberof LetterEditable
     */
    "billing_group_id"?: string;
    /**
     *
     * @type {QrCode}
     * @memberof LetterEditable
     */
    "qr_code"?: QrCode;
    /**
     *
     * @type {LtrUseType}
     * @memberof LetterEditable
     */
    "use_type": LtrUseType | null;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum LetterEditableAddressPlacementEnum {
    TopFirstPage = "top_first_page",
    InsertBlankPage = "insert_blank_page",
    BottomFirstPageCenter = "bottom_first_page_center",
    BottomFirstPage = "bottom_first_page"
}
/**
 * @export
 * @enum {string}
 */
export declare enum LetterEditableExtraServiceEnum {
    Certified = "certified",
    CertifiedReturnReceipt = "certified_return_receipt",
    Registered = "registered",
    Null = "null"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */