x-twitter-scraper 0.7.2 → 0.9.0

data/lib/x_twitter_scraper/models/extraction_estimate_cost_response.rb

@@ -52,6 +52,7 @@ module XTwitterScraper
 
         FOLLOWERS = :followers
         FOLLOWING = :following
+        COLLECTION = :collection
         PAGINATION_CAP = :paginationCap
         POSTS = :posts
         QUOTE_COUNT = :quoteCount

data/lib/x_twitter_scraper/models/extraction_export_results_params.rb

@@ -22,11 +22,155 @@ module XTwitterScraper
       #   @return [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format]
       required :format_, enum: -> { XTwitterScraper::ExtractionExportResultsParams::Format }
 
-      # @!method initialize(id:, format_:, request_options: {})
+      # @!attribute has_description
+      #   Require a non-empty description.
+      #
+      #   @return [Boolean, nil]
+      optional :has_description, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute has_location
+      #   Require a non-empty location.
+      #
+      #   @return [Boolean, nil]
+      optional :has_location, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute has_media
+      #   Require media.
+      #
+      #   @return [Boolean, nil]
+      optional :has_media, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute lang
+      #   Filter by language code.
+      #
+      #   @return [String, nil]
+      optional :lang, String
+
+      # @!attribute max_followers
+      #   Maximum follower count.
+      #
+      #   @return [Integer, nil]
+      optional :max_followers, Integer
+
+      # @!attribute max_following
+      #   Maximum following count.
+      #
+      #   @return [Integer, nil]
+      optional :max_following, Integer
+
+      # @!attribute max_posts
+      #   Maximum post count.
+      #
+      #   @return [Integer, nil]
+      optional :max_posts, Integer
+
+      # @!attribute min_followers
+      #   Minimum follower count.
+      #
+      #   @return [Integer, nil]
+      optional :min_followers, Integer
+
+      # @!attribute min_following
+      #   Minimum following count.
+      #
+      #   @return [Integer, nil]
+      optional :min_following, Integer
+
+      # @!attribute min_likes
+      #   Minimum like count.
+      #
+      #   @return [Integer, nil]
+      optional :min_likes, Integer
+
+      # @!attribute min_posts
+      #   Minimum post count.
+      #
+      #   @return [Integer, nil]
+      optional :min_posts, Integer
+
+      # @!attribute min_replies
+      #   Minimum reply count.
+      #
+      #   @return [Integer, nil]
+      optional :min_replies, Integer
+
+      # @!attribute min_retweets
+      #   Minimum repost count.
+      #
+      #   @return [Integer, nil]
+      optional :min_retweets, Integer
+
+      # @!attribute min_views
+      #   Minimum view count.
+      #
+      #   @return [Integer, nil]
+      optional :min_views, Integer
+
+      # @!attribute search
+      #   Search exported result text.
+      #
+      #   @return [String, nil]
+      optional :search, String
+
+      # @!attribute since_date
+      #   Include results on or after this date.
+      #
+      #   @return [Date, nil]
+      optional :since_date, Date
+
+      # @!attribute until_date
+      #   Include results on or before this date.
+      #
+      #   @return [Date, nil]
+      optional :until_date, Date
+
+      # @!attribute verified
+      #   Filter by verified status.
+      #
+      #   @return [Boolean, nil]
+      optional :verified, XTwitterScraper::Internal::Type::Boolean
+
+      # @!method initialize(id:, format_:, has_description: nil, has_location: nil, has_media: nil, lang: nil, max_followers: nil, max_following: nil, max_posts: nil, min_followers: nil, min_following: nil, min_likes: nil, min_posts: nil, min_replies: nil, min_retweets: nil, min_views: nil, search: nil, since_date: nil, until_date: nil, verified: nil, request_options: {})
       #   @param id [String]
       #
       #   @param format_ [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format] Export file format
       #
