mindee 4.12.0 → 5.0.0.beta1

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_account_details_v2_document'
-require_relative 'bank_account_details_v2_page'
-
-module Mindee
-  module Product
-    module FR
-      # Bank Account Details module.
-      module BankAccountDetails
-        # Bank Account Details API version 2 inference prediction.
-        class BankAccountDetailsV2 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'bank_account_details'
-          @endpoint_version = '2'
-          @has_async = false
-          @has_sync = true
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = BankAccountDetailsV2Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(BankAccountDetailsV2Page.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/bank_account_details/bank_account_details_v2_bban.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module BankAccountDetails
-        # Full extraction of BBAN, including: branch code, bank code, account and key.
-        class BankAccountDetailsV2Bban < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The BBAN bank code outputted as a string.
-          # @return [String]
-          attr_reader :bban_bank_code
-          # The BBAN branch code outputted as a string.
-          # @return [String]
-          attr_reader :bban_branch_code
-          # The BBAN key outputted as a string.
-          # @return [String]
-          attr_reader :bban_key
-          # The BBAN Account number outputted as a string.
-          # @return [String]
-          attr_reader :bban_number
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @bban_bank_code = prediction['bban_bank_code']
-            @bban_branch_code = prediction['bban_branch_code']
-            @bban_key = prediction['bban_key']
-            @bban_number = prediction['bban_number']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:bban_bank_code] = format_for_display(@bban_bank_code)
-            printable[:bban_branch_code] = format_for_display(@bban_branch_code)
-            printable[:bban_key] = format_for_display(@bban_key)
-            printable[:bban_number] = format_for_display(@bban_number)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Bank Code: #{printable[:bban_bank_code]}"
-            out_str << "\n  :Branch Code: #{printable[:bban_branch_code]}"
-            out_str << "\n  :Key: #{printable[:bban_key]}"
-            out_str << "\n  :Account Number: #{printable[:bban_number]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_account_details_v2_bban'
-
-module Mindee
-  module Product
-    module FR
-      module BankAccountDetails
-        # Bank Account Details API version 2.0 document data.
-        class BankAccountDetailsV2Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # Full extraction of the account holders names.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :account_holders_names
-          # Full extraction of BBAN, including: branch code, bank code, account and key.
-          # @return [Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2Bban]
-          attr_reader :bban
-          # Full extraction of the IBAN number.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :iban
-          # Full extraction of the SWIFT code.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :swift_code
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @account_holders_names = Parsing::Standard::StringField.new(
-              prediction['account_holders_names'],
-              page_id
-            )
-            @bban = Product::FR::BankAccountDetails::BankAccountDetailsV2Bban.new(prediction['bban'], page_id)
-            @iban = Parsing::Standard::StringField.new(prediction['iban'], page_id)
-            @swift_code = Parsing::Standard::StringField.new(
-              prediction['swift_code'],
-              page_id
-            )
-          end
-
-          # @return [String]
-          def to_s
-            bban = @bban.to_s
-            out_str = String.new
-            out_str << "\n:Account Holder's Names: #{@account_holders_names}".rstrip
-            out_str << "\n:Basic Bank Account Number:"
-            out_str << bban
-            out_str << "\n:IBAN: #{@iban}".rstrip
-            out_str << "\n:SWIFT Code: #{@swift_code}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_account_details_v2_document'
-
-module Mindee
-  module Product
-    module FR
-      module BankAccountDetails
-        # Bank Account Details API version 2.0 page data.
-        class BankAccountDetailsV2Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            BankAccountDetailsV2PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # Bank Account Details V2 page prediction.
-        class BankAccountDetailsV2PagePrediction < BankAccountDetailsV2Document
-          # @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/fr/bank_statement/bank_statement_v2.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_statement_v2_document'
-require_relative 'bank_statement_v2_page'
-
-module Mindee
-  module Product
-    module FR
-      # Bank Statement module.
-      module BankStatement
-        # Bank Statement API version 2 inference prediction.
-        class BankStatementV2 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'bank_statement_fr'
-          @endpoint_version = '2'
-          @has_async = true
-          @has_sync = false
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = BankStatementV2Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(BankStatementV2Page.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/bank_statement/bank_statement_v2_document.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_statement_v2_transactions'
-
-module Mindee
-  module Product
-    module FR
-      module BankStatement
-        # Bank Statement API version 2.0 document data.
-        class BankStatementV2Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The unique identifier for a customer's account in the bank's system.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :account_number
-          # The physical location of the bank where the statement was issued.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :bank_address
-          # The name of the bank that issued the statement.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :bank_name
-          # The address of the client associated with the bank statement.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :client_address
-          # The name of the clients who own the bank statement.
-          # @return [Array<Mindee::Parsing::Standard::StringField>]
-          attr_reader :client_names
-          # The final amount of money in the account at the end of the statement period.
-          # @return [Mindee::Parsing::Standard::AmountField]
-          attr_reader :closing_balance
-          # The initial amount of money in an account at the start of the period.
-          # @return [Mindee::Parsing::Standard::AmountField]
-          attr_reader :opening_balance
-          # The date on which the bank statement was generated.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :statement_date
-          # The date when the statement period ends.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :statement_end_date
-          # The date when the bank statement period begins.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :statement_start_date
-          # The total amount of money deposited into the account.
-          # @return [Mindee::Parsing::Standard::AmountField]
-          attr_reader :total_credits
-          # The total amount of money debited from the account.
-          # @return [Mindee::Parsing::Standard::AmountField]
-          attr_reader :total_debits
-          # The list of values that represent the financial transactions recorded in a bank statement.
-          # @return [Mindee::Product::FR::BankStatement::BankStatementV2Transactions]
-          attr_reader :transactions
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @account_number = Parsing::Standard::StringField.new(
-              prediction['account_number'],
-              page_id
-            )
-            @bank_address = Parsing::Standard::StringField.new(
-              prediction['bank_address'],
-              page_id
-            )
-            @bank_name = Parsing::Standard::StringField.new(
-              prediction['bank_name'],
-              page_id
-            )
-            @client_address = Parsing::Standard::StringField.new(
-              prediction['client_address'],
-              page_id
-            )
-            @client_names = [] # : Array[Parsing::Standard::StringField]
-            prediction['client_names'].each do |item|
-              @client_names.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-            @closing_balance = Parsing::Standard::AmountField.new(
-              prediction['closing_balance'],
-              page_id
-            )
-            @opening_balance = Parsing::Standard::AmountField.new(
-              prediction['opening_balance'],
-              page_id
-            )
-            @statement_date = Parsing::Standard::DateField.new(
-              prediction['statement_date'],
-              page_id
-            )
-            @statement_end_date = Parsing::Standard::DateField.new(
-              prediction['statement_end_date'],
-              page_id
-            )
-            @statement_start_date = Parsing::Standard::DateField.new(
-              prediction['statement_start_date'],
-              page_id
-            )
-            @total_credits = Parsing::Standard::AmountField.new(
-              prediction['total_credits'],
-              page_id
-            )
-            @total_debits = Parsing::Standard::AmountField.new(
-              prediction['total_debits'],
-              page_id
-            )
-            @transactions = Product::FR::BankStatement::BankStatementV2Transactions.new(
-              prediction['transactions'], page_id
-            )
-          end
-
-          # @return [String]
-          def to_s
-            client_names = @client_names.join("\n #{' ' * 14}")
-            transactions = transactions_to_s
-            out_str = String.new
-            out_str << "\n:Account Number: #{@account_number}".rstrip
-            out_str << "\n:Bank Name: #{@bank_name}".rstrip
-            out_str << "\n:Bank Address: #{@bank_address}".rstrip
-            out_str << "\n:Client Names: #{client_names}".rstrip
-            out_str << "\n:Client Address: #{@client_address}".rstrip
-            out_str << "\n:Statement Date: #{@statement_date}".rstrip
-            out_str << "\n:Statement Start Date: #{@statement_start_date}".rstrip
-            out_str << "\n:Statement End Date: #{@statement_end_date}".rstrip
-            out_str << "\n:Opening Balance: #{@opening_balance}".rstrip
-            out_str << "\n:Closing Balance: #{@closing_balance}".rstrip
-            out_str << "\n:Transactions:"
-            out_str << transactions
-            out_str << "\n:Total Debits: #{@total_debits}".rstrip
-            out_str << "\n:Total Credits: #{@total_credits}".rstrip
-            out_str[1..].to_s
-          end
-
-          private
-
-          # @param char [String]
-          # @return [String]
-          def transactions_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 38}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def transactions_to_s
-            return '' if @transactions.empty?
-
-            line_items = @transactions.map(&:to_table_line).join("\n#{transactions_separator('-')}\n  ")
-            out_str = String.new
-            out_str << "\n#{transactions_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' Amount     |'
-            out_str << ' Date       |'
-            out_str << ' Description                          |'
-            out_str << "\n#{transactions_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{transactions_separator('-')}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/bank_statement/bank_statement_v2_page.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_statement_v2_document'
-
-module Mindee
-  module Product
-    module FR
-      module BankStatement
-        # Bank Statement API version 2.0 page data.
-        class BankStatementV2Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            BankStatementV2PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # Bank Statement V2 page prediction.
-        class BankStatementV2PagePrediction < BankStatementV2Document
-          # @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/fr/bank_statement/bank_statement_v2_transaction.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module BankStatement
-        # The list of values that represent the financial transactions recorded in a bank statement.
-        class BankStatementV2Transaction < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The monetary amount of the transaction.
-          # @return [Float]
-          attr_reader :amount
-          # The date on which the transaction occurred.
-          # @return [String]
-          attr_reader :date
-          # The additional information about the transaction.
-          # @return [String]
-          attr_reader :description
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @amount = prediction['amount']
-            @date = prediction['date']
-            @description = prediction['description']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:amount] =
-              @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
-            printable[:date] = format_for_display(@date)
-            printable[:description] = format_for_display(@description)
-            printable
-          end
-
-          # @return [Hash]
-          def table_printable_values
-            printable = {}
-            printable[:amount] =
-              @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
-            printable[:date] = format_for_display(@date, 10)
-            printable[:description] = format_for_display(@description, 36)
-            printable
-          end
-
-          # @return [String]
-          def to_table_line
-            printable = table_printable_values
-            out_str = String.new
-            out_str << format('| %- 11s', printable[:amount])
-            out_str << format('| %- 11s', printable[:date])
-            out_str << format('| %- 37s', printable[:description])
-            out_str << '|'
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Amount: #{printable[:amount]}"
-            out_str << "\n  :Date: #{printable[:date]}"
-            out_str << "\n  :Description: #{printable[:description]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/bank_statement/bank_statement_v2_transactions.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'bank_statement_v2_transaction'
-
-module Mindee
-  module Product
-    module FR
-      module BankStatement
-        # The list of values that represent the financial transactions recorded in a bank statement.
-        class BankStatementV2Transactions < Array
-          # Entries.
-          # @return [Array<BankStatementV2Transaction>]
-          attr_reader :entries
-
-          # @param prediction [Array]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            entries = prediction.map do |entry|
-              BankStatement::BankStatementV2Transaction.new(entry, page_id)
-            end
-            super(entries)
-          end
-
-          # Creates a line of rST table-compliant string separators.
-          # @param char [String] Character to use as a separator.
-          # @return [String]
-          def self.line_items_separator(char)
-            out_str = String.new
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 38}"
-            out_str
-          end
-
-          # @return [String]
-          def to_s
-            return '' if empty?
-
-            lines = map do |entry|
-              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
-            end.join
-            out_str = String.new
-            out_str << "\n#{self.class.line_items_separator('-')}\n "
-            out_str << ' | Amount    '
-            out_str << ' | Date      '
-            out_str << ' | Description                         '
-            out_str << " |\n#{self.class.line_items_separator('=')}"
-            out_str + lines
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/fr/carte_grise/carte_grise_v1.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'carte_grise_v1_document'
-require_relative 'carte_grise_v1_page'
-
-module Mindee
-  module Product
-    module FR
-      # Carte Grise module.
-      module CarteGrise
-        # Carte Grise API version 1 inference prediction.
-        class CarteGriseV1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'carte_grise'
-          @endpoint_version = '1'
-          @has_async = false
-          @has_sync = true
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = CarteGriseV1Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(CarteGriseV1Page.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