class ShipEngine::TrackingInformation

A tracking information resource

Attributes

actual_delivery_date[RW]
carrier_status_code[RW]

Carrier status code

carrier_status_description[RW]

carrier status description

estimated_delivery_date[RW]
events[RW]

The events that have occured during the lifetime of this tracking number.

exception_description[RW]

Exception description

ship_date[RW]
status_code[RW]

Status code

status_description[RW]

Status description

tracking_number[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/ship_engine/models/tracking_information.rb, line 45
def self.attribute_map
  {
    :'tracking_number' => :'tracking_number',
    :'status_code' => :'status_code',
    :'status_description' => :'status_description',
    :'carrier_status_code' => :'carrier_status_code',
    :'carrier_status_description' => :'carrier_status_description',
    :'ship_date' => :'ship_date',
    :'estimated_delivery_date' => :'estimated_delivery_date',
    :'actual_delivery_date' => :'actual_delivery_date',
    :'exception_description' => :'exception_description',
    :'events' => :'events'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ship_engine/models/tracking_information.rb, line 258
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ship_engine/models/tracking_information.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::TrackingInformation` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|

    h[k.to_sym] = v
  }

  if attributes.key?(:'tracking_number')
    self.tracking_number = attributes[:'tracking_number']
  end

  if attributes.key?(:'status_code')
    self.status_code = attributes[:'status_code']
  end

  if attributes.key?(:'status_description')
    self.status_description = attributes[:'status_description']
  end

  if attributes.key?(:'carrier_status_code')
    self.carrier_status_code = attributes[:'carrier_status_code']
  end

  if attributes.key?(:'carrier_status_description')
    self.carrier_status_description = attributes[:'carrier_status_description']
  end

  if attributes.key?(:'ship_date')
    self.ship_date = attributes[:'ship_date']
  end

  if attributes.key?(:'estimated_delivery_date')
    self.estimated_delivery_date = attributes[:'estimated_delivery_date']
  end

  if attributes.key?(:'actual_delivery_date')
    self.actual_delivery_date = attributes[:'actual_delivery_date']
  end

  if attributes.key?(:'exception_description')
    self.exception_description = attributes[:'exception_description']
  end

  if attributes.key?(:'events')
    if (value = attributes[:'events']).is_a?(Array)
      self.events = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/ship_engine/models/tracking_information.rb, line 77
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ship_engine/models/tracking_information.rb, line 61
def self.openapi_types
  {
    :'tracking_number' => :'String',
    :'status_code' => :'String',
    :'status_description' => :'String',
    :'carrier_status_code' => :'String',
    :'carrier_status_description' => :'String',
    :'ship_date' => :'DateTime',
    :'estimated_delivery_date' => :'DateTime',
    :'actual_delivery_date' => :'DateTime',
    :'exception_description' => :'String',
    :'events' => :'Array<TrackEvent>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ship_engine/models/tracking_information.rb, line 228
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tracking_number == o.tracking_number &&
      status_code == o.status_code &&
      status_description == o.status_description &&
      carrier_status_code == o.carrier_status_code &&
      carrier_status_description == o.carrier_status_description &&
      ship_date == o.ship_date &&
      estimated_delivery_date == o.estimated_delivery_date &&
      actual_delivery_date == o.actual_delivery_date &&
      exception_description == o.exception_description &&
      events == o.events
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ship_engine/models/tracking_information.rb, line 286
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    ShipEngine.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/ship_engine/models/tracking_information.rb, line 355
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ship_engine/models/tracking_information.rb, line 265
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
carrier_status_code=(carrier_status_code) click to toggle source

Custom attribute writer method with validation @param [Object] carrier_status_code Value to be assigned

# File lib/ship_engine/models/tracking_information.rb, line 198
def carrier_status_code=(carrier_status_code)
  if !carrier_status_code.nil? && carrier_status_code.to_s.length < 1
    fail ArgumentError, 'invalid value for "carrier_status_code", the character length must be great than or equal to 1.'
  end

  @carrier_status_code = carrier_status_code
end
carrier_status_description=(carrier_status_description) click to toggle source

Custom attribute writer method with validation @param [Object] carrier_status_description Value to be assigned

# File lib/ship_engine/models/tracking_information.rb, line 208
def carrier_status_description=(carrier_status_description)
  if !carrier_status_description.nil? && carrier_status_description.to_s.length < 0
    fail ArgumentError, 'invalid value for "carrier_status_description", the character length must be great than or equal to 0.'
  end

  @carrier_status_description = carrier_status_description
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ship_engine/models/tracking_information.rb, line 245
def eql?(o)
  self == o
end
exception_description=(exception_description) click to toggle source

Custom attribute writer method with validation @param [Object] exception_description Value to be assigned

# File lib/ship_engine/models/tracking_information.rb, line 218
def exception_description=(exception_description)
  if !exception_description.nil? && exception_description.to_s.length < 0
    fail ArgumentError, 'invalid value for "exception_description", the character length must be great than or equal to 0.'
  end

  @exception_description = exception_description
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/ship_engine/models/tracking_information.rb, line 251
def hash
  [tracking_number, status_code, status_description, carrier_status_code, carrier_status_description, ship_date, estimated_delivery_date, actual_delivery_date, exception_description, events].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ship_engine/models/tracking_information.rb, line 140
def list_invalid_properties
  invalid_properties = Array.new
  if !@status_code.nil? && @status_code.to_s.length < 1
    invalid_properties.push('invalid value for "status_code", the character length must be great than or equal to 1.')
  end

  if !@status_description.nil? && @status_description.to_s.length < 0
    invalid_properties.push('invalid value for "status_description", the character length must be great than or equal to 0.')
  end

  if !@carrier_status_code.nil? && @carrier_status_code.to_s.length < 1
    invalid_properties.push('invalid value for "carrier_status_code", the character length must be great than or equal to 1.')
  end

  if !@carrier_status_description.nil? && @carrier_status_description.to_s.length < 0
    invalid_properties.push('invalid value for "carrier_status_description", the character length must be great than or equal to 0.')
  end

  if !@exception_description.nil? && @exception_description.to_s.length < 0
    invalid_properties.push('invalid value for "exception_description", the character length must be great than or equal to 0.')
  end

  invalid_properties
end
status_code=(status_code) click to toggle source

Custom attribute writer method with validation @param [Object] status_code Value to be assigned

# File lib/ship_engine/models/tracking_information.rb, line 178
def status_code=(status_code)
  if !status_code.nil? && status_code.to_s.length < 1
    fail ArgumentError, 'invalid value for "status_code", the character length must be great than or equal to 1.'
  end

  @status_code = status_code
end
status_description=(status_description) click to toggle source

Custom attribute writer method with validation @param [Object] status_description Value to be assigned

# File lib/ship_engine/models/tracking_information.rb, line 188
def status_description=(status_description)
  if !status_description.nil? && status_description.to_s.length < 0
    fail ArgumentError, 'invalid value for "status_description", the character length must be great than or equal to 0.'
  end

  @status_description = status_description
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ship_engine/models/tracking_information.rb, line 331
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ship_engine/models/tracking_information.rb, line 337
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ship_engine/models/tracking_information.rb, line 325
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ship_engine/models/tracking_information.rb, line 167
def valid?
  return false if !@status_code.nil? && @status_code.to_s.length < 1
  return false if !@status_description.nil? && @status_description.to_s.length < 0
  return false if !@carrier_status_code.nil? && @carrier_status_code.to_s.length < 1
  return false if !@carrier_status_description.nil? && @carrier_status_description.to_s.length < 0
  return false if !@exception_description.nil? && @exception_description.to_s.length < 0
  true
end