Class: WhopSDK::Models::Account::RequiredAction

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

Defined Under Namespace

Modules: Action, Status

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(action:, blocked_capabilities:, cta:, cta_label:, description:, icon_url:, status:, title:) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::Account::RequiredAction for more details.

Actions the account owner must take to unblock capabilities like payouts and card spend, ordered by display priority. Computed only on retrieve and me for callers with company:balance:read scope; null otherwise.

Parameters:

  • action (Symbol, WhopSDK::Models::Account::RequiredAction::Action) —

    What the holder must do; new values may be added, so handle unknown actions grac

  • blocked_capabilities (Array<String>)
  • cta (String, nil) —

    The URL the call-to-action links to, or null when there is no button

  • cta_label (String) —

    Button label, or empty when there is no button

  • description (String) —

    Supporting copy, or empty

  • icon_url (String, nil) —

    The URL of the action's illustration icon, or null if it has none

  • status (Symbol, WhopSDK::Models::Account::RequiredAction::Status) —

    required (act now) or pending (under review)

  • title (String) —

    Headline for the action




# File 'lib/whop_sdk/models/account.rb', line 868

Instance Attribute Details

#action ⇒ Symbol, WhopSDK::Models::Account::RequiredAction::Action

What the holder must do; new values may be added, so handle unknown actions gracefully

Parameters:

  • value (WhopSDK::Models::Account::RequiredAction::action)

Returns:



825
 
# File 'lib/whop_sdk/models/account.rb', line 825

required :action, enum: -> { WhopSDK::Account::RequiredAction::Action }

#blocked_capabilities ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


830
 
# File 'lib/whop_sdk/models/account.rb', line 830

required :blocked_capabilities, WhopSDK::Internal::Type::ArrayOf[String]

#cta ⇒ String?

The URL the call-to-action links to, or null when there is no button

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


836
 
# File 'lib/whop_sdk/models/account.rb', line 836

required :cta, String, nil?: true

#cta_label ⇒ String

Button label, or empty when there is no button

Parameters:

  • value (String)

Returns:

  • (String) 


842
 
# File 'lib/whop_sdk/models/account.rb', line 842

required :cta_label, String

#description ⇒ String

Supporting copy, or empty

Parameters:

  • value (String)

Returns:

  • (String) 


848
 
# File 'lib/whop_sdk/models/account.rb', line 848

required :description, String

#icon_url ⇒ String?

The URL of the action's illustration icon, or null if it has none

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


854
 
# File 'lib/whop_sdk/models/account.rb', line 854

required :icon_url, String, nil?: true

#status ⇒ Symbol, WhopSDK::Models::Account::RequiredAction::Status

required (act now) or pending (under review)

Parameters:

  • value (WhopSDK::Models::Account::RequiredAction::status)

Returns:



860
 
# File 'lib/whop_sdk/models/account.rb', line 860

required :status, enum: -> { WhopSDK::Account::RequiredAction::Status }

#title ⇒ String

Headline for the action

Parameters:

  • value (String)

Returns:

  • (String) 


866
 
# File 'lib/whop_sdk/models/account.rb', line 866

required :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/account.rb', line 904

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


626
 
# File 'sig/whop_sdk/models/account.rbs', line 626

def to_hash: -> {