x-twitter-scraper 0.5.5 → 0.7.0

data/sig/x_twitter_scraper/models/radar_item.rbs

@@ -10,7 +10,7 @@ module XTwitterScraper
         category: XTwitterScraper::Models::RadarItem::category,
         created_at: Time,
         language: String,
-        metadata: ::Hash[Symbol, top],
+        metadata: XTwitterScraper::RadarItem::Metadata,
         published_at: Time,
         region: String,
         score: Float,
@@ -31,7 +31,7 @@ module XTwitterScraper
 
       attr_accessor language: String
 
-      attr_accessor metadata: ::Hash[Symbol, top]
+      attr_accessor metadata: XTwitterScraper::RadarItem::Metadata
 
       attr_accessor published_at: Time
 
@@ -62,7 +62,7 @@ module XTwitterScraper
         category: XTwitterScraper::Models::RadarItem::category,
         created_at: Time,
         language: String,
-        metadata: ::Hash[Symbol, top],
+        metadata: XTwitterScraper::RadarItem::Metadata,
         published_at: Time,
         region: String,
         score: Float,
@@ -79,7 +79,7 @@ module XTwitterScraper
         category: XTwitterScraper::Models::RadarItem::category,
         created_at: Time,
         language: String,
-        metadata: ::Hash[Symbol, top],
+        metadata: XTwitterScraper::RadarItem::Metadata,
         published_at: Time,
         region: String,
         score: Float,
@@ -116,6 +116,102 @@ module XTwitterScraper
         def self?.values: -> ::Array[XTwitterScraper::Models::RadarItem::category]
       end
 
+      type metadata =
+        {
+          author: String,
+          content_url: String,
+          estimated_downvotes: Integer,
+          estimated_upvotes: Integer,
+          number_comments: Integer,
+          score: Integer,
+          selftext: String,
+          source_format: XTwitterScraper::Models::RadarItem::Metadata::source_format,
+          subreddit: String,
+          upvote_ratio: Float
+        }
+
+      class Metadata < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader author: String?
+
+        def author=: (String) -> String
+
+        attr_reader content_url: String?
+
+        def content_url=: (String) -> String
+
+        attr_reader estimated_downvotes: Integer?
+
+        def estimated_downvotes=: (Integer) -> Integer
+
+        attr_reader estimated_upvotes: Integer?
+
+        def estimated_upvotes=: (Integer) -> Integer
+
+        attr_reader number_comments: Integer?
+
+        def number_comments=: (Integer) -> Integer
+
+        attr_reader score: Integer?
+
+        def score=: (Integer) -> Integer
+
+        attr_reader selftext: String?
+
+        def selftext=: (String) -> String
+
+        attr_reader source_format: XTwitterScraper::Models::RadarItem::Metadata::source_format?
+
+        def source_format=: (
+          XTwitterScraper::Models::RadarItem::Metadata::source_format
+        ) -> XTwitterScraper::Models::RadarItem::Metadata::source_format
+
+        attr_reader subreddit: String?
+
+        def subreddit=: (String) -> String
+
+        attr_reader upvote_ratio: Float?
+
+        def upvote_ratio=: (Float) -> Float
+
+        def initialize: (
+          ?author: String,
+          ?content_url: String,
+          ?estimated_downvotes: Integer,
+          ?estimated_upvotes: Integer,
+          ?number_comments: Integer,
+          ?score: Integer,
+          ?selftext: String,
+          ?source_format: XTwitterScraper::Models::RadarItem::Metadata::source_format,
+          ?subreddit: String,
+          ?upvote_ratio: Float
+        ) -> void
+
+        def to_hash: -> {
+          author: String,
+          content_url: String,
+          estimated_downvotes: Integer,
+          estimated_upvotes: Integer,
+          number_comments: Integer,
+          score: Integer,
+          selftext: String,
+          source_format: XTwitterScraper::Models::RadarItem::Metadata::source_format,
+          subreddit: String,
+          upvote_ratio: Float
+        }
+
+        type source_format = :html | :json | :rss
+
+        module SourceFormat
+          extend XTwitterScraper::Internal::Type::Enum
+
+          HTML: :html
+          JSON: :json
+          RSS: :rss
+
+          def self?.values: -> ::Array[XTwitterScraper::Models::RadarItem::Metadata::source_format]
+        end
+      end
+
       type source =
         :github
         | :google_trends

data/sig/x_twitter_scraper/models/search_tweet.rbs

@@ -4,37 +4,7 @@
 
 module XTwitterScraper
   module Models
-    type search_tweet =
-      {
-        id: String,
-        bookmark_count: Integer,
-        like_count: Integer,
-        quote_count: Integer,
-        reply_count: Integer,
-        retweet_count: Integer,
-        text: String,
-        view_count: Integer,
-        author: XTwitterScraper::UserProfile,
-        content_disclosure: XTwitterScraper::ContentDisclosure,
-        conversation_id: String,
-        created_at: String,
-        display_text_range: ::Array[Integer],
-        entities: ::Hash[Symbol, top],
-        in_reply_to_id: String,
-        in_reply_to_user_id: String,
-        in_reply_to_username: String,
-        is_limited_reply: bool,
-        is_note_tweet: bool,
-        is_quote_status: bool,
-        is_reply: bool,
-        lang: String,
-        media: ::Array[XTwitterScraper::TweetMedia],
-        quoted_tweet: XTwitterScraper::EmbeddedTweet,
-        retweeted_tweet: XTwitterScraper::EmbeddedTweet,
-        source: String,
-        type: String,
-        url: String
-      }
+    type search_tweet = ::Hash[Symbol, top]
 
     class SearchTweet < XTwitterScraper::Internal::Type::BaseModel
       attr_accessor id: String
@@ -53,16 +23,34 @@ module XTwitterScraper
 
       attr_accessor view_count: Integer
 
+      attr_reader article: XTwitterScraper::SearchTweet::Article?
+
+      def article=: (
+        XTwitterScraper::SearchTweet::Article | ::Hash[Symbol, top]
+      ) -> XTwitterScraper::SearchTweet::Article
+
       attr_reader author: XTwitterScraper::UserProfile?
 
       def author=: (
-        XTwitterScraper::UserProfile
+        XTwitterScraper::UserProfile | ::Hash[Symbol, top]
       ) -> XTwitterScraper::UserProfile
 
+      attr_reader card: XTwitterScraper::SearchTweet::Card?
+
+      def card=: (
+        XTwitterScraper::SearchTweet::Card | ::Hash[Symbol, top]
+      ) -> XTwitterScraper::SearchTweet::Card
+
+      attr_reader community_note: XTwitterScraper::SearchTweet::CommunityNote?
+
+      def community_note=: (
+        XTwitterScraper::SearchTweet::CommunityNote | ::Hash[Symbol, top]
+      ) -> XTwitterScraper::SearchTweet::CommunityNote
+
       attr_reader content_disclosure: XTwitterScraper::ContentDisclosure?
 
       def content_disclosure=: (
-        XTwitterScraper::ContentDisclosure
+        XTwitterScraper::ContentDisclosure | ::Hash[Symbol, top]
       ) -> XTwitterScraper::ContentDisclosure
 
       attr_reader conversation_id: String?
@@ -77,6 +65,12 @@ module XTwitterScraper
 
       def display_text_range=: (::Array[Integer]) -> ::Array[Integer]
 
+      attr_reader edit: XTwitterScraper::SearchTweet::Edit?
+
+      def edit=: (
+        XTwitterScraper::SearchTweet::Edit | ::Hash[Symbol, top]
+      ) -> XTwitterScraper::SearchTweet::Edit
+
       attr_reader entities: ::Hash[Symbol, top]?
 
       def entities=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
