x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/resources/support/tickets.rb

@@ -31,7 +31,7 @@ module XTwitterScraper
         #
         # @overload retrieve(id, request_options: {})
         #
-        # @param id [String] Support ticket ID
+        # @param id [String] Support ticket public ID
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -51,7 +51,7 @@ module XTwitterScraper
         #
         # @overload update(id, status:, request_options: {})
         #
-        # @param id [String] Support ticket ID to update
+        # @param id [String] Support ticket public ID to update
         #
         # @param status [Symbol, XTwitterScraper::Models::Support::TicketUpdateParams::Status]
         #
@@ -93,7 +93,7 @@ module XTwitterScraper
         #
         # @overload reply(id, body:, request_options: {})
         #
-        # @param id [String] Support ticket ID for the reply
+        # @param id [String] Support ticket public ID for the reply
         #
         # @param body [String]
         #

data/lib/x_twitter_scraper/resources/trends.rb

@@ -2,15 +2,18 @@
 
 module XTwitterScraper
   module Resources
-    # Trending topics by region
+    # Trending topics and hashtags by region
     class Trends
-      # Get regional trending topics
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::TrendListParams} for more details.
+      #
+      # Get trending hashtags and topics by region (alias)
       #
       # @overload list(count: nil, woeid: nil, request_options: {})
       #
-      # @param count [Integer] Number of trending topics to return (1-50, default 30)
+      # @param count [Integer] Number of trending topics returned (1-50, default 30)
       #
-      # @param woeid [Integer] Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+      # @param woeid [Integer] Region Yahoo WOEID code (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/webhooks.rb

@@ -2,7 +2,7 @@
 
 module XTwitterScraper
   module Resources
-    # Webhook endpoint management & delivery
+    # Webhook endpoint management and delivery
     class Webhooks
       # Create webhook
       #
@@ -32,7 +32,7 @@ module XTwitterScraper
       #
       # @overload update(id, event_types: nil, is_active: nil, url: nil, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Resource ID returned by the matching create or list endpoint.
       #
       # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
@@ -78,7 +78,7 @@ module XTwitterScraper
       #
       # @overload deactivate(id, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Resource ID returned by the matching create or list endpoint.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -98,7 +98,7 @@ module XTwitterScraper
       #
       # @overload list_deliveries(id, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Resource ID returned by the matching create or list endpoint.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -114,11 +114,31 @@ module XTwitterScraper
         )
       end
 
+      # Test and resume webhook endpoint
+      #
+      # @overload resume(id, request_options: {})
+      #
+      # @param id [String] Resource ID returned by the matching create or list endpoint.
+      #
+      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [XTwitterScraper::Models::WebhookResumeResponse]
+      #
+      # @see XTwitterScraper::Models::WebhookResumeParams
+      def resume(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["webhooks/%1$s/resume", id],
+          model: XTwitterScraper::Models::WebhookResumeResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Test webhook endpoint
       #
       # @overload test_(id, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Resource ID returned by the matching create or list endpoint.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/x/account_connection_challenges.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Resources
+    class X
+      # Connected X account management
+      class AccountConnectionChallenges
+        # Submit X account email verification code
+        #
+        # @overload submit(id, email_code:, request_options: {})
+        #
+        # @param id [String] Resource ID returned by the matching create or list endpoint.
+        #
+        # @param email_code [String] Code sent to the account email.
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse]
+        #
+        # @see XTwitterScraper::Models::X::AccountConnectionChallengeSubmitParams
+        def submit(id, params)
+          parsed, options = XTwitterScraper::X::AccountConnectionChallengeSubmitParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["x/account-connection-challenges/%1$s/submit", id],
+            body: parsed,
+            model: XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [XTwitterScraper::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/resources/x/accounts.rb

@@ -7,7 +7,7 @@ module XTwitterScraper
       class Accounts
         # Connect X account
         #
-        # @overload create(email:, password:, username:, proxy_country: nil, totp_secret: nil, request_options: {})
+        # @overload create(email:, password:, username:, totp_secret: nil, request_options: {})
         #
         # @param email [String] Account email
         #
@@ -15,8 +15,6 @@ module XTwitterScraper
         #
         # @param username [String] X username
         #
-        # @param proxy_country [String] Proxy country code
-        #
         # @param totp_secret [String] TOTP secret for 2FA
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -31,7 +29,6 @@ module XTwitterScraper
             path: "x/accounts",
             body: parsed,
             model: XTwitterScraper::Models::X::AccountCreateResponse,
-            security: {auth_api_key: true},
             options: options
           )
         end
@@ -40,7 +37,7 @@ module XTwitterScraper
         #
         # @overload retrieve(id, request_options: {})
         #
-        # @param id [String] Resource ID (stringified bigint)
+        # @param id [String] Resource ID returned by the matching create or list endpoint.
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -52,7 +49,6 @@ module XTwitterScraper
             method: :get,
             path: ["x/accounts/%1$s", id],
             model: XTwitterScraper::X::XAccountDetail,
-            security: {auth_api_key: true},
             options: params[:request_options]
           )
         end
@@ -71,7 +67,6 @@ module XTwitterScraper
             method: :get,
             path: "x/accounts",
             model: XTwitterScraper::Models::X::AccountListResponse,
-            security: {auth_api_key: true},
             options: params[:request_options]
           )
         end
@@ -80,7 +75,7 @@ module XTwitterScraper
         #
         # @overload delete(id, request_options: {})
         #
-        # @param id [String] Resource ID (stringified bigint)
+        # @param id [String] Resource ID returned by the matching create or list endpoint.
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -92,7 +87,6 @@ module XTwitterScraper
             method: :delete,
             path: ["x/accounts/%1$s", id],
             model: XTwitterScraper::Models::X::AccountDeleteResponse,
-            security: {auth_api_key: true},
             options: params[:request_options]
           )
         end
@@ -112,19 +106,20 @@ module XTwitterScraper
             method: :post,
             path: "x/accounts/bulk-retry",
             model: XTwitterScraper::Models::X::AccountBulkRetryResponse,
-            security: {auth_api_key: true},
             options: params[:request_options]
           )
         end
 
         # Re-authenticate X account
         #
-        # @overload reauth(id, password:, totp_secret: nil, request_options: {})
+        # @overload reauth(id, password:, email: nil, totp_secret: nil, request_options: {})
         #
-        # @param id [String] Resource ID (stringified bigint)
+        # @param id [String] Resource ID returned by the matching create or list endpoint.
         #
         # @param password [String] Updated account password
         #
+        # @param email [String] Email for the X account (updates stored email)
+        #
         # @param totp_secret [String] TOTP secret for 2FA re-authentication
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -139,7 +134,6 @@ module XTwitterScraper
             path: ["x/accounts/%1$s/reauth", id],
             body: parsed,
             model: XTwitterScraper::Models::X::AccountReauthResponse,
-            security: {auth_api_key: true},
             options: options
           )
         end

data/lib/x_twitter_scraper/resources/x/bookmarks.rb

@@ -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
         #

data/lib/x_twitter_scraper/resources/x/communities/join.rb

@@ -10,13 +10,13 @@ module XTwitterScraper
           #
           # @overload create(id, account:, request_options: {})
           #
-          # @param id [String] Resource ID (stringified bigint)
+          # @param id [String] Resource ID returned by the matching create or list endpoint.
           #
           # @param account [String] X account identifier (@username or account ID)
           #
           # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [XTwitterScraper::Models::X::CommunityActionResult]
+          # @return [XTwitterScraper::Models::X::Communities::JoinCreateResponse]
           #
           # @see XTwitterScraper::Models::X::Communities::JoinCreateParams
           def create(id, params)
@@ -25,7 +25,7 @@ module XTwitterScraper
               method: :post,
               path: ["x/communities/%1$s/join", id],
               body: parsed,
-              model: XTwitterScraper::X::CommunityActionResult,
+              model: XTwitterScraper::Models::X::Communities::JoinCreateResponse,
               options: options
             )
           end
@@ -34,13 +34,13 @@ module XTwitterScraper
           #
           # @overload delete_all(id, account:, request_options: {})
           #
-          # @param id [String] Resource ID (stringified bigint)
+          # @param id [String] Resource ID returned by the matching create or list endpoint.
           #
           # @param account [String] X account identifier (@username or account ID)
           #
           # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [XTwitterScraper::Models::X::CommunityActionResult]
+          # @return [XTwitterScraper::Models::X::Communities::JoinDeleteAllResponse]
           #
           # @see XTwitterScraper::Models::X::Communities::JoinDeleteAllParams
           def delete_all(id, params)
@@ -49,7 +49,7 @@ module XTwitterScraper
               method: :delete,
               path: ["x/communities/%1$s/join", id],
               body: parsed,
-              model: XTwitterScraper::X::CommunityActionResult,
+              model: XTwitterScraper::Models::X::Communities::JoinDeleteAllResponse,
               options: options
             )
           end

data/lib/x_twitter_scraper/resources/x/communities/tweets.rb

@@ -4,17 +4,24 @@ 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
+          # Some parameter documentations has been truncated, see
+          # {XTwitterScraper::Models::X::Communities::TweetListParams} for more details.
           #
-          # @overload list(q:, cursor: nil, query_type: nil, request_options: {})
+          # Requires a Community ID and keyword query.
           #
-          # @param q [String] Search query for cross-community tweets
+          # @overload list(community_id:, q:, cursor: nil, page_size: nil, query_type: nil, request_options: {})
           #
-          # @param cursor [String] Pagination cursor for cross-community results
+          # @param community_id [String] Numeric ID of the community to search
           #
-          # @param query_type [String] Sort order for cross-community results (Latest or Top)
+          # @param q [String] Keyword query within the selected community
+          #
+          # @param cursor [String] Pagination cursor for community results
+          #
+          # @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+          #
+          # @param query_type [Symbol, XTwitterScraper::Models::X::Communities::TweetListParams::QueryType] Sort order for community results (Latest or Top)
           #
           # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -27,20 +34,30 @@ module XTwitterScraper
             @client.request(
               method: :get,
               path: "x/communities/tweets",
-              query: query.transform_keys(query_type: "queryType"),
+              query: query.transform_keys(
+                community_id: "communityId",
+                page_size: "pageSize",
+                query_type: "queryType"
+              ),
               model: XTwitterScraper::PaginatedTweets,
               options: options
             )
           end
 
-          # Get community tweets
+          # Some parameter documentations has been truncated, see
+          # {XTwitterScraper::Models::X::Communities::TweetListByCommunityParams} for more
+          # details.
           #
-          # @overload list_by_community(id, cursor: nil, request_options: {})
+          # List tweets posted in a community
+          #
+          # @overload list_by_community(id, cursor: nil, page_size: nil, request_options: {})
           #
           # @param id [String] Community ID for tweet lookup
           #
           # @param cursor [String] Pagination cursor for community tweets
           #
+          # @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+          #
           # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [XTwitterScraper::Models::PaginatedTweets]
@@ -52,7 +69,7 @@ module XTwitterScraper
             @client.request(
               method: :get,
               path: ["x/communities/%1$s/tweets", id],
-              query: query,
+              query: query.transform_keys(page_size: "pageSize"),
               model: XTwitterScraper::PaginatedTweets,
               options: options
             )

data/lib/x_twitter_scraper/resources/x/communities.rb

@@ -8,7 +8,7 @@ module XTwitterScraper
         # @return [XTwitterScraper::Resources::X::Communities::Join]
         attr_reader :join
 
-        # X data lookups (subscription required)
+        # X Community info, members, and tweets
         # @return [XTwitterScraper::Resources::X::Communities::Tweets]
         attr_reader :tweets
 
