mindee 3.12.0 → 3.13.0

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module BillOfLading
+      # The shipping company responsible for transporting the goods.
+      class BillOfLadingV1Carrier < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The name of the carrier.
+        # @return [String]
+        attr_reader :name
+        # The professional number of the carrier.
+        # @return [String]
+        attr_reader :professional_number
+        # The Standard Carrier Alpha Code (SCAC) of the carrier.
+        # @return [String]
+        attr_reader :scac
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @name = prediction['name']
+          @professional_number = prediction['professional_number']
+          @scac = prediction['scac']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:name] = format_for_display(@name)
+          printable[:professional_number] = format_for_display(@professional_number)
+          printable[:scac] = format_for_display(@scac)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Name: #{printable[:name]}"
+          out_str << "\n  :Professional Number: #{printable[:professional_number]}"
+          out_str << "\n  :SCAC: #{printable[:scac]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_item.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module BillOfLading
+      # The goods being shipped.
+      class BillOfLadingV1CarrierItem < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # A description of the item.
+        # @return [String]
+        attr_reader :description
+        # The gross weight of the item.
+        # @return [Float]
+        attr_reader :gross_weight
+        # The measurement of the item.
+        # @return [Float]
+        attr_reader :measurement
+        # The unit of measurement for the measurement.
+        # @return [String]
+        attr_reader :measurement_unit
+        # The quantity of the item being shipped.
+        # @return [Float]
+        attr_reader :quantity
+        # The unit of measurement for weights.
+        # @return [String]
+        attr_reader :weight_unit
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @description = prediction['description']
+          @gross_weight = prediction['gross_weight']
+          @measurement = prediction['measurement']
+          @measurement_unit = prediction['measurement_unit']
+          @quantity = prediction['quantity']
+          @weight_unit = prediction['weight_unit']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:description] = format_for_display(@description)
+          printable[:gross_weight] = @gross_weight.nil? ? '' : Field.float_to_string(@gross_weight)
+          printable[:measurement] = @measurement.nil? ? '' : Field.float_to_string(@measurement)
+          printable[:measurement_unit] = format_for_display(@measurement_unit)
+          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
+          printable[:weight_unit] = format_for_display(@weight_unit)
+          printable
+        end
+
+        # @return [Hash]
+        def table_printable_values
+          printable = {}
+          printable[:description] = format_for_display(@description, 36)
+          printable[:gross_weight] = @gross_weight.nil? ? '' : Field.float_to_string(@gross_weight)
+          printable[:measurement] = @measurement.nil? ? '' : Field.float_to_string(@measurement)
+          printable[:measurement_unit] = format_for_display(@measurement_unit, nil)
+          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
+          printable[:weight_unit] = format_for_display(@weight_unit, nil)
+          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('| %- 13s', printable[:gross_weight])
+          out_str << format('| %- 12s', printable[:measurement])
+          out_str << format('| %- 17s', printable[:measurement_unit])
+          out_str << format('| %- 9s', printable[:quantity])
+          out_str << format('| %- 12s', printable[:weight_unit])
+          out_str << '|'
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Description: #{printable[:description]}"
+          out_str << "\n  :Gross Weight: #{printable[:gross_weight]}"
+          out_str << "\n  :Measurement: #{printable[:measurement]}"
+          out_str << "\n  :Measurement Unit: #{printable[:measurement_unit]}"
+          out_str << "\n  :Quantity: #{printable[:quantity]}"
+          out_str << "\n  :Weight Unit: #{printable[:weight_unit]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_consignee.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module BillOfLading
+      # The party to whom the goods are being shipped.
+      class BillOfLadingV1Consignee < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The address of the consignee.
+        # @return [String]
+        attr_reader :address
+        # The  email of the shipper.
+        # @return [String]
+        attr_reader :email
+        # The name of the consignee.
+        # @return [String]
+        attr_reader :name
+        # The phone number of the consignee.
+        # @return [String]
+        attr_reader :phone
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @address = prediction['address']
+          @email = prediction['email']
+          @name = prediction['name']
+          @phone = prediction['phone']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:address] = format_for_display(@address)
+          printable[:email] = format_for_display(@email)
+          printable[:name] = format_for_display(@name)
+          printable[:phone] = format_for_display(@phone)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Address: #{printable[:address]}"
+          out_str << "\n  :Email: #{printable[:email]}"
+          out_str << "\n  :Name: #{printable[:name]}"
+          out_str << "\n  :Phone: #{printable[:phone]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_document.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'bill_of_lading_v1_shipper'
+require_relative 'bill_of_lading_v1_consignee'
+require_relative 'bill_of_lading_v1_notify_party'
+require_relative 'bill_of_lading_v1_carrier'
+require_relative 'bill_of_lading_v1_carrier_item'
+
+module Mindee
+  module Product
+    module BillOfLading
+      # Bill of Lading API version 1.1 document data.
+      class BillOfLadingV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # A unique identifier assigned to a Bill of Lading document.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :bill_of_lading_number
+        # The shipping company responsible for transporting the goods.
+        # @return [Mindee::Product::BillOfLading::BillOfLadingV1Carrier]
+        attr_reader :carrier
+        # The goods being shipped.
+        # @return [Array<Mindee::Product::BillOfLading::BillOfLadingV1CarrierItem>]
+        attr_reader :carrier_items
+        # The party to whom the goods are being shipped.
+        # @return [Mindee::Product::BillOfLading::BillOfLadingV1Consignee]
+        attr_reader :consignee
+        # The date when the bill of lading is issued.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date_of_issue
+        # The date when the vessel departs from the port of loading.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :departure_date
+        # The party to be notified of the arrival of the goods.
+        # @return [Mindee::Product::BillOfLading::BillOfLadingV1NotifyParty]
+        attr_reader :notify_party
+        # The place where the goods are to be delivered.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :place_of_delivery
+        # The port where the goods are unloaded from the vessel.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :port_of_discharge
+        # The port where the goods are loaded onto the vessel.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :port_of_loading
+        # The party responsible for shipping the goods.
+        # @return [Mindee::Product::BillOfLading::BillOfLadingV1Shipper]
+        attr_reader :shipper
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @bill_of_lading_number = StringField.new(prediction['bill_of_lading_number'], page_id)
+          @carrier = BillOfLadingV1Carrier.new(prediction['carrier'], page_id)
+          @carrier_items = []
+          prediction['carrier_items'].each do |item|
+            @carrier_items.push(BillOfLadingV1CarrierItem.new(item, page_id))
+          end
+          @consignee = BillOfLadingV1Consignee.new(prediction['consignee'], page_id)
+          @date_of_issue = DateField.new(prediction['date_of_issue'], page_id)
+          @departure_date = DateField.new(prediction['departure_date'], page_id)
+          @notify_party = BillOfLadingV1NotifyParty.new(prediction['notify_party'], page_id)
+          @place_of_delivery = StringField.new(prediction['place_of_delivery'], page_id)
+          @port_of_discharge = StringField.new(prediction['port_of_discharge'], page_id)
+          @port_of_loading = StringField.new(prediction['port_of_loading'], page_id)
+          @shipper = BillOfLadingV1Shipper.new(prediction['shipper'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          shipper = @shipper.to_s
+          consignee = @consignee.to_s
+          notify_party = @notify_party.to_s
+          carrier = @carrier.to_s
+          carrier_items = carrier_items_to_s
+          out_str = String.new
+          out_str << "\n:Bill of Lading Number: #{@bill_of_lading_number}".rstrip
+          out_str << "\n:Shipper:"
+          out_str << shipper
+          out_str << "\n:Consignee:"
+          out_str << consignee
+          out_str << "\n:Notify Party:"
+          out_str << notify_party
+          out_str << "\n:Carrier:"
+          out_str << carrier
+          out_str << "\n:Items:"
+          out_str << carrier_items
+          out_str << "\n:Port of Loading: #{@port_of_loading}".rstrip
+          out_str << "\n:Port of Discharge: #{@port_of_discharge}".rstrip
+          out_str << "\n:Place of Delivery: #{@place_of_delivery}".rstrip
+          out_str << "\n:Date of issue: #{@date_of_issue}".rstrip
+          out_str << "\n:Departure Date: #{@departure_date}".rstrip
+          out_str[1..].to_s
+        end
+
+        private
+
+        # @param char [String]
+        # @return [String]
+        def carrier_items_separator(char)
+          out_str = String.new
+          out_str << '  '
+          out_str << "+#{char * 38}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 13}"
+          out_str << "+#{char * 18}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 13}"
+          out_str << '+'
+          out_str
+        end
+
+        # @return [String]
+        def carrier_items_to_s
+          return '' if @carrier_items.empty?
+
+          line_items = @carrier_items.map(&:to_table_line).join("\n#{carrier_items_separator('-')}\n  ")
+          out_str = String.new
+          out_str << "\n#{carrier_items_separator('-')}"
+          out_str << "\n  |"
+          out_str << ' Description                          |'
+          out_str << ' Gross Weight |'
+          out_str << ' Measurement |'
+          out_str << ' Measurement Unit |'
+          out_str << ' Quantity |'
+          out_str << ' Weight Unit |'
+          out_str << "\n#{carrier_items_separator('=')}"
+          out_str << "\n  #{line_items}"
+          out_str << "\n#{carrier_items_separator('-')}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_notify_party.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module BillOfLading
+      # The party to be notified of the arrival of the goods.
+      class BillOfLadingV1NotifyParty < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The address of the notify party.
+        # @return [String]
+        attr_reader :address
+        # The  email of the shipper.
+        # @return [String]
+        attr_reader :email
+        # The name of the notify party.
+        # @return [String]
+        attr_reader :name
+        # The phone number of the notify party.
+        # @return [String]
+        attr_reader :phone
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @address = prediction['address']
+          @email = prediction['email']
+          @name = prediction['name']
+          @phone = prediction['phone']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:address] = format_for_display(@address)
+          printable[:email] = format_for_display(@email)
+          printable[:name] = format_for_display(@name)
+          printable[:phone] = format_for_display(@phone)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Address: #{printable[:address]}"
+          out_str << "\n  :Email: #{printable[:email]}"
+          out_str << "\n  :Name: #{printable[:name]}"
+          out_str << "\n  :Phone: #{printable[:phone]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'bill_of_lading_v1_document'
+
+module Mindee
+  module Product
+    module BillOfLading
+      # Bill of Lading API version 1.1 page data.
+      class BillOfLadingV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = BillOfLadingV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Bill of Lading V1 page prediction.
+      class BillOfLadingV1PagePrediction < BillOfLadingV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_shipper.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module BillOfLading
+      # The party responsible for shipping the goods.
+      class BillOfLadingV1Shipper < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # The address of the shipper.
+        # @return [String]
+        attr_reader :address
+        # The  email of the shipper.
+        # @return [String]
+        attr_reader :email
+        # The name of the shipper.
+        # @return [String]
+        attr_reader :name
+        # The phone number of the shipper.
+        # @return [String]
+        attr_reader :phone
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @address = prediction['address']
+          @email = prediction['email']
+          @name = prediction['name']
+          @phone = prediction['phone']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:address] = format_for_display(@address)
+          printable[:email] = format_for_display(@email)
+          printable[:name] = format_for_display(@name)
+          printable[:phone] = format_for_display(@phone)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Address: #{printable[:address]}"
+          out_str << "\n  :Email: #{printable[:email]}"
+          out_str << "\n  :Name: #{printable[:name]}"
+          out_str << "\n  :Phone: #{printable[:phone]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/financial_document/financial_document_v1_line_item.rb

