Class: PureCloud::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/document.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Returns a new instance of Document.



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
 
# File 'lib/purecloud/models/document.rb', line 180

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'changeNumber']
    self.change_number = attributes[:'changeNumber']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'dateUploaded']
    self.date_uploaded = attributes[:'dateUploaded']
  end
  
  if attributes[:'contentUri']
    self.content_uri = attributes[:'contentUri']
  end
  
  if attributes[:'workspace']
    self.workspace = attributes[:'workspace']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'uploadedBy']
    self.uploaded_by = attributes[:'uploadedBy']
  end
  
  if attributes[:'contentType']
    self.content_type = attributes[:'contentType']
  end
  
  if attributes[:'contentLength']
    self.content_length = attributes[:'contentLength']
  end
  
  if attributes[:'systemType']
    self.system_type = attributes[:'systemType']
  end
  
  if attributes[:'filename']
    self.filename = attributes[:'filename']
  end
  
  if attributes[:'pageCount']
    self.page_count = attributes[:'pageCount']
  end
  
  if attributes[:'read']
    self.read = attributes[:'read']
  else
    self.read = false
  end
  
  if attributes[:'callerAddress']
    self.caller_address = attributes[:'callerAddress']
  end
  
  if attributes[:'receiverAddress']
    self.receiver_address = attributes[:'receiverAddress']
  end
  
  if attributes[:'tags']
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end
  
  if attributes[:'tagValues']
    if (value = attributes[:'tagValues']).is_a?(Array)
      self.tag_values = value
    end
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'thumbnails']
    if (value = attributes[:'thumbnails']).is_a?(Array)
      self.thumbnails = value
    end
  end
  
  if attributes[:'uploadStatus']
    self.upload_status = attributes[:'uploadStatus']
  end
  
  if attributes[:'uploadDestinationUri']
    self.upload_destination_uri = attributes[:'uploadDestinationUri']
  end
  
  if attributes[:'uploadMethod']
    self.upload_method = attributes[:'uploadMethod']
  end
  
  if attributes[:'lockInfo']
    self.lock_info = attributes[:'lockInfo']
  end
  
  if attributes[:'acl']
    if (value = attributes[:'acl']).is_a?(Array)
      self.acl = value
    end
  end
  
  if attributes[:'sharingStatus']
    self.sharing_status = attributes[:'sharingStatus']
  end
  
  if attributes[:'sharingUri']
    self.sharing_uri = attributes[:'sharingUri']
  end
  
  if attributes[:'downloadSharingUri']
    self.download_sharing_uri = attributes[:'downloadSharingUri']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#acl ⇒ Object

A list of permitted action rights for the user making the request



62
63
64
 
# File 'lib/purecloud/models/document.rb', line 62

def acl
  @acl
end

#attributes ⇒ Object

Returns the value of attribute attributes.



49
50
51
 
# File 'lib/purecloud/models/document.rb', line 49

def attributes
  @attributes
end

#caller_address ⇒ Object

Returns the value of attribute caller_address.



41
42
43
 
# File 'lib/purecloud/models/document.rb', line 41

def caller_address
  @caller_address
end

#change_number ⇒ Object

Returns the value of attribute change_number.



10
11
12
 
# File 'lib/purecloud/models/document.rb', line 10

def change_number
  @change_number
end

#content_length ⇒ Object

Returns the value of attribute content_length.



31
32
33
 
# File 'lib/purecloud/models/document.rb', line 31

def content_length
  @content_length
end

#content_type ⇒ Object

Returns the value of attribute content_type.



29
30
31
 
# File 'lib/purecloud/models/document.rb', line 29

def content_type
  @content_type
end

#content_uri ⇒ Object

Returns the value of attribute content_uri.



21
22
23
 
# File 'lib/purecloud/models/document.rb', line 21

def content_uri
  @content_uri
end

#created_by ⇒ Object

Returns the value of attribute created_by.



25
26
27
 
# File 'lib/purecloud/models/document.rb', line 25

def created_by
  @created_by
end

#date_created ⇒ Object

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



13
14
15
 
# File 'lib/purecloud/models/document.rb', line 13

def date_created
  @date_created
end

#date_modified ⇒ Object

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



