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.



18538
18539
18540
18541
18542
18543
18544
18545
18546
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18538

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.



18536
18537
18538
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18536

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



18536
18537
18538
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18536

def attributes
  @attributes
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



18536
18537
18538
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18536

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



18536
18537
18538
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18536

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



18536
18537
18538
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18536

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



18552
18553
18554
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18552

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

#to_hash ⇒ Object 



18556
18557
18558
18559
18560
18561
18562
18563
18564
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18556

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

#to_json ⇒ Object 



18548
18549
18550
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18548

def to_json
  JSON.dump(to_hash)
end