x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/event.rbi

@@ -14,9 +14,14 @@ module XTwitterScraper
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :data
 
+      # Account monitor ID for account events, or keyword monitor ID for keyword events.
       sig { returns(String) }
       attr_accessor :monitor_id
 
+      # Source monitor type.
+      sig { returns(XTwitterScraper::Event::MonitorType::TaggedSymbol) }
+      attr_accessor :monitor_type
+
       sig { returns(Time) }
       attr_accessor :occurred_at
 
@@ -24,28 +29,57 @@ module XTwitterScraper
       sig { returns(XTwitterScraper::EventType::TaggedSymbol) }
       attr_accessor :type
 
-      sig { returns(String) }
-      attr_accessor :username
+      # Keyword monitor ID, present for keyword monitor events.
+      sig { returns(T.nilable(String)) }
+      attr_reader :keyword_monitor_id
+
+      sig { params(keyword_monitor_id: String).void }
+      attr_writer :keyword_monitor_id
+
+      # Keyword query, present for keyword monitor events.
+      sig { returns(T.nilable(String)) }
+      attr_reader :query
+
+      sig { params(query: String).void }
+      attr_writer :query
+
+      # Account username, present for account monitor events.
+      sig { returns(T.nilable(String)) }
+      attr_reader :username
+
+      sig { params(username: String).void }
+      attr_writer :username
 
-      # Monitor event summary with type, username, and occurrence time.
+      # Monitor event summary with source metadata and occurrence time.
       sig do
         params(
           id: String,
           data: T::Hash[Symbol, T.anything],
           monitor_id: String,
+          monitor_type: XTwitterScraper::Event::MonitorType::OrSymbol,
           occurred_at: Time,
           type: XTwitterScraper::EventType::OrSymbol,
+          keyword_monitor_id: String,
+          query: String,
           username: String
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
         data:,
+        # Account monitor ID for account events, or keyword monitor ID for keyword events.
         monitor_id:,
+        # Source monitor type.
+        monitor_type:,
         occurred_at:,
         # Type of monitor event fired when account activity occurs.
         type:,
-        username:
+        # Keyword monitor ID, present for keyword monitor events.
+        keyword_monitor_id: nil,
+        # Keyword query, present for keyword monitor events.
+        query: nil,
+        # Account username, present for account monitor events.
+        username: nil
       )
       end
 
@@ -55,14 +89,39 @@ module XTwitterScraper
             id: String,
             data: T::Hash[Symbol, T.anything],
             monitor_id: String,
+            monitor_type: XTwitterScraper::Event::MonitorType::TaggedSymbol,
             occurred_at: Time,
             type: XTwitterScraper::EventType::TaggedSymbol,
+            keyword_monitor_id: String,
+            query: String,
             username: String
           }
         )
       end
       def to_hash
       end
