x-twitter-scraper 0.3.0 → 0.4.1

data/lib/x_twitter_scraper/models/x_get_notifications_params.rb

@@ -8,7 +8,7 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute cursor
-      #   Pagination cursor from previous response
+      #   Pagination cursor for notifications
       #
       #   @return [String, nil]
       optional :cursor, String
@@ -20,7 +20,7 @@ module XTwitterScraper
       optional :type, enum: -> { XTwitterScraper::XGetNotificationsParams::Type }
 
       # @!method initialize(cursor: nil, type: nil, request_options: {})
-      #   @param cursor [String] Pagination cursor from previous response
+      #   @param cursor [String] Pagination cursor for notifications
       #
       #   @param type [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type] Notification type filter
       #

data/lib/x_twitter_scraper/models/x_get_trends_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_trends
+    class XGetTrendsResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute count
+      #
+      #   @return [Integer]
+      required :count, Integer
+
+      # @!attribute trends
+      #
+      #   @return [Array<XTwitterScraper::Models::XGetTrendsResponse::Trend>]
+      required :trends,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::XGetTrendsResponse::Trend] }
+
+      # @!attribute woeid
+      #
+      #   @return [Integer]
+      required :woeid, Integer
+
+      # @!method initialize(count:, trends:, woeid:)
+      #   @param count [Integer]
+      #   @param trends [Array<XTwitterScraper::Models::XGetTrendsResponse::Trend>]
+      #   @param woeid [Integer]
+
+      class Trend < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute query
+        #
+        #   @return [String, nil]
+        optional :query, String
+
+        # @!attribute rank
+        #
+        #   @return [Integer, nil]
+        optional :rank, Integer
+
+        # @!method initialize(name:, description: nil, query: nil, rank: nil)
+        #   @param name [String]
+        #   @param description [String]
+        #   @param query [String]
+        #   @param rank [Integer]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/resources/drafts.rb

@@ -13,7 +13,7 @@ module XTwitterScraper
       # @param topic [String]
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::DraftCreateResponse]
+      # @return [XTwitterScraper::Models::DraftDetail]
       #
       # @see XTwitterScraper::Models::DraftCreateParams
       def create(params)
@@ -22,7 +22,7 @@ module XTwitterScraper
           method: :post,
           path: "drafts",
           body: parsed,
-          model: XTwitterScraper::Models::DraftCreateResponse,
+          model: XTwitterScraper::DraftDetail,
           options: options
         )
       end
@@ -35,14 +35,14 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::DraftRetrieveResponse]
+      # @return [XTwitterScraper::Models::DraftDetail]
       #
       # @see XTwitterScraper::Models::DraftRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["drafts/%1$s", id],
-          model: XTwitterScraper::Models::DraftRetrieveResponse,
+          model: XTwitterScraper::DraftDetail,
           options: params[:request_options]
         )
       end
@@ -53,7 +53,7 @@ module XTwitterScraper
       #
       # @param after_cursor [String] Cursor for pagination
       #
-      # @param limit [Integer]
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/draws.rb

@@ -28,9 +28,9 @@ module XTwitterScraper
       #
       # @overload list(after: nil, limit: nil, request_options: {})
       #
-      # @param after [String] Cursor for pagination
+      # @param after [String] Cursor for keyset pagination
       #
-      # @param limit [Integer]
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -55,7 +55,7 @@ module XTwitterScraper
       #
       # @param id [String] Resource ID (stringified bigint)
       #
-      # @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format]
+      # @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format] Export output format
       #
       # @param type [Symbol, XTwitterScraper::Models::DrawExportParams::Type] Export winners or all entries
       #

data/lib/x_twitter_scraper/resources/events.rb

@@ -12,14 +12,14 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::EventRetrieveResponse]
+      # @return [XTwitterScraper::Models::EventDetail]
       #
       # @see XTwitterScraper::Models::EventRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["events/%1$s", id],
-          model: XTwitterScraper::Models::EventRetrieveResponse,
+          model: XTwitterScraper::EventDetail,
           options: params[:request_options]
         )
       end
@@ -28,13 +28,13 @@ module XTwitterScraper
       #
       # @overload list(after: nil, event_type: nil, limit: nil, monitor_id: nil, request_options: {})
       #
-      # @param after [String] Cursor for pagination
+      # @param after [String] Cursor for keyset pagination
       #
