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.



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

def initialize
  clear
end

Instance Attribute Details

#email_body_html ⇒ Object

Returns the value of attribute email_body_html.



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

def email_body_html
  @email_body_html
end

#email_body_plaintext ⇒ Object

Returns the value of attribute email_body_plaintext.



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

def email_body_plaintext
  @email_body_plaintext
end

#email_subject ⇒ Object

Returns the value of attribute email_subject.



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

def email_subject
  @email_subject
end

#from ⇒ Object

Returns the value of attribute from.



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

def from
  @from
end

#message ⇒ Object

Returns the value of attribute message.



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

def message
  @message
end

#status ⇒ Object

If the operation was successful, the status will be in the 200-299 range.



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

def status
  @status
end

#to ⇒ Object

Returns the value of attribute to.



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

def to
  @to
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

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

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


63
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
 
# File 'lib/comet/models/email_report_generated_preview.rb', line 63

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

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


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

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



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

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



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

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:

  • (String) —

    The complete object as a JSON string



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

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