Class: PureCloud::DocumentDataNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentDataNotification

Returns a new instance of DocumentDataNotification.



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
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/purecloud/models/document_data_notification.rb', line 115

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[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'workspace']
    self.workspace = attributes[:'workspace']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'contentType']
    self.content_type = attributes[:'contentType']
  end
  
  if attributes[:'contentLength']
    self.content_length = attributes[:'contentLength']
  end
  
  if attributes[:'filename']
    self.filename = attributes[:'filename']
  end
  
  if attributes[:'fileName']
    self.file_name = attributes[:'fileName']
  end
  
  if attributes[:'changeNumber']
    self.change_number = attributes[:'changeNumber']
  end
  
  if attributes[:'dateUploaded']
    self.date_uploaded = attributes[:'dateUploaded']
  end
  
  if attributes[:'uploadedBy']
    self.uploaded_by = attributes[:'uploadedBy']
  end
  
  if attributes[:'lockInfo']
    self.lock_info = attributes[:'lockInfo']
  end
  
  if attributes[:'pageCount']
    self.page_count = attributes[:'pageCount']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#change_numberObject

Returns the value of attribute change_number.



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

def change_number
  @change_number
end

#content_lengthObject

Returns the value of attribute content_length.



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

def content_length
  @content_length
end

#content_typeObject

Returns the value of attribute content_type.



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

def content_type
  @content_type
end

#created_byObject

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#date_createdObject

Returns the value of attribute date_created.



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

def date_created
  @date_created
end

#date_modifiedObject

Returns the value of attribute date_modified.



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

def date_modified
  @date_modified
end

#date_uploadedObject

Returns the value of attribute date_uploaded.



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

def date_uploaded
  @date_uploaded
end

#file_nameObject

Returns the value of attribute file_name.



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

def file_name
  @file_name
end

#filenameObject

Returns the value of attribute filename.



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

def filename
  @filename
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#lock_infoObject

Returns the value of attribute lock_info.



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

def lock_info
  @lock_info
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#page_countObject

Returns the value of attribute page_count.



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

def page_count
  @page_count
end

#self_uriObject

Returns the value of attribute self_uri.



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

def self_uri
  @self_uri
end

#uploaded_byObject

Returns the value of attribute uploaded_by.



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

def uploaded_by
  @uploaded_by
end

#workspaceObject

Returns the value of attribute workspace.



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

def workspace
  @workspace
end

Class Method Details

.attribute_mapObject

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



54
55
56
57
58
59
60
61
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
# File 'lib/purecloud/models/document_data_notification.rb', line 54

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'workspace' => :'workspace',
    
    :'created_by' => :'createdBy',
    
    :'content_type' => :'contentType',
    
    :'content_length' => :'contentLength',
    
    :'filename' => :'filename',
    
    :'file_name' => :'fileName',
    
    :'change_number' => :'changeNumber',
    
    :'date_uploaded' => :'dateUploaded',
    
    :'uploaded_by' => :'uploadedBy',
    
    :'lock_info' => :'lockInfo',
    
    :'page_count' => :'pageCount',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/purecloud/models/document_data_notification.rb', line 93

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'String',
    :'date_modified' => :'String',
    :'workspace' => :'DocumentDataNotificationWorkspace',
    :'created_by' => :'DocumentDataNotificationCreatedBy',
    :'content_type' => :'String',
    :'content_length' => :'Integer',
    :'filename' => :'String',
    :'file_name' => :'String',
    :'change_number' => :'Integer',
    :'date_uploaded' => :'String',
    :'uploaded_by' => :'DocumentDataNotificationUserData',
    :'lock_info' => :'DocumentDataNotificationLockInfo',
    :'page_count' => :'Integer',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/purecloud/models/document_data_notification.rb', line 189

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 &&
      workspace == o.workspace &&
      created_by == o.created_by &&
      content_type == o.content_type &&
      content_length == o.content_length &&
      filename == o.filename &&
      file_name == o.file_name &&
      change_number == o.change_number &&
      date_uploaded == o.date_uploaded &&
      uploaded_by == o.uploaded_by &&
      lock_info == o.lock_info &&
      page_count == o.page_count &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



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

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



300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/purecloud/models/document_data_notification.rb', line 300

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/purecloud/models/document_data_notification.rb', line 221

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


211
212
213
# File 'lib/purecloud/models/document_data_notification.rb', line 211

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



216
217
218
# File 'lib/purecloud/models/document_data_notification.rb', line 216

def hash
  [id, name, date_created, date_modified, workspace, created_by, content_type, content_length, filename, file_name, change_number, date_uploaded, uploaded_by, lock_info, page_count, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



283
284
285
# File 'lib/purecloud/models/document_data_notification.rb', line 283

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



288
289
290
291
292
293
294
295
296
# File 'lib/purecloud/models/document_data_notification.rb', line 288

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_sObject



278
279
280
# File 'lib/purecloud/models/document_data_notification.rb', line 278

def to_s
  to_hash.to_s
end