Class: Io::Flow::V0::Models::OrderPlaced

Inherits:
Event
  • Object
show all
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

Attributes inherited from Event

#discriminator

Instance Method Summary collapse

Methods inherited from Event

from_json, #to_hash

Constructor Details

#initialize(incoming = {}) ⇒ OrderPlaced

Returns a new instance of OrderPlaced.



36403
36404
36405
36406
36407
36408
36409
36410
36411
36412
36413
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36403

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.



36401
36402
36403
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36401

def allocation
  @allocation
end

#event_id ⇒ Object (readonly)

Returns the value of attribute event_id.



36401
36402
36403
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36401

def event_id
  @event_id
end

#order ⇒ Object (readonly)

Returns the value of attribute order.



36401
36402
36403
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36401

def order
  @order
end

#order_number ⇒ Object (readonly)

Returns the value of attribute order_number.



36401
36402
36403
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36401

def order_number
  @order_number
end

#organization ⇒ Object (readonly)

Returns the value of attribute organization.



36401
36402
36403
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36401

def organization
  @organization
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.



36401
36402
36403
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36401

def timestamp
  @timestamp
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



36419
36420
36421
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36419

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

#subtype_to_hash ⇒ Object 



36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36423

def subtype_to_hash
  {
    :event_id => event_id,
    :timestamp => timestamp,
    :organization => organization,
    :order_number => order_number,
    :order => order.to_hash,
    :allocation => allocation.to_hash
  }
end

#to_json ⇒ Object 



36415
36416
36417
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 36415

def to_json
  JSON.dump(to_hash)
end