Class: PureCloud::InteractionStatRuleNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InteractionStatRuleNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 91

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?(:'dimensionValueName')
    self.dimension_value_name = attributes[:'dimensionValueName']
  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?(:'inAlarm')
    self.in_alarm = attributes[:'inAlarm']
  end

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  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

end

Instance Attribute Details

#alert_types ⇒ Object

Returns the value of attribute alert_types.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 47

def alert_types
  @alert_types
end

#dimension ⇒ Object

Returns the value of attribute dimension.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 25

def dimension
  @dimension
end

#dimension_value ⇒ Object

Returns the value of attribute dimension_value.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 27

def dimension_value
  @dimension_value
end

#dimension_value_name ⇒ Object

Returns the value of attribute dimension_value_name.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 29

def dimension_value_name
  @dimension_value_name
end

#enabled ⇒ Object

Returns the value of attribute enabled.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 43

def enabled
  @enabled
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 21

def id
  @id
end

#in_alarm ⇒ Object

Returns the value of attribute in_alarm.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 41

def in_alarm
  @in_alarm
end

#media_type ⇒ Object

Returns the value of attribute media_type.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 33

def media_type
  @media_type
end

#metric ⇒ Object

Returns the value of attribute metric.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 31

def metric
  @metric
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 23

def name
  @name
end

#notification_users ⇒ Object

Returns the value of attribute notification_users.



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 45

def notification_users
  @notification_users
end

#numeric_range ⇒ Object

Returns the value of attribute numeric_range.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 35

def numeric_range
  @numeric_range
end

#statistic ⇒ Object

Returns the value of attribute statistic.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 37

def statistic
  @statistic
end

#value ⇒ Object

Returns the value of attribute value.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 39

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 50

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'dimension' => :'dimension',
    :'dimension_value' => :'dimensionValue',
    :'dimension_value_name' => :'dimensionValueName',
    :'metric' => :'metric',
    :'media_type' => :'mediaType',
    :'numeric_range' => :'numericRange',
    :'statistic' => :'statistic',
    :'value' => :'value',
    :'in_alarm' => :'inAlarm',
    :'enabled' => :'enabled',
    :'notification_users' => :'notificationUsers',
    :'alert_types' => :'alertTypes'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 70

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'dimension' => :'String',
    :'dimension_value' => :'String',
    :'dimension_value_name' => :'String',
    :'metric' => :'String',
    :'media_type' => :'String',
    :'numeric_range' => :'String',
    :'statistic' => :'String',
    :'value' => :'Float',
    :'in_alarm' => :'BOOLEAN',
    :'enabled' => :'BOOLEAN',
    :'notification_users' => :'Array<HeartBeatAlertNotificationNotificationUsers>',
    :'alert_types' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 243

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 &&
      dimension_value_name == o.dimension_value_name &&
      metric == o.metric &&
      media_type == o.media_type &&
      numeric_range == o.numeric_range &&
      statistic == o.statistic &&
      value == o.value &&
      in_alarm == o.in_alarm &&
      enabled == o.enabled &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types
end

#_deserialize(type, value) ⇒ Object 



294
295
296
297
298
299
300
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
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 294

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 354

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 275

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


264
265
266
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 270

def hash
  [id, name, dimension, dimension_value, dimension_value_name, metric, media_type, numeric_range, statistic, value, in_alarm, enabled, notification_users, alert_types].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



161
162
163
164
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 161

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



337
338
339
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 337

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



342
343
344
345
346
347
348
349
350
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 342

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 



332
333
334
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 332

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb', line 168

def valid?
  allowed_values = ["queueId", "userId"]
  if @dimension && !allowed_values.include?(@dimension)
    return false
  end
  allowed_values = ["tAbandon", "tAnswered", "tTalk", "nOffered", "tHandle", "nTransferred", "oServiceLevel", "tWait", "tHeld", "tAcw"]
  if @metric && !allowed_values.include?(@metric)
    return false
  end
  allowed_values = ["voice", "chat", "email"]
  if @media_type && !allowed_values.include?(@media_type)
    return false
  end
  allowed_values = ["gt", "gte", "lt", "lte", "eq", "ne"]
  if @numeric_range && !allowed_values.include?(@numeric_range)
    return false
  end
  allowed_values = ["count", "min", "ratio", "max"]
  if @statistic && !allowed_values.include?(@statistic)
    return false
  end
end