@lob/lob-typescript-sdk/dist/models/intl-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 { IntlComponents } from "./intl-components";
/**
 * A model used to represent an entry in a result list where the entry can either be a intl_verification or an Error. The SDK will perform necessary casting into the correct corresponding type.
 * @export
 * @class IntlVerificationOrError
 */
export declare class IntlVerificationOrError {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `intl_ver_`.
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    private "_id"?;
    get id(): string;
    set id(newValue: string);
    /**
     * The intended recipient, typically a person\'s or firm\'s name.
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "recipient"?: string | null;
    /**
     *
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "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 IntlVerificationOrError
     */
    "secondary_line"?: string;
    /**
     *
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "last_line"?: string;
    /**
     *
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "country"?: string;
    /**
     *
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "coverage"?: IntlVerificationOrErrorCoverageEnum;
    /**
     *
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "deliverability"?: IntlVerificationOrErrorDeliverabilityEnum;
    /**
     *
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "status"?: IntlVerificationOrErrorStatusEnum;
    /**
     *
     * @type {IntlComponents}
     * @memberof IntlVerificationOrError
     */
    "components"?: IntlComponents;
    /**
     *
     * @type {string}
     * @memberof IntlVerificationOrError
     */
    "object"?: IntlVerificationOrErrorObjectEnum;
    /**
     *
     * @type {BulkError}
     * @memberof IntlVerificationOrError
     */
    "error"?: BulkError;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum IntlVerificationOrErrorCoverageEnum {
    Subbuilding = "SUBBUILDING",
    HousenumberBuilding = "HOUSENUMBER/BUILDING",
    Street = "STREET",
    Locality = "LOCALITY",
    Sparse = "SPARSE"
}
/**
 * @export
 * @enum {string}
 */
export declare enum IntlVerificationOrErrorDeliverabilityEnum {
    Deliverable = "deliverable",
    DeliverableMissingInfo = "deliverable_missing_info",
    Undeliverable = "undeliverable",
    NoMatch = "no_match"
}
/**
 * @export
 * @enum {string}
 */
export declare enum IntlVerificationOrErrorStatusEnum {
    Lv4 = "LV4",
    Lv3 = "LV3",
    Lv2 = "LV2",
    Lv1 = "LV1",
    Lf4 = "LF4",
    Lf3 = "LF3",
    Lf2 = "LF2",
    Lf1 = "LF1",
    Lm4 = "LM4",
    Lm3 = "LM3",
    Lm2 = "LM2",
    Lu1 = "LU1"
}
/**
 * @export
 * @enum {string}
 */
export declare enum IntlVerificationOrErrorObjectEnum {
    IntlVerification = "intl_verification"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */