Class: PureCloud::FaxDocument

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/fax_document.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FaxDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 149

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

  
  if attributes.has_key?(:'dateModified')
    
    
    self.date_modified = attributes[:'dateModified']
    
  
  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?(:'contentType')
    
    
    self.content_type = attributes[:'contentType']
    
  
  end

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

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

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

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

#caller_address ⇒ Object

Returns the value of attribute caller_address.



48
49
50
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 48

def caller_address
  @caller_address
end

#content_length ⇒ Object

Returns the value of attribute content_length.



40
41
42
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 40

def content_length
  @content_length
end

#content_type ⇒ Object

Returns the value of attribute content_type.



38
39
40
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 38

def content_type
  @content_type
end

#content_uri ⇒ Object

Returns the value of attribute content_uri.



32
33
34
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 32

def content_uri
  @content_uri
end

#created_by ⇒ Object

Returns the value of attribute created_by.



36
37
38
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 36

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



27
28
29
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 27

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



30
31
32
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 30

def date_modified
  @date_modified
end

#download_sharing_uri ⇒ Object

Returns the value of attribute download_sharing_uri.



56
57
58
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 56

def download_sharing_uri
  @download_sharing_uri
end

#filename ⇒ Object

Returns the value of attribute filename.



42
43
44
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 42

def filename
  @filename
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 22

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 24

def name
  @name
end

#page_count ⇒ Object

Returns the value of attribute page_count.



46
47
48
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 46

def page_count
  @page_count
end

#read ⇒ Object

Returns the value of attribute read.



44
45
46
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 44

def read
  @read
end

#receiver_address ⇒ Object

Returns the value of attribute receiver_address.



50
51
52
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 50

def receiver_address
  @receiver_address
end

#self_uri ⇒ Object

The URI for this object



59
60
61
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 59

def self_uri
  @self_uri
end

#sharing_uri ⇒ Object

Returns the value of attribute sharing_uri.



54
55
56
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 54

def sharing_uri
  @sharing_uri
end

#thumbnails ⇒ Object

Returns the value of attribute thumbnails.



52
53
54
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 52

def thumbnails
  @thumbnails
end

#workspace ⇒ Object

Returns the value of attribute workspace.



34
35
36
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 34

def workspace
  @workspace
end

Class Method Details

.attribute_map ⇒ Object

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



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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 62

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'content_uri' => :'contentUri',
    
    :'workspace' => :'workspace',
    
    :'created_by' => :'createdBy',
    
    :'content_type' => :'contentType',
    
    :'content_length' => :'contentLength',
    
    :'filename' => :'filename',
    
    :'read' => :'read',
    
    :'page_count' => :'pageCount',
    
    :'caller_address' => :'callerAddress',
    
    :'receiver_address' => :'receiverAddress',
    
    :'thumbnails' => :'thumbnails',
    
    :'sharing_uri' => :'sharingUri',
    
    :'download_sharing_uri' => :'downloadSharingUri',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 105

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'content_uri' => :'String',
    
    :'workspace' => :'UriReference',
    
    :'created_by' => :'UriReference',
    
    :'content_type' => :'String',
    
    :'content_length' => :'Integer',
    
    :'filename' => :'String',
    
    :'read' => :'BOOLEAN',
    
    :'page_count' => :'Integer',
    
    :'caller_address' => :'String',
    
    :'receiver_address' => :'String',
    
    :'thumbnails' => :'Array<DocumentThumbnail>',
    
    :'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



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 502

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      content_uri == o.content_uri &&
      workspace == o.workspace &&
      created_by == o.created_by &&
      content_type == o.content_type &&
      content_length == o.content_length &&
      filename == o.filename &&
      read == o.read &&
      page_count == o.page_count &&
      caller_address == o.caller_address &&
      receiver_address == o.receiver_address &&
      thumbnails == o.thumbnails &&
      sharing_uri == o.sharing_uri &&
      download_sharing_uri == o.download_sharing_uri &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 557

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



617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 617

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



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 538

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


527
528
529
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 527

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



533
534
535
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 533

def hash
  [id, name, date_created, date_modified, content_uri, workspace, created_by, content_type, content_length, filename, read, page_count, caller_address, receiver_address, thumbnails, 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



324
325
326
327
328
329
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 324

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



600
601
602
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 600

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



605
606
607
608
609
610
611
612
613
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 605

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 



595
596
597
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 595

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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/purecloudclient_v2a/models/fax_document.rb', line 333

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end