Class: Io::Flow::V0::Models::OrderPlaced
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Overview
Sent when an order is submitted, allocations are generated and the total value of the order is accounted for by discounts, subsidies, credits and authorized payments – but may not ready to fulfill (e.g. pending assignment of a DC or fraud review). Intended to fuel customer feedback and alert merchants that an order is coming.
Instance Attribute Summary collapse
-
#allocation ⇒ Object
readonly
Returns the value of attribute allocation.
-
#event_id ⇒ Object
readonly
Returns the value of attribute event_id.
-
#order ⇒ Object
readonly
Returns the value of attribute order.
-
#order_number ⇒ Object
readonly
Returns the value of attribute order_number.
-
#organization ⇒ Object
readonly
Returns the value of attribute organization.
-
#timestamp ⇒ Object
readonly
Returns the value of attribute timestamp.
Attributes inherited from Event
Instance Method Summary collapse
- #copy(incoming = {}) ⇒ Object
-
#initialize(incoming = {}) ⇒ OrderPlaced
constructor
A new instance of OrderPlaced.
- #subtype_to_hash ⇒ Object
- #to_json ⇒ Object
Methods inherited from Event
Constructor Details
#initialize(incoming = {}) ⇒ OrderPlaced
Returns a new instance of OrderPlaced.
40978 40979 40980 40981 40982 40983 40984 40985 40986 40987 40988 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40978 def initialize(incoming={}) super(:discriminator => Event::Types::ORDER_PLACED) opts = HttpClient::Helper.symbolize_keys(incoming) HttpClient::Preconditions.require_keys(opts, [:event_id, :timestamp, :organization, :order_number, :order, :allocation], 'OrderPlaced') @event_id = HttpClient::Preconditions.assert_class('event_id', opts.delete(:event_id), String) @timestamp = HttpClient::Preconditions.assert_class('timestamp', HttpClient::Helper.to_date_time_iso8601(opts.delete(:timestamp)), DateTime) @organization = HttpClient::Preconditions.assert_class('organization', opts.delete(:organization), String) @order_number = HttpClient::Preconditions.assert_class('order_number', opts.delete(:order_number), String) @order = (x = opts.delete(:order); x.is_a?(::Io::Flow::V0::Models::Order) ? x : ::Io::Flow::V0::Models::Order.new(x)) @allocation = (x = opts.delete(:allocation); x.is_a?(::Io::Flow::V0::Models::AllocationV2) ? x : ::Io::Flow::V0::Models::AllocationV2.new(x)) end |
Instance Attribute Details
#allocation ⇒ Object (readonly)
Returns the value of attribute allocation.
40976 40977 40978 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40976 def allocation @allocation end |
#event_id ⇒ Object (readonly)
Returns the value of attribute event_id.
40976 40977 40978 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40976 def event_id @event_id end |
#order ⇒ Object (readonly)
Returns the value of attribute order.
40976 40977 40978 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40976 def order @order end |
#order_number ⇒ Object (readonly)
Returns the value of attribute order_number.
40976 40977 40978 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40976 def order_number @order_number end |
#organization ⇒ Object (readonly)
Returns the value of attribute organization.
40976 40977 40978 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40976 def organization @organization end |
#timestamp ⇒ Object (readonly)
Returns the value of attribute timestamp.
40976 40977 40978 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40976 def @timestamp end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
40994 40995 40996 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40994 def copy(incoming={}) OrderPlaced.new(subtype_to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#subtype_to_hash ⇒ Object
40998 40999 41000 41001 41002 41003 41004 41005 41006 41007 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40998 def subtype_to_hash { :event_id => event_id, :timestamp => , :organization => organization, :order_number => order_number, :order => order.to_hash, :allocation => allocation.to_hash } end |
#to_json ⇒ Object
40990 40991 40992 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40990 def to_json JSON.dump(to_hash) end |