x-twitter-scraper 0.7.2 → 0.9.0

data/rbi/x_twitter_scraper/models/extraction_run_response.rbi

@@ -15,188 +15,61 @@ module XTwitterScraper
           )
         end
 
+      sig { returns(T::Boolean) }
+      attr_accessor :allowed
+
       sig { returns(String) }
-      attr_accessor :id
+      attr_accessor :credits_available
 
-      sig { returns(Symbol) }
-      attr_accessor :status
+      sig { returns(String) }
+      attr_accessor :credits_required
 
-      # Identifier for the extraction tool used to run a job.
-      sig do
-        returns(
-          XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-        )
-      end
-      attr_accessor :tool_type
+      sig { returns(Integer) }
+      attr_accessor :estimated_results
+
+      sig { returns(String) }
+      attr_accessor :source
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :resolved_x_user_id
+
+      sig { params(resolved_x_user_id: String).void }
+      attr_writer :resolved_x_user_id
 
       sig do
         params(
-          id: String,
-          tool_type:
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::OrSymbol,
-          status: Symbol
+          allowed: T::Boolean,
+          credits_available: String,
+          credits_required: String,
+          estimated_results: Integer,
+          source: String,
+          resolved_x_user_id: String
         ).returns(T.attached_class)
       end
       def self.new(
-        id:,
-        # Identifier for the extraction tool used to run a job.
-        tool_type:,
-        status: :running
+        allowed:,
+        credits_available:,
+        credits_required:,
+        estimated_results:,
+        source:,
+        resolved_x_user_id: nil
       )
       end
 
       sig do
         override.returns(
           {
-            id: String,
-            status: Symbol,
-            tool_type:
-              XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
+            allowed: T::Boolean,
+            credits_available: String,
+            credits_required: String,
+            estimated_results: Integer,
+            source: String,
+            resolved_x_user_id: String
           }
         )
       end
       def to_hash
       end
-
-      # Identifier for the extraction tool used to run a job.
-      module ToolType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              XTwitterScraper::Models::ExtractionRunResponse::ToolType
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ARTICLE_EXTRACTOR =
-          T.let(
-            :article_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        COMMUNITY_EXTRACTOR =
-          T.let(
-            :community_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        COMMUNITY_MODERATOR_EXPLORER =
-          T.let(
-            :community_moderator_explorer,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        COMMUNITY_POST_EXTRACTOR =
-          T.let(
-            :community_post_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        COMMUNITY_SEARCH =
-          T.let(
-            :community_search,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        FAVORITERS =
-          T.let(
-            :favoriters,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        FOLLOWER_EXPLORER =
-          T.let(
-            :follower_explorer,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        FOLLOWING_EXPLORER =
-          T.let(
-            :following_explorer,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        LIST_FOLLOWER_EXPLORER =
-          T.let(
-            :list_follower_explorer,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        LIST_MEMBER_EXTRACTOR =
-          T.let(
-            :list_member_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        LIST_POST_EXTRACTOR =
-          T.let(
-            :list_post_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        MENTION_EXTRACTOR =
-          T.let(
-            :mention_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        PEOPLE_SEARCH =
-          T.let(
-            :people_search,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        POST_EXTRACTOR =
-          T.let(
-            :post_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        QUOTE_EXTRACTOR =
-          T.let(
-            :quote_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        REPLY_EXTRACTOR =
-          T.let(
-            :reply_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        REPOST_EXTRACTOR =
-          T.let(
-            :repost_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        SPACE_EXPLORER =
-          T.let(
-            :space_explorer,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        THREAD_EXTRACTOR =
-          T.let(
-            :thread_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        TWEET_SEARCH_EXTRACTOR =
-          T.let(
-            :tweet_search_extractor,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        USER_LIKES =
-          T.let(
-            :user_likes,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        USER_MEDIA =
-          T.let(
-            :user_media,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-        VERIFIED_FOLLOWER_EXPLORER =
-          T.let(
-            :verified_follower_explorer,
-            XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              XTwitterScraper::Models::ExtractionRunResponse::ToolType::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/guest_wallet_create_response.rbi

@@ -45,7 +45,7 @@ module XTwitterScraper
       end
       attr_writer :authorization
 
-      # Raw Stripe-hosted checkout URL for user interaction.
+      # Hosted checkout URL for user interaction.
       sig { returns(String) }
       attr_accessor :checkout_url
 
@@ -60,7 +60,8 @@ module XTwitterScraper
       sig { returns(Time) }
       attr_accessor :expires_at
 
-      sig { returns(Symbol) }
+      # Hosted checkout and status polling instructions.
+      sig { returns(String) }
       attr_accessor :instructions
 
       # Wait at least this long before polling status_url.
@@ -96,13 +97,13 @@ module XTwitterScraper
           checkout_url: String,
           credits: String,
           expires_at: Time,
+          instructions: String,
           purchase_id: String,
           status:
             XTwitterScraper::Models::GuestWalletCreateResponse::Status::OrSymbol,
           wallet_id: String,
           account_required: T::Boolean,
           credential_notice: Symbol,
-          instructions: Symbol,
           poll_after_seconds: Integer,
           requires_user_interaction: T::Boolean,
           status_url: Symbol
@@ -115,18 +116,19 @@ module XTwitterScraper
         # secret. Never place it in a URL or log.
         api_key:,
         authorization:,
-        # Raw Stripe-hosted checkout URL for user interaction.
+        # Hosted checkout URL for user interaction.
         checkout_url:,
         # Credits granted after verified payment.
         credits:,
         # Time when the pending checkout expires.
         expires_at:,
+        # Hosted checkout and status polling instructions.
+        instructions:,
         purchase_id:,
         status:,
         wallet_id:,
         account_required: false,
         credential_notice: :"Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available.",
-        instructions: :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.",
         # Wait at least this long before polling status_url.
         poll_after_seconds: 2,
         requires_user_interaction: true,
@@ -146,7 +148,7 @@ module XTwitterScraper
             credential_notice: Symbol,
             credits: String,
             expires_at: Time,
-            instructions: Symbol,
+            instructions: String,
             poll_after_seconds: Integer,
             purchase_id: String,
             requires_user_interaction: T::Boolean,

data/rbi/x_twitter_scraper/models/guest_wallet_topup_response.rbi

@@ -25,7 +25,7 @@ module XTwitterScraper
       sig { params(amount: XTwitterScraper::GuestWalletAmount::OrHash).void }
       attr_writer :amount
 
-      # Raw Stripe-hosted checkout URL for user interaction.
+      # Hosted checkout URL for user interaction.
       sig { returns(String) }
       attr_accessor :checkout_url
 
@@ -37,7 +37,8 @@ module XTwitterScraper
       sig { returns(Time) }
       attr_accessor :expires_at
 
-      sig { returns(Symbol) }
+      # Hosted checkout and status polling instructions.
+      sig { returns(String) }
       attr_accessor :instructions
 
       # Wait at least this long before polling status_url.
@@ -105,13 +106,14 @@ module XTwitterScraper
       end
       attr_writer :credential_notice
 
-      # Pending Stripe checkout and guest wallet purchase details.
+      # Pending hosted checkout and guest wallet purchase details.
       sig do
         params(
           amount: XTwitterScraper::GuestWalletAmount::OrHash,
           checkout_url: String,
           credits: String,
           expires_at: Time,
+          instructions: String,
           purchase_id: String,
           status:
             XTwitterScraper::Models::GuestWalletTopupResponse::Status::OrSymbol,
@@ -122,7 +124,6 @@ module XTwitterScraper
           credential_notice:
             XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice::OrSymbol,
           account_required: T::Boolean,
-          instructions: Symbol,
           poll_after_seconds: Integer,
           requires_user_interaction: T::Boolean,
           status_url: Symbol
@@ -131,12 +132,14 @@ module XTwitterScraper
       def self.new(
         # Confirmed USD amount for a guest wallet purchase.
         amount:,
-        # Raw Stripe-hosted checkout URL for user interaction.
+        # Hosted checkout URL for user interaction.
         checkout_url:,
         # Credits granted after verified payment.
         credits:,
         # Time when the pending checkout expires.
         expires_at:,
+        # Hosted checkout and status polling instructions.
+        instructions:,
         purchase_id:,
         status:,
         wallet_id:,
@@ -146,7 +149,6 @@ module XTwitterScraper
         authorization: nil,
         credential_notice: nil,
         account_required: false,
-        instructions: :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.",
         # Wait at least this long before polling status_url.
         poll_after_seconds: 2,
         requires_user_interaction: true,
@@ -162,7 +164,7 @@ module XTwitterScraper
             checkout_url: String,
             credits: String,
             expires_at: Time,
-            instructions: Symbol,
+            instructions: String,
             poll_after_seconds: Integer,
             purchase_id: String,
             requires_user_interaction: T::Boolean,

data/rbi/x_twitter_scraper/models/monitor.rbi

@@ -35,6 +35,26 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :x_user_id
 
+      # When Xquik automatically paused this monitor.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :paused_at
+
+      sig { params(paused_at: Time).void }
+      attr_writer :paused_at
+
+      # Why Xquik automatically paused this monitor.
+      sig do
+        returns(T.nilable(XTwitterScraper::Monitor::PausedReason::TaggedSymbol))
+      end
+      attr_reader :paused_reason
+
+      sig do
+        params(
+          paused_reason: XTwitterScraper::Monitor::PausedReason::OrSymbol
+        ).void
+      end
+      attr_writer :paused_reason
+
       # Account monitor that tracks activity for a given X user.
       sig do
         params(
@@ -44,7 +64,9 @@ module XTwitterScraper
           is_active: T::Boolean,
           next_billing_at: Time,
           username: String,
-          x_user_id: String
+          x_user_id: String,
+          paused_at: Time,
+          paused_reason: XTwitterScraper::Monitor::PausedReason::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -56,7 +78,11 @@ module XTwitterScraper
         # Next hourly credit charge time for this account monitor.
         next_billing_at:,
         username:,
-        x_user_id:
+        x_user_id:,
+        # When Xquik automatically paused this monitor.
+        paused_at: nil,
+        # Why Xquik automatically paused this monitor.
+        paused_reason: nil
       )
       end
 
@@ -69,12 +95,37 @@ module XTwitterScraper
             is_active: T::Boolean,
             next_billing_at: Time,
             username: String,
-            x_user_id: String
+            x_user_id: String,
+            paused_at: Time,
+            paused_reason: XTwitterScraper::Monitor::PausedReason::TaggedSymbol
           }
         )
       end
       def to_hash
       end
+
+      # Why Xquik automatically paused this monitor.
+      module PausedReason
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, XTwitterScraper::Monitor::PausedReason) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        X_USER_NOT_FOUND =
+          T.let(
+            :x_user_not_found,
+            XTwitterScraper::Monitor::PausedReason::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[XTwitterScraper::Monitor::PausedReason::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/paginated_tweets.rbi

@@ -24,10 +24,10 @@ module XTwitterScraper
       sig { returns(T::Array[XTwitterScraper::SearchTweet]) }
       attr_accessor :tweets
 
-      # Paginated tweets. Source visibility, filters, or remaining credits can reduce
-      # results. An empty filtered page can still have has_next_page true. Follow
-      # next_cursor while has_next_page is true. Zero affordable results returns 402
-      # insufficient_credits.
+      # No-mode search, user Tweet, user reply, and direct reply reads use automatic
+      # coverage. Shape, filters, aliases, and billing stay compatible. Unprefixed
+      # cursors remain legacy. Follow next_cursor while has_next_page is true. An empty
+      # filtered page can still have has_next_page true.
       sig do
         params(
           has_next_page: T::Boolean,

data/rbi/x_twitter_scraper/models/paginated_users.rbi

@@ -24,11 +24,11 @@ module XTwitterScraper
       sig { returns(T::Array[XTwitterScraper::UserProfile]) }
       attr_accessor :users
 
-      # Paginated user profiles. The item count can be lower than pageSize when the
-      # source returns fewer profiles or remaining credits cover fewer results. Follow
-      # next_cursor while has_next_page is true. A relationship can naturally contain
-      # fewer profiles than requested. Zero affordable results returns 402
-      # insufficient_credits.
+      # Paginated user profiles. No-mode follower, following, and verified follower
+      # requests merge independent views automatically. Response fields, page size,
+      # aliases, filters, and per-returned-profile billing stay unchanged. Existing
+      # unprefixed cursors retain legacy behavior. Follow next_cursor while
+      # has_next_page is true.
       sig do
         params(
           has_next_page: T::Boolean,

data/rbi/x_twitter_scraper/models/support/attachment_download_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Support
+      class AttachmentDownloadParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Support::AttachmentDownloadParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :range
+
+        sig { params(range: String).void }
+        attr_writer :range
+
+        sig do
+          params(
+            id: String,
+            range: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, range: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              range: String,
+              request_options: XTwitterScraper::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end