x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/monitors/keyword_list_response.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordListResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::Monitors::KeywordListResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              XTwitterScraper::Models::Monitors::KeywordListResponse::Monitor
+            ]
+          )
+        end
+        attr_accessor :monitors
+
+        sig { returns(Integer) }
+        attr_accessor :total
+
+        sig do
+          params(
+            monitors:
+              T::Array[
+                XTwitterScraper::Models::Monitors::KeywordListResponse::Monitor::OrHash
+              ],
+            total: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(monitors:, total:)
+        end
+
+        sig do
+          override.returns(
+            {
+              monitors:
+                T::Array[
+                  XTwitterScraper::Models::Monitors::KeywordListResponse::Monitor
+                ],
+              total: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Monitor < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::Monitors::KeywordListResponse::Monitor,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # Array of event types to subscribe to.
+          sig { returns(T::Array[XTwitterScraper::EventType::TaggedSymbol]) }
+          attr_accessor :event_types
+
+          sig { returns(T::Boolean) }
+          attr_accessor :is_active
+
+          # Next hourly credit charge time for this keyword query monitor.
+          sig { returns(Time) }
+          attr_accessor :next_billing_at
+
+          sig { returns(String) }
+          attr_accessor :query
+
+          # Keyword monitor that tracks matching public X activity.
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+              is_active: T::Boolean,
+              next_billing_at: Time,
+              query: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            created_at:,
+            # Array of event types to subscribe to.
+            event_types:,
+            is_active:,
+            # Next hourly credit charge time for this keyword query monitor.
+            next_billing_at:,
+            query:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                event_types: T::Array[XTwitterScraper::EventType::TaggedSymbol],
+                is_active: T::Boolean,
+                next_billing_at: Time,
+                query: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Monitors::KeywordRetrieveParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { id: String, request_options: XTwitterScraper::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_retrieve_response.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::Monitors::KeywordRetrieveResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Array of event types to subscribe to.
+        sig { returns(T::Array[XTwitterScraper::EventType::TaggedSymbol]) }
+        attr_accessor :event_types
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_active
+
+        # Next hourly credit charge time for this keyword query monitor.
+        sig { returns(Time) }
+        attr_accessor :next_billing_at
+
+        sig { returns(String) }
+        attr_accessor :query
+
+        # Keyword monitor that tracks matching public X activity.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+            is_active: T::Boolean,
+            next_billing_at: Time,
+            query: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          # Array of event types to subscribe to.
+          event_types:,
+          is_active:,
+          # Next hourly credit charge time for this keyword query monitor.
+          next_billing_at:,
+          query:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              event_types: T::Array[XTwitterScraper::EventType::TaggedSymbol],
+              is_active: T::Boolean,
+              next_billing_at: Time,
+              query: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_update_params.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordUpdateParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Monitors::KeywordUpdateParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Array of event types to subscribe to.
+        sig do
+          returns(T.nilable(T::Array[XTwitterScraper::EventType::OrSymbol]))
+        end
+        attr_reader :event_types
+
+        sig do
+          params(
+            event_types: T::Array[XTwitterScraper::EventType::OrSymbol]
+          ).void
+        end
+        attr_writer :event_types
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_active
+
+        sig { params(is_active: T::Boolean).void }
+        attr_writer :is_active
+
+        sig do
+          params(
+            id: String,
+            event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+            is_active: T::Boolean,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Array of event types to subscribe to.
+          event_types: nil,
+          is_active: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+              is_active: T::Boolean,
+              request_options: XTwitterScraper::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_update_response.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordUpdateResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::Monitors::KeywordUpdateResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Array of event types to subscribe to.
+        sig { returns(T::Array[XTwitterScraper::EventType::TaggedSymbol]) }
+        attr_accessor :event_types
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_active
+
+        # Next hourly credit charge time for this keyword query monitor.
+        sig { returns(Time) }
+        attr_accessor :next_billing_at
+
+        sig { returns(String) }
+        attr_accessor :query
+
+        # Keyword monitor that tracks matching public X activity.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+            is_active: T::Boolean,
+            next_billing_at: Time,
+            query: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          # Array of event types to subscribe to.
+          event_types:,
+          is_active:,
+          # Next hourly credit charge time for this keyword query monitor.
+          next_billing_at:,
+          query:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              event_types: T::Array[XTwitterScraper::EventType::TaggedSymbol],
+              is_active: T::Boolean,
+              next_billing_at: Time,
+              query: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/paginated_tweets.rbi

@@ -17,15 +17,19 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :next_cursor
 
-      sig { returns(T::Array[XTwitterScraper::X::SearchTweet]) }
+      sig { returns(T::Array[XTwitterScraper::SearchTweet]) }
       attr_accessor :tweets
 
-      # Paginated list of tweets with cursor-based navigation.
+      # Paginated tweet results. The item count can be lower than pageSize when the
+      # source returns fewer tweets, filters remove tweets, or remaining credits cover
+      # fewer results. Follow next_cursor while has_next_page is true. An empty page can
+      # still have has_next_page true after filtering. Zero affordable results returns
+      # 402 insufficient_credits.
       sig do
         params(
           has_next_page: T::Boolean,
           next_cursor: String,
-          tweets: T::Array[XTwitterScraper::X::SearchTweet::OrHash]
+          tweets: T::Array[XTwitterScraper::SearchTweet::OrHash]
         ).returns(T.attached_class)
       end
       def self.new(has_next_page:, next_cursor:, tweets:)
@@ -36,7 +40,7 @@ module XTwitterScraper
           {
             has_next_page: T::Boolean,
             next_cursor: String,
-            tweets: T::Array[XTwitterScraper::X::SearchTweet]
+            tweets: T::Array[XTwitterScraper::SearchTweet]
           }
         )
       end

data/rbi/x_twitter_scraper/models/paginated_users.rbi

@@ -17,15 +17,19 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :next_cursor
 
-      sig { returns(T::Array[XTwitterScraper::X::UserProfile]) }
+      sig { returns(T::Array[XTwitterScraper::UserProfile]) }
       attr_accessor :users
 
-      # Paginated list of user profiles with cursor-based navigation.
+      # Paginated user profiles. The item count can be lower than pageSize when the
+      # source returns fewer profiles or remaining credits cover fewer results. Follow
+      # next_cursor while has_next_page is true. A relationship can naturally contain
+      # fewer profiles than requested. Zero affordable results returns 402
+      # insufficient_credits.
       sig do
         params(
           has_next_page: T::Boolean,
           next_cursor: String,
-          users: T::Array[XTwitterScraper::X::UserProfile::OrHash]
+          users: T::Array[XTwitterScraper::UserProfile::OrHash]
         ).returns(T.attached_class)
       end
       def self.new(has_next_page:, next_cursor:, users:)
@@ -36,7 +40,7 @@ module XTwitterScraper
           {
             has_next_page: T::Boolean,
             next_cursor: String,
-            users: T::Array[XTwitterScraper::X::UserProfile]
+            users: T::Array[XTwitterScraper::UserProfile]
           }
         )
       end

data/rbi/x_twitter_scraper/models/radar_item.rbi

@@ -8,9 +8,33 @@ module XTwitterScraper
           T.any(XTwitterScraper::RadarItem, XTwitterScraper::Internal::AnyHash)
         end
 
+      # Radar item identifier.
       sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(XTwitterScraper::RadarItem::Category::TaggedSymbol) }
       attr_accessor :category
 
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :language
+
+      # Source-specific fields. Shape varies per source:
+      #
+      # - reddit: { subreddit: string, author: string }
+      # - 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?,
+      #   growthMrrPercent?, multiple?, paymentProvider?, rank? }
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :metadata
+
       sig { returns(Time) }
       attr_accessor :published_at
 
@@ -20,9 +44,13 @@ module XTwitterScraper
       sig { returns(Float) }
       attr_accessor :score
 
-      sig { returns(String) }
+      sig { returns(XTwitterScraper::RadarItem::Source::TaggedSymbol) }
       attr_accessor :source
 
+      # Source-specific identifier used for deduplication.
+      sig { returns(String) }
+      attr_accessor :source_id
+
       sig { returns(String) }
       attr_accessor :title
 
@@ -44,14 +72,20 @@ module XTwitterScraper
       sig { params(url: String).void }
       attr_writer :url
 
-      # Trending topic with score, category, source, and region.
+      # Trending topic with score, category, source, region, language, and
+      # source-specific metadata.
       sig do
         params(
-          category: String,
+          id: String,
+          category: XTwitterScraper::RadarItem::Category::OrSymbol,
+          created_at: Time,
+          language: String,
+          metadata: T::Hash[Symbol, T.anything],
           published_at: Time,
           region: String,
           score: Float,
-          source: String,
+          source: XTwitterScraper::RadarItem::Source::OrSymbol,
+          source_id: String,
           title: String,
           description: String,
           image_url: String,
@@ -59,11 +93,29 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
+        # Radar item identifier.
+        id:,
         category:,
+        created_at:,
+        language:,
+        # Source-specific fields. Shape varies per source:
+        #
+        # - reddit: { subreddit: string, author: string }
+        # - 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?,
+        #   growthMrrPercent?, multiple?, paymentProvider?, rank? }
+        metadata:,
         published_at:,
         region:,
         score:,
         source:,
+        # Source-specific identifier used for deduplication.
+        source_id:,
         title:,
         description: nil,
         image_url: nil,
@@ -74,11 +126,16 @@ module XTwitterScraper
       sig do
         override.returns(
           {
-            category: String,
+            id: String,
+            category: XTwitterScraper::RadarItem::Category::TaggedSymbol,
+            created_at: Time,
+            language: String,
+            metadata: T::Hash[Symbol, T.anything],
             published_at: Time,
             region: String,
             score: Float,
-            source: String,
+            source: XTwitterScraper::RadarItem::Source::TaggedSymbol,
+            source_id: String,
             title: String,
             description: String,
             image_url: String,
@@ -88,6 +145,74 @@ module XTwitterScraper
       end
       def to_hash
       end
+
+      module Category
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, XTwitterScraper::RadarItem::Category) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        GENERAL =
+          T.let(:general, XTwitterScraper::RadarItem::Category::TaggedSymbol)
+        TECH = T.let(:tech, XTwitterScraper::RadarItem::Category::TaggedSymbol)
+        DEV = T.let(:dev, XTwitterScraper::RadarItem::Category::TaggedSymbol)
+        SCIENCE =
+          T.let(:science, XTwitterScraper::RadarItem::Category::TaggedSymbol)
+        CULTURE =
+          T.let(:culture, XTwitterScraper::RadarItem::Category::TaggedSymbol)
+        POLITICS =
+          T.let(:politics, XTwitterScraper::RadarItem::Category::TaggedSymbol)
+        BUSINESS =
+          T.let(:business, XTwitterScraper::RadarItem::Category::TaggedSymbol)
+        ENTERTAINMENT =
+          T.let(
+            :entertainment,
+            XTwitterScraper::RadarItem::Category::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[XTwitterScraper::RadarItem::Category::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Source
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, XTwitterScraper::RadarItem::Source) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        GITHUB =
+          T.let(:github, XTwitterScraper::RadarItem::Source::TaggedSymbol)
+        GOOGLE_TRENDS =
+          T.let(
+            :google_trends,
+            XTwitterScraper::RadarItem::Source::TaggedSymbol
+          )
+        HACKER_NEWS =
+          T.let(:hacker_news, XTwitterScraper::RadarItem::Source::TaggedSymbol)
+        POLYMARKET =
+          T.let(:polymarket, XTwitterScraper::RadarItem::Source::TaggedSymbol)
+        REDDIT =
+          T.let(:reddit, XTwitterScraper::RadarItem::Source::TaggedSymbol)
+        TRUSTMRR =
+          T.let(:trustmrr, XTwitterScraper::RadarItem::Source::TaggedSymbol)
+        WIKIPEDIA =
+          T.let(:wikipedia, XTwitterScraper::RadarItem::Source::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[XTwitterScraper::RadarItem::Source::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end