x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/models/x/media_upload_params.rbi

@@ -15,7 +15,7 @@ module XTwitterScraper
             )
           end
 
-        # X account (@username or account ID)
+        # X account (@username or ID) uploading media
         sig { returns(String) }
         attr_accessor :account
 
@@ -38,7 +38,7 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # X account (@username or account ID)
+          # X account (@username or ID) uploading media
           account:,
           # Media file to upload
           file:,

data/rbi/x_twitter_scraper/models/x/profile_update_avatar_params.rbi

@@ -15,7 +15,7 @@ module XTwitterScraper
             )
           end
 
-        # X account (@username or account ID)
+        # X account (@username or ID) for avatar update
         sig { returns(String) }
         attr_accessor :account
 
@@ -31,7 +31,7 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # X account (@username or account ID)
+          # X account (@username or ID) for avatar update
           account:,
           # Avatar image (max 716KB)
           file:,

data/rbi/x_twitter_scraper/models/x/profile_update_banner_params.rbi

@@ -15,7 +15,7 @@ module XTwitterScraper
             )
           end
 
-        # X account (@username or account ID)
+        # X account (@username or ID) for banner update
         sig { returns(String) }
         attr_accessor :account
 
@@ -31,7 +31,7 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # X account (@username or account ID)
+          # X account (@username or ID) for banner update
           account:,
           # Banner image (max 2MB)
           file:,

data/rbi/x_twitter_scraper/models/x/profile_update_params.rbi

@@ -15,7 +15,7 @@ module XTwitterScraper
             )
           end
 
-        # X account (@username or account ID)
+        # X account (@username or ID) to update profile
         sig { returns(String) }
         attr_accessor :account
 
@@ -57,7 +57,7 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # X account (@username or account ID)
+          # X account (@username or ID) to update profile
           account:,
           # Bio description
           description: nil,

data/rbi/x_twitter_scraper/models/x/search_tweet.rbi

@@ -38,6 +38,13 @@ module XTwitterScraper
         sig { params(created_at: String).void }
         attr_writer :created_at
 
+        # True for Note Tweets (long-form content, up to 25,000 characters)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_note_tweet
+
+        sig { params(is_note_tweet: T::Boolean).void }
+        attr_writer :is_note_tweet
+
         sig { returns(T.nilable(Integer)) }
         attr_reader :like_count
 
@@ -68,6 +75,7 @@ module XTwitterScraper
         sig { params(view_count: Integer).void }
         attr_writer :view_count
 
