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.



6539
6540
6541
6542
6543
6544
6545
6546
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6539

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.



6537
6538
6539
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6537

def amount
  @amount
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



6537
6538
6539
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6537

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



6537
6538
6539
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6537

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



6537
6538
6539
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6537

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



6552
6553
6554
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6552

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

#to_hash ⇒ Object 



6556
6557
6558
6559
6560
6561
6562
6563
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6556

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

#to_json ⇒ Object 



6548
6549
6550
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 6548

def to_json
  JSON.dump(to_hash)
end