mindee 3.12.0 → 3.14.0

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # The entity that consumes the energy.
+        class EnergyBillV1EnergyConsumer < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The address of the energy consumer.
+          # @return [String]
+          attr_reader :address
+          # The name of the energy consumer.
+          # @return [String]
+          attr_reader :name
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @address = prediction['address']
+            @name = prediction['name']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:address] = format_for_display(@address)
+            printable[:name] = format_for_display(@name)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Address: #{printable[:address]}"
+            out_str << "\n  :Name: #{printable[:name]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # The company that supplies the energy.
+        class EnergyBillV1EnergySupplier < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The address of the energy supplier.
+          # @return [String]
+          attr_reader :address
+          # The name of the energy supplier.
+          # @return [String]
+          attr_reader :name
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @address = prediction['address']
+            @name = prediction['name']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:address] = format_for_display(@address)
+            printable[:name] = format_for_display(@name)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Address: #{printable[:address]}"
+            out_str << "\n  :Name: #{printable[:name]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # Details of energy consumption.
+        class EnergyBillV1EnergyUsage < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # Description or details of the energy usage.
+          # @return [String]
+          attr_reader :description
+          # The end date of the energy usage.
+          # @return [String]
+          attr_reader :end_date
+          # The start date of the energy usage.
+          # @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 energy consumed.
+          # @return [Float]
+          attr_reader :total
+          # The price per unit of energy consumed.
+          # @return [Float]
+          attr_reader :unit_price
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @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? ? '' : Field.float_to_string(@tax_rate)
+            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
+            printable[:unit_price] = @unit_price.nil? ? '' : Field.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? ? '' : Field.float_to_string(@tax_rate)
+            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
+            printable[:unit_price] = @unit_price.nil? ? '' : Field.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/energy_bill/energy_bill_v1_meter_detail.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # Information about the energy meter.
+        class EnergyBillV1MeterDetail < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The unique identifier of the energy meter.
+          # @return [String]
+          attr_reader :meter_number
+          # The type of energy meter.
+          # @return [String]
+          attr_reader :meter_type
+          # The unit of measurement for energy consumption, which can be kW, m³, or L.
+          # @return [String]
+          attr_reader :unit
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @meter_number = prediction['meter_number']
+            @meter_type = prediction['meter_type']
+            @unit = prediction['unit']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:meter_number] = format_for_display(@meter_number)
+            printable[:meter_type] = format_for_display(@meter_type)
+            printable[:unit] = format_for_display(@unit)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Meter Number: #{printable[:meter_number]}"
+            out_str << "\n  :Meter Type: #{printable[:meter_type]}"
+            out_str << "\n  :Unit of Measure: #{printable[:unit]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'energy_bill_v1_document'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # Energy Bill API version 1.0 page data.
+        class EnergyBillV1Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = EnergyBillV1PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Energy Bill V1 page prediction.
+        class EnergyBillV1PagePrediction < EnergyBillV1Document
+          # @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/energy_bill/energy_bill_v1_subscription.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # The subscription details fee for the energy service.
+        class EnergyBillV1Subscription < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # Description or details of the subscription.
+          # @return [String]
+          attr_reader :description
+          # The end date of the subscription.
+          # @return [String]
+          attr_reader :end_date
+          # The start date of the subscription.
+          # @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 subscription.
+          # @return [Float]
+          attr_reader :total
+          # The price per unit of subscription.
+          # @return [Float]
+          attr_reader :unit_price
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @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? ? '' : Field.float_to_string(@tax_rate)
+            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
+            printable[:unit_price] = @unit_price.nil? ? '' : Field.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? ? '' : Field.float_to_string(@tax_rate)
+            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
+            printable[:unit_price] = @unit_price.nil? ? '' : Field.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/energy_bill/energy_bill_v1_taxes_and_contribution.rb

@@ -0,0 +1,97 @@
+# 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(prediction, page_id)
+            @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? ? '' : Field.float_to_string(@tax_rate)
+            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
+            printable[:unit_price] = @unit_price.nil? ? '' : Field.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? ? '' : Field.float_to_string(@tax_rate)
+            printable[:total] = @total.nil? ? '' : Field.float_to_string(@total)
+            printable[:unit_price] = @unit_price.nil? ? '' : Field.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/payslip/payslip_v2.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'payslip_v2_document'
+require_relative 'payslip_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'
+          @endpoint_version = '2'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = PayslipV2Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(PayslipV2Page.new(page))
+              end
+            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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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(prediction, page_id)
+            @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