Class: PureCloud::WfmUserNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WfmUserNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 100

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

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

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

  
  if attributes.has_key?(:'shiftTrade')
    
    
    self.shift_trade = attributes[:'shiftTrade']
    
  
  end

  
  if attributes.has_key?(:'timeOffRequest')
    
    
    self.time_off_request = attributes[:'timeOffRequest']
    
  
  end

  
  if attributes.has_key?(:'markedAsRead')
    
    
    self.marked_as_read = attributes[:'markedAsRead']
    
  
  end

  
  if attributes.has_key?(:'agentNotification')
    
    
    self.agent_notification = attributes[:'agentNotification']
    
  
  end

  
  if attributes.has_key?(:'otherNotificationIdsInGroup')
    
    if (value = attributes[:'otherNotificationIdsInGroup']).is_a?(Array)
      self.other_notification_ids_in_group = value
    end
    
    
  
  end

  
end

Instance Attribute Details

#agent_notification ⇒ Object

Whether this notification is for an agent



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

def agent_notification
  @agent_notification
end

#id ⇒ Object

The immutable globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 22

def id
  @id
end

#marked_as_read ⇒ Object

Whether this notification has been marked "read"



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 40

def marked_as_read
  @marked_as_read
end

#mutable_group_id ⇒ Object

The group ID of the notification (mutable, may change on update)



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

def mutable_group_id
  @mutable_group_id
end

#other_notification_ids_in_group ⇒ Object

Other notification IDs in group. This field is only populated in real-time notifications



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 46

def other_notification_ids_in_group
  @other_notification_ids_in_group
end

#shift_trade ⇒ Object

A shift trade notification. Only set if type == ShiftTrade



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 34

def shift_trade
  @shift_trade
end

#time_off_request ⇒ Object

A time off request notification. Only set if type == TimeOffRequest



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

def time_off_request
  @time_off_request
end

#timestamp ⇒ Object

The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 28

def timestamp
  @timestamp
end

#type ⇒ Object

The type of this notification



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'mutable_group_id' => :'mutableGroupId',
    
    :'timestamp' => :'timestamp',
    
    :'type' => :'type',
    
    :'shift_trade' => :'shiftTrade',
    
    :'time_off_request' => :'timeOffRequest',
    
    :'marked_as_read' => :'markedAsRead',
    
    :'agent_notification' => :'agentNotification',
    
    :'other_notification_ids_in_group' => :'otherNotificationIdsInGroup'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'mutable_group_id' => :'String',
    
    :'timestamp' => :'DateTime',
    
    :'type' => :'String',
    
    :'shift_trade' => :'ShiftTradeNotification',
    
    :'time_off_request' => :'TimeOffRequestNotification',
    
    :'marked_as_read' => :'BOOLEAN',
    
    :'agent_notification' => :'BOOLEAN',
    
    :'other_notification_ids_in_group' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 320

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      mutable_group_id == o.mutable_group_id &&
      timestamp == o.timestamp &&
      type == o.type &&
      shift_trade == o.shift_trade &&
      time_off_request == o.time_off_request &&
      marked_as_read == o.marked_as_read &&
      agent_notification == o.agent_notification &&
      other_notification_ids_in_group == o.other_notification_ids_in_group
end

#_deserialize(type, value) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 366

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 426

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 347

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


336
337
338
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 336

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



342
343
344
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 342

def hash
  [id, mutable_group_id, timestamp, type, shift_trade, time_off_request, marked_as_read, agent_notification, other_notification_ids_in_group].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



194
195
196
197
198
199
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 194

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



409
410
411
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 409

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



414
415
416
417
418
419
420
421
422
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 414

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 



404
405
406
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 404

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



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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/purecloudplatformclientv2/models/wfm_user_notification.rb', line 203

def valid?
  
  
  if @id.nil?
    return false
  end

  
  
  
  
  
  if @mutable_group_id.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ShiftTrade", "TimeOffRequest"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  if @marked_as_read.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
end