class PureCloud::DocumentUpdate
Attributes
The name of the document
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/document_update.rb, line 92 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?(:'changeNumber') self.change_number = attributes[:'changeNumber'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'read') self.read = attributes[:'read'] end if attributes.has_key?(:'addTags') if (value = attributes[:'addTags']).is_a?(Array) self.add_tags = value end end if attributes.has_key?(:'removeTags') if (value = attributes[:'removeTags']).is_a?(Array) self.remove_tags = value end end if attributes.has_key?(:'addTagIds') if (value = attributes[:'addTagIds']).is_a?(Array) self.add_tag_ids = value end end if attributes.has_key?(:'removeTagIds') if (value = attributes[:'removeTagIds']).is_a?(Array) self.remove_tag_ids = value end end if attributes.has_key?(:'updateAttributes') if (value = attributes[:'updateAttributes']).is_a?(Array) self.update_attributes = value end end if attributes.has_key?(:'removeAttributes') if (value = attributes[:'removeAttributes']).is_a?(Array) self.remove_attributes = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/document_update.rb, line 298 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
# File lib/purecloudplatformclientv2/models/document_update.rb, line 344 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
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/document_update.rb, line 404 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 the object from hash
# File lib/purecloudplatformclientv2/models/document_update.rb, line 325 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/document_update.rb, line 314 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/document_update.rb, line 320 def hash [change_number, name, read, add_tags, remove_tags, add_tag_ids, remove_tag_ids, update_attributes, remove_attributes].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/document_update.rb, line 196 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/document_update.rb, line 392 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
# File lib/purecloudplatformclientv2/models/document_update.rb, line 382 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/document_update.rb, line 205 def valid? if @name.nil? return false end end