@lob/lob-typescript-sdk/dist/models/us-verification-or-error.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 { BulkError } from "./bulk-error";
import { DeliverabilityAnalysis } from "./deliverability-analysis";
import { LobConfidenceScore } from "./lob-confidence-score";
import { UsComponents } from "./us-components";
/**
 * A model used to represent an entry in a result list where the entry can either be a us_verification or an Error. The SDK will perform necessary casting into the correct corresponding type.
 * @export
 * @class UsVerificationOrError
 */
export declare class UsVerificationOrError {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `us_ver_`.
     * @type {string}
     * @memberof UsVerificationOrError
     */
    private "_id"?;
    get id(): string;
    set id(newValue: string);
    /**
     * The intended recipient, typically a person\'s or firm\'s name.
     * @type {string}
     * @memberof UsVerificationOrError
     */
    "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 UsVerificationOrError
     */
    "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 UsVerificationOrError
     */
    "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 UsVerificationOrError
     */
    "urbanization"?: string;
    /**
     *
     * @type {string}
     * @memberof UsVerificationOrError
     */
    "last_line"?: string;
    /**
     *
     * @type {string}
     * @memberof UsVerificationOrError
     */
    "deliverability"?: UsVerificationOrErrorDeliverabilityEnum;
    /**
     *
     * @type {UsComponents}
     * @memberof UsVerificationOrError
     */
    "components"?: UsComponents;
    /**
     *
     * @type {DeliverabilityAnalysis}
     * @memberof UsVerificationOrError
     */
    "deliverability_analysis"?: DeliverabilityAnalysis;
    /**
     *
     * @type {LobConfidenceScore}
     * @memberof UsVerificationOrError
     */
    "lob_confidence_score"?: LobConfidenceScore;
    /**
     *
     * @type {string}
     * @memberof UsVerificationOrError
     */
    "object"?: UsVerificationOrErrorObjectEnum;
    /**
     *
     * @type {BulkError}
     * @memberof UsVerificationOrError
     */
    "error"?: BulkError;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum UsVerificationOrErrorDeliverabilityEnum {
    Deliverable = "deliverable",
    DeliverableUnnecessaryUnit = "deliverable_unnecessary_unit",
    DeliverableIncorrectUnit = "deliverable_incorrect_unit",
    DeliverableMissingUnit = "deliverable_missing_unit",
    Undeliverable = "undeliverable"
}
/**
 * @export
 * @enum {string}
 */
export declare enum UsVerificationOrErrorObjectEnum {
    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.
 */