Class: Samsara::Types::VehicleStatsFaultCodesObdiiTroubleCode

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

Overview

Diagnostic trouble code for passenger vehicles.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(confirmed_dtcs: OMIT, ignition_type: OMIT, mil_status: OMIT, monitor_status: OMIT, pending_dtcs: OMIT, permanent_dtcs: OMIT, tx_id:, additional_properties: nil) ⇒ Samsara::Types::VehicleStatsFaultCodesObdiiTroubleCode

Parameters:



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

def initialize(confirmed_dtcs: OMIT, ignition_type: OMIT, mil_status: OMIT, monitor_status: OMIT, pending_dtcs: OMIT, permanent_dtcs: OMIT, tx_id:, additional_properties: nil)
  @confirmed_dtcs = confirmed_dtcs if confirmed_dtcs != OMIT
  @ignition_type = ignition_type if ignition_type != OMIT
  @mil_status = mil_status if mil_status != OMIT
  @monitor_status = monitor_status if monitor_status != OMIT
  @pending_dtcs = pending_dtcs if pending_dtcs != OMIT
  @permanent_dtcs = permanent_dtcs if permanent_dtcs != OMIT
  @tx_id = tx_id
  @additional_properties = additional_properties
  @_field_set = { "confirmedDtcs": confirmed_dtcs, "ignitionType": ignition_type, "milStatus": mil_status, "monitorStatus": monitor_status, "pendingDtcs": pending_dtcs, "permanentDtcs": permanent_dtcs, "txId": tx_id }.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_stats_fault_codes_obdii_trouble_code.rb', line 27

def additional_properties
  @additional_properties
end

#confirmed_dtcs ⇒ Array<Samsara::Types::VehicleStatsFaultCodesPassengerDtc> (readonly)

Returns Confirmed DTC codes.

Returns:



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

def confirmed_dtcs
  @confirmed_dtcs
end

#ignition_type ⇒ Samsara::Types::VehicleStatsFaultCodesIgnitionType (readonly)

Returns:



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

def ignition_type
  @ignition_type
end

#mil_status ⇒ Boolean (readonly)

Returns The MIL status, indicating a check engine light.

Returns:

  • (Boolean) —

    The MIL status, indicating a check engine light.



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

def mil_status
  @mil_status
end

#monitor_status ⇒ Samsara::Types::VehicleStatsFaultCodesPassengerMonitorStatus (readonly)

Returns:



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

def monitor_status
  @monitor_status
end

#pending_dtcs ⇒ Array<Samsara::Types::VehicleStatsFaultCodesPassengerDtc> (readonly)

Returns Pending DTC codes.

Returns:



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

def pending_dtcs
  @pending_dtcs
end

#permanent_dtcs ⇒ Array<Samsara::Types::VehicleStatsFaultCodesPassengerDtc> (readonly)

Returns Permanent DTC codes.

Returns:



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

def permanent_dtcs
  @permanent_dtcs
end

#tx_id ⇒ Integer (readonly)

Returns:

  • (Integer) 


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

def tx_id
  @tx_id
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/samsara_api/types/vehicle_stats_fault_codes_obdii_trouble_code.rb', line 61

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  confirmed_dtcs = parsed_json["confirmedDtcs"]&.map do | item |
  item = item.to_json
  Samsara::Types::VehicleStatsFaultCodesPassengerDtc.from_json(json_object: item)
end
  ignition_type = parsed_json["ignitionType"]
  mil_status = parsed_json["milStatus"]
  unless parsed_json["monitorStatus"].nil?
    monitor_status = parsed_json["monitorStatus"].to_json
    monitor_status = Samsara::Types::VehicleStatsFaultCodesPassengerMonitorStatus.from_json(json_object: monitor_status)
  else
    monitor_status = nil
  end
  pending_dtcs = parsed_json["pendingDtcs"]&.map do | item |
  item = item.to_json
  Samsara::Types::VehicleStatsFaultCodesPassengerDtc.from_json(json_object: item)
end
  permanent_dtcs = parsed_json["permanentDtcs"]&.map do | item |
  item = item.to_json
  Samsara::Types::VehicleStatsFaultCodesPassengerDtc.from_json(json_object: item)
end
  tx_id = parsed_json["txId"]
  new(
    confirmed_dtcs: confirmed_dtcs,
    ignition_type: ignition_type,
    mil_status: mil_status,
    monitor_status: monitor_status,
    pending_dtcs: pending_dtcs,
    permanent_dtcs: permanent_dtcs,
    tx_id: tx_id,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


108
109
110
111
112
113
114
115
116
 
# File 'lib/samsara_api/types/vehicle_stats_fault_codes_obdii_trouble_code.rb', line 108

def self.validate_raw(obj:)
  obj.confirmed_dtcs&.is_a?(Array) != false || raise("Passed value for field obj.confirmed_dtcs is not the expected type, validation failed.")
  obj.ignition_type&.is_a?(Samsara::Types::VehicleStatsFaultCodesIgnitionType) != false || raise("Passed value for field obj.ignition_type is not the expected type, validation failed.")
  obj.mil_status&.is_a?(Boolean) != false || raise("Passed value for field obj.mil_status is not the expected type, validation failed.")
  obj.monitor_status.nil? || Samsara::Types::VehicleStatsFaultCodesPassengerMonitorStatus.validate_raw(obj: obj.monitor_status)
  obj.pending_dtcs&.is_a?(Array) != false || raise("Passed value for field obj.pending_dtcs is not the expected type, validation failed.")
  obj.permanent_dtcs&.is_a?(Array) != false || raise("Passed value for field obj.permanent_dtcs is not the expected type, validation failed.")
  obj.tx_id.is_a?(Integer) != false || raise("Passed value for field obj.tx_id is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


99
100
101
 
# File 'lib/samsara_api/types/vehicle_stats_fault_codes_obdii_trouble_code.rb', line 99

def to_json
  @_field_set&.to_json
end