Class: Samsara::Types::Contact

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

Overview

Information about a notification contact for alerts.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email:, first_name:, id:, last_name:, phone:, additional_properties: nil) ⇒ Samsara::Types::Contact

Parameters:

  • email (String)
  • first_name (String)
  • id (String)
  • last_name (String)
  • phone (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(email:, first_name:, id:, last_name:, phone:, additional_properties: nil)
  @email = email
  @first_name = first_name
  @id = id
  @last_name = last_name
  @phone = phone
  @additional_properties = additional_properties
  @_field_set = { "email": email, "firstName": first_name, "id": id, "lastName": last_name, "phone": phone }
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/contact.rb', line 20

def additional_properties
  @additional_properties
end

#email ⇒ String (readonly)

Returns:

  • (String) 


10
11
12
 
# File 'lib/samsara_api/types/contact.rb', line 10

def email
  @email
end

#first_name ⇒ String (readonly)

Returns:

  • (String) 


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

def first_name
  @first_name
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#last_name ⇒ String (readonly)

Returns:

  • (String) 


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

def last_name
  @last_name
end

#phone ⇒ String (readonly)

Returns:

  • (String) 


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

def phone
  @phone
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  email = parsed_json["email"]
  first_name = parsed_json["firstName"]
  id = parsed_json["id"]
  last_name = parsed_json["lastName"]
  phone = parsed_json["phone"]
  new(
    email: email,
    first_name: first_name,
    id: id,
    last_name: last_name,
    phone: phone,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


76
77
78
79
80
81
82
 
# File 'lib/samsara_api/types/contact.rb', line 76

def self.validate_raw(obj:)
  obj.email.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
  obj.first_name.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.last_name.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
  obj.phone.is_a?(String) != false || raise("Passed value for field obj.phone is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


67
68
69
 
# File 'lib/samsara_api/types/contact.rb', line 67

def to_json
  @_field_set&.to_json
end