Class: WhopSDK::Models::Membership::User

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::Membership::User

Defined in:

lib/whop_sdk/models/membership.rb

Overview

See Also:

• #user

Instance Attribute Summary

• #email ⇒ String^?

  The user’s email address.

• #id ⇒ String

  The unique identifier for the user.

• #name ⇒ String^?

  The user’s display name shown on their public profile.

• #username ⇒ String

  The user’s unique username shown on their public profile.

Instance Method Summary

• #initialize(id:, email:, name:, username:) ⇒ Object constructor

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

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(id:, email:, name:, username:) ⇒ Object

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

The user who owns this membership. Null if the user account has been deleted.

Parameters:

• id (String) —

  The unique identifier for the user.

• email (String, nil) —

  The user’s email address. Requires the member:email:read permission to access. N

• name (String, nil) —

  The user’s display name shown on their public profile.

• username (String) —

  The user’s unique username shown on their public profile.

# File 'lib/whop_sdk/models/membership.rb', line 361

Instance Attribute Details

#email ⇒ String^?

The user’s email address. Requires the member:email:read permission to access. Null if not authorized.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/membership.rb', line 347

required :email, String, nil?: true

#id ⇒ String

The unique identifier for the user.

Returns:

• (String)

# File 'lib/whop_sdk/models/membership.rb', line 340

required :id, String

#name ⇒ String^?

The user’s display name shown on their public profile.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/membership.rb', line 353

required :name, String, nil?: true

#username ⇒ String

The user’s unique username shown on their public profile.

Returns:

• (String)

# File 'lib/whop_sdk/models/membership.rb', line 359

required :username, String