Class: Io::Flow::V0::Models::TrackingLabelForm

Inherits:

Object

• Object
• Io::Flow::V0::Models::TrackingLabelForm

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

Represents a specific label being tracked as part of the tracking bucket

Instance Attribute Summary

• #carrier ⇒ Object readonly

  Returns the value of attribute carrier.

• #carrier_tracking_number ⇒ Object readonly

  Returns the value of attribute carrier_tracking_number.

• #delivery_estimate ⇒ Object readonly

  Returns the value of attribute delivery_estimate.

• #description ⇒ Object readonly

  Returns the value of attribute description.

• #parent_id ⇒ Object readonly

  Returns the value of attribute parent_id.

• #status ⇒ Object readonly

  Returns the value of attribute status.

• #timestamp ⇒ Object readonly

  Returns the value of attribute timestamp.

• #tracking_id ⇒ Object readonly

  Returns the value of attribute tracking_id.

Instance Method Summary

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

  A new instance of TrackingLabelForm.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ TrackingLabelForm

Returns a new instance of TrackingLabelForm.

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

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:tracking_id, :carrier, :carrier_tracking_number], 'TrackingLabelForm')
  @tracking_id = HttpClient::Preconditions.assert_class('tracking_id', opts.delete(:tracking_id), String)
  @status = (x = (x = opts.delete(:status); x.nil? ? "pending" : x); x.is_a?(::Io::Flow::V0::Models::TrackingStatus) ? x : ::Io::Flow::V0::Models::TrackingStatus.apply(x))
  @carrier = HttpClient::Preconditions.assert_class('carrier', opts.delete(:carrier), String)
  @carrier_tracking_number = HttpClient::Preconditions.assert_class('carrier_tracking_number', opts.delete(:carrier_tracking_number), String)
  @delivery_estimate = (x = opts.delete(:delivery_estimate); x.nil? ? nil : HttpClient::Preconditions.assert_class('delivery_estimate', HttpClient::Helper.to_date_time_iso8601(x), DateTime))
  @description = (x = opts.delete(:description); x.nil? ? nil : HttpClient::Preconditions.assert_class('description', x, String))
  @timestamp = (x = opts.delete(:timestamp); x.nil? ? nil : HttpClient::Preconditions.assert_class('timestamp', HttpClient::Helper.to_date_time_iso8601(x), DateTime))
  @parent_id = (x = opts.delete(:parent_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('parent_id', x, String))
end

Instance Attribute Details

#carrier ⇒ Object (readonly)

Returns the value of attribute carrier.

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

def carrier
  @carrier
end

#carrier_tracking_number ⇒ Object (readonly)

Returns the value of attribute carrier_tracking_number.

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

def carrier_tracking_number
  @carrier_tracking_number
end

#delivery_estimate ⇒ Object (readonly)

Returns the value of attribute delivery_estimate.

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

def delivery_estimate
  @delivery_estimate
end

#description ⇒ Object (readonly)

Returns the value of attribute description.

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

def description
  @description
end

#parent_id ⇒ Object (readonly)

Returns the value of attribute parent_id.

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

def parent_id
  @parent_id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.

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

def status
  @status
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.

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

def timestamp
  @timestamp
end

#tracking_id ⇒ Object (readonly)

Returns the value of attribute tracking_id.

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

def tracking_id
  @tracking_id
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

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

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

#to_hash ⇒ Object

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

def to_hash
  {
    :tracking_id => tracking_id,
    :status => status.value,
    :carrier => carrier,
    :carrier_tracking_number => carrier_tracking_number,
    :delivery_estimate => delivery_estimate,
    :description => description,
    :timestamp => timestamp,
    :parent_id => parent_id
  }
end

#to_json ⇒ Object

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

def to_json
  JSON.dump(to_hash)
end