mindee 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b22c708fcdd44e0e5104e5b5e0f9cf669b7f41e46f1c627af252b86ed5b45d7
-  data.tar.gz: 5695f02623e644bbce0d26a3cec7096370d103b01914a97402887a87eba8cc2d
+  metadata.gz: d657be2dabdd3f93c49ead9299fa47fdad4d1afbc0115224668ffc43489b923e
+  data.tar.gz: 3f36429f4d0302573f0619818f0eb1f26177fbf839f9fbb47ed6b8d5a2abd067
 SHA512:
-  metadata.gz: 6b1e14cdac5f7e0a54d5326a2a9a54387568bddc7060e505468ee3f56896cba9a6d1da341d9a5918f695e99ef7aa79d95d065b43a692f8f036892fd0c4fae070
-  data.tar.gz: 92a95c7c1802fc6099a5ce13a869add7d7865ace5331c8d5a449ca4ed83d4e5e6573a193ed151e75f7b4ec8c2da41f30bd23cc2c71e1889d83ddf4012978123d
+  metadata.gz: 4457a03fac7ad60960fe271d4672b17615be5e2bedc34d4b679a17ded4a52afa01cdf1d70f01efae77ff34c6f9e5ebb107098c2e33bc2055d9a7275194a95c4e
+  data.tar.gz: b2671d071bbef4afc2764f9d56a7d8e60022b403ab77b845b0e74b0f33a3ed47a8b9968308baa3595b9db220516d675250d2c20231c9403a0c3f0e74e96fc5a9

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Mindee Ruby API Library Changelog
 
-## v3.6.2 - 2024-03-28
+## v3.8.0 - 2024-05-02
+### Changes
+* :recycle: update products to newer syntax
+* :sparkles: update financial document to v1.6 & invoice to v4.6
+
+
+## v3.7.0 - 2024-03-28
 ### Changes
 * :sparkles: update Invoice to v4.5
 ### Fixes

data/docs/financial_document_v1.md

@@ -34,20 +34,20 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: a6b54e2d-a7fa-4e08-8de6-6cd296f50f3d
+:Mindee ID: 503895c6-eced-42e2-a6fc-0292b7ccf680
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/financial_document v1.2
+:Product: mindee/financial_document v1.6
 :Rotation applied: Yes
 
 Prediction
 ==========
-:Locale: en; en; USD;
+:Locale: en; USD;
 :Invoice Number: INT-001
 :Reference Numbers: 2412/2019
-:Purchase Date: 2019-02-11
+:Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
@@ -63,8 +63,13 @@ Prediction
 :Supplier Address: 4490 Oak Drive Albany, NY 12210
 :Supplier Phone Number:
 :Customer Name: JESSIE M HORNE
+:Supplier Website:
+:Supplier Email:
 :Customer Company Registrations:
 :Customer Address: 2019 Redbud Drive New York, NY 10011
+:Customer ID: 1234567890
+:Shipping Address: 2019 Redbud Drive New York, NY 10011
+:Billing Address: 4312 Wood Road New York, NY 10031
 :Document Type: INVOICE
 :Purchase Subcategory:
 :Purchase Category: miscellaneous
@@ -79,7 +84,7 @@ Prediction
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
   | New set of pedal arms                |              | 2.00     |            |              | 50.00        | 25.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Labon 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
+  | Labor 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
 
 Page Predictions
@@ -87,10 +92,10 @@ Page Predictions
 
 Page 0
 ------
-:Locale: en; en; USD;
+:Locale: en; USD;
 :Invoice Number: INT-001
 :Reference Numbers: 2412/2019
-:Purchase Date: 2019-02-11
+:Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
@@ -106,8 +111,13 @@ Page 0
 :Supplier Address: 4490 Oak Drive Albany, NY 12210
 :Supplier Phone Number:
 :Customer Name: JESSIE M HORNE
+:Supplier Website:
+:Supplier Email:
 :Customer Company Registrations:
 :Customer Address: 2019 Redbud Drive New York, NY 10011
+:Customer ID: 1234567890
+:Shipping Address: 2019 Redbud Drive New York, NY 10011
+:Billing Address: 4312 Wood Road New York, NY 10031
 :Document Type: INVOICE
 :Purchase Subcategory:
 :Purchase Category: miscellaneous
