mindee/src/product/us/usMail/usMailV2SenderAddress.d.ts

Mindee Client Library for Node.js

import { StringDict } from "../../../parsing/common";
import { Polygon } from "../../../geometry";
/**
 * The address of the sender.
 */
export declare class UsMailV2SenderAddress {
    #private;
    /** The city of the sender's address. */
    city: string | null;
    /** The complete address of the sender. */
    complete: string | null;
    /** The postal code of the sender's address. */
    postalCode: string | null;
    /** Second part of the ISO 3166-2 code, consisting of two letters indicating the US State. */
    state: string | null;
    /** The street of the sender's address. */
    street: string | null;
    /** Confidence score */
    confidence: number;
    /** The document page on which the information was found. */
    pageId: number;
    /**
     * Contains the relative vertices coordinates (points) of a polygon containing
     * the field in the document.
     */
    polygon: Polygon;
    constructor({ prediction }: StringDict);
    /**
     * Default string representation.
     */
    toString(): string;
    /**
     * Output in a format suitable for inclusion in a field list.
     */
    toFieldList(): string;
}