mindee 3.17.0 → 3.19.0

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

@@ -0,0 +1,113 @@
+# 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 [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
+          # 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(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']
+            @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

@@ -0,0 +1,66 @@
+# 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(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

data/lib/mindee/product.rb

@@ -13,7 +13,6 @@ require_relative 'product/fr/bank_account_details/bank_account_details_v1'
 require_relative 'product/fr/bank_account_details/bank_account_details_v2'
 require_relative 'product/fr/bank_statement/bank_statement_v1'
 require_relative 'product/fr/carte_grise/carte_grise_v1'
-require_relative 'product/fr/carte_vitale/carte_vitale_v1'
 require_relative 'product/fr/id_card/id_card_v1'
 require_relative 'product/fr/id_card/id_card_v2'
 require_relative 'product/fr/energy_bill/energy_bill_v1'
@@ -37,4 +36,5 @@ require_relative 'product/us/bank_check/bank_check_v1'
 require_relative 'product/us/driver_license/driver_license_v1'
 require_relative 'product/us/healthcare_card/healthcare_card_v1'
 require_relative 'product/us/us_mail/us_mail_v2'
+require_relative 'product/us/us_mail/us_mail_v3'
 require_relative 'product/us/w9/w9_v1'

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '3.17.0'
+  VERSION = '3.19.0'
 
   # Finds and return the current platform.
   # @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.19.0
 platform: ruby
 authors:
 - Mindee, SA
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -166,7 +166,6 @@ files:
 - docs/code_samples/bill_of_lading_v1_async.txt
 - docs/code_samples/business_card_v1_async.txt
 - docs/code_samples/carte_grise_v1.txt
-- docs/code_samples/carte_vitale_v1.txt
 - docs/code_samples/cropper_v1.txt
 - docs/code_samples/custom_v1.txt
 - docs/code_samples/default.txt
@@ -199,6 +198,7 @@ files:
 - docs/code_samples/us_driver_license_v1.txt
 - docs/code_samples/us_healthcare_cards_v1_async.txt
 - docs/code_samples/us_mail_v2_async.txt
+- docs/code_samples/us_mail_v3_async.txt
 - docs/code_samples/us_w9_v1.txt
 - docs/code_samples/workflow_execution.txt
 - docs/cropper_v1.md
@@ -224,7 +224,7 @@ files:
 - docs/payslip_fra_v3.md
 - docs/resume_v1.md
 - docs/us_healthcare_cards_v1.md
-- docs/us_mail_v2.md
+- docs/us_mail_v3.md
 - docs/us_w9_v1.md
 - examples/auto_invoice_splitter_extraction.rb
 - examples/auto_multi_receipts_detector_extraction.rb
@@ -260,6 +260,12 @@ files:
 - lib/mindee/input.rb
 - lib/mindee/input/local_response.rb
 - lib/mindee/input/sources.rb
+- lib/mindee/input/sources/base64_input_source.rb
+- lib/mindee/input/sources/bytes_input_source.rb
+- lib/mindee/input/sources/file_input_source.rb
+- lib/mindee/input/sources/local_input_source.rb
+- lib/mindee/input/sources/path_input_source.rb
+- lib/mindee/input/sources/url_input_source.rb
 - lib/mindee/parsing.rb
 - lib/mindee/parsing/common.rb
 - lib/mindee/parsing/common/api_response.rb
@@ -353,9 +359,6 @@ files:
 - lib/mindee/product/fr/carte_grise/carte_grise_v1.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb
 - lib/mindee/product/fr/carte_grise/carte_grise_v1_page.rb
-- lib/mindee/product/fr/carte_vitale/carte_vitale_v1.rb
-- lib/mindee/product/fr/carte_vitale/carte_vitale_v1_document.rb
-- lib/mindee/product/fr/carte_vitale/carte_vitale_v1_page.rb
 - lib/mindee/product/fr/energy_bill/energy_bill_v1.rb
 - lib/mindee/product/fr/energy_bill/energy_bill_v1_document.rb
 - lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_consumer.rb
@@ -468,6 +471,11 @@ files:
 - lib/mindee/product/us/us_mail/us_mail_v2_page.rb
 - lib/mindee/product/us/us_mail/us_mail_v2_recipient_address.rb
 - lib/mindee/product/us/us_mail/us_mail_v2_sender_address.rb
+- lib/mindee/product/us/us_mail/us_mail_v3.rb
+- lib/mindee/product/us/us_mail/us_mail_v3_document.rb
+- lib/mindee/product/us/us_mail/us_mail_v3_page.rb
+- lib/mindee/product/us/us_mail/us_mail_v3_recipient_address.rb
+- lib/mindee/product/us/us_mail/us_mail_v3_sender_address.rb
 - lib/mindee/product/us/w9/w9_v1.rb
 - lib/mindee/product/us/w9/w9_v1_document.rb
 - lib/mindee/product/us/w9/w9_v1_page.rb
@@ -481,7 +489,7 @@ metadata:
   source_code_uri: https://github.com/mindee/mindee-api-ruby
   changelog_uri: https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -497,7 +505,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Mindee API Helper Library for Ruby
 test_files: []

data/lib/mindee/product/fr/carte_vitale/carte_vitale_v1_document.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module FR
-      module CarteVitale
-        # Carte Vitale API version 1.1 document data.
-        class CarteVitaleV1Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The given name(s) of the card holder.
-          # @return [Array<Mindee::Parsing::Standard::StringField>]
-          attr_reader :given_names
-          # The date the card was issued.
-          # @return [Mindee::Parsing::Standard::DateField]
-          attr_reader :issuance_date
-          # The Social Security Number (Numéro de Sécurité Sociale) of the card holder
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :social_security
-          # The surname of the card holder.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :surname
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super()
-            @given_names = []
-            prediction['given_names'].each do |item|
-              @given_names.push(StringField.new(item, page_id))
-            end
-            @issuance_date = DateField.new(prediction['issuance_date'], page_id)
-            @social_security = StringField.new(prediction['social_security'], page_id)
-            @surname = StringField.new(prediction['surname'], page_id)
-          end
-
-          # @return [String]
-          def to_s
-            given_names = @given_names.join("\n #{' ' * 15}")
-            out_str = String.new
-            out_str << "\n:Given Name(s): #{given_names}".rstrip
-            out_str << "\n:Surname: #{@surname}".rstrip
-            out_str << "\n:Social Security Number: #{@social_security}".rstrip
-            out_str << "\n:Issuance Date: #{@issuance_date}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end