@@ -42,7 +42,7 @@ module XTwitterScraper
         #
         # @overload delete(id, account:, community_name:, request_options: {})
         #
-        # @param id [String] Resource ID (stringified bigint)
+        # @param id [String] Resource ID returned by the matching create or list endpoint.
         #
         # @param account [String] X account (@username or ID) deleting the community
         #
@@ -64,7 +64,7 @@ module XTwitterScraper
           )
         end
 
-        # Get community details
+        # Get community name, description and member count
         #
         # @overload retrieve_info(id, request_options: {})
         #
@@ -84,14 +84,19 @@ module XTwitterScraper
           )
         end
 
-        # Get community members
+        # Some parameter documentations has been truncated, see
+        # {XTwitterScraper::Models::X::CommunityRetrieveMembersParams} for more details.
         #
-        # @overload retrieve_members(id, cursor: nil, request_options: {})
+        # List members of a community
+        #
+        # @overload retrieve_members(id, cursor: nil, page_size: nil, request_options: {})
         #
         # @param id [String] Community ID for member lookup
         #
         # @param cursor [String] Pagination cursor
         #
+        # @param page_size [Integer] Items per page (20-200, default 20). This is an upper bound for paid authenticat
+        #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::PaginatedUsers]
@@ -103,13 +108,13 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: ["x/communities/%1$s/members", id],
-            query: query,
+            query: query.transform_keys(page_size: "pageSize"),
             model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
 
-        # Get community moderators
+        # List moderators of a community
         #
         # @overload retrieve_moderators(id, cursor: nil, request_options: {})
         #
@@ -134,15 +139,22 @@ module XTwitterScraper
           )
         end
 
-        # Search tweets across communities
+        # Some parameter documentations has been truncated, see
+        # {XTwitterScraper::Models::X::CommunityRetrieveSearchParams} for more details.
         #
-        # @overload retrieve_search(q:, cursor: nil, query_type: nil, request_options: {})
+        # Returns tweets, not community records. Requires a Community ID.
+        #
+        # @overload retrieve_search(community_id:, q:, cursor: nil, page_size: nil, query_type: nil, request_options: {})
+        #
+        # @param community_id [String] Numeric ID of the community whose posts to search
         #
         # @param q [String] Search query
         #
         # @param cursor [String] Pagination cursor for community search
         #
-        # @param query_type [String] Sort order (Latest or Top)
+        # @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+        #
+        # @param query_type [Symbol, XTwitterScraper::Models::X::CommunityRetrieveSearchParams::QueryType] Sort order (Latest or Top)
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -155,7 +167,11 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: "x/communities/search",
-            query: query.transform_keys(query_type: "queryType"),
+            query: query.transform_keys(
+              community_id: "communityId",
+              page_size: "pageSize",
+              query_type: "queryType"
+            ),
             model: XTwitterScraper::PaginatedTweets,
             options: options
           )

data/lib/x_twitter_scraper/resources/x/dm.rb

@@ -4,12 +4,17 @@ module XTwitterScraper
   module Resources
     class X
       class Dm
+        # Some parameter documentations has been truncated, see
+        # {XTwitterScraper::Models::X::DmRetrieveHistoryParams} for more details.
+        #
         # Get DM conversation history
         #
-        # @overload retrieve_history(user_id, cursor: nil, max_id: nil, request_options: {})
+        # @overload retrieve_history(user_id, account:, cursor: nil, max_id: nil, request_options: {})
         #
         # @param user_id [String] Target user ID
         #
+        # @param account [String] X handle (without the `@` prefix) of the connected X account used to read the co
+        #
         # @param cursor [String] Pagination cursor for DM history
         #
         # @param max_id [String] Legacy pagination cursor (backward compat)
@@ -19,7 +24,7 @@ module XTwitterScraper
         # @return [XTwitterScraper::Models::X::DmRetrieveHistoryResponse]
         #
         # @see XTwitterScraper::Models::X::DmRetrieveHistoryParams
