mindee 3.20.0 → 4.0.0

data/lib/mindee/product/{generated/generated_v1_prediction.rb → universal/universal_prediction.rb}

@@ -4,19 +4,19 @@ require_relative '../../parsing'
 
 module Mindee
   module Product
-    module Generated
-      # Generated Document V1 page.
-      class GeneratedV1Prediction < Mindee::Parsing::Common::Prediction
+    module Universal
+      # Universal Document V1 page.
+      class UniversalPrediction < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Common
         include Mindee::Parsing::Standard
-        include Mindee::Parsing::Generated
+        include Mindee::Parsing::Universal
         # All value fields in the document
-        # @return [Hash<Symbol, Mindee::Parsing::Generated::GeneratedListField>]
+        # @return [Hash<Symbol, Mindee::Parsing::Universal::UniversalListField>]
         attr_reader :fields
 
-        def initialize
-          super()
-          @fields = {}
+        def initialize(_ = nil)
+          super
+          @fields = {} # : Hash[Symbol | String, untyped]
         end
 
         # String representation.
@@ -24,7 +24,9 @@ module Mindee
           out_str = ''
           pattern = %r{^(\n* *)( {2}):}
           @fields.each do |field_name, field_value|
-            str_value = if field_value.is_a?(GeneratedListField) && field_value.values.length.positive?
+            str_value = if field_value.is_a?(
+              Mindee::Parsing::Universal::UniversalListField
+            ) && field_value.values.length.positive?
                           generate_field_string(field_name, field_value, pattern)
                         else
                           field_value.to_s
@@ -39,21 +41,24 @@ module Mindee
         private
 
         def generate_field_string(field_name, field_value, pattern)
-          return '' if field_value.values.empty? || field_value.values.nil?
+          values = field_value.values
+          return '' if values.nil? || values.empty?
 
           str_value = ''
-          str_value += if field_value.values[0].is_a?(Parsing::Generated::GeneratedObjectField)
-                         field_value.values[0].str_level(1).sub(pattern, '\\1* :')
+          first_value = values[0]
+          str_value += if first_value.is_a?(Parsing::Universal::UniversalObjectField)
+                         first_value.str_level(1).sub(pattern, '\\1* :')
                        else
-                         "#{field_value.values[0].to_s.sub(pattern, '\\1* :')}\n"
+                         "#{first_value.to_s.sub(pattern, '\\1* :')}\n"
                        end
-          field_value.values[1..].each do |sub_value|
-            str_value += if sub_value.is_a?(Parsing::Generated::GeneratedObjectField)
+          Array(values[1..]).each do |sub_value|
+            str_value += if sub_value.is_a?(Parsing::Universal::UniversalObjectField)
                            sub_value.str_level(1).sub(pattern, '\\1* :')
                          else
                            "#{' ' * (field_name.length + 2)} #{sub_value}\n"
                          end
           end
+
           str_value.rstrip
         end
 
@@ -66,7 +71,7 @@ module Mindee
         end
 
         def generate_sub_value_string(field_name, sub_value, pattern)
-          if sub_value.is_a?(GeneratedObjectField)
+          if sub_value.is_a?(Mindee::Parsing::Universal::UniversalObjectField)
             sub_value.str_level(1).gsub(pattern, '\1* :')
           else
             (' ' * (field_name.length + 2)) + "#{sub_value}\n"
@@ -76,29 +81,32 @@ module Mindee
         # Returns a hash of all fields that aren't a collection
         # @return [Hash<String, StringField>]
         def single_fields
-          single_fields = {}
+          single_fields = {} # : Hash[Symbol | String, untyped]
           @fields.each do |field_name, field_value|
-            single_fields[field_name] = field_value if field_value.is_a?(StringField)
+            single_fields[field_name] = field_value if field_value.is_a?(Mindee::Parsing::Standard::StringField)
           end
           single_fields
         end
 
         # Returns a hash of all list-like fields
