x-twitter-scraper 0.3.0 → 0.4.0

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for community moderators
         #
         #   @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 community moderators
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -15,7 +15,7 @@ module XTwitterScraper
         required :q, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for community search
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -29,7 +29,7 @@ module XTwitterScraper
         # @!method initialize(q:, cursor: nil, query_type: nil, request_options: {})
         #   @param q [String] Search query
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for community search
         #
         #   @param query_type [String] Sort order (Latest or Top)
         #

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :user_id, String
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Pagination cursor for DM history
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -28,7 +28,7 @@ module XTwitterScraper
         # @!method initialize(user_id:, cursor: nil, max_id: nil, request_options: {})
         #   @param user_id [String]
         #
-        #   @param cursor [String] Pagination cursor from previous response
+        #   @param cursor [String] Pagination cursor for DM history
         #
         #   @param max_id [String] Legacy pagination cursor (backward compat)
         #

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :user_id, String
 
         # @!attribute account
-        #   X account (@username or account ID)
+        #   X account (@username or ID) sending the DM
         #
         #   @return [String]
         required :account, String
@@ -37,7 +37,7 @@ module XTwitterScraper
         # @!method initialize(user_id:, account:, text:, media_ids: nil, reply_to_message_id: nil, request_options: {})
         #   @param user_id [String]
         #
-        #   @param account [String] X account (@username or account ID)
+        #   @param account [String] X account (@username or ID) sending the DM
         #
         #   @param text [String]
         #

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for list 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 list followers
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for list members
         #
         #   @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 list members
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for list tweets
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -40,7 +40,7 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, include_replies: nil, since_time: nil, until_time: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for list tweets
         #
         #   @param include_replies [Boolean] Include replies (default false)
         #

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

@@ -9,7 +9,7 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute account
-        #   X account (@username or account ID)
+        #   X account (@username or ID) uploading media
         #
         #   @return [String]
         required :account, String
@@ -26,7 +26,7 @@ module XTwitterScraper
         optional :is_long_video, XTwitterScraper::Internal::Type::Boolean
 
         # @!method initialize(account:, file:, is_long_video: nil, request_options: {})
-        #   @param account [String] X account (@username or account ID)
+        #   @param account [String] X account (@username or ID) uploading media
         #
         #   @param file [Pathname, StringIO, IO, String, XTwitterScraper::FilePart] Media file to upload
         #

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

@@ -9,7 +9,7 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute account
-        #   X account (@username or account ID)
+        #   X account (@username or ID) for avatar update
         #
         #   @return [String]
         required :account, String
@@ -21,7 +21,7 @@ module XTwitterScraper
         required :file, XTwitterScraper::Internal::Type::FileInput
 
         # @!method initialize(account:, file:, request_options: {})
-        #   @param account [String] X account (@username or account ID)
+        #   @param account [String] X account (@username or ID) for avatar update
         #
         #   @param file [Pathname, StringIO, IO, String, XTwitterScraper::FilePart] Avatar image (max 716KB)
         #

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

@@ -9,7 +9,7 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute account
-        #   X account (@username or account ID)
+        #   X account (@username or ID) for banner update
         #
         #   @return [String]
         required :account, String
@@ -21,7 +21,7 @@ module XTwitterScraper
         required :file, XTwitterScraper::Internal::Type::FileInput
 
         # @!method initialize(account:, file:, request_options: {})
-        #   @param account [String] X account (@username or account ID)
+        #   @param account [String] X account (@username or ID) for banner update
         #
         #   @param file [Pathname, StringIO, IO, String, XTwitterScraper::FilePart] Banner image (max 2MB)
         #

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

@@ -9,7 +9,7 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute account
-        #   X account (@username or account ID)
+        #   X account (@username or ID) to update profile
         #
         #   @return [String]
         required :account, String
@@ -38,7 +38,7 @@ module XTwitterScraper
         optional :url, String
 
         # @!method initialize(account:, description: nil, location: nil, name: nil, url: nil, request_options: {})
-        #   @param account [String] X account (@username or account ID)
+        #   @param account [String] X account (@username or ID) to update profile
         #
         #   @param description [String] Bio description
         #

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

@@ -29,6 +29,12 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :created_at, String, api_name: :createdAt
 
