x-twitter-scraper 0.7.2 → 0.9.0

data/lib/x_twitter_scraper/models/x/tweet_get_replies_response.rb

@@ -18,8 +18,9 @@ module XTwitterScraper
         optional :nested_replies, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::SearchTweet] }
 
         # @!method initialize(diagnostic: nil, nested_replies: nil)
-        #   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.
         #
         #   @param diagnostic [XTwitterScraper::Models::X::TweetGetRepliesResponse::Diagnostic] Evidence for direct-reply coverage and collector behavior.
         #

data/lib/x_twitter_scraper/models/x/tweet_get_retweeters_params.rb

@@ -17,30 +17,141 @@ module XTwitterScraper
         #   @return [String]
         required :id, String
 
+        # @!attribute bio_contains
+        #   Match any comma-separated or line-separated bio term, ignoring case.
+        #
+        #   @return [String, nil]
+        optional :bio_contains, String
+
         # @!attribute cursor
         #   Pagination cursor for retweeters
         #
         #   @return [String, nil]
         optional :cursor, String
 
+        # @!attribute has_location
+        #   Only return profiles with a location.
+        #
+        #   @return [Boolean, nil]
+        optional :has_location, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute has_website
+        #   Only return profiles with a website.
+        #
+        #   @return [Boolean, nil]
+        optional :has_website, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute location_contains
+        #   Match a location substring, ignoring case.
+        #
+        #   @return [String, nil]
+        optional :location_contains, String
+
+        # @!attribute max_followers
+        #   Maximum follower count. Missing counts pass this maximum.
+        #
+        #   @return [Integer, nil]
+        optional :max_followers, Integer
+
+        # @!attribute max_following
+        #   Maximum following count.
+        #
+        #   @return [Integer, nil]
+        optional :max_following, Integer
+
+        # @!attribute max_statuses
+        #   Maximum post count. maxPosts is also accepted.
+        #
+        #   @return [Integer, nil]
+        optional :max_statuses, Integer
+
+        # @!attribute min_account_age_days
+        #   Minimum account age in whole days.
+        #
+        #   @return [Integer, nil]
+        optional :min_account_age_days, Integer
+
+        # @!attribute min_followers
+        #   Minimum follower count. Filtering happens before billing.
+        #
+        #   @return [Integer, nil]
+        optional :min_followers, Integer
+
+        # @!attribute min_following
+        #   Minimum following count.
+        #
+        #   @return [Integer, nil]
+        optional :min_following, Integer
+
+        # @!attribute min_statuses
+        #   Minimum post count. minPosts is also accepted.
+        #
+        #   @return [Integer, nil]
+        optional :min_statuses, Integer
+
         # @!attribute page_size
-        #   Maximum user profiles requested from this page (20-200, default 200). The
-        #   response can contain fewer profiles because the source returned fewer or
-        #   remaining credits cover fewer results. Keep requesting next_cursor while
-        #   has_next_page is true. The deprecated limit and count aliases remain accepted.
+        #   Maximum user profiles requested from this page (20-200, default 200). Source,
+        #   filters, or credits can return fewer profiles. Keep requesting next_cursor while
+        #   has_next_page is true. Deprecated aliases remain accepted.
         #
         #   @return [Integer, nil]
         optional :page_size, Integer
 
-        # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
+        # @!attribute username_contains
+        #   Match a username substring, ignoring case.
+        #
+        #   @return [String, nil]
+        optional :username_contains, String
+
+        # @!attribute verified_only
+        #   Only return verified profiles.
+        #
+        #   @return [Boolean, nil]
+        optional :verified_only, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute verified_type
+        #   Match the verification type exactly, ignoring case.
+        #
+        #   @return [String, nil]
+        optional :verified_type, String
+
+        # @!method initialize(id:, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {XTwitterScraper::Models::X::TweetGetRetweetersParams} for more details.
         #
         #   @param id [String]
         #
+        #   @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
+        #
         #   @param cursor [String] Pagination cursor for retweeters
         #
