Class: Onlyfans::Models::PostListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/onlyfans/models/post_list_params.rb

Overview

See Also:

• Resources::Posts#list

Defined Under Namespace

Modules: Order, Sort

Instance Attribute Summary

• #account ⇒ String
• #counters ⇒ Boolean^?

  Set to true to include an array of counters (see example responses).

• #limit ⇒ Integer^?

  Number of posts to return (default = 10).

• #minimum_publish_date ⇒ String^?

  Filter posts by minimum publish date.

• #offset ⇒ Integer^?

  Number of posts to skip for pagination.

• #order ⇒ Symbol, ...

  Order the returned posts (default = publish_date).

• #pinned ⇒ Boolean^?

  Set to true to only show pinned posts.

• #query ⇒ String^?

  Search query to filter posts.

• #sort ⇒ Symbol, ...

  Sort the returned posts (default = desc).

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account:, counters: nil, limit: nil, minimum_publish_date: nil, offset: nil, order: nil, pinned: nil, query: nil, sort: nil, request_options: {}) ⇒ Object constructor

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:, counters: nil, limit: nil, minimum_publish_date: nil, offset: nil, order: nil, pinned: nil, query: nil, sort: nil, request_options: {}) ⇒ Object

Parameters:

• account (String)
• counters (Boolean) (defaults to: nil) —

  Set to true to include an array of counters (see example responses)

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

  Number of posts to return (default = 10)

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

  Filter posts by minimum publish date

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

  Number of posts to skip for pagination

• order (Symbol, Onlyfans::Models::PostListParams::Order) (defaults to: nil) —

  Order the returned posts (default = publish_date)

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

  Set to true to only show pinned posts

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

  Search query to filter posts

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

  Sort the returned posts (default = desc)

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

# File 'lib/onlyfans/models/post_list_params.rb', line 63

Instance Attribute Details

#account ⇒ String

Returns:

• (String)

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

required :account, String

#counters ⇒ Boolean^?

Set to true to include an array of counters (see example responses)

Returns:

• (Boolean, nil)

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

optional :counters, Onlyfans::Internal::Type::Boolean

#limit ⇒ Integer^?

Number of posts to return (default = 10)

Returns:

• (Integer, nil)

# File 'lib/onlyfans/models/post_list_params.rb', line 25

optional :limit, Integer

#minimum_publish_date ⇒ String^?

Filter posts by minimum publish date

Returns:

• (String, nil)

# File 'lib/onlyfans/models/post_list_params.rb', line 31

optional :minimum_publish_date, String

#offset ⇒ Integer^?

Number of posts to skip for pagination

Returns:

• (Integer, nil)

# File 'lib/onlyfans/models/post_list_params.rb', line 37

optional :offset, Integer

#order ⇒ Symbol, ...

Order the returned posts (default = publish_date)

Returns:

• (Symbol, Onlyfans::Models::PostListParams::Order, nil)

# File 'lib/onlyfans/models/post_list_params.rb', line 43

optional :order, enum: -> { Onlyfans::PostListParams::Order }

#pinned ⇒ Boolean^?

Set to true to only show pinned posts

Returns:

• (Boolean, nil)

# File 'lib/onlyfans/models/post_list_params.rb', line 49

optional :pinned, Onlyfans::Internal::Type::Boolean

#query ⇒ String^?

Search query to filter posts

Returns:

• (String, nil)

# File 'lib/onlyfans/models/post_list_params.rb', line 55

optional :query, String

#sort ⇒ Symbol, ...

Sort the returned posts (default = desc)

Returns:

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

# File 'lib/onlyfans/models/post_list_params.rb', line 61

optional :sort, enum: -> { Onlyfans::PostListParams::Sort }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/onlyfans/models/post_list_params.rb', line 92