Class: XTwitterScraper::Models::AccountRetrieveResponse

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

Overview

See Also:

  • XTwitterScraper::Resources::Account#retrieve

Defined Under Namespace

Modules: Plan Classes: CreditInfo, MonitorBilling

Instance Attribute Summary collapse

Class Method 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(active_daily_estimate:, active_hourly_burn:, credits_per_active_monitor_day:, credits_per_active_monitor_hour:, events_included:, instant_check_interval_seconds:, unlimited_slots:) ⇒ Object

Parameters:

  • active_daily_estimate (String) —

    Estimated daily credits for currently active monitors.

  • active_hourly_burn (String) —

    Credits charged each hour for currently active monitors.

  • credits_per_active_monitor_day (String) —

    Estimated daily credits for 1 active instant monitor.

  • credits_per_active_monitor_hour (String) —

    Hourly credits charged for 1 active instant monitor.

  • events_included (Boolean) —

    Webhook and event deliveries are included in monitor billing.

  • instant_check_interval_seconds (Integer) —

    Active monitors check every 1 second.

  • unlimited_slots (Boolean) —

    Monitor slot count is unlimited.




# File 'lib/x_twitter_scraper/models/account_retrieve_response.rb', line 46

Instance Attribute Details

#credit_info ⇒ XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo?

Returns:



36
37
38
 
# File 'lib/x_twitter_scraper/models/account_retrieve_response.rb', line 36

optional :credit_info,
-> { XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo },
api_name: :creditInfo

#monitor_billing ⇒ XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling

Parameters:

Returns:



10
11
12
 
# File 'lib/x_twitter_scraper/models/account_retrieve_response.rb', line 10

required :monitor_billing,
-> { XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling },
api_name: :monitorBilling

#monitors_allowed ⇒ Integer

Deprecated.

Monitor slots are unlimited. Use monitorBilling.unlimitedSlots instead.

Deprecated. Monitor slots are unlimited, so this is always Number.MAX_SAFE_INTEGER.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


21
 
# File 'lib/x_twitter_scraper/models/account_retrieve_response.rb', line 21

required :monitors_allowed, Integer, api_name: :monitorsAllowed

#monitors_used ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


26
 
# File 'lib/x_twitter_scraper/models/account_retrieve_response.rb', line 26

required :monitors_used, Integer, api_name: :monitorsUsed

#plan ⇒ Symbol, XTwitterScraper::Models::AccountRetrieveResponse::Plan

Parameters:

  • value (XTwitterScraper::Models::AccountRetrieveResponse::plan)

Returns:



31
 
# File 'lib/x_twitter_scraper/models/account_retrieve_response.rb', line 31

required :plan, enum: -> { XTwitterScraper::Models::AccountRetrieveResponse::Plan }

#x_username ⇒ String?

Linked X username, omitted when no X account is connected.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :x_username, String, api_name: :xUsername

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/account_retrieve_response.rb', line 129

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


41
 
# File 'sig/x_twitter_scraper/models/account_retrieve_response.rbs', line 41

def to_hash: -> {