-        #   @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). The respon
+        #   @param has_location [Boolean] Only return profiles with a location.
+        #
+        #   @param has_website [Boolean] Only return profiles with a website.
+        #
+        #   @param location_contains [String] Match a location substring, ignoring case.
+        #
+        #   @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
+        #
+        #   @param max_following [Integer] Maximum following count.
+        #
+        #   @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
+        #
+        #   @param min_account_age_days [Integer] Minimum account age in whole days.
+        #
+        #   @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
+        #
+        #   @param min_following [Integer] Minimum following count.
+        #
+        #   @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
+        #
+        #   @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). Source, fi
+        #
+        #   @param username_contains [String] Match a username substring, ignoring case.
+        #
+        #   @param verified_only [Boolean] Only return verified profiles.
+        #
+        #   @param verified_type [String] Match the verification type exactly, ignoring case.
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/x_twitter_scraper/models/x/tweet_search_params.rb

@@ -13,7 +13,7 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute q
-        #   Search query (keywords,
+        #   Query, Tweet ID, or status URL. Valid inline bounds apply per page.
         #
         #   @return [String]
         required :q, String
@@ -31,12 +31,24 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :any_words, String
 
+        # @!attribute blue_verified_only
+        #   Only return tweets from Blue-verified authors.
+        #
+        #   @return [Boolean, nil]
+        optional :blue_verified_only, XTwitterScraper::Internal::Type::Boolean
+
         # @!attribute bounding_box
         #   Geo bounding box, e.g. -74.1 40.6 -73.9 40.8.
         #
         #   @return [String, nil]
         optional :bounding_box, String
 
+        # @!attribute card_name
+        #   Match the Tweet card name.
+        #
+        #   @return [String, nil]
+        optional :card_name, String
+
         # @!attribute cashtags
         #   Cashtags separated by spaces, commas, or lines.
         #
@@ -50,7 +62,8 @@ module XTwitterScraper
         optional :conversation_id, String
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Cursor from the previous response. Xquik cursors resume automatic coverage.
+        #   Existing unprefixed cursors keep legacy standard behavior.
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -61,6 +74,12 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :exact_phrase, String
 
+        # @!attribute exclude_source
+        #   Exclude a source application.
+        #
+        #   @return [String, nil]
+        optional :exclude_source, String
+
         # @!attribute exclude_words
         #   Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
         #
@@ -73,6 +92,12 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :from_user, String
 
+        # @!attribute geocode
+        #   Match latitude, longitude, and radius.
+        #
+        #   @return [String, nil]
+        optional :geocode, String
+
         # @!attribute hashtags
         #   Hashtags separated by spaces, commas, or lines.
         #
@@ -92,10 +117,9 @@ module XTwitterScraper
         optional :language, String
 
         # @!attribute limit
-        #   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.
         #
         #   @return [Integer, nil]
         optional :limit, Integer
@@ -106,6 +130,36 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :list_id, String
 
+        # @!attribute max_faves
+        #   Maximum likes threshold. maxLikes is also accepted.
+        #
+        #   @return [Integer, nil]
+        optional :max_faves, Integer
+
+        # @!attribute max_id
+        #   Return Tweets older than this Tweet ID.
+        #
+        #   @return [String, nil]
+        optional :max_id, String
+
+        # @!attribute max_quotes
+        #   Maximum quotes threshold.
+        #
+        #   @return [Integer, nil]
+        optional :max_quotes, Integer
+
+        # @!attribute max_replies
+        #   Maximum replies threshold.
+        #
+        #   @return [Integer, nil]
+        optional :max_replies, Integer
+
+        # @!attribute max_retweets
+        #   Maximum retweets threshold.
+        #
+        #   @return [Integer, nil]
+        optional :max_retweets, Integer
+
         # @!attribute media_type
         #   Filter by media type.
         #
@@ -118,6 +172,12 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :mentioning, String
 
+        # @!attribute min_bookmarks
+        #   Minimum bookmark count threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_bookmarks, Integer
+
         # @!attribute min_faves
         #   Minimum likes threshold.
         #
@@ -142,6 +202,37 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :min_retweets, Integer
 
+        # @!attribute min_views
+        #   Minimum view count threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_views, Integer
+
+        # @!attribute mode
+        #   Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
+        #   Coverage returns diagnostics once and rejects cursors.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::TweetSearchParams::Mode, nil]
+        optional :mode, enum: -> { XTwitterScraper::X::TweetSearchParams::Mode }
+
+        # @!attribute native_retweets
+        #   Only return native reposts.
+        #
+        #   @return [Boolean, nil]
+        optional :native_retweets, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute near
+        #   Match a place name.
+        #
+        #   @return [String, nil]
+        optional :near, String
+
+        # @!attribute news
+        #   Only return news results.
+        #
+        #   @return [Boolean, nil]
+        optional :news, XTwitterScraper::Internal::Type::Boolean
+
         # @!attribute place
         #   Search within a place ID.
         #
@@ -196,18 +287,36 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :retweets_of_tweet_id, String
 
+        # @!attribute safe
+        #   Enable the safe-search filter.
+        #
+        #   @return [Boolean, nil]
+        optional :safe, XTwitterScraper::Internal::Type::Boolean
+
         # @!attribute since_date
         #   Start date in YYYY-MM-DD format.
         #
         #   @return [Date, nil]
         optional :since_date, Date
 
+        # @!attribute since_id
+        #   Return Tweets newer than this Tweet ID.
+        #
+        #   @return [String, nil]
+        optional :since_id, String
+
         # @!attribute since_time
-        #   ISO 8601 timestamp - only return tweets after this time
+        #   Inclusive ISO bound.
         #
         #   @return [String, nil]
         optional :since_time, String
 
+        # @!attribute source
+        #   Match the source application.
+        #
+        #   @return [String, nil]
+        optional :source, String
+
         # @!attribute to_user
         #   Filter replies sent to a username.
         #
@@ -221,7 +330,7 @@ module XTwitterScraper
         optional :until_date, Date
 
         # @!attribute until_time
-        #   ISO 8601 timestamp - only return tweets before this time
+        #   Exclusive ISO bound.
         #
         #   @return [String, nil]
         optional :until_time, String
@@ -238,44 +347,76 @@ module XTwitterScraper
         #   @return [Boolean, nil]
         optional :verified_only, XTwitterScraper::Internal::Type::Boolean
 
-        # @!method initialize(q:, advanced_query: nil, any_words: nil, bounding_box: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, limit: nil, list_id: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, place: nil, place_country: nil, point_radius: nil, query_type: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, since_time: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, request_options: {})
+        # @!attribute within
+        #   Set the radius for the near filter.
+        #
+        #   @return [String, nil]
+        optional :within, String
+
+        # @!attribute within_time
+        #   Match Tweets inside a recent time window.
+        #
+        #   @return [String, nil]
+        optional :within_time, String
+
+        # @!method initialize(q:, advanced_query: nil, any_words: nil, blue_verified_only: nil, bounding_box: nil, card_name: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, limit: nil, list_id: nil, max_faves: nil, max_id: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_bookmarks: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, mode: nil, native_retweets: nil, near: nil, news: nil, place: nil, place_country: nil, point_radius: nil, query_type: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, since_date: nil, since_id: nil, since_time: nil, source: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, within: nil, within_time: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {XTwitterScraper::Models::X::TweetSearchParams} for more details.
         #
-        #   @param q [String] Search query (keywords,
+        #   @param q [String] Query, Tweet ID, or status URL. Valid inline bounds apply per page.
         #
         #   @param advanced_query [String] Raw advanced search query appended as-is.
         #
         #   @param any_words [String] Words or quoted phrases where any one can match. Separate with spaces, commas, o
         #
+        #   @param blue_verified_only [Boolean] Only return tweets from Blue-verified authors.
+        #
         #   @param bounding_box [String] Geo bounding box, e.g. -74.1 40.6 -73.9 40.8.
         #
+        #   @param card_name [String] Match the Tweet card name.
+        #
         #   @param cashtags [String] Cashtags separated by spaces, commas, or lines.
         #
         #   @param conversation_id [String] Conversation ID filter.
         #
-        #   @param cursor [String] Pagination cursor from previous response
+        #   @param cursor [String] Cursor from the previous response. Xquik cursors resume automatic coverage. Exis
         #
         #   @param exact_phrase [String] Exact phrase to match.
         #
+        #   @param exclude_source [String] Exclude a source application.
+        #
         #   @param exclude_words [String] Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
         #
         #   @param from_user [String] Filter by author username.
         #
+        #   @param geocode [String] Match latitude, longitude, and radius.
+        #
         #   @param hashtags [String] Hashtags separated by spaces, commas, or lines.
         #
         #   @param in_reply_to_tweet_id [String] Only replies to this tweet ID.
         #
         #   @param language [String] Language code filter, e.g. en or tr.
         #
-        #   @param limit [Integer] Max tweets to return (server paginates internally). Omit for single page (~20).
+        #   @param limit [Integer] Result upper bound. Omit it for the existing 20-row page size. Explicit coverage
         #
         #   @param list_id [String] Search within a list ID.
         #
+        #   @param max_faves [Integer] Maximum likes threshold. maxLikes is also accepted.
+        #
+        #   @param max_id [String] Return Tweets older than this Tweet ID.
+        #
+        #   @param max_quotes [Integer] Maximum quotes threshold.
+        #
+        #   @param max_replies [Integer] Maximum replies threshold.
+        #
+        #   @param max_retweets [Integer] Maximum retweets threshold.
+        #
         #   @param media_type [Symbol, XTwitterScraper::Models::X::TweetSearchParams::MediaType] Filter by media type.
         #
         #   @param mentioning [String] Filter tweets mentioning a username.
         #
+        #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
+        #
         #   @param min_faves [Integer] Minimum likes threshold.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
@@ -284,6 +425,16 @@ module XTwitterScraper
         #
         #   @param min_retweets [Integer] Minimum retweets threshold.
         #
+        #   @param min_views [Integer] Minimum view count threshold.
+        #
+        #   @param mode [Symbol, XTwitterScraper::Models::X::TweetSearchParams::Mode] Omit mode for resumable maximum coverage. Standard keeps legacy pagination. Cove
+        #
+        #   @param native_retweets [Boolean] Only return native reposts.
+        #
+        #   @param near [String] Match a place name.
+        #
+        #   @param news [Boolean] Only return news results.
+        #
         #   @param place [String] Search within a place ID.
         #
         #   @param place_country [String] Search within a country code.
@@ -302,20 +453,30 @@ module XTwitterScraper
         #
         #   @param retweets_of_tweet_id [String] Only retweets of this tweet ID.
         #
+        #   @param safe [Boolean] Enable the safe-search filter.
+        #
         #   @param since_date [Date] Start date in YYYY-MM-DD format.
         #
-        #   @param since_time [String] ISO 8601 timestamp - only return tweets after this time
+        #   @param since_id [String] Return Tweets newer than this Tweet ID.
+        #
+        #   @param since_time [String] Inclusive ISO bound.
+        #
+        #   @param source [String] Match the source application.
         #
         #   @param to_user [String] Filter replies sent to a username.
         #
         #   @param until_date [Date] End date in YYYY-MM-DD format.
         #
-        #   @param until_time [String] ISO 8601 timestamp - only return tweets before this time
+        #   @param until_time [String] Exclusive ISO bound.
         #
         #   @param url [String] URL substring or domain filter.
         #
         #   @param verified_only [Boolean] Only return tweets from verified authors.
         #
+        #   @param within [String] Set the radius for the near filter.
+        #
+        #   @param within_time [String] Match Tweets inside a recent time window.
+        #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
 
         # Filter by media type.
@@ -333,6 +494,18 @@ module XTwitterScraper
           #   @return [Array<Symbol>]
         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
+
+          STANDARD = :standard
+          COVERAGE = :coverage
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # Sort order - Latest (chronological) or Top (engagement-ranked)
         module QueryType
           extend XTwitterScraper::Internal::Type::Enum