x-twitter-scraper 0.3.0 → 0.4.1

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

@@ -9,13 +9,13 @@ module XTwitterScraper
         #
         # @overload list(cursor: nil, folder_id: nil, request_options: {})
         #
-        # @param cursor [String] Pagination cursor from previous response
+        # @param cursor [String] Pagination cursor for bookmarks
         #
         # @param folder_id [String] Optional bookmark folder ID
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [XTwitterScraper::Models::X::BookmarkListResponse]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::BookmarkListParams
         def list(params = {})
@@ -25,7 +25,7 @@ module XTwitterScraper
             method: :get,
             path: "x/bookmarks",
             query: query.transform_keys(folder_id: "folderId"),
-            model: XTwitterScraper::Models::X::BookmarkListResponse,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end

data/lib/x_twitter_scraper/resources/x/communities/join.rb

@@ -12,11 +12,11 @@ module XTwitterScraper
           #
           # @param id [String] Resource ID (stringified bigint)
           #
-          # @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::Communities::JoinCreateResponse]
+          # @return [XTwitterScraper::Models::X::CommunityActionResult]
           #
           # @see XTwitterScraper::Models::X::Communities::JoinCreateParams
           def create(id, params)
@@ -25,7 +25,7 @@ module XTwitterScraper
               method: :post,
               path: ["x/communities/%1$s/join", id],
               body: parsed,
-              model: XTwitterScraper::Models::X::Communities::JoinCreateResponse,
+              model: XTwitterScraper::X::CommunityActionResult,
               options: options
             )
           end
@@ -36,11 +36,11 @@ module XTwitterScraper
           #
           # @param id [String] Resource ID (stringified bigint)
           #
-          # @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::Communities::JoinDeleteAllResponse]
+          # @return [XTwitterScraper::Models::X::CommunityActionResult]
           #
           # @see XTwitterScraper::Models::X::Communities::JoinDeleteAllParams
           def delete_all(id, params)
@@ -49,7 +49,7 @@ module XTwitterScraper
               method: :delete,
               path: ["x/communities/%1$s/join", id],
               body: parsed,
-              model: XTwitterScraper::Models::X::Communities::JoinDeleteAllResponse,
+              model: XTwitterScraper::X::CommunityActionResult,
               options: options
             )
           end

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

@@ -10,15 +10,15 @@ module XTwitterScraper
           #
           # @overload list(q:, cursor: nil, query_type: nil, request_options: {})
           #
-          # @param q [String] Search query
+          # @param q [String] Search query for cross-community tweets
           #
-          # @param cursor [String] Pagination cursor
+          # @param cursor [String] Pagination cursor for cross-community results
           #
-          # @param query_type [String] Sort order (Latest or Top)
+          # @param query_type [String] Sort order for cross-community results (Latest or Top)
           #
           # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [nil]
+          # @return [XTwitterScraper::Models::PaginatedTweets]
           #
           # @see XTwitterScraper::Models::X::Communities::TweetListParams
           def list(params)
@@ -28,7 +28,32 @@ module XTwitterScraper
               method: :get,
               path: "x/communities/tweets",
               query: query.transform_keys(query_type: "queryType"),
-              model: NilClass,
+              model: XTwitterScraper::PaginatedTweets,
+              options: options
+            )
+          end
+
+          # Get community tweets
+          #
+          # @overload list_by_community(id, cursor: nil, request_options: {})
+          #
+          # @param id [String] Community ID for tweet lookup
+          #
+          # @param cursor [String] Pagination cursor for community tweets
+          #
+          # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [XTwitterScraper::Models::PaginatedTweets]
+          #
+          # @see XTwitterScraper::Models::X::Communities::TweetListByCommunityParams
+          def list_by_community(id, params = {})
+            parsed, options = XTwitterScraper::X::Communities::TweetListByCommunityParams.dump_request(params)
+            query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: ["x/communities/%1$s/tweets", id],
+              query: query,
+              model: XTwitterScraper::PaginatedTweets,
               options: options
             )
           end

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

@@ -16,7 +16,7 @@ module XTwitterScraper
         #
         # @overload create(account:, name:, description: nil, request_options: {})
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account (@username or ID) creating the community
         #
         # @param name [String] Community name
         #
@@ -44,7 +44,7 @@ module XTwitterScraper
         #
         # @param id [String] Resource ID (stringified bigint)
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account (@username or ID) deleting the community
         #
         # @param community_name [String] Community name for confirmation
         #
