Class: Comet::EmailReportingOption

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EmailReportingOption

Returns a new instance of EmailReportingOption.



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

def initialize
  clear
end

Instance Attribute Details

#email_report_config ⇒ Object

Returns the value of attribute email_report_config.



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

def email_report_config
  @email_report_config
end

#language_code ⇒ Object

A supported language code (e.g. “en_US” or the DEFAULT_LANGUAGE constant)



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

def language_code
  @language_code
end

#local_timezone ⇒ Object

The timezone in IANA format (e.g. “Pacific/Auckland” or the DEFAULT_TIMEZONE constant)



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

def local_timezone
  @local_timezone
end

#recipients ⇒ Object

Returns the value of attribute recipients.



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

def recipients
  @recipients
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/comet/models/email_reporting_option.rb', line 36

def clear
  @email_report_config = Comet::EmailReportConfig.new
  @language_code = ''
  @local_timezone = ''
  @recipients = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


52
53
54
55
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
 
# File 'lib/comet/models/email_reporting_option.rb', line 52

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 'EmailReportConfig'
      @email_report_config = Comet::EmailReportConfig.new
      @email_report_config.from_hash(v)
    when 'LanguageCode'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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


45
46
47
48
49
 
# File 'lib/comet/models/email_reporting_option.rb', line 45

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



99
100
101
 
# File 'lib/comet/models/email_reporting_option.rb', line 99

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



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/comet/models/email_reporting_option.rb', line 86

def to_hash
  ret = {}
  ret['EmailReportConfig'] = @email_report_config
  ret['LanguageCode'] = @language_code
  ret['LocalTimezone'] = @local_timezone
  ret['Recipients'] = @recipients
  @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



104
105
106
 
# File 'lib/comet/models/email_reporting_option.rb', line 104

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