-        # @return [Hash<String, GeneratedListField>]
+        # @return [Hash<String, UniversalListField>]
         def list_fields
-          list_fields = {}
+          list_fields = {} # : Hash[Symbol | String, Mindee::Parsing::Universal::UniversalListField]
           @fields.each do |field_name, field_value|
-            list_fields[field_name] = field_value if field_value.is_a?(GeneratedListField)
+            list_fields[field_name] = field_value if field_value.is_a?(Mindee::Parsing::Universal::UniversalListField)
           end
           list_fields
         end
 
         # Returns a hash of all object-like fields
-        # @return [Hash<String, GeneratedObjectField>]
+        # @return [Hash<String, UniversalObjectField>]
         def object_fields
-          object_fields = {}
+          object_fields = {} # : Hash[Symbol | String, untyped]
           @fields.each do |field_name, field_value|
-            object_fields[field_name] = field_value if field_value.is_a?(GeneratedObjectField)
+            if field_value.is_a?(Mindee::Parsing::Universal::UniversalObjectField)
+              object_fields[field_name] =
+                field_value
+            end
           end
           object_fields
         end

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

@@ -13,6 +13,8 @@ module Mindee
         class BankCheckV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'bank_check'
           @endpoint_version = '1'
+          @has_async = false
+          @has_sync = true
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = BankCheckV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(BankCheckV1Page.new(page))
-              end
+              @pages.push(BankCheckV1Page.new(page))
             end
           end
 
@@ -33,6 +33,12 @@ module Mindee
             # 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

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

@@ -31,16 +31,28 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @account_number = StringField.new(prediction['account_number'], page_id)
-            @amount = AmountField.new(prediction['amount'], page_id)
-            @check_number = StringField.new(prediction['check_number'], page_id)
-            @date = DateField.new(prediction['date'], page_id)
-            @payees = []
+            super
+            @account_number = Parsing::Standard::StringField.new(
+              prediction['account_number'],
+              page_id
+            )
+            @amount = Parsing::Standard::AmountField.new(
+              prediction['amount'],
+              page_id
+            )
+            @check_number = Parsing::Standard::StringField.new(
+              prediction['check_number'],
+              page_id
+            )
+            @date = Parsing::Standard::DateField.new(prediction['date'], page_id)
+            @payees = [] # : Array[Parsing::Standard::StringField]
             prediction['payees'].each do |item|
-              @payees.push(StringField.new(item, page_id))
+              @payees.push(Parsing::Standard::StringField.new(item, page_id))
             end
-            @routing_number = StringField.new(prediction['routing_number'], page_id)
+            @routing_number = Parsing::Standard::StringField.new(
+              prediction['routing_number'],
+              page_id
+            )
           end
 
           # @return [String]

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

@@ -11,11 +11,15 @@ module Mindee
         class BankCheckV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = BankCheckV1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            BankCheckV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 
@@ -33,12 +37,15 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            @check_position = PositionField.new(prediction['check_position'], page_id)
+            @check_position = Parsing::Standard::PositionField.new(
+              prediction['check_position'],
+              page_id
+            )
             @signatures_positions = []
             prediction['signatures_positions'].each do |item|
-              @signatures_positions.push(PositionField.new(item, page_id))
+              @signatures_positions.push(Parsing::Standard::PositionField.new(item, page_id))
             end
-            super(prediction, page_id)
+            super
           end
 
           # @return [String]

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

@@ -13,6 +13,8 @@ module Mindee
         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)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = HealthcareCardV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(HealthcareCardV1Page.new(page))
-              end
+              @pages.push(HealthcareCardV1Page.new(page))
             end
           end
 
@@ -33,6 +33,12 @@ module Mindee
             # 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

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

@@ -19,7 +19,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @service_fees = prediction['service_fees']
             @service_name = prediction['service_name']
             @page_id = page_id
@@ -28,7 +28,8 @@ module Mindee
           # @return [Hash]
           def printable_values
             printable = {}
-            printable[:service_fees] = @service_fees.nil? ? '' : Field.float_to_string(@service_fees)
+            printable[:service_fees] =
+              @service_fees.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@service_fees)
             printable[:service_name] = format_for_display(@service_name)
             printable
           end
@@ -36,7 +37,8 @@ module Mindee
           # @return [Hash]
           def table_printable_values
             printable = {}
-            printable[:service_fees] = @service_fees.nil? ? '' : Field.float_to_string(@service_fees)
+            printable[:service_fees] =
+              @service_fees.nil? ? '' : Parsing::Standard::BaseField.float_to_string(@service_fees)
             printable[:service_name] = format_for_display(@service_name, nil)
             printable
           end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'healthcare_card_v1_copay'
+
+module Mindee
+  module Product
+    module US
+      module HealthcareCard
+        # Is a fixed amount for a covered service.
+        class HealthcareCardV1Copays < Array
+          # Entries.
+          # @return [Array<HealthcareCardV1Copay>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              HealthcareCard::HealthcareCardV1Copay.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            out_str << "+#{char * 14}"
+            out_str << "+#{char * 14}"
+            out_str
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << ("\n#{self.class.line_items_separator('-')}\n ")
+            out_str << ' | Service Fees'
+            out_str << ' | Service Name'
+            out_str << (" |\n#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../parsing'
-require_relative 'healthcare_card_v1_copay'
+require_relative 'healthcare_card_v1_copays'
 
 module Mindee
   module Product
@@ -14,7 +14,7 @@ module Mindee
           # @return [Mindee::Parsing::Standard::StringField]
           attr_reader :company_name
           # Is a fixed amount for a covered service.
-          # @return [Array<Mindee::Product::US::HealthcareCard::HealthcareCardV1Copay>]
+          # @return [Mindee::Product::US::HealthcareCard::HealthcareCardV1Copays]
           attr_reader :copays
           # The list of dependents covered by the healthcare plan.
           # @return [Array<Mindee::Parsing::Standard::StringField>]
@@ -50,25 +50,52 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @company_name = StringField.new(prediction['company_name'], page_id)
-            @copays = []
-            prediction['copays'].each do |item|
-              @copays.push(HealthcareCardV1Copay.new(item, page_id))
-            end
-            @dependents = []
+            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(StringField.new(item, page_id))
+              @dependents.push(Parsing::Standard::StringField.new(item, page_id))
             end
-            @enrollment_date = DateField.new(prediction['enrollment_date'], page_id)
-            @group_number = StringField.new(prediction['group_number'], page_id)
-            @issuer80840 = StringField.new(prediction['issuer_80840'], page_id)
-            @member_id = StringField.new(prediction['member_id'], page_id)
-            @member_name = StringField.new(prediction['member_name'], page_id)
-            @payer_id = StringField.new(prediction['payer_id'], page_id)
-            @rx_bin = StringField.new(prediction['rx_bin'], page_id)
-            @rx_grp = StringField.new(prediction['rx_grp'], page_id)
-            @rx_pcn = StringField.new(prediction['rx_pcn'], page_id)
+            @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
+            )
+            @rx_bin = Parsing::Standard::StringField.new(
+              prediction['rx_bin'],
+              page_id
+            )
+            @rx_grp = Parsing::Standard::StringField.new(
+              prediction['rx_grp'],
+              page_id
+            )
+            @rx_pcn = Parsing::Standard::StringField.new(
+              prediction['rx_pcn'],
+              page_id
+            )
           end
 
           # @return [String]

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

@@ -11,11 +11,15 @@ module Mindee
         class HealthcareCardV1Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = HealthcareCardV1PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            HealthcareCardV1PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 

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

@@ -13,6 +13,8 @@ module Mindee
         class UsMailV3 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'us_mail'
           @endpoint_version = '3'
+          @has_async = true
+          @has_sync = false
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = UsMailV3Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(UsMailV3Page.new(page))
-              end
+              @pages.push(UsMailV3Page.new(page))
             end
           end
 
@@ -33,6 +33,12 @@ module Mindee
             # 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

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

@@ -2,7 +2,7 @@
 
 require_relative '../../../parsing'
 require_relative 'us_mail_v3_sender_address'
-require_relative 'us_mail_v3_recipient_address'
+require_relative 'us_mail_v3_recipient_addresses'
 
 module Mindee
   module Product
@@ -15,7 +15,7 @@ module Mindee
           # @return [Mindee::Parsing::Standard::BooleanField]
           attr_reader :is_return_to_sender
           # The addresses of the recipients.
-          # @return [Array<Mindee::Product::US::UsMail::UsMailV3RecipientAddress>]
+          # @return [Mindee::Product::US::UsMail::UsMailV3RecipientAddresses]
           attr_reader :recipient_addresses
           # The names of the recipients.
           # @return [Array<Mindee::Parsing::Standard::StringField>]
@@ -30,18 +30,26 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @is_return_to_sender = BooleanField.new(prediction['is_return_to_sender'], page_id)
-            @recipient_addresses = []
-            prediction['recipient_addresses'].each do |item|
-              @recipient_addresses.push(UsMailV3RecipientAddress.new(item, page_id))
-            end
-            @recipient_names = []
+            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(StringField.new(item, page_id))
+              @recipient_names.push(Parsing::Standard::StringField.new(item, page_id))
             end
-            @sender_address = UsMailV3SenderAddress.new(prediction['sender_address'], page_id)
-            @sender_name = StringField.new(prediction['sender_name'], page_id)
+            @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]

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

@@ -11,11 +11,15 @@ module Mindee
         class UsMailV3Page < Mindee::Parsing::Common::Page
           # @param prediction [Hash]
           def initialize(prediction)
-            super(prediction)
-            @prediction = UsMailV3PagePrediction.new(
-              prediction['prediction'],
-              prediction['id']
-            )
+            super
+            @prediction = if prediction['prediction'].empty?
+                            nil
+                          else
+                            UsMailV3PagePrediction.new(
+                              prediction['prediction'],
+                              prediction['id']
+                            )
+                          end
           end
         end
 

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

@@ -16,7 +16,7 @@ module Mindee
           # @return [String]
           attr_reader :complete
           # Indicates if the recipient's address is a change of address.
-          # @return [Boolean]
+          # @return [bool]
           attr_reader :is_address_change
           # The postal code of the recipient's address.
           # @return [String]
@@ -37,7 +37,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @city = prediction['city']
             @complete = prediction['complete']
             @is_address_change = prediction['is_address_change']

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'us_mail_v3_sender_address'
+require_relative 'us_mail_v3_recipient_address'
+
+module Mindee
+  module Product
+    module US
+      module UsMail
+        # The addresses of the recipients.
+        class UsMailV3RecipientAddresses < Array
+          # Entries.
+          # @return [Array<UsMailV3RecipientAddress>]
+          attr_reader :entries
+
+          # @param prediction [Array]
+          # @param page_id [Integer, nil]
+          def initialize(prediction, page_id)
+            entries = prediction.map do |entry|
+              UsMail::UsMailV3RecipientAddress.new(entry, page_id)
+            end
+            super(entries)
+          end
+
+          # Creates a line of rST table-compliant string separators.
+          # @param char [String] Character to use as a separator.
+          # @return [String]
+          def self.line_items_separator(char)
+            out_str = String.new
+            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
+          end
+
+          # @return [String]
+          def to_s
+            return '' if empty?
+
+            lines = map do |entry|
+              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
+            end.join
+            out_str = String.new
+            out_str << ("\n#{self.class.line_items_separator('-')}\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#{self.class.line_items_separator('=')}")
+            out_str + lines
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super(prediction, page_id)
+            super
             @city = prediction['city']
             @complete = prediction['complete']
             @postal_code = prediction['postal_code']