mindee 3.4.0 → 3.5.0

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module InternationalId
+      # International ID V2 document prediction.
+      class InternationalIdV2Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The physical address of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :address
+        # The date of birth of the document holder.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :birth_date
+        # The place of birth of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :birth_place
+        # The country where the document was issued.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :country_of_issue
+        # The unique identifier assigned to the document.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :document_number
+        # The type of personal identification document.
+        # @return [Mindee::Parsing::Standard::ClassificationField]
+        attr_reader :document_type
+        # The date when the document becomes invalid.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :expiry_date
+        # The list of the document holder's given names.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :given_names
+        # The date when the document was issued.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :issue_date
+        # The Machine Readable Zone, first line.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz_line1
+        # The Machine Readable Zone, second line.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz_line2
+        # The Machine Readable Zone, third line.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz_line3
+        # The country of citizenship of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :nationality
+        # The unique identifier assigned to the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :personal_number
+        # The biological sex of the document holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :sex
+        # The state or territory where the document was issued.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :state_of_issue
+        # The list of the document holder's family names.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :surnames
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @address = StringField.new(prediction['address'], page_id)
+          @birth_date = DateField.new(prediction['birth_date'], page_id)
+          @birth_place = StringField.new(prediction['birth_place'], page_id)
+          @country_of_issue = StringField.new(prediction['country_of_issue'], page_id)
+          @document_number = StringField.new(prediction['document_number'], page_id)
+          @document_type = ClassificationField.new(prediction['document_type'], page_id)
+          @expiry_date = DateField.new(prediction['expiry_date'], 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)
+          @mrz_line1 = StringField.new(prediction['mrz_line1'], page_id)
+          @mrz_line2 = StringField.new(prediction['mrz_line2'], page_id)
+          @mrz_line3 = StringField.new(prediction['mrz_line3'], page_id)
+          @nationality = StringField.new(prediction['nationality'], page_id)
+          @personal_number = StringField.new(prediction['personal_number'], page_id)
+          @sex = StringField.new(prediction['sex'], page_id)
+          @state_of_issue = StringField.new(prediction['state_of_issue'], page_id)
+          @surnames = []
+          prediction['surnames'].each do |item|
+            @surnames.push(StringField.new(item, page_id))
+          end
+        end
+
+        # @return [String]
+        def to_s
+          surnames = @surnames.join("\n #{' ' * 10}")
+          given_names = @given_names.join("\n #{' ' * 13}")
+          out_str = String.new
+          out_str << "\n:Document Type: #{@document_type}".rstrip
+          out_str << "\n:Document Number: #{@document_number}".rstrip
+          out_str << "\n:Surnames: #{surnames}".rstrip
+          out_str << "\n:Given Names: #{given_names}".rstrip
+          out_str << "\n:Sex: #{@sex}".rstrip
+          out_str << "\n:Birth Date: #{@birth_date}".rstrip
+          out_str << "\n:Birth Place: #{@birth_place}".rstrip
+          out_str << "\n:Nationality: #{@nationality}".rstrip
+          out_str << "\n:Personal Number: #{@personal_number}".rstrip
+          out_str << "\n:Country of Issue: #{@country_of_issue}".rstrip
+          out_str << "\n:State of Issue: #{@state_of_issue}".rstrip
+          out_str << "\n:Issue Date: #{@issue_date}".rstrip
+          out_str << "\n:Expiration Date: #{@expiry_date}".rstrip
+          out_str << "\n:Address: #{@address}".rstrip
+          out_str << "\n:MRZ Line 1: #{@mrz_line1}".rstrip
+          out_str << "\n:MRZ Line 2: #{@mrz_line2}".rstrip
+          out_str << "\n:MRZ Line 3: #{@mrz_line3}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'international_id_v2_document'
+
+module Mindee
+  module Product
+    module InternationalId
+      # International ID V2 page.
+      class InternationalIdV2Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = InternationalIdV2PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # International ID V2 page prediction.
+      class InternationalIdV2PagePrediction < InternationalIdV2Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,9 @@ module Mindee
           @prediction = InvoiceV4Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(InvoiceV4Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(InvoiceV4Page.new(page))
+            end
           end
         end
 

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

@@ -19,7 +19,9 @@ module Mindee
           @prediction = MultiReceiptsDetectorV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(MultiReceiptsDetectorV1Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(MultiReceiptsDetectorV1Page.new(page))
+            end
           end
         end
 

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

@@ -19,7 +19,9 @@ module Mindee
           @prediction = PassportV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(PassportV1Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(PassportV1Page.new(page))
+            end
           end
         end
 

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

@@ -19,7 +19,9 @@ module Mindee
           @prediction = ProofOfAddressV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(ProofOfAddressV1Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(ProofOfAddressV1Page.new(page))
+            end
           end
         end
 

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

@@ -19,7 +19,9 @@ module Mindee
           @prediction = ReceiptV5Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            @pages.push(ReceiptV5Page.new(page))
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(ReceiptV5Page.new(page))
+            end
           end
         end
 

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

@@ -20,7 +20,9 @@ module Mindee
             @prediction = BankCheckV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(BankCheckV1Page.new(page))
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(BankCheckV1Page.new(page))
+              end
             end
           end
 

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

@@ -20,7 +20,9 @@ module Mindee
             @prediction = DriverLicenseV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(DriverLicenseV1Page.new(page))
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(DriverLicenseV1Page.new(page))
+              end
             end
           end
 

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

@@ -20,7 +20,9 @@ module Mindee
             @prediction = W9V1Document.new
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(W9V1Page.new(page))
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(W9V1Page.new(page))
+              end
             end
           end
 

data/lib/mindee/product.rb

@@ -11,13 +11,18 @@ require_relative 'product/passport/passport_v1'
 require_relative 'product/receipt/receipt_v4'
 require_relative 'product/receipt/receipt_v5'
 require_relative 'product/eu/license_plate/license_plate_v1'
+require_relative 'product/eu/driver_license/driver_license_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
+require_relative 'product/fr/bank_statement/bank_statement_v1'
 require_relative 'product/fr/carte_vitale/carte_vitale_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/fr/carte_grise/carte_grise_v1'
+require_relative 'product/generated/generated_v1'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
+require_relative 'product/international_id/international_id_v1'
+require_relative 'product/international_id/international_id_v2'
 require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'
 require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

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

data/lib/mindee.rb

@@ -31,6 +31,10 @@ module Mindee
     # Standard fields and functions.
     module Standard
     end
+
+    # Generated fields and functions.
+    module Generated
+    end
   end
 
   # Document input-related internals.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -119,23 +119,29 @@ files:
 - bin/mindee.rb
 - docs/bank_account_details_v2.md
 - docs/bank_check_v1.md
+- docs/bank_statement_fr_v1.md
 - docs/barcode_reader_v1.md
 - docs/carte_grise_v1.md
 - docs/carte_vitale_v1.md
 - docs/code_samples/bank_account_details_v1.txt
 - docs/code_samples/bank_account_details_v2.txt
 - docs/code_samples/bank_check_v1.txt
+- docs/code_samples/bank_statement_fr_v1_async.txt
 - docs/code_samples/barcode_reader_v1.txt
 - docs/code_samples/carte_grise_v1.txt
 - docs/code_samples/carte_vitale_v1.txt
 - docs/code_samples/cropper_v1.txt
 - docs/code_samples/custom_v1.txt
 - docs/code_samples/default.txt
+- docs/code_samples/default_async.txt
+- docs/code_samples/eu_driver_license_v1.txt
 - docs/code_samples/expense_receipts_v4.txt
 - docs/code_samples/expense_receipts_v5.txt
 - docs/code_samples/financial_document_v1.txt
 - docs/code_samples/idcard_fr_v1.txt
 - docs/code_samples/idcard_fr_v2.txt
+- docs/code_samples/international_id_v1_async.txt
+- docs/code_samples/international_id_v2_async.txt
 - docs/code_samples/invoice_splitter_v1_async.txt
 - docs/code_samples/invoices_v4.txt
 - docs/code_samples/license_plates_v1.txt
@@ -146,8 +152,10 @@ files:
 - docs/code_samples/us_w9_v1.txt
 - docs/cropper_v1.md
 - docs/custom_v1.md
+- docs/eu_driver_license_v1.md
 - docs/expense_receipts_v5.md
 - docs/financial_document_v1.md
+- docs/generated_v1.md
 - docs/getting_started.md
 - docs/idcard_fr_v2.md
 - docs/invoice_splitter_v1.md
@@ -187,6 +195,9 @@ files:
 - lib/mindee/parsing/custom.rb
 - lib/mindee/parsing/custom/classification_field.rb
 - lib/mindee/parsing/custom/list_field.rb
+- lib/mindee/parsing/generated.rb
+- lib/mindee/parsing/generated/generated_list_field.rb
+- lib/mindee/parsing/generated/generated_object_field.rb
 - lib/mindee/parsing/standard.rb
 - lib/mindee/parsing/standard/amount_field.rb
 - lib/mindee/parsing/standard/base_field.rb
@@ -212,6 +223,9 @@ files:
 - lib/mindee/product/custom/custom_v1.rb
 - lib/mindee/product/custom/custom_v1_document.rb
 - lib/mindee/product/custom/custom_v1_page.rb
+- lib/mindee/product/eu/driver_license/driver_license_v1.rb
+- lib/mindee/product/eu/driver_license/driver_license_v1_document.rb
+- lib/mindee/product/eu/driver_license/driver_license_v1_page.rb
 - lib/mindee/product/eu/license_plate/license_plate_v1.rb
 - lib/mindee/product/eu/license_plate/license_plate_v1_document.rb
 - lib/mindee/product/eu/license_plate/license_plate_v1_page.rb
@@ -226,6 +240,10 @@ files:
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rb
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb
 - lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1_document.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1_page.rb
+- lib/mindee/product/fr/bank_statement/bank_statement_v1_transaction.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb
@@ -238,6 +256,16 @@ files:
 - lib/mindee/product/fr/id_card/id_card_v2.rb
 - lib/mindee/product/fr/id_card/id_card_v2_document.rb
 - lib/mindee/product/fr/id_card/id_card_v2_page.rb
+- lib/mindee/product/generated/generated_v1.rb
+- lib/mindee/product/generated/generated_v1_document.rb
+- lib/mindee/product/generated/generated_v1_page.rb
+- lib/mindee/product/generated/generated_v1_prediction.rb
+- lib/mindee/product/international_id/international_id_v1.rb
+- lib/mindee/product/international_id/international_id_v1_document.rb
+- lib/mindee/product/international_id/international_id_v1_page.rb
+- lib/mindee/product/international_id/international_id_v2.rb
+- lib/mindee/product/international_id/international_id_v2_document.rb
+- lib/mindee/product/international_id/international_id_v2_page.rb
 - lib/mindee/product/invoice/invoice_v4.rb
 - lib/mindee/product/invoice/invoice_v4_document.rb
 - lib/mindee/product/invoice/invoice_v4_line_item.rb