x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/resources/radar.rbi

@@ -2,14 +2,16 @@
 
 module XTwitterScraper
   module Resources
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     class Radar
       # Get trending topics from curated sources
       sig do
         params(
-          category: String,
-          count: Integer,
+          after: String,
+          category:
+            XTwitterScraper::RadarRetrieveTrendingTopicsParams::Category::OrSymbol,
           hours: Integer,
+          limit: Integer,
           region: String,
           source:
             XTwitterScraper::RadarRetrieveTrendingTopicsParams::Source::OrSymbol,
@@ -17,13 +19,15 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse)
       end
       def retrieve_trending_topics(
-        # Filter by category (general, tech, dev, etc.)
+        # Cursor for pagination (from prior response nextCursor).
+        after: nil,
+        # Filter by category.
         category: nil,
-        # Number of items to return
-        count: nil,
-        # Lookback window in hours
+        # Lookback window in hours (1-72, default 6).
         hours: nil,
-        # Region filter (us, global, etc.)
+        # Number of items to return (1-100, default 50).
+        limit: nil,
+        # Region filter. Use `global` or a region code such as `US`, `GB`, `TR`, or `ES`.
         region: nil,
         # Source filter. One of: github, google_trends, hacker_news, polymarket, reddit,
         # trustmrr, wikipedia

data/rbi/x_twitter_scraper/resources/styles.rbi

@@ -2,7 +2,7 @@
 
 module XTwitterScraper
   module Resources
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     class Styles
       # Get cached style profile
       sig do

data/rbi/x_twitter_scraper/resources/subscribe.rbi

@@ -2,15 +2,21 @@
 
 module XTwitterScraper
   module Resources
-    # Subscription & billing
+    # Subscription, billing, and credits
     class Subscribe
-      # Get checkout or billing URL
+      # Create a subscription checkout or billing-management URL only after the user
+      # confirms. The request never completes payment by itself.
       sig do
         params(
+          tier: XTwitterScraper::SubscribeCreateParams::Tier::OrSymbol,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::SubscribeCreateResponse)
       end
-      def create(request_options: {})
+      def create(
+        # Subscription tier to pre-select.
+        tier: nil,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/x_twitter_scraper/resources/support/tickets.rbi

@@ -24,7 +24,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::Support::TicketRetrieveResponse)
         end
         def retrieve(
-          # Support ticket ID
+          # Support ticket public ID
           id,
           request_options: {}
         )
@@ -40,7 +40,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::Support::TicketUpdateResponse)
         end
         def update(
-          # Support ticket ID to update
+          # Support ticket public ID to update
           id,
           status:,
           request_options: {}
@@ -65,7 +65,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::Support::TicketReplyResponse)
         end
         def reply(
-          # Support ticket ID for the reply
+          # Support ticket public ID for the reply
           id,
           body:,
           request_options: {}

data/rbi/x_twitter_scraper/resources/trends.rbi

@@ -2,9 +2,9 @@
 
 module XTwitterScraper
   module Resources
-    # Trending topics by region
+    # Trending topics and hashtags by region
     class Trends
-      # Get regional trending topics
+      # Get trending hashtags and topics by region (alias)
       sig do
         params(
           count: Integer,
@@ -13,9 +13,9 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::TrendListResponse)
       end
       def list(
-        # Number of trending topics to return (1-50, default 30)
+        # Number of trending topics returned (1-50, default 30)
         count: nil,
-        # Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+        # Region Yahoo WOEID code (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
         woeid: nil,
         request_options: {}
       )

data/rbi/x_twitter_scraper/resources/webhooks.rbi

@@ -2,7 +2,7 @@
 
 module XTwitterScraper
   module Resources
-    # Webhook endpoint management & delivery
+    # Webhook endpoint management and delivery
     class Webhooks
       # Create webhook
       sig do
@@ -32,7 +32,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Webhook)
       end
       def update(
-        # Resource ID (stringified bigint)
+        # Resource ID returned by the matching create or list endpoint.
         id,
         # Array of event types to subscribe to.
         event_types: nil,
@@ -59,7 +59,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::WebhookDeactivateResponse)
       end
       def deactivate(
-        # Resource ID (stringified bigint)
+        # Resource ID returned by the matching create or list endpoint.
         id,
         request_options: {}
       )
@@ -73,7 +73,21 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::WebhookListDeliveriesResponse)
       end
       def list_deliveries(
-        # Resource ID (stringified bigint)
+        # Resource ID returned by the matching create or list endpoint.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Test and resume webhook endpoint
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::WebhookResumeResponse)
+      end
+      def resume(
+        # Resource ID returned by the matching create or list endpoint.
         id,
         request_options: {}
       )
@@ -87,7 +101,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::WebhookTestResponse)
       end
       def test_(
-        # Resource ID (stringified bigint)
+        # Resource ID returned by the matching create or list endpoint.
         id,
         request_options: {}
       )

data/rbi/x_twitter_scraper/resources/x/account_connection_challenges.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      # Connected X account management
+      class AccountConnectionChallenges
+        # Submit X account email verification code
+        sig do
+          params(
+            id: String,
+            email_code: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(
+            XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse
+          )
+        end
+        def submit(
+          # Resource ID returned by the matching create or list endpoint.
+          id,
+          # Code sent to the account email.
+          email_code:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig do
+          params(client: XTwitterScraper::Client).returns(T.attached_class)
+        end
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,6 @@ module XTwitterScraper
             email: String,
             password: String,
             username: String,
-            proxy_country: String,
             totp_secret: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::AccountCreateResponse)
@@ -23,8 +22,6 @@ module XTwitterScraper
           password:,
           # X username
           username:,
-          # Proxy country code
-          proxy_country: nil,
           # TOTP secret for 2FA
           totp_secret: nil,
           request_options: {}
@@ -39,7 +36,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::X::XAccountDetail)
         end
         def retrieve(
-          # Resource ID (stringified bigint)
+          # Resource ID returned by the matching create or list endpoint.
           id,
           request_options: {}
         )
@@ -62,7 +59,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::AccountDeleteResponse)
         end
         def delete(
-          # Resource ID (stringified bigint)
+          # Resource ID returned by the matching create or list endpoint.
           id,
           request_options: {}
         )
@@ -83,15 +80,18 @@ module XTwitterScraper
           params(
             id: String,
             password: String,
+            email: String,
             totp_secret: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::AccountReauthResponse)
         end
         def reauth(
-          # Resource ID (stringified bigint)
+          # Resource ID returned by the matching create or list endpoint.
           id,
           # Updated account password
           password:,
+          # Email for the X account (updates stored email)
+          email: nil,
           # TOTP secret for 2FA re-authentication
           totp_secret: nil,
           request_options: {}

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

@@ -3,7 +3,7 @@
 module XTwitterScraper
   module Resources
     class X
-      # X data lookups (subscription required)
+      # Look up, search, and analyze individual tweets
       class Bookmarks
         # Get bookmarked tweets
         sig do

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

@@ -12,10 +12,12 @@ module XTwitterScraper
               id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
-            ).returns(XTwitterScraper::X::CommunityActionResult)
+            ).returns(
+              XTwitterScraper::Models::X::Communities::JoinCreateResponse
+            )
           end
           def create(
-            # Resource ID (stringified bigint)
+            # Resource ID returned by the matching create or list endpoint.
             id,
             # X account identifier (@username or account ID)
             account:,
@@ -29,10 +31,12 @@ module XTwitterScraper
               id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
-            ).returns(XTwitterScraper::X::CommunityActionResult)
+            ).returns(
+              XTwitterScraper::Models::X::Communities::JoinDeleteAllResponse
+            )
           end
           def delete_all(
-            # Resource ID (stringified bigint)
+            # Resource ID returned by the matching create or list endpoint.
             id,
             # X account identifier (@username or account ID)
             account:,

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

@@ -4,33 +4,45 @@ module XTwitterScraper
   module Resources
     class X
       class Communities
-        # X data lookups (subscription required)
+        # X Community info, members, and tweets
         class Tweets
-          # Search tweets across all communities
+          # Requires a Community ID and keyword query.
           sig do
             params(
+              community_id: String,
               q: String,
               cursor: String,
-              query_type: String,
+              page_size: Integer,
+              query_type:
+                XTwitterScraper::X::Communities::TweetListParams::QueryType::OrSymbol,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::PaginatedTweets)
           end
           def list(
-            # Search query for cross-community tweets
+            # Numeric ID of the community to search
+            community_id:,
+            # Keyword query within the selected community
             q:,
-            # Pagination cursor for cross-community results
+            # Pagination cursor for community results
             cursor: nil,
-            # Sort order for cross-community results (Latest or Top)
+            # Maximum items requested from this page (1-100, default 20). The response can
+            # contain fewer items because the source returned fewer, filters removed items, or
+            # remaining credits cover fewer results. Keep requesting next_cursor while
+            # has_next_page is true, even when a page is empty. The deprecated limit and count
+            # aliases remain accepted.
+            page_size: nil,
+            # Sort order for community results (Latest or Top)
             query_type: nil,
             request_options: {}
           )
           end
 
-          # Get community tweets
+          # List tweets posted in a community
           sig do
             params(
               id: String,
               cursor: String,
+              page_size: Integer,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::PaginatedTweets)
           end
@@ -39,6 +51,12 @@ module XTwitterScraper
             id,
             # Pagination cursor for community tweets
             cursor: nil,
+            # Maximum items requested from this page (1-100, default 20). The response can
+            # contain fewer items because the source returned fewer, filters removed items, or
+            # remaining credits cover fewer results. Keep requesting next_cursor while
+            # has_next_page is true, even when a page is empty. The deprecated limit and count
+            # aliases remain accepted.
+            page_size: nil,
             request_options: {}
           )
           end

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

@@ -8,7 +8,7 @@ module XTwitterScraper
         sig { returns(XTwitterScraper::Resources::X::Communities::Join) }
         attr_reader :join
 
-        # X data lookups (subscription required)
+        # X Community info, members, and tweets
         sig { returns(XTwitterScraper::Resources::X::Communities::Tweets) }
         attr_reader :tweets
 
@@ -42,7 +42,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::CommunityDeleteResponse)
         end
         def delete(
-          # Resource ID (stringified bigint)
+          # Resource ID returned by the matching create or list endpoint.
           id,
           # X account (@username or ID) deleting the community
           account:,
@@ -52,7 +52,7 @@ module XTwitterScraper
         )
         end
 
-        # Get community details
+        # Get community name, description and member count
         sig do
           params(
             id: String,
@@ -66,11 +66,12 @@ module XTwitterScraper
         )
         end
 
-        # Get community members
+        # List members of a community
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedUsers)
         end
@@ -79,11 +80,15 @@ module XTwitterScraper
           id,
           # Pagination cursor
           cursor: nil,
+          # Items per page (20-200, default 20). This is an upper bound for paid
+          # authenticated calls: remaining credits can reduce the returned page size, and
+          # zero affordable results returns 402 insufficient_credits.
+          page_size: nil,
           request_options: {}
         )
         end
 
-        # Get community moderators
+        # List moderators of a community
         sig do
           params(
             id: String,
@@ -100,20 +105,31 @@ module XTwitterScraper
         )
         end
 
