Class: XTwitterScraper::Models::X::XAccount

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/x_twitter_scraper/models/x/x_account.rb,
sig/x_twitter_scraper/models/x/x_account.rbs

Defined Under Namespace

Modules: Health

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id:, created_at:, health:, status:, updated_at:, x_user_id:, x_username:, cookies_obtained_at: nil) ⇒ Object

Some parameter documentations has been truncated, see XTwitterScraper::Models::X::XAccount for more details.

Linked X account summary with connection status, health, and timestamp metadata.

Parameters:

  • id (String)
  • created_at (Time)
  • health (Symbol, XTwitterScraper::Models::X::XAccount::Health) —

    Derived connection health. healthy = session active. needsReauth = user must

  • status (String)
  • updated_at (Time)
  • x_user_id (String)
  • x_username (String)
  • cookies_obtained_at (Time) (defaults to: nil) 



# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 56

Instance Attribute Details

#cookies_obtained_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


54
 
# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 54

optional :cookies_obtained_at, Time, api_name: :cookiesObtainedAt

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


19
 
# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 19

required :created_at, Time, api_name: :createdAt

#health ⇒ Symbol, XTwitterScraper::Models::X::XAccount::Health

Derived connection health. healthy = session active. needsReauth = user must submit fresh credentials. locked = X locked the account; unlock on x.com first. suspended = X banned the account. recovering = past cooldown, will auto-retry on next use. temporaryIssue = temporary connection problem; retry shortly.

Parameters:

  • value (XTwitterScraper::Models::X::XAccount::health)

Returns:



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

required :health, enum: -> { XTwitterScraper::X::XAccount::Health }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 14

required :id, String

#status ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


34
 
# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 34

required :status, String

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


39
 
# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 39

required :updated_at, Time, api_name: :updatedAt

#x_user_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


44
 
# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 44

required :x_user_id, String, api_name: :xUserId

#x_username ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


49
 
# File 'lib/x_twitter_scraper/models/x/x_account.rb', line 49

required :x_username, String, api_name: :xUsername

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


52
 
# File 'sig/x_twitter_scraper/models/x/x_account.rbs', line 52

def to_hash: -> {