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

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::Resources::Referrals::Businesses#retrieve

Defined Under Namespace

Modules: MyPartnerTier, Object, Status Classes: Account, EarningsUsd, FirstTierPartner, Owner, VolumeUsd

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(url:) ⇒ Object

The user's profile picture.

Parameters:

  • url (String) —

    The user's profile picture URL.




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

Instance Attribute Details

#account ⇒ WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account?

Referred account.

Parameters:

Returns:



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

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

#created_at ⇒ Time

When the business referral was created.

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#earnings_usd ⇒ WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd

Parameters:

Returns:



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

required :earnings_usd, -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd }

#first_tier_partner ⇒ WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner?

The partner who referred the business owner onto Whop (first tier). Null if there is no active first-tier partner.

Parameters:

Returns:



36
37
38
 
# File 'lib/whop_sdk/models/referrals/business_retrieve_response.rb', line 36

required :first_tier_partner,
-> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner },
nil?: true

#id ⇒ String

Business referral ID.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#my_partner_tier ⇒ Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier

Which tier the caller earns on for this business: first (they referred the owner) or second (they referred the first-tier partner).

Parameters:

  • value (WhopSDK::Models::Referrals::BusinessRetrieveResponse::my_partner_tier)

Returns:



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

required :my_partner_tier,
enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier }

#object ⇒ Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object

Parameters:

  • value (WhopSDK::Models::Referrals::BusinessRetrieveResponse::object)

Returns:



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

required :object, enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object }

#owner ⇒ WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner?

The owner of the referred business.

Parameters:

Returns:



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

required :owner, -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner }, nil?: true

#payout_percentage ⇒ Float

Referrer's share of Whop gross profit, as a fraction (0.3 = 30%). Second-tier referrals earn a flat 0.1.

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :payout_percentage, Float

#referral_expires_at ⇒ Time?

When the referral expires.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


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

required :referral_expires_at, Time, nil?: true

#referral_started_at ⇒ Time?

When the referral became active.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


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

required :referral_started_at, Time, nil?: true

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

Current referral status.

Parameters:

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

Returns:



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

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

#volume_usd ⇒ WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd

Parameters:

Returns:



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

required :volume_usd, -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {