mindee 4.12.0 → 5.0.0.beta1

data/lib/mindee.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
-require 'mindee/client'
-require 'mindee/client_v2'
-require 'mindee/page_options'
 require 'mindee/logging'
+require 'mindee/page_options'
+require 'mindee/v1'
+require 'mindee/v2'
 
 module Mindee
+  # Dependency management
+  module Dependency
+  end
+
   # Mindee internal error module.
-  module Errors
+  module Error
   end
 
   # Custom extraction module
@@ -43,25 +47,6 @@ module Mindee
   module Logging
   end
 
-  # Parsing internals and fields.
-  module Parsing
-    # Common fields and functions.
-    module Common
-    end
-
-    # Standard fields and functions.
-    module Standard
-    end
-
-    # Universal fields and functions.
-    module Universal
-    end
-
-    # V2-specific module.
-    module V2
-    end
-  end
-
   # Document input-related internals.
   module Input
   end
@@ -84,6 +69,64 @@ module Mindee
     module US
     end
   end
+
+  # V1-specific module.
+  module V1
+    # HTTP module for V1.
+    module HTTP
+    end
+
+    # Parsing internals and fields.
+    module Parsing
+      # Common fields and functions.
+      module Common
+      end
+
+      # Standard fields and functions.
+      module Standard
+      end
+
+      # Universal fields and functions.
+      module Universal
+      end
+    end
+
+    # V1-specific products.
+    module Product
+      # French products.
+      module FR
+      end
+    end
+  end
+
+  # V2-specific module.
+  module V2
+    # Mindee internal http module.
+    module HTTP
+    end
+
+    # File operations.
+    module FileOperation
+      # Crop operations.
+      module Crop
+      end
+
+      # Split operations.
+      module Split
+      end
+    end
+
+    # Product-specific module.
+    module Product
+    end
+
+    # V2 parsing module.
+    module Parsing
+      # V2 search module.
+      module Search
+      end
+    end
+  end
 end
 
 # Shorthand to call the logger from anywhere.

data/mindee-lite.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mindee/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mindee-lite'
+  spec.version = Mindee::VERSION
+  spec.authors = ['Mindee, SA']
+  spec.email = ['opensource@mindee.co']
+
+  spec.summary = 'Mindee API Helper Library for Ruby (Lite)'
+  spec.description = "Quickly and easily connect to Mindee's API services using Ruby. This lite version omits " \
+                     'heavy image and PDF processing dependencies.'
+  spec.homepage = 'https://github.com/mindee/mindee-api-ruby'
+  spec.license = 'MIT'
+
+  spec.metadata['homepage_uri'] = 'https://mindee.com/'
+  spec.metadata['source_code_uri'] = 'https://github.com/mindee/mindee-api-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|spec|features)/}) }
+  end
+  spec.bindir = 'bin'
+  spec.executables = Dir.children('bin')
+                        .select { |f| File.file?(File.join('bin', f)) }
+                        .reject { |f| f == 'products.rb' }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2')
+
+  spec.add_dependency 'base64', '~> 0.3'
+  spec.add_dependency 'logger', '~> 1.7'
+  spec.add_dependency 'marcel', '~> 1.1'
+end

data/mindee.gemspec

@@ -22,23 +22,23 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|spec|features)/}) }
   end
   spec.bindir = 'bin'
-  spec.executables = Dir['bin/*'].map { |f| File.basename(f) }.reject { |f| f == 'cli_products.rb' }
+  spec.executables = Dir.children('bin')
+                        .select { |f| File.file?(File.join('bin', f)) }
+                        .reject { |f| f == 'products.rb' }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2')
 
-  spec.add_dependency 'base64', '~> 0.1'
-  spec.add_dependency 'marcel', '~> 1.0'
+  spec.add_dependency 'base64', '~> 0.3'
+  spec.add_dependency 'logger', '~> 1.7'
+  spec.add_dependency 'marcel', '~> 1.1'
   spec.add_dependency 'mini_magick', '>= 4', '< 6'
   spec.add_dependency 'origamindee', '~> 4.0'
