Class: Onlyfans::Models::SmartLinkListParams

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

Overview

See Also:

  • Onlyfans::Resources::SmartLinks#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_ids: nil, limit: nil, meta_pixel_ids: nil, name: nil, offset: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Comma-separated account prefixed IDs to include.

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

    The number of Smart Links to return. Default 50. Must be at least 1. Must not

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

    Comma-separated Meta Pixel IDs to include.

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

    Filter Smart Links by name. Must not be greater than 255 characters.

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

    The offset used for pagination. Default 0. Must be at least 0.

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



# File 'lib/onlyfans/models/smart_link_list_params.rb', line 41

Instance Attribute Details

#account_ids ⇒ String?

Comma-separated account prefixed IDs to include.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


14
 
# File 'lib/onlyfans/models/smart_link_list_params.rb', line 14

optional :account_ids, String, nil?: true

#limit ⇒ Integer?

The number of Smart Links to return. Default 50. Must be at least 1. Must not be greater than 1000.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


21
 
# File 'lib/onlyfans/models/smart_link_list_params.rb', line 21

optional :limit, Integer

#meta_pixel_ids ⇒ String?

Comma-separated Meta Pixel IDs to include.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


27
 
# File 'lib/onlyfans/models/smart_link_list_params.rb', line 27

optional :meta_pixel_ids, String, nil?: true

#name ⇒ String?

Filter Smart Links by name. Must not be greater than 255 characters.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


33
 
# File 'lib/onlyfans/models/smart_link_list_params.rb', line 33

optional :name, String, nil?: true

#offset ⇒ Integer?

The offset used for pagination. Default 0. Must be at least 0.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


39
 
# File 'lib/onlyfans/models/smart_link_list_params.rb', line 39

optional :offset, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


40
 
# File 'sig/onlyfans/models/smart_link_list_params.rbs', line 40

def to_hash: -> {