x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/resources/events.rb

@@ -8,7 +8,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]
       #
@@ -24,15 +24,18 @@ module XTwitterScraper
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::EventListParams} for more details.
+      #
       # List events
       #
-      # @overload list(after: nil, event_type: nil, limit: nil, monitor_id: nil, request_options: {})
+      # @overload list(cursor: nil, event_type: nil, limit: nil, monitor_id: nil, request_options: {})
       #
-      # @param after [String] Cursor for keyset pagination
+      # @param cursor [String] Cursor for keyset pagination from prior response next_cursor
       #
       # @param event_type [Symbol, XTwitterScraper::Models::EventType] Filter events by type
       #
-      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
       #
       # @param monitor_id [String] Filter events by monitor ID
       #
@@ -49,7 +52,6 @@ module XTwitterScraper
           path: "events",
           query: query.transform_keys(event_type: "eventType", monitor_id: "monitorId"),
           model: XTwitterScraper::Models::EventListResponse,
-          security: {auth_api_key: true},
           options: options
         )
       end

data/lib/x_twitter_scraper/resources/extractions.rb

@@ -2,15 +2,15 @@
 
 module XTwitterScraper
   module Resources
-    # Bulk data extraction (20 tool types)
+    # Bulk data extraction (23 tool types)
     class Extractions
       # Get extraction results
       #
-      # @overload retrieve(id, after: nil, limit: nil, request_options: {})
+      # @overload retrieve(id, cursor: nil, limit: nil, request_options: {})
       #
       # @param id [String] Extraction public ID (UUID)
       #
-      # @param after [String] Cursor for keyset pagination
+      # @param cursor [String] Cursor for keyset pagination from prior response next_cursor
       #
       # @param limit [Integer] Maximum number of results to return (1-1000, default 100)
       #
@@ -31,13 +31,16 @@ module XTwitterScraper
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::ExtractionListParams} for more details.
+      #
       # List extraction jobs
       #
-      # @overload list(after: nil, limit: nil, status: nil, tool_type: nil, request_options: {})
+      # @overload list(cursor: nil, limit: nil, status: nil, tool_type: nil, request_options: {})
       #
-      # @param after [String] Cursor for keyset pagination
+      # @param cursor [String] Cursor for keyset pagination from prior response next_cursor
       #
-      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
       #
       # @param status [Symbol, XTwitterScraper::Models::ExtractionListParams::Status] Filter by job status
       #
@@ -60,30 +63,91 @@ module XTwitterScraper
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::ExtractionEstimateCostParams} for more details.
+      #
       # Estimate extraction cost
       #
-      # @overload estimate_cost(tool_type:, advanced_query: nil, exact_phrase: nil, exclude_words: nil, search_query: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, request_options: {})
+      # @overload estimate_cost(tool_type:, advanced_query: nil, any_words: nil, bounding_box: nil, cashtags: nil, conversation_id: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, list_id: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, place: nil, place_country: nil, point_radius: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, results_limit: nil, retweets: nil, retweets_of_tweet_id: nil, search_query: nil, since_date: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, request_options: {})
       #
       # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::ToolType] Identifier for the extraction tool used to run a job.
       #
       # @param advanced_query [String] Raw advanced query string appended to the estimate (tweet_search_extractor)
       #
+      # @param any_words [String] Alternative words or quoted phrases for estimated results. Separate with spaces,
+      #
+      # @param bounding_box [String] Geo bounding box used for estimation, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_e
+      #
+      # @param cashtags [String] Cashtags applied to the estimate, separated by spaces, commas, or lines.
+      #
+      # @param conversation_id [String] Conversation ID filter used for estimation (tweet_search_extractor)
+      #
       # @param exact_phrase [String] Exact phrase filter for search estimation
       #
-      # @param exclude_words [String] Words excluded from estimated search results
+      # @param exclude_words [String] Words or quoted phrases excluded from estimated results. Separate with spaces, c
+      #
+      # @param from_user [String] Estimate only tweets from this author username (tweet_search_extractor)
+      #
+      # @param hashtags [String] Hashtags applied to the estimate, separated by spaces, commas, or lines.
+      #
+      # @param in_reply_to_tweet_id [String] Estimate only replies to this tweet ID (tweet_search_extractor)
+      #
+      # @param language [String] Language code used for estimate filtering (tweet_search_extractor)
+      #
+      # @param list_id [String] Estimate search results within this list ID (tweet_search_extractor)
+      #
+      # @param media_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::MediaType] Media type used for estimate filtering (tweet_search_extractor)
+      #
+      # @param mentioning [String] Estimate tweets mentioning this username (tweet_search_extractor)
+      #
+      # @param min_faves [Integer] Minimum likes threshold for estimated results (tweet_search_extractor)
+      #
+      # @param min_quotes [Integer] Minimum quote count threshold for estimated results (tweet_search_extractor)
+      #
+      # @param min_replies [Integer] Minimum replies threshold for estimated results (tweet_search_extractor)
       #
-      # @param search_query [String]
+      # @param min_retweets [Integer] Minimum retweets threshold for estimated results (tweet_search_extractor)
       #
-      # @param target_community_id [String]
+      # @param place [String] Estimate search results within this place ID (tweet_search_extractor)
       #
-      # @param target_list_id [String]
+      # @param place_country [String] Estimate search results within this country code (tweet_search_extractor)
       #
-      # @param target_space_id [String]
+      # @param point_radius [String] Geo point radius used for estimation, e.g. -73.99 40.73 25mi (tweet_search_extra
+      #
+      # @param quotes [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Quotes] Quote mode used for estimation (tweet_search_extractor)
+      #
+      # @param quotes_of_tweet_id [String] Estimate only quotes of this tweet ID (tweet_search_extractor)
+      #
+      # @param replies [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Replies] Reply mode used for estimation (tweet_search_extractor)
+      #
+      # @param results_limit [Integer] Maximum number of results to estimate. When set, the estimate caps projected res
+      #
+      # @param retweets [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Retweets] Retweet mode used for estimation (tweet_search_extractor)
+      #
+      # @param retweets_of_tweet_id [String] Estimate only retweets of this tweet ID (tweet_search_extractor)
+      #
+      # @param search_query [String] Required for tweet_search_extractor & community_search.
+      #
+      # @param since_date [Date] Estimate start date in YYYY-MM-DD format (tweet_search_extractor)
+      #
+      # @param target_community_id [String] Required for community_post_extractor & community_search.
+      #
+      # @param target_list_id [String] Required for list_follower_explorer, list_member_extractor & list_post_extractor
+      #
+      # @param target_space_id [String] Required for space_explorer.
       #
       # @param target_tweet_id [String]
       #
       # @param target_username [String]
       #
+      # @param to_user [String] Estimate replies sent to this username (tweet_search_extractor)
+      #
+      # @param until_date [Date] Estimate end date in YYYY-MM-DD format (tweet_search_extractor)
+      #
+      # @param url [String] URL substring or domain filter used for estimation (tweet_search_extractor)
+      #
+      # @param verified_only [Boolean] Estimate only verified authors (tweet_search_extractor)
+      #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [XTwitterScraper::Models::ExtractionEstimateCostResponse]
@@ -102,7 +166,7 @@ module XTwitterScraper
 
       # Export extraction results
       #
-      # @overload export_results(id, format_: nil, request_options: {})
+      # @overload export_results(id, format_:, request_options: {})
       #
       # @param id [String] Extraction public ID
       #
@@ -113,7 +177,7 @@ module XTwitterScraper
       # @return [StringIO]
       #
       # @see XTwitterScraper::Models::ExtractionExportResultsParams
-      def export_results(id, params = {})
+      def export_results(id, params)
         parsed, options = XTwitterScraper::ExtractionExportResultsParams.dump_request(params)
         query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
         @client.request(
@@ -126,30 +190,91 @@ module XTwitterScraper
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::ExtractionRunParams} for more details.
+      #
       # Run extraction
       #
-      # @overload run(tool_type:, advanced_query: nil, exact_phrase: nil, exclude_words: nil, search_query: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, request_options: {})
+      # @overload run(tool_type:, advanced_query: nil, any_words: nil, bounding_box: nil, cashtags: nil, conversation_id: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, list_id: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, place: nil, place_country: nil, point_radius: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, results_limit: nil, retweets: nil, retweets_of_tweet_id: nil, search_query: nil, since_date: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, request_options: {})
       #
       # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType] Identifier for the extraction tool used to run a job.
       #
       # @param advanced_query [String] Raw advanced search query appended as-is (tweet_search_extractor)
       #
