Class: XTwitterScraper::Models::UserProfile

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::UserProfile

Defined in:

lib/x_twitter_scraper/models/user_profile.rb,
sig/x_twitter_scraper/models/user_profile.rbs

Direct Known Subclasses

X::TweetAuthor

Defined Under Namespace

Classes: AffiliatesHighlightedLabel, HighlightsInfo, IdentityVerification

Instance Attribute Summary

• #affiliates_highlighted_label ⇒ XTwitterScraper::Models::UserProfile::AffiliatesHighlightedLabel^?

  Organization affiliation label shown on an X profile.

• #automated_by ⇒ String^?
• #business_account_affiliates_count ⇒ Integer^?
• #community_role ⇒ String^?

  Community role when returned by community member reads.

• #cover_picture ⇒ String^?
• #created_at ⇒ String^?
• #creator_subscriptions_count ⇒ Integer^?
• #description ⇒ String^?
• #favourites_count ⇒ Integer^?
• #followers ⇒ Integer^?
• #following ⇒ Integer^?
• #has_custom_timelines ⇒ Boolean^?
• #has_graduated_access ⇒ Boolean^?
• #has_hidden_subscriptions_on_profile ⇒ Boolean^?
• #highlights_info ⇒ XTwitterScraper::Models::UserProfile::HighlightsInfo^?

  Profile highlight availability and count metadata.

• #id ⇒ String
• #identity_verification ⇒ XTwitterScraper::Models::UserProfile::IdentityVerification^?

  Identity verification metadata displayed by X.

• #is_automated ⇒ Boolean^?
• #is_blue_verified ⇒ Boolean^?

  Whether X shows a blue verification badge.

• #is_profile_translatable ⇒ Boolean^?
• #is_translator ⇒ Boolean^?
• #is_verified ⇒ Boolean^?

  Whether X marks the profile as verified.

• #location ⇒ String^?
• #media_count ⇒ Integer^?
• #name ⇒ String
• #parody_commentary_fan_label ⇒ String^?
• #pinned_tweet_ids ⇒ Array<String>^?
• #possibly_sensitive ⇒ Boolean^?
• #profile_banner_url ⇒ String^?

  Original X profile banner field when available.

• #profile_bio ⇒ Hash{Symbol=>Object}^?

  Structured profile bio with entity annotations.

• #profile_description_language ⇒ String^?
• #profile_image_shape ⇒ String^?
• #profile_interstitial_type ⇒ String^?
• #profile_picture ⇒ String^?
• #profile_sort_enabled ⇒ Boolean^?
• #profile_translator_type ⇒ String^?
• #protected ⇒ Boolean^?

  Whether the profile protects its posts.

• #statuses_count ⇒ Integer^?
• #super_follow_eligible ⇒ Boolean^?
• #unavailable ⇒ Boolean^?
• #unavailable_reason ⇒ String^?
• #url ⇒ String^?
• #username ⇒ String
• #verified ⇒ Boolean^?
• #verified_type ⇒ String^?
• #withheld_in_countries ⇒ Array<String>^?

Instance Method Summary

• #initialize(can_highlight_tweets: nil, highlighted_tweets: nil) ⇒ Object constructor

  Profile highlight availability and count metadata.

• #to_hash ⇒ ::Hash[Symbol, top]

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(can_highlight_tweets: nil, highlighted_tweets: nil) ⇒ Object

Profile highlight availability and count metadata.

Parameters:

• can_highlight_tweets (Boolean) (defaults to: nil)
• highlighted_tweets (String) (defaults to: nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 265

Instance Attribute Details

#affiliates_highlighted_label ⇒ XTwitterScraper::Models::UserProfile::AffiliatesHighlightedLabel^?

Organization affiliation label shown on an X profile.

Returns:

• (XTwitterScraper::Models::UserProfile::AffiliatesHighlightedLabel, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 29

optional :affiliates_highlighted_label,
-> { XTwitterScraper::UserProfile::AffiliatesHighlightedLabel },
api_name: :affiliatesHighlightedLabel

#automated_by ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 36

optional :automated_by, String, api_name: :automatedBy

#business_account_affiliates_count ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 41

optional :business_account_affiliates_count, Integer, api_name: :businessAccountAffiliatesCount

#community_role ⇒ String^?

Community role when returned by community member reads

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 47

optional :community_role, String, api_name: :communityRole

#cover_picture ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 52

optional :cover_picture, String, api_name: :coverPicture

#created_at ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 57

optional :created_at, String, api_name: :createdAt

#creator_subscriptions_count ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 62

optional :creator_subscriptions_count, Integer, api_name: :creatorSubscriptionsCount

#description ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 67

optional :description, String

#favourites_count ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 72

optional :favourites_count, Integer, api_name: :favouritesCount

#followers ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 77

optional :followers, Integer

#following ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 82

optional :following, Integer

#has_custom_timelines ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 87

optional :has_custom_timelines, XTwitterScraper::Internal::Type::Boolean, api_name: :hasCustomTimelines

#has_graduated_access ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 92

optional :has_graduated_access, XTwitterScraper::Internal::Type::Boolean, api_name: :hasGraduatedAccess

#has_hidden_subscriptions_on_profile ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 97

optional :has_hidden_subscriptions_on_profile,
XTwitterScraper::Internal::Type::Boolean,
api_name: :hasHiddenSubscriptionsOnProfile

#highlights_info ⇒ XTwitterScraper::Models::UserProfile::HighlightsInfo^?

Profile highlight availability and count metadata.

Returns:

• (XTwitterScraper::Models::UserProfile::HighlightsInfo, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 105

optional :highlights_info,
-> {
  XTwitterScraper::UserProfile::HighlightsInfo
},
api_name: :highlightsInfo

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 13

required :id, String

#identity_verification ⇒ XTwitterScraper::Models::UserProfile::IdentityVerification^?

Identity verification metadata displayed by X.

Returns:

• (XTwitterScraper::Models::UserProfile::IdentityVerification, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 115

optional :identity_verification,
-> { XTwitterScraper::UserProfile::IdentityVerification },
api_name: :identityVerification

#is_automated ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 122

optional :is_automated, XTwitterScraper::Internal::Type::Boolean, api_name: :isAutomated

#is_blue_verified ⇒ Boolean^?

Whether X shows a blue verification badge

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 128

optional :is_blue_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isBlueVerified

#is_profile_translatable ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 133

optional :is_profile_translatable,
XTwitterScraper::Internal::Type::Boolean,
api_name: :isProfileTranslatable

#is_translator ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 140

optional :is_translator, XTwitterScraper::Internal::Type::Boolean, api_name: :isTranslator

#is_verified ⇒ Boolean^?

Whether X marks the profile as verified

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 146

optional :is_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isVerified

#location ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 151

optional :location, String

#media_count ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 156

optional :media_count, Integer, api_name: :mediaCount

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 18

required :name, String

#parody_commentary_fan_label ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 161

optional :parody_commentary_fan_label, String, api_name: :parodyCommentaryFanLabel

#pinned_tweet_ids ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 166

optional :pinned_tweet_ids, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :pinnedTweetIds

#possibly_sensitive ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 171

optional :possibly_sensitive, XTwitterScraper::Internal::Type::Boolean, api_name: :possiblySensitive

#profile_banner_url ⇒ String^?

Original X profile banner field when available

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 183

optional :profile_banner_url, String, api_name: :profileBannerUrl

#profile_bio ⇒ Hash{Symbol=>Object}^?

Structured profile bio with entity annotations

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 177

optional :profile_bio, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#profile_description_language ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 188

optional :profile_description_language, String, api_name: :profileDescriptionLanguage

#profile_image_shape ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 193

optional :profile_image_shape, String, api_name: :profileImageShape

#profile_interstitial_type ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 198

optional :profile_interstitial_type, String, api_name: :profileInterstitialType

#profile_picture ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 203

optional :profile_picture, String, api_name: :profilePicture

#profile_sort_enabled ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 208

optional :profile_sort_enabled, XTwitterScraper::Internal::Type::Boolean, api_name: :profileSortEnabled

#profile_translator_type ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 213

optional :profile_translator_type, String, api_name: :profileTranslatorType

#protected ⇒ Boolean^?

Whether the profile protects its posts

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 219

optional :protected, XTwitterScraper::Internal::Type::Boolean

#statuses_count ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 224

optional :statuses_count, Integer, api_name: :statusesCount

#super_follow_eligible ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 229

optional :super_follow_eligible,
XTwitterScraper::Internal::Type::Boolean,
api_name: :superFollowEligible

#unavailable ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 236

optional :unavailable, XTwitterScraper::Internal::Type::Boolean

#unavailable_reason ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 241

optional :unavailable_reason, String, api_name: :unavailableReason

#url ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 246

optional :url, String

#username ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 23

required :username, String

#verified ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 251

optional :verified, XTwitterScraper::Internal::Type::Boolean

#verified_type ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 256

optional :verified_type, String, api_name: :verifiedType

#withheld_in_countries ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/x_twitter_scraper/models/user_profile.rb', line 261

optional :withheld_in_countries,
XTwitterScraper::Internal::Type::ArrayOf[String],
api_name: :withheldInCountries

Instance Method Details

#to_hash ⇒ ::Hash[Symbol, top]

Returns:

• (::Hash[Symbol, top])

# File 'sig/x_twitter_scraper/models/user_profile.rbs', line 243

def to_hash: -> ::Hash[Symbol, top]