x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/resources/x/users.rbi

@@ -12,13 +12,13 @@ module XTwitterScraper
         # Look up X user
         sig do
           params(
-            username: String,
+            id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::UserRetrieveResponse)
+          ).returns(XTwitterScraper::X::UserProfile)
         end
         def retrieve(
-          # X username (without @)
-          username,
+          # X username (without @) or user ID
+          id,
           request_options: {}
         )
         end
@@ -28,7 +28,7 @@ module XTwitterScraper
           params(
             ids: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_batch(
           # Comma-separated user IDs (max 100)
@@ -44,12 +44,12 @@ module XTwitterScraper
             cursor: String,
             page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_followers(
           # User ID or username
           id,
-          # Pagination cursor
+          # Pagination cursor for followers list
           cursor: nil,
           # Items per page (20-200, default 200)
           page_size: nil,
@@ -63,14 +63,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(
-            XTwitterScraper::Models::X::UserRetrieveFollowersYouKnowResponse
-          )
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_followers_you_know(
-          # User ID
+          # User ID for followers-you-know lookup
           id,
-          # Pagination cursor from previous response
+          # Pagination cursor for followers-you-know
           cursor: nil,
           request_options: {}
         )
@@ -83,14 +81,14 @@ module XTwitterScraper
             cursor: String,
             page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_following(
-          # User ID or username
+          # User ID or username for following lookup
           id,
-          # Pagination cursor
+          # Pagination cursor for following list
           cursor: nil,
-          # Items per page (20-200, default 200)
+          # Results per page (20-200, default 200)
           page_size: nil,
           request_options: {}
         )
@@ -102,12 +100,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::UserRetrieveLikesResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def retrieve_likes(
           # User ID
           id,
-          # Pagination cursor from previous response
+          # Pagination cursor for liked tweets
           cursor: nil,
           request_options: {}
         )
@@ -119,12 +117,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::UserRetrieveMediaResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def retrieve_media(
-          # User ID
+          # User ID for media lookup
           id,
-          # Pagination cursor from previous response
+          # Pagination cursor for media tweets
           cursor: nil,
           request_options: {}
         )
@@ -138,16 +136,16 @@ module XTwitterScraper
             since_time: String,
             until_time: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def retrieve_mentions(
-          # User ID or username
+          # User ID or username for mentions lookup
           id,
-          # Pagination cursor
+          # Pagination cursor for mentions
           cursor: nil,
-          # Unix timestamp - filter after
+          # Unix timestamp - return mentions after this time
           since_time: nil,
-          # Unix timestamp - filter before
+          # Unix timestamp - return mentions before this time
           until_time: nil,
           request_options: {}
         )
@@ -159,12 +157,12 @@ module XTwitterScraper
             q: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_search(
-          # Search query
+          # User search query
           q:,
-          # Pagination cursor
+          # Pagination cursor for user search
           cursor: nil,
           request_options: {}
         )
@@ -178,11 +176,12 @@ module XTwitterScraper
             include_parent_tweet: T::Boolean,
             include_replies: T::Boolean,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::UserRetrieveTweetsResponse)
+          ).returns(XTwitterScraper::PaginatedTweets)
         end
         def retrieve_tweets(
+          # X user ID or username
           id,
-          # Pagination cursor from previous response
+          # Pagination cursor for user tweets
           cursor: nil,
           # Include parent tweet for replies
           include_parent_tweet: nil,
@@ -198,12 +197,12 @@ module XTwitterScraper
             id: String,
             cursor: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).void
+          ).returns(XTwitterScraper::PaginatedUsers)
         end
         def retrieve_verified_followers(
-          # User ID or username
+          # User ID or username for verified followers
           id,
-          # Pagination cursor
+          # Pagination cursor for verified followers
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/resources/x.rbi

@@ -48,7 +48,11 @@ module XTwitterScraper
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::XGetArticleResponse)
       end
-      def get_article(tweet_id, request_options: {})
+      def get_article(
+        # Tweet ID of the article
+        tweet_id,
+        request_options: {}
+      )
       end
 
       # Get home timeline
@@ -57,10 +61,10 @@ module XTwitterScraper
           cursor: String,
           seen_tweet_ids: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::XGetHomeTimelineResponse)