-      # @param event_type [Symbol, XTwitterScraper::Models::EventListParams::EventType]
+      # @param event_type [Symbol, XTwitterScraper::Models::EventType] Filter events by type
       #
-      # @param limit [Integer]
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
       #
-      # @param monitor_id [String]
+      # @param monitor_id [String] Filter events by monitor ID
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/extractions.rb

@@ -10,9 +10,9 @@ module XTwitterScraper
       #
       # @param id [String] Extraction public ID (UUID)
       #
-      # @param after [String] Cursor for pagination
+      # @param after [String] Cursor for keyset pagination
       #
-      # @param limit [Integer]
+      # @param limit [Integer] Maximum number of results to return (1-1000, default 100)
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -35,13 +35,13 @@ module XTwitterScraper
       #
       # @overload list(after: nil, limit: nil, status: nil, tool_type: nil, request_options: {})
       #
-      # @param after [String] Cursor for pagination
+      # @param after [String] Cursor for keyset pagination
       #
-      # @param limit [Integer]
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
       #
-      # @param status [Symbol, XTwitterScraper::Models::ExtractionListParams::Status]
+      # @param status [Symbol, XTwitterScraper::Models::ExtractionListParams::Status] Filter by job status
       #
-      # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType]
+      # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType] Filter by extraction tool type
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -64,13 +64,13 @@ module XTwitterScraper
       #
       # @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: {})
       #
-      # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::ToolType]
+      # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::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 advanced_query [String] Raw advanced query string appended to the estimate (tweet_search_extractor)
       #
-      # @param exact_phrase [String] Exact phrase to match (tweet_search_extractor)
+      # @param exact_phrase [String] Exact phrase filter for search estimation
       #
-      # @param exclude_words [String] Words to exclude from results (tweet_search_extractor)
+      # @param exclude_words [String] Words excluded from estimated search results
       #
       # @param search_query [String]
       #
@@ -106,7 +106,7 @@ module XTwitterScraper
       #
       # @param id [String] Extraction public ID
       #
-      # @param format_ [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format]
+      # @param format_ [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format] Export file format
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -130,7 +130,7 @@ module XTwitterScraper
       #
       # @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: {})
       #
-      # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType]
+      # @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)
       #

data/lib/x_twitter_scraper/resources/integrations.rb

@@ -6,19 +6,19 @@ module XTwitterScraper
     class Integrations
       # Create integration
       #
-      # @overload create(config:, event_types:, name:, type:, request_options: {})
+      # @overload create(config:, event_types:, name:, type: :telegram, request_options: {})
       #
       # @param config [XTwitterScraper::Models::IntegrationCreateParams::Config] Integration config (e.g. Telegram chatId)
       #
-      # @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationCreateParams::EventType>]
+      # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       # @param name [String]
       #
-      # @param type [Symbol, XTwitterScraper::Models::IntegrationCreateParams::Type]
+      # @param type [Symbol, :telegram]
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::IntegrationCreateResponse]
+      # @return [XTwitterScraper::Models::Integration]
       #
       # @see XTwitterScraper::Models::IntegrationCreateParams
       def create(params)
@@ -27,7 +27,7 @@ module XTwitterScraper
           method: :post,
           path: "integrations",
           body: parsed,
-          model: XTwitterScraper::Models::IntegrationCreateResponse,
+          model: XTwitterScraper::Integration,
           options: options
         )
       end
@@ -40,14 +40,14 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::IntegrationRetrieveResponse]
+      # @return [XTwitterScraper::Models::Integration]
       #
       # @see XTwitterScraper::Models::IntegrationRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["integrations/%1$s", id],
-          model: XTwitterScraper::Models::IntegrationRetrieveResponse,
+          model: XTwitterScraper::Integration,
           options: params[:request_options]
         )
       end
@@ -58,7 +58,7 @@ module XTwitterScraper
       #
       # @param id [String] Resource ID (stringified bigint)
       #
-      # @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationUpdateParams::EventType>]
+      # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       # @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
       #
@@ -74,7 +74,7 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::IntegrationUpdateResponse]
+      # @return [XTwitterScraper::Models::Integration]
       #
       # @see XTwitterScraper::Models::IntegrationUpdateParams
       def update(id, params = {})
@@ -83,7 +83,7 @@ module XTwitterScraper
           method: :patch,
           path: ["integrations/%1$s", id],
           body: parsed,
