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 collapse
-
#carrier ⇒ Object
readonly
Returns the value of attribute carrier.
-
#carrier_tracking_number ⇒ Object
readonly
Returns the value of attribute carrier_tracking_number.
-
#cost ⇒ Object
readonly
Returns the value of attribute cost.
-
#delivery_estimate ⇒ Object
readonly
Returns the value of attribute delivery_estimate.
-
#description ⇒ Object
readonly
Returns the value of attribute description.
-
#ratecard_owner ⇒ Object
readonly
Returns the value of attribute ratecard_owner.
-
#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 collapse
- #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.
66426 66427 66428 66429 66430 66431 66432 66433 66434 66435 66436 66437 66438 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66426 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)) @cost = (x = opts.delete(:cost); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Money) ? x : ::Io::Flow::V0::Models::Money.new(x))) @ratecard_owner = (x = opts.delete(:ratecard_owner); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::RatecardOwner) ? x : ::Io::Flow::V0::Models::RatecardOwner.apply(x))) end |
Instance Attribute Details
#carrier ⇒ Object (readonly)
Returns the value of attribute carrier.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def carrier @carrier end |
#carrier_tracking_number ⇒ Object (readonly)
Returns the value of attribute carrier_tracking_number.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def carrier_tracking_number @carrier_tracking_number end |
#cost ⇒ Object (readonly)
Returns the value of attribute cost.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def cost @cost end |
#delivery_estimate ⇒ Object (readonly)
Returns the value of attribute delivery_estimate.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def delivery_estimate @delivery_estimate end |
#description ⇒ Object (readonly)
Returns the value of attribute description.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def description @description end |
#ratecard_owner ⇒ Object (readonly)
Returns the value of attribute ratecard_owner.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def ratecard_owner @ratecard_owner end |
#status ⇒ Object (readonly)
Returns the value of attribute status.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def status @status end |
#timestamp ⇒ Object (readonly)
Returns the value of attribute timestamp.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def @timestamp end |
#tracking_id ⇒ Object (readonly)
Returns the value of attribute tracking_id.
66424 66425 66426 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66424 def tracking_id @tracking_id end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
66444 66445 66446 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66444 def copy(incoming={}) TrackingLabelForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#to_hash ⇒ Object
66448 66449 66450 66451 66452 66453 66454 66455 66456 66457 66458 66459 66460 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66448 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 => , :cost => cost.nil? ? nil : cost.to_hash, :ratecard_owner => ratecard_owner.nil? ? nil : ratecard_owner.value } end |
#to_json ⇒ Object
66440 66441 66442 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 66440 def to_json JSON.dump(to_hash) end |