Class: Io::Flow::V0::Models::OrderPayment

Inherits:

Object

• Object
• Io::Flow::V0::Models::OrderPayment

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

An Order Payment represents an individual payment applied to an order. The type of the payment can be used to further lookup transaction level detail

Instance Attribute Summary

• #description ⇒ Object readonly

  Returns the value of attribute description.

• #id ⇒ Object readonly

  Returns the value of attribute id.

• #reference ⇒ Object readonly

  Returns the value of attribute reference.

• #total ⇒ Object readonly

  Returns the value of attribute total.

• #type ⇒ Object readonly

  Returns the value of attribute type.

Instance Method Summary

• #copy(incoming = {}) ⇒ Object
• #initialize(incoming = {}) ⇒ OrderPayment constructor

  A new instance of OrderPayment.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ OrderPayment

Returns a new instance of OrderPayment.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20156

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :type, :reference, :description, :total], 'OrderPayment')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::OrderPaymentType) ? x : ::Io::Flow::V0::Models::OrderPaymentType.apply(x))
  @reference = HttpClient::Preconditions.assert_class('reference', opts.delete(:reference), String)
  @description = HttpClient::Preconditions.assert_class('description', opts.delete(:description), String)
  @total = (x = opts.delete(:total); x.is_a?(::Io::Flow::V0::Models::PriceWithBase) ? x : ::Io::Flow::V0::Models::PriceWithBase.new(x))
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20154

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20154

def id
  @id
end

#reference ⇒ Object (readonly)

Returns the value of attribute reference.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20154

def reference
  @reference
end

#total ⇒ Object (readonly)

Returns the value of attribute total.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20154

def total
  @total
end

#type ⇒ Object (readonly)

Returns the value of attribute type.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20154

def type
  @type
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20170

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

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20174

def to_hash
  {
    :id => id,
    :type => type.value,
    :reference => reference,
    :description => description,
    :total => total.to_hash
  }
end

#to_json ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20166

def to_json
  JSON.dump(to_hash)
end