@lob/lob-typescript-sdk
Version:
Lob API wrapper
59 lines (58 loc) • 2.53 kB
TypeScript
/**
* 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 { UploadsMetadata } from "./uploads-metadata";
/**
*
* @export
* @class UploadUpdatable
*/
export declare class UploadUpdatable {
constructor(input?: any);
/**
* Original filename provided when the upload is created.
* @type {string}
* @memberof UploadUpdatable
*/
"originalFilename"?: string;
/**
*
* @type {RequiredAddressColumnMapping}
* @memberof UploadUpdatable
*/
"requiredAddressColumnMapping"?: RequiredAddressColumnMapping;
/**
*
* @type {OptionalAddressColumnMapping}
* @memberof UploadUpdatable
*/
"optionalAddressColumnMapping"?: OptionalAddressColumnMapping;
/**
*
* @type {UploadsMetadata}
* @memberof UploadUpdatable
*/
"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 UploadUpdatable
*/
"mergeVariableColumnMapping"?: object | null;
toJSON(): {};
}
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/