x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/resources/trends.rbi

@@ -4,7 +4,7 @@ module XTwitterScraper
   module Resources
     # Trending topics by region
     class Trends
-      # Get trending topics
+      # Get regional trending topics
       sig do
         params(
           count: Integer,
@@ -13,6 +13,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::TrendListResponse)
       end
       def list(
+        # Number of trending topics to return (1-50, default 30)
         count: nil,
         # Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
         woeid: nil,

data/rbi/x_twitter_scraper/resources/webhooks.rbi

@@ -7,13 +7,13 @@ module XTwitterScraper
       # Create webhook
       sig do
         params(
-          event_types:
-            T::Array[XTwitterScraper::WebhookCreateParams::EventType::OrSymbol],
+          event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           url: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::WebhookCreateResponse)
       end
       def create(
+        # Array of event types to subscribe to.
         event_types:,
         # HTTPS URL
         url:,
@@ -25,16 +25,16 @@ module XTwitterScraper
       sig do
         params(
           id: String,
-          event_types:
-            T::Array[XTwitterScraper::WebhookUpdateParams::EventType::OrSymbol],
+          event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           is_active: T::Boolean,
           url: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::WebhookUpdateResponse)
+        ).returns(XTwitterScraper::Webhook)
       end
       def update(
         # Resource ID (stringified bigint)
         id,
+        # Array of event types to subscribe to.
         event_types: nil,
         is_active: nil,
         url: nil,

data/rbi/x_twitter_scraper/resources/x/accounts.rbi

@@ -36,7 +36,7 @@ module XTwitterScraper
           params(
             id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::AccountRetrieveResponse)
+          ).returns(XTwitterScraper::X::XAccountDetail)
         end
         def retrieve(
           # Resource ID (stringified bigint)
@@ -68,6 +68,16 @@ module XTwitterScraper
         )
         end
 
+        # Clears loginFailedAt and loginFailureReason for all accounts with transient or
+        # automated failure reasons, making them eligible for retry on next use.
+        sig do
+          params(
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::AccountBulkRetryResponse)
+        end
+        def bulk_retry(request_options: {})
+        end
+
         # Re-authenticate X account
         sig do
           params(
@@ -80,9 +90,9 @@ module XTwitterScraper
         def reauth(
           # Resource ID (stringified bigint)
           id,
-          # Account password
+          # Updated account password
           password:,
-          # TOTP secret for 2FA
+          # TOTP secret for 2FA re-authentication
           totp_secret: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/resources/x/bookmarks.rbi

@@ -11,10 +11,10 @@ module XTwitterScraper
             cursor: String,
             folder_id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::BookmarkListResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def list(
-          # Pagination cursor from previous response
+          # Pagination cursor for bookmarks
           cursor: nil,
           # Optional bookmark folder ID
           folder_id: nil,

data/rbi/x_twitter_scraper/resources/x/communities/join.rbi

@@ -12,14 +12,12 @@ module XTwitterScraper
               id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
-            ).returns(
-              XTwitterScraper::Models::X::Communities::JoinCreateResponse
-            )
+            ).returns(XTwitterScraper::X::CommunityActionResult)
           end
           def create(
             # Resource ID (stringified bigint)
             id,
-            # X account (@username or account ID)
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )
@@ -31,14 +29,12 @@ module XTwitterScraper
               id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
-            ).returns(
-              XTwitterScraper::Models::X::Communities::JoinDeleteAllResponse
-            )
+            ).returns(XTwitterScraper::X::CommunityActionResult)
           end
           def delete_all(
             # Resource ID (stringified bigint)
             id,
-            # X account (@username or account ID)
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )

data/rbi/x_twitter_scraper/resources/x/communities/tweets.rbi

@@ -13,19 +13,36 @@ module XTwitterScraper
               cursor: String,
               query_type: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
-            ).void
+            ).returns(XTwitterScraper::PaginatedTweets)
           end
           def list(
-            # Search query
+            # Search query for cross-community tweets
             q:,
-            # Pagination cursor
+            # Pagination cursor for cross-community results
             cursor: nil,
-            # Sort order (Latest or Top)
+            # Sort order for cross-community results (Latest or Top)
             query_type: nil,
             request_options: {}
           )
           end
 
