x-twitter-scraper 0.4.3 → 0.4.4

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

@@ -36,6 +36,26 @@ module XTwitterScraper
         sig { returns(Integer) }
         attr_accessor :view_count
 
+        # Tweet author profile. The lookup route always includes follower count and
+        # verification state. Other profile fields appear when available.
+        sig { returns(T.nilable(XTwitterScraper::X::TweetAuthor)) }
+        attr_reader :author
+
+        sig { params(author: XTwitterScraper::X::TweetAuthor::OrHash).void }
+        attr_writer :author
+
+        # Content disclosure metadata shown by X when a tweet is labeled as paid
+        # partnership content or AI-generated media.
+        sig { returns(T.nilable(XTwitterScraper::ContentDisclosure)) }
+        attr_reader :content_disclosure
+
+        sig do
+          params(
+            content_disclosure: XTwitterScraper::ContentDisclosure::OrHash
+          ).void
+        end
+        attr_writer :content_disclosure
+
         # ID of the root tweet in the conversation thread
         sig { returns(T.nilable(String)) }
         attr_reader :conversation_id
@@ -49,6 +69,13 @@ module XTwitterScraper
         sig { params(created_at: String).void }
         attr_writer :created_at
 
+        # Start and end offsets for rendered tweet text
+        sig { returns(T.nilable(T::Array[Integer])) }
+        attr_reader :display_text_range
+
+        sig { params(display_text_range: T::Array[Integer]).void }
+        attr_writer :display_text_range
+
         # Parsed entities from the tweet text (URLs, mentions, hashtags, media)
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :entities
@@ -56,6 +83,34 @@ module XTwitterScraper
         sig { params(entities: T::Hash[Symbol, T.anything]).void }
         attr_writer :entities
 
+        # Tweet ID being replied to
+        sig { returns(T.nilable(String)) }
+        attr_reader :in_reply_to_id
+
+        sig { params(in_reply_to_id: String).void }
+        attr_writer :in_reply_to_id
+
+        # User ID being replied to
+        sig { returns(T.nilable(String)) }
+        attr_reader :in_reply_to_user_id
+
+        sig { params(in_reply_to_user_id: String).void }
+        attr_writer :in_reply_to_user_id
+
+        # Username being replied to
+        sig { returns(T.nilable(String)) }
+        attr_reader :in_reply_to_username
+
+        sig { params(in_reply_to_username: String).void }
+        attr_writer :in_reply_to_username
+
+        # Whether replies are limited for this tweet
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_limited_reply
+
+        sig { params(is_limited_reply: T::Boolean).void }
+        attr_writer :is_limited_reply
+
         # 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
@@ -77,26 +132,44 @@ module XTwitterScraper
         sig { params(is_reply: T::Boolean).void }
         attr_writer :is_reply
 
+        # Tweet language code
+        sig { returns(T.nilable(String)) }
+        attr_reader :lang
+
+        sig { params(lang: String).void }
+        attr_writer :lang
+
         # Attached media items, omitted when the tweet has no media
-        sig do
-          returns(T.nilable(T::Array[XTwitterScraper::X::TweetDetail::Media]))
-        end
+        sig { returns(T.nilable(T::Array[XTwitterScraper::TweetMedia])) }
         attr_reader :media
 
         sig do
-          params(
-            media: T::Array[XTwitterScraper::X::TweetDetail::Media::OrHash]
-          ).void
+          params(media: T::Array[XTwitterScraper::TweetMedia::OrHash]).void
         end
         attr_writer :media
 
-        # The quoted tweet object, present when isQuoteStatus is true
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        # Quoted or retweeted tweet context. Every object includes id, text, and
+        # engagement metrics. A zero metric can mean X did not report the count. Author,
+        # media, and conversation fields appear when available.
+        sig { returns(T.nilable(XTwitterScraper::EmbeddedTweet)) }
         attr_reader :quoted_tweet
 
-        sig { params(quoted_tweet: T::Hash[Symbol, T.anything]).void }
+        sig do
+          params(quoted_tweet: XTwitterScraper::EmbeddedTweet::OrHash).void
+        end
         attr_writer :quoted_tweet
 
+        # Quoted or retweeted tweet context. Every object includes id, text, and
+        # engagement metrics. A zero metric can mean X did not report the count. Author,
+        # media, and conversation fields appear when available.
+        sig { returns(T.nilable(XTwitterScraper::EmbeddedTweet)) }
+        attr_reader :retweeted_tweet
+
+        sig do
+          params(retweeted_tweet: XTwitterScraper::EmbeddedTweet::OrHash).void
+        end
+        attr_writer :retweeted_tweet
+
         # Client application used to post this tweet
         sig { returns(T.nilable(String)) }
         attr_reader :source
@@ -104,7 +177,22 @@ module XTwitterScraper
         sig { params(source: String).void }
         attr_writer :source
 
