Class: Samsara::Types::VehicleFaultCodeDetailsObjectRequestBody

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

Overview

group must be selected.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(has_any_amber_warning_lamp_codes: OMIT, has_any_fault_codes: OMIT, has_any_malfunction_indicator_lamp_codes: OMIT, has_any_protection_lamp_codes: OMIT, has_any_red_stop_lamp_codes: OMIT, has_any_trailer_abs_lamp_codes: OMIT, specific_fault_codes: OMIT, additional_properties: nil) ⇒ Samsara::Types::VehicleFaultCodeDetailsObjectRequestBody

Parameters:

  • has_any_fault_codes (Boolean) (defaults to: OMIT) —

    If true this means that any code is alertable. Defaults to false.

  • has_any_malfunction_indicator_lamp_codes (Boolean) (defaults to: OMIT) —

    If true then alert on emission-related codes. Defaults to false.

  • has_any_protection_lamp_codes (Boolean) (defaults to: OMIT) —

    If true then alert on codes for non-electric vehicle parts. Defaults to false.

  • has_any_red_stop_lamp_codes (Boolean) (defaults to: OMIT) —

    If true then alert when the vehicle warrants stopping. Defaults to false.

  • has_any_trailer_abs_lamp_codes (Boolean) (defaults to: OMIT) —

    If true then alert when the ABS light is on. Defaults to false.

  • specific_fault_codes (Array<Samsara::Types::SpecificVehicleFaultCodeObjectRequestBody>) (defaults to: OMIT) —

    The list of specific fault codes to be alerted on.

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

    Additional properties unmapped to the current class definition



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 44

def initialize(has_any_amber_warning_lamp_codes: OMIT, has_any_fault_codes: OMIT, has_any_malfunction_indicator_lamp_codes: OMIT, has_any_protection_lamp_codes: OMIT, has_any_red_stop_lamp_codes: OMIT, has_any_trailer_abs_lamp_codes: OMIT, specific_fault_codes: OMIT, additional_properties: nil)
  @has_any_amber_warning_lamp_codes = has_any_amber_warning_lamp_codes if has_any_amber_warning_lamp_codes != OMIT
  @has_any_fault_codes = has_any_fault_codes if has_any_fault_codes != OMIT
  @has_any_malfunction_indicator_lamp_codes = has_any_malfunction_indicator_lamp_codes if has_any_malfunction_indicator_lamp_codes != OMIT
  @has_any_protection_lamp_codes = has_any_protection_lamp_codes if has_any_protection_lamp_codes != OMIT
  @has_any_red_stop_lamp_codes = has_any_red_stop_lamp_codes if has_any_red_stop_lamp_codes != OMIT
  @has_any_trailer_abs_lamp_codes = has_any_trailer_abs_lamp_codes if has_any_trailer_abs_lamp_codes != OMIT
  @specific_fault_codes = specific_fault_codes if specific_fault_codes != OMIT
  @additional_properties = additional_properties
  @_field_set = { "hasAnyAmberWarningLampCodes": has_any_amber_warning_lamp_codes, "hasAnyFaultCodes": has_any_fault_codes, "hasAnyMalfunctionIndicatorLampCodes": has_any_malfunction_indicator_lamp_codes, "hasAnyProtectionLampCodes": has_any_protection_lamp_codes, "hasAnyRedStopLampCodes": has_any_red_stop_lamp_codes, "hasAnyTrailerAbsLampCodes": has_any_trailer_abs_lamp_codes, "specificFaultCodes": specific_fault_codes }.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



27
28
29
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 27

def additional_properties
  @additional_properties
end

#has_any_amber_warning_lamp_codes ⇒ Object (readonly)

stopping. Defaults to false.



13
14
15
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 13

def has_any_amber_warning_lamp_codes
  @has_any_amber_warning_lamp_codes
end

#has_any_fault_codes ⇒ Boolean (readonly)

Returns If true this means that any code is alertable. Defaults to false.

Returns:

  • (Boolean) —

    If true this means that any code is alertable. Defaults to false.



15
16
17
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 15

def has_any_fault_codes
  @has_any_fault_codes
end

#has_any_malfunction_indicator_lamp_codes ⇒ Boolean (readonly)

Returns If true then alert on emission-related codes. Defaults to false.

Returns:

  • (Boolean) —

    If true then alert on emission-related codes. Defaults to false.



17
18
19
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 17

