Class: Io::Flow::V0::Models::TrackingForm

Inherits:

Object

• Object
• Io::Flow::V0::Models::TrackingForm

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

Top level tracking information which contains labels. In cases where shipments are re-labeled, you will see multiple labels for each tracking allowing simple access to see where a shipment is - with which carrier and with the local tracking number

Instance Attribute Summary

• #metadata ⇒ Object readonly

  Returns the value of attribute metadata.

• #order_number ⇒ Object readonly

  Returns the value of attribute order_number.

• #status ⇒ Object readonly

  Returns the value of attribute status.

Instance Method Summary

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

  A new instance of TrackingForm.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ TrackingForm

Returns a new instance of TrackingForm.

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

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  @status = (x = opts.delete(:status); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::TrackingStatus) ? x : ::Io::Flow::V0::Models::TrackingStatus.apply(x)))
  @order_number = (x = opts.delete(:order_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('order_number', x, String))
  @metadata = (x = opts.delete(:metadata); x.nil? ? nil : HttpClient::Preconditions.assert_class('metadata', HttpClient::Helper.to_object(x), Hash))
end

Instance Attribute Details

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.

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

def metadata
  @metadata
end

#order_number ⇒ Object (readonly)

Returns the value of attribute order_number.

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

def order_number
  @order_number
end

#status ⇒ Object (readonly)

Returns the value of attribute status.

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

def status
  @status
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

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

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

#to_hash ⇒ Object

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

def to_hash
  {
    :status => status.nil? ? nil : status.value,
    :order_number => order_number,
    :metadata => metadata
  }
end

#to_json ⇒ Object

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

def to_json
  JSON.dump(to_hash)
end