mindee 4.23.0 → 4.24.0

package/src/product/financialDocument/financialDocumentV1Document.d.ts

@@ -7,11 +7,11 @@ import { AmountField, ClassificationField, CompanyRegistrationField, DateField,
 export declare class FinancialDocumentV1Document implements Prediction {
     /** The customer's address used for billing. */
     billingAddress: StringField;
-    /** The purchase category among predefined classes. */
+    /** The purchase category, only for receipts. */
     category: ClassificationField;
     /** The address of the customer. */
     customerAddress: StringField;
-    /** List of company registrations associated to the customer. */
+    /** List of company registration numbers associated to the customer. */
     customerCompanyRegistrations: CompanyRegistrationField[];
     /** The customer account number or identifier from the supplier. */
     customerId: StringField;
@@ -19,47 +19,50 @@ export declare class FinancialDocumentV1Document implements Prediction {
     customerName: StringField;
     /** The date the purchase was made. */
     date: DateField;
-    /** The document number or identifier. */
+    /** The document number or identifier (invoice number or receipt number). */
     documentNumber: StringField;
-    /** One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'. */
+    /**
+     * The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it
+     * is a receipt.
+     */
     documentType: ClassificationField;
     /** The date on which the payment is due. */
     dueDate: DateField;
     /** The invoice number or identifier only if document is an invoice. */
     invoiceNumber: StringField;
-    /** List of line item details. */
+    /** List of line item present on the document. */
     lineItems: FinancialDocumentV1LineItem[];
-    /** The locale detected on the document. */
+    /** The locale of the document. */
     locale: LocaleField;
     /** The date on which the payment is due / fullfilled. */
     paymentDate: DateField;
-    /** The purchase order number. */
+    /** The purchase order number, only if the document is an invoice. */
     poNumber: StringField;
     /** The receipt number or identifier only if document is a receipt. */
     receiptNumber: StringField;
-    /** List of Reference numbers, including PO number. */
+    /** List of Reference numbers, including PO number, only if the document is an invoice. */
     referenceNumbers: StringField[];
     /** The customer's address used for shipping. */
     shippingAddress: StringField;
-    /** The purchase subcategory among predefined classes for transport and food. */
+    /** The purchase subcategory for transport and food, only for receipts. */
     subcategory: ClassificationField;
     /** The address of the supplier or merchant. */
     supplierAddress: StringField;
-    /** List of company registrations associated to the supplier. */
+    /** List of company registration numbers associated to the supplier. */
     supplierCompanyRegistrations: CompanyRegistrationField[];
     /** The email of the supplier or merchant. */
     supplierEmail: StringField;
     /** The name of the supplier or merchant. */
     supplierName: StringField;
-    /** List of payment details associated to the supplier. */
+    /** List of payment details associated to the supplier (only for invoices). */
     supplierPaymentDetails: PaymentDetailsField[];
     /** The phone number of the supplier or merchant. */
     supplierPhoneNumber: StringField;
     /** The website URL of the supplier or merchant. */
     supplierWebsite: StringField;
-    /** List of tax lines information. */
+    /** List of all taxes on the document. */
     taxes: Taxes;
-    /** The time the purchase was made. */
+    /** The time the purchase was made (only for receipts). */
     time: StringField;
     /** The total amount of tip and gratuity */
     tip: AmountField;
@@ -67,7 +70,7 @@ export declare class FinancialDocumentV1Document implements Prediction {
     totalAmount: AmountField;
     /** The net amount paid: does not include taxes, fees, and discounts. */
     totalNet: AmountField;
-    /** The total amount of taxes. */
+    /** The sum of all taxes present on the document. */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/product/financialDocument/financialDocumentV1Document.js

@@ -9,15 +9,15 @@ const standard_1 = require("../../parsing/standard");
  */
 class FinancialDocumentV1Document {
     constructor(rawPrediction, pageId) {
-        /** List of company registrations associated to the customer. */
+        /** List of company registration numbers associated to the customer. */
         this.customerCompanyRegistrations = [];
-        /** List of line item details. */
+        /** List of line item present on the document. */
         this.lineItems = [];
-        /** List of Reference numbers, including PO number. */
+        /** List of Reference numbers, including PO number, only if the document is an invoice. */
         this.referenceNumbers = [];
-        /** List of company registrations associated to the supplier. */
+        /** List of company registration numbers associated to the supplier. */
         this.supplierCompanyRegistrations = [];
-        /** List of payment details associated to the supplier. */
+        /** List of payment details associated to the supplier (only for invoices). */
         this.supplierPaymentDetails = [];
         this.billingAddress = new standard_1.StringField({
             prediction: rawPrediction["billing_address"],

package/src/product/financialDocument/financialDocumentV1LineItem.d.ts

@@ -1,7 +1,7 @@
 import { StringDict } from "../../parsing/common";
 import { Polygon } from "../../geometry";
 /**
- * List of line item details.
+ * List of line item present on the document.
  */
 export declare class FinancialDocumentV1LineItem {
     #private;

package/src/product/financialDocument/financialDocumentV1LineItem.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FinancialDocumentV1LineItem = void 0;
 const common_1 = require("../../parsing/common");
 /**
- * List of line item details.
+ * List of line item present on the document.
  */
 class FinancialDocumentV1LineItem {
     constructor({ prediction = {} }) {

package/src/product/fr/energyBill/energyBillV1Document.d.ts

@@ -7,7 +7,7 @@ import { EnergyBillV1TaxesAndContribution } from "./energyBillV1TaxesAndContribu
 import { EnergyBillV1MeterDetail } from "./energyBillV1MeterDetail";
 import { AmountField, DateField, StringField } from "../../../parsing/standard";
 /**
- * Energy Bill API version 1.0 document data.
+ * Energy Bill API version 1.2 document data.
  */
 export declare class EnergyBillV1Document implements Prediction {
     /** The unique identifier associated with a specific contract. */

package/src/product/fr/energyBill/energyBillV1Document.js

@@ -10,7 +10,7 @@ const energyBillV1TaxesAndContribution_1 = require("./energyBillV1TaxesAndContri
 const energyBillV1MeterDetail_1 = require("./energyBillV1MeterDetail");
 const standard_1 = require("../../../parsing/standard");
 /**
- * Energy Bill API version 1.0 document data.
+ * Energy Bill API version 1.2 document data.
  */
 class EnergyBillV1Document {
     constructor(rawPrediction, pageId) {
@@ -99,13 +99,15 @@ class EnergyBillV1Document {
         }
         let energyUsageSummary = "";
         if (this.energyUsage && this.energyUsage.length > 0) {
-            const energyUsageColSizes = [38, 12, 12, 10, 11, 12];
+            const energyUsageColSizes = [13, 38, 12, 12, 10, 11, 17, 12];
             energyUsageSummary += "\n" + (0, common_1.lineSeparator)(energyUsageColSizes, "-") + "\n  ";
+            energyUsageSummary += "| Consumption ";
             energyUsageSummary += "| Description                          ";
             energyUsageSummary += "| End Date   ";
             energyUsageSummary += "| Start Date ";
             energyUsageSummary += "| Tax Rate ";
             energyUsageSummary += "| Total     ";
+            energyUsageSummary += "| Unit of Measure ";
             energyUsageSummary += "| Unit Price ";
             energyUsageSummary += "|\n" + (0, common_1.lineSeparator)(energyUsageColSizes, "=");
             energyUsageSummary += this.energyUsage.map((item) => "\n  " + item.toTableLine() + "\n" + (0, common_1.lineSeparator)(energyUsageColSizes, "-")).join("");

package/src/product/fr/energyBill/energyBillV1EnergyUsage.d.ts

@@ -5,6 +5,8 @@ import { Polygon } from "../../../geometry";
  */
 export declare class EnergyBillV1EnergyUsage {
     #private;
+    /** The price per unit of energy consumed. */
+    consumption: number | null;
     /** Description or details of the energy usage. */
     description: string | null;
     /** The end date of the energy usage. */
@@ -15,6 +17,8 @@ export declare class EnergyBillV1EnergyUsage {
     taxRate: number | null;
     /** The total cost of energy consumed. */
     total: number | null;
+    /** The unit of measurement for energy consumption. */
+    unit: string | null;
     /** The price per unit of energy consumed. */
     unitPrice: number | null;
     /** Confidence score */

package/src/product/fr/energyBill/energyBillV1EnergyUsage.js

@@ -21,6 +21,14 @@ class EnergyBillV1EnergyUsage {
          * the field in the document.
          */
         this.polygon = [];
+        if (prediction["consumption"] !== undefined &&
+            prediction["consumption"] !== null &&
+            !isNaN(prediction["consumption"])) {
+            this.consumption = +parseFloat(prediction["consumption"]);
+        }
+        else {
+            this.consumption = null;
+        }
         this.description = prediction["description"];
         this.endDate = prediction["end_date"];
         this.startDate = prediction["start_date"];
@@ -40,6 +48,7 @@ class EnergyBillV1EnergyUsage {
         else {
             this.total = null;
         }
+        this.unit = prediction["unit"];
         if (prediction["unit_price"] !== undefined &&
             prediction["unit_price"] !== null &&
             !isNaN(prediction["unit_price"])) {
@@ -59,7 +68,9 @@ class EnergyBillV1EnergyUsage {
      */
     toString() {
         const printable = __classPrivateFieldGet(this, _EnergyBillV1EnergyUsage_instances, "m", _EnergyBillV1EnergyUsage_printableValues).call(this);
-        return ("Description: " +
+        return ("Consumption: " +
+            printable.consumption +
+            ", Description: " +
             printable.description +
             ", End Date: " +
             printable.endDate +
@@ -69,6 +80,8 @@ class EnergyBillV1EnergyUsage {
             printable.taxRate +
             ", Total: " +
             printable.total +
+            ", Unit of Measure: " +
+            printable.unit +
             ", Unit Price: " +
             printable.unitPrice);
     }
@@ -78,6 +91,8 @@ class EnergyBillV1EnergyUsage {
     toTableLine() {
         const printable = __classPrivateFieldGet(this, _EnergyBillV1EnergyUsage_instances, "m", _EnergyBillV1EnergyUsage_printableValues).call(this);
         return ("| " +
+            printable.consumption.padEnd(11) +
+            " | " +
             printable.description.padEnd(36) +
             " | " +
             printable.endDate.padEnd(10) +
@@ -88,6 +103,8 @@ class EnergyBillV1EnergyUsage {
             " | " +
             printable.total.padEnd(9) +
             " | " +
+            printable.unit.padEnd(15) +
+            " | " +
             printable.unitPrice.padEnd(10) +
             " |");
     }
@@ -95,6 +112,7 @@ class EnergyBillV1EnergyUsage {
 exports.EnergyBillV1EnergyUsage = EnergyBillV1EnergyUsage;
 _EnergyBillV1EnergyUsage_instances = new WeakSet(), _EnergyBillV1EnergyUsage_printableValues = function _EnergyBillV1EnergyUsage_printableValues() {
     return {
+        consumption: this.consumption !== undefined ? (0, common_1.floatToString)(this.consumption) : "",
         description: this.description ?
             this.description.length <= 36 ?
                 (0, common_1.cleanSpecialChars)(this.description) :
@@ -112,6 +130,11 @@ _EnergyBillV1EnergyUsage_instances = new WeakSet(), _EnergyBillV1EnergyUsage_pri
             "",
         taxRate: this.taxRate !== undefined ? (0, common_1.floatToString)(this.taxRate) : "",
         total: this.total !== undefined ? (0, common_1.floatToString)(this.total) : "",
+        unit: this.unit ?
+            this.unit.length <= 15 ?
+                (0, common_1.cleanSpecialChars)(this.unit) :
+                (0, common_1.cleanSpecialChars)(this.unit).slice(0, 12) + "..." :
+            "",
         unitPrice: this.unitPrice !== undefined ? (0, common_1.floatToString)(this.unitPrice) : "",
     };
 };

package/src/product/fr/energyBill/energyBillV1MeterDetail.d.ts

@@ -9,7 +9,7 @@ export declare class EnergyBillV1MeterDetail {
     meterNumber: string | null;
     /** The type of energy meter. */
     meterType: string | null;
-    /** The unit of measurement for energy consumption, which can be kW, m³, or L. */
+    /** The unit of power for energy consumption. */
     unit: string | null;
     /** Confidence score */
     confidence: number;

package/src/product/fr/energyBill/energyBillV1MeterDetail.js

@@ -38,7 +38,7 @@ class EnergyBillV1MeterDetail {
             printable.meterNumber +
             ", Meter Type: " +
             printable.meterType +
-            ", Unit of Measure: " +
+            ", Unit of Power: " +
             printable.unit);
     }
     /**
@@ -49,7 +49,7 @@ class EnergyBillV1MeterDetail {
         return `
   :Meter Number: ${printable.meterNumber}
   :Meter Type: ${printable.meterType}
-  :Unit of Measure: ${printable.unit}`.trimEnd();
+  :Unit of Power: ${printable.unit}`.trimEnd();
     }
 }
 exports.EnergyBillV1MeterDetail = EnergyBillV1MeterDetail;

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

@@ -1,6 +1,6 @@
 export * as bankAccountDetails from "./bankAccountDetails/internal";
 export * as carteGrise from "./carteGrise/internal";
 export * as energyBill from "./energyBill/internal";
-export * as fr from "./healthCard/internal";
+export * as healthCard from "./healthCard/internal";
 export * as idCard from "./idCard/internal";
 export * as payslip from "./payslip/internal";

package/src/product/fr/internal.js

@@ -23,10 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.payslip = exports.idCard = exports.fr = exports.energyBill = exports.carteGrise = exports.bankAccountDetails = void 0;
+exports.payslip = exports.idCard = exports.healthCard = exports.energyBill = exports.carteGrise = exports.bankAccountDetails = void 0;
 exports.bankAccountDetails = __importStar(require("./bankAccountDetails/internal"));
 exports.carteGrise = __importStar(require("./carteGrise/internal"));
 exports.energyBill = __importStar(require("./energyBill/internal"));
-exports.fr = __importStar(require("./healthCard/internal"));
+exports.healthCard = __importStar(require("./healthCard/internal"));
 exports.idCard = __importStar(require("./idCard/internal"));
 exports.payslip = __importStar(require("./payslip/internal"));

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

@@ -1 +1 @@
-export * as ind from "./indianPassport/internal";
+export * as indianPassport from "./indianPassport/internal";

package/src/product/ind/internal.js

@@ -23,5 +23,5 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ind = void 0;
-exports.ind = __importStar(require("./indianPassport/internal"));
+exports.indianPassport = void 0;
+exports.indianPassport = __importStar(require("./indianPassport/internal"));

package/src/product/index.d.ts

@@ -1,3 +1,6 @@
+export * as fr from "./fr";
+export * as ind from "./ind";
+export * as us from "./us";
 export { BarcodeReaderV1 } from "./barcodeReader/barcodeReaderV1";
 export { BillOfLadingV1 } from "./billOfLading/billOfLadingV1";
 export { BusinessCardV1 } from "./businessCard/businessCardV1";
@@ -8,16 +11,10 @@ export { DriverLicenseV1 } from "./driverLicense/driverLicenseV1";
 export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
 export { GeneratedV1 } from "./generated/generatedV1";
 export { InternationalIdV2 } from "./internationalId/internationalIdV2";
-export { InvoiceV4 } from "./invoice/invoiceV4";
 export { InvoiceSplitterV1 } from "./invoiceSplitter/invoiceSplitterV1";
+export { InvoiceV4 } from "./invoice/invoiceV4";
 export { MultiReceiptsDetectorV1 } from "./multiReceiptsDetector/multiReceiptsDetectorV1";
 export { NutritionFactsLabelV1 } from "./nutritionFactsLabel/nutritionFactsLabelV1";
 export { PassportV1 } from "./passport/passportV1";
-export { ProofOfAddressV1 } from "./proofOfAddress/proofOfAddressV1";
-export { ReceiptV4 } from "./receipt/receiptV4";
 export { ReceiptV5 } from "./receipt/receiptV5";
 export { ResumeV1 } from "./resume/resumeV1";
-export * as eu from "./eu";
-export * as fr from "./fr";
-export * as ind from "./ind";
-export * as us from "./us";

package/src/product/index.js

@@ -23,7 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.us = exports.ind = exports.fr = exports.eu = exports.ResumeV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.ProofOfAddressV1 = exports.PassportV1 = exports.NutritionFactsLabelV1 = exports.MultiReceiptsDetectorV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InternationalIdV2 = exports.GeneratedV1 = exports.FinancialDocumentV1 = exports.DriverLicenseV1 = exports.DeliveryNoteV1 = exports.CustomV1 = exports.CropperV1 = exports.BusinessCardV1 = exports.BillOfLadingV1 = exports.BarcodeReaderV1 = void 0;
+exports.ResumeV1 = exports.ReceiptV5 = exports.PassportV1 = exports.NutritionFactsLabelV1 = exports.MultiReceiptsDetectorV1 = exports.InvoiceV4 = exports.InvoiceSplitterV1 = exports.InternationalIdV2 = exports.GeneratedV1 = exports.FinancialDocumentV1 = exports.DriverLicenseV1 = exports.DeliveryNoteV1 = exports.CustomV1 = exports.CropperV1 = exports.BusinessCardV1 = exports.BillOfLadingV1 = exports.BarcodeReaderV1 = exports.us = exports.ind = exports.fr = void 0;
+exports.fr = __importStar(require("./fr"));
+exports.ind = __importStar(require("./ind"));
+exports.us = __importStar(require("./us"));
 var barcodeReaderV1_1 = require("./barcodeReader/barcodeReaderV1");
 Object.defineProperty(exports, "BarcodeReaderV1", { enumerable: true, get: function () { return barcodeReaderV1_1.BarcodeReaderV1; } });
 var billOfLadingV1_1 = require("./billOfLading/billOfLadingV1");
@@ -44,25 +47,17 @@ var generatedV1_1 = require("./generated/generatedV1");
 Object.defineProperty(exports, "GeneratedV1", { enumerable: true, get: function () { return generatedV1_1.GeneratedV1; } });
 var internationalIdV2_1 = require("./internationalId/internationalIdV2");
 Object.defineProperty(exports, "InternationalIdV2", { enumerable: true, get: function () { return internationalIdV2_1.InternationalIdV2; } });
-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 invoiceV4_1 = require("./invoice/invoiceV4");
+Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
 var multiReceiptsDetectorV1_1 = require("./multiReceiptsDetector/multiReceiptsDetectorV1");
 Object.defineProperty(exports, "MultiReceiptsDetectorV1", { enumerable: true, get: function () { return multiReceiptsDetectorV1_1.MultiReceiptsDetectorV1; } });
 var nutritionFactsLabelV1_1 = require("./nutritionFactsLabel/nutritionFactsLabelV1");
 Object.defineProperty(exports, "NutritionFactsLabelV1", { enumerable: true, get: function () { return nutritionFactsLabelV1_1.NutritionFactsLabelV1; } });
 var passportV1_1 = require("./passport/passportV1");
 Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function () { return passportV1_1.PassportV1; } });
-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; } });
 var resumeV1_1 = require("./resume/resumeV1");
 Object.defineProperty(exports, "ResumeV1", { enumerable: true, get: function () { return resumeV1_1.ResumeV1; } });
-exports.eu = __importStar(require("./eu"));
-exports.fr = __importStar(require("./fr"));
-exports.ind = __importStar(require("./ind"));
-exports.us = __importStar(require("./us"));

package/src/product/internal.d.ts

@@ -5,17 +5,16 @@ export * as cropper from "./cropper/internal";
 export * as custom from "./custom/internal";
 export * as deliveryNote from "./deliveryNote/internal";
 export * as driverLicense from "./driverLicense/internal";
-export * as eu from "./eu/internal";
 export * as financialDocument from "./financialDocument/internal";
 export * as fr from "./fr/internal";
 export * as generated from "./generated/internal";
+export * as ind from "./ind/internal";
 export * as internationalId from "./internationalId/internal";
 export * as invoice from "./invoice/internal";
 export * as invoiceSplitter from "./invoiceSplitter/internal";
 export * as multiReceiptsDetector from "./multiReceiptsDetector/internal";
 export * as nutritionFactsLabel from "./nutritionFactsLabel/internal";
 export * as passport from "./passport/internal";
-export * as proofOfAddress from "./proofOfAddress/internal";
 export * as receipt from "./receipt/internal";
 export * as resume from "./resume/internal";
 export * as us from "./us/internal";

package/src/product/internal.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.us = exports.resume = exports.receipt = exports.proofOfAddress = exports.passport = exports.nutritionFactsLabel = exports.multiReceiptsDetector = exports.invoiceSplitter = exports.invoice = exports.internationalId = exports.generated = exports.fr = exports.financialDocument = exports.eu = exports.driverLicense = exports.deliveryNote = exports.custom = exports.cropper = exports.businessCard = exports.billOfLading = exports.barcodeReader = void 0;
+exports.us = exports.resume = exports.receipt = exports.passport = exports.nutritionFactsLabel = exports.multiReceiptsDetector = exports.invoiceSplitter = exports.invoice = exports.internationalId = exports.ind = exports.generated = exports.fr = exports.financialDocument = exports.driverLicense = exports.deliveryNote = exports.custom = exports.cropper = exports.businessCard = exports.billOfLading = exports.barcodeReader = void 0;
 exports.barcodeReader = __importStar(require("./barcodeReader/internal"));
 exports.billOfLading = __importStar(require("./billOfLading/internal"));
 exports.businessCard = __importStar(require("./businessCard/internal"));
@@ -31,17 +31,16 @@ exports.cropper = __importStar(require("./cropper/internal"));
 exports.custom = __importStar(require("./custom/internal"));
 exports.deliveryNote = __importStar(require("./deliveryNote/internal"));
 exports.driverLicense = __importStar(require("./driverLicense/internal"));
-exports.eu = __importStar(require("./eu/internal"));
 exports.financialDocument = __importStar(require("./financialDocument/internal"));
 exports.fr = __importStar(require("./fr/internal"));
 exports.generated = __importStar(require("./generated/internal"));
+exports.ind = __importStar(require("./ind/internal"));
 exports.internationalId = __importStar(require("./internationalId/internal"));
 exports.invoice = __importStar(require("./invoice/internal"));
 exports.invoiceSplitter = __importStar(require("./invoiceSplitter/internal"));
 exports.multiReceiptsDetector = __importStar(require("./multiReceiptsDetector/internal"));
 exports.nutritionFactsLabel = __importStar(require("./nutritionFactsLabel/internal"));
 exports.passport = __importStar(require("./passport/internal"));
-exports.proofOfAddress = __importStar(require("./proofOfAddress/internal"));
 exports.receipt = __importStar(require("./receipt/internal"));
 exports.resume = __importStar(require("./resume/internal"));
 exports.us = __importStar(require("./us/internal"));

package/src/product/invoice/invoiceV4Document.d.ts

@@ -5,11 +5,11 @@ import { AmountField, ClassificationField, CompanyRegistrationField, DateField,
  * Invoice API version 4.9 document data.
  */
 export declare class InvoiceV4Document implements Prediction {
-    /** The customer's address used for billing. */
+    /** The customer billing address. */
     billingAddress: StringField;
     /** The address of the customer. */
     customerAddress: StringField;
-    /** List of company registrations associated to the customer. */
+    /** List of company registration numbers associated to the customer. */
     customerCompanyRegistrations: CompanyRegistrationField[];
     /** The customer account number or identifier from the supplier. */
     customerId: StringField;
@@ -17,45 +17,45 @@ export declare class InvoiceV4Document implements Prediction {
     customerName: StringField;
     /** The date the purchase was made. */
     date: DateField;
-    /** One of: 'INVOICE', 'CREDIT NOTE'. */
+    /** Document type: INVOICE or CREDIT NOTE. */
     documentType: ClassificationField;
     /** The date on which the payment is due. */
     dueDate: DateField;
     /** The invoice number or identifier. */
     invoiceNumber: StringField;
-    /** List of line item details. */
+    /** List of all the line items present on the invoice. */
     lineItems: InvoiceV4LineItem[];
-    /** The locale detected on the document. */
+    /** The locale of the document. */
     locale: LocaleField;
-    /** The date on which the payment is due/ was full-filled. */
+    /** The date on which the payment is due / was full-filled. */
     paymentDate: DateField;
     /** The purchase order number. */
     poNumber: StringField;
-    /** List of Reference numbers, including PO number. */
+    /** List of all reference numbers on the invoice, including the purchase order number. */
     referenceNumbers: StringField[];
     /** Customer's delivery address. */
     shippingAddress: StringField;
     /** The address of the supplier or merchant. */
     supplierAddress: StringField;
-    /** List of company registrations associated to the supplier. */
+    /** List of company registration numbers associated to the supplier. */
     supplierCompanyRegistrations: CompanyRegistrationField[];
-    /** The email of the supplier or merchant. */
+    /** The email address of the supplier or merchant. */
     supplierEmail: StringField;
     /** The name of the supplier or merchant. */
     supplierName: StringField;
-    /** List of payment details associated to the supplier. */
+    /** List of payment details associated to the supplier of the invoice. */
     supplierPaymentDetails: PaymentDetailsField[];
     /** The phone number of the supplier or merchant. */
     supplierPhoneNumber: StringField;
     /** The website URL of the supplier or merchant. */
     supplierWebsite: StringField;
-    /** List of tax line details. */
+    /** List of taxes. Each item contains the detail of the tax. */
     taxes: Taxes;
-    /** The total amount paid: includes taxes, tips, fees, and other charges. */
+    /** The total amount of the invoice: includes taxes, tips, fees, and other charges. */
     totalAmount: AmountField;
-    /** The net amount paid: does not include taxes, fees, and discounts. */
+    /** The net amount of the invoice: does not include taxes, fees, and discounts. */
     totalNet: AmountField;
-    /** The total tax: includes all the taxes paid for this invoice. */
+    /** The total tax: the sum of all the taxes for this invoice. */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/product/invoice/invoiceV4Document.js

@@ -9,15 +9,15 @@ const standard_1 = require("../../parsing/standard");
  */
 class InvoiceV4Document {
     constructor(rawPrediction, pageId) {
-        /** List of company registrations associated to the customer. */
+        /** List of company registration numbers associated to the customer. */
         this.customerCompanyRegistrations = [];
-        /** List of line item details. */
+        /** List of all the line items present on the invoice. */
         this.lineItems = [];
-        /** List of Reference numbers, including PO number. */
+        /** List of all reference numbers on the invoice, including the purchase order number. */
         this.referenceNumbers = [];
-        /** List of company registrations associated to the supplier. */
+        /** List of company registration numbers associated to the supplier. */
         this.supplierCompanyRegistrations = [];
-        /** List of payment details associated to the supplier. */
+        /** List of payment details associated to the supplier of the invoice. */
         this.supplierPaymentDetails = [];
         this.billingAddress = new standard_1.StringField({
             prediction: rawPrediction["billing_address"],

package/src/product/invoice/invoiceV4LineItem.d.ts

@@ -1,13 +1,13 @@
 import { StringDict } from "../../parsing/common";
 import { Polygon } from "../../geometry";
 /**
- * List of line item details.
+ * List of all the line items present on the invoice.
  */
 export declare class InvoiceV4LineItem {
     #private;
     /** The item description. */
     description: string | null;
-    /** The product code referring to the item. */
+    /** The product code of the item. */
     productCode: string | null;
     /** The item quantity */
     quantity: number | null;

package/src/product/invoice/invoiceV4LineItem.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceV4LineItem = void 0;
 const common_1 = require("../../parsing/common");
 /**
- * List of line item details.
+ * List of all the line items present on the invoice.
  */
 class InvoiceV4LineItem {
     constructor({ prediction = {} }) {

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

@@ -0,0 +1 @@
+export { InvoiceSplitterV1 } from "./invoiceSplitterV1";

package/src/product/invoiceSplitter/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceSplitterV1 = void 0;
+var invoiceSplitterV1_1 = require("./invoiceSplitterV1");
+Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });

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

@@ -1,3 +1,3 @@
 export { InvoiceSplitterV1 } from "./invoiceSplitterV1";
 export { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document";
-export { InvoiceSplitterV1PageGroup } from "./invoiceSplitterV1PageGroup";
+export { InvoiceSplitterV1InvoicePageGroup } from "./invoiceSplitterV1InvoicePageGroup";

package/src/product/invoiceSplitter/internal.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvoiceSplitterV1PageGroup = exports.InvoiceSplitterV1Document = exports.InvoiceSplitterV1 = void 0;
+exports.InvoiceSplitterV1InvoicePageGroup = exports.InvoiceSplitterV1Document = exports.InvoiceSplitterV1 = void 0;
 var invoiceSplitterV1_1 = require("./invoiceSplitterV1");
 Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });
 var invoiceSplitterV1Document_1 = require("./invoiceSplitterV1Document");
 Object.defineProperty(exports, "InvoiceSplitterV1Document", { enumerable: true, get: function () { return invoiceSplitterV1Document_1.InvoiceSplitterV1Document; } });
-var invoiceSplitterV1PageGroup_1 = require("./invoiceSplitterV1PageGroup");
-Object.defineProperty(exports, "InvoiceSplitterV1PageGroup", { enumerable: true, get: function () { return invoiceSplitterV1PageGroup_1.InvoiceSplitterV1PageGroup; } });
+var invoiceSplitterV1InvoicePageGroup_1 = require("./invoiceSplitterV1InvoicePageGroup");
+Object.defineProperty(exports, "InvoiceSplitterV1InvoicePageGroup", { enumerable: true, get: function () { return invoiceSplitterV1InvoicePageGroup_1.InvoiceSplitterV1InvoicePageGroup; } });

package/src/product/invoiceSplitter/invoiceSplitterV1.d.ts

@@ -1,7 +1,7 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document";
 /**
- * Inference prediction for Invoice Splitter, API version 1.
+ * Invoice Splitter API version 1 inference prediction.
  */
 export declare class InvoiceSplitterV1 extends Inference {
     /** The endpoint's name. */