x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/models/draw_retrieve_response.rbi

@@ -11,204 +11,39 @@ module XTwitterScraper
           )
         end
 
-      sig { returns(XTwitterScraper::Models::DrawRetrieveResponse::Draw) }
+      # Full giveaway draw with tweet metrics, entries, and timing.
+      sig { returns(XTwitterScraper::DrawDetail) }
       attr_reader :draw
 
-      sig do
-        params(
-          draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw::OrHash
-        ).void
-      end
+      sig { params(draw: XTwitterScraper::DrawDetail::OrHash).void }
       attr_writer :draw
 
-      sig do
-        returns(T::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner])
-      end
+      sig { returns(T::Array[XTwitterScraper::Winner]) }
       attr_accessor :winners
 
       sig do
         params(
-          draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw::OrHash,
-          winners:
-            T::Array[
-              XTwitterScraper::Models::DrawRetrieveResponse::Winner::OrHash
-            ]
+          draw: XTwitterScraper::DrawDetail::OrHash,
+          winners: T::Array[XTwitterScraper::Winner::OrHash]
         ).returns(T.attached_class)
       end
-      def self.new(draw:, winners:)
+      def self.new(
+        # Full giveaway draw with tweet metrics, entries, and timing.
+        draw:,
+        winners:
+      )
       end
 
       sig do
         override.returns(
           {
-            draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw,
-            winners:
-              T::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner]
+            draw: XTwitterScraper::DrawDetail,
+            winners: T::Array[XTwitterScraper::Winner]
           }
         )
       end
       def to_hash
       end
-
-      class Draw < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              XTwitterScraper::Models::DrawRetrieveResponse::Draw,
-              XTwitterScraper::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        sig { returns(Time) }
-        attr_accessor :created_at
-
-        sig { returns(String) }
-        attr_accessor :status
-
-        sig { returns(Integer) }
-        attr_accessor :total_entries
-
-        sig { returns(String) }
-        attr_accessor :tweet_author_username
-
-        sig { returns(String) }
-        attr_accessor :tweet_id
-
-        sig { returns(Integer) }
-        attr_accessor :tweet_like_count
-
-        sig { returns(Integer) }
-        attr_accessor :tweet_quote_count
-
-        sig { returns(Integer) }
-        attr_accessor :tweet_reply_count
-
-        sig { returns(Integer) }
-        attr_accessor :tweet_retweet_count
-
-        sig { returns(String) }
-        attr_accessor :tweet_text
-
-        sig { returns(String) }
-        attr_accessor :tweet_url
-
-        sig { returns(Integer) }
-        attr_accessor :valid_entries
-
-        sig { returns(T.nilable(Time)) }
-        attr_reader :drawn_at
-
-        sig { params(drawn_at: Time).void }
-        attr_writer :drawn_at
-
-        sig do
-          params(
-            id: String,
-            created_at: Time,
-            status: String,
-            total_entries: Integer,
-            tweet_author_username: String,
-            tweet_id: String,
-            tweet_like_count: Integer,
-            tweet_quote_count: Integer,
-            tweet_reply_count: Integer,
-            tweet_retweet_count: Integer,
-            tweet_text: String,
-            tweet_url: String,
-            valid_entries: Integer,
-            drawn_at: Time
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          created_at:,
-          status:,
-          total_entries:,
-          tweet_author_username:,
-          tweet_id:,
-          tweet_like_count:,
-          tweet_quote_count:,
-          tweet_reply_count:,
-          tweet_retweet_count:,
-          tweet_text:,
-          tweet_url:,
-          valid_entries:,
-          drawn_at: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              created_at: Time,
-              status: String,
-              total_entries: Integer,
-              tweet_author_username: String,
-              tweet_id: String,
-              tweet_like_count: Integer,
-              tweet_quote_count: Integer,
-              tweet_reply_count: Integer,
-              tweet_retweet_count: Integer,
-              tweet_text: String,
-              tweet_url: String,
-              valid_entries: Integer,
-              drawn_at: Time
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      class Winner < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              XTwitterScraper::Models::DrawRetrieveResponse::Winner,
-              XTwitterScraper::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :author_username
-
-        sig { returns(T::Boolean) }
-        attr_accessor :is_backup
-
-        sig { returns(Integer) }
-        attr_accessor :position
-
-        sig { returns(String) }
-        attr_accessor :tweet_id
-
-        sig do
-          params(
-            author_username: String,
-            is_backup: T::Boolean,
-            position: Integer,
-            tweet_id: String
-          ).returns(T.attached_class)
-        end
-        def self.new(author_username:, is_backup:, position:, tweet_id:)
-        end
-
-        sig do
-          override.returns(
-            {
-              author_username: String,
-              is_backup: T::Boolean,
-              position: Integer,
-              tweet_id: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/draw_run_response.rbi

@@ -23,9 +23,7 @@ module XTwitterScraper
       sig { returns(Integer) }
       attr_accessor :valid_entries
 
-      sig do
-        returns(T::Array[XTwitterScraper::Models::DrawRunResponse::Winner])
-      end
+      sig { returns(T::Array[XTwitterScraper::Winner]) }
       attr_accessor :winners
 
       sig do
@@ -34,8 +32,7 @@ module XTwitterScraper
           total_entries: Integer,
           tweet_id: String,
           valid_entries: Integer,
-          winners:
-            T::Array[XTwitterScraper::Models::DrawRunResponse::Winner::OrHash]
+          winners: T::Array[XTwitterScraper::Winner::OrHash]
         ).returns(T.attached_class)
       end
       def self.new(id:, total_entries:, tweet_id:, valid_entries:, winners:)
@@ -48,58 +45,12 @@ module XTwitterScraper
             total_entries: Integer,
             tweet_id: String,
             valid_entries: Integer,
-            winners: T::Array[XTwitterScraper::Models::DrawRunResponse::Winner]
+            winners: T::Array[XTwitterScraper::Winner]
           }
         )
       end
       def to_hash
       end
-
-      class Winner < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              XTwitterScraper::Models::DrawRunResponse::Winner,
-              XTwitterScraper::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :author_username
-
-        sig { returns(T::Boolean) }
-        attr_accessor :is_backup
-
-        sig { returns(Integer) }
-        attr_accessor :position
-
-        sig { returns(String) }
-        attr_accessor :tweet_id
-
-        sig do
-          params(
-            author_username: String,
-            is_backup: T::Boolean,
-            position: Integer,
-            tweet_id: String
-          ).returns(T.attached_class)
-        end
-        def self.new(author_username:, is_backup:, position:, tweet_id:)
-        end
-
-        sig do
-          override.returns(
-            {
-              author_username: String,
-              is_backup: T::Boolean,
-              position: Integer,
-              tweet_id: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/error.rbi

@@ -11,6 +11,7 @@ module XTwitterScraper
       sig { returns(XTwitterScraper::Error::Error::OrSymbol) }
       attr_accessor :error
 
+      # Error response containing a machine-readable error code.
       sig do
         params(error: XTwitterScraper::Error::Error::OrSymbol).returns(
           T.attached_class

data/rbi/x_twitter_scraper/models/event.rbi

@@ -20,23 +20,33 @@ module XTwitterScraper
       sig { returns(Time) }
       attr_accessor :occurred_at
 
-      sig { returns(XTwitterScraper::Event::Type::OrSymbol) }
+      # Type of monitor event fired when account activity occurs.
+      sig { returns(XTwitterScraper::EventType::TaggedSymbol) }
       attr_accessor :type
 
       sig { returns(String) }
       attr_accessor :username
 
+      # Monitor event summary with type, username, and occurrence time.
       sig do
         params(
           id: String,
           data: T::Hash[Symbol, T.anything],
           monitor_id: String,
           occurred_at: Time,
-          type: XTwitterScraper::Event::Type::OrSymbol,
+          type: XTwitterScraper::EventType::OrSymbol,
           username: String
         ).returns(T.attached_class)
       end
-      def self.new(id:, data:, monitor_id:, occurred_at:, type:, username:)
+      def self.new(
+        id:,
+        data:,
+        monitor_id:,
+        occurred_at:,
+        # Type of monitor event fired when account activity occurs.
+        type:,
+        username:
+      )
       end
 
       sig do
@@ -46,40 +56,13 @@ module XTwitterScraper
             data: T::Hash[Symbol, T.anything],
             monitor_id: String,
             occurred_at: Time,
-            type: XTwitterScraper::Event::Type::OrSymbol,
+            type: XTwitterScraper::EventType::TaggedSymbol,
             username: String
           }
         )
       end
       def to_hash
       end
-
-      module Type
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, XTwitterScraper::Event::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TWEET_NEW =
-          T.let(:"tweet.new", XTwitterScraper::Event::Type::TaggedSymbol)
-        TWEET_REPLY =
-          T.let(:"tweet.reply", XTwitterScraper::Event::Type::TaggedSymbol)
-        TWEET_RETWEET =
-          T.let(:"tweet.retweet", XTwitterScraper::Event::Type::TaggedSymbol)
-        TWEET_QUOTE =
-          T.let(:"tweet.quote", XTwitterScraper::Event::Type::TaggedSymbol)
-        FOLLOWER_GAINED =
-          T.let(:"follower.gained", XTwitterScraper::Event::Type::TaggedSymbol)
-        FOLLOWER_LOST =
-          T.let(:"follower.lost", XTwitterScraper::Event::Type::TaggedSymbol)
-
-        sig do
-          override.returns(T::Array[XTwitterScraper::Event::Type::TaggedSymbol])
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/event_detail.rbi

@@ -24,7 +24,8 @@ module XTwitterScraper
       sig { returns(Time) }
       attr_accessor :occurred_at
 
-      sig { returns(XTwitterScraper::EventDetail::Type::OrSymbol) }
+      # Type of monitor event fired when account activity occurs.
+      sig { returns(XTwitterScraper::EventType::TaggedSymbol) }
       attr_accessor :type
 
       sig { returns(String) }
@@ -36,13 +37,14 @@ module XTwitterScraper
       sig { params(x_event_id: String).void }
       attr_writer :x_event_id
 
+      # Full monitor event including payload data and optional X event ID.
       sig do
         params(
           id: String,
           data: T::Hash[Symbol, T.anything],
           monitor_id: String,
           occurred_at: Time,
-          type: XTwitterScraper::EventDetail::Type::OrSymbol,
+          type: XTwitterScraper::EventType::OrSymbol,
           username: String,
           x_event_id: String
         ).returns(T.attached_class)
@@ -53,6 +55,7 @@ module XTwitterScraper
         data:,
         monitor_id:,
         occurred_at:,
+        # Type of monitor event fired when account activity occurs.
         type:,
         username:,
         x_event_id: nil
@@ -66,7 +69,7 @@ module XTwitterScraper
             data: T::Hash[Symbol, T.anything],
             monitor_id: String,
             occurred_at: Time,
-            type: XTwitterScraper::EventDetail::Type::OrSymbol,
+            type: XTwitterScraper::EventType::TaggedSymbol,
             username: String,
             x_event_id: String
           }