-          model: XTwitterScraper::Models::IntegrationUpdateResponse,
+          model: XTwitterScraper::Integration,
           options: options
         )
       end
@@ -132,7 +132,7 @@ module XTwitterScraper
       #
       # @param id [String] Resource ID (stringified bigint)
       #
-      # @param limit [Integer]
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/monitors.rb

@@ -8,7 +8,7 @@ module XTwitterScraper
       #
       # @overload create(event_types:, username:, request_options: {})
       #
-      # @param event_types [Array<Symbol, XTwitterScraper::Models::MonitorCreateParams::EventType>]
+      # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       # @param username [String] X username (without @)
       #
@@ -36,14 +36,14 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::MonitorRetrieveResponse]
+      # @return [XTwitterScraper::Models::Monitor]
       #
       # @see XTwitterScraper::Models::MonitorRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["monitors/%1$s", id],
-          model: XTwitterScraper::Models::MonitorRetrieveResponse,
+          model: XTwitterScraper::Monitor,
           options: params[:request_options]
         )
       end
@@ -54,13 +54,13 @@ module XTwitterScraper
       #
       # @param id [String] Resource ID (stringified bigint)
       #
-      # @param event_types [Array<Symbol, XTwitterScraper::Models::MonitorUpdateParams::EventType>]
+      # @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::MonitorUpdateResponse]
+      # @return [XTwitterScraper::Models::Monitor]
       #
       # @see XTwitterScraper::Models::MonitorUpdateParams
       def update(id, params = {})
@@ -69,7 +69,7 @@ module XTwitterScraper
           method: :patch,
           path: ["monitors/%1$s", id],
           body: parsed,
-          model: XTwitterScraper::Models::MonitorUpdateResponse,
+          model: XTwitterScraper::Monitor,
           options: options
         )
       end

data/lib/x_twitter_scraper/resources/radar.rb

@@ -19,7 +19,7 @@ module XTwitterScraper
       #
       # @param region [String] Region filter (us, global, etc.)
       #
-      # @param source [String] Source filter. One of: github, google_trends, hacker_news, polymarket, reddit, t
+      # @param source [Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Source] Source filter. One of: github, google_trends, hacker_news, polymarket, reddit, t
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/styles.rb

@@ -6,29 +6,29 @@ module XTwitterScraper
     class Styles
       # Get cached style profile
       #
-      # @overload retrieve(username, request_options: {})
+      # @overload retrieve(id, request_options: {})
       #
-      # @param username [String] X username of cached style
+      # @param id [String] Style profile ID or X username
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::StyleRetrieveResponse]
+      # @return [XTwitterScraper::Models::StyleProfile]
       #
       # @see XTwitterScraper::Models::StyleRetrieveParams
-      def retrieve(username, params = {})
+      def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["styles/%1$s", username],
-          model: XTwitterScraper::Models::StyleRetrieveResponse,
+          path: ["styles/%1$s", id],
+          model: XTwitterScraper::StyleProfile,
           options: params[:request_options]
         )
       end
 
       # Save style profile with custom tweets
       #
-      # @overload update(username, label:, tweets:, request_options: {})
+      # @overload update(id, label:, tweets:, request_options: {})
       #
-      # @param username [String] X username of cached style
+      # @param id [String] Style profile ID or X username
       #
       # @param label [String] Display label for the style
       #
@@ -36,16 +36,16 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::StyleUpdateResponse]
+      # @return [XTwitterScraper::Models::StyleProfile]
       #
       # @see XTwitterScraper::Models::StyleUpdateParams
-      def update(username, params)
+      def update(id, params)
         parsed, options = XTwitterScraper::StyleUpdateParams.dump_request(params)
         @client.request(
           method: :put,
-          path: ["styles/%1$s", username],
+          path: ["styles/%1$s", id],
           body: parsed,
-          model: XTwitterScraper::Models::StyleUpdateResponse,
+          model: XTwitterScraper::StyleProfile,
           options: options
         )
       end
@@ -70,19 +70,19 @@ module XTwitterScraper
 
       # Delete a style profile
       #
-      # @overload delete(username, request_options: {})
+      # @overload delete(id, request_options: {})
       #
-      # @param username [String] X username of cached style
+      # @param id [String] Style profile ID or X username
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see XTwitterScraper::Models::StyleDeleteParams
-      def delete(username, params = {})
+      def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["styles/%1$s", username],
+          path: ["styles/%1$s", id],
           model: NilClass,
           options: params[:request_options]
         )