@@ -88,13 +88,13 @@ module XTwitterScraper
         #
         # @overload retrieve_members(id, cursor: nil, request_options: {})
         #
-        # @param id [String] Community ID
+        # @param id [String] Community ID for member lookup
         #
         # @param cursor [String] Pagination cursor
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::CommunityRetrieveMembersParams
         def retrieve_members(id, params = {})
@@ -104,7 +104,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/communities/%1$s/members", id],
             query: query,
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -113,13 +113,13 @@ module XTwitterScraper
         #
         # @overload retrieve_moderators(id, cursor: nil, request_options: {})
         #
-        # @param id [String] Community ID
+        # @param id [String] Community ID for moderator lookup
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for community moderators
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::CommunityRetrieveModeratorsParams
         def retrieve_moderators(id, params = {})
@@ -129,7 +129,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/communities/%1$s/moderators", id],
             query: query,
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -140,13 +140,13 @@ module XTwitterScraper
         #
         # @param q [String] Search query
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for community search
         #
         # @param query_type [String] Sort order (Latest or Top)
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::CommunityRetrieveSearchParams
         def retrieve_search(params)
@@ -156,7 +156,7 @@ module XTwitterScraper
             method: :get,
             path: "x/communities/search",
             query: query.transform_keys(query_type: "queryType"),
-            model: NilClass,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end

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

@@ -10,7 +10,7 @@ module XTwitterScraper
         #
         # @param user_id [String] Target user ID
         #
-        # @param cursor [String] Pagination cursor from previous response
+        # @param cursor [String] Pagination cursor for DM history
         #
         # @param max_id [String] Legacy pagination cursor (backward compat)
         #
@@ -37,7 +37,7 @@ module XTwitterScraper
         #
         # @param user_id [String] Recipient user ID
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account (@username or ID) sending the DM
         #
         # @param text [String]
         #

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

@@ -11,11 +11,11 @@ module XTwitterScraper
         #
         # @param id [String] List ID
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for list followers
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::ListRetrieveFollowersParams
         def retrieve_followers(id, params = {})
@@ -25,7 +25,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/lists/%1$s/followers", id],
             query: query,
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -34,13 +34,13 @@ module XTwitterScraper
         #
         # @overload retrieve_members(id, cursor: nil, request_options: {})
         #
-        # @param id [String] List ID
+        # @param id [String] List ID for member lookup
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for list members
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedUsers]
         #
         # @see XTwitterScraper::Models::X::ListRetrieveMembersParams
         def retrieve_members(id, params = {})
@@ -50,7 +50,7 @@ module XTwitterScraper
             method: :get,
             path: ["x/lists/%1$s/members", id],
             query: query,
-            model: NilClass,
+            model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
@@ -59,9 +59,9 @@ module XTwitterScraper
         #
         # @overload retrieve_tweets(id, cursor: nil, include_replies: nil, since_time: nil, until_time: nil, request_options: {})
         #
-        # @param id [String] List ID
+        # @param id [String] List ID for tweet lookup
         #
-        # @param cursor [String] Pagination cursor
+        # @param cursor [String] Pagination cursor for list tweets
         #
         # @param include_replies [Boolean] Include replies (default false)
         #
@@ -71,7 +71,7 @@ module XTwitterScraper
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [nil]
+        # @return [XTwitterScraper::Models::PaginatedTweets]
         #
         # @see XTwitterScraper::Models::X::ListRetrieveTweetsParams
         def retrieve_tweets(id, params = {})
@@ -85,7 +85,7 @@ module XTwitterScraper
               since_time: "sinceTime",
               until_time: "untilTime"
             ),
-            model: NilClass,
+            model: XTwitterScraper::PaginatedTweets,
             options: options
           )
         end

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

@@ -33,7 +33,7 @@ module XTwitterScraper
         #
         # @overload upload(account:, file:, is_long_video: nil, request_options: {})
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account (@username or ID) uploading media
         #
         # @param file [Pathname, StringIO, IO, String, XTwitterScraper::FilePart] Media file to upload
         #

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

@@ -9,7 +9,7 @@ module XTwitterScraper
         #
         # @overload update(account:, description: nil, location: nil, name: nil, url: nil, request_options: {})
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account (@username or ID) to update profile
         #
         # @param description [String] Bio description
         #
