class PureCloud::PolicyActions

Attributes

always_delete[RW]

true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false

assign_calibrations[RW]
assign_evaluations[RW]
assign_metered_assignment_by_agent[RW]
assign_metered_evaluations[RW]
assign_surveys[RW]
delete_recording[RW]

true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false

initiate_screen_recording[RW]
integration_export[RW]

Policy action for exporting recordings using an integration to 3rd party s3.

media_transcriptions[RW]
retain_recording[RW]

true to retain the recording associated with the conversation. Default = true

retention_duration[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/policy_actions.rb, line 50
def self.attribute_map
  {
    
    :'retain_recording' => :'retainRecording',
    
    :'delete_recording' => :'deleteRecording',
    
    :'always_delete' => :'alwaysDelete',
    
    :'assign_evaluations' => :'assignEvaluations',
    
    :'assign_metered_evaluations' => :'assignMeteredEvaluations',
    
    :'assign_metered_assignment_by_agent' => :'assignMeteredAssignmentByAgent',
    
    :'assign_calibrations' => :'assignCalibrations',
    
    :'assign_surveys' => :'assignSurveys',
    
    :'retention_duration' => :'retentionDuration',
    
    :'initiate_screen_recording' => :'initiateScreenRecording',
    
    :'media_transcriptions' => :'mediaTranscriptions',
    
    :'integration_export' => :'integrationExport'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/policy_actions.rb, line 113
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?(:'retainRecording')
    
    
    self.retain_recording = attributes[:'retainRecording']
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/policy_actions.rb, line 81
def self.swagger_types
  {
    
    :'retain_recording' => :'BOOLEAN',
    
    :'delete_recording' => :'BOOLEAN',
    
    :'always_delete' => :'BOOLEAN',
    
    :'assign_evaluations' => :'Array<EvaluationAssignment>',
    
    :'assign_metered_evaluations' => :'Array<MeteredEvaluationAssignment>',
    
    :'assign_metered_assignment_by_agent' => :'Array<MeteredAssignmentByAgent>',
    
    :'assign_calibrations' => :'Array<CalibrationAssignment>',
    
    :'assign_surveys' => :'Array<SurveyAssignment>',
    
    :'retention_duration' => :'RetentionDuration',
    
    :'initiate_screen_recording' => :'InitiateScreenRecording',
    
    :'media_transcriptions' => :'Array<MediaTranscription>',
    
    :'integration_export' => :'IntegrationExport'
    
  }
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/policy_actions.rb, line 368
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      retain_recording == o.retain_recording &&
      delete_recording == o.delete_recording &&
      always_delete == o.always_delete &&
      assign_evaluations == o.assign_evaluations &&
      assign_metered_evaluations == o.assign_metered_evaluations &&
      assign_metered_assignment_by_agent == o.assign_metered_assignment_by_agent &&
      assign_calibrations == o.assign_calibrations &&
      assign_surveys == o.assign_surveys &&
      retention_duration == o.retention_duration &&
      initiate_screen_recording == o.initiate_screen_recording &&
      media_transcriptions == o.media_transcriptions &&
      integration_export == o.integration_export
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/policy_actions.rb, line 417
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/policy_actions.rb, line 477
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/policy_actions.rb, line 398
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/policy_actions.rb, line 387
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/policy_actions.rb, line 393
def hash
  [retain_recording, delete_recording, always_delete, assign_evaluations, assign_metered_evaluations, assign_metered_assignment_by_agent, assign_calibrations, assign_surveys, retention_duration, initiate_screen_recording, media_transcriptions, integration_export].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/policy_actions.rb, line 244
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/policy_actions.rb, line 460
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/policy_actions.rb, line 465
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/policy_actions.rb, line 455
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/policy_actions.rb, line 253
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end