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.



37241
37242
37243
37244
37245
37246
37247
37248
37249
37250
37251
37252
37253
37254
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37241

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

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def attributes
  @attributes
end

#authorization ⇒ Object (readonly)

Returns the value of attribute authorization.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def authorization
  @authorization
end

#base ⇒ Object (readonly)

Returns the value of attribute base.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def base
  @base
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def currency
  @currency
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def id
  @id
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def key
  @key
end

#requested ⇒ Object (readonly)

Returns the value of attribute requested.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def requested
  @requested
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



37239
37240
37241
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37239

def status
  @status
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



37260
37261
37262
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37260

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

#to_hash ⇒ Object 



37264
37265
37266
37267
37268
37269
37270
37271
37272
37273
37274
37275
37276
37277
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37264

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

#to_json ⇒ Object 



37256
37257
37258
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 37256

def to_json
  JSON.dump(to_hash)
end