Class: PureCloud::HistoryListing

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HistoryListing

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
243
244
245
246
247
248
249
250
251
252
253
254
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 161

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#action_name ⇒ Object

Action name



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

def action_name
  @action_name
end

#action_status ⇒ Object

Action status



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

def action_status
  @action_status
end

#client ⇒ Object

Returns the value of attribute client.



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

def client
  @client
end

#complete ⇒ Object

Returns the value of attribute complete.



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

def complete
  @complete
end

#completed ⇒ Object

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



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 53

def completed
  @completed
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#entities ⇒ Object

Returns the value of attribute entities.



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

def entities
  @entities
end

#error_code ⇒ Object

Returns the value of attribute error_code.



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

def error_code
  @error_code
end

#error_details ⇒ Object

Returns the value of attribute error_details.



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

def error_details
  @error_details
end

#error_message ⇒ Object

Returns the value of attribute error_message.



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

def error_message
  @error_message
end

#error_message_params ⇒ Object

Returns the value of attribute error_message_params.



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

def error_message_params
  @error_message_params
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#page_count ⇒ Object

Returns the value of attribute page_count.



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 63

def page_count
  @page_count
end

#page_number ⇒ Object

Returns the value of attribute page_number.



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 59

def page_number
  @page_number
end

#page_size ⇒ Object

Returns the value of attribute page_size.



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 61

def page_size
  @page_size
end

#started ⇒ Object

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



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 50

def started
  @started
end

#system ⇒ Object

Returns the value of attribute system.



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

def system
  @system
end

#total ⇒ Object

Returns the value of attribute total.



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 57

def total
  @total
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
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
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 66

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'complete' => :'complete',
    
    :'user' => :'user',
    
    :'client' => :'client',
    
    :'error_message' => :'errorMessage',
    
    :'error_code' => :'errorCode',
    
    :'error_details' => :'errorDetails',
    
    :'error_message_params' => :'errorMessageParams',
    
    :'action_name' => :'actionName',
    
    :'action_status' => :'actionStatus',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'system' => :'system',
    
    :'started' => :'started',
    
    :'completed' => :'completed',
    
    :'entities' => :'entities',
    
    :'total' => :'total',
    
    :'page_number' => :'pageNumber',
    
    :'page_size' => :'pageSize',
    
    :'page_count' => :'pageCount'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'complete' => :'BOOLEAN',
    
    :'user' => :'User',
    
    :'client' => :'DomainEntityRef',
    
    :'error_message' => :'String',
    
    :'error_code' => :'String',
    
    :'error_details' => :'Array<Detail>',
    
    :'error_message_params' => :'Hash<String, String>',
    
    :'action_name' => :'String',
    
    :'action_status' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'system' => :'BOOLEAN',
    
    :'started' => :'DateTime',
    
    :'completed' => :'DateTime',
    
    :'entities' => :'Array<HistoryEntry>',
    
    :'total' => :'Integer',
    
    :'page_number' => :'Integer',
    
    :'page_size' => :'Integer',
    
    :'page_count' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 582

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      complete == o.complete &&
      user == o.user &&
      client == o.client &&
      error_message == o.error_message &&
      error_code == o.error_code &&
      error_details == o.error_details &&
      error_message_params == o.error_message_params &&
      action_name == o.action_name &&
      action_status == o.action_status &&
      name == o.name &&
      description == o.description &&
      system == o.system &&
      started == o.started &&
      completed == o.completed &&
      entities == o.entities &&
      total == o.total &&
      page_number == o.page_number &&
      page_size == o.page_size &&
      page_count == o.page_count
end

#_deserialize(type, value) ⇒ Object 



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 639

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



699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 699

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



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 620

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


609
610
611
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 609

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



615
616
617
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 615

def hash
  [id, complete, user, client, error_message, error_code, error_details, error_message_params, action_name, action_status, name, description, system, started, completed, entities, total, page_number, page_size, page_count].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



358
359
360
361
362
363
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 358

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



682
683
684
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 682

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



687
688
689
690
691
692
693
694
695
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 687

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 



677
678
679
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 677

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



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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/purecloudplatformclientv2/models/history_listing.rb', line 367

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["CREATE", "CHECKIN", "DEBUG", "DELETE", "HISTORY", "PUBLISH", "STATE_CHANGE", "UPDATE", "VALIDATE"]
  if @action_name && !allowed_values.include?(@action_name)
    return false
  end
  
  
  
  
  
  allowed_values = ["LOCKED", "UNLOCKED", "STARTED", "PENDING_GENERATION", "PENDING_BACKEND_NOTIFICATION", "SUCCESS", "FAILURE"]
  if @action_status && !allowed_values.include?(@action_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end