mindee 4.13.0 → 5.0.0.rc1

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

@@ -1,265 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'energy_bill_v1_energy_supplier'
-require_relative 'energy_bill_v1_energy_consumer'
-require_relative 'energy_bill_v1_subscriptions'
-require_relative 'energy_bill_v1_energy_usages'
-require_relative 'energy_bill_v1_taxes_and_contributions'
-require_relative 'energy_bill_v1_meter_detail'
-
-module Mindee
-  module Product
-    module FR
-      module EnergyBill
-        # Energy Bill API version 1.2 document data.
-        class EnergyBillV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The unique identifier associated with a specific contract.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :contract_id
-          # The unique identifier assigned to each electricity or gas consumption point. It specifies the exact
-          # location where the energy is delivered.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :delivery_point
-          # The date by which the payment for the energy invoice is due.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :due_date
-          # The entity that consumes the energy.
-          # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyConsumer]
-          attr_reader :energy_consumer
-          # The company that supplies the energy.
-          # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1EnergySupplier]
-          attr_reader :energy_supplier
-          # Details of energy consumption.
-          # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyUsages]
-          attr_reader :energy_usage
-          # The date when the energy invoice was issued.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :invoice_date
-          # The unique identifier of the energy invoice.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :invoice_number
-          # Information about the energy meter.
-          # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1MeterDetail]
-          attr_reader :meter_details
-          # The subscription details fee for the energy service.
-          # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1Subscriptions]
-          attr_reader :subscription
-          # Details of Taxes and Contributions.
-          # @return [Mindee::Product::FR::EnergyBill::EnergyBillV1TaxesAndContributions]
-          attr_reader :taxes_and_contributions
-          # The total amount to be paid for the energy invoice.
-          # @return [Mindee::Parsing::Standard::AmountField]
-          attr_reader :total_amount
-          # The total amount to be paid for the energy invoice before taxes.
-          # @return [Mindee::Parsing::Standard::AmountField]
-          attr_reader :total_before_taxes
-          # Total of taxes applied to the invoice.
-          # @return [Mindee::Parsing::Standard::AmountField]
-          attr_reader :total_taxes
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @contract_id = Parsing::Standard::StringField.new(
-              prediction['contract_id'],
-              page_id
-            )
-            @delivery_point = Parsing::Standard::StringField.new(
-              prediction['delivery_point'],
-              page_id
-            )
-            @due_date = Parsing::Standard::DateField.new(
-              prediction['due_date'],
-              page_id
-            )
-            @energy_consumer = Product::FR::EnergyBill::EnergyBillV1EnergyConsumer.new(
-              prediction['energy_consumer'],
-              page_id
-            )
-            @energy_supplier = Product::FR::EnergyBill::EnergyBillV1EnergySupplier.new(
-              prediction['energy_supplier'],
-              page_id
-            )
-            @energy_usage = Product::FR::EnergyBill::EnergyBillV1EnergyUsages.new(prediction['energy_usage'], page_id)
-            @invoice_date = Parsing::Standard::DateField.new(
-              prediction['invoice_date'],
-              page_id
-            )
-            @invoice_number = Parsing::Standard::StringField.new(
-              prediction['invoice_number'],
-              page_id
-            )
-            @meter_details = Product::FR::EnergyBill::EnergyBillV1MeterDetail.new(
-              prediction['meter_details'],
-              page_id
-            )
-            @subscription = Product::FR::EnergyBill::EnergyBillV1Subscriptions.new(prediction['subscription'], page_id)
-            @taxes_and_contributions = Product::FR::EnergyBill::EnergyBillV1TaxesAndContributions.new(
-              prediction['taxes_and_contributions'], page_id
-            )
-            @total_amount = Parsing::Standard::AmountField.new(
-              prediction['total_amount'],
-              page_id
-            )
-            @total_before_taxes = Parsing::Standard::AmountField.new(
-              prediction['total_before_taxes'],
-              page_id
-            )
-            @total_taxes = Parsing::Standard::AmountField.new(
-              prediction['total_taxes'],
-              page_id
-            )
-          end
-
-          # @return [String]
-          def to_s
-            energy_supplier = @energy_supplier.to_s
-            energy_consumer = @energy_consumer.to_s
-            subscription = subscription_to_s
-            energy_usage = energy_usage_to_s
-            taxes_and_contributions = taxes_and_contributions_to_s
-            meter_details = @meter_details.to_s
-            out_str = String.new
-            out_str << "\n:Invoice Number: #{@invoice_number}".rstrip
-            out_str << "\n:Contract ID: #{@contract_id}".rstrip
-            out_str << "\n:Delivery Point: #{@delivery_point}".rstrip
-            out_str << "\n:Invoice Date: #{@invoice_date}".rstrip
-            out_str << "\n:Due Date: #{@due_date}".rstrip
-            out_str << "\n:Total Before Taxes: #{@total_before_taxes}".rstrip
-            out_str << "\n:Total Taxes: #{@total_taxes}".rstrip
-            out_str << "\n:Total Amount: #{@total_amount}".rstrip
-            out_str << "\n:Energy Supplier:"
-            out_str << energy_supplier
-            out_str << "\n:Energy Consumer:"
-            out_str << energy_consumer
-            out_str << "\n:Subscription:"
-            out_str << subscription
-            out_str << "\n:Energy Usage:"
-            out_str << energy_usage
-            out_str << "\n:Taxes and Contributions:"
-            out_str << taxes_and_contributions
-            out_str << "\n:Meter Details:"
-            out_str << meter_details
-            out_str[1..].to_s
-          end
-
-          private
-
-          # @param char [String]
-          # @return [String]
-          def subscription_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 38}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 10}"
-            out_str << "+#{char * 11}"
-            out_str << "+#{char * 12}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def subscription_to_s
-            return '' if @subscription.empty?
-
-            line_items = @subscription.map(&:to_table_line).join("\n#{subscription_separator('-')}\n  ")
-            out_str = String.new
-            out_str << "\n#{subscription_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' Description                          |'
-            out_str << ' End Date   |'
-            out_str << ' Start Date |'
-            out_str << ' Tax Rate |'
-            out_str << ' Total     |'
-            out_str << ' Unit Price |'
-            out_str << "\n#{subscription_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{subscription_separator('-')}"
-            out_str
-          end
-
-          # @param char [String]
-          # @return [String]
-          def energy_usage_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 13}"
-            out_str << "+#{char * 38}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 10}"
-            out_str << "+#{char * 11}"
-            out_str << "+#{char * 17}"
-            out_str << "+#{char * 12}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def energy_usage_to_s
-            return '' if @energy_usage.empty?
-
-            line_items = @energy_usage.map(&:to_table_line).join("\n#{energy_usage_separator('-')}\n  ")
-            out_str = String.new
-            out_str << "\n#{energy_usage_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' Consumption |'
-            out_str << ' Description                          |'
-            out_str << ' End Date   |'
-            out_str << ' Start Date |'
-            out_str << ' Tax Rate |'
-            out_str << ' Total     |'
-            out_str << ' Unit of Measure |'
-            out_str << ' Unit Price |'
-            out_str << "\n#{energy_usage_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{energy_usage_separator('-')}"
-            out_str
-          end
-
-          # @param char [String]
-          # @return [String]
-          def taxes_and_contributions_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 38}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 12}"
-            out_str << "+#{char * 10}"
-            out_str << "+#{char * 11}"
-            out_str << "+#{char * 12}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def taxes_and_contributions_to_s
-            return '' if @taxes_and_contributions.empty?
-
-            line_items = @taxes_and_contributions.map(&:to_table_line).join(
-              "\n#{taxes_and_contributions_separator('-')}\n  "
-            )
-            out_str = String.new
-            out_str << "\n#{taxes_and_contributions_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' Description                          |'
-            out_str << ' End Date   |'
-            out_str << ' Start Date |'
-            out_str << ' Tax Rate |'
-            out_str << ' Total     |'
-            out_str << ' Unit Price |'
-            out_str << "\n#{taxes_and_contributions_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{taxes_and_contributions_separator('-')}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# 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
-            @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

