Class: Io::Flow::V0::Models::CreditPayment

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

Overview

A Credit Payment records a ‘non cash’ payment against an order (e.g. a store credit, gift card, etc.), recording the amount of that credit and additional details to reconcile payments. The primary purpose of the credit payment is to record that a payment has been made against an order so the remaining balance can be correctly computed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ CreditPayment

Returns a new instance of CreditPayment.



16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16521

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :order, :key, :description, :value, :original, :attributes], 'CreditPayment')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @order = (x = opts.delete(:order); x.is_a?(::Io::Flow::V0::Models::ExpandableOrder) ? x : ::Io::Flow::V0::Models::ExpandableOrder.from_json(x))
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @description = HttpClient::Preconditions.assert_class('description', opts.delete(:description), String)
  @value = (x = opts.delete(:value); x.is_a?(::Io::Flow::V0::Models::PriceWithBase) ? x : ::Io::Flow::V0::Models::PriceWithBase.new(x))
  @original = (x = opts.delete(:original); x.is_a?(::Io::Flow::V0::Models::OriginalPrices) ? x : ::Io::Flow::V0::Models::OriginalPrices.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 }
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



16519
16520
16521
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16519

def attributes
  @attributes
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



16519
16520
16521
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16519

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



16519
16520
16521
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16519

def id
  @id
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



16519
16520
16521
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16519

def key
  @key
end

#order ⇒ Object (readonly)

Returns the value of attribute order.



16519
16520
16521
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16519

def order
  @order
end

#original ⇒ Object (readonly)

Returns the value of attribute original.



16519
16520
16521
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16519

def original
  @original
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



16519
16520
16521
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16519

def value
  @value
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



16537
16538
16539
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16537

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

#to_hash ⇒ Object 



16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16541

def to_hash
  {
    :id => id,
    :order => order.to_hash,
    :key => key,
    :description => description,
    :value => value.to_hash,
    :original => original.to_hash,
    :attributes => attributes
  }
end

#to_json ⇒ Object 



16533
16534
16535
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16533

def to_json
  JSON.dump(to_hash)
end