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.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 120

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']
  else
    self.unread = false
  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. = [‘SMS’, ‘DEVICE’, ‘EMAIL’]



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

def alert_types
  @alert_types
end

#dimension ⇒ Object

The dimension of concern.



12
13
14
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 12

def dimension
  @dimension
end

#dimension_value ⇒ Object

The value of the dimension.



15
16
17
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 15

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



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

def end_date
  @end_date
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 6

def id
  @id
end

#media_type ⇒ Object

The media type.



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

def media_type
  @media_type
end

#metric ⇒ Object

The metric to be assessed.



18
19
20
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 18

def metric
  @metric
end

#name ⇒ Object

Name of the rule that generated the alert



9
10
11
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 9

def name
  @name
end

#notification_users ⇒ Object

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



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

def notification_users
  @notification_users
end

#numeric_range ⇒ Object

The comparison descriptor used against the metric’s value.



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

def numeric_range
  @numeric_range
end

#rule_id ⇒ Object

The id of the rule.



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

def rule_id
  @rule_id
end

#rule_uri ⇒ Object

Returns the value of attribute rule_uri.



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

def rule_uri
  @rule_uri
end

#self_uri ⇒ Object

The URI for this object



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

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



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

def start_date
  @start_date
end

#statistic ⇒ Object

The statistic of concern for the metric.



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

def statistic
  @statistic
end

#unread ⇒ Object

Indicates if the alert has been read.



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

def unread
  @unread
end

#value ⇒ Object

The threshold value.



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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



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
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 56

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.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 97

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.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 249

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 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 301

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 358

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 282

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


272
273
274
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



277
278
279
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 277

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))



341
342
343
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 341

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



346
347
348
349
350
351
352
353
354
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 346

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 



336
337
338
 
# File 'lib/purecloud/models/interaction_stats_alert.rb', line 336

def to_s
  to_hash.to_s
end