x-twitter-scraper 0.4.2 → 0.4.4

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Resources
+    class X
+      # X write actions (tweets, likes, follows, DMs)
+      class WriteActions
+        # Get write action status
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] Write action ID returned by a pending write response.
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [XTwitterScraper::Models::X::WriteActionRetrieveResponse]
+        #
+        # @see XTwitterScraper::Models::X::WriteActionRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["x/write-actions/%1$s", id],
+            model: XTwitterScraper::Models::X::WriteActionRetrieveResponse,
+            options: params[:request_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.rb

@@ -2,23 +2,25 @@
 
 module XTwitterScraper
   module Resources
-    # X data lookups (subscription required)
     class X
+      # X write actions (tweets, likes, follows, DMs)
+      # @return [XTwitterScraper::Resources::X::WriteActions]
+      attr_reader :write_actions
+
       # @return [XTwitterScraper::Resources::X::Tweets]
       attr_reader :tweets
 
-      # X data lookups (subscription required)
       # @return [XTwitterScraper::Resources::X::Users]
       attr_reader :users
 
-      # X data lookups (subscription required)
+      # Look up, search, and explore user profiles and relationships
       # @return [XTwitterScraper::Resources::X::Followers]
       attr_reader :followers
 
       # @return [XTwitterScraper::Resources::X::Dm]
       attr_reader :dm
 
-      # Media upload & download
+      # Media upload and download
       # @return [XTwitterScraper::Resources::X::Media]
       attr_reader :media
 
@@ -33,19 +35,27 @@ module XTwitterScraper
       # @return [XTwitterScraper::Resources::X::Accounts]
       attr_reader :accounts
 
-      # X data lookups (subscription required)
+      # Connected X account management
+      # @return [XTwitterScraper::Resources::X::AccountConnectionChallenges]
+      attr_reader :account_connection_challenges
+
+      # Look up, search, and analyze individual tweets
       # @return [XTwitterScraper::Resources::X::Bookmarks]
       attr_reader :bookmarks
 
-      # X data lookups (subscription required)
+      # X List followers, members, and tweets
       # @return [XTwitterScraper::Resources::X::Lists]
       attr_reader :lists
 
-      # Retrieve the full content of an X Article (long-form post) by tweet ID.
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::XGetArticleParams} for more details.
+      #
+      # Retrieve the full content of an X Article (long-form post) by numeric tweet ID.
+      # Returns article_not_found when the tweet is valid but is not an X Article.
       #
       # @overload get_article(tweet_id, request_options: {})
       #
-      # @param tweet_id [String] Tweet ID of the article
+      # @param tweet_id [String] Numeric tweet ID of the article, 15-20 digits. If you have a tweet URL, use the
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -67,7 +77,7 @@ module XTwitterScraper
       #
       # @param cursor [String] Pagination cursor for timeline
       #
-      # @param seen_tweet_ids [String] Comma-separated tweet IDs to exclude from results
+      # @param seen_tweet_ids [String] Comma-separated tweet IDs to exclude from results. Empty entries are ignored.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -92,7 +102,7 @@ module XTwitterScraper
       #
       # @param cursor [String] Pagination cursor for notifications
       #
-      # @param type [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type] Notification type filter
+      # @param type [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type] Notification type filter. Unrecognized values fall back to All.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -111,9 +121,13 @@ module XTwitterScraper
         )
       end
 
-      # Get trending topics
+      # Get trending hashtags and topics from X by region
+      #
+      # @overload get_trends(count: nil, woeid: nil, request_options: {})
       #
-      # @overload get_trends(request_options: {})
+      # @param count [Integer] Number of trending topics to return (1-50, default 30)
+      #
+      # @param woeid [Integer] Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -121,11 +135,14 @@ module XTwitterScraper
       #
       # @see XTwitterScraper::Models::XGetTrendsParams
       def get_trends(params = {})
+        parsed, options = XTwitterScraper::XGetTrendsParams.dump_request(params)
+        query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "x/trends",
+          query: query,
           model: XTwitterScraper::Models::XGetTrendsResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -134,6 +151,7 @@ module XTwitterScraper
       # @param client [XTwitterScraper::Client]
       def initialize(client:)
         @client = client
+        @write_actions = XTwitterScraper::Resources::X::WriteActions.new(client: client)
         @tweets = XTwitterScraper::Resources::X::Tweets.new(client: client)
         @users = XTwitterScraper::Resources::X::Users.new(client: client)
         @followers = XTwitterScraper::Resources::X::Followers.new(client: client)
@@ -142,6 +160,8 @@ module XTwitterScraper
         @profile = XTwitterScraper::Resources::X::Profile.new(client: client)
         @communities = XTwitterScraper::Resources::X::Communities.new(client: client)
         @accounts = XTwitterScraper::Resources::X::Accounts.new(client: client)
+        @account_connection_challenges =
+          XTwitterScraper::Resources::X::AccountConnectionChallenges.new(client: client)
         @bookmarks = XTwitterScraper::Resources::X::Bookmarks.new(client: client)
         @lists = XTwitterScraper::Resources::X::Lists.new(client: client)
       end

data/lib/x_twitter_scraper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XTwitterScraper
-  VERSION = "0.4.2"
+  VERSION = "0.4.4"
 end

data/lib/x_twitter_scraper.rb

@@ -52,23 +52,21 @@ require_relative "x_twitter_scraper/errors"
 require_relative "x_twitter_scraper/internal/transport/base_client"
 require_relative "x_twitter_scraper/internal/transport/pooled_net_requester"
 require_relative "x_twitter_scraper/client"
+require_relative "x_twitter_scraper/models/user_profile"
 require_relative "x_twitter_scraper/models/account_retrieve_params"
 require_relative "x_twitter_scraper/models/account_retrieve_response"
 require_relative "x_twitter_scraper/models/account_set_x_username_params"
 require_relative "x_twitter_scraper/models/account_set_x_username_response"
 require_relative "x_twitter_scraper/models/account_update_locale_params"
 require_relative "x_twitter_scraper/models/account_update_locale_response"
-require_relative "x_twitter_scraper/models/api_key"
-require_relative "x_twitter_scraper/models/api_key_create_params"
-require_relative "x_twitter_scraper/models/api_key_create_response"
-require_relative "x_twitter_scraper/models/api_key_list_params"
-require_relative "x_twitter_scraper/models/api_key_list_response"
-require_relative "x_twitter_scraper/models/api_key_revoke_params"
-require_relative "x_twitter_scraper/models/api_key_revoke_response"
 require_relative "x_twitter_scraper/models/compose_create_params"
 require_relative "x_twitter_scraper/models/compose_create_response"
+require_relative "x_twitter_scraper/models/content_disclosure"
+require_relative "x_twitter_scraper/models/credit_redirect_topup_checkout_params"
 require_relative "x_twitter_scraper/models/credit_retrieve_balance_params"
 require_relative "x_twitter_scraper/models/credit_retrieve_balance_response"
+require_relative "x_twitter_scraper/models/credit_retrieve_topup_status_params"
+require_relative "x_twitter_scraper/models/credit_retrieve_topup_status_response"
 require_relative "x_twitter_scraper/models/credit_topup_balance_params"
 require_relative "x_twitter_scraper/models/credit_topup_balance_response"
 require_relative "x_twitter_scraper/models/delivery"
@@ -88,6 +86,7 @@ require_relative "x_twitter_scraper/models/draw_retrieve_params"
 require_relative "x_twitter_scraper/models/draw_retrieve_response"
 require_relative "x_twitter_scraper/models/draw_run_params"
 require_relative "x_twitter_scraper/models/draw_run_response"
+require_relative "x_twitter_scraper/models/embedded_tweet"
 require_relative "x_twitter_scraper/models/error"
 require_relative "x_twitter_scraper/models/event"
 require_relative "x_twitter_scraper/models/event_detail"
@@ -105,19 +104,13 @@ require_relative "x_twitter_scraper/models/extraction_retrieve_params"
 require_relative "x_twitter_scraper/models/extraction_retrieve_response"
 require_relative "x_twitter_scraper/models/extraction_run_params"
 require_relative "x_twitter_scraper/models/extraction_run_response"
