x-twitter-scraper 0.7.2 → 0.9.0

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

@@ -24,6 +24,18 @@ 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 card_name
+        #   Match the Tweet card name.
+        #
+        #   @return [String, nil]
+        optional :card_name, String
+
         # @!attribute cashtags
         #   Cashtags separated by spaces, commas, or lines.
         #
@@ -48,6 +60,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.
         #
@@ -60,6 +78,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.
         #
@@ -78,6 +102,36 @@ module XTwitterScraper
         #   @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_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.
         #
@@ -90,6 +144,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.
         #
@@ -114,6 +174,30 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :min_retweets, Integer
 
+        # @!attribute min_views
+        #   Minimum view count threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_views, Integer
+
+        # @!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 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
@@ -152,12 +236,30 @@ 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 source
+        #   Match the source application.
+        #
+        #   @return [String, nil]
+        optional :source, String
+
         # @!attribute to_user
         #   Filter replies sent to a username.
         #
@@ -182,7 +284,19 @@ module XTwitterScraper
         #   @return [Boolean, nil]
         optional :verified_only, XTwitterScraper::Internal::Type::Boolean
 
-        # @!method initialize(id:, any_words: 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, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: 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: {})
+        # @!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(id:, any_words: nil, blue_verified_only: 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, 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, native_retweets: nil, near: nil, news: nil, page_size: 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, source: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, within: nil, within_time: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {XTwitterScraper::Models::X::UserRetrieveMediaParams} for more details.
         #
@@ -190,6 +304,10 @@ module XTwitterScraper
         #
         #   @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 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.
@@ -198,20 +316,36 @@ module XTwitterScraper
         #
         #   @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 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::UserRetrieveMediaParams::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.
@@ -220,6 +354,14 @@ module XTwitterScraper
         #
         #   @param min_retweets [Integer] Minimum retweets threshold.
         #
+        #   @param min_views [Integer] Minimum view count threshold.
+        #
+        #   @param native_retweets [Boolean] Only return native reposts.
+        #
+        #   @param near [String] Match a place name.
+        #
+        #   @param news [Boolean] Only return news results.
+        #
         #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
         #
         #   @param quotes [Symbol, XTwitterScraper::Models::X::UserRetrieveMediaParams::Quotes] Quote mode.
@@ -232,8 +374,14 @@ 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_id [String] Return Tweets newer than this Tweet ID.
+        #
+        #   @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.
@@ -242,6 +390,10 @@ module XTwitterScraper
         #
         #   @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.

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

@@ -24,6 +24,18 @@ 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 card_name
+        #   Match the Tweet card name.
+        #
+        #   @return [String, nil]
+        optional :card_name, String
+
         # @!attribute cashtags
         #   Cashtags separated by spaces, commas, or lines.
         #
@@ -48,6 +60,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.
         #
@@ -60,6 +78,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.
         #
@@ -78,6 +102,36 @@ module XTwitterScraper
         #   @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_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.
         #
@@ -90,6 +144,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.
         #
@@ -114,6 +174,30 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :min_retweets, Integer
 
+        # @!attribute min_views
+        #   Minimum view count threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_views, Integer
+
+        # @!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 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
@@ -152,18 +236,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
         #   Unix timestamp - return mentions after this time
         #
         #   @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.
         #
@@ -194,7 +296,19 @@ module XTwitterScraper
         #   @return [Boolean, nil]
         optional :verified_only, XTwitterScraper::Internal::Type::Boolean
 
-        # @!method initialize(id:, any_words: 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, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, page_size: 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(id:, any_words: nil, blue_verified_only: 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, 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, native_retweets: nil, near: nil, news: nil, page_size: 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::UserRetrieveMentionsParams} for more details.
         #
@@ -202,6 +316,10 @@ module XTwitterScraper
         #
         #   @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 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.
@@ -210,20 +328,36 @@ module XTwitterScraper
         #
         #   @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 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::UserRetrieveMentionsParams::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.
@@ -232,6 +366,14 @@ module XTwitterScraper
         #
         #   @param min_retweets [Integer] Minimum retweets threshold.
         #
+        #   @param min_views [Integer] Minimum view count threshold.
+        #
+        #   @param native_retweets [Boolean] Only return native reposts.
+        #
+        #   @param near [String] Match a place name.
+        #
+        #   @param news [Boolean] Only return news results.
+        #
         #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
         #
         #   @param quotes [Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::Quotes] Quote mode.
@@ -244,10 +386,16 @@ 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_id [String] Return Tweets newer than this Tweet ID.
+        #
         #   @param since_time [String] Unix timestamp - return mentions after this time
         #
+        #   @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.
@@ -258,6 +406,10 @@ module XTwitterScraper
         #
         #   @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.