-        def retrieve_history(user_id, params = {})
+        def retrieve_history(user_id, params)
           parsed, options = XTwitterScraper::X::DmRetrieveHistoryParams.dump_request(params)
           query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
           @client.request(
@@ -33,7 +38,7 @@ module XTwitterScraper
 
         # Send direct message
         #
-        # @overload send_(user_id, account:, text:, media_ids: nil, reply_to_message_id: nil, request_options: {})
+        # @overload send_(user_id, account:, text:, media_ids: nil, request_options: {})
         #
         # @param user_id [String] Recipient user ID
         #
@@ -41,9 +46,7 @@ module XTwitterScraper
         #
         # @param text [String]
         #
-        # @param media_ids [Array<String>]
-        #
-        # @param reply_to_message_id [String]
+        # @param media_ids [Array<String>] Optional array containing exactly 1 uploaded media ID.
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/x_twitter_scraper/resources/x/followers.rb

@@ -3,15 +3,15 @@
 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
         #
         # @overload check(source:, target:, request_options: {})
         #
-        # @param source [String] Username to check (without @)
+        # @param source [String] Source username, @username, or X or Twitter profile URL
         #
-        # @param target [String] Target username (without @)
+        # @param target [String] Target username, @username, or X or Twitter profile URL
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/x_twitter_scraper/resources/x/lists.rb

@@ -3,16 +3,21 @@
 module XTwitterScraper
   module Resources
     class X
-      # X data lookups (subscription required)
+      # X List followers, members, and tweets
       class Lists
-        # Get list followers
+        # Some parameter documentations has been truncated, see
+        # {XTwitterScraper::Models::X::ListRetrieveFollowersParams} for more details.
         #
-        # @overload retrieve_followers(id, cursor: nil, request_options: {})
+        # List followers of an X List
+        #
+        # @overload retrieve_followers(id, cursor: nil, page_size: nil, request_options: {})
         #
         # @param id [String] List ID
         #
         # @param cursor [String] Pagination cursor for list followers
         #
+        # @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). The respon
+        #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::PaginatedUsers]
@@ -24,20 +29,22 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: ["x/lists/%1$s/followers", id],
-            query: query,
+            query: query.transform_keys(page_size: "pageSize"),
             model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
 
-        # Get list members
+        # List members of an X List
         #
-        # @overload retrieve_members(id, cursor: nil, request_options: {})
+        # @overload retrieve_members(id, cursor: nil, page_size: nil, request_options: {})
         #
         # @param id [String] List ID for member lookup
         #
         # @param cursor [String] Pagination cursor for list members
         #
+        # @param page_size [Integer] Members per page (20-200, default 20)
+        #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::PaginatedUsers]
@@ -49,15 +56,18 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: ["x/lists/%1$s/members", id],
-            query: query,
+            query: query.transform_keys(page_size: "pageSize"),
             model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
 
-        # Get list tweets
+        # Some parameter documentations has been truncated, see
+        # {XTwitterScraper::Models::X::ListRetrieveTweetsParams} for more details.
         #
-        # @overload retrieve_tweets(id, cursor: nil, include_replies: nil, since_time: nil, until_time: nil, request_options: {})
+        # List tweets from an X List
+        #
+        # @overload retrieve_tweets(id, cursor: nil, include_replies: nil, page_size: nil, since_time: nil, until_time: nil, request_options: {})
         #
         # @param id [String] List ID for tweet lookup
         #
@@ -65,6 +75,8 @@ module XTwitterScraper
         #
         # @param include_replies [Boolean] Include replies (default false)
         #
+        # @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+        #
         # @param since_time [String] Unix timestamp - filter after
         #
         # @param until_time [String] Unix timestamp - filter before
@@ -82,6 +94,7 @@ module XTwitterScraper
             path: ["x/lists/%1$s/tweets", id],
             query: query.transform_keys(
               include_replies: "includeReplies",
+              page_size: "pageSize",
               since_time: "sinceTime",
               until_time: "untilTime"
             ),