Class: Io::Flow::V0::Models::PaymentRefund

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

A refund is used to return already captured funds back to the customer. The customer will see the amount credited back to them as a separate transaction.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ PaymentRefund

Returns a new instance of PaymentRefund.



58507
58508
58509
58510
58511
58512
58513
58514
58515
58516
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58507

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :amount, :currency, :created_at, :updated_at, :status], 'PaymentRefund')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @amount = HttpClient::Preconditions.assert_class('amount', HttpClient::Helper.to_big_decimal(opts.delete(:amount)), BigDecimal)
  @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
  @created_at = HttpClient::Preconditions.assert_class('created_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:created_at)), DateTime)
  @updated_at = HttpClient::Preconditions.assert_class('updated_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:updated_at)), DateTime)
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::PaymentRefundStatus) ? x : ::Io::Flow::V0::Models::PaymentRefundStatus.new(x))
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



58505
58506
58507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58505

def amount
  @amount
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



58505
58506
58507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58505

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



58505
58506
58507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58505

def currency
  @currency
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



58505
58506
58507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58505

def id
  @id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



58505
58506
58507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58505

def status
  @status
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



58505
58506
58507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58505

def updated_at
  @updated_at
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



58522
58523
58524
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58522

def copy(incoming={})
  PaymentRefund.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



58526
58527
58528
58529
58530
58531
58532
58533
58534
58535
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58526

def to_hash
  {
    :id => id,
    :amount => amount.to_f.to_s,
    :currency => currency,
    :created_at => created_at,
    :updated_at => updated_at,
    :status => status.to_hash
  }
end

#to_json ⇒ Object 



58518
58519
58520
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 58518

def to_json
  JSON.dump(to_hash)
end