x-twitter-scraper 0.6.0 → 0.7.0

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

@@ -48,6 +48,12 @@ module XTwitterScraper
         #   @return [Integer]
         required :view_count, Integer, api_name: :viewCount
 
+        # @!attribute article
+        #   Article metadata attached to a tweet.
+        #
+        #   @return [XTwitterScraper::Models::X::TweetDetail::Article, nil]
+        optional :article, -> { XTwitterScraper::X::TweetDetail::Article }
+
         # @!attribute author
         #   Tweet author profile. The lookup route always includes follower count and
         #   verification state. Other profile fields appear when available.
@@ -55,6 +61,22 @@ module XTwitterScraper
         #   @return [XTwitterScraper::Models::X::TweetAuthor, nil]
         optional :author, -> { XTwitterScraper::X::TweetAuthor }
 
+        # @!attribute card
+        #   Public card metadata attached to a tweet.
+        #
+        #   @return [XTwitterScraper::Models::X::TweetDetail::Card, nil]
+        optional :card, -> { XTwitterScraper::X::TweetDetail::Card }
+
+        # @!attribute community_note
+        #   Community Note presentation metadata returned by X.
+        #
+        #   @return [XTwitterScraper::Models::X::TweetDetail::CommunityNote, nil]
+        optional :community_note,
+                 -> {
+                   XTwitterScraper::X::TweetDetail::CommunityNote
+                 },
+                 api_name: :communityNote
+
         # @!attribute content_disclosure
         #   Content disclosure metadata shown by X when a tweet is labeled as paid
         #   partnership content or AI-generated media.
@@ -81,6 +103,12 @@ module XTwitterScraper
                  XTwitterScraper::Internal::Type::ArrayOf[Integer],
                  api_name: :displayTextRange
 
+        # @!attribute edit
+        #   Edit history metadata returned by X.
+        #
+        #   @return [XTwitterScraper::Models::X::TweetDetail::Edit, nil]
+        optional :edit, -> { XTwitterScraper::X::TweetDetail::Edit }
+
         # @!attribute entities
         #   Parsed entities from the tweet text (URLs, mentions, hashtags, media)
         #
@@ -129,6 +157,11 @@ module XTwitterScraper
         #   @return [Boolean, nil]
         optional :is_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isReply
 
+        # @!attribute is_translatable
+        #
+        #   @return [Boolean, nil]
+        optional :is_translatable, XTwitterScraper::Internal::Type::Boolean, api_name: :isTranslatable
+
         # @!attribute lang
         #   Tweet language code
         #
@@ -141,6 +174,31 @@ module XTwitterScraper
         #   @return [Array<XTwitterScraper::Models::TweetMedia>, nil]
         optional :media, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia] }
 
+        # @!attribute note_tweet
+        #   Complete Note Tweet content and rich-text metadata.
+        #
+        #   @return [XTwitterScraper::Models::X::TweetDetail::NoteTweet, nil]
+        optional :note_tweet, -> { XTwitterScraper::X::TweetDetail::NoteTweet }, api_name: :noteTweet
+
+        # @!attribute place
+        #   Public place metadata attached to a tweet.
+        #
+        #   @return [XTwitterScraper::Models::X::TweetDetail::Place, nil]
+        optional :place, -> { XTwitterScraper::X::TweetDetail::Place }
+
+        # @!attribute possibly_sensitive
+        #
+        #   @return [Boolean, nil]
+        optional :possibly_sensitive, XTwitterScraper::Internal::Type::Boolean, api_name: :possiblySensitive
+
+        # @!attribute previous_counts
+        #   Engagement counts retained from a prior tweet edit.
+        #
+        #   @return [XTwitterScraper::Models::X::TweetDetail::PreviousCounts, nil]
+        optional :previous_counts,
+                 -> { XTwitterScraper::X::TweetDetail::PreviousCounts },
+                 api_name: :previousCounts
+
         # @!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,
@@ -175,7 +233,12 @@ module XTwitterScraper
         #   @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)
