x_api_scraper 0.1.0

data/lib/xapi_scraper/models/components/tweetmodel.rb

@@ -0,0 +1,518 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module XapiScraper
+  module Models
+    module Components
+
+      class TweetModel
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier for the Tweet
+        field(
+          :tweet_id,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("tweet_id"), required: true}}
+        )
+        # The actual text content of the Tweet
+        field :text, ::String, {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("text"), required: true}}
+        # A list of Tweet IDs for each edit of the Tweet
+        field(
+          :edit_tweet_ids,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("edit_tweet_ids")}}
+        )
+        # A list of hashtags mentioned in the Tweet
+        field(
+          :hashtags,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("hashtags")}}
+        )
+        # A list of cashtags (stock symbols) mentioned in the Tweet
+        field(
+          :cashtags,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("cashtags")}}
+        )
+        # A list of media objects (photos, videos) attached to the Tweet
+        field(
+          :media,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::MediaModel)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("media")}}
+        )
+        # A list of related Tweets
+        field(
+          :related_tweets,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::TweetModel)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("related_tweets")}}
+        )
+        # A list of replies to this Tweet
+        field(
+          :replies,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::TweetModel)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("replies")}}
+        )
+        # A list of URLs included in the Tweet
+        field(
+          :urls,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("urls")}}
+        )
+        # Indicates whether the content or user is associated with a paid promotion
+        field(
+          :is_paid_promotion,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("is_paid_promotion")}}
+        )
+        # The date and time the Tweet was created
+        field(
+          :created_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("created_at")}}
+        )
+        # The ISO 8601 format of the creation date
+        field(
+          :created_at_datetime,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("created_at_datetime")}}
+        )
+        # Number of times the Tweet has been bookmarked
+        field(
+          :bookmark_count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("bookmark_count")}}
+        )
+        # Indicates if the authenticating user has bookmarked this Tweet
+        field(
+          :bookmarked,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("bookmarked")}}
+        )
+        # Community note associated with the Tweet
+        field(
+          :community_note,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("community_note")}}
+        )
+        # Timestamp for when the Tweet is no longer editable
+        field(
+          :editable_until_msecs,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("editable_until_msecs")}}
+        )
+        # Number of edits remaining for the Tweet
+        field(
+          :edits_remaining,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("edits_remaining")}}
+        )
+        # Number of likes (favorites) for the Tweet
+        field(
+          :favorite_count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("favorite_count")}}
+        )
+        # Indicates if the authenticating user has liked this Tweet
+        field(
+          :favorited,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("favorited")}}
+        )
+        # The full text of the Tweet, especially for extended tweets
+        field(
+          :full_text,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("full_text")}}
+        )
+        # Indicates if the Tweet has a card attached
+        field(
+          :has_card,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("has_card")}}
+        )
+        # Indicates if the Tweet has community notes
+        field(
+          :has_community_notes,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("has_community_notes")}}
+        )
+        # The unique identifier for the Tweet (same as tweet_id)
+        field(
+          :id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("id")}}
+        )
+        # ID of the Tweet this is a reply to
+        field(
+          :in_reply_to,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("in_reply_to")}}
+        )
+        # ID of the user this is a reply to
+        field(
+          :in_reply_to_user_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("in_reply_to_user_id")}}
+        )
+        # Screen name of the user this is a reply to
+        field(
+          :in_reply_to_screen_name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("in_reply_to_screen_name")}}
+        )
+        # Indicates if the Tweet is eligible for editing
+        field(
+          :is_edit_eligible,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("is_edit_eligible")}}
+        )
+        # Indicates if this Tweet is a quote of another Tweet
+        field(
+          :is_quote_status,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("is_quote_status")}}
+        )
+        # The unique identifier for the Tweet that this is a quote of
+        field(
+          :quoted_status_id_str,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("quoted_status_id_str")}}
+        )
+        # Indicates if the Tweet is translatable
+        field(
+          :is_translatable,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("is_translatable")}}
+        )
+        # The BCP 47 language identifier for the Tweet's content
+        field(
+          :lang,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("lang")}}
+        )
+        # The location associated with the Tweet
+        field(
+          :place,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("place")}}
+        )
+        # A poll attached to the Tweet
+        field(
+          :poll,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("poll")}}
+        )
+        # Indicates if the Tweet may contain sensitive content
+        field(
+          :possibly_sensitive,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("possibly_sensitive")}}
+        )
+        # Indicates if the sensitive content flag is editable
+        field(
+          :possibly_sensitive_editable,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("possibly_sensitive_editable")}}
+        )
+        # The Tweet object being quoted
+        field(
+          :quote,
+          Crystalline::Nilable.new(Models::Components::TweetModel),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("quote")}}
+        )
+        # Number of times this Tweet has been quoted
+        field(
+          :quote_count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("quote_count")}}
+        )
+        # Number of replies to this Tweet
+        field(
+          :reply_count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("reply_count")}}
+        )
+        # The Tweet object this is a reply to
+        field(
+          :reply_to,
+          Crystalline::Nilable.new(Models::Components::TweetModel),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("reply_to")}}
+        )
+        # Number of times this Tweet has been retweeted
+        field(
+          :retweet_count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("retweet_count")}}
+        )
+        # The original Tweet object if this is a retweet
+        field(
+          :retweeted_tweet,
+          Crystalline::Nilable.new(Models::Components::TweetModel),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("retweeted_tweet")}}
+        )
+        # The conversation thread ID
+        field(
+          :thread,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::TweetModel)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("thread")}}
+        )
+        # Title for the thumbnail in a card
+        field(
+          :thumbnail_title,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("thumbnail_title")}}
+        )
+        # URL for the thumbnail in a card
+        field(
+          :thumbnail_url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("thumbnail_url")}}
+        )
+        # The user who posted the Tweet
+        field(
+          :user,
+          Crystalline::Nilable.new(Models::Components::UserModel),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("user")}}
+        )
+        # Number of views for the Tweet
+        field(
+          :view_count,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("view_count")}}
+        )
+        # State of the view count
+        field(
+          :view_count_state,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("view_count_state")}}
+        )
+        # Raw status dictionary
+        field(
+          :status,
+          Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("status")}}
+        )
+        # The target count of items requested, for context
+        field(
+          :target_count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("target_count")}}
+        )
+
+        sig {
+          params(
+            tweet_id: ::String,
+            text: ::String,
+            edit_tweet_ids: T.nilable(T::Array[::String]),
+            hashtags: T.nilable(T::Array[::String]),
+            cashtags: T.nilable(T::Array[::String]),
+            media: T.nilable(T::Array[Models::Components::MediaModel]),
+            related_tweets: T.nilable(T::Array[Models::Components::TweetModel]),
+            replies: T.nilable(T::Array[Models::Components::TweetModel]),
+            urls: T.nilable(T::Array[::String]),
+            is_paid_promotion: T.nilable(T::Boolean),
+            created_at: T.nilable(::String),
+            created_at_datetime: T.nilable(::String),
+            bookmark_count: T.nilable(::Integer),
+            bookmarked: T.nilable(T::Boolean),
+            community_note: T.nilable(::String),
+            editable_until_msecs: T.nilable(::String),
+            edits_remaining: T.nilable(::String),
+            favorite_count: T.nilable(::Integer),
+            favorited: T.nilable(T::Boolean),
+            full_text: T.nilable(::String),
+            has_card: T.nilable(T::Boolean),
+            has_community_notes: T.nilable(T::Boolean),
+            id: T.nilable(::String),
+            in_reply_to: T.nilable(::String),
+            in_reply_to_user_id: T.nilable(::String),
+            in_reply_to_screen_name: T.nilable(::String),
+            is_edit_eligible: T.nilable(T::Boolean),
+            is_quote_status: T.nilable(T::Boolean),
+            quoted_status_id_str: T.nilable(::String),
+            is_translatable: T.nilable(T::Boolean),
+            lang: T.nilable(::String),
+            place: T.nilable(::String),
+            poll: T.nilable(::String),
+            possibly_sensitive: T.nilable(T::Boolean),
+            possibly_sensitive_editable: T.nilable(T::Boolean),
+            quote: T.nilable(Models::Components::TweetModel),
+            quote_count: T.nilable(::Integer),
+            reply_count: T.nilable(::Integer),
+            reply_to: T.nilable(Models::Components::TweetModel),
+            retweet_count: T.nilable(::Integer),
+            retweeted_tweet: T.nilable(Models::Components::TweetModel),
+            thread: T.nilable(T::Array[Models::Components::TweetModel]),
+            thumbnail_title: T.nilable(::String),
+            thumbnail_url: T.nilable(::String),
+            user: T.nilable(Models::Components::UserModel),
+            view_count: T.nilable(::String),
+            view_count_state: T.nilable(::String),
+            status: T.nilable(T::Hash[Symbol, ::Object]),
+            target_count: T.nilable(::Integer)
+          )
+            .void
+        }
+        def initialize(
+          tweet_id:,
+          text:,
+          edit_tweet_ids: nil,
+          hashtags: nil,
+          cashtags: nil,
+          media: nil,
+          related_tweets: nil,
+          replies: nil,
+          urls: nil,
+          is_paid_promotion: nil,
+          created_at: nil,
+          created_at_datetime: nil,
+          bookmark_count: nil,
+          bookmarked: nil,
+          community_note: nil,
+          editable_until_msecs: nil,
+          edits_remaining: nil,
+          favorite_count: nil,
+          favorited: nil,
+          full_text: nil,
+          has_card: nil,
+          has_community_notes: nil,
+          id: nil,
+          in_reply_to: nil,
+          in_reply_to_user_id: nil,
+          in_reply_to_screen_name: nil,
+          is_edit_eligible: nil,
+          is_quote_status: nil,
+          quoted_status_id_str: nil,
+          is_translatable: nil,
+          lang: nil,
+          place: nil,
+          poll: nil,
+          possibly_sensitive: nil,
+          possibly_sensitive_editable: nil,
+          quote: nil,
+          quote_count: nil,
+          reply_count: nil,
+          reply_to: nil,
+          retweet_count: nil,
+          retweeted_tweet: nil,
+          thread: nil,
+          thumbnail_title: nil,
+          thumbnail_url: nil,
+          user: nil,
+          view_count: nil,
+          view_count_state: nil,
+          status: nil,
+          target_count: nil
+        )
+          @tweet_id = tweet_id
+          @text = text
+          @edit_tweet_ids = edit_tweet_ids
+          @hashtags = hashtags
+          @cashtags = cashtags
+          @media = media
+          @related_tweets = related_tweets
+          @replies = replies
+          @urls = urls
+          @is_paid_promotion = is_paid_promotion
+          @created_at = created_at
+          @created_at_datetime = created_at_datetime
+          @bookmark_count = bookmark_count
+          @bookmarked = bookmarked
+          @community_note = community_note
+          @editable_until_msecs = editable_until_msecs
+          @edits_remaining = edits_remaining
+          @favorite_count = favorite_count
+          @favorited = favorited
+          @full_text = full_text
+          @has_card = has_card
+          @has_community_notes = has_community_notes
+          @id = id
+          @in_reply_to = in_reply_to
+          @in_reply_to_user_id = in_reply_to_user_id
+          @in_reply_to_screen_name = in_reply_to_screen_name
+          @is_edit_eligible = is_edit_eligible
+          @is_quote_status = is_quote_status
+          @quoted_status_id_str = quoted_status_id_str
+          @is_translatable = is_translatable
+          @lang = lang
+          @place = place
+          @poll = poll
+          @possibly_sensitive = possibly_sensitive
+          @possibly_sensitive_editable = possibly_sensitive_editable
+          @quote = quote
+          @quote_count = quote_count
+          @reply_count = reply_count
+          @reply_to = reply_to
+          @retweet_count = retweet_count
+          @retweeted_tweet = retweeted_tweet
+          @thread = thread
+          @thumbnail_title = thumbnail_title
+          @thumbnail_url = thumbnail_url
+          @user = user
+          @view_count = view_count
+          @view_count_state = view_count_state
+          @status = status
+          @target_count = target_count
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @tweet_id == other.tweet_id
+          return false unless @text == other.text
+          return false unless @edit_tweet_ids == other.edit_tweet_ids
+          return false unless @hashtags == other.hashtags
+          return false unless @cashtags == other.cashtags
+          return false unless @media == other.media
+          return false unless @related_tweets == other.related_tweets
+          return false unless @replies == other.replies
+          return false unless @urls == other.urls
+          return false unless @is_paid_promotion == other.is_paid_promotion
+          return false unless @created_at == other.created_at
+          return false unless @created_at_datetime == other.created_at_datetime
+          return false unless @bookmark_count == other.bookmark_count
+          return false unless @bookmarked == other.bookmarked
+          return false unless @community_note == other.community_note
+          return false unless @editable_until_msecs == other.editable_until_msecs
+          return false unless @edits_remaining == other.edits_remaining
+          return false unless @favorite_count == other.favorite_count
+          return false unless @favorited == other.favorited
+          return false unless @full_text == other.full_text
+          return false unless @has_card == other.has_card
+          return false unless @has_community_notes == other.has_community_notes
+          return false unless @id == other.id
+          return false unless @in_reply_to == other.in_reply_to
+          return false unless @in_reply_to_user_id == other.in_reply_to_user_id
+          return false unless @in_reply_to_screen_name == other.in_reply_to_screen_name
+          return false unless @is_edit_eligible == other.is_edit_eligible
+          return false unless @is_quote_status == other.is_quote_status
+          return false unless @quoted_status_id_str == other.quoted_status_id_str
+          return false unless @is_translatable == other.is_translatable
+          return false unless @lang == other.lang
+          return false unless @place == other.place
+          return false unless @poll == other.poll
+          return false unless @possibly_sensitive == other.possibly_sensitive
+          return false unless @possibly_sensitive_editable == other.possibly_sensitive_editable
+          return false unless @quote == other.quote
+          return false unless @quote_count == other.quote_count
+          return false unless @reply_count == other.reply_count
+          return false unless @reply_to == other.reply_to
+          return false unless @retweet_count == other.retweet_count
+          return false unless @retweeted_tweet == other.retweeted_tweet
+          return false unless @thread == other.thread
+          return false unless @thumbnail_title == other.thumbnail_title
+          return false unless @thumbnail_url == other.thumbnail_url
+          return false unless @user == other.user
+          return false unless @view_count == other.view_count
+          return false unless @view_count_state == other.view_count_state
+          return false unless @status == other.status
+          return false unless @target_count == other.target_count
+          true
+        end
+      end
+    end
+  end
+end