+        # Tweet returned from search results with inline author info.
         sig do
           params(
             id: String,
@@ -75,6 +83,7 @@ module XTwitterScraper
             author: XTwitterScraper::X::SearchTweet::Author::OrHash,
             bookmark_count: Integer,
             created_at: String,
+            is_note_tweet: T::Boolean,
             like_count: Integer,
             quote_count: Integer,
             reply_count: Integer,
@@ -88,6 +97,8 @@ module XTwitterScraper
           author: nil,
           bookmark_count: nil,
           created_at: nil,
+          # True for Note Tweets (long-form content, up to 25,000 characters)
+          is_note_tweet: nil,
           like_count: nil,
           quote_count: nil,
           reply_count: nil,
@@ -104,6 +115,7 @@ module XTwitterScraper
               author: XTwitterScraper::X::SearchTweet::Author,
               bookmark_count: Integer,
               created_at: String,
+              is_note_tweet: T::Boolean,
               like_count: Integer,
               quote_count: Integer,
               reply_count: Integer,

data/rbi/x_twitter_scraper/models/x/tweet_author.rbi

@@ -30,6 +30,7 @@ module XTwitterScraper
         sig { params(profile_picture: String).void }
         attr_writer :profile_picture
 
+        # Author of a tweet with follower count and verification status.
         sig do
           params(
             id: String,

data/rbi/x_twitter_scraper/models/x/tweet_delete_params.rbi

@@ -16,22 +16,22 @@ module XTwitterScraper
           end
 
         sig { returns(String) }
-        attr_accessor :tweet_id
+        attr_accessor :id
 
-        # X account (@username or account ID)
+        # X account identifier (@username or account ID)
         sig { returns(String) }
         attr_accessor :account
 
         sig do
           params(
-            tweet_id: String,
+            id: String,
             account: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          tweet_id:,
-          # X account (@username or account ID)
+          id:,
+          # X account identifier (@username or account ID)
           account:,
           request_options: {}
         )
@@ -40,7 +40,7 @@ module XTwitterScraper
         sig do
           override.returns(
             {
-              tweet_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions
             }

data/rbi/x_twitter_scraper/models/x/tweet_detail.rbi

@@ -36,12 +36,75 @@ module XTwitterScraper
         sig { returns(Integer) }
         attr_accessor :view_count
 
+        # ID of the root tweet in the conversation thread
+        sig { returns(T.nilable(String)) }
+        attr_reader :conversation_id
+
+        sig { params(conversation_id: String).void }
+        attr_writer :conversation_id
+
         sig { returns(T.nilable(String)) }
         attr_reader :created_at
 
         sig { params(created_at: String).void }
         attr_writer :created_at
 
+        # Parsed entities from the tweet text (URLs, mentions, hashtags, media)
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :entities
+
+        sig { params(entities: T::Hash[Symbol, T.anything]).void }
+        attr_writer :entities
+
+        # Whether this is a Note Tweet (long-form post, up to 25,000 characters)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_note_tweet
+
+        sig { params(is_note_tweet: T::Boolean).void }
+        attr_writer :is_note_tweet
+
+        # Whether this tweet quotes another tweet
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_quote_status
+
+        sig { params(is_quote_status: T::Boolean).void }
+        attr_writer :is_quote_status
+
+        # Whether this tweet is a reply to another tweet
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_reply
+
+        sig { params(is_reply: T::Boolean).void }
+        attr_writer :is_reply
+
+        # Attached media items, omitted when the tweet has no media
+        sig do
+          returns(T.nilable(T::Array[XTwitterScraper::X::TweetDetail::Media]))
+        end
+        attr_reader :media
+
+        sig do
+          params(
+            media: T::Array[XTwitterScraper::X::TweetDetail::Media::OrHash]
+          ).void
+        end
+        attr_writer :media
+
+        # The quoted tweet object, present when isQuoteStatus is true
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :quoted_tweet
+
+        sig { params(quoted_tweet: T::Hash[Symbol, T.anything]).void }
+        attr_writer :quoted_tweet
+
+        # Client application used to post this tweet
+        sig { returns(T.nilable(String)) }
+        attr_reader :source
+
+        sig { params(source: String).void }
+        attr_writer :source
+
+        # Full tweet with text, engagement metrics, media, and metadata.
         sig do
           params(
             id: String,
@@ -52,7 +115,15 @@ module XTwitterScraper
             retweet_count: Integer,
             text: String,
             view_count: Integer,
-            created_at: String
+            conversation_id: String,
+            created_at: String,
+            entities: T::Hash[Symbol, T.anything],
+            is_note_tweet: T::Boolean,
+            is_quote_status: T::Boolean,
+            is_reply: T::Boolean,
+            media: T::Array[XTwitterScraper::X::TweetDetail::Media::OrHash],
+            quoted_tweet: T::Hash[Symbol, T.anything],
+            source: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -64,7 +135,23 @@ module XTwitterScraper
           retweet_count:,
           text:,
           view_count:,
-          created_at: nil
+          # ID of the root tweet in the conversation thread
+          conversation_id: nil,
+          created_at: nil,
+          # Parsed entities from the tweet text (URLs, mentions, hashtags, media)
+          entities: nil,
+          # Whether this is a Note Tweet (long-form post, up to 25,000 characters)
+          is_note_tweet: nil,
+          # Whether this tweet quotes another tweet
+          is_quote_status: nil,
+          # Whether this tweet is a reply to another tweet
+          is_reply: nil,
+          # Attached media items, omitted when the tweet has no media
+          media: nil,
+          # The quoted tweet object, present when isQuoteStatus is true
+          quoted_tweet: nil,
+          # Client application used to post this tweet
+          source: nil
         )
         end
 
@@ -79,12 +166,117 @@ module XTwitterScraper
               retweet_count: Integer,
               text: String,
               view_count: Integer,
-              created_at: String
+              conversation_id: String,
+              created_at: String,
+              entities: T::Hash[Symbol, T.anything],
+              is_note_tweet: T::Boolean,
+              is_quote_status: T::Boolean,
+              is_reply: T::Boolean,
+              media: T::Array[XTwitterScraper::X::TweetDetail::Media],
+              quoted_tweet: T::Hash[Symbol, T.anything],
+              source: String
             }
           )
         end
         def to_hash
         end
+
+        class Media < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::X::TweetDetail::Media,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :media_url
+
+          sig { params(media_url: String).void }
+          attr_writer :media_url
+
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::X::TweetDetail::Media::Type::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type: XTwitterScraper::X::TweetDetail::Media::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :url
+
+          sig { params(url: String).void }
+          attr_writer :url
+
+          sig do
+            params(
+              media_url: String,
+              type: XTwitterScraper::X::TweetDetail::Media::Type::OrSymbol,
+              url: String
+            ).returns(T.attached_class)
+          end
+          def self.new(media_url: nil, type: nil, url: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                media_url: String,
+                type:
+                  XTwitterScraper::X::TweetDetail::Media::Type::TaggedSymbol,
+                url: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Type
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, XTwitterScraper::X::TweetDetail::Media::Type)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PHOTO =
+              T.let(
+                :photo,
+                XTwitterScraper::X::TweetDetail::Media::Type::TaggedSymbol
+              )
+            VIDEO =
+              T.let(
+                :video,
+                XTwitterScraper::X::TweetDetail::Media::Type::TaggedSymbol
+              )
+            ANIMATED_GIF =
+              T.let(
+                :animated_gif,
+                XTwitterScraper::X::TweetDetail::Media::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::X::TweetDetail::Media::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
     end
   end

data/rbi/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor from previous response
+        # Pagination cursor for favoriters
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -34,7 +34,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor from previous response
+          # Pagination cursor for favoriters
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/tweet_get_quotes_params.rbi

@@ -18,28 +18,28 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for quote tweets
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Include replies (default false)
+        # Include reply quotes (default false)
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :include_replies
 
         sig { params(include_replies: T::Boolean).void }
         attr_writer :include_replies
 
-        # Unix timestamp - filter after
+        # Unix timestamp - return quotes posted after this time
         sig { returns(T.nilable(String)) }
         attr_reader :since_time
 
         sig { params(since_time: String).void }
         attr_writer :since_time
 
-        # Unix timestamp - filter before
+        # Unix timestamp - return quotes posted before this time
         sig { returns(T.nilable(String)) }
         attr_reader :until_time
 
@@ -58,13 +58,13 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for quote tweets
           cursor: nil,
-          # Include replies (default false)
+          # Include reply quotes (default false)
           include_replies: nil,
-          # Unix timestamp - filter after
+          # Unix timestamp - return quotes posted after this time
           since_time: nil,
-          # Unix timestamp - filter before
+          # Unix timestamp - return quotes posted before this time
           until_time: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/tweet_get_replies_params.rbi

@@ -18,21 +18,21 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for tweet replies
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Unix timestamp - filter after
+        # Unix timestamp - return replies posted after this time
         sig { returns(T.nilable(String)) }
         attr_reader :since_time
 
         sig { params(since_time: String).void }
         attr_writer :since_time
 
-        # Unix timestamp - filter before
+        # Unix timestamp - return replies posted before this time
         sig { returns(T.nilable(String)) }
         attr_reader :until_time
 
@@ -50,11 +50,11 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for tweet replies
           cursor: nil,
-          # Unix timestamp - filter after
+          # Unix timestamp - return replies posted after this time
           since_time: nil,
-          # Unix timestamp - filter before
+          # Unix timestamp - return replies posted before this time
           until_time: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for retweeters
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -34,7 +34,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for retweeters
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/tweet_get_thread_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for thread tweets
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -34,7 +34,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for thread tweets
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/tweet_retrieve_params.rbi

@@ -16,23 +16,20 @@ module XTwitterScraper
           end
 
         sig { returns(String) }
-        attr_accessor :tweet_id
+        attr_accessor :id
 
         sig do
           params(
-            tweet_id: String,
+            id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(tweet_id:, request_options: {})
+        def self.new(id:, request_options: {})
         end
 
         sig do
           override.returns(
-            {
-              tweet_id: String,
-              request_options: XTwitterScraper::RequestOptions
-            }
+            { id: String, request_options: XTwitterScraper::RequestOptions }
           )
         end
         def to_hash