mindee 3.19.1 → 4.0.0

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_document.rb

@@ -5,7 +5,7 @@ require_relative 'bill_of_lading_v1_shipper'
 require_relative 'bill_of_lading_v1_consignee'
 require_relative 'bill_of_lading_v1_notify_party'
 require_relative 'bill_of_lading_v1_carrier'
-require_relative 'bill_of_lading_v1_carrier_item'
+require_relative 'bill_of_lading_v1_carrier_items'
 
 module Mindee
   module Product
@@ -20,7 +20,7 @@ module Mindee
         # @return [Mindee::Product::BillOfLading::BillOfLadingV1Carrier]
         attr_reader :carrier
         # The goods being shipped.
-        # @return [Array<Mindee::Product::BillOfLading::BillOfLadingV1CarrierItem>]
+        # @return [Mindee::Product::BillOfLading::BillOfLadingV1CarrierItems]
         attr_reader :carrier_items
         # The party to whom the goods are being shipped.
         # @return [Mindee::Product::BillOfLading::BillOfLadingV1Consignee]
@@ -50,21 +50,48 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @bill_of_lading_number = StringField.new(prediction['bill_of_lading_number'], page_id)
-          @carrier = BillOfLadingV1Carrier.new(prediction['carrier'], page_id)
-          @carrier_items = []
-          prediction['carrier_items'].each do |item|
-            @carrier_items.push(BillOfLadingV1CarrierItem.new(item, page_id))
-          end
-          @consignee = BillOfLadingV1Consignee.new(prediction['consignee'], page_id)
-          @date_of_issue = DateField.new(prediction['date_of_issue'], page_id)
-          @departure_date = DateField.new(prediction['departure_date'], page_id)
-          @notify_party = BillOfLadingV1NotifyParty.new(prediction['notify_party'], page_id)
-          @place_of_delivery = StringField.new(prediction['place_of_delivery'], page_id)
-          @port_of_discharge = StringField.new(prediction['port_of_discharge'], page_id)
-          @port_of_loading = StringField.new(prediction['port_of_loading'], page_id)
-          @shipper = BillOfLadingV1Shipper.new(prediction['shipper'], page_id)
+          super
+          @bill_of_lading_number = Parsing::Standard::StringField.new(
+            prediction['bill_of_lading_number'],
+            page_id
+          )
+          @carrier = Product::BillOfLading::BillOfLadingV1Carrier.new(
+            prediction['carrier'],
+            page_id
+          )
+          @carrier_items = Product::BillOfLading::BillOfLadingV1CarrierItems.new(prediction['carrier_items'], page_id)
+          @consignee = Product::BillOfLading::BillOfLadingV1Consignee.new(
+            prediction['consignee'],
+            page_id
+          )
+          @date_of_issue = Parsing::Standard::DateField.new(
+            prediction['date_of_issue'],
+            page_id
+          )
+          @departure_date = Parsing::Standard::DateField.new(
+            prediction['departure_date'],
+            page_id
+          )
+          @notify_party = Product::BillOfLading::BillOfLadingV1NotifyParty.new(
+            prediction['notify_party'],
+            page_id
+          )
+          @place_of_delivery = Parsing::Standard::StringField.new(
+            prediction['place_of_delivery'],
+            page_id
+          )
+          @port_of_discharge = Parsing::Standard::StringField.new(
+            prediction['port_of_discharge'],
+            page_id
+          )
+          @port_of_loading = Parsing::Standard::StringField.new(
+            prediction['port_of_loading'],
+            page_id
+          )
+          @shipper = Product::BillOfLading::BillOfLadingV1Shipper.new(
+            prediction['shipper'],
+            page_id
+          )
         end
 
         # @return [String]

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_notify_party.rb

@@ -24,7 +24,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @address = prediction['address']
           @email = prediction['email']
           @name = prediction['name']

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_page.rb

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

data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_shipper.rb

@@ -24,7 +24,7 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super(prediction, page_id)
+          super
           @address = prediction['address']
           @email = prediction['email']
           @name = prediction['name']

data/lib/mindee/product/business_card/business_card_v1.rb

@@ -12,6 +12,8 @@ module Mindee
       class BusinessCardV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'business_card'
         @endpoint_version = '1'
+        @has_async = true
+        @has_sync = false
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = BusinessCardV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(BusinessCardV1Page.new(page))
-            end
+            @pages.push(BusinessCardV1Page.new(page))
           end
         end
 
@@ -32,6 +32,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/business_card/business_card_v1_document.rb

