mindee 4.10.0 → 4.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/package.json +1 -1
  3. package/src/product/barcodeReader/barcodeReaderV1.d.ts +1 -1
  4. package/src/product/barcodeReader/barcodeReaderV1.js +1 -1
  5. package/src/product/barcodeReader/barcodeReaderV1Document.d.ts +1 -1
  6. package/src/product/barcodeReader/barcodeReaderV1Document.js +1 -1
  7. package/src/product/cropper/cropperV1.d.ts +1 -1
  8. package/src/product/cropper/cropperV1.js +1 -1
  9. package/src/product/cropper/cropperV1Document.d.ts +1 -1
  10. package/src/product/cropper/cropperV1Document.js +1 -1
  11. package/src/product/cropper/cropperV1Page.d.ts +1 -1
  12. package/src/product/cropper/cropperV1Page.js +1 -1
  13. package/src/product/eu/driverLicense/driverLicenseV1.d.ts +1 -1
  14. package/src/product/eu/driverLicense/driverLicenseV1.js +1 -1
  15. package/src/product/eu/driverLicense/driverLicenseV1Document.d.ts +1 -1
  16. package/src/product/eu/driverLicense/driverLicenseV1Document.js +1 -1
  17. package/src/product/eu/driverLicense/driverLicenseV1Page.d.ts +1 -1
  18. package/src/product/eu/driverLicense/driverLicenseV1Page.js +1 -1
  19. package/src/product/eu/licensePlate/licensePlateV1.d.ts +1 -1
  20. package/src/product/eu/licensePlate/licensePlateV1.js +1 -1
  21. package/src/product/eu/licensePlate/licensePlateV1Document.d.ts +1 -1
  22. package/src/product/eu/licensePlate/licensePlateV1Document.js +1 -1
  23. package/src/product/financialDocument/financialDocumentV1.d.ts +1 -1
  24. package/src/product/financialDocument/financialDocumentV1.js +1 -1
  25. package/src/product/financialDocument/financialDocumentV1Document.d.ts +16 -2
  26. package/src/product/financialDocument/financialDocumentV1Document.js +36 -1
  27. package/src/product/fr/bankAccountDetails/bankAccountDetailsV1.d.ts +1 -1
  28. package/src/product/fr/bankAccountDetails/bankAccountDetailsV1.js +1 -1
  29. package/src/product/fr/bankAccountDetails/bankAccountDetailsV1Document.d.ts +1 -1
  30. package/src/product/fr/bankAccountDetails/bankAccountDetailsV1Document.js +1 -1
  31. package/src/product/fr/bankAccountDetails/bankAccountDetailsV2.d.ts +1 -1
  32. package/src/product/fr/bankAccountDetails/bankAccountDetailsV2.js +1 -1
  33. package/src/product/fr/bankAccountDetails/bankAccountDetailsV2Document.d.ts +1 -1
  34. package/src/product/fr/bankAccountDetails/bankAccountDetailsV2Document.js +1 -1
  35. package/src/product/fr/carteGrise/carteGriseV1.d.ts +1 -1
  36. package/src/product/fr/carteGrise/carteGriseV1.js +1 -1
  37. package/src/product/fr/carteGrise/carteGriseV1Document.d.ts +1 -1
  38. package/src/product/fr/carteGrise/carteGriseV1Document.js +1 -1
  39. package/src/product/fr/carteVitale/carteVitaleV1.d.ts +1 -1
  40. package/src/product/fr/carteVitale/carteVitaleV1.js +1 -1
  41. package/src/product/fr/carteVitale/carteVitaleV1Document.d.ts +1 -1
  42. package/src/product/fr/carteVitale/carteVitaleV1Document.js +1 -1
  43. package/src/product/fr/idCard/idCardV1.d.ts +1 -1
  44. package/src/product/fr/idCard/idCardV1.js +1 -1
  45. package/src/product/fr/idCard/idCardV1Document.d.ts +1 -1
  46. package/src/product/fr/idCard/idCardV1Document.js +1 -1
  47. package/src/product/fr/idCard/idCardV1Page.d.ts +1 -1
  48. package/src/product/fr/idCard/idCardV1Page.js +1 -1
  49. package/src/product/fr/idCard/idCardV2.d.ts +1 -1
  50. package/src/product/fr/idCard/idCardV2.js +1 -1
  51. package/src/product/fr/idCard/idCardV2Document.d.ts +1 -1
  52. package/src/product/fr/idCard/idCardV2Document.js +1 -1
  53. package/src/product/fr/idCard/idCardV2Page.d.ts +1 -1
  54. package/src/product/fr/idCard/idCardV2Page.js +1 -1
  55. package/src/product/internationalId/internationalIdV2.d.ts +1 -1
  56. package/src/product/internationalId/internationalIdV2.js +1 -1
  57. package/src/product/internationalId/internationalIdV2Document.d.ts +1 -1
  58. package/src/product/internationalId/internationalIdV2Document.js +1 -1
  59. package/src/product/invoice/invoiceV4.d.ts +1 -1
  60. package/src/product/invoice/invoiceV4.js +1 -1
  61. package/src/product/invoice/invoiceV4Document.d.ts +9 -1
  62. package/src/product/invoice/invoiceV4Document.js +21 -1
  63. package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1.d.ts +1 -1
  64. package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1.js +1 -1
  65. package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.d.ts +1 -1
  66. package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.js +1 -1
  67. package/src/product/passport/passportV1.d.ts +1 -1
  68. package/src/product/passport/passportV1.js +1 -1
  69. package/src/product/passport/passportV1Document.d.ts +1 -1
  70. package/src/product/passport/passportV1Document.js +1 -1
  71. package/src/product/proofOfAddress/proofOfAddressV1.d.ts +1 -1
  72. package/src/product/proofOfAddress/proofOfAddressV1.js +1 -1
  73. package/src/product/proofOfAddress/proofOfAddressV1Document.d.ts +1 -1
  74. package/src/product/proofOfAddress/proofOfAddressV1Document.js +1 -1
  75. package/src/product/receipt/receiptV5.d.ts +1 -1
  76. package/src/product/receipt/receiptV5.js +1 -1
  77. package/src/product/receipt/receiptV5Document.d.ts +3 -1
  78. package/src/product/receipt/receiptV5Document.js +6 -1
  79. package/src/product/resume/resumeV1.d.ts +1 -1
  80. package/src/product/resume/resumeV1.js +1 -1
  81. package/src/product/resume/resumeV1Document.d.ts +1 -1
  82. package/src/product/resume/resumeV1Document.js +1 -1
  83. package/src/product/us/bankCheck/bankCheckV1.d.ts +1 -1
  84. package/src/product/us/bankCheck/bankCheckV1.js +1 -1
  85. package/src/product/us/bankCheck/bankCheckV1Document.d.ts +1 -1
  86. package/src/product/us/bankCheck/bankCheckV1Document.js +1 -1
  87. package/src/product/us/bankCheck/bankCheckV1Page.d.ts +1 -1
  88. package/src/product/us/bankCheck/bankCheckV1Page.js +1 -1
  89. package/src/product/us/driverLicense/driverLicenseV1.d.ts +1 -1
  90. package/src/product/us/driverLicense/driverLicenseV1.js +1 -1
  91. package/src/product/us/driverLicense/driverLicenseV1Document.d.ts +1 -1
  92. package/src/product/us/driverLicense/driverLicenseV1Document.js +1 -1
  93. package/src/product/us/driverLicense/driverLicenseV1Page.d.ts +1 -1
  94. package/src/product/us/driverLicense/driverLicenseV1Page.js +1 -1
  95. package/src/product/us/w9/w9V1.d.ts +1 -1
  96. package/src/product/us/w9/w9V1.js +1 -1
  97. package/src/product/us/w9/w9V1Document.d.ts +1 -1
  98. package/src/product/us/w9/w9V1Document.js +1 -1
  99. package/src/product/us/w9/w9V1Page.d.ts +1 -1
  100. package/src/product/us/w9/w9V1Page.js +1 -1
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const standard_1 = require("../../../parsing/standard");
6
6
  const idCardV1Document_1 = require("./idCardV1Document");
