mindee 3.1.1 → 3.3.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)
@@ -140,11 +140,11 @@ module Mindee
           out_str << "\n:Total Amount: #{@total_amount}".rstrip
           out_str << "\n:Taxes:#{@taxes}".rstrip
           out_str << "\n:Supplier Payment Details: #{supplier_payment_details}".rstrip
-          out_str << "\n:Supplier name: #{@supplier_name}".rstrip
+          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:Customer name: #{@customer_name}".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:Document Type: #{@document_type}".rstrip

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_grise/carte_grise_v1.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'carte_grise_v1_document'
+require_relative 'carte_grise_v1_page'
+
+module Mindee
+  module Product
+    module FR
+      # Carte Grise module.
+      module CarteGrise
+        # Carte Grise V1 prediction inference.
+        class CarteGriseV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'carte_grise'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = CarteGriseV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(CarteGriseV1Page.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/carte_grise/carte_grise_v1_document.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module CarteGrise
+        # Carte Grise V1 document prediction.
+        class CarteGriseV1Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # The vehicle's license plate number.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :a
+          # The vehicle's first release date.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :b
+          # The vehicle owner's full name including maiden name.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :c1
+          # The vehicle owner's address.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :c3
+          # Number of owners of the license certificate.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :c41
+          # Mentions about the ownership of the vehicle.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :c4a
+          # The vehicle's brand.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :d1
+          # The vehicle's commercial name.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :d3
+          # The Vehicle Identification Number (VIN).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :e
+          # The vehicle's maximum admissible weight.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :f1
+          # The vehicle's maximum admissible weight within the license's state.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :f2
+          # The vehicle's maximum authorized weight with coupling.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :f3
+          # The document's formula number.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :formula_number
+          # The vehicle's weight with coupling if tractor different than category M1.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :g
+          # The vehicle's national empty weight.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :g1
+          # The car registration date of the given certificate.
+          # @return [Mindee::Parsing::Standard::DateField]
+          attr_reader :i
+          # The vehicle's category.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :j
+          # The vehicle's national type.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :j1
+          # The vehicle's body type (CE).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :j2
+          # The vehicle's body type (National designation).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :j3
+          # Machine Readable Zone, first line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz1
+          # Machine Readable Zone, second line.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :mrz2
+          # The vehicle's owner first name.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :owner_first_name
+          # The vehicle's owner surname.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :owner_surname
+          # The vehicle engine's displacement (cm3).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :p1
+          # The vehicle's maximum net power (kW).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :p2
+          # The vehicle's fuel type or energy source.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :p3
+          # The vehicle's administrative power (fiscal horsepower).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :p6
+          # The vehicle's power to weight ratio.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :q
+          # The vehicle's number of seats.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :s1
+          # The vehicle's number of standing rooms (person).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :s2
+          # The vehicle's sound level (dB).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :u1
+          # The vehicle engine's rotation speed (RPM).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :u2
+          # The vehicle's CO2 emission (g/km).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :v7
+          # Next technical control date.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :x1
+          # Amount of the regional proportional tax of the registration (in euros).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :y1
+          # Amount of the additional parafiscal tax of the registration (in euros).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :y2
+          # Amount of the additional CO2 tax of the registration (in euros).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :y3
+          # Amount of the fee for managing the registration (in euros).
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :y4
+          # Amount of the fee for delivery of the registration certificate in euros.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :y5
+          # Total amount of registration fee to be paid in euros.
+          # @return [Mindee::Parsing::Standard::StringField]
+          attr_reader :y6
+
+          # rubocop:disable Metrics/AbcSize
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @a = StringField.new(prediction['a'], page_id)
+            @b = DateField.new(prediction['b'], page_id)
+            @c1 = StringField.new(prediction['c1'], page_id)
+            @c3 = StringField.new(prediction['c3'], page_id)
+            @c41 = StringField.new(prediction['c41'], page_id)
+            @c4a = StringField.new(prediction['c4a'], page_id)
+            @d1 = StringField.new(prediction['d1'], page_id)
+            @d3 = StringField.new(prediction['d3'], page_id)
+            @e = StringField.new(prediction['e'], page_id)
+            @f1 = StringField.new(prediction['f1'], page_id)
+            @f2 = StringField.new(prediction['f2'], page_id)
+            @f3 = StringField.new(prediction['f3'], page_id)
+            @formula_number = StringField.new(prediction['formula_number'], page_id)
+            @g = StringField.new(prediction['g'], page_id)
+            @g1 = StringField.new(prediction['g1'], page_id)
+            @i = DateField.new(prediction['i'], page_id)
+            @j = StringField.new(prediction['j'], page_id)
+            @j1 = StringField.new(prediction['j1'], page_id)
+            @j2 = StringField.new(prediction['j2'], page_id)
+            @j3 = StringField.new(prediction['j3'], page_id)
+            @mrz1 = StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = StringField.new(prediction['mrz2'], page_id)
+            @owner_first_name = StringField.new(prediction['owner_first_name'], page_id)
+            @owner_surname = StringField.new(prediction['owner_surname'], page_id)
+            @p1 = StringField.new(prediction['p1'], page_id)
+            @p2 = StringField.new(prediction['p2'], page_id)
+            @p3 = StringField.new(prediction['p3'], page_id)
+            @p6 = StringField.new(prediction['p6'], page_id)
+            @q = StringField.new(prediction['q'], page_id)
+            @s1 = StringField.new(prediction['s1'], page_id)
+            @s2 = StringField.new(prediction['s2'], page_id)
+            @u1 = StringField.new(prediction['u1'], page_id)
+            @u2 = StringField.new(prediction['u2'], page_id)
+            @v7 = StringField.new(prediction['v7'], page_id)
+            @x1 = StringField.new(prediction['x1'], page_id)
+            @y1 = StringField.new(prediction['y1'], page_id)
+            @y2 = StringField.new(prediction['y2'], page_id)
+            @y3 = StringField.new(prediction['y3'], page_id)
+            @y4 = StringField.new(prediction['y4'], page_id)
+            @y5 = StringField.new(prediction['y5'], page_id)
+            @y6 = StringField.new(prediction['y6'], page_id)
+          end
+
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n:a: #{@a}".rstrip
+            out_str << "\n:b: #{@b}".rstrip
+            out_str << "\n:c1: #{@c1}".rstrip
+            out_str << "\n:c3: #{@c3}".rstrip
+            out_str << "\n:c41: #{@c41}".rstrip
+            out_str << "\n:c4a: #{@c4a}".rstrip
+            out_str << "\n:d1: #{@d1}".rstrip
+            out_str << "\n:d3: #{@d3}".rstrip
+            out_str << "\n:e: #{@e}".rstrip
+            out_str << "\n:f1: #{@f1}".rstrip
+            out_str << "\n:f2: #{@f2}".rstrip
+            out_str << "\n:f3: #{@f3}".rstrip
+            out_str << "\n:g: #{@g}".rstrip
+            out_str << "\n:g1: #{@g1}".rstrip
+            out_str << "\n:i: #{@i}".rstrip
+            out_str << "\n:j: #{@j}".rstrip
+            out_str << "\n:j1: #{@j1}".rstrip
+            out_str << "\n:j2: #{@j2}".rstrip
+            out_str << "\n:j3: #{@j3}".rstrip
+            out_str << "\n:p1: #{@p1}".rstrip
+            out_str << "\n:p2: #{@p2}".rstrip
+            out_str << "\n:p3: #{@p3}".rstrip
+            out_str << "\n:p6: #{@p6}".rstrip
+            out_str << "\n:q: #{@q}".rstrip
+            out_str << "\n:s1: #{@s1}".rstrip
+            out_str << "\n:s2: #{@s2}".rstrip
+            out_str << "\n:u1: #{@u1}".rstrip
+            out_str << "\n:u2: #{@u2}".rstrip
+            out_str << "\n:v7: #{@v7}".rstrip
+            out_str << "\n:x1: #{@x1}".rstrip
+            out_str << "\n:y1: #{@y1}".rstrip
+            out_str << "\n:y2: #{@y2}".rstrip
+            out_str << "\n:y3: #{@y3}".rstrip
+            out_str << "\n:y4: #{@y4}".rstrip
+            out_str << "\n:y5: #{@y5}".rstrip
+            out_str << "\n:y6: #{@y6}".rstrip
+            out_str << "\n:Formula Number: #{@formula_number}".rstrip
+            out_str << "\n:Owner's First Name: #{@owner_first_name}".rstrip
+            out_str << "\n:Owner's Surname: #{@owner_surname}".rstrip
+            out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
+            out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
+            out_str[1..].to_s
+          end
+          # rubocop:enable Metrics/AbcSize
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'carte_grise_v1_document'
+
+module Mindee
+  module Product
+    module FR
+      module CarteGrise
+        # Carte Grise V1 page.
+        class CarteGriseV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = CarteGriseV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Carte Grise V1 page prediction.
+        class CarteGriseV1PagePrediction < CarteGriseV1Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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]