mindee 3.1.0 → 3.2.0

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

@@ -11,7 +11,7 @@ module Mindee
         include Mindee::Parsing::Standard
 
         # Locale information.
-        # @return [Mindee::Parsing::Standard::Locale]
+        # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
         # The nature of the invoice.
         # @return [Mindee::Parsing::Standard::ClassificationField]
@@ -29,10 +29,10 @@ module Mindee
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :date
         # The invoice number.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :invoice_number
         # List of Reference numbers including PO number.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :reference_numbers
         # The due date of the invoice.
         # @return [Mindee::Parsing::Standard::DateField]
@@ -41,25 +41,25 @@ module Mindee
         # @return [Mindee::Parsing::Standard::Taxes]
         attr_reader :taxes
         # The name of the customer.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_name
         # The address of the customer.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_address
         # The company registration information for the customer.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :customer_company_registrations
         # The supplier's name.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_name
         # The supplier's address.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_address
         # The payment information.
-        # @return [Array<Mindee::Parsing::Standard::PaymentDetails>]
+        # @return [Array<Mindee::Parsing::Standard::PaymentDetailsField>]
         attr_reader :supplier_payment_details
         # The supplier's company registration information.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :supplier_company_registrations
         # Line items details.
         # @return [Array<Mindee::InvoiceV4LineItem>]
@@ -69,33 +69,33 @@ module Mindee
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
           super()
-          @locale = Locale.new(prediction['locale'])
+          @locale = LocaleField.new(prediction['locale'])
           @document_type = ClassificationField.new(prediction['document_type'], page_id)
           @total_amount = AmountField.new(prediction['total_amount'], page_id)
           @total_net = AmountField.new(prediction['total_net'], page_id)
-          @customer_address = TextField.new(prediction['customer_address'], page_id)
-          @customer_name = TextField.new(prediction['customer_name'], page_id)
+          @customer_address = StringField.new(prediction['customer_address'], page_id)
+          @customer_name = StringField.new(prediction['customer_name'], page_id)
           @date = DateField.new(prediction['date'], page_id)
           @due_date = DateField.new(prediction['due_date'], page_id)
