x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/models/x/users/follow_delete_all_params.rbi

@@ -17,22 +17,22 @@ module XTwitterScraper
             end
 
           sig { returns(String) }
-          attr_accessor :user_id
+          attr_accessor :id
 
-          # X account (@username or account ID)
+          # X account identifier (@username or account ID)
           sig { returns(String) }
           attr_accessor :account
 
           sig do
             params(
-              user_id: String,
+              id: String,
               account: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
-            user_id:,
-            # X account (@username or account ID)
+            id:,
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )
@@ -41,7 +41,7 @@ module XTwitterScraper
           sig do
             override.returns(
               {
-                user_id: String,
+                id: String,
                 account: String,
                 request_options: XTwitterScraper::RequestOptions
               }

data/rbi/x_twitter_scraper/models/x/x_account.rbi

@@ -29,6 +29,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :x_username
 
+        # Linked X account summary with username and connection status.
         sig do
           params(
             id: String,

data/rbi/x_twitter_scraper/models/x/x_account_detail.rbi

@@ -47,6 +47,7 @@ module XTwitterScraper
         sig { params(updated_at: Time).void }
         attr_writer :updated_at
 
+        # Full X account details including proxy, cookies, and update timestamp.
         sig do
           params(
             id: String,

data/rbi/x_twitter_scraper/models/x_get_article_response.rbi

@@ -21,33 +21,32 @@ module XTwitterScraper
       end
       attr_writer :article
 
-      sig do
-        returns(T.nilable(XTwitterScraper::Models::XGetArticleResponse::Author))
-      end
+      # Author of a tweet with follower count and verification status.
+      sig { returns(T.nilable(XTwitterScraper::X::TweetAuthor)) }
       attr_reader :author
 
-      sig do
-        params(
-          author: XTwitterScraper::Models::XGetArticleResponse::Author::OrHash
-        ).void
-      end
+      sig { params(author: XTwitterScraper::X::TweetAuthor::OrHash).void }
       attr_writer :author
 
       sig do
         params(
           article:
             XTwitterScraper::Models::XGetArticleResponse::Article::OrHash,
-          author: XTwitterScraper::Models::XGetArticleResponse::Author::OrHash
+          author: XTwitterScraper::X::TweetAuthor::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(article:, author: nil)
+      def self.new(
+        article:,
+        # Author of a tweet with follower count and verification status.
+        author: nil
+      )
       end
 
       sig do
         override.returns(
           {
             article: XTwitterScraper::Models::XGetArticleResponse::Article,
-            author: XTwitterScraper::Models::XGetArticleResponse::Author
+            author: XTwitterScraper::X::TweetAuthor
           }
         )
       end
@@ -260,66 +259,6 @@ module XTwitterScraper
           end
         end
       end
-
-      class Author < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              XTwitterScraper::Models::XGetArticleResponse::Author,
-              XTwitterScraper::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        sig { returns(Integer) }
-        attr_accessor :followers
-
-        sig { returns(String) }
-        attr_accessor :username
-
-        sig { returns(T::Boolean) }
-        attr_accessor :verified
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :profile_picture
-
-        sig { params(profile_picture: String).void }
-        attr_writer :profile_picture
-
-        sig do
-          params(
-            id: String,
-            followers: Integer,
-            username: String,
-            verified: T::Boolean,
-            profile_picture: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          followers:,
-          username:,
-          verified:,
-          profile_picture: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              followers: Integer,
-              username: String,
-              verified: T::Boolean,
-              profile_picture: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/x_get_home_timeline_params.rbi

@@ -14,7 +14,7 @@ module XTwitterScraper
           )
         end
 
-      # Pagination cursor from previous response
+      # Pagination cursor for timeline
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
 
@@ -36,7 +36,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Pagination cursor from previous response
+        # Pagination cursor for timeline
         cursor: nil,
         # Comma-separated tweet IDs to exclude from results
         seen_tweet_ids: nil,

data/rbi/x_twitter_scraper/models/x_get_notifications_params.rbi

@@ -14,7 +14,7 @@ module XTwitterScraper
           )
         end
 
-      # Pagination cursor from previous response
+      # Pagination cursor for notifications
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
 
@@ -44,7 +44,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Pagination cursor from previous response
+        # Pagination cursor for notifications
         cursor: nil,
         # Notification type filter
         type: nil,

data/rbi/x_twitter_scraper/models/x_get_trends_response.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class XGetTrendsResponse < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::Models::XGetTrendsResponse,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Integer) }
+      attr_accessor :count
+
+      sig do
+        returns(T::Array[XTwitterScraper::Models::XGetTrendsResponse::Trend])
+      end
+      attr_accessor :trends
+
+      sig { returns(Integer) }
+      attr_accessor :woeid
+
+      sig do
+        params(
+          count: Integer,
+          trends:
+            T::Array[
+              XTwitterScraper::Models::XGetTrendsResponse::Trend::OrHash
+            ],
+          woeid: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(count:, trends:, woeid:)
+      end
+
+      sig do
+        override.returns(
+          {
+            count: Integer,
+            trends:
+              T::Array[XTwitterScraper::Models::XGetTrendsResponse::Trend],
+            woeid: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Trend < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::XGetTrendsResponse::Trend,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :query
+
+        sig { params(query: String).void }
+        attr_writer :query
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :rank
+
+        sig { params(rank: Integer).void }
+        attr_writer :rank
+
+        sig do
+          params(
+            name: String,
+            description: String,
+            query: String,
+            rank: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(name:, description: nil, query: nil, rank: nil)
+        end
+
+        sig do
+          override.returns(
+            { name: String, description: String, query: String, rank: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/drafts.rbi

@@ -11,7 +11,7 @@ module XTwitterScraper
           goal: XTwitterScraper::DraftCreateParams::Goal::OrSymbol,
           topic: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::DraftCreateResponse)
+        ).returns(XTwitterScraper::DraftDetail)
       end
       def create(text:, goal: nil, topic: nil, request_options: {})
       end
@@ -21,7 +21,7 @@ module XTwitterScraper
         params(
           id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::DraftRetrieveResponse)
+        ).returns(XTwitterScraper::DraftDetail)
       end
       def retrieve(
         # Resource ID (stringified bigint)
@@ -41,6 +41,7 @@ module XTwitterScraper
       def list(
         # Cursor for pagination
         after_cursor: nil,
+        # Maximum number of items to return (1-100, default 50)
         limit: nil,
         request_options: {}
       )

data/rbi/x_twitter_scraper/resources/draws.rbi

@@ -27,8 +27,9 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::DrawListResponse)
       end
       def list(
-        # Cursor for pagination
+        # Cursor for keyset pagination
         after: nil,
+        # Maximum number of items to return (1-100, default 50)
         limit: nil,
         request_options: {}
       )
@@ -46,6 +47,7 @@ module XTwitterScraper
       def export(
         # Resource ID (stringified bigint)
         id,
+        # Export output format
         format_: nil,
         # Export winners or all entries
         type: nil,

data/rbi/x_twitter_scraper/resources/events.rbi

@@ -9,7 +9,7 @@ module XTwitterScraper
         params(
           id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::EventRetrieveResponse)
+        ).returns(XTwitterScraper::EventDetail)
       end
       def retrieve(
         # Resource ID (stringified bigint)
@@ -22,17 +22,20 @@ module XTwitterScraper
       sig do
         params(
           after: String,
-          event_type: XTwitterScraper::EventListParams::EventType::OrSymbol,
+          event_type: XTwitterScraper::EventType::OrSymbol,
           limit: Integer,
           monitor_id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::EventListResponse)
       end
       def list(
-        # Cursor for pagination
+        # Cursor for keyset pagination
         after: nil,
+        # Filter events by type
         event_type: nil,
+        # Maximum number of items to return (1-100, default 50)
         limit: nil,
+        # Filter events by monitor ID
         monitor_id: nil,
         request_options: {}
       )

data/rbi/x_twitter_scraper/resources/extractions.rbi

@@ -16,8 +16,9 @@ module XTwitterScraper
       def retrieve(
         # Extraction public ID (UUID)
         id,
-        # Cursor for pagination
+        # Cursor for keyset pagination
         after: nil,
+        # Maximum number of results to return (1-1000, default 100)
         limit: nil,
         request_options: {}
       )
@@ -34,10 +35,13 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::ExtractionListResponse)
       end
       def list(
-        # Cursor for pagination
+        # Cursor for keyset pagination
         after: nil,
+        # Maximum number of items to return (1-100, default 50)
         limit: nil,
+        # Filter by job status
         status: nil,
+        # Filter by extraction tool type
         tool_type: nil,
         request_options: {}
       )
@@ -61,12 +65,13 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::ExtractionEstimateCostResponse)
       end
       def estimate_cost(
+        # Identifier for the extraction tool used to run a job.
         tool_type:,
-        # Raw advanced search query appended as-is (tweet_search_extractor)
+        # Raw advanced query string appended to the estimate (tweet_search_extractor)
         advanced_query: nil,
-        # Exact phrase to match (tweet_search_extractor)
+        # Exact phrase filter for search estimation
         exact_phrase: nil,
-        # Words to exclude from results (tweet_search_extractor)
+        # Words excluded from estimated search results
         exclude_words: nil,
         search_query: nil,
         target_community_id: nil,
@@ -90,6 +95,7 @@ module XTwitterScraper
       def export_results(
         # Extraction public ID
         id,
+        # Export file format
         format_: nil,
         request_options: {}
       )
@@ -112,6 +118,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::ExtractionRunResponse)
       end
       def run(
+        # Identifier for the extraction tool used to run a job.
         tool_type:,
         # Raw advanced search query appended as-is (tweet_search_extractor)
         advanced_query: nil,

data/rbi/x_twitter_scraper/resources/integrations.rbi

@@ -8,21 +8,19 @@ module XTwitterScraper
       sig do
         params(
           config: XTwitterScraper::IntegrationCreateParams::Config::OrHash,
-          event_types:
-            T::Array[
-              XTwitterScraper::IntegrationCreateParams::EventType::OrSymbol
-            ],
+          event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           name: String,
-          type: XTwitterScraper::IntegrationCreateParams::Type::OrSymbol,
+          type: Symbol,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::IntegrationCreateResponse)
+        ).returns(XTwitterScraper::Integration)
       end
       def create(
         # Integration config (e.g. Telegram chatId)
         config:,
+        # Array of event types to subscribe to.
         event_types:,
         name:,
-        type:,
+        type: :telegram,
         request_options: {}
       )
       end
@@ -32,7 +30,7 @@ module XTwitterScraper
         params(
           id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::IntegrationRetrieveResponse)
+        ).returns(XTwitterScraper::Integration)
       end
       def retrieve(
         # Resource ID (stringified bigint)
@@ -45,10 +43,7 @@ module XTwitterScraper
       sig do
         params(
           id: String,
-          event_types:
-            T::Array[
-              XTwitterScraper::IntegrationUpdateParams::EventType::OrSymbol
-            ],
+          event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           filters: T::Hash[Symbol, T.anything],
           is_active: T::Boolean,
           message_template: T::Hash[Symbol, T.anything],
@@ -56,11 +51,12 @@ module XTwitterScraper
           scope_all_monitors: T::Boolean,
           silent_push: T::Boolean,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::IntegrationUpdateResponse)
+        ).returns(XTwitterScraper::Integration)
       end
       def update(
         # Resource ID (stringified bigint)
         id,
+        # Array of event types to subscribe to.
         event_types: nil,
         # Event filter rules (JSON)
         filters: nil,
@@ -108,6 +104,7 @@ module XTwitterScraper
       def list_deliveries(
         # Resource ID (stringified bigint)
         id,
+        # Maximum number of items to return (1-100, default 50)
         limit: nil,
         request_options: {}
       )

data/rbi/x_twitter_scraper/resources/monitors.rbi

@@ -7,13 +7,13 @@ module XTwitterScraper
       # Create monitor
       sig do
         params(
-          event_types:
-            T::Array[XTwitterScraper::MonitorCreateParams::EventType::OrSymbol],
+          event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           username: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::MonitorCreateResponse)
       end
       def create(
+        # Array of event types to subscribe to.
         event_types:,
         # X username (without @)
         username:,
@@ -26,7 +26,7 @@ module XTwitterScraper
         params(
           id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::MonitorRetrieveResponse)
+        ).returns(XTwitterScraper::Monitor)
       end
       def retrieve(
         # Resource ID (stringified bigint)
@@ -39,15 +39,15 @@ module XTwitterScraper
       sig do
         params(
           id: String,
-          event_types:
-            T::Array[XTwitterScraper::MonitorUpdateParams::EventType::OrSymbol],
+          event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           is_active: T::Boolean,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::MonitorUpdateResponse)
+        ).returns(XTwitterScraper::Monitor)
       end
       def update(
         # Resource ID (stringified bigint)
         id,
+        # Array of event types to subscribe to.
         event_types: nil,
         is_active: nil,
         request_options: {}

data/rbi/x_twitter_scraper/resources/radar.rbi

@@ -11,7 +11,8 @@ module XTwitterScraper
           count: Integer,
           hours: Integer,
           region: String,
-          source: String,
+          source:
+            XTwitterScraper::RadarRetrieveTrendingTopicsParams::Source::OrSymbol,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse)
       end

data/rbi/x_twitter_scraper/resources/styles.rbi

@@ -7,13 +7,13 @@ module XTwitterScraper
       # Get cached style profile
       sig do
         params(
-          username: String,
+          id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::StyleRetrieveResponse)
+        ).returns(XTwitterScraper::StyleProfile)
       end
       def retrieve(
-        # X username of cached style
-        username,
+        # Style profile ID or X username
+        id,
         request_options: {}
       )
       end
@@ -21,15 +21,15 @@ module XTwitterScraper
       # Save style profile with custom tweets
       sig do
         params(
-          username: String,
+          id: String,
           label: String,
           tweets: T::Array[XTwitterScraper::StyleUpdateParams::Tweet::OrHash],
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::StyleUpdateResponse)
+        ).returns(XTwitterScraper::StyleProfile)
       end
       def update(
-        # X username of cached style
-        username,
+        # Style profile ID or X username
+        id,
         # Display label for the style
         label:,
         # Array of tweet objects
@@ -50,13 +50,13 @@ module XTwitterScraper
       # Delete a style profile
       sig do
         params(
-          username: String,
+          id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).void
       end
       def delete(
-        # X username of cached style
-        username,
+        # Style profile ID or X username
+        id,
         request_options: {}
       )
       end
@@ -66,7 +66,7 @@ module XTwitterScraper
         params(
           username: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::StyleAnalyzeResponse)
+        ).returns(XTwitterScraper::StyleProfile)
       end
       def analyze(
         # X username to analyze
@@ -95,13 +95,13 @@ module XTwitterScraper
       # Get engagement metrics for style tweets
       sig do
         params(
-          username: String,
+          id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::StyleGetPerformanceResponse)
       end
       def get_performance(
-        # X username of cached style
-        username,
+        # Style profile ID or X username
+        id,
         request_options: {}
       )
       end

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

@@ -23,7 +23,11 @@ module XTwitterScraper
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::Support::TicketRetrieveResponse)
         end
-        def retrieve(id, request_options: {})
+        def retrieve(
+          # Support ticket ID
+          id,
+          request_options: {}
+        )
         end
 
         # Update ticket status
@@ -35,7 +39,12 @@ module XTwitterScraper
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::Support::TicketUpdateResponse)
         end
-        def update(id, status:, request_options: {})
+        def update(
+          # Support ticket ID to update
+          id,
+          status:,
+          request_options: {}
+        )
         end
 
         # List user's support tickets
@@ -55,7 +64,12 @@ module XTwitterScraper
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::Support::TicketReplyResponse)
         end
-        def reply(id, body:, request_options: {})
+        def reply(
+          # Support ticket ID for the reply
+          id,
+          body:,
+          request_options: {}
+        )
         end
 
         # @api private