x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/models/x/tweet_retrieve_response.rbi

@@ -12,199 +12,44 @@ module XTwitterScraper
             )
           end
 
-        sig do
-          returns(XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet)
-        end
+        # Full tweet with text, engagement metrics, media, and metadata.
+        sig { returns(XTwitterScraper::X::TweetDetail) }
         attr_reader :tweet
 
-        sig do
-          params(
-            tweet:
-              XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet::OrHash
-          ).void
-        end
+        sig { params(tweet: XTwitterScraper::X::TweetDetail::OrHash).void }
         attr_writer :tweet
 
-        sig do
-          returns(
-            T.nilable(XTwitterScraper::Models::X::TweetRetrieveResponse::Author)
-          )
-        end
+        # Author of a tweet with follower count and verification status.
+        sig { returns(T.nilable(XTwitterScraper::X::TweetAuthor)) }
         attr_reader :author
 
-        sig do
-          params(
-            author:
-              XTwitterScraper::Models::X::TweetRetrieveResponse::Author::OrHash
-          ).void
-        end
+        sig { params(author: XTwitterScraper::X::TweetAuthor::OrHash).void }
         attr_writer :author
 
         sig do
           params(
-            tweet:
-              XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet::OrHash,
-            author:
-              XTwitterScraper::Models::X::TweetRetrieveResponse::Author::OrHash
+            tweet: XTwitterScraper::X::TweetDetail::OrHash,
+            author: XTwitterScraper::X::TweetAuthor::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(tweet:, author: nil)
+        def self.new(
+          # Full tweet with text, engagement metrics, media, and metadata.
+          tweet:,
+          # Author of a tweet with follower count and verification status.
+          author: nil
+        )
         end
 
         sig do
           override.returns(
             {
-              tweet: XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet,
-              author: XTwitterScraper::Models::X::TweetRetrieveResponse::Author
+              tweet: XTwitterScraper::X::TweetDetail,
+              author: XTwitterScraper::X::TweetAuthor
             }
           )
         end
         def to_hash
         end
-
-        class Tweet < XTwitterScraper::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                XTwitterScraper::Models::X::TweetRetrieveResponse::Tweet,
-                XTwitterScraper::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :id
-
-          sig { returns(Integer) }
-          attr_accessor :bookmark_count
-
-          sig { returns(Integer) }
-          attr_accessor :like_count
-
-          sig { returns(Integer) }
-          attr_accessor :quote_count
-
-          sig { returns(Integer) }
-          attr_accessor :reply_count
-
-          sig { returns(Integer) }
-          attr_accessor :retweet_count
-
-          sig { returns(String) }
-          attr_accessor :text
-
-          sig { returns(Integer) }
-          attr_accessor :view_count
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :created_at
-
-          sig { params(created_at: String).void }
-          attr_writer :created_at
-
-          sig do
-            params(
-              id: String,
-              bookmark_count: Integer,
-              like_count: Integer,
-              quote_count: Integer,
-              reply_count: Integer,
-              retweet_count: Integer,
-              text: String,
-              view_count: Integer,
-              created_at: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            id:,
-            bookmark_count:,
-            like_count:,
-            quote_count:,
-            reply_count:,
-            retweet_count:,
-            text:,
-            view_count:,
-            created_at: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                bookmark_count: Integer,
-                like_count: Integer,
-                quote_count: Integer,
-                reply_count: Integer,
-                retweet_count: Integer,
-                text: String,
-                view_count: Integer,
-                created_at: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        class Author < XTwitterScraper::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                XTwitterScraper::Models::X::TweetRetrieveResponse::Author,
-                XTwitterScraper::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :id
-
-          sig { returns(Integer) }
-          attr_accessor :followers
-
-          sig { returns(String) }
-          attr_accessor :username
-
-          sig { returns(T::Boolean) }
-          attr_accessor :verified
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :profile_picture
-
-          sig { params(profile_picture: String).void }
-          attr_writer :profile_picture
-
-          sig do
-            params(
-              id: String,
-              followers: Integer,
-              username: String,
-              verified: T::Boolean,
-              profile_picture: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            id:,
-            followers:,
-            username:,
-            verified:,
-            profile_picture: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                followers: Integer,
-                username: String,
-                verified: T::Boolean,
-                profile_picture: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
       end
     end
   end

data/rbi/x_twitter_scraper/models/x/tweet_search_params.rbi

@@ -26,7 +26,7 @@ module XTwitterScraper
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Deprecated — use cursor-based pagination instead
+        # Max tweets to return (server paginates internally). Omit for single page (~20).
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
@@ -82,7 +82,7 @@ module XTwitterScraper
           q:,
           # Pagination cursor from previous response
           cursor: nil,
-          # Deprecated — use cursor-based pagination instead
+          # Max tweets to return (server paginates internally). Omit for single page (~20).
           limit: nil,
           # Sort order — Latest (chronological) or Top (engagement-ranked)
           query_type: nil,

data/rbi/x_twitter_scraper/models/x/tweets/like_create_params.rbi

@@ -17,22 +17,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: {}
           )
@@ -41,7 +41,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/tweets/like_delete_params.rbi

@@ -17,22 +17,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: {}
           )
@@ -41,7 +41,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/tweets/retweet_create_params.rbi

@@ -17,22 +17,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: {}
           )
