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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction

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

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

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

• #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^?

  Illustration icon URL, or null.

• #impact_score ⇒ Integer^?

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

• #reasoning ⇒ String^?

  Why this action was recommended for this account, or null.

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

  Always optional — never blocking.

• #title ⇒ String

  Headline for the recommendation.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(action:, blocked_capabilities:, cta:, cta_label:, description:, icon_url:, impact_score:, reasoning:, status:, title:) ⇒ Object constructor

  Some parameter documentations has been truncated, see RecommendedAction for more details.

• #to_hash ⇒ {

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

Parameters:

• action (Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::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::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status) —

  Always optional — never blocking

• title (String) —

  Headline for the recommendation

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

Instance Attribute Details

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

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

Parameters:

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

Returns:

• (Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action)

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

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

#blocked_capabilities ⇒ Array<String>

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

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

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

#cta ⇒ String

The URL the call-to-action links to

Parameters:

• value (String)

Returns:

• (String)

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

required :cta, String

#cta_label ⇒ String

Button label

Parameters:

• value (String)

Returns:

• (String)

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

required :cta_label, String

#description ⇒ String

Supporting copy, or empty

Parameters:

• value (String)

Returns:

• (String)

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

required :description, String

#icon_url ⇒ String^?

Illustration icon URL, or null

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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)

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

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)

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

required :reasoning, String, nil?: true

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

Always optional — never blocking

Parameters:

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

Returns:

• (Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status)

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

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

#title ⇒ String

Headline for the recommendation

Parameters:

• value (String)

Returns:

• (String)

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

required :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {