x-twitter-scraper 0.5.4 → 0.6.0

data/lib/x_twitter_scraper/models/event.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/event_detail.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/event_list_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/event_list_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/event_retrieve_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/event_type.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_estimate_cost_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_estimate_cost_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_export_results_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_job.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_list_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_list_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_retrieve_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_retrieve_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_run_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/extraction_run_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/guest_wallet_amount.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/guest_wallet_create_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/guest_wallet_create_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/guest_wallet_retrieve_status_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/guest_wallet_retrieve_status_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/guest_wallet_topup_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/guest_wallet_topup_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_create_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_create_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_deactivate_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_deactivate_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_list_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_list_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_retrieve_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitor_update_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_create_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_create_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_deactivate_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_deactivate_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_list_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_list_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_retrieve_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_retrieve_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_update_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/monitors/keyword_update_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/paginated_tweets.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/paginated_users.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/radar_item.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper
@@ -20,6 +24,7 @@ module XTwitterScraper
       required :created_at, Time, api_name: :createdAt
 
       # @!attribute language
+      #   BCP-47 language code. und means the source did not identify a language.
       #
       #   @return [String]
       required :language, String
@@ -27,7 +32,18 @@ module XTwitterScraper
       # @!attribute metadata
       #   Source-specific fields. Shape varies per source:
       #
-      #   - reddit: { subreddit: string, author: string }
+      #   - reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?,
+      #     sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?,
+      #     numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?,
+      #     postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?,
+      #     editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?,
+      #     isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?,
+      #     isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. `score` is Reddit's
+      #     public net score. Exact public upvote and downvote counts are not available.
+      #     Estimated counts derive from the public score and upvote ratio, which Reddit
+      #     may fuzz. Comment bodies are not included. Current items combine public
+      #     listing discovery with server-rendered post data and use `sourceFormat: html`;
+      #     `json` and `rss` remain for legacy rows.
       #   - github: { starsToday: number }
       #   - hacker_news: { points: number, numberComments: number }
       #   - google_trends: { approxTraffic: number }
@@ -35,10 +51,15 @@ module XTwitterScraper
       #   - wikipedia: { views: number }
       #   - trustmrr: { mrr, growthPercent, last30Days, total, customers,
       #     activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?,
-      #     growthMrrPercent?, multiple?, paymentProvider?, rank? }
+      #     foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?,
+      #     multiple?, paymentProvider?, profitMarginLast30Days?, rank?,
+      #     revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup
+      #     growth source, xHandle is the founder's X username without @. The rank field
+      #     is the source's revenue rank. Result order represents reported 30-day
+      #     revenue-growth rank.
       #
-      #   @return [Hash{Symbol=>Object}]
-      required :metadata, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+      #   @return [XTwitterScraper::Models::RadarItem::Metadata]
+      required :metadata, -> { XTwitterScraper::RadarItem::Metadata }
 
       # @!attribute published_at
       #
@@ -77,6 +98,7 @@ module XTwitterScraper
       optional :description, String
 
       # @!attribute image_url
+      #   Source image. Startup growth items return the logo here.
       #
       #   @return [String, nil]
       optional :image_url, String, api_name: :imageUrl
@@ -99,9 +121,9 @@ module XTwitterScraper
       #
       #   @param created_at [Time]
       #
-      #   @param language [String]
+      #   @param language [String] BCP-47 language code. und means the source did not identify a language.
       #
-      #   @param metadata [Hash{Symbol=>Object}] Source-specific fields. Shape varies per source:
+      #   @param metadata [XTwitterScraper::Models::RadarItem::Metadata] Source-specific fields. Shape varies per source:
       #
       #   @param published_at [Time]
       #
@@ -117,7 +139,7 @@ module XTwitterScraper
       #
       #   @param description [String]
       #
-      #   @param image_url [String]
+      #   @param image_url [String] Source image. Startup growth items return the logo here.
       #
       #   @param url [String]
 
@@ -138,6 +160,125 @@ module XTwitterScraper
         #   @return [Array<Symbol>]
       end
 
