mindee 3.1.1 → 3.2.0

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

@@ -13,13 +13,13 @@ module Mindee
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :category
         # The address of the customer.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_address
         # List of company registrations associated to the customer.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :customer_company_registrations
         # The name of the customer.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_name
         # The date the purchase was made.
         # @return [Mindee::Parsing::Standard::DateField]
@@ -31,40 +31,40 @@ module Mindee
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :due_date
         # The invoice number or identifier.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :invoice_number
         # List of line item details.
         # @return [Array<Mindee::Product::FinancialDocument::FinancialDocumentV1LineItem>]
         attr_reader :line_items
         # The locale detected on the document.
-        # @return [Mindee::Parsing::Standard::Locale]
+        # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
         # List of Reference numbers, including PO number.
-        # @return [Array<Mindee::Parsing::Standard::TextField>]
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
         # The purchase subcategory among predefined classes for transport and food.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :subcategory
         # The address of the supplier or merchant.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_address
         # List of company registrations associated to the supplier.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :supplier_company_registrations
         # The name of the supplier or merchant.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_name
         # List of payment details associated to the supplier.
-        # @return [Array<Mindee::Parsing::Standard::PaymentDetails>]
+        # @return [Array<Mindee::Parsing::Standard::PaymentDetailsField>]
         attr_reader :supplier_payment_details
         # The phone number of the supplier or merchant.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_phone_number
         # List of tax lines information.
         # @return [Mindee::Parsing::Standard::Taxes]
         attr_reader :taxes
         # The time the purchase was made.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :time
         # The total amount of tip and gratuity
         # @return [Mindee::Parsing::Standard::AmountField]
@@ -84,39 +84,39 @@ module Mindee
         def initialize(prediction, page_id)
           super()
           @category = ClassificationField.new(prediction['category'], page_id)
