class PureCloud::ReportingExportJobRequest

Attributes

exclude_empty_rows[RW]

Excludes empty rows from the exports

export_format[RW]

The requested format of the exported data

filter[RW]

Filters to apply to create the view

has_custom_participant_attributes[RW]

Indicates if custom participant attributes will be exported

has_format_durations[RW]

Indicates if durations are formatted in hh:mm:ss format instead of ms

has_split_by_media[RW]

Indicates if media type will be split in aggregate detail exports

has_split_filters[RW]

Indicates if filters will be split in aggregate detail exports

interval[RW]

The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss

locale[RW]

The locale use for localization of the exported data, i.e. en-us, es-mx

name[RW]

The user supplied name of the export request

period[RW]

The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H

read[RW]

Indicates if the request has been marked as read

recipient_emails[RW]

The list of email recipients for the exports

selected_columns[RW]

The list of ordered selected columns from the export view by the user

time_zone[RW]

The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London

view_type[RW]

The type of view export job to be created

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/reporting_export_job_request.rb, line 70
def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'time_zone' => :'timeZone',
    
    :'export_format' => :'exportFormat',
    
    :'interval' => :'interval',
    
    :'period' => :'period',
    
    :'view_type' => :'viewType',
    
    :'filter' => :'filter',
    
    :'read' => :'read',
    
    :'locale' => :'locale',
    
    :'has_format_durations' => :'hasFormatDurations',
    
    :'has_split_filters' => :'hasSplitFilters',
    
    :'exclude_empty_rows' => :'excludeEmptyRows',
    
    :'has_split_by_media' => :'hasSplitByMedia',
    
    :'selected_columns' => :'selectedColumns',
    
    :'has_custom_participant_attributes' => :'hasCustomParticipantAttributes',
    
    :'recipient_emails' => :'recipientEmails'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/reporting_export_job_request.rb, line 109