+      # @see XTwitterScraper::Models::RadarItem#metadata
+      class Metadata < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute author
+        #
+        #   @return [String, nil]
+        optional :author, String
+
+        # @!attribute content_url
+        #
+        #   @return [String, nil]
+        optional :content_url, String, api_name: :contentUrl
+
+        # @!attribute estimated_downvotes
+        #
+        #   @return [Integer, nil]
+        optional :estimated_downvotes, Integer, api_name: :estimatedDownvotes
+
+        # @!attribute estimated_upvotes
+        #
+        #   @return [Integer, nil]
+        optional :estimated_upvotes, Integer, api_name: :estimatedUpvotes
+
+        # @!attribute number_comments
+        #
+        #   @return [Integer, nil]
+        optional :number_comments, Integer, api_name: :numberComments
+
+        # @!attribute score
+        #
+        #   @return [Integer, nil]
+        optional :score, Integer
+
+        # @!attribute selftext
+        #
+        #   @return [String, nil]
+        optional :selftext, String
+
+        # @!attribute source_format
+        #   Current items use html. json and rss are retained for legacy rows.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::RadarItem::Metadata::SourceFormat, nil]
+        optional :source_format,
+                 enum: -> { XTwitterScraper::RadarItem::Metadata::SourceFormat },
+                 api_name: :sourceFormat
+
+        # @!attribute subreddit
+        #
+        #   @return [String, nil]
+        optional :subreddit, String
+
+        # @!attribute upvote_ratio
+        #
+        #   @return [Float, nil]
+        optional :upvote_ratio, Float, api_name: :upvoteRatio
+
+        # @!method initialize(author: nil, content_url: nil, estimated_downvotes: nil, estimated_upvotes: nil, number_comments: nil, score: nil, selftext: nil, source_format: nil, subreddit: nil, upvote_ratio: nil)
+        #   Source-specific fields. Shape varies per source:
+        #
+        #   - reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?,
+        #     sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?,
+        #     numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?,
+        #     postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?,
+        #     editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?,
+        #     isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?,
+        #     isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. `score` is Reddit's
+        #     public net score. Exact public upvote and downvote counts are not available.
+        #     Estimated counts derive from the public score and upvote ratio, which Reddit
+        #     may fuzz. Comment bodies are not included. Current items combine public
+        #     listing discovery with server-rendered post data and use `sourceFormat: html`;
+        #     `json` and `rss` remain for legacy rows.
+        #   - github: { starsToday: number }
+        #   - hacker_news: { points: number, numberComments: number }
+        #   - google_trends: { approxTraffic: number }
+        #   - polymarket: { volume24hr: number }
+        #   - wikipedia: { views: number }
+        #   - trustmrr: { mrr, growthPercent, last30Days, total, customers,
+        #     activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?,
+        #     foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?,
+        #     multiple?, paymentProvider?, profitMarginLast30Days?, rank?,
+        #     revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup
+        #     growth source, xHandle is the founder's X username without @. The rank field
+        #     is the source's revenue rank. Result order represents reported 30-day
+        #     revenue-growth rank.
+        #
+        #   @param author [String]
+        #
+        #   @param content_url [String]
+        #
+        #   @param estimated_downvotes [Integer]
+        #
+        #   @param estimated_upvotes [Integer]
+        #
+        #   @param number_comments [Integer]
+        #
+        #   @param score [Integer]
+        #
+        #   @param selftext [String]
+        #
+        #   @param source_format [Symbol, XTwitterScraper::Models::RadarItem::Metadata::SourceFormat] Current items use html. json and rss are retained for legacy rows.
+        #
+        #   @param subreddit [String]
+        #
+        #   @param upvote_ratio [Float]
+
+        # Current items use html. json and rss are retained for legacy rows.
+        #
+        # @see XTwitterScraper::Models::RadarItem::Metadata#source_format
+        module SourceFormat
+          extend XTwitterScraper::Internal::Type::Enum
+
+          HTML = :html
+          JSON = :json
+          RSS = :rss
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see XTwitterScraper::Models::RadarItem#source
       module Source
         extend XTwitterScraper::Internal::Type::Enum

data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/search_tweet.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/style_analyze_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/style_compare_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/style_compare_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper