Class: SocketLabs::InjectionApi::Core::Serialization::AddressJson

Inherits:
Object
  • Object
show all
Defined in:
lib/socketlabs/injectionapi/core/serialization/address_json.rb

Overview

Represents an individual email address for a message. To be serialized into JSON string before sending to the Injection Api.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email_address = nil, friendly_name = nil) ⇒ AddressJson

Initializes a new instance of the AddressJson class

Parameters:

  • email_address (String) (defaults to: nil)
  • friendly_name (String) (defaults to: nil) 


20
21
22
23
24
25
26
 
# File 'lib/socketlabs/injectionapi/core/serialization/address_json.rb', line 20

def initialize(
  email_address = nil, 
  friendly_name = nil
)
  @email_address = email_address
  @friendly_name = friendly_name
end

Instance Attribute Details

#email_address ⇒ Object

the email address



13
14
15
 
# File 'lib/socketlabs/injectionapi/core/serialization/address_json.rb', line 13

def email_address
  @email_address
end

#friendly_name ⇒ Object

the friendly or display name



15
16
17
 
# File 'lib/socketlabs/injectionapi/core/serialization/address_json.rb', line 15

def friendly_name
  @friendly_name
end

Instance Method Details

#to_hash ⇒ hash

build json hash for AddressJson

Returns:

  • (hash) 


30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/socketlabs/injectionapi/core/serialization/address_json.rb', line 30

def to_hash
  if @friendly_name.nil? || @friendly_name.empty?
    {
      :emailAddress  => @email_address
    }
  else
    {
      :emailAddress => @email_address,
      :friendlyName => @friendly_name
    }
  end
end