-        # Search tweets across communities
+        # Returns tweets, not community records. Requires a Community ID.
         sig do
           params(
+            community_id: String,
             q: String,
             cursor: String,
-            query_type: String,
+            page_size: Integer,
+            query_type:
+              XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::OrSymbol,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedTweets)
         end
         def retrieve_search(
+          # Numeric ID of the community whose posts to search
+          community_id:,
           # Search query
           q:,
           # Pagination cursor for community search
           cursor: nil,
+          # Maximum items requested from this page (1-100, default 20). The response can
+          # contain fewer items because the source returned fewer, filters removed items, or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true, even when a page is empty. The deprecated limit and count
+          # aliases remain accepted.
+          page_size: nil,
           # Sort order (Latest or Top)
           query_type: nil,
           request_options: {}

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

@@ -8,6 +8,7 @@ module XTwitterScraper
         sig do
           params(
             user_id: String,
+            account: String,
             cursor: String,
             max_id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
@@ -16,6 +17,9 @@ module XTwitterScraper
         def retrieve_history(
           # Target user ID
           user_id,
+          # X handle (without the `@` prefix) of the connected X account used to read the
+          # conversation. The account must be a participant in the conversation.
+          account:,
           # Pagination cursor for DM history
           cursor: nil,
           # Legacy pagination cursor (backward compat)
@@ -31,7 +35,6 @@ module XTwitterScraper
             account: String,
             text: String,
             media_ids: T::Array[String],
-            reply_to_message_id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::DmSendResponse)
         end
@@ -41,8 +44,8 @@ module XTwitterScraper
           # X account (@username or ID) sending the DM
           account:,
           text:,
+          # Optional array containing exactly 1 uploaded media ID.
           media_ids: nil,
-          reply_to_message_id: nil,
           request_options: {}
         )
         end

data/rbi/x_twitter_scraper/resources/x/followers.rbi

@@ -3,9 +3,9 @@
 module XTwitterScraper
   module Resources
     class X
-      # X data lookups (subscription required)
+      # Look up, search, and explore user profiles and relationships
       class Followers
-        # Check follow relationship
+        # Check if one user follows another
         sig do
           params(
             source: String,
@@ -14,9 +14,9 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::FollowerCheckResponse)
         end
         def check(
-          # Username to check (without @)
+          # Source username, @username, or X or Twitter profile URL
           source:,
-          # Target username (without @)
+          # Target username, @username, or X or Twitter profile URL
           target:,
           request_options: {}
         )

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

@@ -3,13 +3,14 @@
 module XTwitterScraper
   module Resources
     class X
-      # X data lookups (subscription required)
+      # X List followers, members, and tweets
       class Lists
-        # Get list followers
+        # List followers of an X List
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedUsers)
         end
@@ -18,15 +19,21 @@ module XTwitterScraper
           id,
           # Pagination cursor for list followers
           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
 
-        # Get list members
+        # List members of an X List
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedUsers)
         end
@@ -35,16 +42,19 @@ module XTwitterScraper
           id,
           # Pagination cursor for list members
           cursor: nil,
+          # Members per page (20-200, default 20)
+          page_size: nil,
           request_options: {}
         )
         end
 
-        # Get list tweets
+        # List tweets from an X List
         sig do
           params(
             id: String,
             cursor: String,
             include_replies: T::Boolean,
+            page_size: Integer,
             since_time: String,
             until_time: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
@@ -57,6 +67,12 @@ module XTwitterScraper
           cursor: nil,
           # Include replies (default false)
           include_replies: nil,
+          # Maximum items requested from this page (1-100, default 20). The response can
+          # contain fewer items because the source returned fewer, filters removed items, or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true, even when a page is empty. The deprecated limit and count
+          # aliases remain accepted.
+          page_size: nil,
           # Unix timestamp - filter after
           since_time: nil,
           # Unix timestamp - filter before

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

@@ -3,21 +3,27 @@
 module XTwitterScraper
   module Resources
     class X
-      # Media upload & download
+      # Media upload and download
       class Media
-        # Download tweet media
+        # Download images and videos from tweets
         sig do
           params(
+            tweet_id: String,
             tweet_ids: T::Array[String],
             tweet_input: String,
+            tweet_url: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::MediaDownloadResponse)
         end
         def download(
-          # Array of tweet URLs or IDs (bulk, max 50)
+          # Numeric tweet ID alias for tweetInput
+          tweet_id: nil,
+          # Array of tweet URLs or IDs (bulk, max 50 string items)
           tweet_ids: nil,
           # Tweet URL or ID (single tweet)
           tweet_input: nil,
+          # Tweet URL alias for tweetInput
+          tweet_url: nil,
           request_options: {}
         )
         end
@@ -26,17 +32,15 @@ module XTwitterScraper
         sig do
           params(
             account: String,
-            file: XTwitterScraper::Internal::FileInput,
-            is_long_video: T::Boolean,
+            url: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::MediaUploadResponse)
         end
         def upload(
-          # X account (@username or ID) uploading media
+          # X account (@username or ID) uploading media from URL
           account:,
-          # Media file to upload
-          file:,
-          is_long_video: nil,
+          # HTTPS URL to download and upload as media
+          url:,
           request_options: {}
         )
         end