mindee 4.5.0 → 4.7.0.pre.rc1

data/sig/mindee/parsing/common/inference.rbs

@@ -3,16 +3,23 @@ module Mindee
   module Parsing
     module Common
       class Inference
-        def is_rotation_applied: -> untyped
-        def pages: -> Array[Page]
-        def prediction: -> untyped
-        def product: -> untyped
-        def initialize: (untyped) -> void
+        def self.endpoint_name: () -> String?
+        def self.endpoint_version: () -> String?
+        def self.has_async: () -> bool
+        def self.has_sync: () -> bool
+
+        attr_reader endpoint_name: String
+        attr_reader endpoint_version: String
+        attr_reader extras: Extras::Extras
+        attr_reader has_async: bool
+        attr_reader has_sync: bool
+        attr_reader is_rotation_applied: bool
+        attr_reader pages: Array[Page]
+        attr_reader prediction: Prediction
+        attr_reader product: Product
+
+        def initialize: (Hash[String | Symbol, untyped]) -> void
         def to_s: -> String
-        def self.endpoint_name: -> String
-        def self.endpoint_version: -> String
-        def self.has_async: -> bool
-        def self.has_sync: -> bool
       end
     end
   end

data/sig/mindee/parsing/common/job.rbs

@@ -8,8 +8,8 @@ module Mindee
         def available_at: -> Time
         def status: () -> (:waiting | :processing | :completed | :failed)
         def millisecs_taken: -> Integer
-        def error: -> Hash[Symbol | String, untyped]
-        def initialize: (Hash[Symbol | String, untyped]) -> void
+        def error: -> Hash[String | Symbol, untyped]
+        def initialize: (Hash[String | Symbol, untyped]) -> void
       end
     end
   end

data/sig/mindee/parsing/common/ocr/mvision_v1.rbs

@@ -5,9 +5,9 @@ module Mindee
       module OCR
         class MVisionV1
           def pages: -> []
-          def initialize: (untyped) -> untyped
+          def initialize: (Hash[String | Symbol, untyped]) -> void
           def to_s: -> String
-          def reconstruct_vertically: (untyped, untyped, untyped) -> untyped
+          def reconstruct_vertically: (Array[Geometry::Point], Integer, Float) -> OCRLine
         end
       end
     end

data/sig/mindee/parsing/common/ocr/ocr.rbs

@@ -4,34 +4,36 @@ module Mindee
     module Common
       module OCR
         class OCRWord
-          def confidence: -> untyped
-          def confidence=: (untyped) -> untyped
-          def text: -> untyped
-          def bounding_box: -> untyped
-          def polygon: -> untyped
-          def initialize: (untyped) -> void
-          def to_s: -> untyped
+          attr_reader bounding_box: Geometry::Quadrilateral
+          attr_accessor confidence: Float
+          attr_reader polygon: Geometry::Polygon
+          attr_reader text: String
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+          def to_s: -> String
         end
-        class OCRLine < Array[untyped]
-          def initialize: (?Array[untyped]?, ?Array[untyped]?) -> void
+        class OCRLine < Array[OCRWord]
+          def initialize: (?Array[untyped]?, ?Array[OCRWord]?) -> void
           def sort_on_x: -> OCRLine
           def to_s: -> String
         end
         class OCRPage
-          def all_words: -> Array[untyped]
-          def lines: -> Array[untyped]
-          def initialize: (untyped) -> untyped
-          def all_lines: -> Array[untyped]
+          attr_reader all_words: Array[OCRWord]
+          attr_reader lines: Array[OCRLine]
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+          def all_lines: -> Array[OCRLine]
           def to_s: -> String
-          def parse_one: (Array[OCRWord], untyped, Array[untyped], Array[untyped]) -> Array[OCRLine]?
-          def to_lines: -> Array[untyped]
-          def words_on_same_line?: (OCRWord, OCRWord) -> untyped
+          def parse_one: (Array[OCRWord], OCRWord?, Array[Integer], Array[OCRLine]) -> Array[OCRLine]?
+          def to_lines: -> Array[OCRLine]
+          def words_on_same_line?: (OCRWord, OCRWord) -> bool
         end
         class OCR
-          def mvision_v1: -> untyped
-          def initialize: (untyped) -> untyped
-          def to_s: -> untyped
-          def reconstruct_vertically: (untyped, untyped, ?Float) -> untyped
+          attr_reader mvision_v1: MVisionV1
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+          def to_s: -> String
+          def reconstruct_vertically: (Array[Geometry::Point], Integer, ?Float) -> OCRLine
         end
       end
     end

