x-twitter-scraper 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8792afcc912a8fd874ef1043061e5665ea854668ad08416dd828db64110c4df0
-  data.tar.gz: 3f8bb5f24306f664e560a1c3cb8d0cb999ee65a1140ec7b4a84ff22ec8bc46c8
+  metadata.gz: 5f3cc0414acafe6f28d5e4f7ff3dc1256fd6ec5f6e53da6bd17a6fc15f01fd6b
+  data.tar.gz: 869c3bc0cebda16b1e082d6b79310712b455a3e6ff5e0362d544b861f0e6f40f
 SHA512:
-  metadata.gz: 451d33d084cdeb8b5f7a9faab57ae296eff565682277aa2a655e2f5916c5ce43f8d1d94d7029832bd9cdf2bf8432e6bd836077b67b9feb38e9262429a92a36cd
-  data.tar.gz: fd3d82bc8347ff72b9b259b0e9ccaf8f22f7b9c45572f7d3e5c7b7a3e7e19f5dfc63bf3020077f94072b261ce6c4691f96a3076dd787c170269992b8d426f0e3
+  metadata.gz: f48e30e4f4727986fa4e4ae2c57f8dc33703f61ce0ce54ed443d225dfd98a9a06cd55a31ebb9a0073fc60a64e166e200ba8f88031c39496dfce1596236539f1e
+  data.tar.gz: c9928ce4d434a0dfddb7d1491b652eacd1338869ddc3976f24cae6ebf7499d9cba86d0389dd249e32efc7b5fd801f75a4f26c444314f4c0e959e174f3507c3f0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.10.0 (2026-08-12)
+
+Full Changelog: [v0.9.1...v0.10.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.9.1...v0.10.0)
+
+### Features
+
+* **api:** sync public contracts ([b7fafe0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/b7fafe0efcf6b27464565ca4c54159c2276cb58a))
+
 ## 0.9.1 (2026-08-11)
 
 Full Changelog: [v0.9.0...v0.9.1](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.9.0...v0.9.1)

data/README.md

@@ -35,7 +35,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "x-twitter-scraper", "~> 0.9.1"
+gem "x-twitter-scraper", "~> 0.10.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/x_twitter_scraper/models/error.rb

@@ -118,12 +118,17 @@ module XTwitterScraper
           IDEMPOTENCY_CONFLICT = :idempotency_conflict
           IDEMPOTENCY_KEY_CONFLICT = :idempotency_key_conflict
           INVALID_COMMUNITY_ID = :invalid_community_id
+          INVALID_COMPLETE_REPLIES_REQUEST = :invalid_complete_replies_request
           INVALID_COVERAGE_CURSOR = :invalid_coverage_cursor
+          INVALID_COVERAGE_REQUEST = :invalid_coverage_request
           INVALID_IDEMPOTENCY_KEY = :invalid_idempotency_key
           INVALID_LIST_ID = :invalid_list_id
+          INVALID_OUTPUT_OPTIONS = :invalid_output_options
           INVALID_PAYMENT_AMOUNT = :invalid_payment_amount
           INVALID_RANGE = :invalid_range
+          INVALID_REPLY_OPTIONS = :invalid_reply_options
           LOGIN_RATE_LIMITED = :login_rate_limited
+          LOGIN_SERVICE_UNAVAILABLE = :login_service_unavailable
           MISSING_IDEMPOTENCY_KEY = :missing_idempotency_key
           MISSING_IDS = :missing_ids
           NO_CACHED_STYLE = :no_cached_style
@@ -134,6 +139,7 @@ module XTwitterScraper
           SUPPORT_MEDIA_RATE_LIMIT = :support_media_rate_limit
           SUPPORT_REQUEST_RATE_LIMIT = :support_request_rate_limit
           TOO_MANY_IDS = :too_many_ids
+          TOO_MANY_TWEETS = :too_many_tweets
           UNKNOWN_FIELD = :unknown_field
           UNSUPPORTED_MEDIA_TYPE = :unsupported_media_type
           WEBHOOK_INACTIVE = :webhook_inactive
@@ -251,12 +257,17 @@ module XTwitterScraper
             IDEMPOTENCY_CONFLICT = :idempotency_conflict
             IDEMPOTENCY_KEY_CONFLICT = :idempotency_key_conflict
             INVALID_COMMUNITY_ID = :invalid_community_id
+            INVALID_COMPLETE_REPLIES_REQUEST = :invalid_complete_replies_request
             INVALID_COVERAGE_CURSOR = :invalid_coverage_cursor
+            INVALID_COVERAGE_REQUEST = :invalid_coverage_request
             INVALID_IDEMPOTENCY_KEY = :invalid_idempotency_key
             INVALID_LIST_ID = :invalid_list_id
