mindee/src/product/billOfLading/billOfLadingV1Consignee.d.ts

Mindee Client Library for Node.js

import { StringDict } from "../../parsing/common";
import { Polygon } from "../../geometry";
/**
 * The party to whom the goods are being shipped.
 */
export declare class BillOfLadingV1Consignee {
    #private;
    /** The address of the consignee. */
    address: string | null;
    /** The  email of the shipper. */
    email: string | null;
    /** The name of the consignee. */
    name: string | null;
    /** The phone number of the consignee. */
    phone: 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;
}