def self.swagger_types
  {
    
    :'name' => :'String',
    
    :'time_zone' => :'String',
    
    :'export_format' => :'String',
    
    :'interval' => :'String',
    
    :'period' => :'String',
    
    :'view_type' => :'String',
    
    :'filter' => :'ViewFilter',
    
    :'read' => :'BOOLEAN',
    
    :'locale' => :'String',
    
    :'has_format_durations' => :'BOOLEAN',
    
    :'has_split_filters' => :'BOOLEAN',
    
    :'exclude_empty_rows' => :'BOOLEAN',
    
    :'has_split_by_media' => :'BOOLEAN',
    
    :'selected_columns' => :'Array<SelectedColumns>',
    
    :'has_custom_participant_attributes' => :'BOOLEAN',
    
    :'recipient_emails' => :'Array<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/reporting_export_job_request.rb, line 536
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      time_zone == o.time_zone &&
      export_format == o.export_format &&
      interval == o.interval &&
      period == o.period &&
      view_type == o.view_type &&
      filter == o.filter &&
      read == o.read &&
      locale == o.locale &&
      has_format_durations == o.has_format_durations &&
      has_split_filters == o.has_split_filters &&
      exclude_empty_rows == o.exclude_empty_rows &&
      has_split_by_media == o.has_split_by_media &&
      selected_columns == o.selected_columns &&
      has_custom_participant_attributes == o.has_custom_participant_attributes &&
      recipient_emails == o.recipient_emails
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/reporting_export_job_request.rb, line 589
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/reporting_export_job_request.rb, line 649
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/reporting_export_job_request.rb, line 570
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/reporting_export_job_request.rb, line 559
def eql?(o)
  self == o
end
export_format=(export_format) click to toggle source

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

# File lib/purecloudplatformclientv2/models/reporting_export_job_request.rb, line 449
def export_format=(export_format)
  allowed_values = ["CSV", "PDF"]
  if export_format && !allowed_values.include?(export_format)
    fail ArgumentError, "invalid value for 'export_format', must be one of #{allowed_values}."
  end
  @export_format = export_format
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/reporting_export_job_request.rb, line 565
def hash
  [name, time_zone, export_format, interval, period, view_type, filter, read, locale, has_format_durations, has_split_filters, exclude_empty_rows, has_split_by_media, selected_columns, has_custom_participant_attributes, recipient_emails].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/reporting_export_job_request.rb, line 308
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/reporting_export_job_request.rb, line 632
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/reporting_export_job_request.rb, line 637
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/reporting_export_job_request.rb, line 627
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/reporting_export_job_request.rb, line 317
def valid?
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  if @time_zone.nil?
    return false
  end

  
  
  
  
  
  if @export_format.nil?
    return false
  end

  
  
  allowed_values = ["CSV", "PDF"]
  if @export_format && !allowed_values.include?(@export_format)
    return false
  end
  
  
  
  
  if @interval.nil?
    return false
  end

  
  
  
  
  
  if @period.nil?
    return false
  end

  
  
  
  
  
  if @view_type.nil?
    return false
  end

  
  
  allowed_values = ["QUEUE_PERFORMANCE_SUMMARY_VIEW", "QUEUE_PERFORMANCE_DETAIL_VIEW", "INTERACTION_SEARCH_VIEW", "AGENT_PERFORMANCE_SUMMARY_VIEW", "AGENT_PERFORMANCE_DETAIL_VIEW", "AGENT_STATUS_SUMMARY_VIEW", "AGENT_STATUS_DETAIL_VIEW", "AGENT_EVALUATION_SUMMARY_VIEW", "AGENT_EVALUATION_DETAIL_VIEW", "AGENT_QUEUE_DETAIL_VIEW", "AGENT_INTERACTION_DETAIL_VIEW", "ABANDON_INSIGHTS_VIEW", "SKILLS_PERFORMANCE_VIEW", "SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW", "SURVEY_FORM_PERFORMANCE_DETAIL_VIEW", "DNIS_PERFORMANCE_SUMMARY_VIEW", "DNIS_PERFORMANCE_DETAIL_VIEW", "WRAP_UP_PERFORMANCE_SUMMARY_VIEW", "AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW", "QUEUE_ACTIVITY_SUMMARY_VIEW", "QUEUE_ACTIVITY_DETAIL_VIEW", "AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW", "QUEUE_AGENT_DETAIL_VIEW", "QUEUE_INTERACTION_DETAIL_VIEW", "AGENT_SCHEDULE_DETAIL_VIEW", "IVR_PERFORMANCE_SUMMARY_VIEW", "IVR_PERFORMANCE_DETAIL_VIEW", "ANSWER_INSIGHTS_VIEW", "HANDLE_INSIGHTS_VIEW", "TALK_INSIGHTS_VIEW", "HOLD_INSIGHTS_VIEW", "ACW_INSIGHTS_VIEW", "WAIT_INSIGHTS_VIEW", "AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW", "FLOW_OUTCOME_SUMMARY_VIEW", "FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW", "FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW", "FLOW_DESTINATION_SUMMARY_VIEW", "FLOW_DESTINATION_DETAIL_VIEW", "API_USAGE_VIEW"]
  if @view_type && !allowed_values.include?(@view_type)
    return false
  end
  
  
  
  
  if @filter.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @locale.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end
view_type=(view_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/reporting_export_job_request.rb, line 473
def view_type=(view_type)
  allowed_values = ["QUEUE_PERFORMANCE_SUMMARY_VIEW", "QUEUE_PERFORMANCE_DETAIL_VIEW", "INTERACTION_SEARCH_VIEW", "AGENT_PERFORMANCE_SUMMARY_VIEW", "AGENT_PERFORMANCE_DETAIL_VIEW", "AGENT_STATUS_SUMMARY_VIEW", "AGENT_STATUS_DETAIL_VIEW", "AGENT_EVALUATION_SUMMARY_VIEW", "AGENT_EVALUATION_DETAIL_VIEW", "AGENT_QUEUE_DETAIL_VIEW", "AGENT_INTERACTION_DETAIL_VIEW", "ABANDON_INSIGHTS_VIEW", "SKILLS_PERFORMANCE_VIEW", "SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW", "SURVEY_FORM_PERFORMANCE_DETAIL_VIEW", "DNIS_PERFORMANCE_SUMMARY_VIEW", "DNIS_PERFORMANCE_DETAIL_VIEW", "WRAP_UP_PERFORMANCE_SUMMARY_VIEW", "AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW", "QUEUE_ACTIVITY_SUMMARY_VIEW", "QUEUE_ACTIVITY_DETAIL_VIEW", "AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW", "QUEUE_AGENT_DETAIL_VIEW", "QUEUE_INTERACTION_DETAIL_VIEW", "AGENT_SCHEDULE_DETAIL_VIEW", "IVR_PERFORMANCE_SUMMARY_VIEW", "IVR_PERFORMANCE_DETAIL_VIEW", "ANSWER_INSIGHTS_VIEW", "HANDLE_INSIGHTS_VIEW", "TALK_INSIGHTS_VIEW", "HOLD_INSIGHTS_VIEW", "ACW_INSIGHTS_VIEW", "WAIT_INSIGHTS_VIEW", "AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW", "FLOW_OUTCOME_SUMMARY_VIEW", "FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW", "FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW", "FLOW_DESTINATION_SUMMARY_VIEW", "FLOW_DESTINATION_DETAIL_VIEW", "API_USAGE_VIEW"]
  if view_type && !allowed_values.include?(view_type)
    fail ArgumentError, "invalid value for 'view_type', must be one of #{allowed_values}."
  end
  @view_type = view_type
end