@lob/lob-typescript-sdk/dist/models/us-verification.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 { DeliverabilityAnalysis } from "./deliverability-analysis";
import { LobConfidenceScore } from "./lob-confidence-score";
import { UsComponents } from "./us-components";
/**
 *
 * @export
 * @class UsVerification
 */
export declare class UsVerification {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `us_ver_`.
     * @type {string}
     * @memberof UsVerification
     */
    private "_id"?;
    get id(): string;
    set id(newValue: string);
    /**
     * The intended recipient, typically a person\'s or firm\'s name.
     * @type {string}
     * @memberof UsVerification
     */
    "recipient"?: string | null;
    /**
     * The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
     * @type {string}
     * @memberof UsVerification
     */
    "primary_line"?: string;
    /**
     * The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
     * @type {string}
     * @memberof UsVerification
     */
    "secondary_line"?: string;
    /**
     * Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
     * @type {string}
     * @memberof UsVerification
     */
    "urbanization"?: string;
    /**
     * Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)
     * @type {string}
     * @memberof UsVerification
     */
    "last_line"?: string;
    /**
     * Summarizes the deliverability of the `us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building\'s default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * `deliverable_missing_unit` – The address is deliverable to the building\'s default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * `undeliverable` – The address is not deliverable according to the USPS.
     * @type {string}
     * @memberof UsVerification
     */
    "deliverability"?: UsVerificationDeliverabilityEnum;
    /**
     * This field indicates whether an address was found in a more comprehensive address dataset that includes sources from the USPS, open source mapping data, and our proprietary mail delivery data. This field can be interpreted as a representation of whether an address is a real location or not. Additionally a valid address may contradict the deliverability field since an address can be a real valid location but the USPS may not deliver to that address.
     * @type {boolean}
     * @memberof UsVerification
     */
    "valid_address"?: UsVerificationValidAddressEnum;
    /**
     *
     * @type {UsComponents}
     * @memberof UsVerification
     */
    "components"?: UsComponents;
    /**
     *
     * @type {DeliverabilityAnalysis}
     * @memberof UsVerification
     */
    "deliverability_analysis"?: DeliverabilityAnalysis;
    /**
     *
     * @type {LobConfidenceScore}
     * @memberof UsVerification
     */
    "lob_confidence_score"?: LobConfidenceScore;
    /**
     *
     * @type {string}
     * @memberof UsVerification
     */
    "object"?: UsVerificationObjectEnum;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum UsVerificationDeliverabilityEnum {
    Deliverable = "deliverable",
    DeliverableUnnecessaryUnit = "deliverable_unnecessary_unit",
    DeliverableIncorrectUnit = "deliverable_incorrect_unit",
    DeliverableMissingUnit = "deliverable_missing_unit",
    Undeliverable = "undeliverable"
}
/**
 * @export
 * @enum {string}
 */
export declare enum UsVerificationValidAddressEnum {
    True = "true",
    False = "false"
}
/**
 * @export
 * @enum {string}
 */
export declare enum UsVerificationObjectEnum {
    UsVerification = "us_verification"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */