x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/models/search_tweet.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class SearchTweet < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute bookmark_count
+      #
+      #   @return [Integer]
+      required :bookmark_count, Integer, api_name: :bookmarkCount
+
+      # @!attribute like_count
+      #
+      #   @return [Integer]
+      required :like_count, Integer, api_name: :likeCount
+
+      # @!attribute quote_count
+      #
+      #   @return [Integer]
+      required :quote_count, Integer, api_name: :quoteCount
+
+      # @!attribute reply_count
+      #
+      #   @return [Integer]
+      required :reply_count, Integer, api_name: :replyCount
+
+      # @!attribute retweet_count
+      #
+      #   @return [Integer]
+      required :retweet_count, Integer, api_name: :retweetCount
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute view_count
+      #
+      #   @return [Integer]
+      required :view_count, Integer, api_name: :viewCount
+
+      # @!attribute author
+      #   X user profile with bio, follower counts, and verification status.
+      #
+      #   @return [XTwitterScraper::Models::UserProfile, nil]
+      optional :author, -> { XTwitterScraper::UserProfile }
+
+      # @!attribute content_disclosure
+      #   Content disclosure metadata shown by X when a tweet is labeled as paid
+      #   partnership content or AI-generated media.
+      #
+      #   @return [XTwitterScraper::Models::ContentDisclosure, nil]
+      optional :content_disclosure, -> { XTwitterScraper::ContentDisclosure }, api_name: :contentDisclosure
+
+      # @!attribute conversation_id
+      #   Root tweet ID for the search result conversation
+      #
+      #   @return [String, nil]
+      optional :conversation_id, String, api_name: :conversationId
+
+      # @!attribute created_at
+      #
+      #   @return [String, nil]
+      optional :created_at, String, api_name: :createdAt
+
+      # @!attribute display_text_range
+      #   Start and end offsets for rendered tweet text
+      #
+      #   @return [Array<Integer>, nil]
+      optional :display_text_range,
+               XTwitterScraper::Internal::Type::ArrayOf[Integer],
+               api_name: :displayTextRange
+
+      # @!attribute entities
+      #   Parsed search-result entities including URLs, mentions, hashtags, and media
+      #   markers
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :entities, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+
+      # @!attribute in_reply_to_id
+      #   Tweet ID being replied to
+      #
+      #   @return [String, nil]
+      optional :in_reply_to_id, String, api_name: :inReplyToId
+
+      # @!attribute in_reply_to_user_id
+      #   User ID being replied to
+      #
+      #   @return [String, nil]
+      optional :in_reply_to_user_id, String, api_name: :inReplyToUserId
+
+      # @!attribute in_reply_to_username
+      #   Username being replied to
+      #
+      #   @return [String, nil]
+      optional :in_reply_to_username, String, api_name: :inReplyToUsername
+
+      # @!attribute is_limited_reply
+      #   Whether the tweet has limited reply permissions
+      #
+      #   @return [Boolean, nil]
+      optional :is_limited_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isLimitedReply
+
+      # @!attribute is_note_tweet
+      #   True for Note Tweets (long-form content, up to 25,000 characters)
+      #
+      #   @return [Boolean, nil]
+      optional :is_note_tweet, XTwitterScraper::Internal::Type::Boolean, api_name: :isNoteTweet
+
+      # @!attribute is_quote_status
+      #   True when this search result quotes another tweet
+      #
+      #   @return [Boolean, nil]
+      optional :is_quote_status, XTwitterScraper::Internal::Type::Boolean, api_name: :isQuoteStatus
+
+      # @!attribute is_reply
+      #   True when this search result is a reply
+      #
+      #   @return [Boolean, nil]
+      optional :is_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isReply
+
+      # @!attribute lang
+      #   Tweet language code
+      #
+      #   @return [String, nil]
+      optional :lang, String
+
+      # @!attribute media
+      #   Search-result media attachments, omitted when no media is present
+      #
+      #   @return [Array<XTwitterScraper::Models::TweetMedia>, nil]
+      optional :media, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia] }
+
+      # @!attribute quoted_tweet
+      #   Quoted or retweeted tweet context. Every object includes id, text, and
+      #   engagement metrics. A zero metric can mean X did not report the count. Author,
+      #   media, and conversation fields appear when available.
+      #
+      #   @return [XTwitterScraper::Models::EmbeddedTweet, nil]
+      optional :quoted_tweet, -> { XTwitterScraper::EmbeddedTweet }
+
+      # @!attribute retweeted_tweet
+      #   Quoted or retweeted tweet context. Every object includes id, text, and
+      #   engagement metrics. A zero metric can mean X did not report the count. Author,
+      #   media, and conversation fields appear when available.
+      #
+      #   @return [XTwitterScraper::Models::EmbeddedTweet, nil]
+      optional :retweeted_tweet, -> { XTwitterScraper::EmbeddedTweet }
+
+      # @!attribute source
+      #   Client application used to post the tweet
+      #
+      #   @return [String, nil]
+      optional :source, String
+
+      # @!attribute type
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!attribute url
+      #   Tweet permalink URL
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!method initialize(id:, bookmark_count:, like_count:, quote_count:, reply_count:, retweet_count:, text:, view_count:, author: nil, content_disclosure: nil, conversation_id: nil, created_at: nil, display_text_range: nil, entities: nil, in_reply_to_id: nil, in_reply_to_user_id: nil, in_reply_to_username: nil, is_limited_reply: nil, is_note_tweet: nil, is_quote_status: nil, is_reply: nil, lang: nil, media: nil, quoted_tweet: nil, retweeted_tweet: nil, source: nil, type: nil, url: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {XTwitterScraper::Models::SearchTweet} for more details.
+      #
+      #   Tweet returned from search results with inline author info. A zero metric can
+      #   mean X did not report the count.
+      #
+      #   @param id [String]
+      #
+      #   @param bookmark_count [Integer]
+      #
+      #   @param like_count [Integer]
+      #
+      #   @param quote_count [Integer]
+      #
+      #   @param reply_count [Integer]
+      #
+      #   @param retweet_count [Integer]
+      #
+      #   @param text [String]
+      #
+      #   @param view_count [Integer]
+      #
+      #   @param author [XTwitterScraper::Models::UserProfile] X user profile with bio, follower counts, and verification status.
+      #
+      #   @param content_disclosure [XTwitterScraper::Models::ContentDisclosure] Content disclosure metadata shown by X when a tweet is labeled as paid partnersh
+      #
+      #   @param conversation_id [String] Root tweet ID for the search result conversation
+      #
+      #   @param created_at [String]
+      #
+      #   @param display_text_range [Array<Integer>] Start and end offsets for rendered tweet text
+      #
+      #   @param entities [Hash{Symbol=>Object}] Parsed search-result entities including URLs, mentions, hashtags, and media mark
+      #
+      #   @param in_reply_to_id [String] Tweet ID being replied to
+      #
+      #   @param in_reply_to_user_id [String] User ID being replied to
+      #
+      #   @param in_reply_to_username [String] Username being replied to
+      #
+      #   @param is_limited_reply [Boolean] Whether the tweet has limited reply permissions
+      #
+      #   @param is_note_tweet [Boolean] True for Note Tweets (long-form content, up to 25,000 characters)
+      #
+      #   @param is_quote_status [Boolean] True when this search result quotes another tweet
+      #
+      #   @param is_reply [Boolean] True when this search result is a reply
+      #
+      #   @param lang [String] Tweet language code
+      #
+      #   @param media [Array<XTwitterScraper::Models::TweetMedia>] Search-result media attachments, omitted when no media is present
+      #
+      #   @param quoted_tweet [XTwitterScraper::Models::EmbeddedTweet] Quoted or retweeted tweet context. Every object includes id, text, and engagemen
+      #
+      #   @param retweeted_tweet [XTwitterScraper::Models::EmbeddedTweet] Quoted or retweeted tweet context. Every object includes id, text, and engagemen
+      #
+      #   @param source [String] Client application used to post the tweet
+      #
+      #   @param type [String]
+      #
+      #   @param url [String] Tweet permalink URL
+    end
+  end
+end

data/lib/x_twitter_scraper/models/subscribe_create_params.rb

@@ -7,8 +7,28 @@ module XTwitterScraper
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute tier
+      #   Subscription tier to pre-select.
+      #
+      #   @return [Symbol, XTwitterScraper::Models::SubscribeCreateParams::Tier, nil]
+      optional :tier, enum: -> { XTwitterScraper::SubscribeCreateParams::Tier }
+
+      # @!method initialize(tier: nil, request_options: {})
+      #   @param tier [Symbol, XTwitterScraper::Models::SubscribeCreateParams::Tier] Subscription tier to pre-select.
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      # Subscription tier to pre-select.
+      module Tier
+        extend XTwitterScraper::Internal::Type::Enum
+
+        STARTER = :starter
+        PRO = :pro
+        BUSINESS = :business
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/x_twitter_scraper/models/subscribe_create_response.rb

@@ -4,25 +4,25 @@ module XTwitterScraper
   module Models
     # @see XTwitterScraper::Resources::Subscribe#create
     class SubscribeCreateResponse < XTwitterScraper::Internal::Type::BaseModel
-      # @!attribute url
+      # @!attribute message
       #
       #   @return [String]
-      required :url, String
+      required :message, String
 
-      # @!attribute message
+      # @!attribute status
       #
-      #   @return [String, nil]
-      optional :message, String
+      #   @return [Symbol, XTwitterScraper::Models::SubscribeCreateResponse::Status]
+      required :status, enum: -> { XTwitterScraper::Models::SubscribeCreateResponse::Status }
 
-      # @!attribute status
+      # @!attribute url
       #
-      #   @return [Symbol, XTwitterScraper::Models::SubscribeCreateResponse::Status, nil]
-      optional :status, enum: -> { XTwitterScraper::Models::SubscribeCreateResponse::Status }
+      #   @return [String]
+      required :url, String
 
-      # @!method initialize(url:, message: nil, status: nil)
-      #   @param url [String]
+      # @!method initialize(message:, status:, url:)
       #   @param message [String]
       #   @param status [Symbol, XTwitterScraper::Models::SubscribeCreateResponse::Status]
+      #   @param url [String]
 
       # @see XTwitterScraper::Models::SubscribeCreateResponse#status
       module Status

data/lib/x_twitter_scraper/models/trend_list_params.rb

@@ -8,21 +8,24 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute count
-      #   Number of trending topics to return (1-50, default 30)
+      #   Number of trending topics returned (1-50, default 30)
       #
       #   @return [Integer, nil]
       optional :count, Integer
 
       # @!attribute woeid
-      #   Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+      #   Region Yahoo WOEID code (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
       #
       #   @return [Integer, nil]
       optional :woeid, Integer
 
       # @!method initialize(count: nil, woeid: nil, request_options: {})
-      #   @param count [Integer] Number of trending topics to return (1-50, default 30)
+      #   Some parameter documentations has been truncated, see
+      #   {XTwitterScraper::Models::TrendListParams} for more details.
       #
-      #   @param woeid [Integer] Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+      #   @param count [Integer] Number of trending topics returned (1-50, default 30)
+      #
+      #   @param woeid [Integer] Region Yahoo WOEID code (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/x_twitter_scraper/models/tweet_media.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class TweetMedia < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute media_url
+      #   Media preview URL
+      #
+      #   @return [String]
+      required :media_url, String, api_name: :mediaUrl
+
+      # @!attribute type
+      #
+      #   @return [Symbol, XTwitterScraper::Models::TweetMedia::Type]
+      required :type, enum: -> { XTwitterScraper::TweetMedia::Type }
+
+      # @!attribute url
+      #   X media link from the tweet
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute video_variants
+      #   Available video encodings, ordered as returned
+      #
+      #   @return [Array<XTwitterScraper::Models::TweetMedia::VideoVariant>, nil]
+      optional :video_variants,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::VideoVariant] },
+               api_name: :videoVariants
+
+      # @!method initialize(media_url:, type:, url:, video_variants: nil)
+      #   Normalized media attached to a tweet.
+      #
+      #   @param media_url [String] Media preview URL
+      #
+      #   @param type [Symbol, XTwitterScraper::Models::TweetMedia::Type]
+      #
+      #   @param url [String] X media link from the tweet
+      #
+      #   @param video_variants [Array<XTwitterScraper::Models::TweetMedia::VideoVariant>] Available video encodings, ordered as returned
+
+      # @see XTwitterScraper::Models::TweetMedia#type
+      module Type
+        extend XTwitterScraper::Internal::Type::Enum
+
+        PHOTO = :photo
+        VIDEO = :video
+        ANIMATED_GIF = :animated_gif
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class VideoVariant < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute content_type
+        #
+        #   @return [String]
+        required :content_type, String, api_name: :contentType
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute bitrate
+        #
+        #   @return [Integer, nil]
+        optional :bitrate, Integer
+
+        # @!method initialize(content_type:, url:, bitrate: nil)
+        #   @param content_type [String]
+        #   @param url [String]
+        #   @param bitrate [Integer]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/user_profile.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class UserProfile < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute username
+      #
+      #   @return [String]
+      required :username, String
+
+      # @!attribute automated_by
+      #
+      #   @return [String, nil]
+      optional :automated_by, String, api_name: :automatedBy
+
+      # @!attribute can_dm
+      #
+      #   @return [Boolean, nil]
+      optional :can_dm, XTwitterScraper::Internal::Type::Boolean, api_name: :canDm
+
+      # @!attribute community_role
+      #   Community role when returned by community member reads
+      #
+      #   @return [String, nil]
+      optional :community_role, String, api_name: :communityRole
+
+      # @!attribute cover_picture
+      #
+      #   @return [String, nil]
+      optional :cover_picture, String, api_name: :coverPicture
+
+      # @!attribute created_at
+      #
+      #   @return [String, nil]
+      optional :created_at, String, api_name: :createdAt
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute favourites_count
+      #
+      #   @return [Integer, nil]
+      optional :favourites_count, Integer, api_name: :favouritesCount
+
+      # @!attribute followers
+      #
+      #   @return [Integer, nil]
+      optional :followers, Integer
+
+      # @!attribute following
+      #
+      #   @return [Integer, nil]
+      optional :following, Integer
+
+      # @!attribute has_custom_timelines
+      #
+      #   @return [Boolean, nil]
+      optional :has_custom_timelines, XTwitterScraper::Internal::Type::Boolean, api_name: :hasCustomTimelines
+
+      # @!attribute is_automated
+      #
+      #   @return [Boolean, nil]
+      optional :is_automated, XTwitterScraper::Internal::Type::Boolean, api_name: :isAutomated
+
+      # @!attribute is_blue_verified
+      #   Whether X shows a blue verification badge
+      #
+      #   @return [Boolean, nil]
+      optional :is_blue_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isBlueVerified
+
+      # @!attribute is_translator
+      #
+      #   @return [Boolean, nil]
+      optional :is_translator, XTwitterScraper::Internal::Type::Boolean, api_name: :isTranslator
+
+      # @!attribute is_verified
+      #   Whether X marks the profile as verified
+      #
+      #   @return [Boolean, nil]
+      optional :is_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isVerified
+
+      # @!attribute location
+      #
+      #   @return [String, nil]
+      optional :location, String
+
+      # @!attribute media_count
+      #
+      #   @return [Integer, nil]
+      optional :media_count, Integer, api_name: :mediaCount
+
+      # @!attribute pinned_tweet_ids
+      #
+      #   @return [Array<String>, nil]
+      optional :pinned_tweet_ids, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :pinnedTweetIds
+
+      # @!attribute possibly_sensitive
+      #
+      #   @return [Boolean, nil]
+      optional :possibly_sensitive, XTwitterScraper::Internal::Type::Boolean, api_name: :possiblySensitive
+
+      # @!attribute profile_bio
+      #   Structured profile bio with entity annotations
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :profile_bio, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+
+      # @!attribute profile_banner_url
+      #   Original X profile banner field when available
+      #
+      #   @return [String, nil]
+      optional :profile_banner_url, String, api_name: :profileBannerUrl
+
+      # @!attribute profile_picture
+      #
+      #   @return [String, nil]
+      optional :profile_picture, String, api_name: :profilePicture
+
+      # @!attribute protected
+      #   Whether the profile protects its posts
+      #
+      #   @return [Boolean, nil]
+      optional :protected, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute statuses_count
+      #
+      #   @return [Integer, nil]
+      optional :statuses_count, Integer, api_name: :statusesCount
+
+      # @!attribute unavailable
+      #
+      #   @return [Boolean, nil]
+      optional :unavailable, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute unavailable_reason
+      #
+      #   @return [String, nil]
+      optional :unavailable_reason, String, api_name: :unavailableReason
+
+      # @!attribute url
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!attribute verified
+      #
+      #   @return [Boolean, nil]
+      optional :verified, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute verified_type
+      #
+      #   @return [String, nil]
+      optional :verified_type, String, api_name: :verifiedType
+
+      # @!attribute viewer_followed_by
+      #   Whether this profile follows the authenticated viewer
+      #
+      #   @return [Boolean, nil]
+      optional :viewer_followed_by, XTwitterScraper::Internal::Type::Boolean, api_name: :viewerFollowedBy
+
+      # @!attribute viewer_following
+      #   Whether the authenticated viewer follows this profile
+      #
+      #   @return [Boolean, nil]
+      optional :viewer_following, XTwitterScraper::Internal::Type::Boolean, api_name: :viewerFollowing
+
+      # @!attribute withheld_in_countries
+      #
+      #   @return [Array<String>, nil]
+      optional :withheld_in_countries,
+               XTwitterScraper::Internal::Type::ArrayOf[String],
+               api_name: :withheldInCountries
+
+      # @!method initialize(id:, name:, username:, automated_by: nil, can_dm: nil, community_role: nil, cover_picture: nil, created_at: nil, description: nil, favourites_count: nil, followers: nil, following: nil, has_custom_timelines: nil, is_automated: nil, is_blue_verified: nil, is_translator: nil, is_verified: nil, location: nil, media_count: nil, pinned_tweet_ids: nil, possibly_sensitive: nil, profile_bio: nil, profile_banner_url: nil, profile_picture: nil, protected: nil, statuses_count: nil, unavailable: nil, unavailable_reason: nil, url: nil, verified: nil, verified_type: nil, viewer_followed_by: nil, viewer_following: nil, withheld_in_countries: nil)
+      #   X user profile with bio, follower counts, and verification status.
+      #
+      #   @param id [String]
+      #
+      #   @param name [String]
+      #
+      #   @param username [String]
+      #
+      #   @param automated_by [String]
+      #
+      #   @param can_dm [Boolean]
+      #
+      #   @param community_role [String] Community role when returned by community member reads
+      #
+      #   @param cover_picture [String]
+      #
+      #   @param created_at [String]
+      #
+      #   @param description [String]
+      #
+      #   @param favourites_count [Integer]
+      #
+      #   @param followers [Integer]
+      #
+      #   @param following [Integer]
+      #
+      #   @param has_custom_timelines [Boolean]
+      #
+      #   @param is_automated [Boolean]
+      #
+      #   @param is_blue_verified [Boolean] Whether X shows a blue verification badge
+      #
+      #   @param is_translator [Boolean]
+      #
+      #   @param is_verified [Boolean] Whether X marks the profile as verified
+      #
+      #   @param location [String]
+      #
+      #   @param media_count [Integer]
+      #
+      #   @param pinned_tweet_ids [Array<String>]
+      #
+      #   @param possibly_sensitive [Boolean]
+      #
+      #   @param profile_bio [Hash{Symbol=>Object}] Structured profile bio with entity annotations
+      #
+      #   @param profile_banner_url [String] Original X profile banner field when available
+      #
+      #   @param profile_picture [String]
+      #
+      #   @param protected [Boolean] Whether the profile protects its posts
+      #
+      #   @param statuses_count [Integer]
+      #
+      #   @param unavailable [Boolean]
+      #
+      #   @param unavailable_reason [String]
+      #
+      #   @param url [String]
+      #
+      #   @param verified [Boolean]
+      #
+      #   @param verified_type [String]
+      #
+      #   @param viewer_followed_by [Boolean] Whether this profile follows the authenticated viewer
+      #
+      #   @param viewer_following [Boolean] Whether the authenticated viewer follows this profile
+      #
+      #   @param withheld_in_countries [Array<String>]
+    end
+  end
+end