class SquareConnect::Refund

Represents a refund processed for a Square transaction.

Attributes

additional_recipients[RW]

Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.

amount_money[RW]

The amount of money refunded to the buyer.

created_at[RW]

The time when the refund was created, in RFC 3339 format.

id[RW]

The refund's unique ID.

location_id[RW]

The ID of the refund's associated location.

processing_fee_money[RW]

The amount of Square processing fee money refunded to the merchant.

reason[RW]

The reason for the refund being issued.

status[RW]

The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`). See [RefundStatus](type-refundstatus) for possible values

tender_id[RW]

The ID of the refunded tender.

transaction_id[RW]

The ID of the transaction that the refunded tender is part of.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/refund.rb, line 47
def self.attribute_map
  {
    :'id' => :'id',
    :'location_id' => :'location_id',
    :'transaction_id' => :'transaction_id',
    :'tender_id' => :'tender_id',
    :'created_at' => :'created_at',
    :'reason' => :'reason',
    :'amount_money' => :'amount_money',
    :'status' => :'status',
    :'processing_fee_money' => :'processing_fee_money',
    :'additional_recipients' => :'additional_recipients'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/square_connect/models/refund.rb, line 80
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'location_id')
    self.location_id = attributes[:'location_id']
  end

  if attributes.has_key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end

  if attributes.has_key?(:'tender_id')
    self.tender_id = attributes[:'tender_id']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'reason')
    self.reason = attributes[:'reason']
  end

  if attributes.has_key?(:'amount_money')
    self.amount_money = attributes[:'amount_money']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'processing_fee_money')
    self.processing_fee_money = attributes[:'processing_fee_money']
  end

  if attributes.has_key?(:'additional_recipients')
    if (value = attributes[:'additional_recipients']).is_a?(Array)
      self.additional_recipients = value
    end
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/refund.rb, line 63
def self.swagger_types
  {
    :'id' => :'String',
    :'location_id' => :'String',
    :'transaction_id' => :'String',
    :'tender_id' => :'String',
    :'created_at' => :'String',
    :'reason' => :'String',
    :'amount_money' => :'Money',
    :'status' => :'String',
    :'processing_fee_money' => :'Money',
    :'additional_recipients' => :'Array<AdditionalRecipient>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/square_connect/models/refund.rb, line 180
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      location_id == o.location_id &&
      transaction_id == o.transaction_id &&
      tender_id == o.tender_id &&
      created_at == o.created_at &&
      reason == o.reason &&
      amount_money == o.amount_money &&
      status == o.status &&
      processing_fee_money == o.processing_fee_money &&
      additional_recipients == o.additional_recipients
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/square_connect/models/refund.rb, line 231
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
    temp_model = SquareConnect.const_get(type).new
    temp_model.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/square_connect/models/refund.rb, line 297
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/square_connect/models/refund.rb, line 210
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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/square_connect/models/refund.rb, line 197
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/square_connect/models/refund.rb, line 203
def hash
  [id, location_id, transaction_id, tender_id, created_at, reason, amount_money, status, processing_fee_money, additional_recipients].hash
end
list_invalid_properties() click to toggle source

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

# File lib/square_connect/models/refund.rb, line 132
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

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

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

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

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

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

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

  return 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/square_connect/models/refund.rb, line 277
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/square_connect/models/refund.rb, line 283
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/square_connect/models/refund.rb, line 271
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/square_connect/models/refund.rb, line 167
def valid?
  return false if @id.nil?
  return false if @location_id.nil?
  return false if @transaction_id.nil?
  return false if @tender_id.nil?
  return false if @reason.nil?
  return false if @amount_money.nil?
  return false if @status.nil?
  return true
end