+        # @!attribute view_state
+        #
+        #   @return [String, nil]
+        optional :view_state, String, api_name: :viewState
+
+        # @!method initialize(id:, bookmark_count:, like_count:, quote_count:, reply_count:, retweet_count:, text:, view_count:, article: nil, author: nil, card: nil, community_note: nil, content_disclosure: nil, conversation_id: nil, created_at: nil, display_text_range: nil, edit: 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, is_translatable: nil, lang: nil, media: nil, note_tweet: nil, place: nil, possibly_sensitive: nil, previous_counts: nil, quoted_tweet: nil, retweeted_tweet: nil, source: nil, type: nil, url: nil, view_state: nil)
         #   Some parameter documentations has been truncated, see
         #   {XTwitterScraper::Models::X::TweetDetail} for more details.
         #
@@ -198,8 +261,14 @@ module XTwitterScraper
         #
         #   @param view_count [Integer]
         #
+        #   @param article [XTwitterScraper::Models::X::TweetDetail::Article] Article metadata attached to a tweet.
+        #
         #   @param author [XTwitterScraper::Models::X::TweetAuthor] Tweet author profile. The lookup route always includes follower count and verifi
         #
+        #   @param card [XTwitterScraper::Models::X::TweetDetail::Card] Public card metadata attached to a tweet.
+        #
+        #   @param community_note [XTwitterScraper::Models::X::TweetDetail::CommunityNote] Community Note presentation metadata returned by X.
+        #
         #   @param content_disclosure [XTwitterScraper::Models::ContentDisclosure] Content disclosure metadata shown by X when a tweet is labeled as paid partnersh
         #
         #   @param conversation_id [String] ID of the root tweet in the conversation thread
@@ -208,6 +277,8 @@ module XTwitterScraper
         #
         #   @param display_text_range [Array<Integer>] Start and end offsets for rendered tweet text
         #
+        #   @param edit [XTwitterScraper::Models::X::TweetDetail::Edit] Edit history metadata returned by X.
+        #
         #   @param entities [Hash{Symbol=>Object}] Parsed entities from the tweet text (URLs, mentions, hashtags, media)
         #
         #   @param in_reply_to_id [String] Tweet ID being replied to
@@ -224,10 +295,20 @@ module XTwitterScraper
         #
         #   @param is_reply [Boolean] Whether this tweet is a reply to another tweet
         #
+        #   @param is_translatable [Boolean]
+        #
         #   @param lang [String] Tweet language code
         #
         #   @param media [Array<XTwitterScraper::Models::TweetMedia>] Attached media items, omitted when the tweet has no media
         #
+        #   @param note_tweet [XTwitterScraper::Models::X::TweetDetail::NoteTweet] Complete Note Tweet content and rich-text metadata.
+        #
+        #   @param place [XTwitterScraper::Models::X::TweetDetail::Place] Public place metadata attached to a tweet.
+        #
+        #   @param possibly_sensitive [Boolean]
+        #
+        #   @param previous_counts [XTwitterScraper::Models::X::TweetDetail::PreviousCounts] Engagement counts retained from a prior tweet edit.
+        #
         #   @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
@@ -237,6 +318,297 @@ module XTwitterScraper
         #   @param type [String] Tweet result type
         #
         #   @param url [String] Tweet permalink URL
+        #
+        #   @param view_state [String]
+
+        # @see XTwitterScraper::Models::X::TweetDetail#article
+        class Article < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute cover_media_url
+          #
+          #   @return [String, nil]
+          optional :cover_media_url, String, api_name: :coverMediaUrl
+
+          # @!attribute preview_text
+          #
+          #   @return [String, nil]
+          optional :preview_text, String, api_name: :previewText
+
+          # @!attribute title
+          #
+          #   @return [String, nil]
+          optional :title, String
+
+          # @!method initialize(id: nil, cover_media_url: nil, preview_text: nil, title: nil)
+          #   Article metadata attached to a tweet.
+          #
+          #   @param id [String]
+          #   @param cover_media_url [String]
+          #   @param preview_text [String]
+          #   @param title [String]
+        end
+
+        # @see XTwitterScraper::Models::X::TweetDetail#card
+        class Card < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute binding_values
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :binding_values,
+                   XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown],
+                   api_name: :bindingValues
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute url
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(id: nil, binding_values: nil, name: nil, url: nil)
+          #   Public card metadata attached to a tweet.
+          #
+          #   @param id [String]
+          #   @param binding_values [Hash{Symbol=>Object}]
+          #   @param name [String]
+          #   @param url [String]
+        end
+
+        # @see XTwitterScraper::Models::X::TweetDetail#community_note
+        class CommunityNote < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute destination_url
+          #
+          #   @return [String, nil]
+          optional :destination_url, String, api_name: :destinationUrl
+
+          # @!attribute footer
+          #
+          #   @return [String, nil]
+          optional :footer, String
+
+          # @!attribute short_title
+          #
+          #   @return [String, nil]
+          optional :short_title, String, api_name: :shortTitle
+
+          # @!attribute subtitle
+          #
+          #   @return [String, nil]
+          optional :subtitle, String
+
+          # @!attribute title
+          #
+          #   @return [String, nil]
+          optional :title, String
+
+          # @!attribute visual_style
+          #
+          #   @return [String, nil]
+          optional :visual_style, String, api_name: :visualStyle
+
+          # @!method initialize(id: nil, destination_url: nil, footer: nil, short_title: nil, subtitle: nil, title: nil, visual_style: nil)
+          #   Community Note presentation metadata returned by X.
+          #
+          #   @param id [String]
+          #   @param destination_url [String]
+          #   @param footer [String]
+          #   @param short_title [String]
+          #   @param subtitle [String]
+          #   @param title [String]
+          #   @param visual_style [String]
+        end
+
+        # @see XTwitterScraper::Models::X::TweetDetail#edit
+        class Edit < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute editable_until_msecs
+          #
+          #   @return [String, nil]
+          optional :editable_until_msecs, String, api_name: :editableUntilMsecs
+
+          # @!attribute edit_tweet_ids
+          #
+          #   @return [Array<String>, nil]
+          optional :edit_tweet_ids, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :editTweetIds
+
+          # @!method initialize(editable_until_msecs: nil, edit_tweet_ids: nil)
+          #   Edit history metadata returned by X.
+          #
+          #   @param editable_until_msecs [String]
+          #   @param edit_tweet_ids [Array<String>]
+        end
+
+        # @see XTwitterScraper::Models::X::TweetDetail#note_tweet
+        class NoteTweet < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute text
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute entities
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :entities, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+
+          # @!attribute is_expandable
+          #
+          #   @return [Boolean, nil]
+          optional :is_expandable, XTwitterScraper::Internal::Type::Boolean, api_name: :isExpandable
+
+          # @!attribute richtext_tags
+          #
+          #   @return [Array<XTwitterScraper::Models::X::TweetDetail::NoteTweet::RichtextTag>, nil]
+          optional :richtext_tags,
+                   -> {
+                     XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::X::TweetDetail::NoteTweet::RichtextTag]
+                   },
+                   api_name: :richtextTags
+
+          # @!method initialize(text:, id: nil, entities: nil, is_expandable: nil, richtext_tags: nil)
+          #   Complete Note Tweet content and rich-text metadata.
+          #
+          #   @param text [String]
+          #   @param id [String]
+          #   @param entities [Hash{Symbol=>Object}]
+          #   @param is_expandable [Boolean]
+          #   @param richtext_tags [Array<XTwitterScraper::Models::X::TweetDetail::NoteTweet::RichtextTag>]
+
+          class RichtextTag < XTwitterScraper::Internal::Type::BaseModel
+            # @!attribute from_index
+            #
+            #   @return [Integer]
+            required :from_index, Integer, api_name: :fromIndex
+
+            # @!attribute to_index
+            #
+            #   @return [Integer]
+            required :to_index, Integer, api_name: :toIndex
+
+            # @!attribute types
+            #
+            #   @return [Array<String>]
+            required :types, XTwitterScraper::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(from_index:, to_index:, types:)
+            #   @param from_index [Integer]
+            #   @param to_index [Integer]
+            #   @param types [Array<String>]
+          end
+        end
+
+        # @see XTwitterScraper::Models::X::TweetDetail#place
+        class Place < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute bounding_box
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :bounding_box,
+                   XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown],
+                   api_name: :boundingBox
+
+          # @!attribute country
+          #
+          #   @return [String, nil]
+          optional :country, String
+
+          # @!attribute country_code
+          #
+          #   @return [String, nil]
+          optional :country_code, String, api_name: :countryCode
+
+          # @!attribute full_name
+          #
+          #   @return [String, nil]
+          optional :full_name, String, api_name: :fullName
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute place_type
+          #
+          #   @return [String, nil]
+          optional :place_type, String, api_name: :placeType
+
+          # @!attribute url
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(id: nil, bounding_box: nil, country: nil, country_code: nil, full_name: nil, name: nil, place_type: nil, url: nil)
+          #   Public place metadata attached to a tweet.
+          #
+          #   @param id [String]
+          #   @param bounding_box [Hash{Symbol=>Object}]
+          #   @param country [String]
+          #   @param country_code [String]
+          #   @param full_name [String]
+          #   @param name [String]
+          #   @param place_type [String]
+          #   @param url [String]
+        end
+
+        # @see XTwitterScraper::Models::X::TweetDetail#previous_counts
+        class PreviousCounts < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute bookmark_count
+          #
+          #   @return [Integer, nil]
+          optional :bookmark_count, Integer, api_name: :bookmarkCount
+
+          # @!attribute like_count
+          #
+          #   @return [Integer, nil]
+          optional :like_count, Integer, api_name: :likeCount
+
+          # @!attribute quote_count
+          #
+          #   @return [Integer, nil]
+          optional :quote_count, Integer, api_name: :quoteCount
+
+          # @!attribute reply_count
+          #
+          #   @return [Integer, nil]
+          optional :reply_count, Integer, api_name: :replyCount
+
+          # @!attribute retweet_count
+          #
+          #   @return [Integer, nil]
+          optional :retweet_count, Integer, api_name: :retweetCount
+
+          # @!method initialize(bookmark_count: nil, like_count: nil, quote_count: nil, reply_count: nil, retweet_count: nil)
+          #   Engagement counts retained from a prior tweet edit.
+          #
+          #   @param bookmark_count [Integer]
+          #   @param like_count [Integer]
+          #   @param quote_count [Integer]
+          #   @param reply_count [Integer]
+          #   @param retweet_count [Integer]
+        end
       end
     end
   end

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

@@ -121,10 +121,8 @@ module XTwitterScraper
         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
+        #   Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+        #   results. Continue while has_next_page is true. Deprecated limit and count
         #   aliases remain accepted.
         #
         #   @return [Integer, nil]
@@ -242,7 +240,7 @@ module XTwitterScraper
         #
         #   @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 page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
         #
         #   @param quotes [Symbol, XTwitterScraper::Models::X::TweetGetQuotesParams::Quotes] Quote mode.
         #

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

@@ -78,6 +78,14 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :language, String
 
+        # @!attribute limit
+        #   With mode=complete, maximum combined direct and nested reply rows (1-25000).
+        #   Without complete mode, this is the deprecated pageSize alias and uses the normal
+        #   1-100 page range.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
         # @!attribute media_type
         #   Filter by media type.
         #
@@ -114,11 +122,16 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :min_retweets, Integer
 
+        # @!attribute mode
+        #   Set complete for maximum-coverage collection. Complete mode accepts only limit.
+        #   Remove cursor, pageSize, count, time ranges, and tweet filters.
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Mode, nil]
+        optional :mode, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::Mode }
+
         # @!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
+        #   Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+        #   results. Continue while has_next_page is true. Deprecated limit and count
         #   aliases remain accepted.
         #
         #   @return [Integer, nil]
@@ -196,7 +209,7 @@ module XTwitterScraper
         #   @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, 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, since_time: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, request_options: {})
+        # @!method initialize(id:, any_words: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, limit: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, mode: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, since_time: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {XTwitterScraper::Models::X::TweetGetRepliesParams} for more details.
         #
@@ -222,6 +235,8 @@ module XTwitterScraper
         #
         #   @param language [String] Language code filter, e.g. en or tr.
         #
+        #   @param limit [Integer] With mode=complete, maximum combined direct and nested reply rows (1-25000). Wit
+        #
         #   @param media_type [Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::MediaType] Filter by media type.
         #
         #   @param mentioning [String] Filter tweets mentioning a username.
@@ -234,7 +249,9 @@ module XTwitterScraper
         #
         #   @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 mode [Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Mode] Set complete for maximum-coverage collection. Complete mode accepts only limit.
+        #
+        #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
         #
         #   @param quotes [Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Quotes] Quote mode.
         #
@@ -277,6 +294,17 @@ module XTwitterScraper
           #   @return [Array<Symbol>]
         end
 
+        # Set complete for maximum-coverage collection. Complete mode accepts only limit.
+        # Remove cursor, pageSize, count, time ranges, and tweet filters.
+        module Mode
+          extend XTwitterScraper::Internal::Type::Enum
+
+          COMPLETE = :complete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # Quote mode.
         module Quotes
           extend XTwitterScraper::Internal::Type::Enum