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.



12746
12747
12748
12749
12750
12751
12752
12753
12754
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12746

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.



12744
12745
12746
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12744

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



12744
12745
12746
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12744

def attributes
  @attributes
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



12744
12745
12746
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12744

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



12744
12745
12746
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12744

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



12744
12745
12746
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12744

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



12760
12761
12762
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12760

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

#to_hash ⇒ Object 



12764
12765
12766
12767
12768
12769
12770
12771
12772
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12764

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

#to_json ⇒ Object 



12756
12757
12758
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12756

def to_json
  JSON.dump(to_hash)
end