+          # Get community tweets
+          sig do
+            params(
+              id: String,
+              cursor: String,
+              request_options: XTwitterScraper::RequestOptions::OrHash
+            ).returns(XTwitterScraper::PaginatedTweets)
+          end
+          def list_by_community(
+            # Community ID for tweet lookup
+            id,
+            # Pagination cursor for community tweets
+            cursor: nil,
+            request_options: {}
+          )
+          end
+
           # @api private
           sig do
             params(client: XTwitterScraper::Client).returns(T.attached_class)

data/rbi/x_twitter_scraper/resources/x/communities.rbi

@@ -22,7 +22,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::CommunityCreateResponse)
         end
         def create(
-          # X account (@username or account ID)
+          # X account (@username or ID) creating the community
           account:,
           # Community name
           name:,
@@ -44,7 +44,7 @@ module XTwitterScraper
         def delete(
           # Resource ID (stringified bigint)
           id,
-          # X account (@username or account ID)
+          # X account (@username or ID) deleting the community
           account:,
           # Community name for confirmation
           community_name:,
@@ -72,10 +72,10 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_members(
-          # Community ID
+          # Community ID for member lookup
           id,
           # Pagination cursor
           cursor: nil,
@@ -89,12 +89,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_moderators(
-          # Community ID
+          # Community ID for moderator lookup
           id,
-          # Pagination cursor
+          # Pagination cursor for community moderators
           cursor: nil,
           request_options: {}
         )
@@ -107,12 +107,12 @@ module XTwitterScraper
             cursor: String,
             query_type: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def retrieve_search(
           # Search query
           q:,
-          # Pagination cursor
+          # Pagination cursor for community search
           cursor: nil,
           # Sort order (Latest or Top)
           query_type: nil,

data/rbi/x_twitter_scraper/resources/x/dm.rbi

@@ -16,7 +16,7 @@ module XTwitterScraper
         def retrieve_history(
           # Target user ID
           user_id,
-          # Pagination cursor from previous response
+          # Pagination cursor for DM history
           cursor: nil,
           # Legacy pagination cursor (backward compat)
           max_id: nil,
@@ -38,7 +38,7 @@ module XTwitterScraper
         def send_(
           # Recipient user ID
           user_id,
-          # X account (@username or account ID)
+          # X account (@username or ID) sending the DM
           account:,
           text:,
           media_ids: nil,

data/rbi/x_twitter_scraper/resources/x/lists.rbi

@@ -11,12 +11,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_followers(
           # List ID
           id,
-          # Pagination cursor
+          # Pagination cursor for list followers
           cursor: nil,
           request_options: {}
         )
@@ -28,12 +28,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_members(
-          # List ID
+          # List ID for member lookup
           id,
-          # Pagination cursor
+          # Pagination cursor for list members
           cursor: nil,
           request_options: {}
         )
@@ -48,12 +48,12 @@ module XTwitterScraper
             since_time: String,
             until_time: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def retrieve_tweets(
-          # List ID
+          # List ID for tweet lookup
           id,
-          # Pagination cursor
+          # Pagination cursor for list tweets
           cursor: nil,
           # Include replies (default false)
           include_replies: nil,

data/rbi/x_twitter_scraper/resources/x/media.rbi

@@ -32,7 +32,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::MediaUploadResponse)
         end
         def upload(
-          # X account (@username or account ID)
+          # X account (@username or ID) uploading media
           account:,
           # Media file to upload
           file:,

data/rbi/x_twitter_scraper/resources/x/profile.rbi

@@ -17,7 +17,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::ProfileUpdateResponse)
         end
         def update(
-          # X account (@username or account ID)
+          # X account (@username or ID) to update profile
           account:,
           # Bio description
           description: nil,
@@ -39,7 +39,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::ProfileUpdateAvatarResponse)
         end
         def update_avatar(
-          # X account (@username or account ID)
+          # X account (@username or ID) for avatar update
           account:,
           # Avatar image (max 716KB)
           file:,
@@ -56,7 +56,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::ProfileUpdateBannerResponse)
         end
         def update_banner(
-          # 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/resources/x/tweets/like.rbi

@@ -9,14 +9,15 @@ module XTwitterScraper
           # Like tweet
           sig do
             params(
-              tweet_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::LikeCreateResponse)
           end
           def create(
-            tweet_id,
-            # X account (@username or account ID)
+            # Tweet ID to like
+            id,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )
@@ -25,14 +26,15 @@ module XTwitterScraper
           # Unlike tweet
           sig do
             params(
-              tweet_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::LikeDeleteResponse)
           end
           def delete(
-            tweet_id,
-            # X account (@username or account ID)
+            # Tweet ID to unlike
+            id,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )

data/rbi/x_twitter_scraper/resources/x/tweets/retweet.rbi

@@ -9,14 +9,15 @@ module XTwitterScraper
           # Retweet
           sig do
             params(
-              tweet_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::RetweetCreateResponse)
           end
           def create(
-            tweet_id,
-            # X account (@username or account ID)
+            # Tweet ID to retweet
+            id,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )
@@ -25,14 +26,15 @@ module XTwitterScraper
           # Unretweet
           sig do
             params(
-              tweet_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::RetweetDeleteResponse)
           end
           def delete(
-            tweet_id,
-            # X account (@username or account ID)
+            # Tweet ID to unretweet
+            id,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )

data/rbi/x_twitter_scraper/resources/x/tweets.rbi

@@ -41,11 +41,15 @@ module XTwitterScraper
         # Look up tweet
         sig do
           params(
-            tweet_id: String,
+            id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::TweetRetrieveResponse)
         end
-        def retrieve(tweet_id, request_options: {})
+        def retrieve(
+          # Tweet ID
+          id,
+          request_options: {}
+        )
         end
 
         # Get multiple tweets by IDs
@@ -53,7 +57,7 @@ module XTwitterScraper
           params(
             ids: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def list(
           # Comma-separated tweet IDs (max 100)
@@ -65,14 +69,15 @@ module XTwitterScraper
         # Delete tweet
         sig do
           params(
-            tweet_id: String,
+            id: String,
             account: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::TweetDeleteResponse)
         end
         def delete(
-          tweet_id,
-          # X account (@username or account ID)
+          # Tweet ID to delete
+          id,
+          # X account identifier (@username or account ID)
           account:,
           request_options: {}
         )
@@ -84,12 +89,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::TweetGetFavoritersResponse)
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def get_favoriters(
-          # Tweet ID
+          # Tweet ID to get favoriters
           id,
-          # Pagination cursor from previous response
+          # Pagination cursor for favoriters
           cursor: nil,
           request_options: {}
         )
@@ -104,18 +109,18 @@ module XTwitterScraper
             since_time: String,
             until_time: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::TweetGetQuotesResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def get_quotes(
-          # Tweet ID
+          # Tweet ID to get quotes
           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: {}
         )
@@ -129,16 +134,16 @@ module XTwitterScraper
             since_time: String,
             until_time: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::TweetGetRepliesResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def get_replies(
-          # Tweet ID
+          # Tweet ID to get replies
           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: {}
         )
@@ -150,12 +155,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::TweetGetRetweetersResponse)
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def get_retweeters(
-          # Tweet ID
+          # Tweet ID to get retweeters
           id,
-          # Pagination cursor
+          # Pagination cursor for retweeters
           cursor: nil,
           request_options: {}
         )
@@ -167,12 +172,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::TweetGetThreadResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def get_thread(
-          # Tweet ID
+          # Tweet ID to get thread context
           id,
-          # Pagination cursor
+          # Pagination cursor for thread tweets
           cursor: nil,
           request_options: {}
         )
@@ -189,14 +194,14 @@ module XTwitterScraper
             since_time: String,
             until_time: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::TweetSearchResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def search(
           # Search query (keywords,
           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/resources/x/users/follow.rbi

@@ -9,15 +9,15 @@ module XTwitterScraper
           # Follow user
           sig do
             params(
-              user_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Users::FollowCreateResponse)
           end
           def create(
             # User ID to follow
-            user_id,
-            # X account (@username or account ID)
+            id,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )
@@ -26,7 +26,7 @@ module XTwitterScraper
           # Unfollow user
           sig do
             params(
-              user_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(
@@ -35,8 +35,8 @@ module XTwitterScraper
           end
           def delete_all(
             # User ID to unfollow
-            user_id,
-            # X account (@username or account ID)
+            id,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )