x-twitter-scraper 0.7.2 → 0.9.0

data/rbi/x_twitter_scraper/models/x/tweet_get_replies_params.rbi

@@ -30,6 +30,20 @@ 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
+
+        # 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
@@ -44,7 +58,8 @@ module XTwitterScraper
         sig { params(conversation_id: String).void }
         attr_writer :conversation_id
 
-        # Pagination cursor for tweet replies
+        # 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
 
@@ -58,6 +73,20 @@ module XTwitterScraper
         sig { params(exact_phrase: String).void }
         attr_writer :exact_phrase
 
+        # Exclude replies written by the source-post author.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :exclude_original_author
+
+        sig { params(exclude_original_author: T::Boolean).void }
+        attr_writer :exclude_original_author
+
+        # 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
@@ -72,6 +101,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
@@ -79,6 +115,20 @@ module XTwitterScraper
         sig { params(hashtags: String).void }
         attr_writer :hashtags
 
+        # Only return replies containing media.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_media_only
+
+        sig { params(has_media_only: T::Boolean).void }
+        attr_writer :has_media_only
+
+        # Include the source post and count it toward limit.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_original_post
+
+        sig { params(include_original_post: T::Boolean).void }
+        attr_writer :include_original_post
+
         # Only replies to this tweet ID.
         sig { returns(T.nilable(String)) }
         attr_reader :in_reply_to_tweet_id
@@ -93,15 +143,57 @@ module XTwitterScraper
         sig { params(language: String).void }
         attr_writer :language
 
-        # With mode=complete, maximum combined direct and nested reply rows (1-25000).
-        # Without complete mode, this is the deprecated pageSize alias and uses the normal
-        # 1-100 page range.
+        # With mode=complete, maximum combined direct and nested reply rows (1-25000,
+        # default 25000). Automatic pages accept 1-300. Standard pages accept 1-100.
+        # Prefer pageSize outside complete mode.
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
         sig { params(limit: Integer).void }
         attr_writer :limit
 
+        # Maximum reply depth from the source post.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_depth
+
+        sig { params(max_depth: Integer).void }
+        attr_writer :max_depth
+
+        # 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(
@@ -127,6 +219,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
@@ -155,8 +254,17 @@ module XTwitterScraper
         sig { params(min_retweets: Integer).void }
         attr_writer :min_retweets
 
