mindee 5.9.0 → 5.10.0

package/src/v1/product/internationalId/internationalIdV2Document.d.ts

@@ -4,39 +4,73 @@ import { ClassificationField, DateField, StringField } from "../../parsing/stand
  * International ID API version 2.2 document data.
  */
 export declare class InternationalIdV2Document implements Prediction {
-    /** The physical address of the document holder. */
+    /**
+     * The physical address of the document holder.
+     */
     address: StringField;
-    /** The date of birth of the document holder. */
+    /**
+     * The date of birth of the document holder.
+     */
     birthDate: DateField;
-    /** The place of birth of the document holder. */
+    /**
+     * The place of birth of the document holder.
+     */
     birthPlace: StringField;
-    /** The country where the document was issued. */
+    /**
+     * The country where the document was issued.
+     */
     countryOfIssue: StringField;
-    /** The unique identifier assigned to the document. */
+    /**
+     * The unique identifier assigned to the document.
+     */
     documentNumber: StringField;
-    /** The type of personal identification document. */
+    /**
+     * The type of personal identification document.
+     */
     documentType: ClassificationField;
-    /** The date when the document becomes invalid. */
+    /**
+     * The date when the document becomes invalid.
+     */
     expiryDate: DateField;
-    /** The list of the document holder's given names. */
+    /**
+     * The list of the document holder's given names.
+     */
     givenNames: StringField[];
-    /** The date when the document was issued. */
+    /**
+     * The date when the document was issued.
+     */
     issueDate: DateField;
-    /** The Machine Readable Zone, first line. */
+    /**
+     * The Machine Readable Zone, first line.
+     */
     mrzLine1: StringField;
-    /** The Machine Readable Zone, second line. */
+    /**
+     * The Machine Readable Zone, second line.
+     */
     mrzLine2: StringField;
-    /** The Machine Readable Zone, third line. */
+    /**
+     * The Machine Readable Zone, third line.
+     */
     mrzLine3: StringField;
-    /** The country of citizenship of the document holder. */
+    /**
+     * The country of citizenship of the document holder.
+     */
     nationality: StringField;
-    /** The unique identifier assigned to the document holder. */
+    /**
+     * The unique identifier assigned to the document holder.
+     */
     personalNumber: StringField;
-    /** The biological sex of the document holder. */
+    /**
+     * The biological sex of the document holder.
+     */
     sex: StringField;
-    /** The state or territory where the document was issued. */
+    /**
+     * The state or territory where the document was issued.
+     */
     stateOfIssue: StringField;
-    /** The list of the document holder's family names. */
+    /**
+     * The list of the document holder's family names.
+     */
     surnames: StringField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/internationalId/internationalIdV2Document.js

@@ -5,9 +5,13 @@ import { ClassificationField, DateField, StringField, } from "../../parsing/stan
  */
 export class InternationalIdV2Document {
     constructor(rawPrediction, pageId) {
-        /** The list of the document holder's given names. */
+        /**
+         * The list of the document holder's given names.
+         */
         this.givenNames = [];
-        /** The list of the document holder's family names. */
+        /**
+         * The list of the document holder's family names.
+         */
         this.surnames = [];
         this.address = new StringField({
             prediction: rawPrediction["address"],

package/src/v1/product/invoice/invoiceV4.d.ts

@@ -4,13 +4,21 @@ import { InvoiceV4Document } from "./invoiceV4Document.js";
  * Invoice API version 4 inference prediction.
  */
 export declare class InvoiceV4 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: InvoiceV4Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<InvoiceV4Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/invoice/invoiceV4.js

@@ -6,11 +6,17 @@ import { InvoiceV4Document } from "./invoiceV4Document.js";
 export class InvoiceV4 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "invoices";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "4";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new InvoiceV4Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

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

@@ -5,63 +5,121 @@ import { AddressField, AmountField, ClassificationField, CompanyRegistrationFiel
  * Invoice API version 4.11 document data.
  */
 export declare class InvoiceV4Document implements Prediction {
-    /** The customer billing address. */
+    /**
+     * The customer billing address.
+     */
     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 or client. */
+    /**
+     * The name of the customer or client.
+     */
     customerName: StringField;
-    /** The date the purchase was made. */
+    /**
+     * The date the purchase was made.
+     */
     date: DateField;
-    /** Document type: INVOICE or CREDIT NOTE. */
+    /**
+     * Document type: INVOICE or CREDIT NOTE.
+     */
     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. */
+    /**
+     * The invoice number or identifier.
+     */
     invoiceNumber: StringField;
-    /** List of all the line items present on the invoice. */
+    /**
+     * List of all the line items present on the invoice.
+     */
     lineItems: InvoiceV4LineItem[];
-    /** The locale of 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 fulfilled.
+     */
     paymentDate: DateField;
-    /** The purchase order number. */
+    /**
+     * The purchase order number.
+     */
     poNumber: StringField;
-    /** List of all reference numbers on the invoice, including the purchase order number. */
+    /**
+     * List of all reference numbers on the invoice, including the purchase order number.
+     */
     referenceNumbers: StringField[];
-    /** Customer's delivery address. */
+    /**
+     * Customer's delivery address.
+     */
     shippingAddress: AddressField;
-    /** The purchase subcategory for transport, food and shopping. */
+    /**
+     * The purchase subcategory for transport, food and shopping.
+     */
     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 address of the supplier or merchant. */
+    /**
+     * The email address 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 of the invoice. */
+    /**
+     * List of payment details associated to the supplier of the invoice.
+     */
     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 taxes. Each item contains the detail of the tax. */
+    /**
+     * List of taxes. Each item contains the detail of the tax.
+     */
     taxes: Taxes;
-    /** The total amount of the invoice: 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 of the invoice: 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: the sum of all the taxes for this invoice. */
+    /**
+     * The total tax: the sum of all the taxes for this invoice.
+     */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/invoice/invoiceV4Document.js

@@ -6,15 +6,25 @@ import { AddressField, AmountField, ClassificationField, CompanyRegistrationFiel
  */
 export class InvoiceV4Document {
     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 all the line items present on the invoice. */
+        /**
+         * List of all the line items present on the invoice.
+         */
         this.lineItems = [];
-        /** List of all reference numbers on the invoice, including the purchase order number. */
+        /**
+         * List of all reference numbers on the invoice, including the purchase order number.
+         */
         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 of the invoice. */
+        /**
+         * List of payment details associated to the supplier of the invoice.
+         */
         this.supplierPaymentDetails = [];
         this.billingAddress = new AddressField({
             prediction: rawPrediction["billing_address"],

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

@@ -5,25 +5,45 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class InvoiceV4LineItem {
     #private;
-    /** The item description. */
+    /**
+     * The item description.
+     */
     description: string | null;
-    /** The product code of the item. */
+    /**
+     * The product code of 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/invoice/invoiceV4LineItem.js

@@ -13,7 +13,9 @@ export class InvoiceV4LineItem {
     // eslint-disable-next-line sonarjs/cognitive-complexity
     constructor({ prediction = {} }) {
         _InvoiceV4LineItem_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/invoiceSplitter/invoiceSplitterV1.d.ts

@@ -4,13 +4,21 @@ import { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document.js";
  * Invoice Splitter API version 1 inference prediction.
  */
 export declare class InvoiceSplitterV1 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: InvoiceSplitterV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<InvoiceSplitterV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/invoiceSplitter/invoiceSplitterV1.js

@@ -6,11 +6,17 @@ import { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document.js";
 export class InvoiceSplitterV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "invoice_splitter";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new InvoiceSplitterV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/invoiceSplitter/invoiceSplitterV1Document.d.ts

@@ -4,7 +4,9 @@ import { InvoiceSplitterV1InvoicePageGroup } from "./invoiceSplitterV1InvoicePag
  * Invoice Splitter API version 1.4 document data.
  */
 export declare class InvoiceSplitterV1Document implements Prediction {
-    /** List of page groups. Each group represents a single invoice within a multi-invoice document. */
+    /**
+     * List of page groups. Each group represents a single invoice within a multi-invoice document.
+     */
     invoicePageGroups: InvoiceSplitterV1InvoicePageGroup[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/invoiceSplitter/invoiceSplitterV1Document.js

@@ -5,7 +5,9 @@ import { InvoiceSplitterV1InvoicePageGroup } from "./invoiceSplitterV1InvoicePag
  */
 export class InvoiceSplitterV1Document {
     constructor(rawPrediction, pageId) {
-        /** List of page groups. Each group represents a single invoice within a multi-invoice document. */
+        /**
+         * List of page groups. Each group represents a single invoice within a multi-invoice document.
+         */
         this.invoicePageGroups = [];
         if (rawPrediction["invoice_page_groups"]) {
             rawPrediction["invoice_page_groups"].map((itemPrediction) => this.invoicePageGroups.push(new InvoiceSplitterV1InvoicePageGroup({

package/src/v1/product/invoiceSplitter/invoiceSplitterV1InvoicePageGroup.d.ts

@@ -5,11 +5,17 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class InvoiceSplitterV1InvoicePageGroup {
     #private;
-    /** List of page indexes that belong to the same invoice (group). */
+    /**
+     * List of page indexes that belong to the same invoice (group).
+     */
     pageIndexes: Array<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/invoiceSplitter/invoiceSplitterV1InvoicePageGroup.js

@@ -11,7 +11,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class InvoiceSplitterV1InvoicePageGroup {
     constructor({ prediction = {} }) {
         _InvoiceSplitterV1InvoicePageGroup_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/multiReceiptsDetector/multiReceiptsDetectorV1.d.ts

@@ -4,13 +4,21 @@ import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Docume
  * Multi Receipts Detector API version 1 inference prediction.
  */
 export declare class MultiReceiptsDetectorV1 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: MultiReceiptsDetectorV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<MultiReceiptsDetectorV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1.js

@@ -6,11 +6,17 @@ import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Docume
 export class MultiReceiptsDetectorV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "multi_receipts_detector";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new MultiReceiptsDetectorV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

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

@@ -4,7 +4,9 @@ import { PositionField } from "../../parsing/standard/index.js";
  * Multi Receipts Detector API version 1.1 document data.
  */
 export declare class MultiReceiptsDetectorV1Document implements Prediction {
-    /** Positions of the receipts on the document. */
+    /**
+     * Positions of the receipts on the document.
+     */
     receipts: PositionField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.js

@@ -5,7 +5,9 @@ import { PositionField } from "../../parsing/standard/index.js";
  */
 export class MultiReceiptsDetectorV1Document {
     constructor(rawPrediction, pageId) {
-        /** Positions of the receipts on the document. */
+        /**
+         * Positions of the receipts on the document.
+         */
         this.receipts = [];
         if (rawPrediction["receipts"]) {
             rawPrediction["receipts"].map((itemPrediction) => this.receipts.push(new PositionField({

package/src/v1/product/passport/passportV1.d.ts

@@ -4,13 +4,21 @@ import { PassportV1Document } from "./passportV1Document.js";
  * Passport API version 1 inference prediction.
  */
 export declare class PassportV1 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: PassportV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<PassportV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/passport/passportV1.js

@@ -6,11 +6,17 @@ import { PassportV1Document } from "./passportV1Document.js";
 export class PassportV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "passport";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new PassportV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {