stagehand 0.0.3 → 3.5.2

data/rbi/stagehand/models/session_act_params.rbi

@@ -0,0 +1,204 @@
+# typed: strong
+
+module Stagehand
+  module Models
+    class SessionActParams < Stagehand::Internal::Type::BaseModel
+      extend Stagehand::Internal::Type::RequestParameters::Converter
+      include Stagehand::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Stagehand::SessionActParams, Stagehand::Internal::AnyHash)
+        end
+
+      # Natural language instruction or Action object
+      sig { returns(T.any(String, Stagehand::Action)) }
+      attr_accessor :input
+
+      # Target frame ID for the action
+      sig { returns(T.nilable(String)) }
+      attr_accessor :frame_id
+
+      sig { returns(T.nilable(Stagehand::SessionActParams::Options)) }
+      attr_reader :options
+
+      sig { params(options: Stagehand::SessionActParams::Options::OrHash).void }
+      attr_writer :options
+
+      # Whether to stream the response via SSE
+      sig do
+        returns(
+          T.nilable(Stagehand::SessionActParams::XStreamResponse::OrSymbol)
+        )
+      end
+      attr_reader :x_stream_response
+
+      sig do
+        params(
+          x_stream_response:
+            Stagehand::SessionActParams::XStreamResponse::OrSymbol
+        ).void
+      end
+      attr_writer :x_stream_response
+
+      sig do
+        params(
+          input: T.any(String, Stagehand::Action::OrHash),
+          frame_id: T.nilable(String),
+          options: Stagehand::SessionActParams::Options::OrHash,
+          x_stream_response:
+            Stagehand::SessionActParams::XStreamResponse::OrSymbol,
+          request_options: Stagehand::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Natural language instruction or Action object
+        input:,
+        # Target frame ID for the action
+        frame_id: nil,
+        options: nil,
+        # Whether to stream the response via SSE
+        x_stream_response: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            input: T.any(String, Stagehand::Action),
+            frame_id: T.nilable(String),
+            options: Stagehand::SessionActParams::Options,
+            x_stream_response:
+              Stagehand::SessionActParams::XStreamResponse::OrSymbol,
+            request_options: Stagehand::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Natural language instruction or Action object
+      module Input
+        extend Stagehand::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(String, Stagehand::Action) }
+
+        sig do
+          override.returns(
+            T::Array[Stagehand::SessionActParams::Input::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+
+      class Options < Stagehand::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Stagehand::SessionActParams::Options,
+              Stagehand::Internal::AnyHash
+            )
+          end
+
+        # Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
+        sig { returns(T.nilable(T.any(Stagehand::ModelConfig, String))) }
+        attr_reader :model
+
+        sig do
+          params(model: T.any(Stagehand::ModelConfig::OrHash, String)).void
+        end
+        attr_writer :model
+
+        # Timeout in ms for the action
+        sig { returns(T.nilable(Float)) }
+        attr_reader :timeout
+
+        sig { params(timeout: Float).void }
+        attr_writer :timeout
+
+        # Variables to substitute in the action instruction
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :variables
+
+        sig { params(variables: T::Hash[Symbol, String]).void }
+        attr_writer :variables
+
+        sig do
+          params(
+            model: T.any(Stagehand::ModelConfig::OrHash, String),
+            timeout: Float,
+            variables: T::Hash[Symbol, String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
+          model: nil,
+          # Timeout in ms for the action
+          timeout: nil,
+          # Variables to substitute in the action instruction
+          variables: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              model: T.any(Stagehand::ModelConfig, String),
+              timeout: Float,
+              variables: T::Hash[Symbol, String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
+        module Model
+          extend Stagehand::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(Stagehand::ModelConfig, String) }
+
+          sig do
+            override.returns(
+              T::Array[Stagehand::SessionActParams::Options::Model::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+
+      # Whether to stream the response via SSE
+      module XStreamResponse
+        extend Stagehand::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Stagehand::SessionActParams::XStreamResponse)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRUE =
+          T.let(
+            :true,
+            Stagehand::SessionActParams::XStreamResponse::TaggedSymbol
+          )
+        FALSE =
+          T.let(
+            :false,
+            Stagehand::SessionActParams::XStreamResponse::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Stagehand::SessionActParams::XStreamResponse::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/stagehand/models/session_act_response.rbi

@@ -0,0 +1,250 @@
+# typed: strong
+
+module Stagehand
+  module Models
+    class SessionActResponse < Stagehand::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Stagehand::Models::SessionActResponse,
+            Stagehand::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Stagehand::Models::SessionActResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Stagehand::Models::SessionActResponse::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # Indicates whether the request was successful
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig do
+        params(
+          data: Stagehand::Models::SessionActResponse::Data::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Indicates whether the request was successful
+        success:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Stagehand::Models::SessionActResponse::Data,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Stagehand::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Stagehand::Models::SessionActResponse::Data,
+              Stagehand::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Stagehand::Models::SessionActResponse::Data::Result) }
+        attr_reader :result
+
+        sig do
+          params(
+            result: Stagehand::Models::SessionActResponse::Data::Result::OrHash
+          ).void
+        end
+        attr_writer :result
+
+        # Action ID for tracking
+        sig { returns(T.nilable(String)) }
+        attr_reader :action_id
+
+        sig { params(action_id: String).void }
+        attr_writer :action_id
+
+        sig do
+          params(
+            result: Stagehand::Models::SessionActResponse::Data::Result::OrHash,
+            action_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          result:,
+          # Action ID for tracking
+          action_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              result: Stagehand::Models::SessionActResponse::Data::Result,
+              action_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Result < Stagehand::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Stagehand::Models::SessionActResponse::Data::Result,
+                Stagehand::Internal::AnyHash
+              )
+            end
+
+          # Description of the action that was performed
+          sig { returns(String) }
+          attr_accessor :action_description
+
+          # List of actions that were executed
+          sig do
+            returns(
+              T::Array[
+                Stagehand::Models::SessionActResponse::Data::Result::Action
+              ]
+            )
+          end
+          attr_accessor :actions
+
+          # Human-readable result message
+          sig { returns(String) }
+          attr_accessor :message
+
+          # Whether the action completed successfully
+          sig { returns(T::Boolean) }
+          attr_accessor :success
+
+          sig do
+            params(
+              action_description: String,
+              actions:
+                T::Array[
+                  Stagehand::Models::SessionActResponse::Data::Result::Action::OrHash
+                ],
+              message: String,
+              success: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Description of the action that was performed
+            action_description:,
+            # List of actions that were executed
+            actions:,
+            # Human-readable result message
+            message:,
+            # Whether the action completed successfully
+            success:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                action_description: String,
+                actions:
+                  T::Array[
+                    Stagehand::Models::SessionActResponse::Data::Result::Action
+                  ],
+                message: String,
+                success: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Action < Stagehand::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Stagehand::Models::SessionActResponse::Data::Result::Action,
+                  Stagehand::Internal::AnyHash
+                )
+              end
+
+            # Human-readable description of the action
+            sig { returns(String) }
+            attr_accessor :description
+
+            # CSS selector or XPath for the element
+            sig { returns(String) }
+            attr_accessor :selector
+
+            # Arguments to pass to the method
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :arguments
+
+            sig { params(arguments: T::Array[String]).void }
+            attr_writer :arguments
+
+            # Backend node ID for the element
+            sig { returns(T.nilable(Float)) }
+            attr_reader :backend_node_id
+
+            sig { params(backend_node_id: Float).void }
+            attr_writer :backend_node_id
+
+            # The method to execute (click, fill, etc.)
+            sig { returns(T.nilable(String)) }
+            attr_reader :method_
+
+            sig { params(method_: String).void }
+            attr_writer :method_
+
+            # Action object returned by observe and used by act
+            sig do
+              params(
+                description: String,
+                selector: String,
+                arguments: T::Array[String],
+                backend_node_id: Float,
+                method_: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Human-readable description of the action
+              description:,
+              # CSS selector or XPath for the element
+              selector:,
+              # Arguments to pass to the method
+              arguments: nil,
+              # Backend node ID for the element
+              backend_node_id: nil,
+              # The method to execute (click, fill, etc.)
+              method_: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  description: String,
+                  selector: String,
+                  arguments: T::Array[String],
+                  backend_node_id: Float,
+                  method_: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/stagehand/models/session_end_params.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Stagehand
+  module Models
+    class SessionEndParams < Stagehand::Internal::Type::BaseModel
+      extend Stagehand::Internal::Type::RequestParameters::Converter
+      include Stagehand::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Stagehand::SessionEndParams, Stagehand::Internal::AnyHash)
+        end
+
+      # Whether to stream the response via SSE
+      sig do
+        returns(
+          T.nilable(Stagehand::SessionEndParams::XStreamResponse::OrSymbol)
+        )
+      end
+      attr_reader :x_stream_response
+
+      sig do
+        params(
+          x_stream_response:
+            Stagehand::SessionEndParams::XStreamResponse::OrSymbol
+        ).void
+      end
+      attr_writer :x_stream_response
+
+      sig do
+        params(
+          x_stream_response:
+            Stagehand::SessionEndParams::XStreamResponse::OrSymbol,
+          request_options: Stagehand::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether to stream the response via SSE
+        x_stream_response: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            x_stream_response:
+              Stagehand::SessionEndParams::XStreamResponse::OrSymbol,
+            request_options: Stagehand::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether to stream the response via SSE
+      module XStreamResponse
+        extend Stagehand::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Stagehand::SessionEndParams::XStreamResponse)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRUE =
+          T.let(
+            :true,
+            Stagehand::SessionEndParams::XStreamResponse::TaggedSymbol
+          )
+        FALSE =
+          T.let(
+            :false,
+            Stagehand::SessionEndParams::XStreamResponse::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Stagehand::SessionEndParams::XStreamResponse::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/stagehand/models/session_end_response.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Stagehand
+  module Models
+    class SessionEndResponse < Stagehand::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Stagehand::Models::SessionEndResponse,
+            Stagehand::Internal::AnyHash
+          )
+        end
+
+      # Indicates whether the request was successful
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      sig { params(success: T::Boolean).returns(T.attached_class) }
+      def self.new(
+        # Indicates whether the request was successful
+        success:
+      )
+      end
+
+      sig { override.returns({ success: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end