+            INVALID_OUTPUT_OPTIONS = :invalid_output_options
             INVALID_PAYMENT_AMOUNT = :invalid_payment_amount
             INVALID_RANGE = :invalid_range
+            INVALID_REPLY_OPTIONS = :invalid_reply_options
             LOGIN_RATE_LIMITED = :login_rate_limited
+            LOGIN_SERVICE_UNAVAILABLE = :login_service_unavailable
             MISSING_IDEMPOTENCY_KEY = :missing_idempotency_key
             MISSING_IDS = :missing_ids
             NO_CACHED_STYLE = :no_cached_style
@@ -267,6 +278,7 @@ module XTwitterScraper
             SUPPORT_MEDIA_RATE_LIMIT = :support_media_rate_limit
             SUPPORT_REQUEST_RATE_LIMIT = :support_request_rate_limit
             TOO_MANY_IDS = :too_many_ids
+            TOO_MANY_TWEETS = :too_many_tweets
             UNKNOWN_FIELD = :unknown_field
             UNSUPPORTED_MEDIA_TYPE = :unsupported_media_type
             WEBHOOK_INACTIVE = :webhook_inactive

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

@@ -157,7 +157,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -366,7 +366,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #

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

@@ -184,7 +184,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -421,7 +421,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #

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

@@ -17,12 +17,145 @@ module XTwitterScraper
         #   @return [String]
         required :id, String
 
+        # @!attribute any_words
+        #   Words or quoted phrases where any one can match. Separate with spaces, commas,
+        #   or lines.
+        #
+        #   @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 cashtags
+        #   Cashtags separated by spaces, commas, or lines.
+        #
+        #   @return [String, nil]
+        optional :cashtags, String
+
+        # @!attribute conversation_id
+        #   Conversation ID filter.
+        #
+        #   @return [String, nil]
+        optional :conversation_id, String
+
         # @!attribute cursor
         #   Pagination cursor for thread tweets
         #
         #   @return [String, nil]
         optional :cursor, String
 
+        # @!attribute exact_phrase
+        #   Exact phrase to match.
+        #
+        #   @return [String, nil]
+        optional :exact_phrase, String
+
+        # @!attribute exclude_words
+        #   Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+        #
+        #   @return [String, nil]
+        optional :exclude_words, String
+
+        # @!attribute from_user
+        #   Filter by author username.
+        #
+        #   @return [String, nil]
+        optional :from_user, String
+
+        # @!attribute hashtags
+        #   Hashtags separated by spaces, commas, or lines.
+        #
+        #   @return [String, nil]
+        optional :hashtags, String
+
+        # @!attribute in_reply_to_tweet_id
+        #   Only replies to this tweet ID.
+        #
+        #   @return [String, nil]
+        optional :in_reply_to_tweet_id, String
+
+        # @!attribute language
+        #   Language code filter, e.g. en or tr.
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute max_faves
+        #   Maximum likes threshold. maxLikes is also accepted.
+        #
+        #   @return [Integer, nil]
+        optional :max_faves, Integer
+
+        # @!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.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::TweetGetThreadParams::MediaType, nil]
+        optional :media_type, enum: -> { XTwitterScraper::X::TweetGetThreadParams::MediaType }
+
+        # @!attribute mentioning
+        #   Filter tweets mentioning a username.
+        #
+        #   @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. minLikes is also accepted.
+        #
+        #   @return [Integer, nil]
+        optional :min_faves, Integer
+
+        # @!attribute min_quotes
+        #   Minimum quote count threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_quotes, Integer
+
+        # @!attribute min_replies
+        #   Minimum replies threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_replies, Integer
+
+        # @!attribute min_retweets
+        #   Minimum retweets threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_retweets, Integer
+
+        # @!attribute min_views
+        #   Minimum view count threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_views, Integer
+
         # @!attribute page_size
         #   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
@@ -31,17 +164,192 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :page_size, Integer
 
