mindee 3.16.0 → 3.18.0

data/lib/mindee/parsing/common/execution_file.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mindee
+  module Parsing
+    module Common
+      # Representation of a workflow execution's file data.
+      class ExecutionFile
+        # File name.
+        # @return [String]
+        attr_reader :name
+
+        # Optional alias for the file.
+        # @return [String]
+        attr_reader :alias
+
+        # @param http_response [Hash]
+        def initialize(http_response)
+          @name = http_response['name']
+          @alias = http_response['alias']
+        end
+      end
+    end
+  end
+end

data/lib/mindee/parsing/common/execution_priority.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mindee
+  module Parsing
+    module Common
+      # Execution policy priority values.
+      module ExecutionPriority
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+
+        # Sets the priority to one of its possibly values, defaults to nil otherwise.
+        # @param [String, nil] priority_str
+        # @return [Symbol, nil]
+        def self.to_priority(priority_str)
+          return nil if priority_str.nil?
+
+          case priority_str.downcase
+          when 'low'
+            :low
+          when 'high'
+            :high
+          else
+            :medium
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/parsing/common.rb

@@ -2,6 +2,9 @@
 
 require_relative 'common/api_response'
 require_relative 'common/document'
+require_relative 'common/execution'
+require_relative 'common/execution_file'
+require_relative 'common/execution_priority'
 require_relative 'common/inference'
 require_relative 'common/ocr'
 require_relative 'common/prediction'

data/lib/mindee/product/{international_id/international_id_v1.rb → driver_license/driver_license_v1.rb}

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'international_id_v1_document'
-require_relative 'international_id_v1_page'
+require_relative 'driver_license_v1_document'
+require_relative 'driver_license_v1_page'
 
 module Mindee
   module Product
-    # International ID module.
-    module InternationalId
-      # International ID V1 prediction inference.
-      class InternationalIdV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'international_id'
+    # Driver License module.
+    module DriverLicense
+      # Driver License API version 1 inference prediction.
+      class DriverLicenseV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'driver_license'
         @endpoint_version = '1'
 
         # @param prediction [Hash]
         def initialize(prediction)
           super
-          @prediction = InternationalIdV1Document.new(prediction['prediction'], nil)
+          @prediction = DriverLicenseV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
             if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(InternationalIdV1Page.new(page))
+              @pages.push(DriverLicenseV1Page.new(page))
             end
           end
         end

data/lib/mindee/product/driver_license/driver_license_v1_document.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module DriverLicense
+      # Driver License API version 1.0 document data.
+      class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The category or class of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :category
+        # The alpha-3 ISO 3166 code of the country where the driver license was issued.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :country_code
+        # The date of birth of the driver license holder.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date_of_birth
+        # The DD number of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :dd_number
+        # The expiry date of the driver license.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :expiry_date
+        # The first name of the driver license holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :first_name
+        # The unique identifier of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :id
+        # The date when the driver license was issued.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :issued_date
+        # The authority that issued the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :issuing_authority
+        # The last name of the driver license holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :last_name
+        # The Machine Readable Zone (MRZ) of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz
+        # The place of birth of the driver license holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :place_of_birth
+        # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :state
+
+        # @param prediction [Hash]
+        # @param page_id [Integer, nil]
+        def initialize(prediction, page_id)
+          super()
+          @category = StringField.new(prediction['category'], page_id)
+          @country_code = StringField.new(prediction['country_code'], page_id)
+          @date_of_birth = DateField.new(prediction['date_of_birth'], page_id)
+          @dd_number = StringField.new(prediction['dd_number'], page_id)
+          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
+          @first_name = StringField.new(prediction['first_name'], page_id)
+          @id = StringField.new(prediction['id'], page_id)
+          @issued_date = DateField.new(prediction['issued_date'], page_id)
+          @issuing_authority = StringField.new(prediction['issuing_authority'], page_id)
+          @last_name = StringField.new(prediction['last_name'], page_id)
+          @mrz = StringField.new(prediction['mrz'], page_id)
+          @place_of_birth = StringField.new(prediction['place_of_birth'], page_id)
+          @state = StringField.new(prediction['state'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n:Country Code: #{@country_code}".rstrip
+          out_str << "\n:State: #{@state}".rstrip
+          out_str << "\n:ID: #{@id}".rstrip
+          out_str << "\n:Category: #{@category}".rstrip
+          out_str << "\n:Last Name: #{@last_name}".rstrip
+          out_str << "\n:First Name: #{@first_name}".rstrip
+          out_str << "\n:Date of Birth: #{@date_of_birth}".rstrip
+          out_str << "\n:Place of Birth: #{@place_of_birth}".rstrip
+          out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+          out_str << "\n:Issued Date: #{@issued_date}".rstrip
+          out_str << "\n:Issuing Authority: #{@issuing_authority}".rstrip
+          out_str << "\n:MRZ: #{@mrz}".rstrip
+          out_str << "\n:DD Number: #{@dd_number}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/{international_id/international_id_v1_page.rb → driver_license/driver_license_v1_page.rb}

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'international_id_v1_document'
+require_relative 'driver_license_v1_document'
 
 module Mindee
   module Product
-    module InternationalId
-      # International ID V1 page.
-      class InternationalIdV1Page < Mindee::Parsing::Common::Page
+    module DriverLicense
+      # Driver License API version 1.0 page data.
+      class DriverLicenseV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
           super(prediction)
-          @prediction = InternationalIdV1PagePrediction.new(
+          @prediction = DriverLicenseV1PagePrediction.new(
             prediction['prediction'],
             prediction['id']
           )
         end
       end
 
-      # International ID V1 page prediction.
-      class InternationalIdV1PagePrediction < InternationalIdV1Document
+      # Driver License V1 page prediction.
+      class DriverLicenseV1PagePrediction < DriverLicenseV1Document
         # @return [String]
         def to_s
           out_str = String.new

data/lib/mindee/product/fr/{carte_vitale/carte_vitale_v1.rb → health_card/health_card_v1.rb}

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 require_relative '../../../parsing'
-require_relative 'carte_vitale_v1_document'
-require_relative 'carte_vitale_v1_page'
+require_relative 'health_card_v1_document'
+require_relative 'health_card_v1_page'
 
 module Mindee
   module Product
     module FR
-      # Carte Vitale module.
-      module CarteVitale
-        # Carte Vitale API version 1 inference prediction.
-        class CarteVitaleV1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'carte_vitale'
+      # Health Card module.
+      module HealthCard
+        # Health Card API version 1 inference prediction.
+        class HealthCardV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'french_healthcard'
           @endpoint_version = '1'
 
           # @param prediction [Hash]
           def initialize(prediction)
             super
-            @prediction = CarteVitaleV1Document.new(prediction['prediction'], nil)
+            @prediction = HealthCardV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
               if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(CarteVitaleV1Page.new(page))
+                @pages.push(HealthCardV1Page.new(page))
               end
             end
           end

data/lib/mindee/product/fr/{carte_vitale/carte_vitale_v1_document.rb → health_card/health_card_v1_document.rb}

@@ -5,17 +5,17 @@ require_relative '../../../parsing'
 module Mindee
   module Product
     module FR
-      module CarteVitale
-        # Carte Vitale API version 1.1 document data.
-        class CarteVitaleV1Document < Mindee::Parsing::Common::Prediction
+      module HealthCard
+        # Health Card API version 1.0 document data.
+        class HealthCardV1Document < Mindee::Parsing::Common::Prediction
           include Mindee::Parsing::Standard
-          # The given name(s) of the card holder.
+          # The given names of the card holder.
           # @return [Array<Mindee::Parsing::Standard::StringField>]
           attr_reader :given_names
-          # The date the card was issued.
+          # The date when the carte vitale document was issued.
           # @return [Mindee::Parsing::Standard::DateField]
           attr_reader :issuance_date
-          # The Social Security Number (Numéro de Sécurité Sociale) of the card holder
+          # The social security number of the card holder.
           # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :social_security
           # The surname of the card holder.

data/lib/mindee/product/fr/{carte_vitale/carte_vitale_v1_page.rb → health_card/health_card_v1_page.rb}

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
 require_relative '../../../parsing'
-require_relative 'carte_vitale_v1_document'
+require_relative 'health_card_v1_document'
 
 module Mindee
   module Product
     module FR
-      module CarteVitale
-        # Carte Vitale API version 1.1 page data.
-        class CarteVitaleV1Page < Mindee::Parsing::Common::Page
+      module HealthCard
+        # Health Card API version 1.0 page data.
+        class HealthCardV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
             super(prediction)
-            @prediction = CarteVitaleV1PagePrediction.new(
+            @prediction = HealthCardV1PagePrediction.new(
               prediction['prediction'],
               prediction['id']
             )
           end
         end
 
-        # Carte Vitale V1 page prediction.
-        class CarteVitaleV1PagePrediction < CarteVitaleV1Document
+        # Health Card V1 page prediction.
+        class HealthCardV1PagePrediction < HealthCardV1Document
           # @return [String]
           def to_s
             out_str = String.new

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'payslip_v3_document'
+require_relative 'payslip_v3_page'
+
+module Mindee
+  module Product
+    module FR
+      # Payslip module.
+      module Payslip
+        # Payslip API version 3 inference prediction.
+        class PayslipV3 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'payslip_fra'
+          @endpoint_version = '3'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = PayslipV3Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(PayslipV3Page.new(page))
+              end
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Information about the employee's bank account.
+        class PayslipV3BankAccountDetail < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The name of the bank.
+          # @return [String]
+          attr_reader :bank_name
+          # The IBAN of the bank account.
+          # @return [String]
+          attr_reader :iban
+          # The SWIFT code of the bank.
+          # @return [String]
+          attr_reader :swift
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @bank_name = prediction['bank_name']
+            @iban = prediction['iban']
+            @swift = prediction['swift']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:bank_name] = format_for_display(@bank_name)
+            printable[:iban] = format_for_display(@iban)
+            printable[:swift] = format_for_display(@swift)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Bank Name: #{printable[:bank_name]}"
+            out_str << "\n  :IBAN: #{printable[:iban]}"
+            out_str << "\n  :SWIFT: #{printable[:swift]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+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
+        # Payslip API version 3.0 document data.
+        class PayslipV3Document < Mindee::Parsing::Common::Prediction
+          include Mindee::Parsing::Standard
+          # Information about the employee's bank account.
+          # @return [Mindee::Product::FR::Payslip::PayslipV3BankAccountDetail]
+          attr_reader :bank_account_details
+          # Information about the employee.
+          # @return [Mindee::Product::FR::Payslip::PayslipV3Employee]
+          attr_reader :employee
+          # Information about the employer.
+          # @return [Mindee::Product::FR::Payslip::PayslipV3Employer]
+          attr_reader :employer
+          # Information about the employment.
+          # @return [Mindee::Product::FR::Payslip::PayslipV3Employment]
+          attr_reader :employment
+          # Information about paid time off.
+          # @return [Array<Mindee::Product::FR::Payslip::PayslipV3PaidTimeOff>]
+          attr_reader :paid_time_off
+          # Detailed information about the pay.
+          # @return [Mindee::Product::FR::Payslip::PayslipV3PayDetail]
+          attr_reader :pay_detail
+          # Information about the pay period.
+          # @return [Mindee::Product::FR::Payslip::PayslipV3PayPeriod]
+          attr_reader :pay_period
+          # Detailed information about the earnings.
+          # @return [Array<Mindee::Product::FR::Payslip::PayslipV3SalaryDetail>]
+          attr_reader :salary_details
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super()
+            @bank_account_details = PayslipV3BankAccountDetail.new(prediction['bank_account_details'], page_id)
+            @employee = PayslipV3Employee.new(prediction['employee'], page_id)
+            @employer = PayslipV3Employer.new(prediction['employer'], page_id)
+            @employment = PayslipV3Employment.new(prediction['employment'], page_id)
+            @paid_time_off = []
+            prediction['paid_time_off'].each do |item|
+              @paid_time_off.push(PayslipV3PaidTimeOff.new(item, page_id))
+            end
+            @pay_detail = PayslipV3PayDetail.new(prediction['pay_detail'], page_id)
+            @pay_period = PayslipV3PayPeriod.new(prediction['pay_period'], page_id)
+            @salary_details = []
+            prediction['salary_details'].each do |item|
+              @salary_details.push(PayslipV3SalaryDetail.new(item, page_id))
+            end
+          end
+
+          # @return [String]
+          def to_s
+            pay_period = @pay_period.to_s
+            employee = @employee.to_s
+            employer = @employer.to_s
+            bank_account_details = @bank_account_details.to_s
+            employment = @employment.to_s
+            salary_details = salary_details_to_s
+            pay_detail = @pay_detail.to_s
+            paid_time_off = paid_time_off_to_s
+            out_str = String.new
+            out_str << "\n:Pay Period:"
+            out_str << pay_period
+            out_str << "\n:Employee:"
+            out_str << employee
+            out_str << "\n:Employer:"
+            out_str << employer
+            out_str << "\n:Bank Account Details:"
+            out_str << bank_account_details
+            out_str << "\n:Employment:"
+            out_str << employment
+            out_str << "\n:Salary Details:"
+            out_str << salary_details
+            out_str << "\n:Pay Detail:"
+            out_str << pay_detail
+            out_str << "\n:Paid Time Off:"
+            out_str << paid_time_off
+            out_str[1..].to_s
+          end
+
+          private
+
+          # @param char [String]
+          # @return [String]
+          def salary_details_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 11}"
+            out_str << "+#{char * 38}"
+            out_str << "+#{char * 8}"
+            out_str << "+#{char * 11}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def salary_details_to_s
+            return '' if @salary_details.empty?
+
+            line_items = @salary_details.map(&:to_table_line).join("\n#{salary_details_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{salary_details_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' Amount       |'
+            out_str << ' Base      |'
+            out_str << ' Description                          |'
+            out_str << ' Number |'
+            out_str << ' Rate      |'
+            out_str << "\n#{salary_details_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{salary_details_separator('-')}"
+            out_str
+          end
+
+          # @param char [String]
+          # @return [String]
+          def paid_time_off_separator(char)
+            out_str = String.new
+            out_str << '  '
+            out_str << "+#{char * 11}"
+            out_str << "+#{char * 8}"
+            out_str << "+#{char * 13}"
+            out_str << "+#{char * 11}"
+            out_str << "+#{char * 11}"
+            out_str << '+'
+            out_str
+          end
+
+          # @return [String]
+          def paid_time_off_to_s
+            return '' if @paid_time_off.empty?
+
+            line_items = @paid_time_off.map(&:to_table_line).join("\n#{paid_time_off_separator('-')}\n  ")
+            out_str = String.new
+            out_str << "\n#{paid_time_off_separator('-')}"
+            out_str << "\n  |"
+            out_str << ' Accrued   |'
+            out_str << ' Period |'
+            out_str << ' Type        |'
+            out_str << ' Remaining |'
+            out_str << ' Used      |'
+            out_str << "\n#{paid_time_off_separator('=')}"
+            out_str << "\n  #{line_items}"
+            out_str << "\n#{paid_time_off_separator('-')}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+
+module Mindee
+  module Product
+    module FR
+      module Payslip
+        # Information about the employee.
+        class PayslipV3Employee < Mindee::Parsing::Standard::FeatureField
+          include Mindee::Parsing::Standard
+          # The address of the employee.
+          # @return [String]
+          attr_reader :address
+          # The date of birth of the employee.
+          # @return [String]
+          attr_reader :date_of_birth
+          # The first name of the employee.
+          # @return [String]
+          attr_reader :first_name
+          # The last name of the employee.
+          # @return [String]
+          attr_reader :last_name
+          # The phone number of the employee.
+          # @return [String]
+          attr_reader :phone_number
+          # The registration number of the employee.
+          # @return [String]
+          attr_reader :registration_number
+          # The social security number of the employee.
+          # @return [String]
+          attr_reader :social_security_number
+
+          # @param prediction [Hash]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            super(prediction, page_id)
+            @address = prediction['address']
+            @date_of_birth = prediction['date_of_birth']
+            @first_name = prediction['first_name']
+            @last_name = prediction['last_name']
+            @phone_number = prediction['phone_number']
+            @registration_number = prediction['registration_number']
+            @social_security_number = prediction['social_security_number']
+            @page_id = page_id
+          end
+
+          # @return [Hash]
+          def printable_values
+            printable = {}
+            printable[:address] = format_for_display(@address)
+            printable[:date_of_birth] = format_for_display(@date_of_birth)
+            printable[:first_name] = format_for_display(@first_name)
+            printable[:last_name] = format_for_display(@last_name)
+            printable[:phone_number] = format_for_display(@phone_number)
+            printable[:registration_number] = format_for_display(@registration_number)
+            printable[:social_security_number] = format_for_display(@social_security_number)
+            printable
+          end
+
+          # @return [String]
+          def to_s
+            printable = printable_values
+            out_str = String.new
+            out_str << "\n  :Address: #{printable[:address]}"
+            out_str << "\n  :Date of Birth: #{printable[:date_of_birth]}"
+            out_str << "\n  :First Name: #{printable[:first_name]}"
+            out_str << "\n  :Last Name: #{printable[:last_name]}"
+            out_str << "\n  :Phone Number: #{printable[:phone_number]}"
+            out_str << "\n  :Registration Number: #{printable[:registration_number]}"
+            out_str << "\n  :Social Security Number: #{printable[:social_security_number]}"
+            out_str
+          end
+        end
+      end
+    end
+  end
+end