x-twitter-scraper 0.3.0 → 0.4.0

data/lib/x_twitter_scraper/models/paginated_tweets.rb

@@ -15,106 +15,15 @@ module XTwitterScraper
 
       # @!attribute tweets
       #
-      #   @return [Array<XTwitterScraper::Models::PaginatedTweets::Tweet>]
-      required :tweets, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::PaginatedTweets::Tweet] }
+      #   @return [Array<XTwitterScraper::Models::X::SearchTweet>]
+      required :tweets, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::X::SearchTweet] }
 
       # @!method initialize(has_next_page:, next_cursor:, tweets:)
+      #   Paginated list of tweets with cursor-based navigation.
+      #
       #   @param has_next_page [Boolean]
       #   @param next_cursor [String]
-      #   @param tweets [Array<XTwitterScraper::Models::PaginatedTweets::Tweet>]
-
-      class Tweet < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute text
-        #
-        #   @return [String]
-        required :text, String
-
-        # @!attribute author
-        #
-        #   @return [XTwitterScraper::Models::PaginatedTweets::Tweet::Author, nil]
-        optional :author, -> { XTwitterScraper::PaginatedTweets::Tweet::Author }
-
-        # @!attribute bookmark_count
-        #
-        #   @return [Integer, nil]
-        optional :bookmark_count, Integer, api_name: :bookmarkCount
-
-        # @!attribute created_at
-        #
-        #   @return [String, nil]
-        optional :created_at, String, api_name: :createdAt
-
-        # @!attribute like_count
-        #
-        #   @return [Integer, nil]
-        optional :like_count, Integer, api_name: :likeCount
-
-        # @!attribute quote_count
-        #
-        #   @return [Integer, nil]
-        optional :quote_count, Integer, api_name: :quoteCount
-
-        # @!attribute reply_count
-        #
-        #   @return [Integer, nil]
-        optional :reply_count, Integer, api_name: :replyCount
-
-        # @!attribute retweet_count
-        #
-        #   @return [Integer, nil]
-        optional :retweet_count, Integer, api_name: :retweetCount
-
-        # @!attribute view_count
-        #
-        #   @return [Integer, nil]
-        optional :view_count, Integer, api_name: :viewCount
-
-        # @!method initialize(id:, text:, author: nil, bookmark_count: nil, created_at: nil, like_count: nil, quote_count: nil, reply_count: nil, retweet_count: nil, view_count: nil)
-        #   @param id [String]
-        #   @param text [String]
-        #   @param author [XTwitterScraper::Models::PaginatedTweets::Tweet::Author]
-        #   @param bookmark_count [Integer]
-        #   @param created_at [String]
-        #   @param like_count [Integer]
-        #   @param quote_count [Integer]
-        #   @param reply_count [Integer]
-        #   @param retweet_count [Integer]
-        #   @param view_count [Integer]
-
-        # @see XTwitterScraper::Models::PaginatedTweets::Tweet#author
-        class Author < XTwitterScraper::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute username
-          #
-          #   @return [String]
-          required :username, String
-
-          # @!attribute verified
-          #
-          #   @return [Boolean, nil]
-          optional :verified, XTwitterScraper::Internal::Type::Boolean
-
-          # @!method initialize(id:, name:, username:, verified: nil)
-          #   @param id [String]
-          #   @param name [String]
-          #   @param username [String]
-          #   @param verified [Boolean]
-        end
-      end
+      #   @param tweets [Array<XTwitterScraper::Models::X::SearchTweet>]
     end
   end
 end

data/lib/x_twitter_scraper/models/paginated_users.rb

@@ -15,83 +15,15 @@ module XTwitterScraper
 
       # @!attribute users
       #
-      #   @return [Array<XTwitterScraper::Models::PaginatedUsers::User>]
-      required :users, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::PaginatedUsers::User] }
+      #   @return [Array<XTwitterScraper::Models::X::UserProfile>]
+      required :users, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::X::UserProfile] }
 
       # @!method initialize(has_next_page:, next_cursor:, users:)
