class PureCloud::LocationDefinition

Attributes

address[RW]
address_stored[RW]

Boolean field which states if the address has been stored for E911

address_verification_details[RW]

Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter

address_verified[RW]

Boolean field which states if the address has been verified as an actual address

contact_user[RW]

Site contact for the location entity

emergency_number[RW]

Emergency number for the location entity

floorplan_image[RW]

Floorplan images of the location entity, retrieved with ?expand=images query parameter

id[RW]

The globally unique identifier for the object.

images[RW]
name[RW]
notes[RW]

Notes for the location entity

path[RW]

A list of ancestor IDs in order

profile_image[RW]

Profile image of the location entity, retrieved with ?expand=images query parameter

self_uri[RW]

The URI for this object

state[RW]

Current state of the location entity

version[RW]

Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 67
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'contact_user' => :'contactUser',
    
    :'emergency_number' => :'emergencyNumber',
    
    :'address' => :'address',
    
    :'state' => :'state',
    
    :'notes' => :'notes',
    
    :'version' => :'version',
    
    :'path' => :'path',
    
    :'profile_image' => :'profileImage',
    
    :'floorplan_image' => :'floorplanImage',
    
    :'address_verification_details' => :'addressVerificationDetails',
    
    :'address_verified' => :'addressVerified',
    
    :'address_stored' => :'addressStored',
    
    :'images' => :'images',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 146
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?(:'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

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

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

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

  
  if attributes.has_key?(:'path')
    
    if (value = attributes[:'path']).is_a?(Array)
      self.path = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'profileImage')
    
    if (value = attributes[:'profileImage']).is_a?(Array)
      self.profile_image = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'floorplanImage')
    
    if (value = attributes[:'floorplanImage']).is_a?(Array)
      self.floorplan_image = value
    end
    
    
  
  end

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 106
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'contact_user' => :'AddressableEntityRef',
    
    :'emergency_number' => :'LocationEmergencyNumber',
    
    :'address' => :'LocationAddress',
    
    :'state' => :'String',
    
    :'notes' => :'String',
    
    :'version' => :'Integer',
    
    :'path' => :'Array<String>',
    
    :'profile_image' => :'Array<LocationImage>',
    
    :'floorplan_image' => :'Array<LocationImage>',
    
    :'address_verification_details' => :'LocationAddressVerificationDetails',
    
    :'address_verified' => :'BOOLEAN',
    
    :'address_stored' => :'BOOLEAN',
    
    :'images' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 481
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      contact_user == o.contact_user &&
      emergency_number == o.emergency_number &&
      address == o.address &&
      state == o.state &&
      notes == o.notes &&
      version == o.version &&
      path == o.path &&
      profile_image == o.profile_image &&
      floorplan_image == o.floorplan_image &&
      address_verification_details == o.address_verification_details &&
      address_verified == o.address_verified &&
      address_stored == o.address_stored &&
      images == o.images &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/location_definition.rb, line 534
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) click to toggle source

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_definition.rb, line 594
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) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 515
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 504
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 510
def hash
  [id, name, contact_user, emergency_number, address, state, notes, version, path, profile_image, floorplan_image, address_verification_details, address_verified, address_stored, images, self_uri].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 307
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 418
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
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 577
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/location_definition.rb, line 582
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() click to toggle source
# File lib/purecloudplatformclientv2/models/location_definition.rb, line 572
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_definition.rb, line 316
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end