Class: ModernTreasury::Models::ForeignExchangeQuoteCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/foreign_exchange_quote_create_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(internal_account_id: , target_currency: , base_amount: nil, base_currency: nil, effective_at: nil, target_amount: nil, request_options: {}) ⇒ Object

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

Parameters:

  • internal_account_id (String) (defaults to: ) —

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

  • target_currency (Symbol, ModernTreasury::Models::Currency) (defaults to: ) —

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

  • base_amount (Integer) (defaults to: nil) —

    Amount in the lowest denomination of the ‘base_currency` to convert, often calle

  • base_currency (Symbol, ModernTreasury::Models::Currency) (defaults to: nil) —

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

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

    The timestamp until when the quoted rate is valid.

  • target_amount (Integer) (defaults to: nil) —

    Amount in the lowest denomination of the ‘target_currency`, often called the “bu

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



# File 'lib/modern_treasury/models/foreign_exchange_quote_create_params.rb', line 48

Instance Attribute Details

#base_amount ⇒ Integer?

Amount in the lowest denomination of the ‘base_currency` to convert, often called the “sell” amount.

Returns:

  • (Integer, nil) 


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

optional :base_amount, Integer

#base_currency ⇒ Symbol, ...

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

Returns:



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

optional :base_currency, enum: -> { ModernTreasury::Currency }

#effective_at ⇒ Time?

The timestamp until when the quoted rate is valid.

Returns:

  • (Time, nil) 


39
 
# File 'lib/modern_treasury/models/foreign_exchange_quote_create_params.rb', line 39

optional :effective_at, Time

#internal_account_id ⇒ String

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

Returns:

  • (String) 


14
 
# File 'lib/modern_treasury/models/foreign_exchange_quote_create_params.rb', line 14

required :internal_account_id, String

#target_amount ⇒ Integer?

Amount in the lowest denomination of the ‘target_currency`, often called the “buy” amount.

Returns:

  • (Integer, nil) 


46
 
# File 'lib/modern_treasury/models/foreign_exchange_quote_create_params.rb', line 46

optional :target_amount, Integer

#target_currency ⇒ Symbol, ModernTreasury::Models::Currency

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

Returns:



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

required :target_currency, enum: -> { ModernTreasury::Currency }