Class: Io::Flow::V0::Models::CaptureForm

Inherits:

Object

• Object
• Io::Flow::V0::Models::CaptureForm

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

• #amount ⇒ Object readonly

  Returns the value of attribute amount.

• #attributes ⇒ Object readonly

  Returns the value of attribute attributes.

• #authorization_id ⇒ Object readonly

  Returns the value of attribute authorization_id.

• #currency ⇒ Object readonly

  Returns the value of attribute currency.

• #key ⇒ Object readonly

  Returns the value of attribute key.

Instance Method Summary

• #copy(incoming = {}) ⇒ Object
• #initialize(incoming = {}) ⇒ CaptureForm constructor

  A new instance of CaptureForm.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ CaptureForm

Returns a new instance of CaptureForm.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11618

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.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11616

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11616

def attributes
  @attributes
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11616

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11616

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11616

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11632

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

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11636

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

#to_json ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11628

def to_json
  JSON.dump(to_hash)
end