@@ -45,21 +45,48 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @address = StringField.new(prediction['address'], page_id)
-          @company = StringField.new(prediction['company'], page_id)
-          @email = StringField.new(prediction['email'], page_id)
-          @fax_number = StringField.new(prediction['fax_number'], page_id)
-          @firstname = StringField.new(prediction['firstname'], page_id)
-          @job_title = StringField.new(prediction['job_title'], page_id)
-          @lastname = StringField.new(prediction['lastname'], page_id)
-          @mobile_number = StringField.new(prediction['mobile_number'], page_id)
-          @phone_number = StringField.new(prediction['phone_number'], page_id)
-          @social_media = []
+          super
+          @address = Parsing::Standard::StringField.new(
+            prediction['address'],
+            page_id
+          )
+          @company = Parsing::Standard::StringField.new(
+            prediction['company'],
+            page_id
+          )
+          @email = Parsing::Standard::StringField.new(prediction['email'], page_id)
+          @fax_number = Parsing::Standard::StringField.new(
+            prediction['fax_number'],
+            page_id
+          )
+          @firstname = Parsing::Standard::StringField.new(
+            prediction['firstname'],
+            page_id
+          )
+          @job_title = Parsing::Standard::StringField.new(
+            prediction['job_title'],
+            page_id
+          )
+          @lastname = Parsing::Standard::StringField.new(
+            prediction['lastname'],
+            page_id
+          )
+          @mobile_number = Parsing::Standard::StringField.new(
+            prediction['mobile_number'],
+            page_id
+          )
+          @phone_number = Parsing::Standard::StringField.new(
+            prediction['phone_number'],
+            page_id
+          )
+          @social_media = [] # : Array[Parsing::Standard::StringField]
           prediction['social_media'].each do |item|
-            @social_media.push(StringField.new(item, page_id))
+            @social_media.push(Parsing::Standard::StringField.new(item, page_id))
           end
-          @website = StringField.new(prediction['website'], page_id)
+          @website = Parsing::Standard::StringField.new(
+            prediction['website'],
+            page_id
+          )
         end
 
         # @return [String]

data/lib/mindee/product/business_card/business_card_v1_page.rb

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

data/lib/mindee/product/cropper/cropper_v1.rb

@@ -12,16 +12,16 @@ module Mindee
       class CropperV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'cropper'
         @endpoint_version = '1'
+        @has_async = false
+        @has_sync = true
 
         # @param prediction [Hash]
         def initialize(prediction)
           super
-          @prediction = CropperV1Document.new
+          @prediction = CropperV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(CropperV1Page.new(page))
-            end
+            @pages.push(CropperV1Page.new(page))
           end
         end
 
@@ -32,6 +32,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/cropper/cropper_v1_page.rb

@@ -10,11 +10,15 @@ module Mindee
       class CropperV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
-          super(prediction)
-          @prediction = CropperV1PagePrediction.new(
-            prediction['prediction'],
-            prediction['id']
-          )
+          super
+          @prediction = if prediction['prediction'].empty?
+                          nil
+                        else
+                          CropperV1PagePrediction.new(
+                            prediction['prediction'],
+                            prediction['id']
+                          )
+                        end
         end
       end
 
@@ -31,9 +35,9 @@ module Mindee
         def initialize(prediction, page_id)
           @cropping = []
           prediction['cropping'].each do |item|
-            @cropping.push(PositionField.new(item, page_id))
+            @cropping.push(Parsing::Standard::PositionField.new(item, page_id))
           end
-          super()
+          super
         end
 
         # @return [String]

data/lib/mindee/product/delivery_note/delivery_note_v1.rb

@@ -12,6 +12,8 @@ module Mindee
       class DeliveryNoteV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'delivery_notes'
         @endpoint_version = '1'
+        @has_async = true
+        @has_sync = false
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = DeliveryNoteV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(DeliveryNoteV1Page.new(page))
-            end
+            @pages.push(DeliveryNoteV1Page.new(page))
           end
         end
 
@@ -32,6 +32,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/delivery_note/delivery_note_v1_document.rb

@@ -33,14 +33,35 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @customer_address = StringField.new(prediction['customer_address'], page_id)
-          @customer_name = StringField.new(prediction['customer_name'], page_id)
-          @delivery_date = DateField.new(prediction['delivery_date'], page_id)
-          @delivery_number = StringField.new(prediction['delivery_number'], page_id)
-          @supplier_address = StringField.new(prediction['supplier_address'], page_id)
-          @supplier_name = StringField.new(prediction['supplier_name'], page_id)
-          @total_amount = AmountField.new(prediction['total_amount'], page_id)
+          super
+          @customer_address = Parsing::Standard::StringField.new(
+            prediction['customer_address'],
+            page_id
+          )
+          @customer_name = Parsing::Standard::StringField.new(
+            prediction['customer_name'],
+            page_id
+          )
+          @delivery_date = Parsing::Standard::DateField.new(
+            prediction['delivery_date'],
+            page_id
+          )
+          @delivery_number = Parsing::Standard::StringField.new(
+            prediction['delivery_number'],
+            page_id
+          )
+          @supplier_address = Parsing::Standard::StringField.new(
+            prediction['supplier_address'],
+            page_id
+          )
+          @supplier_name = Parsing::Standard::StringField.new(
+            prediction['supplier_name'],
+            page_id
+          )
+          @total_amount = Parsing::Standard::AmountField.new(
+            prediction['total_amount'],
+            page_id
+          )
         end
 
         # @return [String]