data/sig/mindee/parsing/common/orientation.rbs

@@ -3,9 +3,10 @@ module Mindee
   module Parsing
     module Common
       class Orientation
-        def page_id: -> untyped
-        def value: -> untyped
-        def initialize: (untyped, untyped) -> untyped
+        attr_reader page_id: Integer?
+        attr_reader value: Integer?
+
+        def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
       end
     end
   end

data/sig/mindee/parsing/common/page.rbs

@@ -3,11 +3,12 @@ module Mindee
   module Parsing
     module Common
       class Page
-        def page_id: -> untyped
-        def orientation: -> untyped
-        def prediction: -> untyped
-        def extras: -> untyped
-        def initialize: (untyped) -> void
+        attr_reader extras: Extras::Extras
+        attr_reader orientation: Common::Orientation
+        attr_reader page_id: Integer
+        attr_reader prediction: Common::Prediction
+
+        def initialize: (Hash[String | Symbol, untyped]) -> void
         def to_s: -> String
       end
     end

data/sig/mindee/parsing/common/product.rbs

@@ -3,10 +3,10 @@ module Mindee
   module Parsing
     module Common
       class Product
-        def name: -> untyped
-        def type: -> untyped
-        def version: -> untyped
-        def initialize: (Hash[String, untyped]) -> untyped
+        attr_reader name: String
+        attr_reader type: String?
+        attr_reader version: String
+        def initialize: (Hash[String | Symbol, untyped]) -> void
       end
     end
   end

data/sig/mindee/parsing/common/workflow_response.rbs

@@ -3,10 +3,14 @@ module Mindee
   module Parsing
     module Common
       class WorkflowResponse
-        def execution: -> untyped
-        def api_request: -> untyped
-        def raw_http: -> untyped
-        def initialize: (untyped, untyped, untyped) -> untyped
+        @api_request: ApiRequest
+        @execution: Execution
+        @raw_http: String
+
+        def execution: -> Execution
+        def api_request: -> ApiRequest
+        def raw_http: -> String
+        def initialize: (singleton(Parsing::Common::Inference), Hash[String | Symbol, untyped] | Net::HTTPResponse, String) -> void
       end
     end
   end

data/sig/mindee/parsing/standard/abstract_field.rbs

@@ -8,7 +8,7 @@ module Mindee
         def page_id: -> Integer?
         def confidence: -> Float?
         def confidence=: (Float?) -> Float?
-        def initialize: (Hash[Symbol | String, untyped], Integer?) -> void
+        def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
         def to_s: -> String
         def self.array_confidence: (Array[untyped]) -> Float
         def self.array_sum: (Array[untyped]) -> Float

data/sig/mindee/parsing/standard/address_field.rbs

@@ -0,0 +1,18 @@
+# lib/mindee/parsing/standard/address_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class AddressField < StringField
+        def street_number: -> String
+        def street_name: -> String
+        def po_box: -> String
+        def address_complement: -> String
+        def city: -> String
+        def postal_code: -> String
+        def state: -> String
+        def country: -> String
+        def initialize: (Hash[String | Symbol, untyped], ?Integer?, ?reconstructed: bool) -> void
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/amount_field.rbs

@@ -2,10 +2,12 @@
 module Mindee
   module Parsing
     module Standard
-      class AmountField # failed to identify its superclass
-        def value: -> untyped
-        def initialize: (untyped, untyped, ?reconstructed: false) -> nil
-        def to_s: -> untyped
+      class AmountField < BaseField
+        attr_reader value: Float?
+
+
+        def initialize: (Hash[String | Symbol, untyped], Integer?, ?reconstructed: bool) -> void
+        def to_s: -> String
       end
     end
   end

data/sig/mindee/parsing/standard/base_field.rbs

@@ -3,7 +3,7 @@ module Mindee
   module Parsing
     module Standard
       class BaseField < Parsing::Standard::AbstractField
-        def initialize: (Hash[Symbol | String, untyped], Integer?, ?reconstructed: bool) -> void
+        def initialize: (Hash[String | Symbol, untyped], Integer?, ?reconstructed: bool) -> void
         def value: -> (String | Float | Integer | bool)
         def reconstructed: -> bool
       end

data/sig/mindee/parsing/standard/boolean_field.rbs

