Class: Samsara::Types::OperationalSettingsObjectRequestBody

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

Overview

Settings on when the alert should be operational.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(time_range_type:, time_ranges:, additional_properties: nil) ⇒ Samsara::Types::OperationalSettingsObjectRequestBody

Parameters:



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

def initialize(time_range_type:, time_ranges:, additional_properties: nil)
  @time_range_type = time_range_type
  @time_ranges = time_ranges
  @additional_properties = additional_properties
  @_field_set = { "timeRangeType": time_range_type, "timeRanges": time_ranges }
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/operational_settings_object_request_body.rb', line 16

def additional_properties
  @additional_properties
end

#time_range_type ⇒ Samsara::Types::OperationalSettingsObjectRequestBodyTimeRangeType (readonly)

Returns The type of time ranges. Valid values: ‘activeBetween`, `inactiveBetween`.

Returns:



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

def time_range_type
  @time_range_type
end

#time_ranges ⇒ Array<Samsara::Types::TimeRangeObjectRequestBody> (readonly)

Returns The time ranges this alert applies to.

Returns:



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

def time_ranges
  @time_ranges
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  time_range_type = parsed_json["timeRangeType"]
  time_ranges = parsed_json["timeRanges"]&.map do | item |
  item = item.to_json
  Samsara::Types::TimeRangeObjectRequestBody.from_json(json_object: item)
end
  new(
    time_range_type: time_range_type,
    time_ranges: time_ranges,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


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

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


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

def to_json
  @_field_set&.to_json
end