Class: FreightKit::TrackingResponse

Inherits:
Response show all
Defined in:
lib/freight_kit/models/tracking_response.rb

Overview

Note:

Some carriers provide more information than others, so not all attributes will be set, depending on what carrier you are using.

Represents the response to a Carrier#find_tracking_info call.

Instance Attribute Summary collapse

Attributes inherited from Response

#error, #request, #response

Method Summary

Methods inherited from Model

#attributes, #initialize

Constructor Details

This class inherits a constructor from FreightKit::Model

Instance Attribute Details

#actual_delivery_date ⇒ DateTime

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#attempted_delivery_date ⇒ DateTime

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#carrier ⇒ Symbol

Returns:

  • (Symbol) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#carrier_name ⇒ String

Returns:

  • (String) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#delivery_signature ⇒ String

Returns:

  • (String) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#destination ⇒ FreightKit::Location

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#estimated_delivery_date ⇒ FreightKit::DateTime

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#origin ⇒ FreightKit::Location

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#scheduled_delivery_date ⇒ DateTime

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#ship_time ⇒ Date, Time

Returns:

  • (Date, Time) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#shipment_events ⇒ Array<FreightKit::ShipmentEvent>

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#shipper_address ⇒ FreightKit::Location

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#status ⇒ Symbol

Returns:

  • (Symbol) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#status_code ⇒ string

Returns:

  • (string) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#status_description ⇒ String

Returns:

  • (String) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end

#tracking_number ⇒ String

Returns:

  • (String) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/freight_kit/models/tracking_response.rb', line 57

class TrackingResponse < Response
  attr_accessor :actual_delivery_date,
                :attempted_delivery_date,
                :carrier,
                :carrier_name,
                :delivery_signature,
                :destination,
                :estimated_delivery_date,
                :origin,
                :scheduled_delivery_date,
                :ship_time,
                :shipment_events,
                :shipper_address,
                :status,
                :status_code,
                :status_description,
                :tracking_number
end