class PureCloud::SocialConversationNotificationSocialMediaParticipant

Attributes

address[RW]
attributes[RW]
connected_time[RW]
direction[RW]
disconnect_type[RW]
end_time[RW]
error_info[RW]
external_contact[RW]
external_organization[RW]
held[RW]
id[RW]
name[RW]
preview_text[RW]
provider[RW]
purpose[RW]
queue[RW]
script[RW]
social_media_hub[RW]
social_media_id[RW]
social_user_name[RW]
start_hold_time[RW]
start_time[RW]
state[RW]
user[RW]
wrapup[RW]
wrapup_prompt[RW]
wrapup_required[RW]
wrapup_skipped[RW]
wrapup_timeout_ms[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 80
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'address' => :'address',
    
    :'start_time' => :'startTime',
    
    :'connected_time' => :'connectedTime',
    
    :'end_time' => :'endTime',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'purpose' => :'purpose',
    
    :'state' => :'state',
    
    :'direction' => :'direction',
    
    :'disconnect_type' => :'disconnectType',
    
    :'held' => :'held',
    
    :'wrapup_required' => :'wrapupRequired',
    
    :'wrapup_prompt' => :'wrapupPrompt',
    
    :'user' => :'user',
    
    :'queue' => :'queue',
    
    :'attributes' => :'attributes',
    
    :'error_info' => :'errorInfo',
    
    :'script' => :'script',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'provider' => :'provider',
    
    :'external_contact' => :'externalContact',
    
    :'external_organization' => :'externalOrganization',
    
    :'wrapup' => :'wrapup',
    
    :'social_media_id' => :'socialMediaId',
    
    :'social_media_hub' => :'socialMediaHub',
    
    :'social_user_name' => :'socialUserName',
    
    :'preview_text' => :'previewText'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 180
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[:'address']
    self.address = attributes[:'address']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'purpose']
    self.purpose = attributes[:'purpose']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  end
  
  if attributes[:'wrapupRequired']
    self.wrapup_required = attributes[:'wrapupRequired']
  end
  
  if attributes[:'wrapupPrompt']
    self.wrapup_prompt = attributes[:'wrapupPrompt']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'errorInfo']
    self.error_info = attributes[:'errorInfo']
  end
  
  if attributes[:'script']
    self.script = attributes[:'script']
  end
  
  if attributes[:'wrapupTimeoutMs']
    self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs']
  end
  
  if attributes[:'wrapupSkipped']
    self.wrapup_skipped = attributes[:'wrapupSkipped']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
  if attributes[:'externalContact']
    self.external_contact = attributes[:'externalContact']
  end
  
  if attributes[:'externalOrganization']
    self.external_organization = attributes[:'externalOrganization']
  end
  
  if attributes[:'wrapup']
    self.wrapup = attributes[:'wrapup']
  end
  
  if attributes[:'socialMediaId']
    self.social_media_id = attributes[:'socialMediaId']
  end
  
  if attributes[:'socialMediaHub']
    self.social_media_hub = attributes[:'socialMediaHub']
  end
  
  if attributes[:'socialUserName']
    self.social_user_name = attributes[:'socialUserName']
  end
  
  if attributes[:'previewText']
    self.preview_text = attributes[:'previewText']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 145
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'address' => :'String',
    :'start_time' => :'DateTime',
    :'connected_time' => :'DateTime',
    :'end_time' => :'DateTime',
    :'start_hold_time' => :'DateTime',
    :'purpose' => :'String',
    :'state' => :'String',
    :'direction' => :'String',
    :'disconnect_type' => :'String',
    :'held' => :'BOOLEAN',
    :'wrapup_required' => :'BOOLEAN',
    :'wrapup_prompt' => :'String',
    :'user' => :'DocumentDataV2NotificationCreatedBy',
    :'queue' => :'SocialConversationNotificationUriReference',
    :'attributes' => :'Hash<String, String>',
    :'error_info' => :'SocialConversationNotificationErrorInfo',
    :'script' => :'SocialConversationNotificationUriReference',
    :'wrapup_timeout_ms' => :'Integer',
    :'wrapup_skipped' => :'BOOLEAN',
    :'provider' => :'String',
    :'external_contact' => :'SocialConversationNotificationUriReference',
    :'external_organization' => :'SocialConversationNotificationUriReference',
    :'wrapup' => :'ConversationNotificationWrapup',
    :'social_media_id' => :'String',
    :'social_media_hub' => :'String',
    :'social_user_name' => :'String',
    :'preview_text' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 335
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      address == o.address &&
      start_time == o.start_time &&
      connected_time == o.connected_time &&
      end_time == o.end_time &&
      start_hold_time == o.start_hold_time &&
      purpose == o.purpose &&
      state == o.state &&
      direction == o.direction &&
      disconnect_type == o.disconnect_type &&
      held == o.held &&
      wrapup_required == o.wrapup_required &&
      wrapup_prompt == o.wrapup_prompt &&
      user == o.user &&
      queue == o.queue &&
      attributes == o.attributes &&
      error_info == o.error_info &&
      script == o.script &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      wrapup_skipped == o.wrapup_skipped &&
      provider == o.provider &&
      external_contact == o.external_contact &&
      external_organization == o.external_organization &&
      wrapup == o.wrapup &&
      social_media_id == o.social_media_id &&
      social_media_hub == o.social_media_hub &&
      social_user_name == o.social_user_name &&
      preview_text == o.preview_text
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 399
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/social_conversation_notification_social_media_participant.rb, line 459
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/social_conversation_notification_social_media_participant.rb, line 380
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
direction=(direction) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 317
def direction=(direction)
  allowed_values = ["inbound", "outbound"]
  if direction && !allowed_values.include?(direction)
    fail "invalid value for 'direction', must be one of #{allowed_values}"
  end
  @direction = direction
end
disconnect_type=(disconnect_type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 326
def disconnect_type=(disconnect_type)
  allowed_values = ["endpoint", "client", "system", "transfer", "timeout", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam", "uncallable"]
  if disconnect_type && !allowed_values.include?(disconnect_type)
    fail "invalid value for 'disconnect_type', must be one of #{allowed_values}"
  end
  @disconnect_type = disconnect_type
end
eql?(o) click to toggle source

@see the `==` method

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

Calculate hash code according to all attributes.

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 375
def hash
  [id, name, address, start_time, connected_time, end_time, start_hold_time, purpose, state, direction, disconnect_type, held, wrapup_required, wrapup_prompt, user, queue, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, provider, external_contact, external_organization, wrapup, social_media_id, social_media_hub, social_user_name, preview_text].hash
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 308
def state=(state)
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "scheduled", "none"]
  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/social_conversation_notification_social_media_participant.rb, line 442
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/social_conversation_notification_social_media_participant.rb, line 447
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/social_conversation_notification_social_media_participant.rb, line 437
def to_s
  to_hash.to_s
end