-require_relative "x_twitter_scraper/models/integration"
-require_relative "x_twitter_scraper/models/integration_create_params"
-require_relative "x_twitter_scraper/models/integration_delete_params"
-require_relative "x_twitter_scraper/models/integration_delete_response"
-require_relative "x_twitter_scraper/models/integration_delivery"
-require_relative "x_twitter_scraper/models/integration_list_deliveries_params"
-require_relative "x_twitter_scraper/models/integration_list_deliveries_response"
-require_relative "x_twitter_scraper/models/integration_list_params"
-require_relative "x_twitter_scraper/models/integration_list_response"
-require_relative "x_twitter_scraper/models/integration_retrieve_params"
-require_relative "x_twitter_scraper/models/integration_send_test_params"
-require_relative "x_twitter_scraper/models/integration_send_test_response"
-require_relative "x_twitter_scraper/models/integration_update_params"
+require_relative "x_twitter_scraper/models/guest_wallet_amount"
+require_relative "x_twitter_scraper/models/guest_wallet_create_params"
+require_relative "x_twitter_scraper/models/guest_wallet_create_response"
+require_relative "x_twitter_scraper/models/guest_wallet_retrieve_status_params"
+require_relative "x_twitter_scraper/models/guest_wallet_retrieve_status_response"
+require_relative "x_twitter_scraper/models/guest_wallet_topup_params"
+require_relative "x_twitter_scraper/models/guest_wallet_topup_response"
 require_relative "x_twitter_scraper/models/monitor"
 require_relative "x_twitter_scraper/models/monitor_create_params"
 require_relative "x_twitter_scraper/models/monitor_create_response"
@@ -126,12 +119,23 @@ require_relative "x_twitter_scraper/models/monitor_deactivate_response"
 require_relative "x_twitter_scraper/models/monitor_list_params"
 require_relative "x_twitter_scraper/models/monitor_list_response"
 require_relative "x_twitter_scraper/models/monitor_retrieve_params"
+require_relative "x_twitter_scraper/models/monitors/keyword_create_params"
+require_relative "x_twitter_scraper/models/monitors/keyword_create_response"
+require_relative "x_twitter_scraper/models/monitors/keyword_deactivate_params"
+require_relative "x_twitter_scraper/models/monitors/keyword_deactivate_response"
+require_relative "x_twitter_scraper/models/monitors/keyword_list_params"
+require_relative "x_twitter_scraper/models/monitors/keyword_list_response"
+require_relative "x_twitter_scraper/models/monitors/keyword_retrieve_params"
+require_relative "x_twitter_scraper/models/monitors/keyword_retrieve_response"
+require_relative "x_twitter_scraper/models/monitors/keyword_update_params"
+require_relative "x_twitter_scraper/models/monitors/keyword_update_response"
 require_relative "x_twitter_scraper/models/monitor_update_params"
 require_relative "x_twitter_scraper/models/paginated_tweets"
 require_relative "x_twitter_scraper/models/paginated_users"
 require_relative "x_twitter_scraper/models/radar_item"
 require_relative "x_twitter_scraper/models/radar_retrieve_trending_topics_params"
 require_relative "x_twitter_scraper/models/radar_retrieve_trending_topics_response"
+require_relative "x_twitter_scraper/models/search_tweet"
 require_relative "x_twitter_scraper/models/style_analyze_params"
 require_relative "x_twitter_scraper/models/style_compare_params"
 require_relative "x_twitter_scraper/models/style_compare_response"
@@ -158,6 +162,7 @@ require_relative "x_twitter_scraper/models/support/ticket_update_params"
 require_relative "x_twitter_scraper/models/support/ticket_update_response"
 require_relative "x_twitter_scraper/models/trend_list_params"
 require_relative "x_twitter_scraper/models/trend_list_response"
+require_relative "x_twitter_scraper/models/tweet_media"
 require_relative "x_twitter_scraper/models/webhook"
 require_relative "x_twitter_scraper/models/webhook_create_params"
 require_relative "x_twitter_scraper/models/webhook_create_response"
@@ -167,12 +172,16 @@ require_relative "x_twitter_scraper/models/webhook_list_deliveries_params"
 require_relative "x_twitter_scraper/models/webhook_list_deliveries_response"
 require_relative "x_twitter_scraper/models/webhook_list_params"
 require_relative "x_twitter_scraper/models/webhook_list_response"
+require_relative "x_twitter_scraper/models/webhook_resume_params"
+require_relative "x_twitter_scraper/models/webhook_resume_response"
 require_relative "x_twitter_scraper/models/webhook_test_params"
 require_relative "x_twitter_scraper/models/webhook_test_response"
 require_relative "x_twitter_scraper/models/webhook_update_params"
 require_relative "x_twitter_scraper/models/winner"
 require_relative "x_twitter_scraper/models/x/account_bulk_retry_params"
 require_relative "x_twitter_scraper/models/x/account_bulk_retry_response"