@@ -4,7 +4,7 @@ module Mindee
     module Standard
       class BooleanField < BaseField
         def value: -> bool?
-        def initialize: (Hash[Symbol | String, untyped], ?Integer?, ?reconstructed: false) -> void
+        def initialize: (Hash[String | Symbol, untyped], ?Integer?, ?reconstructed: false) -> void
         def to_s: -> String
       end
     end

data/sig/mindee/parsing/standard/company_registration_field.rbs

@@ -3,8 +3,9 @@ module Mindee
   module Parsing
     module Standard
       class CompanyRegistrationField < BaseField
-        def type: -> untyped
-        def initialize: (untyped, untyped, ?reconstructed: false) -> untyped
+        attr_reader type: String
+
+        def initialize: (Hash[String | Symbol, untyped], Integer?, ?reconstructed: false) -> void
         def to_table_line: -> String
         def to_s: -> String
         def printable_values: -> Hash[String, untyped]

data/sig/mindee/parsing/standard/date_field.rbs

@@ -2,12 +2,12 @@
 module Mindee
   module Parsing
     module Standard
-      class DateField # failed to identify its superclass
-        def date_object: -> untyped
-        def value: -> untyped
-        def raw: -> untyped
-        def is_computed: -> untyped
-        def initialize: (untyped, untyped) -> nil
+      class DateField < BaseField
+        def date_object: -> DateTime
+        def value: -> String?
+        def raw: -> String?
+        def is_computed: -> bool
+        def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
       end
     end
   end

data/sig/mindee/parsing/standard/locale_field.rbs

@@ -8,7 +8,7 @@ module Mindee
         def country: -> String?
         def currency: -> String?
         def value: -> String?
-        def initialize: (Hash[Symbol | String, untyped], ?Integer?) -> void
+        def initialize: (Hash[String | Symbol, untyped], ?Integer?) -> void
         def to_s: -> String
       end
     end

data/sig/mindee/parsing/standard/payment_details_field.rbs

@@ -2,12 +2,13 @@
 module Mindee
   module Parsing
     module Standard
-      class PaymentDetailsField # failed to identify its superclass
-        def account_number: -> untyped
-        def iban: -> untyped
-        def routing_number: -> untyped
-        def swift: -> untyped
-        def initialize: (untyped, untyped, ?reconstructed: false) -> untyped
+      class PaymentDetailsField < BaseField
+        attr_reader account_number: String ?
+        attr_reader iban: String?
+        attr_reader routing_number: String?
+        attr_reader swift: String?
+
+        def initialize: (Hash[String | Symbol, untyped], Integer?, ?reconstructed: bool) -> void
         def to_s: -> String
       end
     end

data/sig/mindee/parsing/standard/position_field.rbs

@@ -8,9 +8,9 @@ module Mindee
         def quadrangle: -> Geometry::Quadrilateral
         def rectangle: -> Geometry::Quadrilateral
         def bounding_box: -> Geometry::Quadrilateral
-        def initialize: (Hash[Symbol | String, untyped], Integer?) -> void
+        def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
         def to_s: -> String
-        def to_quadrilateral: (Hash[Symbol | String, Array[untyped]], String) -> Geometry::Quadrilateral?
+        def to_quadrilateral: (Hash[String | Symbol, Array[untyped]], String) -> Geometry::Quadrilateral?
       end
     end
   end

data/sig/mindee/parsing/standard/string_field.rbs

@@ -5,7 +5,7 @@ module Mindee
       class StringField < BaseField
         def value: -> String
         def raw_value: -> String
-        def initialize: (Hash[Symbol | String, untyped], ?Integer?, ?reconstructed: bool) -> void
+        def initialize: (Hash[String | Symbol, untyped], ?Integer?, ?reconstructed: bool) -> void
       end
     end
   end

data/sig/mindee/parsing/standard/tax_field.rbs

@@ -3,18 +3,19 @@ module Mindee
   module Parsing
     module Standard
       class TaxField < BaseField
-        def value: -> untyped
-        def rate: -> untyped
-        def code: -> untyped
-        def base: -> untyped
-        def initialize: (untyped, untyped) -> void
-        def print_float: (untyped) -> String
+        attr_reader base: Float
+        attr_reader code: String
+        attr_reader rate: Float
+        attr_reader value: Float?
+
+        def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
+        def print_float: (Float) -> String
         def to_s: -> String
         def printable_values: -> Hash[untyped, String]
         def to_table_line: -> String
       end
       class Taxes < Array[TaxField]
