mindee 3.15.0 → 3.17.0

data/lib/mindee/parsing/common/execution.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Mindee
+  module Parsing
+    module Common
+      # Identifier for the batch to which the execution belongs.
+      class Execution
+        # Identifier for the batch to which the execution belongs.
+        # @return [String]
+        attr_reader :batch_name
+        # The time at which the execution started.
+        # @return [Time, nil]
+        attr_reader :created_at
+        # File representation within a workflow execution.
+        # @return [ExecutionFile]
+        attr_reader :file
+        # Identifier for the execution.
+        # @return [String]
+        attr_reader :id
+        # Deserialized inference object.
+        # @return [Mindee::Inference]
+        attr_reader :inference
+        # Priority of the execution.
+        # @return [ExecutionPriority]
+        attr_reader :priority
+        # The time at which the file was tagged as reviewed.
+        # @return [Time, nil]
+        attr_reader :reviewed_at
+        # The time at which the file was uploaded to a workflow.
+        # @return [Time, nil]
+        attr_reader :available_at
+        # Reviewed fields and values.
+        # @return [Mindee::Product::Generated::GeneratedV1Document]
+        attr_reader :reviewed_prediction
+        # Execution Status.
+        # @return [String]
+        attr_reader :status
+        # Execution type.
+        # @return [String]
+        attr_reader :type
+        # The time at which the file was uploaded to a workflow.
+        # @return [Time, nil]
+        attr_reader :uploaded_at
+        # Identifier for the workflow.
+        # @return [String]
+        attr_reader :workflow_id
+
+        # rubocop:disable Metrics/CyclomaticComplexity
+
+        # @param product_class [Mindee::Inference]
+        # @param http_response [Hash]
+        def initialize(product_class, http_response)
+          @batch_name = http_response['batch_name']
+          @created_at = Time.iso8601(http_response['created_at']) if http_response['created_at']
+          @file = ExecutionFile.new(http_response['file']) if http_response['file']
+          @id = http_response['id']
+          @inference = product_class.new(http_response['inference']) if http_response['inference']
+          @priority = Mindee::Parsing::Common::ExecutionPriority.to_priority(http_response['priority'])
+          @reviewed_at = Time.iso8601(http_response['reviewed_at']) if http_response['reviewed_at']
+          @available_at = Time.iso8601(http_response['available_at']) if http_response['available_at']
+          if http_response['reviewed_prediction']
+            @reviewed_prediction = GeneratedV1Document.new(http_response['reviewed_prediction'])
+          end
+          @status = http_response['status']
+          @type = http_response['type']
+          @uploaded_at = Time.iso8601(http_response['uploaded_at']) if http_response['uploaded_at']
+          @workflow_id = http_response['workflow_id']
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+      end
+    end
+  end
+end

data/lib/mindee/parsing/common/execution_file.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mindee
+  module Parsing
+    module Common
+      # Representation of a workflow execution's file data.
+      class ExecutionFile
+        # File name.
+        # @return [String]
+        attr_reader :name
+
+        # Optional alias for the file.
+        # @return [String]
+        attr_reader :alias
+
+        # @param http_response [Hash]
+        def initialize(http_response)
+          @name = http_response['name']
+          @alias = http_response['alias']
+        end
+      end
+    end
+  end
+end

data/lib/mindee/parsing/common/execution_priority.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mindee
+  module Parsing
+    module Common
+      # Execution policy priority values.
+      module ExecutionPriority
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+
+        # Sets the priority to one of its possibly values, defaults to nil otherwise.
+        # @param [String, nil] priority_str
+        # @return [Symbol, nil]
+        def self.to_priority(priority_str)
+          return nil if priority_str.nil?
+
+          case priority_str.downcase
+          when 'low'
+            :low
+          when 'high'
+            :high
+          else
+            :medium
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/parsing/common.rb

@@ -2,6 +2,9 @@
 
 require_relative 'common/api_response'
 require_relative 'common/document'
+require_relative 'common/execution'
+require_relative 'common/execution_file'
+require_relative 'common/execution_priority'
 require_relative 'common/inference'
 require_relative 'common/ocr'
 require_relative 'common/prediction'

data/lib/mindee/product/{international_id/international_id_v1.rb → business_card/business_card_v1.rb}

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'international_id_v1_document'
-require_relative 'international_id_v1_page'
+require_relative 'business_card_v1_document'
+require_relative 'business_card_v1_page'
 
 module Mindee
   module Product
-    # International ID module.
-    module InternationalId
-      # International ID V1 prediction inference.
-      class InternationalIdV1 < Mindee::Parsing::Common::Inference
-        @endpoint_name = 'international_id'
+    # Business Card module.
+    module BusinessCard
+      # Business Card API version 1 inference prediction.
+      class BusinessCardV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'business_card'
         @endpoint_version = '1'
 
         # @param prediction [Hash]
         def initialize(prediction)
           super
-          @prediction = InternationalIdV1Document.new(prediction['prediction'], nil)
+          @prediction = BusinessCardV1Document.new(prediction['prediction'], nil)
           @pages = []
           prediction['pages'].each do |page|
             if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
-              @pages.push(InternationalIdV1Page.new(page))
+              @pages.push(BusinessCardV1Page.new(page))
             end
           end
         end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module BusinessCard
+      # Business Card API version 1.0 document data.
+      class BusinessCardV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The address of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :address
+        # The company the person works for.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :company
+        # The email address of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :email
+        # The Fax number of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :fax_number
+        # The given name of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :firstname
+        # The job title of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :job_title
+        # The lastname of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :lastname
+        # The mobile number of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mobile_number
+        # The phone number of the person.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :phone_number
+        # The social media profiles of the person or company.
+        # @return [Array<Mindee::Parsing::Standard::StringField>]
+        attr_reader :social_media
+        # The website of the person or company.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :website
+
+        # @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 = []
+          prediction['social_media'].each do |item|
+            @social_media.push(StringField.new(item, page_id))
+          end
+          @website = StringField.new(prediction['website'], page_id)
+        end
+
+        # @return [String]
+        def to_s
+          social_media = @social_media.join("\n #{' ' * 14}")
+          out_str = String.new
+          out_str << "\n:Firstname: #{@firstname}".rstrip
+          out_str << "\n:Lastname: #{@lastname}".rstrip
+          out_str << "\n:Job Title: #{@job_title}".rstrip
+          out_str << "\n:Company: #{@company}".rstrip
+          out_str << "\n:Email: #{@email}".rstrip
+          out_str << "\n:Phone Number: #{@phone_number}".rstrip
+          out_str << "\n:Mobile Number: #{@mobile_number}".rstrip
+          out_str << "\n:Fax Number: #{@fax_number}".rstrip
+          out_str << "\n:Address: #{@address}".rstrip
+          out_str << "\n:Website: #{@website}".rstrip
+          out_str << "\n:Social Media: #{social_media}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindee/product/{international_id/international_id_v1_page.rb → business_card/business_card_v1_page.rb}

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 require_relative '../../parsing'
-require_relative 'international_id_v1_document'
+require_relative 'business_card_v1_document'
 
 module Mindee
   module Product
-    module InternationalId
-      # International ID V1 page.
-      class InternationalIdV1Page < Mindee::Parsing::Common::Page
+    module BusinessCard
+      # Business Card API version 1.0 page data.
+      class BusinessCardV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)
           super(prediction)
