Class: WhopSDK::Models::AudienceListParams

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

Overview

See Also:

  • WhopSDK::Resources::Audiences#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(account_id:, after: nil, audience_id: nil, first: nil, request_options: {}) ⇒ Object

Parameters:

  • account_id (String) —

    Account ID, prefixed biz_.

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

    Cursor for the next page of audiences.

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

    Audience ID, prefixed adaud_, used to filter the response to one audience.

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

    Number of audiences to return. Defaults to 20; maximum 100.

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



# File 'lib/whop_sdk/models/audience_list_params.rb', line 34

Instance Attribute Details

#account_id ⇒ String

Account ID, prefixed biz_.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :account_id, String

#after ⇒ String?

Cursor for the next page of audiences.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :after, String

#audience_id ⇒ String?

Audience ID, prefixed adaud_, used to filter the response to one audience.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :audience_id, String

#first ⇒ Integer?

Number of audiences to return. Defaults to 20; maximum 100.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :first, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


33
 
# File 'sig/whop_sdk/models/audience_list_params.rbs', line 33

def to_hash: -> {