Class: Crisphive::Vehicle

Inherits:
Object
  • Object
show all
Defined in:
lib/crisphive/models/vehicle.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vehicle

Initializes the object

Parameters:

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

    Model attributes in the form of hash



150
151
152
153
154
155
156
157
158
159
160
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
225
226
227
228
229
230
231
232
 
# File 'lib/crisphive/models/vehicle.rb', line 150

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Crisphive::Vehicle` 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 `Crisphive::Vehicle`. 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?(:'brand')
    self.brand = attributes[:'brand']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'technician_ids')
    if (value = attributes[:'technician_ids']).is_a?(Array)
      self.technician_ids = value
    end
  end

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

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

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

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

Instance Attribute Details

#brand ⇒ Object

Manufacturer / make (e.g. "Ford"). Empty if not set.



19
20
21
 
# File 'lib/crisphive/models/vehicle.rb', line 19

def brand
  @brand
end

#business_id ⇒ Object

UUID of the business that owns this vehicle.



22
23
24
 
# File 'lib/crisphive/models/vehicle.rb', line 22

def business_id
  @business_id
end

#created_at ⇒ Object

When the vehicle record was created (RFC3339).



25
26
27
 
# File 'lib/crisphive/models/vehicle.rb', line 25

def created_at
  @created_at
end

#current_mileage ⇒ Object

Current odometer reading; null if not tracked.



28
29
30
 
# File 'lib/crisphive/models/vehicle.rb', line 28

def current_mileage
  @current_mileage
end

#deleted_at ⇒ Object

Set (RFC3339) only when the record has been soft-deleted; omitted otherwise.



31
32
33
 
# File 'lib/crisphive/models/vehicle.rb', line 31

def deleted_at
  @deleted_at
end

#id ⇒ Object

Vehicle UUID — the stable identifier used in every vehicle endpoint.



34
35
36
 
# File 'lib/crisphive/models/vehicle.rb', line 34

def id
  @id
end

#model ⇒ Object

Model name (e.g. "Transit"). Empty if not set.



37
38
39
 
# File 'lib/crisphive/models/vehicle.rb', line 37

def model
  @model
end

#name ⇒ Object

Vehicle display name.



40
41
42
 
# File 'lib/crisphive/models/vehicle.rb', line 40

def name
  @name
end

#operational_status ⇒ Object

Live operational state derived from the vehicle's jobs: on_job = a job's scheduled window contains now (the vehicle is out working); assigned = attached to an upcoming/open job that is not in progress; other values mirror status.



43
44
45
 
# File 'lib/crisphive/models/vehicle.rb', line 43

def operational_status
  @operational_status
end

#owner ⇒ Object

The technician who currently owns (claimed) this vehicle; null if unowned.



46
47
48
 
# File 'lib/crisphive/models/vehicle.rb', line 46

def owner
  @owner
end

#plate_number ⇒ Object

License plate number. Empty if not set.



49
50
51
 
# File 'lib/crisphive/models/vehicle.rb', line 49

def plate_number
  @plate_number
end

#status ⇒ Object

Stored status. on_job here means "attached to an open job" (set at assignment, cleared at complete/archive/unassign) — see operational_status for the live state.



52
53
54
 
# File 'lib/crisphive/models/vehicle.rb', line 52

def status
  @status
end

#technician_ids ⇒ Object

UUIDs of technicians who use this vehicle (derived from each technician's vehicle list). Empty array if none.



55
56
57
 
# File 'lib/crisphive/models/vehicle.rb', line 55

def technician_ids
  @technician_ids
end

#updated_at ⇒ Object

When the vehicle record was last modified (RFC3339).



58
59
60
 
# File 'lib/crisphive/models/vehicle.rb', line 58

def updated_at
  @updated_at
end

#utilization_percent ⇒ Object

Percentage of capacity the vehicle is utilized (0–100).



61
62
63
 
# File 'lib/crisphive/models/vehicle.rb', line 61

def utilization_percent
  @utilization_percent
end

#vehicle_type ⇒ Object

Vehicle category.



64
65
66
 
# File 'lib/crisphive/models/vehicle.rb', line 64

def vehicle_type
  @vehicle_type
end

#year ⇒ Object

Model year. Zero if not set.



67
68
69
 
# File 'lib/crisphive/models/vehicle.rb', line 67

def year
  @year
end

Class Method Details

._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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/crisphive/models/vehicle.rb', line 348

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Crisphive.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



115
116
117
 
# File 'lib/crisphive/models/vehicle.rb', line 115

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/crisphive/models/vehicle.rb', line 92

def self.attribute_map
  {
    :'brand' => :'brand',
    :'business_id' => :'business_id',
    :'created_at' => :'created_at',
    :'current_mileage' => :'current_mileage',
    :'deleted_at' => :'deleted_at',
    :'id' => :'id',
    :'model' => :'model',
    :'name' => :'name',
    :'operational_status' => :'operational_status',
    :'owner' => :'owner',
    :'plate_number' => :'plate_number',
    :'status' => :'status',
    :'technician_ids' => :'technician_ids',
    :'updated_at' => :'updated_at',
    :'utilization_percent' => :'utilization_percent',
    :'vehicle_type' => :'vehicle_type',
    :'year' => :'year'
  }
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/crisphive/models/vehicle.rb', line 324

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
 
# File 'lib/crisphive/models/vehicle.rb', line 143

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

.openapi_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/crisphive/models/vehicle.rb', line 120

def self.openapi_types
  {
    :'brand' => :'String',
    :'business_id' => :'String',
    :'created_at' => :'Time',
    :'current_mileage' => :'Integer',
    :'deleted_at' => :'Time',
    :'id' => :'String',
    :'model' => :'String',
    :'name' => :'String',
    :'operational_status' => :'String',
    :'owner' => :'VehicleOwner',
    :'plate_number' => :'String',
    :'status' => :'String',
    :'technician_ids' => :'Array<String>',
    :'updated_at' => :'Time',
    :'utilization_percent' => :'Integer',
    :'vehicle_type' => :'String',
    :'year' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/crisphive/models/vehicle.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      brand == o.brand &&
      business_id == o.business_id &&
      created_at == o.created_at &&
      current_mileage == o.current_mileage &&
      deleted_at == o.deleted_at &&
      id == o.id &&
      model == o.model &&
      name == o.name &&
      operational_status == o.operational_status &&
      owner == o.owner &&
      plate_number == o.plate_number &&
      status == o.status &&
      technician_ids == o.technician_ids &&
      updated_at == o.updated_at &&
      utilization_percent == o.utilization_percent &&
      vehicle_type == o.vehicle_type &&
      year == o.year
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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/crisphive/models/vehicle.rb', line 419

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/crisphive/models/vehicle.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



317
318
319
 
# File 'lib/crisphive/models/vehicle.rb', line 317

def hash
  [brand, business_id, created_at, current_mileage, deleted_at, id, model, name, operational_status, owner, plate_number, status, technician_ids, updated_at, utilization_percent, vehicle_type, year].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



236
237
238
239
240
 
# File 'lib/crisphive/models/vehicle.rb', line 236

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



395
396
397
 
# File 'lib/crisphive/models/vehicle.rb', line 395

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



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/crisphive/models/vehicle.rb', line 401

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



389
390
391
 
# File 'lib/crisphive/models/vehicle.rb', line 389

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



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/crisphive/models/vehicle.rb', line 244

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  operational_status_validator = EnumAttributeValidator.new('String', ["inactive", "idle", "assigned", "on_job", "maintenance"])
  return false unless operational_status_validator.valid?(@operational_status)
  status_validator = EnumAttributeValidator.new('String', ["inactive", "idle", "on_job", "maintenance"])
  return false unless status_validator.valid?(@status)
  vehicle_type_validator = EnumAttributeValidator.new('String', ["van", "truck", "car"])
  return false unless vehicle_type_validator.valid?(@vehicle_type)
  true
end