Class: PureCloud::InteractionStatsAlert

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/interaction_stats_alert.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InteractionStatsAlert

Returns a new instance of InteractionStatsAlert.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 136

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'dimension']
    self.dimension = attributes[:'dimension']
  end
  
  if attributes[:'dimensionValue']
    self.dimension_value = attributes[:'dimensionValue']
  end
  
  if attributes[:'metric']
    self.metric = attributes[:'metric']
  end
  
  if attributes[:'mediaType']
    self.media_type = attributes[:'mediaType']
  end
  
  if attributes[:'numericRange']
    self.numeric_range = attributes[:'numericRange']
  end
  
  if attributes[:'statistic']
    self.statistic = attributes[:'statistic']
  end
  
  if attributes[:'value']
    self.value = attributes[:'value']
  end
  
  if attributes[:'ruleId']
    self.rule_id = attributes[:'ruleId']
  end
  
  if attributes[:'unread']
    self.unread = attributes[:'unread']
  end
  
  if attributes[:'startDate']
    self.start_date = attributes[:'startDate']
  end
  
  if attributes[:'endDate']
    self.end_date = attributes[:'endDate']
  end
  
  if attributes[:'notificationUsers']
    if (value = attributes[:'notificationUsers']).is_a?(Array)
      self.notification_users = value
    end
  end
  
  if attributes[:'alertTypes']
    if (value = attributes[:'alertTypes']).is_a?(Array)
      self.alert_types = value
    end
  end
  
  if attributes[:'ruleUri']
    self.rule_uri = attributes[:'ruleUri']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#alert_types ⇒ Object

A collection of notification methods.



64
65
66
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 64

def alert_types
  @alert_types
end

#dimension ⇒ Object

The dimension of concern.



28
29
30
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 28

def dimension
  @dimension
end

#dimension_value ⇒ Object

The value of the dimension.



31
32
33
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 31

def dimension_value
  @dimension_value
end

#end_date ⇒ Object

The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



58
59
60
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 58

def end_date
  @end_date
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 22

def id
  @id
end

#media_type ⇒ Object

The media type.



37
38
39
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 37

def media_type
  @media_type
end

#metric ⇒ Object

The metric to be assessed.



34
35
36
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 34

def metric
  @metric
end

#name ⇒ Object

Name of the rule that generated the alert



25
26
27
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 25

def name
  @name
end

#notification_users ⇒ Object

The ids of users who were notified of alarm state change.



61
62
63
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 61

def notification_users
  @notification_users
end

#numeric_range ⇒ Object

The comparison descriptor used against the metric’s value.



40
41
42
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 40

def numeric_range
  @numeric_range
end

#rule_id ⇒ Object

The id of the rule.



49
50
51
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 49

def rule_id
  @rule_id
end

#rule_uri ⇒ Object

Returns the value of attribute rule_uri.



66
67
68
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 66

def rule_uri
  @rule_uri
end

#self_uri ⇒ Object

The URI for this object



69
70
71
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 69

def self_uri
  @self_uri
end

#start_date ⇒ Object

The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



55
56
57
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 55

def start_date
  @start_date
end

#statistic ⇒ Object

The statistic of concern for the metric.



43
44
45
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 43

def statistic
  @statistic
end

#unread ⇒ Object

Indicates if the alert has been read.



52
53
54
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 52

def unread
  @unread
end

#value ⇒ Object

The threshold value.



46
47
48
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 46

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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
109
110
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 72

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'dimension' => :'dimension',
    
    :'dimension_value' => :'dimensionValue',
    
    :'metric' => :'metric',
    
    :'media_type' => :'mediaType',
    
    :'numeric_range' => :'numericRange',
    
    :'statistic' => :'statistic',
    
    :'value' => :'value',
    
    :'rule_id' => :'ruleId',
    
    :'unread' => :'unread',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'notification_users' => :'notificationUsers',
    
    :'alert_types' => :'alertTypes',
    
    :'rule_uri' => :'ruleUri',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 113

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'dimension' => :'String',
    :'dimension_value' => :'String',
    :'metric' => :'String',
    :'media_type' => :'String',
    :'numeric_range' => :'String',
    :'statistic' => :'String',
    :'value' => :'Float',
    :'rule_id' => :'String',
    :'unread' => :'BOOLEAN',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'notification_users' => :'Array<User>',
    :'alert_types' => :'Array<String>',
    :'rule_uri' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      dimension == o.dimension &&
      dimension_value == o.dimension_value &&
      metric == o.metric &&
      media_type == o.media_type &&
      numeric_range == o.numeric_range &&
      statistic == o.statistic &&
      value == o.value &&
      rule_id == o.rule_id &&
      unread == o.unread &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types &&
      rule_uri == o.rule_uri &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 315

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 375

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 296

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



291
292
293
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 291

def hash
  [id, name, dimension, dimension_value, metric, media_type, numeric_range, statistic, value, rule_id, unread, start_date, end_date, notification_users, alert_types, rule_uri, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



358
359
360
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 358

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



363
364
365
366
367
368
369
370
371
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 363

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



353
354
355
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 353

def to_s
  to_hash.to_s
end