mindee 4.13.0 → 5.0.0.rc1

data/lib/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contribution.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module EnergyBill
-        # Details of Taxes and Contributions.
-        class EnergyBillV1TaxesAndContribution < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # Description or details of the Taxes and Contributions.
-          # @return [String]
-          attr_reader :description
-          # The end date of the Taxes and Contributions.
-          # @return [String]
-          attr_reader :end_date
-          # The start date of the Taxes and Contributions.
-          # @return [String]
-          attr_reader :start_date
-          # The rate of tax applied to the total cost.
-          # @return [Float]
-          attr_reader :tax_rate
-          # The total cost of Taxes and Contributions.
-          # @return [Float]
-          attr_reader :total
-          # The price per unit of Taxes and Contributions.
-          # @return [Float]
-          attr_reader :unit_price
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @description = prediction['description']
-            @end_date = prediction['end_date']
-            @start_date = prediction['start_date']
-            @tax_rate = prediction['tax_rate']
-            @total = prediction['total']
-            @unit_price = prediction['unit_price']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:description] = format_for_display(@description)
-            printable[:end_date] = format_for_display(@end_date)
-            printable[:start_date] = format_for_display(@start_date)
-            printable[:tax_rate] =
-              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
-            printable[:total] =
-              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
-            printable[:unit_price] =
-              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
-            printable
-          end
-
-          # @return [Hash]
-          def table_printable_values
-            printable = {}
-            printable[:description] = format_for_display(@description, 36)
-            printable[:end_date] = format_for_display(@end_date, 10)
-            printable[:start_date] = format_for_display(@start_date, nil)
-            printable[:tax_rate] =
-              @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
-            printable[:total] =
-              @total.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@total)
-            printable[:unit_price] =
-              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
-            printable
-          end
-
-          # @return [String]
-          def to_table_line
-            printable = table_printable_values
-            out_str = String.new
-            out_str << format('| %- 37s', printable[:description])
-            out_str << format('| %- 11s', printable[:end_date])
-            out_str << format('| %- 11s', printable[:start_date])
-            out_str << format('| %- 9s', printable[:tax_rate])
-            out_str << format('| %- 10s', printable[:total])
-            out_str << format('| %- 11s', printable[:unit_price])
-            out_str << '|'
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Description: #{printable[:description]}"
-            out_str << "\n  :End Date: #{printable[:end_date]}"
-            out_str << "\n  :Start Date: #{printable[:start_date]}"
-            out_str << "\n  :Tax Rate: #{printable[:tax_rate]}"
-            out_str << "\n  :Total: #{printable[:total]}"
-            out_str << "\n  :Unit Price: #{printable[:unit_price]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/health_card/health_card_v1.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'health_card_v1_document'
-require_relative 'health_card_v1_page'
-
-module Mindee
-  module Product
-    module FR
-      # Health Card module.
-      module HealthCard
-        # Health Card API version 1 inference prediction.
-        class HealthCardV1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'french_healthcard'
-          @endpoint_version = '1'
-          @has_async = true
-          @has_sync = false
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = HealthCardV1Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(HealthCardV1Page.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

data/lib/mindee/product/fr/health_card/health_card_v1_document.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module HealthCard
-        # Health Card API version 1.0 document data.
-        class HealthCardV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The given names of the card holder.
-          # @return [Array<Mindee::Parsing::Standard::StringField>]
-          attr_reader :given_names
-          # The date when the carte vitale document was issued.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :issuance_date
-          # The social security number of the card holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :social_security
-          # The surname of the card holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :surname
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @given_names = [] # : Array[Parsing::Standard::StringField]
-            prediction['given_names'].each do |item|
-              @given_names.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-            @issuance_date = Parsing::Standard::DateField.new(
-              prediction['issuance_date'],
-              page_id
-            )
-            @social_security = Parsing::Standard::StringField.new(
-              prediction['social_security'],
-              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:Given Name(s): #{given_names}".rstrip
-            out_str << "\n:Surname: #{@surname}".rstrip
-            out_str << "\n:Social Security Number: #{@social_security}".rstrip
-            out_str << "\n:Issuance Date: #{@issuance_date}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'id_card_v1_document'
-
-module Mindee
-  module Product
-    module FR
-      module IdCard
-        # Carte Nationale d'Identité API version 1.1 page data.
-        class IdCardV1Page < Mindee::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::Parsing::Standard
-
-          # The side of the document which is visible.
-          # @return [Mindee::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

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'id_card_v2_document'
-require_relative 'id_card_v2_page'
-
-module Mindee
-  module Product
-    module FR
-      # Carte Nationale d'Identité module.
-      module IdCard
-        # Carte Nationale d'Identité API version 2 inference prediction.
-        class IdCardV2 < Mindee::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

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

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

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

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'id_card_v2_document'
-
-module Mindee
-  module Product
-    module FR
-      module IdCard
-        # Carte Nationale d'Identité API version 2.0 page data.
-        class IdCardV2Page < Mindee::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::Parsing::Standard
-
-          # The sides of the document which are visible.
-          # @return [Mindee::Parsing::Standard::ClassificationField]
-          attr_reader :document_side
-          # The document type or format.
-          # @return [Mindee::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

data/lib/mindee/product/fr/payslip/payslip_v2_bank_account_detail.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module Payslip
-        # Information about the employee's bank account.
-        class PayslipV2BankAccountDetail < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The name of the bank.
-          # @return [String]
-          attr_reader :bank_name
-          # The IBAN of the bank account.
-          # @return [String]
-          attr_reader :iban
-          # The SWIFT code of the bank.
-          # @return [String]
-          attr_reader :swift
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @bank_name = prediction['bank_name']
-            @iban = prediction['iban']
-            @swift = prediction['swift']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:bank_name] = format_for_display(@bank_name)
-            printable[:iban] = format_for_display(@iban)
-            printable[:swift] = format_for_display(@swift)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Bank Name: #{printable[:bank_name]}"
-            out_str << "\n  :IBAN: #{printable[:iban]}"
-            out_str << "\n  :SWIFT: #{printable[:swift]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end