Class: Samsara::Types::SettingsComplianceResponseObjectResponseBody

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

Overview

transferred US DOT datafile.

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_unregulated_vehicles_enabled: OMIT, canada_hos_enabled: OMIT, carrier_name: OMIT, dot_number: OMIT, driver_auto_duty_enabled: OMIT, edit_certified_logs_enabled: OMIT, force_manual_location_for_duty_status_changes_enabled: OMIT, force_review_unassigned_hos_enabled: OMIT, main_office_formatted_address: OMIT, persistent_duty_status_enabled: OMIT, additional_properties: nil) ⇒ Samsara::Types::SettingsComplianceResponseObjectResponseBody

Parameters:

  • canada_hos_enabled (Boolean) (defaults to: OMIT) —

    Enable Canada HOS

  • carrier_name (String) (defaults to: OMIT) —

    Carrier name of the organization

  • dot_number (Long) (defaults to: OMIT) —

    DOT Number

  • driver_auto_duty_enabled (Boolean) (defaults to: OMIT) —

    Enable Driver Auto-Duty

  • edit_certified_logs_enabled (Boolean) (defaults to: OMIT) —

    Drivers Can Edit Certified Log

  • force_manual_location_for_duty_status_changes_enabled (Boolean) (defaults to: OMIT) —

    Force Manual Location For Duty Status Changes

  • force_review_unassigned_hos_enabled (Boolean) (defaults to: OMIT) —

    Force Review of Unassigned HOS

  • main_office_formatted_address (String) (defaults to: OMIT) —

    Office Address

  • persistent_duty_status_enabled (Boolean) (defaults to: OMIT) —

    Persistent Duty Status

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

    Additional properties unmapped to the current class definition



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/samsara_api/types/settings_compliance_response_object_response_body.rb', line 52

def initialize(allow_unregulated_vehicles_enabled: OMIT, canada_hos_enabled: OMIT, carrier_name: OMIT, dot_number: OMIT, driver_auto_duty_enabled: OMIT, edit_certified_logs_enabled: OMIT, force_manual_location_for_duty_status_changes_enabled: OMIT, force_review_unassigned_hos_enabled: OMIT, main_office_formatted_address: OMIT, persistent_duty_status_enabled: OMIT, additional_properties: nil)
  @allow_unregulated_vehicles_enabled = allow_unregulated_vehicles_enabled if allow_unregulated_vehicles_enabled != OMIT
  @canada_hos_enabled = canada_hos_enabled if canada_hos_enabled != OMIT
  @carrier_name = carrier_name if carrier_name != OMIT
  @dot_number = dot_number if dot_number != OMIT
  @driver_auto_duty_enabled = driver_auto_duty_enabled if driver_auto_duty_enabled != OMIT
  @edit_certified_logs_enabled = edit_certified_logs_enabled if edit_certified_logs_enabled != OMIT
  @force_manual_location_for_duty_status_changes_enabled = force_manual_location_for_duty_status_changes_enabled if force_manual_location_for_duty_status_changes_enabled != OMIT
  @force_review_unassigned_hos_enabled = force_review_unassigned_hos_enabled if force_review_unassigned_hos_enabled != OMIT
  @main_office_formatted_address = main_office_formatted_address if main_office_formatted_address != OMIT
  @persistent_duty_status_enabled = persistent_duty_status_enabled if persistent_duty_status_enabled != OMIT
  @additional_properties = additional_properties
  @_field_set = { "allowUnregulatedVehiclesEnabled": allow_unregulated_vehicles_enabled, "canadaHosEnabled": canada_hos_enabled, "carrierName": carrier_name, "dotNumber": dot_number, "driverAutoDutyEnabled": driver_auto_duty_enabled, "editCertifiedLogsEnabled": edit_certified_logs_enabled, "forceManualLocationForDutyStatusChangesEnabled": force_manual_location_for_duty_status_changes_enabled, "forceReviewUnassignedHosEnabled": force_review_unassigned_hos_enabled, "mainOfficeFormattedAddress": main_office_formatted_address, "persistentDutyStatusEnabled": persistent_duty_status_enabled }.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



32
33
34
# File 'lib/samsara_api/types/settings_compliance_response_object_response_body.rb', line 32

def additional_properties
  @additional_properties
end

#allow_unregulated_vehicles_enabled ⇒ Object (readonly)

organizations can now mark vehicles as unregulated.



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

def allow_unregulated_vehicles_enabled
  @allow_unregulated_vehicles_enabled
end

#canada_hos_enabled ⇒ Boolean (readonly)

Returns Enable Canada HOS.

Returns:

  • (Boolean) —

    Enable Canada HOS



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

def canada_hos_enabled
  @canada_hos_enabled
end

#carrier_name ⇒ String (readonly)

Returns Carrier name of the organization.

Returns:

  • (String) —

    Carrier name of the organization



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

def carrier_name
  @carrier_name
end

#dot_number ⇒ Long (readonly)

Returns DOT Number.

Returns:

  • (Long) —

    DOT Number



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

def dot_number
  @dot_number
end

#driver_auto_duty_enabled ⇒ Boolean (readonly)

Returns Enable Driver Auto-Duty.

Returns:

  • (Boolean) —

    Enable Driver Auto-Duty



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

def driver_auto_duty_enabled
  @driver_auto_duty_enabled
end

#edit_certified_logs_enabled ⇒ Boolean (readonly)

Returns Drivers Can Edit Certified Log.

Returns:

  • (Boolean) —

    Drivers Can Edit Certified Log



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

def edit_certified_logs_enabled
  @edit_certified_logs_enabled
end

#force_manual_location_for_duty_status_changes_enabled ⇒ Boolean (readonly)

Returns Force Manual Location For Duty Status Changes.

Returns:

  • (Boolean) —

    Force Manual Location For Duty Status Changes



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

def force_manual_location_for_duty_status_changes_enabled
  @force_manual_location_for_duty_status_changes_enabled
end

#force_review_unassigned_hos_enabled ⇒ Boolean (readonly)

Returns Force Review of Unassigned HOS.

Returns:

  • (Boolean) —

    Force Review of Unassigned HOS



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

def force_review_unassigned_hos_enabled
  @force_review_unassigned_hos_enabled
end

#main_office_formatted_address ⇒ String (readonly)

Returns Office Address.

Returns:

  • (String) —

    Office Address



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

def main_office_formatted_address
  @main_office_formatted_address
end

#persistent_duty_status_enabled ⇒ Boolean (readonly)

Returns Persistent Duty Status.

Returns:

  • (Boolean) —

    Persistent Duty Status



30
31
32
# File 'lib/samsara_api/types/settings_compliance_response_object_response_body.rb', line 30

def persistent_duty_status_enabled
  @persistent_duty_status_enabled
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/samsara_api/types/settings_compliance_response_object_response_body.rb', line 73

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  allow_unregulated_vehicles_enabled = parsed_json["allowUnregulatedVehiclesEnabled"]
  canada_hos_enabled = parsed_json["canadaHosEnabled"]
  carrier_name = parsed_json["carrierName"]
  dot_number = parsed_json["dotNumber"]
  driver_auto_duty_enabled = parsed_json["driverAutoDutyEnabled"]
  edit_certified_logs_enabled = parsed_json["editCertifiedLogsEnabled"]
  force_manual_location_for_duty_status_changes_enabled = parsed_json["forceManualLocationForDutyStatusChangesEnabled"]
  force_review_unassigned_hos_enabled = parsed_json["forceReviewUnassignedHosEnabled"]
  main_office_formatted_address = parsed_json["mainOfficeFormattedAddress"]
  persistent_duty_status_enabled = parsed_json["persistentDutyStatusEnabled"]
  new(
    allow_unregulated_vehicles_enabled: allow_unregulated_vehicles_enabled,
    canada_hos_enabled: canada_hos_enabled,
    carrier_name: carrier_name,
    dot_number: dot_number,
    driver_auto_duty_enabled: driver_auto_duty_enabled,
    edit_certified_logs_enabled: edit_certified_logs_enabled,
    force_manual_location_for_duty_status_changes_enabled: force_manual_location_for_duty_status_changes_enabled,
    force_review_unassigned_hos_enabled: force_review_unassigned_hos_enabled,
    main_office_formatted_address: main_office_formatted_address,
    persistent_duty_status_enabled: persistent_duty_status_enabled,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void)


113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/samsara_api/types/settings_compliance_response_object_response_body.rb', line 113

def self.validate_raw(obj:)
  obj.allow_unregulated_vehicles_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.allow_unregulated_vehicles_enabled is not the expected type, validation failed.")
  obj.canada_hos_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.canada_hos_enabled is not the expected type, validation failed.")
  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.driver_auto_duty_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.driver_auto_duty_enabled is not the expected type, validation failed.")
  obj.edit_certified_logs_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.edit_certified_logs_enabled is not the expected type, validation failed.")
  obj.force_manual_location_for_duty_status_changes_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.force_manual_location_for_duty_status_changes_enabled is not the expected type, validation failed.")
  obj.force_review_unassigned_hos_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.force_review_unassigned_hos_enabled is not the expected type, validation failed.")
  obj.main_office_formatted_address&.is_a?(String) != false || raise("Passed value for field obj.main_office_formatted_address is not the expected type, validation failed.")
  obj.persistent_duty_status_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.persistent_duty_status_enabled is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String)


104
105
106
# File 'lib/samsara_api/types/settings_compliance_response_object_response_body.rb', line 104

def to_json
  @_field_set&.to_json
end