x-twitter-scraper 0.6.0 → 0.7.0

data/lib/x_twitter_scraper/models/trend_list_response.rb

@@ -40,6 +40,12 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :description, String
 
+        # @!attribute promoted_content
+        #   Promotion identifier from X. Null for organic trends.
+        #
+        #   @return [String, nil]
+        optional :promoted_content, String, api_name: :promotedContent, nil?: true
+
         # @!attribute query
         #
         #   @return [String, nil]
@@ -50,11 +56,32 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :rank, Integer
 
-        # @!method initialize(name:, description: nil, query: nil, rank: nil)
+        # @!attribute tweet_volume
+        #   Approximate public post volume when X supplies it.
+        #
+        #   @return [Integer, nil]
+        optional :tweet_volume, Integer, api_name: :tweetVolume, nil?: true
+
+        # @!attribute url
+        #   X search URL for the trend.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(name:, description: nil, promoted_content: nil, query: nil, rank: nil, tweet_volume: nil, url: nil)
         #   @param name [String]
+        #
         #   @param description [String]
+        #
+        #   @param promoted_content [String, nil] Promotion identifier from X. Null for organic trends.
+        #
         #   @param query [String]
+        #
         #   @param rank [Integer]
+        #
+        #   @param tweet_volume [Integer, nil] Approximate public post volume when X supplies it.
+        #
+        #   @param url [String] X search URL for the trend.
       end
     end
   end

data/lib/x_twitter_scraper/models/tweet_media.rb

@@ -24,6 +24,102 @@ module XTwitterScraper
       #   @return [String]
       required :url, String
 
+      # @!attribute id
+      #   X media entity ID.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute allow_download
+      #   Whether X permits direct media download.
+      #
+      #   @return [Boolean, nil]
+      optional :allow_download, XTwitterScraper::Internal::Type::Boolean, api_name: :allowDownload
+
+      # @!attribute alt_text
+      #   Accessibility text supplied for the media.
+      #
+      #   @return [String, nil]
+      optional :alt_text, String, api_name: :altText
+
+      # @!attribute aspect_ratio
+      #   Video aspect ratio as width and height.
+      #
+      #   @return [Array<Integer>, nil]
+      optional :aspect_ratio, XTwitterScraper::Internal::Type::ArrayOf[Integer], api_name: :aspectRatio
+
+      # @!attribute availability_status
+      #   Media availability state reported by X.
+      #
+      #   @return [String, nil]
+      optional :availability_status, String, api_name: :availabilityStatus
+
+      # @!attribute display_url
+      #   Display-friendly media URL reported by X.
+      #
+      #   @return [String, nil]
+      optional :display_url, String, api_name: :displayUrl
+
+      # @!attribute duration_millis
+      #   Video duration in milliseconds.
+      #
+      #   @return [Integer, nil]
+      optional :duration_millis, Integer, api_name: :durationMillis
+
+      # @!attribute expanded_url
+      #   Expanded X media URL.
+      #
+      #   @return [String, nil]
+      optional :expanded_url, String, api_name: :expandedUrl
+
+      # @!attribute face_rects
+      #   Face-aware crop rectangles grouped by media size.
+      #
+      #   @return [Hash{Symbol=>Array<XTwitterScraper::Models::TweetMedia::FaceRect>}, nil]
+      optional :face_rects,
+               -> {
+                 XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::FaceRect]]
+               },
+               api_name: :faceRects
+
+      # @!attribute focus_rects
+      #   Suggested image crops reported by X.
+      #
+      #   @return [Array<XTwitterScraper::Models::TweetMedia::FocusRect>, nil]
+      optional :focus_rects,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::FocusRect] },
+               api_name: :focusRects
+
+      # @!attribute height
+      #   Original media height.
+      #
+      #   @return [Integer, nil]
+      optional :height, Integer
+
+      # @!attribute indices
+      #   Media entity offsets in the tweet text.
+      #
+      #   @return [Array<Integer>, nil]
+      optional :indices, XTwitterScraper::Internal::Type::ArrayOf[Integer]
+
+      # @!attribute media_key
+      #   Stable X media key.
+      #
+      #   @return [String, nil]
+      optional :media_key, String, api_name: :mediaKey
+
+      # @!attribute monetizable
+      #   Whether X reports the media as monetizable.
+      #
+      #   @return [Boolean, nil]
+      optional :monetizable, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute sizes
+      #   Named media renditions and resize modes.
+      #
+      #   @return [Hash{Symbol=>XTwitterScraper::Models::TweetMedia::Size}, nil]
+      optional :sizes, -> { XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::TweetMedia::Size] }
+
       # @!attribute video_variants
       #   Available video encodings, ordered as returned
       #
@@ -32,7 +128,13 @@ module XTwitterScraper
                -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::VideoVariant] },
                api_name: :videoVariants
 
-      # @!method initialize(media_url:, type:, url:, video_variants: nil)
+      # @!attribute width
+      #   Original media width.
+      #
+      #   @return [Integer, nil]
+      optional :width, Integer
+
+      # @!method initialize(media_url:, type:, url:, id: nil, allow_download: nil, alt_text: nil, aspect_ratio: nil, availability_status: nil, display_url: nil, duration_millis: nil, expanded_url: nil, face_rects: nil, focus_rects: nil, height: nil, indices: nil, media_key: nil, monetizable: nil, sizes: nil, video_variants: nil, width: nil)
       #   Normalized media attached to a tweet.
       #
       #   @param media_url [String] Media preview URL
@@ -41,7 +143,39 @@ module XTwitterScraper
       #
       #   @param url [String] X media link from the tweet
       #
+      #   @param id [String] X media entity ID.
+      #
+      #   @param allow_download [Boolean] Whether X permits direct media download.
+      #
+      #   @param alt_text [String] Accessibility text supplied for the media.
+      #
+      #   @param aspect_ratio [Array<Integer>] Video aspect ratio as width and height.
+      #
+      #   @param availability_status [String] Media availability state reported by X.
+      #
+      #   @param display_url [String] Display-friendly media URL reported by X.
+      #
+      #   @param duration_millis [Integer] Video duration in milliseconds.
+      #
+      #   @param expanded_url [String] Expanded X media URL.
+      #
+      #   @param face_rects [Hash{Symbol=>Array<XTwitterScraper::Models::TweetMedia::FaceRect>}] Face-aware crop rectangles grouped by media size.
+      #
+      #   @param focus_rects [Array<XTwitterScraper::Models::TweetMedia::FocusRect>] Suggested image crops reported by X.
+      #
+      #   @param height [Integer] Original media height.
+      #
+      #   @param indices [Array<Integer>] Media entity offsets in the tweet text.
+      #
+      #   @param media_key [String] Stable X media key.
+      #
+      #   @param monetizable [Boolean] Whether X reports the media as monetizable.
+      #
+      #   @param sizes [Hash{Symbol=>XTwitterScraper::Models::TweetMedia::Size}] Named media renditions and resize modes.
+      #
       #   @param video_variants [Array<XTwitterScraper::Models::TweetMedia::VideoVariant>] Available video encodings, ordered as returned
+      #
+      #   @param width [Integer] Original media width.
 
       # @see XTwitterScraper::Models::TweetMedia#type
       module Type
@@ -55,6 +189,84 @@ module XTwitterScraper
         #   @return [Array<Symbol>]
       end
 
+      class FaceRect < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute h
+        #
+        #   @return [Integer]
+        required :h, Integer
+
+        # @!attribute w
+        #
+        #   @return [Integer]
+        required :w, Integer
+
+        # @!attribute x
+        #
+        #   @return [Integer]
+        required :x, Integer
+
+        # @!attribute y_
+        #
+        #   @return [Integer]
+        required :y_, Integer, api_name: :y
+
+        # @!method initialize(h:, w:, x:, y_:)
+        #   @param h [Integer]
+        #   @param w [Integer]
+        #   @param x [Integer]
+        #   @param y_ [Integer]
+      end
+
+      class FocusRect < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute h
+        #
+        #   @return [Integer]
+        required :h, Integer
+
+        # @!attribute w
+        #
+        #   @return [Integer]
+        required :w, Integer
+
+        # @!attribute x
+        #
+        #   @return [Integer]
+        required :x, Integer
+
+        # @!attribute y_
+        #
+        #   @return [Integer]
+        required :y_, Integer, api_name: :y
+
+        # @!method initialize(h:, w:, x:, y_:)
+        #   @param h [Integer]
+        #   @param w [Integer]
+        #   @param x [Integer]
+        #   @param y_ [Integer]
+      end
+
+      class Size < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute h
+        #
+        #   @return [Integer]
+        required :h, Integer
+
+        # @!attribute resize
+        #
+        #   @return [String]
+        required :resize, String
+
+        # @!attribute w
+        #
+        #   @return [Integer]
+        required :w, Integer
+
+        # @!method initialize(h:, resize:, w:)
+        #   @param h [Integer]
+        #   @param resize [String]
+        #   @param w [Integer]
+      end
+
       class VideoVariant < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute content_type
         #

data/lib/x_twitter_scraper/models/user_profile.rb

@@ -22,15 +22,23 @@ module XTwitterScraper
       #   @return [String]
       required :username, String
 
+      # @!attribute affiliates_highlighted_label
+      #   Organization affiliation label shown on an X profile.
+      #
+      #   @return [XTwitterScraper::Models::UserProfile::AffiliatesHighlightedLabel, nil]
+      optional :affiliates_highlighted_label,
+               -> { XTwitterScraper::UserProfile::AffiliatesHighlightedLabel },
+               api_name: :affiliatesHighlightedLabel
+
       # @!attribute automated_by
       #
       #   @return [String, nil]
       optional :automated_by, String, api_name: :automatedBy
 
-      # @!attribute can_dm
+      # @!attribute business_account_affiliates_count
       #
-      #   @return [Boolean, nil]
-      optional :can_dm, XTwitterScraper::Internal::Type::Boolean, api_name: :canDm
+      #   @return [Integer, nil]
+      optional :business_account_affiliates_count, Integer, api_name: :businessAccountAffiliatesCount
 
       # @!attribute community_role
       #   Community role when returned by community member reads
@@ -48,6 +56,11 @@ module XTwitterScraper
       #   @return [String, nil]
       optional :created_at, String, api_name: :createdAt
 
+      # @!attribute creator_subscriptions_count
+      #
+      #   @return [Integer, nil]
+      optional :creator_subscriptions_count, Integer, api_name: :creatorSubscriptionsCount
+
       # @!attribute description
       #
       #   @return [String, nil]
@@ -73,6 +86,36 @@ module XTwitterScraper
       #   @return [Boolean, nil]
       optional :has_custom_timelines, XTwitterScraper::Internal::Type::Boolean, api_name: :hasCustomTimelines
 
+      # @!attribute has_graduated_access
+      #
+      #   @return [Boolean, nil]
+      optional :has_graduated_access, XTwitterScraper::Internal::Type::Boolean, api_name: :hasGraduatedAccess
+
+      # @!attribute has_hidden_subscriptions_on_profile
+      #
+      #   @return [Boolean, nil]
+      optional :has_hidden_subscriptions_on_profile,
+               XTwitterScraper::Internal::Type::Boolean,
+               api_name: :hasHiddenSubscriptionsOnProfile
+
+      # @!attribute highlights_info
+      #   Profile highlight availability and count metadata.
+      #
+      #   @return [XTwitterScraper::Models::UserProfile::HighlightsInfo, nil]
+      optional :highlights_info,
+               -> {
+                 XTwitterScraper::UserProfile::HighlightsInfo
+               },
+               api_name: :highlightsInfo
+
+      # @!attribute identity_verification
+      #   Identity verification metadata displayed by X.
+      #
+      #   @return [XTwitterScraper::Models::UserProfile::IdentityVerification, nil]
+      optional :identity_verification,
+               -> { XTwitterScraper::UserProfile::IdentityVerification },
+               api_name: :identityVerification
+
       # @!attribute is_automated
       #
       #   @return [Boolean, nil]
@@ -84,6 +127,13 @@ module XTwitterScraper
       #   @return [Boolean, nil]
       optional :is_blue_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isBlueVerified
 
+      # @!attribute is_profile_translatable
+      #
+      #   @return [Boolean, nil]
+      optional :is_profile_translatable,
+               XTwitterScraper::Internal::Type::Boolean,
+               api_name: :isProfileTranslatable
+
       # @!attribute is_translator
       #
       #   @return [Boolean, nil]
@@ -105,6 +155,11 @@ module XTwitterScraper
       #   @return [Integer, nil]
       optional :media_count, Integer, api_name: :mediaCount
 
