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

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

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::Referrals::BusinessRetrieveResponse::Account::RequiredAction for more details.

Parameters:




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

Instance Attribute Details

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

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

Parameters:

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

Returns:



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

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

#blocked_capabilities ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


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

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) 


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

required :cta, String, nil?: true

#cta_label ⇒ String

Button label, or empty when there is no button

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :cta_label, String

#description ⇒ String

Supporting copy, or empty

Parameters:

  • value (String)

Returns:

  • (String) 


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

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) 


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

required :icon_url, String, nil?: true

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

required (act now) or pending (under review)

Parameters:

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

Returns:



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

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

#title ⇒ String

Headline for the action

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {