Class: Samsara::Types::DriverWithExternalIdObjectResponseBody

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

Overview

A driver object with an id and map of external ids.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(driver_id:, external_ids: OMIT, additional_properties: nil) ⇒ Samsara::Types::DriverWithExternalIdObjectResponseBody

Parameters:

  • driver_id (String) —

    Samsara ID of the driver.

  • external_ids (Hash{String => String}) (defaults to: OMIT) —

    A map of external ids

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

    Additional properties unmapped to the current class definition



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

def initialize(driver_id:, external_ids: OMIT, additional_properties: nil)
  @driver_id = driver_id
  @external_ids = external_ids if external_ids != OMIT
  @additional_properties = additional_properties
  @_field_set = { "driverId": driver_id, "externalIds": external_ids }.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/driver_with_external_id_object_response_body.rb', line 14

def additional_properties
  @additional_properties
end

#driver_id ⇒ String (readonly)

Returns Samsara ID of the driver.

Returns:

  • (String) —

    Samsara ID of the driver.



10
11
12
 
# File 'lib/samsara_api/types/driver_with_external_id_object_response_body.rb', line 10

def driver_id
  @driver_id
end

#external_ids ⇒ Hash{String => String} (readonly)

Returns A map of external ids.

Returns:

  • (Hash{String => String}) —

    A map of external ids



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

def external_ids
  @external_ids
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  driver_id = parsed_json["driverId"]
  external_ids = parsed_json["externalIds"]
  new(
    driver_id: driver_id,
    external_ids: external_ids,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


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

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


52
53
54
 
# File 'lib/samsara_api/types/driver_with_external_id_object_response_body.rb', line 52

def to_json
  @_field_set&.to_json
end