+        ).returns(XTwitterScraper::PaginatedTweets)
       end
       def get_home_timeline(
-        # Pagination cursor from previous response
+        # Pagination cursor for timeline
         cursor: nil,
         # Comma-separated tweet IDs to exclude from results
         seen_tweet_ids: nil,
@@ -77,7 +81,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::XGetNotificationsResponse)
       end
       def get_notifications(
-        # Pagination cursor from previous response
+        # Pagination cursor for notifications
         cursor: nil,
         # Notification type filter
         type: nil,
@@ -87,7 +91,9 @@ module XTwitterScraper
 
       # Get trending topics
       sig do
-        params(request_options: XTwitterScraper::RequestOptions::OrHash).void
+        params(
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::XGetTrendsResponse)
       end
       def get_trends(request_options: {})
       end

data/sig/x_twitter_scraper/models/api_key_list_response.rbs

@@ -1,62 +1,13 @@
 module XTwitterScraper
   module Models
-    type api_key_list_response =
-      { keys: ::Array[XTwitterScraper::Models::APIKeyListResponse::Key] }
+    type api_key_list_response = { keys: ::Array[XTwitterScraper::APIKey] }
 
     class APIKeyListResponse < XTwitterScraper::Internal::Type::BaseModel
-      attr_accessor keys: ::Array[XTwitterScraper::Models::APIKeyListResponse::Key]
+      attr_accessor keys: ::Array[XTwitterScraper::APIKey]
 
-      def initialize: (
-        keys: ::Array[XTwitterScraper::Models::APIKeyListResponse::Key]
-      ) -> void
+      def initialize: (keys: ::Array[XTwitterScraper::APIKey]) -> void
 
-      def to_hash: -> {
-        keys: ::Array[XTwitterScraper::Models::APIKeyListResponse::Key]
-      }
-
-      type key =
-        {
-          id: String,
-          created_at: Time,
-          is_active: bool,
-          name: String,
-          prefix: String,
-          last_used_at: Time
-        }
-
-      class Key < XTwitterScraper::Internal::Type::BaseModel
-        attr_accessor id: String
-
-        attr_accessor created_at: Time
-
-        attr_accessor is_active: bool
-
-        attr_accessor name: String
-
-        attr_accessor prefix: String
-
-        attr_reader last_used_at: Time?
-
-        def last_used_at=: (Time) -> Time
-
-        def initialize: (
-          id: String,
-          created_at: Time,
-          is_active: bool,
-          name: String,
-          prefix: String,
-          ?last_used_at: Time
-        ) -> void
-
-        def to_hash: -> {
-          id: String,
-          created_at: Time,
-          is_active: bool,
-          name: String,
-          prefix: String,
-          last_used_at: Time
-        }
-      end
+      def to_hash: -> { keys: ::Array[XTwitterScraper::APIKey] }
     end
   end
 end

data/sig/x_twitter_scraper/models/draft_list_response.rbs

@@ -2,13 +2,13 @@ module XTwitterScraper
   module Models
     type draft_list_response =
       {
-        drafts: ::Array[XTwitterScraper::Models::DraftListResponse::Draft],
+        drafts: ::Array[XTwitterScraper::Draft],
         has_more: bool,
         next_cursor: String
       }
 
     class DraftListResponse < XTwitterScraper::Internal::Type::BaseModel
-      attr_accessor drafts: ::Array[XTwitterScraper::Models::DraftListResponse::Draft]
+      attr_accessor drafts: ::Array[XTwitterScraper::Draft]
 
       attr_accessor has_more: bool
 
@@ -17,57 +17,16 @@ module XTwitterScraper
       def next_cursor=: (String) -> String
 
       def initialize: (
-        drafts: ::Array[XTwitterScraper::Models::DraftListResponse::Draft],
+        drafts: ::Array[XTwitterScraper::Draft],
         has_more: bool,
         ?next_cursor: String
       ) -> void
 
       def to_hash: -> {
-        drafts: ::Array[XTwitterScraper::Models::DraftListResponse::Draft],
+        drafts: ::Array[XTwitterScraper::Draft],
         has_more: bool,
         next_cursor: String
       }
-
-      type draft =
-        {
-          id: String,
-          created_at: Time,
-          text: String,
-          goal: String,
-          topic: String
-        }
-
-      class Draft < XTwitterScraper::Internal::Type::BaseModel
-        attr_accessor id: String
-
-        attr_accessor created_at: Time
-
-        attr_accessor text: String
-
-        attr_reader goal: String?
-
-        def goal=: (String) -> String
-
-        attr_reader topic: String?
-
-        def topic=: (String) -> String
-
-        def initialize: (
-          id: String,
-          created_at: Time,
-          text: String,
-          ?goal: String,
-          ?topic: String
-        ) -> void
-
-        def to_hash: -> {
-          id: String,
-          created_at: Time,
-          text: String,
-          goal: String,
-          topic: String
-        }
-      end
     end
   end
 end

data/sig/x_twitter_scraper/models/draw_list_response.rbs

@@ -2,13 +2,13 @@ module XTwitterScraper
   module Models
     type draw_list_response =
       {
-        draws: ::Array[XTwitterScraper::Models::DrawListResponse::Draw],
+        draws: ::Array[XTwitterScraper::DrawListItem],
         has_more: bool,
         next_cursor: String
       }
 
     class DrawListResponse < XTwitterScraper::Internal::Type::BaseModel
-      attr_accessor draws: ::Array[XTwitterScraper::Models::DrawListResponse::Draw]
+      attr_accessor draws: ::Array[XTwitterScraper::DrawListItem]
 
       attr_accessor has_more: bool
 
@@ -17,65 +17,16 @@ module XTwitterScraper
       def next_cursor=: (String) -> String
 
       def initialize: (
-        draws: ::Array[XTwitterScraper::Models::DrawListResponse::Draw],
+        draws: ::Array[XTwitterScraper::DrawListItem],
         has_more: bool,
         ?next_cursor: String
       ) -> void
 
       def to_hash: -> {
-        draws: ::Array[XTwitterScraper::Models::DrawListResponse::Draw],
+        draws: ::Array[XTwitterScraper::DrawListItem],
         has_more: bool,
         next_cursor: String
       }
-
-      type draw =
-        {
-          id: String,
-          created_at: Time,
-          status: String,
-          total_entries: Integer,
-          tweet_url: String,
-          valid_entries: Integer,
-          drawn_at: Time
-        }
-
-      class Draw < XTwitterScraper::Internal::Type::BaseModel
-        attr_accessor id: String
-
-        attr_accessor created_at: Time
-
-        attr_accessor status: String
-
-        attr_accessor total_entries: Integer
-
-        attr_accessor tweet_url: String
-
-        attr_accessor valid_entries: Integer
-
-        attr_reader drawn_at: Time?
-
-        def drawn_at=: (Time) -> Time
-
-        def initialize: (
-          id: String,
-          created_at: Time,
-          status: String,
-          total_entries: Integer,
-          tweet_url: String,
-          valid_entries: Integer,
-          ?drawn_at: Time
-        ) -> void
-
-        def to_hash: -> {
-          id: String,
-          created_at: Time,
-          status: String,
-          total_entries: Integer,
-          tweet_url: String,
-          valid_entries: Integer,
-          drawn_at: Time
-        }
-      end
     end
   end
 end

data/sig/x_twitter_scraper/models/draw_retrieve_response.rbs

@@ -2,140 +2,24 @@ module XTwitterScraper
   module Models
     type draw_retrieve_response =
       {
-        draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw,
-        winners: ::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner]
+        draw: XTwitterScraper::DrawDetail,
+        winners: ::Array[XTwitterScraper::Winner]
       }
 
     class DrawRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
