Class: WhopSDK::Models::UserListParams

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

Overview

See Also:

  • WhopSDK::Resources::Users#list

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(after: nil, before: nil, first: nil, last: nil, query: nil, request_options: {}) ⇒ Object

Parameters:

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

    A cursor; returns users after this position.

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

    A cursor; returns users before this position.

  • first (Integer) (defaults to: nil) —

    The number of users to return (max 50).

  • last (Integer) (defaults to: nil) —

    The number of users to return from the end of the range.

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

    A search term to filter users by name or username.

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



# File 'lib/whop_sdk/models/user_list_params.rb', line 40

Instance Attribute Details

#after ⇒ String?

A cursor; returns users after this position.

Parameters:

  • (String)

Returns:

  • (String, nil) 


14
 
# File 'lib/whop_sdk/models/user_list_params.rb', line 14

optional :after, String

#before ⇒ String?

A cursor; returns users before this position.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :before, String

#first ⇒ Integer?

The number of users to return (max 50).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :first, Integer

#last ⇒ Integer?

The number of users to return from the end of the range.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


32
 
# File 'lib/whop_sdk/models/user_list_params.rb', line 32

optional :last, Integer

#query ⇒ String?

A search term to filter users by name or username.

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# File 'lib/whop_sdk/models/user_list_params.rb', line 38

optional :query, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/whop_sdk/models/user_list_params.rbs', line 46

def to_hash: -> {