Class: Onlyfans::Models::TransactionListParams

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

Overview

See Also:

  • Onlyfans::Resources::Transactions#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:, limit: nil, marker: nil, start_date: nil, tips_source: nil, type: nil, request_options: {}) ⇒ Object

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

`post_

Parameters:

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

    The number of transactions to return. Recommended: 10

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

    The marker used for pagination. Default: null

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

    The start date for transactions list. Default: -30days

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

    Filter tips by source. Only applies when type=tips. Options: profile,

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

    Filter by transaction type. Options: subscribes, tips, post, `chat_message

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



# File 'lib/onlyfans/models/transaction_list_params.rb', line 47

Instance Attribute Details

#account ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :account, String

#limit ⇒ String?

The number of transactions to return. Recommended: 10

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :limit, String

#marker ⇒ String?

The marker used for pagination. Default: null

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :marker, String

#start_date ⇒ String?

The start date for transactions list. Default: -30days

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :start_date, String

#tips_source ⇒ String?

Filter tips by source. Only applies when type=tips. Options: profile, post_all, chat, stream, story

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :tips_source, String

#type ⇒ String?

Filter by transaction type. Options: subscribes, tips, post, chat_messages, stream

Parameters:

  • (String)

Returns:

  • (String, nil) 


45
 
# File 'lib/onlyfans/models/transaction_list_params.rb', line 45

optional :type, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/onlyfans/models/transaction_list_params.rbs', line 50

def to_hash: -> {