class OpenapiClient::TrackEvent

A track event

Attributes

carrier_occurred_at[RW]

Carrier timestamp for the event, it is assumed to be the local time of where the event occurred.

city_locality[RW]

City locality

company_name[RW]

Company Name

country_code[RW]
description[RW]

Event description

event_code[RW]

Event Code

latitude[RW]

Latitude coordinate of tracking event.

longitude[RW]

Longitude coordinate of tracking event.

occurred_at[RW]

Timestamp for carrier event

postal_code[RW]

Postal code

signer[RW]

Signer information

state_province[RW]

State province

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/track_event.rb, line 54
def self.attribute_map
  {
    :'occurred_at' => :'occurred_at',
    :'carrier_occurred_at' => :'carrier_occurred_at',
    :'description' => :'description',
    :'city_locality' => :'city_locality',
    :'state_province' => :'state_province',
    :'postal_code' => :'postal_code',
    :'country_code' => :'country_code',
    :'company_name' => :'company_name',
    :'signer' => :'signer',
    :'event_code' => :'event_code',
    :'latitude' => :'latitude',
    :'longitude' => :'longitude'
  }
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/openapi_client/models/track_event.rb, line 391
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/openapi_client/models/track_event.rb, line 97
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::TrackEvent` 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|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::TrackEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'longitude')
    self.longitude = attributes[:'longitude']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/openapi_client/models/track_event.rb, line 72
def self.openapi_types
  {
    :'occurred_at' => :'DateTime',
    :'carrier_occurred_at' => :'DateTime',
    :'description' => :'String',
    :'city_locality' => :'String',
    :'state_province' => :'String',
    :'postal_code' => :'String',
    :'country_code' => :'String',
    :'company_name' => :'String',
    :'signer' => :'String',
    :'event_code' => :'String',
    :'latitude' => :'Float',
    :'longitude' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/openapi_client/models/track_event.rb, line 359
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      occurred_at == o.occurred_at &&
      carrier_occurred_at == o.carrier_occurred_at &&
      description == o.description &&
      city_locality == o.city_locality &&
      state_province == o.state_province &&
      postal_code == o.postal_code &&
      country_code == o.country_code &&
      company_name == o.company_name &&
      signer == o.signer &&
      event_code == o.event_code &&
      latitude == o.latitude &&
      longitude == o.longitude
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/openapi_client/models/track_event.rb, line 419
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
    OpenapiClient.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/openapi_client/models/track_event.rb, line 488
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/openapi_client/models/track_event.rb, line 398
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
city_locality=(city_locality) click to toggle source

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

# File lib/openapi_client/models/track_event.rb, line 259
def city_locality=(city_locality)
  if city_locality.nil?
    fail ArgumentError, 'city_locality cannot be nil'
  end

  if city_locality.to_s.length < 0
    fail ArgumentError, 'invalid value for "city_locality", the character length must be great than or equal to 0.'
  end

  @city_locality = city_locality
end
company_name=(company_name) click to toggle source

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

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

  @company_name = company_name
end
description=(description) click to toggle source

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

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

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

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

# File lib/openapi_client/models/track_event.rb, line 378
def eql?(o)
  self == o
end
event_code=(event_code) click to toggle source

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

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

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

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

# File lib/openapi_client/models/track_event.rb, line 384
def hash
  [occurred_at, carrier_occurred_at, description, city_locality, state_province, postal_code, country_code, company_name, signer, event_code, latitude, longitude].hash
end
latitude=(latitude) click to toggle source

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

# File lib/openapi_client/models/track_event.rb, line 331
def latitude=(latitude)
  if !latitude.nil? && latitude > 90
    fail ArgumentError, 'invalid value for "latitude", must be smaller than or equal to 90.'
  end

  if !latitude.nil? && latitude < 0
    fail ArgumentError, 'invalid value for "latitude", must be greater than or equal to 0.'
  end

  @latitude = latitude
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/openapi_client/models/track_event.rb, line 161
def list_invalid_properties
  invalid_properties = Array.new
  if @occurred_at.nil?
    invalid_properties.push('invalid value for "occurred_at", occurred_at cannot be nil.')
  end

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

  if @city_locality.nil?
    invalid_properties.push('invalid value for "city_locality", city_locality cannot be nil.')
  end

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

  if @state_province.nil?
    invalid_properties.push('invalid value for "state_province", state_province cannot be nil.')
  end

  if @state_province.to_s.length < 2
    invalid_properties.push('invalid value for "state_province", the character length must be great than or equal to 2.')
  end

  if @postal_code.nil?
    invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
  end

  if @postal_code.to_s.length < 5
    invalid_properties.push('invalid value for "postal_code", the character length must be great than or equal to 5.')
  end

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

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

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

  if !@latitude.nil? && @latitude > 90
    invalid_properties.push('invalid value for "latitude", must be smaller than or equal to 90.')
  end

  if !@latitude.nil? && @latitude < 0
    invalid_properties.push('invalid value for "latitude", must be greater than or equal to 0.')
  end

  if !@longitude.nil? && @longitude > 180
    invalid_properties.push('invalid value for "longitude", must be smaller than or equal to 180.')
  end

  if !@longitude.nil? && @longitude < 0
    invalid_properties.push('invalid value for "longitude", must be greater than or equal to 0.')
  end

  invalid_properties
end
longitude=(longitude) click to toggle source

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

# File lib/openapi_client/models/track_event.rb, line 345
def longitude=(longitude)
  if !longitude.nil? && longitude > 180
    fail ArgumentError, 'invalid value for "longitude", must be smaller than or equal to 180.'
  end

  if !longitude.nil? && longitude < 0
    fail ArgumentError, 'invalid value for "longitude", must be greater than or equal to 0.'
  end

  @longitude = longitude
end
postal_code=(postal_code) click to toggle source

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

# File lib/openapi_client/models/track_event.rb, line 287
def postal_code=(postal_code)
  if postal_code.nil?
    fail ArgumentError, 'postal_code cannot be nil'
  end

  if postal_code.to_s.length < 5
    fail ArgumentError, 'invalid value for "postal_code", the character length must be great than or equal to 5.'
  end

  @postal_code = postal_code
end
signer=(signer) click to toggle source

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

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

  @signer = signer
end
state_province=(state_province) click to toggle source

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

# File lib/openapi_client/models/track_event.rb, line 273
def state_province=(state_province)
  if state_province.nil?
    fail ArgumentError, 'state_province cannot be nil'
  end

  if state_province.to_s.length < 2
    fail ArgumentError, 'invalid value for "state_province", the character length must be great than or equal to 2.'
  end

  @state_province = state_province
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/openapi_client/models/track_event.rb, line 464
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/openapi_client/models/track_event.rb, line 470
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/openapi_client/models/track_event.rb, line 458
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/openapi_client/models/track_event.rb, line 228
def valid?
  return false if @occurred_at.nil?
  return false if !@description.nil? && @description.to_s.length < 0
  return false if @city_locality.nil?
  return false if @city_locality.to_s.length < 0
  return false if @state_province.nil?
  return false if @state_province.to_s.length < 2
  return false if @postal_code.nil?
  return false if @postal_code.to_s.length < 5
  return false if !@company_name.nil? && @company_name.to_s.length < 0
  return false if !@signer.nil? && @signer.to_s.length < 0
  return false if !@event_code.nil? && @event_code.to_s.length < 0
  return false if !@latitude.nil? && @latitude > 90
  return false if !@latitude.nil? && @latitude < 0
  return false if !@longitude.nil? && @longitude > 180
  return false if !@longitude.nil? && @longitude < 0
  true
end