Class: ModernTreasury::Models::ForeignExchangeQuote

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/foreign_exchange_quote.rb

Overview

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

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: , created_at: , effective_at: , expires_at: , foreign_exchange_indicator: , foreign_exchange_rate: , internal_account_id: , live_mode: , metadata: , object: , updated_at: , vendor_id: nil) ⇒ Object

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

Parameters:

  • id (String) (defaults to: )
  • created_at (Time) (defaults to: )
  • effective_at (Time) (defaults to: ) —

    The timestamp until when the quoted rate is valid.

  • expires_at (Time) (defaults to: ) —

    The timestamp until which the quote must be booked by.

  • foreign_exchange_indicator (String) (defaults to: ) —

    Either ‘fixed_to_variable` if the `base_amount` was specified, or `variable_to_f

  • foreign_exchange_rate (ModernTreasury::Models::ForeignExchangeRate) (defaults to: ) —

    The serialized rate information represented by this quote.

  • internal_account_id (String) (defaults to: ) —

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

  • live_mode (Boolean) (defaults to: ) —

    This field will be true if this object exists in the live environment or false i

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

    Additional data represented as key-value pairs. Both the key and value must be s

  • object (String) (defaults to: )
  • updated_at (Time) (defaults to: )
  • vendor_id (String) (defaults to: nil) —

    This vendor assigned ID for this quote.




# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 79

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


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

required :created_at, Time

#effective_at ⇒ Time

The timestamp until when the quoted rate is valid.

Returns:

  • (Time) 


21
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 21

required :effective_at, Time

#expires_at ⇒ Time

The timestamp until which the quote must be booked by.

Returns:

  • (Time) 


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

required :expires_at, Time

#foreign_exchange_indicator ⇒ String

Either ‘fixed_to_variable` if the `base_amount` was specified, or `variable_to_fixed` if the `target_amount` was specified when requesting the quote.

Returns:

  • (String) 


35
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 35

required :foreign_exchange_indicator, String

#foreign_exchange_rate ⇒ ModernTreasury::Models::ForeignExchangeRate

The serialized rate information represented by this quote.

Returns:



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

required :foreign_exchange_rate, -> { ModernTreasury::ForeignExchangeRate }

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 10

required :id, String

#internal_account_id ⇒ String

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

Returns:

  • (String) 


47
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 47

required :internal_account_id, String

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean) 


54
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 54

required :live_mode, ModernTreasury::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

  • (Hash{Symbol=>String}) 


61
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 61

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

#object ⇒ String

Returns:

  • (String) 


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

required :object, String

#updated_at ⇒ Time

Returns:

  • (Time) 


71
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 71

required :updated_at, Time

#vendor_id ⇒ String?

This vendor assigned ID for this quote.

Returns:

  • (String, nil) 


77
 
# File 'lib/modern_treasury/models/foreign_exchange_quote.rb', line 77

optional :vendor_id, String