16
17
18
 
# File 'lib/purecloud/models/document.rb', line 16

def date_modified
  @date_modified
end

#date_uploaded ⇒ Object

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



19
20
21
 
# File 'lib/purecloud/models/document.rb', line 19

def date_uploaded
  @date_uploaded
end

#download_sharing_uri ⇒ Object

Returns the value of attribute download_sharing_uri.



68
69
70
 
# File 'lib/purecloud/models/document.rb', line 68

def download_sharing_uri
  @download_sharing_uri
end

#filename ⇒ Object

Returns the value of attribute filename.



35
36
37
 
# File 'lib/purecloud/models/document.rb', line 35

def filename
  @filename
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/document.rb', line 6

def id
  @id
end

#lock_info ⇒ Object

Returns the value of attribute lock_info.



59
60
61
 
# File 'lib/purecloud/models/document.rb', line 59

def lock_info
  @lock_info
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/document.rb', line 8

def name
  @name
end

#page_count ⇒ Object

Returns the value of attribute page_count.



37
38
39
 
# File 'lib/purecloud/models/document.rb', line 37

def page_count
  @page_count
end

#read ⇒ Object

Returns the value of attribute read.



39
40
41
 
# File 'lib/purecloud/models/document.rb', line 39

def read
  @read
end

#receiver_address ⇒ Object

Returns the value of attribute receiver_address.



43
44
45
 
# File 'lib/purecloud/models/document.rb', line 43

def receiver_address
  @receiver_address
end

#self_uri ⇒ Object

The URI for this object



71
72
73
 
# File 'lib/purecloud/models/document.rb', line 71

def self_uri
  @self_uri
end

#sharing_status ⇒ Object

Returns the value of attribute sharing_status.



64
65
66
 
# File 'lib/purecloud/models/document.rb', line 64

def sharing_status
  @sharing_status
end

#sharing_uri ⇒ Object

Returns the value of attribute sharing_uri.



66
67
68
 
# File 'lib/purecloud/models/document.rb', line 66

def sharing_uri
  @sharing_uri
end

#system_type ⇒ Object

Returns the value of attribute system_type.



33
34
35
 
# File 'lib/purecloud/models/document.rb', line 33

def system_type
  @system_type
end

#tag_values ⇒ Object

Returns the value of attribute tag_values.



47
48
49
 
# File 'lib/purecloud/models/document.rb', line 47

def tag_values
  @tag_values
end

#tags ⇒ Object

Returns the value of attribute tags.



45
46
47
 
# File 'lib/purecloud/models/document.rb', line 45

def tags
  @tags
end

#thumbnails ⇒ Object

Returns the value of attribute thumbnails.



51
52
53
 
# File 'lib/purecloud/models/document.rb', line 51

def thumbnails
  @thumbnails
end

#upload_destination_uri ⇒ Object

Returns the value of attribute upload_destination_uri.



55
56
57
 
# File 'lib/purecloud/models/document.rb', line 55

def upload_destination_uri
  @upload_destination_uri
end

#upload_method ⇒ Object

Returns the value of attribute upload_method.



57
58
59
 
# File 'lib/purecloud/models/document.rb', line 57

def upload_method
  @upload_method
end

#upload_status ⇒ Object

Returns the value of attribute upload_status.



53
54
55
 
# File 'lib/purecloud/models/document.rb', line 53

def upload_status
  @upload_status
end

#uploaded_by ⇒ Object

Returns the value of attribute uploaded_by.



27
28
29
 
# File 'lib/purecloud/models/document.rb', line 27

def uploaded_by
  @uploaded_by
end

#workspace ⇒ Object

Returns the value of attribute workspace.



23
24
25
 
# File 'lib/purecloud/models/document.rb', line 23

def workspace
  @workspace
end

Class Method Details

.attribute_map ⇒ Object

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



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
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
 
