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.



7197
7198
7199
7200
7201
7202
7203
7204
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7197

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))
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



7195
7196
7197
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7195

def amount
  @amount
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.



7195
7196
7197
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7195

def authorization_id
  @authorization_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



7195
7196
7197
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7195

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



7195
7196
7197
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7195

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



7210
7211
7212
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7210

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

#to_hash ⇒ Object 



7214
7215
7216
7217
7218
7219
7220
7221
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7214

def to_hash
  {
    :authorization_id => authorization_id,
    :key => key,
    :amount => amount,
    :currency => currency
  }
end

#to_json ⇒ Object 



7206
7207
7208
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 7206

def to_json
  JSON.dump(to_hash)
end