@lob/lob-typescript-sdk/dist/models/upload.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 { OptionalAddressColumnMapping } from "./optional-address-column-mapping";
import { RequiredAddressColumnMapping } from "./required-address-column-mapping";
import { UploadState } from "./upload-state";
import { UploadsMetadata } from "./uploads-metadata";
/**
 *
 * @export
 * @class Upload
 */
export declare class Upload {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `upl_`.
     * @type {string}
     * @memberof Upload
     */
    private "_id";
    get id(): string;
    set id(newValue: string);
    /**
     * Account ID that made the request
     * @type {string}
     * @memberof Upload
     */
    "accountId": string;
    /**
     * The environment in which the mailpieces were created. Today, will only be `live`.
     * @type {string}
     * @memberof Upload
     */
    "mode": UploadModeEnum;
    /**
     * Url where your campaign mailpiece failures can be retrieved
     * @type {string}
     * @memberof Upload
     */
    "failuresUrl"?: string;
    /**
     * Filename of the upload
     * @type {string}
     * @memberof Upload
     */
    "originalFilename"?: string;
    /**
     *
     * @type {UploadState}
     * @memberof Upload
     */
    "state": UploadState;
    /**
     * Total number of recipients for the campaign
     * @type {number}
     * @memberof Upload
     */
    "totalMailpieces": number;
    /**
     * Number of mailpieces that failed to create
     * @type {number}
     * @memberof Upload
     */
    "failedMailpieces": number;
    /**
     * Number of mailpieces that were successfully created
     * @type {number}
     * @memberof Upload
     */
    "validatedMailpieces": number;
    /**
     * Number of bytes processed in your CSV
     * @type {number}
     * @memberof Upload
     */
    "bytesProcessed": number;
    /**
     * A timestamp in ISO 8601 format of the date the upload was created
     * @type {string}
     * @memberof Upload
     */
    "dateCreated": string;
    /**
     * A timestamp in ISO 8601 format of the date the upload was last modified
     * @type {string}
     * @memberof Upload
     */
    "dateModified": string;
    /**
     *
     * @type {RequiredAddressColumnMapping}
     * @memberof Upload
     */
    "requiredAddressColumnMapping": RequiredAddressColumnMapping;
    /**
     *
     * @type {OptionalAddressColumnMapping}
     * @memberof Upload
     */
    "optionalAddressColumnMapping": OptionalAddressColumnMapping;
    /**
     *
     * @type {UploadsMetadata}
     * @memberof Upload
     */
    "metadata": UploadsMetadata;
    /**
     * The mapping of column headers in your file to the merge variables present in your creative. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7\" target=\"_blank\">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same \"name\" as a \"key\" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects.
     * @type {object}
     * @memberof Upload
     */
    "mergeVariableColumnMapping": object | null;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum UploadModeEnum {
    Test = "test",
    Live = "live"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */