Class: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account

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

Overview

See Also:

  • WhopSDK::Models::Referrals::BusinessRetrieveResponse#account

Defined Under Namespace

Classes: Capabilities, RecommendedAction, RequiredAction

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(id:, capabilities:, logo_url:, recommended_actions:, required_actions:, route:, title:) ⇒ Object

Referred account.

Parameters:




# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 168

Instance Attribute Details

#capabilities ⇒ WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities?

Parameters:

Returns:



130
131
132
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 130

required :capabilities,
-> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities },
nil?: true

#id ⇒ String

Referred account ID.

Parameters:

  • value (String)

Returns:

  • (String) 


125
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 125

required :id, String

#logo_url ⇒ String?

Referred account logo URL.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


138
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 138

required :logo_url, String, nil?: true

#recommended_actions ⇒ Array<WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction>?

Optional actions that unlock capabilities or grow the referred account.

Parameters:

Returns:



144
145
146
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 144

required :recommended_actions,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction] },
nil?: true

#required_actions ⇒ Array<WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction>?

Actions the referred account owner must take to unblock capabilities.

Parameters:

Returns:



152
153
154
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 152

required :required_actions,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction] },
nil?: true

#route ⇒ String

Referred account route.

Parameters:

  • value (String)

Returns:

  • (String) 


160
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 160

required :route, String

#title ⇒ String

Referred account display name.

Parameters:

  • value (String)

Returns:

  • (String) 


166
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 166

required :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 437

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


116
 
# File 'sig/whop_sdk/models/referrals/business_retrieve_response.rbs', line 116

def to_hash: -> {