mindee 4.1.0 → 4.2.0

package/src/product/fr/idCard/idCardV2Document.d.ts

@@ -0,0 +1,42 @@
+import { Prediction, StringDict } from "../../../parsing/common";
+import { DateField, StringField } from "../../../parsing/standard";
+/**
+ * Document data for Carte Nationale d'Identité, API version 2.
+ */
+export declare class IdCardV2Document implements Prediction {
+    /** The alternate name of the card holder. */
+    alternateName: StringField;
+    /** The name of the issuing authority. */
+    authority: StringField;
+    /** The date of birth of the card holder. */
+    birthDate: DateField;
+    /** The place of birth of the card holder. */
+    birthPlace: StringField;
+    /** The card access number (CAN). */
+    cardAccessNumber: StringField;
+    /** The document number. */
+    documentNumber: StringField;
+    /** The expiry date of the identification card. */
+    expiryDate: DateField;
+    /** The gender of the card holder. */
+    gender: StringField;
+    /** The given name(s) of the card holder. */
+    givenNames: StringField[];
+    /** The date of issue of the identification card. */
+    issueDate: DateField;
+    /** The Machine Readable Zone, first line. */
+    mrz1: StringField;
+    /** The Machine Readable Zone, second line. */
+    mrz2: StringField;
+    /** The Machine Readable Zone, third line. */
+    mrz3: StringField;
+    /** The nationality of the card holder. */
+    nationality: StringField;
+    /** The surname of the card holder. */
+    surname: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/fr/idCard/idCardV2Document.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdCardV2Document = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+/**
+ * Document data for Carte Nationale d'Identité, API version 2.
+ */
+class IdCardV2Document {
+    constructor(rawPrediction, pageId) {
+        /** The given name(s) of the card holder. */
+        this.givenNames = [];
+        this.alternateName = new standard_1.StringField({
+            prediction: rawPrediction["alternate_name"],
+            pageId: pageId,
+        });
+        this.authority = new standard_1.StringField({
+            prediction: rawPrediction["authority"],
+            pageId: pageId,
+        });
+        this.birthDate = new standard_1.DateField({
+            prediction: rawPrediction["birth_date"],
+            pageId: pageId,
+        });
+        this.birthPlace = new standard_1.StringField({
+            prediction: rawPrediction["birth_place"],
+            pageId: pageId,
+        });
+        this.cardAccessNumber = new standard_1.StringField({
+            prediction: rawPrediction["card_access_number"],
+            pageId: pageId,
+        });
+        this.documentNumber = new standard_1.StringField({
+            prediction: rawPrediction["document_number"],
+            pageId: pageId,
+        });
+        this.expiryDate = new standard_1.DateField({
+            prediction: rawPrediction["expiry_date"],
+            pageId: pageId,
+        });
+        this.gender = new standard_1.StringField({
+            prediction: rawPrediction["gender"],
+            pageId: pageId,
+        });
+        rawPrediction["given_names"] &&
+            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.issueDate = new standard_1.DateField({
+            prediction: rawPrediction["issue_date"],
+            pageId: pageId,
+        });
+        this.mrz1 = new standard_1.StringField({
+            prediction: rawPrediction["mrz1"],
+            pageId: pageId,
+        });
+        this.mrz2 = new standard_1.StringField({
+            prediction: rawPrediction["mrz2"],
+            pageId: pageId,
+        });
+        this.mrz3 = new standard_1.StringField({
+            prediction: rawPrediction["mrz3"],
+            pageId: pageId,
+        });
+        this.nationality = new standard_1.StringField({
+            prediction: rawPrediction["nationality"],
+            pageId: pageId,
+        });
+        this.surname = new standard_1.StringField({
+            prediction: rawPrediction["surname"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const givenNames = this.givenNames.join("\n                ");
+        const outStr = `:Nationality: ${this.nationality}
+:Card Access Number: ${this.cardAccessNumber}
+:Document Number: ${this.documentNumber}
+:Given Name(s): ${givenNames}
+:Surname: ${this.surname}
+:Alternate Name: ${this.alternateName}
+:Date of Birth: ${this.birthDate}
+:Place of Birth: ${this.birthPlace}
+:Gender: ${this.gender}
+:Expiry Date: ${this.expiryDate}
+:Mrz Line 1: ${this.mrz1}
+:Mrz Line 2: ${this.mrz2}
+:Mrz Line 3: ${this.mrz3}
+:Date of Issue: ${this.issueDate}
+:Issuing Authority: ${this.authority}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.IdCardV2Document = IdCardV2Document;

package/src/product/fr/idCard/idCardV2Page.d.ts

@@ -0,0 +1,14 @@
+import { StringDict } from "../../../parsing/common";
+import { ClassificationField } from "../../../parsing/standard";
+import { IdCardV2Document } from "./idCardV2Document";
+/**
+ * Page data for Carte Nationale d'Identité, API version 2.
+ */
+export declare class IdCardV2Page extends IdCardV2Document {
+    /** The sides of the document which are visible. */
+    documentSide: ClassificationField;
+    /** The document type or format. */
+    documentType: ClassificationField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/product/fr/idCard/idCardV2Page.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdCardV2Page = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+const idCardV2Document_1 = require("./idCardV2Document");
+/**
+ * Page data for Carte Nationale d'Identité, API version 2.
+ */
+class IdCardV2Page extends idCardV2Document_1.IdCardV2Document {
+    constructor(rawPrediction, pageId) {
+        super(rawPrediction, pageId);
+        this.documentSide = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_side"],
+        });
+        this.documentType = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_type"],
+        });
+    }
+    toString() {
+        let outStr = `:Document Type: ${this.documentType}
+:Document Sides: ${this.documentSide}`.trimEnd();
+        outStr += "\n" + super.toString();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.IdCardV2Page = IdCardV2Page;

package/src/product/fr/idCard/internal.d.ts

@@ -1,3 +1,4 @@
 export { IdCardV1 } from "./idCardV1";
+export { IdCardV2 } from "./idCardV2";
 export { IdCardV1Document } from "./idCardV1Document";
 export { IdCardV1Page } from "./idCardV1Page";

package/src/product/fr/idCard/internal.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IdCardV1Page = exports.IdCardV1Document = exports.IdCardV1 = void 0;
+exports.IdCardV1Page = exports.IdCardV1Document = exports.IdCardV2 = exports.IdCardV1 = void 0;
 var idCardV1_1 = require("./idCardV1");
 Object.defineProperty(exports, "IdCardV1", { enumerable: true, get: function () { return idCardV1_1.IdCardV1; } });
+var idCardV2_1 = require("./idCardV2");
+Object.defineProperty(exports, "IdCardV2", { enumerable: true, get: function () { return idCardV2_1.IdCardV2; } });
 var idCardV1Document_1 = require("./idCardV1Document");
 Object.defineProperty(exports, "IdCardV1Document", { enumerable: true, get: function () { return idCardV1Document_1.IdCardV1Document; } });
 var idCardV1Page_1 = require("./idCardV1Page");

package/src/product/fr/index.d.ts

@@ -1,4 +1,5 @@
 export { IdCardV1 } from "./idCard/idCardV1";
+export { IdCardV2 } from "./idCard/idCardV2";
 export { BankAccountDetailsV1 } from "./bankAccountDetails/bankAccountDetailsV1";
 export { BankAccountDetailsV2 } from "./bankAccountDetails/bankAccountDetailsV2";
 export { CarteVitaleV1 } from "./carteVitale/carteVitaleV1";

package/src/product/fr/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CarteVitaleV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = exports.IdCardV1 = void 0;
+exports.CarteVitaleV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = exports.IdCardV2 = exports.IdCardV1 = void 0;
 var idCardV1_1 = require("./idCard/idCardV1");
 Object.defineProperty(exports, "IdCardV1", { enumerable: true, get: function () { return idCardV1_1.IdCardV1; } });
+var idCardV2_1 = require("./idCard/idCardV2");
+Object.defineProperty(exports, "IdCardV2", { enumerable: true, get: function () { return idCardV2_1.IdCardV2; } });
 var bankAccountDetailsV1_1 = require("./bankAccountDetails/bankAccountDetailsV1");
 Object.defineProperty(exports, "BankAccountDetailsV1", { enumerable: true, get: function () { return bankAccountDetailsV1_1.BankAccountDetailsV1; } });
 var bankAccountDetailsV2_1 = require("./bankAccountDetails/bankAccountDetailsV2");

package/src/product/index.d.ts

@@ -1,12 +1,14 @@
+export { BarcodeReaderV1 } from "./barcodeReader/barcodeReaderV1";
+export { CropperV1 } from "./cropper/cropperV1";
+export { CustomV1 } from "./custom/customV1";
+export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
 export { InvoiceV4 } from "./invoice/invoiceV4";
 export { InvoiceSplitterV1 } from "./invoiceSplitter/invoiceSplitterV1";
-export { ReceiptV4 } from "./receipt/receiptV4";
-export { ReceiptV5 } from "./receipt/receiptV5";
+export { MultiReceiptsDetectorV1 } from "./multiReceiptsDetector/multiReceiptsDetectorV1";
 export { PassportV1 } from "./passport/passportV1";
-export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
-export { CustomV1 } from "./custom/customV1";
-export { CropperV1 } from "./cropper/cropperV1";
 export { ProofOfAddressV1 } from "./proofOfAddress/proofOfAddressV1";
+export { ReceiptV4 } from "./receipt/receiptV4";
+export { ReceiptV5 } from "./receipt/receiptV5";
+export * as eu from "./eu";
 export * as fr from "./fr";
 export * as us from "./us";
-export * as eu from "./eu";

package/src/product/index.js

@@ -23,25 +23,29 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = void 0;
+exports.us = exports.fr = exports.eu = exports.ReceiptV5 = exports.ReceiptV4 = exports.ProofOfAddressV1 = exports.PassportV1 = exports.MultiReceiptsDetectorV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.FinancialDocumentV1 = exports.CustomV1 = exports.CropperV1 = exports.BarcodeReaderV1 = void 0;
+var barcodeReaderV1_1 = require("./barcodeReader/barcodeReaderV1");
+Object.defineProperty(exports, "BarcodeReaderV1", { enumerable: true, get: function () { return barcodeReaderV1_1.BarcodeReaderV1; } });
+var cropperV1_1 = require("./cropper/cropperV1");
+Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
+var customV1_1 = require("./custom/customV1");
+Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return customV1_1.CustomV1; } });
+var financialDocumentV1_1 = require("./financialDocument/financialDocumentV1");
+Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return financialDocumentV1_1.FinancialDocumentV1; } });
 var invoiceV4_1 = require("./invoice/invoiceV4");
 Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
 var invoiceSplitterV1_1 = require("./invoiceSplitter/invoiceSplitterV1");
 Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });
-var receiptV4_1 = require("./receipt/receiptV4");
-Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return receiptV4_1.ReceiptV4; } });
-var receiptV5_1 = require("./receipt/receiptV5");
-Object.defineProperty(exports, "ReceiptV5", { enumerable: true, get: function () { return receiptV5_1.ReceiptV5; } });
+var multiReceiptsDetectorV1_1 = require("./multiReceiptsDetector/multiReceiptsDetectorV1");
+Object.defineProperty(exports, "MultiReceiptsDetectorV1", { enumerable: true, get: function () { return multiReceiptsDetectorV1_1.MultiReceiptsDetectorV1; } });
 var passportV1_1 = require("./passport/passportV1");
 Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function () { return passportV1_1.PassportV1; } });
-var financialDocumentV1_1 = require("./financialDocument/financialDocumentV1");
-Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return financialDocumentV1_1.FinancialDocumentV1; } });
-var customV1_1 = require("./custom/customV1");
-Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return customV1_1.CustomV1; } });
-var cropperV1_1 = require("./cropper/cropperV1");
-Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
 var proofOfAddressV1_1 = require("./proofOfAddress/proofOfAddressV1");
 Object.defineProperty(exports, "ProofOfAddressV1", { enumerable: true, get: function () { return proofOfAddressV1_1.ProofOfAddressV1; } });
+var receiptV4_1 = require("./receipt/receiptV4");
+Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return receiptV4_1.ReceiptV4; } });
+var receiptV5_1 = require("./receipt/receiptV5");
+Object.defineProperty(exports, "ReceiptV5", { enumerable: true, get: function () { return receiptV5_1.ReceiptV5; } });
+exports.eu = __importStar(require("./eu"));
 exports.fr = __importStar(require("./fr"));
 exports.us = __importStar(require("./us"));
-exports.eu = __importStar(require("./eu"));

package/src/product/internal.d.ts

@@ -1,3 +1,4 @@
+export * as barcodeReader from "./barcodeReader/internal";
 export * as cropper from "./cropper/internal";
 export * as custom from "./custom/internal";
 export * as eu from "./eu/internal";
@@ -5,6 +6,7 @@ export * as financialDocument from "./financialDocument/internal";
 export * as fr from "./fr/internal";
 export * as invoice from "./invoice/internal";
 export * as invoiceSplitter from "./invoiceSplitter/internal";
+export * as multiReceiptsDetector from "./multiReceiptsDetector/internal";
 export * as passport from "./passport/internal";
 export * as proofOfAddress from "./proofOfAddress/internal";
 export * as receipt from "./receipt/internal";

package/src/product/internal.js

@@ -23,7 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.us = exports.receipt = exports.proofOfAddress = exports.passport = exports.invoiceSplitter = exports.invoice = exports.fr = exports.financialDocument = exports.eu = exports.custom = exports.cropper = void 0;
+exports.us = exports.receipt = exports.proofOfAddress = exports.passport = exports.multiReceiptsDetector = exports.invoiceSplitter = exports.invoice = exports.fr = exports.financialDocument = exports.eu = exports.custom = exports.cropper = exports.barcodeReader = void 0;
+exports.barcodeReader = __importStar(require("./barcodeReader/internal"));
 exports.cropper = __importStar(require("./cropper/internal"));
 exports.custom = __importStar(require("./custom/internal"));
 exports.eu = __importStar(require("./eu/internal"));
@@ -31,6 +32,7 @@ exports.financialDocument = __importStar(require("./financialDocument/internal")
 exports.fr = __importStar(require("./fr/internal"));
 exports.invoice = __importStar(require("./invoice/internal"));
 exports.invoiceSplitter = __importStar(require("./invoiceSplitter/internal"));
+exports.multiReceiptsDetector = __importStar(require("./multiReceiptsDetector/internal"));
 exports.passport = __importStar(require("./passport/internal"));
 exports.proofOfAddress = __importStar(require("./proofOfAddress/internal"));
 exports.receipt = __importStar(require("./receipt/internal"));

package/src/product/multiReceiptsDetector/internal.d.ts

@@ -0,0 +1,2 @@
+export { MultiReceiptsDetectorV1 } from "./multiReceiptsDetectorV1";
+export { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Document";

package/src/product/multiReceiptsDetector/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiReceiptsDetectorV1Document = exports.MultiReceiptsDetectorV1 = void 0;
+var multiReceiptsDetectorV1_1 = require("./multiReceiptsDetectorV1");
+Object.defineProperty(exports, "MultiReceiptsDetectorV1", { enumerable: true, get: function () { return multiReceiptsDetectorV1_1.MultiReceiptsDetectorV1; } });
+var multiReceiptsDetectorV1Document_1 = require("./multiReceiptsDetectorV1Document");
+Object.defineProperty(exports, "MultiReceiptsDetectorV1Document", { enumerable: true, get: function () { return multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document; } });

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../parsing/common";
+import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Document";
+/**
+ * Inference prediction for Multi Receipts Detector, API version 1.
+ */
+export declare class MultiReceiptsDetectorV1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: MultiReceiptsDetectorV1Document;
+    /** The document's pages. */
+    pages: Page<MultiReceiptsDetectorV1Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiReceiptsDetectorV1 = void 0;
+const common_1 = require("../../parsing/common");
+const multiReceiptsDetectorV1Document_1 = require("./multiReceiptsDetectorV1Document");
+/**
+ * Inference prediction for Multi Receipts Detector, API version 1.
+ */
+class MultiReceiptsDetectorV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "multi_receipts_detector";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document, page, page["id"], page["orientation"]));
+    }
+}
+exports.MultiReceiptsDetectorV1 = MultiReceiptsDetectorV1;

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.d.ts

@@ -0,0 +1,14 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { PositionField } from "../../parsing/standard";
+/**
+ * Document data for Multi Receipts Detector, API version 1.
+ */
+export declare class MultiReceiptsDetectorV1Document implements Prediction {
+    /** Positions of the receipts on the document. */
+    receipts: PositionField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiReceiptsDetectorV1Document = void 0;
+const common_1 = require("../../parsing/common");
+const standard_1 = require("../../parsing/standard");
+/**
+ * Document data for Multi Receipts Detector, API version 1.
+ */
+class MultiReceiptsDetectorV1Document {
+    constructor(rawPrediction, pageId) {
+        /** Positions of the receipts on the document. */
+        this.receipts = [];
+        rawPrediction["receipts"] &&
+            rawPrediction["receipts"].map((itemPrediction) => this.receipts.push(new standard_1.PositionField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const receipts = this.receipts.join("\n                   ");
+        const outStr = `:List of Receipts: ${receipts}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.MultiReceiptsDetectorV1Document = MultiReceiptsDetectorV1Document;

package/src/product/passport/passportV1Document.js

@@ -60,7 +60,7 @@ class PassportV1Document {
      * Default string representation.
      */
     toString() {
-        const givenNames = this.givenNames.join("\n              ");
+        const givenNames = this.givenNames.join("\n                ");
         const outStr = `:Country Code: ${this.country}
 :ID Number: ${this.idNumber}
 :Given Name(s): ${givenNames}

package/src/product/proofOfAddress/proofOfAddressV1Document.js

@@ -57,8 +57,8 @@ class ProofOfAddressV1Document {
      * Default string representation.
      */
     toString() {
-        const issuerCompanyRegistration = this.issuerCompanyRegistration.join("\n                              ");
-        const recipientCompanyRegistration = this.recipientCompanyRegistration.join("\n                                 ");
+        const issuerCompanyRegistration = this.issuerCompanyRegistration.join("\n                               ");
+        const recipientCompanyRegistration = this.recipientCompanyRegistration.join("\n                                  ");
         const dates = this.dates.join("\n        ");
         const outStr = `:Locale: ${this.locale}
 :Issuer Name: ${this.issuerName}

package/src/product/us/bankCheck/bankCheckV1Page.js

@@ -22,7 +22,7 @@ class BankCheckV1Page extends bankCheckV1Document_1.BankCheckV1Document {
         })));
     }
     toString() {
-        const signaturesPositions = this.signaturesPositions.join("\n                       ");
+        const signaturesPositions = this.signaturesPositions.join("\n                      ");
         let outStr = `:Check Position: ${this.checkPosition}
 :Signature Positions: ${signaturesPositions}`.trimEnd();
         outStr += "\n" + super.toString();

package/src/product/us/index.d.ts

@@ -1,2 +1,3 @@
 export { BankCheckV1 } from "./bankCheck/bankCheckV1";
 export { DriverLicenseV1 } from "./driverLicense/driverLicenseV1";
+export { W9V1 } from "./w9/w9V1";

package/src/product/us/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriverLicenseV1 = exports.BankCheckV1 = void 0;
+exports.W9V1 = exports.DriverLicenseV1 = exports.BankCheckV1 = void 0;
 var bankCheckV1_1 = require("./bankCheck/bankCheckV1");
 Object.defineProperty(exports, "BankCheckV1", { enumerable: true, get: function () { return bankCheckV1_1.BankCheckV1; } });
 var driverLicenseV1_1 = require("./driverLicense/driverLicenseV1");
 Object.defineProperty(exports, "DriverLicenseV1", { enumerable: true, get: function () { return driverLicenseV1_1.DriverLicenseV1; } });
+var w9V1_1 = require("./w9/w9V1");
+Object.defineProperty(exports, "W9V1", { enumerable: true, get: function () { return w9V1_1.W9V1; } });

package/src/product/us/w9/internal.d.ts

@@ -0,0 +1,3 @@
+export { W9V1 } from "./w9V1";
+export { W9V1Document } from "./w9V1Document";
+export { W9V1Page } from "./w9V1Page";

package/src/product/us/w9/internal.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W9V1Page = exports.W9V1Document = exports.W9V1 = void 0;
+var w9V1_1 = require("./w9V1");
+Object.defineProperty(exports, "W9V1", { enumerable: true, get: function () { return w9V1_1.W9V1; } });
+var w9V1Document_1 = require("./w9V1Document");
+Object.defineProperty(exports, "W9V1Document", { enumerable: true, get: function () { return w9V1Document_1.W9V1Document; } });
+var w9V1Page_1 = require("./w9V1Page");
+Object.defineProperty(exports, "W9V1Page", { enumerable: true, get: function () { return w9V1Page_1.W9V1Page; } });

package/src/product/us/w9/w9V1.d.ts

@@ -0,0 +1,17 @@
+import { Inference, StringDict, Page } from "../../../parsing/common";
+import { W9V1Document } from "./w9V1Document";
+import { W9V1Page } from "./w9V1Page";
+/**
+ * Inference prediction for US W9, API version 1.
+ */
+export declare class W9V1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: W9V1Document;
+    /** The document's pages. */
+    pages: Page<W9V1Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/us/w9/w9V1.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W9V1 = void 0;
+const common_1 = require("../../../parsing/common");
+const w9V1Document_1 = require("./w9V1Document");
+const w9V1Page_1 = require("./w9V1Page");
+/**
+ * Inference prediction for US W9, API version 1.
+ */
+class W9V1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "us_w9";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new w9V1Document_1.W9V1Document();
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(w9V1Page_1.W9V1Page, page, page["id"], page["orientation"]));
+    }
+}
+exports.W9V1 = W9V1;

package/src/product/us/w9/w9V1Document.d.ts

@@ -0,0 +1,10 @@
+import { Prediction } from "../../../parsing/common";
+/**
+ * Document data for US W9, API version 1.
+ */
+export declare class W9V1Document implements Prediction {
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/us/w9/w9V1Document.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W9V1Document = void 0;
+/**
+ * Document data for US W9, API version 1.
+ */
+class W9V1Document {
+    /**
+     * Default string representation.
+     */
+    toString() {
+        return "";
+    }
+}
+exports.W9V1Document = W9V1Document;

package/src/product/us/w9/w9V1Page.d.ts

@@ -0,0 +1,34 @@
+import { StringDict } from "../../../parsing/common";
+import { PositionField, StringField } from "../../../parsing/standard";
+import { W9V1Document } from "./w9V1Document";
+/**
+ * Page data for US W9, API version 1.
+ */
+export declare class W9V1Page extends W9V1Document {
+    /** The street address (number, street, and apt. or suite no.) of the applicant. */
+    address: StringField;
+    /** The business name or disregarded entity name, if different from Name. */
+    businessName: StringField;
+    /** The city, state, and ZIP code of the applicant. */
+    cityStateZip: StringField;
+    /** The employer identification number. */
+    ein: StringField;
+    /** Name as shown on the applicant's income tax return. */
+    name: StringField;
+    /** Position of the signature date on the document. */
+    signatureDatePosition: PositionField;
+    /** Position of the signature on the document. */
+    signaturePosition: PositionField;
+    /** The applicant's social security number. */
+    ssn: StringField;
+    /** The federal tax classification, which can vary depending on the revision date. */
+    taxClassification: StringField;
+    /** Depending on revision year, among S, C, P or D for Limited Liability Company Classification. */
+    taxClassificationLlc: StringField;
+    /** Tax Classification Other Details. */
+    taxClassificationOtherDetails: StringField;
+    /** The Revision month and year of the W9 form. */
+    w9RevisionDate: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}