x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/models/event_list_response.rbi

@@ -11,9 +11,7 @@ module XTwitterScraper
           )
         end
 
-      sig do
-        returns(T::Array[XTwitterScraper::Models::EventListResponse::Event])
-      end
+      sig { returns(T::Array[XTwitterScraper::Event]) }
       attr_accessor :events
 
       sig { returns(T::Boolean) }
@@ -27,8 +25,7 @@ module XTwitterScraper
 
       sig do
         params(
-          events:
-            T::Array[XTwitterScraper::Models::EventListResponse::Event::OrHash],
+          events: T::Array[XTwitterScraper::Event::OrHash],
           has_more: T::Boolean,
           next_cursor: String
         ).returns(T.attached_class)
@@ -39,7 +36,7 @@ module XTwitterScraper
       sig do
         override.returns(
           {
-            events: T::Array[XTwitterScraper::Models::EventListResponse::Event],
+            events: T::Array[XTwitterScraper::Event],
             has_more: T::Boolean,
             next_cursor: String
           }
@@ -47,122 +44,6 @@ module XTwitterScraper
       end
       def to_hash
       end
-
-      class Event < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              XTwitterScraper::Models::EventListResponse::Event,
-              XTwitterScraper::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        sig { returns(T::Hash[Symbol, T.anything]) }
-        attr_accessor :data
-
-        sig { returns(String) }
-        attr_accessor :monitor_id
-
-        sig { returns(Time) }
-        attr_accessor :occurred_at
-
-        sig do
-          returns(
-            XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-          )
-        end
-        attr_accessor :type
-
-        sig { returns(String) }
-        attr_accessor :username
-
-        sig do
-          params(
-            id: String,
-            data: T::Hash[Symbol, T.anything],
-            monitor_id: String,
-            occurred_at: Time,
-            type:
-              XTwitterScraper::Models::EventListResponse::Event::Type::OrSymbol,
-            username: String
-          ).returns(T.attached_class)
-        end
-        def self.new(id:, data:, monitor_id:, occurred_at:, type:, username:)
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              data: T::Hash[Symbol, T.anything],
-              monitor_id: String,
-              occurred_at: Time,
-              type:
-                XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol,
-              username: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module Type
-          extend XTwitterScraper::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                XTwitterScraper::Models::EventListResponse::Event::Type
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          TWEET_NEW =
-            T.let(
-              :"tweet.new",
-              XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-            )
-          TWEET_REPLY =
-            T.let(
-              :"tweet.reply",
-              XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-            )
-          TWEET_RETWEET =
-            T.let(
-              :"tweet.retweet",
-              XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-            )
-          TWEET_QUOTE =
-            T.let(
-              :"tweet.quote",
-              XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-            )
-          FOLLOWER_GAINED =
-            T.let(
-              :"follower.gained",
-              XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-            )
-          FOLLOWER_LOST =
-            T.let(
-              :"follower.lost",
-              XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                XTwitterScraper::Models::EventListResponse::Event::Type::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/event_type.rbi

@@ -2,6 +2,7 @@
 
 module XTwitterScraper
   module Models
+    # Type of monitor event fired when account activity occurs.
     module EventType
       extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/models/extraction_estimate_cost_params.rbi

@@ -14,6 +14,7 @@ module XTwitterScraper
           )
         end
 
+      # Identifier for the extraction tool used to run a job.
       sig do
         returns(
           XTwitterScraper::ExtractionEstimateCostParams::ToolType::OrSymbol
@@ -21,21 +22,21 @@ module XTwitterScraper
       end
       attr_accessor :tool_type
 
-      # Raw advanced search query appended as-is (tweet_search_extractor)
+      # Raw advanced query string appended to the estimate (tweet_search_extractor)
       sig { returns(T.nilable(String)) }
       attr_reader :advanced_query
 
       sig { params(advanced_query: String).void }
       attr_writer :advanced_query
 
-      # Exact phrase to match (tweet_search_extractor)
+      # Exact phrase filter for search estimation
       sig { returns(T.nilable(String)) }
       attr_reader :exact_phrase
 
       sig { params(exact_phrase: String).void }
       attr_writer :exact_phrase
 
-      # Words to exclude from results (tweet_search_extractor)
+      # Words excluded from estimated search results
       sig { returns(T.nilable(String)) }
       attr_reader :exclude_words
 
@@ -95,12 +96,13 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
+        # Identifier for the extraction tool used to run a job.
         tool_type:,
-        # Raw advanced search query appended as-is (tweet_search_extractor)
+        # Raw advanced query string appended to the estimate (tweet_search_extractor)
         advanced_query: nil,
-        # Exact phrase to match (tweet_search_extractor)
+        # Exact phrase filter for search estimation
         exact_phrase: nil,
-        # Words to exclude from results (tweet_search_extractor)
+        # Words excluded from estimated search results
         exclude_words: nil,
         search_query: nil,
         target_community_id: nil,
@@ -133,6 +135,7 @@ module XTwitterScraper
       def to_hash
       end
 
+      # Identifier for the extraction tool used to run a job.
       module ToolType
         extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/models/extraction_export_results_params.rbi

@@ -17,6 +17,7 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :id
 
+      # Export file format
       sig do
         returns(
           T.nilable(
@@ -42,7 +43,12 @@ module XTwitterScraper
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, format_: nil, request_options: {})
+      def self.new(
+        id:,
+        # Export file format
+        format_: nil,
+        request_options: {}
+      )
       end
 
       sig do
@@ -58,6 +64,7 @@ module XTwitterScraper
       def to_hash
       end
 
+      # Export file format
       module Format
         extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/models/extraction_job.rbi

@@ -17,10 +17,11 @@ module XTwitterScraper
       sig { returns(Time) }
       attr_accessor :created_at
 
-      sig { returns(XTwitterScraper::ExtractionJob::Status::OrSymbol) }
+      sig { returns(XTwitterScraper::ExtractionJob::Status::TaggedSymbol) }
       attr_accessor :status
 
-      sig { returns(XTwitterScraper::ExtractionJob::ToolType::OrSymbol) }
+      # Identifier for the extraction tool used to run a job.
+      sig { returns(XTwitterScraper::ExtractionJob::ToolType::TaggedSymbol) }
       attr_accessor :tool_type
 
       sig { returns(Integer) }
@@ -32,6 +33,7 @@ module XTwitterScraper
       sig { params(completed_at: Time).void }
       attr_writer :completed_at
 
+      # Extraction job tracking status, tool type, and result count.
       sig do
         params(
           id: String,
@@ -46,6 +48,7 @@ module XTwitterScraper
         id:,
         created_at:,
         status:,
+        # Identifier for the extraction tool used to run a job.
         tool_type:,
         total_results:,
         completed_at: nil
@@ -57,8 +60,8 @@ module XTwitterScraper
           {
             id: String,
             created_at: Time,
-            status: XTwitterScraper::ExtractionJob::Status::OrSymbol,
-            tool_type: XTwitterScraper::ExtractionJob::ToolType::OrSymbol,
+            status: XTwitterScraper::ExtractionJob::Status::TaggedSymbol,
+            tool_type: XTwitterScraper::ExtractionJob::ToolType::TaggedSymbol,
             total_results: Integer,
             completed_at: Time
           }
@@ -93,6 +96,7 @@ module XTwitterScraper
         end
       end
 
+      # Identifier for the extraction tool used to run a job.
       module ToolType
         extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/models/extraction_list_params.rbi

@@ -14,19 +14,21 @@ 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
 
+      # 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 by job status
       sig do
         returns(
           T.nilable(XTwitterScraper::ExtractionListParams::Status::OrSymbol)
@@ -41,6 +43,7 @@ module XTwitterScraper
       end
       attr_writer :status
 
+      # Filter by extraction tool type
       sig do
         returns(
           T.nilable(XTwitterScraper::ExtractionListParams::ToolType::OrSymbol)
@@ -65,10 +68,13 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Cursor for pagination
+        # Cursor for keyset pagination
         after: nil,
+        # Maximum number of items to return (1-100, default 50)
         limit: nil,
+        # Filter by job status
         status: nil,
+        # Filter by extraction tool type
         tool_type: nil,
         request_options: {}
       )
@@ -89,6 +95,7 @@ module XTwitterScraper
       def to_hash
       end
 
+      # Filter by job status
       module Status
         extend XTwitterScraper::Internal::Type::Enum
 
@@ -125,6 +132,7 @@ module XTwitterScraper
         end
       end
 
+      # Filter by extraction tool type
       module ToolType
         extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/models/extraction_list_response.rbi

@@ -11,11 +11,7 @@ module XTwitterScraper
           )
         end
 
-      sig do
-        returns(
-          T::Array[XTwitterScraper::Models::ExtractionListResponse::Extraction]
-        )
-      end
+      sig { returns(T::Array[XTwitterScraper::ExtractionJob]) }
       attr_accessor :extractions
 
       sig { returns(T::Boolean) }
@@ -29,10 +25,7 @@ module XTwitterScraper
 
       sig do
         params(
-          extractions:
-            T::Array[
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::OrHash
-            ],
+          extractions: T::Array[XTwitterScraper::ExtractionJob::OrHash],
           has_more: T::Boolean,
           next_cursor: String
         ).returns(T.attached_class)
@@ -43,10 +36,7 @@ module XTwitterScraper
       sig do
         override.returns(
           {
-            extractions:
-              T::Array[
-                XTwitterScraper::Models::ExtractionListResponse::Extraction
-              ],
+            extractions: T::Array[XTwitterScraper::ExtractionJob],
             has_more: T::Boolean,
             next_cursor: String
           }
@@ -54,247 +44,6 @@ module XTwitterScraper
       end
       def to_hash
       end
-
-      class Extraction < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              XTwitterScraper::Models::ExtractionListResponse::Extraction,
-              XTwitterScraper::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        sig { returns(Time) }
-        attr_accessor :created_at
-
-        sig do
-          returns(
-            XTwitterScraper::Models::ExtractionListResponse::Extraction::Status::TaggedSymbol
-          )
-        end
-        attr_accessor :status
-
-        sig do
-          returns(
-            XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-          )
-        end
-        attr_accessor :tool_type
-
-        sig { returns(Integer) }
-        attr_accessor :total_results
-
-        sig { returns(T.nilable(Time)) }
-        attr_reader :completed_at
-
-        sig { params(completed_at: Time).void }
-        attr_writer :completed_at
-
-        sig do
-          params(
-            id: String,
-            created_at: Time,
-            status:
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::Status::OrSymbol,
-            tool_type:
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::OrSymbol,
-            total_results: Integer,
-            completed_at: Time
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          created_at:,
-          status:,
-          tool_type:,
-          total_results:,
-          completed_at: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              created_at: Time,
-              status:
-                XTwitterScraper::Models::ExtractionListResponse::Extraction::Status::TaggedSymbol,
-              tool_type:
-                XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol,
-              total_results: Integer,
-              completed_at: Time
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module Status
-          extend XTwitterScraper::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                XTwitterScraper::Models::ExtractionListResponse::Extraction::Status
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          RUNNING =
-            T.let(
-              :running,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::Status::TaggedSymbol
-            )
-          COMPLETED =
-            T.let(
-              :completed,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::Status::TaggedSymbol
-            )
-          FAILED =
-            T.let(
-              :failed,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::Status::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                XTwitterScraper::Models::ExtractionListResponse::Extraction::Status::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        module ToolType
-          extend XTwitterScraper::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          ARTICLE_EXTRACTOR =
-            T.let(
-              :article_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          COMMUNITY_EXTRACTOR =
-            T.let(
-              :community_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          COMMUNITY_MODERATOR_EXPLORER =
-            T.let(
-              :community_moderator_explorer,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          COMMUNITY_POST_EXTRACTOR =
-            T.let(
-              :community_post_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          COMMUNITY_SEARCH =
-            T.let(
-              :community_search,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          FOLLOWER_EXPLORER =
-            T.let(
-              :follower_explorer,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          FOLLOWING_EXPLORER =
-            T.let(
-              :following_explorer,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          LIST_FOLLOWER_EXPLORER =
-            T.let(
-              :list_follower_explorer,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          LIST_MEMBER_EXTRACTOR =
-            T.let(
-              :list_member_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          LIST_POST_EXTRACTOR =
-            T.let(
-              :list_post_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          MENTION_EXTRACTOR =
-            T.let(
-              :mention_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          PEOPLE_SEARCH =
-            T.let(
-              :people_search,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          POST_EXTRACTOR =
-            T.let(
-              :post_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          QUOTE_EXTRACTOR =
-            T.let(
-              :quote_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          REPLY_EXTRACTOR =
-            T.let(
-              :reply_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          REPOST_EXTRACTOR =
-            T.let(
-              :repost_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          SPACE_EXPLORER =
-            T.let(
-              :space_explorer,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          THREAD_EXTRACTOR =
-            T.let(
-              :thread_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          TWEET_SEARCH_EXTRACTOR =
-            T.let(
-              :tweet_search_extractor,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-          VERIFIED_FOLLOWER_EXPLORER =
-            T.let(
-              :verified_follower_explorer,
-              XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/extraction_retrieve_params.rbi

@@ -17,13 +17,14 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :id
 
-      # Cursor for pagination
+      # Cursor for keyset pagination
       sig { returns(T.nilable(String)) }
       attr_reader :after
 
       sig { params(after: String).void }
       attr_writer :after
 
+      # Maximum number of results to return (1-1000, default 100)
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -40,8 +41,9 @@ module XTwitterScraper
       end
       def self.new(
         id:,
-        # Cursor for pagination
+        # Cursor for keyset pagination
         after: nil,
+        # Maximum number of results to return (1-1000, default 100)
         limit: nil,
         request_options: {}
       )

data/rbi/x_twitter_scraper/models/extraction_run_params.rbi

@@ -14,6 +14,7 @@ module XTwitterScraper
           )
         end
 
+      # Identifier for the extraction tool used to run a job.
       sig { returns(XTwitterScraper::ExtractionRunParams::ToolType::OrSymbol) }
       attr_accessor :tool_type
 
@@ -90,6 +91,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
+        # Identifier for the extraction tool used to run a job.
         tool_type:,
         # Raw advanced search query appended as-is (tweet_search_extractor)
         advanced_query: nil,
@@ -127,6 +129,7 @@ module XTwitterScraper
       def to_hash
       end
 
+      # Identifier for the extraction tool used to run a job.
       module ToolType
         extend XTwitterScraper::Internal::Type::Enum