Class: Io::Flow::V0::Models::Refund
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::Refund
- 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
-
#amount ⇒ Object
readonly
Returns the value of attribute amount.
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#authorization ⇒ Object
readonly
Returns the value of attribute authorization.
-
#base ⇒ Object
readonly
Returns the value of attribute base.
-
#captures ⇒ Object
readonly
Returns the value of attribute captures.
-
#created_at ⇒ Object
readonly
Returns the value of attribute created_at.
-
#currency ⇒ Object
readonly
Returns the value of attribute currency.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#key ⇒ Object
readonly
Returns the value of attribute key.
-
#requested ⇒ Object
readonly
Returns the value of attribute requested.
-
#status ⇒ Object
readonly
Returns the value of attribute status.
Instance Method Summary collapse
- #copy(incoming = {}) ⇒ Object
-
#initialize(incoming = {}) ⇒ Refund
constructor
A new instance of Refund.
- #to_hash ⇒ Object
- #to_json ⇒ Object
Constructor Details
#initialize(incoming = {}) ⇒ Refund
Returns a new instance of Refund.
62918 62919 62920 62921 62922 62923 62924 62925 62926 62927 62928 62929 62930 62931 62932 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62918 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) @requested = (x = opts.delete(:requested); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Money) ? x : ::Io::Flow::V0::Models::Money.new(x))) @captures = HttpClient::Preconditions.assert_class('captures', opts.delete(:captures), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::RefundCaptureSummary) ? x : ::Io::Flow::V0::Models::RefundCaptureSummary.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 }) @status = (x = (x = opts.delete(:status); x.nil? ? "succeeded" : x); x.is_a?(::Io::Flow::V0::Models::RefundStatus) ? x : ::Io::Flow::V0::Models::RefundStatus.apply(x)) @base = (x = opts.delete(:base); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Money) ? x : ::Io::Flow::V0::Models::Money.new(x))) end |
Instance Attribute Details
#amount ⇒ Object (readonly)
Returns the value of attribute amount.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def amount @amount end |
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def attributes @attributes end |
#authorization ⇒ Object (readonly)
Returns the value of attribute authorization.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def @authorization end |
#base ⇒ Object (readonly)
Returns the value of attribute base.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def base @base end |
#captures ⇒ Object (readonly)
Returns the value of attribute captures.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def captures @captures end |
#created_at ⇒ Object (readonly)
Returns the value of attribute created_at.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def created_at @created_at end |
#currency ⇒ Object (readonly)
Returns the value of attribute currency.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def currency @currency end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def id @id end |
#key ⇒ Object (readonly)
Returns the value of attribute key.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def key @key end |
#requested ⇒ Object (readonly)
Returns the value of attribute requested.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def requested @requested end |
#status ⇒ Object (readonly)
Returns the value of attribute status.
62916 62917 62918 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62916 def status @status end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
62938 62939 62940 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62938 def copy(incoming={}) Refund.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#to_hash ⇒ Object
62942 62943 62944 62945 62946 62947 62948 62949 62950 62951 62952 62953 62954 62955 62956 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62942 def to_hash { :id => id, :key => key, :authorization => .to_hash, :amount => amount.to_f.to_s, :currency => currency, :requested => requested.nil? ? nil : requested.to_hash, :captures => captures.map { |o| o.to_hash }, :created_at => created_at, :attributes => attributes.nil? ? nil : attributes, :status => status.value, :base => base.nil? ? nil : base.to_hash } end |
#to_json ⇒ Object
62934 62935 62936 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62934 def to_json JSON.dump(to_hash) end |