7
7
  /**
8
- * Page data for Carte Nationale d'Identité, API version 1.
8
+ * Carte Nationale d'Identité API version 1.1 page data.
9
9
  */
10
10
  class IdCardV1Page extends idCardV1Document_1.IdCardV1Document {
11
11
  constructor(rawPrediction, pageId) {
@@ -2,7 +2,7 @@ import { Inference, StringDict, Page } from "../../../parsing/common";
2
2
  import { IdCardV2Document } from "./idCardV2Document";
3
3
  import { IdCardV2Page } from "./idCardV2Page";
4
4
  /**
5
- * Inference prediction for Carte Nationale d'Identité, API version 2.
5
+ * Carte Nationale d'Identité API version 2 inference prediction.
6
6
  */
7
7
  export declare class IdCardV2 extends Inference {
8
8
  /** The endpoint's name. */
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const idCardV2Document_1 = require("./idCardV2Document");
6
6
  const idCardV2Page_1 = require("./idCardV2Page");
7
7
  /**
8
- * Inference prediction for Carte Nationale d'Identité, API version 2.
8
+ * Carte Nationale d'Identité API version 2 inference prediction.
9
9
  */
10
10
  class IdCardV2 extends common_1.Inference {
11
11
  constructor(rawPrediction) {
@@ -1,7 +1,7 @@
1
1
  import { Prediction, StringDict } from "../../../parsing/common";
2
2
  import { DateField, StringField } from "../../../parsing/standard";
3
3
  /**
4
- * Document data for Carte Nationale d'Identité, API version 2.
4
+ * Carte Nationale d'Identité API version 2.0 document data.
5
5
  */
6
6
  export declare class IdCardV2Document implements Prediction {
7
7
  /** The alternate name of the card holder. */
@@ -4,7 +4,7 @@ exports.IdCardV2Document = void 0;
4
4
  const common_1 = require("../../../parsing/common");
5
5
  const standard_1 = require("../../../parsing/standard");
6
6
  /**
7
- * Document data for Carte Nationale d'Identité, API version 2.
7
+ * Carte Nationale d'Identité API version 2.0 document data.
8
8
  */
9
9
  class IdCardV2Document {
10
10
  constructor(rawPrediction, pageId) {
@@ -2,7 +2,7 @@ import { StringDict } from "../../../parsing/common";
2
2
  import { ClassificationField } from "../../../parsing/standard";
3
3
  import { IdCardV2Document } from "./idCardV2Document";
4
4
  /**
5
- * Page data for Carte Nationale d'Identité, API version 2.
5
+ * Carte Nationale d'Identité API version 2.0 page data.
6
6
  */
7
7
  export declare class IdCardV2Page extends IdCardV2Document {
8
8
  /** The sides of the document which are visible. */
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const standard_1 = require("../../../parsing/standard");
6
6
  const idCardV2Document_1 = require("./idCardV2Document");
7
7
  /**
8
- * Page data for Carte Nationale d'Identité, API version 2.
8
+ * Carte Nationale d'Identité API version 2.0 page data.
9
9
  */
10
10
  class IdCardV2Page extends idCardV2Document_1.IdCardV2Document {
11
11
  constructor(rawPrediction, pageId) {
@@ -1,7 +1,7 @@
1
1
  import { Inference, StringDict, Page } from "../../parsing/common";
2
2
  import { InternationalIdV2Document } from "./internationalIdV2Document";
3
3
  /**
4
- * Inference prediction for International ID, API version 2.
4
+ * International ID API version 2 inference prediction.
5
5
  */
6
6
  export declare class InternationalIdV2 extends Inference {
7
7
  /** The endpoint's name. */
@@ -4,7 +4,7 @@ exports.InternationalIdV2 = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const internationalIdV2Document_1 = require("./internationalIdV2Document");
6
6
  /**
7
- * Inference prediction for International ID, API version 2.
7
+ * International ID API version 2 inference prediction.
8
8
  */
9
9
  class InternationalIdV2 extends common_1.Inference {
10
10
  constructor(rawPrediction) {
@@ -1,7 +1,7 @@
1
1
  import { Prediction, StringDict } from "../../parsing/common";
2
2
  import { ClassificationField, DateField, StringField } from "../../parsing/standard";
3
3
  /**
4
- * Document data for International ID, API version 2.
4
+ * International ID API version 2.0 document data.
5
5
  */
6
6
  export declare class InternationalIdV2Document implements Prediction {
7
7
  /** The physical address of the document holder. */
@@ -4,7 +4,7 @@ exports.InternationalIdV2Document = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const standard_1 = require("../../parsing/standard");
6
6
  /**
7
- * Document data for International ID, API version 2.
7
+ * International ID API version 2.0 document data.
8
8
  */
9
9
  class InternationalIdV2Document {
10
10
  constructor(rawPrediction, pageId) {
@@ -1,7 +1,7 @@
1
1
  import { Inference, StringDict, Page } from "../../parsing/common";
2
2
  import { InvoiceV4Document } from "./invoiceV4Document";
3
3
  /**
4
- * Inference prediction for Invoice, API version 4.
4
+ * Invoice API version 4 inference prediction.
5
5
  */
6
6
  export declare class InvoiceV4 extends Inference {
7
7
  /** The endpoint's name. */
@@ -4,7 +4,7 @@ exports.InvoiceV4 = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const invoiceV4Document_1 = require("./invoiceV4Document");
6
6
  /**
7
- * Inference prediction for Invoice, API version 4.
7
+ * Invoice API version 4 inference prediction.
8
8
  */
9
9
  class InvoiceV4 extends common_1.Inference {
10
10
  constructor(rawPrediction) {
@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
2
2
  import { InvoiceV4LineItem } from "./invoiceV4LineItem";
3
3
  import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
4
4
  /**
5
- * Document data for Invoice, API version 4.
5
+ * Invoice API version 4.6 document data.
6
6
  */
7
7
  export declare class InvoiceV4Document implements Prediction {
8
8
  /** The customer's address used for billing. */
@@ -11,6 +11,8 @@ export declare class InvoiceV4Document implements Prediction {
11
11
  customerAddress: StringField;
12
12
  /** List of company registrations associated to the customer. */
13
13
  customerCompanyRegistrations: CompanyRegistrationField[];
14
+ /** The customer account number or identifier from the supplier. */
15
+ customerId: StringField;
14
16
  /** The name of the customer or client. */
15
17
  customerName: StringField;
16
18
  /** The date the purchase was made. */
@@ -33,10 +35,16 @@ export declare class InvoiceV4Document implements Prediction {
33
35
  supplierAddress: StringField;
34
36
  /** List of company registrations associated to the supplier. */
35
37
  supplierCompanyRegistrations: CompanyRegistrationField[];
38
+ /** The email of the supplier or merchant. */
39
+ supplierEmail: StringField;
36
40
  /** The name of the supplier or merchant. */
37
41
  supplierName: StringField;
38
42
  /** List of payment details associated to the supplier. */
39
43
  supplierPaymentDetails: PaymentDetailsField[];
44
+ /** The phone number of the supplier or merchant. */
45
+ supplierPhoneNumber: StringField;
46
+ /** The website URL of the supplier or merchant. */
47
+ supplierWebsite: StringField;
40
48
  /** List of tax line details. */
41
49
  taxes: Taxes;
42
50
  /** The total amount paid: includes taxes, tips, fees, and other charges. */
@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
5
5
  const invoiceV4LineItem_1 = require("./invoiceV4LineItem");
6
6
  const standard_1 = require("../../parsing/standard");
7
7
  /**
8
- * Document data for Invoice, API version 4.
8
+ * Invoice API version 4.6 document data.
9
9
  */
10
10
  class InvoiceV4Document {
11
11
  constructor(rawPrediction, pageId) {
@@ -32,6 +32,10 @@ class InvoiceV4Document {
32
32
  prediction: itemPrediction,
33
33
  pageId: pageId,
34
34
  })));
35
+ this.customerId = new standard_1.StringField({
36
+ prediction: rawPrediction["customer_id"],
37
+ pageId: pageId,
38
+ });
35
39
  this.customerName = new standard_1.StringField({
36
40
  prediction: rawPrediction["customer_name"],
37
41
  pageId: pageId,
@@ -77,6 +81,10 @@ class InvoiceV4Document {
77
81
  prediction: itemPrediction,
78
82
  pageId: pageId,
79
83
  })));
84
+ this.supplierEmail = new standard_1.StringField({
85
+ prediction: rawPrediction["supplier_email"],
86
+ pageId: pageId,
87
+ });
80
88
  this.supplierName = new standard_1.StringField({
81
89
  prediction: rawPrediction["supplier_name"],
82
90
  pageId: pageId,
@@ -86,6 +94,14 @@ class InvoiceV4Document {
86
94
  prediction: itemPrediction,
87
95
  pageId: pageId,
88
96
  })));
97
+ this.supplierPhoneNumber = new standard_1.StringField({
98
+ prediction: rawPrediction["supplier_phone_number"],
99
+ pageId: pageId,
100
+ });
101
+ this.supplierWebsite = new standard_1.StringField({
102
+ prediction: rawPrediction["supplier_website"],
103
+ pageId: pageId,
104
+ });
89
105
  this.taxes = new standard_1.Taxes().init(rawPrediction["taxes"], pageId);
90
106
  this.totalAmount = new standard_1.AmountField({
91
107
  prediction: rawPrediction["total_amount"],
@@ -135,9 +151,13 @@ class InvoiceV4Document {
135
151
  :Supplier Name: ${this.supplierName}
136
152
  :Supplier Company Registrations: ${supplierCompanyRegistrations}
137
153
  :Supplier Address: ${this.supplierAddress}
154
+ :Supplier Phone Number: ${this.supplierPhoneNumber}
155
+ :Supplier Website: ${this.supplierWebsite}
156
+ :Supplier Email: ${this.supplierEmail}
138
157
  :Customer Name: ${this.customerName}
139
158
  :Customer Company Registrations: ${customerCompanyRegistrations}
140
159
  :Customer Address: ${this.customerAddress}
160
+ :Customer ID: ${this.customerId}
141
161
  :Shipping Address: ${this.shippingAddress}
142
162
  :Billing Address: ${this.billingAddress}
143
163
  :Document Type: ${this.documentType}
@@ -1,7 +1,7 @@
1
1
  import { Inference, StringDict, Page } from "../../parsing/common";
2
2
  import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Document";
3
3
  /**
4
- * Inference prediction for Multi Receipts Detector, API version 1.
4
+ * Multi Receipts Detector API version 1 inference prediction.
5
5
  */
6
6
  export declare class MultiReceiptsDetectorV1 extends Inference {
7
7
  /** The endpoint's name. */
@@ -4,7 +4,7 @@ exports.MultiReceiptsDetectorV1 = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const multiReceiptsDetectorV1Document_1 = require("./multiReceiptsDetectorV1Document");
6
6
  /**
7
- * Inference prediction for Multi Receipts Detector, API version 1.
7
+ * Multi Receipts Detector API version 1 inference prediction.
8
8
  */
9
9
  class MultiReceiptsDetectorV1 extends common_1.Inference {
10
10
  constructor(rawPrediction) {
@@ -1,7 +1,7 @@
1
1
  import { Prediction, StringDict } from "../../parsing/common";
2
2
  import { PositionField } from "../../parsing/standard";
3
3
  /**
4
- * Document data for Multi Receipts Detector, API version 1.
4
+ * Multi Receipts Detector API version 1.0 document data.
5
5
  */
6
6
  export declare class MultiReceiptsDetectorV1Document implements Prediction {
7
7
  /** Positions of the receipts on the document. */
@@ -4,7 +4,7 @@ exports.MultiReceiptsDetectorV1Document = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const standard_1 = require("../../parsing/standard");
6
6
  /**
7
- * Document data for Multi Receipts Detector, API version 1.
7
+ * Multi Receipts Detector API version 1.0 document data.
8
8
  */
9
9
  class MultiReceiptsDetectorV1Document {
10
10
  constructor(rawPrediction, pageId) {
@@ -1,7 +1,7 @@
1
1
  import { Inference, StringDict, Page } from "../../parsing/common";
2
2
  import { PassportV1Document } from "./passportV1Document";
3
3
  /**
4
- * Inference prediction for Passport, API version 1.
4
+ * Passport API version 1 inference prediction.
5
5
  */
6
6
  export declare class PassportV1 extends Inference {
7
7
  /** The endpoint's name. */
@@ -4,7 +4,7 @@ exports.PassportV1 = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const passportV1Document_1 = require("./passportV1Document");
6
6
  /**
7
- * Inference prediction for Passport, API version 1.
7
+ * Passport API version 1 inference prediction.
8
8
  */
9
9
  class PassportV1 extends common_1.Inference {
10
10
  constructor(rawPrediction) {
@@ -1,7 +1,7 @@
1
1
  import { Prediction, StringDict } from "../../parsing/common";
2
2
  import { DateField, StringField } from "../../parsing/standard";
3
3
  /**
4
- * Document data for Passport, API version 1.
4
+ * Passport API version 1.1 document data.
5
5
  */
6
6
  export declare class PassportV1Document implements Prediction {
7
7
  /** The date of birth of the passport holder. */
@@ -4,7 +4,7 @@ exports.PassportV1Document = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const standard_1 = require("../../parsing/standard");
6
6
  /**
7
- * Document data for Passport, API version 1.
7
+ * Passport API version 1.1 document data.
8
8
  */
9
9
  class PassportV1Document {
10
10
  constructor(rawPrediction, pageId) {
@@ -1,7 +1,7 @@
1
1
  import { Inference, StringDict, Page } from "../../parsing/common";
2
2
  import { ProofOfAddressV1Document } from "./proofOfAddressV1Document";
3
3
  /**
4
- * Inference prediction for Proof of Address, API version 1.
4
+ * Proof of Address API version 1 inference prediction.
5
5
  */
6
6
  export declare class ProofOfAddressV1 extends Inference {
7
7
  /** The endpoint's name. */
@@ -4,7 +4,7 @@ exports.ProofOfAddressV1 = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const proofOfAddressV1Document_1 = require("./proofOfAddressV1Document");
6
6
  /**
7
- * Inference prediction for Proof of Address, API version 1.
7
+ * Proof of Address API version 1 inference prediction.
8
8
  */
9
9
  class ProofOfAddressV1 extends common_1.Inference {
10
10
  constructor(rawPrediction) {
@@ -1,7 +1,7 @@
1
1
  import { Prediction, StringDict } from "../../parsing/common";
2
2
  import { CompanyRegistrationField, DateField, LocaleField, StringField } from "../../parsing/standard";
3
3
  /**
4
- * Document data for Proof of Address, API version 1.
4
+ * Proof of Address API version 1.1 document data.
5
5
  */
6
6
  export declare class ProofOfAddressV1Document implements Prediction {
7
7
  /** The date the document was issued. */
@@ -4,7 +4,7 @@ exports.ProofOfAddressV1Document = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const standard_1 = require("../../parsing/standard");
6
6
  /**
7
- * Document data for Proof of Address, API version 1.
7
+ * Proof of Address API version 1.1 document data.
8
8
  */
9
9
  class ProofOfAddressV1Document {
10
10
  constructor(rawPrediction, pageId) {
@@ -1,7 +1,7 @@
1
1
  import { Inference, StringDict, Page } from "../../parsing/common";
2
2
  import { ReceiptV5Document } from "./receiptV5Document";
3
3
  /**
4
- * Inference prediction for Receipt, API version 5.
4
+ * Receipt API version 5 inference prediction.
5
5
  */
6
6
  export declare class ReceiptV5 extends Inference {
7
7
  /** The endpoint's name. */
@@ -4,7 +4,7 @@ exports.ReceiptV5 = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const receiptV5Document_1 = require("./receiptV5Document");
6
6
  /**
7
- * Inference prediction for Receipt, API version 5.
7
+ * Receipt API version 5 inference prediction.
8
8
  */
9
9
  class ReceiptV5 extends common_1.Inference {
10
10
  constructor(rawPrediction) {
@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
2
2
  import { ReceiptV5LineItem } from "./receiptV5LineItem";
3
3
  import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, StringField, Taxes } from "../../parsing/standard";
4
4
  /**
5
- * Document data for Receipt, API version 5.
5
+ * Receipt API version 5.2 document data.
6
6
  */
7
7
  export declare class ReceiptV5Document implements Prediction {
8
8
  /** The purchase category among predefined classes. */
@@ -15,6 +15,8 @@ export declare class ReceiptV5Document implements Prediction {
15
15
  lineItems: ReceiptV5LineItem[];
16
16
  /** The locale detected on the document. */
17
17
  locale: LocaleField;
18
+ /** The receipt number or identifier. */
19
+ receiptNumber: StringField;
18
20
  /** The purchase subcategory among predefined classes for transport and food. */
19
21
  subcategory: ClassificationField;
20
22
  /** The address of the supplier or merchant. */
@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
5
5
  const receiptV5LineItem_1 = require("./receiptV5LineItem");
6
6
  const standard_1 = require("../../parsing/standard");
7
7
  /**
8
- * Document data for Receipt, API version 5.
8
+ * Receipt API version 5.2 document data.
9
9
  */
10
10
  class ReceiptV5Document {
11
11
  constructor(rawPrediction, pageId) {
@@ -31,6 +31,10 @@ class ReceiptV5Document {
31
31
  this.locale = new standard_1.LocaleField({
32
32
  prediction: rawPrediction["locale"],
33
33
  });
34
+ this.receiptNumber = new standard_1.StringField({
35
+ prediction: rawPrediction["receipt_number"],
36
+ pageId: pageId,
37
+ });
34
38
  this.subcategory = new standard_1.ClassificationField({
35
39
  prediction: rawPrediction["subcategory"],
36
40
  });
@@ -104,6 +108,7 @@ class ReceiptV5Document {
104
108
  :Supplier Company Registrations: ${supplierCompanyRegistrations}
105
109
  :Supplier Address: ${this.supplierAddress}
106
110
  :Supplier Phone Number: ${this.supplierPhoneNumber}
111
+ :Receipt Number: ${this.receiptNumber}
107
112
  :Line Items: ${lineItemsSummary}`.trimEnd();
108
113
  return (0, common_1.cleanOutString)(outStr);
109
114
  }
@@ -1,7 +1,7 @@
1
1
  import { Inference, StringDict, Page } from "../../parsing/common";
2
2
  import { ResumeV1Document } from "./resumeV1Document";
3
3
  /**
4
- * Inference prediction for Resume, API version 1.
4
+ * Resume API version 1 inference prediction.
5
5
  */
6
6
  export declare class ResumeV1 extends Inference {
7
7
  /** The endpoint's name. */
@@ -4,7 +4,7 @@ exports.ResumeV1 = void 0;
4
4
  const common_1 = require("../../parsing/common");
5
5
  const resumeV1Document_1 = require("./resumeV1Document");
6
6
  /**
7
- * Inference prediction for Resume, API version 1.
7
+ * Resume API version 1 inference prediction.
8
8
  */
9
9
  class ResumeV1 extends common_1.Inference {
10
10
  constructor(rawPrediction) {
@@ -6,7 +6,7 @@ import { ResumeV1ProfessionalExperience } from "./resumeV1ProfessionalExperience
6
6
  import { ResumeV1Certificate } from "./resumeV1Certificate";
7
7
  import { ClassificationField, StringField } from "../../parsing/standard";
8
8
  /**
9
- * Document data for Resume, API version 1.
9
+ * Resume API version 1.0 document data.
10
10
  */
11
11
  export declare class ResumeV1Document implements Prediction {
12
12
  /** The location information of the candidate, including city, state, and country. */
@@ -9,7 +9,7 @@ const resumeV1ProfessionalExperience_1 = require("./resumeV1ProfessionalExperien
9
9
  const resumeV1Certificate_1 = require("./resumeV1Certificate");
10
10
  const standard_1 = require("../../parsing/standard");
11
11
  /**
12
- * Document data for Resume, API version 1.
12
+ * Resume API version 1.0 document data.
13
13
  */
14
14
  class ResumeV1Document {
15
15
  constructor(rawPrediction, pageId) {
@@ -2,7 +2,7 @@ import { Inference, StringDict, Page } from "../../../parsing/common";
2
2
  import { BankCheckV1Document } from "./bankCheckV1Document";
3
3
  import { BankCheckV1Page } from "./bankCheckV1Page";
4
4
  /**
5
- * Inference prediction for Bank Check, API version 1.
5
+ * Bank Check API version 1 inference prediction.
6
6
  */
7
7
  export declare class BankCheckV1 extends Inference {
8
8
  /** The endpoint's name. */
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const bankCheckV1Document_1 = require("./bankCheckV1Document");
6
6
  const bankCheckV1Page_1 = require("./bankCheckV1Page");
7
7
  /**
8
- * Inference prediction for Bank Check, API version 1.
8
+ * Bank Check API version 1 inference prediction.
9
9
  */
10
10
  class BankCheckV1 extends common_1.Inference {
11
11
  constructor(rawPrediction) {
@@ -1,7 +1,7 @@
1
1
  import { Prediction, StringDict } from "../../../parsing/common";
2
2
  import { AmountField, DateField, StringField } from "../../../parsing/standard";
3
3
  /**
4
- * Document data for Bank Check, API version 1.
4
+ * Bank Check API version 1.1 document data.
5
5
  */
6
6
  export declare class BankCheckV1Document implements Prediction {
7
7
  /** The check payer's account number. */
@@ -4,7 +4,7 @@ exports.BankCheckV1Document = void 0;
4
4
  const common_1 = require("../../../parsing/common");
5
5
  const standard_1 = require("../../../parsing/standard");
6
6
  /**
7
- * Document data for Bank Check, API version 1.
7
+ * Bank Check API version 1.1 document data.
8
8
  */
9
9
  class BankCheckV1Document {
10
10
  constructor(rawPrediction, pageId) {
@@ -2,7 +2,7 @@ import { StringDict } from "../../../parsing/common";
2
2
  import { PositionField } from "../../../parsing/standard";
3
3
  import { BankCheckV1Document } from "./bankCheckV1Document";
4
4
  /**
5
- * Page data for Bank Check, API version 1.
5
+ * Bank Check API version 1.1 page data.
6
6
  */
7
7
  export declare class BankCheckV1Page extends BankCheckV1Document {
8
8
  /** The position of the check on the document. */
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const standard_1 = require("../../../parsing/standard");
6
6
  const bankCheckV1Document_1 = require("./bankCheckV1Document");
7
7
  /**
8
- * Page data for Bank Check, API version 1.
8
+ * Bank Check API version 1.1 page data.
9
9
  */
10
10
  class BankCheckV1Page extends bankCheckV1Document_1.BankCheckV1Document {
11
11
  constructor(rawPrediction, pageId) {
@@ -2,7 +2,7 @@ import { Inference, StringDict, Page } from "../../../parsing/common";
2
2
  import { DriverLicenseV1Document } from "./driverLicenseV1Document";
3
3
  import { DriverLicenseV1Page } from "./driverLicenseV1Page";
4
4
  /**
5
- * Inference prediction for Driver License, API version 1.
5
+ * Driver License API version 1 inference prediction.
6
6
  */
7
7
  export declare class DriverLicenseV1 extends Inference {
8
8
  /** The endpoint's name. */
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const driverLicenseV1Document_1 = require("./driverLicenseV1Document");
6
6
  const driverLicenseV1Page_1 = require("./driverLicenseV1Page");
7
7
  /**
8
- * Inference prediction for Driver License, API version 1.
8
+ * Driver License API version 1 inference prediction.
9
9
  */
10
10
  class DriverLicenseV1 extends common_1.Inference {
11
11
  constructor(rawPrediction) {
@@ -1,7 +1,7 @@
1
1
  import { Prediction, StringDict } from "../../../parsing/common";
2
2
  import { DateField, StringField } from "../../../parsing/standard";
3
3
  /**
4
- * Document data for Driver License, API version 1.
4
+ * Driver License API version 1.1 document data.
5
5
  */
6
6
  export declare class DriverLicenseV1Document implements Prediction {
7
7
  /** US driver license holders address */
@@ -4,7 +4,7 @@ exports.DriverLicenseV1Document = void 0;
4
4
  const common_1 = require("../../../parsing/common");
5
5
  const standard_1 = require("../../../parsing/standard");
6
6
  /**
7
- * Document data for Driver License, API version 1.
7
+ * Driver License API version 1.1 document data.
8
8
  */
9
9
  class DriverLicenseV1Document {
10
10
  constructor(rawPrediction, pageId) {
@@ -2,7 +2,7 @@ import { StringDict } from "../../../parsing/common";
2
2
  import { PositionField } from "../../../parsing/standard";
3
3
  import { DriverLicenseV1Document } from "./driverLicenseV1Document";
4
4
  /**
5
- * Page data for Driver License, API version 1.
5
+ * Driver License API version 1.1 page data.
6
6
  */
7
7
  export declare class DriverLicenseV1Page extends DriverLicenseV1Document {
8
8
  /** Has a photo of the US driver license holder */
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const standard_1 = require("../../../parsing/standard");
6
6
  const driverLicenseV1Document_1 = require("./driverLicenseV1Document");
7
7
  /**
8
- * Page data for Driver License, API version 1.
8
+ * Driver License API version 1.1 page data.
9
9
  */
10
10
  class DriverLicenseV1Page extends driverLicenseV1Document_1.DriverLicenseV1Document {
11
11
  constructor(rawPrediction, pageId) {
@@ -2,7 +2,7 @@ import { Inference, StringDict, Page } from "../../../parsing/common";
2
2
  import { W9V1Document } from "./w9V1Document";
3
3
  import { W9V1Page } from "./w9V1Page";
4
4
  /**
5
- * Inference prediction for W9, API version 1.
5
+ * W9 API version 1 inference prediction.
6
6
  */
7
7
  export declare class W9V1 extends Inference {
8
8
  /** The endpoint's name. */
@@ -5,7 +5,7 @@ const common_1 = require("../../../parsing/common");
5
5
  const w9V1Document_1 = require("./w9V1Document");
6
6
  const w9V1Page_1 = require("./w9V1Page");
7
7
  /**
8
- * Inference prediction for W9, API version 1.
8
+ * W9 API version 1 inference prediction.
9
9
  */
10
10
  class W9V1 extends common_1.Inference {
11
11
  constructor(rawPrediction) {
@@ -1,6 +1,6 @@
1
1
  import { Prediction } from "../../../parsing/common";
2
2
  /**
3
- * Document data for W9, API version 1.
3
+ * W9 API version 1.0 document data.
4
4
  */
5
5
  export declare class W9V1Document implements Prediction {
6
6
  /**
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.W9V1Document = void 0;
4
4
  /**
5
- * Document data for W9, API version 1.
5
+ * W9 API version 1.0 document data.
6
6
  */
7
7
  class W9V1Document {
8
8
  /**