+      #   @param has_description [Boolean] Require a non-empty description.
+      #
+      #   @param has_location [Boolean] Require a non-empty location.
+      #
+      #   @param has_media [Boolean] Require media.
+      #
+      #   @param lang [String] Filter by language code.
+      #
+      #   @param max_followers [Integer] Maximum follower count.
+      #
+      #   @param max_following [Integer] Maximum following count.
+      #
+      #   @param max_posts [Integer] Maximum post count.
+      #
+      #   @param min_followers [Integer] Minimum follower count.
+      #
+      #   @param min_following [Integer] Minimum following count.
+      #
+      #   @param min_likes [Integer] Minimum like count.
+      #
+      #   @param min_posts [Integer] Minimum post count.
+      #
+      #   @param min_replies [Integer] Minimum reply count.
+      #
+      #   @param min_retweets [Integer] Minimum repost count.
+      #
+      #   @param min_views [Integer] Minimum view count.
+      #
+      #   @param search [String] Search exported result text.
+      #
+      #   @param since_date [Date] Include results on or after this date.
+      #
+      #   @param until_date [Date] Include results on or before this date.
+      #
+      #   @param verified [Boolean] Filter by verified status.
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
 
       # Export file format

data/lib/x_twitter_scraper/models/extraction_list_params.rb

@@ -12,7 +12,7 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute cursor
-      #   Cursor for keyset pagination from prior response next_cursor
+      #   Previous nextCursor.
       #
       #   @return [String, nil]
       optional :cursor, String
@@ -42,7 +42,7 @@ module XTwitterScraper
       #   Some parameter documentations has been truncated, see
       #   {XTwitterScraper::Models::ExtractionListParams} for more details.
       #
-      #   @param cursor [String] Cursor for keyset pagination from prior response next_cursor
+      #   @param cursor [String] Previous nextCursor.
       #
       #   @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
       #

data/lib/x_twitter_scraper/models/extraction_retrieve_params.rb

@@ -17,25 +17,92 @@ module XTwitterScraper
       required :id, String
 
       # @!attribute cursor
-      #   Cursor for keyset pagination from prior response next_cursor
+      #   Previous nextCursor.
       #
       #   @return [String, nil]
       optional :cursor, String
 
+      # @!attribute field_style
+      #   Preserve source keys or convert result field names.
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::FieldStyle, nil]
+      optional :field_style, enum: -> { XTwitterScraper::ExtractionRetrieveParams::FieldStyle }
+
+      # @!attribute include_raw
+      #   Use outputMode=raw instead.
+      #
+      #   @return [Boolean, nil]
+      optional :include_raw, XTwitterScraper::Internal::Type::Boolean
+
       # @!attribute limit
       #   Maximum number of results to return (1-1000, default 100)
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!method initialize(id:, cursor: nil, limit: nil, request_options: {})
+      # @!attribute output_mode
+      #   Select compact, full, or raw-compatible result fields.
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputMode, nil]
+      optional :output_mode, enum: -> { XTwitterScraper::ExtractionRetrieveParams::OutputMode }
+
+      # @!attribute output_preset
+      #   Keep enrichment nested or merge it into each result.
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputPreset, nil]
+      optional :output_preset, enum: -> { XTwitterScraper::ExtractionRetrieveParams::OutputPreset }
+
+      # @!method initialize(id:, cursor: nil, field_style: nil, include_raw: nil, limit: nil, output_mode: nil, output_preset: nil, request_options: {})
       #   @param id [String]
       #
-      #   @param cursor [String] Cursor for keyset pagination from prior response next_cursor
+      #   @param cursor [String] Previous nextCursor.
+      #
+      #   @param field_style [Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::FieldStyle] Preserve source keys or convert result field names.
+      #
+      #   @param include_raw [Boolean] Use outputMode=raw instead.
       #
       #   @param limit [Integer] Maximum number of results to return (1-1000, default 100)
       #
+      #   @param output_mode [Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputMode] Select compact, full, or raw-compatible result fields.
+      #
+      #   @param output_preset [Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputPreset] Keep enrichment nested or merge it into each result.
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      # Preserve source keys or convert result field names.
+      module FieldStyle
+        extend XTwitterScraper::Internal::Type::Enum
+
+        SOURCE = :source
+        CAMEL_CASE = :camelCase
+        SNAKE_CASE = :snake_case
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Select compact, full, or raw-compatible result fields.
+      module OutputMode
+        extend XTwitterScraper::Internal::Type::Enum
+
+        COMPACT = :compact
+        FULL = :full
+        RAW = :raw
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Keep enrichment nested or merge it into each result.
+      module OutputPreset
+        extend XTwitterScraper::Internal::Type::Enum
+
+        NESTED = :nested
+        FLAT = :flat
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end