Class: Io::Flow::V0::Models::Tracking

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

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Tracking

Returns a new instance of Tracking.



54440
54441
54442
54443
54444
54445
54446
54447
54448
54449
54450
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54440

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :labels, :status, :attributes, :url], 'Tracking')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @labels = HttpClient::Preconditions.assert_class('labels', opts.delete(:labels), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::TrackingLabel) ? x : ::Io::Flow::V0::Models::TrackingLabel.new(x)) }
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::TrackingStatus) ? x : ::Io::Flow::V0::Models::TrackingStatus.apply(x))
  @attributes = HttpClient::Preconditions.assert_class('attributes', opts.delete(:attributes), Hash).inject({}) { |h, d| h[d[0]] = HttpClient::Preconditions.assert_class('attributes', d[1], String); h }
  @url = HttpClient::Preconditions.assert_class('url', opts.delete(:url), String)
  @window = (x = opts.delete(:window); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::DatetimeRange) ? x : ::Io::Flow::V0::Models::DatetimeRange.new(x)))
  @order_number = (x = opts.delete(:order_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('order_number', x, String))
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



54438
54439
54440
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54438

def attributes
  @attributes
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



54438
54439
54440
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54438

def id
  @id
end

#labels ⇒ Object (readonly)

Returns the value of attribute labels.



54438
54439
54440
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54438

def labels
  @labels
end

#order_number ⇒ Object (readonly)

Returns the value of attribute order_number.



54438
54439
54440
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54438

def order_number
  @order_number
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



54438
54439
54440
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54438

def status
  @status
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



54438
54439
54440
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54438

def url
  @url
end

#window ⇒ Object (readonly)

Returns the value of attribute window.



54438
54439
54440
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54438

def window
  @window
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



54456
54457
54458
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54456

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

#to_hash ⇒ Object 



54460
54461
54462
54463
54464
54465
54466
54467
54468
54469
54470
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54460

def to_hash
  {
    :id => id,
    :labels => labels.map { |o| o.to_hash },
    :status => status.value,
    :attributes => attributes,
    :url => url,
    :window => window.nil? ? nil : window.to_hash,
    :order_number => order_number
  }
end

#to_json ⇒ Object 



54452
54453
54454
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54452

def to_json
  JSON.dump(to_hash)
end