x-twitter-scraper 0.4.5 → 0.5.2

data/rbi/x_twitter_scraper/models/error.rbi

@@ -18,6 +18,34 @@ module XTwitterScraper
       end
       attr_accessor :error
 
+      # Human-readable error guidance.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      # Machine-readable reason for a login cooldown.
+      sig { returns(T.nilable(String)) }
+      attr_reader :reason
+
+      sig { params(reason: String).void }
+      attr_writer :reason
+
+      # Seconds until the next permitted request.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :retry_after
+
+      sig { params(retry_after: Integer).void }
+      attr_writer :retry_after
+
+      # Required wait in milliseconds.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :retry_after_ms
+
+      sig { params(retry_after_ms: Integer).void }
+      attr_writer :retry_after_ms
+
       # Error response. Default v1 returns a legacy string error code. Send
       # `xquik-api-contract: 2026-04-29` to receive the structured best-practice error
       # object.
@@ -27,10 +55,24 @@ module XTwitterScraper
             T.any(
               XTwitterScraper::Error::Error::LegacyErrorCode::OrSymbol,
               XTwitterScraper::Error::Error::StructuredError::OrHash
-            )
+            ),
+          message: String,
+          reason: String,
+          retry_after: Integer,
+          retry_after_ms: Integer
         ).returns(T.attached_class)
       end
-      def self.new(error:)
+      def self.new(
+        error:,
+        # Human-readable error guidance.
+        message: nil,
+        # Machine-readable reason for a login cooldown.
+        reason: nil,
+        # Seconds until the next permitted request.
+        retry_after: nil,
+        # Required wait in milliseconds.
+        retry_after_ms: nil
+      )
       end
 
       sig do
@@ -40,7 +82,11 @@ module XTwitterScraper
               T.any(
                 XTwitterScraper::Error::Error::LegacyErrorCode::OrSymbol,
                 XTwitterScraper::Error::Error::StructuredError
-              )
+              ),
+            message: String,
+            reason: String,
+            retry_after: Integer,
+            retry_after_ms: Integer
           }
         )
       end
@@ -267,6 +313,171 @@ module XTwitterScraper
               :user_not_found,
               XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
             )
