mindee 4.3.2 → 4.4.0

package/src/product/fr/carteGrise/carteGriseV1Document.d.ts

@@ -0,0 +1,94 @@
+import { Prediction, StringDict } from "../../../parsing/common";
+import { DateField, StringField } from "../../../parsing/standard";
+/**
+ * Document data for Carte Grise, API version 1.
+ */
+export declare class CarteGriseV1Document implements Prediction {
+    /** The vehicle's license plate number. */
+    a: StringField;
+    /** The vehicle's first release date. */
+    b: DateField;
+    /** The vehicle owner's full name including maiden name. */
+    c1: StringField;
+    /** The vehicle owner's address. */
+    c3: StringField;
+    /** Number of owners of the license certificate. */
+    c41: StringField;
+    /** Mentions about the ownership of the vehicle. */
+    c4A: StringField;
+    /** The vehicle's brand. */
+    d1: StringField;
+    /** The vehicle's commercial name. */
+    d3: StringField;
+    /** The Vehicle Identification Number (VIN). */
+    e: StringField;
+    /** The vehicle's maximum admissible weight. */
+    f1: StringField;
+    /** The vehicle's maximum admissible weight within the license's state. */
+    f2: StringField;
+    /** The vehicle's maximum authorized weight with coupling. */
+    f3: StringField;
+    /** The document's formula number. */
+    formulaNumber: StringField;
+    /** The vehicle's weight with coupling if tractor different than category M1. */
+    g: StringField;
+    /** The vehicle's national empty weight. */
+    g1: StringField;
+    /** The car registration date of the given certificate. */
+    i: DateField;
+    /** The vehicle's category. */
+    j: StringField;
+    /** The vehicle's national type. */
+    j1: StringField;
+    /** The vehicle's body type (CE). */
+    j2: StringField;
+    /** The vehicle's body type (National designation). */
+    j3: StringField;
+    /** Machine Readable Zone, first line. */
+    mrz1: StringField;
+    /** Machine Readable Zone, second line. */
+    mrz2: StringField;
+    /** The vehicle's owner first name. */
+    ownerFirstName: StringField;
+    /** The vehicle's owner surname. */
+    ownerSurname: StringField;
+    /** The vehicle engine's displacement (cm3). */
+    p1: StringField;
+    /** The vehicle's maximum net power (kW). */
+    p2: StringField;
+    /** The vehicle's fuel type or energy source. */
+    p3: StringField;
+    /** The vehicle's administrative power (fiscal horsepower). */
+    p6: StringField;
+    /** The vehicle's power to weight ratio. */
+    q: StringField;
+    /** The vehicle's number of seats. */
+    s1: StringField;
+    /** The vehicle's number of standing rooms (person). */
+    s2: StringField;
+    /** The vehicle's sound level (dB). */
+    u1: StringField;
+    /** The vehicle engine's rotation speed (RPM). */
+    u2: StringField;
+    /** The vehicle's CO2 emission (g/km). */
+    v7: StringField;
+    /** Next technical control date. */
+    x1: StringField;
+    /** Amount of the regional proportional tax of the registration (in euros). */
+    y1: StringField;
+    /** Amount of the additional parafiscal tax of the registration (in euros). */
+    y2: StringField;
+    /** Amount of the additional CO2 tax of the registration (in euros). */
+    y3: StringField;
+    /** Amount of the fee for managing the registration (in euros). */
+    y4: StringField;
+    /** Amount of the fee for delivery of the registration certificate in euros. */
+    y5: StringField;
+    /** Total amount of registration fee to be paid in euros. */
+    y6: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/fr/carteGrise/carteGriseV1Document.js

@@ -0,0 +1,224 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarteGriseV1Document = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+/**
+ * Document data for Carte Grise, API version 1.
+ */
+class CarteGriseV1Document {
+    constructor(rawPrediction, pageId) {
+        this.a = new standard_1.StringField({
+            prediction: rawPrediction["a"],
+            pageId: pageId,
+        });
+        this.b = new standard_1.DateField({
+            prediction: rawPrediction["b"],
+            pageId: pageId,
+        });
+        this.c1 = new standard_1.StringField({
+            prediction: rawPrediction["c1"],
+            pageId: pageId,
+        });
+        this.c3 = new standard_1.StringField({
+            prediction: rawPrediction["c3"],
+            pageId: pageId,
+        });
+        this.c41 = new standard_1.StringField({
+            prediction: rawPrediction["c41"],
+            pageId: pageId,
+        });
+        this.c4A = new standard_1.StringField({
+            prediction: rawPrediction["c4a"],
+            pageId: pageId,
+        });
+        this.d1 = new standard_1.StringField({
+            prediction: rawPrediction["d1"],
+            pageId: pageId,
+        });
+        this.d3 = new standard_1.StringField({
+            prediction: rawPrediction["d3"],
+            pageId: pageId,
+        });
+        this.e = new standard_1.StringField({
+            prediction: rawPrediction["e"],
+            pageId: pageId,
+        });
+        this.f1 = new standard_1.StringField({
+            prediction: rawPrediction["f1"],
+            pageId: pageId,
+        });
+        this.f2 = new standard_1.StringField({
+            prediction: rawPrediction["f2"],
+            pageId: pageId,
+        });
+        this.f3 = new standard_1.StringField({
+            prediction: rawPrediction["f3"],
+            pageId: pageId,
+        });
+        this.formulaNumber = new standard_1.StringField({
+            prediction: rawPrediction["formula_number"],
+            pageId: pageId,
+        });
+        this.g = new standard_1.StringField({
+            prediction: rawPrediction["g"],
+            pageId: pageId,
+        });
+        this.g1 = new standard_1.StringField({
+            prediction: rawPrediction["g1"],
+            pageId: pageId,
+        });
+        this.i = new standard_1.DateField({
+            prediction: rawPrediction["i"],
+            pageId: pageId,
+        });
+        this.j = new standard_1.StringField({
+            prediction: rawPrediction["j"],
+            pageId: pageId,
+        });
+        this.j1 = new standard_1.StringField({
+            prediction: rawPrediction["j1"],
+            pageId: pageId,
+        });
+        this.j2 = new standard_1.StringField({
+            prediction: rawPrediction["j2"],
+            pageId: pageId,
+        });
+        this.j3 = new standard_1.StringField({
+            prediction: rawPrediction["j3"],
+            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.ownerFirstName = new standard_1.StringField({
+            prediction: rawPrediction["owner_first_name"],
+            pageId: pageId,
+        });
+        this.ownerSurname = new standard_1.StringField({
+            prediction: rawPrediction["owner_surname"],
+            pageId: pageId,
+        });
+        this.p1 = new standard_1.StringField({
+            prediction: rawPrediction["p1"],
+            pageId: pageId,
+        });
+        this.p2 = new standard_1.StringField({
+            prediction: rawPrediction["p2"],
+            pageId: pageId,
+        });
+        this.p3 = new standard_1.StringField({
+            prediction: rawPrediction["p3"],
+            pageId: pageId,
+        });
+        this.p6 = new standard_1.StringField({
+            prediction: rawPrediction["p6"],
+            pageId: pageId,
+        });
+        this.q = new standard_1.StringField({
+            prediction: rawPrediction["q"],
+            pageId: pageId,
+        });
+        this.s1 = new standard_1.StringField({
+            prediction: rawPrediction["s1"],
+            pageId: pageId,
+        });
+        this.s2 = new standard_1.StringField({
+            prediction: rawPrediction["s2"],
+            pageId: pageId,
+        });
+        this.u1 = new standard_1.StringField({
+            prediction: rawPrediction["u1"],
+            pageId: pageId,
+        });
+        this.u2 = new standard_1.StringField({
+            prediction: rawPrediction["u2"],
+            pageId: pageId,
+        });
+        this.v7 = new standard_1.StringField({
+            prediction: rawPrediction["v7"],
+            pageId: pageId,
+        });
+        this.x1 = new standard_1.StringField({
+            prediction: rawPrediction["x1"],
+            pageId: pageId,
+        });
+        this.y1 = new standard_1.StringField({
+            prediction: rawPrediction["y1"],
+            pageId: pageId,
+        });
+        this.y2 = new standard_1.StringField({
+            prediction: rawPrediction["y2"],
+            pageId: pageId,
+        });
+        this.y3 = new standard_1.StringField({
+            prediction: rawPrediction["y3"],
+            pageId: pageId,
+        });
+        this.y4 = new standard_1.StringField({
+            prediction: rawPrediction["y4"],
+            pageId: pageId,
+        });
+        this.y5 = new standard_1.StringField({
+            prediction: rawPrediction["y5"],
+            pageId: pageId,
+        });
+        this.y6 = new standard_1.StringField({
+            prediction: rawPrediction["y6"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const outStr = `:a: ${this.a}
+:b: ${this.b}
+:c1: ${this.c1}
+:c3: ${this.c3}
+:c41: ${this.c41}
+:c4a: ${this.c4A}
+:d1: ${this.d1}
+:d3: ${this.d3}
+:e: ${this.e}
+:f1: ${this.f1}
+:f2: ${this.f2}
+:f3: ${this.f3}
+:g: ${this.g}
+:g1: ${this.g1}
+:i: ${this.i}
+:j: ${this.j}
+:j1: ${this.j1}
+:j2: ${this.j2}
+:j3: ${this.j3}
+:p1: ${this.p1}
+:p2: ${this.p2}
+:p3: ${this.p3}
+:p6: ${this.p6}
+:q: ${this.q}
+:s1: ${this.s1}
+:s2: ${this.s2}
+:u1: ${this.u1}
+:u2: ${this.u2}
+:v7: ${this.v7}
+:x1: ${this.x1}
+:y1: ${this.y1}
+:y2: ${this.y2}
+:y3: ${this.y3}
+:y4: ${this.y4}
+:y5: ${this.y5}
+:y6: ${this.y6}
+:Formula Number: ${this.formulaNumber}
+:Owner's First Name: ${this.ownerFirstName}
+:Owner's Surname: ${this.ownerSurname}
+:MRZ Line 1: ${this.mrz1}
+:MRZ Line 2: ${this.mrz2}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.CarteGriseV1Document = CarteGriseV1Document;

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

@@ -0,0 +1,2 @@
+export { CarteGriseV1 } from "./carteGriseV1";
+export { CarteGriseV1Document } from "./carteGriseV1Document";

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarteGriseV1Document = exports.CarteGriseV1 = void 0;
+var carteGriseV1_1 = require("./carteGriseV1");
+Object.defineProperty(exports, "CarteGriseV1", { enumerable: true, get: function () { return carteGriseV1_1.CarteGriseV1; } });
+var carteGriseV1Document_1 = require("./carteGriseV1Document");
+Object.defineProperty(exports, "CarteGriseV1Document", { enumerable: true, get: function () { return carteGriseV1Document_1.CarteGriseV1Document; } });

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

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

package/src/product/fr/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CarteVitaleV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = exports.IdCardV2 = exports.IdCardV1 = void 0;
+exports.CarteVitaleV1 = exports.BankAccountDetailsV2 = exports.BankAccountDetailsV1 = exports.CarteGriseV1 = 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 carteGriseV1_1 = require("./carteGrise/carteGriseV1");
+Object.defineProperty(exports, "CarteGriseV1", { enumerable: true, get: function () { return carteGriseV1_1.CarteGriseV1; } });
 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/fr/internal.d.ts

@@ -1,3 +1,4 @@
 export * as bankAccountDetails from "./bankAccountDetails/internal";
 export * as carteVitale from "./carteVitale/internal";
 export * as idCard from "./idCard/internal";
+export * as carteGrise from "./carteGrise/internal";

package/src/product/fr/internal.js

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

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

@@ -1,46 +1,47 @@
 import { Prediction, StringDict } from "../../parsing/common";
-import { ClassificationField, Taxes, PaymentDetailsField, LocaleField, AmountField, StringField, DateField, CompanyRegistrationField } from "../../parsing/standard";
 import { InvoiceV4LineItem } from "./invoiceV4LineItem";
+import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
  * Document data for Invoice, API version 4.
  */
 export declare class InvoiceV4Document implements Prediction {
-    /** LocaleField information. */
-    locale: LocaleField;
-    /** The nature of the invoice. */
-    documentType: ClassificationField;
-    /** List of Reference numbers including PO number. */
-    referenceNumbers: StringField[];
-    /** The total amount with tax included. */
-    totalAmount: AmountField;
-    /** The creation date of the invoice. */
+    /** The address of the customer. */
+    customerAddress: StringField;
+    /** List of company registrations associated to the customer. */
+    customerCompanyRegistrations: CompanyRegistrationField[];
+    /** The name of the customer or client. */
+    customerName: StringField;
+    /** The date the purchase was made. */
     date: DateField;
-    /** The due date of the invoice. */
+    /** One of: 'INVOICE', 'CREDIT NOTE'. */
+    documentType: ClassificationField;
+    /** The date on which the payment is due. */
     dueDate: DateField;
-    /** The total tax. */
-    totalTax: AmountField;
-    /** The total amount without the tax value. */
-    totalNet: AmountField;
-    /** The supplier name. */
-    supplierName: StringField;
-    /** The supplier address. */
+    /** The invoice number or identifier. */
+    invoiceNumber: StringField;
+    /** List of line item details. */
+    lineItems: InvoiceV4LineItem[];
+    /** The locale detected on the document. */
+    locale: LocaleField;
+    /** List of Reference numbers, including PO number. */
+    referenceNumbers: StringField[];
+    /** The address of the supplier or merchant. */
     supplierAddress: StringField;
-    /** The payment information. */
-    supplierPaymentDetails: PaymentDetailsField[];
-    /** The supplier company registration information. */
+    /** List of company registrations associated to the supplier. */
     supplierCompanyRegistrations: CompanyRegistrationField[];
-    /** The invoice number. */
-    invoiceNumber: StringField;
-    /** The name of the customer. */
-    customerName: StringField;
-    /** The address of the customer. */
-    customerAddress: StringField;
-    /** The company registration information for the customer. */
-    customerCompanyRegistrations: CompanyRegistrationField[];
-    /** The list of the taxes. */
+    /** The name of the supplier or merchant. */
+    supplierName: StringField;
+    /** List of payment details associated to the supplier. */
+    supplierPaymentDetails: PaymentDetailsField[];
+    /** List of tax line details. */
     taxes: Taxes;
-    /** Line items details. */
-    lineItems: InvoiceV4LineItem[];
+    /** The total amount paid: includes taxes, tips, fees, and other charges. */
+    totalAmount: AmountField;
+    /** The net amount paid: does not include taxes, fees, and discounts. */
+    totalNet: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }