Class: Onlyfans::Models::ChatListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Onlyfans::Resources::Chats#list

Defined Under Namespace

Modules: Filter, Order, SkipUsers

Instance Attribute Summary

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

  Optionally, filter the chats by type.

• #limit ⇒ String^?

  Number of chats to return (1 - 100).

• #offset ⇒ String^?

  Number of chats to skip for pagination.

• #order ⇒ Symbol, ...

  Sort order for chats (recent or old).

• #query ⇒ String^?

  Search query to filter chats.

• #skip_users ⇒ Symbol, ...

  Whether to skip user details in response (all or none).

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account:, filter: nil, limit: nil, offset: nil, order: nil, query: nil, skip_users: nil, request_options: {}) ⇒ Object constructor
• #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, offset: nil, order: nil, query: nil, skip_users: nil, request_options: {}) ⇒ Object

Parameters:

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

  Optionally, filter the chats by type.

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

  Number of chats to return (1 - 100). Default = 10

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

  Number of chats to skip for pagination

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

  Sort order for chats (recent or old). Default = recent

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

  Search query to filter chats

• skip_users (Symbol, Onlyfans::Models::ChatListParams::SkipUsers) (defaults to: nil) —

  Whether to skip user details in response (all or none). Default = all

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

# File 'lib/onlyfans/models/chat_list_params.rb', line 51

Instance Attribute Details

#account ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :account, String

#filter ⇒ Symbol, ...

Optionally, filter the chats by type.

Returns:

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

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

optional :filter, enum: -> { Onlyfans::ChatListParams::Filter }

#limit ⇒ String^?

Number of chats to return (1 - 100). Default = 10

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :limit, String

#offset ⇒ String^?

Number of chats to skip for pagination

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :offset, String

#order ⇒ Symbol, ...

Sort order for chats (recent or old). Default = recent

Returns:

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

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

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

#query ⇒ String^?

Search query to filter chats

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :query, String

#skip_users ⇒ Symbol, ...

Whether to skip user details in response (all or none). Default = all

Returns:

• (Symbol, Onlyfans::Models::ChatListParams::SkipUsers, nil)

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

optional :skip_users, enum: -> { Onlyfans::ChatListParams::SkipUsers }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/onlyfans/models/chat_list_params.rb', line 78

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/onlyfans/models/chat_list_params.rbs', line 62

def to_hash: -> {