Class: Io::Flow::V0::Models::MerchantOfRecordAuthorizationForm
- Inherits:
-
AuthorizationForm
- Object
- AuthorizationForm
- Io::Flow::V0::Models::MerchantOfRecordAuthorizationForm
- 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
-
#amount ⇒ Object
readonly
Returns the value of attribute amount.
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#currency ⇒ Object
readonly
Returns the value of attribute currency.
-
#cvv ⇒ Object
readonly
Returns the value of attribute cvv.
-
#ip ⇒ Object
readonly
Returns the value of attribute ip.
-
#key ⇒ Object
readonly
Returns the value of attribute key.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#order_number ⇒ Object
readonly
Returns the value of attribute order_number.
-
#token ⇒ Object
readonly
Returns the value of attribute token.
Attributes inherited from AuthorizationForm
Instance Method Summary collapse
- #copy(incoming = {}) ⇒ Object
-
#initialize(incoming = {}) ⇒ MerchantOfRecordAuthorizationForm
constructor
A new instance of MerchantOfRecordAuthorizationForm.
- #subtype_to_hash ⇒ Object
- #to_json ⇒ Object
Methods inherited from AuthorizationForm
Constructor Details
#initialize(incoming = {}) ⇒ MerchantOfRecordAuthorizationForm
Returns a new instance of MerchantOfRecordAuthorizationForm.
20806 20807 20808 20809 20810 20811 20812 20813 20814 20815 20816 20817 20818 20819 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20806 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
#amount ⇒ Object (readonly)
Returns the value of attribute amount.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def amount @amount end |
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def attributes @attributes end |
#currency ⇒ Object (readonly)
Returns the value of attribute currency.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def currency @currency end |
#cvv ⇒ Object (readonly)
Returns the value of attribute cvv.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def cvv @cvv end |
#ip ⇒ Object (readonly)
Returns the value of attribute ip.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def ip @ip end |
#key ⇒ Object (readonly)
Returns the value of attribute key.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def key @key end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def @options end |
#order_number ⇒ Object (readonly)
Returns the value of attribute order_number.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def order_number @order_number end |
#token ⇒ Object (readonly)
Returns the value of attribute token.
20804 20805 20806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20804 def token @token end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
20825 20826 20827 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20825 def copy(incoming={}) MerchantOfRecordAuthorizationForm.new(subtype_to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#subtype_to_hash ⇒ Object
20829 20830 20831 20832 20833 20834 20835 20836 20837 20838 20839 20840 20841 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20829 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 => .nil? ? nil : .map { |o| o.value } } end |
#to_json ⇒ Object
20821 20822 20823 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20821 def to_json JSON.dump(to_hash) end |