Class: Io::Flow::V0::Models::Refund

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

Overview

Refunds can be created against either a specific capture or an authorization (in which case we will select 1 or more specific captures against which to execute the refund).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Refund

Returns a new instance of Refund.



23109
23110
23111
23112
23113
23114
23115
23116
23117
23118
23119
23120
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23109

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :key, :authorization, :amount, :currency, :captures, :created_at], 'Refund')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @authorization = (x = opts.delete(:authorization); x.is_a?(::Io::Flow::V0::Models::AuthorizationReference) ? x : ::Io::Flow::V0::Models::AuthorizationReference.new(x))
  @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)
  @captures = HttpClient::Preconditions.assert_class('captures', opts.delete(:captures), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::RefundCapture) ? x : ::Io::Flow::V0::Models::RefundCapture.new(x)) }
  @created_at = HttpClient::Preconditions.assert_class('created_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:created_at)), DateTime)
  @attributes = (x = opts.delete(:attributes); x.nil? ? nil : HttpClient::Preconditions.assert_class('attributes', x, Hash).inject({}) { |h, d| h[d[0]] = HttpClient::Preconditions.assert_class('attributes', d[1], String); h })
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def attributes
  @attributes
end

#authorization ⇒ Object (readonly)

Returns the value of attribute authorization.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def authorization
  @authorization
end

#captures ⇒ Object (readonly)

Returns the value of attribute captures.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def captures
  @captures
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def currency
  @currency
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def id
  @id
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



23107
23108
23109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23107

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



23126
23127
23128
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23126

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

#to_hash ⇒ Object 



23130
23131
23132
23133
23134
23135
23136
23137
23138
23139
23140
23141
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23130

def to_hash
  {
    :id => id,
    :key => key,
    :authorization => authorization.to_hash,
    :amount => amount,
    :currency => currency,
    :captures => captures.map { |o| o.to_hash },
    :created_at => created_at,
    :attributes => attributes.nil? ? nil : attributes
  }
end

#to_json ⇒ Object 



23122
23123
23124
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 23122

def to_json
  JSON.dump(to_hash)
end