Class: PureCloud::DocumentUpdate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentUpdate

Returns a new instance of DocumentUpdate.



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

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[:'changeNumber']
    self.change_number = attributes[:'changeNumber']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'read']
    self.read = attributes[:'read']
  end
  
  if attributes[:'addTags']
    if (value = attributes[:'addTags']).is_a?(Array)
      self.add_tags = value
    end
  end
  
  if attributes[:'removeTags']
    if (value = attributes[:'removeTags']).is_a?(Array)
      self.remove_tags = value
    end
  end
  
  if attributes[:'addTagIds']
    if (value = attributes[:'addTagIds']).is_a?(Array)
      self.add_tag_ids = value
    end
  end
  
  if attributes[:'removeTagIds']
    if (value = attributes[:'removeTagIds']).is_a?(Array)
      self.remove_tag_ids = value
    end
  end
  
  if attributes[:'updateAttributes']
    if (value = attributes[:'updateAttributes']).is_a?(Array)
      self.update_attributes = value
    end
  end
  
  if attributes[:'removeAttributes']
    if (value = attributes[:'removeAttributes']).is_a?(Array)
      self.remove_attributes = value
    end
  end
  
end

Instance Attribute Details

#add_tag_ids ⇒ Object

Returns the value of attribute add_tag_ids.



32
33
34
 
# File 'lib/purecloud/models/document_update.rb', line 32

def add_tag_ids
  @add_tag_ids
end

#add_tags ⇒ Object

Returns the value of attribute add_tags.



28
29
30
 
# File 'lib/purecloud/models/document_update.rb', line 28

def add_tags
  @add_tags
end

#change_number ⇒ Object

Returns the value of attribute change_number.



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

def change_number
  @change_number
end

#name ⇒ Object

The name of the document



24
25
26
 
# File 'lib/purecloud/models/document_update.rb', line 24

def name
  @name
end

#read ⇒ Object

Returns the value of attribute read.



26
27
28
 
# File 'lib/purecloud/models/document_update.rb', line 26

def read
  @read
end

#remove_attributes ⇒ Object

Returns the value of attribute remove_attributes.



38
39
40
 
# File 'lib/purecloud/models/document_update.rb', line 38

def remove_attributes
  @remove_attributes
end

#remove_tag_ids ⇒ Object

Returns the value of attribute remove_tag_ids.



34
35
36
 
# File 'lib/purecloud/models/document_update.rb', line 34

def remove_tag_ids
  @remove_tag_ids
end

#remove_tags ⇒ Object

Returns the value of attribute remove_tags.



30
31
32
 
# File 'lib/purecloud/models/document_update.rb', line 30

def remove_tags
  @remove_tags
end

#update_attributes ⇒ Object

Returns the value of attribute update_attributes.



36
37
38
 
# File 'lib/purecloud/models/document_update.rb', line 36

def update_attributes
  @update_attributes
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/purecloud/models/document_update.rb', line 41

def self.attribute_map
  {
    
    :'change_number' => :'changeNumber',
    
    :'name' => :'name',
    
    :'read' => :'read',
    
    :'add_tags' => :'addTags',
    
    :'remove_tags' => :'removeTags',
    
    :'add_tag_ids' => :'addTagIds',
    
    :'remove_tag_ids' => :'removeTagIds',
    
    :'update_attributes' => :'updateAttributes',
    
    :'remove_attributes' => :'removeAttributes'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/purecloud/models/document_update.rb', line 66

def self.swagger_types
  {
    :'change_number' => :'Integer',
    :'name' => :'String',
    :'read' => :'BOOLEAN',
    :'add_tags' => :'Array<String>',
    :'remove_tags' => :'Array<String>',
    :'add_tag_ids' => :'Array<String>',
    :'remove_tag_ids' => :'Array<String>',
    :'update_attributes' => :'Array<DocumentAttribute>',
    :'remove_attributes' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/purecloud/models/document_update.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      change_number == o.change_number &&
      name == o.name &&
      read == o.read &&
      add_tags == o.add_tags &&
      remove_tags == o.remove_tags &&
      add_tag_ids == o.add_tag_ids &&
      remove_tag_ids == o.remove_tag_ids &&
      update_attributes == o.update_attributes &&
      remove_attributes == o.remove_attributes
end

#_deserialize(type, value) ⇒ Object 



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

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/purecloud/models/document_update.rb', line 243

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/purecloud/models/document_update.rb', line 164

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


154
155
156
 
# File 'lib/purecloud/models/document_update.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



159
160
161
 
# File 'lib/purecloud/models/document_update.rb', line 159

def hash
  [change_number, name, read, add_tags, remove_tags, add_tag_ids, remove_tag_ids, update_attributes, remove_attributes].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



226
227
228
 
# File 'lib/purecloud/models/document_update.rb', line 226

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



231
232
233
234
235
236
237
238
239
 
# File 'lib/purecloud/models/document_update.rb', line 231

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 



221
222
223
 
# File 'lib/purecloud/models/document_update.rb', line 221

def to_s
  to_hash.to_s
end