-        # Full tweet with text, engagement metrics, media, and metadata.
+        # Tweet result type
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        # Tweet permalink URL
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        # Full tweet with text, engagement metrics, media, and metadata. A zero metric can
+        # mean X did not report the count.
         sig do
           params(
             id: String,
@@ -115,15 +203,26 @@ module XTwitterScraper
             retweet_count: Integer,
             text: String,
             view_count: Integer,
+            author: XTwitterScraper::X::TweetAuthor::OrHash,
+            content_disclosure: XTwitterScraper::ContentDisclosure::OrHash,
             conversation_id: String,
             created_at: String,
+            display_text_range: T::Array[Integer],
             entities: T::Hash[Symbol, T.anything],
+            in_reply_to_id: String,
+            in_reply_to_user_id: String,
+            in_reply_to_username: String,
+            is_limited_reply: T::Boolean,
             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
+            lang: String,
+            media: T::Array[XTwitterScraper::TweetMedia::OrHash],
+            quoted_tweet: XTwitterScraper::EmbeddedTweet::OrHash,
+            retweeted_tweet: XTwitterScraper::EmbeddedTweet::OrHash,
+            source: String,
+            type: String,
+            url: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -135,23 +234,51 @@ module XTwitterScraper
           retweet_count:,
           text:,
           view_count:,
+          # Tweet author profile. The lookup route always includes follower count and
+          # verification state. Other profile fields appear when available.
+          author: nil,
+          # Content disclosure metadata shown by X when a tweet is labeled as paid
+          # partnership content or AI-generated media.
+          content_disclosure: nil,
           # ID of the root tweet in the conversation thread
           conversation_id: nil,
           created_at: nil,
+          # Start and end offsets for rendered tweet text
+          display_text_range: nil,
           # Parsed entities from the tweet text (URLs, mentions, hashtags, media)
           entities: nil,
+          # Tweet ID being replied to
+          in_reply_to_id: nil,
+          # User ID being replied to
+          in_reply_to_user_id: nil,
+          # Username being replied to
+          in_reply_to_username: nil,
+          # Whether replies are limited for this tweet
+          is_limited_reply: 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,
+          # Tweet language code
+          lang: nil,
           # Attached media items, omitted when the tweet has no media
           media: nil,
-          # The quoted tweet object, present when isQuoteStatus is true
+          # Quoted or retweeted tweet context. Every object includes id, text, and
+          # engagement metrics. A zero metric can mean X did not report the count. Author,
+          # media, and conversation fields appear when available.
           quoted_tweet: nil,
+          # Quoted or retweeted tweet context. Every object includes id, text, and
+          # engagement metrics. A zero metric can mean X did not report the count. Author,
+          # media, and conversation fields appear when available.
+          retweeted_tweet: nil,
           # Client application used to post this tweet
-          source: nil
+          source: nil,
+          # Tweet result type
+          type: nil,
+          # Tweet permalink URL
+          url: nil
         )
         end
 
@@ -166,117 +293,31 @@ module XTwitterScraper
               retweet_count: Integer,
               text: String,
               view_count: Integer,
+              author: XTwitterScraper::X::TweetAuthor,
+              content_disclosure: XTwitterScraper::ContentDisclosure,
               conversation_id: String,
               created_at: String,
+              display_text_range: T::Array[Integer],
               entities: T::Hash[Symbol, T.anything],
+              in_reply_to_id: String,
+              in_reply_to_user_id: String,
+              in_reply_to_username: String,
+              is_limited_reply: T::Boolean,
               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
+              lang: String,
+              media: T::Array[XTwitterScraper::TweetMedia],
+              quoted_tweet: XTwitterScraper::EmbeddedTweet,
+              retweeted_tweet: XTwitterScraper::EmbeddedTweet,
+              source: String,
+              type: String,
+              url: 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

@@ -25,10 +25,21 @@ module XTwitterScraper
         sig { params(cursor: String).void }
         attr_writer :cursor
 
+        # Maximum user profiles requested from this page (20-200, default 200). The
+        # response can contain fewer profiles because the source returned fewer or
+        # remaining credits cover fewer results. Keep requesting next_cursor while
+        # has_next_page is true. The deprecated limit and count aliases remain accepted.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -36,6 +47,11 @@ module XTwitterScraper
           id:,
           # Pagination cursor for favoriters
           cursor: nil,
+          # Maximum user profiles requested from this page (20-200, default 200). The
+          # response can contain fewer profiles because the source returned fewer or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true. The deprecated limit and count aliases remain accepted.
+          page_size: nil,
           request_options: {}
         )
         end
@@ -45,6 +61,7 @@ module XTwitterScraper
             {
               id: String,
               cursor: String,
+              page_size: Integer,
               request_options: XTwitterScraper::RequestOptions
             }
           )