class VeloPayments::AcceptedPayment

Attributes

amount[RW]
currency_type[RW]

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.

payment_memo[RW]
payor_payment_id[RW]
remote_id[RW]
source_account_name[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/velopayments/models/accepted_payment.rb, line 31
def self.attribute_map
  {
    :'remote_id' => :'remoteId',
    :'currency_type' => :'currencyType',
    :'amount' => :'amount',
    :'source_account_name' => :'sourceAccountName',
    :'payor_payment_id' => :'payorPaymentId',
    :'payment_memo' => :'paymentMemo'
  }
end
build_from_hash(attributes) click to toggle source

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/accepted_payment.rb, line 205
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/velopayments/models/accepted_payment.rb, line 62
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::AcceptedPayment` 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::AcceptedPayment`. 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?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

  if attributes.key?(:'currency_type')
    self.currency_type = attributes[:'currency_type']
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'source_account_name')
    self.source_account_name = attributes[:'source_account_name']
  end

  if attributes.key?(:'payor_payment_id')
    self.payor_payment_id = attributes[:'payor_payment_id']
  end

  if attributes.key?(:'payment_memo')
    self.payment_memo = attributes[:'payment_memo']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/velopayments/models/accepted_payment.rb, line 55
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/velopayments/models/accepted_payment.rb, line 43
def self.openapi_types
  {
    :'remote_id' => :'String',
    :'currency_type' => :'String',
    :'amount' => :'Integer',
    :'source_account_name' => :'String',
    :'payor_payment_id' => :'String',
    :'payment_memo' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/velopayments/models/accepted_payment.rb, line 179
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      remote_id == o.remote_id &&
      currency_type == o.currency_type &&
      amount == o.amount &&
      source_account_name == o.source_account_name &&
      payor_payment_id == o.payor_payment_id &&
      payment_memo == o.payment_memo
end
_deserialize(type, value) click to toggle source

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/accepted_payment.rb, line 233
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
_to_hash(value) click to toggle source

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/accepted_payment.rb, line 302
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
build_from_hash(attributes) click to toggle source

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/accepted_payment.rb, line 212
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
currency_type=(currency_type) click to toggle source

Custom attribute writer method with validation @param [Object] currency_type Value to be assigned

# File lib/velopayments/models/accepted_payment.rb, line 156
def currency_type=(currency_type)
  if currency_type.nil?
    fail ArgumentError, 'currency_type cannot be nil'
  end

  if currency_type.to_s.length > 3
    fail ArgumentError, 'invalid value for "currency_type", the character length must be smaller than or equal to 3.'
  end

  if currency_type.to_s.length < 3
    fail ArgumentError, 'invalid value for "currency_type", the character length must be great than or equal to 3.'
  end

  pattern = Regexp.new(/^[A-Z]{3}$/)
  if currency_type !~ pattern
    fail ArgumentError, "invalid value for \"currency_type\", must conform to the pattern #{pattern}."
  end

  @currency_type = currency_type
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/velopayments/models/accepted_payment.rb, line 192
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/velopayments/models/accepted_payment.rb, line 198
def hash
  [remote_id, currency_type, amount, source_account_name, payor_payment_id, payment_memo].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/velopayments/models/accepted_payment.rb, line 102
def list_invalid_properties
  invalid_properties = Array.new
  if @remote_id.nil?
    invalid_properties.push('invalid value for "remote_id", remote_id cannot be nil.')
  end

  if @currency_type.nil?
    invalid_properties.push('invalid value for "currency_type", currency_type cannot be nil.')
  end

  if @currency_type.to_s.length > 3
    invalid_properties.push('invalid value for "currency_type", the character length must be smaller than or equal to 3.')
  end

  if @currency_type.to_s.length < 3
    invalid_properties.push('invalid value for "currency_type", the character length must be great than or equal to 3.')
  end

  pattern = Regexp.new(/^[A-Z]{3}$/)
  if @currency_type !~ pattern
    invalid_properties.push("invalid value for \"currency_type\", must conform to the pattern #{pattern}.")
  end

  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @source_account_name.nil?
    invalid_properties.push('invalid value for "source_account_name", source_account_name cannot be nil.')
  end

  if @payor_payment_id.nil?
    invalid_properties.push('invalid value for "payor_payment_id", payor_payment_id cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/velopayments/models/accepted_payment.rb, line 278
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/velopayments/models/accepted_payment.rb, line 284
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/velopayments/models/accepted_payment.rb, line 272
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/velopayments/models/accepted_payment.rb, line 142
def valid?
  return false if @remote_id.nil?
  return false if @currency_type.nil?
  return false if @currency_type.to_s.length > 3
  return false if @currency_type.to_s.length < 3
  return false if @currency_type !~ Regexp.new(/^[A-Z]{3}$/)
  return false if @amount.nil?
  return false if @source_account_name.nil?
  return false if @payor_payment_id.nil?
  true
end