@lob/lob-typescript-sdk/dist/models/zip.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 { ZipCodeType } from "./zip-code-type";
import { ZipLookupCity } from "./zip-lookup-city";
/**
 *
 * @export
 * @class Zip
 */
export declare class Zip {
    constructor(input?: any);
    /**
     * A 5-digit ZIP code.
     * @type {string}
     * @memberof Zip
     */
    private "_zip_code"?;
    get zip_code(): string;
    set zip_code(newValue: string);
    /**
     * Unique identifier prefixed with `us_zip_`.
     * @type {string}
     * @memberof Zip
     */
    private "_id";
    get id(): string;
    set id(newValue: string);
    /**
     * An array of city objects containing valid cities for the `zip_code`. Multiple cities will be returned if more than one city is associated with the input ZIP code.
     * @type {Array<ZipLookupCity>}
     * @memberof Zip
     */
    "cities": Array<ZipLookupCity>;
    /**
     *
     * @type {ZipCodeType}
     * @memberof Zip
     */
    "zip_code_type": ZipCodeType;
    /**
     *
     * @type {string}
     * @memberof Zip
     */
    "object": ZipObjectEnum;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum ZipObjectEnum {
    UsZipLookup = "us_zip_lookup"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */