Class: Comet::EmailReportConfig

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EmailReportConfig

Returns a new instance of EmailReportConfig.



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

def initialize
  clear
end

Instance Attribute Details

#filter ⇒ Object

Returns the value of attribute filter.



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

def filter
  @filter
end

#report_type ⇒ Object

One of the EMAILREPORTTYPE_ constants



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

def report_type
  @report_type
end

#summary_frequency ⇒ Object

Used as a list of scheduled times to send



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

def summary_frequency
  @summary_frequency
end

#time_span ⇒ Object

Used to the determine the time bounds of a report



25
26
27
 
# File 'lib/comet/models/email_report_config.rb', line 25

def time_span
  @time_span
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



31
32
33
 
# File 'lib/comet/models/email_report_config.rb', line 31

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @report_type = 0
  @summary_frequency = []
  @time_span = Comet::TimeSpan.new
  @filter = Comet::SearchClause.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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

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

      @report_type = v
    when 'SummaryFrequency'
      if v.nil?
        @summary_frequency = []
      else
        @summary_frequency = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @summary_frequency[i1] = Comet::ScheduleConfig.new
          @summary_frequency[i1].from_hash(v1)
        end
      end
    when 'TimeSpan'
      @time_span = Comet::TimeSpan.new
      @time_span.from_hash(v)
    when 'Filter'
      @filter = Comet::SearchClause.new
      @filter.from_hash(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) 


46
47
48
49
50
 
# File 'lib/comet/models/email_report_config.rb', line 46

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



100
101
102
 
# File 'lib/comet/models/email_report_config.rb', line 100

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



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

def to_hash
  ret = {}
  ret['ReportType'] = @report_type
  ret['SummaryFrequency'] = @summary_frequency
  unless @time_span.nil?
    ret['TimeSpan'] = @time_span
  end
  ret['Filter'] = @filter
  @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



105
106
107
 
# File 'lib/comet/models/email_report_config.rb', line 105

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