Class: Io::Flow::V0::Models::OrderPlacedV2

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 = {}) ⇒ OrderPlacedV2

Returns a new instance of OrderPlacedV2.



40902
40903
40904
40905
40906
40907
40908
40909
40910
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40902

def initialize(incoming={})
  super(:discriminator => Event::Types::ORDER_PLACED_V2)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:event_id, :timestamp, :organization, :order_placed], 'OrderPlacedV2')
  @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_placed = (x = opts.delete(:order_placed); x.is_a?(::Io::Flow::V0::Models::OrderPlacedDetails) ? x : ::Io::Flow::V0::Models::OrderPlacedDetails.new(x))
end

Instance Attribute Details

#event_id ⇒ Object (readonly)

Returns the value of attribute event_id.



40900
40901
40902
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40900

def event_id
  @event_id
end

#order_placed ⇒ Object (readonly)

Returns the value of attribute order_placed.



40900
40901
40902
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40900

def order_placed
  @order_placed
end

#organization ⇒ Object (readonly)

Returns the value of attribute organization.



40900
40901
40902
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40900

def organization
  @organization
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.



40900
40901
40902
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40900

def timestamp
  @timestamp
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



40916
40917
40918
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40916

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

#subtype_to_hash ⇒ Object 



40920
40921
40922
40923
40924
40925
40926
40927
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40920

def subtype_to_hash
  {
    :event_id => event_id,
    :timestamp => timestamp,
    :organization => organization,
    :order_placed => order_placed.to_hash
  }
end

#to_json ⇒ Object 



40912
40913
40914
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 40912

def to_json
  JSON.dump(to_hash)
end