class PureCloud::VoicemailMessage

Attributes

audio_recording_duration_seconds[RW]

The voicemail message's audio recording duration in seconds

audio_recording_size_bytes[RW]

The voicemail message's audio recording size in bytes

caller_address[RW]

The caller address

caller_name[RW]

Optionally the name of the caller that left the voicemail message if the caller was a known user

caller_user[RW]

Optionally the user that left the voicemail message if the caller was a known user

conversation[RW]

The conversation that the voicemail message is associated with

copied_from[RW]

Represents where this voicemail message was copied from

copied_to[RW]

Represents where this voicemail has been copied to

created_date[RW]

The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

delete_retention_policy[RW]

The retention policy for this voicemail when deleted is set to true

deleted[RW]

Whether the voicemail message has been marked as deleted

deleted_date[RW]

The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

group[RW]

The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue

id[RW]

The globally unique identifier for the object.

modified_date[RW]

The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

note[RW]

An optional note

queue[RW]

The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group

read[RW]

Whether the voicemail message is marked as read

self_uri[RW]

The URI for this object

user[RW]

The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/voicemail_message.rb, line 82
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'conversation' => :'conversation',
    
    :'read' => :'read',
    
    :'audio_recording_duration_seconds' => :'audioRecordingDurationSeconds',
    
    :'audio_recording_size_bytes' => :'audioRecordingSizeBytes',
    
    :'created_date' => :'createdDate',
    
    :'modified_date' => :'modifiedDate',
    
    :'deleted_date' => :'deletedDate',
    
    :'caller_address' => :'callerAddress',
    
    :'caller_name' => :'callerName',
    
    :'caller_user' => :'callerUser',
    
    :'deleted' => :'deleted',
    
    :'note' => :'note',
    
    :'user' => :'user',
    
    :'group' => :'group',
    
    :'queue' => :'queue',
    
    :'copied_from' => :'copiedFrom',
    
    :'copied_to' => :'copiedTo',
    
    :'delete_retention_policy' => :'deleteRetentionPolicy',
    
    :'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/voicemail_message.rb, line 177
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?(:'conversation')
    
    
    self.conversation = attributes[:'conversation']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'deleteRetentionPolicy')
    
    
    self.delete_retention_policy = attributes[:'deleteRetentionPolicy']
    
  
  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/voicemail_message.rb, line 129
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'conversation' => :'Conversation',
    
    :'read' => :'BOOLEAN',
    
    :'audio_recording_duration_seconds' => :'Integer',
    
    :'audio_recording_size_bytes' => :'Integer',
    
    :'created_date' => :'DateTime',
    
    :'modified_date' => :'DateTime',
    
    :'deleted_date' => :'DateTime',
    
    :'caller_address' => :'String',
    
    :'caller_name' => :'String',
    
    :'caller_user' => :'User',
    
    :'deleted' => :'BOOLEAN',
    
    :'note' => :'String',
    
    :'user' => :'User',
    
    :'group' => :'Group',
    
    :'queue' => :'Queue',
    
    :'copied_from' => :'VoicemailCopyRecord',
    
    :'copied_to' => :'Array<VoicemailCopyRecord>',
    
    :'delete_retention_policy' => :'VoicemailRetentionPolicy',
    
    :'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/voicemail_message.rb, line 566
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      conversation == o.conversation &&
      read == o.read &&
      audio_recording_duration_seconds == o.audio_recording_duration_seconds &&
      audio_recording_size_bytes == o.audio_recording_size_bytes &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      deleted_date == o.deleted_date &&
      caller_address == o.caller_address &&
      caller_name == o.caller_name &&
      caller_user == o.caller_user &&
      deleted == o.deleted &&
      note == o.note &&
      user == o.user &&
      group == o.group &&
      queue == o.queue &&
      copied_from == o.copied_from &&
      copied_to == o.copied_to &&
      delete_retention_policy == o.delete_retention_policy &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/voicemail_message.rb, line 623
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/voicemail_message.rb, line 683
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/voicemail_message.rb, line 604
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/voicemail_message.rb, line 593
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/voicemail_message.rb, line 599
def hash
  [id, conversation, read, audio_recording_duration_seconds, audio_recording_size_bytes, created_date, modified_date, deleted_date, caller_address, caller_name, caller_user, deleted, note, user, group, queue, copied_from, copied_to, delete_retention_policy, 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/voicemail_message.rb, line 370
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/voicemail_message.rb, line 666
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/voicemail_message.rb, line 671
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/voicemail_message.rb, line 661
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/voicemail_message.rb, line 379
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end