Class: Io::Flow::V0::Models::CaptureForm

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

Overview

Capture actually transfers funds. You can capture as many times as you’d like up until the total amount of the authorization has been captured or the authorization otherwise becomes unavailable (e.g. expires).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ CaptureForm

Returns a new instance of CaptureForm.



24747
24748
24749
24750
24751
24752
24753
24754
24755
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24747

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:authorization_id], 'CaptureForm')
  @authorization_id = HttpClient::Preconditions.assert_class('authorization_id', opts.delete(:authorization_id), String)
  @key = (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, String))
  @amount = (x = opts.delete(:amount); x.nil? ? nil : HttpClient::Preconditions.assert_class('amount', HttpClient::Helper.to_big_decimal(x), BigDecimal))
  @currency = (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String))
  @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.



24745
24746
24747
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24745

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



24745
24746
24747
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24745

def attributes
  @attributes
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



24745
24746
24747
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24745

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



24745
24746
24747
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24745

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



24745
24746
24747
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24745

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



24761
24762
24763
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24761

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

#to_hash ⇒ Object 



24765
24766
24767
24768
24769
24770
24771
24772
24773
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24765

def to_hash
  {
    :authorization_id => authorization_id,
    :key => key,
    :amount => amount.to_f.to_s,
    :currency => currency,
    :attributes => attributes.nil? ? nil : attributes
  }
end

#to_json ⇒ Object 



24757
24758
24759
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24757

def to_json
  JSON.dump(to_hash)
end