Class: PureCloud::InteractionStatAlertNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InteractionStatAlertNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'ruleId')
    self.rule_id = attributes[:'ruleId']
  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?(:'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

end

Instance Attribute Details

#alert_types ⇒ Object

Returns the value of attribute alert_types.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 51

def alert_types
  @alert_types
end

#dimension ⇒ Object

Returns the value of attribute dimension.



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

def dimension
  @dimension
end

#dimension_value ⇒ Object

Returns the value of attribute dimension_value.



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

def dimension_value
  @dimension_value
end

#dimension_value_name ⇒ Object

Returns the value of attribute dimension_value_name.



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

def dimension_value_name
  @dimension_value_name
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#media_type ⇒ Object

Returns the value of attribute media_type.



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

def media_type
  @media_type
end

#metric ⇒ Object

Returns the value of attribute metric.



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

def metric
  @metric
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#notification_users ⇒ Object

Returns the value of attribute notification_users.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 49

def notification_users
  @notification_users
end

#numeric_range ⇒ Object

Returns the value of attribute numeric_range.



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

def numeric_range
  @numeric_range
end

#rule_id ⇒ Object

Returns the value of attribute rule_id.



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

def rule_id
  @rule_id
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#statistic ⇒ Object

Returns the value of attribute statistic.



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

def statistic
  @statistic
end

#unread ⇒ Object

Returns the value of attribute unread.



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

def unread
  @unread
end

#value ⇒ Object

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 54

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

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 76

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'rule_id' => :'String',
    :'dimension' => :'String',
    :'dimension_value' => :'String',
    :'dimension_value_name' => :'String',
    :'metric' => :'String',
    :'media_type' => :'String',
    :'numeric_range' => :'String',
    :'statistic' => :'String',
    :'value' => :'Float',
    :'unread' => :'BOOLEAN',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      rule_id == o.rule_id &&
      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 &&
      unread == o.unread &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types
end

#_deserialize(type, value) ⇒ Object 



312
313
314
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
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 312

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 372

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 293

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


282
283
284
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 288

def hash
  [id, name, rule_id, dimension, dimension_value, dimension_value_name, metric, media_type, numeric_range, statistic, value, unread, start_date, end_date, 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



177
178
179
180
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 177

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



355
356
357
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 355

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



360
361
362
363
364
365
366
367
368
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 360

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 



350
351
352
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 350

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb', line 184

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