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

Returns a new instance of EmailReportGeneratedPreview.



41
42
43
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 41

def initialize
  clear
end

Instance Attribute Details

#email_body_html ⇒ Object

Returns the value of attribute email_body_html.



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

def email_body_html
  @email_body_html
end

#email_body_plaintext ⇒ Object

Returns the value of attribute email_body_plaintext.



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

def email_body_plaintext
  @email_body_plaintext
end

#email_subject ⇒ Object

Returns the value of attribute email_subject.



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

def email_subject
  @email_subject
end

#from ⇒ Object

Returns the value of attribute from.



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

def from
  @from
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

#to ⇒ Object

Returns the value of attribute to.



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

def to
  @to
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



39
40
41
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 39

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 45

def clear
  @status = 0
  @message = ''
  @from = ''
  @to = []
  @email_subject = ''
  @email_body_html = ''
  @email_body_plaintext = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Raises:

Parameters:

  • The complete object as a Ruby hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 64

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

      @from = v
    when 'To'
      if v.nil?
        @to = []
      else
        @to = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @to[i1] = v1
        end
      end
    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

Raises:

Parameters:

  • The complete object in JSON format



57
58
59
60
61
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 57

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:

  • The complete object as a Ruby hash



127
128
129
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 127

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • The complete object as a Ruby hash



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 111

def to_hash
  ret = {}
  ret['Status'] = @status
  ret['Message'] = @message
  ret['From'] = @from
  ret['To'] = @to
  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

Returns The complete object as a JSON string.

Returns:

  • The complete object as a JSON string



132
133
134
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 132

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