Class: PureCloud::Document

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'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



78
79
80
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 78

def acl
  @acl
end

#attributes ⇒ Object

Returns the value of attribute attributes.



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 65

def attributes
  @attributes
end

#caller_address ⇒ Object

Returns the value of attribute caller_address.



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

def caller_address
  @caller_address
end

#change_number ⇒ Object

Returns the value of attribute change_number.



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

def change_number
  @change_number
end

#content_length ⇒ Object

Returns the value of attribute content_length.



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

def content_length
  @content_length
end

#content_type ⇒ Object

Returns the value of attribute content_type.



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

def content_type
  @content_type
end

#content_uri ⇒ Object

Returns the value of attribute content_uri.



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

def content_uri
  @content_uri
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

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



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

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



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

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



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

def date_uploaded
  @date_uploaded
end

#download_sharing_uri ⇒ Object

Returns the value of attribute download_sharing_uri.



84
85
86
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 84

def download_sharing_uri
  @download_sharing_uri
end

#filename ⇒ Object

Returns the value of attribute filename.



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

def filename
  @filename
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#lock_info ⇒ Object

Returns the value of attribute lock_info.



75
76
77
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 75

def lock_info
  @lock_info
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#page_count ⇒ Object

Returns the value of attribute page_count.



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

def page_count
  @page_count
end

#read ⇒ Object

Returns the value of attribute read.



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

def read
  @read
end

#receiver_address ⇒ Object

Returns the value of attribute receiver_address.



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

def receiver_address
  @receiver_address
end

#self_uri ⇒ Object

The URI for this object



87
88
89
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 87

def self_uri
  @self_uri
end

#sharing_status ⇒ Object

Returns the value of attribute sharing_status.



80
81
82
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 80

def sharing_status
  @sharing_status
end

#sharing_uri ⇒ Object

Returns the value of attribute sharing_uri.



82
83
84
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 82

def sharing_uri
  @sharing_uri
end

#system_type ⇒ Object

Returns the value of attribute system_type.



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

def system_type
  @system_type
end

#tag_values ⇒ Object

Returns the value of attribute tag_values.



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

def tag_values
  @tag_values
end

#tags ⇒ Object

Returns the value of attribute tags.



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

def tags
  @tags
end

#thumbnails ⇒ Object

Returns the value of attribute thumbnails.



67
68
69
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 67

def thumbnails
  @thumbnails
end

#upload_destination_uri ⇒ Object

Returns the value of attribute upload_destination_uri.



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

def upload_destination_uri
  @upload_destination_uri
end

#upload_method ⇒ Object

Returns the value of attribute upload_method.



73
74
75
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 73

def upload_method
  @upload_method
end

#upload_status ⇒ Object

Returns the value of attribute upload_status.



69
70
71
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 69

def upload_status
  @upload_status
end

#uploaded_by ⇒ Object

Returns the value of attribute uploaded_by.



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

def uploaded_by
  @uploaded_by
end

#workspace ⇒ Object

Returns the value of attribute workspace.



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

def workspace
  @workspace
end

Class Method Details

.attribute_map ⇒ Object

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



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

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.



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

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

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 363

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 



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
460
461
462
463
464
465
466
467
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 431

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



491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 491

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



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

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


401
402
403
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 401

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



407
408
409
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 407

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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



309
310
311
312
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 309

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



474
475
476
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 474

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



479
480
481
482
483
484
485
486
487
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 479

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 



469
470
471
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 469

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/purecloudplatformclientv2/models/document.rb', line 316

def valid?
  allowed_values = ["DOCUMENT", "FAX", "RECORDING"]
  if @system_type && !allowed_values.include?(@system_type)
    return false
  end
  allowed_values = ["SINGLE_PUT", "MULTIPART_POST"]
  if @upload_method && !allowed_values.include?(@upload_method)
    return false
  end
  allowed_values = ["NONE", "LIMITED", "PUBLIC"]
  if @sharing_status && !allowed_values.include?(@sharing_status)
    return false
  end
end