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.



15042
15043
15044
15045
15046
15047
15048
15049
15050
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15042

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.



15040
15041
15042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15040

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



15040
15041
15042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15040

def attributes
  @attributes
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



15040
15041
15042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15040

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



15040
15041
15042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15040

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



15040
15041
15042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15040

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



15056
15057
15058
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15056

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

#to_hash ⇒ Object 



15060
15061
15062
15063
15064
15065
15066
15067
15068
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15060

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

#to_json ⇒ Object 



15052
15053
15054
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15052

def to_json
  JSON.dump(to_hash)
end