Class: Pinnacle::ViewLocation

Inherits:
Object
  • Object
show all
Defined in:
lib/rcs/types/view_location.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_type:, lat_lng:, label:, title: OMIT, additional_properties: nil) ⇒ Pinnacle::ViewLocation

Parameters:

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

    The title for the view location action. Maximum length is 25 characters.

  • action_type (String) —

    The type of action being sent

  • lat_lng (Pinnacle::LatLng)
  • label (String) —

    The name of the location

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

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rcs/types/view_location.rb', line 31

def initialize(action_type:, lat_lng:, label:, title: OMIT, additional_properties: nil)
  @title = title if title != OMIT
  @action_type = action_type
  @lat_lng = lat_lng
  @label = label
  @additional_properties = additional_properties
  @_field_set = {
    "title": title,
    "action_type": action_type,
    "lat_lng": lat_lng,
    "label": label
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#action_type ⇒ String (readonly)

Returns The type of action being sent.

Returns:

  • (String) —

    The type of action being sent



12
13
14
 
# File 'lib/rcs/types/view_location.rb', line 12

def action_type
  @action_type
end

#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/rcs/types/view_location.rb', line 18

def additional_properties
  @additional_properties
end

#label ⇒ String (readonly)

Returns The name of the location.

Returns:

  • (String) —

    The name of the location



16
17
18
 
# File 'lib/rcs/types/view_location.rb', line 16

def label
  @label
end

#lat_lng ⇒ Pinnacle::LatLng (readonly)

Returns:



14
15
16
 
# File 'lib/rcs/types/view_location.rb', line 14

def lat_lng
  @lat_lng
end

#title ⇒ String (readonly)

Returns The title for the view location action. Maximum length is 25 characters.

Returns:

  • (String) —

    The title for the view location action. Maximum length is 25 characters.



10
11
12
 
# File 'lib/rcs/types/view_location.rb', line 10

def title
  @title
end

Class Method Details

.from_json(json_object:) ⇒ Pinnacle::ViewLocation

Deserialize a JSON object to an instance of ViewLocation

Parameters:

  • json_object (String)

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/rcs/types/view_location.rb', line 51

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  title = parsed_json["title"]
  action_type = parsed_json["action_type"]
  if parsed_json["lat_lng"].nil?
    lat_lng = nil
  else
    lat_lng = parsed_json["lat_lng"].to_json
    lat_lng = Pinnacle::LatLng.from_json(json_object: lat_lng)
  end
  label = parsed_json["label"]
  new(
    title: title,
    action_type: action_type,
    lat_lng: lat_lng,
    label: label,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


85
86
87
88
89
90
 
# File 'lib/rcs/types/view_location.rb', line 85

def self.validate_raw(obj:)
  obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
  obj.action_type.is_a?(String) != false || raise("Passed value for field obj.action_type is not the expected type, validation failed.")
  Pinnacle::LatLng.validate_raw(obj: obj.lat_lng)
  obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ViewLocation to a JSON object

Returns:

  • (String) 


75
76
77
 
# File 'lib/rcs/types/view_location.rb', line 75

def to_json(*_args)
  @_field_set&.to_json
end