-        def initialize: (untyped, untyped) -> void
+        def initialize: (Array[untyped], Integer?) -> void
         def line_separator: (String) -> String
         def to_s: -> String
       end

data/sig/mindee/parsing/universal/universal_list_field.rbs

@@ -3,11 +3,10 @@ module Mindee
   module Parsing
     module Universal
       class UniversalListField
-        def page_id: -> Integer?
-        def page_id=: (Integer?) -> untyped
-        def values: -> Array[UniversalObjectField | Standard::StringField]
-        def values=: (Array[UniversalObjectField | Standard::StringField]) -> Array[UniversalObjectField | Standard::StringField]
-        def initialize: (Array[Hash[Symbol | String, untyped]], ?nil) -> untyped
+        attr_reader page_id: Integer
+        attr_reader values: Array[UniversalObjectField | Standard::StringField]
+
+        def initialize: (Array[Hash[String | Symbol, untyped]], ?Integer?) -> void
         def contents_list: -> Array[String]
         def contents_string: (?String) -> String
         def to_s: -> String

data/sig/mindee/parsing/universal/universal_object_field.rbs

@@ -3,21 +3,27 @@ module Mindee
   module Parsing
     module Universal
       class UniversalObjectField
-        def page_id: -> Integer?
-        def page_id=: (Integer?) -> untyped
-        def confidence: -> Float?
-        def confidence=: (Float?) -> untyped
-        def raw_value: -> Hash[Symbol | String, untyped]
-        def raw_value=: (Hash[Symbol | String, untyped]) -> untyped
-        def initialize: (Hash[Symbol | String, untyped], ?Integer?) -> void
+        attr_reader all_values: Hash[String | Symbol, String | Standard::PositionField?]
+        attr_reader confidence: Float
+        attr_reader page_id: Integer
+        attr_reader raw_value: String
+
+        def initialize: (Hash[String | Symbol, untyped], ?Integer?) -> void
         def str_level: (?Integer) -> String
-        def method_missing: (Symbol, *Array[untyped]) -> Object
+        def method_missing: (Symbol, *untyped, untyped)
+          -> (String
+            | Integer
+            | Float
+            | bool
+            | Standard::PositionField
+            | Hash[String | Symbol, untyped]
+           ?)
         def respond_to_missing?: (Symbol, ?bool) -> bool
         def to_s: -> String
-        def handle_position_field: (String | Symbol, untyped, Integer?) -> void
-        def handle_default_field: (String | Symbol, untyped) -> void
+        def handle_position_field: (String | Symbol, Hash[String | Symbol, untyped] | Integer | String | Float | bool?, Integer?) -> void
+        def handle_default_field: (String | Symbol, Hash[String | Symbol, untyped] | Integer | String | Float | bool?) -> void
       end
-      def self.universal_object?: (Hash[Symbol | String, untyped]) -> bool
+      def self.universal_object?: (Hash[String | Symbol, untyped]) -> bool
     end
   end
 end

data/sig/mindee/parsing/v2/common_response.rbs

@@ -0,0 +1,11 @@
+# lib/mindee/parsing/v2/common_response.rb
+module Mindee
+  module Parsing
+    module V2
+      class CommonResponse
+        attr_reader raw_http: Hash[String | Symbol, untyped]
+        def initialize: (Hash[String | Symbol, untyped]) -> void
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/error_response.rbs

@@ -0,0 +1,16 @@
+# lib/mindee/parsing/v2/error_response.rb
+module Mindee
+  module Parsing
+    module V2
+      class ErrorResponse
+        attr_reader detail: String
+        attr_reader status: Integer
+        def initialize: (Hash[String | Symbol, untyped]) -> void
+
+        def as_hash: -> Hash[Symbol, String | Integer]
+
+        def to_s: -> String
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/field/base_field.rbs

@@ -0,0 +1,17 @@
+# lib/mindee/parsing/v2/field/base_field.rb
+module Mindee
+  module Parsing
+    module V2
+      module Field
+        class BaseField
+          attr_reader indent_level: Integer
+          attr_reader confidence: FieldConfidence?
+          attr_reader locations: Array[FieldLocation]
+
+          def initialize: (Hash[String | Symbol, untyped], ?Integer) -> void
+          def self.create_field: (Hash[String | Symbol, untyped], ?Integer) -> (ListField | Field::ObjectField | Field::SimpleField)
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/field/field_confidence.rbs