@@ -74,50 +77,6 @@ module XTwitterScraper
       end
       def to_hash
       end
-
-      module Type
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, XTwitterScraper::EventDetail::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TWEET_NEW =
-          T.let(:"tweet.new", XTwitterScraper::EventDetail::Type::TaggedSymbol)
-        TWEET_REPLY =
-          T.let(
-            :"tweet.reply",
-            XTwitterScraper::EventDetail::Type::TaggedSymbol
-          )
-        TWEET_RETWEET =
-          T.let(
-            :"tweet.retweet",
-            XTwitterScraper::EventDetail::Type::TaggedSymbol
-          )
-        TWEET_QUOTE =
-          T.let(
-            :"tweet.quote",
-            XTwitterScraper::EventDetail::Type::TaggedSymbol
-          )
-        FOLLOWER_GAINED =
-          T.let(
-            :"follower.gained",
-            XTwitterScraper::EventDetail::Type::TaggedSymbol
-          )
-        FOLLOWER_LOST =
-          T.let(
-            :"follower.lost",
-            XTwitterScraper::EventDetail::Type::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[XTwitterScraper::EventDetail::Type::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/event_list_params.rbi

@@ -14,33 +14,28 @@ module XTwitterScraper
           )
         end
 
-      # Cursor for pagination
+      # Cursor for keyset pagination
       sig { returns(T.nilable(String)) }
       attr_reader :after
 
       sig { params(after: String).void }
       attr_writer :after
 
-      sig do
-        returns(
-          T.nilable(XTwitterScraper::EventListParams::EventType::OrSymbol)
-        )
-      end
+      # Filter events by type
+      sig { returns(T.nilable(XTwitterScraper::EventType::OrSymbol)) }
       attr_reader :event_type
 
-      sig do
-        params(
-          event_type: XTwitterScraper::EventListParams::EventType::OrSymbol
-        ).void
-      end
+      sig { params(event_type: XTwitterScraper::EventType::OrSymbol).void }
       attr_writer :event_type
 
+      # Maximum number of items to return (1-100, default 50)
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
       sig { params(limit: Integer).void }
       attr_writer :limit
 
+      # Filter events by monitor ID
       sig { returns(T.nilable(String)) }
       attr_reader :monitor_id
 
@@ -50,17 +45,20 @@ module XTwitterScraper
       sig do
         params(
           after: String,
-          event_type: XTwitterScraper::EventListParams::EventType::OrSymbol,
+          event_type: XTwitterScraper::EventType::OrSymbol,
           limit: Integer,
           monitor_id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Cursor for pagination
+        # Cursor for keyset pagination
         after: nil,
+        # Filter events by type
         event_type: nil,
+        # Maximum number of items to return (1-100, default 50)
         limit: nil,
+        # Filter events by monitor ID
         monitor_id: nil,
         request_options: {}
       )
@@ -70,7 +68,7 @@ module XTwitterScraper
         override.returns(
           {
             after: String,
-            event_type: XTwitterScraper::EventListParams::EventType::OrSymbol,
+            event_type: XTwitterScraper::EventType::OrSymbol,
             limit: Integer,
             monitor_id: String,
             request_options: XTwitterScraper::RequestOptions
@@ -79,55 +77,6 @@ module XTwitterScraper
       end
       def to_hash
       end
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, XTwitterScraper::EventListParams::EventType)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TWEET_NEW =
-          T.let(
-            :"tweet.new",
-            XTwitterScraper::EventListParams::EventType::TaggedSymbol
-          )
-        TWEET_REPLY =
-          T.let(
-            :"tweet.reply",
-            XTwitterScraper::EventListParams::EventType::TaggedSymbol
-          )
-        TWEET_RETWEET =
-          T.let(
-            :"tweet.retweet",
-            XTwitterScraper::EventListParams::EventType::TaggedSymbol
-          )
-        TWEET_QUOTE =
-          T.let(
-            :"tweet.quote",
-            XTwitterScraper::EventListParams::EventType::TaggedSymbol
-          )
-        FOLLOWER_GAINED =
-          T.let(
-            :"follower.gained",
-            XTwitterScraper::EventListParams::EventType::TaggedSymbol
-          )
-        FOLLOWER_LOST =
-          T.let(
-            :"follower.lost",
-            XTwitterScraper::EventListParams::EventType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[XTwitterScraper::EventListParams::EventType::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end