x-twitter-scraper 0.7.3 → 0.9.0

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

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # Paginated user profiles. No-mode follower, following, and verified follower
+      # requests merge independent views automatically. Response fields, page size,
+      # aliases, filters, and per-returned-profile billing stay unchanged. Existing
+      # unprefixed cursors retain legacy behavior. Follow next_cursor while
+      # has_next_page is true.
+      #
+      # @see XTwitterScraper::Resources::X::Users#retrieve_following
+      module UserRetrieveFollowingResponse
+        extend XTwitterScraper::Internal::Type::Union
+
+        # Paginated user profiles. No-mode follower, following, and verified follower requests merge independent views automatically. Response fields, page size, aliases, filters, and per-returned-profile billing stay unchanged. Existing unprefixed cursors retain legacy behavior. Follow next_cursor while has_next_page is true.
+        variant -> { XTwitterScraper::PaginatedUsers }
+
+        # Paginated user profiles. No-mode follower, following, and verified follower requests merge independent views automatically. Response fields, page size, aliases, filters, and per-returned-profile billing stay unchanged. Existing unprefixed cursors retain legacy behavior. Follow next_cursor while has_next_page is true.
+        variant -> { XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse }
+
+        class UserListCoverageResponse < XTwitterScraper::Models::PaginatedUsers
+          # @!attribute diagnostic
+          #   Coverage evidence across parallel relationship strategies.
+          #
+          #   @return [XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic]
+          required :diagnostic,
+                   -> { XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic }
+
+          # @!attribute has_next_page
+          #
+          #   @return [Boolean, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::HasNextPage, nil]
+          optional :has_next_page,
+                   enum: -> { XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::HasNextPage }
+
+          # @!attribute next_cursor
+          #
+          #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::NextCursor, nil]
+          optional :next_cursor,
+                   enum: -> { XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::NextCursor }
+
+          # @!method initialize(diagnostic:, has_next_page: nil, next_cursor: nil)
+          #   Paginated user profiles. No-mode follower, following, and verified follower
+          #   requests merge independent views automatically. Response fields, page size,
+          #   aliases, filters, and per-returned-profile billing stay unchanged. Existing
+          #   unprefixed cursors retain legacy behavior. Follow next_cursor while
+          #   has_next_page is true.
+          #
+          #   @param diagnostic [XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic] Coverage evidence across parallel relationship strategies.
+          #
+          #   @param has_next_page [Boolean, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::HasNextPage]
+          #
+          #   @param next_cursor [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::NextCursor]
+
+          class Diagnostic < XTwitterScraper::Internal::Type::BaseModel
+            # @!attribute complete
+            #   True when every strategy exhausted its source.
+            #
+            #   @return [Boolean]
+            required :complete, XTwitterScraper::Internal::Type::Boolean
+
+            # @!attribute cursor_failure_count
+            #
+            #   @return [Integer]
+            required :cursor_failure_count, Integer, api_name: :cursorFailureCount
+
+            # @!attribute deadline_reached
+            #
+            #   @return [Boolean]
+            required :deadline_reached, XTwitterScraper::Internal::Type::Boolean, api_name: :deadlineReached
+
+            # @!attribute duplicate_count
+            #
+            #   @return [Integer]
+            required :duplicate_count, Integer, api_name: :duplicateCount
+
+            # @!attribute failed_strategy_count
+            #
+            #   @return [Integer]
+            required :failed_strategy_count, Integer, api_name: :failedStrategyCount
+
+            # @!attribute malformed_count
+            #
+            #   @return [Integer]
+            required :malformed_count, Integer, api_name: :malformedCount
+
+            # @!attribute pages_fetched
+            #
+            #   @return [Integer]
+            required :pages_fetched, Integer, api_name: :pagesFetched
+
+            # @!attribute response_truncated
+            #   Whether credits or the requested limit reduced output.
+            #
+            #   @return [Boolean]
+            required :response_truncated,
+                     XTwitterScraper::Internal::Type::Boolean,
+                     api_name: :responseTruncated
+
+            # @!attribute result_limit_reached
+            #
+            #   @return [Boolean]
+            required :result_limit_reached,
+                     XTwitterScraper::Internal::Type::Boolean,
+                     api_name: :resultLimitReached
+
+            # @!attribute returned_users
+            #
+            #   @return [Integer]
+            required :returned_users, Integer, api_name: :returnedUsers
+
+            # @!attribute stalled_strategy_count
+            #
+            #   @return [Integer]
+            required :stalled_strategy_count, Integer, api_name: :stalledStrategyCount
+
+            # @!attribute strategies
+            #
+            #   @return [Array<XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy>]
+            required :strategies,
+                     -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy] }
+
+            # @!attribute strategy_count
+            #
+            #   @return [Integer]
+            required :strategy_count, Integer, api_name: :strategyCount
+
+            # @!attribute unique_users
+            #
+            #   @return [Integer]
+            required :unique_users, Integer, api_name: :uniqueUsers
+
+            # @!method initialize(complete:, cursor_failure_count:, deadline_reached:, duplicate_count:, failed_strategy_count:, malformed_count:, pages_fetched:, response_truncated:, result_limit_reached:, returned_users:, stalled_strategy_count:, strategies:, strategy_count:, unique_users:)
+            #   Coverage evidence across parallel relationship strategies.
+            #
+            #   @param complete [Boolean] True when every strategy exhausted its source.
+            #
+            #   @param cursor_failure_count [Integer]
+            #
+            #   @param deadline_reached [Boolean]
+            #
+            #   @param duplicate_count [Integer]
+            #
+            #   @param failed_strategy_count [Integer]
+            #
+            #   @param malformed_count [Integer]
+            #
+            #   @param pages_fetched [Integer]
+            #
+            #   @param response_truncated [Boolean] Whether credits or the requested limit reduced output.
+            #
+            #   @param result_limit_reached [Boolean]
+            #
+            #   @param returned_users [Integer]
+            #
+            #   @param stalled_strategy_count [Integer]
+            #
+            #   @param strategies [Array<XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy>]
+            #
+            #   @param strategy_count [Integer]
+            #
+            #   @param unique_users [Integer]
+
+            class Strategy < XTwitterScraper::Internal::Type::BaseModel
+              # @!attribute duplicate_count
+              #
+              #   @return [Integer]
+              required :duplicate_count, Integer, api_name: :duplicateCount
+
+              # @!attribute pages_fetched
+              #
+              #   @return [Integer]
+              required :pages_fetched, Integer, api_name: :pagesFetched
+
+              # @!attribute stop_reason
+              #
+              #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
+              required :stop_reason,
+                       enum: -> { XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason },
+                       api_name: :stopReason
+
+              # @!attribute strategy
+              #
+              #   @return [Integer]
+              required :strategy, Integer
+
+              # @!attribute unique_added
+              #
+              #   @return [Integer]
+              required :unique_added, Integer, api_name: :uniqueAdded
+
+              # @!method initialize(duplicate_count:, pages_fetched:, stop_reason:, strategy:, unique_added:)
+              #   @param duplicate_count [Integer]
+              #   @param pages_fetched [Integer]
+              #   @param stop_reason [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
+              #   @param strategy [Integer]
+              #   @param unique_added [Integer]
+
+              # @see XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy#stop_reason
+              module StopReason
+                extend XTwitterScraper::Internal::Type::Enum
+
+                CURSOR_FAILURE = :cursor_failure
+                DEADLINE = :deadline
+                EXHAUSTED = :exhausted
+                FAILED = :failed
+                PAGE_LIMIT = :page_limit
+                RESULT_LIMIT = :result_limit
+                STALLED = :stalled
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+
+          module HasNextPage
+            extend XTwitterScraper::Internal::Type::Enum
+
+            FALSE = false
+
+            # @!method self.values
+            #   @return [Array<Boolean>]
+          end
+
+          module NextCursor
+            extend XTwitterScraper::Internal::Type::Enum
+
+            EMPTY = :""
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(XTwitterScraper::Models::PaginatedUsers, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse)]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/user_retrieve_likes_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::UserRetrieveLikesParams} 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::UserRetrieveLikesParams::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::UserRetrieveLikesParams::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.