x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/models/x/user_retrieve_tweets_params.rb

@@ -13,12 +13,55 @@ module XTwitterScraper
         #   @return [String]
         required :id, String
 
+        # @!attribute any_words
+        #   Words or quoted phrases where any one can match. Separate with spaces, commas,
+        #   or lines.
+        #
+        #   @return [String, nil]
+        optional :any_words, String
+
+        # @!attribute cashtags
+        #   Cashtags separated by spaces, commas, or lines.
+        #
+        #   @return [String, nil]
+        optional :cashtags, String
+
+        # @!attribute conversation_id
+        #   Conversation ID filter.
+        #
+        #   @return [String, nil]
+        optional :conversation_id, String
+
         # @!attribute cursor
         #   Pagination cursor for user tweets
         #
         #   @return [String, nil]
         optional :cursor, String
 
+        # @!attribute exact_phrase
+        #   Exact phrase to match.
+        #
+        #   @return [String, nil]
+        optional :exact_phrase, String
+
+        # @!attribute exclude_words
+        #   Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+        #
+        #   @return [String, nil]
+        optional :exclude_words, String
+
+        # @!attribute from_user
+        #   Filter by author username.
+        #
+        #   @return [String, nil]
+        optional :from_user, String
+
+        # @!attribute hashtags
+        #   Hashtags separated by spaces, commas, or lines.
+        #
+        #   @return [String, nil]
+        optional :hashtags, String
+
         # @!attribute include_parent_tweet
         #   Include parent tweet for replies
         #
@@ -31,16 +74,240 @@ module XTwitterScraper
         #   @return [Boolean, nil]
         optional :include_replies, XTwitterScraper::Internal::Type::Boolean
 
-        # @!method initialize(id:, cursor: nil, include_parent_tweet: nil, include_replies: nil, request_options: {})
+        # @!attribute in_reply_to_tweet_id
+        #   Only replies to this tweet ID.
+        #
+        #   @return [String, nil]
+        optional :in_reply_to_tweet_id, String
+
+        # @!attribute language
+        #   Language code filter, e.g. en or tr.
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute media_type
+        #   Filter by media type.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::MediaType, nil]
+        optional :media_type, enum: -> { XTwitterScraper::X::UserRetrieveTweetsParams::MediaType }
+
+        # @!attribute mentioning
+        #   Filter tweets mentioning a username.
+        #
+        #   @return [String, nil]
+        optional :mentioning, String
+
+        # @!attribute min_faves
+        #   Minimum likes threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_faves, Integer
+
+        # @!attribute min_quotes
+        #   Minimum quote count threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_quotes, Integer
+
+        # @!attribute min_replies
+        #   Minimum replies threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_replies, Integer
+
+        # @!attribute min_retweets
+        #   Minimum retweets threshold.
+        #
+        #   @return [Integer, nil]
+        optional :min_retweets, Integer
+
+        # @!attribute page_size
+        #   Maximum items requested from this page (1-100, default 20). The response can
+        #   contain fewer items because the source returned fewer, filters removed items, or
+        #   remaining credits cover fewer results. Keep requesting next_cursor while
+        #   has_next_page is true, even when a page is empty. The deprecated limit and count
+        #   aliases remain accepted.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute quotes
+        #   Quote mode.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::Quotes, nil]
+        optional :quotes, enum: -> { XTwitterScraper::X::UserRetrieveTweetsParams::Quotes }
+
+        # @!attribute quotes_of_tweet_id
+        #   Only quotes of this tweet ID.
+        #
+        #   @return [String, nil]
+        optional :quotes_of_tweet_id, String
+
+        # @!attribute replies
+        #   Reply mode.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::Replies, nil]
+        optional :replies, enum: -> { XTwitterScraper::X::UserRetrieveTweetsParams::Replies }
+
+        # @!attribute retweets
+        #   Retweet mode.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::Retweets, nil]
+        optional :retweets, enum: -> { XTwitterScraper::X::UserRetrieveTweetsParams::Retweets }
+
+        # @!attribute retweets_of_tweet_id
+        #   Only retweets of this tweet ID.
+        #
+        #   @return [String, nil]
+        optional :retweets_of_tweet_id, String
+
+        # @!attribute since_date
+        #   Start date in YYYY-MM-DD format.
+        #
+        #   @return [Date, nil]
+        optional :since_date, Date
+
+        # @!attribute to_user
+        #   Filter replies sent to a username.
+        #
+        #   @return [String, nil]
+        optional :to_user, String
+
+        # @!attribute until_date
+        #   End date in YYYY-MM-DD format.
+        #
+        #   @return [Date, nil]
+        optional :until_date, Date
+
+        # @!attribute url
+        #   URL substring or domain filter.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!attribute verified_only
+        #   Only return tweets from verified authors.
+        #
+        #   @return [Boolean, nil]
+        optional :verified_only, XTwitterScraper::Internal::Type::Boolean
+
+        # @!method initialize(id:, any_words: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, include_parent_tweet: nil, include_replies: nil, in_reply_to_tweet_id: nil, language: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {XTwitterScraper::Models::X::UserRetrieveTweetsParams} for more details.
+        #
         #   @param id [String]
         #
+        #   @param any_words [String] Words or quoted phrases where any one can match. Separate with spaces, commas, o
+        #
+        #   @param cashtags [String] Cashtags separated by spaces, commas, or lines.
+        #
+        #   @param conversation_id [String] Conversation ID filter.
+        #
         #   @param cursor [String] Pagination cursor for user tweets
         #
+        #   @param exact_phrase [String] Exact phrase to match.
+        #
+        #   @param exclude_words [String] Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+        #
+        #   @param from_user [String] Filter by author username.
+        #
+        #   @param hashtags [String] Hashtags separated by spaces, commas, or lines.
+        #
         #   @param include_parent_tweet [Boolean] Include parent tweet for replies
         #
         #   @param include_replies [Boolean] Include reply tweets
         #
+        #   @param in_reply_to_tweet_id [String] Only replies to this tweet ID.
+        #
+        #   @param language [String] Language code filter, e.g. en or tr.
+        #
+        #   @param media_type [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::MediaType] Filter by media type.
+        #
+        #   @param mentioning [String] Filter tweets mentioning a username.
+        #
+        #   @param min_faves [Integer] Minimum likes threshold.
+        #
+        #   @param min_quotes [Integer] Minimum quote count threshold.
+        #
+        #   @param min_replies [Integer] Minimum replies threshold.
+        #
+        #   @param min_retweets [Integer] Minimum retweets threshold.
+        #
+        #   @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+        #
+        #   @param quotes [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::Quotes] Quote mode.
+        #
+        #   @param quotes_of_tweet_id [String] Only quotes of this tweet ID.
+        #
+        #   @param replies [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::Replies] Reply mode.
+        #
+        #   @param retweets [Symbol, XTwitterScraper::Models::X::UserRetrieveTweetsParams::Retweets] Retweet mode.
+        #
+        #   @param retweets_of_tweet_id [String] Only retweets of this tweet ID.
+        #
+        #   @param since_date [Date] Start date in YYYY-MM-DD format.
+        #
+        #   @param to_user [String] Filter replies sent to a username.
+        #
+        #   @param until_date [Date] End date in YYYY-MM-DD format.
+        #
+        #   @param url [String] URL substring or domain filter.
+        #
+        #   @param verified_only [Boolean] Only return tweets from verified authors.
+        #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter by media type.
+        module MediaType
+          extend XTwitterScraper::Internal::Type::Enum
+
+          IMAGES = :images
+          VIDEOS = :videos
+          GIFS = :gifs
+          MEDIA = :media
+          LINKS = :links
+          NONE = :none
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Quote mode.
+        module Quotes
+          extend XTwitterScraper::Internal::Type::Enum
+
+          INCLUDE = :include
+          EXCLUDE = :exclude
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Reply mode.
+        module Replies
+          extend XTwitterScraper::Internal::Type::Enum
+
+          INCLUDE = :include
+          EXCLUDE = :exclude
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Retweet mode.
+        module Retweets
+          extend XTwitterScraper::Internal::Type::Enum
+
+          INCLUDE = :include
+          EXCLUDE = :exclude
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rb

@@ -19,11 +19,26 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :cursor, String
 
-        # @!method initialize(id:, cursor: nil, request_options: {})
+        # @!attribute page_size
+        #   Maximum user profiles requested from this page (20-200, default 200). The
+        #   response can contain fewer profiles because the source returned fewer or
+        #   remaining credits cover fewer results. Keep requesting next_cursor while
+        #   has_next_page is true. The deprecated limit and count aliases remain accepted.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersParams} for more
+        #   details.
+        #
         #   @param id [String]
         #
         #   @param cursor [String] Pagination cursor for verified followers
         #
