Class: Io::Flow::V0::Models::Capture

Inherits:

Object

• Object
• Io::Flow::V0::Models::Capture

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.

• #authorization ⇒ Object readonly

  Returns the value of attribute authorization.

• #created_at ⇒ Object readonly

  Returns the value of attribute created_at.

• #currency ⇒ Object readonly

  Returns the value of attribute currency.

• #id ⇒ Object readonly

  Returns the value of attribute id.

• #key ⇒ Object readonly

  Returns the value of attribute key.

Instance Method Summary

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

  A new instance of Capture.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ Capture

Returns a new instance of Capture.

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

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :key, :authorization, :amount, :currency, :created_at], 'Capture')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @authorization = (x = opts.delete(:authorization); x.is_a?(::Io::Flow::V0::Models::AuthorizationReference) ? x : ::Io::Flow::V0::Models::AuthorizationReference.new(x))
  @amount = HttpClient::Preconditions.assert_class('amount', HttpClient::Helper.to_big_decimal(opts.delete(:amount)), BigDecimal)
  @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
  @created_at = HttpClient::Preconditions.assert_class('created_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:created_at)), DateTime)
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.

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

def amount
  @amount
end

#authorization ⇒ Object (readonly)

Returns the value of attribute authorization.

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

def authorization
  @authorization
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.

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

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.

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

def currency
  @currency
end

#id ⇒ Object (readonly)

Returns the value of attribute id.

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

def id
  @id
end

#key ⇒ Object (readonly)

Returns the value of attribute key.

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

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

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

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

#to_hash ⇒ Object

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

def to_hash
  {
    :id => id,
    :key => key,
    :authorization => authorization.to_hash,
    :amount => amount,
    :currency => currency,
    :created_at => created_at
  }
end

#to_json ⇒ Object

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

def to_json
  JSON.dump(to_hash)
end