class PureCloud::WebChatMemberInfo

Attributes

authenticated_guest[RW]

If true, the guest member is an authenticated guest.

avatar_image_url[RW]

The url to the avatar image of the member.

custom_fields[RW]

Any custom fields of information pertaining to this member.

display_name[RW]

The display name of the member.

email[RW]

The email address of the member.

first_name[RW]

The first name of the member.

id[RW]

The communicationId of this member.

join_date[RW]

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

last_name[RW]

The last name of the member.

leave_date[RW]

The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

phone_number[RW]

The phone number of the member.

role[RW]

The role of the member, one of [agent, customer, acd, workflow]

state[RW]

The connection state of this member.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/web_chat_member_info.rb, line 61
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'display_name' => :'displayName',
    
    :'first_name' => :'firstName',
    
    :'last_name' => :'lastName',
    
    :'email' => :'email',
    
    :'phone_number' => :'phoneNumber',
    
    :'avatar_image_url' => :'avatarImageUrl',
    
    :'role' => :'role',
    
    :'join_date' => :'joinDate',
    
    :'leave_date' => :'leaveDate',
    
    :'authenticated_guest' => :'authenticatedGuest',
    
    :'custom_fields' => :'customFields',
    
    :'state' => :'state'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/web_chat_member_info.rb, line 128
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?(:'displayName')
    
    
    self.display_name = attributes[:'displayName']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/web_chat_member_info.rb, line 94
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'display_name' => :'String',
    
    :'first_name' => :'String',
    
    :'last_name' => :'String',
    
    :'email' => :'String',
    
    :'phone_number' => :'String',
    
    :'avatar_image_url' => :'String',
    
    :'role' => :'String',
    
    :'join_date' => :'DateTime',
    
    :'leave_date' => :'DateTime',
    
    :'authenticated_guest' => :'BOOLEAN',
    
    :'custom_fields' => :'Hash<String, String>',
    
    :'state' => :'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/web_chat_member_info.rb, line 424
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      display_name == o.display_name &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      email == o.email &&
      phone_number == o.phone_number &&
      avatar_image_url == o.avatar_image_url &&
      role == o.role &&
      join_date == o.join_date &&
      leave_date == o.leave_date &&
      authenticated_guest == o.authenticated_guest &&
      custom_fields == o.custom_fields &&
      state == o.state
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/web_chat_member_info.rb, line 474
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/web_chat_member_info.rb, line 534
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/web_chat_member_info.rb, line 455
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/web_chat_member_info.rb, line 444
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/web_chat_member_info.rb, line 450
def hash
  [id, display_name, first_name, last_name, email, phone_number, avatar_image_url, role, join_date, leave_date, authenticated_guest, custom_fields, state].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/web_chat_member_info.rb, line 258
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
role=(role) click to toggle source

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

# File lib/purecloudplatformclientv2/models/web_chat_member_info.rb, line 377
def role=(role)
  allowed_values = ["AGENT", "CUSTOMER", "WORKFLOW", "ACD"]
  if role && !allowed_values.include?(role)
    fail ArgumentError, "invalid value for 'role', must be one of #{allowed_values}."
  end
  @role = role
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/web_chat_member_info.rb, line 411
def state=(state)
  allowed_values = ["CONNECTED", "DISCONNECTED", "ALERTING"]
  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/web_chat_member_info.rb, line 517
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/web_chat_member_info.rb, line 522
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/web_chat_member_info.rb, line 512
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/web_chat_member_info.rb, line 267
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @role.nil?
    return false
  end

  
  
  allowed_values = ["AGENT", "CUSTOMER", "WORKFLOW", "ACD"]
  if @role && !allowed_values.include?(@role)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["CONNECTED", "DISCONNECTED", "ALERTING"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
end