Class: Samsara::Types::DriverCarrierSettings

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

Overview

only updates the override setting for this driver.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(carrier_name: OMIT, dot_number: OMIT, home_terminal_address: OMIT, home_terminal_name: OMIT, main_office_address: OMIT, additional_properties: nil) ⇒ Samsara::Types::DriverCarrierSettings

Parameters:

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

    Additional properties unmapped to the current class definition



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/samsara_api/types/driver_carrier_settings.rb', line 42

def initialize(carrier_name: OMIT, dot_number: OMIT, home_terminal_address: OMIT, home_terminal_name: OMIT, main_office_address: OMIT, additional_properties: nil)
  @carrier_name = carrier_name if carrier_name != OMIT
  @dot_number = dot_number if dot_number != OMIT
  @home_terminal_address = home_terminal_address if home_terminal_address != OMIT
  @home_terminal_name = home_terminal_name if home_terminal_name != OMIT
  @main_office_address = main_office_address if main_office_address != OMIT
  @additional_properties = additional_properties
  @_field_set = { "carrierName": carrier_name, "dotNumber": dot_number, "homeTerminalAddress": home_terminal_address, "homeTerminalName": home_terminal_name, "mainOfficeAddress": main_office_address }.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



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

def additional_properties
  @additional_properties
end

#carrier_name ⇒ String (readonly)

Returns Carrier for a given driver.

Returns:

  • (String) —

    Carrier for a given driver.



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

def carrier_name
  @carrier_name
end

#dot_number ⇒ Object (readonly)

setting for this driver.



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

def dot_number
  @dot_number
end

#home_terminal_address ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/samsara_api/types/driver_carrier_settings.rb', line 18

def home_terminal_address
  @home_terminal_address
end

#home_terminal_name ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/samsara_api/types/driver_carrier_settings.rb', line 20

def home_terminal_name
  @home_terminal_name
end

#main_office_address ⇒ Object (readonly)

organization's settings, the override value is used.



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

def main_office_address
  @main_office_address
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/samsara_api/types/driver_carrier_settings.rb', line 57

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  carrier_name = parsed_json["carrierName"]
  dot_number = parsed_json["dotNumber"]
  home_terminal_address = parsed_json["homeTerminalAddress"]
  home_terminal_name = parsed_json["homeTerminalName"]
  main_office_address = parsed_json["mainOfficeAddress"]
  new(
    carrier_name: carrier_name,
    dot_number: dot_number,
    home_terminal_address: home_terminal_address,
    home_terminal_name: home_terminal_name,
    main_office_address: main_office_address,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


86
87
88
89
90
91
92
 
# File 'lib/samsara_api/types/driver_carrier_settings.rb', line 86

def self.validate_raw(obj:)
  obj.carrier_name&.is_a?(String) != false || raise("Passed value for field obj.carrier_name is not the expected type, validation failed.")
  obj.dot_number&.is_a?(Long) != false || raise("Passed value for field obj.dot_number is not the expected type, validation failed.")
  obj.home_terminal_address&.is_a?(String) != false || raise("Passed value for field obj.home_terminal_address is not the expected type, validation failed.")
  obj.home_terminal_name&.is_a?(String) != false || raise("Passed value for field obj.home_terminal_name is not the expected type, validation failed.")
  obj.main_office_address&.is_a?(String) != false || raise("Passed value for field obj.main_office_address is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


77
78
79
 
# File 'lib/samsara_api/types/driver_carrier_settings.rb', line 77

def to_json
  @_field_set&.to_json
end