Class: PureCloud::RoutingStatusRule

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RoutingStatusRule

Returns a new instance of RoutingStatusRule.



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
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 95

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[:'agent']
    self.agent = attributes[:'agent']
  end
  
  if attributes[:'routingStatus']
    self.routing_status = attributes[:'routingStatus']
  end
  
  if attributes[:'routingLimitInSeconds']
    self.routing_limit_in_seconds = attributes[:'routingLimitInSeconds']
  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

#agent ⇒ Object

The agent whose routing status will be watched.



28
29
30
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 28

def agent
  @agent
end

#alert_types ⇒ Object

A collection of notification methods.



46
47
48
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 46

def alert_types
  @alert_types
end

#enabled ⇒ Object

Indicates if the rule is enabled.



37
38
39
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 37

def enabled
  @enabled
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 22

def id
  @id
end

#in_alarm ⇒ Object

Indicates if the rule is in alarm state.



40
41
42
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 40

def in_alarm
  @in_alarm
end

#name ⇒ Object

Name of the rule



25
26
27
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 25

def name
  @name
end

#notification_users ⇒ Object

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



43
44
45
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 43

def notification_users
  @notification_users
end

#routing_limit_in_seconds ⇒ Object

The number of seconds to wait before alerting based upon the agent’s routing status.



34
35
36
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 34

def routing_limit_in_seconds
  @routing_limit_in_seconds
end

#routing_status ⇒ Object

The routing status on which to alert.



31
32
33
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 31

def routing_status
  @routing_status
end

#self_uri ⇒ Object

The URI for this object



49
50
51
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 49

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 52

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'agent' => :'agent',
    
    :'routing_status' => :'routingStatus',
    
    :'routing_limit_in_seconds' => :'routingLimitInSeconds',
    
    :'enabled' => :'enabled',
    
    :'in_alarm' => :'inAlarm',
    
    :'notification_users' => :'notificationUsers',
    
    :'alert_types' => :'alertTypes',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 79

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'agent' => :'User',
    :'routing_status' => :'String',
    :'routing_limit_in_seconds' => :'Integer',
    :'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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      agent == o.agent &&
      routing_status == o.routing_status &&
      routing_limit_in_seconds == o.routing_limit_in_seconds &&
      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 



207
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
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 207

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 267

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 188

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


178
179
180
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



183
184
185
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 183

def hash
  [id, name, agent, routing_status, routing_limit_in_seconds, enabled, in_alarm, notification_users, alert_types, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



250
251
252
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 250

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



255
256
257
258
259
260
261
262
263
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 255

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 



245
246
247
 
# File 'lib/purecloud/models/routing_status_rule.rb', line 245

def to_s
  to_hash.to_s
end