class PureCloud::Queue

Attributes

acw_settings[RW]

The ACW settings for the queue.

bullseye[RW]

The bulls-eye settings for the queue.

calling_party_name[RW]

The name to use for caller identification for outbound calls from this queue.

calling_party_number[RW]

The phone number to use for caller identification for outbound calls from this queue.

created_by[RW]
created_by_app[RW]
date_created[RW]

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_modified[RW]

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

description[RW]
id[RW]

The globally unique identifier for the object.

media_settings[RW]

The media settings for the queue.

member_count[RW]
modified_by[RW]
modified_by_app[RW]
name[RW]
outbound_email_address[RW]
queue_flow[RW]

The in-queue flow to use for conversations waiting in queue.

self_uri[RW]

The URI for this object

skill_evaluation_method[RW]

The skill evaluation method to use when routing conversations.

state[RW]
version[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/queue.rb, line 75
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',
    
    :'media_settings' => :'mediaSettings',
    
    :'bullseye' => :'bullseye',
    
    :'acw_settings' => :'acwSettings',
    
    :'skill_evaluation_method' => :'skillEvaluationMethod',
    
    :'queue_flow' => :'queueFlow',
    
    :'calling_party_name' => :'callingPartyName',
    
    :'calling_party_number' => :'callingPartyNumber',
    
    :'outbound_email_address' => :'outboundEmailAddress',
    
    :'member_count' => :'memberCount',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/queue.rb, line 151
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'modifiedBy']
    self.modified_by = attributes[:'modifiedBy']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'modifiedByApp']
    self.modified_by_app = attributes[:'modifiedByApp']
  end
  
  if attributes[:'createdByApp']
    self.created_by_app = attributes[:'createdByApp']
  end
  
  if attributes[:'mediaSettings']
    if (value = attributes[:'mediaSettings']).is_a?(Array)
      self.media_settings = value
    end
  end
  
  if attributes[:'bullseye']
    self.bullseye = attributes[:'bullseye']
  end
  
  if attributes[:'acwSettings']
    self.acw_settings = attributes[:'acwSettings']
  end
  
  if attributes[:'skillEvaluationMethod']
    self.skill_evaluation_method = attributes[:'skillEvaluationMethod']
  end
  
  if attributes[:'queueFlow']
    self.queue_flow = attributes[:'queueFlow']
  end
  
  if attributes[:'callingPartyName']
    self.calling_party_name = attributes[:'callingPartyName']
  end
  
  if attributes[:'callingPartyNumber']
    self.calling_party_number = attributes[:'callingPartyNumber']
  end
  
  if attributes[:'outboundEmailAddress']
    self.outbound_email_address = attributes[:'outboundEmailAddress']
  end
  
  if attributes[:'memberCount']
    self.member_count = attributes[:'memberCount']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/queue.rb, line 124
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',
    :'media_settings' => :'Hash<String, MediaSetting>',
    :'bullseye' => :'Bullseye',
    :'acw_settings' => :'AcwSettings',
    :'skill_evaluation_method' => :'String',
    :'queue_flow' => :'UriReference',
    :'calling_party_name' => :'String',
    :'calling_party_number' => :'String',
    :'outbound_email_address' => :'QueueEmailAddress',
    :'member_count' => :'Integer',
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/queue.rb, line 265
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 &&
      media_settings == o.media_settings &&
      bullseye == o.bullseye &&
      acw_settings == o.acw_settings &&
      skill_evaluation_method == o.skill_evaluation_method &&
      queue_flow == o.queue_flow &&
      calling_party_name == o.calling_party_name &&
      calling_party_number == o.calling_party_number &&
      outbound_email_address == o.outbound_email_address &&
      member_count == o.member_count &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/queue.rb, line 321
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/purecloud/models/queue.rb, line 381
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/purecloud/models/queue.rb, line 302
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

# File lib/purecloud/models/queue.rb, line 292
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/queue.rb, line 297
def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, outbound_email_address, member_count, self_uri].hash
end
skill_evaluation_method=(skill_evaluation_method) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/queue.rb, line 256
def skill_evaluation_method=(skill_evaluation_method)
  allowed_values = ["NONE", "BEST", "ALL"]
  if skill_evaluation_method && !allowed_values.include?(skill_evaluation_method)
    fail "invalid value for 'skill_evaluation_method', must be one of #{allowed_values}"
  end
  @skill_evaluation_method = skill_evaluation_method
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/queue.rb, line 247
def state=(state)
  allowed_values = ["active", "inactive", "deleted"]
  if state && !allowed_values.include?(state)
    fail "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/purecloud/models/queue.rb, line 364
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/queue.rb, line 369
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/purecloud/models/queue.rb, line 359
def to_s
  to_hash.to_s
end