Class: Io::Flow::V0::Models::MerchantOfRecordAuthorizationForm

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

Overview

Creates an authorization for a transaction for which Flow is the merchant of record. In this case, you must provide your order number for a valid Flow order. 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 AuthorizationForm

#discriminator

Instance Method Summary collapse

Methods inherited from AuthorizationForm

from_json, #to_hash

Constructor Details

#initialize(incoming = {}) ⇒ MerchantOfRecordAuthorizationForm

Returns a new instance of MerchantOfRecordAuthorizationForm.



19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19601

def initialize(incoming={})
  super(:discriminator => AuthorizationForm::Types::MERCHANT_OF_RECORD_AUTHORIZATION_FORM)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:token, :order_number], 'MerchantOfRecordAuthorizationForm')
  @token = HttpClient::Preconditions.assert_class('token', opts.delete(:token), String)
  @order_number = HttpClient::Preconditions.assert_class('order_number', opts.delete(:order_number), 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))
  @key = (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, String))
  @cvv = (x = opts.delete(:cvv); x.nil? ? nil : HttpClient::Preconditions.assert_class('cvv', 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 })
  @ip = (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String))
  @options = (x = opts.delete(:options); x.nil? ? nil : HttpClient::Preconditions.assert_class('options', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::AuthorizationOption) ? x : ::Io::Flow::V0::Models::AuthorizationOption.apply(x)) })
end

Instance Attribute Details

#amountObject (readonly)

Returns the value of attribute amount.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def amount
  @amount
end

#attributesObject (readonly)

Returns the value of attribute attributes.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def attributes
  @attributes
end

#currencyObject (readonly)

Returns the value of attribute currency.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def currency
  @currency
end

#cvvObject (readonly)

Returns the value of attribute cvv.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def cvv
  @cvv
end

#ipObject (readonly)

Returns the value of attribute ip.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def ip
  @ip
end

#keyObject (readonly)

Returns the value of attribute key.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def key
  @key
end

#optionsObject (readonly)

Returns the value of attribute options.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def options
  @options
end

#order_numberObject (readonly)

Returns the value of attribute order_number.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def order_number
  @order_number
end

#tokenObject (readonly)

Returns the value of attribute token.



19599
19600
19601
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19599

def token
  @token
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



19620
19621
19622
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19620

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

#subtype_to_hashObject



19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19624

def subtype_to_hash
  {
    :token => token,
    :order_number => order_number,
    :amount => amount,
    :currency => currency,
    :key => key,
    :cvv => cvv,
    :attributes => attributes.nil? ? nil : attributes,
    :ip => ip,
    :options => options.nil? ? nil : options.map { |o| o.value }
  }
end

#to_jsonObject



19616
19617
19618
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 19616

def to_json
  JSON.dump(to_hash)
end