mindee 3.19.1 → 4.0.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'financial_document_v1_line_item'
+require_relative 'financial_document_v1_line_items'
 
 module Mindee
   module Product
@@ -43,7 +43,7 @@ module Mindee
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :invoice_number
         # List of line item details.
-        # @return [Array<Mindee::Product::FinancialDocument::FinancialDocumentV1LineItem>]
+        # @return [Mindee::Product::FinancialDocument::FinancialDocumentV1LineItems]
         attr_reader :line_items
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
@@ -109,54 +109,122 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @billing_address = StringField.new(prediction['billing_address'], page_id)
-          @category = ClassificationField.new(prediction['category'], page_id)
-          @customer_address = StringField.new(prediction['customer_address'], page_id)
-          @customer_company_registrations = []
+          super
+          @billing_address = Parsing::Standard::StringField.new(
+            prediction['billing_address'],
+            page_id
+          )
+          @category = Parsing::Standard::ClassificationField.new(
+            prediction['category'],
+            page_id
+          )
+          @customer_address = Parsing::Standard::StringField.new(
+            prediction['customer_address'],
+            page_id
+          )
+          @customer_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
           prediction['customer_company_registrations'].each do |item|
-            @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
+            @customer_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
           end
-          @customer_id = StringField.new(prediction['customer_id'], page_id)
-          @customer_name = StringField.new(prediction['customer_name'], page_id)
-          @date = DateField.new(prediction['date'], page_id)
-          @document_number = StringField.new(prediction['document_number'], page_id)
-          @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @due_date = DateField.new(prediction['due_date'], page_id)
-          @invoice_number = StringField.new(prediction['invoice_number'], page_id)
-          @line_items = []
-          prediction['line_items'].each do |item|
-            @line_items.push(FinancialDocumentV1LineItem.new(item, page_id))
-          end
-          @locale = LocaleField.new(prediction['locale'], page_id)
-          @payment_date = DateField.new(prediction['payment_date'], page_id)
-          @po_number = StringField.new(prediction['po_number'], page_id)
-          @receipt_number = StringField.new(prediction['receipt_number'], page_id)
-          @reference_numbers = []
+          @customer_id = Parsing::Standard::StringField.new(
+            prediction['customer_id'],
+            page_id
+          )
+          @customer_name = Parsing::Standard::StringField.new(
+            prediction['customer_name'],
+            page_id
+          )
+          @date = Parsing::Standard::DateField.new(prediction['date'], page_id)
+          @document_number = Parsing::Standard::StringField.new(
+            prediction['document_number'],
+            page_id
+          )
+          @document_type = Parsing::Standard::ClassificationField.new(
+            prediction['document_type'],
+            page_id
+          )
+          @due_date = Parsing::Standard::DateField.new(
+            prediction['due_date'],
+            page_id
+          )
+          @invoice_number = Parsing::Standard::StringField.new(
+            prediction['invoice_number'],
+            page_id
+          )
+          @line_items = Product::FinancialDocument::FinancialDocumentV1LineItems.new(
+            prediction['line_items'], page_id
+          )
+          @locale = Parsing::Standard::LocaleField.new(
+            prediction['locale'],
+            page_id
+          )
+          @payment_date = Parsing::Standard::DateField.new(
+            prediction['payment_date'],
+            page_id
+          )
+          @po_number = Parsing::Standard::StringField.new(
+            prediction['po_number'],
+            page_id
+          )
+          @receipt_number = Parsing::Standard::StringField.new(
+            prediction['receipt_number'],
+            page_id
+          )
+          @reference_numbers = [] # : Array[Parsing::Standard::StringField]
           prediction['reference_numbers'].each do |item|
-            @reference_numbers.push(StringField.new(item, page_id))
+            @reference_numbers.push(Parsing::Standard::StringField.new(item, page_id))
           end
-          @shipping_address = StringField.new(prediction['shipping_address'], page_id)
-          @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
-          @supplier_address = StringField.new(prediction['supplier_address'], page_id)
-          @supplier_company_registrations = []
+          @shipping_address = Parsing::Standard::StringField.new(
+            prediction['shipping_address'],
+            page_id
+          )
+          @subcategory = Parsing::Standard::ClassificationField.new(
+            prediction['subcategory'],
+            page_id
+          )
+          @supplier_address = Parsing::Standard::StringField.new(
+            prediction['supplier_address'],
+            page_id
+          )
+          @supplier_company_registrations = [] # : Array[Parsing::Standard::CompanyRegistrationField]
           prediction['supplier_company_registrations'].each do |item|
