Class: Merge::Crm::EmailAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/types/email_address.rb

Overview

The EmailAddress Object

Description

The EmailAddress object is used to represent an entity's email address.

Usage Example

Fetch from the GET Contact endpoint and view their email addresses.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(created_at: OMIT, modified_at: OMIT, email_address: OMIT, email_address_type: OMIT, additional_properties: nil) ⇒ Merge::Crm::EmailAddress 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 37

def initialize(created_at: OMIT, modified_at: OMIT, email_address: OMIT, email_address_type: OMIT,
               additional_properties: nil)
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @email_address = email_address if email_address != OMIT
  @email_address_type = email_address_type if email_address_type != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "created_at": created_at,
    "modified_at": modified_at,
    "email_address": email_address,
    "email_address_type": email_address_type
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly) 



24
25
26
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 24

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly) 



16
17
18
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 16

def created_at
  @created_at
end

#email_address ⇒ String (readonly) 



20
21
22
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 20

def email_address
  @email_address
end

#email_address_type ⇒ String (readonly) 



22
23
24
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 22

def email_address_type
  @email_address_type
end

#modified_at ⇒ DateTime (readonly) 



18
19
20
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 18

def modified_at
  @modified_at
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Crm::EmailAddress

Deserialize a JSON object to an instance of EmailAddress



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 58

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  email_address = parsed_json["email_address"]
  email_address_type = parsed_json["email_address_type"]
  new(
    created_at: created_at,
    modified_at: modified_at,
    email_address: email_address,
    email_address_type: email_address_type,
    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.



87
88
89
90
91
92
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 87

def self.validate_raw(obj:)
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.email_address&.is_a?(String) != false || raise("Passed value for field obj.email_address is not the expected type, validation failed.")
  obj.email_address_type&.is_a?(String) != false || raise("Passed value for field obj.email_address_type is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of EmailAddress to a JSON object



77
78
79
 
# File 'lib/merge_ruby_client/crm/types/email_address.rb', line 77

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