mindee 4.12.0 → 5.0.0.beta1

data/lib/mindee/product/ind/indian_passport/indian_passport_v1_document.rb

@@ -1,206 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module IND
-      module IndianPassport
-        # Passport - India API version 1.2 document data.
-        class IndianPassportV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The first line of the address of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address1
-          # The second line of the address of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address2
-          # The third line of the address of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address3
-          # The birth date of the passport holder, ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :birth_date
-          # The birth place of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :birth_place
-          # ISO 3166-1 alpha-3 country code (3 letters format).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :country
-          # The date when the passport will expire, ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :expiry_date
-          # The file number of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :file_number
-          # The gender of the passport holder.
-          # @return [Mindee::Parsing::Standard::ClassificationField]
-          attr_reader :gender
-          # The given names of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :given_names
-          # The identification number of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :id_number
-          # The date when the passport was issued, ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :issuance_date
-          # The place where the passport was issued.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :issuance_place
-          # The name of the legal guardian of the passport holder (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :legal_guardian
-          # The first line of the machine-readable zone (MRZ) of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :mrz1
-          # The second line of the machine-readable zone (MRZ) of the passport document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :mrz2
-          # The name of the mother of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :name_of_mother
-          # The name of the spouse of the passport holder (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :name_of_spouse
-          # The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :old_passport_date_of_issue
-          # The number of the old passport (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :old_passport_number
-          # The place of issue of the old passport (if applicable).
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :old_passport_place_of_issue
-          # The page number of the passport document.
-          # @return [Mindee::Parsing::Standard::ClassificationField]
-          attr_reader :page_number
-          # The surname of the passport holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :surname
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @address1 = Parsing::Standard::StringField.new(
-              prediction['address1'],
-              page_id
-            )
-            @address2 = Parsing::Standard::StringField.new(
-              prediction['address2'],
-              page_id
-            )
-            @address3 = Parsing::Standard::StringField.new(
-              prediction['address3'],
-              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 = Parsing::Standard::StringField.new(
-              prediction['country'],
-              page_id
-            )
-            @expiry_date = Parsing::Standard::DateField.new(
-              prediction['expiry_date'],
-              page_id
-            )
-            @file_number = Parsing::Standard::StringField.new(
-              prediction['file_number'],
-              page_id
-            )
-            @gender = Parsing::Standard::ClassificationField.new(
-              prediction['gender'],
-              page_id
-            )
-            @given_names = Parsing::Standard::StringField.new(
-              prediction['given_names'],
-              page_id
-            )
-            @id_number = Parsing::Standard::StringField.new(
-              prediction['id_number'],
-              page_id
-            )
-            @issuance_date = Parsing::Standard::DateField.new(
-              prediction['issuance_date'],
-              page_id
-            )
-            @issuance_place = Parsing::Standard::StringField.new(
-              prediction['issuance_place'],
-              page_id
-            )
-            @legal_guardian = Parsing::Standard::StringField.new(
-              prediction['legal_guardian'],
-              page_id
-            )
-            @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
-            @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
-            @name_of_mother = Parsing::Standard::StringField.new(
-              prediction['name_of_mother'],
-              page_id
-            )
-            @name_of_spouse = Parsing::Standard::StringField.new(
-              prediction['name_of_spouse'],
-              page_id
-            )
-            @old_passport_date_of_issue = Parsing::Standard::DateField.new(
-              prediction['old_passport_date_of_issue'],
-              page_id
-            )
-            @old_passport_number = Parsing::Standard::StringField.new(
-              prediction['old_passport_number'],
-              page_id
-            )
-            @old_passport_place_of_issue = Parsing::Standard::StringField.new(
-              prediction['old_passport_place_of_issue'],
-              page_id
-            )
-            @page_number = Parsing::Standard::ClassificationField.new(
-              prediction['page_number'],
-              page_id
-            )
-            @surname = Parsing::Standard::StringField.new(
-              prediction['surname'],
-              page_id
-            )
-          end
-
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n:Page Number: #{@page_number}".rstrip
-            out_str << "\n:Country: #{@country}".rstrip
-            out_str << "\n:ID Number: #{@id_number}".rstrip
-            out_str << "\n:Given Names: #{@given_names}".rstrip
-            out_str << "\n:Surname: #{@surname}".rstrip
-            out_str << "\n:Birth Date: #{@birth_date}".rstrip
-            out_str << "\n:Birth Place: #{@birth_place}".rstrip
-            out_str << "\n:Issuance Place: #{@issuance_place}".rstrip
-            out_str << "\n:Gender: #{@gender}".rstrip
-            out_str << "\n:Issuance Date: #{@issuance_date}".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:Legal Guardian: #{@legal_guardian}".rstrip
-            out_str << "\n:Name of Spouse: #{@name_of_spouse}".rstrip
-            out_str << "\n:Name of Mother: #{@name_of_mother}".rstrip
-            out_str << "\n:Old Passport Date of Issue: #{@old_passport_date_of_issue}".rstrip
-            out_str << "\n:Old Passport Number: #{@old_passport_number}".rstrip
-            out_str << "\n:Old Passport Place of Issue: #{@old_passport_place_of_issue}".rstrip
-            out_str << "\n:Address Line 1: #{@address1}".rstrip
-            out_str << "\n:Address Line 2: #{@address2}".rstrip
-            out_str << "\n:Address Line 3: #{@address3}".rstrip
-            out_str << "\n:File Number: #{@file_number}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/ind/indian_passport/indian_passport_v1_page.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'indian_passport_v1_document'
-
-module Mindee
-  module Product
-    module IND
-      module IndianPassport
-        # Passport - India API version 1.2 page data.
-        class IndianPassportV1Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            IndianPassportV1PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # Passport - India V1 page prediction.
-        class IndianPassportV1PagePrediction < IndianPassportV1Document
-          # @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/international_id/international_id_v2.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'international_id_v2_document'
-require_relative 'international_id_v2_page'
-
-module Mindee
-  module Product
-    # International ID module.
-    module InternationalId
-      # International ID API version 2 inference prediction.
-      class InternationalIdV2 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'international_id'
-        @endpoint_version = '2'
-        @has_async = true
-        @has_sync = false
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = InternationalIdV2Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(InternationalIdV2Page.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

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

@@ -1,161 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module InternationalId
-      # International ID API version 2.2 document data.
-      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 = 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

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'international_id_v2_document'
-
-module Mindee
-  module Product
-    module InternationalId
-      # International ID API version 2.2 page data.
-      class InternationalIdV2Page < Mindee::Parsing::Common::Page
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = if prediction['prediction'].empty?
-                          nil
-                        else
-                          InternationalIdV2PagePrediction.new(
-                            prediction['prediction'],
-                            prediction['id']
-                          )
-                        end
-        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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'invoice_v4_document'
-require_relative 'invoice_v4_page'
-
-module Mindee
-  module Product
-    # Invoice module.
-    module Invoice
-      # Invoice API version 4 inference prediction.
-      class InvoiceV4 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'invoices'
-        @endpoint_version = '4'
-        @has_async = true
-        @has_sync = true
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = InvoiceV4Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(InvoiceV4Page.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