-            @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
+            @supplier_company_registrations.push(Parsing::Standard::CompanyRegistrationField.new(item, page_id))
           end
-          @supplier_email = StringField.new(prediction['supplier_email'], page_id)
-          @supplier_name = StringField.new(prediction['supplier_name'], page_id)
-          @supplier_payment_details = []
+          @supplier_email = Parsing::Standard::StringField.new(
+            prediction['supplier_email'],
+            page_id
+          )
+          @supplier_name = Parsing::Standard::StringField.new(
+            prediction['supplier_name'],
+            page_id
+          )
+          @supplier_payment_details = [] # : Array[Parsing::Standard::PaymentDetailsField]
           prediction['supplier_payment_details'].each do |item|
-            @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
+            @supplier_payment_details.push(Parsing::Standard::PaymentDetailsField.new(item, page_id))
           end
-          @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
-          @supplier_website = StringField.new(prediction['supplier_website'], page_id)
-          @taxes = Taxes.new(prediction['taxes'], page_id)
-          @time = StringField.new(prediction['time'], page_id)
-          @tip = AmountField.new(prediction['tip'], page_id)
-          @total_amount = AmountField.new(prediction['total_amount'], page_id)
-          @total_net = AmountField.new(prediction['total_net'], page_id)
-          @total_tax = AmountField.new(prediction['total_tax'], page_id)
+          @supplier_phone_number = Parsing::Standard::StringField.new(
+            prediction['supplier_phone_number'],
+            page_id
+          )
+          @supplier_website = Parsing::Standard::StringField.new(
+            prediction['supplier_website'],
+            page_id
+          )
+          @taxes = Parsing::Standard::Taxes.new(prediction['taxes'], page_id)
+          @time = Parsing::Standard::StringField.new(prediction['time'], page_id)
+          @tip = Parsing::Standard::AmountField.new(prediction['tip'], page_id)
+          @total_amount = Parsing::Standard::AmountField.new(
+            prediction['total_amount'],
+            page_id
+          )
+          @total_net = Parsing::Standard::AmountField.new(
+            prediction['total_net'],
+            page_id
+          )
+          @total_tax = Parsing::Standard::AmountField.new(
+            prediction['total_tax'],
+            page_id
+          )
         end
 
         # @return [String]

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

@@ -36,7 +36,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @description = prediction['description']
           @product_code = prediction['product_code']
           @quantity = prediction['quantity']
@@ -53,12 +53,17 @@ module Mindee
           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[:quantity] =
+            @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+          printable[:tax_amount] =
+            @tax_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_amount)
+          printable[:tax_rate] =
+            @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+          printable[:total_amount] =
+            @total_amount.nil? ? '' : Parsing::Standard::BaseField.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[:unit_price] =
+            @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
           printable
         end
 
@@ -67,12 +72,17 @@ module Mindee
           printable = {}
           printable[:description] = format_for_display(@description, 36)
           printable[:product_code] = format_for_display(@product_code, nil)
-          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[:quantity] =
+            @quantity.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@quantity)
+          printable[:tax_amount] =
+            @tax_amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_amount)
+          printable[:tax_rate] =
+            @tax_rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@tax_rate)
+          printable[:total_amount] =
+            @total_amount.nil? ? '' : Parsing::Standard::BaseField.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[:unit_price] =
+            @unit_price.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@unit_price)
           printable
         end
 

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'financial_document_v1_line_item'
+
+module Mindee
+  module Product
+    module FinancialDocument
+      # List of line item details.
+      class FinancialDocumentV1LineItems < Array
+        # Entries.
+        # @return [Array<FinancialDocumentV1LineItem>]
+        attr_reader :entries
+
+        # @param prediction [Array]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          entries = prediction.map do |entry|
+            FinancialDocument::FinancialDocumentV1LineItem.new(entry, page_id)
+          end
+          super(entries)
+        end
+
+        # Creates a line of rST table-compliant string separators.
+        # @param char [String] Character to use as a separator.
+        # @return [String]
+        def self.line_items_separator(char)
+          out_str = String.new
+          out_str << "+#{char * 38}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 10}"
+          out_str << "+#{char * 12}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 14}"
+          out_str << "+#{char * 17}"
+          out_str << "+#{char * 12}"
+          out_str
+        end
+
+        # @return [String]
+        def to_s
+          return '' if empty?
+
+          lines = map do |entry|
+            "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+          end.join
+          out_str = String.new
+          out_str << ("\n#{self.class.line_items_separator('-')}\n ")
+          out_str << ' | Description                         '
+          out_str << ' | Product code'
+          out_str << ' | Quantity'
+          out_str << ' | Tax Amount'
+          out_str << ' | Tax Rate (%)'
+          out_str << ' | Total Amount'
+          out_str << ' | Unit of measure'
+          out_str << ' | Unit Price'
+          out_str << (" |\n#{self.class.line_items_separator('=')}")
+          out_str + lines
+        end
+      end
+    end
+  end
+end

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

@@ -10,11 +10,15 @@ module Mindee
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
-          super(prediction)
-          @prediction = FinancialDocumentV1PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
+          super
+          @prediction = if prediction['prediction'].empty?
+                          nil
+                        else
+                          FinancialDocumentV1PagePrediction.new(
+                            prediction['prediction'],
+                            prediction['id']
+                          )
+                        end
         end
       end
 

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

@@ -13,6 +13,8 @@ module Mindee
         class BankAccountDetailsV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'bank_account_details'
           @endpoint_version = '1'
+          @has_async = false
+          @has_sync = true
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = BankAccountDetailsV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(BankAccountDetailsV1Page.new(page))
-              end
+              @pages.push(BankAccountDetailsV1Page.new(page))
             end
           end
 
@@ -33,6 +33,12 @@ module Mindee
             # Version for this product.
             # @return [String]
             attr_reader :endpoint_version
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
           end
         end
       end

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

@@ -22,10 +22,13 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @account_holder_name = StringField.new(prediction['account_holder_name'], page_id)
-            @iban = StringField.new(prediction['iban'], page_id)
-            @swift = StringField.new(prediction['swift'], page_id)
+            super
+            @account_holder_name = Parsing::Standard::StringField.new(
+              prediction['account_holder_name'],
+              page_id
+            )
+            @iban = Parsing::Standard::StringField.new(prediction['iban'], page_id)
+            @swift = Parsing::Standard::StringField.new(prediction['swift'], page_id)
           end
 
           # @return [String]

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

@@ -11,11 +11,15 @@ module Mindee
         class BankAccountDetailsV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = BankAccountDetailsV1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            BankAccountDetailsV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 

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

@@ -13,6 +13,8 @@ module Mindee
         class BankAccountDetailsV2 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'bank_account_details'
           @endpoint_version = '2'
+          @has_async = false
+          @has_sync = true
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = BankAccountDetailsV2Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(BankAccountDetailsV2Page.new(page))
-              end
+              @pages.push(BankAccountDetailsV2Page.new(page))
             end
           end
 
@@ -33,6 +33,12 @@ module Mindee
             # Version for this product.
             # @return [String]
             attr_reader :endpoint_version
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
           end
         end
       end

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

@@ -25,7 +25,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @bban_bank_code = prediction['bban_bank_code']
             @bban_branch_code = prediction['bban_branch_code']
             @bban_key = prediction['bban_key']

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

@@ -26,11 +26,17 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @account_holders_names = StringField.new(prediction['account_holders_names'], page_id)
-            @bban = BankAccountDetailsV2Bban.new(prediction['bban'], page_id)
-            @iban = StringField.new(prediction['iban'], page_id)
-            @swift_code = StringField.new(prediction['swift_code'], page_id)
+            super
+            @account_holders_names = Parsing::Standard::StringField.new(
+              prediction['account_holders_names'],
+              page_id
+            )
+            @bban = Product::FR::BankAccountDetails::BankAccountDetailsV2Bban.new(prediction['bban'], page_id)
+            @iban = Parsing::Standard::StringField.new(prediction['iban'], page_id)
+            @swift_code = Parsing::Standard::StringField.new(
+              prediction['swift_code'],
+              page_id
+            )
           end
 
           # @return [String]

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

@@ -11,11 +11,15 @@ module Mindee
         class BankAccountDetailsV2Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = BankAccountDetailsV2PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            BankAccountDetailsV2PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 

data/lib/mindee/product/fr/bank_statement/bank_statement_v2.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'bank_statement_v2_document'
+require_relative 'bank_statement_v2_page'
+
+module Mindee
+  module Product
+    module FR
+      # Bank Statement module.
+      module BankStatement
+        # Bank Statement API version 2 inference prediction.
+        class BankStatementV2 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'bank_statement_fr'
+          @endpoint_version = '2'
+          @has_async = true
+          @has_sync = false
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = BankStatementV2Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              @pages.push(BankStatementV2Page.new(page))
+            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
+            # Whether this product has access to an asynchronous endpoint.
+            # @return [bool]
+            attr_reader :has_async
+            # Whether this product has access to synchronous endpoint.
+            # @return [bool]
+            attr_reader :has_sync
+          end
+        end
+      end
+    end
+  end
+end