@@ -39,7 +39,7 @@ module XTwitterScraper
         #
         # @overload update_avatar(account:, file:, request_options: {})
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account (@username or ID) for avatar update
         #
         # @param file [Pathname, StringIO, IO, String, XTwitterScraper::FilePart] Avatar image (max 716KB)
         #
@@ -64,7 +64,7 @@ module XTwitterScraper
         #
         # @overload update_banner(account:, file:, request_options: {})
         #
-        # @param account [String] X account (@username or account ID)
+        # @param account [String] X account (@username or ID) for banner update
         #
         # @param file [Pathname, StringIO, IO, String, XTwitterScraper::FilePart] Banner image (max 2MB)
         #

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

@@ -8,22 +8,22 @@ module XTwitterScraper
         class Like
           # Like tweet
           #
-          # @overload create(tweet_id, account:, request_options: {})
+          # @overload create(id, account:, request_options: {})
           #
-          # @param tweet_id [String]
+          # @param id [String] Tweet ID to like
           #
-          # @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::Tweets::LikeCreateResponse]
           #
           # @see XTwitterScraper::Models::X::Tweets::LikeCreateParams
-          def create(tweet_id, params)
+          def create(id, params)
             parsed, options = XTwitterScraper::X::Tweets::LikeCreateParams.dump_request(params)
             @client.request(
               method: :post,
-              path: ["x/tweets/%1$s/like", tweet_id],
+              path: ["x/tweets/%1$s/like", id],
               body: parsed,
               model: XTwitterScraper::Models::X::Tweets::LikeCreateResponse,
               options: options
@@ -32,22 +32,22 @@ module XTwitterScraper
 
           # Unlike tweet
           #
-          # @overload delete(tweet_id, account:, request_options: {})
+          # @overload delete(id, account:, request_options: {})
           #
-          # @param tweet_id [String]
+          # @param id [String] Tweet ID to unlike
           #
-          # @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::Tweets::LikeDeleteResponse]
           #
           # @see XTwitterScraper::Models::X::Tweets::LikeDeleteParams
-          def delete(tweet_id, params)
+          def delete(id, params)
             parsed, options = XTwitterScraper::X::Tweets::LikeDeleteParams.dump_request(params)
             @client.request(
               method: :delete,
-              path: ["x/tweets/%1$s/like", tweet_id],
+              path: ["x/tweets/%1$s/like", id],
               body: parsed,
               model: XTwitterScraper::Models::X::Tweets::LikeDeleteResponse,
               options: options

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

@@ -8,22 +8,22 @@ module XTwitterScraper
         class Retweet
           # Retweet
           #
-          # @overload create(tweet_id, account:, request_options: {})
+          # @overload create(id, account:, request_options: {})
           #
-          # @param tweet_id [String]
+          # @param id [String] Tweet ID to retweet
           #
-          # @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::Tweets::RetweetCreateResponse]
           #
           # @see XTwitterScraper::Models::X::Tweets::RetweetCreateParams
-          def create(tweet_id, params)
+          def create(id, params)
             parsed, options = XTwitterScraper::X::Tweets::RetweetCreateParams.dump_request(params)
             @client.request(
               method: :post,
-              path: ["x/tweets/%1$s/retweet", tweet_id],
+              path: ["x/tweets/%1$s/retweet", id],
               body: parsed,
               model: XTwitterScraper::Models::X::Tweets::RetweetCreateResponse,
               options: options
@@ -32,22 +32,22 @@ module XTwitterScraper
 
           # Unretweet
           #
-          # @overload delete(tweet_id, account:, request_options: {})
+          # @overload delete(id, account:, request_options: {})
           #
-          # @param tweet_id [String]
+          # @param id [String] Tweet ID to unretweet
           #
-          # @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::Tweets::RetweetDeleteResponse]
           #
           # @see XTwitterScraper::Models::X::Tweets::RetweetDeleteParams
-          def delete(tweet_id, params)
+          def delete(id, params)
             parsed, options = XTwitterScraper::X::Tweets::RetweetDeleteParams.dump_request(params)
             @client.request(
               method: :delete,
-              path: ["x/tweets/%1$s/retweet", tweet_id],
+              path: ["x/tweets/%1$s/retweet", id],
               body: parsed,
               model: XTwitterScraper::Models::X::Tweets::RetweetDeleteResponse,
               options: options