+      # @param any_words [String] Words or quoted phrases where any one can match. Separate with spaces, commas, o
+      #
+      # @param bounding_box [String] Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
+      #
+      # @param cashtags [String] Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)
+      #
+      # @param conversation_id [String] Conversation ID filter (tweet_search_extractor)
+      #
       # @param exact_phrase [String] Exact phrase to match (tweet_search_extractor)
       #
-      # @param exclude_words [String] Words to exclude from results (tweet_search_extractor)
+      # @param exclude_words [String] Words or quoted phrases to exclude. Separate with spaces, commas, or lines. (twe
+      #
+      # @param from_user [String] Filter by author username (tweet_search_extractor)
+      #
+      # @param hashtags [String] Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)
+      #
+      # @param in_reply_to_tweet_id [String] Only replies to this tweet ID (tweet_search_extractor)
+      #
+      # @param language [String] Language code filter (tweet_search_extractor)
+      #
+      # @param list_id [String] Search within a list ID (tweet_search_extractor)
+      #
+      # @param media_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::MediaType] Media type filter (tweet_search_extractor)
+      #
+      # @param mentioning [String] Filter tweets mentioning a username (tweet_search_extractor)
+      #
+      # @param min_faves [Integer] Minimum likes threshold (tweet_search_extractor)
+      #
+      # @param min_quotes [Integer] Minimum quote count threshold (tweet_search_extractor)
+      #
+      # @param min_replies [Integer] Minimum replies threshold (tweet_search_extractor)
       #
-      # @param search_query [String]
+      # @param min_retweets [Integer] Minimum retweets threshold (tweet_search_extractor)
       #
-      # @param target_community_id [String]
+      # @param place [String] Search within a place ID (tweet_search_extractor)
       #
-      # @param target_list_id [String]
+      # @param place_country [String] Search within a country code (tweet_search_extractor)
       #
-      # @param target_space_id [String]
+      # @param point_radius [String] Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
+      #
+      # @param quotes [Symbol, XTwitterScraper::Models::ExtractionRunParams::Quotes] Quote mode (tweet_search_extractor)
+      #
+      # @param quotes_of_tweet_id [String] Only quotes of this tweet ID (tweet_search_extractor)
+      #
+      # @param replies [Symbol, XTwitterScraper::Models::ExtractionRunParams::Replies] Reply mode (tweet_search_extractor)
+      #
+      # @param results_limit [Integer] Maximum number of results to extract. When set, the extraction stops after reach
+      #
+      # @param retweets [Symbol, XTwitterScraper::Models::ExtractionRunParams::Retweets] Retweet mode (tweet_search_extractor)
+      #
+      # @param retweets_of_tweet_id [String] Only retweets of this tweet ID (tweet_search_extractor)
+      #
+      # @param search_query [String] Required for tweet_search_extractor & community_search.
+      #
+      # @param since_date [Date] Start date YYYY-MM-DD (tweet_search_extractor)
+      #
+      # @param target_community_id [String] Required for community_post_extractor & community_search.
+      #
+      # @param target_list_id [String] Required for list_follower_explorer, list_member_extractor & list_post_extractor
+      #
+      # @param target_space_id [String] Required for space_explorer.
       #
       # @param target_tweet_id [String]
       #
       # @param target_username [String]
       #
+      # @param to_user [String] Filter replies sent to a username (tweet_search_extractor)
+      #
+      # @param until_date [Date] End date YYYY-MM-DD (tweet_search_extractor)
+      #
+      # @param url [String] URL substring or domain filter (tweet_search_extractor)
+      #
+      # @param verified_only [Boolean] Only verified authors (tweet_search_extractor)
+      #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [XTwitterScraper::Models::ExtractionRunResponse]

