Class: WhopSDK::Models::MemberRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/member_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Classes: Company, 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(id:, route:, title:) ⇒ Object

The company for the member.

Parameters:

  • id (String) —

    The unique identifier for the company.

  • route (String) —

    The slug/route of the company on the Whop site.

  • title (String) —

    The written name of the company.




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

Instance Attribute Details

#access_level ⇒ Symbol, WhopSDK::Models::AccessLevel

The access level of the product member. If its admin, the member is an authorized user of the company. If its customer, the member has a valid membership to any product on the company. If its no_access, the member does not have access to the product.

Returns:



20
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 20

required :access_level, enum: -> { WhopSDK::AccessLevel }

#company ⇒ WhopSDK::Models::MemberRetrieveResponse::Company

The company for the member.

Returns:



26
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 26

required :company, -> { WhopSDK::Models::MemberRetrieveResponse::Company }

#company_token_balance ⇒ Float

The member’s token balance for this company. Computed live from the ledger, not from a cache.

Returns:

  • (Float) 


33
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 33

required :company_token_balance, Float

#created_at ⇒ Time

The datetime the company member was created.

Returns:

  • (Time) 


39
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 39

required :created_at, Time

#id ⇒ String

The unique identifier for the company member.

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 11

required :id, String

#joined_at ⇒ Time

When the member joined the company

Returns:

  • (Time) 


45
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 45

required :joined_at, Time

#most_recent_action ⇒ Symbol, ...

The different most recent actions a member can have.

Returns:



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

required :most_recent_action, enum: -> { WhopSDK::MemberMostRecentActions }, nil?: true

#most_recent_action_at ⇒ Time?

The time for the most recent action, if applicable.

Returns:

  • (Time, nil) 


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

required :most_recent_action_at, Time, nil?: true

#phone ⇒ String?

The phone number for the member, if available.

Returns:

  • (String, nil) 


63
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 63

required :phone, String, nil?: true

#status ⇒ Symbol, WhopSDK::Models::MemberStatuses

The status of the member

Returns:



69
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 69

required :status, enum: -> { WhopSDK::MemberStatuses }

#updated_at ⇒ Time

The datetime the company member was last updated.

Returns:

  • (Time) 


75
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 75

required :updated_at, Time

#usd_total_spent ⇒ Float

How much money this customer has spent on the company’s products and plans

Returns:

  • (Float) 


81
 
# File 'lib/whop_sdk/models/member_retrieve_response.rb', line 81

required :usd_total_spent, Float

#user ⇒ WhopSDK::Models::MemberRetrieveResponse::User?

The user for this member, if any.

Returns:



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

required :user, -> { WhopSDK::Models::MemberRetrieveResponse::User }, nil?: true