mindee 3.20.0 → 4.0.0

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

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

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module DriverLicense
-        # Driver License API version 1.1 document data.
-        class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # US driver license holders address
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :address
-          # US driver license holders date of birth
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :date_of_birth
-          # Document Discriminator Number of the US Driver License
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :dd_number
-          # US driver license holders class
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :dl_class
-          # ID number of the US Driver License.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :driver_license_id
-          # US driver license holders endorsements
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :endorsements
-          # Date on which the documents expires.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :expiry_date
-          # US driver license holders eye colour
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :eye_color
-          # US driver license holders first name(s)
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :first_name
-          # US driver license holders hair colour
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :hair_color
-          # US driver license holders hight
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :height
-          # Date on which the documents was issued.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :issued_date
-          # US driver license holders last name
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :last_name
-          # US driver license holders restrictions
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :restrictions
-          # US driver license holders gender
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :sex
-          # US State
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :state
-          # US driver license holders weight
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :weight
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super()
-            @address = StringField.new(prediction['address'], page_id)
-            @date_of_birth = DateField.new(prediction['date_of_birth'], page_id)
-            @dd_number = StringField.new(prediction['dd_number'], page_id)
-            @dl_class = StringField.new(prediction['dl_class'], page_id)
-            @driver_license_id = StringField.new(prediction['driver_license_id'], page_id)
-            @endorsements = StringField.new(prediction['endorsements'], page_id)
-            @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-            @eye_color = StringField.new(prediction['eye_color'], page_id)
-            @first_name = StringField.new(prediction['first_name'], page_id)
-            @hair_color = StringField.new(prediction['hair_color'], page_id)
-            @height = StringField.new(prediction['height'], page_id)
-            @issued_date = DateField.new(prediction['issued_date'], page_id)
-            @last_name = StringField.new(prediction['last_name'], page_id)
-            @restrictions = StringField.new(prediction['restrictions'], page_id)
-            @sex = StringField.new(prediction['sex'], page_id)
-            @state = StringField.new(prediction['state'], page_id)
-            @weight = StringField.new(prediction['weight'], page_id)
-          end
-
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n:State: #{@state}".rstrip
-            out_str << "\n:Driver License ID: #{@driver_license_id}".rstrip
-            out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
-            out_str << "\n:Date Of Issue: #{@issued_date}".rstrip
-            out_str << "\n:Last Name: #{@last_name}".rstrip
-            out_str << "\n:First Name: #{@first_name}".rstrip
-            out_str << "\n:Address: #{@address}".rstrip
-            out_str << "\n:Date Of Birth: #{@date_of_birth}".rstrip
-            out_str << "\n:Restrictions: #{@restrictions}".rstrip
-            out_str << "\n:Endorsements: #{@endorsements}".rstrip
-            out_str << "\n:Driver License Class: #{@dl_class}".rstrip
-            out_str << "\n:Sex: #{@sex}".rstrip
-            out_str << "\n:Height: #{@height}".rstrip
-            out_str << "\n:Weight: #{@weight}".rstrip
-            out_str << "\n:Hair Color: #{@hair_color}".rstrip
-            out_str << "\n:Eye Color: #{@eye_color}".rstrip
-            out_str << "\n:Document Discriminator: #{@dd_number}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/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 US
-      module DriverLicense
-        # Driver License API version 1.1 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 US driver license holder
-          # @return [Mindee::Parsing::Standard::PositionField]
-          attr_reader :photo
-          # Has a signature of the US 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/us/us_mail/us_mail_v2.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'us_mail_v2_document'
-require_relative 'us_mail_v2_page'
-
-module Mindee
-  module Product
-    module US
-      # US Mail module.
-      module UsMail
-        # US Mail API version 2 inference prediction.
-        class UsMailV2 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'us_mail'
-          @endpoint_version = '2'
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = UsMailV2Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(UsMailV2Page.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/us/us_mail/us_mail_v2_document.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'us_mail_v2_sender_address'
-require_relative 'us_mail_v2_recipient_address'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # US Mail API version 2.0 document data.
-        class UsMailV2Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The addresses of the recipients.
-          # @return [Array<Mindee::Product::US::UsMail::UsMailV2RecipientAddress>]
-          attr_reader :recipient_addresses
-          # The names of the recipients.
-          # @return [Array<Mindee::Parsing::Standard::StringField>]
-          attr_reader :recipient_names
-          # The address of the sender.
-          # @return [Mindee::Product::US::UsMail::UsMailV2SenderAddress]
-          attr_reader :sender_address
-          # The name of the sender.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :sender_name
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super()
-            @recipient_addresses = []
-            prediction['recipient_addresses'].each do |item|
-              @recipient_addresses.push(UsMailV2RecipientAddress.new(item, page_id))
-            end
-            @recipient_names = []
-            prediction['recipient_names'].each do |item|
-              @recipient_names.push(StringField.new(item, page_id))
-            end
-            @sender_address = UsMailV2SenderAddress.new(prediction['sender_address'], page_id)
-            @sender_name = StringField.new(prediction['sender_name'], page_id)
-          end
-
-          # @return [String]
-          def to_s
-            sender_address = @sender_address.to_s
-            recipient_names = @recipient_names.join("\n #{' ' * 17}")
-            recipient_addresses = recipient_addresses_to_s
-            out_str = String.new
-            out_str << "\n:Sender Name: #{@sender_name}".rstrip
-            out_str << "\n:Sender Address:"
-            out_str << sender_address
-            out_str << "\n:Recipient Names: #{recipient_names}".rstrip
-            out_str << "\n:Recipient Addresses:"
-            out_str << recipient_addresses
-            out_str[1..].to_s
-          end
-
-          private
-
-          # @param char [String]
-          # @return [String]
-          def recipient_addresses_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 17}"
-            out_str << "+#{char * 37}"
-            out_str << "+#{char * 19}"
-            out_str << "+#{char * 13}"
-            out_str << "+#{char * 24}"
-            out_str << "+#{char * 7}"
-            out_str << "+#{char * 27}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def recipient_addresses_to_s
-            return '' if @recipient_addresses.empty?
-
-            line_items = @recipient_addresses.map(&:to_table_line).join("\n#{recipient_addresses_separator('-')}\n  ")
-            out_str = String.new
-            out_str << "\n#{recipient_addresses_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' City            |'
-            out_str << ' Complete Address                    |'
-            out_str << ' Is Address Change |'
-            out_str << ' Postal Code |'
-            out_str << ' Private Mailbox Number |'
-            out_str << ' State |'
-            out_str << ' Street                    |'
-            out_str << "\n#{recipient_addresses_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{recipient_addresses_separator('-')}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v2_page.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'us_mail_v2_document'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # US Mail API version 2.0 page data.
-        class UsMailV2Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super(prediction)
-            @prediction = UsMailV2PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
-          end
-        end
-
-        # US Mail V2 page prediction.
-        class UsMailV2PagePrediction < UsMailV2Document
-          # @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/us/us_mail/us_mail_v2_recipient_address.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # The addresses of the recipients.
-        class UsMailV2RecipientAddress < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The city of the recipient's address.
-          # @return [String]
-          attr_reader :city
-          # The complete address of the recipient.
-          # @return [String]
-          attr_reader :complete
-          # Indicates if the recipient's address is a change of address.
-          # @return [Boolean]
-          attr_reader :is_address_change
-          # The postal code of the recipient's address.
-          # @return [String]
-          attr_reader :postal_code
-          # The private mailbox number of the recipient's address.
-          # @return [String]
-          attr_reader :private_mailbox_number
-          # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-          # @return [String]
-          attr_reader :state
-          # The street of the recipient's address.
-          # @return [String]
-          attr_reader :street
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super(prediction, page_id)
-            @city = prediction['city']
-            @complete = prediction['complete']
-            @is_address_change = prediction['is_address_change']
-            @postal_code = prediction['postal_code']
-            @private_mailbox_number = prediction['private_mailbox_number']
-            @state = prediction['state']
-            @street = prediction['street']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:city] = format_for_display(@city)
-            printable[:complete] = format_for_display(@complete)
-            printable[:is_address_change] = format_for_display(@is_address_change)
-            printable[:postal_code] = format_for_display(@postal_code)
-            printable[:private_mailbox_number] = format_for_display(@private_mailbox_number)
-            printable[:state] = format_for_display(@state)
-            printable[:street] = format_for_display(@street)
-            printable
-          end
-
-          # @return [Hash]
-          def table_printable_values
-            printable = {}
-            printable[:city] = format_for_display(@city, 15)
-            printable[:complete] = format_for_display(@complete, 35)
-            printable[:is_address_change] = format_for_display(@is_address_change, nil)
-            printable[:postal_code] = format_for_display(@postal_code, nil)
-            printable[:private_mailbox_number] = format_for_display(@private_mailbox_number, nil)
-            printable[:state] = format_for_display(@state, nil)
-            printable[:street] = format_for_display(@street, 25)
-            printable
-          end
-
-          # @return [String]
-          def to_table_line
-            printable = table_printable_values
-            out_str = String.new
-            out_str << format('| %- 16s', printable[:city])
-            out_str << format('| %- 36s', printable[:complete])
-            out_str << format('| %- 18s', printable[:is_address_change])
-            out_str << format('| %- 12s', printable[:postal_code])
-            out_str << format('| %- 23s', printable[:private_mailbox_number])
-            out_str << format('| %- 6s', printable[:state])
-            out_str << format('| %- 26s', printable[:street])
-            out_str << '|'
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :City: #{printable[:city]}"
-            out_str << "\n  :Complete Address: #{printable[:complete]}"
-            out_str << "\n  :Is Address Change: #{printable[:is_address_change]}"
-            out_str << "\n  :Postal Code: #{printable[:postal_code]}"
-            out_str << "\n  :Private Mailbox Number: #{printable[:private_mailbox_number]}"
-            out_str << "\n  :State: #{printable[:state]}"
-            out_str << "\n  :Street: #{printable[:street]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v2_sender_address.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # The address of the sender.
-        class UsMailV2SenderAddress < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The city of the sender's address.
-          # @return [String]
-          attr_reader :city
-          # The complete address of the sender.
-          # @return [String]
-          attr_reader :complete
-          # The postal code of the sender's address.
-          # @return [String]
-          attr_reader :postal_code
-          # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-          # @return [String]
-          attr_reader :state
-          # The street of the sender's address.
-          # @return [String]
-          attr_reader :street
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super(prediction, page_id)
-            @city = prediction['city']
-            @complete = prediction['complete']
-            @postal_code = prediction['postal_code']
-            @state = prediction['state']
-            @street = prediction['street']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:city] = format_for_display(@city)
-            printable[:complete] = format_for_display(@complete)
-            printable[:postal_code] = format_for_display(@postal_code)
-            printable[:state] = format_for_display(@state)
-            printable[:street] = format_for_display(@street)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :City: #{printable[:city]}"
-            out_str << "\n  :Complete Address: #{printable[:complete]}"
-            out_str << "\n  :Postal Code: #{printable[:postal_code]}"
-            out_str << "\n  :State: #{printable[:state]}"
-            out_str << "\n  :Street: #{printable[:street]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end