class PureCloud::Phone

Attributes

capabilities[RW]
created_by[RW]

The ID of the user that created the resource.

created_by_app[RW]

The application that created the resource.

date_created[RW]

The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_modified[RW]

The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

description[RW]

The resource's description.

id[RW]

The globally unique identifier for the object.

line_base_settings[RW]
lines[RW]

Lines

modified_by[RW]

The ID of the user that last modified the resource.

modified_by_app[RW]

The application that last modified the resource.

name[RW]

The name of the entity.

phone_base_settings[RW]

Phone Base Settings

phone_meta_base[RW]
primary_edge[RW]
properties[RW]
secondary_edge[RW]
secondary_status[RW]

The status of the phone and lines from the secondary Edge.

self_uri[RW]

The URI for this object

site[RW]

The site associated to the phone.

state[RW]

Indicates if the resource is active, inactive, or deleted.

status[RW]

The status of the phone and lines from the primary Edge.

user_agent_info[RW]

User Agent Information for this phone. This includes model, firmware version, and manufacturer.

version[RW]

The current version of the resource.

web_rtc_user[RW]

This is the user associated with a WebRTC type phone. It is required for all WebRTC phones.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/phone.rb, line 91
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'version' => :'version',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'created_by' => :'createdBy',
    
    :'state' => :'state',
    
    :'modified_by_app' => :'modifiedByApp',
    
    :'created_by_app' => :'createdByApp',
    
    :'site' => :'site',
    
    :'phone_base_settings' => :'phoneBaseSettings',
    
    :'line_base_settings' => :'lineBaseSettings',
    
    :'phone_meta_base' => :'phoneMetaBase',
    
    :'lines' => :'lines',
    
    :'status' => :'status',
    
    :'secondary_status' => :'secondaryStatus',
    
    :'user_agent_info' => :'userAgentInfo',
    
    :'properties' => :'properties',
    
    :'capabilities' => :'capabilities',
    
    :'web_rtc_user' => :'webRtcUser',
    
    :'primary_edge' => :'primaryEdge',
    
    :'secondary_edge' => :'secondaryEdge',
    
    :'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/phone.rb, line 206
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?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'secondaryEdge')
    
    
    self.secondary_edge = attributes[:'secondaryEdge']
    
  
  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/phone.rb, line 148
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'version' => :'Integer',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'modified_by' => :'String',
    
    :'created_by' => :'String',
    
    :'state' => :'String',
    
    :'modified_by_app' => :'String',
    
    :'created_by_app' => :'String',
    
    :'site' => :'DomainEntityRef',
    
    :'phone_base_settings' => :'DomainEntityRef',
    
    :'line_base_settings' => :'DomainEntityRef',
    
    :'phone_meta_base' => :'DomainEntityRef',
    
    :'lines' => :'Array<Line>',
    
    :'status' => :'PhoneStatus',
    
    :'secondary_status' => :'PhoneStatus',
    
    :'user_agent_info' => :'UserAgentInfo',
    
    :'properties' => :'Hash<String, Object>',
    
    :'capabilities' => :'PhoneCapabilities',
    
    :'web_rtc_user' => :'DomainEntityRef',
    
    :'primary_edge' => :'Edge',
    
    :'secondary_edge' => :'Edge',
    
    :'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/phone.rb, line 721
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      state == o.state &&
      modified_by_app == o.modified_by_app &&
      created_by_app == o.created_by_app &&
      site == o.site &&
      phone_base_settings == o.phone_base_settings &&
      line_base_settings == o.line_base_settings &&
      phone_meta_base == o.phone_meta_base &&
      lines == o.lines &&
      status == o.status &&
      secondary_status == o.secondary_status &&
      user_agent_info == o.user_agent_info &&
      properties == o.properties &&
      capabilities == o.capabilities &&
      web_rtc_user == o.web_rtc_user &&
      primary_edge == o.primary_edge &&
      secondary_edge == o.secondary_edge &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/phone.rb, line 783
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/phone.rb, line 843
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/phone.rb, line 764
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/phone.rb, line 753
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/phone.rb, line 759
def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, site, phone_base_settings, line_base_settings, phone_meta_base, lines, status, secondary_status, user_agent_info, properties, capabilities, web_rtc_user, primary_edge, secondary_edge, 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/phone.rb, line 446
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/phone.rb, line 628
def state=(state)
  allowed_values = ["active", "inactive", "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/phone.rb, line 826
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/phone.rb, line 831
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/phone.rb, line 821
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/phone.rb, line 455
def valid?
  
  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  if @site.nil?
    return false
  end

  
  
  
  
  
  if @phone_base_settings.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @lines.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end