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.



33106
33107
33108
33109
33110
33111
33112
33113
33114
33115
33116
33117
33118
33119
33120
33121
33122
33123
33124
33125
33126
33127
33128
33129
33130
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33106

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)
  @merchant_of_record = (x = (x = opts.delete(:merchant_of_record); x.nil? ? "flow" : x); x.is_a?(::Io::Flow::V0::Models::MerchantOfRecord) ? x : ::Io::Flow::V0::Models::MerchantOfRecord.apply(x))
  @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::OrderCustomer) ? x : ::Io::Flow::V0::Models::OrderCustomer.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)))
  @billing_address = (x = opts.delete(:billing_address); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::BillingAddress) ? x : ::Io::Flow::V0::Models::BillingAddress.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)))
  @payment_order_reference = (x = opts.delete(:payment_order_reference); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::PaymentOrderReference) ? x : ::Io::Flow::V0::Models::PaymentOrderReference.from_json(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))
  @base = (x = opts.delete(:base); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Money) ? x : ::Io::Flow::V0::Models::Money.new(x)))
  @processor = (x = opts.delete(:processor); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ExpandablePaymentProcessor) ? x : ::Io::Flow::V0::Models::ExpandablePaymentProcessor.from_json(x)))
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def amount
  @amount
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def attributes
  @attributes
end

#base ⇒ Object (readonly)

Returns the value of attribute base.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def base
  @base
end

#billing_address ⇒ Object (readonly)

Returns the value of attribute billing_address.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def billing_address
  @billing_address
end

#card ⇒ Object (readonly)

Returns the value of attribute card.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def card
  @card
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def currency
  @currency
end

#customer ⇒ Object (readonly)

Returns the value of attribute customer.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def customer
  @customer
end

#destination ⇒ Object (readonly)

Returns the value of attribute destination.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def destination
  @destination
end

#expires_at ⇒ Object (readonly)

Returns the value of attribute expires_at.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def id
  @id
end

#ip ⇒ Object (readonly)

Returns the value of attribute ip.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def ip
  @ip
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def key
  @key
end

#merchant_of_record ⇒ Object (readonly)

Returns the value of attribute merchant_of_record.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def merchant_of_record
  @merchant_of_record
end

#method ⇒ Object (readonly)

Returns the value of attribute method.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def method
  @method
end

#order ⇒ Object (readonly)

Returns the value of attribute order.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def order
  @order
end

#payment_order_reference ⇒ Object (readonly)

Returns the value of attribute payment_order_reference.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def payment_order_reference
  @payment_order_reference
end

#processor ⇒ Object (readonly)

Returns the value of attribute processor.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def processor
  @processor
end

#requested ⇒ Object (readonly)

Returns the value of attribute requested.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def requested
  @requested
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



33104
33105
33106
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33104

def result
  @result
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



33136
33137
33138
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33136

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

#subtype_to_hash ⇒ Object 



33140
33141
33142
33143
33144
33145
33146
33147
33148
33149
33150
33151
33152
33153
33154
33155
33156
33157
33158
33159
33160
33161
33162
33163
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33140

def subtype_to_hash
  {
    :id => id,
    :key => key,
    :merchant_of_record => merchant_of_record.value,
    :method => method.nil? ? nil : method.to_hash,
    :card => card.to_hash,
    :amount => amount.to_f.to_s,
    :currency => currency,
    :requested => requested.nil? ? nil : requested.to_hash,
    :customer => customer.to_hash,
    :attributes => attributes,
    :destination => destination.nil? ? nil : destination.to_hash,
    :billing_address => billing_address.nil? ? nil : billing_address.to_hash,
    :order => order.nil? ? nil : order.to_hash,
    :payment_order_reference => payment_order_reference.nil? ? nil : payment_order_reference.to_hash,
    :ip => ip,
    :result => result.to_hash,
    :created_at => created_at,
    :expires_at => expires_at,
    :base => base.nil? ? nil : base.to_hash,
    :processor => processor.nil? ? nil : processor.to_hash
  }
end

#to_json ⇒ Object 



33132
33133
33134
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33132

def to_json
  JSON.dump(to_hash)
end