@@ -122,7 +132,7 @@ Page 0
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
   | New set of pedal arms                |              | 2.00     |            |              | 50.00        | 25.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Labon 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
+  | Labor 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
 ```
 
@@ -215,6 +225,13 @@ A `FinancialDocumentV1LineItem` implements the following attributes:
 # Attributes
 The following fields are extracted for Financial Document V1:
 
+## Billing Address
+**billing_address** ([StringField](#string-field)): The customer's address used for billing.
+
+```rb
+puts result.document.inference.prediction.billing_address.value
+```
+
 ## Purchase Category
 **category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
 
@@ -238,6 +255,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Customer ID
+**customer_id** ([StringField](#string-field)): The customer account number or identifier from the supplier.
+
+```rb
+puts result.document.inference.prediction.customer_id.value
+```
+
 ## Customer Name
 **customer_name** ([StringField](#string-field)): The name of the customer.
 
@@ -298,6 +322,13 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
 end
 ```
 
+## Shipping Address
+**shipping_address** ([StringField](#string-field)): The customer's address used for shipping.
+
+```rb
+puts result.document.inference.prediction.shipping_address.value
+```
+
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 
@@ -321,6 +352,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Supplier Email
+**supplier_email** ([StringField](#string-field)): The email of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_email.value
+```
+
 ## Supplier Name
 **supplier_name** ([StringField](#string-field)): The name of the supplier or merchant.
 
@@ -347,6 +385,13 @@ end
 puts result.document.inference.prediction.supplier_phone_number.value
 ```
 
+## Supplier Website
+**supplier_website** ([StringField](#string-field)): The website URL of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_website.value
+```
+
 ## Taxes
 **taxes** (Array<[TaxField](#taxes-field)>): List of tax lines information.
 

data/docs/invoices_v4.md

@@ -34,12 +34,12 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: a9062dd1-0d34-42ab-9505-0481a8545106
+:Mindee ID: 5c0371d0-1433-43a4-b8fb-a3b11aaf9a0e
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.5
+:Product: mindee/invoices v4.6
 :Rotation applied: Yes
 
 Prediction
@@ -48,7 +48,7 @@ Prediction
 :Invoice Number: 14
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date: 2018-09-25
+:Due Date:
 :Total Net:
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -61,10 +61,14 @@ Prediction
 :Supplier Payment Details:
 :Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
-:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
+:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
+:Supplier Phone Number: 4165551212
+:Supplier Website:
+:Supplier Email: i_doi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
+:Customer ID:
 :Shipping Address:
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
@@ -88,7 +92,7 @@ Page 0
 :Invoice Number: 14
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date: 2018-09-25
+:Due Date:
 :Total Net:
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -101,10 +105,14 @@ Page 0
 :Supplier Payment Details:
 :Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
-:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
+:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
+:Supplier Phone Number: 4165551212
+:Supplier Website:
+:Supplier Email: i_doi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
+:Customer ID:
 :Shipping Address:
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
@@ -232,6 +240,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Customer ID
+**customer_id** ([StringField](#string-field)): The customer account number or identifier from the supplier.
+
+```rb
+puts result.document.inference.prediction.customer_id.value
+```
+
 ## Customer Name
 **customer_name** ([StringField](#string-field)): The name of the customer or client.
 
@@ -315,6 +330,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Supplier Email
+**supplier_email** ([StringField](#string-field)): The email of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_email.value
+```
+
 ## Supplier Name
 **supplier_name** ([StringField](#string-field)): The name of the supplier or merchant.
 
@@ -334,6 +356,20 @@ for supplier_payment_details_elem in result.document.inference.prediction.suppli
 end
 ```
 
+## Supplier Phone Number
+**supplier_phone_number** ([StringField](#string-field)): The phone number of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_phone_number.value
+```
+
+## Supplier Website
+**supplier_website** ([StringField](#string-field)): The website URL of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_website.value
+```
+
 ## Taxes
 **taxes** (Array<[TaxField](#taxes-field)>): List of tax line details.
 

data/lib/mindee/product/barcode_reader/barcode_reader_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Barcode Reader module.
     module BarcodeReader
-      # Barcode Reader V1 prediction inference.
+      # Barcode Reader API version 1 inference prediction.
       class BarcodeReaderV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'barcode_reader'
         @endpoint_version = '1'

data/lib/mindee/product/barcode_reader/barcode_reader_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module BarcodeReader
-      # Barcode Reader V1 document prediction.
+      # Barcode Reader API version 1.0 document data.
       class BarcodeReaderV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # List of decoded 1D barcodes.

data/lib/mindee/product/barcode_reader/barcode_reader_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'barcode_reader_v1_document'
 module Mindee
   module Product
     module BarcodeReader
-      # Barcode Reader V1 page.
+      # Barcode Reader API version 1.0 page data.
       class BarcodeReaderV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/cropper/cropper_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Cropper module.
     module Cropper
-      # Cropper V1 prediction inference.
+      # Cropper API version 1 inference prediction.
       class CropperV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'cropper'
         @endpoint_version = '1'

data/lib/mindee/product/cropper/cropper_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module Cropper
-      # Cropper V1 document prediction.
+      # Cropper API version 1.1 document data.
       class CropperV1Document < Mindee::Parsing::Common::Prediction
       end
     end

data/lib/mindee/product/cropper/cropper_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'cropper_v1_document'
 module Mindee
   module Product
     module Cropper
-      # Cropper V1 page.
+      # Cropper API version 1.1 page data.
       class CropperV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/eu/driver_license/driver_license_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module EU
       # Driver License module.
       module DriverLicense
-        # Driver License V1 prediction inference.
+        # Driver License API version 1 inference prediction.
         class DriverLicenseV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'eu_driver_license'
           @endpoint_version = '1'

data/lib/mindee/product/eu/driver_license/driver_license_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module EU
       module DriverLicense
-        # Driver License V1 document prediction.
+        # Driver License API version 1.0 document data.
         class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # EU driver license holders address

data/lib/mindee/product/eu/driver_license/driver_license_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module EU
       module DriverLicense
-        # Driver License V1 page.
+        # Driver License API version 1.0 page data.
         class DriverLicenseV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/eu/license_plate/license_plate_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module EU
       # License Plate module.
       module LicensePlate
-        # License Plate V1 prediction inference.
+        # License Plate API version 1 inference prediction.
         class LicensePlateV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'license_plates'
           @endpoint_version = '1'

data/lib/mindee/product/eu/license_plate/license_plate_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module EU
       module LicensePlate
-        # License Plate V1 document prediction.
+        # License Plate API version 1.1 document data.
         class LicensePlateV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # List of all license plates found in the image.

data/lib/mindee/product/eu/license_plate/license_plate_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module EU
       module LicensePlate
-        # License Plate V1 page.
+        # License Plate API version 1.1 page data.
         class LicensePlateV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/financial_document/financial_document_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Financial Document module.
     module FinancialDocument
-      # Financial Document V1 prediction inference.
+      # Financial Document API version 1 inference prediction.
       class FinancialDocumentV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'financial_document'
         @endpoint_version = '1'

data/lib/mindee/product/financial_document/financial_document_v1_document.rb

@@ -6,9 +6,12 @@ require_relative 'financial_document_v1_line_item'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document V1 document prediction.
+      # Financial Document API version 1.6 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
+        # The customer's address used for billing.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :billing_address
         # The purchase category among predefined classes.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :category
@@ -18,6 +21,9 @@ module Mindee
         # List of company registrations associated to the customer.
         # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :customer_company_registrations
+        # The customer account number or identifier from the supplier.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_id
         # The name of the customer.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_name
@@ -42,6 +48,9 @@ module Mindee
         # List of Reference numbers, including PO number.
         # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
+        # The customer's address used for shipping.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :shipping_address
         # The purchase subcategory among predefined classes for transport and food.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :subcategory
@@ -51,6 +60,9 @@ module Mindee
         # List of company registrations associated to the supplier.
         # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :supplier_company_registrations
+        # The email of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_email
         # The name of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_name
@@ -60,6 +72,9 @@ module Mindee
         # The phone number of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_phone_number
+        # The website URL of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_website
         # List of tax lines information.
         # @return [Mindee::Parsing::Standard::Taxes]
         attr_reader :taxes
@@ -83,12 +98,14 @@ module Mindee
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
           super()
+          @billing_address = StringField.new(prediction['billing_address'], page_id)
           @category = ClassificationField.new(prediction['category'], page_id)
           @customer_address = StringField.new(prediction['customer_address'], page_id)
           @customer_company_registrations = []
           prediction['customer_company_registrations'].each do |item|
             @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
+          @customer_id = StringField.new(prediction['customer_id'], page_id)
           @customer_name = StringField.new(prediction['customer_name'], page_id)
           @date = DateField.new(prediction['date'], page_id)
           @document_type = ClassificationField.new(prediction['document_type'], page_id)
@@ -103,18 +120,21 @@ module Mindee
           prediction['reference_numbers'].each do |item|
             @reference_numbers.push(StringField.new(item, page_id))
           end
+          @shipping_address = StringField.new(prediction['shipping_address'], page_id)
           @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
           @supplier_address = StringField.new(prediction['supplier_address'], page_id)
           @supplier_company_registrations = []
           prediction['supplier_company_registrations'].each do |item|
             @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
+          @supplier_email = StringField.new(prediction['supplier_email'], page_id)
           @supplier_name = StringField.new(prediction['supplier_name'], page_id)
           @supplier_payment_details = []
           prediction['supplier_payment_details'].each do |item|
             @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
           end
           @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
+          @supplier_website = StringField.new(prediction['supplier_website'], page_id)
           @taxes = Taxes.new(prediction['taxes'], page_id)
           @time = StringField.new(prediction['time'], page_id)
           @tip = AmountField.new(prediction['tip'], page_id)
@@ -145,8 +165,13 @@ module Mindee
           out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
           out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
           out_str << "\n:Customer Name: #{@customer_name}".rstrip
+          out_str << "\n:Supplier Website: #{@supplier_website}".rstrip
+          out_str << "\n:Supplier Email: #{@supplier_email}".rstrip
           out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
           out_str << "\n:Customer Address: #{@customer_address}".rstrip
+          out_str << "\n:Customer ID: #{@customer_id}".rstrip
+          out_str << "\n:Shipping Address: #{@shipping_address}".rstrip
+          out_str << "\n:Billing Address: #{@billing_address}".rstrip
           out_str << "\n:Document Type: #{@document_type}".rstrip
           out_str << "\n:Purchase Subcategory: #{@subcategory}".rstrip
           out_str << "\n:Purchase Category: #{@category}".rstrip

data/lib/mindee/product/financial_document/financial_document_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_document'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document V1 page.
+      # Financial Document API version 1.6 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module FR
       # Bank Account Details module.
       module BankAccountDetails
-        # Bank Account Details V1 prediction inference.
+        # Bank Account Details API version 1 inference prediction.
         class BankAccountDetailsV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'bank_account_details'
           @endpoint_version = '1'

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module FR
       module BankAccountDetails
-        # Bank Account Details V1 document prediction.
+        # Bank Account Details API version 1.0 document data.
         class BankAccountDetailsV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The name of the account holder as seen on the document.

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module FR
       module BankAccountDetails
-        # Bank Account Details V1 page.
+        # Bank Account Details API version 1.0 page data.
         class BankAccountDetailsV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2.rb

@@ -9,7 +9,7 @@ module Mindee
     module FR
       # Bank Account Details module.
       module BankAccountDetails
-        # Bank Account Details V2 prediction inference.
+        # Bank Account Details API version 2 inference prediction.
         class BankAccountDetailsV2 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'bank_account_details'
           @endpoint_version = '2'

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module FR
       module BankAccountDetails
-        # Bank Account Details V2 document prediction.
+        # Bank Account Details API version 2.0 document data.
         class BankAccountDetailsV2Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # Full extraction of the account holders names.

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module FR
       module BankAccountDetails
-        # Bank Account Details V2 page.
+        # Bank Account Details API version 2.0 page data.
         class BankAccountDetailsV2Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/fr/carte_grise/carte_grise_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module FR
       # Carte Grise module.
       module CarteGrise
-        # Carte Grise V1 prediction inference.
+        # Carte Grise API version 1 inference prediction.
         class CarteGriseV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'carte_grise'
           @endpoint_version = '1'

data/lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module FR
       module CarteGrise
-        # Carte Grise V1 document prediction.
+        # Carte Grise API version 1.1 document data.
         class CarteGriseV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The vehicle's license plate number.

data/lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module FR
       module CarteGrise
-        # Carte Grise V1 page.
+        # Carte Grise API version 1.1 page data.
         class CarteGriseV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module FR
       # Carte Vitale module.
       module CarteVitale
-        # Carte Vitale V1 prediction inference.
+        # Carte Vitale API version 1 inference prediction.
         class CarteVitaleV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'carte_vitale'
           @endpoint_version = '1'

data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module FR
       module CarteVitale
-        # Carte Vitale V1 document prediction.
+        # Carte Vitale API version 1.1 document data.
         class CarteVitaleV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The given name(s) of the card holder.

data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module FR
       module CarteVitale
-        # Carte Vitale V1 page.
+        # Carte Vitale API version 1.1 page data.
         class CarteVitaleV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/fr/id_card/id_card_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module FR
       # Carte Nationale d'Identité module.
       module IdCard
-        # Carte Nationale d'Identité V1 prediction inference.
+        # Carte Nationale d'Identité API version 1 inference prediction.
         class IdCardV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'idcard_fr'
           @endpoint_version = '1'

data/lib/mindee/product/fr/id_card/id_card_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module FR
       module IdCard
-        # Carte Nationale d'Identité V1 document prediction.
+        # Carte Nationale d'Identité API version 1.1 document data.
         class IdCardV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The name of the issuing authority.

data/lib/mindee/product/fr/id_card/id_card_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module FR
       module IdCard
-        # Carte Nationale d'Identité V1 page.
+        # Carte Nationale d'Identité API version 1.1 page data.
         class IdCardV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/fr/id_card/id_card_v2.rb

@@ -9,7 +9,7 @@ module Mindee
     module FR
       # Carte Nationale d'Identité module.
       module IdCard
-        # Carte Nationale d'Identité V2 prediction inference.
+        # Carte Nationale d'Identité API version 2 inference prediction.
         class IdCardV2 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'idcard_fr'
           @endpoint_version = '2'

data/lib/mindee/product/fr/id_card/id_card_v2_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module FR
       module IdCard
-        # Carte Nationale d'Identité V2 document prediction.
+        # Carte Nationale d'Identité API version 2.0 document data.
         class IdCardV2Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The alternate name of the card holder.

data/lib/mindee/product/fr/id_card/id_card_v2_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module FR
       module IdCard
-        # Carte Nationale d'Identité V2 page.
+        # Carte Nationale d'Identité API version 2.0 page data.
         class IdCardV2Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/international_id/international_id_v2.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # International ID module.
     module InternationalId
-      # International ID V2 prediction inference.
+      # International ID API version 2 inference prediction.
       class InternationalIdV2 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'international_id'
         @endpoint_version = '2'

data/lib/mindee/product/international_id/international_id_v2_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module InternationalId
-      # International ID V2 document prediction.
+      # International ID API version 2.0 document data.
       class InternationalIdV2Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The physical address of the document holder.

data/lib/mindee/product/international_id/international_id_v2_page.rb

@@ -6,7 +6,7 @@ require_relative 'international_id_v2_document'
 module Mindee
   module Product
     module InternationalId
-      # International ID V2 page.
+      # International ID API version 2.0 page data.
       class InternationalIdV2Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/invoice/invoice_v4.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Invoice module.
     module Invoice
-      # Invoice V4 prediction inference.
+      # Invoice API version 4 inference prediction.
       class InvoiceV4 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'invoices'
         @endpoint_version = '4'

data/lib/mindee/product/invoice/invoice_v4_document.rb

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_line_item'
 module Mindee
   module Product
     module Invoice
-      # Invoice V4 document prediction.
+      # Invoice API version 4.6 document data.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -18,6 +18,9 @@ module Mindee
         # List of company registrations associated to the customer.
         # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :customer_company_registrations
+        # The customer account number or identifier from the supplier.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_id
         # The name of the customer or client.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_name
@@ -51,12 +54,21 @@ module Mindee
         # List of company registrations associated to the supplier.
         # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :supplier_company_registrations
+        # The email of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_email
         # The name of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_name
         # List of payment details associated to the supplier.
         # @return [Array<Mindee::Parsing::Standard::PaymentDetailsField>]
         attr_reader :supplier_payment_details
+        # The phone number of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_phone_number
+        # The website URL of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_website
         # List of tax line details.
         # @return [Mindee::Parsing::Standard::Taxes]
         attr_reader :taxes
@@ -80,6 +92,7 @@ module Mindee
           prediction['customer_company_registrations'].each do |item|
             @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
+          @customer_id = StringField.new(prediction['customer_id'], page_id)
           @customer_name = StringField.new(prediction['customer_name'], page_id)
           @date = DateField.new(prediction['date'], page_id)
           @document_type = ClassificationField.new(prediction['document_type'], page_id)
@@ -100,11 +113,14 @@ module Mindee
           prediction['supplier_company_registrations'].each do |item|
             @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
+          @supplier_email = StringField.new(prediction['supplier_email'], page_id)
           @supplier_name = StringField.new(prediction['supplier_name'], page_id)
           @supplier_payment_details = []
           prediction['supplier_payment_details'].each do |item|
             @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
           end
+          @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
+          @supplier_website = StringField.new(prediction['supplier_website'], page_id)
           @taxes = Taxes.new(prediction['taxes'], page_id)
           @total_amount = AmountField.new(prediction['total_amount'], page_id)
           @total_net = AmountField.new(prediction['total_net'], page_id)
@@ -132,9 +148,13 @@ module Mindee
           out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
           out_str << "\n:Supplier Company Registrations: #{supplier_company_registrations}".rstrip
           out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
+          out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
+          out_str << "\n:Supplier Website: #{@supplier_website}".rstrip
+          out_str << "\n:Supplier Email: #{@supplier_email}".rstrip
           out_str << "\n:Customer Name: #{@customer_name}".rstrip
           out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
           out_str << "\n:Customer Address: #{@customer_address}".rstrip
+          out_str << "\n:Customer ID: #{@customer_id}".rstrip
           out_str << "\n:Shipping Address: #{@shipping_address}".rstrip
           out_str << "\n:Billing Address: #{@billing_address}".rstrip
           out_str << "\n:Document Type: #{@document_type}".rstrip

data/lib/mindee/product/invoice/invoice_v4_page.rb

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_document'
 module Mindee
   module Product
     module Invoice
-      # Invoice V4 page.
+      # Invoice API version 4.6 page data.
       class InvoiceV4Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Multi Receipts Detector module.
     module MultiReceiptsDetector
-      # Multi Receipts Detector V1 prediction inference.
+      # Multi Receipts Detector API version 1 inference prediction.
       class MultiReceiptsDetectorV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'multi_receipts_detector'
         @endpoint_version = '1'

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module MultiReceiptsDetector
-      # Multi Receipts Detector V1 document prediction.
+      # Multi Receipts Detector API version 1.0 document data.
       class MultiReceiptsDetectorV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # Positions of the receipts on the document.

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'multi_receipts_detector_v1_document'
 module Mindee
   module Product
     module MultiReceiptsDetector
-      # Multi Receipts Detector V1 page.
+      # Multi Receipts Detector API version 1.0 page data.
       class MultiReceiptsDetectorV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/passport/passport_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Passport module.
     module Passport
-      # Passport V1 prediction inference.
+      # Passport API version 1 inference prediction.
       class PassportV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'passport'
         @endpoint_version = '1'

data/lib/mindee/product/passport/passport_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module Passport
-      # Passport V1 document prediction.
+      # Passport API version 1.1 document data.
       class PassportV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The date of birth of the passport holder.

data/lib/mindee/product/passport/passport_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'passport_v1_document'
 module Mindee
   module Product
     module Passport
-      # Passport V1 page.
+      # Passport API version 1.1 page data.
       class PassportV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/proof_of_address/proof_of_address_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Proof of Address module.
     module ProofOfAddress
-      # Proof of Address V1 prediction inference.
+      # Proof of Address API version 1 inference prediction.
       class ProofOfAddressV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'proof_of_address'
         @endpoint_version = '1'

data/lib/mindee/product/proof_of_address/proof_of_address_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module ProofOfAddress
-      # Proof of Address V1 document prediction.
+      # Proof of Address API version 1.1 document data.
       class ProofOfAddressV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The date the document was issued.

data/lib/mindee/product/proof_of_address/proof_of_address_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'proof_of_address_v1_document'
 module Mindee
   module Product
     module ProofOfAddress
-      # Proof of Address V1 page.
+      # Proof of Address API version 1.1 page data.
       class ProofOfAddressV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/receipt/receipt_v5.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Receipt module.
     module Receipt
-      # Receipt V5 prediction inference.
+      # Receipt API version 5 inference prediction.
       class ReceiptV5 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'expense_receipts'
         @endpoint_version = '5'

data/lib/mindee/product/receipt/receipt_v5_document.rb

@@ -6,7 +6,7 @@ require_relative 'receipt_v5_line_item'
 module Mindee
   module Product
     module Receipt
-      # Receipt V5 document prediction.
+      # Receipt API version 5.1 document data.
       class ReceiptV5Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The purchase category among predefined classes.

data/lib/mindee/product/receipt/receipt_v5_page.rb

@@ -6,7 +6,7 @@ require_relative 'receipt_v5_document'
 module Mindee
   module Product
     module Receipt
-      # Receipt V5 page.
+      # Receipt API version 5.1 page data.
       class ReceiptV5Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/resume/resume_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Resume module.
     module Resume
-      # Resume V1 prediction inference.
+      # Resume API version 1 inference prediction.
       class ResumeV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'resume'
         @endpoint_version = '1'

data/lib/mindee/product/resume/resume_v1_document.rb

@@ -10,7 +10,7 @@ require_relative 'resume_v1_certificate'
 module Mindee
   module Product
     module Resume
-      # Resume V1 document prediction.
+      # Resume API version 1.0 document data.
       class ResumeV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The location information of the candidate, including city, state, and country.

data/lib/mindee/product/resume/resume_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'resume_v1_document'
 module Mindee
   module Product
     module Resume
-      # Resume V1 page.
+      # Resume API version 1.0 page data.
       class ResumeV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/us/bank_check/bank_check_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module US
       # Bank Check module.
       module BankCheck
-        # Bank Check V1 prediction inference.
+        # Bank Check API version 1 inference prediction.
         class BankCheckV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'bank_check'
           @endpoint_version = '1'

data/lib/mindee/product/us/bank_check/bank_check_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module US
       module BankCheck
-        # Bank Check V1 document prediction.
+        # Bank Check API version 1.1 document data.
         class BankCheckV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The check payer's account number.

data/lib/mindee/product/us/bank_check/bank_check_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module BankCheck
-        # Bank Check V1 page.
+        # Bank Check API version 1.1 page data.
         class BankCheckV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/us/driver_license/driver_license_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module US
       # Driver License module.
       module DriverLicense
-        # Driver License V1 prediction inference.
+        # Driver License API version 1 inference prediction.
         class DriverLicenseV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'us_driver_license'
           @endpoint_version = '1'

data/lib/mindee/product/us/driver_license/driver_license_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module US
       module DriverLicense
-        # Driver License V1 document prediction.
+        # Driver License API version 1.1 document data.
         class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # US driver license holders address

data/lib/mindee/product/us/driver_license/driver_license_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module DriverLicense
-        # Driver License V1 page.
+        # Driver License API version 1.1 page data.
         class DriverLicenseV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/product/us/w9/w9_v1.rb

@@ -9,7 +9,7 @@ module Mindee
     module US
       # W9 module.
       module W9
-        # W9 V1 prediction inference.
+        # W9 API version 1 inference prediction.
         class W9V1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'us_w9'
           @endpoint_version = '1'

data/lib/mindee/product/us/w9/w9_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module US
       module W9
-        # W9 V1 document prediction.
+        # W9 API version 1.0 document data.
         class W9V1Document < Mindee::Parsing::Common::Prediction
         end
       end

data/lib/mindee/product/us/w9/w9_v1_page.rb

@@ -7,7 +7,7 @@ module Mindee
   module Product
     module US
       module W9
-        # W9 V1 page.
+        # W9 API version 1.0 page data.
         class W9V1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.7.0'
+  VERSION = '3.8.0'
 
   # Finds and return the current platform.
   # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel