Class: Vatsense::Models::CurrencyConvertParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Vatsense::Models::CurrencyConvertParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/vatsense/models/currency_convert_params.rb

Overview

See Also:

• Resources::Currency#convert

Defined Under Namespace

Modules: To

Instance Attribute Summary

• #amount ⇒ String

  The amount to convert.

• #from ⇒ String

  The 3-character source currency code (e.g. “USD”, “CAD”).

• #to ⇒ Symbol, Vatsense::Models::CurrencyConvertParams::To

  The 3-character target currency code.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(amount:, from:, to:, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CurrencyConvertParams 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(amount:, from:, to:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Vatsense::Models::CurrencyConvertParams for more details.

Parameters:

• amount (String) —

  The amount to convert. Must be a string with exactly 2 decimal places (e.g. “39.

• from (String) —

  The 3-character source currency code (e.g. “USD”, “CAD”).

• to (Symbol, Vatsense::Models::CurrencyConvertParams::To) —

  The 3-character target currency code. Must be either “GBP” or “EUR”.

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

# File 'lib/vatsense/models/currency_convert_params.rb', line 29

Instance Attribute Details

#amount ⇒ String

The amount to convert. Must be a string with exactly 2 decimal places (e.g. “39.99”).

Returns:

• (String)

# File 'lib/vatsense/models/currency_convert_params.rb', line 15

required :amount, String

#from ⇒ String

The 3-character source currency code (e.g. “USD”, “CAD”).

Returns:

• (String)

# File 'lib/vatsense/models/currency_convert_params.rb', line 21

required :from, String

#to ⇒ Symbol, Vatsense::Models::CurrencyConvertParams::To

The 3-character target currency code. Must be either “GBP” or “EUR”.

Returns:

• (Symbol, Vatsense::Models::CurrencyConvertParams::To)

# File 'lib/vatsense/models/currency_convert_params.rb', line 27

required :to, enum: -> { Vatsense::CurrencyConvertParams::To }