-      attr_accessor draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw
+      attr_accessor draw: XTwitterScraper::DrawDetail
 
-      attr_accessor winners: ::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner]
+      attr_accessor winners: ::Array[XTwitterScraper::Winner]
 
       def initialize: (
-        draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw,
-        winners: ::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner]
+        draw: XTwitterScraper::DrawDetail,
+        winners: ::Array[XTwitterScraper::Winner]
       ) -> void
 
       def to_hash: -> {
-        draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw,
-        winners: ::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner]
+        draw: XTwitterScraper::DrawDetail,
+        winners: ::Array[XTwitterScraper::Winner]
       }
-
-      type draw =
-        {
-          id: String,
-          created_at: Time,
-          status: String,
-          total_entries: Integer,
-          tweet_author_username: String,
-          tweet_id: String,
-          tweet_like_count: Integer,
-          tweet_quote_count: Integer,
-          tweet_reply_count: Integer,
-          tweet_retweet_count: Integer,
-          tweet_text: String,
-          tweet_url: String,
-          valid_entries: Integer,
-          drawn_at: Time
-        }
-
-      class Draw < XTwitterScraper::Internal::Type::BaseModel
-        attr_accessor id: String
-
-        attr_accessor created_at: Time
-
-        attr_accessor status: String
-
-        attr_accessor total_entries: Integer
-
-        attr_accessor tweet_author_username: String
-
-        attr_accessor tweet_id: String
-
-        attr_accessor tweet_like_count: Integer
-
-        attr_accessor tweet_quote_count: Integer
-
-        attr_accessor tweet_reply_count: Integer
-
-        attr_accessor tweet_retweet_count: Integer
-
-        attr_accessor tweet_text: String
-
-        attr_accessor tweet_url: String
-
-        attr_accessor valid_entries: Integer
-
-        attr_reader drawn_at: Time?
-
-        def drawn_at=: (Time) -> Time
-
-        def initialize: (
-          id: String,
-          created_at: Time,
-          status: String,
-          total_entries: Integer,
-          tweet_author_username: String,
-          tweet_id: String,
-          tweet_like_count: Integer,
-          tweet_quote_count: Integer,
-          tweet_reply_count: Integer,
-          tweet_retweet_count: Integer,
-          tweet_text: String,
-          tweet_url: String,
-          valid_entries: Integer,
-          ?drawn_at: Time
-        ) -> void
-
-        def to_hash: -> {
-          id: String,
-          created_at: Time,
-          status: String,
-          total_entries: Integer,
-          tweet_author_username: String,
-          tweet_id: String,
-          tweet_like_count: Integer,
-          tweet_quote_count: Integer,
-          tweet_reply_count: Integer,
-          tweet_retweet_count: Integer,
-          tweet_text: String,
-          tweet_url: String,
-          valid_entries: Integer,
-          drawn_at: Time
-        }
-      end
-
-      type winner =
-        {
-          author_username: String,
-          is_backup: bool,
-          position: Integer,
-          tweet_id: String
-        }
-
-      class Winner < XTwitterScraper::Internal::Type::BaseModel
-        attr_accessor author_username: String
-
-        attr_accessor is_backup: bool
-
-        attr_accessor position: Integer
-
-        attr_accessor tweet_id: String
-
-        def initialize: (
-          author_username: String,
-          is_backup: bool,
-          position: Integer,
-          tweet_id: String
-        ) -> void
-
-        def to_hash: -> {
-          author_username: String,
-          is_backup: bool,
-          position: Integer,
-          tweet_id: String
-        }
-      end
     end
   end
 end

data/sig/x_twitter_scraper/models/draw_run_response.rbs

@@ -6,7 +6,7 @@ module XTwitterScraper
         total_entries: Integer,
         tweet_id: String,
         valid_entries: Integer,
-        winners: ::Array[XTwitterScraper::Models::DrawRunResponse::Winner]
+        winners: ::Array[XTwitterScraper::Winner]
       }
 
     class DrawRunResponse < XTwitterScraper::Internal::Type::BaseModel
@@ -18,14 +18,14 @@ module XTwitterScraper
 
       attr_accessor valid_entries: Integer
 
-      attr_accessor winners: ::Array[XTwitterScraper::Models::DrawRunResponse::Winner]
+      attr_accessor winners: ::Array[XTwitterScraper::Winner]
 
       def initialize: (
         id: String,
         total_entries: Integer,
         tweet_id: String,
         valid_entries: Integer,
-        winners: ::Array[XTwitterScraper::Models::DrawRunResponse::Winner]
+        winners: ::Array[XTwitterScraper::Winner]
       ) -> void
 
       def to_hash: -> {
@@ -33,40 +33,8 @@ module XTwitterScraper
         total_entries: Integer,
         tweet_id: String,
         valid_entries: Integer,
-        winners: ::Array[XTwitterScraper::Models::DrawRunResponse::Winner]
+        winners: ::Array[XTwitterScraper::Winner]
       }
-
-      type winner =
-        {
-          author_username: String,
-          is_backup: bool,
-          position: Integer,
-          tweet_id: String
-        }
-
-      class Winner < XTwitterScraper::Internal::Type::BaseModel
-        attr_accessor author_username: String
-
-        attr_accessor is_backup: bool
-
-        attr_accessor position: Integer
-
-        attr_accessor tweet_id: String
-
-        def initialize: (
-          author_username: String,
-          is_backup: bool,
-          position: Integer,
-          tweet_id: String
-        ) -> void
-
-        def to_hash: -> {
-          author_username: String,
-          is_backup: bool,
-          position: Integer,
-          tweet_id: String
-        }
-      end
     end
   end
 end