Class: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User

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::Leader#user

Defined Under Namespace

Classes: ProfilePicture

Instance Attribute Summary

• #city ⇒ String^?

  The city where the referrer is located, derived from their IP address.

• #country ⇒ String^?

  The country where the referrer is located, derived from their IP address.

• #id ⇒ String^?

  User ID, prefixed user_.

• #name ⇒ String^?

  The user's display name.

• #profile_picture ⇒ WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture^?

  The user's profile picture.

• #username ⇒ String^?

  The user's unique username.

Instance Method Summary

• #initialize(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see User 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(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil) ⇒ Object

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

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:

• city (String, nil) —

  The city where the referrer is located, derived from their IP address. Null if l

• country (String, nil) —

  The country where the referrer is located, derived from their IP address. Null i

• id (String) (defaults to: nil) —

  User ID, prefixed user_. Present only on the caller's own entry.

• name (String, nil) (defaults to: nil) —

  The user's display name. Present only on the caller's own entry.

• profile_picture (WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture) (defaults to: nil) —

  The user's profile picture. Present only on the caller's own entry.

• username (String) (defaults to: nil) —

  The user's unique username. Present only on the caller's own entry.

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

Instance Attribute Details

#city ⇒ String^?

The city where the referrer is located, derived from their IP address. Null if location sharing is disabled.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :city, String, nil?: true

#country ⇒ String^?

The country where the referrer is located, derived from their IP address. Null if location sharing is disabled.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :country, String, nil?: true

#id ⇒ String^?

User ID, prefixed user_. Present only on the caller's own entry.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :id, String

#name ⇒ String^?

The user's display name. Present only on the caller's own entry.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :name, String, nil?: true

#profile_picture ⇒ WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture^?

The user's profile picture. Present only on the caller's own entry.

Returns:

• (WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, nil)

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

optional :profile_picture,
-> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture }

#username ⇒ String^?

The user's unique username. Present only on the caller's own entry.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :username, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {