x-twitter-scraper 0.7.2 → 0.9.0

data/rbi/x_twitter_scraper/models/x/tweet_search_params.rbi

@@ -19,7 +19,7 @@ module XTwitterScraper
             )
           end
 
-        # Search query (keywords,
+        # Query, Tweet ID, or status URL. Valid inline bounds apply per page.
         sig { returns(String) }
         attr_accessor :q
 
@@ -38,6 +38,13 @@ module XTwitterScraper
         sig { params(any_words: String).void }
         attr_writer :any_words
 
+        # Only return tweets from Blue-verified authors.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :blue_verified_only
+
+        sig { params(blue_verified_only: T::Boolean).void }
+        attr_writer :blue_verified_only
+
         # Geo bounding box, e.g. -74.1 40.6 -73.9 40.8.
         sig { returns(T.nilable(String)) }
         attr_reader :bounding_box
@@ -45,6 +52,13 @@ module XTwitterScraper
         sig { params(bounding_box: String).void }
         attr_writer :bounding_box
 
+        # Match the Tweet card name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :card_name
+
+        sig { params(card_name: String).void }
+        attr_writer :card_name
+
         # Cashtags separated by spaces, commas, or lines.
         sig { returns(T.nilable(String)) }
         attr_reader :cashtags
@@ -59,7 +73,8 @@ module XTwitterScraper
         sig { params(conversation_id: String).void }
         attr_writer :conversation_id
 
-        # Pagination cursor from previous response
+        # Cursor from the previous response. Xquik cursors resume automatic coverage.
+        # Existing unprefixed cursors keep legacy standard behavior.
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -73,6 +88,13 @@ module XTwitterScraper
         sig { params(exact_phrase: String).void }
         attr_writer :exact_phrase
 
+        # Exclude a source application.
+        sig { returns(T.nilable(String)) }
+        attr_reader :exclude_source
+
+        sig { params(exclude_source: String).void }
+        attr_writer :exclude_source
+
         # Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
         sig { returns(T.nilable(String)) }
         attr_reader :exclude_words
@@ -87,6 +109,13 @@ module XTwitterScraper
         sig { params(from_user: String).void }
         attr_writer :from_user
 
+        # Match latitude, longitude, and radius.
+        sig { returns(T.nilable(String)) }
+        attr_reader :geocode
+
+        sig { params(geocode: String).void }
+        attr_writer :geocode
+
         # Hashtags separated by spaces, commas, or lines.
         sig { returns(T.nilable(String)) }
         attr_reader :hashtags
@@ -108,10 +137,9 @@ module XTwitterScraper
         sig { params(language: String).void }
         attr_writer :language
 
-        # Max tweets to return (server paginates internally). Omit for single page (~20).
-        # This is an upper bound for paid authenticated calls: remaining credits can
-        # reduce the returned page size, and zero affordable results returns 402
-        # insufficient_credits.
+        # Result upper bound. Omit it for the existing 20-row page size. Explicit coverage
+        # defaults to 2000 and allows 10000. For paid requests, remaining credits can
+        # reduce results. Zero affordable results returns 402.
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
@@ -125,6 +153,41 @@ module XTwitterScraper
         sig { params(list_id: String).void }
         attr_writer :list_id
 
