x-twitter-scraper 0.3.0 → 0.4.0

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

@@ -48,18 +48,19 @@ module XTwitterScraper
 
         # Look up tweet
         #
-        # @overload retrieve(tweet_id, request_options: {})
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] Tweet ID
         #
-        # @param tweet_id [String]
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::X::TweetRetrieveResponse]
         #
         # @see XTwitterScraper::Models::X::TweetRetrieveParams
-        def retrieve(tweet_id, params = {})
+        def retrieve(id, params = {})
           @client.request(
             method: :get,
-            path: ["x/tweets/%1$s", tweet_id],
+            path: ["x/tweets/%1$s", id],
             model: XTwitterScraper::Models::X::TweetRetrieveResponse,
             options: params[:request_options]
           )
@@ -73,33 +74,39 @@ module XTwitterScraper
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::TweetListParams
         def list(params)
           parsed, options = XTwitterScraper::X::TweetListParams.dump_request(params)
           query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
-          @client.request(method: :get, path: "x/tweets", query: query, model: NilClass, options: options)
+          @client.request(
+            method: :get,
+            path: "x/tweets",
+            query: query,
+            model: XTwitterScraper::PaginatedTweets,
+            options: options
+          )
         end
 
         # Delete tweet
         #
-        # @overload delete(tweet_id, account:, request_options: {})
+        # @overload delete(id, account:, request_options: {})
         #
-        # @param tweet_id [String]
+        # @param id [String] Tweet ID to delete
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account identifier (@username or account ID)
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::X::TweetDeleteResponse]
         #
         # @see XTwitterScraper::Models::X::TweetDeleteParams
-        def delete(tweet_id, params)
+        def delete(id, params)
           parsed, options = XTwitterScraper::X::TweetDeleteParams.dump_request(params)
           @client.request(
             method: :delete,
-            path: ["x/tweets/%1$s", tweet_id],
+            path: ["x/tweets/%1$s", id],
             body: parsed,
             model: XTwitterScraper::Models::X::TweetDeleteResponse,
             options: options
@@ -110,13 +117,13 @@ module XTwitterScraper
         #
         # @overload get_favoriters(id, cursor: nil, request_options: {})
         #
-        # @param id [String] Tweet ID
+        # @param id [String] Tweet ID to get favoriters
         #
-        # @param cursor [String] Pagination cursor from previous response
+        # @param cursor [String] Pagination cursor for favoriters
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::TweetGetFavoritersResponse]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::TweetGetFavoritersParams
         def get_favoriters(id, params = {})
@@ -126,7 +133,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/tweets/%1$s/favoriters", id],
             query: query,
-            model: XTwitterScraper::Models::X::TweetGetFavoritersResponse,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -135,19 +142,19 @@ module XTwitterScraper
         #
         # @overload get_quotes(id, cursor: nil, include_replies: nil, since_time: nil, until_time: nil, request_options: {})
         #
-        # @param id [String] Tweet ID
+        # @param id [String] Tweet ID to get quotes
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for quote tweets
         #
-        # @param include_replies [Boolean] Include replies (default false)
+        # @param include_replies [Boolean] Include reply quotes (default false)
         #
-        # @param since_time [String] Unix timestamp - filter after
+        # @param since_time [String] Unix timestamp - return quotes posted after this time
         #
-        # @param until_time [String] Unix timestamp - filter before
+        # @param until_time [String] Unix timestamp - return quotes posted before this time
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::TweetGetQuotesResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::TweetGetQuotesParams
         def get_quotes(id, params = {})
@@ -161,7 +168,7 @@ module XTwitterScraper
               since_time: "sinceTime",
               until_time: "untilTime"
             ),
-            model: XTwitterScraper::Models::X::TweetGetQuotesResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end
@@ -170,17 +177,17 @@ module XTwitterScraper
         #
         # @overload get_replies(id, cursor: nil, since_time: nil, until_time: nil, request_options: {})
         #
-        # @param id [String] Tweet ID
+        # @param id [String] Tweet ID to get replies
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for tweet replies
         #
-        # @param since_time [String] Unix timestamp - filter after
+        # @param since_time [String] Unix timestamp - return replies posted after this time
         #
-        # @param until_time [String] Unix timestamp - filter before
+        # @param until_time [String] Unix timestamp - return replies posted before this time
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::TweetGetRepliesResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::TweetGetRepliesParams
         def get_replies(id, params = {})
@@ -190,7 +197,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/tweets/%1$s/replies", id],
             query: query.transform_keys(since_time: "sinceTime", until_time: "untilTime"),
-            model: XTwitterScraper::Models::X::TweetGetRepliesResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end
@@ -199,13 +206,13 @@ module XTwitterScraper
         #
         # @overload get_retweeters(id, cursor: nil, request_options: {})
         #
-        # @param id [String] Tweet ID
+        # @param id [String] Tweet ID to get retweeters
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for retweeters
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::TweetGetRetweetersResponse]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::TweetGetRetweetersParams
         def get_retweeters(id, params = {})
@@ -215,7 +222,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/tweets/%1$s/retweeters", id],
             query: query,
-            model: XTwitterScraper::Models::X::TweetGetRetweetersResponse,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -224,13 +231,13 @@ module XTwitterScraper
         #
         # @overload get_thread(id, cursor: nil, request_options: {})
         #
-        # @param id [String] Tweet ID
+        # @param id [String] Tweet ID to get thread context
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for thread tweets
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::TweetGetThreadResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::TweetGetThreadParams
         def get_thread(id, params = {})
@@ -240,7 +247,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/tweets/%1$s/thread", id],
             query: query,
-            model: XTwitterScraper::Models::X::TweetGetThreadResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end
@@ -253,7 +260,7 @@ module XTwitterScraper
         #
         # @param cursor [String] Pagination cursor from previous response
         #
-        # @param limit [Integer] Deprecated — use cursor-based pagination instead
+        # @param limit [Integer] Max tweets to return (server paginates internally). Omit for single page (~20).
         #
         # @param query_type [Symbol, XTwitterScraper::Models::X::TweetSearchParams::QueryType] Sort order — Latest (chronological) or Top (engagement-ranked)
         #
@@ -263,7 +270,7 @@ module XTwitterScraper
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::TweetSearchResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::TweetSearchParams
         def search(params)
@@ -277,7 +284,7 @@ module XTwitterScraper
               since_time: "sinceTime",
               until_time: "untilTime"
             ),
-            model: XTwitterScraper::Models::X::TweetSearchResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end

data/lib/x_twitter_scraper/resources/x/users/follow.rb

@@ -8,22 +8,22 @@ module XTwitterScraper
         class Follow
           # Follow user
           #
-          # @overload create(user_id, account:, request_options: {})
+          # @overload create(id, account:, request_options: {})
           #
-          # @param user_id [String] User ID to follow
+          # @param id [String] User ID to follow
           #
-          # @param account [String] X account (@username or account ID)
+          # @param account [String] X account identifier (@username or account ID)
           #
           # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [XTwitterScraper::Models::X::Users::FollowCreateResponse]
           #
           # @see XTwitterScraper::Models::X::Users::FollowCreateParams
