@lob/lob-typescript-sdk/dist/models/buckslip.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 { BuckslipOrder } from "./buckslip-order";
import { Thumbnail } from "./thumbnail";
/**
 *
 * @export
 * @class Buckslip
 */
export declare class Buckslip {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `bck_`.
     * @type {string}
     * @memberof Buckslip
     */
    private "_id";
    get id(): string;
    set id(newValue: string);
    /**
     * True if the buckslips should be auto-reordered.
     * @type {boolean}
     * @memberof Buckslip
     */
    "auto_reorder": boolean;
    /**
     * The number of buckslips to be reordered.
     * @type {number}
     * @memberof Buckslip
     */
    "reorder_quantity": number | null;
    /**
     * The threshold amount of the buckslip
     * @type {number}
     * @memberof Buckslip
     */
    "threshold_amount": number;
    /**
     * The signed link for the buckslip.
     * @type {string}
     * @memberof Buckslip
     */
    "url": string;
    /**
     * The raw URL of the buckslip.
     * @type {string}
     * @memberof Buckslip
     */
    "raw_url": string;
    /**
     * The original URL of the front template.
     * @type {string}
     * @memberof Buckslip
     */
    "front_original_url": string;
    /**
     * The original URL of the back template.
     * @type {string}
     * @memberof Buckslip
     */
    "back_original_url": string;
    /**
     *
     * @type {Array<Thumbnail>}
     * @memberof Buckslip
     */
    "thumbnails": Array<Thumbnail>;
    /**
     * The available quantity of buckslips.
     * @type {number}
     * @memberof Buckslip
     */
    "available_quantity": number;
    /**
     * The allocated quantity of buckslips.
     * @type {number}
     * @memberof Buckslip
     */
    "allocated_quantity": number;
    /**
     * The onhand quantity of buckslips.
     * @type {number}
     * @memberof Buckslip
     */
    "onhand_quantity": number;
    /**
     * The pending quantity of buckslips.
     * @type {number}
     * @memberof Buckslip
     */
    "pending_quantity": number;
    /**
     * The sum of pending and onhand quantities of buckslips.
     * @type {number}
     * @memberof Buckslip
     */
    "projected_quantity": number;
    /**
     * An array of buckslip orders that are associated with the buckslip.
     * @type {Array<BuckslipOrder>}
     * @memberof Buckslip
     */
    "buckslip_orders": Array<BuckslipOrder>;
    /**
     *
     * @type {string}
     * @memberof Buckslip
     */
    "stock": BuckslipStockEnum;
    /**
     *
     * @type {string}
     * @memberof Buckslip
     */
    "weight": BuckslipWeightEnum;
    /**
     *
     * @type {string}
     * @memberof Buckslip
     */
    "finish": BuckslipFinishEnum;
    /**
     *
     * @type {string}
     * @memberof Buckslip
     */
    "status": BuckslipStatusEnum;
    /**
     * object
     * @type {string}
     * @memberof Buckslip
     */
    "object": BuckslipObjectEnum;
    /**
     * Description of the buckslip.
     * @type {string}
     * @memberof Buckslip
     */
    "description": string | null;
    /**
     * The size of the buckslip
     * @type {string}
     * @memberof Buckslip
     */
    "size"?: BuckslipSizeEnum;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum BuckslipStockEnum {
    Text = "text",
    Cover = "cover"
}
/**
 * @export
 * @enum {string}
 */
export declare enum BuckslipWeightEnum {
    _80 = "80#"
}
/**
 * @export
 * @enum {string}
 */
export declare enum BuckslipFinishEnum {
    Gloss = "gloss",
    Matte = "matte"
}
/**
 * @export
 * @enum {string}
 */
export declare enum BuckslipStatusEnum {
    Processed = "processed",
    Rendered = "rendered"
}
/**
 * @export
 * @enum {string}
 */
export declare enum BuckslipObjectEnum {
    Buckslip = "buckslip"
}
/**
 * @export
 * @enum {string}
 */
export declare enum BuckslipSizeEnum {
    _875x375 = "8.75x3.75"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */