x-twitter-scraper 0.7.2 → 0.9.0

data/rbi/x_twitter_scraper/models/extraction_estimate_cost_response.rbi

@@ -99,6 +99,11 @@ module XTwitterScraper
             :following,
             XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
           )
+        COLLECTION =
+          T.let(
+            :collection,
+            XTwitterScraper::Models::ExtractionEstimateCostResponse::Source::TaggedSymbol
+          )
         PAGINATION_CAP =
           T.let(
             :paginationCap,

data/rbi/x_twitter_scraper/models/extraction_export_results_params.rbi

@@ -29,11 +29,155 @@ module XTwitterScraper
       end
       attr_accessor :format_
 
+      # Require a non-empty description.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_description
+
+      sig { params(has_description: T::Boolean).void }
+      attr_writer :has_description
+
+      # Require a non-empty location.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_location
+
+      sig { params(has_location: T::Boolean).void }
+      attr_writer :has_location
+
+      # Require media.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_media
+
+      sig { params(has_media: T::Boolean).void }
+      attr_writer :has_media
+
+      # Filter by language code.
+      sig { returns(T.nilable(String)) }
+      attr_reader :lang
+
+      sig { params(lang: String).void }
+      attr_writer :lang
+
+      # Maximum follower count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_followers
+
+      sig { params(max_followers: Integer).void }
+      attr_writer :max_followers
+
+      # Maximum following count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_following
+
+      sig { params(max_following: Integer).void }
+      attr_writer :max_following
+
+      # Maximum post count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_posts
+
+      sig { params(max_posts: Integer).void }
+      attr_writer :max_posts
+
+      # Minimum follower count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_followers
+
+      sig { params(min_followers: Integer).void }
+      attr_writer :min_followers
+
+      # Minimum following count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_following
+
+      sig { params(min_following: Integer).void }
+      attr_writer :min_following
+
+      # Minimum like count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_likes
+
+      sig { params(min_likes: Integer).void }
+      attr_writer :min_likes
+
+      # Minimum post count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_posts
+
+      sig { params(min_posts: Integer).void }
+      attr_writer :min_posts
+
+      # Minimum reply count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_replies
+
+      sig { params(min_replies: Integer).void }
+      attr_writer :min_replies
+
+      # Minimum repost count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_retweets
+
+      sig { params(min_retweets: Integer).void }
+      attr_writer :min_retweets
+
+      # Minimum view count.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_views
+
+      sig { params(min_views: Integer).void }
+      attr_writer :min_views
+
+      # Search exported result text.
+      sig { returns(T.nilable(String)) }
+      attr_reader :search
+
+      sig { params(search: String).void }
+      attr_writer :search
+
+      # Include results on or after this date.
+      sig { returns(T.nilable(Date)) }
+      attr_reader :since_date
+
+      sig { params(since_date: Date).void }
+      attr_writer :since_date
+
+      # Include results on or before this date.
+      sig { returns(T.nilable(Date)) }
+      attr_reader :until_date
+
+      sig { params(until_date: Date).void }
+      attr_writer :until_date
+
+      # Filter by verified status.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :verified
+
+      sig { params(verified: T::Boolean).void }
+      attr_writer :verified
+
       sig do
         params(
           id: String,
           format_:
             XTwitterScraper::ExtractionExportResultsParams::Format::OrSymbol,
+          has_description: T::Boolean,
+          has_location: T::Boolean,
+          has_media: T::Boolean,
+          lang: String,
+          max_followers: Integer,
+          max_following: Integer,
+          max_posts: Integer,
+          min_followers: Integer,
+          min_following: Integer,
+          min_likes: Integer,
+          min_posts: Integer,
+          min_replies: Integer,
+          min_retweets: Integer,
+          min_views: Integer,
+          search: String,
+          since_date: Date,
+          until_date: Date,
+          verified: T::Boolean,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -41,6 +185,42 @@ module XTwitterScraper
         id:,
         # Export file format
         format_:,
+        # Require a non-empty description.
+        has_description: nil,
+        # Require a non-empty location.
+        has_location: nil,
+        # Require media.
+        has_media: nil,
+        # Filter by language code.
+        lang: nil,
+        # Maximum follower count.
+        max_followers: nil,
+        # Maximum following count.
+        max_following: nil,
+        # Maximum post count.
+        max_posts: nil,
+        # Minimum follower count.
+        min_followers: nil,
+        # Minimum following count.
+        min_following: nil,
+        # Minimum like count.
+        min_likes: nil,
+        # Minimum post count.
+        min_posts: nil,
+        # Minimum reply count.
+        min_replies: nil,
+        # Minimum repost count.
+        min_retweets: nil,
+        # Minimum view count.
+        min_views: nil,
+        # Search exported result text.
+        search: nil,
+        # Include results on or after this date.
+        since_date: nil,
+        # Include results on or before this date.
+        until_date: nil,
+        # Filter by verified status.
+        verified: nil,
         request_options: {}
       )
       end
@@ -51,6 +231,24 @@ module XTwitterScraper
             id: String,
             format_:
               XTwitterScraper::ExtractionExportResultsParams::Format::OrSymbol,
+            has_description: T::Boolean,
+            has_location: T::Boolean,
+            has_media: T::Boolean,
+            lang: String,
+            max_followers: Integer,
+            max_following: Integer,
+            max_posts: Integer,
+            min_followers: Integer,
+            min_following: Integer,
+            min_likes: Integer,
+            min_posts: Integer,
+            min_replies: Integer,
+            min_retweets: Integer,
+            min_views: Integer,
+            search: String,
+            since_date: Date,
+            until_date: Date,
+            verified: T::Boolean,
             request_options: XTwitterScraper::RequestOptions
           }
         )

data/rbi/x_twitter_scraper/models/extraction_list_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
           )
         end
 