-        # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
+        # @!attribute quotes
+        #   Quote mode.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::TweetGetThreadParams::Quotes, nil]
+        optional :quotes, enum: -> { XTwitterScraper::X::TweetGetThreadParams::Quotes }
+
+        # @!attribute quotes_of_tweet_id
+        #   Only quotes of this tweet ID.
+        #
+        #   @return [String, nil]
+        optional :quotes_of_tweet_id, String
+
+        # @!attribute replies
+        #   Reply mode.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::TweetGetThreadParams::Replies, nil]
+        optional :replies, enum: -> { XTwitterScraper::X::TweetGetThreadParams::Replies }
+
+        # @!attribute retweets
+        #   Retweet mode.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::TweetGetThreadParams::Retweets, nil]
+        optional :retweets, enum: -> { XTwitterScraper::X::TweetGetThreadParams::Retweets }
+
+        # @!attribute retweets_of_tweet_id
+        #   Only retweets of this tweet ID.
+        #
+        #   @return [String, nil]
+        optional :retweets_of_tweet_id, String
+
+        # @!attribute since_date
+        #   Start date in YYYY-MM-DD format.
+        #
+        #   @return [Date, nil]
+        optional :since_date, Date
+
+        # @!attribute to_user
+        #   Filter replies sent to a username.
+        #
+        #   @return [String, nil]
+        optional :to_user, String
+
+        # @!attribute until_date
+        #   End date in YYYY-MM-DD format.
+        #
+        #   @return [Date, nil]
+        optional :until_date, Date
+
+        # @!attribute url
+        #   URL substring or domain filter.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!attribute verified_only
+        #   Only return tweets from verified authors.
+        #
+        #   @return [Boolean, nil]
+        optional :verified_only, XTwitterScraper::Internal::Type::Boolean
+
+        # @!method initialize(id:, any_words: nil, blue_verified_only: 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, max_faves: 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, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {XTwitterScraper::Models::X::TweetGetThreadParams} for more details.
         #
         #   @param id [String]
         #
+        #   @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 cashtags [String] Cashtags separated by spaces, commas, or lines.
+        #
+        #   @param conversation_id [String] Conversation ID filter.
+        #
         #   @param cursor [String] Pagination cursor for thread tweets
         #
+        #   @param exact_phrase [String] Exact phrase to match.
+        #
+        #   @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 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 max_faves [Integer] Maximum likes threshold. maxLikes is also accepted.
+        #
+        #   @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::TweetGetThreadParams::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. minLikes is also accepted.
+        #
+        #   @param min_quotes [Integer] Minimum quote count threshold.
+        #
+        #   @param min_replies [Integer] Minimum replies threshold.
+        #
+        #   @param min_retweets [Integer] Minimum retweets threshold.
+        #
+        #   @param min_views [Integer] Minimum view count threshold.
+        #
         #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
         #
+        #   @param quotes [Symbol, XTwitterScraper::Models::X::TweetGetThreadParams::Quotes] Quote mode.
+        #
+        #   @param quotes_of_tweet_id [String] Only quotes of this tweet ID.
+        #
+        #   @param replies [Symbol, XTwitterScraper::Models::X::TweetGetThreadParams::Replies] Reply mode.
+        #
+        #   @param retweets [Symbol, XTwitterScraper::Models::X::TweetGetThreadParams::Retweets] Retweet mode.
+        #
+        #   @param retweets_of_tweet_id [String] Only retweets of this tweet ID.
+        #
+        #   @param since_date [Date] Start date in YYYY-MM-DD format.
+        #
+        #   @param to_user [String] Filter replies sent to a username.
+        #
+        #   @param until_date [Date] End date in YYYY-MM-DD format.
+        #
+        #   @param url [String] URL substring or domain filter.
+        #
+        #   @param verified_only [Boolean] Only return tweets from verified authors.
+        #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter by media type.
+        module MediaType
+          extend XTwitterScraper::Internal::Type::Enum
+
+          IMAGES = :images
+          VIDEOS = :videos
+          GIFS = :gifs
+          MEDIA = :media
+          LINKS = :links
+          NONE = :none
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Quote mode.
+        module Quotes
+          extend XTwitterScraper::Internal::Type::Enum
+
+          INCLUDE = :include
+          EXCLUDE = :exclude
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Reply mode.
+        module Replies
+          extend XTwitterScraper::Internal::Type::Enum
+
+          INCLUDE = :include
+          EXCLUDE = :exclude
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Retweet mode.
+        module Retweets
+          extend XTwitterScraper::Internal::Type::Enum
+
+          INCLUDE = :include
+          EXCLUDE = :exclude
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

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

@@ -179,7 +179,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -417,7 +417,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #

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

@@ -151,7 +151,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -346,7 +346,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #

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

@@ -151,7 +151,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -346,7 +346,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #

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

@@ -151,7 +151,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -358,7 +358,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #

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

@@ -158,7 +158,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -354,7 +354,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #

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

@@ -164,7 +164,7 @@ module XTwitterScraper
         optional :min_bookmarks, Integer
 
         # @!attribute min_faves
-        #   Minimum likes threshold.
+        #   Minimum likes threshold. minLikes is also accepted.
         #
         #   @return [Integer, nil]
         optional :min_faves, Integer
@@ -362,7 +362,7 @@ module XTwitterScraper
         #
         #   @param min_bookmarks [Integer] Minimum bookmark count threshold.
         #
-        #   @param min_faves [Integer] Minimum likes threshold.
+        #   @param min_faves [Integer] Minimum likes threshold. minLikes is also accepted.
         #
         #   @param min_quotes [Integer] Minimum quote count threshold.
         #