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.



24345
24346
24347
24348
24349
24350
24351
24352
24353
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24345

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.



24343
24344
24345
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24343

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



24343
24344
24345
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24343

def attributes
  @attributes
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



24343
24344
24345
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24343

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



24343
24344
24345
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24343

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



24343
24344
24345
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24343

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



24359
24360
24361
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24359

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

#to_hash ⇒ Object 



24363
24364
24365
24366
24367
24368
24369
24370
24371
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24363

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 



24355
24356
24357
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24355

def to_json
  JSON.dump(to_hash)
end