-          @prediction = InternationalIdV1PagePrediction.new(
+          @prediction = BusinessCardV1PagePrediction.new(
             prediction['prediction'],
             prediction['id']
           )
         end
       end
 
-      # International ID V1 page prediction.
-      class InternationalIdV1PagePrediction < InternationalIdV1Document
+      # Business Card V1 page prediction.
+      class BusinessCardV1PagePrediction < BusinessCardV1Document
         # @return [String]
         def to_s
           out_str = String.new

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'delivery_note_v1_document'
+require_relative 'delivery_note_v1_page'
+
+module Mindee
+  module Product
+    # Delivery note module.
+    module DeliveryNote
+      # Delivery note API version 1 inference prediction.
+      class DeliveryNoteV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'delivery_notes'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @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
+          end
+        end
+
+        class << self
+          # Name of the endpoint for this product.
+          # @return [String]
+          attr_reader :endpoint_name
+          # Version for this product.
+          # @return [String]
+          attr_reader :endpoint_version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module DeliveryNote
+      # Delivery note API version 1.1 document data.
+      class DeliveryNoteV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The address of the customer receiving the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_address
+        # The name of the customer receiving the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_name
+        # The date on which the delivery is scheduled to arrive.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :delivery_date
+        # A unique identifier for the delivery note.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :delivery_number
+        # The address of the supplier providing the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_address
+        # The name of the supplier providing the goods.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_name
+        # The total monetary value of the goods being delivered.
+        # @return [Mindee::Parsing::Standard::AmountField]
+        attr_reader :total_amount
+
+        # @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)
+        end
+
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n:Delivery Date: #{@delivery_date}".rstrip
+          out_str << "\n:Delivery Number: #{@delivery_number}".rstrip
+          out_str << "\n:Supplier Name: #{@supplier_name}".rstrip
+          out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
+          out_str << "\n:Customer Name: #{@customer_name}".rstrip
+          out_str << "\n:Customer Address: #{@customer_address}".rstrip
+          out_str << "\n:Total Amount: #{@total_amount}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'delivery_note_v1_document'
+
+module Mindee
+  module Product
+    module DeliveryNote
+      # Delivery note API version 1.1 page data.
+      class DeliveryNoteV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = DeliveryNoteV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Delivery note V1 page prediction.
+      class DeliveryNoteV1PagePrediction < DeliveryNoteV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'driver_license_v1_document'
+require_relative 'driver_license_v1_page'
+
+module Mindee
+  module Product
+    # Driver License module.
+    module DriverLicense
+      # Driver License API version 1 inference prediction.
+      class DriverLicenseV1 < Mindee::Parsing::Common::Inference
+        @endpoint_name = 'driver_license'
+        @endpoint_version = '1'
+
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super
+          @prediction = DriverLicenseV1Document.new(prediction['prediction'], nil)
+          @pages = []
+          prediction['pages'].each do |page|
+            if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+              @pages.push(DriverLicenseV1Page.new(page))
+            end
+          end
+        end
+
+        class << self
+          # Name of the endpoint for this product.
+          # @return [String]
+          attr_reader :endpoint_name
+          # Version for this product.
+          # @return [String]
+          attr_reader :endpoint_version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+
+module Mindee
+  module Product
+    module DriverLicense
+      # Driver License API version 1.0 document data.
+      class DriverLicenseV1Document < Mindee::Parsing::Common::Prediction
+        include Mindee::Parsing::Standard
+        # The category or class of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :category
+        # The alpha-3 ISO 3166 code of the country where the driver license was issued.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :country_code
+        # The date of birth of the driver license holder.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :date_of_birth
+        # The DD number of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :dd_number
+        # The expiry date of the driver license.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :expiry_date
+        # The first name of the driver license holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :first_name
+        # The unique identifier of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :id
+        # The date when the driver license was issued.
+        # @return [Mindee::Parsing::Standard::DateField]
+        attr_reader :issued_date
+        # The authority that issued the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :issuing_authority
+        # The last name of the driver license holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :last_name
+        # The Machine Readable Zone (MRZ) of the driver license.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :mrz
+        # The place of birth of the driver license holder.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :place_of_birth
+        # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :state
+
+        # @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)
+        end
+
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n:Country Code: #{@country_code}".rstrip
+          out_str << "\n:State: #{@state}".rstrip
+          out_str << "\n:ID: #{@id}".rstrip
+          out_str << "\n:Category: #{@category}".rstrip
+          out_str << "\n:Last Name: #{@last_name}".rstrip
+          out_str << "\n:First Name: #{@first_name}".rstrip
+          out_str << "\n:Date of Birth: #{@date_of_birth}".rstrip
+          out_str << "\n:Place of Birth: #{@place_of_birth}".rstrip
+          out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
+          out_str << "\n:Issued Date: #{@issued_date}".rstrip
+          out_str << "\n:Issuing Authority: #{@issuing_authority}".rstrip
+          out_str << "\n:MRZ: #{@mrz}".rstrip
+          out_str << "\n:DD Number: #{@dd_number}".rstrip
+          out_str[1..].to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing'
+require_relative 'driver_license_v1_document'
+
+module Mindee
+  module Product
+    module DriverLicense
+      # Driver License API version 1.0 page data.
+      class DriverLicenseV1Page < Mindee::Parsing::Common::Page
+        # @param prediction [Hash]
+        def initialize(prediction)
+          super(prediction)
+          @prediction = DriverLicenseV1PagePrediction.new(
+            prediction['prediction'],
+            prediction['id']
+          )
+        end
+      end
+
+      # Driver License V1 page prediction.
+      class DriverLicenseV1PagePrediction < DriverLicenseV1Document
+        # @return [String]
+        def to_s
+          out_str = String.new
+          out_str << "\n#{super}"
+          out_str
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_line_item'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.10 document data.
+      # Financial Document API version 1.11 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
         # The customer's address used for billing.

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

@@ -6,7 +6,7 @@ require_relative 'financial_document_v1_document'
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document API version 1.10 page data.
+      # Financial Document API version 1.11 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

data/lib/mindee/product/fr/health_card/health_card_v1.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing'
+require_relative 'health_card_v1_document'
+require_relative 'health_card_v1_page'
+
+module Mindee
+  module Product
+    module FR
+      # Health Card module.
+      module HealthCard
+        # Health Card API version 1 inference prediction.
+        class HealthCardV1 < Mindee::Parsing::Common::Inference
+          @endpoint_name = 'french_healthcard'
+          @endpoint_version = '1'
+
+          # @param prediction [Hash]
+          def initialize(prediction)
+            super
+            @prediction = HealthCardV1Document.new(prediction['prediction'], nil)
+            @pages = []
+            prediction['pages'].each do |page|
+              if page.key?('prediction') && !page['prediction'].nil? && !page['prediction'].empty?
+                @pages.push(HealthCardV1Page.new(page))
+              end
+            end
+          end
+
+          class << self
+            # Name of the endpoint for this product.
+            # @return [String]
+            attr_reader :endpoint_name
+            # Version for this product.
+            # @return [String]
+            attr_reader :endpoint_version
+          end
+        end
+      end
+    end
+  end
+end