Class: ModernTreasury::Models::LedgerListParams

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

Overview

See Also:

  • ModernTreasury::Resources::Ledgers#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(id: nil, after_cursor: nil, metadata: nil, per_page: nil, updated_at: nil, request_options: {}) ⇒ Object

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

Parameters:

  • id (Array<String>) (defaults to: nil) —

    If you have specific IDs to retrieve in bulk, you can pass them as query paramet

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

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

  • per_page (Integer) (defaults to: nil)
  • updated_at (Hash{Symbol=>Time}) (defaults to: nil) —

    Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by the pos

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



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

Instance Attribute Details

#after_cursor ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :after_cursor, String, nil?: true

#id ⇒ Array<String>?

If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with id[]=, for example ?id[]=123&id[]=abc.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


15
 
# File 'lib/modern_treasury/models/ledger_list_params.rb', line 15

optional :id, ModernTreasury::Internal::Type::ArrayOf[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) 


28
 
# File 'lib/modern_treasury/models/ledger_list_params.rb', line 28

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

#per_page ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


33
 
# File 'lib/modern_treasury/models/ledger_list_params.rb', line 33

optional :per_page, Integer

#updated_at ⇒ Hash{Symbol=>Time}?

Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z.

Parameters:

  • (::Hash[Symbol, Time])

Returns:

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


41
 
# File 'lib/modern_treasury/models/ledger_list_params.rb', line 41

optional :updated_at, ModernTreasury::Internal::Type::HashOf[Time]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


44
 
# File 'sig/modern_treasury/models/ledger_list_params.rbs', line 44

def to_hash: -> {