Class: ModernTreasury::Models::ReturnListParams

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

Overview

See Also:

  • ModernTreasury::Resources::Returns#list

Defined Under Namespace

Modules: ReturnableType

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ModernTreasury

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(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, per_page: nil, returnable_id: nil, returnable_type: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::ReturnListParams for more details.

Parameters:

  • after_cursor (String, nil) (defaults to: nil)
  • counterparty_id (String) (defaults to: nil) —

    Specify counterparty_id if you wish to see returns that occurred with a specif

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

    Specify internal_account_id if you wish to see returns to/from a specific acco

  • per_page (Integer) (defaults to: nil)
  • returnable_id (String) (defaults to: nil) —

    The ID of a valid returnable. Must be accompanied by returnable_type.

  • returnable_type (Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType) (defaults to: nil) —

    One of payment_order, reversal, or incoming_payment_detail. Must be accomp

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



# File 'lib/modern_treasury/models/return_list_params.rb', line 47

Instance Attribute Details

#after_cursor ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


13
 
# File 'lib/modern_treasury/models/return_list_params.rb', line 13

optional :after_cursor, String, nil?: true

#counterparty_id ⇒ String?

Specify counterparty_id if you wish to see returns that occurred with a specific counterparty.

Parameters:

  • (String)

Returns:

  • (String, nil) 


20
 
# File 'lib/modern_treasury/models/return_list_params.rb', line 20

optional :counterparty_id, String

#internal_account_id ⇒ String?

Specify internal_account_id if you wish to see returns to/from a specific account.

Parameters:

  • (String)

Returns:

  • (String, nil) 


27
 
# File 'lib/modern_treasury/models/return_list_params.rb', line 27

optional :internal_account_id, String

#per_page ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


32
 
# File 'lib/modern_treasury/models/return_list_params.rb', line 32

optional :per_page, Integer

#returnable_id ⇒ String?

The ID of a valid returnable. Must be accompanied by returnable_type.

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# File 'lib/modern_treasury/models/return_list_params.rb', line 38

optional :returnable_id, String

#returnable_type ⇒ Symbol, ...

One of payment_order, reversal, or incoming_payment_detail. Must be accompanied by returnable_id.

Returns:



45
 
# File 'lib/modern_treasury/models/return_list_params.rb', line 45

optional :returnable_type, enum: -> { ModernTreasury::ReturnListParams::ReturnableType }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


52
 
# File 'sig/modern_treasury/models/return_list_params.rbs', line 52

def to_hash: -> {