Class: Comet::EmailReportGeneratedPreview

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EmailReportGeneratedPreview 



35
36
37
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 35

def initialize
  clear
end

Instance Attribute Details

#email_body_html ⇒ Object

Returns the value of attribute email_body_html.



27
28
29
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 27

def email_body_html
  @email_body_html
end

#email_body_plaintext ⇒ Object

Returns the value of attribute email_body_plaintext.



30
31
32
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 30

def email_body_plaintext
  @email_body_plaintext
end

#email_subject ⇒ Object

Returns the value of attribute email_subject.



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

def email_subject
  @email_subject
end

#message ⇒ Object

Returns the value of attribute message.



21
22
23
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 21

def message
  @message
end

#status ⇒ Object

Returns the value of attribute status.



18
19
20
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 18

def status
  @status
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



33
34
35
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 33

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



39
40
41
42
43
44
45
46
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 39

def clear
  @status = 0
  @message = ''
  @email_subject = ''
  @email_body_html = ''
  @email_body_plaintext = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 56

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 'Status'
      raise TypeError "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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

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

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

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

#from_json(json_string) ⇒ Object 



49
50
51
52
53
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 49

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 



102
103
104
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 102

def to_h
  to_hash
end

#to_hash ⇒ Hash 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 88

def to_hash
  ret = {}
  ret['Status'] = @status
  ret['Message'] = @message
  ret['EmailSubject'] = @email_subject
  ret['EmailBodyHTML'] = @email_body_html
  ret['EmailBodyPlaintext'] = @email_body_plaintext
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String 



107
108
109
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 107

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