stagehand 0.0.3 → 3.5.2

data/sig/stagehand/models/session_execute_params.rbs

@@ -0,0 +1,193 @@
+module Stagehand
+  module Models
+    type session_execute_params =
+      {
+        agent_config: Stagehand::SessionExecuteParams::AgentConfig,
+        execute_options: Stagehand::SessionExecuteParams::ExecuteOptions,
+        frame_id: String?,
+        should_cache: bool,
+        x_stream_response: Stagehand::Models::SessionExecuteParams::x_stream_response
+      }
+      & Stagehand::Internal::Type::request_parameters
+
+    class SessionExecuteParams < Stagehand::Internal::Type::BaseModel
+      extend Stagehand::Internal::Type::RequestParameters::Converter
+      include Stagehand::Internal::Type::RequestParameters
+
+      attr_accessor agent_config: Stagehand::SessionExecuteParams::AgentConfig
+
+      attr_accessor execute_options: Stagehand::SessionExecuteParams::ExecuteOptions
+
+      attr_accessor frame_id: String?
+
+      attr_reader should_cache: bool?
+
+      def should_cache=: (bool) -> bool
+
+      attr_reader x_stream_response: Stagehand::Models::SessionExecuteParams::x_stream_response?
+
+      def x_stream_response=: (
+        Stagehand::Models::SessionExecuteParams::x_stream_response
+      ) -> Stagehand::Models::SessionExecuteParams::x_stream_response
+
+      def initialize: (
+        agent_config: Stagehand::SessionExecuteParams::AgentConfig,
+        execute_options: Stagehand::SessionExecuteParams::ExecuteOptions,
+        ?frame_id: String?,
+        ?should_cache: bool,
+        ?x_stream_response: Stagehand::Models::SessionExecuteParams::x_stream_response,
+        ?request_options: Stagehand::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        agent_config: Stagehand::SessionExecuteParams::AgentConfig,
+        execute_options: Stagehand::SessionExecuteParams::ExecuteOptions,
+        frame_id: String?,
+        should_cache: bool,
+        x_stream_response: Stagehand::Models::SessionExecuteParams::x_stream_response,
+        request_options: Stagehand::RequestOptions
+      }
+
+      type agent_config =
+        {
+          cua: bool,
+          execution_model: Stagehand::Models::SessionExecuteParams::AgentConfig::execution_model,
+          mode: Stagehand::Models::SessionExecuteParams::AgentConfig::mode,
+          model: Stagehand::Models::SessionExecuteParams::AgentConfig::model,
+          provider: Stagehand::Models::SessionExecuteParams::AgentConfig::provider,
+          system_prompt: String
+        }
+
+      class AgentConfig < Stagehand::Internal::Type::BaseModel
+        attr_reader cua: bool?
+
+        def cua=: (bool) -> bool
+
+        attr_reader execution_model: Stagehand::Models::SessionExecuteParams::AgentConfig::execution_model?
+
+        def execution_model=: (
+          Stagehand::Models::SessionExecuteParams::AgentConfig::execution_model
+        ) -> Stagehand::Models::SessionExecuteParams::AgentConfig::execution_model
+
+        attr_reader mode: Stagehand::Models::SessionExecuteParams::AgentConfig::mode?
+
+        def mode=: (
+          Stagehand::Models::SessionExecuteParams::AgentConfig::mode
+        ) -> Stagehand::Models::SessionExecuteParams::AgentConfig::mode
+
+        attr_reader model: Stagehand::Models::SessionExecuteParams::AgentConfig::model?
+
+        def model=: (
+          Stagehand::Models::SessionExecuteParams::AgentConfig::model
+        ) -> Stagehand::Models::SessionExecuteParams::AgentConfig::model
+
+        attr_reader provider: Stagehand::Models::SessionExecuteParams::AgentConfig::provider?
+
+        def provider=: (
+          Stagehand::Models::SessionExecuteParams::AgentConfig::provider
+        ) -> Stagehand::Models::SessionExecuteParams::AgentConfig::provider
+
+        attr_reader system_prompt: String?
+
+        def system_prompt=: (String) -> String
+
+        def initialize: (
+          ?cua: bool,
+          ?execution_model: Stagehand::Models::SessionExecuteParams::AgentConfig::execution_model,
+          ?mode: Stagehand::Models::SessionExecuteParams::AgentConfig::mode,
+          ?model: Stagehand::Models::SessionExecuteParams::AgentConfig::model,
+          ?provider: Stagehand::Models::SessionExecuteParams::AgentConfig::provider,
+          ?system_prompt: String
+        ) -> void
+
+        def to_hash: -> {
+          cua: bool,
+          execution_model: Stagehand::Models::SessionExecuteParams::AgentConfig::execution_model,
+          mode: Stagehand::Models::SessionExecuteParams::AgentConfig::mode,
+          model: Stagehand::Models::SessionExecuteParams::AgentConfig::model,
+          provider: Stagehand::Models::SessionExecuteParams::AgentConfig::provider,
+          system_prompt: String
+        }
+
+        type execution_model = Stagehand::ModelConfig | String
+
+        module ExecutionModel
+          extend Stagehand::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Stagehand::Models::SessionExecuteParams::AgentConfig::execution_model]
+        end
+
+        type mode = :dom | :hybrid | :cua
+
+        module Mode
+          extend Stagehand::Internal::Type::Enum
+
+          DOM: :dom
+          HYBRID: :hybrid
+          CUA: :cua
+
+          def self?.values: -> ::Array[Stagehand::Models::SessionExecuteParams::AgentConfig::mode]
+        end
+
+        type model = Stagehand::ModelConfig | String
+
+        module Model
+          extend Stagehand::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Stagehand::Models::SessionExecuteParams::AgentConfig::model]
+        end
+
+        type provider = :openai | :anthropic | :google | :microsoft
+
+        module Provider
+          extend Stagehand::Internal::Type::Enum
+
+          OPENAI: :openai
+          ANTHROPIC: :anthropic
+          GOOGLE: :google
+          MICROSOFT: :microsoft
+
+          def self?.values: -> ::Array[Stagehand::Models::SessionExecuteParams::AgentConfig::provider]
+        end
+      end
+
+      type execute_options =
+        { instruction: String, highlight_cursor: bool, max_steps: Float }
+
+      class ExecuteOptions < Stagehand::Internal::Type::BaseModel
+        attr_accessor instruction: String
+
+        attr_reader highlight_cursor: bool?
+
+        def highlight_cursor=: (bool) -> bool
+
+        attr_reader max_steps: Float?
+
+        def max_steps=: (Float) -> Float
+
+        def initialize: (
+          instruction: String,
+          ?highlight_cursor: bool,
+          ?max_steps: Float
+        ) -> void
+
+        def to_hash: -> {
+          instruction: String,
+          highlight_cursor: bool,
+          max_steps: Float
+        }
+      end
+
+      type x_stream_response = :true | :false
+
+      module XStreamResponse
+        extend Stagehand::Internal::Type::Enum
+
+        TRUE: :true
+        FALSE: :false
+
+        def self?.values: -> ::Array[Stagehand::Models::SessionExecuteParams::x_stream_response]
+      end
+    end
+  end
+end

