Class: Samsara::Types::SpecificVehicleFaultCodeObjectRequestBody

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

Overview

A specific vehicle fault code.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fault_code:, type:, additional_properties: nil) ⇒ Samsara::Types::SpecificVehicleFaultCodeObjectRequestBody

Parameters:

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

    Additional properties unmapped to the current class definition



28
29
30
31
32
33
 
# File 'lib/samsara_api/types/specific_vehicle_fault_code_object_request_body.rb', line 28

def initialize(fault_code:, type:, additional_properties: nil)
  @fault_code = fault_code
  @type = type
  @additional_properties = additional_properties
  @_field_set = { "faultCode": fault_code, "type": type }
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



16
17
18
 
# File 'lib/samsara_api/types/specific_vehicle_fault_code_object_request_body.rb', line 16

def additional_properties
  @additional_properties
end

#fault_code ⇒ String (readonly)

Returns The specific fault code name.

Returns:

  • (String) —

    The specific fault code name.



11
12
13
 
# File 'lib/samsara_api/types/specific_vehicle_fault_code_object_request_body.rb', line 11

def fault_code
  @fault_code
end

#type ⇒ Object (readonly)

‘J1939_DTC`, `J1939_SPN`, `PASSENGER_DTC`



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

def type
  @type
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/samsara_api/types/specific_vehicle_fault_code_object_request_body.rb', line 39

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


63
64
65
66
 
# File 'lib/samsara_api/types/specific_vehicle_fault_code_object_request_body.rb', line 63

def self.validate_raw(obj:)
  obj.fault_code.is_a?(String) != false || raise("Passed value for field obj.fault_code is not the expected type, validation failed.")
  obj.type.is_a?(Samsara::Types::SpecificVehicleFaultCodeObjectRequestBodyType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


54
55
56
 
# File 'lib/samsara_api/types/specific_vehicle_fault_code_object_request_body.rb', line 54

def to_json
  @_field_set&.to_json
end