@@ -1,48 +0,0 @@
-# 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
-            @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

@@ -1,121 +0,0 @@
-# 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
-          # The price per unit of energy consumed.
-          # @return [Float]
-          attr_reader :consumption
-          # 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 unit of measurement for energy consumption.
-          # @return [String]
-          attr_reader :unit
-          # 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
-            @consumption = prediction['consumption']
-            @description = prediction['description']
-            @end_date = prediction['end_date']
-            @start_date = prediction['start_date']
-            @tax_rate = prediction['tax_rate']
-            @total = prediction['total']
-            @unit = prediction['unit']
-            @unit_price = prediction['unit_price']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:consumption] =
-              @consumption.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@consumption)
-            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] = format_for_display(@unit)
-            printable[:unit_price] =
-              @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
-            printable
-          end
-
-          # @return [Hash]
-          def table_printable_values
-            printable = {}
-            printable[:consumption] =
-              @consumption.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@consumption)
-            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] = format_for_display(@unit, nil)
-            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('| %- 12s', printable[:consumption])
-            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('| %- 16s', printable[:unit])
-            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  :Consumption: #{printable[:consumption]}"
-            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 of Measure: #{printable[:unit]}"
-            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

@@ -1,54 +0,0 @@
-# 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 power for energy consumption.
-          # @return [String]
-          attr_reader :unit
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @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 Power: #{printable[:unit]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,103 +0,0 @@
-# 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
-            @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