Class: ModernTreasury::Models::TransactionListParams

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

Overview

See Also:

  • ModernTreasury::Resources::Transactions#list

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, as_of_date_end: nil, as_of_date_start: nil, counterparty_id: nil, description: nil, direction: nil, internal_account_id: nil, metadata: nil, payment_type: nil, per_page: nil, posted: nil, transactable_type: nil, vendor_id: nil, virtual_account_id: nil, request_options: {}) ⇒ Object

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

Parameters:

  • after_cursor (String, nil) (defaults to: nil)
  • as_of_date_end (Date) (defaults to: nil) —

    Filters transactions with an as_of_date starting on or before the specified da

  • as_of_date_start (Date) (defaults to: nil) —

    Filters transactions with an as_of_date starting on or after the specified dat

  • counterparty_id (String) (defaults to: nil)
  • description (String) (defaults to: nil) —

    Filters for transactions including the queried string in the description.

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

    Specify internal_account_id if you wish to see transactions to/from a specific

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    For example, if you want to query for records with metadata key Type and value

  • payment_type (String) (defaults to: nil)
  • per_page (Integer) (defaults to: nil)
  • posted (Boolean) (defaults to: nil) —

    Either true or false.

  • transactable_type (String) (defaults to: nil)
  • vendor_id (String) (defaults to: nil) —

    Filters for transactions including the queried vendor id (an identifier given to

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



# File 'lib/modern_treasury/models/transaction_list_params.rb', line 93

Instance Attribute Details

#after_cursor ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :after_cursor, String, nil?: true

#as_of_date_end ⇒ Date?

Filters transactions with an as_of_date starting on or before the specified date (YYYY-MM-DD).

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


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

optional :as_of_date_end, Date

#as_of_date_start ⇒ Date?

Filters transactions with an as_of_date starting on or after the specified date (YYYY-MM-DD).

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


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

optional :as_of_date_start, Date

#counterparty_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :counterparty_id, String

#description ⇒ String?

Filters for transactions including the queried string in the description.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :description, String

#direction ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 43

optional :direction, String

#internal_account_id ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


50
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 50

optional :internal_account_id, String

#metadata ⇒ Hash{Symbol=>String}?

For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


58
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 58

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#payment_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


63
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 63

optional :payment_type, String

#per_page ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


68
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 68

optional :per_page, Integer

#posted ⇒ Boolean?

Either true or false.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


74
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 74

optional :posted, ModernTreasury::Internal::Type::Boolean

#transactable_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


79
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 79

optional :transactable_type, String

#vendor_id ⇒ String?

Filters for transactions including the queried vendor id (an identifier given to transactions by the bank).

Parameters:

  • (String)

Returns:

  • (String, nil) 


86
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 86

optional :vendor_id, String

#virtual_account_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


91
 
# File 'lib/modern_treasury/models/transaction_list_params.rb', line 91

optional :virtual_account_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


98
 
# File 'sig/modern_treasury/models/transaction_list_params.rbs', line 98

def to_hash: -> {