class VeloPayments::PaymentEventResponseV3

Attributes

account_name[RW]
account_number[RW]

The account number attached to the event.

event_date_time[RW]

The date/time at which the event occurred.

event_id[RW]

The id of the event.

event_type[RW]

The type of the event.

iban[RW]
payment_amount[RW]

The destination amount exposed by the event.

payment_currency[RW]
principal[RW]
routing_number[RW]

The routing number attached to the event.

source_amount[RW]

The source amount exposed by the event.

source_currency[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/velopayments/models/payment_event_response_v3.rb, line 71
def self.attribute_map
  {
    :'event_id' => :'eventId',
    :'event_date_time' => :'eventDateTime',
    :'event_type' => :'eventType',
    :'source_currency' => :'sourceCurrency',
    :'source_amount' => :'sourceAmount',
    :'payment_currency' => :'paymentCurrency',
    :'payment_amount' => :'paymentAmount',
    :'account_number' => :'accountNumber',
    :'routing_number' => :'routingNumber',
    :'iban' => :'iban',
    :'account_name' => :'accountName',
    :'principal' => :'principal'
  }
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/payment_event_response_v3.rb, line 250
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/payment_event_response_v3.rb, line 114
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PaymentEventResponseV3` 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::PaymentEventResponseV3`. 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?(:'event_id')
    self.event_id = attributes[:'event_id']
  end

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/velopayments/models/payment_event_response_v3.rb, line 89
def self.openapi_types
  {
    :'event_id' => :'String',
    :'event_date_time' => :'DateTime',
    :'event_type' => :'String',
    :'source_currency' => :'PaymentAuditCurrencyV3',
    :'source_amount' => :'Integer',
    :'payment_currency' => :'PaymentAuditCurrencyV3',
    :'payment_amount' => :'Integer',
    :'account_number' => :'String',
    :'routing_number' => :'String',
    :'iban' => :'String',
    :'account_name' => :'String',
    :'principal' => :'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/payment_event_response_v3.rb, line 218
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_id == o.event_id &&
      event_date_time == o.event_date_time &&
      event_type == o.event_type &&
      source_currency == o.source_currency &&
      source_amount == o.source_amount &&
      payment_currency == o.payment_currency &&
      payment_amount == o.payment_amount &&
      account_number == o.account_number &&
      routing_number == o.routing_number &&
      iban == o.iban &&
      account_name == o.account_name &&
      principal == o.principal
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/payment_event_response_v3.rb, line 278
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/payment_event_response_v3.rb, line 347
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/payment_event_response_v3.rb, line 257
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
eql?(o) click to toggle source

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

# File lib/velopayments/models/payment_event_response_v3.rb, line 237
def eql?(o)
  self == o
end
event_type=(event_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] event_type Object to be assigned

# File lib/velopayments/models/payment_event_response_v3.rb, line 208
def event_type=(event_type)
  validator = EnumAttributeValidator.new('String', ["PAYOUT_SUBMITTED", "PAYOUT_COMPLETED", "PAYOUT_INSTRUCTED_V3", "BANK_PAYMENT_REQUESTED", "SOURCE_AMOUNT_CONFIRMED", "PAYMENT_SUBMITTED", "PAYMENT_SUBMITTED_ACCEPTED", "PAYMENT_SUBMITTED_REJECTED", "PAYMENT_CONFIRMED", "PAYMENT_AWAITING_FUNDS", "PAYMENT_FUNDED", "PAYMENT_UNFUNDED", "PAYMENT_FAILED", "ACH_SUBMITTED_TO_ODFI", "PAYMENT_ACCEPTED_BY_RAILS", "ACH_RETURN_RECEIVED", "RETURN_PAYMENT_FUNDING_REQUESTED", "PAYOUT_BATCH_EXECUTED", "PAYOUT_BATCH_QUOTE_EXPIRED", "PAYOUT_BATCH_FUNDED", "PAYOUT_BATCH_FUNDS_RETURN_REQUEST", "PAYOUT_BATCH_FUNDS_RETURNED", "PAYOUT_FUNDS_REQUEST", "PAYOUT_FUNDS_GRANTED", "PAYOUT_FUNDS_DENIED", "PAYOUT_BATCH_QUOTED", "PAYOUT_QUOTED", "ACH_PAYMENT_RETURN_CANCELLED", "RETURN_PAYMENT_CANCELLATION_REQUESTED", "PAYOUT_WITHDRAWN"])
  unless validator.valid?(event_type)
    fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
  end
  @event_type = event_type
end
hash() click to toggle source

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

# File lib/velopayments/models/payment_event_response_v3.rb, line 243
def hash
  [event_id, event_date_time, event_type, source_currency, source_amount, payment_currency, payment_amount, account_number, routing_number, iban, account_name, principal].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/payment_event_response_v3.rb, line 178
def list_invalid_properties
  invalid_properties = Array.new
  if @event_id.nil?
    invalid_properties.push('invalid value for "event_id", event_id cannot be nil.')
  end

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

  if @event_type.nil?
    invalid_properties.push('invalid value for "event_type", event_type 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/payment_event_response_v3.rb, line 323
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/payment_event_response_v3.rb, line 329
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/payment_event_response_v3.rb, line 317
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/payment_event_response_v3.rb, line 197
def valid?
  return false if @event_id.nil?
  return false if @event_date_time.nil?
  return false if @event_type.nil?
  event_type_validator = EnumAttributeValidator.new('String', ["PAYOUT_SUBMITTED", "PAYOUT_COMPLETED", "PAYOUT_INSTRUCTED_V3", "BANK_PAYMENT_REQUESTED", "SOURCE_AMOUNT_CONFIRMED", "PAYMENT_SUBMITTED", "PAYMENT_SUBMITTED_ACCEPTED", "PAYMENT_SUBMITTED_REJECTED", "PAYMENT_CONFIRMED", "PAYMENT_AWAITING_FUNDS", "PAYMENT_FUNDED", "PAYMENT_UNFUNDED", "PAYMENT_FAILED", "ACH_SUBMITTED_TO_ODFI", "PAYMENT_ACCEPTED_BY_RAILS", "ACH_RETURN_RECEIVED", "RETURN_PAYMENT_FUNDING_REQUESTED", "PAYOUT_BATCH_EXECUTED", "PAYOUT_BATCH_QUOTE_EXPIRED", "PAYOUT_BATCH_FUNDED", "PAYOUT_BATCH_FUNDS_RETURN_REQUEST", "PAYOUT_BATCH_FUNDS_RETURNED", "PAYOUT_FUNDS_REQUEST", "PAYOUT_FUNDS_GRANTED", "PAYOUT_FUNDS_DENIED", "PAYOUT_BATCH_QUOTED", "PAYOUT_QUOTED", "ACH_PAYMENT_RETURN_CANCELLED", "RETURN_PAYMENT_CANCELLATION_REQUESTED", "PAYOUT_WITHDRAWN"])
  return false unless event_type_validator.valid?(@event_type)
  true
end