+      # @!attribute parody_commentary_fan_label
+      #
+      #   @return [String, nil]
+      optional :parody_commentary_fan_label, String, api_name: :parodyCommentaryFanLabel
+
       # @!attribute pinned_tweet_ids
       #
       #   @return [Array<String>, nil]
@@ -127,11 +182,36 @@ module XTwitterScraper
       #   @return [String, nil]
       optional :profile_banner_url, String, api_name: :profileBannerUrl
 
+      # @!attribute profile_description_language
+      #
+      #   @return [String, nil]
+      optional :profile_description_language, String, api_name: :profileDescriptionLanguage
+
+      # @!attribute profile_image_shape
+      #
+      #   @return [String, nil]
+      optional :profile_image_shape, String, api_name: :profileImageShape
+
+      # @!attribute profile_interstitial_type
+      #
+      #   @return [String, nil]
+      optional :profile_interstitial_type, String, api_name: :profileInterstitialType
+
       # @!attribute profile_picture
       #
       #   @return [String, nil]
       optional :profile_picture, String, api_name: :profilePicture
 
+      # @!attribute profile_sort_enabled
+      #
+      #   @return [Boolean, nil]
+      optional :profile_sort_enabled, XTwitterScraper::Internal::Type::Boolean, api_name: :profileSortEnabled
+
+      # @!attribute profile_translator_type
+      #
+      #   @return [String, nil]
+      optional :profile_translator_type, String, api_name: :profileTranslatorType
+
       # @!attribute protected
       #   Whether the profile protects its posts
       #
@@ -143,6 +223,13 @@ module XTwitterScraper
       #   @return [Integer, nil]
       optional :statuses_count, Integer, api_name: :statusesCount
 
+      # @!attribute super_follow_eligible
+      #
+      #   @return [Boolean, nil]
+      optional :super_follow_eligible,
+               XTwitterScraper::Internal::Type::Boolean,
+               api_name: :superFollowEligible
+
       # @!attribute unavailable
       #
       #   @return [Boolean, nil]
@@ -168,18 +255,6 @@ module XTwitterScraper
       #   @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]
@@ -187,7 +262,7 @@ module XTwitterScraper
                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)
+      # @!method initialize(id:, name:, username:, affiliates_highlighted_label: nil, automated_by: nil, business_account_affiliates_count: nil, community_role: nil, cover_picture: nil, created_at: nil, creator_subscriptions_count: nil, description: nil, favourites_count: nil, followers: nil, following: nil, has_custom_timelines: nil, has_graduated_access: nil, has_hidden_subscriptions_on_profile: nil, highlights_info: nil, identity_verification: nil, is_automated: nil, is_blue_verified: nil, is_profile_translatable: nil, is_translator: nil, is_verified: nil, location: nil, media_count: nil, parody_commentary_fan_label: nil, pinned_tweet_ids: nil, possibly_sensitive: nil, profile_bio: nil, profile_banner_url: nil, profile_description_language: nil, profile_image_shape: nil, profile_interstitial_type: nil, profile_picture: nil, profile_sort_enabled: nil, profile_translator_type: nil, protected: nil, statuses_count: nil, super_follow_eligible: nil, unavailable: nil, unavailable_reason: nil, url: nil, verified: nil, verified_type: nil, withheld_in_countries: nil)
       #   X user profile with bio, follower counts, and verification status.
       #
       #   @param id [String]
@@ -196,9 +271,11 @@ module XTwitterScraper
       #
       #   @param username [String]
       #
+      #   @param affiliates_highlighted_label [XTwitterScraper::Models::UserProfile::AffiliatesHighlightedLabel] Organization affiliation label shown on an X profile.
+      #
       #   @param automated_by [String]
       #
-      #   @param can_dm [Boolean]
+      #   @param business_account_affiliates_count [Integer]
       #
       #   @param community_role [String] Community role when returned by community member reads
       #
@@ -206,6 +283,8 @@ module XTwitterScraper
       #
       #   @param created_at [String]
       #
+      #   @param creator_subscriptions_count [Integer]
+      #
       #   @param description [String]
       #
       #   @param favourites_count [Integer]
@@ -216,10 +295,20 @@ module XTwitterScraper
       #
       #   @param has_custom_timelines [Boolean]
       #
