class VeloPayments::QuoteFxSummary
Attributes
Valid ISO 4217 3 letter currency code. See the <a href="www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
Valid ISO 4217 3 letter currency code. See the <a href="www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/velopayments/models/quote_fx_summary.rb, line 64 def self.attribute_map { :'rate' => :'rate', :'inverted_rate' => :'invertedRate', :'creation_time' => :'creationTime', :'expiry_time' => :'expiryTime', :'quote_id' => :'quoteId', :'total_source_amount' => :'totalSourceAmount', :'total_payment_amount' => :'totalPaymentAmount', :'source_currency' => :'sourceCurrency', :'payment_currency' => :'paymentCurrency', :'funding_status' => :'fundingStatus', :'status' => :'status' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/velopayments/models/quote_fx_summary.rb, line 356 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/velopayments/models/quote_fx_summary.rb, line 105 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::QuoteFxSummary` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::QuoteFxSummary`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'rate') self.rate = attributes[:'rate'] end if attributes.key?(:'inverted_rate') self.inverted_rate = attributes[:'inverted_rate'] end if attributes.key?(:'creation_time') self.creation_time = attributes[:'creation_time'] end if attributes.key?(:'expiry_time') self.expiry_time = attributes[:'expiry_time'] end if attributes.key?(:'quote_id') self.quote_id = attributes[:'quote_id'] end if attributes.key?(:'total_source_amount') self.total_source_amount = attributes[:'total_source_amount'] end if attributes.key?(:'total_payment_amount') self.total_payment_amount = attributes[:'total_payment_amount'] end if attributes.key?(:'source_currency') self.source_currency = attributes[:'source_currency'] end if attributes.key?(:'payment_currency') self.payment_currency = attributes[:'payment_currency'] end if attributes.key?(:'funding_status') self.funding_status = attributes[:'funding_status'] end if attributes.key?(:'status') self.status = attributes[:'status'] end end
List of attributes with nullable: true
# File lib/velopayments/models/quote_fx_summary.rb, line 98 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/velopayments/models/quote_fx_summary.rb, line 81 def self.openapi_types { :'rate' => :'Float', :'inverted_rate' => :'Float', :'creation_time' => :'DateTime', :'expiry_time' => :'DateTime', :'quote_id' => :'String', :'total_source_amount' => :'Integer', :'total_payment_amount' => :'Integer', :'source_currency' => :'String', :'payment_currency' => :'String', :'funding_status' => :'String', :'status' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/velopayments/models/quote_fx_summary.rb, line 325 def ==(o) return true if self.equal?(o) self.class == o.class && rate == o.rate && inverted_rate == o.inverted_rate && creation_time == o.creation_time && expiry_time == o.expiry_time && quote_id == o.quote_id && total_source_amount == o.total_source_amount && total_payment_amount == o.total_payment_amount && source_currency == o.source_currency && payment_currency == o.payment_currency && funding_status == o.funding_status && status == o.status end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/velopayments/models/quote_fx_summary.rb, line 384 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model VeloPayments.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/velopayments/models/quote_fx_summary.rb, line 453 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/velopayments/models/quote_fx_summary.rb, line 363 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/velopayments/models/quote_fx_summary.rb, line 343 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] funding_status
Object to be assigned
# File lib/velopayments/models/quote_fx_summary.rb, line 305 def funding_status=(funding_status) validator = EnumAttributeValidator.new('String', ["UNFUNDED", "INSTRUCTED", "FUNDED"]) unless validator.valid?(funding_status) fail ArgumentError, "invalid value for \"funding_status\", must be one of #{validator.allowable_values}." end @funding_status = funding_status end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/velopayments/models/quote_fx_summary.rb, line 349 def hash [rate, inverted_rate, creation_time, expiry_time, quote_id, total_source_amount, total_payment_amount, source_currency, payment_currency, funding_status, status].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/velopayments/models/quote_fx_summary.rb, line 165 def list_invalid_properties invalid_properties = Array.new if @rate.nil? invalid_properties.push('invalid value for "rate", rate cannot be nil.') end if @creation_time.nil? invalid_properties.push('invalid value for "creation_time", creation_time cannot be nil.') end if @quote_id.nil? invalid_properties.push('invalid value for "quote_id", quote_id cannot be nil.') end if @total_source_amount.nil? invalid_properties.push('invalid value for "total_source_amount", total_source_amount cannot be nil.') end if @total_payment_amount.nil? invalid_properties.push('invalid value for "total_payment_amount", total_payment_amount cannot be nil.') end if @source_currency.nil? invalid_properties.push('invalid value for "source_currency", source_currency cannot be nil.') end if @source_currency.to_s.length > 3 invalid_properties.push('invalid value for "source_currency", the character length must be smaller than or equal to 3.') end if @source_currency.to_s.length < 3 invalid_properties.push('invalid value for "source_currency", the character length must be great than or equal to 3.') end pattern = Regexp.new(/^[A-Z]{3}$/) if @source_currency !~ pattern invalid_properties.push("invalid value for \"source_currency\", must conform to the pattern #{pattern}.") end if @payment_currency.nil? invalid_properties.push('invalid value for "payment_currency", payment_currency cannot be nil.') end if @payment_currency.to_s.length > 3 invalid_properties.push('invalid value for "payment_currency", the character length must be smaller than or equal to 3.') end if @payment_currency.to_s.length < 3 invalid_properties.push('invalid value for "payment_currency", the character length must be great than or equal to 3.') end pattern = Regexp.new(/^[A-Z]{3}$/) if @payment_currency !~ pattern invalid_properties.push("invalid value for \"payment_currency\", must conform to the pattern #{pattern}.") end if @funding_status.nil? invalid_properties.push('invalid value for "funding_status", funding_status cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end invalid_properties end
Custom attribute writer method with validation @param [Object] payment_currency
Value to be assigned
# File lib/velopayments/models/quote_fx_summary.rb, line 282 def payment_currency=(payment_currency) if payment_currency.nil? fail ArgumentError, 'payment_currency cannot be nil' end if payment_currency.to_s.length > 3 fail ArgumentError, 'invalid value for "payment_currency", the character length must be smaller than or equal to 3.' end if payment_currency.to_s.length < 3 fail ArgumentError, 'invalid value for "payment_currency", the character length must be great than or equal to 3.' end pattern = Regexp.new(/^[A-Z]{3}$/) if payment_currency !~ pattern fail ArgumentError, "invalid value for \"payment_currency\", must conform to the pattern #{pattern}." end @payment_currency = payment_currency end
Custom attribute writer method with validation @param [Object] source_currency
Value to be assigned
# File lib/velopayments/models/quote_fx_summary.rb, line 259 def source_currency=(source_currency) if source_currency.nil? fail ArgumentError, 'source_currency cannot be nil' end if source_currency.to_s.length > 3 fail ArgumentError, 'invalid value for "source_currency", the character length must be smaller than or equal to 3.' end if source_currency.to_s.length < 3 fail ArgumentError, 'invalid value for "source_currency", the character length must be great than or equal to 3.' end pattern = Regexp.new(/^[A-Z]{3}$/) if source_currency !~ pattern fail ArgumentError, "invalid value for \"source_currency\", must conform to the pattern #{pattern}." end @source_currency = source_currency end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/velopayments/models/quote_fx_summary.rb, line 315 def status=(status) validator = EnumAttributeValidator.new('String', ["UNQUOTED", "QUOTED", "EXPIRED", "EXECUTED", "REJECTED"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/velopayments/models/quote_fx_summary.rb, line 435 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/velopayments/models/quote_fx_summary.rb, line 423 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/velopayments/models/quote_fx_summary.rb, line 234 def valid? return false if @rate.nil? return false if @creation_time.nil? return false if @quote_id.nil? return false if @total_source_amount.nil? return false if @total_payment_amount.nil? return false if @source_currency.nil? return false if @source_currency.to_s.length > 3 return false if @source_currency.to_s.length < 3 return false if @source_currency !~ Regexp.new(/^[A-Z]{3}$/) return false if @payment_currency.nil? return false if @payment_currency.to_s.length > 3 return false if @payment_currency.to_s.length < 3 return false if @payment_currency !~ Regexp.new(/^[A-Z]{3}$/) return false if @funding_status.nil? funding_status_validator = EnumAttributeValidator.new('String', ["UNFUNDED", "INSTRUCTED", "FUNDED"]) return false unless funding_status_validator.valid?(@funding_status) return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["UNQUOTED", "QUOTED", "EXPIRED", "EXECUTED", "REJECTED"]) return false unless status_validator.valid?(@status) true end