+        # @!attribute is_note_tweet
+        #   True for Note Tweets (long-form content, up to 25,000 characters)
+        #
+        #   @return [Boolean, nil]
+        optional :is_note_tweet, XTwitterScraper::Internal::Type::Boolean, api_name: :isNoteTweet
+
         # @!attribute like_count
         #
         #   @return [Integer, nil]
@@ -54,16 +60,29 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :view_count, Integer, api_name: :viewCount
 
-        # @!method initialize(id:, text:, author: nil, bookmark_count: nil, created_at: nil, like_count: nil, quote_count: nil, reply_count: nil, retweet_count: nil, view_count: nil)
+        # @!method initialize(id:, text:, author: nil, bookmark_count: nil, created_at: nil, is_note_tweet: nil, like_count: nil, quote_count: nil, reply_count: nil, retweet_count: nil, view_count: nil)
+        #   Tweet returned from search results with inline author info.
+        #
         #   @param id [String]
+        #
         #   @param text [String]
+        #
         #   @param author [XTwitterScraper::Models::X::SearchTweet::Author]
+        #
         #   @param bookmark_count [Integer]
+        #
         #   @param created_at [String]
+        #
+        #   @param is_note_tweet [Boolean] True for Note Tweets (long-form content, up to 25,000 characters)
+        #
         #   @param like_count [Integer]
+        #
         #   @param quote_count [Integer]
+        #
         #   @param reply_count [Integer]
+        #
         #   @param retweet_count [Integer]
+        #
         #   @param view_count [Integer]
 
         # @see XTwitterScraper::Models::X::SearchTweet#author

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

@@ -30,6 +30,8 @@ module XTwitterScraper
         optional :profile_picture, String, api_name: :profilePicture
 
         # @!method initialize(id:, followers:, username:, verified:, profile_picture: nil)
+        #   Author of a tweet with follower count and verification status.
+        #
         #   @param id [String]
         #   @param followers [Integer]
         #   @param username [String]

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

@@ -8,21 +8,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/tweet_detail.rb

@@ -44,21 +44,129 @@ module XTwitterScraper
         #   @return [Integer]
         required :view_count, Integer, api_name: :viewCount
 
+        # @!attribute conversation_id
+        #   ID of the root tweet in the conversation thread
+        #
+        #   @return [String, nil]
+        optional :conversation_id, String, api_name: :conversationId
+
         # @!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)
+        # @!attribute entities
+        #   Parsed entities from the tweet text (URLs, mentions, hashtags, media)
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :entities, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+
+        # @!attribute is_note_tweet
+        #   Whether this is a Note Tweet (long-form post, up to 25,000 characters)
+        #
+        #   @return [Boolean, nil]
+        optional :is_note_tweet, XTwitterScraper::Internal::Type::Boolean, api_name: :isNoteTweet
+
+        # @!attribute is_quote_status
+        #   Whether this tweet quotes another tweet
+        #
+        #   @return [Boolean, nil]
+        optional :is_quote_status, XTwitterScraper::Internal::Type::Boolean, api_name: :isQuoteStatus
+
+        # @!attribute is_reply
+        #   Whether this tweet is a reply to another tweet
+        #
+        #   @return [Boolean, nil]
+        optional :is_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isReply
+
+        # @!attribute media
+        #   Attached media items, omitted when the tweet has no media
+        #
+        #   @return [Array<XTwitterScraper::Models::X::TweetDetail::Media>, nil]
+        optional :media, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::X::TweetDetail::Media] }
+
+        # @!attribute quoted_tweet
+        #   The quoted tweet object, present when isQuoteStatus is true
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :quoted_tweet, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+
+        # @!attribute source
+        #   Client application used to post this tweet
+        #
+        #   @return [String, nil]
+        optional :source, String
+
+        # @!method initialize(id:, bookmark_count:, like_count:, quote_count:, reply_count:, retweet_count:, text:, view_count:, conversation_id: nil, created_at: nil, entities: nil, is_note_tweet: nil, is_quote_status: nil, is_reply: nil, media: nil, quoted_tweet: nil, source: nil)
+        #   Full tweet with text, engagement metrics, media, and metadata.
+        #
         #   @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 conversation_id [String] ID of the root tweet in the conversation thread
+        #
         #   @param created_at [String]
