@lob/lob-typescript-sdk/dist/models/export.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.
 */
/**
 *
 * @export
 * @class Export
 */
export declare class Export {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `ex_`.
     * @type {string}
     * @memberof Export
     */
    private "_id";
    get id(): string;
    set id(newValue: string);
    /**
     * A timestamp in ISO 8601 format of the date the export was created
     * @type {string}
     * @memberof Export
     */
    "dateCreated": string;
    /**
     * A timestamp in ISO 8601 format of the date the export was last modified
     * @type {string}
     * @memberof Export
     */
    "dateModified": string;
    /**
     * Returns as `true` if the resource has been successfully deleted.
     * @type {boolean}
     * @memberof Export
     */
    "deleted": boolean;
    /**
     * The URL for the generated export file.
     * @type {string}
     * @memberof Export
     */
    "s3Url"?: string;
    /**
     * The state of the export file, which can be `in_progress`, `failed` or `succeeded`.
     * @type {string}
     * @memberof Export
     */
    "state": ExportStateEnum;
    /**
     * The export file type, which can be `all`, `failures` or `successes`.
     * @type {string}
     * @memberof Export
     */
    "type": ExportTypeEnum;
    /**
     * Unique identifier prefixed with `upl_`.
     * @type {string}
     * @memberof Export
     */
    private "_uploadId";
    get uploadId(): string;
    set uploadId(newValue: string);
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum ExportStateEnum {
    InProgress = "in_progress",
    Failed = "failed",
    Succeeded = "succeeded"
}
/**
 * @export
 * @enum {string}
 */
export declare enum ExportTypeEnum {
    All = "all",
    Failures = "failures",
    Successes = "successes"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */