Class: WhopSDK::Models::UserRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/user_retrieve_params.rb,
sig/whop_sdk/models/user_retrieve_params.rbs

Overview

See Also:

  • WhopSDK::Resources::Users#retrieve

Defined Under Namespace

Modules: Interval

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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:, account_id: nil, from: nil, include_balance_history: nil, interval: nil, time_zone: nil, to: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    When set, returns the user's account-specific profile overrides for this account

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

    Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago

  • include_balance_history (Boolean) (defaults to: nil) —

    On GET /users/me, also compute the caller's balance history (opt-in; runs a he

  • interval (Symbol, WhopSDK::Models::UserRetrieveParams::Interval) (defaults to: nil) —

    Balance-history point granularity. Defaults to day. Only used with `include_ba

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

    IANA time zone the balance-history points are bucketed in. Defaults to UTC. On

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

    Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only use

  • request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/whop_sdk/models/user_retrieve_params.rb', line 58

Instance Attribute Details

#account_id ⇒ String?

When set, returns the user's account-specific profile overrides for this account.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :account_id, String

#from ⇒ String?

Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with include_balance_history.

Parameters:

  • (String)

Returns:

  • (String, nil) 


27
 
# File 'lib/whop_sdk/models/user_retrieve_params.rb', line 27

optional :from, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/whop_sdk/models/user_retrieve_params.rb', line 13

required :id, String

#include_balance_history ⇒ Boolean?

On GET /users/me, also compute the caller's balance history (opt-in; runs a heavier query). Ignored for other users and for callers without balance-read scope.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


35
 
# File 'lib/whop_sdk/models/user_retrieve_params.rb', line 35

optional :include_balance_history, WhopSDK::Internal::Type::Boolean

#interval ⇒ Symbol, ...

Balance-history point granularity. Defaults to day. Only used with include_balance_history.

Returns:



42
 
# File 'lib/whop_sdk/models/user_retrieve_params.rb', line 42

optional :interval, enum: -> { WhopSDK::UserRetrieveParams::Interval }

#time_zone ⇒ String?

IANA time zone the balance-history points are bucketed in. Defaults to UTC. Only used with include_balance_history.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/whop_sdk/models/user_retrieve_params.rb', line 49

optional :time_zone, String

#to ⇒ String?

Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with include_balance_history.

Parameters:

  • (String)

Returns:

  • (String, nil) 


56
 
# File 'lib/whop_sdk/models/user_retrieve_params.rb', line 56

optional :to, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


58
 
# File 'sig/whop_sdk/models/user_retrieve_params.rbs', line 58

def to_hash: -> {