-          def create(user_id, params)
+          def create(id, params)
             parsed, options = XTwitterScraper::X::Users::FollowCreateParams.dump_request(params)
             @client.request(
               method: :post,
-              path: ["x/users/%1$s/follow", user_id],
+              path: ["x/users/%1$s/follow", id],
               body: parsed,
               model: XTwitterScraper::Models::X::Users::FollowCreateResponse,
               options: options
@@ -32,22 +32,22 @@ module XTwitterScraper
 
           # Unfollow user
           #
-          # @overload delete_all(user_id, account:, request_options: {})
+          # @overload delete_all(id, account:, request_options: {})
           #
-          # @param user_id [String] User ID to unfollow
+          # @param id [String] User ID to unfollow
           #
-          # @param account [String] X account (@username or account ID)
+          # @param account [String] X account identifier (@username or account ID)
           #
           # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [XTwitterScraper::Models::X::Users::FollowDeleteAllResponse]
           #
           # @see XTwitterScraper::Models::X::Users::FollowDeleteAllParams
-          def delete_all(user_id, params)
+          def delete_all(id, params)
             parsed, options = XTwitterScraper::X::Users::FollowDeleteAllParams.dump_request(params)
             @client.request(
               method: :delete,
-              path: ["x/users/%1$s/follow", user_id],
+              path: ["x/users/%1$s/follow", id],
               body: parsed,
               model: XTwitterScraper::Models::X::Users::FollowDeleteAllResponse,
               options: options

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

@@ -11,20 +11,20 @@ module XTwitterScraper
 
         # Look up X user
         #
-        # @overload retrieve(username, request_options: {})
+        # @overload retrieve(id, request_options: {})
         #
-        # @param username [String] X username (without @)
+        # @param id [String] X username (without @) or user ID
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::UserRetrieveResponse]
+        # @return [XTwitterScraper::Models::X::UserProfile]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveParams
-        def retrieve(username, params = {})
+        def retrieve(id, params = {})
           @client.request(
             method: :get,
-            path: ["x/users/%1$s", username],
-            model: XTwitterScraper::Models::X::UserRetrieveResponse,
+            path: ["x/users/%1$s", id],
+            model: XTwitterScraper::X::UserProfile,
             options: params[:request_options]
           )
         end
@@ -37,7 +37,7 @@ module XTwitterScraper
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveBatchParams
         def retrieve_batch(params)
@@ -47,7 +47,7 @@ module XTwitterScraper
             method: :get,
             path: "x/users/batch",
             query: query,
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -58,13 +58,13 @@ module XTwitterScraper
         #
         # @param id [String] User ID or username
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for followers list
         #
         # @param page_size [Integer] Items per page (20-200, default 200)
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveFollowersParams
         def retrieve_followers(id, params = {})
@@ -74,7 +74,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/users/%1$s/followers", id],
             query: query.transform_keys(page_size: "pageSize"),
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -83,13 +83,13 @@ module XTwitterScraper
         #
         # @overload retrieve_followers_you_know(id, cursor: nil, request_options: {})
         #
-        # @param id [String] User ID
+        # @param id [String] User ID for followers-you-know lookup
         #
-        # @param cursor [String] Pagination cursor from previous response
+        # @param cursor [String] Pagination cursor for followers-you-know
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::UserRetrieveFollowersYouKnowResponse]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveFollowersYouKnowParams
         def retrieve_followers_you_know(id, params = {})
@@ -99,7 +99,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/users/%1$s/followers-you-know", id],
             query: query,
-            model: XTwitterScraper::Models::X::UserRetrieveFollowersYouKnowResponse,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -108,15 +108,15 @@ module XTwitterScraper
         #
         # @overload retrieve_following(id, cursor: nil, page_size: nil, request_options: {})
         #
-        # @param id [String] User ID or username
+        # @param id [String] User ID or username for following lookup
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for following list
         #
-        # @param page_size [Integer] Items per page (20-200, default 200)
+        # @param page_size [Integer] Results per page (20-200, default 200)
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveFollowingParams
         def retrieve_following(id, params = {})
@@ -126,7 +126,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/users/%1$s/following", id],
             query: query.transform_keys(page_size: "pageSize"),
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -137,11 +137,11 @@ module XTwitterScraper
         #
         # @param id [String] User ID
         #
-        # @param cursor [String] Pagination cursor from previous response
+        # @param cursor [String] Pagination cursor for liked tweets
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::UserRetrieveLikesResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveLikesParams
         def retrieve_likes(id, params = {})
@@ -151,7 +151,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/users/%1$s/likes", id],
             query: query,
-            model: XTwitterScraper::Models::X::UserRetrieveLikesResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end
@@ -160,13 +160,13 @@ module XTwitterScraper
         #
         # @overload retrieve_media(id, cursor: nil, request_options: {})
         #
-        # @param id [String] User ID
+        # @param id [String] User ID for media lookup
         #
-        # @param cursor [String] Pagination cursor from previous response
+        # @param cursor [String] Pagination cursor for media tweets
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::UserRetrieveMediaResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveMediaParams
         def retrieve_media(id, params = {})
@@ -176,7 +176,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/users/%1$s/media", id],
             query: query,
-            model: XTwitterScraper::Models::X::UserRetrieveMediaResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end
@@ -185,17 +185,17 @@ module XTwitterScraper
         #
         # @overload retrieve_mentions(id, cursor: nil, since_time: nil, until_time: nil, request_options: {})
         #
-        # @param id [String] User ID or username
+        # @param id [String] User ID or username for mentions lookup
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for mentions
         #
-        # @param since_time [String] Unix timestamp - filter after
+        # @param since_time [String] Unix timestamp - return mentions after this time
         #
-        # @param until_time [String] Unix timestamp - filter before
+        # @param until_time [String] Unix timestamp - return mentions before this time
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveMentionsParams
         def retrieve_mentions(id, params = {})
@@ -205,7 +205,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/users/%1$s/mentions", id],
             query: query.transform_keys(since_time: "sinceTime", until_time: "untilTime"),
-            model: NilClass,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end
@@ -214,13 +214,13 @@ module XTwitterScraper
         #
         # @overload retrieve_search(q:, cursor: nil, request_options: {})
         #
-        # @param q [String] Search query
+        # @param q [String] User search query
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for user search
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveSearchParams
         def retrieve_search(params)
@@ -230,7 +230,7 @@ module XTwitterScraper
             method: :get,
             path: "x/users/search",
             query: query,
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -239,9 +239,9 @@ module XTwitterScraper
         #
         # @overload retrieve_tweets(id, cursor: nil, include_parent_tweet: nil, include_replies: nil, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] X user ID or username
         #
-        # @param cursor [String] Pagination cursor from previous response
+        # @param cursor [String] Pagination cursor for user tweets
         #
         # @param include_parent_tweet [Boolean] Include parent tweet for replies
         #
@@ -249,7 +249,7 @@ module XTwitterScraper
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::UserRetrieveTweetsResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveTweetsParams
         def retrieve_tweets(id, params = {})
@@ -262,7 +262,7 @@ module XTwitterScraper
               include_parent_tweet: "includeParentTweet",
               include_replies: "includeReplies"
             ),
-            model: XTwitterScraper::Models::X::UserRetrieveTweetsResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end
@@ -271,13 +271,13 @@ module XTwitterScraper
         #
         # @overload retrieve_verified_followers(id, cursor: nil, request_options: {})
         #
-        # @param id [String] User ID or username
+        # @param id [String] User ID or username for verified followers
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for verified followers
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersParams
         def retrieve_verified_followers(id, params = {})
@@ -287,7 +287,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/users/%1$s/verified-followers", id],
             query: query,
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end

data/lib/x_twitter_scraper/resources/x.rb

@@ -45,7 +45,8 @@ module XTwitterScraper
       #
       # @overload get_article(tweet_id, request_options: {})
       #
-      # @param tweet_id [String]
+      # @param tweet_id [String] Tweet ID of the article
+      #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [XTwitterScraper::Models::XGetArticleResponse]
@@ -64,13 +65,13 @@ module XTwitterScraper
       #
       # @overload get_home_timeline(cursor: nil, seen_tweet_ids: nil, request_options: {})
       #
-      # @param cursor [String] Pagination cursor from previous response
+      # @param cursor [String] Pagination cursor for timeline
       #
       # @param seen_tweet_ids [String] Comma-separated tweet IDs to exclude from results
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [XTwitterScraper::Models::XGetHomeTimelineResponse]
+      # @return [XTwitterScraper::Models::PaginatedTweets]
       #
       # @see XTwitterScraper::Models::XGetHomeTimelineParams
       def get_home_timeline(params = {})
@@ -80,7 +81,7 @@ module XTwitterScraper
           method: :get,
           path: "x/timeline",
           query: query.transform_keys(seen_tweet_ids: "seenTweetIds"),
-          model: XTwitterScraper::Models::XGetHomeTimelineResponse,
+          model: XTwitterScraper::PaginatedTweets,
           options: options
         )
       end
@@ -89,7 +90,7 @@ module XTwitterScraper
       #
       # @overload get_notifications(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
       #
@@ -116,11 +117,16 @@ module XTwitterScraper
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [nil]
+      # @return [XTwitterScraper::Models::XGetTrendsResponse]
       #
       # @see XTwitterScraper::Models::XGetTrendsParams
       def get_trends(params = {})
-        @client.request(method: :get, path: "x/trends", model: NilClass, options: params[:request_options])
+        @client.request(
+          method: :get,
+          path: "x/trends",
+          model: XTwitterScraper::Models::XGetTrendsResponse,
+          options: params[:request_options]
+        )
       end
 
       # @api private

data/lib/x_twitter_scraper/version.rb

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