Class: Onlyfans::Models::NotificationListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/onlyfans/models/notification_list_params.rb

Overview

See Also:

• Resources::Notifications#list

Defined Under Namespace

Modules: SkipUsers, Type

Instance Attribute Summary

• #account ⇒ String
• #from_id ⇒ Integer^?

  Used for pagination.

• #limit ⇒ Integer^?

  The number of notifications.

• #skip_users ⇒ Symbol, ...

  Whether to skip user details.

• #type ⇒ Symbol, ...

  Filter notifications by a specific type.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account:, from_id: nil, limit: nil, skip_users: nil, type: nil, request_options: {}) ⇒ Object constructor

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

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:, from_id: nil, limit: nil, skip_users: nil, type: nil, request_options: {}) ⇒ Object

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

Parameters:

• account (String)
• from_id (Integer) (defaults to: nil) —

  Used for pagination. This value should be the ID of the previous response’s last

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

  The number of notifications. Default ‘10`

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

  Whether to skip user details. Default ‘all`

• type (Symbol, Onlyfans::Models::NotificationListParams::Type) (defaults to: nil) —

  Filter notifications by a specific type

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

# File 'lib/onlyfans/models/notification_list_params.rb', line 40

Instance Attribute Details

#account ⇒ String

Returns:

• (String)

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

required :account, String

#from_id ⇒ Integer^?

Used for pagination. This value should be the ID of the previous response’s last notification.

Returns:

• (Integer, nil)

# File 'lib/onlyfans/models/notification_list_params.rb', line 20

optional :from_id, Integer

#limit ⇒ Integer^?

The number of notifications. Default ‘10`

Returns:

• (Integer, nil)

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

optional :limit, Integer

#skip_users ⇒ Symbol, ...

Whether to skip user details. Default ‘all`

Returns:

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

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

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

#type ⇒ Symbol, ...

Filter notifications by a specific type

Returns:

• (Symbol, Onlyfans::Models::NotificationListParams::Type, nil)

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

optional :type, enum: -> { Onlyfans::NotificationListParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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