Class: PureCloud::DocumentAudit

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentAudit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'actionContext')
    self.action_context = attributes[:'actionContext']
  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?(:'changes')
    if (value = attributes[:'changes']).is_a?(Array)
      self.changes = value
    end
  end

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

end

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



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

def action
  @action
end

#action_context ⇒ Object

Returns the value of attribute action_context.



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

def action_context
  @action_context
end

#application ⇒ Object

Returns the value of attribute application.



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

def application
  @application
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#entity ⇒ Object

Returns the value of attribute entity.



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

def entity
  @entity
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#level ⇒ Object

Returns the value of attribute level.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 38

def level
  @level
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 54

def self_uri
  @self_uri
end

#service_name ⇒ Object

Returns the value of attribute service_name.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 36

def service_name
  @service_name
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#timestamp ⇒ Object

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



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

def timestamp
  @timestamp
end

#transaction_id ⇒ Object

Returns the value of attribute transaction_id.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 30

def transaction_id
  @transaction_id
end

#transaction_initiator ⇒ Object

Returns the value of attribute transaction_initiator.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 32

def transaction_initiator
  @transaction_initiator
end

#user ⇒ Object

Returns the value of attribute user.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 26

def user
  @user
end

#workspace ⇒ Object

Returns the value of attribute workspace.



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

def workspace
  @workspace
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 57

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'user' => :'user',
    :'workspace' => :'workspace',
    :'transaction_id' => :'transactionId',
    :'transaction_initiator' => :'transactionInitiator',
    :'application' => :'application',
    :'service_name' => :'serviceName',
    :'level' => :'level',
    :'timestamp' => :'timestamp',
    :'status' => :'status',
    :'action_context' => :'actionContext',
    :'action' => :'action',
    :'entity' => :'entity',
    :'changes' => :'changes',
    :'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
94
95
96
97
98
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 79

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'user' => :'UriReference',
    :'workspace' => :'UriReference',
    :'transaction_id' => :'String',
    :'transaction_initiator' => :'BOOLEAN',
    :'application' => :'String',
    :'service_name' => :'String',
    :'level' => :'String',
    :'timestamp' => :'DateTime',
    :'status' => :'String',
    :'action_context' => :'String',
    :'action' => :'String',
    :'entity' => :'AuditEntityReference',
    :'changes' => :'Array<AuditChange>',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      user == o.user &&
      workspace == o.workspace &&
      transaction_id == o.transaction_id &&
      transaction_initiator == o.transaction_initiator &&
      application == o.application &&
      service_name == o.service_name &&
      level == o.level &&
      timestamp == o.timestamp &&
      status == o.status &&
      action_context == o.action_context &&
      action == o.action &&
      entity == o.entity &&
      changes == o.changes &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 299

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 359

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 280

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


269
270
271
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 275

def hash
  [id, name, user, workspace, transaction_id, transaction_initiator, application, service_name, level, timestamp, status, action_context, action, entity, changes, self_uri].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



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

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



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

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



347
348
349
350
351
352
353
354
355
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 347

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 



337
338
339
 
# File 'lib/purecloudplatformclientv2/models/document_audit.rb', line 337

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



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

def valid?
  allowed_values = ["USER", "SYSTEM"]
  if @level && !allowed_values.include?(@level)
    return false
  end
  allowed_values = ["SUCCESS", "FAILURE"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  allowed_values = ["CREATE", "READ", "UPDATE", "DELETE", "DOWNLOAD", "VIEW", "UPLOAD", "SAVE", "MOVE", "COPY", "ADD", "REMOVE", "RECEIVE", "CONVERT", "FAX", "CREATE_COVERPAGE", "USER_ADD", "USER_REMOVE", "MEMBER_ADD", "MEMBER_REMOVE", "MEMBER_UPDATE", "TAG_ADD", "TAG_REMOVE", "TAG_UPDATE", "ATTRIBUTE_ADD", "ATTRIBUTE_REMOVE", "ATTRIBUTE_UPDATE", "ATTRIBUTE_GROUP_INSTANCE_ADD", "ATTRIBUTE_GROUP_INSTANCE_REMOVE", "ATTRIBUTE_GROUP_INSTANCE_UPDATE", "INDEX_SAVE", "INDEX_DELETE", "INDEX_CREATE", "FILE_SAVE", "FILE_DELETE", "FILE_READ", "THUMBNAIL_CREATE", "TEXT_EXTRACT", "SHARE_ADD", "SHARE_REMOVE", "VERSION_CREATE"]
  if @action_context && !allowed_values.include?(@action_context)
    return false
  end
  allowed_values = ["CREATE", "READ", "UPDATE", "DELETE", "DOWNLOAD", "VIEW", "UPLOAD", "SAVE", "MOVE", "COPY", "ADD", "REMOVE", "RECEIVE", "CONVERT", "FAX", "CREATE_COVERPAGE", "USER_ADD", "USER_REMOVE", "MEMBER_ADD", "MEMBER_REMOVE", "MEMBER_UPDATE", "TAG_ADD", "TAG_REMOVE", "TAG_UPDATE", "ATTRIBUTE_ADD", "ATTRIBUTE_REMOVE", "ATTRIBUTE_UPDATE", "ATTRIBUTE_GROUP_INSTANCE_ADD", "ATTRIBUTE_GROUP_INSTANCE_REMOVE", "ATTRIBUTE_GROUP_INSTANCE_UPDATE", "INDEX_SAVE", "INDEX_DELETE", "INDEX_CREATE", "FILE_SAVE", "FILE_DELETE", "FILE_READ", "THUMBNAIL_CREATE", "TEXT_EXTRACT", "SHARE_ADD", "SHARE_REMOVE", "VERSION_CREATE"]
  if @action && !allowed_values.include?(@action)
    return false
  end
end