class PureCloud::CallHistoryConversation

Attributes

direction[RW]

The direction of the call relating to the current user

had_cobrowse[RW]

Did this conversation have a cobrowse session

had_screen_share[RW]

Did this conversation have a screen share session

id[RW]

The globally unique identifier for the object.

missed_call[RW]

Did the user not answer this conversation

name[RW]
participants[RW]

The list of participants involved in the conversation.

self_uri[RW]

The URI for this object

start_time[RW]

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

was_callback[RW]

Was this conversation a callback

was_conference[RW]

Was this conversation a conference

was_outbound_campaign[RW]

Was this conversation associated with an outbound campaign

went_to_voicemail[RW]

Did the call end in the current user's voicemail

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/call_history_conversation.rb, line 60
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'participants' => :'participants',
    
    :'direction' => :'direction',
    
    :'went_to_voicemail' => :'wentToVoicemail',
    
    :'missed_call' => :'missedCall',
    
    :'start_time' => :'startTime',
    
    :'was_conference' => :'wasConference',
    
    :'was_callback' => :'wasCallback',
    
    :'had_screen_share' => :'hadScreenShare',
    
    :'had_cobrowse' => :'hadCobrowse',
    
    :'was_outbound_campaign' => :'wasOutboundCampaign',
    
    :'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/call_history_conversation.rb, line 127
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?(:'participants')
    
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
    
    
  
  end

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'wasOutboundCampaign')
    
    
    self.was_outbound_campaign = attributes[:'wasOutboundCampaign']
    
  
  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/call_history_conversation.rb, line 93
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'participants' => :'Array<CallHistoryParticipant>',
    
    :'direction' => :'String',
    
    :'went_to_voicemail' => :'BOOLEAN',
    
    :'missed_call' => :'BOOLEAN',
    
    :'start_time' => :'DateTime',
    
    :'was_conference' => :'BOOLEAN',
    
    :'was_callback' => :'BOOLEAN',
    
    :'had_screen_share' => :'BOOLEAN',
    
    :'had_cobrowse' => :'BOOLEAN',
    
    :'was_outbound_campaign' => :'BOOLEAN',
    
    :'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/call_history_conversation.rb, line 404
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      participants == o.participants &&
      direction == o.direction &&
      went_to_voicemail == o.went_to_voicemail &&
      missed_call == o.missed_call &&
      start_time == o.start_time &&
      was_conference == o.was_conference &&
      was_callback == o.was_callback &&
      had_screen_share == o.had_screen_share &&
      had_cobrowse == o.had_cobrowse &&
      was_outbound_campaign == o.was_outbound_campaign &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/call_history_conversation.rb, line 454
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/call_history_conversation.rb, line 514
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/call_history_conversation.rb, line 435
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). @param [Object] direction Object to be assigned

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

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

# File lib/purecloudplatformclientv2/models/call_history_conversation.rb, line 424
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/call_history_conversation.rb, line 430
def hash
  [id, name, participants, direction, went_to_voicemail, missed_call, start_time, was_conference, was_callback, had_screen_share, had_cobrowse, was_outbound_campaign, 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/call_history_conversation.rb, line 257
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/call_history_conversation.rb, line 497
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/call_history_conversation.rb, line 502
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/call_history_conversation.rb, line 492
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/call_history_conversation.rb, line 266
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["inbound", "outbound"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end