Class: Comet::AdminEmailOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/admin_email_options.rb

Overview

AdminEmailOptions is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdminEmailOptions

Returns a new instance of AdminEmailOptions.



24
25
26
 
# File 'lib/comet/models/admin_email_options.rb', line 24

def initialize
  clear
end

Instance Attribute Details

#from_email ⇒ Object

Returns the value of attribute from_email.



16
17
18
 
# File 'lib/comet/models/admin_email_options.rb', line 16

def from_email
  @from_email
end

#from_name ⇒ Object

Returns the value of attribute from_name.



19
20
21
 
# File 'lib/comet/models/admin_email_options.rb', line 19

def from_name
  @from_name
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



22
23
24
 
# File 'lib/comet/models/admin_email_options.rb', line 22

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



28
29
30
31
32
 
# File 'lib/comet/models/admin_email_options.rb', line 28

def clear
  @from_email = ''
  @from_name = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/comet/models/admin_email_options.rb', line 42

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'FromEmail'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @from_email = v
    when 'FromName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @from_name = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


35
36
37
38
39
 
# File 'lib/comet/models/admin_email_options.rb', line 35

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



73
74
75
 
# File 'lib/comet/models/admin_email_options.rb', line 73

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



62
63
64
65
66
67
68
69
70
 
# File 'lib/comet/models/admin_email_options.rb', line 62

def to_hash
  ret = {}
  ret['FromEmail'] = @from_email
  ret['FromName'] = @from_name
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



78
79
80
 
# File 'lib/comet/models/admin_email_options.rb', line 78

def to_json(options = {})
  to_hash.to_json(options)
end