mindee 4.13.0 → 5.0.0.rc1

data/lib/mindee/product/us/bank_check/bank_check_v1_page.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_check_v1_document'
-
-module Mindee
-  module Product
-    module US
-      module BankCheck
-        # Bank Check API version 1.1 page data.
-        class BankCheckV1Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            BankCheckV1PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # Bank Check V1 page prediction.
-        class BankCheckV1PagePrediction < BankCheckV1Document
-          include Mindee::Parsing::Standard
-
-          # The position of the check on the document.
-          # @return [Mindee::Parsing::Standard::PositionField]
-          attr_reader :check_position
-          # List of signature positions
-          # @return [Array<Mindee::Parsing::Standard::PositionField>]
-          attr_reader :signatures_positions
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            @check_position = Parsing::Standard::PositionField.new(
-              prediction['check_position'],
-              page_id
-            )
-            @signatures_positions = []
-            prediction['signatures_positions'].each do |item|
-              @signatures_positions.push(Parsing::Standard::PositionField.new(item, page_id))
-            end
-            super
-          end
-
-          # @return [String]
-          def to_s
-            signatures_positions = @signatures_positions.join("\n #{' ' * 21}")
-            out_str = String.new
-            out_str << "\n:Check Position: #{@check_position}".rstrip
-            out_str << "\n:Signature Positions: #{signatures_positions}".rstrip
-            out_str << "\n#{super}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'healthcare_card_v1_document'
-require_relative 'healthcare_card_v1_page'
-
-module Mindee
-  module Product
-    module US
-      # Healthcare Card module.
-      module HealthcareCard
-        # Healthcare Card API version 1 inference prediction.
-        class HealthcareCardV1 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'us_healthcare_cards'
-          @endpoint_version = '1'
-          @has_async = true
-          @has_sync = false
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = HealthcareCardV1Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(HealthcareCardV1Page.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
-            # Whether this product has access to an asynchronous endpoint.
-            # @return [bool]
-            attr_reader :has_async
-            # Whether this product has access to synchronous endpoint.
-            # @return [bool]
-            attr_reader :has_sync
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_copay.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module HealthcareCard
-        # Copayments for covered services.
-        class HealthcareCardV1Copay < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The price of the service.
-          # @return [Float]
-          attr_reader :service_fees
-          # The name of the service.
-          # @return [String]
-          attr_reader :service_name
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @service_fees = prediction['service_fees']
-            @service_name = prediction['service_name']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:service_fees] =
-              @service_fees.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@service_fees)
-            printable[:service_name] = format_for_display(@service_name)
-            printable
-          end
-
-          # @return [Hash]
-          def table_printable_values
-            printable = {}
-            printable[:service_fees] =
-              @service_fees.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@service_fees)
-            printable[:service_name] = format_for_display(@service_name, 20)
-            printable
-          end
-
-          # @return [String]
-          def to_table_line
-            printable = table_printable_values
-            out_str = String.new
-            out_str << format('| %- 13s', printable[:service_fees])
-            out_str << format('| %- 21s', printable[:service_name])
-            out_str << '|'
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :Service Fees: #{printable[:service_fees]}"
-            out_str << "\n  :Service Name: #{printable[:service_name]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_document.rb

@@ -1,167 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'healthcare_card_v1_copays'
-
-module Mindee
-  module Product
-    module US
-      module HealthcareCard
-        # Healthcare Card API version 1.3 document data.
-        class HealthcareCardV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The name of the company that provides the healthcare plan.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :company_name
-          # Copayments for covered services.
-          # @return [Mindee::Product::US::HealthcareCard::HealthcareCardV1Copays]
-          attr_reader :copays
-          # The list of dependents covered by the healthcare plan.
-          # @return [Array<Mindee::Parsing::Standard::StringField>]
-          attr_reader :dependents
-          # The date when the member enrolled in the healthcare plan.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :enrollment_date
-          # The group number associated with the healthcare plan.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :group_number
-          # The organization that issued the healthcare plan.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :issuer80840
-          # The unique identifier for the member in the healthcare system.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :member_id
-          # The name of the member covered by the healthcare plan.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :member_name
-          # The unique identifier for the payer in the healthcare system.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :payer_id
-          # The name of the healthcare plan.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :plan_name
-          # The BIN number for prescription drug coverage.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :rx_bin
-          # The group number for prescription drug coverage.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :rx_grp
-          # The ID number for prescription drug coverage.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :rx_id
-          # The PCN number for prescription drug coverage.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :rx_pcn
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @company_name = Parsing::Standard::StringField.new(
-              prediction['company_name'],
-              page_id
-            )
-            @copays = Product::US::HealthcareCard::HealthcareCardV1Copays.new(prediction['copays'], page_id)
-            @dependents = [] # : Array[Parsing::Standard::StringField]
-            prediction['dependents'].each do |item|
-              @dependents.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-            @enrollment_date = Parsing::Standard::DateField.new(
-              prediction['enrollment_date'],
-              page_id
-            )
-            @group_number = Parsing::Standard::StringField.new(
-              prediction['group_number'],
-              page_id
-            )
-            @issuer80840 = Parsing::Standard::StringField.new(
-              prediction['issuer_80840'],
-              page_id
-            )
-            @member_id = Parsing::Standard::StringField.new(
-              prediction['member_id'],
-              page_id
-            )
-            @member_name = Parsing::Standard::StringField.new(
-              prediction['member_name'],
-              page_id
-            )
-            @payer_id = Parsing::Standard::StringField.new(
-              prediction['payer_id'],
-              page_id
-            )
-            @plan_name = Parsing::Standard::StringField.new(
-              prediction['plan_name'],
-              page_id
-            )
-            @rx_bin = Parsing::Standard::StringField.new(
-              prediction['rx_bin'],
-              page_id
-            )
-            @rx_grp = Parsing::Standard::StringField.new(
-              prediction['rx_grp'],
-              page_id
-            )
-            @rx_id = Parsing::Standard::StringField.new(prediction['rx_id'], page_id)
-            @rx_pcn = Parsing::Standard::StringField.new(
-              prediction['rx_pcn'],
-              page_id
-            )
-          end
-
-          # @return [String]
-          def to_s
-            dependents = @dependents.join("\n #{' ' * 12}")
-            copays = copays_to_s
-            out_str = String.new
-            out_str << "\n:Company Name: #{@company_name}".rstrip
-            out_str << "\n:Plan Name: #{@plan_name}".rstrip
-            out_str << "\n:Member Name: #{@member_name}".rstrip
-            out_str << "\n:Member ID: #{@member_id}".rstrip
-            out_str << "\n:Issuer 80840: #{@issuer80840}".rstrip
-            out_str << "\n:Dependents: #{dependents}".rstrip
-            out_str << "\n:Group Number: #{@group_number}".rstrip
-            out_str << "\n:Payer ID: #{@payer_id}".rstrip
-            out_str << "\n:RX BIN: #{@rx_bin}".rstrip
-            out_str << "\n:RX ID: #{@rx_id}".rstrip
-            out_str << "\n:RX GRP: #{@rx_grp}".rstrip
-            out_str << "\n:RX PCN: #{@rx_pcn}".rstrip
-            out_str << "\n:Copays:"
-            out_str << copays
-            out_str << "\n:Enrollment Date: #{@enrollment_date}".rstrip
-            out_str[1..].to_s
-          end
-
-          private
-
-          # @param char [String]
-          # @return [String]
-          def copays_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 14}"
-            out_str << "+#{char * 22}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def copays_to_s
-            return '' if @copays.empty?
-
-            line_items = @copays.map(&:to_table_line).join("\n#{copays_separator('-')}\n  ")
-            out_str = String.new
-            out_str << "\n#{copays_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' Service Fees |'
-            out_str << ' Service Name         |'
-            out_str << "\n#{copays_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{copays_separator('-')}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_page.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'healthcare_card_v1_document'
-
-module Mindee
-  module Product
-    module US
-      module HealthcareCard
-        # Healthcare Card API version 1.3 page data.
-        class HealthcareCardV1Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            HealthcareCardV1PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # Healthcare Card V1 page prediction.
-        class HealthcareCardV1PagePrediction < HealthcareCardV1Document
-          # @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_v3_document.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'us_mail_v3_sender_address'
-require_relative 'us_mail_v3_recipient_addresses'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # US Mail API version 3.0 document data.
-        class UsMailV3Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # Whether the mailing is marked as return to sender.
-          # @return [Mindee::Parsing::Standard::BooleanField]
-          attr_reader :is_return_to_sender
-          # The addresses of the recipients.
-          # @return [Mindee::Product::US::UsMail::UsMailV3RecipientAddresses]
-          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::UsMailV3SenderAddress]
-          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
-            @is_return_to_sender = Parsing::Standard::BooleanField.new(
-              prediction['is_return_to_sender'],
-              page_id
-            )
-            @recipient_addresses = Product::US::UsMail::UsMailV3RecipientAddresses.new(
-              prediction['recipient_addresses'], page_id
-            )
-            @recipient_names = [] # : Array[Parsing::Standard::StringField]
-            prediction['recipient_names'].each do |item|
-              @recipient_names.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-            @sender_address = Product::US::UsMail::UsMailV3SenderAddress.new(
-              prediction['sender_address'],
-              page_id
-            )
-            @sender_name = Parsing::Standard::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 << "\n:Return to Sender: #{@is_return_to_sender}".rstrip
-            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 << "+#{char * 17}"
-            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 << ' Unit            |'
-            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_v3_recipient_address.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # The addresses of the recipients.
-        class UsMailV3RecipientAddress < 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 [bool]
-          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
-          # The unit number of the recipient's address.
-          # @return [String]
-          attr_reader :unit
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @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']
-            @unit = prediction['unit']
-            @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[:unit] = format_for_display(@unit)
-            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[:unit] = format_for_display(@unit, 15)
-            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 << format('| %- 16s', printable[:unit])
-            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 << "\n  :Unit: #{printable[:unit]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v3_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 UsMailV3SenderAddress < 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
-            @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