Class: PureCloud::InteractionStatsAlert

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InteractionStatsAlert

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



119
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
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 119

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

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

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'dimension')
    self.dimension = attributes[:'dimension']
  end

  if attributes.has_key?(:'dimensionValue')
    self.dimension_value = attributes[:'dimensionValue']
  end

  if attributes.has_key?(:'metric')
    self.metric = attributes[:'metric']
  end

  if attributes.has_key?(:'mediaType')
    self.media_type = attributes[:'mediaType']
  end

  if attributes.has_key?(:'numericRange')
    self.numeric_range = attributes[:'numericRange']
  end

  if attributes.has_key?(:'statistic')
    self.statistic = attributes[:'statistic']
  end

  if attributes.has_key?(:'value')
    self.value = attributes[:'value']
  end

  if attributes.has_key?(:'ruleId')
    self.rule_id = attributes[:'ruleId']
  end

  if attributes.has_key?(:'unread')
    self.unread = attributes[:'unread']
  end

  if attributes.has_key?(:'startDate')
    self.start_date = attributes[:'startDate']
  end

  if attributes.has_key?(:'endDate')
    self.end_date = attributes[:'endDate']
  end

  if attributes.has_key?(:'notificationUsers')
    if (value = attributes[:'notificationUsers']).is_a?(Array)
      self.notification_users = value
    end
  end

  if attributes.has_key?(:'alertTypes')
    if (value = attributes[:'alertTypes']).is_a?(Array)
      self.alert_types = value
    end
  end

  if attributes.has_key?(:'ruleUri')
    self.rule_uri = attributes[:'ruleUri']
  end

  if attributes.has_key?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

end

Instance Attribute Details

#alert_types ⇒ Object

A collection of notification methods.



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

def alert_types
  @alert_types
end

#dimension ⇒ Object

The dimension of concern.



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

def dimension
  @dimension
end

#dimension_value ⇒ Object

The value of the dimension.



31
32
33
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 22

def id
  @id
end

#media_type ⇒ Object

The media type.



37
38
39
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 52

def unread
  @unread
end

#value ⇒ Object

The threshold value.



46
47
48
 
# File 'lib/purecloudplatformclientv2/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
 
# File 'lib/purecloudplatformclientv2/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.



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

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

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 335

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 



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 389

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



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 449

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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 370

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


359
360
361
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



365
366
367
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 365

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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



201
202
203
204
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 201

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



432
433
434
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 432

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



437
438
439
440
441
442
443
444
445
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 437

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 



427
428
429
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 427

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/purecloudplatformclientv2/models/interaction_stats_alert.rb', line 208

def valid?
  if @name.nil?
    return false
  end

  if @dimension.nil?
    return false
  end

  allowed_values = ["queueId", "userId"]
  if @dimension && !allowed_values.include?(@dimension)
    return false
  end
  if @dimension_value.nil?
    return false
  end

  if @metric.nil?
    return false
  end

  allowed_values = ["tAbandon", "tAnswered", "tTalk", "nOffered", "tHandle", "nTransferred", "oServiceLevel", "tWait", "tHeld", "tAcw"]
  if @metric && !allowed_values.include?(@metric)
    return false
  end
  if @media_type.nil?
    return false
  end

  allowed_values = ["voice", "chat", "email"]
  if @media_type && !allowed_values.include?(@media_type)
    return false
  end
  if @numeric_range.nil?
    return false
  end

  allowed_values = ["gt", "gte", "lt", "lte", "eq", "ne"]
  if @numeric_range && !allowed_values.include?(@numeric_range)
    return false
  end
  if @statistic.nil?
    return false
  end

  allowed_values = ["count", "min", "ratio", "max"]
  if @statistic && !allowed_values.include?(@statistic)
    return false
  end
  if @value.nil?
    return false
  end

  if @rule_id.nil?
    return false
  end

  if @unread.nil?
    return false
  end

  if @start_date.nil?
    return false
  end

  if @notification_users.nil?
    return false
  end

  if @alert_types.nil?
    return false
  end

end