@@ -41,7 +41,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/tweets/retweet_delete_params.rbi

@@ -17,22 +17,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: {}
           )
@@ -41,7 +41,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/user_profile.rbi

@@ -69,6 +69,7 @@ module XTwitterScraper
         sig { params(verified: T::Boolean).void }
         attr_writer :verified
 
+        # X user profile with bio, follower counts, and verification status.
         sig do
           params(
             id: String,

data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for followers list
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -42,7 +42,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for followers list
           cursor: nil,
           # Items per page (20-200, default 200)
           page_size: nil,

data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor from previous response
+        # Pagination cursor for followers-you-know
         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 followers-you-know
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/user_retrieve_following_params.rbi

@@ -18,14 +18,14 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for following list
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Items per page (20-200, default 200)
+        # Results per page (20-200, default 200)
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
 
@@ -42,9 +42,9 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for following list
           cursor: nil,
-          # Items per page (20-200, default 200)
+          # Results per page (20-200, default 200)
           page_size: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/user_retrieve_likes_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor from previous response
+        # Pagination cursor for liked tweets
         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 liked tweets
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/user_retrieve_media_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor from previous response
+        # Pagination cursor for media tweets
         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 media tweets
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbi

@@ -18,21 +18,21 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for mentions
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Unix timestamp - filter after
+        # Unix timestamp - return mentions 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 mentions 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 mentions
           cursor: nil,
-          # Unix timestamp - filter after
+          # Unix timestamp - return mentions after this time
           since_time: nil,
-          # Unix timestamp - filter before
+          # Unix timestamp - return mentions before this time
           until_time: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/user_retrieve_params.rbi

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

data/rbi/x_twitter_scraper/models/x/user_retrieve_search_params.rbi

@@ -15,11 +15,11 @@ module XTwitterScraper
             )
           end
 
-        # Search query
+        # User search query
         sig { returns(String) }
         attr_accessor :q
 
-        # Pagination cursor
+        # Pagination cursor for user search
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -34,9 +34,9 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # Search query
+          # User search query
           q:,
-          # Pagination cursor
+          # Pagination cursor for user search
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor from previous response
+        # Pagination cursor for user tweets
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -50,7 +50,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor from previous response
+          # Pagination cursor for user tweets
           cursor: nil,
           # Include parent tweet for replies
           include_parent_tweet: nil,

data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbi

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

data/rbi/x_twitter_scraper/models/x/users/follow_create_params.rbi

@@ -17,22 +17,22 @@ module XTwitterScraper
             end
 
           sig { returns(String) }
-          attr_accessor :user_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(
-              user_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
-            user_id:,
-            # X account (@username or account ID)
+            id:,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )
@@ -41,7 +41,7 @@ module XTwitterScraper
           sig do
             override.returns(
               {
-                user_id: String,
+                id: String,
                 account: String,
                 request_options: XTwitterScraper::RequestOptions
               }