Class: WhopSDK::Models::Account::RecommendedAction

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:, impact_score:, reasoning:, status:, title:) ⇒ Object

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

Deprecated: use the GET /accounts/{account_id}/recommend_actions endpoint instead. Optional actions that unlock capabilities or grow the account, same shape as required_actions. Computed only on retrieve and me; null otherwise.

Parameters:

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

    The recommendation; new values may be added, so handle unknown actions gracefull

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

    The URL the call-to-action links to

  • cta_label (String) —

    Button label

  • description (String) —

    Supporting copy, or empty

  • icon_url (String, nil) —

    Illustration icon URL, or null

  • impact_score (Integer, nil) —

    Estimated revenue impact from 0-100, comparable across accounts, or null when

  • reasoning (String, nil) —

    Why this action was recommended for this account, or null

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

    Always optional — never blocking

  • title (String) —

    Headline for the recommendation




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

Instance Attribute Details

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

The recommendation; new values may be added, so handle unknown actions gracefully

Parameters:

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

Returns:



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

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

#blocked_capabilities ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


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

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

#cta ⇒ String

The URL the call-to-action links to

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :cta, String

#cta_label ⇒ String

Button label

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :cta_label, String

#description ⇒ String

Supporting copy, or empty

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :description, String

#icon_url ⇒ String?

Illustration icon URL, or null

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :icon_url, String, nil?: true

#impact_score ⇒ Integer?

Estimated revenue impact from 0-100, comparable across accounts, or null when not ranked

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

required :impact_score, Integer, nil?: true

#reasoning ⇒ String?

Why this action was recommended for this account, or null

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :reasoning, String, nil?: true

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

Always optional — never blocking

Parameters:

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

Returns:



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

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

#title ⇒ String

Headline for the recommendation

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {