@lob/lob-typescript-sdk/dist/models/address.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 { CountryExtendedExpanded } from "./country-extended-expanded";
/**
 *
 * @export
 * @class Address
 */
export declare class Address {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `adr_`.
     * @type {string}
     * @memberof Address
     */
    private "_id"?;
    get id(): string;
    set id(newValue: string);
    /**
     * An internal description that identifies this resource. Must be no longer than 255 characters.
     * @type {string}
     * @memberof Address
     */
    "description"?: string | null;
    /**
     * name associated with address
     * @type {string}
     * @memberof Address
     */
    "name"?: string | null;
    /**
     * Either `name` or `company` is required, you may also add both.
     * @type {string}
     * @memberof Address
     */
    "company"?: string | null;
    /**
     * Must be no longer than 40 characters.
     * @type {string}
     * @memberof Address
     */
    "phone"?: string | null;
    /**
     * Must be no longer than 100 characters.
     * @type {string}
     * @memberof Address
     */
    "email"?: string | null;
    /**
     * Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. \'{\"customer_id\" : \"NEWYORK2015\"}\' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
     * @type {{ [key: string]: string; }}
     * @memberof Address
     */
    "metadata"?: {
        [key: string]: string;
    };
    /**
     *
     * @type {string}
     * @memberof Address
     */
    "address_line1"?: string;
    /**
     *
     * @type {string}
     * @memberof Address
     */
    "address_line2"?: string | null;
    /**
     *
     * @type {string}
     * @memberof Address
     */
    "address_city"?: string;
    /**
     * 2 letter state short-name code
     * @type {string}
     * @memberof Address
     */
    private "_address_state"?;
    get address_state(): string;
    set address_state(newValue: string);
    /**
     * Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`.
     * @type {string}
     * @memberof Address
     */
    private "_address_zip"?;
    get address_zip(): string;
    set address_zip(newValue: string);
    /**
     *
     * @type {CountryExtendedExpanded}
     * @memberof Address
     */
    "address_country"?: CountryExtendedExpanded;
    /**
     *
     * @type {string}
     * @memberof Address
     */
    "object"?: AddressObjectEnum;
    /**
     * A timestamp in ISO 8601 format of the date the resource was created.
     * @type {string}
     * @memberof Address
     */
    "date_created"?: string;
    /**
     * A timestamp in ISO 8601 format of the date the resource was last modified.
     * @type {string}
     * @memberof Address
     */
    "date_modified"?: string;
    /**
     * Only returned if the resource has been successfully deleted.
     * @type {boolean}
     * @memberof Address
     */
    "deleted"?: boolean;
    /**
     * Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account.
     * @type {boolean}
     * @memberof Address
     */
    "recipient_moved"?: boolean | null;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum AddressObjectEnum {
    Address = "address"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */