Class: Comet::DefaultEmailReportPolicy

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DefaultEmailReportPolicy

Returns a new instance of DefaultEmailReportPolicy.



28
29
30
 
# File 'lib/comet/models/default_email_report_policy.rb', line 28

def initialize
  clear
end

Instance Attribute Details

#reports ⇒ Object

Returns the value of attribute reports.



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

def reports
  @reports
end

#should_override_default_reports ⇒ Object

If true, the email reports will use the custom configuration that is defined in UserCustomEmailSettings / Reports fields. If false, the email reports will use configuration from the policy setting if present, or else from the built-in system default email report configuration.



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

def should_override_default_reports
  @should_override_default_reports
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @reports = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/comet/models/default_email_report_policy.rb', line 45

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 'ShouldOverrideDefaultReports'
      @should_override_default_reports = v
    when 'Reports'
      if v.nil?
        @reports = []
      else
        @reports = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @reports[i1] = Comet::EmailReportConfig.new
          @reports[i1].from_hash(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) 


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

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



80
81
82
 
# File 'lib/comet/models/default_email_report_policy.rb', line 80

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



69
70
71
72
73
74
75
76
77
 
# File 'lib/comet/models/default_email_report_policy.rb', line 69

def to_hash
  ret = {}
  ret['ShouldOverrideDefaultReports'] = @should_override_default_reports
  ret['Reports'] = @reports
  @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



85
86
87
 
# File 'lib/comet/models/default_email_report_policy.rb', line 85

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