data/sig/stagehand/models/session_execute_response.rbs

@@ -0,0 +1,215 @@
+module Stagehand
+  module Models
+    type session_execute_response =
+      { data: Stagehand::Models::SessionExecuteResponse::Data, success: bool }
+
+    class SessionExecuteResponse < Stagehand::Internal::Type::BaseModel
+      attr_accessor data: Stagehand::Models::SessionExecuteResponse::Data
+
+      attr_accessor success: bool
+
+      def initialize: (
+        data: Stagehand::Models::SessionExecuteResponse::Data,
+        success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Stagehand::Models::SessionExecuteResponse::Data,
+        success: bool
+      }
+
+      type data =
+        {
+          result: Stagehand::Models::SessionExecuteResponse::Data::Result,
+          cache_entry: Stagehand::Models::SessionExecuteResponse::Data::CacheEntry
+        }
+
+      class Data < Stagehand::Internal::Type::BaseModel
+        attr_accessor result: Stagehand::Models::SessionExecuteResponse::Data::Result
+
+        attr_reader cache_entry: Stagehand::Models::SessionExecuteResponse::Data::CacheEntry?
+
+        def cache_entry=: (
+          Stagehand::Models::SessionExecuteResponse::Data::CacheEntry
+        ) -> Stagehand::Models::SessionExecuteResponse::Data::CacheEntry
+
+        def initialize: (
+          result: Stagehand::Models::SessionExecuteResponse::Data::Result,
+          ?cache_entry: Stagehand::Models::SessionExecuteResponse::Data::CacheEntry
+        ) -> void
+
+        def to_hash: -> {
+          result: Stagehand::Models::SessionExecuteResponse::Data::Result,
+          cache_entry: Stagehand::Models::SessionExecuteResponse::Data::CacheEntry
+        }
+
+        type result =
+          {
+            actions: ::Array[Stagehand::Models::SessionExecuteResponse::Data::Result::Action],
+            completed: bool,
+            message: String,
+            success: bool,
+            metadata: ::Hash[Symbol, top],
+            usage: Stagehand::Models::SessionExecuteResponse::Data::Result::Usage
+          }
+
+        class Result < Stagehand::Internal::Type::BaseModel
+          attr_accessor actions: ::Array[Stagehand::Models::SessionExecuteResponse::Data::Result::Action]
+
+          attr_accessor completed: bool
+
+          attr_accessor message: String
+
+          attr_accessor success: bool
+
+          attr_reader metadata: ::Hash[Symbol, top]?
+
+          def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          attr_reader usage: Stagehand::Models::SessionExecuteResponse::Data::Result::Usage?
+
+          def usage=: (
+            Stagehand::Models::SessionExecuteResponse::Data::Result::Usage
+          ) -> Stagehand::Models::SessionExecuteResponse::Data::Result::Usage
+
+          def initialize: (
+            actions: ::Array[Stagehand::Models::SessionExecuteResponse::Data::Result::Action],
+            completed: bool,
+            message: String,
+            success: bool,
+            ?metadata: ::Hash[Symbol, top],
+            ?usage: Stagehand::Models::SessionExecuteResponse::Data::Result::Usage
+          ) -> void
+
+          def to_hash: -> {
+            actions: ::Array[Stagehand::Models::SessionExecuteResponse::Data::Result::Action],
+            completed: bool,
+            message: String,
+            success: bool,
+            metadata: ::Hash[Symbol, top],
+            usage: Stagehand::Models::SessionExecuteResponse::Data::Result::Usage
+          }
+
+          type action =
+            {
+              type: String,
+              action: String,
+              instruction: String,
+              page_text: String,
+              page_url: String,
+              reasoning: String,
+              task_completed: bool,
+              time_ms: Float
+            }
+
+          class Action < Stagehand::Internal::Type::BaseModel
+            attr_accessor type: String
+
+            attr_reader action: String?
+
+            def action=: (String) -> String
+
+            attr_reader instruction: String?
+
+            def instruction=: (String) -> String
+
+            attr_reader page_text: String?
+
+            def page_text=: (String) -> String
+
+            attr_reader page_url: String?
+
+            def page_url=: (String) -> String
+
+            attr_reader reasoning: String?
+
+            def reasoning=: (String) -> String
+
+            attr_reader task_completed: bool?
+
+            def task_completed=: (bool) -> bool
+
+            attr_reader time_ms: Float?
+
+            def time_ms=: (Float) -> Float
+
+            def initialize: (
+              type: String,
+              ?action: String,
+              ?instruction: String,
+              ?page_text: String,
+              ?page_url: String,
+              ?reasoning: String,
+              ?task_completed: bool,
+              ?time_ms: Float
+            ) -> void
+
+            def to_hash: -> {
+              type: String,
+              action: String,
+              instruction: String,
+              page_text: String,
+              page_url: String,
+              reasoning: String,
+              task_completed: bool,
+              time_ms: Float
+            }
+          end
+
+          type usage =
+            {
+              inference_time_ms: Float,
+              input_tokens: Float,
+              output_tokens: Float,
+              cached_input_tokens: Float,
+              reasoning_tokens: Float
+            }
+
+          class Usage < Stagehand::Internal::Type::BaseModel
+            attr_accessor inference_time_ms: Float
+
+            attr_accessor input_tokens: Float
+
+            attr_accessor output_tokens: Float
+
+            attr_reader cached_input_tokens: Float?
+
+            def cached_input_tokens=: (Float) -> Float
+
+            attr_reader reasoning_tokens: Float?
+
+            def reasoning_tokens=: (Float) -> Float
+
+            def initialize: (
+              inference_time_ms: Float,
+              input_tokens: Float,
+              output_tokens: Float,
+              ?cached_input_tokens: Float,
+              ?reasoning_tokens: Float
+            ) -> void
+
+            def to_hash: -> {
+              inference_time_ms: Float,
+              input_tokens: Float,
+              output_tokens: Float,
+              cached_input_tokens: Float,
+              reasoning_tokens: Float
+            }
+          end
+        end
+
+        type cache_entry = { cache_key: String, entry: top }
+
+        class CacheEntry < Stagehand::Internal::Type::BaseModel
+          attr_accessor cache_key: String
+
+          attr_accessor entry: top
+
+          def initialize: (cache_key: String, entry: top) -> void
+
+          def to_hash: -> { cache_key: String, entry: top }
+        end
+      end
+    end
+  end
+end

data/sig/stagehand/models/session_extract_params.rbs

@@ -0,0 +1,112 @@
+module Stagehand
+  module Models
+    type session_extract_params =
+      {
+        frame_id: String?,
+        instruction: String,
+        options: Stagehand::SessionExtractParams::Options,
+        schema: ::Hash[Symbol, top],
+        x_stream_response: Stagehand::Models::SessionExtractParams::x_stream_response
+      }
+      & Stagehand::Internal::Type::request_parameters
+
+    class SessionExtractParams < Stagehand::Internal::Type::BaseModel
+      extend Stagehand::Internal::Type::RequestParameters::Converter
+      include Stagehand::Internal::Type::RequestParameters
+
+      attr_accessor frame_id: String?
+
+      attr_reader instruction: String?
+
+      def instruction=: (String) -> String
+
+      attr_reader options: Stagehand::SessionExtractParams::Options?
+
+      def options=: (
+        Stagehand::SessionExtractParams::Options
+      ) -> Stagehand::SessionExtractParams::Options
+
+      attr_reader schema: ::Hash[Symbol, top]?
+
+      def schema=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader x_stream_response: Stagehand::Models::SessionExtractParams::x_stream_response?
+
+      def x_stream_response=: (
+        Stagehand::Models::SessionExtractParams::x_stream_response
+      ) -> Stagehand::Models::SessionExtractParams::x_stream_response
+
+      def initialize: (
+        ?frame_id: String?,
+        ?instruction: String,
+        ?options: Stagehand::SessionExtractParams::Options,
+        ?schema: ::Hash[Symbol, top],
+        ?x_stream_response: Stagehand::Models::SessionExtractParams::x_stream_response,
+        ?request_options: Stagehand::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        frame_id: String?,
+        instruction: String,
+        options: Stagehand::SessionExtractParams::Options,
+        schema: ::Hash[Symbol, top],
+        x_stream_response: Stagehand::Models::SessionExtractParams::x_stream_response,
+        request_options: Stagehand::RequestOptions
+      }
+
+      type options =
+        {
+          model: Stagehand::Models::SessionExtractParams::Options::model,
+          selector: String,
+          timeout: Float
+        }
+
+      class Options < Stagehand::Internal::Type::BaseModel
+        attr_reader model: Stagehand::Models::SessionExtractParams::Options::model?
+
+        def model=: (
+          Stagehand::Models::SessionExtractParams::Options::model
+        ) -> Stagehand::Models::SessionExtractParams::Options::model
+
+        attr_reader selector: String?
+
+        def selector=: (String) -> String
+
+        attr_reader timeout: Float?
+
+        def timeout=: (Float) -> Float
+
+        def initialize: (
+          ?model: Stagehand::Models::SessionExtractParams::Options::model,
+          ?selector: String,
+          ?timeout: Float
+        ) -> void
+
+        def to_hash: -> {
+          model: Stagehand::Models::SessionExtractParams::Options::model,
+          selector: String,
+          timeout: Float
+        }
+
+        type model = Stagehand::ModelConfig | String
+
+        module Model
+          extend Stagehand::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Stagehand::Models::SessionExtractParams::Options::model]
+        end
+      end
+
+      type x_stream_response = :true | :false
+
+      module XStreamResponse
+        extend Stagehand::Internal::Type::Enum
+
+        TRUE: :true
+        FALSE: :false
+
+        def self?.values: -> ::Array[Stagehand::Models::SessionExtractParams::x_stream_response]
+      end
+    end
+  end
+end

data/sig/stagehand/models/session_extract_response.rbs

@@ -0,0 +1,36 @@
+module Stagehand
+  module Models
+    type session_extract_response =
+      { data: Stagehand::Models::SessionExtractResponse::Data, success: bool }
+
+    class SessionExtractResponse < Stagehand::Internal::Type::BaseModel
+      attr_accessor data: Stagehand::Models::SessionExtractResponse::Data
+
+      attr_accessor success: bool
+
+      def initialize: (
+        data: Stagehand::Models::SessionExtractResponse::Data,
+        success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Stagehand::Models::SessionExtractResponse::Data,
+        success: bool
+      }
+
+      type data = { result: top, action_id: String }
+
+      class Data < Stagehand::Internal::Type::BaseModel
+        attr_accessor result: top
+
+        attr_reader action_id: String?
+
+        def action_id=: (String) -> String
+
+        def initialize: (result: top, ?action_id: String) -> void
+
+        def to_hash: -> { result: top, action_id: String }
+      end
+    end
+  end
+end

data/sig/stagehand/models/session_navigate_params.rbs

@@ -0,0 +1,114 @@
+module Stagehand
+  module Models
+    type session_navigate_params =
+      {
+        url: String,
+        frame_id: String?,
+        options: Stagehand::SessionNavigateParams::Options,
+        stream_response: bool,
+        x_stream_response: Stagehand::Models::SessionNavigateParams::x_stream_response
+      }
+      & Stagehand::Internal::Type::request_parameters
+
+    class SessionNavigateParams < Stagehand::Internal::Type::BaseModel
+      extend Stagehand::Internal::Type::RequestParameters::Converter
+      include Stagehand::Internal::Type::RequestParameters
+
+      attr_accessor url: String
+
+      attr_accessor frame_id: String?
+
+      attr_reader options: Stagehand::SessionNavigateParams::Options?
+
+      def options=: (
+        Stagehand::SessionNavigateParams::Options
+      ) -> Stagehand::SessionNavigateParams::Options
+
+      attr_reader stream_response: bool?
+
+      def stream_response=: (bool) -> bool
+
+      attr_reader x_stream_response: Stagehand::Models::SessionNavigateParams::x_stream_response?
+
+      def x_stream_response=: (
+        Stagehand::Models::SessionNavigateParams::x_stream_response
+      ) -> Stagehand::Models::SessionNavigateParams::x_stream_response
+
+      def initialize: (
+        url: String,
+        ?frame_id: String?,
+        ?options: Stagehand::SessionNavigateParams::Options,
+        ?stream_response: bool,
+        ?x_stream_response: Stagehand::Models::SessionNavigateParams::x_stream_response,
+        ?request_options: Stagehand::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        url: String,
+        frame_id: String?,
+        options: Stagehand::SessionNavigateParams::Options,
+        stream_response: bool,
+        x_stream_response: Stagehand::Models::SessionNavigateParams::x_stream_response,
+        request_options: Stagehand::RequestOptions
+      }
+
+      type options =
+        {
+          referer: String,
+          timeout: Float,
+          wait_until: Stagehand::Models::SessionNavigateParams::Options::wait_until
+        }
+
+      class Options < Stagehand::Internal::Type::BaseModel
+        attr_reader referer: String?
+
+        def referer=: (String) -> String
+
+        attr_reader timeout: Float?
+
+        def timeout=: (Float) -> Float
+
+        attr_reader wait_until: Stagehand::Models::SessionNavigateParams::Options::wait_until?
+
+        def wait_until=: (
+          Stagehand::Models::SessionNavigateParams::Options::wait_until
+        ) -> Stagehand::Models::SessionNavigateParams::Options::wait_until
+
+        def initialize: (
+          ?referer: String,
+          ?timeout: Float,
+          ?wait_until: Stagehand::Models::SessionNavigateParams::Options::wait_until
+        ) -> void
+
+        def to_hash: -> {
+          referer: String,
+          timeout: Float,
+          wait_until: Stagehand::Models::SessionNavigateParams::Options::wait_until
+        }
+
+        type wait_until = :load | :domcontentloaded | :networkidle
+
+        module WaitUntil
+          extend Stagehand::Internal::Type::Enum
+
+          LOAD: :load
+          DOMCONTENTLOADED: :domcontentloaded
+          NETWORKIDLE: :networkidle
+
+          def self?.values: -> ::Array[Stagehand::Models::SessionNavigateParams::Options::wait_until]
+        end
+      end
+
+      type x_stream_response = :true | :false
+
+      module XStreamResponse
+        extend Stagehand::Internal::Type::Enum
+
+        TRUE: :true
+        FALSE: :false
+
+        def self?.values: -> ::Array[Stagehand::Models::SessionNavigateParams::x_stream_response]
+      end
+    end
+  end
+end

data/sig/stagehand/models/session_navigate_response.rbs

@@ -0,0 +1,36 @@
+module Stagehand
+  module Models
+    type session_navigate_response =
+      { data: Stagehand::Models::SessionNavigateResponse::Data, success: bool }
+
+    class SessionNavigateResponse < Stagehand::Internal::Type::BaseModel
+      attr_accessor data: Stagehand::Models::SessionNavigateResponse::Data
+
+      attr_accessor success: bool
+
+      def initialize: (
+        data: Stagehand::Models::SessionNavigateResponse::Data,
+        success: bool
+      ) -> void
+
+      def to_hash: -> {
+        data: Stagehand::Models::SessionNavigateResponse::Data,
+        success: bool
+      }
+
+      type data = { result: top, action_id: String }
+
+      class Data < Stagehand::Internal::Type::BaseModel
+        attr_accessor result: top
+
+        attr_reader action_id: String?
+
+        def action_id=: (String) -> String
+
+        def initialize: (result: top, ?action_id: String) -> void
+
+        def to_hash: -> { result: top, action_id: String }
+      end
+    end
+  end
+end