Class: ModernTreasury::Models::CounterpartyListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::CounterpartyListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/counterparty_list_params.rb

Overview

See Also:

• Resources::Counterparties#list

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #created_at_lower_bound ⇒ Time^?

  Used to return counterparties created after some datetime.

• #created_at_upper_bound ⇒ Time^?

  Used to return counterparties created before some datetime.

• #email ⇒ String^?

  Performs a partial string match of the email field.

• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #legal_entity_id ⇒ String^?

  Filters for counterparties with the given legal entity ID.

• #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`.

• #name ⇒ String^?

  Performs a partial string match of the name field.

• #per_page ⇒ Integer^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(after_cursor: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, email: nil, external_id: nil, legal_entity_id: nil, metadata: nil, name: nil, per_page: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CounterpartyListParams for more details.

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, created_at_lower_bound: nil, created_at_upper_bound: nil, email: nil, external_id: nil, legal_entity_id: nil, metadata: nil, name: nil, per_page: nil, request_options: {}) ⇒ Object

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

Parameters:

• after_cursor (String, nil) (defaults to: nil)
• created_at_lower_bound (Time) (defaults to: nil) —

  Used to return counterparties created after some datetime.

• created_at_upper_bound (Time) (defaults to: nil) —

  Used to return counterparties created before some datetime.

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

  Performs a partial string match of the email field. This is also case insensitiv

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

  An optional user-defined 180 character unique identifier.

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

  Filters for counterparties with the given legal entity ID.

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

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

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

  Performs a partial string match of the name field. This is also case insensitive

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

# File 'lib/modern_treasury/models/counterparty_list_params.rb', line 66

Instance Attribute Details

#after_cursor ⇒ String^?

Returns:

• (String, nil)

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

optional :after_cursor, String, nil?: true

#created_at_lower_bound ⇒ Time^?

Used to return counterparties created after some datetime.

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/counterparty_list_params.rb', line 19

optional :created_at_lower_bound, Time

#created_at_upper_bound ⇒ Time^?

Used to return counterparties created before some datetime.

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/counterparty_list_params.rb', line 25

optional :created_at_upper_bound, Time

#email ⇒ String^?

Performs a partial string match of the email field. This is also case insensitive.

Returns:

• (String, nil)

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

optional :email, String

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Returns:

• (String, nil)

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

optional :external_id, String

#legal_entity_id ⇒ String^?

Filters for counterparties with the given legal entity ID.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_list_params.rb', line 44

optional :legal_entity_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)

# File 'lib/modern_treasury/models/counterparty_list_params.rb', line 52

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

#name ⇒ String^?

Performs a partial string match of the name field. This is also case insensitive.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_list_params.rb', line 59

optional :name, String

#per_page ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/counterparty_list_params.rb', line 64

optional :per_page, Integer