+require_relative "x_twitter_scraper/models/x/account_connection_challenge_submit_params"
+require_relative "x_twitter_scraper/models/x/account_connection_challenge_submit_response"
 require_relative "x_twitter_scraper/models/x/account_create_params"
 require_relative "x_twitter_scraper/models/x/account_create_response"
 require_relative "x_twitter_scraper/models/x/account_delete_params"
@@ -186,10 +195,11 @@ require_relative "x_twitter_scraper/models/x/bookmark_list_params"
 require_relative "x_twitter_scraper/models/x/bookmark_retrieve_folders_params"
 require_relative "x_twitter_scraper/models/x/bookmark_retrieve_folders_response"
 require_relative "x_twitter_scraper/models/x/communities/join_create_params"
+require_relative "x_twitter_scraper/models/x/communities/join_create_response"
 require_relative "x_twitter_scraper/models/x/communities/join_delete_all_params"
+require_relative "x_twitter_scraper/models/x/communities/join_delete_all_response"
 require_relative "x_twitter_scraper/models/x/communities/tweet_list_by_community_params"
 require_relative "x_twitter_scraper/models/x/communities/tweet_list_params"
-require_relative "x_twitter_scraper/models/x/community_action_result"
 require_relative "x_twitter_scraper/models/x/community_create_params"
 require_relative "x_twitter_scraper/models/x/community_create_response"
 require_relative "x_twitter_scraper/models/x/community_delete_params"
@@ -218,7 +228,6 @@ require_relative "x_twitter_scraper/models/x/profile_update_banner_params"
 require_relative "x_twitter_scraper/models/x/profile_update_banner_response"
 require_relative "x_twitter_scraper/models/x/profile_update_params"
 require_relative "x_twitter_scraper/models/x/profile_update_response"
-require_relative "x_twitter_scraper/models/x/search_tweet"
 require_relative "x_twitter_scraper/models/x/tweet_author"
 require_relative "x_twitter_scraper/models/x/tweet_create_params"
 require_relative "x_twitter_scraper/models/x/tweet_create_response"
@@ -242,8 +251,10 @@ require_relative "x_twitter_scraper/models/x/tweets/retweet_create_response"
 require_relative "x_twitter_scraper/models/x/tweets/retweet_delete_params"
 require_relative "x_twitter_scraper/models/x/tweets/retweet_delete_response"
 require_relative "x_twitter_scraper/models/x/tweet_search_params"
-require_relative "x_twitter_scraper/models/x/user_profile"
+require_relative "x_twitter_scraper/models/x/user_remove_follower_params"
+require_relative "x_twitter_scraper/models/x/user_remove_follower_response"
 require_relative "x_twitter_scraper/models/x/user_retrieve_batch_params"
+require_relative "x_twitter_scraper/models/x/user_retrieve_batch_response"
 require_relative "x_twitter_scraper/models/x/user_retrieve_followers_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_followers_you_know_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_following_params"
@@ -251,6 +262,7 @@ require_relative "x_twitter_scraper/models/x/user_retrieve_likes_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_media_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_mentions_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_params"
+require_relative "x_twitter_scraper/models/x/user_retrieve_replies_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_search_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_tweets_params"
 require_relative "x_twitter_scraper/models/x/user_retrieve_verified_followers_params"
@@ -258,6 +270,8 @@ require_relative "x_twitter_scraper/models/x/users/follow_create_params"
 require_relative "x_twitter_scraper/models/x/users/follow_create_response"
 require_relative "x_twitter_scraper/models/x/users/follow_delete_all_params"
 require_relative "x_twitter_scraper/models/x/users/follow_delete_all_response"
+require_relative "x_twitter_scraper/models/x/write_action_retrieve_params"
+require_relative "x_twitter_scraper/models/x/write_action_retrieve_response"
 require_relative "x_twitter_scraper/models/x/x_account"
 require_relative "x_twitter_scraper/models/x/x_account_detail"
 require_relative "x_twitter_scraper/models/x_get_article_params"
@@ -269,17 +283,15 @@ require_relative "x_twitter_scraper/models/x_get_trends_params"
 require_relative "x_twitter_scraper/models/x_get_trends_response"
 require_relative "x_twitter_scraper/models"
 require_relative "x_twitter_scraper/resources/account"
