mindee 3.11.0 → 3.13.0

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Information about the pay period.
+        class PayslipV2PayPeriod < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The end date of the pay period.
+          # @return [String]
+          attr_reader :end_date
+          # The month of the pay period.
+          # @return [String]
+          attr_reader :month
+          # The date of payment for the pay period.
+          # @return [String]
+          attr_reader :payment_date
+          # The start date of the pay period.
+          # @return [String]
+          attr_reader :start_date
+          # The year of the pay period.
+          # @return [String]
+          attr_reader :year
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @end_date = prediction['end_date']
+            @month = prediction['month']
+            @payment_date = prediction['payment_date']
+            @start_date = prediction['start_date']
+            @year = prediction['year']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:end_date] = format_for_display(@end_date)
+            printable[:month] = format_for_display(@month)
+            printable[:payment_date] = format_for_display(@payment_date)
+            printable[:start_date] = format_for_display(@start_date)
+            printable[:year] = format_for_display(@year)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :End Date: #{printable[:end_date]}"
+            out_str << "\n  :Month: #{printable[:month]}"
+            out_str << "\n  :Payment Date: #{printable[:payment_date]}"
+            out_str << "\n  :Start Date: #{printable[:start_date]}"
+            out_str << "\n  :Year: #{printable[:year]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Information about paid time off.
+        class PayslipV2Pto < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The amount of paid time off accrued in this period.
+          # @return [Float]
+          attr_reader :accrued_this_period
+          # The balance of paid time off at the end of the period.
+          # @return [Float]
+          attr_reader :balance_end_of_period
+          # The amount of paid time off used in this period.
+          # @return [Float]
+          attr_reader :used_this_period
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @accrued_this_period = prediction['accrued_this_period']
+            @balance_end_of_period = prediction['balance_end_of_period']
+            @used_this_period = prediction['used_this_period']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:accrued_this_period] =
+              @accrued_this_period.nil? ? '' : Field.float_to_string(@accrued_this_period)
+            printable[:balance_end_of_period] =
+              @balance_end_of_period.nil? ? '' : Field.float_to_string(@balance_end_of_period)
+            printable[:used_this_period] = @used_this_period.nil? ? '' : Field.float_to_string(@used_this_period)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Accrued This Period: #{printable[:accrued_this_period]}"
+            out_str << "\n  :Balance End of Period: #{printable[:balance_end_of_period]}"
+            out_str << "\n  :Used This Period: #{printable[:used_this_period]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Detailed information about the earnings.
+        class PayslipV2SalaryDetail < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The amount of the earnings.
+          # @return [Float]
+          attr_reader :amount
+          # The base value of the earnings.
+          # @return [Float]
+          attr_reader :base
+          # The description of the earnings.
+          # @return [String]
+          attr_reader :description
+          # The rate of the earnings.
+          # @return [Float]
+          attr_reader :rate
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @amount = prediction['amount']
+            @base = prediction['base']
+            @description = prediction['description']
+            @rate = prediction['rate']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
+            printable[:base] = @base.nil? ? '' : Field.float_to_string(@base)
+            printable[:description] = format_for_display(@description)
+            printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {}
+            printable[:amount] = @amount.nil? ? '' : Field.float_to_string(@amount)
+            printable[:base] = @base.nil? ? '' : Field.float_to_string(@base)
+            printable[:description] = format_for_display(@description, 36)
+            printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 13s', printable[:amount])
+            out_str << format('| %- 10s', printable[:base])
+            out_str << format('| %- 37s', printable[:description])
+            out_str << format('| %- 10s', printable[:rate])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Amount: #{printable[:amount]}"
+            out_str << "\n  :Base: #{printable[:base]}"
+            out_str << "\n  :Description: #{printable[:description]}"
+            out_str << "\n  :Rate: #{printable[:rate]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/international_id/international_id_v2_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module InternationalId
-      # International ID API version 2.0 document data.
+      # International ID API version 2.1 document data.
       class InternationalIdV2Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The physical address of the document holder.

data/lib/mindee/product/international_id/international_id_v2_page.rb

@@ -6,7 +6,7 @@ require_relative 'international_id_v2_document'
 module Mindee
   module Product
     module InternationalId
-      # International ID API version 2.0 page data.
+      # International ID API version 2.1 page data.
       class InternationalIdV2Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/invoice/invoice_v4_document.rb

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_line_item'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.6 document data.
+      # Invoice API version 4.7 document data.
       class InvoiceV4Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.
@@ -176,6 +176,7 @@ module Mindee
           out_str << "+#{char * 12}"
           out_str << "+#{char * 14}"
           out_str << "+#{char * 14}"
+          out_str << "+#{char * 17}"
           out_str << "+#{char * 12}"
           out_str << '+'
           out_str
@@ -195,6 +196,7 @@ module Mindee
           out_str << ' Tax Amount |'
           out_str << ' Tax Rate (%) |'
           out_str << ' Total Amount |'
+          out_str << ' Unit of measure |'
           out_str << ' Unit Price |'
           out_str << "\n#{line_items_separator('=')}"
           out_str << "\n  #{line_items}"

data/lib/mindee/product/invoice/invoice_v4_line_item.rb

@@ -26,6 +26,9 @@ module Mindee
         # The item total amount.
         # @return [Float]
         attr_reader :total_amount
+        # The item unit of measure.
+        # @return [String]
+        attr_reader :unit_measure
         # The item unit price.
         # @return [Float]
         attr_reader :unit_price
