@lob/lob-typescript-sdk/dist/models/card.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 { Thumbnail } from "./thumbnail";
/**
 *
 * @export
 * @class Card
 */
export declare class Card {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `card_`.
     * @type {string}
     * @memberof Card
     */
    private "_id";
    get id(): string;
    set id(newValue: string);
    /**
     * The signed link for the card.
     * @type {string}
     * @memberof Card
     */
    "url": string;
    /**
     * True if the cards should be auto-reordered.
     * @type {boolean}
     * @memberof Card
     */
    "auto_reorder": boolean;
    /**
     * The number of cards to be reordered. Only present when auto_reorder is True.
     * @type {number}
     * @memberof Card
     */
    "reorder_quantity"?: number | null;
    /**
     * The raw URL of the card.
     * @type {string}
     * @memberof Card
     */
    "raw_url"?: string;
    /**
     * The original URL of the front template.
     * @type {string}
     * @memberof Card
     */
    "front_original_url"?: string;
    /**
     * The original URL of the back template.
     * @type {string}
     * @memberof Card
     */
    "back_original_url"?: string;
    /**
     *
     * @type {Array<Thumbnail>}
     * @memberof Card
     */
    "thumbnails": Array<Thumbnail>;
    /**
     * The available quantity of cards.
     * @type {number}
     * @memberof Card
     */
    "available_quantity": number;
    /**
     * The pending quantity of cards.
     * @type {number}
     * @memberof Card
     */
    "pending_quantity": number;
    /**
     *
     * @type {string}
     * @memberof Card
     */
    "status"?: CardStatusEnum;
    /**
     * The orientation of the card.
     * @type {string}
     * @memberof Card
     */
    "orientation"?: CardOrientationEnum;
    /**
     * The threshold amount of the card
     * @type {number}
     * @memberof Card
     */
    "threshold_amount"?: number;
    /**
     * A timestamp in ISO 8601 format of the date the resource was created.
     * @type {string}
     * @memberof Card
     */
    "date_created": string;
    /**
     * A timestamp in ISO 8601 format of the date the resource was last modified.
     * @type {string}
     * @memberof Card
     */
    "date_modified": string;
    /**
     * Only returned if the resource has been successfully deleted.
     * @type {boolean}
     * @memberof Card
     */
    "deleted"?: boolean;
    /**
     * object
     * @type {string}
     * @memberof Card
     */
    "object": CardObjectEnum;
    /**
     * Description of the card.
     * @type {string}
     * @memberof Card
     */
    "description"?: string | null;
    /**
     * The size of the card
     * @type {string}
     * @memberof Card
     */
    "size": CardSizeEnum;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum CardStatusEnum {
    Processed = "processed",
    Rendered = "rendered"
}
/**
 * @export
 * @enum {string}
 */
export declare enum CardOrientationEnum {
    Horizontal = "horizontal",
    Vertical = "vertical"
}
/**
 * @export
 * @enum {string}
 */
export declare enum CardObjectEnum {
    Card = "card"
}
/**
 * @export
 * @enum {string}
 */
export declare enum CardSizeEnum {
    _3375x2125 = "3.375x2.125",
    _2125x3375 = "2.125x3.375"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */