mindee 3.12.0 → 3.13.0

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

@@ -0,0 +1,235 @@
+# 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_subscription'
+require_relative 'energy_bill_v1_energy_usage'
+require_relative 'energy_bill_v1_taxes_and_contribution'
+require_relative 'energy_bill_v1_meter_detail'
+
+module Mindee
+  module Product
+    module FR
+      module EnergyBill
+        # Energy Bill API version 1.0 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 [Array<Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyUsage>]
+          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 [Array<Mindee::Product::FR::EnergyBill::EnergyBillV1Subscription>]
+          attr_reader :subscription
+          # Details of Taxes and Contributions.
+          # @return [Array<Mindee::Product::FR::EnergyBill::EnergyBillV1TaxesAndContribution>]
+          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 = StringField.new(prediction['contract_id'], page_id)
+            @delivery_point = StringField.new(prediction['delivery_point'], page_id)
+            @due_date = DateField.new(prediction['due_date'], page_id)
+            @energy_consumer = EnergyBillV1EnergyConsumer.new(prediction['energy_consumer'], page_id)
+            @energy_supplier = EnergyBillV1EnergySupplier.new(prediction['energy_supplier'], page_id)
+            @energy_usage = []
+            prediction['energy_usage'].each do |item|
+              @energy_usage.push(EnergyBillV1EnergyUsage.new(item, page_id))
+            end
+            @invoice_date = DateField.new(prediction['invoice_date'], page_id)
+            @invoice_number = StringField.new(prediction['invoice_number'], page_id)
+            @meter_details = EnergyBillV1MeterDetail.new(prediction['meter_details'], page_id)
+            @subscription = []
+            prediction['subscription'].each do |item|
+              @subscription.push(EnergyBillV1Subscription.new(item, page_id))
+            end
+            @taxes_and_contributions = []
+            prediction['taxes_and_contributions'].each do |item|
+              @taxes_and_contributions.push(EnergyBillV1TaxesAndContribution.new(item, page_id))
+            end
+            @total_amount = AmountField.new(prediction['total_amount'], page_id)
+            @total_before_taxes = AmountField.new(prediction['total_before_taxes'], page_id)
+            @total_taxes = 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 * 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 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 << ' Description                          |'
+            out_str << ' End Date   |'
+            out_str << ' Start Date |'
+            out_str << ' Tax Rate |'
+            out_str << ' Total     |'
+            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

@@ -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