# File 'lib/purecloud/models/document.rb', line 74

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'change_number' => :'changeNumber',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'date_uploaded' => :'dateUploaded',
    
    :'content_uri' => :'contentUri',
    
    :'workspace' => :'workspace',
    
    :'created_by' => :'createdBy',
    
    :'uploaded_by' => :'uploadedBy',
    
    :'content_type' => :'contentType',
    
    :'content_length' => :'contentLength',
    
    :'system_type' => :'systemType',
    
    :'filename' => :'filename',
    
    :'page_count' => :'pageCount',
    
    :'read' => :'read',
    
    :'caller_address' => :'callerAddress',
    
    :'receiver_address' => :'receiverAddress',
    
    :'tags' => :'tags',
    
    :'tag_values' => :'tagValues',
    
    :'attributes' => :'attributes',
    
    :'thumbnails' => :'thumbnails',
    
    :'upload_status' => :'uploadStatus',
    
    :'upload_destination_uri' => :'uploadDestinationUri',
    
    :'upload_method' => :'uploadMethod',
    
    :'lock_info' => :'lockInfo',
    
    :'acl' => :'acl',
    
    :'sharing_status' => :'sharingStatus',
    
    :'sharing_uri' => :'sharingUri',
    
    :'download_sharing_uri' => :'downloadSharingUri',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloud/models/document.rb', line 143

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'change_number' => :'Integer',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'date_uploaded' => :'DateTime',
    :'content_uri' => :'String',
    :'workspace' => :'UriReference',
    :'created_by' => :'UriReference',
    :'uploaded_by' => :'UriReference',
    :'content_type' => :'String',
    :'content_length' => :'Integer',
    :'system_type' => :'String',
    :'filename' => :'String',
    :'page_count' => :'Integer',
    :'read' => :'BOOLEAN',
    :'caller_address' => :'String',
    :'receiver_address' => :'String',
    :'tags' => :'Array<String>',
    :'tag_values' => :'Array<TagValue>',
    :'attributes' => :'Array<DocumentAttribute>',
    :'thumbnails' => :'Array<DocumentThumbnail>',
    :'upload_status' => :'UriReference',
    :'upload_destination_uri' => :'String',
    :'upload_method' => :'String',
    :'lock_info' => :'LockInfo',
    :'acl' => :'Array<String>',
    :'sharing_status' => :'String',
    :'sharing_uri' => :'String',
    :'download_sharing_uri' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/purecloud/models/document.rb', line 353

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      change_number == o.change_number &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      date_uploaded == o.date_uploaded &&
      content_uri == o.content_uri &&
      workspace == o.workspace &&
      created_by == o.created_by &&
      uploaded_by == o.uploaded_by &&
      content_type == o.content_type &&
      content_length == o.content_length &&
      system_type == o.system_type &&
      filename == o.filename &&
      page_count == o.page_count &&
      read == o.read &&
      caller_address == o.caller_address &&
      receiver_address == o.receiver_address &&
      tags == o.tags &&
      tag_values == o.tag_values &&
      attributes == o.attributes &&
      thumbnails == o.thumbnails &&
      upload_status == o.upload_status &&
      upload_destination_uri == o.upload_destination_uri &&
      upload_method == o.upload_method &&
      lock_info == o.lock_info &&
      acl == o.acl &&
      sharing_status == o.sharing_status &&
      sharing_uri == o.sharing_uri &&
      download_sharing_uri == o.download_sharing_uri &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/document.rb', line 419

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/purecloud/models/document.rb', line 476

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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/purecloud/models/document.rb', line 400

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

Returns:

  • (Boolean)

See Also:

  • `==` method


390
391
392
 
# File 'lib/purecloud/models/document.rb', line 390

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



395
396
397
 
# File 'lib/purecloud/models/document.rb', line 395

def hash
  [id, name, change_number, date_created, date_modified, date_uploaded, content_uri, workspace, created_by, uploaded_by, content_type, content_length, system_type, filename, page_count, read, caller_address, receiver_address, tags, tag_values, attributes, thumbnails, upload_status, upload_destination_uri, upload_method, lock_info, acl, sharing_status, sharing_uri, download_sharing_uri, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



459
460
461
 
# File 'lib/purecloud/models/document.rb', line 459

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



464
465
466
467
468
469
470
471
472
 
# File 'lib/purecloud/models/document.rb', line 464

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 



454
455
456
 
# File 'lib/purecloud/models/document.rb', line 454

def to_s
  to_hash.to_s
end