Class: Io::Flow::V0::Models::CardAuthorization

Inherits:
Authorization show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

An authorization is used to check and reserve funds w/ a given payment method. No funds are actually transferred; once you have you an authorization, you can capture up to the amount of the authorization.

Instance Attribute Summary collapse

Attributes inherited from Authorization

#discriminator

Instance Method Summary collapse

Methods inherited from Authorization

from_json, #to_hash

Constructor Details

#initialize(incoming = {}) ⇒ CardAuthorization

Returns a new instance of CardAuthorization.



15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15236

def initialize(incoming={})
  super(:discriminator => Authorization::Types::CARD_AUTHORIZATION)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :key, :card, :amount, :currency, :customer, :attributes, :result, :created_at], 'CardAuthorization')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @method = (x = opts.delete(:method); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::PaymentMethod) ? x : ::Io::Flow::V0::Models::PaymentMethod.new(x)))
  @card = (x = opts.delete(:card); x.is_a?(::Io::Flow::V0::Models::ExpandableCard) ? x : ::Io::Flow::V0::Models::ExpandableCard.from_json(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)
  @requested = (x = opts.delete(:requested); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Money) ? x : ::Io::Flow::V0::Models::Money.new(x)))
  @customer = (x = opts.delete(:customer); x.is_a?(::Io::Flow::V0::Models::Customer) ? x : ::Io::Flow::V0::Models::Customer.new(x))
  @attributes = HttpClient::Preconditions.assert_class('attributes', opts.delete(:attributes), Hash).inject({}) { |h, d| h[d[0]] = HttpClient::Preconditions.assert_class('attributes', d[1], String); h }
  @destination = (x = opts.delete(:destination); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Address) ? x : ::Io::Flow::V0::Models::Address.new(x)))
  @order = (x = opts.delete(:order); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::AuthorizationOrderReference) ? x : ::Io::Flow::V0::Models::AuthorizationOrderReference.new(x)))
  @ip = (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String))
  @result = (x = opts.delete(:result); x.is_a?(::Io::Flow::V0::Models::AuthorizationResult) ? x : ::Io::Flow::V0::Models::AuthorizationResult.new(x))
  @created_at = HttpClient::Preconditions.assert_class('created_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:created_at)), DateTime)
  @expires_at = (x = opts.delete(:expires_at); x.nil? ? nil : HttpClient::Preconditions.assert_class('expires_at', HttpClient::Helper.to_date_time_iso8601(x), DateTime))
end

Instance Attribute Details

#amountObject (readonly)

Returns the value of attribute amount.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def amount
  @amount
end

#attributesObject (readonly)

Returns the value of attribute attributes.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def attributes
  @attributes
end

#cardObject (readonly)

Returns the value of attribute card.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def card
  @card
end

#created_atObject (readonly)

Returns the value of attribute created_at.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def created_at
  @created_at
end

#currencyObject (readonly)

Returns the value of attribute currency.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def currency
  @currency
end

#customerObject (readonly)

Returns the value of attribute customer.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def customer
  @customer
end

#destinationObject (readonly)

Returns the value of attribute destination.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def destination
  @destination
end

#expires_atObject (readonly)

Returns the value of attribute expires_at.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def expires_at
  @expires_at
end

#idObject (readonly)

Returns the value of attribute id.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def id
  @id
end

#ipObject (readonly)

Returns the value of attribute ip.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def ip
  @ip
end

#keyObject (readonly)

Returns the value of attribute key.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def key
  @key
end

#methodObject (readonly)

Returns the value of attribute method.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def method
  @method
end

#orderObject (readonly)

Returns the value of attribute order.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def order
  @order
end

#requestedObject (readonly)

Returns the value of attribute requested.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def requested
  @requested
end

#resultObject (readonly)

Returns the value of attribute result.



15234
15235
15236
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15234

def result
  @result
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



15261
15262
15263
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15261

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

#subtype_to_hashObject



15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15265

def subtype_to_hash
  {
    :id => id,
    :key => key,
    :method => method.nil? ? nil : method.to_hash,
    :card => card.to_hash,
    :amount => amount,
    :currency => currency,
    :requested => requested.nil? ? nil : requested.to_hash,
    :customer => customer.to_hash,
    :attributes => attributes,
    :destination => destination.nil? ? nil : destination.to_hash,
    :order => order.nil? ? nil : order.to_hash,
    :ip => ip,
    :result => result.to_hash,
    :created_at => created_at,
    :expires_at => expires_at
  }
end

#to_jsonObject



15257
15258
15259
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15257

def to_json
  JSON.dump(to_hash)
end