x-twitter-scraper 0.3.0 → 0.4.0

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

@@ -6,112 +6,21 @@ module XTwitterScraper
       # @see XTwitterScraper::Resources::X::Tweets#retrieve
       class TweetRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute tweet
+        #   Full tweet with text, engagement metrics, media, and metadata.
         #
-        #   @return [XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet]
-        required :tweet, -> { XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet }
+        #   @return [XTwitterScraper::Models::X::TweetDetail]
+        required :tweet, -> { XTwitterScraper::X::TweetDetail }
 
         # @!attribute author
+        #   Author of a tweet with follower count and verification status.
         #
-        #   @return [XTwitterScraper::Models::X::TweetRetrieveResponse::Author, nil]
-        optional :author, -> { XTwitterScraper::Models::X::TweetRetrieveResponse::Author }
+        #   @return [XTwitterScraper::Models::X::TweetAuthor, nil]
+        optional :author, -> { XTwitterScraper::X::TweetAuthor }
 
         # @!method initialize(tweet:, author: nil)
-        #   @param tweet [XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet]
-        #   @param author [XTwitterScraper::Models::X::TweetRetrieveResponse::Author]
-
-        # @see XTwitterScraper::Models::X::TweetRetrieveResponse#tweet
-        class Tweet < XTwitterScraper::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute bookmark_count
-          #
-          #   @return [Integer]
-          required :bookmark_count, Integer, api_name: :bookmarkCount
-
-          # @!attribute like_count
-          #
-          #   @return [Integer]
-          required :like_count, Integer, api_name: :likeCount
-
-          # @!attribute quote_count
-          #
-          #   @return [Integer]
-          required :quote_count, Integer, api_name: :quoteCount
-
-          # @!attribute reply_count
-          #
-          #   @return [Integer]
-          required :reply_count, Integer, api_name: :replyCount
-
-          # @!attribute retweet_count
-          #
-          #   @return [Integer]
-          required :retweet_count, Integer, api_name: :retweetCount
-
-          # @!attribute text
-          #
-          #   @return [String]
-          required :text, String
-
-          # @!attribute view_count
-          #
-          #   @return [Integer]
-          required :view_count, Integer, api_name: :viewCount
-
-          # @!attribute created_at
-          #
-          #   @return [String, nil]
-          optional :created_at, String, api_name: :createdAt
-
-          # @!method initialize(id:, bookmark_count:, like_count:, quote_count:, reply_count:, retweet_count:, text:, view_count:, created_at: nil)
-          #   @param id [String]
-          #   @param bookmark_count [Integer]
-          #   @param like_count [Integer]
-          #   @param quote_count [Integer]
-          #   @param reply_count [Integer]
-          #   @param retweet_count [Integer]
-          #   @param text [String]
-          #   @param view_count [Integer]
-          #   @param created_at [String]
-        end
-
-        # @see XTwitterScraper::Models::X::TweetRetrieveResponse#author
-        class Author < XTwitterScraper::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute followers
-          #
-          #   @return [Integer]
-          required :followers, Integer
-
-          # @!attribute username
-          #
-          #   @return [String]
-          required :username, String
-
-          # @!attribute verified
-          #
-          #   @return [Boolean]
-          required :verified, XTwitterScraper::Internal::Type::Boolean
-
-          # @!attribute profile_picture
-          #
-          #   @return [String, nil]
-          optional :profile_picture, String, api_name: :profilePicture
-
-          # @!method initialize(id:, followers:, username:, verified:, profile_picture: nil)
-          #   @param id [String]
-          #   @param followers [Integer]
-          #   @param username [String]
-          #   @param verified [Boolean]
-          #   @param profile_picture [String]
-        end
+        #   @param tweet [XTwitterScraper::Models::X::TweetDetail] Full tweet with text, engagement metrics, media, and metadata.
+        #
+        #   @param author [XTwitterScraper::Models::X::TweetAuthor] Author of a tweet with follower count and verification status.
       end
     end
   end

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

@@ -21,7 +21,7 @@ module XTwitterScraper
         optional :cursor, String
 
         # @!attribute limit
-        #   Deprecated — use cursor-based pagination instead
+        #   Max tweets to return (server paginates internally). Omit for single page (~20).
         #
         #   @return [Integer, nil]
         optional :limit, Integer
@@ -49,7 +49,7 @@ module XTwitterScraper
         #
         #   @param cursor [String] Pagination cursor from previous response
         #
-        #   @param limit [Integer] Deprecated — use cursor-based pagination instead
+        #   @param limit [Integer] Max tweets to return (server paginates internally). Omit for single page (~20).
         #
         #   @param query_type [Symbol, XTwitterScraper::Models::X::TweetSearchParams::QueryType] Sort order — Latest (chronological) or Top (engagement-ranked)
         #

data/lib/x_twitter_scraper/models/x/tweets/like_create_params.rb

@@ -9,21 +9,21 @@ module XTwitterScraper
           extend XTwitterScraper::Internal::Type::RequestParameters::Converter
           include XTwitterScraper::Internal::Type::RequestParameters
 
-          # @!attribute tweet_id
+          # @!attribute id
           #
           #   @return [String]
-          required :tweet_id, String
+          required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
 
-          # @!method initialize(tweet_id:, account:, request_options: {})
-          #   @param tweet_id [String]
+          # @!method initialize(id:, account:, request_options: {})
+          #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/x_twitter_scraper/models/x/tweets/like_delete_params.rb

@@ -9,21 +9,21 @@ module XTwitterScraper
           extend XTwitterScraper::Internal::Type::RequestParameters::Converter
           include XTwitterScraper::Internal::Type::RequestParameters
 
-          # @!attribute tweet_id
+          # @!attribute id
           #
           #   @return [String]
-          required :tweet_id, String
+          required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
 
-          # @!method initialize(tweet_id:, account:, request_options: {})
-          #   @param tweet_id [String]
+          # @!method initialize(id:, account:, request_options: {})
+          #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/x_twitter_scraper/models/x/tweets/retweet_create_params.rb

@@ -9,21 +9,21 @@ module XTwitterScraper
           extend XTwitterScraper::Internal::Type::RequestParameters::Converter
           include XTwitterScraper::Internal::Type::RequestParameters
 
-          # @!attribute tweet_id
+          # @!attribute id
           #
           #   @return [String]
-          required :tweet_id, String
+          required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
 
-          # @!method initialize(tweet_id:, account:, request_options: {})
-          #   @param tweet_id [String]
+          # @!method initialize(id:, account:, request_options: {})
+          #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/x_twitter_scraper/models/x/tweets/retweet_delete_params.rb

@@ -9,21 +9,21 @@ module XTwitterScraper
           extend XTwitterScraper::Internal::Type::RequestParameters::Converter
           include XTwitterScraper::Internal::Type::RequestParameters
 
-          # @!attribute tweet_id
+          # @!attribute id
           #
           #   @return [String]
-          required :tweet_id, String
+          required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
 
-          # @!method initialize(tweet_id:, account:, request_options: {})
-          #   @param tweet_id [String]
+          # @!method initialize(id:, account:, request_options: {})
+          #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

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

@@ -3,6 +3,7 @@
 module XTwitterScraper
   module Models
     module X
+      # @see XTwitterScraper::Resources::X::Users#retrieve
       class UserProfile < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute id
         #
@@ -60,6 +61,8 @@ module XTwitterScraper
         optional :verified, XTwitterScraper::Internal::Type::Boolean
 
         # @!method initialize(id:, name:, username:, created_at: nil, description: nil, followers: nil, following: nil, location: nil, profile_picture: nil, statuses_count: nil, verified: nil)
+        #   X user profile with bio, follower counts, and verification status.
+        #
         #   @param id [String]
         #   @param name [String]
         #   @param username [String]

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for followers list
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -28,7 +28,7 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for followers list
         #
         #   @param page_size [Integer] Items per page (20-200, default 200)
         #

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Pagination cursor for followers-you-know
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -22,7 +22,7 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor from previous response
+        #   @param cursor [String] Pagination cursor for followers-you-know
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,13 +14,13 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for following list
         #
         #   @return [String, nil]
         optional :cursor, String
 
         # @!attribute page_size
-        #   Items per page (20-200, default 200)
+        #   Results per page (20-200, default 200)
         #
         #   @return [Integer, nil]
         optional :page_size, Integer
@@ -28,9 +28,9 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for following list
         #
-        #   @param page_size [Integer] Items per page (20-200, default 200)
+        #   @param page_size [Integer] Results per page (20-200, default 200)
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Pagination cursor for liked tweets
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -22,7 +22,7 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor from previous response
+        #   @param cursor [String] Pagination cursor for liked tweets
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Pagination cursor for media tweets
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -22,7 +22,7 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor from previous response
+        #   @param cursor [String] Pagination cursor for media tweets
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,19 +14,19 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for mentions
         #
         #   @return [String, nil]
         optional :cursor, String
 
         # @!attribute since_time
-        #   Unix timestamp - filter after
+        #   Unix timestamp - return mentions after this time
         #
         #   @return [String, nil]
         optional :since_time, String
 
         # @!attribute until_time
-        #   Unix timestamp - filter before
+        #   Unix timestamp - return mentions before this time
         #
         #   @return [String, nil]
         optional :until_time, String
@@ -34,11 +34,11 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, since_time: nil, until_time: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for mentions
         #
-        #   @param since_time [String] Unix timestamp - filter after
+        #   @param since_time [String] Unix timestamp - return mentions after this time
         #
-        #   @param until_time [String] Unix timestamp - filter before
+        #   @param until_time [String] Unix timestamp - return mentions before this time
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -8,13 +8,13 @@ module XTwitterScraper
         extend XTwitterScraper::Internal::Type::RequestParameters::Converter
         include XTwitterScraper::Internal::Type::RequestParameters
 
-        # @!attribute username
+        # @!attribute id
         #
         #   @return [String]
-        required :username, String
+        required :id, String
 
-        # @!method initialize(username:, request_options: {})
-        #   @param username [String]
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -9,21 +9,21 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute q
-        #   Search query
+        #   User search query
         #
         #   @return [String]
         required :q, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for user search
         #
         #   @return [String, nil]
         optional :cursor, String
 
         # @!method initialize(q:, cursor: nil, request_options: {})
-        #   @param q [String] Search query
+        #   @param q [String] User search query
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for user search
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Pagination cursor for user tweets
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -34,7 +34,7 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, include_parent_tweet: nil, include_replies: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor from previous response
+        #   @param cursor [String] Pagination cursor for user tweets
         #
         #   @param include_parent_tweet [Boolean] Include parent tweet for replies
         #

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for verified followers
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -22,7 +22,7 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for verified followers
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/x_twitter_scraper/models/x/users/follow_create_params.rb

@@ -9,21 +9,21 @@ module XTwitterScraper
           extend XTwitterScraper::Internal::Type::RequestParameters::Converter
           include XTwitterScraper::Internal::Type::RequestParameters
 
-          # @!attribute user_id
+          # @!attribute id
           #
           #   @return [String]
-          required :user_id, String
+          required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
 
-          # @!method initialize(user_id:, account:, request_options: {})
-          #   @param user_id [String]
+          # @!method initialize(id:, account:, request_options: {})
+          #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/x_twitter_scraper/models/x/users/follow_delete_all_params.rb

@@ -9,21 +9,21 @@ module XTwitterScraper
           extend XTwitterScraper::Internal::Type::RequestParameters::Converter
           include XTwitterScraper::Internal::Type::RequestParameters
 
-          # @!attribute user_id
+          # @!attribute id
           #
           #   @return [String]
