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

Mindee Client Library for Node.js

import { Prediction, StringDict } from "../../parsing/common";
import { BillOfLadingV1Shipper } from "./billOfLadingV1Shipper";
import { BillOfLadingV1Consignee } from "./billOfLadingV1Consignee";
import { BillOfLadingV1NotifyParty } from "./billOfLadingV1NotifyParty";
import { BillOfLadingV1Carrier } from "./billOfLadingV1Carrier";
import { BillOfLadingV1CarrierItem } from "./billOfLadingV1CarrierItem";
import { DateField, StringField } from "../../parsing/standard";
/**
 * Bill of Lading API version 1.1 document data.
 */
export declare class BillOfLadingV1Document implements Prediction {
    /** A unique identifier assigned to a Bill of Lading document. */
    billOfLadingNumber: StringField;
    /** The shipping company responsible for transporting the goods. */
    carrier: BillOfLadingV1Carrier;
    /** The goods being shipped. */
    carrierItems: BillOfLadingV1CarrierItem[];
    /** The party to whom the goods are being shipped. */
    consignee: BillOfLadingV1Consignee;
    /** The date when the bill of lading is issued. */
    dateOfIssue: DateField;
    /** The date when the vessel departs from the port of loading. */
    departureDate: DateField;
    /** The party to be notified of the arrival of the goods. */
    notifyParty: BillOfLadingV1NotifyParty;
    /** The place where the goods are to be delivered. */
    placeOfDelivery: StringField;
    /** The port where the goods are unloaded from the vessel. */
    portOfDischarge: StringField;
    /** The port where the goods are loaded onto the vessel. */
    portOfLoading: StringField;
    /** The party responsible for shipping the goods. */
    shipper: BillOfLadingV1Shipper;
    constructor(rawPrediction: StringDict, pageId?: number);
    /**
     * Default string representation.
     */
    toString(): string;
}