Class: Onlyfans::Models::Engagement::Messages::DirectMessageListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/onlyfans/models/engagement/messages/direct_message_list_params.rb

Overview

See Also:

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:, end_date: nil, limit: nil, offset: nil, query: nil, start_date: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Onlyfans::Models::Engagement::Messages::DirectMessageListParams for more details.

Parameters:

  • account (String)
  • end_date (String) (defaults to: nil) —

    The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER ‘start

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

    Number of messages to return (default = 10)

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

    Optional offset for manual pagination.

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

    Optionally, filter by message text.

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

    The earliest message to retrieve. Keep empty to get all.

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



# File 'lib/onlyfans/models/engagement/messages/direct_message_list_params.rb', line 48

Instance Attribute Details

#account ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/onlyfans/models/engagement/messages/direct_message_list_params.rb', line 15

required :account, String

#end_date ⇒ String?

The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER ‘startDate`. This is also used for pagination.

Returns:

  • (String, nil) 


22
 
# File 'lib/onlyfans/models/engagement/messages/direct_message_list_params.rb', line 22

optional :end_date, String

#limit ⇒ Integer?

Number of messages to return (default = 10)

Returns:

  • (Integer, nil) 


28
 
# File 'lib/onlyfans/models/engagement/messages/direct_message_list_params.rb', line 28

optional :limit, Integer

#offset ⇒ Integer?

Optional offset for manual pagination.

Returns:

  • (Integer, nil) 


34
 
# File 'lib/onlyfans/models/engagement/messages/direct_message_list_params.rb', line 34

optional :offset, Integer

#query ⇒ String?

Optionally, filter by message text.

Returns:

  • (String, nil) 


40
 
# File 'lib/onlyfans/models/engagement/messages/direct_message_list_params.rb', line 40

optional :query, String

#start_date ⇒ String?

The earliest message to retrieve. Keep empty to get all.

Returns:

  • (String, nil) 


46
 
# File 'lib/onlyfans/models/engagement/messages/direct_message_list_params.rb', line 46

optional :start_date, String