-        # Set complete for maximum-coverage collection. Complete mode accepts only limit.
-        # Remove cursor, pageSize, count, time ranges, and tweet filters.
+        # Minimum view count threshold.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_views
+
+        sig { params(min_views: Integer).void }
+        attr_writer :min_views
+
+        # Optional advanced override. Omit mode for automatic maximum direct reply
+        # coverage with pagination. Standard keeps legacy pagination. Complete returns
+        # direct and nested replies with diagnostics, scope, depth, sorting, and
+        # original-post controls.
         sig do
           returns(
             T.nilable(XTwitterScraper::X::TweetGetRepliesParams::Mode::OrSymbol)
@@ -171,9 +279,29 @@ module XTwitterScraper
         end
         attr_writer :mode
 
-        # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
-        # results. Continue while has_next_page is true. Deprecated limit and count
-        # aliases remain accepted.
+        # 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
+
+        # Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20.
+        # Continue while has_next_page is true. Deprecated aliases remain accepted.
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
 
@@ -247,6 +375,30 @@ 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
+
+        # Select all replies, direct replies, or nested replies.
+        sig do
+          returns(
+            T.nilable(
+              XTwitterScraper::X::TweetGetRepliesParams::Scope::OrSymbol
+            )
+          )
+        end
+        attr_reader :scope
+
+        sig do
+          params(
+            scope: XTwitterScraper::X::TweetGetRepliesParams::Scope::OrSymbol
+          ).void
+        end
+        attr_writer :scope
+
         # Start date in YYYY-MM-DD format.
         sig { returns(T.nilable(Date)) }
         attr_reader :since_date
@@ -254,6 +406,13 @@ module XTwitterScraper
         sig { params(since_date: Date).void }
         attr_writer :since_date
 
+        # 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
+
         # Unix timestamp - return replies posted after this time
         sig { returns(T.nilable(String)) }
         attr_reader :since_time
@@ -261,6 +420,28 @@ module XTwitterScraper
         sig { params(since_time: String).void }
         attr_writer :since_time
 
+        # Sort the selected replies before applying limit.
+        sig do
+          returns(
+            T.nilable(XTwitterScraper::X::TweetGetRepliesParams::Sort::OrSymbol)
+          )
+        end
+        attr_reader :sort
+
+        sig do
+          params(
+            sort: XTwitterScraper::X::TweetGetRepliesParams::Sort::OrSymbol
+          ).void
+        end
+        attr_writer :sort
+
+        # 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
@@ -296,28 +477,60 @@ 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(
             id: String,
             any_words: String,
+            blue_verified_only: T::Boolean,
+            card_name: String,
             cashtags: String,
             conversation_id: String,
             cursor: String,
             exact_phrase: String,
+            exclude_original_author: T::Boolean,
+            exclude_source: String,
             exclude_words: String,
             from_user: String,
+            geocode: String,
             hashtags: String,
+            has_media_only: T::Boolean,
+            include_original_post: T::Boolean,
             in_reply_to_tweet_id: String,
             language: String,
             limit: Integer,
+            max_depth: Integer,
+            max_faves: Integer,
+            max_id: String,
+            max_quotes: Integer,
+            max_replies: Integer,
+            max_retweets: Integer,
             media_type:
               XTwitterScraper::X::TweetGetRepliesParams::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::TweetGetRepliesParams::Mode::OrSymbol,
+            native_retweets: T::Boolean,
+            near: String,
+            news: T::Boolean,
             page_size: Integer,
             quotes: XTwitterScraper::X::TweetGetRepliesParams::Quotes::OrSymbol,
             quotes_of_tweet_id: String,
@@ -326,13 +539,20 @@ module XTwitterScraper
             retweets:
               XTwitterScraper::X::TweetGetRepliesParams::Retweets::OrSymbol,
             retweets_of_tweet_id: String,
+            safe: T::Boolean,
+            scope: XTwitterScraper::X::TweetGetRepliesParams::Scope::OrSymbol,
             since_date: Date,
+            since_id: String,
             since_time: String,
+            sort: XTwitterScraper::X::TweetGetRepliesParams::Sort::OrSymbol,
+            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
@@ -341,32 +561,61 @@ module XTwitterScraper
           # 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,
+          # 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 for tweet replies
+          # 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 replies written by the source-post author.
+          exclude_original_author: 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 return replies containing media.
+          has_media_only: nil,
+          # Include the source post and count it toward limit.
+          include_original_post: nil,
           # Only replies to this tweet ID.
           in_reply_to_tweet_id: nil,
           # Language code filter, e.g. en or tr.
           language: nil,
-          # With mode=complete, maximum combined direct and nested reply rows (1-25000).
-          # Without complete mode, this is the deprecated pageSize alias and uses the normal
-          # 1-100 page range.
+          # With mode=complete, maximum combined direct and nested reply rows (1-25000,
+          # default 25000). Automatic pages accept 1-300. Standard pages accept 1-100.
+          # Prefer pageSize outside complete mode.
           limit: nil,
+          # Maximum reply depth from the source post.
+          max_depth: 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.
@@ -375,12 +624,21 @@ module XTwitterScraper
           min_replies: nil,
           # Minimum retweets threshold.
           min_retweets: nil,
-          # Set complete for maximum-coverage collection. Complete mode accepts only limit.
-          # Remove cursor, pageSize, count, time ranges, and tweet filters.
+          # Minimum view count threshold.
+          min_views: nil,
+          # Optional advanced override. Omit mode for automatic maximum direct reply
+          # coverage with pagination. Standard keeps legacy pagination. Complete returns
+          # direct and nested replies with diagnostics, scope, depth, sorting, and
+          # original-post controls.
           mode: nil,
-          # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
-          # results. Continue while has_next_page is true. Deprecated limit and count
-          # aliases remain accepted.
+          # Only return native reposts.
+          native_retweets: nil,
+          # Match a place name.
+          near: nil,
+          # Only return news results.
+          news: nil,
+          # Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20.
+          # Continue while has_next_page is true. Deprecated aliases remain accepted.
           page_size: nil,
           # Quote mode.
           quotes: nil,
@@ -392,10 +650,20 @@ module XTwitterScraper
           retweets: nil,
           # Only retweets of this tweet ID.
           retweets_of_tweet_id: nil,
+          # Enable the safe-search filter.
+          safe: nil,
+          # Select all replies, direct replies, or nested replies.
+          scope: nil,
           # Start date in YYYY-MM-DD format.
           since_date: nil,
+          # Return Tweets newer than this Tweet ID.
+          since_id: nil,
           # Unix timestamp - return replies posted after this time
           since_time: nil,
+          # Sort the selected replies before applying limit.
+          sort: nil,
+          # Match the source application.
+          source: nil,
           # Filter replies sent to a username.
           to_user: nil,
           # End date in YYYY-MM-DD format.
@@ -406,6 +674,10 @@ module XTwitterScraper
           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
@@ -415,24 +687,42 @@ module XTwitterScraper
             {
               id: String,
               any_words: String,
+              blue_verified_only: T::Boolean,
+              card_name: String,
               cashtags: String,
               conversation_id: String,
               cursor: String,
               exact_phrase: String,
+              exclude_original_author: T::Boolean,
+              exclude_source: String,
               exclude_words: String,
               from_user: String,
+              geocode: String,
               hashtags: String,
+              has_media_only: T::Boolean,
+              include_original_post: T::Boolean,
               in_reply_to_tweet_id: String,
               language: String,
               limit: Integer,
+              max_depth: Integer,
+              max_faves: Integer,
+              max_id: String,
+              max_quotes: Integer,
+              max_replies: Integer,
+              max_retweets: Integer,
               media_type:
                 XTwitterScraper::X::TweetGetRepliesParams::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::TweetGetRepliesParams::Mode::OrSymbol,
+              native_retweets: T::Boolean,
+              near: String,
+              news: T::Boolean,
               page_size: Integer,
               quotes:
                 XTwitterScraper::X::TweetGetRepliesParams::Quotes::OrSymbol,
@@ -442,13 +732,20 @@ module XTwitterScraper
               retweets:
                 XTwitterScraper::X::TweetGetRepliesParams::Retweets::OrSymbol,
               retweets_of_tweet_id: String,
+              safe: T::Boolean,
+              scope: XTwitterScraper::X::TweetGetRepliesParams::Scope::OrSymbol,
               since_date: Date,
+              since_id: String,
               since_time: String,
+              sort: XTwitterScraper::X::TweetGetRepliesParams::Sort::OrSymbol,
+              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
             }
           )
@@ -511,8 +808,10 @@ module XTwitterScraper
           end
         end
 
-        # Set complete for maximum-coverage collection. Complete mode accepts only limit.
-        # Remove cursor, pageSize, count, time ranges, and tweet filters.
+        # Optional advanced override. Omit mode for automatic maximum direct reply
+        # coverage with pagination. Standard keeps legacy pagination. Complete returns
+        # direct and nested replies with diagnostics, scope, depth, sorting, and
+        # original-post controls.
         module Mode
           extend XTwitterScraper::Internal::Type::Enum
 
@@ -522,6 +821,11 @@ module XTwitterScraper
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+          STANDARD =
+            T.let(
+              :standard,
+              XTwitterScraper::X::TweetGetRepliesParams::Mode::TaggedSymbol
+            )
           COMPLETE =
             T.let(
               :complete,
@@ -649,6 +953,85 @@ module XTwitterScraper
           def self.values
           end
         end
+
+        # Select all replies, direct replies, or nested replies.
+        module Scope
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, XTwitterScraper::X::TweetGetRepliesParams::Scope)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALL =
+            T.let(
+              :all,
+              XTwitterScraper::X::TweetGetRepliesParams::Scope::TaggedSymbol
+            )
+          DIRECT =
+            T.let(
+              :direct,
+              XTwitterScraper::X::TweetGetRepliesParams::Scope::TaggedSymbol
+            )
+          NESTED =
+            T.let(
+              :nested,
+              XTwitterScraper::X::TweetGetRepliesParams::Scope::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::X::TweetGetRepliesParams::Scope::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Sort the selected replies before applying limit.
+        module Sort
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, XTwitterScraper::X::TweetGetRepliesParams::Sort)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          RELEVANCE =
+            T.let(
+              :relevance,
+              XTwitterScraper::X::TweetGetRepliesParams::Sort::TaggedSymbol
+            )
+          LATEST =
+            T.let(
+              :latest,
+              XTwitterScraper::X::TweetGetRepliesParams::Sort::TaggedSymbol
+            )
+          OLDEST =
+            T.let(
+              :oldest,
+              XTwitterScraper::X::TweetGetRepliesParams::Sort::TaggedSymbol
+            )
+          LIKES =
+            T.let(
+              :likes,
+              XTwitterScraper::X::TweetGetRepliesParams::Sort::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::X::TweetGetRepliesParams::Sort::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/x_twitter_scraper/models/x/tweet_get_replies_response.rbi

@@ -41,8 +41,9 @@ module XTwitterScraper
         end
         attr_writer :nested_replies
 
-        # Reply rows. Complete mode also returns nested replies and coverage diagnostics.
-        # Keep nested replies separate from direct coverage.
+        # Direct reply rows. No-mode requests use resumable automatic coverage. Complete
+        # mode also returns nested replies and coverage diagnostics. Keep nested replies
+        # separate from direct coverage.
         sig do
           params(
             diagnostic: