class PureCloud::PhoneStatus

Attributes

edge[RW]

The URI of the edge that provided this status information.

edges_status[RW]

The status of the primary or secondary Edges assigned to the phone lines.

event_creation_time[RW]

Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London

id[RW]

The globally unique identifier for the object.

line_statuses[RW]

A list of LineStatus information for each of the lines of this phone

name[RW]
operational_status[RW]

The Operational Status of this phone

phone_assignment_to_edge_type[RW]

The phone status's edge assignment type.

provision[RW]

Provision information for this phone

self_uri[RW]

The URI for this object

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/phone_status.rb, line 51
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'operational_status' => :'operationalStatus',
    
    :'edges_status' => :'edgesStatus',
    
    :'event_creation_time' => :'eventCreationTime',
    
    :'provision' => :'provision',
    
    :'line_statuses' => :'lineStatuses',
    
    :'phone_assignment_to_edge_type' => :'phoneAssignmentToEdgeType',
    
    :'edge' => :'edge',
    
    :'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_status.rb, line 106
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?(:'operationalStatus')
    
    
    self.operational_status = attributes[:'operationalStatus']
    
  
  end

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

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

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

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

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

  
  if attributes.has_key?(:'edge')
    
    
    self.edge = attributes[:'edge']
    
  
  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_status.rb, line 78
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'operational_status' => :'String',
    
    :'edges_status' => :'String',
    
    :'event_creation_time' => :'String',
    
    :'provision' => :'ProvisionInfo',
    
    :'line_statuses' => :'Array<LineStatus>',
    
    :'phone_assignment_to_edge_type' => :'String',
    
    :'edge' => :'DomainEntityRef',
    
    :'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_status.rb, line 357
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      operational_status == o.operational_status &&
      edges_status == o.edges_status &&
      event_creation_time == o.event_creation_time &&
      provision == o.provision &&
      line_statuses == o.line_statuses &&
      phone_assignment_to_edge_type == o.phone_assignment_to_edge_type &&
      edge == o.edge &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/phone_status.rb, line 404
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_status.rb, line 464
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_status.rb, line 385
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
edges_status=(edges_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/phone_status.rb, line 305
def edges_status=(edges_status)
  allowed_values = ["IN_SERVICE", "MIXED_SERVICE", "OUT_OF_SERVICE", "NO_EDGES"]
  if edges_status && !allowed_values.include?(edges_status)
    fail ArgumentError, "invalid value for 'edges_status', must be one of #{allowed_values}."
  end
  @edges_status = edges_status
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/phone_status.rb, line 374
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_status.rb, line 380
def hash
  [id, name, operational_status, edges_status, event_creation_time, provision, line_statuses, phone_assignment_to_edge_type, 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_status.rb, line 209
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
operational_status=(operational_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/phone_status.rb, line 291
def operational_status=(operational_status)
  allowed_values = ["OPERATIONAL", "DEGRADED", "OFFLINE"]
  if operational_status && !allowed_values.include?(operational_status)
    fail ArgumentError, "invalid value for 'operational_status', must be one of #{allowed_values}."
  end
  @operational_status = operational_status
end
phone_assignment_to_edge_type=(phone_assignment_to_edge_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/phone_status.rb, line 334
def phone_assignment_to_edge_type=(phone_assignment_to_edge_type)
  allowed_values = ["PRIMARY", "SECONDARY"]
  if phone_assignment_to_edge_type && !allowed_values.include?(phone_assignment_to_edge_type)
    fail ArgumentError, "invalid value for 'phone_assignment_to_edge_type', must be one of #{allowed_values}."
  end
  @phone_assignment_to_edge_type = phone_assignment_to_edge_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/phone_status.rb, line 447
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_status.rb, line 452
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_status.rb, line 442
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_status.rb, line 218
def valid?
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["OPERATIONAL", "DEGRADED", "OFFLINE"]
  if @operational_status && !allowed_values.include?(@operational_status)
    return false
  end
  
  
  
  
  
  allowed_values = ["IN_SERVICE", "MIXED_SERVICE", "OUT_OF_SERVICE", "NO_EDGES"]
  if @edges_status && !allowed_values.include?(@edges_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["PRIMARY", "SECONDARY"]
  if @phone_assignment_to_edge_type && !allowed_values.include?(@phone_assignment_to_edge_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end