-  spec.add_dependency 'pdf-reader', '~> 2.14'
-
-  spec.add_development_dependency 'openssl', '~> 3.3.2'
-  spec.add_development_dependency 'prism', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 13.2'
-  spec.add_development_dependency 'rbs', '~> 3.6'
-  spec.add_development_dependency 'rspec', '~> 3.13'
-  spec.add_development_dependency 'rubocop', '~> 1.76.0'
-  spec.add_development_dependency 'steep', '~> 1.7'
+  spec.add_dependency 'pdf-reader', '~> 2.15'
+
+  spec.add_development_dependency 'bundle-audit', '~> 0.2.0'
+  spec.add_development_dependency 'rbs', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.86'
+  spec.add_development_dependency 'steep', '~> 1.10'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

data/sig/custom/marcel.rbs

@@ -1,3 +1,3 @@
 module Marcel
   MimeType: untyped
-end
+end

data/sig/custom/net_http.rbs

@@ -40,4 +40,4 @@ module Net
     def body: -> untyped
     def code: -> String?
   end
-end
+end

data/sig/custom/origami.rbs

@@ -56,4 +56,4 @@ module Origami
     def data= : (String | StringIO) -> void
     def dictionary : -> Hash[Symbol, untyped]
   end
-end
+end

data/sig/mindee/dependency.rbs

@@ -0,0 +1,13 @@
+module Mindee
+  module Dependency
+    MINDEE_DEPENDENCIES_LOAD_ERROR: String
+
+    self.@all_deps_available: bool
+
+    def self.check_all_dependencies: -> bool
+
+    def self.all_deps_available?: -> bool
+    def self.require_all_deps!: -> void
+
+  end
+end

data/sig/mindee/error/mindee_error.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/error/mindee_error.rb
+module Mindee
+  module Error
+    class MindeeError < StandardError
+    end
+    class MindeeAPIError < MindeeError
+    end
+    class MindeeConfigurationError < MindeeError
+    end
+    class MindeeGeometryError < MindeeError
+    end
+  end
+end

data/sig/mindee/error/mindee_http_error.rbs

@@ -0,0 +1,17 @@
+# lib/mindee/error/mindee_http_error.rb
+module Mindee
+  module Error
+    class MindeeHTTPError < Error::MindeeError
+      attr_reader api_code: Integer
+      attr_reader api_details: String
+      attr_reader api_message: String
+      attr_reader status_code: Integer
+
+      def initialize: (Hash[String | Symbol, untyped], String, Integer) -> void
+    end
+    class MindeeHTTPClientError < MindeeHTTPError
+    end
+    class MindeeHTTPServerError < MindeeHTTPError
+    end
+  end
+end

data/sig/mindee/error/mindee_http_error_v2.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/error/mindee_http_error_v2.rb
+module Mindee
+  module Error
+    # API V2 HttpError
+    class MindeeHTTPErrorV2 < MindeeError
+      attr_reader detail: String
+      attr_reader status: Integer
+      attr_reader code: String
+      attr_reader title: String
+      attr_reader errors: Array[V2::Parsing::ErrorItem]
+
+      def initialize: (Hash[String, untyped] | Mindee::V2::Parsing::ErrorResponse) -> void
+    end
+  end
+end

data/sig/mindee/error/mindee_http_unknown_error_v2.rbs

@@ -0,0 +1,9 @@
+# lib/mindee/error/mindee_http_unknown_error_v2.rb
+module Mindee
+  module Error
+    # Unknown HTTP error for the V2 API.
+    class MindeeHTTPUnknownErrorV2 < MindeeHTTPErrorV2
+      def initialize: (Hash[String|Symbol, untyped]) -> void
+    end
+  end
+end

data/sig/mindee/error/mindee_input_error.rbs

