Class: Io::Flow::V0::Models::Reversal

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

Overview

A reversal is used to clear an authorization (full or partial).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Reversal

Returns a new instance of Reversal.



37800
37801
37802
37803
37804
37805
37806
37807
37808
37809
37810
37811
37812
37813
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37800

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :key, :authorization, :status, :amount, :currency, :requested, :created_at, :attributes], 'Reversal')
  @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))
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::ReversalStatus) ? x : ::Io::Flow::V0::Models::ReversalStatus.apply(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.is_a?(::Io::Flow::V0::Models::Money) ? x : ::Io::Flow::V0::Models::Money.new(x))
  @created_at = HttpClient::Preconditions.assert_class('created_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:created_at)), DateTime)
  @attributes = HttpClient::Preconditions.assert_class('attributes', opts.delete(:attributes), Hash).inject({}) { |h, d| h[d[0]] = HttpClient::Preconditions.assert_class('attributes', d[1], String); h }
  @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

#amountObject (readonly)

Returns the value of attribute amount.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def amount
  @amount
end

#attributesObject (readonly)

Returns the value of attribute attributes.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def attributes
  @attributes
end

#authorizationObject (readonly)

Returns the value of attribute authorization.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def authorization
  @authorization
end

#baseObject (readonly)

Returns the value of attribute base.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def base
  @base
end

#created_atObject (readonly)

Returns the value of attribute created_at.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def created_at
  @created_at
end

#currencyObject (readonly)

Returns the value of attribute currency.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def currency
  @currency
end

#idObject (readonly)

Returns the value of attribute id.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def id
  @id
end

#keyObject (readonly)

Returns the value of attribute key.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def key
  @key
end

#requestedObject (readonly)

Returns the value of attribute requested.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def requested
  @requested
end

#statusObject (readonly)

Returns the value of attribute status.



37798
37799
37800
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37798

def status
  @status
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



37819
37820
37821
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37819

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

#to_hashObject



37823
37824
37825
37826
37827
37828
37829
37830
37831
37832
37833
37834
37835
37836
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37823

def to_hash
  {
    :id => id,
    :key => key,
    :authorization => authorization.to_hash,
    :status => status.value,
    :amount => amount.to_f.to_s,
    :currency => currency,
    :requested => requested.to_hash,
    :created_at => created_at,
    :attributes => attributes,
    :base => base.nil? ? nil : base.to_hash
  }
end

#to_jsonObject



37815
37816
37817
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37815

def to_json
  JSON.dump(to_hash)
end