-          @invoice_number = TextField.new(prediction['invoice_number'], page_id)
-          @supplier_name = TextField.new(prediction['supplier_name'], page_id)
-          @supplier_address = TextField.new(prediction['supplier_address'], page_id)
+          @invoice_number = StringField.new(prediction['invoice_number'], page_id)
+          @supplier_name = StringField.new(prediction['supplier_name'], page_id)
+          @supplier_address = StringField.new(prediction['supplier_address'], 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
           @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
           @taxes = Taxes.new(prediction['taxes'], 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_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
           @total_tax = AmountField.new(
             { value: nil, confidence: 0.0 }, page_id
@@ -168,7 +168,7 @@ module Mindee
 
           total_excl = {
             'value' => @total_amount.value - @taxes.map(&:value).sum,
-            'confidence' => TextField.array_confidence(@taxes) * @total_amount.confidence,
+            'confidence' => StringField.array_confidence(@taxes) * @total_amount.confidence,
           }
           @total_net = AmountField.new(total_excl, page_id, reconstructed: true)
         end
@@ -178,7 +178,7 @@ module Mindee
 
           total_incl = {
             'value' => @taxes.map(&:value).sum + @total_net.value,
-            'confidence' => TextField.array_confidence(@taxes) * @total_net.confidence,
+            'confidence' => StringField.array_confidence(@taxes) * @total_net.confidence,
           }
           @total_amount = AmountField.new(total_incl, page_id, reconstructed: true)
         end
@@ -188,7 +188,7 @@ module Mindee
 
           total_tax = {
             'value' => @taxes.map(&:value).sum,
-            'confidence' => TextField.array_confidence(@taxes),
+            'confidence' => StringField.array_confidence(@taxes),
           }
           return unless total_tax['value'].positive?
 
@@ -200,7 +200,7 @@ module Mindee
 
           total_tax = {
             'value' => @total_amount.value - @total_net.value,
-            'confidence' => TextField.array_confidence(@taxes),
+            'confidence' => StringField.array_confidence(@taxes),
           }
           return unless total_tax['value'] >= 0
 

data/lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb

@@ -6,6 +6,7 @@ require_relative 'invoice_splitter_v1_page'
 
 module Mindee
   module Product
+    # Invoice Splitter module.
     module InvoiceSplitter
       # Invoice Splitter V1 prediction inference.
       class InvoiceSplitterV1 < Mindee::Parsing::Common::Inference

data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_document.rb

@@ -6,7 +6,7 @@ module Mindee
   module Product
     module InvoiceSplitter
       # Page Group for Invoice Splitter class
-      class PageGroup
+      class InvoiceSplitterV1PageGroup
         # @return[Array<Integer>]
         attr_reader :page_indexes
 
@@ -29,7 +29,7 @@ module Mindee
 
       # Invoice Splitter V1 document prediction.
       class InvoiceSplitterV1Document < Mindee::Parsing::Common::Prediction
-        # @return[Array<Mindee::Product::PageGroup>]
+        # @return[Array<Mindee::Product::InvoiceSplitterV1PageGroup>]
         attr_reader :invoice_page_groups
 
         # @param prediction [Hash]
@@ -39,12 +39,14 @@ module Mindee
           construct_invoice_page_groups_from_prediction(prediction)
         end
 
+        # Reconstructs the page groups of a prediction
+        # @param prediction [hash]
         def construct_invoice_page_groups_from_prediction(prediction)
           @invoice_page_groups = []
           return unless prediction.key?('invoice_page_groups') && prediction['invoice_page_groups'].any?
 
           prediction['invoice_page_groups'].each do |page_group_prediction|
-            @invoice_page_groups.append(PageGroup.new(page_group_prediction))
+            @invoice_page_groups.append(InvoiceSplitterV1PageGroup.new(page_group_prediction))
           end
         end
 

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'multi_receipts_detector_v1_document'
+require_relative 'multi_receipts_detector_v1_page'
+
+module Mindee
+  module Product
+    # Multi Receipts Detector module.
+    module MultiReceiptsDetector
+      # Multi Receipts Detector V1 prediction inference.
+      class MultiReceiptsDetectorV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'multi_receipts_detector'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = MultiReceiptsDetectorV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            @pages.push(MultiReceiptsDetectorV1Page.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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module MultiReceiptsDetector
+      # Multi Receipts Detector V1 document prediction.
+      class MultiReceiptsDetectorV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # Positions of the receipts on the document.
+        # @return [Array<Mindee::Parsing::Standard::PositionField>]
+        attr_reader :receipts
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @receipts = []
+          prediction['receipts'].each do |item|
+            @receipts.push(PositionField.new(item, page_id))
+          end
+        end
+
+        # @return [String]
+        def to_s
+          receipts = @receipts.join("\n #{' ' * 18}")
+          out_str = String.new
+          out_str << "\n:List of Receipts: #{receipts}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'multi_receipts_detector_v1_document'
+
+module Mindee
+  module Product
+    module MultiReceiptsDetector
+      # Multi Receipts Detector V1 page.
+      class MultiReceiptsDetectorV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = MultiReceiptsDetectorV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Multi Receipts Detector V1 page prediction.
+      class MultiReceiptsDetectorV1PagePrediction < MultiReceiptsDetectorV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ require_relative 'passport_v1_page'
 
 module Mindee
   module Product
+    # Passport module.
     module Passport
       # Passport V1 prediction inference.
       class PassportV1 < Mindee::Parsing::Common::Inference

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

@@ -12,34 +12,34 @@ module Mindee
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :birth_date
         # The place of birth of the passport holder.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :birth_place
         # The country's 3 letter code (ISO 3166-1 alpha-3).
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :country
         # The expiry date of the passport.
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :expiry_date
         # The gender of the passport holder.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :gender
         # The given name(s) of the passport holder.
-        # @return [Array<Mindee::Parsing::Standard::TextField>]
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :given_names
         # The passport's identification number.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :id_number
         # The date the passport was issued.
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :issuance_date
         # 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 passport holder.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :surname
 
         # @param prediction [Hash]
@@ -47,19 +47,19 @@ module Mindee
         def initialize(prediction, page_id)
           super()
           @birth_date = DateField.new(prediction['birth_date'], page_id)
-          @birth_place = TextField.new(prediction['birth_place'], page_id)
-          @country = TextField.new(prediction['country'], page_id)
+          @birth_place = StringField.new(prediction['birth_place'], page_id)
+          @country = StringField.new(prediction['country'], 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)
+          @id_number = StringField.new(prediction['id_number'], page_id)
           @issuance_date = DateField.new(prediction['issuance_date'], page_id)
-          @mrz1 = TextField.new(prediction['mrz1'], page_id)
-          @mrz2 = TextField.new(prediction['mrz2'], page_id)
-          @surname = TextField.new(prediction['surname'], 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/proof_of_address/proof_of_address_v1.rb

@@ -6,6 +6,7 @@ require_relative 'proof_of_address_v1_page'
 
 module Mindee
   module Product
+    # Proof of Address module.
     module ProofOfAddress
       # Proof of Address V1 prediction inference.
       class ProofOfAddressV1 < Mindee::Parsing::Common::Inference

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

@@ -15,25 +15,25 @@ module Mindee
         # @return [Array<Mindee::Parsing::Standard::DateField>]
         attr_reader :dates
         # The address of the document's issuer.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :issuer_address
         # List of company registrations found for the issuer.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :issuer_company_registration
         # The name of the person or company issuing the document.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :issuer_name
         # The locale detected on the document.
-        # @return [Mindee::Parsing::Standard::Locale]
+        # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
         # The address of the recipient.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :recipient_address
         # List of company registrations found for the recipient.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistration>]
+        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :recipient_company_registration
         # The name of the person or company receiving the document.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :recipient_name
 
         # @param prediction [Hash]
@@ -45,19 +45,19 @@ module Mindee
           prediction['dates'].each do |item|
             @dates.push(DateField.new(item, page_id))
           end
-          @issuer_address = TextField.new(prediction['issuer_address'], page_id)
+          @issuer_address = StringField.new(prediction['issuer_address'], page_id)
           @issuer_company_registration = []
           prediction['issuer_company_registration'].each do |item|
-            @issuer_company_registration.push(CompanyRegistration.new(item, page_id))
+            @issuer_company_registration.push(CompanyRegistrationField.new(item, page_id))
           end
-          @issuer_name = TextField.new(prediction['issuer_name'], page_id)
-          @locale = Locale.new(prediction['locale'], page_id)
-          @recipient_address = TextField.new(prediction['recipient_address'], page_id)
+          @issuer_name = StringField.new(prediction['issuer_name'], page_id)
+          @locale = LocaleField.new(prediction['locale'], page_id)
+          @recipient_address = StringField.new(prediction['recipient_address'], page_id)
           @recipient_company_registration = []
           prediction['recipient_company_registration'].each do |item|
-            @recipient_company_registration.push(CompanyRegistration.new(item, page_id))
+            @recipient_company_registration.push(CompanyRegistrationField.new(item, page_id))
           end
-          @recipient_name = TextField.new(prediction['recipient_name'], page_id)
+          @recipient_name = StringField.new(prediction['recipient_name'], page_id)
         end
 
         # @return [String]

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

@@ -9,7 +9,7 @@ module Mindee
       class ReceiptV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # Where the purchase was made, the language, and the currency.
-        # @return [Mindee::Parsing::Standard::Locale]
+        # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
         # Total including taxes
         # @return [Mindee::Parsing::Standard::AmountField]
@@ -24,13 +24,13 @@ module Mindee
         # @return [Mindee::Parsing::Standard::DateField]
         attr_reader :date
         # The name of the supplier or merchant, as seen on the receipt.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier
         # List of taxes detected on the receipt.
         # @return [Mindee::Parsing::Standard::Taxes]
         attr_reader :taxes
         # Time as seen on the receipt in HH:MM format.
-        # @return [Mindee::Parsing::Standard::TextField]
+        # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :time
         # The receipt category among predefined classes.
         # @return [Mindee::Parsing::Standard::ClassificationField]
@@ -49,7 +49,7 @@ module Mindee
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
           super()
-          @locale = Locale.new(prediction['locale'])
+          @locale = LocaleField.new(prediction['locale'])
           @total_amount = AmountField.new(prediction['total_amount'], page_id)
           @total_net = AmountField.new(prediction['total_net'], page_id)
           @total_tax = AmountField.new(prediction['total_tax'], page_id)
@@ -58,8 +58,8 @@ module Mindee
           @category = ClassificationField.new(prediction['category'], page_id)
           @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
           @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @supplier = TextField.new(prediction['supplier'], page_id)
-          @time = TextField.new(prediction['time'], page_id)
+          @supplier = StringField.new(prediction['supplier'], page_id)
+          @time = StringField.new(prediction['time'], page_id)
           @taxes = Taxes.new(prediction['taxes'], page_id)
         end
 

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

@@ -6,6 +6,7 @@ require_relative 'receipt_v5_page'
 
 module Mindee
   module Product
+    # Receipt module.
     module Receipt
       # Receipt V5 prediction inference.
       class ReceiptV5 < Mindee::Parsing::Common::Inference

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

@@ -22,28 +22,28 @@ module Mindee
         # @return [Array<Mindee::Product::Receipt::ReceiptV5LineItem>]
         attr_reader :line_items
         # The locale detected on the document.
-        # @return [Mindee::Parsing::Standard::Locale]
+        # @return [Mindee::Parsing::Standard::LocaleField]
         attr_reader :locale
         # 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
         # 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]
@@ -69,17 +69,17 @@ module Mindee
           prediction['line_items'].each do |item|
             @line_items.push(ReceiptV5LineItem.new(item, page_id))
           end
-          @locale = Locale.new(prediction['locale'], page_id)
+          @locale = LocaleField.new(prediction['locale'], page_id)
           @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_phone_number = TextField.new(prediction['supplier_phone_number'], page_id)
+          @supplier_name = StringField.new(prediction['supplier_name'], 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/us/bank_check/bank_check_v1.rb

@@ -7,6 +7,7 @@ require_relative 'bank_check_v1_page'
 module Mindee
   module Product
     module US
+      # Bank Check module.
       module BankCheck
         # Bank Check V1 prediction inference.
         class BankCheckV1 < Mindee::Parsing::Common::Inference

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

@@ -10,37 +10,37 @@ module Mindee
         class BankCheckV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
           # The check payer's account number.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :account_number
           # The amount of the check.
           # @return [Mindee::Parsing::Standard::AmountField]
           attr_reader :amount
           # The issuer's check number.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :check_number
           # The date the check was issued.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :date
           # List of the check's payees (recipients).
-          # @return [Array<Mindee::Parsing::Standard::TextField>]
+          # @return [Array<Mindee::Parsing::Standard::StringField>]
           attr_reader :payees
           # The check issuer's routing number.
-          # @return [Mindee::Parsing::Standard::TextField]
+          # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :routing_number
 
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
             super()
-            @account_number = TextField.new(prediction['account_number'], page_id)
+            @account_number = StringField.new(prediction['account_number'], page_id)
             @amount = AmountField.new(prediction['amount'], page_id)
-            @check_number = TextField.new(prediction['check_number'], page_id)
+            @check_number = StringField.new(prediction['check_number'], page_id)
             @date = DateField.new(prediction['date'], page_id)
             @payees = []
             prediction['payees'].each do |item|
-              @payees.push(TextField.new(item, page_id))
+              @payees.push(StringField.new(item, page_id))
             end
-            @routing_number = TextField.new(prediction['routing_number'], page_id)
+            @routing_number = StringField.new(prediction['routing_number'], page_id)
           end
 
           # @return [String]

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

@@ -7,6 +7,7 @@ require_relative 'driver_license_v1_page'
 module Mindee
   module Product
     module US
+      # Driver License module.
       module DriverLicense
         # Driver License V1 prediction inference.
         class DriverLicenseV1 < Mindee::Parsing::Common::Inference