@@ -0,0 +1,18 @@
+# lib/mindee/error/mindee_input_error.rb
+module Mindee
+  module Error
+    class MindeeInputError < MindeeError
+    end
+    class MindeeSourceError < MindeeInputError
+    end
+    class MindeeMimeTypeError < MindeeSourceError
+      attr_reader invalid_mimetype: String
+
+      def initialize: (String) -> void
+    end
+    class MindeeImageError < MindeeInputError
+    end
+    class MindeePDFError < MindeeInputError
+    end
+  end
+end

data/sig/mindee/geometry/point.rbs

@@ -7,6 +7,8 @@ module Mindee
 
       def initialize: (Float, Float) -> void
       def []: (Integer) -> Float
+
+      def to_s: -> String
     end
   end
 end

data/sig/mindee/geometry/polygon.rbs

@@ -5,6 +5,8 @@ module Mindee
       def initialize: (Array[::Mindee::Geometry::Point | Array[Float]]) -> void
       def centroid: -> Point
       def point_in_y?: (Point) -> bool
+
+      def to_s: -> String
     end
   end
 end

data/sig/mindee/http/http_error_handler.rbs

@@ -4,11 +4,11 @@ module Mindee
     module ErrorHandler
       def extract_error: (Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]?
       def create_error_obj: (Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
-      def self.generate_v2_error: (Hash[String, Integer | String]) -> Errors::MindeeHTTPErrorV2
-      def generate_v2_error: (Hash[Symbol, String | Integer]) -> Errors::MindeeHTTPErrorV2
+      def self.generate_v2_error: (Hash[String, Integer | String]) -> Error::MindeeHTTPErrorV2
+      def generate_v2_error: (Hash[Symbol, String | Integer]) -> Error::MindeeHTTPErrorV2
 
-      def self.handle_error: (String, Net::HTTPResponse) -> Errors::MindeeHTTPError
-      def handle_error:      (String, Net::HTTPResponse) -> Errors::MindeeHTTPError
+      def self.handle_error: (String, Net::HTTPResponse) -> Error::MindeeHTTPError
+      def handle_error:      (String, Net::HTTPResponse) -> Error::MindeeHTTPError
       def handle_v2_error: (Hash[String | Symbol, untyped]) -> void
     end
   end

data/sig/mindee/image/extracted_image.rbs

@@ -6,10 +6,16 @@ module Mindee
       def page_id: -> Integer
       def element_id: -> Integer
       def buffer: -> StringIO
-      def internal_file_name: -> String
-      def initialize: (Input::Source::LocalInputSource, Integer, Integer) -> Integer
+      def filename: -> String
+      def initialize: (
+        Input::Source::LocalInputSource | Input::Source::BytesInputSource,
+        Integer,
+        Integer?,
+        ?preserve_input_filename: bool
+      ) -> Integer
       def write_to_file: (String, ?String?) -> void
       def as_source: -> Input::Source::BytesInputSource
+      def as_input_source: -> Input::Source::BytesInputSource
     end
   end
 end

data/sig/mindee/image/image_extractor.rbs

@@ -6,7 +6,7 @@ module Mindee
       def self.to_blob: () -> String
       def self.extract_multiple_images_from_source: (Input::Source::LocalInputSource, Integer, Array[Array[Geometry::Point] |Geometry::Polygon | Geometry::Quadrilateral]) -> Array[ExtractedImage]
       def self.extract_images_from_polygons: (Input::Source::LocalInputSource, StringIO | File, Integer, Array[Array[Geometry::Point] | Geometry::Polygon | Geometry::Quadrilateral]) -> Array[ExtractedImage]
-      def self.create_extracted_image: (StringIO | File, String, Integer, Integer) -> void
+      def self.create_extracted_image: (StringIO | File, String, Integer, Integer) -> ExtractedImage
       def self.load_input_source_pdf_page_as_stringio: (Input::Source::LocalInputSource, Integer) -> (StringIO | File)
     end
   end

data/sig/mindee/input/base_parameters.rbs

@@ -0,0 +1,35 @@
+# lib/mindee/input/base_parameters.rb
+
+module Mindee
+  module Input
+    class BaseParameters
+      attr_reader self.slug: String
+
+      def self.from_hash: (params: Hash[String | Symbol, untyped]) -> instance
+      def self.load_from_hash: (params: Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
+
+      def slug: -> String
+
+      attr_reader model_id: String
+      attr_reader file_alias: String?
+      attr_reader webhook_ids: Array[String]?
+      attr_reader polling_options: PollingOptions
+      attr_reader close_file: bool
+
+      def initialize: (
+          String,
+          ?file_alias: String?,
+          ?webhook_ids: Array[String]?,
+          ?polling_options: Hash[Symbol | String, untyped] | PollingOptions?,
+          ?close_file: bool?
+        ) -> void
+
+      def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
+      def validate_async_params: () -> void
+
+      private
+
+      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions?) -> PollingOptions
+    end
+  end
+end

data/sig/mindee/input/local_response.rbs

@@ -2,13 +2,13 @@
 module Mindee
   module Input
     class LocalResponse
-      def file: -> StringIO
+      attr_reader file: StringIO
       def initialize: (File | IO | StringIO | String | Pathname | Tempfile) -> void
       def as_hash: -> Hash[String | Symbol, untyped]
       def self.process_secret_key: (String) -> String
       def get_hmac_signature: (String) -> String
       def valid_hmac_signature?: (String, String) -> bool
-      def deserialize_response: (singleton(Parsing::V2::CommonResponse))-> (Parsing::V2::JobResponse | Parsing::V2::InferenceResponse)
+      def deserialize_response: (singleton(V2::Parsing::CommonResponse))-> (V2::Parsing::CommonResponse)
     end
   end
 end

data/sig/mindee/input/sources/local_input_source.rbs

@@ -20,7 +20,6 @@ module Mindee
         def process_pdf: (PageOptions) -> StringIO?
         def read_contents: (?close: bool) -> [String?, Hash[:filename, String]]
         def page_count: -> Integer
-        def count_pages: -> Integer
         def write_to_file: (String?) -> void
         def compress!: (?quality: Integer, ?max_width: Integer?, ?max_height: Integer?, ?force_source_text: bool, ?disable_source_text: bool) -> Integer
         def source_text?: -> bool?

data/sig/mindee/pdf/extracted_pdf.rbs

@@ -1,15 +1,17 @@
 # lib/mindee/pdf/extracted_pdf.rb
 module Mindee
   module PDF
-    module PDFExtractor
-      class ExtractedPDF
-        attr_reader pdf_bytes: StringIO
-        attr_reader filename: String
-        def initialize: (StringIO, String) -> void
-        def page_count: -> Integer
-        def write_to_file: (String, ?override: bool) -> Integer
-        def as_input_source: -> Input::Source::BytesInputSource
-      end
+    class ExtractedPDF
+      attr_reader pdf_bytes: StringIO
+      attr_reader filename: String
+
+      def initialize: (StringIO | File, String) -> void
+
+      def page_count: -> Integer
+
+      def write_to_file: (String, ?override: bool) -> void
+
+      def as_input_source: -> Input::Source::BytesInputSource
     end
   end
 end

data/sig/mindee/pdf/pdf_extractor.rbs

@@ -1,17 +1,19 @@
 # lib/mindee/pdf/pdf_extractor.rb
 module Mindee
   module PDF
-    module PDFExtractor
-      class PDFExtractor
-        attr_reader filename: String
-        attr_reader source_pdf: StringIO
+    class PDFExtractor
+      attr_reader filename: String
+      attr_reader source_pdf: StringIO
 
-        def initialize: (Input::Source::LocalInputSource) -> void
-        def page_count: -> Integer
-        def cut_pages: (Array[Integer]) -> StringIO
-        def extract_sub_documents: (Array[Array[Integer]]) -> Array[ExtractedPDF]
-        def extract_invoices: (Array[Product::InvoiceSplitter::InvoiceSplitterV1InvoicePageGroup] | Array [Array[Integer]], ?strict: bool) -> Array[ExtractedPDF]
-      end
+      def initialize: (Input::Source::LocalInputSource) -> void
+
+      def page_count: -> Integer
+
+      def cut_pages: (Array[Integer]) -> StringIO
+
+      def extract_sub_documents: (Array[Array[Integer]]) -> Array[ExtractedPDF]
+
+      def extract_invoices: (Array[V1::Product::InvoiceSplitter::InvoiceSplitterV1InvoicePageGroup] | Array[Array[Integer]], ?strict: bool) -> Array[ExtractedPDF]
     end
   end
 end

data/sig/mindee/pdf/pdf_tools.rbs

@@ -8,6 +8,8 @@ module Mindee
       Height: Integer | Float
       Width: Integer | Float
 
+      def self.pdf_header?: (StringIO | File) -> bool
+
       def to_io_stream: (?Hash[Symbol, untyped]) -> StringIO
       def intents_as_pdfa1: () -> void
       def delinearize!: () -> void

data/sig/mindee/v1/client.rbs

@@ -0,0 +1,84 @@
+# lib/v1/mindee/client.rb
+
+module Mindee
+  module V1
+    OTS_OWNER: String
+
+    class ParseOptions
+      attr_accessor all_words: bool
+      attr_accessor full_text: bool
+      attr_accessor close_file: bool
+      attr_accessor page_options: PageOptions
+      attr_accessor cropper: bool
+      attr_accessor rag: bool
+      attr_accessor workflow_id: String?
+      attr_accessor initial_delay_sec: Integer | Float
+      attr_accessor delay_sec: Integer | Float
+      attr_accessor max_retries: Integer
+
+      def initialize: (params: Hash[String | Symbol, untyped]) -> void
+    end
+
+    class WorkflowOptions
+      attr_accessor document_alias: (String?)
+      attr_accessor priority: (Symbol?)
+      attr_accessor full_text: bool
+      attr_accessor rag: bool?
+      attr_accessor public_url: (String?)
+      attr_accessor page_options: (PageOptions)
+      attr_accessor close_file: bool
+
+      def initialize: (params: Hash[String | Symbol, untyped]) -> void
+    end
+
+    class Client
+      @api_key: String?
+
+      def initialize: (?api_key: String) -> void
+
+      def logger: () -> Logging
+
+      def parse: (Input::Source::LocalInputSource | Input::Source::URLInputSource, singleton(V1::Parsing::Common::Inference), ?endpoint: (V1::HTTP::Endpoint?), options: ParseOptions | Hash[String | Symbol, untyped]) -> V1::Parsing::Common::ApiResponse
+
+      def parse_sync: (Input::Source::LocalInputSource | Input::Source::URLInputSource, singleton(V1::Parsing::Common::Inference), V1::HTTP::Endpoint, ParseOptions) -> V1::Parsing::Common::ApiResponse
+
+      def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, singleton(V1::Parsing::Common::Inference), ?endpoint: (V1::HTTP::Endpoint?), options: ParseOptions | Hash[String | Symbol, untyped]) -> V1::Parsing::Common::ApiResponse
+
+      def parse_queued: (String, singleton(V1::Parsing::Common::Inference), ?endpoint: V1::HTTP::Endpoint?) -> V1::Parsing::Common::ApiResponse
+
+      def enqueue_and_parse: (Input::Source::URLInputSource | Input::Source::LocalInputSource, singleton(V1::Parsing::Common::Inference), V1::HTTP::Endpoint, ParseOptions) -> V1::Parsing::Common::ApiResponse
+
+      def execute_workflow: (Input::Source::URLInputSource | Input::Source::LocalInputSource, String, options: (Hash[String | Symbol, untyped] | WorkflowOptions)) -> V1::Parsing::Common::WorkflowResponse
+
+      def load_prediction: (singleton(V1::Parsing::Common::Inference), Input::LocalResponse) -> V1::Parsing::Common::ApiResponse
+
+      def source_from_path: (String, ?repair_pdf: bool) -> Input::Source::PathInputSource
+
+      def source_from_bytes: (String, String, ?repair_pdf: bool) -> Input::Source::BytesInputSource
+
+      def source_from_b64string: (String, String, ?repair_pdf: bool) -> Input::Source::Base64InputSource
+
+      def source_from_file: (File, String, ?repair_pdf: bool) -> Input::Source::FileInputSource
+
+      def source_from_url: (String) -> Input::Source::URLInputSource
+
+      def create_endpoint: (endpoint_name: String, account_name: String, version: String) -> V1::HTTP::Endpoint
+
+      private
+
+      def normalize_parse_options: ((Hash[String | Symbol, untyped] | ParseOptions)) -> ParseOptions
+
+      def process_pdf_if_required: (Input::Source::LocalInputSource, ParseOptions | WorkflowOptions) -> void
+
+      def initialize_endpoint: (singleton(V1::Parsing::Common::Inference), ?endpoint_name: String, ?account_name: String, ?version: String) -> V1::HTTP::Endpoint
+
+      def validate_async_params: (Integer | Float, Integer | Float, Integer) -> void
+
+      def fix_endpoint_name: (singleton(V1::Parsing::Common::Inference), String?) -> String
+
+      def fix_account_name: (String) -> String
+
+      def fix_version: (singleton(V1::Parsing::Common::Inference), String) -> String
+    end
+  end
+end

