mindee 3.19.1 → 4.0.0

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

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module EU
-      module DriverLicense
-        # Driver License API version 1.0 document data.
-        class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # EU driver license holders address
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address
-          # EU driver license holders categories
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :category
-          # Country code extracted as a string.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :country_code
-          # The date of birth of the document holder
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :date_of_birth
-          # ID number of the Document.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :document_id
-          # Date the document expires
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :expiry_date
-          # First name(s) of the driver license holder
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :first_name
-          # Authority that issued the document
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :issue_authority
-          # Date the document was issued
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :issue_date
-          # Last name of the driver license holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :last_name
-          # Machine-readable license number
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :mrz
-          # Place where the driver license holder was born
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :place_of_birth
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super()
-            @address = StringField.new(prediction['address'], page_id)
-            @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)
-            @document_id = StringField.new(prediction['document_id'], page_id)
-            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-            @first_name = StringField.new(prediction['first_name'], page_id)
-            @issue_authority = StringField.new(prediction['issue_authority'], page_id)
-            @issue_date = DateField.new(prediction['issue_date'], 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)
-          end
-
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n:Country Code: #{@country_code}".rstrip
-            out_str << "\n:Document ID: #{@document_id}".rstrip
-            out_str << "\n:Driver License 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:Issue Date: #{@issue_date}".rstrip
-            out_str << "\n:Issue Authority: #{@issue_authority}".rstrip
-            out_str << "\n:MRZ: #{@mrz}".rstrip
-            out_str << "\n:Address: #{@address}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/eu/driver_license/driver_license_v1_page.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'driver_license_v1_document'
-
-module Mindee
-  module Product
-    module EU
-      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 = DriverLicenseV1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
-          end
-        end
-
-        # Driver License V1 page prediction.
-        class DriverLicenseV1PagePrediction < DriverLicenseV1Document
-          include Mindee::Parsing::Standard
-
-          # Has a photo of the EU driver license holder
-          # @return [Mindee::Parsing::Standard::PositionField]
-          attr_reader :photo
-          # Has a signature of the EU driver license holder
-          # @return [Mindee::Parsing::Standard::PositionField]
-          attr_reader :signature
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            @photo = PositionField.new(prediction['photo'], page_id)
-            @signature = PositionField.new(prediction['signature'], page_id)
-            super(prediction, page_id)
-          end
-
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n:Photo: #{@photo}".rstrip
-            out_str << "\n:Signature: #{@signature}".rstrip
-            out_str << "\n#{super}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_statement_v1_document'
-require_relative 'bank_statement_v1_page'
-
-module Mindee
-  module Product
-    module FR
-      # Bank Statement (FR) module.
-      module BankStatement
-        # Bank Statement (FR) V1 prediction inference.
-        class BankStatementV1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'bank_statement_fr'
-          @endpoint_version = '1'
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = BankStatementV1Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(BankStatementV1Page.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/bank_statement/bank_statement_v1_page.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_statement_v1_document'
-
-module Mindee
-  module Product
-    module FR
-      module BankStatement
-        # Bank Statement (FR) V1 page.
-        class BankStatementV1Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super(prediction)
-            @prediction = BankStatementV1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
-          end
-        end
-
-        # Bank Statement (FR) V1 page prediction.
-        class BankStatementV1PagePrediction < BankStatementV1Document
-          # @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/generated/generated_v1.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'generated_v1_document'
-require_relative 'generated_v1_page'
-
-module Mindee
-  module Product
-    # Generated product module.
-    module Generated
-      # Generated Document V1 prediction inference.
-      class GeneratedV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = ''
-        @endpoint_version = ''
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = GeneratedV1Document.new(prediction['prediction'])
-          @pages = []
-          prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(GeneratedV1Page.new(page))
-            end
-          end
-        end
-
-        class << self
-          # Name of the endpoint for this product.
-          # @return [String]
-          attr_reader :endpoint_name
-          # Version for this product.
-          # @return [String]
-          attr_reader :endpoint_version
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/generated/generated_v1_document.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'generated_v1_prediction'
-
-module Mindee
-  module Product
-    module Generated
-      # Generated Document V1 prediction
-      class GeneratedV1Document < Mindee::Product::Generated::GeneratedV1Prediction
-        include Mindee::Parsing::Standard
-        # @param raw_prediction [Hash]
-        def initialize(raw_prediction)
-          # Generated document.
-
-          # raw_prediction: Dictionary containing the JSON document response
-          super()
-          raw_prediction.each do |field_name, field_contents|
-            if field_contents.is_a?(Array)
-              @fields[field_name] = Parsing::Generated::GeneratedListField.new(field_contents)
-            elsif field_contents.is_a?(Hash) && Parsing::Generated.generated_object?(field_contents)
-              @fields[field_name] = Parsing::Generated::GeneratedObjectField.new(field_contents)
-            else
-              field_contents_str = field_contents.dup
-              if field_contents_str.key?('value') && field_contents_str['value'].nil? == false
-                field_contents_str['value'] = field_contents_str['value'].to_s
-              end
-              @fields[field_name] = StringField.new(field_contents_str)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/proof_of_address/proof_of_address_v1.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'proof_of_address_v1_document'
-require_relative 'proof_of_address_v1_page'
-
-module Mindee
-  module Product
-    # Proof of Address module.
-    module ProofOfAddress
-      # Proof of Address API version 1 inference prediction.
-      class ProofOfAddressV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'proof_of_address'
-        @endpoint_version = '1'
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = ProofOfAddressV1Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(ProofOfAddressV1Page.new(page))
-            end
-          end
-        end
-
-        class << self
-          # Name of the endpoint for this product.
-          # @return [String]
-          attr_reader :endpoint_name
-          # Version for this product.
-          # @return [String]
-          attr_reader :endpoint_version
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/proof_of_address/proof_of_address_v1_document.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module ProofOfAddress
-      # Proof of Address API version 1.1 document data.
-      class ProofOfAddressV1Document < Mindee::Parsing::Common::Prediction
-        include Mindee::Parsing::Standard
-        # The date the document was issued.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :date
-        # List of dates found on the document.
-        # @return [Array<Mindee::Parsing::Standard::DateField>]
-        attr_reader :dates
-        # The address of the document's issuer.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :issuer_address
-        # List of company registrations found for the issuer.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
-        attr_reader :issuer_company_registration
-        # The name of the person or company issuing the document.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :issuer_name
-        # The locale detected on the document.
-        # @return [Mindee::Parsing::Standard::LocaleField]
-        attr_reader :locale
-        # The address of the recipient.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :recipient_address
-        # List of company registrations found for the recipient.
-        # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
-        attr_reader :recipient_company_registration
-        # The name of the person or company receiving the document.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :recipient_name
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super()
-          @date = DateField.new(prediction['date'], page_id)
-          @dates = []
-          prediction['dates'].each do |item|
-            @dates.push(DateField.new(item, page_id))
-          end
-          @issuer_address = StringField.new(prediction['issuer_address'], page_id)
-          @issuer_company_registration = []
-          prediction['issuer_company_registration'].each do |item|
-            @issuer_company_registration.push(CompanyRegistrationField.new(item, page_id))
-          end
-          @issuer_name = StringField.new(prediction['issuer_name'], page_id)
-          @locale = LocaleField.new(prediction['locale'], page_id)
-          @recipient_address = StringField.new(prediction['recipient_address'], page_id)
-          @recipient_company_registration = []
-          prediction['recipient_company_registration'].each do |item|
-            @recipient_company_registration.push(CompanyRegistrationField.new(item, page_id))
-          end
-          @recipient_name = StringField.new(prediction['recipient_name'], page_id)
-        end
-
-        # @return [String]
-        def to_s
-          issuer_company_registration = @issuer_company_registration.join("\n #{' ' * 30}")
-          recipient_company_registration = @recipient_company_registration.join("\n #{' ' * 33}")
-          dates = @dates.join("\n #{' ' * 7}")
-          out_str = String.new
-          out_str << "\n:Locale: #{@locale}".rstrip
-          out_str << "\n:Issuer Name: #{@issuer_name}".rstrip
-          out_str << "\n:Issuer Company Registrations: #{issuer_company_registration}".rstrip
-          out_str << "\n:Issuer Address: #{@issuer_address}".rstrip
-          out_str << "\n:Recipient Name: #{@recipient_name}".rstrip
-          out_str << "\n:Recipient Company Registrations: #{recipient_company_registration}".rstrip
-          out_str << "\n:Recipient Address: #{@recipient_address}".rstrip
-          out_str << "\n:Dates: #{dates}".rstrip
-          out_str << "\n:Date of Issue: #{@date}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/proof_of_address/proof_of_address_v1_page.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'proof_of_address_v1_document'
-
-module Mindee
-  module Product
-    module ProofOfAddress
-      # Proof of Address API version 1.1 page data.
-      class ProofOfAddressV1Page < Mindee::Parsing::Common::Page
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super(prediction)
-          @prediction = ProofOfAddressV1PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
-        end
-      end
-
-      # Proof of Address V1 page prediction.
-      class ProofOfAddressV1PagePrediction < ProofOfAddressV1Document
-        # @return [String]
-        def to_s
-          out_str = String.new
-          out_str << "\n#{super}"
-          out_str
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/receipt/receipt_v4.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'receipt_v4_document'
-require_relative 'receipt_v4_page'
-
-module Mindee
-  module Product
-    module Receipt
-      # Expense Receipt V4 prediction inference.
-      class ReceiptV4 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'expense_receipts'
-        @endpoint_version = '4'
-
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super
-          @prediction = ReceiptV4Document.new(prediction['prediction'], nil)
-          @pages = []
-          prediction['pages'].each do |page|
-            @pages.push(ReceiptV4Page.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
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/receipt/receipt_v4_document.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module Product
-    module Receipt
-      # Expense Receipt V4 document prediction.
-      class ReceiptV4Document < Mindee::Parsing::Common::Prediction
-        include Mindee::Parsing::Standard
-        # Where the purchase was made, the language, and the currency.
-        # @return [Mindee::Parsing::Standard::LocaleField]
-        attr_reader :locale
-        # Total including taxes
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_amount
-        # Total amount of the purchase excluding taxes.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_net
-        # Total tax amount of the purchase.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :total_tax
-        # The purchase date.
-        # @return [Mindee::Parsing::Standard::DateField]
-        attr_reader :date
-        # The name of the supplier or merchant, as seen on the receipt.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :supplier
-        # List of taxes detected on the receipt.
-        # @return [Mindee::Parsing::Standard::Taxes]
-        attr_reader :taxes
-        # Time as seen on the receipt in HH:MM format.
-        # @return [Mindee::Parsing::Standard::StringField]
-        attr_reader :time
-        # The receipt category among predefined classes.
-        # @return [Mindee::Parsing::Standard::ClassificationField]
-        attr_reader :category
-        # The receipt sub-category among predefined classes.
-        # @return [Mindee::Parsing::Standard::ClassificationField]
-        attr_reader :subcategory
-        # Whether the document is an expense receipt or a credit card receipt.
-        # @return [Mindee::Parsing::Standard::ClassificationField]
-        attr_reader :document_type
-        # Total amount of tip and gratuity. Both typed and handwritten characters are supported.
-        # @return [Mindee::Parsing::Standard::AmountField]
-        attr_reader :tip
-
-        # @param prediction [Hash]
-        # @param page_id [Integer, nil]
-        def initialize(prediction, page_id)
-          super()
-          @locale = LocaleField.new(prediction['locale'])
-          @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)
-          @tip = AmountField.new(prediction['tip'], page_id)
-          @date = DateField.new(prediction['date'], page_id)
-          @category = ClassificationField.new(prediction['category'], page_id)
-          @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
-          @document_type = ClassificationField.new(prediction['document_type'], page_id)
-          @supplier = StringField.new(prediction['supplier'], page_id)
-          @time = StringField.new(prediction['time'], page_id)
-          @taxes = Taxes.new(prediction['taxes'], page_id)
-        end
-
-        # @return [String]
-        def to_s
-          out_str = String.new
-          out_str << "\n:Locale: #{@locale}".rstrip
-          out_str << "\n:Date: #{@date}".rstrip
-          out_str << "\n:Category: #{@category}".rstrip
-          out_str << "\n:Subcategory: #{@subcategory}".rstrip
-          out_str << "\n:Document type: #{@document_type}".rstrip
-          out_str << "\n:Time: #{@time}".rstrip
-          out_str << "\n:Supplier name: #{@supplier}".rstrip
-          out_str << "\n:Taxes:#{@taxes}".rstrip
-          out_str << "\n:Total net: #{@total_net}".rstrip
-          out_str << "\n:Total tax: #{@total_tax}".rstrip
-          out_str << "\n:Tip: #{@tip}".rstrip
-          out_str << "\n:Total amount: #{@total_amount}".rstrip
-          out_str[1..].to_s
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/receipt/receipt_v4_page.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'receipt_v4_document'
-
-module Mindee
-  module Product
-    module Receipt
-      # Expense Receipt V4 page.
-      class ReceiptV4Page < Mindee::Parsing::Common::Page
-        # @param prediction [Hash]
-        def initialize(prediction)
-          super(prediction)
-          @prediction = ReceiptV4PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
-        end
-      end
-
-      # Expense Receipt V4 page prediction.
-      class ReceiptV4PagePrediction < ReceiptV4Document
-        # @return [String]
-        def to_s
-          out_str = String.new
-          out_str << "\n#{super}"
-          out_str
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/driver_license/driver_license_v1.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'driver_license_v1_document'
-require_relative 'driver_license_v1_page'
-
-module Mindee
-  module Product
-    module US
-      # Driver License module.
-      module DriverLicense
-        # Driver License API version 1 inference prediction.
-        class DriverLicenseV1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'us_driver_license'
-          @endpoint_version = '1'
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = DriverLicenseV1Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(DriverLicenseV1Page.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