class VeloPayments::GetPaymentsForPayoutResponseV4Summary

Attributes

confirmed_payments[RW]

The count of payments within the payout which have been confirmed.

incomplete_payments[RW]

The count of payments within the payout which are incomplete.

instructed[RW]
instructed_date_time[RW]

The date/time at which the payout was instructed.

payout_from[RW]
payout_memo[RW]

The memo attached to the payout.

payout_status[RW]

The current status of the payout.

payout_to[RW]
payout_type[RW]
quoted[RW]
quoted_date_time[RW]

The date/time at which the payout was quoted.

released_payments[RW]

The count of payments within the payout which have been released.

returned_payments[RW]

The count of payments within the payout which have been returned.

submitted_date_time[RW]

The date/time at which the payout was submitted.

submitting[RW]
total_payments[RW]

The count of payments within the payout.

withdrawn[RW]
withdrawn_date_time[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb, line 86
def self.attribute_map
  {
    :'payout_status' => :'payoutStatus',
    :'submitted_date_time' => :'submittedDateTime',
    :'instructed_date_time' => :'instructedDateTime',
    :'withdrawn_date_time' => :'withdrawnDateTime',
    :'quoted_date_time' => :'quotedDateTime',
    :'payout_memo' => :'payoutMemo',
    :'total_payments' => :'totalPayments',
    :'confirmed_payments' => :'confirmedPayments',
    :'released_payments' => :'releasedPayments',
    :'incomplete_payments' => :'incompletePayments',
    :'returned_payments' => :'returnedPayments',
    :'payout_type' => :'payoutType',
    :'submitting' => :'submitting',
    :'payout_from' => :'payoutFrom',
    :'payout_to' => :'payoutTo',
    :'quoted' => :'quoted',
    :'instructed' => :'instructed',
    :'withdrawn' => :'withdrawn'
  }
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/get_payments_for_payout_response_v4_summary.rb, line 292
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/get_payments_for_payout_response_v4_summary.rb, line 141
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::GetPaymentsForPayoutResponseV4Summary` 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::GetPaymentsForPayoutResponseV4Summary`. 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?(:'payout_status')
    self.payout_status = attributes[:'payout_status']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb, line 110
def self.openapi_types
  {
    :'payout_status' => :'String',
    :'submitted_date_time' => :'DateTime',
    :'instructed_date_time' => :'DateTime',
    :'withdrawn_date_time' => :'DateTime',
    :'quoted_date_time' => :'DateTime',
    :'payout_memo' => :'String',
    :'total_payments' => :'Integer',
    :'confirmed_payments' => :'Integer',
    :'released_payments' => :'Integer',
    :'incomplete_payments' => :'Integer',
    :'returned_payments' => :'Integer',
    :'payout_type' => :'PayoutTypeV4',
    :'submitting' => :'PayoutPayorV4',
    :'payout_from' => :'PayoutPayorV4',
    :'payout_to' => :'PayoutPayorV4',
    :'quoted' => :'PayoutPrincipalV4',
    :'instructed' => :'PayoutPrincipalV4',
    :'withdrawn' => :'PayoutPrincipalV4'
  }
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/get_payments_for_payout_response_v4_summary.rb, line 254
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payout_status == o.payout_status &&
      submitted_date_time == o.submitted_date_time &&
      instructed_date_time == o.instructed_date_time &&
      withdrawn_date_time == o.withdrawn_date_time &&
      quoted_date_time == o.quoted_date_time &&
      payout_memo == o.payout_memo &&
      total_payments == o.total_payments &&
      confirmed_payments == o.confirmed_payments &&
      released_payments == o.released_payments &&
      incomplete_payments == o.incomplete_payments &&
      returned_payments == o.returned_payments &&
      payout_type == o.payout_type &&
      submitting == o.submitting &&
      payout_from == o.payout_from &&
      payout_to == o.payout_to &&
      quoted == o.quoted &&
      instructed == o.instructed &&
      withdrawn == o.withdrawn
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/get_payments_for_payout_response_v4_summary.rb, line 320
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/get_payments_for_payout_response_v4_summary.rb, line 389
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/get_payments_for_payout_response_v4_summary.rb, line 299
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/get_payments_for_payout_response_v4_summary.rb, line 279
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/get_payments_for_payout_response_v4_summary.rb, line 285
def hash
  [payout_status, submitted_date_time, instructed_date_time, withdrawn_date_time, quoted_date_time, payout_memo, total_payments, confirmed_payments, released_payments, incomplete_payments, returned_payments, payout_type, submitting, payout_from, payout_to, quoted, instructed, withdrawn].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/get_payments_for_payout_response_v4_summary.rb, line 229
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
payout_status=(payout_status) click to toggle source

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

# File lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb, line 244
def payout_status=(payout_status)
  validator = EnumAttributeValidator.new('String', ["ACCEPTED", "REJECTED", "SUBMITTED", "QUOTED", "INSTRUCTED", "COMPLETED", "INCOMPLETE", "CONFIRMED", "WITHDRAWN"])
  unless validator.valid?(payout_status)
    fail ArgumentError, "invalid value for \"payout_status\", must be one of #{validator.allowable_values}."
  end
  @payout_status = payout_status
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/get_payments_for_payout_response_v4_summary.rb, line 365
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/get_payments_for_payout_response_v4_summary.rb, line 371
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/get_payments_for_payout_response_v4_summary.rb, line 359
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/get_payments_for_payout_response_v4_summary.rb, line 236
def valid?
  payout_status_validator = EnumAttributeValidator.new('String', ["ACCEPTED", "REJECTED", "SUBMITTED", "QUOTED", "INSTRUCTED", "COMPLETED", "INCOMPLETE", "CONFIRMED", "WITHDRAWN"])
  return false unless payout_status_validator.valid?(@payout_status)
  true
end