data/lib/mindee/product/delivery_note/delivery_note_v1_page.rb

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

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

@@ -12,6 +12,8 @@ module Mindee
       class DriverLicenseV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'driver_license'
         @endpoint_version = '1'
+        @has_async = true
+        @has_sync = false
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @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
+            @pages.push(DriverLicenseV1Page.new(page))
           end
         end
 
@@ -32,6 +32,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/driver_license/driver_license_v1_document.rb

@@ -51,20 +51,50 @@ module Mindee
         # @param prediction [Hash]
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
-          super()
-          @category = StringField.new(prediction['category'], page_id)
-          @country_code = StringField.new(prediction['country_code'], page_id)
-          @date_of_birth = DateField.new(prediction['date_of_birth'], page_id)
-          @dd_number = StringField.new(prediction['dd_number'], page_id)
-          @expiry_date = DateField.new(prediction['expiry_date'], page_id)
-          @first_name = StringField.new(prediction['first_name'], page_id)
-          @id = StringField.new(prediction['id'], page_id)
-          @issued_date = DateField.new(prediction['issued_date'], page_id)
-          @issuing_authority = StringField.new(prediction['issuing_authority'], page_id)
-          @last_name = StringField.new(prediction['last_name'], page_id)
-          @mrz = StringField.new(prediction['mrz'], page_id)
-          @place_of_birth = StringField.new(prediction['place_of_birth'], page_id)
-          @state = StringField.new(prediction['state'], page_id)
+          super
+          @category = Parsing::Standard::StringField.new(
+            prediction['category'],
+            page_id
+          )
+          @country_code = Parsing::Standard::StringField.new(
+            prediction['country_code'],
+            page_id
+          )
+          @date_of_birth = Parsing::Standard::DateField.new(
+            prediction['date_of_birth'],
+            page_id
+          )
+          @dd_number = Parsing::Standard::StringField.new(
+            prediction['dd_number'],
+            page_id
+          )
+          @expiry_date = Parsing::Standard::DateField.new(
+            prediction['expiry_date'],
+            page_id
+          )
+          @first_name = Parsing::Standard::StringField.new(
+            prediction['first_name'],
+            page_id
+          )
+          @id = Parsing::Standard::StringField.new(prediction['id'], page_id)
+          @issued_date = Parsing::Standard::DateField.new(
+            prediction['issued_date'],
+            page_id
+          )
+          @issuing_authority = Parsing::Standard::StringField.new(
+            prediction['issuing_authority'],
+            page_id
+          )
+          @last_name = Parsing::Standard::StringField.new(
+            prediction['last_name'],
+            page_id
+          )
+          @mrz = Parsing::Standard::StringField.new(prediction['mrz'], page_id)
+          @place_of_birth = Parsing::Standard::StringField.new(
+            prediction['place_of_birth'],
+            page_id
+          )
+          @state = Parsing::Standard::StringField.new(prediction['state'], page_id)
         end
 
         # @return [String]

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

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

data/lib/mindee/product/eu/license_plate/license_plate_v1.rb

@@ -13,6 +13,8 @@ module Mindee
         class LicensePlateV1 < Mindee::Parsing::Common::Inference
           @endpoint_name = 'license_plates'
           @endpoint_version = '1'
+          @has_async = false
+          @has_sync = true
 
           # @param prediction [Hash]
           def initialize(prediction)
@@ -20,9 +22,7 @@ module Mindee
             @prediction = LicensePlateV1Document.new(prediction['prediction'], nil)
             @pages = []
             prediction['pages'].each do |page|
-              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-                @pages.push(LicensePlateV1Page.new(page))
-              end
+              @pages.push(LicensePlateV1Page.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/eu/license_plate/license_plate_v1_document.rb

@@ -16,10 +16,10 @@ module Mindee
           # @param prediction [Hash]
           # @param page_id [Integer, nil]
           def initialize(prediction, page_id)
-            super()
-            @license_plates = []
+            super
+            @license_plates = [] # : Array[Parsing::Standard::StringField]
             prediction['license_plates'].each do |item|
-              @license_plates.push(StringField.new(item, page_id))
+              @license_plates.push(Parsing::Standard::StringField.new(item, page_id))
             end
           end
 

data/lib/mindee/product/eu/license_plate/license_plate_v1_page.rb

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

data/lib/mindee/product/financial_document/financial_document_v1.rb

@@ -12,6 +12,8 @@ module Mindee
       class FinancialDocumentV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'financial_document'
         @endpoint_version = '1'
+        @has_async = true
+        @has_sync = true
 
         # @param prediction [Hash]
         def initialize(prediction)
@@ -19,9 +21,7 @@ module Mindee
           @prediction = FinancialDocumentV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
-            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(FinancialDocumentV1Page.new(page))
-            end
+            @pages.push(FinancialDocumentV1Page.new(page))
           end
         end
 
@@ -32,6 +32,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