@@ -96,7 +96,7 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::StyleAnalyzeResponse]
+      # @return [XTwitterScraper::Models::StyleProfile]
       #
       # @see XTwitterScraper::Models::StyleAnalyzeParams
       def analyze(params)
@@ -105,7 +105,7 @@ module XTwitterScraper
           method: :post,
           path: "styles",
           body: parsed,
-          model: XTwitterScraper::Models::StyleAnalyzeResponse,
+          model: XTwitterScraper::StyleProfile,
           options: options
         )
       end
@@ -137,19 +137,19 @@ module XTwitterScraper
 
       # Get engagement metrics for style tweets
       #
-      # @overload get_performance(username, request_options: {})
+      # @overload get_performance(id, request_options: {})
       #
-      # @param username [String] X username of cached style
+      # @param id [String] Style profile ID or X username
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [XTwitterScraper::Models::StyleGetPerformanceResponse]
       #
       # @see XTwitterScraper::Models::StyleGetPerformanceParams
-      def get_performance(username, params = {})
+      def get_performance(id, params = {})
         @client.request(
           method: :get,
-          path: ["styles/%1$s/performance", username],
+          path: ["styles/%1$s/performance", id],
           model: XTwitterScraper::Models::StyleGetPerformanceResponse,
           options: params[:request_options]
         )

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

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

data/lib/x_twitter_scraper/resources/trends.rb

@@ -4,11 +4,11 @@ module XTwitterScraper
   module Resources
     # Trending topics by region
     class Trends
-      # Get trending topics
+      # Get regional trending topics
       #
       # @overload list(count: nil, woeid: nil, request_options: {})
       #
-      # @param count [Integer]
+      # @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)
       #

data/lib/x_twitter_scraper/resources/webhooks.rb

@@ -8,7 +8,7 @@ module XTwitterScraper
       #
       # @overload create(event_types:, url:, request_options: {})
       #
-      # @param event_types [Array<Symbol, XTwitterScraper::Models::WebhookCreateParams::EventType>]
+      # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       # @param url [String] HTTPS URL
       #
@@ -34,7 +34,7 @@ module XTwitterScraper
       #
       # @param id [String] Resource ID (stringified bigint)
       #
-      # @param event_types [Array<Symbol, XTwitterScraper::Models::WebhookUpdateParams::EventType>]
+      # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       # @param is_active [Boolean]
       #
@@ -42,7 +42,7 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::WebhookUpdateResponse]
+      # @return [XTwitterScraper::Models::Webhook]
       #
       # @see XTwitterScraper::Models::WebhookUpdateParams
       def update(id, params = {})
@@ -51,7 +51,7 @@ module XTwitterScraper
           method: :patch,
           path: ["webhooks/%1$s", id],
           body: parsed,
-          model: XTwitterScraper::Models::WebhookUpdateResponse,
+          model: XTwitterScraper::Webhook,
           options: options
         )
       end

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

@@ -44,14 +44,14 @@ module XTwitterScraper
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::AccountRetrieveResponse]
+        # @return [XTwitterScraper::Models::X::XAccountDetail]
         #
         # @see XTwitterScraper::Models::X::AccountRetrieveParams
         def retrieve(id, params = {})
           @client.request(
             method: :get,
             path: ["x/accounts/%1$s", id],
-            model: XTwitterScraper::Models::X::AccountRetrieveResponse,
+            model: XTwitterScraper::X::XAccountDetail,
             security: {auth_api_key: true},
             options: params[:request_options]
           )
@@ -97,15 +97,35 @@ module XTwitterScraper
           )
         end
 
+        # Clears loginFailedAt and loginFailureReason for all accounts with transient or
+        # automated failure reasons, making them eligible for retry on next use.
+        #
+        # @overload bulk_retry(request_options: {})
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [XTwitterScraper::Models::X::AccountBulkRetryResponse]
+        #
+        # @see XTwitterScraper::Models::X::AccountBulkRetryParams
+        def bulk_retry(params = {})
+          @client.request(
+            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: {})
         #
         # @param id [String] Resource ID (stringified bigint)
         #
-        # @param password [String] Account password
+        # @param password [String] Updated account password
         #
-        # @param totp_secret [String] TOTP secret for 2FA
+        # @param totp_secret [String] TOTP secret for 2FA re-authentication
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #