mindee 3.16.0 → 3.18.0

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Information about the employer.
+        class PayslipV3Employer < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The address of the employer.
+          # @return [String]
+          attr_reader :address
+          # The company ID of the employer.
+          # @return [String]
+          attr_reader :company_id
+          # The site of the company.
+          # @return [String]
+          attr_reader :company_site
+          # The NAF code of the employer.
+          # @return [String]
+          attr_reader :naf_code
+          # The name of the employer.
+          # @return [String]
+          attr_reader :name
+          # The phone number of the employer.
+          # @return [String]
+          attr_reader :phone_number
+          # The URSSAF number of the employer.
+          # @return [String]
+          attr_reader :urssaf_number
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @address = prediction['address']
+            @company_id = prediction['company_id']
+            @company_site = prediction['company_site']
+            @naf_code = prediction['naf_code']
+            @name = prediction['name']
+            @phone_number = prediction['phone_number']
+            @urssaf_number = prediction['urssaf_number']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:address] = format_for_display(@address)
+            printable[:company_id] = format_for_display(@company_id)
+            printable[:company_site] = format_for_display(@company_site)
+            printable[:naf_code] = format_for_display(@naf_code)
+            printable[:name] = format_for_display(@name)
+            printable[:phone_number] = format_for_display(@phone_number)
+            printable[:urssaf_number] = format_for_display(@urssaf_number)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Address: #{printable[:address]}"
+            out_str << "\n  :Company ID: #{printable[:company_id]}"
+            out_str << "\n  :Company Site: #{printable[:company_site]}"
+            out_str << "\n  :NAF Code: #{printable[:naf_code]}"
+            out_str << "\n  :Name: #{printable[:name]}"
+            out_str << "\n  :Phone Number: #{printable[:phone_number]}"
+            out_str << "\n  :URSSAF Number: #{printable[:urssaf_number]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Information about the employment.
+        class PayslipV3Employment < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The category of the employment.
+          # @return [String]
+          attr_reader :category
+          # The coefficient of the employment.
+          # @return [String]
+          attr_reader :coefficient
+          # The collective agreement of the employment.
+          # @return [String]
+          attr_reader :collective_agreement
+          # The job title of the employee.
+          # @return [String]
+          attr_reader :job_title
+          # The position level of the employment.
+          # @return [String]
+          attr_reader :position_level
+          # The seniority date of the employment.
+          # @return [String]
+          attr_reader :seniority_date
+          # The start date of the employment.
+          # @return [String]
+          attr_reader :start_date
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @category = prediction['category']
+            @coefficient = prediction['coefficient']
+            @collective_agreement = prediction['collective_agreement']
+            @job_title = prediction['job_title']
+            @position_level = prediction['position_level']
+            @seniority_date = prediction['seniority_date']
+            @start_date = prediction['start_date']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:category] = format_for_display(@category)
+            printable[:coefficient] = format_for_display(@coefficient)
+            printable[:collective_agreement] = format_for_display(@collective_agreement)
+            printable[:job_title] = format_for_display(@job_title)
+            printable[:position_level] = format_for_display(@position_level)
+            printable[:seniority_date] = format_for_display(@seniority_date)
+            printable[:start_date] = format_for_display(@start_date)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Category: #{printable[:category]}"
+            out_str << "\n  :Coefficient: #{printable[:coefficient]}"
+            out_str << "\n  :Collective Agreement: #{printable[:collective_agreement]}"
+            out_str << "\n  :Job Title: #{printable[:job_title]}"
+            out_str << "\n  :Position Level: #{printable[:position_level]}"
+            out_str << "\n  :Seniority Date: #{printable[:seniority_date]}"
+            out_str << "\n  :Start Date: #{printable[:start_date]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'payslip_v3_document'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Payslip API version 3.0 page data.
+        class PayslipV3Page < Mindee::Parsing::Common::Page
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super(prediction)
+            @prediction = PayslipV3PagePrediction.new(
+              prediction['prediction'],
+              prediction['id']
+            )
+          end
+        end
+
+        # Payslip V3 page prediction.
+        class PayslipV3PagePrediction < PayslipV3Document
+          # @return [String]
+          def to_s
+            out_str = String.new
+            out_str << "\n#{super}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Information about paid time off.
+        class PayslipV3PaidTimeOff < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The amount of paid time off accrued in the period.
+          # @return [Float]
+          attr_reader :accrued
+          # The paid time off period.
+          # @return [String]
+          attr_reader :period
+          # The type of paid time off.
+          # @return [String]
+          attr_reader :pto_type
+          # The remaining amount of paid time off at the end of the period.
+          # @return [Float]
+          attr_reader :remaining
+          # The amount of paid time off used in the period.
+          # @return [Float]
+          attr_reader :used
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @accrued = prediction['accrued']
+            @period = prediction['period']
+            @pto_type = prediction['pto_type']
+            @remaining = prediction['remaining']
+            @used = prediction['used']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:accrued] = @accrued.nil? ? '' : Field.float_to_string(@accrued)
+            printable[:period] = format_for_display(@period)
+            printable[:pto_type] = format_for_display(@pto_type)
+            printable[:remaining] = @remaining.nil? ? '' : Field.float_to_string(@remaining)
+            printable[:used] = @used.nil? ? '' : Field.float_to_string(@used)
+            printable
+          end
+
+          # @return [Hash]
+          def table_printable_values
+            printable = {}
+            printable[:accrued] = @accrued.nil? ? '' : Field.float_to_string(@accrued)
+            printable[:period] = format_for_display(@period, 6)
+            printable[:pto_type] = format_for_display(@pto_type, 11)
+            printable[:remaining] = @remaining.nil? ? '' : Field.float_to_string(@remaining)
+            printable[:used] = @used.nil? ? '' : Field.float_to_string(@used)
+            printable
+          end
+
+          # @return [String]
+          def to_table_line
+            printable = table_printable_values
+            out_str = String.new
+            out_str << format('| %- 10s', printable[:accrued])
+            out_str << format('| %- 7s', printable[:period])
+            out_str << format('| %- 12s', printable[:pto_type])
+            out_str << format('| %- 10s', printable[:remaining])
+            out_str << format('| %- 10s', printable[:used])
+            out_str << '|'
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Accrued: #{printable[:accrued]}"
+            out_str << "\n  :Period: #{printable[:period]}"
+            out_str << "\n  :Type: #{printable[:pto_type]}"
+            out_str << "\n  :Remaining: #{printable[:remaining]}"
+            out_str << "\n  :Used: #{printable[:used]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Detailed information about the pay.
+        class PayslipV3PayDetail < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The gross salary of the employee.
+          # @return [Float]
+          attr_reader :gross_salary
+          # The year-to-date gross salary of the employee.
+          # @return [Float]
+          attr_reader :gross_salary_ytd
+          # The income tax rate of the employee.
+          # @return [Float]
+          attr_reader :income_tax_rate
+          # The income tax withheld from the employee's pay.
+          # @return [Float]
+          attr_reader :income_tax_withheld
+          # The net paid amount of the employee.
+          # @return [Float]
+          attr_reader :net_paid
+          # The net paid amount before tax of the employee.
+          # @return [Float]
+          attr_reader :net_paid_before_tax
+          # The net taxable amount of the employee.
+          # @return [Float]
+          attr_reader :net_taxable
+          # The year-to-date net taxable amount of the employee.
+          # @return [Float]
+          attr_reader :net_taxable_ytd
+          # The total cost to the employer.
+          # @return [Float]
+          attr_reader :total_cost_employer
+          # The total taxes and deductions of the employee.
+          # @return [Float]
+          attr_reader :total_taxes_and_deductions
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @gross_salary = prediction['gross_salary']
+            @gross_salary_ytd = prediction['gross_salary_ytd']
+            @income_tax_rate = prediction['income_tax_rate']
+            @income_tax_withheld = prediction['income_tax_withheld']
+            @net_paid = prediction['net_paid']
+            @net_paid_before_tax = prediction['net_paid_before_tax']
+            @net_taxable = prediction['net_taxable']
+            @net_taxable_ytd = prediction['net_taxable_ytd']
+            @total_cost_employer = prediction['total_cost_employer']
+            @total_taxes_and_deductions = prediction['total_taxes_and_deductions']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:gross_salary] = @gross_salary.nil? ? '' : Field.float_to_string(@gross_salary)
+            printable[:gross_salary_ytd] = @gross_salary_ytd.nil? ? '' : Field.float_to_string(@gross_salary_ytd)
+            printable[:income_tax_rate] = @income_tax_rate.nil? ? '' : Field.float_to_string(@income_tax_rate)
+            printable[:income_tax_withheld] =
+              @income_tax_withheld.nil? ? '' : Field.float_to_string(@income_tax_withheld)
+            printable[:net_paid] = @net_paid.nil? ? '' : Field.float_to_string(@net_paid)
+            printable[:net_paid_before_tax] =
+              @net_paid_before_tax.nil? ? '' : Field.float_to_string(@net_paid_before_tax)
+            printable[:net_taxable] = @net_taxable.nil? ? '' : Field.float_to_string(@net_taxable)
+            printable[:net_taxable_ytd] = @net_taxable_ytd.nil? ? '' : Field.float_to_string(@net_taxable_ytd)
+            printable[:total_cost_employer] =
+              @total_cost_employer.nil? ? '' : Field.float_to_string(@total_cost_employer)
+            printable[:total_taxes_and_deductions] =
+              @total_taxes_and_deductions.nil? ? '' : Field.float_to_string(@total_taxes_and_deductions)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Gross Salary: #{printable[:gross_salary]}"
+            out_str << "\n  :Gross Salary YTD: #{printable[:gross_salary_ytd]}"
+            out_str << "\n  :Income Tax Rate: #{printable[:income_tax_rate]}"
+            out_str << "\n  :Income Tax Withheld: #{printable[:income_tax_withheld]}"
+            out_str << "\n  :Net Paid: #{printable[:net_paid]}"
+            out_str << "\n  :Net Paid Before Tax: #{printable[:net_paid_before_tax]}"
+            out_str << "\n  :Net Taxable: #{printable[:net_taxable]}"
+            out_str << "\n  :Net Taxable YTD: #{printable[:net_taxable_ytd]}"
+            out_str << "\n  :Total Cost Employer: #{printable[:total_cost_employer]}"
+            out_str << "\n  :Total Taxes and Deductions: #{printable[:total_taxes_and_deductions]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/fr/payslip/payslip_v3_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 PayslipV3PayPeriod < 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_v3_salary_detail.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Detailed information about the earnings.
+        class PayslipV3SalaryDetail < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The amount of the earning.
+          # @return [Float]
+          attr_reader :amount
+          # The base rate value of the earning.
+          # @return [Float]
+          attr_reader :base
+          # The description of the earnings.
+          # @return [String]
+          attr_reader :description
+          # The number of units in the earning.
+          # @return [Float]
+          attr_reader :number
+          # The rate of the earning.
+          # @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']
+            @number = prediction['number']
+            @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[:number] = @number.nil? ? '' : Field.float_to_string(@number)
+            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[:number] = @number.nil? ? '' : Field.float_to_string(@number)
+            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('| %- 7s', printable[:number])
+            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  :Number: #{printable[:number]}"
+            out_str << "\n  :Rate: #{printable[:rate]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/resume/resume_v1_document.rb

@@ -10,7 +10,7 @@ require_relative 'resume_v1_certificate'
 module Mindee
   module Product
     module Resume
-      # Resume API version 1.1 document data.
+      # Resume API version 1.2 document data.
       class ResumeV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The location information of the candidate, including city, state, and country.

data/lib/mindee/product/resume/resume_v1_page.rb

@@ -6,7 +6,7 @@ require_relative 'resume_v1_document'
 module Mindee
   module Product
     module Resume
-      # Resume API version 1.1 page data.
+      # Resume API version 1.2 page data.
       class ResumeV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product.rb

@@ -6,23 +6,24 @@ require_relative 'product/business_card/business_card_v1'
 require_relative 'product/custom/custom_v1'
 require_relative 'product/cropper/cropper_v1'
 require_relative 'product/delivery_note/delivery_note_v1'
+require_relative 'product/driver_license/driver_license_v1'
 require_relative 'product/eu/license_plate/license_plate_v1'
 require_relative 'product/eu/driver_license/driver_license_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 require_relative 'product/fr/bank_statement/bank_statement_v1'
 require_relative 'product/fr/carte_grise/carte_grise_v1'
-require_relative 'product/fr/carte_vitale/carte_vitale_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/fr/energy_bill/energy_bill_v1'
+require_relative 'product/fr/health_card/health_card_v1'
 require_relative 'product/fr/payslip/payslip_v2'
+require_relative 'product/fr/payslip/payslip_v3'
 require_relative 'product/financial_document/financial_document_v1'
 require_relative 'product/generated/generated_v1'
 require_relative 'product/ind/indian_passport/indian_passport_v1'
 require_relative 'product/invoice/invoice_v4'
 require_relative 'product/invoice_splitter/invoice_splitter_v1'
-require_relative 'product/international_id/international_id_v1'
 require_relative 'product/international_id/international_id_v2'
 require_relative 'product/multi_receipts_detector/multi_receipts_detector_v1'
 require_relative 'product/nutrition_facts_label/nutrition_facts_label_v1'

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.16.0'
+  VERSION = '3.18.0'
 
   # Finds and return the current platform.
   # @return [String]