@@ -0,0 +1,27 @@
+# lib/mindee/parsing/v2/field/field_confidence.rb
+module Mindee
+  module Parsing
+    module V2
+      module Field
+        class FieldConfidence
+          attr_reader value: String
+          CERTAIN: String
+          HIGH: String
+          MEDIUM: String
+          LOW: String
+          VALID_VALUES: Array[String]
+          def initialize: (String) -> void
+          def self.from_string: (String) -> FieldConfidence
+          def certain?: -> bool
+          def high?: -> bool
+          def medium?: -> bool
+          def low?: -> bool
+          def to_s: -> String
+          def ==: (FieldConfidence) -> bool
+          def eql?: (FieldConfidence) -> bool
+          def inspect: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/field/field_location.rbs

@@ -0,0 +1,16 @@
+# lib/mindee/parsing/v2/field/field_location.rb
+module Mindee
+  module Parsing
+    module V2
+      module Field
+        class FieldLocation
+          attr_reader page: Integer?
+          attr_reader polygon: Geometry::Polygon?
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/field/inference_fields.rbs

@@ -0,0 +1,19 @@
+# lib/mindee/parsing/v2/field/inference_fields.rb
+module Mindee
+  module Parsing
+    module V2
+      module Field
+        class InferenceFields < Hash[String, ListField | ObjectField | SimpleField?]
+          attr_reader indent_level: Integer
+
+          def logger: () -> Logger
+          def initialize: (Hash[String | Symbol, untyped], ?Integer) -> void
+          def get: (String) -> (ListField | ObjectField | SimpleField?)
+          def method_missing: (Symbol, *untyped) -> (ListField | ObjectField | SimpleField?)
+          def respond_to_missing?: (Symbol, ?bool) -> bool
+          def to_s: (?Integer) -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/field/list_field.rbs

@@ -0,0 +1,22 @@
+# lib/mindee/parsing/v2/field/list_field.rb
+module Mindee
+  module Parsing
+    module V2
+      module Field
+        class ListField < BaseField
+          include Enumerable[BaseField]
+
+          attr_reader items: Array[BaseField]
+          def initialize: (Hash[String | Symbol, untyped], ?Integer) -> void
+          def to_s: -> String
+          def empty?: -> bool
+          def size: -> Integer
+          def length: -> Integer
+          # NOTE: Steep is incapable of handling typing of `each` when multiple types are used.
+          def each: () { (untyped) -> untyped } -> untyped
+          def []: (Integer) -> (BaseField)
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/field/object_field.rbs

@@ -0,0 +1,21 @@
+# TypeProf 0.30.1
+
+module Mindee
+  module Parsing
+    module V2
+      module Field
+        # A field containing a nested set of inference fields.
+        class ObjectField < BaseField
+          attr_reader fields: InferenceFields
+          def initialize: (Hash[String | Symbol, untyped], ?Integer) -> void
+          def multi_str: -> String
+          def respond_to_missing?: (Symbol, bool) -> bool
+          def single_str: -> String
+          def to_s: -> String
+          def to_s_from_list: -> String
+          def method_missing: (Symbol, *untyped, untyped) -> (ObjectField?)
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/field/simple_field.rbs

@@ -0,0 +1,16 @@
+# lib/mindee/parsing/v2/field/simple_field.rb
+module Mindee
+  module Parsing
+    module V2
+      module Field
+        class SimpleField < BaseField
+          attr_reader value: String | Integer | Float | bool?
+
+          def initialize: (Hash[String | Symbol, untyped], ?Integer) -> void
+          def to_s: -> String
+          def format_numeric_value: (Integer | Float) -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/inference.rbs

@@ -0,0 +1,16 @@
+# lib/mindee/parsing/v2/inference.rb
+module Mindee
+  module Parsing
+    module V2
+      class Inference
+        attr_reader file: InferenceFile
+        attr_reader id: String
+        attr_reader model: InferenceModel
+        attr_reader result: InferenceResult
+
+        def initialize: (Hash[String | Symbol, untyped]) -> void
+        def to_s: -> String
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/inference_file.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/parsing/v2/inference_file.rb
+module Mindee
+  module Parsing
+    module V2
+      class InferenceFile
+        attr_reader name: String
+        attr_reader file_alias: String?
+        attr_reader page_count: Integer
+        attr_reader mime_type: String
+        def initialize: (Hash[String | Symbol, untyped]) -> void
+        def to_s: -> String
+      end
+    end
+  end
+end