+
+      # Source monitor type.
+      module MonitorType
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, XTwitterScraper::Event::MonitorType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCOUNT =
+          T.let(:account, XTwitterScraper::Event::MonitorType::TaggedSymbol)
+        KEYWORD =
+          T.let(:keyword, XTwitterScraper::Event::MonitorType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[XTwitterScraper::Event::MonitorType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/event_detail.rbi

@@ -14,13 +14,18 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :id
 
-      # Event payload — shape varies by event type (JSON)
+      # Event payload - shape varies by event type (JSON)
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :data
 
+      # Monitor ID associated with this detailed event payload.
       sig { returns(String) }
       attr_accessor :monitor_id
 
+      # Source monitor type for this detailed event.
+      sig { returns(XTwitterScraper::EventDetail::MonitorType::TaggedSymbol) }
+      attr_accessor :monitor_type
+
       sig { returns(Time) }
       attr_accessor :occurred_at
 
@@ -28,8 +33,26 @@ module XTwitterScraper
       sig { returns(XTwitterScraper::EventType::TaggedSymbol) }
       attr_accessor :type
 
-      sig { returns(String) }
-      attr_accessor :username
+      # Keyword monitor ID included on detailed keyword events.
+      sig { returns(T.nilable(String)) }
+      attr_reader :keyword_monitor_id
+
+      sig { params(keyword_monitor_id: String).void }
+      attr_writer :keyword_monitor_id
+
+      # Keyword query for this detailed monitor event.
+      sig { returns(T.nilable(String)) }
+      attr_reader :query
+
+      sig { params(query: String).void }
+      attr_writer :query
+
+      # Account username for this detailed monitor event.
+      sig { returns(T.nilable(String)) }
+      attr_reader :username
+
+      sig { params(username: String).void }
+      attr_writer :username
 
       sig { returns(T.nilable(String)) }
       attr_reader :x_event_id
@@ -43,21 +66,32 @@ module XTwitterScraper
           id: String,
           data: T::Hash[Symbol, T.anything],
           monitor_id: String,
+          monitor_type: XTwitterScraper::EventDetail::MonitorType::OrSymbol,
           occurred_at: Time,
           type: XTwitterScraper::EventType::OrSymbol,
+          keyword_monitor_id: String,
+          query: String,
           username: String,
           x_event_id: String
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
-        # Event payload — shape varies by event type (JSON)
+        # Event payload - shape varies by event type (JSON)
         data:,
+        # Monitor ID associated with this detailed event payload.
         monitor_id:,
+        # Source monitor type for this detailed event.
+        monitor_type:,
         occurred_at:,
         # Type of monitor event fired when account activity occurs.
         type:,
-        username:,
+        # Keyword monitor ID included on detailed keyword events.
+        keyword_monitor_id: nil,
+        # Keyword query for this detailed monitor event.
+        query: nil,
+        # Account username for this detailed monitor event.
+        username: nil,
         x_event_id: nil
       )
       end
@@ -68,8 +102,12 @@ module XTwitterScraper
             id: String,
             data: T::Hash[Symbol, T.anything],
             monitor_id: String,
+            monitor_type:
+              XTwitterScraper::EventDetail::MonitorType::TaggedSymbol,
             occurred_at: Time,
             type: XTwitterScraper::EventType::TaggedSymbol,
+            keyword_monitor_id: String,
+            query: String,
             username: String,
             x_event_id: String
           }
@@ -77,6 +115,36 @@ module XTwitterScraper
       end
       def to_hash
       end
+
+      # Source monitor type for this detailed event.
+      module MonitorType
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, XTwitterScraper::EventDetail::MonitorType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCOUNT =
+          T.let(
+            :account,
+            XTwitterScraper::EventDetail::MonitorType::TaggedSymbol
+          )
+        KEYWORD =
+          T.let(
+            :keyword,
+            XTwitterScraper::EventDetail::MonitorType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[XTwitterScraper::EventDetail::MonitorType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/event_list_params.rbi

@@ -14,12 +14,12 @@ module XTwitterScraper
           )
         end
 
-      # Cursor for keyset pagination
+      # Cursor for keyset pagination from prior response next_cursor
       sig { returns(T.nilable(String)) }
-      attr_reader :after
+      attr_reader :cursor
 
-      sig { params(after: String).void }
-      attr_writer :after
+      sig { params(cursor: String).void }
+      attr_writer :cursor
 
       # Filter events by type
       sig { returns(T.nilable(XTwitterScraper::EventType::OrSymbol)) }
@@ -28,7 +28,10 @@ module XTwitterScraper
       sig { params(event_type: XTwitterScraper::EventType::OrSymbol).void }
       attr_writer :event_type
 
-      # Maximum number of items to return (1-100, default 50)
+      # Maximum number of items to return (1-100, default 50). For paid per-result
+      # endpoints, the returned count may be lower when remaining credits cannot cover
+      # the requested page. If zero paid results are affordable, the endpoint returns
+      # 402 insufficient_credits.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -44,7 +47,7 @@ module XTwitterScraper
 
       sig do
         params(
-          after: String,
+          cursor: String,
           event_type: XTwitterScraper::EventType::OrSymbol,
           limit: Integer,
           monitor_id: String,
@@ -52,11 +55,14 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Cursor for keyset pagination
-        after: nil,
+        # Cursor for keyset pagination from prior response next_cursor
+        cursor: nil,
         # Filter events by type
         event_type: nil,
-        # Maximum number of items to return (1-100, default 50)
+        # Maximum number of items to return (1-100, default 50). For paid per-result
+        # endpoints, the returned count may be lower when remaining credits cannot cover
+        # the requested page. If zero paid results are affordable, the endpoint returns
+        # 402 insufficient_credits.
         limit: nil,
         # Filter events by monitor ID
         monitor_id: nil,
@@ -67,7 +73,7 @@ module XTwitterScraper
       sig do
         override.returns(
           {
-            after: String,
+            cursor: String,
             event_type: XTwitterScraper::EventType::OrSymbol,
             limit: Integer,
             monitor_id: String,

data/rbi/x_twitter_scraper/models/event_type.rbi

@@ -16,10 +16,64 @@ module XTwitterScraper
         T.let(:"tweet.retweet", XTwitterScraper::EventType::TaggedSymbol)
       TWEET_QUOTE =
         T.let(:"tweet.quote", XTwitterScraper::EventType::TaggedSymbol)
-      FOLLOWER_GAINED =
-        T.let(:"follower.gained", XTwitterScraper::EventType::TaggedSymbol)
-      FOLLOWER_LOST =
-        T.let(:"follower.lost", XTwitterScraper::EventType::TaggedSymbol)
+      TWEET_MEDIA =
+        T.let(:"tweet.media", XTwitterScraper::EventType::TaggedSymbol)
+      TWEET_LINK =
+        T.let(:"tweet.link", XTwitterScraper::EventType::TaggedSymbol)
+      TWEET_POLL =
+        T.let(:"tweet.poll", XTwitterScraper::EventType::TaggedSymbol)
+      TWEET_MENTION =
+        T.let(:"tweet.mention", XTwitterScraper::EventType::TaggedSymbol)
+      TWEET_HASHTAG =
+        T.let(:"tweet.hashtag", XTwitterScraper::EventType::TaggedSymbol)
+      TWEET_LONGFORM =
+        T.let(:"tweet.longform", XTwitterScraper::EventType::TaggedSymbol)
+      PROFILE_AVATAR_CHANGED =
+        T.let(
+          :"profile.avatar.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
+      PROFILE_BANNER_CHANGED =
+        T.let(
+          :"profile.banner.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
+      PROFILE_NAME_CHANGED =
+        T.let(:"profile.name.changed", XTwitterScraper::EventType::TaggedSymbol)
+      PROFILE_USERNAME_CHANGED =
+        T.let(
+          :"profile.username.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
+      PROFILE_BIO_CHANGED =
+        T.let(:"profile.bio.changed", XTwitterScraper::EventType::TaggedSymbol)
+      PROFILE_LOCATION_CHANGED =
+        T.let(
+          :"profile.location.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
+      PROFILE_URL_CHANGED =
+        T.let(:"profile.url.changed", XTwitterScraper::EventType::TaggedSymbol)
+      PROFILE_VERIFIED_CHANGED =
+        T.let(
+          :"profile.verified.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
+      PROFILE_PROTECTED_CHANGED =
+        T.let(
+          :"profile.protected.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
+      PROFILE_PINNED_TWEET_CHANGED =
+        T.let(
+          :"profile.pinned_tweet.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
+      PROFILE_UNAVAILABLE_CHANGED =
+        T.let(
+          :"profile.unavailable.changed",
+          XTwitterScraper::EventType::TaggedSymbol
+        )
 
       sig do
         override.returns(T::Array[XTwitterScraper::EventType::TaggedSymbol])