-          @customer_address = TextField.new(prediction['customer_address'], 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(CompanyRegistration.new(item, page_id))
+            @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
-          @customer_name = TextField.new(prediction['customer_name'], 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)
           @due_date = DateField.new(prediction['due_date'], page_id)
-          @invoice_number = TextField.new(prediction['invoice_number'], page_id)
+          @invoice_number = StringField.new(prediction['invoice_number'], page_id)
           @line_items = []
           prediction['line_items'].each do |item|
             @line_items.push(FinancialDocumentV1LineItem.new(item, page_id))
           end
-          @locale = Locale.new(prediction['locale'], page_id)
+          @locale = LocaleField.new(prediction['locale'], page_id)
           @reference_numbers = []
           prediction['reference_numbers'].each do |item|
-            @reference_numbers.push(TextField.new(item, page_id))
+            @reference_numbers.push(StringField.new(item, page_id))
           end
           @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
-          @supplier_address = TextField.new(prediction['supplier_address'], 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(CompanyRegistration.new(item, page_id))
+            @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
-          @supplier_name = TextField.new(prediction['supplier_name'], 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(PaymentDetails.new(item, page_id))
+            @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
           end
-          @supplier_phone_number = TextField.new(prediction['supplier_phone_number'], page_id)
+          @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
           @taxes = Taxes.new(prediction['taxes'], page_id)
-          @time = TextField.new(prediction['time'], page_id)
+          @time = StringField.new(prediction['time'], page_id)
           @tip = AmountField.new(prediction['tip'], page_id)
           @total_amount = AmountField.new(prediction['total_amount'], page_id)
           @total_net = AmountField.new(prediction['total_net'], page_id)

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

@@ -7,6 +7,7 @@ require_relative 'bank_account_details_v1_page'
 module Mindee
   module Product
     module FR
+      # Bank Account Details module.
       module BankAccountDetails
         # Bank Account Details V1 prediction inference.
         class BankAccountDetailsV1 < Mindee::Parsing::Common::Inference

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

@@ -10,22 +10,22 @@ module Mindee
         class BankAccountDetailsV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The name of the account holder as seen on the document.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :account_holder_name
           # The International Bank Account Number (IBAN).
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :iban
           # The bank's SWIFT Business Identifier Code (BIC).
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :swift
 
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
             super()
-            @account_holder_name = TextField.new(prediction['account_holder_name'], page_id)
-            @iban = TextField.new(prediction['iban'], page_id)
-            @swift = TextField.new(prediction['swift'], page_id)
+            @account_holder_name = StringField.new(prediction['account_holder_name'], page_id)
+            @iban = StringField.new(prediction['iban'], page_id)
+            @swift = StringField.new(prediction['swift'], page_id)
           end
 
           # @return [String]

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

@@ -7,6 +7,7 @@ require_relative 'bank_account_details_v2_page'
 module Mindee
   module Product
     module FR
+      # Bank Account Details module.
       module BankAccountDetails
         # Bank Account Details V2 prediction inference.
         class BankAccountDetailsV2 < Mindee::Parsing::Common::Inference

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

@@ -11,26 +11,26 @@ module Mindee
         class BankAccountDetailsV2Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # Full extraction of the account holders names.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :account_holders_names
           # Full extraction of BBAN, including: branch code, bank code, account and key.
           # @return [Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2Bban]
           attr_reader :bban
           # Full extraction of the IBAN number.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :iban
           # Full extraction of the SWIFT code.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :swift_code
 
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
             super()
-            @account_holders_names = TextField.new(prediction['account_holders_names'], page_id)
+            @account_holders_names = StringField.new(prediction['account_holders_names'], page_id)
             @bban = BankAccountDetailsV2Bban.new(prediction['bban'], page_id)
-            @iban = TextField.new(prediction['iban'], page_id)
-            @swift_code = TextField.new(prediction['swift_code'], page_id)
+            @iban = StringField.new(prediction['iban'], page_id)
+            @swift_code = StringField.new(prediction['swift_code'], page_id)
           end
 
           # @return [String]

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

@@ -7,6 +7,7 @@ require_relative 'carte_vitale_v1_page'
 module Mindee
   module Product
     module FR
+      # Carte Vitale module.
       module CarteVitale
         # Carte Vitale V1 prediction inference.
         class CarteVitaleV1 < Mindee::Parsing::Common::Inference

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

@@ -10,16 +10,16 @@ module Mindee
         class CarteVitaleV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The given name(s) of the card holder.
-          # @return [Array<Mindee::Parsing::Standard::TextField>]
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
           attr_reader :given_names
           # The date the card was issued.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :issuance_date
           # The Social Security Number (Numéro de Sécurité Sociale) of the card holder
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :social_security
           # The surname of the card holder.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :surname
 
           # @param prediction [Hash]
@@ -28,11 +28,11 @@ module Mindee
             super()
             @given_names = []
             prediction['given_names'].each do |item|
-              @given_names.push(TextField.new(item, page_id))
+              @given_names.push(StringField.new(item, page_id))
             end
             @issuance_date = DateField.new(prediction['issuance_date'], page_id)
-            @social_security = TextField.new(prediction['social_security'], page_id)
-            @surname = TextField.new(prediction['surname'], page_id)
+            @social_security = StringField.new(prediction['social_security'], page_id)
+            @surname = StringField.new(prediction['surname'], page_id)
           end
 
           # @return [String]

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

@@ -7,6 +7,7 @@ require_relative 'id_card_v1_page'
 module Mindee
   module Product
     module FR
+      # Carte Nationale d'Identité module.
       module IdCard
         # Carte Nationale d'Identité V1 prediction inference.
         class IdCardV1 < Mindee::Parsing::Common::Inference

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

@@ -10,53 +10,53 @@ module Mindee
         class IdCardV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The name of the issuing authority.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :authority
           # The date of birth of the card holder.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :birth_date
           # The place of birth of the card holder.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :birth_place
           # The expiry date of the identification card.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :expiry_date
           # The gender of the card holder.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :gender
           # The given name(s) of the card holder.
-          # @return [Array<Mindee::Parsing::Standard::TextField>]
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
           attr_reader :given_names
           # The identification card number.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :id_number
           # Machine Readable Zone, first line
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :mrz1
           # Machine Readable Zone, second line
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :mrz2
           # The surname of the card holder.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :surname
 
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
             super()
-            @authority = TextField.new(prediction['authority'], page_id)
+            @authority = StringField.new(prediction['authority'], page_id)
             @birth_date = DateField.new(prediction['birth_date'], page_id)
-            @birth_place = TextField.new(prediction['birth_place'], page_id)
+            @birth_place = StringField.new(prediction['birth_place'], page_id)
             @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-            @gender = TextField.new(prediction['gender'], page_id)
+            @gender = StringField.new(prediction['gender'], page_id)
             @given_names = []
             prediction['given_names'].each do |item|
-              @given_names.push(TextField.new(item, page_id))
+              @given_names.push(StringField.new(item, page_id))
             end
-            @id_number = TextField.new(prediction['id_number'], page_id)
-            @mrz1 = TextField.new(prediction['mrz1'], page_id)
-            @mrz2 = TextField.new(prediction['mrz2'], page_id)
-            @surname = TextField.new(prediction['surname'], page_id)
+            @id_number = StringField.new(prediction['id_number'], page_id)
+            @mrz1 = StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = StringField.new(prediction['mrz2'], page_id)
+            @surname = StringField.new(prediction['surname'], page_id)
           end
 
           # @return [String]

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v2_document'
+require_relative 'id_card_v2_page'
+
+module Mindee
+  module Product
+    module FR
+      # Carte Nationale d'Identité module.
+      module IdCard
+        # Carte Nationale d'Identité V2 prediction inference.
+        class IdCardV2 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'idcard_fr'
+          @endpoint_version = '2'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = IdCardV2Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(IdCardV2Page.new(page))
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module IdCard
+        # Carte Nationale d'Identité V2 document prediction.
+        class IdCardV2Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The alternate name of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :alternate_name
+          # The name of the issuing authority.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :authority
+          # The date of birth of the card holder.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :birth_date
+          # The place of birth of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :birth_place
+          # The card access number (CAN).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :card_access_number
+          # The document number.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :document_number
+          # The expiry date of the identification card.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :expiry_date
+          # The gender of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :gender
+          # The given name(s) of the card holder.
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
+          attr_reader :given_names
+          # The date of issue of the identification card.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :issue_date
+          # The Machine Readable Zone, first line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz1
+          # The Machine Readable Zone, second line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz2
+          # The Machine Readable Zone, third line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz3
+          # The nationality of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :nationality
+          # The surname of the card holder.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :surname
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @alternate_name = StringField.new(prediction['alternate_name'], page_id)
+            @authority = StringField.new(prediction['authority'], page_id)
+            @birth_date = DateField.new(prediction['birth_date'], page_id)
+            @birth_place = StringField.new(prediction['birth_place'], page_id)
+            @card_access_number = StringField.new(prediction['card_access_number'], page_id)
+            @document_number = StringField.new(prediction['document_number'], page_id)
+            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+            @gender = StringField.new(prediction['gender'], page_id)
+            @given_names = []
+            prediction['given_names'].each do |item|
+              @given_names.push(StringField.new(item, page_id))
+            end
+            @issue_date = DateField.new(prediction['issue_date'], page_id)
+            @mrz1 = StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = StringField.new(prediction['mrz2'], page_id)
+            @mrz3 = StringField.new(prediction['mrz3'], page_id)
+            @nationality = StringField.new(prediction['nationality'], page_id)
+            @surname = StringField.new(prediction['surname'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            given_names = @given_names.join("\n #{' ' * 15}")
+            out_str = String.new
+            out_str << "\n:Nationality: #{@nationality}".rstrip
+            out_str << "\n:Card Access Number: #{@card_access_number}".rstrip
+            out_str << "\n:Document Number: #{@document_number}".rstrip
+            out_str << "\n:Given Name(s): #{given_names}".rstrip
+            out_str << "\n:Surname: #{@surname}".rstrip
+            out_str << "\n:Alternate Name: #{@alternate_name}".rstrip
+            out_str << "\n:Date of Birth: #{@birth_date}".rstrip
+            out_str << "\n:Place of Birth: #{@birth_place}".rstrip
+            out_str << "\n:Gender: #{@gender}".rstrip
+            out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+            out_str << "\n:Mrz Line 1: #{@mrz1}".rstrip
+            out_str << "\n:Mrz Line 2: #{@mrz2}".rstrip
+            out_str << "\n:Mrz Line 3: #{@mrz3}".rstrip
+            out_str << "\n:Date of Issue: #{@issue_date}".rstrip
+            out_str << "\n:Issuing Authority: #{@authority}".rstrip
+            out_str[1..].to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v2_document'
+
+module Mindee
+  module Product
+    module FR
+      module IdCard
+        # Carte Nationale d'Identité V2 page.
+        class IdCardV2Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = IdCardV2PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Carte Nationale d'Identité V2 page prediction.
+        class IdCardV2PagePrediction < IdCardV2Document
+          include Mindee::Parsing::Standard
+
+          # The sides of the document which are visible.
+          # @return [Mindee::Parsing::Standard::ClassificationField]
+          attr_reader :document_side
+          # The document type or format.
+          # @return [Mindee::Parsing::Standard::ClassificationField]
+          attr_reader :document_type
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            @document_side = ClassificationField.new(prediction['document_side'], page_id)
+            @document_type = ClassificationField.new(prediction['document_type'], page_id)
+            super(prediction, page_id)
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:Document Type: #{@document_type}".rstrip
+            out_str << "\n:Document Sides: #{@document_side}".rstrip
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ require_relative 'invoice_v4_page'
 
 module Mindee
   module Product
+    # Invoice module.
     module Invoice
       # Invoice document.
       class InvoiceV4 < Mindee::Parsing::Common::Inference