-require_relative "x_twitter_scraper/resources/api_keys"
-require_relative "x_twitter_scraper/resources/bot"
-require_relative "x_twitter_scraper/resources/bot/platform_links"
 require_relative "x_twitter_scraper/resources/compose"
 require_relative "x_twitter_scraper/resources/credits"
 require_relative "x_twitter_scraper/resources/drafts"
 require_relative "x_twitter_scraper/resources/draws"
 require_relative "x_twitter_scraper/resources/events"
 require_relative "x_twitter_scraper/resources/extractions"
-require_relative "x_twitter_scraper/resources/integrations"
+require_relative "x_twitter_scraper/resources/guest_wallets"
 require_relative "x_twitter_scraper/resources/monitors"
+require_relative "x_twitter_scraper/resources/monitors/keywords"
 require_relative "x_twitter_scraper/resources/radar"
 require_relative "x_twitter_scraper/resources/styles"
 require_relative "x_twitter_scraper/resources/subscribe"
@@ -288,6 +300,7 @@ require_relative "x_twitter_scraper/resources/support/tickets"
 require_relative "x_twitter_scraper/resources/trends"
 require_relative "x_twitter_scraper/resources/webhooks"
 require_relative "x_twitter_scraper/resources/x"
+require_relative "x_twitter_scraper/resources/x/account_connection_challenges"
 require_relative "x_twitter_scraper/resources/x/accounts"
 require_relative "x_twitter_scraper/resources/x/bookmarks"
 require_relative "x_twitter_scraper/resources/x/communities"
@@ -303,3 +316,4 @@ require_relative "x_twitter_scraper/resources/x/tweets/like"
 require_relative "x_twitter_scraper/resources/x/tweets/retweet"
 require_relative "x_twitter_scraper/resources/x/users"
 require_relative "x_twitter_scraper/resources/x/users/follow"
+require_relative "x_twitter_scraper/resources/x/write_actions"

data/rbi/x_twitter_scraper/client.rbi

@@ -17,31 +17,27 @@ module XTwitterScraper
     sig { returns(T.nilable(String)) }
     attr_reader :bearer_token
 
-    # Account info & settings
+    # Account info and settings
     sig { returns(XTwitterScraper::Resources::Account) }
     attr_reader :account
 
-    # API key management (session auth only)
-    sig { returns(XTwitterScraper::Resources::APIKeys) }
-    attr_reader :api_keys
-
-    # Subscription & billing
+    # Subscription, billing, and credits
     sig { returns(XTwitterScraper::Resources::Subscribe) }
     attr_reader :subscribe
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     sig { returns(XTwitterScraper::Resources::Compose) }
     attr_reader :compose
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     sig { returns(XTwitterScraper::Resources::Drafts) }
     attr_reader :drafts
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     sig { returns(XTwitterScraper::Resources::Styles) }
     attr_reader :styles
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     sig { returns(XTwitterScraper::Resources::Radar) }
     attr_reader :radar
 
@@ -53,7 +49,7 @@ module XTwitterScraper
     sig { returns(XTwitterScraper::Resources::Events) }
     attr_reader :events
 
-    # Bulk data extraction (20 tool types)
+    # Bulk data extraction (23 tool types)
     sig { returns(XTwitterScraper::Resources::Extractions) }
     attr_reader :extractions
 
@@ -61,32 +57,28 @@ module XTwitterScraper
     sig { returns(XTwitterScraper::Resources::Draws) }
     attr_reader :draws
 
-    # Webhook endpoint management & delivery
+    # Webhook endpoint management and delivery
     sig { returns(XTwitterScraper::Resources::Webhooks) }
     attr_reader :webhooks
 
-    # Push notification integrations (Telegram)
-    sig { returns(XTwitterScraper::Resources::Integrations) }
-    attr_reader :integrations
-
-    # X data lookups (subscription required)
     sig { returns(XTwitterScraper::Resources::X) }
     attr_reader :x
 
-    # Trending topics by region
+    # Trending topics and hashtags by region
     sig { returns(XTwitterScraper::Resources::Trends) }
     attr_reader :trends
 
-    sig { returns(XTwitterScraper::Resources::Bot) }
-    attr_reader :bot
-
     sig { returns(XTwitterScraper::Resources::Support) }
     attr_reader :support
 
-    # Subscription & billing
+    # Subscription, billing, and credits
     sig { returns(XTwitterScraper::Resources::Credits) }
     attr_reader :credits
 
+    # Accountless prepaid access for paid read endpoints
+    sig { returns(XTwitterScraper::Resources::GuestWallets) }
+    attr_reader :guest_wallets
+
     # @api private
     sig do
       override