data/lib/x_twitter_scraper/resources/guest_wallets.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Resources
+    # Accountless prepaid access for paid read endpoints
+    class GuestWallets
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::GuestWalletCreateParams} for more details.
+      #
+      # Create a one-use Stripe-hosted checkout after the user explicitly confirms a
+      # $10-$250 USD amount. This request creates no charge by itself. The user opens
+      # checkout_url on Stripe. This endpoint returns the paid-read API key without
+      # requiring an Xquik account, email, dashboard, or Xquik web page. An idempotent
+      # replay returns the same key.
+      #
+      # @overload create(amount_minor:, idempotency_key:, currency: :usd, request_options: {})
+      #
+      # @param amount_minor [Integer] Body param: Confirmed USD amount in cents.
+      #
+      # @param idempotency_key [String] Header param: Generate a cryptographically random UUID v4. Reuse it only to retr
+      #
+      # @param currency [Symbol, :usd] Body param
+      #
+      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [XTwitterScraper::Models::GuestWalletCreateResponse]
+      #
+      # @see XTwitterScraper::Models::GuestWalletCreateParams
+      def create(params)
+        parsed, options = XTwitterScraper::GuestWalletCreateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :post,
+          path: "guest-wallets",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: XTwitterScraper::Models::GuestWalletCreateResponse,
+          security: {},
+          options: options
+        )
+      end
+
+      # Poll after Stripe payment. Use usable to decide whether paid reads can run. An
+      # active wallet can remain usable while a top-up is pending. A new wallet becomes
+      # usable only after verified webhook fulfillment. Send the guest key as
+      # Authorization: Bearer.
+      #
+      # @overload retrieve_status(request_options: {})
+      #
+      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [XTwitterScraper::Models::GuestWalletRetrieveStatusResponse]
+      #
+      # @see XTwitterScraper::Models::GuestWalletRetrieveStatusParams
+      def retrieve_status(params = {})
+        @client.request(
+          method: :get,
+          path: "guest-wallets/status",
+          model: XTwitterScraper::Models::GuestWalletRetrieveStatusResponse,
+          security: {auth_api_key: true},
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::GuestWalletTopupParams} for more details.
+      #
+      # Create a one-use Stripe-hosted checkout for an existing paid-read guest key
+      # after the user explicitly confirms a $10-$250 USD amount. The key remains the
+      # same. This request creates no charge by itself and never redirects through an
+      # Xquik web page.
+      #
+      # @overload topup(amount_minor:, idempotency_key:, currency: :usd, request_options: {})
+      #
+      # @param amount_minor [Integer] Body param: Confirmed USD amount in cents.
+      #
+      # @param idempotency_key [String] Header param: Generate a cryptographically random UUID v4. Reuse it only to retr
+      #
+      # @param currency [Symbol, :usd] Body param
+      #
+      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [XTwitterScraper::Models::GuestWalletTopupResponse]
+      #
+      # @see XTwitterScraper::Models::GuestWalletTopupParams
+      def topup(params)
+        parsed, options = XTwitterScraper::GuestWalletTopupParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :post,
+          path: "guest-wallets/topups",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: XTwitterScraper::Models::GuestWalletTopupResponse,
+          security: {auth_api_key: true},
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [XTwitterScraper::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/resources/monitors/keywords.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Resources
+    class Monitors
+      # Real-time X account monitoring
+      class Keywords
+        # Creates an instant keyword monitor. Keyword monitors are unlimited. Active
+        # monitors check every 1 second and cost 21 credits per hour. Events and webhook
+        # deliveries are included. Creation requires available credits for the first
+        # hourly charge.
+        #
+        # @overload create(event_types:, query:, request_options: {})
+        #
+        # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+        #
+        # @param query [String] X search query to monitor. Whitespace is normalized.
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [XTwitterScraper::Models::Monitors::KeywordCreateResponse]
+        #
+        # @see XTwitterScraper::Models::Monitors::KeywordCreateParams
+        def create(params)
+          parsed, options = XTwitterScraper::Monitors::KeywordCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "monitors/keywords",
+            body: parsed,
+            model: XTwitterScraper::Models::Monitors::KeywordCreateResponse,
+            options: options
+          )
+        end
+
+        # Get keyword monitor
+        #
+        # @overload retrieve(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::Monitors::KeywordRetrieveResponse]
+        #
+        # @see XTwitterScraper::Models::Monitors::KeywordRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["monitors/keywords/%1$s", id],
+            model: XTwitterScraper::Models::Monitors::KeywordRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Update keyword monitor
+        #
+        # @overload update(id, event_types: nil, is_active: nil, request_options: {})
+        #
+        # @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.
+        #
+        # @param is_active [Boolean]
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [XTwitterScraper::Models::Monitors::KeywordUpdateResponse]
+        #
+        # @see XTwitterScraper::Models::Monitors::KeywordUpdateParams
+        def update(id, params = {})
+          parsed, options = XTwitterScraper::Monitors::KeywordUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["monitors/keywords/%1$s", id],
+            body: parsed,
+            model: XTwitterScraper::Models::Monitors::KeywordUpdateResponse,
+            options: options
+          )
+        end
+
+        # List keyword monitors
+        #
+        # @overload list(request_options: {})
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [XTwitterScraper::Models::Monitors::KeywordListResponse]
+        #
+        # @see XTwitterScraper::Models::Monitors::KeywordListParams
+        def list(params = {})
+          @client.request(
+            method: :get,
+            path: "monitors/keywords",
+            model: XTwitterScraper::Models::Monitors::KeywordListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Delete keyword monitor
+        #
+        # @overload deactivate(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::Monitors::KeywordDeactivateResponse]
+        #
+        # @see XTwitterScraper::Models::Monitors::KeywordDeactivateParams
+        def deactivate(id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["monitors/keywords/%1$s", id],
+            model: XTwitterScraper::Models::Monitors::KeywordDeactivateResponse,
+            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/monitors.rb

@@ -4,7 +4,14 @@ module XTwitterScraper
   module Resources
     # Real-time X account monitoring
     class Monitors
-      # Create monitor
+      # Real-time X account monitoring
+      # @return [XTwitterScraper::Resources::Monitors::Keywords]
+      attr_reader :keywords
+
+      # Creates an instant monitor. Monitors are unlimited. Active monitors check every
+      # 1 second and cost 21 credits per hour. Events and webhook deliveries are
+      # included. Creation requires available credits for the first hourly charge and
+      # username lookup.
       #
       # @overload create(event_types:, username:, request_options: {})
       #
@@ -32,7 +39,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 +59,7 @@ module XTwitterScraper
       #
       # @overload update(id, event_types: nil, is_active: 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.
       #
@@ -92,11 +99,11 @@ module XTwitterScraper
         )
       end
 
-      # Deactivate monitor
+      # Delete monitor
       #
       # @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]
       #
@@ -117,6 +124,7 @@ module XTwitterScraper
       # @param client [XTwitterScraper::Client]
       def initialize(client:)
         @client = client
+        @keywords = XTwitterScraper::Resources::Monitors::Keywords.new(client: client)
       end
     end
   end

data/lib/x_twitter_scraper/resources/radar.rb

@@ -2,22 +2,24 @@
 
 module XTwitterScraper
   module Resources
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     class Radar
       # Some parameter documentations has been truncated, see
       # {XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams} for more details.
       #
       # Get trending topics from curated sources
       #
-      # @overload retrieve_trending_topics(category: nil, count: nil, hours: nil, region: nil, source: nil, request_options: {})
+      # @overload retrieve_trending_topics(after: nil, category: nil, hours: nil, limit: nil, region: nil, source: nil, request_options: {})
       #
-      # @param category [String] Filter by category (general, tech, dev, etc.)
+      # @param after [String] Cursor for pagination (from prior response nextCursor).
       #
-      # @param count [Integer] Number of items to return
+      # @param category [Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Category] Filter by category.
       #
-      # @param hours [Integer] Lookback window in hours
+      # @param hours [Integer] Lookback window in hours (1-72, default 6).
       #
-      # @param region [String] Region filter (us, global, etc.)
+      # @param limit [Integer] Number of items to return (1-100, default 50).
+      #
+      # @param region [String] Region filter. Use `global` or a region code such as `US`, `GB`, `TR`, or `ES`.
       #
       # @param source [Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Source] Source filter. One of: github, google_trends, hacker_news, polymarket, reddit, t
       #

data/lib/x_twitter_scraper/resources/styles.rb

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

data/lib/x_twitter_scraper/resources/subscribe.rb

@@ -2,11 +2,14 @@
 
 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.
       #
-      # @overload create(request_options: {})
+      # @overload create(tier: nil, request_options: {})
+      #
+      # @param tier [Symbol, XTwitterScraper::Models::SubscribeCreateParams::Tier] Subscription tier to pre-select.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -14,11 +17,13 @@ module XTwitterScraper
       #
       # @see XTwitterScraper::Models::SubscribeCreateParams
       def create(params = {})
+        parsed, options = XTwitterScraper::SubscribeCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "subscribe",
+          body: parsed,
           model: XTwitterScraper::Models::SubscribeCreateResponse,
-          options: params[:request_options]
+          options: options
         )
       end