Class: PureCloud::HeartBeatAlertNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeartBeatAlertNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 75

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?(:'senderId')
    self.sender_id = attributes[:'senderId']
  end

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

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

end

Instance Attribute Details

#alert_types ⇒ Object

Returns the value of attribute alert_types.



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

def alert_types
  @alert_types
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#heart_beat_timeout_in_minutes ⇒ Object

Returns the value of attribute heart_beat_timeout_in_minutes.



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

def heart_beat_timeout_in_minutes
  @heart_beat_timeout_in_minutes
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#notification_users ⇒ Object

Returns the value of attribute notification_users.



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

def notification_users
  @notification_users
end

#rule_id ⇒ Object

Returns the value of attribute rule_id.



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

def rule_id
  @rule_id
end

#rule_type ⇒ Object

Returns the value of attribute rule_type.



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

def rule_type
  @rule_type
end

#sender_id ⇒ Object

Returns the value of attribute sender_id.



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

def sender_id
  @sender_id
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 42

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'sender_id' => :'senderId',
    :'heart_beat_timeout_in_minutes' => :'heartBeatTimeoutInMinutes',
    :'rule_id' => :'ruleId',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'notification_users' => :'notificationUsers',
    :'alert_types' => :'alertTypes',
    :'rule_type' => :'ruleType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 58

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'sender_id' => :'String',
    :'heart_beat_timeout_in_minutes' => :'Float',
    :'rule_id' => :'String',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'notification_users' => :'Array<HeartBeatAlertNotificationNotificationUsers>',
    :'alert_types' => :'Array<String>',
    :'rule_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      sender_id == o.sender_id &&
      heart_beat_timeout_in_minutes == o.heart_beat_timeout_in_minutes &&
      rule_id == o.rule_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types &&
      rule_type == o.rule_type
end

#_deserialize(type, value) ⇒ Object 



202
203
204
205
206
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
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 202

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 262

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 183

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


172
173
174
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, name, sender_id, heart_beat_timeout_in_minutes, rule_id, start_date, end_date, notification_users, alert_types, rule_type].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



129
130
131
132
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 129

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



245
246
247
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 245

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



250
251
252
253
254
255
256
257
258
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 250

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 



240
241
242
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 240

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



136
137
138
139
140
141
 
# File 'lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb', line 136

def valid?
  allowed_values = ["EDGE"]
  if @rule_type && !allowed_values.include?(@rule_type)
    return false
  end
end