x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/extraction_estimate_cost_response.rbi

@@ -14,33 +14,46 @@ module XTwitterScraper
       sig { returns(T::Boolean) }
       attr_accessor :allowed
 
+      sig { returns(String) }
+      attr_accessor :credits_available
+
+      sig { returns(String) }
+      attr_accessor :credits_required
+
       sig { returns(Integer) }
       attr_accessor :estimated_results
 
-      sig { returns(Float) }
-      attr_accessor :projected_percent
-
-      sig { returns(String) }
+      sig do
+        returns(
+          XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+        )
+      end
       attr_accessor :source
 
-      sig { returns(Float) }
-      attr_accessor :usage_percent
+      sig { returns(T.nilable(String)) }
+      attr_reader :resolved_x_user_id
+
+      sig { params(resolved_x_user_id: String).void }
+      attr_writer :resolved_x_user_id
 
       sig do
         params(
           allowed: T::Boolean,
+          credits_available: String,
+          credits_required: String,
           estimated_results: Integer,
-          projected_percent: Float,
-          source: String,
-          usage_percent: Float
+          source:
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::OrSymbol,
+          resolved_x_user_id: String
         ).returns(T.attached_class)
       end
       def self.new(
         allowed:,
+        credits_available:,
+        credits_required:,
         estimated_results:,
-        projected_percent:,
         source:,
-        usage_percent:
+        resolved_x_user_id: nil
       )
       end
 
@@ -48,15 +61,86 @@ module XTwitterScraper
         override.returns(
           {
             allowed: T::Boolean,
+            credits_available: String,
+            credits_required: String,
             estimated_results: Integer,
-            projected_percent: Float,
-            source: String,
-            usage_percent: Float
+            source:
+              XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol,
+            resolved_x_user_id: String
           }
         )
       end
       def to_hash
       end
