mindee 5.8.0 → 5.10.0

package/src/v1/product/cropper/cropperV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { CropperV1Document } from "./cropperV1Document.js";
 import { CropperV1Page } from "./cropperV1Page.js";
 /**
@@ -7,11 +7,17 @@ import { CropperV1Page } from "./cropperV1Page.js";
 export class CropperV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "cropper";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new CropperV1Document();
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/cropper/cropperV1Document.d.ts

@@ -1,4 +1,4 @@
-import { Prediction } from "../../../v1/parsing/common/index.js";
+import { Prediction } from "../../parsing/common/index.js";
 /**
  * Cropper API version 1.1 document data.
  */

package/src/v1/product/cropper/cropperV1Page.d.ts

@@ -1,11 +1,13 @@
-import { StringDict } from "../../../v1/parsing/common/index.js";
-import { PositionField } from "../../../v1/parsing/standard/index.js";
+import { StringDict } from "../../parsing/common/index.js";
+import { PositionField } from "../../parsing/standard/index.js";
 import { CropperV1Document } from "./cropperV1Document.js";
 /**
  * Cropper API version 1.1 page data.
  */
 export declare class CropperV1Page extends CropperV1Document {
-    /** List of documents found in the image. */
+    /**
+     * List of documents found in the image.
+     */
     cropping: PositionField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     toString(): string;

package/src/v1/product/cropper/cropperV1Page.js

@@ -1,5 +1,5 @@
-import { cleanOutString } from "../../../v1/parsing/common/index.js";
-import { PositionField } from "../../../v1/parsing/standard/index.js";
+import { cleanOutString } from "../../parsing/common/index.js";
+import { PositionField } from "../../parsing/standard/index.js";
 import { CropperV1Document } from "./cropperV1Document.js";
 /**
  * Cropper API version 1.1 page data.
@@ -7,7 +7,9 @@ import { CropperV1Document } from "./cropperV1Document.js";
 export class CropperV1Page extends CropperV1Document {
     constructor(rawPrediction, pageId) {
         super();
-        /** List of documents found in the image. */
+        /**
+         * List of documents found in the image.
+         */
         this.cropping = [];
         rawPrediction["cropping"].map((itemPrediction) => this.cropping.push(new PositionField({
             prediction: itemPrediction,

package/src/v1/product/driverLicense/driverLicenseV1.d.ts

@@ -1,16 +1,24 @@
-import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, StringDict, Page } from "../../parsing/common/index.js";
 import { DriverLicenseV1Document } from "./driverLicenseV1Document.js";
 /**
  * Driver License API version 1 inference prediction.
  */
 export declare class DriverLicenseV1 extends Inference {
-    /** The endpoint's name. */
+    /**
+     * The endpoint's name.
+     */
     endpointName: string;
-    /** The endpoint's version. */
+    /**
+     * The endpoint's version.
+     */
     endpointVersion: string;
-    /** The document-level prediction. */
+    /**
+     * The document-level prediction.
+     */
     prediction: DriverLicenseV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<DriverLicenseV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/driverLicense/driverLicenseV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { DriverLicenseV1Document } from "./driverLicenseV1Document.js";
 /**
  * Driver License API version 1 inference prediction.
@@ -6,11 +6,17 @@ import { DriverLicenseV1Document } from "./driverLicenseV1Document.js";
 export class DriverLicenseV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "driver_license";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new DriverLicenseV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/driverLicense/driverLicenseV1Document.d.ts

@@ -1,34 +1,60 @@
-import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
-import { DateField, StringField } from "../../../v1/parsing/standard/index.js";
+import { Prediction, StringDict } from "../../parsing/common/index.js";
+import { DateField, StringField } from "../../parsing/standard/index.js";
 /**
  * Driver License API version 1.0 document data.
  */
 export declare class DriverLicenseV1Document implements Prediction {
-    /** The category or class of the driver license. */
+    /**
+     * The category or class of the driver license.
+     */
     category: StringField;
-    /** The alpha-3 ISO 3166 code of the country where the driver license was issued. */
+    /**
+     * The alpha-3 ISO 3166 code of the country where the driver license was issued.
+     */
     countryCode: StringField;
-    /** The date of birth of the driver license holder. */
+    /**
+     * The date of birth of the driver license holder.
+     */
     dateOfBirth: DateField;
-    /** The DD number of the driver license. */
+    /**
+     * The DD number of the driver license.
+     */
     ddNumber: StringField;
-    /** The expiry date of the driver license. */
+    /**
+     * The expiry date of the driver license.
+     */
     expiryDate: DateField;
-    /** The first name of the driver license holder. */
+    /**
+     * The first name of the driver license holder.
+     */
     firstName: StringField;
-    /** The unique identifier of the driver license. */
+    /**
+     * The unique identifier of the driver license.
+     */
     id: StringField;
-    /** The date when the driver license was issued. */
+    /**
+     * The date when the driver license was issued.
+     */
     issuedDate: DateField;
-    /** The authority that issued the driver license. */
+    /**
+     * The authority that issued the driver license.
+     */
     issuingAuthority: StringField;
-    /** The last name of the driver license holder. */
+    /**
+     * The last name of the driver license holder.
+     */
     lastName: StringField;
-    /** The Machine Readable Zone (MRZ) of the driver license. */
+    /**
+     * The Machine Readable Zone (MRZ) of the driver license.
+     */
     mrz: StringField;
-    /** The place of birth of the driver license holder. */
+    /**
+     * The place of birth of the driver license holder.
+     */
     placeOfBirth: StringField;
-    /** Second part of the ISO 3166-2 code, consisting of two letters indicating the US State. */
+    /**
+     * Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+     */
     state: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/driverLicense/driverLicenseV1Document.js

@@ -1,5 +1,5 @@
-import { cleanOutString, } from "../../../v1/parsing/common/index.js";
-import { DateField, StringField } from "../../../v1/parsing/standard/index.js";
+import { cleanOutString, } from "../../parsing/common/index.js";
+import { DateField, StringField } from "../../parsing/standard/index.js";
 /**
  * Driver License API version 1.0 document data.
  */

package/src/v1/product/financialDocument/financialDocumentV1.d.ts

@@ -1,16 +1,24 @@
-import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, StringDict, Page } from "../../parsing/common/index.js";
 import { FinancialDocumentV1Document } from "./financialDocumentV1Document.js";
 /**
  * Financial Document API version 1 inference prediction.
  */
 export declare class FinancialDocumentV1 extends Inference {
-    /** The endpoint's name. */
+    /**
+     * The endpoint's name.
+     */
     endpointName: string;
-    /** The endpoint's version. */
+    /**
+     * The endpoint's version.
+     */
     endpointVersion: string;
-    /** The document-level prediction. */
+    /**
+     * The document-level prediction.
+     */
     prediction: FinancialDocumentV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<FinancialDocumentV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/financialDocument/financialDocumentV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { FinancialDocumentV1Document } from "./financialDocumentV1Document.js";
 /**
  * Financial Document API version 1 inference prediction.
@@ -6,11 +6,17 @@ import { FinancialDocumentV1Document } from "./financialDocumentV1Document.js";
 export class FinancialDocumentV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "financial_document";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new FinancialDocumentV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

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

@@ -1,78 +1,142 @@
-import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
+import { Prediction, StringDict } from "../../parsing/common/index.js";
 import { FinancialDocumentV1LineItem } from "./financialDocumentV1LineItem.js";
-import { AddressField, AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../../v1/parsing/standard/index.js";
+import { AddressField, AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard/index.js";
 /**
  * Financial Document API version 1.14 document data.
  */
 export declare class FinancialDocumentV1Document implements Prediction {
-    /** The customer's address used for billing. */
+    /**
+     * The customer's address used for billing.
+     */
     billingAddress: AddressField;
-    /** The purchase category. */
+    /**
+     * The purchase category.
+     */
     category: ClassificationField;
-    /** The address of the customer. */
+    /**
+     * The address of the customer.
+     */
     customerAddress: AddressField;
-    /** List of company registration numbers associated to the customer. */
+    /**
+     * List of company registration numbers associated to the customer.
+     */
     customerCompanyRegistrations: CompanyRegistrationField[];
-    /** The customer account number or identifier from the supplier. */
+    /**
+     * The customer account number or identifier from the supplier.
+     */
     customerId: StringField;
-    /** The name of the customer. */
+    /**
+     * The name of the customer.
+     */
     customerName: StringField;
-    /** The date the purchase was made. */
+    /**
+     * The date the purchase was made.
+     */
     date: DateField;
-    /** The document number or identifier (invoice number or receipt number). */
+    /**
+     * The document number or identifier (invoice number or receipt number).
+     */
     documentNumber: StringField;
     /**
      * 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;
-    /** Document type extended. */
+    /**
+     * Document type extended.
+     */
     documentTypeExtended: ClassificationField;
-    /** The date on which the payment is due. */
+    /**
+     * The date on which the payment is due.
+     */
     dueDate: DateField;
-    /** The invoice number or identifier only if document is an invoice. */
+    /**
+     * The invoice number or identifier only if document is an invoice.
+     */
     invoiceNumber: StringField;
-    /** List of line item present on the document. */
+    /**
+     * List of line item present on the document.
+     */
     lineItems: FinancialDocumentV1LineItem[];
-    /** The locale of the document. */
+    /**
+     * The locale of the document.
+     */
     locale: LocaleField;
-    /** The date on which the payment is due / fullfilled. */
+    /**
+     * The date on which the payment is due / fulfilled.
+     */
     paymentDate: DateField;
-    /** The purchase order number, only if the document is an invoice. */
+    /**
+     * The purchase order number, only if the document is an invoice.
+     */
     poNumber: StringField;
-    /** The receipt number or identifier only if document is a receipt. */
+    /**
+     * The receipt number or identifier only if document is a receipt.
+     */
     receiptNumber: StringField;
-    /** List of Reference numbers, including PO number, only if the document is an invoice. */
+    /**
+     * List of Reference numbers, including PO number, only if the document is an invoice.
+     */
     referenceNumbers: StringField[];
-    /** The customer's address used for shipping. */
+    /**
+     * The customer's address used for shipping.
+     */
     shippingAddress: AddressField;
-    /** The purchase subcategory for transport, food and shooping. */
+    /**
+     * The purchase subcategory for transport, food and shooping.
+     */
     subcategory: ClassificationField;
-    /** The address of the supplier or merchant. */
+    /**
+     * The address of the supplier or merchant.
+     */
     supplierAddress: AddressField;
-    /** List of company registration numbers associated to the supplier. */
+    /**
+     * List of company registration numbers associated to the supplier.
+     */
     supplierCompanyRegistrations: CompanyRegistrationField[];
-    /** The email of the supplier or merchant. */
+    /**
+     * The email of the supplier or merchant.
+     */
     supplierEmail: StringField;
-    /** The name of the supplier or merchant. */
+    /**
+     * The name of the supplier or merchant.
+     */
     supplierName: StringField;
-    /** List of payment details associated to the supplier (only for invoices). */
+    /**
+     * List of payment details associated to the supplier (only for invoices).
+     */
     supplierPaymentDetails: PaymentDetailsField[];
-    /** The phone number of the supplier or merchant. */
+    /**
+     * The phone number of the supplier or merchant.
+     */
     supplierPhoneNumber: StringField;
-    /** The website URL of the supplier or merchant. */
+    /**
+     * The website URL of the supplier or merchant.
+     */
     supplierWebsite: StringField;
-    /** List of all taxes on the document. */
+    /**
+     * List of all taxes on the document.
+     */
     taxes: Taxes;
-    /** The time the purchase was made (only for receipts). */
+    /**
+     * The time the purchase was made (only for receipts).
+     */
     time: StringField;
-    /** The total amount of tip and gratuity */
+    /**
+     * The total amount of tip and gratuity
+     */
     tip: AmountField;
-    /** The total amount paid: includes taxes, tips, fees, and other charges. */
+    /**
+     * The total amount paid: includes taxes, tips, fees, and other charges.
+     */
     totalAmount: AmountField;
-    /** The net amount paid: does not include taxes, fees, and discounts. */
+    /**
+     * The net amount paid: does not include taxes, fees, and discounts.
+     */
     totalNet: AmountField;
-    /** The sum of all taxes present on the document. */
+    /**
+     * The sum of all taxes present on the document.
+     */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/financialDocument/financialDocumentV1Document.js

@@ -1,20 +1,30 @@
-import { cleanOutString, lineSeparator, } from "../../../v1/parsing/common/index.js";
+import { cleanOutString, lineSeparator, } from "../../parsing/common/index.js";
 import { FinancialDocumentV1LineItem } from "./financialDocumentV1LineItem.js";
-import { AddressField, AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes, } from "../../../v1/parsing/standard/index.js";
+import { AddressField, AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes, } from "../../parsing/standard/index.js";
 /**
  * Financial Document API version 1.14 document data.
  */
 export class FinancialDocumentV1Document {
     constructor(rawPrediction, pageId) {
-        /** List of company registration numbers associated to the customer. */
+        /**
+         * List of company registration numbers associated to the customer.
+         */
         this.customerCompanyRegistrations = [];
-        /** List of line item present on the document. */
+        /**
+         * List of line item present on the document.
+         */
         this.lineItems = [];
-        /** List of Reference numbers, including PO number, only if the document is an invoice. */
+        /**
+         * List of Reference numbers, including PO number, only if the document is an invoice.
+         */
         this.referenceNumbers = [];
-        /** List of company registration numbers associated to the supplier. */
+        /**
+         * List of company registration numbers associated to the supplier.
+         */
         this.supplierCompanyRegistrations = [];
-        /** List of payment details associated to the supplier (only for invoices). */
+        /**
+         * List of payment details associated to the supplier (only for invoices).
+         */
         this.supplierPaymentDetails = [];
         this.billingAddress = new AddressField({
             prediction: rawPrediction["billing_address"],

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

@@ -5,25 +5,45 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class FinancialDocumentV1LineItem {
     #private;
-    /** The item description. */
+    /**
+     * The item description.
+     */
     description: string | null;
-    /** The product code referring to the item. */
+    /**
+     * The product code referring to the item.
+     */
     productCode: string | null;
-    /** The item quantity */
+    /**
+     * The item quantity
+     */
     quantity: number | null;
-    /** The item tax amount. */
+    /**
+     * The item tax amount.
+     */
     taxAmount: number | null;
-    /** The item tax rate in percentage. */
+    /**
+     * The item tax rate in percentage.
+     */
     taxRate: number | null;
-    /** The item total amount. */
+    /**
+     * The item total amount.
+     */
     totalAmount: number | null;
-    /** The item unit of measure. */
+    /**
+     * The item unit of measure.
+     */
     unitMeasure: string | null;
-    /** The item unit price. */
+    /**
+     * The item unit price.
+     */
     unitPrice: number | null;
-    /** Confidence score */
+    /**
+     * Confidence score
+     */
     confidence: number;
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId: number;
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/financialDocument/financialDocumentV1LineItem.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _FinancialDocumentV1LineItem_instances, _a, _FinancialDocumentV1LineItem_parseNumber, _FinancialDocumentV1LineItem_printableValues;
-import { cleanAndTruncate, floatToString } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate, floatToString } from "../../parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * List of line item present on the document.
@@ -12,7 +12,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class FinancialDocumentV1LineItem {
     constructor({ prediction = {} }) {
         _FinancialDocumentV1LineItem_instances.add(this);
-        /** Confidence score */
+        /**
+         * Confidence score
+         */
         this.confidence = 0.0;
         /**
          * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1.d.ts

@@ -1,16 +1,24 @@
-import { Inference, StringDict, Page } from "../../../../v1/parsing/common/index.js";
+import { Inference, StringDict, Page } from "../../../parsing/common/index.js";
 import { BankAccountDetailsV1Document } from "./bankAccountDetailsV1Document.js";
 /**
  * Bank Account Details API version 1 inference prediction.
  */
 export declare class BankAccountDetailsV1 extends Inference {
-    /** The endpoint's name. */
+    /**
+     * The endpoint's name.
+     */
     endpointName: string;
-    /** The endpoint's version. */
+    /**
+     * The endpoint's version.
+     */
     endpointVersion: string;
-    /** The document-level prediction. */
+    /**
+     * The document-level prediction.
+     */
     prediction: BankAccountDetailsV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<BankAccountDetailsV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../../parsing/common/index.js";
 import { BankAccountDetailsV1Document } from "./bankAccountDetailsV1Document.js";
 /**
  * Bank Account Details API version 1 inference prediction.
@@ -6,11 +6,17 @@ import { BankAccountDetailsV1Document } from "./bankAccountDetailsV1Document.js"
 export class BankAccountDetailsV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "bank_account_details";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new BankAccountDetailsV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1Document.d.ts

@@ -1,14 +1,20 @@
-import { Prediction, StringDict } from "../../../../v1/parsing/common/index.js";
-import { StringField } from "../../../../v1/parsing/standard/index.js";
+import { Prediction, StringDict } from "../../../parsing/common/index.js";
+import { StringField } from "../../../parsing/standard/index.js";
 /**
  * Bank Account Details API version 1.0 document data.
  */
 export declare class BankAccountDetailsV1Document implements Prediction {
-    /** The name of the account holder as seen on the document. */
+    /**
+     * The name of the account holder as seen on the document.
+     */
     accountHolderName: StringField;
-    /** The International Bank Account Number (IBAN). */
+    /**
+     * The International Bank Account Number (IBAN).
+     */
     iban: StringField;
-    /** The bank's SWIFT Business Identifier Code (BIC). */
+    /**
+     * The bank's SWIFT Business Identifier Code (BIC).
+     */
     swift: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**