data/sig/mindee/v1/extraction/multi_receipts_extractor.rbs

@@ -0,0 +1,8 @@
+# lib/mindee/v1/extraction/multi_receipts_extractor.rb
+module Mindee
+  module V1
+    module Extraction
+      def self.extract_receipts: (Input::Source::LocalInputSource, Product::MultiReceiptsDetector::MultiReceiptsDetectorV1) -> Array[Image::ExtractedImage]
+    end
+  end
+end

data/sig/mindee/v1/http/endpoint.rbs

@@ -0,0 +1,41 @@
+# lib/mindee/v1/http/endpoint.rb
+module Mindee
+  module V1
+    module HTTP
+      API_KEY_ENV_NAME: String
+      API_KEY_DEFAULT: String?
+      BASE_URL_ENV_NAME: String
+      BASE_URL_DEFAULT: String
+      REQUEST_TIMEOUT_ENV_NAME: String
+      TIMEOUT_DEFAULT: Integer
+      USER_AGENT: String
+
+      class Endpoint
+        attr_reader api_key: String
+        attr_reader base_url: String
+        attr_reader request_timeout: Integer
+        attr_reader url_root: String
+
+        def logger: () -> Logger
+
+        def initialize: (String, String, String?, ?api_key: String) -> String
+
+        def predict: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Hash[String | Symbol, untyped], String]
+
+        def predict_async: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Hash[String | Symbol, untyped], String]
+
+        def parse_async: (String) -> [Hash[String | Symbol, untyped], String]
+
+        def predict_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> Net::HTTPResponse
+
+        def document_queue_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> Net::HTTPResponse
+
+        def document_queue_req_get: (String) -> Net::HTTPResponse
+
+        def check_api_key: -> void
+
+        def configure_ssl: (Net::HTTP) -> void
+      end
+    end
+  end
+end

data/sig/mindee/v1/http/workflow_endpoint.rbs

@@ -0,0 +1,22 @@
+# lib/mindee/v1/http/workflow_endpoint.rb
+module Mindee
+  module V1
+    module HTTP
+      class WorkflowEndpoint
+        def api_key: -> String
+
+        def request_timeout: -> Integer
+
+        def url: -> String
+
+        def initialize: (untyped, ?api_key: String) -> String
+
+        def execute_workflow: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> [Hash[String, untyped], String]
+
+        def workflow_execution_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> Net::HTTPResponse?
+
+        def check_api_key: -> nil
+      end
+    end
+  end
+end