Class: Onlyfans::Models::ReleaseFormListTaggableUsersParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Onlyfans::Models::ReleaseFormListTaggableUsersParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/onlyfans/models/release_form_list_taggable_users_params.rb,
sig/onlyfans/models/release_form_list_taggable_users_params.rbs

Overview

See Also:

• Onlyfans::Resources::ReleaseForms#list_taggable_users

Defined Under Namespace

Modules: Filter, Sort, SortDirection

Instance Attribute Summary

• #account ⇒ String
• #filter ⇒ Symbol, ...

  Filter users by type: all or pending.

• #limit ⇒ Integer^?

  Number of users to return per page (1-50).

• #name ⇒ String^?

  Filter users by name or username.

• #offset ⇒ Integer^?

  Number of users to skip for pagination.

• #sort ⇒ Symbol, ...

  Sort field: date or name.

• #sort_direction ⇒ Symbol, ...

  Sort direction: desc or asc.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account:, filter: nil, limit: nil, name: nil, offset: nil, sort: nil, sort_direction: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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:, filter: nil, limit: nil, name: nil, offset: nil, sort: nil, sort_direction: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Onlyfans::Models::ReleaseFormListTaggableUsersParams for more details.

Parameters:

• account (String)
• filter (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::Filter, nil) (defaults to: nil) —

  Filter users by type: all or pending.

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

  Number of users to return per page (1-50). Must be at least 1. Must not be great

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

  Filter users by name or username.

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

  Number of users to skip for pagination. Must be at least 0.

• sort (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::Sort, nil) (defaults to: nil) —

  Sort field: date or name.

• sort_direction (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::SortDirection, nil) (defaults to: nil) —

  Sort direction: desc or asc.

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

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 54

Instance Attribute Details

#account ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 13

required :account, String

#filter ⇒ Symbol, ...

Filter users by type: all or pending.

Parameters:

• value (Onlyfans::Models::ReleaseFormListTaggableUsersParams::filter, nil)

Returns:

• (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::Filter, nil)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 19

optional :filter, enum: -> { Onlyfans::ReleaseFormListTaggableUsersParams::Filter }, nil?: true

#limit ⇒ Integer^?

Number of users to return per page (1-50). Must be at least 1. Must not be greater than 50.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 26

optional :limit, Integer

#name ⇒ String^?

Filter users by name or username.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 32

optional :name, String, nil?: true

#offset ⇒ Integer^?

Number of users to skip for pagination. Must be at least 0.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 38

optional :offset, Integer

#sort ⇒ Symbol, ...

Sort field: date or name.

Parameters:

• value (Onlyfans::Models::ReleaseFormListTaggableUsersParams::sort, nil)

Returns:

• (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::Sort, nil)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 44

optional :sort, enum: -> { Onlyfans::ReleaseFormListTaggableUsersParams::Sort }, nil?: true

#sort_direction ⇒ Symbol, ...

Sort direction: desc or asc.

Parameters:

• value (Onlyfans::Models::ReleaseFormListTaggableUsersParams::sort_direction, nil)

Returns:

• (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::SortDirection, nil)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 50

optional :sort_direction,
enum: -> { Onlyfans::ReleaseFormListTaggableUsersParams::SortDirection },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/onlyfans/models/release_form_list_taggable_users_params.rb', line 81

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/onlyfans/models/release_form_list_taggable_users_params.rbs', line 48

def to_hash: -> {