Class: PureCloud::AuditLogMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuditLogMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
191
192
193
194
195
196
197
198
199
200
201
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
239
240
241
242
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#action ⇒ Object

Action that took place.



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

def action
  @action
end

#client ⇒ Object

Client associated with this audit message.



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

def client
  @client
end

#context ⇒ Object

Additional context for this message.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 55

def context
  @context
end

#entity ⇒ Object

Entity that was impacted.



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

def entity
  @entity
end

#entity_type ⇒ Object

Type of the entity that was impacted.



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

def entity_type
  @entity_type
end

#event_date ⇒ Object

Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def event_date
  @event_date
end

#id ⇒ Object

Id of the audit message.



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

def id
  @id
end

#message ⇒ Object

Message describing the event being audited.



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

def message
  @message
end

#property_changes ⇒ Object

List of properties that were changed and changes made to those properties.



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 52

def property_changes
  @property_changes
end

#remote_ip ⇒ Object

List of IP addresses of systems that originated or handled the request.



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

def remote_ip
  @remote_ip
end

#service_name ⇒ Object

Name of the service that logged this audit message.



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

def service_name
  @service_name
end

#user ⇒ Object

User associated with this audit message.



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 58

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'user' => :'user',
    
    :'client' => :'client',
    
    :'remote_ip' => :'remoteIp',
    
    :'service_name' => :'serviceName',
    
    :'event_date' => :'eventDate',
    
    :'message' => :'message',
    
    :'action' => :'action',
    
    :'entity' => :'entity',
    
    :'entity_type' => :'entityType',
    
    :'property_changes' => :'propertyChanges',
    
    :'context' => :'context'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 89

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'user' => :'DomainEntityRef',
    
    :'client' => :'AddressableEntityRef',
    
    :'remote_ip' => :'Array<String>',
    
    :'service_name' => :'String',
    
    :'event_date' => :'DateTime',
    
    :'message' => :'MessageInfo',
    
    :'action' => :'String',
    
    :'entity' => :'AddressableEntityRef',
    
    :'entity_type' => :'String',
    
    :'property_changes' => :'Array<PropertyChange>',
    
    :'context' => :'Hash<String, String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 412

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user == o.user &&
      client == o.client &&
      remote_ip == o.remote_ip &&
      service_name == o.service_name &&
      event_date == o.event_date &&
      message == o.message &&
      action == o.action &&
      entity == o.entity &&
      entity_type == o.entity_type &&
      property_changes == o.property_changes &&
      context == o.context
end

#_deserialize(type, value) ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 461

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



521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 521

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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 442

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


431
432
433
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 431

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



437
438
439
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 437

def hash
  [id, user, client, remote_ip, service_name, event_date, message, action, entity, entity_type, property_changes, context].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



246
247
248
249
250
251
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 246

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



504
505
506
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 504

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



509
510
511
512
513
514
515
516
517
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 509

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 



499
500
501
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 499

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/purecloudplatformclientv2/models/audit_log_message.rb', line 255

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement", "Triggers", "ResponseManagement"]
  if @service_name && !allowed_values.include?(@service_name)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "ApplyProtection", "RevokeProtection", "UpdateRetention", "ReadAll", "Execute", "Publish", "Unpublish", "Enable", "Disable", "Authorize", "Deauthorize", "Authenticate", "ChangePassword"]
  if @action && !allowed_values.include?(@action)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "SessionType", "EventType", "ClickstreamSettings", "Schedule", "Trigger", "Response"]
  if @entity_type && !allowed_values.include?(@entity_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end