+        #   @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). The respon
+        #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/x_twitter_scraper/models/x/write_action_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::WriteActions#retrieve
+      class WriteActionRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::WriteActions#retrieve
+      class WriteActionRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute action
+        #
+        #   @return [String]
+        required :action, String
+
+        # @!attribute charged
+        #
+        #   @return [Boolean]
+        required :charged, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute charged_credits
+        #
+        #   @return [String]
+        required :charged_credits, String, api_name: :chargedCredits
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute media
+        #
+        #   @return [XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media]
+        required :media, -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media }
+
+        # @!attribute retryable
+        #
+        #   @return [Boolean, false]
+        required :retryable, const: false
+
+        # @!attribute send_dispatched
+        #
+        #   @return [Boolean]
+        required :send_dispatched, XTwitterScraper::Internal::Type::Boolean, api_name: :sendDispatched
+
+        # @!attribute status
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status]
+        required :status, enum: -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status }
+
+        # @!attribute write_action_id
+        #
+        #   @return [String]
+        required :write_action_id, String, api_name: :writeActionId
+
+        # @!attribute confirmation_attempts
+        #
+        #   @return [Integer, nil]
+        optional :confirmation_attempts, Integer, api_name: :confirmationAttempts
+
+        # @!attribute confirmation_checked_at
+        #
+        #   @return [Time, nil]
+        optional :confirmation_checked_at, Time, api_name: :confirmationCheckedAt
+
+        # @!attribute confirmation_source
+        #
+        #   @return [String, nil]
+        optional :confirmation_source, String, api_name: :confirmationSource, nil?: true
+
+        # @!attribute confirmed_at
+        #
+        #   @return [Time, nil]
+        optional :confirmed_at, Time, api_name: :confirmedAt
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute message_id
+        #
+        #   @return [String, nil]
+        optional :message_id, String, api_name: :messageId
+
+        # @!attribute send_dispatched_at
+        #
+        #   @return [Time, nil]
+        optional :send_dispatched_at, Time, api_name: :sendDispatchedAt
+
+        # @!attribute target_id
+        #
+        #   @return [String, nil]
+        optional :target_id, String, api_name: :targetId, nil?: true
+
+        # @!attribute tweet_id
+        #
+        #   @return [String, nil]
+        optional :tweet_id, String, api_name: :tweetId
+
+        # @!method initialize(action:, charged:, charged_credits:, created_at:, media:, send_dispatched:, status:, write_action_id:, confirmation_attempts: nil, confirmation_checked_at: nil, confirmation_source: nil, confirmed_at: nil, message: nil, message_id: nil, send_dispatched_at: nil, target_id: nil, tweet_id: nil, retryable: false)
+        #   @param action [String]
+        #   @param charged [Boolean]
+        #   @param charged_credits [String]
+        #   @param created_at [Time]
+        #   @param media [XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media]
+        #   @param send_dispatched [Boolean]
+        #   @param status [Symbol, XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status]
+        #   @param write_action_id [String]
+        #   @param confirmation_attempts [Integer]
+        #   @param confirmation_checked_at [Time]
+        #   @param confirmation_source [String, nil]
+        #   @param confirmed_at [Time]
+        #   @param message [String]
+        #   @param message_id [String]
+        #   @param send_dispatched_at [Time]
+        #   @param target_id [String, nil]
+        #   @param tweet_id [String]
+        #   @param retryable [Boolean, false]
+
+        # @see XTwitterScraper::Models::X::WriteActionRetrieveResponse#media
+        class Media < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute count
+          #
+          #   @return [Integer]
+          required :count, Integer
+
+          # @!attribute credits
+          #
+          #   @return [String]
+          required :credits, String
+
+          # @!attribute kind
+          #
+          #   @return [Symbol, XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind]
+          required :kind, enum: -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind }
+
+          # @!attribute total_bytes
+          #
+          #   @return [String]
+          required :total_bytes, String, api_name: :totalBytes
+
+          # @!method initialize(count:, credits:, kind:, total_bytes:)
+          #   @param count [Integer]
+          #   @param credits [String]
+          #   @param kind [Symbol, XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind]
+          #   @param total_bytes [String]
+
+          # @see XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media#kind
+          module Kind
+            extend XTwitterScraper::Internal::Type::Enum
+
+            NONE = :none
+            IMAGE = :image
+            VIDEO = :video
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see XTwitterScraper::Models::X::WriteActionRetrieveResponse#status
+        module Status
+          extend XTwitterScraper::Internal::Type::Enum
+
+          SUCCESS = :success
+          FAILED = :failed
+          PENDING_CONFIRMATION = :pending_confirmation
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/x_account.rb

@@ -14,11 +14,26 @@ module XTwitterScraper
         #   @return [Time]
         required :created_at, Time, api_name: :createdAt
 