+        # Maximum likes threshold. maxLikes is also accepted.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_faves
+
+        sig { params(max_faves: Integer).void }
+        attr_writer :max_faves
+
+        # Return Tweets older than this Tweet ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :max_id
+
+        sig { params(max_id: String).void }
+        attr_writer :max_id
+
+        # Maximum quotes threshold.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_quotes
+
+        sig { params(max_quotes: Integer).void }
+        attr_writer :max_quotes
+
+        # Maximum replies threshold.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_replies
+
+        sig { params(max_replies: Integer).void }
+        attr_writer :max_replies
+
+        # Maximum retweets threshold.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_retweets
+
+        sig { params(max_retweets: Integer).void }
+        attr_writer :max_retweets
+
         # Filter by media type.
         sig do
           returns(
@@ -150,6 +213,13 @@ module XTwitterScraper
         sig { params(mentioning: String).void }
         attr_writer :mentioning
 
+        # Minimum bookmark count threshold.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_bookmarks
+
+        sig { params(min_bookmarks: Integer).void }
+        attr_writer :min_bookmarks
+
         # Minimum likes threshold.
         sig { returns(T.nilable(Integer)) }
         attr_reader :min_faves
@@ -178,6 +248,50 @@ module XTwitterScraper
         sig { params(min_retweets: Integer).void }
         attr_writer :min_retweets
 
+        # Minimum view count threshold.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_views
+
+        sig { params(min_views: Integer).void }
+        attr_writer :min_views
+
+        # Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
+        # Coverage returns diagnostics once and rejects cursors.
+        sig do
+          returns(
+            T.nilable(XTwitterScraper::X::TweetSearchParams::Mode::OrSymbol)
+          )
+        end
+        attr_reader :mode
+
+        sig do
+          params(
+            mode: XTwitterScraper::X::TweetSearchParams::Mode::OrSymbol
+          ).void
+        end
+        attr_writer :mode
+
+        # Only return native reposts.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :native_retweets
+
+        sig { params(native_retweets: T::Boolean).void }
+        attr_writer :native_retweets
+
+        # Match a place name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :near
+
+        sig { params(near: String).void }
+        attr_writer :near
+
+        # Only return news results.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :news
+
+        sig { params(news: T::Boolean).void }
+        attr_writer :news
+
         # Search within a place ID.
         sig { returns(T.nilable(String)) }
         attr_reader :place
@@ -276,6 +390,13 @@ module XTwitterScraper
         sig { params(retweets_of_tweet_id: String).void }
         attr_writer :retweets_of_tweet_id
 
+        # Enable the safe-search filter.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :safe
+
+        sig { params(safe: T::Boolean).void }
+        attr_writer :safe
+
         # Start date in YYYY-MM-DD format.
         sig { returns(T.nilable(Date)) }
         attr_reader :since_date
@@ -283,13 +404,27 @@ module XTwitterScraper
         sig { params(since_date: Date).void }
         attr_writer :since_date
 
-        # ISO 8601 timestamp - only return tweets after this time
+        # Return Tweets newer than this Tweet ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :since_id
+
+        sig { params(since_id: String).void }
+        attr_writer :since_id
+
+        # Inclusive ISO bound.
         sig { returns(T.nilable(String)) }
         attr_reader :since_time
 
         sig { params(since_time: String).void }
         attr_writer :since_time
 
+        # Match the source application.
+        sig { returns(T.nilable(String)) }
+        attr_reader :source
+
+        sig { params(source: String).void }
+        attr_writer :source
+
         # Filter replies sent to a username.
         sig { returns(T.nilable(String)) }
         attr_reader :to_user
@@ -304,7 +439,7 @@ module XTwitterScraper
         sig { params(until_date: Date).void }
         attr_writer :until_date
 
-        # ISO 8601 timestamp - only return tweets before this time
+        # Exclusive ISO bound.
         sig { returns(T.nilable(String)) }
         attr_reader :until_time
 
@@ -325,30 +460,59 @@ module XTwitterScraper
         sig { params(verified_only: T::Boolean).void }
         attr_writer :verified_only
 
+        # Set the radius for the near filter.
+        sig { returns(T.nilable(String)) }
+        attr_reader :within
+
+        sig { params(within: String).void }
+        attr_writer :within
+
+        # Match Tweets inside a recent time window.
+        sig { returns(T.nilable(String)) }
+        attr_reader :within_time
+
+        sig { params(within_time: String).void }
+        attr_writer :within_time
+
         sig do
           params(
             q: String,
             advanced_query: String,
             any_words: String,
+            blue_verified_only: T::Boolean,
             bounding_box: String,
+            card_name: String,
             cashtags: String,
             conversation_id: String,
             cursor: String,
             exact_phrase: String,
+            exclude_source: String,
             exclude_words: String,
             from_user: String,
+            geocode: String,
             hashtags: String,
             in_reply_to_tweet_id: String,
             language: String,
             limit: Integer,
             list_id: String,
+            max_faves: Integer,
+            max_id: String,
+            max_quotes: Integer,
+            max_replies: Integer,
+            max_retweets: Integer,
             media_type:
               XTwitterScraper::X::TweetSearchParams::MediaType::OrSymbol,
             mentioning: String,
+            min_bookmarks: Integer,
             min_faves: Integer,
             min_quotes: Integer,
             min_replies: Integer,
             min_retweets: Integer,
+            min_views: Integer,
+            mode: XTwitterScraper::X::TweetSearchParams::Mode::OrSymbol,
+            native_retweets: T::Boolean,
+            near: String,
+            news: T::Boolean,
             place: String,
             place_country: String,
             point_radius: String,
@@ -359,55 +523,80 @@ module XTwitterScraper
             replies: XTwitterScraper::X::TweetSearchParams::Replies::OrSymbol,
             retweets: XTwitterScraper::X::TweetSearchParams::Retweets::OrSymbol,
             retweets_of_tweet_id: String,
+            safe: T::Boolean,
             since_date: Date,
+            since_id: String,
             since_time: String,
+            source: String,
             to_user: String,
             until_date: Date,
             until_time: String,
             url: String,
             verified_only: T::Boolean,
+            within: String,
+            within_time: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # Search query (keywords,
+          # Query, Tweet ID, or status URL. Valid inline bounds apply per page.
           q:,
           # Raw advanced search query appended as-is.
           advanced_query: nil,
           # Words or quoted phrases where any one can match. Separate with spaces, commas,
           # or lines.
           any_words: nil,
+          # Only return tweets from Blue-verified authors.
+          blue_verified_only: nil,
           # Geo bounding box, e.g. -74.1 40.6 -73.9 40.8.
           bounding_box: nil,
+          # Match the Tweet card name.
+          card_name: nil,
           # Cashtags separated by spaces, commas, or lines.
           cashtags: nil,
           # Conversation ID filter.
           conversation_id: nil,
-          # Pagination cursor from previous response
+          # Cursor from the previous response. Xquik cursors resume automatic coverage.
+          # Existing unprefixed cursors keep legacy standard behavior.
           cursor: nil,
           # Exact phrase to match.
           exact_phrase: nil,
+          # Exclude a source application.
+          exclude_source: nil,
           # Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
           exclude_words: nil,
           # Filter by author username.
           from_user: nil,
+          # Match latitude, longitude, and radius.
+          geocode: nil,
           # Hashtags separated by spaces, commas, or lines.
           hashtags: nil,
           # Only replies to this tweet ID.
           in_reply_to_tweet_id: nil,
           # Language code filter, e.g. en or tr.
           language: nil,
-          # Max tweets to return (server paginates internally). Omit for single page (~20).
-          # This is an upper bound for paid authenticated calls: remaining credits can
-          # reduce the returned page size, and zero affordable results returns 402
-          # insufficient_credits.
+          # Result upper bound. Omit it for the existing 20-row page size. Explicit coverage
+          # defaults to 2000 and allows 10000. For paid requests, remaining credits can
+          # reduce results. Zero affordable results returns 402.
           limit: nil,
           # Search within a list ID.
           list_id: nil,
+          # Maximum likes threshold. maxLikes is also accepted.
+          max_faves: nil,
+          # Return Tweets older than this Tweet ID.
+          max_id: nil,
+          # Maximum quotes threshold.
+          max_quotes: nil,
+          # Maximum replies threshold.
+          max_replies: nil,
+          # Maximum retweets threshold.
+          max_retweets: nil,
           # Filter by media type.
           media_type: nil,
           # Filter tweets mentioning a username.
           mentioning: nil,
+          # Minimum bookmark count threshold.
+          min_bookmarks: nil,
           # Minimum likes threshold.
           min_faves: nil,
           # Minimum quote count threshold.
@@ -416,6 +605,17 @@ module XTwitterScraper
           min_replies: nil,
           # Minimum retweets threshold.
           min_retweets: nil,
+          # Minimum view count threshold.
+          min_views: nil,
+          # Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
+          # Coverage returns diagnostics once and rejects cursors.
+          mode: nil,
+          # Only return native reposts.
+          native_retweets: nil,
+          # Match a place name.
+          near: nil,
+          # Only return news results.
+          news: nil,
           # Search within a place ID.
           place: nil,
           # Search within a country code.
@@ -434,20 +634,30 @@ module XTwitterScraper
           retweets: nil,
           # Only retweets of this tweet ID.
           retweets_of_tweet_id: nil,
+          # Enable the safe-search filter.
+          safe: nil,
           # Start date in YYYY-MM-DD format.
           since_date: nil,
-          # ISO 8601 timestamp - only return tweets after this time
+          # Return Tweets newer than this Tweet ID.
+          since_id: nil,
+          # Inclusive ISO bound.
           since_time: nil,
+          # Match the source application.
+          source: nil,
           # Filter replies sent to a username.
           to_user: nil,
           # End date in YYYY-MM-DD format.
           until_date: nil,
-          # ISO 8601 timestamp - only return tweets before this time
+          # Exclusive ISO bound.
           until_time: nil,
           # URL substring or domain filter.
           url: nil,
           # Only return tweets from verified authors.
           verified_only: nil,
+          # Set the radius for the near filter.
+          within: nil,
+          # Match Tweets inside a recent time window.
+          within_time: nil,
           request_options: {}
         )
         end
@@ -458,25 +668,40 @@ module XTwitterScraper
               q: String,
               advanced_query: String,
               any_words: String,
+              blue_verified_only: T::Boolean,
               bounding_box: String,
+              card_name: String,
               cashtags: String,
               conversation_id: String,
               cursor: String,
               exact_phrase: String,
+              exclude_source: String,
               exclude_words: String,
               from_user: String,
+              geocode: String,
               hashtags: String,
               in_reply_to_tweet_id: String,
               language: String,
               limit: Integer,
               list_id: String,
+              max_faves: Integer,
+              max_id: String,
+              max_quotes: Integer,
+              max_replies: Integer,
+              max_retweets: Integer,
               media_type:
                 XTwitterScraper::X::TweetSearchParams::MediaType::OrSymbol,
               mentioning: String,
+              min_bookmarks: Integer,
               min_faves: Integer,
               min_quotes: Integer,
               min_replies: Integer,
               min_retweets: Integer,
+              min_views: Integer,
+              mode: XTwitterScraper::X::TweetSearchParams::Mode::OrSymbol,
+              native_retweets: T::Boolean,
+              near: String,
+              news: T::Boolean,
               place: String,
               place_country: String,
               point_radius: String,
@@ -488,13 +713,18 @@ module XTwitterScraper
               retweets:
                 XTwitterScraper::X::TweetSearchParams::Retweets::OrSymbol,
               retweets_of_tweet_id: String,
+              safe: T::Boolean,
               since_date: Date,
+              since_id: String,
               since_time: String,
+              source: String,
               to_user: String,
               until_date: Date,
               until_time: String,
               url: String,
               verified_only: T::Boolean,
+              within: String,
+              within_time: String,
               request_options: XTwitterScraper::RequestOptions
             }
           )
@@ -554,6 +784,39 @@ module XTwitterScraper
           end
         end
 
+        # Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
+        # Coverage returns diagnostics once and rejects cursors.
+        module Mode
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, XTwitterScraper::X::TweetSearchParams::Mode)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          STANDARD =
+            T.let(
+              :standard,
+              XTwitterScraper::X::TweetSearchParams::Mode::TaggedSymbol
+            )
+          COVERAGE =
+            T.let(
+              :coverage,
+              XTwitterScraper::X::TweetSearchParams::Mode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::X::TweetSearchParams::Mode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         # Sort order - Latest (chronological) or Top (engagement-ranked)
         module QueryType
           extend XTwitterScraper::Internal::Type::Enum