Class: Samsara::Types::DriverAppSettingsResponseObjectResponseBody

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

Overview

through the Samsara Settings page or the API at any time.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(driver_fleet_id: OMIT, gamification: OMIT, gamification_config: OMIT, org_vehicle_search: OMIT, trailer_selection: OMIT, trailer_selection_config: OMIT, additional_properties: nil) ⇒ Samsara::Types::DriverAppSettingsResponseObjectResponseBody

Parameters:



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

def initialize(driver_fleet_id: OMIT, gamification: OMIT, gamification_config: OMIT, org_vehicle_search: OMIT, trailer_selection: OMIT, trailer_selection_config: OMIT, additional_properties: nil)
  @driver_fleet_id = driver_fleet_id if driver_fleet_id != OMIT
  @gamification = gamification if gamification != OMIT
  @gamification_config = gamification_config if gamification_config != OMIT
  @org_vehicle_search = org_vehicle_search if org_vehicle_search != OMIT
  @trailer_selection = trailer_selection if trailer_selection != OMIT
  @trailer_selection_config = trailer_selection_config if trailer_selection_config != OMIT
  @additional_properties = additional_properties
  @_field_set = { "driverFleetId": driver_fleet_id, "gamification": gamification, "gamificationConfig": gamification_config, "orgVehicleSearch": org_vehicle_search, "trailerSelection": trailer_selection, "trailerSelectionConfig": trailer_selection_config }.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



28
29
30
 
# File 'lib/samsara_api/types/driver_app_settings_response_object_response_body.rb', line 28

def additional_properties
  @additional_properties
end

#driver_fleet_id ⇒ String (readonly)

Returns Login user name for the fleet driver app.

Returns:

  • (String) —

    Login user name for the fleet driver app



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

def driver_fleet_id
  @driver_fleet_id
end

#gamification ⇒ Object (readonly)

the Drivers Page. Unconfigured drivers will be grouped on an organization level.



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

def gamification
  @gamification
end

#gamification_config ⇒ Samsara::Types::DriverAppSettingsGamificationConfigTinyObjectResponseBody (readonly)

Returns:



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

def gamification_config
  @gamification_config
end

#org_vehicle_search ⇒ Object (readonly)

connected to the internet.



22
23
24
 
# File 'lib/samsara_api/types/driver_app_settings_response_object_response_body.rb', line 22

def org_vehicle_search
  @org_vehicle_search
end

#trailer_selection ⇒ Boolean (readonly)

Returns Allow drivers to see and select trailers in the Samsara Driver app.

Returns:

  • (Boolean) —

    Allow drivers to see and select trailers in the Samsara Driver app.



24
25
26
 
# File 'lib/samsara_api/types/driver_app_settings_response_object_response_body.rb', line 24

def trailer_selection
  @trailer_selection
end

#trailer_selection_config ⇒ Samsara::Types::DriverAppSettingsTrailerSelectionConfigTinyObjectResponseBody (readonly)

Returns:



26
27
28
 
# File 'lib/samsara_api/types/driver_app_settings_response_object_response_body.rb', line 26

def trailer_selection_config
  @trailer_selection_config
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/samsara_api/types/driver_app_settings_response_object_response_body.rb', line 63

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  driver_fleet_id = parsed_json["driverFleetId"]
  gamification = parsed_json["gamification"]
  unless parsed_json["gamificationConfig"].nil?
    gamification_config = parsed_json["gamificationConfig"].to_json
    gamification_config = Samsara::Types::DriverAppSettingsGamificationConfigTinyObjectResponseBody.from_json(json_object: gamification_config)
  else
    gamification_config = nil
  end
  org_vehicle_search = parsed_json["orgVehicleSearch"]
  trailer_selection = parsed_json["trailerSelection"]
  unless parsed_json["trailerSelectionConfig"].nil?
    trailer_selection_config = parsed_json["trailerSelectionConfig"].to_json
    trailer_selection_config = Samsara::Types::DriverAppSettingsTrailerSelectionConfigTinyObjectResponseBody.from_json(json_object: trailer_selection_config)
  else
    trailer_selection_config = nil
  end
  new(
    driver_fleet_id: driver_fleet_id,
    gamification: gamification,
    gamification_config: gamification_config,
    org_vehicle_search: org_vehicle_search,
    trailer_selection: trailer_selection,
    trailer_selection_config: trailer_selection_config,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


105
106
107
108
109
110
111
112
 
# File 'lib/samsara_api/types/driver_app_settings_response_object_response_body.rb', line 105

def self.validate_raw(obj:)
  obj.driver_fleet_id&.is_a?(String) != false || raise("Passed value for field obj.driver_fleet_id is not the expected type, validation failed.")
  obj.gamification&.is_a?(Boolean) != false || raise("Passed value for field obj.gamification is not the expected type, validation failed.")
  obj.gamification_config.nil? || Samsara::Types::DriverAppSettingsGamificationConfigTinyObjectResponseBody.validate_raw(obj: obj.gamification_config)
  obj.org_vehicle_search&.is_a?(Boolean) != false || raise("Passed value for field obj.org_vehicle_search is not the expected type, validation failed.")
  obj.trailer_selection&.is_a?(Boolean) != false || raise("Passed value for field obj.trailer_selection is not the expected type, validation failed.")
  obj.trailer_selection_config.nil? || Samsara::Types::DriverAppSettingsTrailerSelectionConfigTinyObjectResponseBody.validate_raw(obj: obj.trailer_selection_config)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


96
97
98
 
# File 'lib/samsara_api/types/driver_app_settings_response_object_response_body.rb', line 96

def to_json
  @_field_set&.to_json
end