class PureCloud::OrphanRecording

Attributes

created_time[RW]

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

file_state[RW]
id[RW]

The globally unique identifier for the object.

media_size_bytes[RW]
media_type[RW]
name[RW]
orphan_status[RW]

The status of the orphaned recording's conversation.

provider_endpoint[RW]
provider_type[RW]
recording[RW]
recovered_time[RW]

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

self_uri[RW]

The URI for this object

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 51
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'created_time' => :'createdTime',
    
    :'recovered_time' => :'recoveredTime',
    
    :'provider_type' => :'providerType',
    
    :'media_size_bytes' => :'mediaSizeBytes',
    
    :'media_type' => :'mediaType',
    
    :'file_state' => :'fileState',
    
    :'provider_endpoint' => :'providerEndpoint',
    
    :'recording' => :'recording',
    
    :'orphan_status' => :'orphanStatus',
    
    :'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/orphan_recording.rb, line 114
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?(:'createdTime')
    
    
    self.created_time = attributes[:'createdTime']
    
  
  end

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'orphanStatus')
    
    
    self.orphan_status = attributes[:'orphanStatus']
    
  
  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/orphan_recording.rb, line 82
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'created_time' => :'DateTime',
    
    :'recovered_time' => :'DateTime',
    
    :'provider_type' => :'String',
    
    :'media_size_bytes' => :'Integer',
    
    :'media_type' => :'String',
    
    :'file_state' => :'String',
    
    :'provider_endpoint' => :'Endpoint',
    
    :'recording' => :'Recording',
    
    :'orphan_status' => :'String',
    
    :'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/orphan_recording.rb, line 413
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      created_time == o.created_time &&
      recovered_time == o.recovered_time &&
      provider_type == o.provider_type &&
      media_size_bytes == o.media_size_bytes &&
      media_type == o.media_type &&
      file_state == o.file_state &&
      provider_endpoint == o.provider_endpoint &&
      recording == o.recording &&
      orphan_status == o.orphan_status &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 462
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/orphan_recording.rb, line 522
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/orphan_recording.rb, line 443
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/orphan_recording.rb, line 432
def eql?(o)
  self == o
end
file_state=(file_state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 371
def file_state=(file_state)
  allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING"]
  if file_state && !allowed_values.include?(file_state)
    fail ArgumentError, "invalid value for 'file_state', must be one of #{allowed_values}."
  end
  @file_state = file_state
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 438
def hash
  [id, name, created_time, recovered_time, provider_type, media_size_bytes, media_type, file_state, provider_endpoint, recording, orphan_status, 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/orphan_recording.rb, line 233
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
media_type=(media_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 357
def media_type=(media_type)
  allowed_values = ["CALL", "CHAT", "EMAIL", "SCREEN"]
  if media_type && !allowed_values.include?(media_type)
    fail ArgumentError, "invalid value for 'media_type', must be one of #{allowed_values}."
  end
  @media_type = media_type
end
orphan_status=(orphan_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 395
def orphan_status=(orphan_status)
  allowed_values = ["NO_CONVERSATION", "UNKNOWN_CONVERSATION", "CONVERSATION_NOT_COMPLETE", "CONVERSATION_NOT_EVALUATED", "EVALUATED"]
  if orphan_status && !allowed_values.include?(orphan_status)
    fail ArgumentError, "invalid value for 'orphan_status', must be one of #{allowed_values}."
  end
  @orphan_status = orphan_status
end
provider_type=(provider_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 338
def provider_type=(provider_type)
  allowed_values = ["EDGE", "CHAT", "EMAIL", "SCREEN_RECORDING"]
  if provider_type && !allowed_values.include?(provider_type)
    fail ArgumentError, "invalid value for 'provider_type', must be one of #{allowed_values}."
  end
  @provider_type = provider_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/orphan_recording.rb, line 510
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/orphan_recording.rb, line 500
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/orphan_recording.rb, line 242
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["EDGE", "CHAT", "EMAIL", "SCREEN_RECORDING"]
  if @provider_type && !allowed_values.include?(@provider_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["CALL", "CHAT", "EMAIL", "SCREEN"]
  if @media_type && !allowed_values.include?(@media_type)
    return false
  end
  
  
  
  
  
  allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING"]
  if @file_state && !allowed_values.include?(@file_state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["NO_CONVERSATION", "UNKNOWN_CONVERSATION", "CONVERSATION_NOT_COMPLETE", "CONVERSATION_NOT_EVALUATED", "EVALUATED"]
  if @orphan_status && !allowed_values.include?(@orphan_status)
    return false
  end
  
  
  
  
  
  
  
end