Class UsMailV2RecipientAddress

The addresses of the recipients.

Hierarchy

  • UsMailV2RecipientAddress

Constructors

constructor

Properties

city complete confidence isAddressChange pageId polygon postalCode privateMailboxNumber state street

Methods

#printableValues toString toTableLine

Constructors

constructor

Properties

city

city: null | string

The city of the recipient's address.

complete

complete: null | string

The complete address of the recipient.

confidence

confidence: number = 0.0

Confidence score

isAddressChange

isAddressChange: null | boolean

Indicates if the recipient's address is a change of address.

pageId

pageId: number

The document page on which the information was found.

polygon

polygon: Polygon = []

Contains the relative vertices coordinates (points) of a polygon containing the field in the document.

postalCode

postalCode: null | string

The postal code of the recipient's address.

privateMailboxNumber

privateMailboxNumber: null | string

The private mailbox number of the recipient's address.

state

state: null | string

Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.

street

street: null | string

The street of the recipient's address.

Methods

Private #printableValues

  • #printableValues(): {
        city: string;
        complete: string;
        isAddressChange: string;
        postalCode: string;
        privateMailboxNumber: string;
        state: string;
        street: string;
    }

  • Collection of fields as representable strings.

    Returns {
        city: string;
        complete: string;
        isAddressChange: string;
        postalCode: string;
        privateMailboxNumber: string;
        state: string;
        street: string;
    }

    • city: string
    • complete: string
    • isAddressChange: string
    • postalCode: string
    • privateMailboxNumber: string
    • state: string
    • street: string

toString

toTableLine

Settings

Member Visibility

Theme

Generated using TypeDoc