+        # @!attribute health
+        #   Derived login/cookie health. `healthy` = cookies valid. `needsReauth` = user
+        #   must submit fresh credentials. `locked` = X locked the account; unlock on x.com
+        #   first. `suspended` = X banned the account. `recovering` = past cooldown, will
+        #   auto-retry on next use. `temporaryIssue` = transient backend problem; retry
+        #   shortly.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::XAccount::Health]
+        required :health, enum: -> { XTwitterScraper::X::XAccount::Health }
+
         # @!attribute status
         #
         #   @return [String]
         required :status, String
 
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time, api_name: :updatedAt
+
         # @!attribute x_user_id
         #
         #   @return [String]
@@ -29,14 +44,53 @@ module XTwitterScraper
         #   @return [String]
         required :x_username, String, api_name: :xUsername
 
-        # @!method initialize(id:, created_at:, status:, x_user_id:, x_username:)
-        #   Linked X account summary with username and connection status.
+        # @!attribute cookies_obtained_at
+        #
+        #   @return [Time, nil]
+        optional :cookies_obtained_at, Time, api_name: :cookiesObtainedAt
+
+        # @!method initialize(id:, created_at:, health:, status:, updated_at:, x_user_id:, x_username:, cookies_obtained_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {XTwitterScraper::Models::X::XAccount} for more details.
+        #
+        #   Linked X account summary with connection status, health, and timestamp metadata.
         #
         #   @param id [String]
+        #
         #   @param created_at [Time]
+        #
+        #   @param health [Symbol, XTwitterScraper::Models::X::XAccount::Health] Derived login/cookie health. `healthy` = cookies valid. `needsReauth` = user mus
+        #
         #   @param status [String]
+        #
+        #   @param updated_at [Time]
+        #
         #   @param x_user_id [String]
+        #
         #   @param x_username [String]
+        #
+        #   @param cookies_obtained_at [Time]
+
+        # Derived login/cookie health. `healthy` = cookies valid. `needsReauth` = user
+        # must submit fresh credentials. `locked` = X locked the account; unlock on x.com
+        # first. `suspended` = X banned the account. `recovering` = past cooldown, will
+        # auto-retry on next use. `temporaryIssue` = transient backend problem; retry
+        # shortly.
+        #
+        # @see XTwitterScraper::Models::X::XAccount#health
+        module Health
+          extend XTwitterScraper::Internal::Type::Enum
+
+          HEALTHY = :healthy
+          LOCKED = :locked
+          NEEDS_REAUTH = :needsReauth
+          RECOVERING = :recovering
+          SUSPENDED = :suspended
+          TEMPORARY_ISSUE = :temporaryIssue
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
 

data/lib/x_twitter_scraper/models/x/x_account_detail.rb

@@ -15,6 +15,11 @@ module XTwitterScraper
         #   @return [Time]
         required :created_at, Time, api_name: :createdAt
 
+        # @!attribute health
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::XAccountDetail::Health]
+        required :health, enum: -> { XTwitterScraper::X::XAccountDetail::Health }
+
         # @!attribute status
         #
         #   @return [String]
@@ -35,27 +40,37 @@ module XTwitterScraper
         #   @return [Time, nil]
         optional :cookies_obtained_at, Time, api_name: :cookiesObtainedAt
 
-        # @!attribute proxy_country
-        #
-        #   @return [String, nil]
-        optional :proxy_country, String, api_name: :proxyCountry
-
         # @!attribute updated_at
         #
         #   @return [Time, nil]
         optional :updated_at, Time, api_name: :updatedAt
 
-        # @!method initialize(id:, created_at:, status:, x_user_id:, x_username:, cookies_obtained_at: nil, proxy_country: nil, updated_at: nil)
-        #   Full X account details including proxy, cookies, and update timestamp.
+        # @!method initialize(id:, created_at:, health:, status:, x_user_id:, x_username:, cookies_obtained_at: nil, updated_at: nil)
+        #   Full X account details with status, cookies, and update timestamp.
         #
         #   @param id [String]
         #   @param created_at [Time]
+        #   @param health [Symbol, XTwitterScraper::Models::X::XAccountDetail::Health]
         #   @param status [String]
         #   @param x_user_id [String]
         #   @param x_username [String]
         #   @param cookies_obtained_at [Time]
-        #   @param proxy_country [String]
         #   @param updated_at [Time]
+
+        # @see XTwitterScraper::Models::X::XAccountDetail#health
+        module Health
+          extend XTwitterScraper::Internal::Type::Enum
+
+          HEALTHY = :healthy
+          LOCKED = :locked
+          NEEDS_REAUTH = :needsReauth
+          RECOVERING = :recovering
+          SUSPENDED = :suspended
+          TEMPORARY_ISSUE = :temporaryIssue
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end