Class: XTwitterScraper::Models::CreditRetrieveBalanceResponse

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

Overview

See Also:

  • XTwitterScraper::Resources::Credits#retrieve_balance

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(auto_topup_amount_dollars:, auto_topup_enabled:, auto_topup_threshold:, balance:, lifetime_purchased:, lifetime_used:) ⇒ Object

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

Parameters:

  • auto_topup_amount_dollars (Float) —

    Configured dollar amount for each automatic top-up.

  • auto_topup_enabled (Boolean)
  • auto_topup_threshold (String) —

    Credit balance threshold that triggers automatic top-up when enabled, represente

  • balance (String) —

    Current credit balance as a bigint string to preserve precision above Number.MAX

  • lifetime_purchased (String) —

    Lifetime purchased credits as a bigint string.

  • lifetime_used (String) —

    Lifetime consumed credits as a bigint string.




# File 'lib/x_twitter_scraper/models/credit_retrieve_balance_response.rb', line 48

Instance Attribute Details

#auto_topup_amount_dollars ⇒ Float

Configured dollar amount for each automatic top-up.

Parameters:

  • value (Float)

Returns:

  • (Float) 


15
 
# File 'lib/x_twitter_scraper/models/credit_retrieve_balance_response.rb', line 15

required :auto_topup_amount_dollars, Float

#auto_topup_enabled ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


20
 
# File 'lib/x_twitter_scraper/models/credit_retrieve_balance_response.rb', line 20

required :auto_topup_enabled, XTwitterScraper::Internal::Type::Boolean

#auto_topup_threshold ⇒ String

Credit balance threshold that triggers automatic top-up when enabled, represented as a bigint string.

Parameters:

  • value (String)

Returns:

  • (String) 


27
 
# File 'lib/x_twitter_scraper/models/credit_retrieve_balance_response.rb', line 27

required :auto_topup_threshold, String

#balance ⇒ String

Current credit balance as a bigint string to preserve precision above Number.MAX_SAFE_INTEGER.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :balance, String

#lifetime_purchased ⇒ String

Lifetime purchased credits as a bigint string.

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/x_twitter_scraper/models/credit_retrieve_balance_response.rb', line 40

required :lifetime_purchased, String

#lifetime_used ⇒ String

Lifetime consumed credits as a bigint string.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :lifetime_used, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/x_twitter_scraper/models/credit_retrieve_balance_response.rbs', line 39

def to_hash: -> {