+      #   @param has_graduated_access [Boolean]
+      #
+      #   @param has_hidden_subscriptions_on_profile [Boolean]
+      #
+      #   @param highlights_info [XTwitterScraper::Models::UserProfile::HighlightsInfo] Profile highlight availability and count metadata.
+      #
+      #   @param identity_verification [XTwitterScraper::Models::UserProfile::IdentityVerification] Identity verification metadata displayed by X.
+      #
       #   @param is_automated [Boolean]
       #
       #   @param is_blue_verified [Boolean] Whether X shows a blue verification badge
       #
+      #   @param is_profile_translatable [Boolean]
+      #
       #   @param is_translator [Boolean]
       #
       #   @param is_verified [Boolean] Whether X marks the profile as verified
@@ -228,6 +317,8 @@ module XTwitterScraper
       #
       #   @param media_count [Integer]
       #
+      #   @param parody_commentary_fan_label [String]
+      #
       #   @param pinned_tweet_ids [Array<String>]
       #
       #   @param possibly_sensitive [Boolean]
@@ -236,12 +327,24 @@ module XTwitterScraper
       #
       #   @param profile_banner_url [String] Original X profile banner field when available
       #
+      #   @param profile_description_language [String]
+      #
+      #   @param profile_image_shape [String]
+      #
+      #   @param profile_interstitial_type [String]
+      #
       #   @param profile_picture [String]
       #
+      #   @param profile_sort_enabled [Boolean]
+      #
+      #   @param profile_translator_type [String]
+      #
       #   @param protected [Boolean] Whether the profile protects its posts
       #
       #   @param statuses_count [Integer]
       #
+      #   @param super_follow_eligible [Boolean]
+      #
       #   @param unavailable [Boolean]
       #
       #   @param unavailable_reason [String]
@@ -252,11 +355,98 @@ module XTwitterScraper
       #
       #   @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>]
+
+      # @see XTwitterScraper::Models::UserProfile#affiliates_highlighted_label
+      class AffiliatesHighlightedLabel < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute badge_url
+        #
+        #   @return [String, nil]
+        optional :badge_url, String, api_name: :badgeUrl
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!attribute url_type
+        #
+        #   @return [String, nil]
+        optional :url_type, String, api_name: :urlType
+
+        # @!attribute user_label_display_type
+        #
+        #   @return [String, nil]
+        optional :user_label_display_type, String, api_name: :userLabelDisplayType
+
+        # @!attribute user_label_type
+        #
+        #   @return [String, nil]
+        optional :user_label_type, String, api_name: :userLabelType
+
+        # @!method initialize(badge_url: nil, description: nil, url: nil, url_type: nil, user_label_display_type: nil, user_label_type: nil)
+        #   Organization affiliation label shown on an X profile.
+        #
+        #   @param badge_url [String]
+        #   @param description [String]
+        #   @param url [String]
+        #   @param url_type [String]
+        #   @param user_label_display_type [String]
+        #   @param user_label_type [String]
+      end
+
+      # @see XTwitterScraper::Models::UserProfile#highlights_info
+      class HighlightsInfo < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute can_highlight_tweets
+        #
+        #   @return [Boolean, nil]
+        optional :can_highlight_tweets,
+                 XTwitterScraper::Internal::Type::Boolean,
+                 api_name: :canHighlightTweets
+
+        # @!attribute highlighted_tweets
+        #
+        #   @return [String, nil]
+        optional :highlighted_tweets, String, api_name: :highlightedTweets
+
+        # @!method initialize(can_highlight_tweets: nil, highlighted_tweets: nil)
+        #   Profile highlight availability and count metadata.
+        #
+        #   @param can_highlight_tweets [Boolean]
+        #   @param highlighted_tweets [String]
+      end
+
+      # @see XTwitterScraper::Models::UserProfile#identity_verification
+      class IdentityVerification < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute is_identity_verified
+        #
+        #   @return [Boolean, nil]
+        optional :is_identity_verified,
+                 XTwitterScraper::Internal::Type::Boolean,
+                 api_name: :isIdentityVerified
+
+        # @!attribute verified_since_msec
+        #
+        #   @return [String, nil]
+        optional :verified_since_msec, String, api_name: :verifiedSinceMsec
+
+        # @!method initialize(description: nil, is_identity_verified: nil, verified_since_msec: nil)
+        #   Identity verification metadata displayed by X.
+        #
+        #   @param description [String]
+        #   @param is_identity_verified [Boolean]
+        #   @param verified_since_msec [String]
+      end
     end
   end
 end