class PureCloud::LocationUpdateDefinition
Attributes
Address
of the location
The user id of the location contact
Emergency number for the location
The name of the Location
. Required for creates, not required for updates
Notes for the location
A list of ancestor ids
Current activity status of the location.
Current version of the location
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 46 def self.attribute_map { :'name' => :'name', :'version' => :'version', :'state' => :'state', :'path' => :'path', :'notes' => :'notes', :'contact_user' => :'contactUser', :'emergency_number' => :'emergencyNumber', :'address' => :'address' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 93 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'path') if (value = attributes[:'path']).is_a?(Array) self.path = value end end if attributes.has_key?(:'notes') self.notes = attributes[:'notes'] end if attributes.has_key?(:'contactUser') self.contact_user = attributes[:'contactUser'] end if attributes.has_key?(:'emergencyNumber') self.emergency_number = attributes[:'emergencyNumber'] end if attributes.has_key?(:'address') self.address = attributes[:'address'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 69 def self.swagger_types { :'name' => :'String', :'version' => :'Integer', :'state' => :'String', :'path' => :'Array<String>', :'notes' => :'String', :'contact_user' => :'String', :'emergency_number' => :'LocationEmergencyNumber', :'address' => :'LocationAddress' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 290 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && version == o.version && state == o.state && path == o.path && notes == o.notes && contact_user == o.contact_user && emergency_number == o.emergency_number && address == o.address end
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 335 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/location_update_definition.rb, line 395 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/location_update_definition.rb, line 316 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/location_update_definition.rb, line 305 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 311 def hash [name, version, state, path, notes, contact_user, emergency_number, address].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/location_update_definition.rb, line 178 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 252 def state=(state) allowed_values = ["active", "deleted"] if state && !allowed_values.include?(state) fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}." end @state = state end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/location_update_definition.rb, line 383 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/location_update_definition.rb, line 373 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/location_update_definition.rb, line 187 def valid? if @name.nil? return false end if @version.nil? return false end allowed_values = ["active", "deleted"] if @state && !allowed_values.include?(@state) return false end end