+        #
+        #   @param entities [Hash{Symbol=>Object}] Parsed entities from the tweet text (URLs, mentions, hashtags, media)
+        #
+        #   @param is_note_tweet [Boolean] Whether this is a Note Tweet (long-form post, up to 25,000 characters)
+        #
+        #   @param is_quote_status [Boolean] Whether this tweet quotes another tweet
+        #
+        #   @param is_reply [Boolean] Whether this tweet is a reply to another tweet
+        #
+        #   @param media [Array<XTwitterScraper::Models::X::TweetDetail::Media>] Attached media items, omitted when the tweet has no media
+        #
+        #   @param quoted_tweet [Hash{Symbol=>Object}] The quoted tweet object, present when isQuoteStatus is true
+        #
+        #   @param source [String] Client application used to post this tweet
+
+        class Media < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute media_url
+          #
+          #   @return [String, nil]
+          optional :media_url, String, api_name: :mediaUrl
+
+          # @!attribute type
+          #
+          #   @return [Symbol, XTwitterScraper::Models::X::TweetDetail::Media::Type, nil]
+          optional :type, enum: -> { XTwitterScraper::X::TweetDetail::Media::Type }
+
+          # @!attribute url
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(media_url: nil, type: nil, url: nil)
+          #   @param media_url [String]
+          #   @param type [Symbol, XTwitterScraper::Models::X::TweetDetail::Media::Type]
+          #   @param url [String]
+
+          # @see XTwitterScraper::Models::X::TweetDetail::Media#type
+          module Type
+            extend XTwitterScraper::Internal::Type::Enum
+
+            PHOTO = :photo
+            VIDEO = :video
+            ANIMATED_GIF = :animated_gif
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
     end
   end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Pagination cursor for favoriters
         #
         #   @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 favoriters
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,25 +14,25 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for quote tweets
         #
         #   @return [String, nil]
         optional :cursor, String
 
         # @!attribute include_replies
-        #   Include replies (default false)
+        #   Include reply quotes (default false)
         #
         #   @return [Boolean, nil]
         optional :include_replies, XTwitterScraper::Internal::Type::Boolean
 
         # @!attribute since_time
-        #   Unix timestamp - filter after
+        #   Unix timestamp - return quotes posted after this time
         #
         #   @return [String, nil]
         optional :since_time, String
 
         # @!attribute until_time
-        #   Unix timestamp - filter before
+        #   Unix timestamp - return quotes posted before this time
         #
         #   @return [String, nil]
         optional :until_time, String
@@ -40,13 +40,13 @@ module XTwitterScraper
         # @!method initialize(id:, cursor: nil, include_replies: nil, since_time: nil, until_time: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param cursor [String] Pagination cursor
+        #   @param cursor [String] Pagination cursor for quote tweets
         #
-        #   @param include_replies [Boolean] Include replies (default false)
+        #   @param include_replies [Boolean] Include reply quotes (default false)
         #
-        #   @param since_time [String] Unix timestamp - filter after
+        #   @param since_time [String] Unix timestamp - return quotes posted after this time
         #
-        #   @param until_time [String] Unix timestamp - filter before
+        #   @param until_time [String] Unix timestamp - return quotes posted before this time
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,19 +14,19 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for tweet replies
         #
         #   @return [String, nil]
         optional :cursor, String
 
         # @!attribute since_time
-        #   Unix timestamp - filter after
+        #   Unix timestamp - return replies posted after this time
         #
         #   @return [String, nil]
         optional :since_time, String
 
         # @!attribute until_time
-        #   Unix timestamp - filter before
+        #   Unix timestamp - return replies posted 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 tweet replies
         #
-        #   @param since_time [String] Unix timestamp - filter after
+        #   @param since_time [String] Unix timestamp - return replies posted after this time
         #
-        #   @param until_time [String] Unix timestamp - filter before
+        #   @param until_time [String] Unix timestamp - return replies posted before this time
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for retweeters
         #
         #   @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 retweeters
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute cursor
-        #   Pagination cursor
+        #   Pagination cursor for thread 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
+        #   @param cursor [String] Pagination cursor for thread tweets
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -8,13 +8,13 @@ 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
 
-        # @!method initialize(tweet_id:, request_options: {})
-        #   @param tweet_id [String]
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end
     end