@@ -40,12 +43,27 @@ module Mindee
           @tax_amount = prediction['tax_amount']
           @tax_rate = prediction['tax_rate']
           @total_amount = prediction['total_amount']
+          @unit_measure = prediction['unit_measure']
           @unit_price = prediction['unit_price']
           @page_id = page_id
         end
 
         # @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)
@@ -53,13 +71,14 @@ module Mindee
           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, nil)
           printable[:unit_price] = @unit_price.nil? ? '' : Field.float_to_string(@unit_price)
           printable
         end
 
         # @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])
@@ -67,6 +86,7 @@ module Mindee
           out_str << format('| %- 11s', printable[:tax_amount])
           out_str << format('| %- 13s', printable[:tax_rate])
           out_str << format('| %- 13s', printable[:total_amount])
+          out_str << format('| %- 16s', printable[:unit_measure])
           out_str << format('| %- 11s', printable[:unit_price])
           out_str << '|'
         end
@@ -81,6 +101,7 @@ module Mindee
           out_str << "\n  :Tax Amount: #{printable[:tax_amount]}"
           out_str << "\n  :Tax Rate (%): #{printable[:tax_rate]}"
           out_str << "\n  :Total Amount: #{printable[:total_amount]}"
+          out_str << "\n  :Unit of measure: #{printable[:unit_measure]}"
           out_str << "\n  :Unit Price: #{printable[:unit_price]}"
           out_str
         end

data/lib/mindee/product/invoice/invoice_v4_page.rb

@@ -6,7 +6,7 @@ require_relative 'invoice_v4_document'
 module Mindee
   module Product
     module Invoice
-      # Invoice API version 4.6 page data.
+      # Invoice API version 4.7 page data.
       class InvoiceV4Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_document.rb

@@ -29,7 +29,7 @@ module Mindee
 
       # Invoice Splitter V1 document prediction.
       class InvoiceSplitterV1Document < Mindee::Parsing::Common::Prediction
-        # @return[Array<Mindee::Product::InvoiceSplitterV1PageGroup>]
+        # @return[Array<Mindee::Product::InvoiceSplitter::InvoiceSplitterV1PageGroup>]
         attr_reader :invoice_page_groups
 
         # @param prediction [Hash]

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb

@@ -5,7 +5,7 @@ require_relative '../../parsing'
 module Mindee
   module Product
     module MultiReceiptsDetector
-      # Multi Receipts Detector API version 1.0 document data.
+      # Multi Receipts Detector API version 1.1 document data.
       class MultiReceiptsDetectorV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # Positions of the receipts on the document.

data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'multi_receipts_detector_v1_document'
 module Mindee
   module Product
     module MultiReceiptsDetector
-      # Multi Receipts Detector API version 1.0 page data.
+      # Multi Receipts Detector API version 1.1 page data.
       class MultiReceiptsDetectorV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'nutrition_facts_label_v1_document'
+require_relative 'nutrition_facts_label_v1_page'
+
+module Mindee
+  module Product
+    # Nutrition Facts Label module.
+    module NutritionFactsLabel
+      # Nutrition Facts Label API version 1 inference prediction.
+      class NutritionFactsLabelV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'nutrition_facts'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = NutritionFactsLabelV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(NutritionFactsLabelV1Page.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

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_added_sugar.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of added sugars in the product.
+      class NutritionFactsLabelV1AddedSugar < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of added sugars to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of added sugars per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of added sugars per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
+          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
+          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_calorie.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of calories in the product.
+      class NutritionFactsLabelV1Calorie < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of calories to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of calories per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of calories per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
+          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
+          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_cholesterol.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of cholesterol in the product.
+      class NutritionFactsLabelV1Cholesterol < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of cholesterol to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of cholesterol per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of cholesterol per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
+          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
+          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_dietary_fiber.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module NutritionFactsLabel
+      # The amount of dietary fiber in the product.
+      class NutritionFactsLabelV1DietaryFiber < Mindee::Parsing::Standard::FeatureField
+        include Mindee::Parsing::Standard
+        # DVs are the recommended amounts of dietary fiber to consume or not to exceed each day.
+        # @return [Float]
+        attr_reader :daily_value
+        # The amount of dietary fiber per 100g of the product.
+        # @return [Float]
+        attr_reader :per_100g
+        # The amount of dietary fiber per serving of the product.
+        # @return [Float]
+        attr_reader :per_serving
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super(prediction, page_id)
+          @daily_value = prediction['daily_value']
+          @per_100g = prediction['per_100g']
+          @per_serving = prediction['per_serving']
+          @page_id = page_id
+        end
+
+        # @return [Hash]
+        def printable_values
+          printable = {}
+          printable[:daily_value] = @daily_value.nil? ? '' : Field.float_to_string(@daily_value)
+          printable[:per_100g] = @per_100g.nil? ? '' : Field.float_to_string(@per_100g)
+          printable[:per_serving] = @per_serving.nil? ? '' : Field.float_to_string(@per_serving)
+          printable
+        end
+
+        # @return [String]
+        def to_s
+          printable = printable_values
+          out_str = String.new
+          out_str << "\n  :Daily Value: #{printable[:daily_value]}"
+          out_str << "\n  :Per 100g: #{printable[:per_100g]}"
+          out_str << "\n  :Per Serving: #{printable[:per_serving]}"
+          out_str
+        end
+      end
+    end
+  end
+end