+          BODY_TOO_LARGE =
+            T.let(
+              :body_too_large,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          CHECKOUT_UNAVAILABLE =
+            T.let(
+              :checkout_unavailable,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          CONNECTION_CHALLENGE_EXPIRED =
+            T.let(
+              :connection_challenge_expired,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          CONNECTION_CHALLENGE_INACTIVE =
+            T.let(
+              :connection_challenge_inactive,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          DRAFT_NOT_FOUND =
+            T.let(
+              :draft_not_found,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          FAVORITERS_UNAVAILABLE =
+            T.let(
+              :favoriters_unavailable,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          FORBIDDEN =
+            T.let(
+              :forbidden,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          GUEST_WALLET_UNAVAILABLE =
+            T.let(
+              :guest_wallet_unavailable,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          GUEST_WALLETS_DISABLED =
+            T.let(
+              :guest_wallets_disabled,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          GUEST_WALLETS_UNAVAILABLE =
+            T.let(
+              :guest_wallets_unavailable,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          IDEMPOTENCY_CONFLICT =
+            T.let(
+              :idempotency_conflict,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          IDEMPOTENCY_KEY_CONFLICT =
+            T.let(
+              :idempotency_key_conflict,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          INVALID_COMMUNITY_ID =
+            T.let(
+              :invalid_community_id,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          INVALID_IDEMPOTENCY_KEY =
+            T.let(
+              :invalid_idempotency_key,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          INVALID_LIST_ID =
+            T.let(
+              :invalid_list_id,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          INVALID_PAYMENT_AMOUNT =
+            T.let(
+              :invalid_payment_amount,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          INVALID_RANGE =
+            T.let(
+              :invalid_range,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          LOGIN_RATE_LIMITED =
+            T.let(
+              :login_rate_limited,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          MISSING_IDEMPOTENCY_KEY =
+            T.let(
+              :missing_idempotency_key,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          MISSING_IDS =
+            T.let(
+              :missing_ids,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          NO_CACHED_STYLE =
+            T.let(
+              :no_cached_style,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          PASSKEY_REQUIRED =
+            T.let(
+              :passkey_required,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          RATE_LIMITED =
+            T.let(
+              :rate_limited,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          READ_REQUEST_TIMEOUT =
+            T.let(
+              :read_request_timeout,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          REPLIES_INCOMPLETE =
+            T.let(
+              :replies_incomplete,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          SUPPORT_MEDIA_RATE_LIMIT =
+            T.let(
+              :support_media_rate_limit,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          SUPPORT_REQUEST_RATE_LIMIT =
+            T.let(
+              :support_request_rate_limit,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          TOO_MANY_IDS =
+            T.let(
+              :too_many_ids,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          UNKNOWN_FIELD =
+            T.let(
+              :unknown_field,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          UNSUPPORTED_MEDIA_TYPE =
+            T.let(
+              :unsupported_media_type,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          WEBHOOK_INACTIVE =
+            T.let(
+              :webhook_inactive,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          WRITE_TRACKING_UNAVAILABLE =
+            T.let(
+              :write_tracking_unavailable,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
+          X_WRITE_UNCONFIRMED =
+            T.let(
+              :x_write_unconfirmed,
+              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
+            )
           X_ACCOUNT_FEATURE_REQUIRED =
             T.let(
               :x_account_feature_required,
@@ -397,11 +608,6 @@ module XTwitterScraper
               :x_write_failed,
               XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
             )
-          X_WRITE_UNCONFIRMED =
-            T.let(
-              :x_write_unconfirmed,
-              XTwitterScraper::Error::Error::LegacyErrorCode::TaggedSymbol
-            )
 
           sig do
             override.returns(
@@ -678,6 +884,171 @@ module XTwitterScraper
                 :user_not_found,
                 XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
               )
+            BODY_TOO_LARGE =
+              T.let(
+                :body_too_large,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            CHECKOUT_UNAVAILABLE =
+              T.let(
+                :checkout_unavailable,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            CONNECTION_CHALLENGE_EXPIRED =
+              T.let(
+                :connection_challenge_expired,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            CONNECTION_CHALLENGE_INACTIVE =
+              T.let(
+                :connection_challenge_inactive,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            DRAFT_NOT_FOUND =
+              T.let(
+                :draft_not_found,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            FAVORITERS_UNAVAILABLE =
+              T.let(
+                :favoriters_unavailable,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            FORBIDDEN =
+              T.let(
+                :forbidden,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            GUEST_WALLET_UNAVAILABLE =
+              T.let(
+                :guest_wallet_unavailable,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            GUEST_WALLETS_DISABLED =
+              T.let(
+                :guest_wallets_disabled,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            GUEST_WALLETS_UNAVAILABLE =
+              T.let(
+                :guest_wallets_unavailable,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            IDEMPOTENCY_CONFLICT =
+              T.let(
+                :idempotency_conflict,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            IDEMPOTENCY_KEY_CONFLICT =
+              T.let(
+                :idempotency_key_conflict,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            INVALID_COMMUNITY_ID =
+              T.let(
+                :invalid_community_id,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            INVALID_IDEMPOTENCY_KEY =
+              T.let(
+                :invalid_idempotency_key,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            INVALID_LIST_ID =
+              T.let(
+                :invalid_list_id,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            INVALID_PAYMENT_AMOUNT =
+              T.let(
+                :invalid_payment_amount,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            INVALID_RANGE =
+              T.let(
+                :invalid_range,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            LOGIN_RATE_LIMITED =
+              T.let(
+                :login_rate_limited,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            MISSING_IDEMPOTENCY_KEY =
+              T.let(
+                :missing_idempotency_key,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            MISSING_IDS =
+              T.let(
+                :missing_ids,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            NO_CACHED_STYLE =
+              T.let(
+                :no_cached_style,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            PASSKEY_REQUIRED =
+              T.let(
+                :passkey_required,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            RATE_LIMITED =
+              T.let(
+                :rate_limited,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            READ_REQUEST_TIMEOUT =
+              T.let(
+                :read_request_timeout,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            REPLIES_INCOMPLETE =
+              T.let(
+                :replies_incomplete,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            SUPPORT_MEDIA_RATE_LIMIT =
+              T.let(
+                :support_media_rate_limit,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            SUPPORT_REQUEST_RATE_LIMIT =
+              T.let(
+                :support_request_rate_limit,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            TOO_MANY_IDS =
+              T.let(
+                :too_many_ids,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            UNKNOWN_FIELD =
+              T.let(
+                :unknown_field,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            UNSUPPORTED_MEDIA_TYPE =
+              T.let(
+                :unsupported_media_type,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            WEBHOOK_INACTIVE =
+              T.let(
+                :webhook_inactive,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            WRITE_TRACKING_UNAVAILABLE =
+              T.let(
+                :write_tracking_unavailable,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
+            X_WRITE_UNCONFIRMED =
+              T.let(
+                :x_write_unconfirmed,
+                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
+              )
             X_ACCOUNT_FEATURE_REQUIRED =
               T.let(
                 :x_account_feature_required,
@@ -808,11 +1179,6 @@ module XTwitterScraper
                 :x_write_failed,
                 XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
               )
-            X_WRITE_UNCONFIRMED =
-              T.let(
-                :x_write_unconfirmed,
-                XTwitterScraper::Error::Error::StructuredError::Code::TaggedSymbol
-              )
 
             sig do
               override.returns(

data/rbi/x_twitter_scraper/models/extraction_estimate_cost_params.rbi

@@ -260,7 +260,7 @@ module XTwitterScraper
       sig { params(retweets_of_tweet_id: String).void }
       attr_writer :retweets_of_tweet_id
 
-      # Required for tweet_search_extractor & community_search.
+      # Query used to price tweet_search_extractor or community_search.
       sig { returns(T.nilable(String)) }
       attr_reader :search_query
 
@@ -274,14 +274,14 @@ module XTwitterScraper
       sig { params(since_date: Date).void }
       attr_writer :since_date
 
-      # Required for community_post_extractor & community_search.
+      # Community ID used to price community_post_extractor or community_search.
       sig { returns(T.nilable(String)) }
       attr_reader :target_community_id
 
       sig { params(target_community_id: String).void }
       attr_writer :target_community_id
 
-      # Required for list_follower_explorer, list_member_extractor &
+      # List ID used to price list_follower_explorer, list_member_extractor, or
       # list_post_extractor.
       sig { returns(T.nilable(String)) }
       attr_reader :target_list_id
@@ -289,7 +289,7 @@ module XTwitterScraper
       sig { params(target_list_id: String).void }
       attr_writer :target_list_id
 
-      # Required for space_explorer.
+      # Space ID used to price space_explorer.
       sig { returns(T.nilable(String)) }
       attr_reader :target_space_id
 
@@ -447,16 +447,16 @@ module XTwitterScraper
         retweets: nil,
         # Estimate only retweets of this tweet ID (tweet_search_extractor)
         retweets_of_tweet_id: nil,
-        # Required for tweet_search_extractor & community_search.
+        # Query used to price tweet_search_extractor or community_search.
         search_query: nil,
         # Estimate start date in YYYY-MM-DD format (tweet_search_extractor)
         since_date: nil,
-        # Required for community_post_extractor & community_search.
+        # Community ID used to price community_post_extractor or community_search.
         target_community_id: nil,
-        # Required for list_follower_explorer, list_member_extractor &
+        # List ID used to price list_follower_explorer, list_member_extractor, or
         # list_post_extractor.
         target_list_id: nil,
-        # Required for space_explorer.
+        # Space ID used to price space_explorer.
         target_space_id: nil,
         target_tweet_id: nil,
         target_username: nil,

data/rbi/x_twitter_scraper/models/guest_wallet_create_params.rbi

@@ -14,7 +14,7 @@ module XTwitterScraper
           )
         end
 
-      # Confirmed USD amount in cents.
+      # USD cents accepted for this checkout.
       sig { returns(Integer) }
       attr_accessor :amount_minor
 
@@ -33,7 +33,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Confirmed USD amount in cents.
+        # USD cents accepted for this checkout.
         amount_minor:,
         idempotency_key:,
         currency: :usd,

data/rbi/x_twitter_scraper/models/guest_wallet_create_response.rbi

@@ -165,19 +165,101 @@ module XTwitterScraper
             )
           end
 
-        sig { returns(Symbol) }
+        sig do
+          returns(
+            XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Header::TaggedSymbol
+          )
+        end
         attr_accessor :header
 
-        sig { returns(Symbol) }
+        sig do
+          returns(
+            XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Scheme::TaggedSymbol
+          )
+        end
         attr_accessor :scheme
 
-        sig { params(header: Symbol, scheme: Symbol).returns(T.attached_class) }
-        def self.new(header: :Authorization, scheme: :Bearer)
+        sig do
+          params(
+            header:
+              XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Header::OrSymbol,
+            scheme:
+              XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Scheme::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(header:, scheme:)
         end
 
-        sig { override.returns({ header: Symbol, scheme: Symbol }) }
+        sig do
+          override.returns(
+            {
+              header:
+                XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Header::TaggedSymbol,
+              scheme:
+                XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Scheme::TaggedSymbol
+            }
+          )
+        end
         def to_hash
         end
+
+        module Header
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Header
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTHORIZATION =
+            T.let(
+              :Authorization,
+              XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Header::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Header::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Scheme
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Scheme
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BEARER =
+            T.let(
+              :Bearer,
+              XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Scheme::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::Models::GuestWalletCreateResponse::Authorization::Scheme::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       module Status

data/rbi/x_twitter_scraper/models/guest_wallet_topup_params.rbi

@@ -14,7 +14,7 @@ module XTwitterScraper
           )
         end
 
-      # Confirmed USD amount in cents.
+      # USD cents accepted for this checkout.
       sig { returns(Integer) }
       attr_accessor :amount_minor
 
@@ -33,7 +33,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Confirmed USD amount in cents.
+        # USD cents accepted for this checkout.
         amount_minor:,
         idempotency_key:,
         currency: :usd,