Class: Samsara::Types::CircleRequestBody

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

Overview

is a circle.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(latitude: OMIT, longitude: OMIT, name:, radius_meters:, additional_properties: nil) ⇒ Samsara::Types::CircleRequestBody

Parameters:

  • name (String) —

    The name of the cirlce.

  • radius_meters (Long) —

    The radius of the circular geofence in meters.

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

    Additional properties unmapped to the current class definition



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/samsara_api/types/circle_request_body.rb', line 34

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



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

def additional_properties
  @additional_properties
end

#latitude ⇒ Float (readonly)

Returns Latitude of the address. Will be geocoded from formattedAddress if not provided.

Returns:

  • (Float) —

    Latitude of the address. Will be geocoded from formattedAddress if not provided.



11
12
13
 
# File 'lib/samsara_api/types/circle_request_body.rb', line 11

def latitude
  @latitude
end

#longitude ⇒ Object (readonly)

provided.



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

def longitude
  @longitude
end

#name ⇒ String (readonly)

Returns The name of the cirlce.

Returns:

  • (String) —

    The name of the cirlce.



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

def name
  @name
end

#radius_meters ⇒ Long (readonly)

Returns The radius of the circular geofence in meters.

Returns:

  • (Long) —

    The radius of the circular geofence in meters.



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

def radius_meters
  @radius_meters
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/samsara_api/types/circle_request_body.rb', line 48

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  latitude = parsed_json["latitude"]
  longitude = parsed_json["longitude"]
  name = parsed_json["name"]
  radius_meters = parsed_json["radiusMeters"]
  new(
    latitude: latitude,
    longitude: longitude,
    name: name,
    radius_meters: radius_meters,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


75
76
77
78
79
80
 
# File 'lib/samsara_api/types/circle_request_body.rb', line 75

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


66
67
68
 
# File 'lib/samsara_api/types/circle_request_body.rb', line 66

def to_json
  @_field_set&.to_json
end