Class: Samsara::Types::PolygonRequestBody

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

Overview

is a polygon.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, vertices: OMIT, additional_properties: nil) ⇒ Samsara::Types::PolygonRequestBody

Parameters:

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

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
 
# File 'lib/samsara_api/types/polygon_request_body.rb', line 31

def initialize(name:, vertices: OMIT, additional_properties: nil)
  @name = name
  @vertices = vertices if vertices != OMIT
  @additional_properties = additional_properties
  @_field_set = { "name": name, "vertices": vertices }.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



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

def additional_properties
  @additional_properties
end

#name ⇒ String (readonly)

Returns The name of the polygon.

Returns:

  • (String) —

    The name of the polygon.



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

def name
  @name
end

#vertices ⇒ Object (readonly) 



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

def vertices
  @vertices
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/samsara_api/types/polygon_request_body.rb', line 43

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  name = parsed_json["name"]
  vertices = parsed_json["vertices"]&.map do | item |
  item = item.to_json
  Samsara::Types::VertexRequestBody.from_json(json_object: item)
end
  new(
    name: name,
    vertices: vertices,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


69
70
71
72
 
# File 'lib/samsara_api/types/polygon_request_body.rb', line 69

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


60
61
62
 
# File 'lib/samsara_api/types/polygon_request_body.rb', line 60

def to_json
  @_field_set&.to_json
end