+      #   Paginated list of user profiles with cursor-based navigation.
+      #
       #   @param has_next_page [Boolean]
       #   @param next_cursor [String]
-      #   @param users [Array<XTwitterScraper::Models::PaginatedUsers::User>]
-
-      class User < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute name
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute username
-        #
-        #   @return [String]
-        required :username, String
-
-        # @!attribute created_at
-        #
-        #   @return [String, nil]
-        optional :created_at, String, api_name: :createdAt
-
-        # @!attribute description
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!attribute followers
-        #
-        #   @return [Integer, nil]
-        optional :followers, Integer
-
-        # @!attribute following
-        #
-        #   @return [Integer, nil]
-        optional :following, Integer
-
-        # @!attribute location
-        #
-        #   @return [String, nil]
-        optional :location, String
-
-        # @!attribute profile_picture
-        #
-        #   @return [String, nil]
-        optional :profile_picture, String, api_name: :profilePicture
-
-        # @!attribute statuses_count
-        #
-        #   @return [Integer, nil]
-        optional :statuses_count, Integer, api_name: :statusesCount
-
-        # @!attribute verified
-        #
-        #   @return [Boolean, nil]
-        optional :verified, XTwitterScraper::Internal::Type::Boolean
-
-        # @!method initialize(id:, name:, username:, created_at: nil, description: nil, followers: nil, following: nil, location: nil, profile_picture: nil, statuses_count: nil, verified: nil)
-        #   @param id [String]
-        #   @param name [String]
-        #   @param username [String]
-        #   @param created_at [String]
-        #   @param description [String]
-        #   @param followers [Integer]
-        #   @param following [Integer]
-        #   @param location [String]
-        #   @param profile_picture [String]
-        #   @param statuses_count [Integer]
-        #   @param verified [Boolean]
-      end
+      #   @param users [Array<XTwitterScraper::Models::X::UserProfile>]
     end
   end
 end

data/lib/x_twitter_scraper/models/radar_item.rb

@@ -49,6 +49,8 @@ module XTwitterScraper
       optional :url, String
 
       # @!method initialize(category:, published_at:, region:, score:, source:, title:, description: nil, image_url: nil, url: nil)
+      #   Trending topic with score, category, source, and region.
+      #
       #   @param category [String]
       #   @param published_at [Time]
       #   @param region [String]

data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb

@@ -35,8 +35,8 @@ module XTwitterScraper
       #   Source filter. One of: github, google_trends, hacker_news, polymarket, reddit,
       #   trustmrr, wikipedia
       #
-      #   @return [String, nil]
-      optional :source, String
+      #   @return [Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Source, nil]
+      optional :source, enum: -> { XTwitterScraper::RadarRetrieveTrendingTopicsParams::Source }
 
       # @!method initialize(category: nil, count: nil, hours: nil, region: nil, source: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
@@ -50,9 +50,26 @@ 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}]
+
+      # Source filter. One of: github, google_trends, hacker_news, polymarket, reddit,
+      # trustmrr, wikipedia
+      module Source
+        extend XTwitterScraper::Internal::Type::Enum
+
+        GITHUB = :github
+        GOOGLE_TRENDS = :google_trends
+        HACKER_NEWS = :hacker_news
+        POLYMARKET = :polymarket
+        REDDIT = :reddit
+        TRUSTMRR = :trustmrr
+        WIKIPEDIA = :wikipedia
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rb

@@ -6,9 +6,8 @@ module XTwitterScraper
     class RadarRetrieveTrendingTopicsResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute items
       #
-      #   @return [Array<XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse::Item>]
-      required :items,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse::Item] }
+      #   @return [Array<XTwitterScraper::Models::RadarItem>]
+      required :items, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::RadarItem] }
 
       # @!attribute total
       #
@@ -16,66 +15,8 @@ module XTwitterScraper
       required :total, Integer
 
       # @!method initialize(items:, total:)
-      #   @param items [Array<XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse::Item>]
+      #   @param items [Array<XTwitterScraper::Models::RadarItem>]
       #   @param total [Integer]
-
-      class Item < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute category
-        #
-        #   @return [String]
-        required :category, String
-
-        # @!attribute published_at
-        #
-        #   @return [Time]
-        required :published_at, Time, api_name: :publishedAt
-
-        # @!attribute region
-        #
-        #   @return [String]
-        required :region, String
-
-        # @!attribute score
-        #
-        #   @return [Float]
-        required :score, Float
-
-        # @!attribute source
-        #
-        #   @return [String]
-        required :source, String
-
-        # @!attribute title
-        #
-        #   @return [String]
-        required :title, String
-
-        # @!attribute description
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!attribute image_url
-        #
-        #   @return [String, nil]
-        optional :image_url, String, api_name: :imageUrl
-
-        # @!attribute url
-        #
-        #   @return [String, nil]
-        optional :url, String
-
-        # @!method initialize(category:, published_at:, region:, score:, source:, title:, description: nil, image_url: nil, url: nil)
-        #   @param category [String]
-        #   @param published_at [Time]
-        #   @param region [String]
-        #   @param score [Float]
-        #   @param source [String]
-        #   @param title [String]
-        #   @param description [String]
-        #   @param image_url [String]
-        #   @param url [String]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/style_compare_response.rb

@@ -5,146 +5,21 @@ module XTwitterScraper
     # @see XTwitterScraper::Resources::Styles#compare
     class StyleCompareResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute style1
+      #   Full style profile with sampled tweets used for tone analysis.
       #
-      #   @return [XTwitterScraper::Models::StyleCompareResponse::Style1]
-      required :style1, -> { XTwitterScraper::Models::StyleCompareResponse::Style1 }
+      #   @return [XTwitterScraper::Models::StyleProfile]
+      required :style1, -> { XTwitterScraper::StyleProfile }
 
       # @!attribute style2
+      #   Full style profile with sampled tweets used for tone analysis.
       #
-      #   @return [XTwitterScraper::Models::StyleCompareResponse::Style2]
-      required :style2, -> { XTwitterScraper::Models::StyleCompareResponse::Style2 }
+      #   @return [XTwitterScraper::Models::StyleProfile]
+      required :style2, -> { XTwitterScraper::StyleProfile }
 
       # @!method initialize(style1:, style2:)