@@ -50,6 +50,20 @@ module Mindee
 
         # @return [Hash]
         def printable_values
+          printable = {}
+          printable[:description] = format_for_display(@description)
+          printable[:product_code] = format_for_display(@product_code)
+          printable[:quantity] = @quantity.nil? ? '' : Field.float_to_string(@quantity)
+          printable[:tax_amount] = @tax_amount.nil? ? '' : Field.float_to_string(@tax_amount)
+          printable[:tax_rate] = @tax_rate.nil? ? '' : Field.float_to_string(@tax_rate)
+          printable[:total_amount] = @total_amount.nil? ? '' : Field.float_to_string(@total_amount)
+          printable[:unit_measure] = format_for_display(@unit_measure)
+          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[:product_code] = format_for_display(@product_code, nil)
@@ -64,7 +78,7 @@ module Mindee
 
         # @return [String]
         def to_table_line
-          printable = printable_values
+          printable = table_printable_values
           out_str = String.new
           out_str << format('| %- 37s', printable[:description])
           out_str << format('| %- 13s', printable[:product_code])

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

@@ -36,24 +36,13 @@ module Mindee
           # @return [Hash]
           def printable_values
             printable = {}
-            printable[:bban_bank_code] = format_for_display(@bban_bank_code, nil)
-            printable[:bban_branch_code] = format_for_display(@bban_branch_code, nil)
-            printable[:bban_key] = format_for_display(@bban_key, nil)
-            printable[:bban_number] = format_for_display(@bban_number, nil)
+            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_table_line
-            printable = printable_values
-            out_str = String.new
-            out_str << format('| %- 10s', printable[:bban_bank_code])
-            out_str << format('| %- 12s', printable[:bban_branch_code])
-            out_str << format('| %- 4s', printable[:bban_key])
-            out_str << format('| %- 15s', printable[:bban_number])
-            out_str << '|'
-          end
-
           # @return [String]
           def to_s
             printable = printable_values

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'energy_bill_v1_document'
+require_relative 'energy_bill_v1_page'
+
+module Mindee
+  module Product
+    module FR
+      # Energy Bill module.
+      module EnergyBill
+        # Energy Bill API version 1 inference prediction.
+        class EnergyBillV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'energy_bill_fra'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = EnergyBillV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(EnergyBillV1Page.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