def has_any_malfunction_indicator_lamp_codes
  @has_any_malfunction_indicator_lamp_codes
end

#has_any_protection_lamp_codes ⇒ Boolean (readonly)

Returns If true then alert on codes for non-electric vehicle parts. Defaults to false.

Returns:

  • (Boolean) —

    If true then alert on codes for non-electric vehicle parts. Defaults to false.



19
20
21
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 19

def has_any_protection_lamp_codes
  @has_any_protection_lamp_codes
end

#has_any_red_stop_lamp_codes ⇒ Boolean (readonly)

Returns If true then alert when the vehicle warrants stopping. Defaults to false.

Returns:

  • (Boolean) —

    If true then alert when the vehicle warrants stopping. Defaults to false.



21
22
23
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 21

def has_any_red_stop_lamp_codes
  @has_any_red_stop_lamp_codes
end

#has_any_trailer_abs_lamp_codes ⇒ Boolean (readonly)

Returns If true then alert when the ABS light is on. Defaults to false.

Returns:

  • (Boolean) —

    If true then alert when the ABS light is on. Defaults to false.



23
24
25
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 23

def has_any_trailer_abs_lamp_codes
  @has_any_trailer_abs_lamp_codes
end

#specific_fault_codes ⇒ Array<Samsara::Types::SpecificVehicleFaultCodeObjectRequestBody> (readonly)

Returns The list of specific fault codes to be alerted on.

Returns:



25
26
27
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 25

def specific_fault_codes
  @specific_fault_codes
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 62

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  has_any_amber_warning_lamp_codes = parsed_json["hasAnyAmberWarningLampCodes"]
  has_any_fault_codes = parsed_json["hasAnyFaultCodes"]
  has_any_malfunction_indicator_lamp_codes = parsed_json["hasAnyMalfunctionIndicatorLampCodes"]
  has_any_protection_lamp_codes = parsed_json["hasAnyProtectionLampCodes"]
  has_any_red_stop_lamp_codes = parsed_json["hasAnyRedStopLampCodes"]
  has_any_trailer_abs_lamp_codes = parsed_json["hasAnyTrailerAbsLampCodes"]
  specific_fault_codes = parsed_json["specificFaultCodes"]&.map do | item |
  item = item.to_json
  Samsara::Types::SpecificVehicleFaultCodeObjectRequestBody.from_json(json_object: item)
end
  new(
    has_any_amber_warning_lamp_codes: has_any_amber_warning_lamp_codes,
    has_any_fault_codes: has_any_fault_codes,
    has_any_malfunction_indicator_lamp_codes: has_any_malfunction_indicator_lamp_codes,
    has_any_protection_lamp_codes: has_any_protection_lamp_codes,
    has_any_red_stop_lamp_codes: has_any_red_stop_lamp_codes,
    has_any_trailer_abs_lamp_codes: has_any_trailer_abs_lamp_codes,
    specific_fault_codes: specific_fault_codes,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


99
100
101
102
103
104
105
106
107
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 99

def self.validate_raw(obj:)
  obj.has_any_amber_warning_lamp_codes&.is_a?(Boolean) != false || raise("Passed value for field obj.has_any_amber_warning_lamp_codes is not the expected type, validation failed.")
  obj.has_any_fault_codes&.is_a?(Boolean) != false || raise("Passed value for field obj.has_any_fault_codes is not the expected type, validation failed.")
  obj.has_any_malfunction_indicator_lamp_codes&.is_a?(Boolean) != false || raise("Passed value for field obj.has_any_malfunction_indicator_lamp_codes is not the expected type, validation failed.")
  obj.has_any_protection_lamp_codes&.is_a?(Boolean) != false || raise("Passed value for field obj.has_any_protection_lamp_codes is not the expected type, validation failed.")
  obj.has_any_red_stop_lamp_codes&.is_a?(Boolean) != false || raise("Passed value for field obj.has_any_red_stop_lamp_codes is not the expected type, validation failed.")
  obj.has_any_trailer_abs_lamp_codes&.is_a?(Boolean) != false || raise("Passed value for field obj.has_any_trailer_abs_lamp_codes is not the expected type, validation failed.")
  obj.specific_fault_codes&.is_a?(Array) != false || raise("Passed value for field obj.specific_fault_codes is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


90
91
92
 
# File 'lib/samsara_api/types/vehicle_fault_code_details_object_request_body.rb', line 90

def to_json
  @_field_set&.to_json
end