Class: Io::Flow::V0::Models::TrackingLabel
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::TrackingLabel
- 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 collapse
-
#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.
-
#events ⇒ Object
readonly
Returns the value of attribute events.
-
#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 collapse
- #copy(incoming = {}) ⇒ Object
-
#initialize(incoming = {}) ⇒ TrackingLabel
constructor
A new instance of TrackingLabel.
- #to_hash ⇒ Object
- #to_json ⇒ Object
Constructor Details
#initialize(incoming = {}) ⇒ TrackingLabel
Returns a new instance of TrackingLabel.
71474 71475 71476 71477 71478 71479 71480 71481 71482 71483 71484 71485 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71474 def initialize(incoming={}) opts = HttpClient::Helper.symbolize_keys(incoming) HttpClient::Preconditions.require_keys(opts, [:id, :carrier, :carrier_tracking_number, :events, :status, :timestamp], 'TrackingLabel') @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String) @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) @events = HttpClient::Preconditions.assert_class('events', opts.delete(:events), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::TrackingEvent) ? x : ::Io::Flow::V0::Models::TrackingEvent.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) @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)) end |
Instance Attribute Details
#carrier ⇒ Object (readonly)
Returns the value of attribute carrier.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def carrier @carrier end |
#carrier_tracking_number ⇒ Object (readonly)
Returns the value of attribute carrier_tracking_number.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def carrier_tracking_number @carrier_tracking_number end |
#delivery_estimate ⇒ Object (readonly)
Returns the value of attribute delivery_estimate.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def delivery_estimate @delivery_estimate end |
#description ⇒ Object (readonly)
Returns the value of attribute description.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def description @description end |
#events ⇒ Object (readonly)
Returns the value of attribute events.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def events @events end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def id @id end |
#status ⇒ Object (readonly)
Returns the value of attribute status.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def status @status end |
#timestamp ⇒ Object (readonly)
Returns the value of attribute timestamp.
71472 71473 71474 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71472 def @timestamp end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
71491 71492 71493 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71491 def copy(incoming={}) TrackingLabel.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#to_hash ⇒ Object
71495 71496 71497 71498 71499 71500 71501 71502 71503 71504 71505 71506 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71495 def to_hash { :id => id, :carrier => carrier, :carrier_tracking_number => carrier_tracking_number, :events => events.map { |o| o.to_hash }, :status => status.value, :timestamp => , :delivery_estimate => delivery_estimate, :description => description } end |
#to_json ⇒ Object
71487 71488 71489 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 71487 def to_json JSON.dump(to_hash) end |