mindee 4.13.0 → 5.0.0.rc1

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v1_document'
+require_relative 'id_card_v1_page'
+
+module Mindee
+  module V1
+    module Product
+      module FR
+        # Carte Nationale d'Identité module.
+        module IdCard
+          # Carte Nationale d'Identité API version 1 inference prediction.
+          class IdCardV1 < Mindee::V1::Parsing::Common::Inference
+            @endpoint_name = 'idcard_fr'
+            @endpoint_version = '1'
+            @has_async = false
+            @has_sync = true
+
+            # @param prediction [Hash]
+            def initialize(prediction)
+              super
+              @prediction = IdCardV1Document.new(prediction['prediction'], nil)
+              @pages = []
+              prediction['pages'].each do |page|
+                @pages.push(IdCardV1Page.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
+              # Whether this product has access to an asynchronous endpoint.
+              # @return [bool]
+              attr_reader :has_async
+              # Whether this product has access to synchronous endpoint.
+              # @return [bool]
+              attr_reader :has_sync
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module FR
+        module IdCard
+          # Carte Nationale d'Identité API version 1.1 document data.
+          class IdCardV1Document < Mindee::V1::Parsing::Common::Prediction
+            include Mindee::V1::Parsing::Standard
+
+            # The name of the issuing authority.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :authority
+            # The date of birth of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::DateField]
+            attr_reader :birth_date
+            # The place of birth of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :birth_place
+            # The expiry date of the identification card.
+            # @return [Mindee::V1::Parsing::Standard::DateField]
+            attr_reader :expiry_date
+            # The gender of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :gender
+            # The given name(s) of the card holder.
+            # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+            attr_reader :given_names
+            # The identification card number.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :id_number
+            # Machine Readable Zone, first line
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :mrz1
+            # Machine Readable Zone, second line
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :mrz2
+            # The surname of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :surname
+
+            # @param prediction [Hash]
+            # @param page_id [Integer, nil]
+            def initialize(prediction, page_id)
+              super
+              @authority = Parsing::Standard::StringField.new(
+                prediction['authority'],
+                page_id
+              )
+              @birth_date = Parsing::Standard::DateField.new(
+                prediction['birth_date'],
+                page_id
+              )
+              @birth_place = Parsing::Standard::StringField.new(
+                prediction['birth_place'],
+                page_id
+              )
+              @expiry_date = Parsing::Standard::DateField.new(
+                prediction['expiry_date'],
+                page_id
+              )
+              @gender = Parsing::Standard::StringField.new(
+                prediction['gender'],
+                page_id
+              )
+              @given_names = [] # : Array[Parsing::Standard::StringField]
+              prediction['given_names'].each do |item|
+                @given_names.push(Parsing::Standard::StringField.new(item, page_id))
+              end
+              @id_number = Parsing::Standard::StringField.new(
+                prediction['id_number'],
+                page_id
+              )
+              @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
+              @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
+              @surname = Parsing::Standard::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:Identity Number: #{@id_number}".rstrip
+              out_str << "\n:Given Name(s): #{given_names}".rstrip
+              out_str << "\n:Surname: #{@surname}".rstrip
+              out_str << "\n:Date of Birth: #{@birth_date}".rstrip
+              out_str << "\n:Place of Birth: #{@birth_place}".rstrip
+              out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+              out_str << "\n:Issuing Authority: #{@authority}".rstrip
+              out_str << "\n:Gender: #{@gender}".rstrip
+              out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
+              out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
+              out_str[1..].to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v1_document'
+
+module Mindee
+  module V1
+    module Product
+      module FR
+        module IdCard
+          # Carte Nationale d'Identité API version 1.1 page data.
+          class IdCardV1Page < Mindee::V1::Parsing::Common::Page
+            # @param prediction [Hash]
+            def initialize(prediction)
+              super
+              @prediction = if prediction['prediction'].empty?
+                              nil
+                            else
+                              IdCardV1PagePrediction.new(
+                                prediction['prediction'],
+                                prediction['id']
+                              )
+                            end
+            end
+          end
+
+          # Carte Nationale d'Identité V1 page prediction.
+          class IdCardV1PagePrediction < IdCardV1Document
+            include Mindee::V1::Parsing::Standard
+
+            # The side of the document which is visible.
+            # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+            attr_reader :document_side
+
+            # @param prediction [Hash]
+            # @param page_id [Integer, nil]
+            def initialize(prediction, page_id)
+              @document_side = Parsing::Standard::ClassificationField.new(
+                prediction['document_side'],
+                page_id
+              )
+              super
+            end
+
+            # @return [String]
+            def to_s
+              out_str = String.new
+              out_str << "\n:Document Side: #{@document_side}".rstrip
+              out_str << "\n#{super}"
+              out_str
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v2_document'
+require_relative 'id_card_v2_page'
+
+module Mindee
+  module V1
+    module Product
+      module FR
+        # Carte Nationale d'Identité module.
+        module IdCard
+          # Carte Nationale d'Identité API version 2 inference prediction.
+          class IdCardV2 < Mindee::V1::Parsing::Common::Inference
+            @endpoint_name = 'idcard_fr'
+            @endpoint_version = '2'
+            @has_async = false
+            @has_sync = true
+
+            # @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
+              # Whether this product has access to an asynchronous endpoint.
+              # @return [bool]
+              attr_reader :has_async
+              # Whether this product has access to synchronous endpoint.
+              # @return [bool]
+              attr_reader :has_sync
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module FR
+        module IdCard
+          # Carte Nationale d'Identité API version 2.0 document data.
+          class IdCardV2Document < Mindee::V1::Parsing::Common::Prediction
+            include Mindee::V1::Parsing::Standard
+
+            # The alternate name of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :alternate_name
+            # The name of the issuing authority.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :authority
+            # The date of birth of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::DateField]
+            attr_reader :birth_date
+            # The place of birth of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :birth_place
+            # The card access number (CAN).
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :card_access_number
+            # The document number.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :document_number
+            # The expiry date of the identification card.
+            # @return [Mindee::V1::Parsing::Standard::DateField]
+            attr_reader :expiry_date
+            # The gender of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :gender
+            # The given name(s) of the card holder.
+            # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+            attr_reader :given_names
+            # The date of issue of the identification card.
+            # @return [Mindee::V1::Parsing::Standard::DateField]
+            attr_reader :issue_date
+            # The Machine Readable Zone, first line.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :mrz1
+            # The Machine Readable Zone, second line.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :mrz2
+            # The Machine Readable Zone, third line.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :mrz3
+            # The nationality of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :nationality
+            # The surname of the card holder.
+            # @return [Mindee::V1::Parsing::Standard::StringField]
+            attr_reader :surname
+
+            # @param prediction [Hash]
+            # @param page_id [Integer, nil]
+            def initialize(prediction, page_id)
+              super
+              @alternate_name = Parsing::Standard::StringField.new(
+                prediction['alternate_name'],
+                page_id
+              )
+              @authority = Parsing::Standard::StringField.new(
+                prediction['authority'],
+                page_id
+              )
+              @birth_date = Parsing::Standard::DateField.new(
+                prediction['birth_date'],
+                page_id
+              )
+              @birth_place = Parsing::Standard::StringField.new(
+                prediction['birth_place'],
+                page_id
+              )
+              @card_access_number = Parsing::Standard::StringField.new(
+                prediction['card_access_number'],
+                page_id
+              )
+              @document_number = Parsing::Standard::StringField.new(
+                prediction['document_number'],
+                page_id
+              )
+              @expiry_date = Parsing::Standard::DateField.new(
+                prediction['expiry_date'],
+                page_id
+              )
+              @gender = Parsing::Standard::StringField.new(
+                prediction['gender'],
+                page_id
+              )
+              @given_names = [] # : Array[Parsing::Standard::StringField]
+              prediction['given_names'].each do |item|
+                @given_names.push(Parsing::Standard::StringField.new(item, page_id))
+              end
+              @issue_date = Parsing::Standard::DateField.new(
+                prediction['issue_date'],
+                page_id
+              )
+              @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
+              @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
+              @mrz3 = Parsing::Standard::StringField.new(prediction['mrz3'], page_id)
+              @nationality = Parsing::Standard::StringField.new(
+                prediction['nationality'],
+                page_id
+              )
+              @surname = Parsing::Standard::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
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'id_card_v2_document'
+
+module Mindee
+  module V1
+    module Product
+      module FR
+        module IdCard
+          # Carte Nationale d'Identité API version 2.0 page data.
+          class IdCardV2Page < Mindee::V1::Parsing::Common::Page
+            # @param prediction [Hash]
+            def initialize(prediction)
+              super
+              @prediction = if prediction['prediction'].empty?
+                              nil
+                            else
+                              IdCardV2PagePrediction.new(
+                                prediction['prediction'],
+                                prediction['id']
+                              )
+                            end
+            end
+          end
+
+          # Carte Nationale d'Identité V2 page prediction.
+          class IdCardV2PagePrediction < IdCardV2Document
+            include Mindee::V1::Parsing::Standard
+
+            # The sides of the document which are visible.
+            # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+            attr_reader :document_side
+            # The document type or format.
+            # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+            attr_reader :document_type
+
+            # @param prediction [Hash]
+            # @param page_id [Integer, nil]
+            def initialize(prediction, page_id)
+              @document_side = Parsing::Standard::ClassificationField.new(
+                prediction['document_side'],
+                page_id
+              )
+              @document_type = Parsing::Standard::ClassificationField.new(
+                prediction['document_type'],
+                page_id
+              )
+              super
+            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
+end

data/lib/mindee/{product/fr/payslip/payslip_v2.rb → v1/product/international_id/international_id_v2.rb}

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative '../../../parsing'
-require_relative 'payslip_v2_document'
-require_relative 'payslip_v2_page'
+require_relative '../../parsing'
+require_relative 'international_id_v2_document'
+require_relative 'international_id_v2_page'
 
 module Mindee
-  module Product
-    module FR
-      # Payslip module.
-      module Payslip
-        # Payslip API version 2 inference prediction.
-        class PayslipV2 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'payslip_fra'
+  module V1
+    module Product
+      # International ID module.
+      module InternationalId
+        # International ID API version 2 inference prediction.
+        class InternationalIdV2 < Mindee::V1::Parsing::Common::Inference
+          @endpoint_name = 'international_id'
           @endpoint_version = '2'
           @has_async = true
           @has_sync = false
@@ -19,10 +19,10 @@ module Mindee
           # @param prediction [Hash]
           def initialize(prediction)
             super
-            @prediction = PayslipV2Document.new(prediction['prediction'], nil)
+            @prediction = InternationalIdV2Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              @pages.push(PayslipV2Page.new(page))
+              @pages.push(InternationalIdV2Page.new(page))
             end
           end
 

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

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module V1
+    module Product
+      module InternationalId
+        # International ID API version 2.2 document data.
+        class InternationalIdV2Document < Mindee::V1::Parsing::Common::Prediction
+          include Mindee::V1::Parsing::Standard
+
+          # The physical address of the document holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :address
+          # The date of birth of the document holder.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :birth_date
+          # The place of birth of the document holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :birth_place
+          # The country where the document was issued.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :country_of_issue
+          # The unique identifier assigned to the document.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :document_number
+          # The type of personal identification document.
+          # @return [Mindee::V1::Parsing::Standard::ClassificationField]
+          attr_reader :document_type
+          # The date when the document becomes invalid.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :expiry_date
+          # The list of the document holder's given names.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :given_names
+          # The date when the document was issued.
+          # @return [Mindee::V1::Parsing::Standard::DateField]
+          attr_reader :issue_date
+          # The Machine Readable Zone, first line.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :mrz_line1
+          # The Machine Readable Zone, second line.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :mrz_line2
+          # The Machine Readable Zone, third line.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :mrz_line3
+          # The country of citizenship of the document holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :nationality
+          # The unique identifier assigned to the document holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :personal_number
+          # The biological sex of the document holder.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :sex
+          # The state or territory where the document was issued.
+          # @return [Mindee::V1::Parsing::Standard::StringField]
+          attr_reader :state_of_issue
+          # The list of the document holder's family names.
+          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
+          attr_reader :surnames
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super
+            @address = Parsing::Standard::StringField.new(
+              prediction['address'],
+              page_id
+            )
+            @birth_date = Parsing::Standard::DateField.new(
+              prediction['birth_date'],
+              page_id
+            )
+            @birth_place = Parsing::Standard::StringField.new(
+              prediction['birth_place'],
+              page_id
+            )
+            @country_of_issue = Parsing::Standard::StringField.new(
+              prediction['country_of_issue'],
+              page_id
+            )
+            @document_number = Parsing::Standard::StringField.new(
+              prediction['document_number'],
+              page_id
+            )
+            @document_type = Parsing::Standard::ClassificationField.new(
+              prediction['document_type'],
+              page_id
+            )
+            @expiry_date = Parsing::Standard::DateField.new(
+              prediction['expiry_date'],
+              page_id
+            )
+            @given_names = [] # : Array[Parsing::Standard::StringField]
+            prediction['given_names'].each do |item|
+              @given_names.push(Parsing::Standard::StringField.new(item, page_id))
+            end
+            @issue_date = Parsing::Standard::DateField.new(
+              prediction['issue_date'],
+              page_id
+            )
+            @mrz_line1 = Parsing::Standard::StringField.new(
+              prediction['mrz_line1'],
+              page_id
+            )
+            @mrz_line2 = Parsing::Standard::StringField.new(
+              prediction['mrz_line2'],
+              page_id
+            )
+            @mrz_line3 = Parsing::Standard::StringField.new(
+              prediction['mrz_line3'],
+              page_id
+            )
+            @nationality = Parsing::Standard::StringField.new(
+              prediction['nationality'],
+              page_id
+            )
+            @personal_number = Parsing::Standard::StringField.new(
+              prediction['personal_number'],
+              page_id
+            )
+            @sex = Parsing::Standard::StringField.new(prediction['sex'], page_id)
+            @state_of_issue = Parsing::Standard::StringField.new(
+              prediction['state_of_issue'],
+              page_id
+            )
+            @surnames = [] # : Array[Parsing::Standard::StringField]
+            prediction['surnames'].each do |item|
+              @surnames.push(Parsing::Standard::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
+end