Class: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me

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

Overview

See Also:

  • WhopSDK::Models::Referrals::BusinessLeaderboardResponse#me

Defined Under Namespace

Classes: User

Instance Attribute 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(first_referral_started_at:, rank:, total_earnings_usd:, total_volume_usd:, user:) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me for more details.

The caller's own standing; null when the caller has no referral earnings.

Parameters:

  • first_referral_started_at (Time) —

    When the referrer's earliest business referral became active.

  • rank (Integer) —

    1-based leaderboard position.

  • total_earnings_usd (String) —

    The referrer's pending + completed earnings across all referred businesses, in U

  • total_volume_usd (String) —

    Credited GMV across all the referrer's referred businesses, in USD.

  • user (WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User, nil) —

    The ranked referrer. Identity fields (id, name, username, profile_picture) are r




# File 'lib/whop_sdk/models/referrals/business_leaderboard_response.rb', line 188

Instance Attribute Details

#first_referral_started_at ⇒ Time

When the referrer's earliest business referral became active.

Parameters:

  • value (Time)

Returns:

  • (Time) 


159
 
# File 'lib/whop_sdk/models/referrals/business_leaderboard_response.rb', line 159

required :first_referral_started_at, Time

#rank ⇒ Integer

1-based leaderboard position.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


165
 
# File 'lib/whop_sdk/models/referrals/business_leaderboard_response.rb', line 165

required :rank, Integer

#total_earnings_usd ⇒ String

The referrer's pending + completed earnings across all referred businesses, in USD.

Parameters:

  • value (String)

Returns:

  • (String) 


172
 
# File 'lib/whop_sdk/models/referrals/business_leaderboard_response.rb', line 172

required :total_earnings_usd, String

#total_volume_usd ⇒ String

Credited GMV across all the referrer's referred businesses, in USD.

Parameters:

  • value (String)

Returns:

  • (String) 


178
 
# File 'lib/whop_sdk/models/referrals/business_leaderboard_response.rb', line 178

required :total_volume_usd, String

#user ⇒ WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User?

The ranked referrer. Identity fields (id, name, username, profile_picture) are returned only on the caller's own entry; other referrers expose coarse location only.

Parameters:

Returns:



186
 
# File 'lib/whop_sdk/models/referrals/business_leaderboard_response.rb', line 186

required :user, -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


150
 
# File 'sig/whop_sdk/models/referrals/business_leaderboard_response.rbs', line 150

def to_hash: -> {