@@ -109,6 +103,10 @@ module XTwitterScraper
 
       def is_reply=: (bool) -> bool
 
+      attr_reader is_translatable: bool?
+
+      def is_translatable=: (bool) -> bool
+
       attr_reader lang: String?
 
       def lang=: (String) -> String
@@ -119,16 +117,38 @@ module XTwitterScraper
         ::Array[XTwitterScraper::TweetMedia]
       ) -> ::Array[XTwitterScraper::TweetMedia]
 
+      attr_reader note_tweet: XTwitterScraper::SearchTweet::NoteTweet?
+
+      def note_tweet=: (
+        XTwitterScraper::SearchTweet::NoteTweet | ::Hash[Symbol, top]
+      ) -> XTwitterScraper::SearchTweet::NoteTweet
+
+      attr_reader place: XTwitterScraper::SearchTweet::Place?
+
+      def place=: (
+        XTwitterScraper::SearchTweet::Place | ::Hash[Symbol, top]
+      ) -> XTwitterScraper::SearchTweet::Place
+
+      attr_reader possibly_sensitive: bool?
+
+      def possibly_sensitive=: (bool) -> bool
+
+      attr_reader previous_counts: XTwitterScraper::SearchTweet::PreviousCounts?
+
+      def previous_counts=: (
+        XTwitterScraper::SearchTweet::PreviousCounts | ::Hash[Symbol, top]
+      ) -> XTwitterScraper::SearchTweet::PreviousCounts
+
       attr_reader quoted_tweet: XTwitterScraper::EmbeddedTweet?
 
       def quoted_tweet=: (
-        XTwitterScraper::EmbeddedTweet
+        XTwitterScraper::EmbeddedTweet | ::Hash[Symbol, top]
       ) -> XTwitterScraper::EmbeddedTweet
 
       attr_reader retweeted_tweet: XTwitterScraper::EmbeddedTweet?
 
       def retweeted_tweet=: (
-        XTwitterScraper::EmbeddedTweet
+        XTwitterScraper::EmbeddedTweet | ::Hash[Symbol, top]
       ) -> XTwitterScraper::EmbeddedTweet
 
       attr_reader source: String?
@@ -143,6 +163,10 @@ module XTwitterScraper
 
       def url=: (String) -> String
 
+      attr_reader view_state: String?
+
+      def view_state=: (String) -> String
+
       def initialize: (
         id: String,
         bookmark_count: Integer,
@@ -152,11 +176,15 @@ module XTwitterScraper
         retweet_count: Integer,
         text: String,
         view_count: Integer,
-        ?author: XTwitterScraper::UserProfile,
-        ?content_disclosure: XTwitterScraper::ContentDisclosure,
+        ?article: XTwitterScraper::SearchTweet::Article | ::Hash[Symbol, top],
+        ?author: XTwitterScraper::UserProfile | ::Hash[Symbol, top],
+        ?card: XTwitterScraper::SearchTweet::Card | ::Hash[Symbol, top],
+        ?community_note: XTwitterScraper::SearchTweet::CommunityNote | ::Hash[Symbol, top],
+        ?content_disclosure: XTwitterScraper::ContentDisclosure | ::Hash[Symbol, top],
         ?conversation_id: String,
         ?created_at: String,
         ?display_text_range: ::Array[Integer],
+        ?edit: XTwitterScraper::SearchTweet::Edit | ::Hash[Symbol, top],
         ?entities: ::Hash[Symbol, top],
         ?in_reply_to_id: String,
         ?in_reply_to_user_id: String,
@@ -165,45 +193,280 @@ module XTwitterScraper
         ?is_note_tweet: bool,
         ?is_quote_status: bool,
         ?is_reply: bool,
+        ?is_translatable: bool,
         ?lang: String,
         ?media: ::Array[XTwitterScraper::TweetMedia],
-        ?quoted_tweet: XTwitterScraper::EmbeddedTweet,
-        ?retweeted_tweet: XTwitterScraper::EmbeddedTweet,
+        ?note_tweet: XTwitterScraper::SearchTweet::NoteTweet | ::Hash[Symbol, top],
+        ?place: XTwitterScraper::SearchTweet::Place | ::Hash[Symbol, top],
+        ?possibly_sensitive: bool,
+        ?previous_counts: XTwitterScraper::SearchTweet::PreviousCounts | ::Hash[Symbol, top],
+        ?quoted_tweet: XTwitterScraper::EmbeddedTweet | ::Hash[Symbol, top],
+        ?retweeted_tweet: XTwitterScraper::EmbeddedTweet | ::Hash[Symbol, top],
         ?source: String,
         ?type: String,
-        ?url: String
+        ?url: String,
+        ?view_state: String
       ) -> void
 
-      def to_hash: -> {
-        id: String,
-        bookmark_count: Integer,
-        like_count: Integer,
-        quote_count: Integer,
-        reply_count: Integer,
-        retweet_count: Integer,
-        text: String,
-        view_count: Integer,
-        author: XTwitterScraper::UserProfile,
-        content_disclosure: XTwitterScraper::ContentDisclosure,
-        conversation_id: String,
-        created_at: String,
-        display_text_range: ::Array[Integer],
-        entities: ::Hash[Symbol, top],
-        in_reply_to_id: String,
-        in_reply_to_user_id: String,
-        in_reply_to_username: String,
-        is_limited_reply: bool,
-        is_note_tweet: bool,
-        is_quote_status: bool,
-        is_reply: bool,
-        lang: String,
-        media: ::Array[XTwitterScraper::TweetMedia],
-        quoted_tweet: XTwitterScraper::EmbeddedTweet,
-        retweeted_tweet: XTwitterScraper::EmbeddedTweet,
-        source: String,
-        type: String,
-        url: String
-      }
+      def to_hash: -> ::Hash[Symbol, top]
+
+      type article = ::Hash[Symbol, top]
+
+      class Article < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader cover_media_url: String?
+
+        def cover_media_url=: (String) -> String
+
+        attr_reader preview_text: String?
+
+        def preview_text=: (String) -> String
+
+        attr_reader title: String?
+
+        def title=: (String) -> String
+
+        def initialize: (
+          ?id: String,
+          ?cover_media_url: String,
+          ?preview_text: String,
+          ?title: String
+        ) -> void
+
+        def to_hash: -> ::Hash[Symbol, top]
+      end
+
+      type card = ::Hash[Symbol, top]
+
+      class Card < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader binding_values: ::Hash[Symbol, top]?
+
+        def binding_values=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_reader url: String?
+
+        def url=: (String) -> String
+
+        def initialize: (
+          ?id: String,
+          ?binding_values: ::Hash[Symbol, top],
+          ?name: String,
+          ?url: String
+        ) -> void
+
+        def to_hash: -> ::Hash[Symbol, top]
+      end
+
+      type community_note = ::Hash[Symbol, top]
+
+      class CommunityNote < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader destination_url: String?
+
+        def destination_url=: (String) -> String
+
+        attr_reader footer: String?
+
+        def footer=: (String) -> String
+
+        attr_reader short_title: String?
+
+        def short_title=: (String) -> String
+
+        attr_reader subtitle: String?
+
+        def subtitle=: (String) -> String
+
+        attr_reader title: String?
+
+        def title=: (String) -> String
+
+        attr_reader visual_style: String?
+
+        def visual_style=: (String) -> String
+
+        def initialize: (
+          ?id: String,
+          ?destination_url: String,
+          ?footer: String,
+          ?short_title: String,
+          ?subtitle: String,
+          ?title: String,
+          ?visual_style: String
+        ) -> void
+
+        def to_hash: -> ::Hash[Symbol, top]
+      end
+
+      type edit =
+        { editable_until_msecs: String, edit_tweet_ids: ::Array[String] }
+
+      class Edit < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader editable_until_msecs: String?
+
+        def editable_until_msecs=: (String) -> String
+
+        attr_reader edit_tweet_ids: ::Array[String]?
+
+        def edit_tweet_ids=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          ?editable_until_msecs: String,
+          ?edit_tweet_ids: ::Array[String]
+        ) -> void
+
+        def to_hash: -> ::Hash[Symbol, top]
+      end
+
+      type note_tweet = ::Hash[Symbol, top]
+
+      class NoteTweet < XTwitterScraper::Internal::Type::BaseModel
+        attr_accessor text: String
+
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader entities: ::Hash[Symbol, top]?
+
+        def entities=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader is_expandable: bool?
+
+        def is_expandable=: (bool) -> bool
+
+        attr_reader richtext_tags: ::Array[XTwitterScraper::SearchTweet::NoteTweet::RichtextTag]?
+
+        def richtext_tags=: (
+          ::Array[XTwitterScraper::SearchTweet::NoteTweet::RichtextTag]
+        ) -> ::Array[XTwitterScraper::SearchTweet::NoteTweet::RichtextTag]
+
+        def initialize: (
+          text: String,
+          ?id: String,
+          ?entities: ::Hash[Symbol, top],
+          ?is_expandable: bool,
+          ?richtext_tags: ::Array[XTwitterScraper::SearchTweet::NoteTweet::RichtextTag]
+        ) -> void
+
+        def to_hash: -> ::Hash[Symbol, top]
+
+        type richtext_tag =
+          { from_index: Integer, to_index: Integer, types: ::Array[String] }
+
+        class RichtextTag < XTwitterScraper::Internal::Type::BaseModel
+          attr_accessor from_index: Integer
+
+          attr_accessor to_index: Integer
+
+          attr_accessor types: ::Array[String]
+
+          def initialize: (
+            from_index: Integer,
+            to_index: Integer,
+            types: ::Array[String]
+          ) -> void
+
+          def to_hash: -> ::Hash[Symbol, top]
+        end
+      end
+
+      type place = ::Hash[Symbol, top]
+
+      class Place < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader bounding_box: ::Hash[Symbol, top]?
+
+        def bounding_box=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader country: String?
+
+        def country=: (String) -> String
+
+        attr_reader country_code: String?
+
+        def country_code=: (String) -> String
+
+        attr_reader full_name: String?
+
+        def full_name=: (String) -> String
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_reader place_type: String?
+
+        def place_type=: (String) -> String
+
+        attr_reader url: String?
+
+        def url=: (String) -> String
+
+        def initialize: (
+          ?id: String,
+          ?bounding_box: ::Hash[Symbol, top],
+          ?country: String,
+          ?country_code: String,
+          ?full_name: String,
+          ?name: String,
+          ?place_type: String,
+          ?url: String
+        ) -> void
+
+        def to_hash: -> ::Hash[Symbol, top]
+      end
+
+      type previous_counts = ::Hash[Symbol, top]
+
+      class PreviousCounts < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader bookmark_count: Integer?
+
+        def bookmark_count=: (Integer) -> Integer
+
+        attr_reader like_count: Integer?
+
+        def like_count=: (Integer) -> Integer
+
+        attr_reader quote_count: Integer?
+
+        def quote_count=: (Integer) -> Integer
+
+        attr_reader reply_count: Integer?
+
+        def reply_count=: (Integer) -> Integer
+
+        attr_reader retweet_count: Integer?
+
+        def retweet_count=: (Integer) -> Integer
+
+        def initialize: (
+          ?bookmark_count: Integer,
+          ?like_count: Integer,
+          ?quote_count: Integer,
+          ?reply_count: Integer,
+          ?retweet_count: Integer
+        ) -> void
+
+        def to_hash: -> ::Hash[Symbol, top]
+      end
     end
   end
 end