mindee 3.20.0 → 4.0.0

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

@@ -28,7 +28,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @amount = prediction['amount']
             @base = prediction['base']
             @description = prediction['description']
@@ -40,22 +40,30 @@ module Mindee
           # @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[:amount] =
+              @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
+            printable[:base] =
+              @base.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@base)
             printable[:description] = format_for_display(@description)
-            printable[:number] = @number.nil? ? '' : Field.float_to_string(@number)
-            printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
+            printable[:number] =
+              @number.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@number)
+            printable[:rate] =
+              @rate.nil? ? '' : Parsing::Standard::BaseField.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[:amount] =
+              @amount.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@amount)
+            printable[:base] =
+              @base.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@base)
             printable[:description] = format_for_display(@description, 36)
-            printable[:number] = @number.nil? ? '' : Field.float_to_string(@number)
-            printable[:rate] = @rate.nil? ? '' : Field.float_to_string(@rate)
+            printable[:number] =
+              @number.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@number)
+            printable[:rate] =
+              @rate.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@rate)
             printable
           end
 

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'payslip_v3_pay_period'
+require_relative 'payslip_v3_employee'
+require_relative 'payslip_v3_employer'
+require_relative 'payslip_v3_bank_account_detail'
+require_relative 'payslip_v3_employment'
+require_relative 'payslip_v3_salary_detail'
+require_relative 'payslip_v3_pay_detail'
+require_relative 'payslip_v3_paid_time_off'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Detailed information about the earnings.
+        class PayslipV3SalaryDetails < Array
+          # Entries.
+          # @return [Array<PayslipV3SalaryDetail>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              Payslip::PayslipV3SalaryDetail.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 * 14}"
+            out_str << "+#{char * 11}"
+            out_str << "+#{char * 38}"
+            out_str << "+#{char * 8}"
+            out_str << "+#{char * 11}"
+            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 << ' | Amount      '
+            out_str << ' | Base     '
+            out_str << ' | Description                         '
+            out_str << ' | Number'
+            out_str << ' | Rate     '
+            out_str << (" |\n#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/ind/indian_passport/indian_passport_v1.rb

@@ -13,6 +13,8 @@ module Mindee
         class IndianPassportV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'ind_passport'
           @endpoint_version = '1'
+          @has_async = true
+          @has_sync = false
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = IndianPassportV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(IndianPassportV1Page.new(page))
-              end
+              @pages.push(IndianPassportV1Page.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/ind/indian_passport/indian_passport_v1_document.rb

@@ -82,30 +82,93 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @address1 = StringField.new(prediction['address1'], page_id)
-            @address2 = StringField.new(prediction['address2'], page_id)
-            @address3 = StringField.new(prediction['address3'], page_id)
-            @birth_date = DateField.new(prediction['birth_date'], page_id)
-            @birth_place = StringField.new(prediction['birth_place'], page_id)
-            @country = StringField.new(prediction['country'], page_id)
-            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-            @file_number = StringField.new(prediction['file_number'], page_id)
-            @gender = ClassificationField.new(prediction['gender'], page_id)
-            @given_names = StringField.new(prediction['given_names'], page_id)
-            @id_number = StringField.new(prediction['id_number'], page_id)
-            @issuance_date = DateField.new(prediction['issuance_date'], page_id)
-            @issuance_place = StringField.new(prediction['issuance_place'], page_id)
-            @legal_guardian = StringField.new(prediction['legal_guardian'], page_id)
-            @mrz1 = StringField.new(prediction['mrz1'], page_id)
-            @mrz2 = StringField.new(prediction['mrz2'], page_id)
-            @name_of_mother = StringField.new(prediction['name_of_mother'], page_id)
-            @name_of_spouse = StringField.new(prediction['name_of_spouse'], page_id)
-            @old_passport_date_of_issue = DateField.new(prediction['old_passport_date_of_issue'], page_id)
-            @old_passport_number = StringField.new(prediction['old_passport_number'], page_id)
-            @old_passport_place_of_issue = StringField.new(prediction['old_passport_place_of_issue'], page_id)
-            @page_number = ClassificationField.new(prediction['page_number'], page_id)
-            @surname = StringField.new(prediction['surname'], page_id)
+            super
+            @address1 = Parsing::Standard::StringField.new(
+              prediction['address1'],
+              page_id
+            )
+            @address2 = Parsing::Standard::StringField.new(
+              prediction['address2'],
+              page_id
+            )
+            @address3 = Parsing::Standard::StringField.new(
+              prediction['address3'],
+              page_id
+            )
+            @birth_date = Parsing::Standard::DateField.new(
+              prediction['birth_date'],
+              page_id
+            )
+            @birth_place = Parsing::Standard::StringField.new(
+              prediction['birth_place'],
+              page_id
+            )
+            @country = Parsing::Standard::StringField.new(
+              prediction['country'],
+              page_id
+            )
+            @expiry_date = Parsing::Standard::DateField.new(
+              prediction['expiry_date'],
+              page_id
+            )
+            @file_number = Parsing::Standard::StringField.new(
+              prediction['file_number'],
+              page_id
+            )
+            @gender = Parsing::Standard::ClassificationField.new(
+              prediction['gender'],
+              page_id
+            )
+            @given_names = Parsing::Standard::StringField.new(
+              prediction['given_names'],
+              page_id
+            )
+            @id_number = Parsing::Standard::StringField.new(
+              prediction['id_number'],
+              page_id
+            )
+            @issuance_date = Parsing::Standard::DateField.new(
+              prediction['issuance_date'],
+              page_id
+            )
+            @issuance_place = Parsing::Standard::StringField.new(
+              prediction['issuance_place'],
+              page_id
+            )
+            @legal_guardian = Parsing::Standard::StringField.new(
+              prediction['legal_guardian'],
+              page_id
+            )
+            @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
+            @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
+            @name_of_mother = Parsing::Standard::StringField.new(
+              prediction['name_of_mother'],
+              page_id
+            )
+            @name_of_spouse = Parsing::Standard::StringField.new(
+              prediction['name_of_spouse'],
+              page_id
+            )
+            @old_passport_date_of_issue = Parsing::Standard::DateField.new(
+              prediction['old_passport_date_of_issue'],
+              page_id
+            )
+            @old_passport_number = Parsing::Standard::StringField.new(
+              prediction['old_passport_number'],
+              page_id
+            )
+            @old_passport_place_of_issue = Parsing::Standard::StringField.new(
+              prediction['old_passport_place_of_issue'],
+              page_id
+            )
+            @page_number = Parsing::Standard::ClassificationField.new(
+              prediction['page_number'],
+              page_id
+            )
+            @surname = Parsing::Standard::StringField.new(
+              prediction['surname'],
+              page_id
+            )
           end
 
           # @return [String]

data/lib/mindee/product/ind/indian_passport/indian_passport_v1_page.rb

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

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

@@ -12,6 +12,8 @@ module Mindee
       class InternationalIdV2 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'international_id'
         @endpoint_version = '2'
+        @has_async = true
+        @has_sync = false
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = InternationalIdV2Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(InternationalIdV2Page.new(page))
-            end
+            @pages.push(InternationalIdV2Page.new(page))
           end
         end
 
@@ -32,6 +32,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/international_id/international_id_v2_document.rb

@@ -63,29 +63,71 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @address = StringField.new(prediction['address'], page_id)
-          @birth_date = DateField.new(prediction['birth_date'], page_id)
-          @birth_place = StringField.new(prediction['birth_place'], page_id)
-          @country_of_issue = StringField.new(prediction['country_of_issue'], page_id)
-          @document_number = StringField.new(prediction['document_number'], page_id)
-          @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-          @given_names = []
+          super
+          @address = Parsing::Standard::StringField.new(
+            prediction['address'],
+            page_id
+          )
+          @birth_date = Parsing::Standard::DateField.new(
+            prediction['birth_date'],
+            page_id
+          )
+          @birth_place = Parsing::Standard::StringField.new(
+            prediction['birth_place'],
+            page_id
+          )
+          @country_of_issue = Parsing::Standard::StringField.new(
+            prediction['country_of_issue'],
+            page_id
+          )
+          @document_number = Parsing::Standard::StringField.new(
+            prediction['document_number'],
+            page_id
+          )
+          @document_type = Parsing::Standard::ClassificationField.new(
+            prediction['document_type'],
+            page_id
+          )
+          @expiry_date = Parsing::Standard::DateField.new(
+            prediction['expiry_date'],
+            page_id
+          )
+          @given_names = [] # : Array[Parsing::Standard::StringField]
           prediction['given_names'].each do |item|
-            @given_names.push(StringField.new(item, page_id))
+            @given_names.push(Parsing::Standard::StringField.new(item, page_id))
           end
-          @issue_date = DateField.new(prediction['issue_date'], page_id)
-          @mrz_line1 = StringField.new(prediction['mrz_line1'], page_id)
-          @mrz_line2 = StringField.new(prediction['mrz_line2'], page_id)
-          @mrz_line3 = StringField.new(prediction['mrz_line3'], page_id)
-          @nationality = StringField.new(prediction['nationality'], page_id)
-          @personal_number = StringField.new(prediction['personal_number'], page_id)
-          @sex = StringField.new(prediction['sex'], page_id)
-          @state_of_issue = StringField.new(prediction['state_of_issue'], page_id)
-          @surnames = []
+          @issue_date = Parsing::Standard::DateField.new(
+            prediction['issue_date'],
+            page_id
+          )
+          @mrz_line1 = Parsing::Standard::StringField.new(
+            prediction['mrz_line1'],
+            page_id
+          )
+          @mrz_line2 = Parsing::Standard::StringField.new(
+            prediction['mrz_line2'],
+            page_id
+          )
+          @mrz_line3 = Parsing::Standard::StringField.new(
+            prediction['mrz_line3'],
+            page_id
+          )
+          @nationality = Parsing::Standard::StringField.new(
+            prediction['nationality'],
+            page_id
+          )
+          @personal_number = Parsing::Standard::StringField.new(
+            prediction['personal_number'],
+            page_id
+          )
+          @sex = Parsing::Standard::StringField.new(prediction['sex'], page_id)
+          @state_of_issue = Parsing::Standard::StringField.new(
+            prediction['state_of_issue'],
+            page_id
+          )
+          @surnames = [] # : Array[Parsing::Standard::StringField]
           prediction['surnames'].each do |item|
-            @surnames.push(StringField.new(item, page_id))
+            @surnames.push(Parsing::Standard::StringField.new(item, page_id))
           end
         end
 

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

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

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

@@ -12,6 +12,8 @@ module Mindee
       class InvoiceV4 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'invoices'
         @endpoint_version = '4'
+        @has_async = true
+        @has_sync = true
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = InvoiceV4Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(InvoiceV4Page.new(page))
-            end
+            @pages.push(InvoiceV4Page.new(page))
           end
         end
 
@@ -32,6 +32,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/invoice/invoice_v4_document.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'invoice_v4_line_item'
+require_relative 'invoice_v4_line_items'
 
 module Mindee
   module Product
@@ -37,7 +37,7 @@ module Mindee
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :invoice_number
         # List of line item details.
-        # @return [Array<Mindee::Product::Invoice::InvoiceV4LineItem>]
+        # @return [Mindee::Product::Invoice::InvoiceV4LineItems]
         attr_reader :line_items
         # The locale detected on the document.
         # @return [Mindee::Parsing::Standard::LocaleField]
@@ -91,48 +91,102 @@ 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)
-          @customer_address = StringField.new(prediction['customer_address'], page_id)
-          @customer_company_registrations = []
+          super
+          @billing_address = Parsing::Standard::StringField.new(
+            prediction['billing_address'],
+            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_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(InvoiceV4LineItem.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)
-          @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_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::Invoice::InvoiceV4LineItems.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
+          )
+          @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)
-          @supplier_address = StringField.new(prediction['supplier_address'], page_id)
-          @supplier_company_registrations = []
+          @shipping_address = Parsing::Standard::StringField.new(
+            prediction['shipping_address'],
+            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)
-          @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)
+          @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]