Class: Io::Flow::V0::Models::TrackingLabel

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

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ TrackingLabel

Returns a new instance of TrackingLabel.



22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22218

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.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def carrier
  @carrier
end

#carrier_tracking_number ⇒ Object (readonly)

Returns the value of attribute carrier_tracking_number.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def carrier_tracking_number
  @carrier_tracking_number
end

#delivery_estimate ⇒ Object (readonly)

Returns the value of attribute delivery_estimate.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def delivery_estimate
  @delivery_estimate
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def description
  @description
end

#events ⇒ Object (readonly)

Returns the value of attribute events.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def events
  @events
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def id
  @id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def status
  @status
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.



22216
22217
22218
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22216

def timestamp
  @timestamp
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



22235
22236
22237
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22235

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

#to_hash ⇒ Object 



22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22239

def to_hash
  {
    :id => id,
    :carrier => carrier,
    :carrier_tracking_number => carrier_tracking_number,
    :events => events.map { |o| o.to_hash },
    :status => status.value,
    :timestamp => timestamp,
    :delivery_estimate => delivery_estimate,
    :description => description
  }
end

#to_json ⇒ Object 



22231
22232
22233
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 22231

def to_json
  JSON.dump(to_hash)
end