stagehand 3.19.3 → 3.21.0

data/rbi/stagehand/models/session_start_params.rbi

@@ -680,6 +680,8 @@ module Stagehand
         sig { params(keep_alive: T::Boolean).void }
         attr_writer :keep_alive
 
+        # Deprecated. Browserbase API keys are now project-scoped, so this field is no
+        # longer required.
         sig { returns(T.nilable(String)) }
         attr_reader :project_id
 
@@ -751,6 +753,8 @@ module Stagehand
           browser_settings: nil,
           extension_id: nil,
           keep_alive: nil,
+          # Deprecated. Browserbase API keys are now project-scoped, so this field is no
+          # longer required.
           project_id: nil,
           proxies: nil,
           region: nil,
@@ -800,6 +804,18 @@ module Stagehand
           sig { params(block_ads: T::Boolean).void }
           attr_writer :block_ads
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :captcha_image_selector
+
+          sig { params(captcha_image_selector: String).void }
+          attr_writer :captcha_image_selector
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :captcha_input_selector
+
+          sig { params(captcha_input_selector: String).void }
+          attr_writer :captcha_input_selector
+
           sig do
             returns(
               T.nilable(
@@ -846,6 +862,23 @@ module Stagehand
           sig { params(log_session: T::Boolean).void }
           attr_writer :log_session
 
+          sig do
+            returns(
+              T.nilable(
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::OrSymbol
+              )
+            )
+          end
+          attr_reader :os
+
+          sig do
+            params(
+              os:
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::OrSymbol
+            ).void
+          end
+          attr_writer :os
+
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :record_session
 
@@ -858,6 +891,12 @@ module Stagehand
           sig { params(solve_captchas: T::Boolean).void }
           attr_writer :solve_captchas
 
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :verified
+
+          sig { params(verified: T::Boolean).void }
+          attr_writer :verified
+
           sig do
             returns(
               T.nilable(
@@ -879,14 +918,19 @@ module Stagehand
             params(
               advanced_stealth: T::Boolean,
               block_ads: T::Boolean,
+              captcha_image_selector: String,
+              captcha_input_selector: String,
               context:
                 Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Context::OrHash,
               extension_id: String,
               fingerprint:
                 Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Fingerprint::OrHash,
               log_session: T::Boolean,
+              os:
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::OrSymbol,
               record_session: T::Boolean,
               solve_captchas: T::Boolean,
+              verified: T::Boolean,
               viewport:
                 Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Viewport::OrHash
             ).returns(T.attached_class)
@@ -894,12 +938,16 @@ module Stagehand
           def self.new(
             advanced_stealth: nil,
             block_ads: nil,
+            captcha_image_selector: nil,
+            captcha_input_selector: nil,
             context: nil,
             extension_id: nil,
             fingerprint: nil,
             log_session: nil,
+            os: nil,
             record_session: nil,
             solve_captchas: nil,
+            verified: nil,
             viewport: nil
           )
           end
@@ -909,14 +957,19 @@ module Stagehand
               {
                 advanced_stealth: T::Boolean,
                 block_ads: T::Boolean,
+                captcha_image_selector: String,
+                captcha_input_selector: String,
                 context:
                   Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Context,
                 extension_id: String,
                 fingerprint:
                   Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Fingerprint,
                 log_session: T::Boolean,
+                os:
+                  Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::OrSymbol,
                 record_session: T::Boolean,
                 solve_captchas: T::Boolean,
+                verified: T::Boolean,
                 viewport:
                   Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Viewport
               }
@@ -1348,6 +1401,55 @@ module Stagehand
             end
           end
 
+          module Os
+            extend Stagehand::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            WINDOWS =
+              T.let(
+                :windows,
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::TaggedSymbol
+              )
+            MAC =
+              T.let(
+                :mac,
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::TaggedSymbol
+              )
+            LINUX =
+              T.let(
+                :linux,
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::TaggedSymbol
+              )
+            MOBILE =
+              T.let(
+                :mobile,
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::TaggedSymbol
+              )
+            TABLET =
+              T.let(
+                :tablet,
+                Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Stagehand::SessionStartParams::BrowserbaseSessionCreateParams::BrowserSettings::Os::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           class Viewport < Stagehand::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/sig/stagehand/models/model_config.rbs

@@ -1,64 +1,332 @@
 module Stagehand
   module Models
     type model_config =
-      {
-        model_name: String,
-        api_key: String,
-        base_url: String,
-        headers: ::Hash[Symbol, String],
-        provider: Stagehand::Models::ModelConfig::provider
-      }
+      Stagehand::ModelConfig::VertexModelConfigObject
+      | Stagehand::ModelConfig::GenericModelConfigObject
 
-    class ModelConfig < Stagehand::Internal::Type::BaseModel
-      attr_accessor model_name: String
+    module ModelConfig
+      extend Stagehand::Internal::Type::Union
 
-      attr_reader api_key: String?
+      type vertex_model_config_object =
+        {
+          auth: Stagehand::ModelConfig::VertexModelConfigObject::Auth,
+          model_name: String,
+          provider: :vertex,
+          provider_options: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions,
+          api_key: String,
+          base_url: String,
+          headers: ::Hash[Symbol, String]
+        }
 
-      def api_key=: (String) -> String
+      class VertexModelConfigObject < Stagehand::Internal::Type::BaseModel
+        attr_accessor auth: Stagehand::ModelConfig::VertexModelConfigObject::Auth
 
-      attr_reader base_url: String?
+        attr_accessor model_name: String
 
-      def base_url=: (String) -> String
+        attr_accessor provider: :vertex
 
-      attr_reader headers: ::Hash[Symbol, String]?
+        attr_accessor provider_options: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions
 
-      def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+        attr_reader api_key: String?
 
-      attr_reader provider: Stagehand::Models::ModelConfig::provider?
+        def api_key=: (String) -> String
 
-      def provider=: (
-        Stagehand::Models::ModelConfig::provider
-      ) -> Stagehand::Models::ModelConfig::provider
+        attr_reader base_url: String?
 
-      def initialize: (
-        model_name: String,
-        ?api_key: String,
-        ?base_url: String,
-        ?headers: ::Hash[Symbol, String],
-        ?provider: Stagehand::Models::ModelConfig::provider
-      ) -> void
+        def base_url=: (String) -> String
 
-      def to_hash: -> {
-        model_name: String,
-        api_key: String,
-        base_url: String,
-        headers: ::Hash[Symbol, String],
-        provider: Stagehand::Models::ModelConfig::provider
-      }
+        attr_reader headers: ::Hash[Symbol, String]?
 
-      type provider = :openai | :anthropic | :google | :microsoft | :bedrock
+        def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
 
-      module Provider
-        extend Stagehand::Internal::Type::Enum
+        def initialize: (
+          auth: Stagehand::ModelConfig::VertexModelConfigObject::Auth,
+          model_name: String,
+          provider_options: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions,
+          ?api_key: String,
+          ?base_url: String,
+          ?headers: ::Hash[Symbol, String],
+          ?provider: :vertex
+        ) -> void
 
-        OPENAI: :openai
-        ANTHROPIC: :anthropic
-        GOOGLE: :google
-        MICROSOFT: :microsoft
-        BEDROCK: :bedrock
+        def to_hash: -> {
+          auth: Stagehand::ModelConfig::VertexModelConfigObject::Auth,
+          model_name: String,
+          provider: :vertex,
+          provider_options: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions,
+          api_key: String,
+          base_url: String,
+          headers: ::Hash[Symbol, String]
+        }
 
-        def self?.values: -> ::Array[Stagehand::Models::ModelConfig::provider]
+        type auth =
+          {
+            credentials: Stagehand::ModelConfig::VertexModelConfigObject::Auth::Credentials,
+            type: :googleServiceAccount,
+            project_id: String,
+            scopes: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::scopes,
+            universe_domain: String
+          }
+
+        class Auth < Stagehand::Internal::Type::BaseModel
+          attr_accessor credentials: Stagehand::ModelConfig::VertexModelConfigObject::Auth::Credentials
+
+          attr_accessor type: :googleServiceAccount
+
+          attr_reader project_id: String?
+
+          def project_id=: (String) -> String
+
+          attr_reader scopes: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::scopes?
+
+          def scopes=: (
+            Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::scopes
+          ) -> Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::scopes
+
+          attr_reader universe_domain: String?
+
+          def universe_domain=: (String) -> String
+
+          def initialize: (
+            credentials: Stagehand::ModelConfig::VertexModelConfigObject::Auth::Credentials,
+            ?project_id: String,
+            ?scopes: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::scopes,
+            ?universe_domain: String,
+            ?type: :googleServiceAccount
+          ) -> void
+
+          def to_hash: -> {
+            credentials: Stagehand::ModelConfig::VertexModelConfigObject::Auth::Credentials,
+            type: :googleServiceAccount,
+            project_id: String,
+            scopes: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::scopes,
+            universe_domain: String
+          }
+
+          type credentials =
+            {
+              client_email: String,
+              private_key: String,
+              :auth_provider_x509_cert_url => String,
+              auth_uri: String,
+              client_id: String,
+              :client_x509_cert_url => String,
+              private_key_id: String,
+              project_id: String,
+              token_uri: String,
+              type: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::type_,
+              universe_domain: String
+            }
+
+          class Credentials < Stagehand::Internal::Type::BaseModel
+            attr_accessor client_email: String
+
+            attr_accessor private_key: String
+
+            attr_reader auth_provider_x509_cert_url: String?
+
+            def auth_provider_x509_cert_url=: (String) -> String
+
+            attr_reader auth_uri: String?
+
+            def auth_uri=: (String) -> String
+
+            attr_reader client_id: String?
+
+            def client_id=: (String) -> String
+
+            attr_reader client_x509_cert_url: String?
+
+            def client_x509_cert_url=: (String) -> String
+
+            attr_reader private_key_id: String?
+
+            def private_key_id=: (String) -> String
+
+            attr_reader project_id: String?
+
+            def project_id=: (String) -> String
+
+            attr_reader token_uri: String?
+
+            def token_uri=: (String) -> String
+
+            attr_reader type: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::type_?
+
+            def type=: (
+              Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::type_
+            ) -> Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::type_
+
+            attr_reader universe_domain: String?
+
+            def universe_domain=: (String) -> String
+
+            def initialize: (
+              client_email: String,
+              private_key: String,
+              ?auth_provider_x509_cert_url: String,
+              ?auth_uri: String,
+              ?client_id: String,
+              ?client_x509_cert_url: String,
+              ?private_key_id: String,
+              ?project_id: String,
+              ?token_uri: String,
+              ?type: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::type_,
+              ?universe_domain: String
+            ) -> void
+
+            def to_hash: -> {
+              client_email: String,
+              private_key: String,
+              :auth_provider_x509_cert_url => String,
+              auth_uri: String,
+              client_id: String,
+              :client_x509_cert_url => String,
+              private_key_id: String,
+              project_id: String,
+              token_uri: String,
+              type: Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::type_,
+              universe_domain: String
+            }
+
+            type type_ = :service_account
+
+            module Type
+              extend Stagehand::Internal::Type::Enum
+
+              SERVICE_ACCOUNT: :service_account
+
+              def self?.values: -> ::Array[Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::Credentials::type_]
+            end
+          end
+
+          type scopes = String | ::Array[String]
+
+          module Scopes
+            extend Stagehand::Internal::Type::Union
+
+            def self?.variants: -> ::Array[Stagehand::Models::ModelConfig::VertexModelConfigObject::Auth::scopes]
+
+            StringArray: Stagehand::Internal::Type::Converter
+          end
+        end
+
+        type provider_options =
+          {
+            vertex: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions::Vertex
+          }
+
+        class ProviderOptions < Stagehand::Internal::Type::BaseModel
+          attr_accessor vertex: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions::Vertex
+
+          def initialize: (
+            vertex: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions::Vertex
+          ) -> void
+
+          def to_hash: -> {
+            vertex: Stagehand::ModelConfig::VertexModelConfigObject::ProviderOptions::Vertex
+          }
+
+          type vertex =
+            {
+              location: String,
+              project: String,
+              base_url: String,
+              headers: ::Hash[Symbol, String]
+            }
+
+          class Vertex < Stagehand::Internal::Type::BaseModel
+            attr_accessor location: String
+
+            attr_accessor project: String
+
+            attr_reader base_url: String?
+
+            def base_url=: (String) -> String
+
+            attr_reader headers: ::Hash[Symbol, String]?
+
+            def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+            def initialize: (
+              location: String,
+              project: String,
+              ?base_url: String,
+              ?headers: ::Hash[Symbol, String]
+            ) -> void
+
+            def to_hash: -> {
+              location: String,
+              project: String,
+              base_url: String,
+              headers: ::Hash[Symbol, String]
+            }
+          end
+        end
       end
+
+      type generic_model_config_object =
+        {
+          model_name: String,
+          api_key: String,
+          base_url: String,
+          headers: ::Hash[Symbol, String],
+          provider: Stagehand::Models::ModelConfig::GenericModelConfigObject::provider
+        }
+
+      class GenericModelConfigObject < Stagehand::Internal::Type::BaseModel
+        attr_accessor model_name: String
+
+        attr_reader api_key: String?
+
+        def api_key=: (String) -> String
+
+        attr_reader base_url: String?
+
+        def base_url=: (String) -> String
+
+        attr_reader headers: ::Hash[Symbol, String]?
+
+        def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+        attr_reader provider: Stagehand::Models::ModelConfig::GenericModelConfigObject::provider?
+
+        def provider=: (
+          Stagehand::Models::ModelConfig::GenericModelConfigObject::provider
+        ) -> Stagehand::Models::ModelConfig::GenericModelConfigObject::provider
+
+        def initialize: (
+          model_name: String,
+          ?api_key: String,
+          ?base_url: String,
+          ?headers: ::Hash[Symbol, String],
+          ?provider: Stagehand::Models::ModelConfig::GenericModelConfigObject::provider
+        ) -> void
+
+        def to_hash: -> {
+          model_name: String,
+          api_key: String,
+          base_url: String,
+          headers: ::Hash[Symbol, String],
+          provider: Stagehand::Models::ModelConfig::GenericModelConfigObject::provider
+        }
+
+        type provider = :openai | :anthropic | :google | :microsoft | :bedrock
+
+        module Provider
+          extend Stagehand::Internal::Type::Enum
+
+          OPENAI: :openai
+          ANTHROPIC: :anthropic
+          GOOGLE: :google
+          MICROSOFT: :microsoft
+          BEDROCK: :bedrock
+
+          def self?.values: -> ::Array[Stagehand::Models::ModelConfig::GenericModelConfigObject::provider]
+        end
+      end
+
+      def self?.variants: -> ::Array[Stagehand::Models::model_config]
     end
   end
 end