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.



25019
25020
25021
25022
25023
25024
25025
25026
25027
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25019

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.



25017
25018
25019
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25017

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



25017
25018
25019
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25017

def attributes
  @attributes
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



25017
25018
25019
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25017

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



25017
25018
25019
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25017

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



25017
25018
25019
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25017

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



25033
25034
25035
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25033

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

#to_hash ⇒ Object 



25037
25038
25039
25040
25041
25042
25043
25044
25045
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25037

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

#to_json ⇒ Object 



25029
25030
25031
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 25029

def to_json
  JSON.dump(to_hash)
end