Class: ModernTreasury::Models::ForeignExchangeQuoteListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/foreign_exchange_quote_list_params.rb

Overview

See Also:

• Resources::ForeignExchangeQuotes#list

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #base_currency ⇒ String^?

  Currency to convert, often called the “sell” currency.

• #effective_at_end ⇒ Date^?

  An inclusive upper bound for searching effective_at.

• #effective_at_start ⇒ Date^?

  An inclusive lower bound for searching effective_at.

• #expires_at ⇒ Time^?

  The timestamp until which the quote must be booked by.

• #internal_account_id ⇒ String^?

  The ID for the ‘InternalAccount` this quote is associated with.

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

• #per_page ⇒ Integer^?
• #target_currency ⇒ String^?

  Currency to convert the ‘base_currency` to, often called the “buy” currency.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(after_cursor: nil, base_currency: nil, effective_at_end: nil, effective_at_start: nil, expires_at: nil, internal_account_id: nil, metadata: nil, per_page: nil, target_currency: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ForeignExchangeQuoteListParams 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, base_currency: nil, effective_at_end: nil, effective_at_start: nil, expires_at: nil, internal_account_id: nil, metadata: nil, per_page: nil, target_currency: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Currency to convert, often called the “sell” currency.

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

  An inclusive upper bound for searching effective_at

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

  An inclusive lower bound for searching effective_at

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

  The timestamp until which the quote must be booked by.

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

  The ID for the ‘InternalAccount` this quote is associated with.

• 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)
• target_currency (String) (defaults to: nil) —

  Currency to convert the ‘base_currency` to, often called the “buy” currency.

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

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

Instance Attribute Details

#after_cursor ⇒ String^?

Returns:

• (String, nil)

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

optional :after_cursor, String, nil?: true

#base_currency ⇒ String^?

Currency to convert, often called the “sell” currency.

Returns:

• (String, nil)

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

optional :base_currency, String

#effective_at_end ⇒ Date^?

An inclusive upper bound for searching effective_at

Returns:

• (Date, nil)

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

optional :effective_at_end, Date

#effective_at_start ⇒ Date^?

An inclusive lower bound for searching effective_at

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/foreign_exchange_quote_list_params.rb', line 31

optional :effective_at_start, Date

#expires_at ⇒ Time^?

The timestamp until which the quote must be booked by.

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/foreign_exchange_quote_list_params.rb', line 37

optional :expires_at, Time

#internal_account_id ⇒ String^?

The ID for the ‘InternalAccount` this quote is associated with.

Returns:

• (String, nil)

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

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.

Returns:

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

# File 'lib/modern_treasury/models/foreign_exchange_quote_list_params.rb', line 51

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

#per_page ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/foreign_exchange_quote_list_params.rb', line 56

optional :per_page, Integer

#target_currency ⇒ String^?

Currency to convert the ‘base_currency` to, often called the “buy” currency.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/foreign_exchange_quote_list_params.rb', line 62

optional :target_currency, String