class PureCloud::ContactList

Attributes

attempt_limits[RW]

the associated AttemptLimits

column_names[RW]

the contact column names

date_created[RW]

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

date_modified[RW]

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

id[RW]

The globally unique identifier for the object.

import_status[RW]

the status of the import process

name[RW]
phone_columns[RW]

the columns containing phone numbers

preview_mode_accepted_values[RW]

list of user-defined values indicating the contact is to be dialed in preview mode only

preview_mode_column_name[RW]

the name of the column that holds the indicators for contacts that are to be dialed in preview mode only

self_uri[RW]

The URI for this object

size[RW]

the number of contacts in the contact list

version[RW]

Required for updates, must match the version number of the most recent update

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/contact_list.rb, line 60
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'version' => :'version',
    
    :'column_names' => :'columnNames',
    
    :'phone_columns' => :'phoneColumns',
    
    :'import_status' => :'importStatus',
    
    :'preview_mode_column_name' => :'previewModeColumnName',
    
    :'preview_mode_accepted_values' => :'previewModeAcceptedValues',
    
    :'size' => :'size',
    
    :'attempt_limits' => :'attemptLimits',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/contact_list.rb, line 112
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[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'columnNames']
    if (value = attributes[:'columnNames']).is_a?(Array)
      self.column_names = value
    end
  end
  
  if attributes[:'phoneColumns']
    if (value = attributes[:'phoneColumns']).is_a?(Array)
      self.phone_columns = value
    end
  end
  
  if attributes[:'importStatus']
    self.import_status = attributes[:'importStatus']
  end
  
  if attributes[:'previewModeColumnName']
    self.preview_mode_column_name = attributes[:'previewModeColumnName']
  end
  
  if attributes[:'previewModeAcceptedValues']
    if (value = attributes[:'previewModeAcceptedValues']).is_a?(Array)
      self.preview_mode_accepted_values = value
    end
  end
  
  if attributes[:'size']
    self.size = attributes[:'size']
  end
  
  if attributes[:'attemptLimits']
    self.attempt_limits = attributes[:'attemptLimits']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/contact_list.rb, line 93
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'version' => :'Integer',
    :'column_names' => :'Array<String>',
    :'phone_columns' => :'Array<ContactPhoneNumberColumn>',
    :'import_status' => :'ImportStatus',
    :'preview_mode_column_name' => :'String',
    :'preview_mode_accepted_values' => :'Array<String>',
    :'size' => :'Integer',
    :'attempt_limits' => :'UriReference',
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/contact_list.rb, line 180
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      version == o.version &&
      column_names == o.column_names &&
      phone_columns == o.phone_columns &&
      import_status == o.import_status &&
      preview_mode_column_name == o.preview_mode_column_name &&
      preview_mode_accepted_values == o.preview_mode_accepted_values &&
      size == o.size &&
      attempt_limits == o.attempt_limits &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/contact_list.rb, line 228
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/contact_list.rb, line 288
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/contact_list.rb, line 209
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/contact_list.rb, line 199
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/contact_list.rb, line 204
def hash
  [id, name, date_created, date_modified, version, column_names, phone_columns, import_status, preview_mode_column_name, preview_mode_accepted_values, size, attempt_limits, self_uri].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/contact_list.rb, line 271
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/contact_list.rb, line 276
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/contact_list.rb, line 266
def to_s
  to_hash.to_s
end