Class: Io::Flow::V0::Models::TrackingEvent

Inherits:

Object

• Object
• Io::Flow::V0::Models::TrackingEvent

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #address ⇒ Object readonly

  Returns the value of attribute address.

• #description ⇒ Object readonly

  Returns the value of attribute description.

• #id ⇒ Object readonly

  Returns the value of attribute id.

• #status ⇒ Object readonly

  Returns the value of attribute status.

• #timestamp ⇒ Object readonly

  Returns the value of attribute timestamp.

Instance Method Summary

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

  A new instance of TrackingEvent.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ TrackingEvent

Returns a new instance of TrackingEvent.

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

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :address, :status, :timestamp], 'TrackingEvent')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @address = (x = opts.delete(:address); x.is_a?(::Io::Flow::V0::Models::Address) ? x : ::Io::Flow::V0::Models::Address.new(x))
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::TrackingStatus) ? x : ::Io::Flow::V0::Models::TrackingStatus.apply(x))
  @timestamp = HttpClient::Preconditions.assert_class('timestamp', HttpClient::Helper.to_date_time_iso8601(opts.delete(:timestamp)), DateTime)
  @description = (x = opts.delete(:description); x.nil? ? nil : HttpClient::Preconditions.assert_class('description', x, String))
end

Instance Attribute Details

#address ⇒ Object (readonly)

Returns the value of attribute address.

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

def address
  @address
end

#description ⇒ Object (readonly)

Returns the value of attribute description.

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

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.

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

def id
  @id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.

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

def status
  @status
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.

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

def timestamp
  @timestamp
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

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

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

#to_hash ⇒ Object

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

def to_hash
  {
    :id => id,
    :address => address.to_hash,
    :status => status.value,
    :timestamp => timestamp,
    :description => description
  }
end

#to_json ⇒ Object

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

def to_json
  JSON.dump(to_hash)
end