Class: Samsara::Types::HosViolations

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

Overview

information on HOS rules.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cycle_violation_duration_ms: OMIT, shift_driving_violation_duration_ms: OMIT, additional_properties: nil) ⇒ Samsara::Types::HosViolations

Parameters:

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

    Additional properties unmapped to the current class definition



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

def initialize(cycle_violation_duration_ms: OMIT, shift_driving_violation_duration_ms: OMIT, additional_properties: nil)
  @cycle_violation_duration_ms = cycle_violation_duration_ms if cycle_violation_duration_ms != OMIT
  @shift_driving_violation_duration_ms = shift_driving_violation_duration_ms if shift_driving_violation_duration_ms != OMIT
  @additional_properties = additional_properties
  @_field_set = { "cycleViolationDurationMs": cycle_violation_duration_ms, "shiftDrivingViolationDurationMs": shift_driving_violation_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



20
21
22
 
# File 'lib/samsara_api/types/hos_violations.rb', line 20

def additional_properties
  @additional_properties
end

#cycle_violation_duration_ms ⇒ Object (readonly)

driver has been on duty or driving past the 60/70-hour limit in 7/8 days.



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

def cycle_violation_duration_ms
  @cycle_violation_duration_ms
end

#shift_driving_violation_duration_ms ⇒ Object (readonly)

driver has been driving past the 11-hour limit.



18
19
20
 
# File 'lib/samsara_api/types/hos_violations.rb', line 18

def shift_driving_violation_duration_ms
  @shift_driving_violation_duration_ms
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/samsara_api/types/hos_violations.rb', line 47

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  cycle_violation_duration_ms = parsed_json["cycleViolationDurationMs"]
  shift_driving_violation_duration_ms = parsed_json["shiftDrivingViolationDurationMs"]
  new(
    cycle_violation_duration_ms: cycle_violation_duration_ms,
    shift_driving_violation_duration_ms: shift_driving_violation_duration_ms,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


70
71
72
73
 
# File 'lib/samsara_api/types/hos_violations.rb', line 70

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


61
62
63
 
# File 'lib/samsara_api/types/hos_violations.rb', line 61

def to_json
  @_field_set&.to_json
end