Class: PureCloud::InteractionStatsRule

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InteractionStatsRule

Returns a new instance of InteractionStatsRule.



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 103

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[:'enabled']
    self.enabled = attributes[:'enabled']
  else
    self.enabled = false
  end
  
  if attributes[:'inAlarm']
    self.in_alarm = attributes[:'inAlarm']
  else
    self.in_alarm = false
  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[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#alert_types ⇒ Object

A collection of notification methods. = [‘SMS’, ‘DEVICE’, ‘EMAIL’]



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

def alert_types
  @alert_types
end

#dimension ⇒ Object

The dimension of concern.



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

def dimension
  @dimension
end

#dimension_value ⇒ Object

The value of the dimension.



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

def dimension_value
  @dimension_value
end

#enabled ⇒ Object

Indicates if the rule is enabled.



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

def enabled
  @enabled
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#in_alarm ⇒ Object

Indicates if the rule is in alarm state.



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

def in_alarm
  @in_alarm
end

#media_type ⇒ Object

The media type.



21
22
23
 
# File 'lib/purecloud/models/interaction_stats_rule.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_rule.rb', line 18

def metric
  @metric
end

#name ⇒ Object

Name of the rule



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

def name
  @name
end

#notification_users ⇒ Object

The ids of users who will be notified of alarm state change.



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

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_rule.rb', line 24

def numeric_range
  @numeric_range
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#statistic ⇒ Object

The statistic of concern for the metric.



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

def statistic
  @statistic
end

#value ⇒ Object

The threshold value.



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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
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
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 48

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',
    
    :'enabled' => :'enabled',
    
    :'in_alarm' => :'inAlarm',
    
    :'notification_users' => :'notificationUsers',
    
    :'alert_types' => :'alertTypes',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 83

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',
    :'enabled' => :'BOOLEAN',
    :'in_alarm' => :'BOOLEAN',
    :'notification_users' => :'Array<User>',
    :'alert_types' => :'Array<String>',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 222

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 &&
      enabled == o.enabled &&
      in_alarm == o.in_alarm &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 271

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 328

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



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

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


242
243
244
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



247
248
249
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 247

def hash
  [id, name, dimension, dimension_value, metric, media_type, numeric_range, statistic, value, enabled, in_alarm, notification_users, alert_types, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



311
312
313
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 311

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



316
317
318
319
320
321
322
323
324
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 316

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 



306
307
308
 
# File 'lib/purecloud/models/interaction_stats_rule.rb', line 306

def to_s
  to_hash.to_s
end