Class: ModernTreasury::Models::ExternalAccountListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/external_account_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(after_cursor: nil, counterparty_id: nil, external_id: nil, metadata: nil, party_name: nil, per_page: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    An optional user-defined 180 character unique identifier.

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

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

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

    Searches the ExternalAccount’s party_name AND the Counterparty’s party_name

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



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

Instance Attribute Details

#after_cursor ⇒ String?

Returns:

  • (String, nil) 


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

optional :after_cursor, String, nil?: true

#counterparty_id ⇒ String?

Returns:

  • (String, nil) 


18
 
# File 'lib/modern_treasury/models/external_account_list_params.rb', line 18

optional :counterparty_id, String

#external_id ⇒ String?

An optional user-defined 180 character unique identifier.

Returns:

  • (String, nil) 


24
 
# File 'lib/modern_treasury/models/external_account_list_params.rb', line 24

optional :external_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.

Returns:

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


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

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

#party_name ⇒ String?

Searches the ExternalAccount’s party_name AND the Counterparty’s party_name

Returns:

  • (String, nil) 


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

optional :party_name, String

#per_page ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :per_page, Integer