-          required :user_id, String
+          required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
 
-          # @!method initialize(user_id:, account:, request_options: {})
-          #   @param user_id [String]
+          # @!method initialize(id:, account:, request_options: {})
+          #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

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

@@ -30,6 +30,8 @@ module XTwitterScraper
         required :x_username, String, api_name: :xUsername
 
         # @!method initialize(id:, created_at:, status:, x_user_id:, x_username:)
+        #   Linked X account summary with username and connection status.
+        #
         #   @param id [String]
         #   @param created_at [Time]
         #   @param status [String]

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

@@ -3,6 +3,7 @@
 module XTwitterScraper
   module Models
     module X
+      # @see XTwitterScraper::Resources::X::Accounts#retrieve
       class XAccountDetail < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute id
         #
@@ -45,6 +46,8 @@ module XTwitterScraper
         optional :updated_at, Time, api_name: :updatedAt
 
         # @!method initialize(id:, created_at:, status:, x_user_id:, x_username:, cookies_obtained_at: nil, proxy_country: nil, updated_at: nil)
+        #   Full X account details including proxy, cookies, and update timestamp.
+        #
         #   @param id [String]
         #   @param created_at [Time]
         #   @param status [String]

data/lib/x_twitter_scraper/models/x_get_article_response.rb

@@ -10,13 +10,15 @@ module XTwitterScraper
       required :article, -> { XTwitterScraper::Models::XGetArticleResponse::Article }
 
       # @!attribute author
+      #   Author of a tweet with follower count and verification status.
       #
-      #   @return [XTwitterScraper::Models::XGetArticleResponse::Author, nil]
-      optional :author, -> { XTwitterScraper::Models::XGetArticleResponse::Author }
+      #   @return [XTwitterScraper::Models::X::TweetAuthor, nil]
+      optional :author, -> { XTwitterScraper::X::TweetAuthor }
 
       # @!method initialize(article:, author: nil)
       #   @param article [XTwitterScraper::Models::XGetArticleResponse::Article]
-      #   @param author [XTwitterScraper::Models::XGetArticleResponse::Author]
+      #
+      #   @param author [XTwitterScraper::Models::X::TweetAuthor] Author of a tweet with follower count and verification status.
 
       # @see XTwitterScraper::Models::XGetArticleResponse#article
       class Article < XTwitterScraper::Internal::Type::BaseModel
@@ -122,41 +124,6 @@ module XTwitterScraper
           #   @param width [Integer]
         end
       end
-
-      # @see XTwitterScraper::Models::XGetArticleResponse#author
-      class Author < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute followers
-        #
-        #   @return [Integer]
-        required :followers, Integer
-
-        # @!attribute username
-        #
-        #   @return [String]
-        required :username, String
-
-        # @!attribute verified
-        #
-        #   @return [Boolean]
-        required :verified, XTwitterScraper::Internal::Type::Boolean
-
-        # @!attribute profile_picture
-        #
-        #   @return [String, nil]
-        optional :profile_picture, String, api_name: :profilePicture
-
-        # @!method initialize(id:, followers:, username:, verified:, profile_picture: nil)
-        #   @param id [String]
-        #   @param followers [Integer]
-        #   @param username [String]
-        #   @param verified [Boolean]
-        #   @param profile_picture [String]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/x_get_home_timeline_params.rb

@@ -8,7 +8,7 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute cursor
-      #   Pagination cursor from previous response
+      #   Pagination cursor for timeline
       #
       #   @return [String, nil]
       optional :cursor, String
@@ -20,7 +20,7 @@ module XTwitterScraper
       optional :seen_tweet_ids, String
 
       # @!method initialize(cursor: nil, seen_tweet_ids: nil, request_options: {})
-      #   @param cursor [String] Pagination cursor from previous response
+      #   @param cursor [String] Pagination cursor for timeline
       #
       #   @param seen_tweet_ids [String] Comma-separated tweet IDs to exclude from results
       #