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.



10181
10182
10183
10184
10185
10186
10187
10188
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10181

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))
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



10179
10180
10181
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10179

def amount
  @amount
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



10179
10180
10181
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10179

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



10179
10180
10181
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10179

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



10179
10180
10181
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10179

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



10194
10195
10196
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10194

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

#to_hash ⇒ Object 



10198
10199
10200
10201
10202
10203
10204
10205
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10198

def to_hash
  {
    :authorization_id => authorization_id,
    :key => key,
    :amount => amount,
    :currency => currency
  }
end

#to_json ⇒ Object 



10190
10191
10192
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10190

def to_json
  JSON.dump(to_hash)
end