-      #   @param style1 [XTwitterScraper::Models::StyleCompareResponse::Style1]
-      #   @param style2 [XTwitterScraper::Models::StyleCompareResponse::Style2]
-
-      # @see XTwitterScraper::Models::StyleCompareResponse#style1
-      class Style1 < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute fetched_at
-        #
-        #   @return [Time]
-        required :fetched_at, Time, api_name: :fetchedAt
-
-        # @!attribute is_own_account
-        #
-        #   @return [Boolean]
-        required :is_own_account, XTwitterScraper::Internal::Type::Boolean, api_name: :isOwnAccount
-
-        # @!attribute tweet_count
-        #
-        #   @return [Integer]
-        required :tweet_count, Integer, api_name: :tweetCount
-
-        # @!attribute tweets
-        #
-        #   @return [Array<XTwitterScraper::Models::StyleCompareResponse::Style1::Tweet>]
-        required :tweets,
-                 -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::StyleCompareResponse::Style1::Tweet] }
-
-        # @!attribute x_username
-        #
-        #   @return [String]
-        required :x_username, String, api_name: :xUsername
-
-        # @!method initialize(fetched_at:, is_own_account:, tweet_count:, tweets:, x_username:)
-        #   @param fetched_at [Time]
-        #   @param is_own_account [Boolean]
-        #   @param tweet_count [Integer]
-        #   @param tweets [Array<XTwitterScraper::Models::StyleCompareResponse::Style1::Tweet>]
-        #   @param x_username [String]
-
-        class Tweet < XTwitterScraper::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute text
-          #
-          #   @return [String]
-          required :text, String
-
-          # @!attribute author_username
-          #
-          #   @return [String, nil]
-          optional :author_username, String, api_name: :authorUsername
-
-          # @!attribute created_at
-          #
-          #   @return [String, nil]
-          optional :created_at, String, api_name: :createdAt
-
-          # @!method initialize(id:, text:, author_username: nil, created_at: nil)
-          #   @param id [String]
-          #   @param text [String]
-          #   @param author_username [String]
-          #   @param created_at [String]
-        end
-      end
-
-      # @see XTwitterScraper::Models::StyleCompareResponse#style2
-      class Style2 < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute fetched_at
-        #
-        #   @return [Time]
-        required :fetched_at, Time, api_name: :fetchedAt
-
-        # @!attribute is_own_account
-        #
-        #   @return [Boolean]
-        required :is_own_account, XTwitterScraper::Internal::Type::Boolean, api_name: :isOwnAccount
-
-        # @!attribute tweet_count
-        #
-        #   @return [Integer]
-        required :tweet_count, Integer, api_name: :tweetCount
-
-        # @!attribute tweets
-        #
-        #   @return [Array<XTwitterScraper::Models::StyleCompareResponse::Style2::Tweet>]
-        required :tweets,
-                 -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::StyleCompareResponse::Style2::Tweet] }
-
-        # @!attribute x_username
-        #
-        #   @return [String]
-        required :x_username, String, api_name: :xUsername
-
-        # @!method initialize(fetched_at:, is_own_account:, tweet_count:, tweets:, x_username:)
-        #   @param fetched_at [Time]
-        #   @param is_own_account [Boolean]
-        #   @param tweet_count [Integer]
-        #   @param tweets [Array<XTwitterScraper::Models::StyleCompareResponse::Style2::Tweet>]
-        #   @param x_username [String]
-
-        class Tweet < XTwitterScraper::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute text
-          #
-          #   @return [String]
-          required :text, String
-
-          # @!attribute author_username
-          #
-          #   @return [String, nil]
-          optional :author_username, String, api_name: :authorUsername
-
-          # @!attribute created_at
-          #
-          #   @return [String, nil]
-          optional :created_at, String, api_name: :createdAt
-
-          # @!method initialize(id:, text:, author_username: nil, created_at: nil)
-          #   @param id [String]
-          #   @param text [String]
-          #   @param author_username [String]
-          #   @param created_at [String]
-        end
-      end
+      #   @param style1 [XTwitterScraper::Models::StyleProfile] Full style profile with sampled tweets used for tone analysis.
+      #
+      #   @param style2 [XTwitterScraper::Models::StyleProfile] Full style profile with sampled tweets used for tone analysis.
     end
   end
 end

data/lib/x_twitter_scraper/models/style_delete_params.rb

@@ -7,13 +7,13 @@ module XTwitterScraper
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      # @!attribute username
+      # @!attribute id
       #
       #   @return [String]
-      required :username, String
+      required :id, String
 
-      # @!method initialize(username:, request_options: {})
-      #   @param username [String]
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/x_twitter_scraper/models/style_get_performance_params.rb

@@ -7,13 +7,13 @@ module XTwitterScraper
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      # @!attribute username
+      # @!attribute id
       #
       #   @return [String]
-      required :username, String
+      required :id, String
 
-      # @!method initialize(username:, request_options: {})
-      #   @param username [String]
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/x_twitter_scraper/models/style_list_response.rb

@@ -6,40 +6,11 @@ module XTwitterScraper
     class StyleListResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute styles
       #
