Class: OpenapiClient::TrackEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/track_event.rb

Overview

A track event

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrackEvent

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# 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

Instance Attribute Details

#carrier_occurred_at ⇒ Object

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



22
23
24
 
# File 'lib/openapi_client/models/track_event.rb', line 22

def carrier_occurred_at
  @carrier_occurred_at
end

#city_locality ⇒ Object

City locality



28
29
30
 
# File 'lib/openapi_client/models/track_event.rb', line 28

def city_locality
  @city_locality
end

#company_name ⇒ Object

Company Name



39
40
41
 
# File 'lib/openapi_client/models/track_event.rb', line 39

def company_name
  @company_name
end

#country_code ⇒ Object

Returns the value of attribute country_code.



36
37
38
 
# File 'lib/openapi_client/models/track_event.rb', line 36

def country_code
  @country_code
end

#description ⇒ Object

Event description



25
26
27
 
# File 'lib/openapi_client/models/track_event.rb', line 25

def description
  @description
end

#event_code ⇒ Object

Event Code



45
46
47
 
# File 'lib/openapi_client/models/track_event.rb', line 45

def event_code
  @event_code
end

#latitude ⇒ Object

Latitude coordinate of tracking event.



48
49
50
 
# File 'lib/openapi_client/models/track_event.rb', line 48

def latitude
  @latitude
end

#longitude ⇒ Object

Longitude coordinate of tracking event.



51
52
53
 
# File 'lib/openapi_client/models/track_event.rb', line 51

def longitude
  @longitude
end

#occurred_at ⇒ Object

Timestamp for carrier event



19
20
21
 
# File 'lib/openapi_client/models/track_event.rb', line 19

def occurred_at
  @occurred_at
end

#postal_code ⇒ Object

Postal code



34
35
36
 
# File 'lib/openapi_client/models/track_event.rb', line 34

def postal_code
  @postal_code
end

#signer ⇒ Object

Signer information



42
43
44
 
# File 'lib/openapi_client/models/track_event.rb', line 42

def signer
  @signer
end

#state_province ⇒ Object

State province



31
32
33
 
# File 'lib/openapi_client/models/track_event.rb', line 31

def state_province
  @state_province
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



391
392
393
 
# File 'lib/openapi_client/models/track_event.rb', line 391

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/openapi_client/models/track_event.rb', line 90

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



488
489
490
491
492
493
494
495
496
497
498
499
500
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


378
379
380
 
# File 'lib/openapi_client/models/track_event.rb', line 378

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



384
385
386
 
# 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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



464
465
466
 
# File 'lib/openapi_client/models/track_event.rb', line 464

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



470
471
472
473
474
475
476
477
478
479
480
481
482
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



458
459
460
 
# File 'lib/openapi_client/models/track_event.rb', line 458

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# 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