+
+      module Source
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              XTwitterScraper::Models::ExtractionEstimateCostResponse::Source
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FOLLOWERS =
+          T.let(
+            :followers,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        FOLLOWING =
+          T.let(
+            :following,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        PAGINATION_CAP =
+          T.let(
+            :paginationCap,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        POSTS =
+          T.let(
+            :posts,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        QUOTE_COUNT =
+          T.let(
+            :quoteCount,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        REPLY_COUNT =
+          T.let(
+            :replyCount,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        RESULTS_LIMIT =
+          T.let(
+            :resultsLimit,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        RETWEET_COUNT =
+          T.let(
+            :retweetCount,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+        UNKNOWN =
+          T.let(
+            :unknown,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/extraction_export_results_params.rbi

@@ -20,20 +20,10 @@ module XTwitterScraper
       # Export file format
       sig do
         returns(
-          T.nilable(
-            XTwitterScraper::ExtractionExportResultsParams::Format::OrSymbol
-          )
+          XTwitterScraper::ExtractionExportResultsParams::Format::OrSymbol
         )
       end
-      attr_reader :format_
-
-      sig do
-        params(
-          format_:
-            XTwitterScraper::ExtractionExportResultsParams::Format::OrSymbol
-        ).void
-      end
-      attr_writer :format_
+      attr_accessor :format_
 
       sig do
         params(
@@ -46,7 +36,7 @@ module XTwitterScraper
       def self.new(
         id:,
         # Export file format
-        format_: nil,
+        format_:,
         request_options: {}
       )
       end

data/rbi/x_twitter_scraper/models/extraction_job.rbi

@@ -131,6 +131,11 @@ module XTwitterScraper
             :community_search,
             XTwitterScraper::ExtractionJob::ToolType::TaggedSymbol
           )
+        FAVORITERS =
+          T.let(
+            :favoriters,
+            XTwitterScraper::ExtractionJob::ToolType::TaggedSymbol
+          )
         FOLLOWER_EXPLORER =
           T.let(
             :follower_explorer,
@@ -201,6 +206,16 @@ module XTwitterScraper
             :tweet_search_extractor,
             XTwitterScraper::ExtractionJob::ToolType::TaggedSymbol
           )
+        USER_LIKES =
+          T.let(
+            :user_likes,
+            XTwitterScraper::ExtractionJob::ToolType::TaggedSymbol
+          )
+        USER_MEDIA =
+          T.let(
+            :user_media,
+            XTwitterScraper::ExtractionJob::ToolType::TaggedSymbol
+          )
         VERIFIED_FOLLOWER_EXPLORER =
           T.let(
             :verified_follower_explorer,

data/rbi/x_twitter_scraper/models/extraction_list_params.rbi

@@ -14,14 +14,17 @@ 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
 
-      # 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
 
@@ -60,7 +63,7 @@ module XTwitterScraper
 
       sig do
         params(
-          after: String,
+          cursor: String,
           limit: Integer,
           status: XTwitterScraper::ExtractionListParams::Status::OrSymbol,
           tool_type: XTwitterScraper::ExtractionListParams::ToolType::OrSymbol,
@@ -68,9 +71,12 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Cursor for keyset pagination
-        after: nil,
-        # Maximum number of items to return (1-100, default 50)
+        # Cursor for keyset pagination from prior response next_cursor
+        cursor: nil,
+        # 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 by job status
         status: nil,
@@ -83,7 +89,7 @@ module XTwitterScraper
       sig do
         override.returns(
           {
-            after: String,
+            cursor: String,
             limit: Integer,
             status: XTwitterScraper::ExtractionListParams::Status::OrSymbol,
             tool_type:
@@ -167,6 +173,11 @@ module XTwitterScraper
             :community_search,
             XTwitterScraper::ExtractionListParams::ToolType::TaggedSymbol
           )
+        FAVORITERS =
+          T.let(
+            :favoriters,
+            XTwitterScraper::ExtractionListParams::ToolType::TaggedSymbol
+          )
         FOLLOWER_EXPLORER =
           T.let(
             :follower_explorer,
@@ -237,6 +248,16 @@ module XTwitterScraper
             :tweet_search_extractor,
             XTwitterScraper::ExtractionListParams::ToolType::TaggedSymbol
           )
+        USER_LIKES =
+          T.let(
+            :user_likes,
+            XTwitterScraper::ExtractionListParams::ToolType::TaggedSymbol
+          )
+        USER_MEDIA =
+          T.let(
+            :user_media,
+            XTwitterScraper::ExtractionListParams::ToolType::TaggedSymbol
+          )
         VERIFIED_FOLLOWER_EXPLORER =
           T.let(
             :verified_follower_explorer,

data/rbi/x_twitter_scraper/models/extraction_retrieve_params.rbi

@@ -17,12 +17,12 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :id
 
-      # 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
 
       # Maximum number of results to return (1-1000, default 100)
       sig { returns(T.nilable(Integer)) }
@@ -34,15 +34,15 @@ module XTwitterScraper
       sig do
         params(
           id: String,
-          after: String,
+          cursor: String,
           limit: Integer,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
-        # Cursor for keyset pagination
-        after: nil,
+        # Cursor for keyset pagination from prior response next_cursor
+        cursor: nil,
         # Maximum number of results to return (1-1000, default 100)
         limit: nil,
         request_options: {}
@@ -53,7 +53,7 @@ module XTwitterScraper
         override.returns(
           {
             id: String,
-            after: String,
+            cursor: String,
             limit: Integer,
             request_options: XTwitterScraper::RequestOptions
           }

data/rbi/x_twitter_scraper/models/extraction_retrieve_response.rbi

@@ -14,7 +14,7 @@ module XTwitterScraper
       sig { returns(T::Boolean) }
       attr_accessor :has_more
 
-      # Extraction job metadata — shape varies by tool type (JSON)
+      # Extraction job metadata - shape varies by tool type (JSON)
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :job
 
@@ -37,7 +37,7 @@ module XTwitterScraper
       end
       def self.new(
         has_more:,
-        # Extraction job metadata — shape varies by tool type (JSON)
+        # Extraction job metadata - shape varies by tool type (JSON)
         job:,
         results:,
         next_cursor: nil