-      #   @return [Array<XTwitterScraper::Models::StyleListResponse::Style>]
-      required :styles,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::StyleListResponse::Style] }
+      #   @return [Array<XTwitterScraper::Models::StyleProfileSummary>]
+      required :styles, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::StyleProfileSummary] }
 
       # @!method initialize(styles:)
-      #   @param styles [Array<XTwitterScraper::Models::StyleListResponse::Style>]
-
-      class Style < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute fetched_at
-        #
-        #   @return [Time]
-        required :fetched_at, Time, api_name: :fetchedAt
-
-        # @!attribute is_own_account
-        #
-        #   @return [Boolean]
-        required :is_own_account, XTwitterScraper::Internal::Type::Boolean, api_name: :isOwnAccount
-
-        # @!attribute tweet_count
-        #
-        #   @return [Integer]
-        required :tweet_count, Integer, api_name: :tweetCount
-
-        # @!attribute x_username
-        #
-        #   @return [String]
-        required :x_username, String, api_name: :xUsername
-
-        # @!method initialize(fetched_at:, is_own_account:, tweet_count:, x_username:)
-        #   @param fetched_at [Time]
-        #   @param is_own_account [Boolean]
-        #   @param tweet_count [Integer]
-        #   @param x_username [String]
-      end
+      #   @param styles [Array<XTwitterScraper::Models::StyleProfileSummary>]
     end
   end
 end

data/lib/x_twitter_scraper/models/style_profile.rb

@@ -2,6 +2,7 @@
 
 module XTwitterScraper
   module Models
+    # @see XTwitterScraper::Resources::Styles#retrieve
     class StyleProfile < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute fetched_at
       #
@@ -29,6 +30,8 @@ module XTwitterScraper
       required :x_username, String, api_name: :xUsername
 
       # @!method initialize(fetched_at:, is_own_account:, tweet_count:, tweets:, x_username:)
+      #   Full style profile with sampled tweets used for tone analysis.
+      #
       #   @param fetched_at [Time]
       #   @param is_own_account [Boolean]
       #   @param tweet_count [Integer]

data/lib/x_twitter_scraper/models/style_profile_summary.rb

@@ -24,6 +24,8 @@ module XTwitterScraper
       required :x_username, String, api_name: :xUsername
 
       # @!method initialize(fetched_at:, is_own_account:, tweet_count:, x_username:)
+      #   Style profile summary with tweet count and ownership flag.
+      #
       #   @param fetched_at [Time]
       #   @param is_own_account [Boolean]
       #   @param tweet_count [Integer]

data/lib/x_twitter_scraper/models/style_retrieve_params.rb

@@ -7,13 +7,13 @@ module XTwitterScraper
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      # @!attribute username
+      # @!attribute id
       #
       #   @return [String]
-      required :username, String
+      required :id, String
 
-      # @!method initialize(username:, request_options: {})
-      #   @param username [String]
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/x_twitter_scraper/models/style_update_params.rb

@@ -7,10 +7,10 @@ module XTwitterScraper
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      # @!attribute username
+      # @!attribute id
       #
       #   @return [String]
-      required :username, String
+      required :id, String
 
       # @!attribute label
       #   Display label for the style
@@ -25,8 +25,8 @@ module XTwitterScraper
       required :tweets,
                -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::StyleUpdateParams::Tweet] }
 
-      # @!method initialize(username:, label:, tweets:, request_options: {})
-      #   @param username [String]
+      # @!method initialize(id:, label:, tweets:, request_options: {})
+      #   @param id [String]
       #
       #   @param label [String] Display label for the style
       #

data/lib/x_twitter_scraper/models/trend_list_params.rb

@@ -8,6 +8,7 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute count
+      #   Number of trending topics to return (1-50, default 30)
       #
       #   @return [Integer, nil]
       optional :count, Integer
@@ -19,7 +20,7 @@ module XTwitterScraper
       optional :woeid, Integer
 
       # @!method initialize(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)
       #