Class: Samsara::Types::HosShift

Inherits:
Object
  • Object
show all
Defined in:
lib/samsara_api/types/hos_shift.rb

Overview

Remaining durations and start time for the HOS on duty shift limits.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(shift_remaining_duration_ms: OMIT, additional_properties: nil) ⇒ Samsara::Types::HosShift

Parameters:

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



26
27
28
29
30
31
32
 
# File 'lib/samsara_api/types/hos_shift.rb', line 26

def initialize(shift_remaining_duration_ms: OMIT, additional_properties: nil)
  @shift_remaining_duration_ms = shift_remaining_duration_ms if shift_remaining_duration_ms != OMIT
  @additional_properties = additional_properties
  @_field_set = { "shiftRemainingDurationMs": shift_remaining_duration_ms }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



14
15
16
 
# File 'lib/samsara_api/types/hos_shift.rb', line 14

def additional_properties
  @additional_properties
end

#shift_remaining_duration_ms ⇒ Object (readonly)

driver can be on duty or driving before hitting the 14-hour limit.



12
13
14
 
# File 'lib/samsara_api/types/hos_shift.rb', line 12

def shift_remaining_duration_ms
  @shift_remaining_duration_ms
end

Class Method Details

.from_json(json_object:) ⇒ Samsara::Types::HosShift

Parameters:

  • json_object (String)

Returns:



37
38
39
40
41
42
 
# File 'lib/samsara_api/types/hos_shift.rb', line 37

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  shift_remaining_duration_ms = parsed_json["shiftRemainingDurationMs"]
  new(shift_remaining_duration_ms: shift_remaining_duration_ms, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


55
56
57
 
# File 'lib/samsara_api/types/hos_shift.rb', line 55

def self.validate_raw(obj:)
  obj.shift_remaining_duration_ms&.is_a?(Float) != false || raise("Passed value for field obj.shift_remaining_duration_ms is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


46
47
48
 
# File 'lib/samsara_api/types/hos_shift.rb', line 46

def to_json
  @_field_set&.to_json
end