-      # Cursor for keyset pagination from prior response next_cursor
+      # Previous nextCursor.
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
 
@@ -75,7 +75,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
-        # Cursor for keyset pagination from prior response next_cursor
+        # Previous nextCursor.
         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

data/rbi/x_twitter_scraper/models/extraction_retrieve_params.rbi

@@ -21,13 +21,38 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :id
 
-      # Cursor for keyset pagination from prior response next_cursor
+      # Previous nextCursor.
       sig { returns(T.nilable(String)) }
       attr_reader :cursor
 
       sig { params(cursor: String).void }
       attr_writer :cursor
 
+      # Preserve source keys or convert result field names.
+      sig do
+        returns(
+          T.nilable(
+            XTwitterScraper::ExtractionRetrieveParams::FieldStyle::OrSymbol
+          )
+        )
+      end
+      attr_reader :field_style
+
+      sig do
+        params(
+          field_style:
+            XTwitterScraper::ExtractionRetrieveParams::FieldStyle::OrSymbol
+        ).void
+      end
+      attr_writer :field_style
+
+      # Use outputMode=raw instead.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_raw
+
+      sig { params(include_raw: T::Boolean).void }
+      attr_writer :include_raw
+
       # Maximum number of results to return (1-1000, default 100)
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
@@ -35,20 +60,71 @@ module XTwitterScraper
       sig { params(limit: Integer).void }
       attr_writer :limit
 
+      # Select compact, full, or raw-compatible result fields.
+      sig do
+        returns(
+          T.nilable(
+            XTwitterScraper::ExtractionRetrieveParams::OutputMode::OrSymbol
+          )
+        )
+      end
+      attr_reader :output_mode
+
+      sig do
+        params(
+          output_mode:
+            XTwitterScraper::ExtractionRetrieveParams::OutputMode::OrSymbol
+        ).void
+      end
+      attr_writer :output_mode
+
+      # Keep enrichment nested or merge it into each result.
+      sig do
+        returns(
+          T.nilable(
+            XTwitterScraper::ExtractionRetrieveParams::OutputPreset::OrSymbol
+          )
+        )
+      end
+      attr_reader :output_preset
+
+      sig do
+        params(
+          output_preset:
+            XTwitterScraper::ExtractionRetrieveParams::OutputPreset::OrSymbol
+        ).void
+      end
+      attr_writer :output_preset
+
       sig do
         params(
           id: String,
           cursor: String,
+          field_style:
+            XTwitterScraper::ExtractionRetrieveParams::FieldStyle::OrSymbol,
+          include_raw: T::Boolean,
           limit: Integer,
+          output_mode:
+            XTwitterScraper::ExtractionRetrieveParams::OutputMode::OrSymbol,
+          output_preset:
+            XTwitterScraper::ExtractionRetrieveParams::OutputPreset::OrSymbol,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
-        # Cursor for keyset pagination from prior response next_cursor
+        # Previous nextCursor.
         cursor: nil,
+        # Preserve source keys or convert result field names.
+        field_style: nil,
+        # Use outputMode=raw instead.
+        include_raw: nil,
         # Maximum number of results to return (1-1000, default 100)
         limit: nil,
+        # Select compact, full, or raw-compatible result fields.
+        output_mode: nil,
+        # Keep enrichment nested or merge it into each result.
+        output_preset: nil,
         request_options: {}
       )
       end
@@ -58,13 +134,129 @@ module XTwitterScraper
           {
             id: String,
             cursor: String,
+            field_style:
+              XTwitterScraper::ExtractionRetrieveParams::FieldStyle::OrSymbol,
+            include_raw: T::Boolean,
             limit: Integer,
+            output_mode:
+              XTwitterScraper::ExtractionRetrieveParams::OutputMode::OrSymbol,
+            output_preset:
+              XTwitterScraper::ExtractionRetrieveParams::OutputPreset::OrSymbol,
             request_options: XTwitterScraper::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # Preserve source keys or convert result field names.
+      module FieldStyle
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, XTwitterScraper::ExtractionRetrieveParams::FieldStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SOURCE =
+          T.let(
+            :source,
+            XTwitterScraper::ExtractionRetrieveParams::FieldStyle::TaggedSymbol
+          )
+        CAMEL_CASE =
+          T.let(
+            :camelCase,
+            XTwitterScraper::ExtractionRetrieveParams::FieldStyle::TaggedSymbol
+          )
+        SNAKE_CASE =
+          T.let(
+            :snake_case,
+            XTwitterScraper::ExtractionRetrieveParams::FieldStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::ExtractionRetrieveParams::FieldStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Select compact, full, or raw-compatible result fields.
+      module OutputMode
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, XTwitterScraper::ExtractionRetrieveParams::OutputMode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        COMPACT =
+          T.let(
+            :compact,
+            XTwitterScraper::ExtractionRetrieveParams::OutputMode::TaggedSymbol
+          )
+        FULL =
+          T.let(
+            :full,
+            XTwitterScraper::ExtractionRetrieveParams::OutputMode::TaggedSymbol
+          )
+        RAW =
+          T.let(
+            :raw,
+            XTwitterScraper::ExtractionRetrieveParams::OutputMode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::ExtractionRetrieveParams::OutputMode::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Keep enrichment nested or merge it into each result.
+      module OutputPreset
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              XTwitterScraper::ExtractionRetrieveParams::OutputPreset
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NESTED =
+          T.let(
+            :nested,
+            XTwitterScraper::ExtractionRetrieveParams::OutputPreset::TaggedSymbol
+          )
+        FLAT =
+          T.let(
+            :flat,
+            XTwitterScraper::ExtractionRetrieveParams::OutputPreset::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::ExtractionRetrieveParams::OutputPreset::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end