class PureCloud::Campaign

Attributes

abandon_rate[RW]

the targeted abandon rate percentage

call_analysis_language[RW]

The language the edge will use to analyse the call

call_analysis_response_set[RW]

the identifier of the call analysis response set, required for all dialing modes other than preview

callable_time_set[RW]

the identifier of the callable time set

caller_address[RW]

caller id phone number to be displayed on the outbound call

caller_name[RW]

caller id name to be displayed on the outbound call

campaign_status[RW]

status of the campaign; can be set to 'on' or 'off'

contact_list[RW]

identifier of the contact list for the campaign

contact_sort[RW]

information determining the order in which the contacts will be dialed

date_created[RW]

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

date_modified[RW]

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

dialing_mode[RW]

dialing mode of the campaign

dnc_lists[RW]

identifiers of the do not call lists

edge_group[RW]

identifier of the edge group, required for all dialing modes other than preview

errors[RW]

a list of current error conditions associated with the campaign

id[RW]

The globally unique identifier for the object.

name[RW]
no_answer_timeout[RW]

for non-preview campaigns, how long to wait before dispositioning as 'no-answer', default 30 seconds

outbound_line_count[RW]

for agentless campaigns, the number of outbound lines to be concurrently dialed

phone_columns[RW]

the contact list phone columns to be called for the campaign

preview_time_out_seconds[RW]

for preview campaigns, number of seconds before a call will be automatically placed. A value of 0 indicates no automatic placement of calls

priority[RW]

The priority of this campaign relative to other campaigns

queue[RW]

identifier of the agent assignment queue, required for all dialing modes other than agentless

rule_sets[RW]

identifiers of the rule sets

script[RW]

identifier of the campaign script, required for all dialing modes other than agentless

self_uri[RW]

The URI for this object

skip_preview_disabled[RW]

for preview campaigns, indicator of whether the agent can skip a preview without placing a call

version[RW]

Required for updates, must match the version number of the most recent update

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/campaign.rb, line 105
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'version' => :'version',
    
    :'contact_list' => :'contactList',
    
    :'queue' => :'queue',
    
    :'dialing_mode' => :'dialingMode',
    
    :'script' => :'script',
    
    :'edge_group' => :'edgeGroup',
    
    :'campaign_status' => :'campaignStatus',
    
    :'phone_columns' => :'phoneColumns',
    
    :'abandon_rate' => :'abandonRate',
    
    :'dnc_lists' => :'dncLists',
    
    :'callable_time_set' => :'callableTimeSet',
    
    :'call_analysis_response_set' => :'callAnalysisResponseSet',
    
    :'errors' => :'errors',
    
    :'caller_name' => :'callerName',
    
    :'caller_address' => :'callerAddress',
    
    :'outbound_line_count' => :'outboundLineCount',
    
    :'rule_sets' => :'ruleSets',
    
    :'skip_preview_disabled' => :'skipPreviewDisabled',
    
    :'preview_time_out_seconds' => :'previewTimeOutSeconds',
    
    :'contact_sort' => :'contactSort',
    
    :'no_answer_timeout' => :'noAnswerTimeout',
    
    :'call_analysis_language' => :'callAnalysisLanguage',
    
    :'priority' => :'priority',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/campaign.rb, line 202
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'contactList']
    self.contact_list = attributes[:'contactList']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
  if attributes[:'dialingMode']
    self.dialing_mode = attributes[:'dialingMode']
  end
  
  if attributes[:'script']
    self.script = attributes[:'script']
  end
  
  if attributes[:'edgeGroup']
    self.edge_group = attributes[:'edgeGroup']
  end
  
  if attributes[:'campaignStatus']
    self.campaign_status = attributes[:'campaignStatus']
  end
  
  if attributes[:'phoneColumns']
    if (value = attributes[:'phoneColumns']).is_a?(Array)
      self.phone_columns = value
    end
  end
  
  if attributes[:'abandonRate']
    self.abandon_rate = attributes[:'abandonRate']
  end
  
  if attributes[:'dncLists']
    if (value = attributes[:'dncLists']).is_a?(Array)
      self.dnc_lists = value
    end
  end
  
  if attributes[:'callableTimeSet']
    self.callable_time_set = attributes[:'callableTimeSet']
  end
  
  if attributes[:'callAnalysisResponseSet']
    self.call_analysis_response_set = attributes[:'callAnalysisResponseSet']
  end
  
  if attributes[:'errors']
    if (value = attributes[:'errors']).is_a?(Array)
      self.errors = value
    end
  end
  
  if attributes[:'callerName']
    self.caller_name = attributes[:'callerName']
  end
  
  if attributes[:'callerAddress']
    self.caller_address = attributes[:'callerAddress']
  end
  
  if attributes[:'outboundLineCount']
    self.outbound_line_count = attributes[:'outboundLineCount']
  end
  
  if attributes[:'ruleSets']
    if (value = attributes[:'ruleSets']).is_a?(Array)
      self.rule_sets = value
    end
  end
  
  if attributes[:'skipPreviewDisabled']
    self.skip_preview_disabled = attributes[:'skipPreviewDisabled']
  end
  
  if attributes[:'previewTimeOutSeconds']
    self.preview_time_out_seconds = attributes[:'previewTimeOutSeconds']
  end
  
  if attributes[:'contactSort']
    self.contact_sort = attributes[:'contactSort']
  end
  
  if attributes[:'noAnswerTimeout']
    self.no_answer_timeout = attributes[:'noAnswerTimeout']
  end
  
  if attributes[:'callAnalysisLanguage']
    self.call_analysis_language = attributes[:'callAnalysisLanguage']
  end
  
  if attributes[:'priority']
    self.priority = attributes[:'priority']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/campaign.rb, line 168
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'version' => :'Integer',
    :'contact_list' => :'UriReference',
    :'queue' => :'UriReference',
    :'dialing_mode' => :'String',
    :'script' => :'UriReference',
    :'edge_group' => :'UriReference',
    :'campaign_status' => :'String',
    :'phone_columns' => :'Array<PhoneColumn>',
    :'abandon_rate' => :'Float',
    :'dnc_lists' => :'Array<UriReference>',
    :'callable_time_set' => :'UriReference',
    :'call_analysis_response_set' => :'UriReference',
    :'errors' => :'Array<RestErrorDetail>',
    :'caller_name' => :'String',
    :'caller_address' => :'String',
    :'outbound_line_count' => :'Integer',
    :'rule_sets' => :'Array<UriReference>',
    :'skip_preview_disabled' => :'BOOLEAN',
    :'preview_time_out_seconds' => :'Integer',
    :'contact_sort' => :'ContactSort',
    :'no_answer_timeout' => :'Integer',
    :'call_analysis_language' => :'String',
    :'priority' => :'Integer',
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/campaign.rb, line 341
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      version == o.version &&
      contact_list == o.contact_list &&
      queue == o.queue &&
      dialing_mode == o.dialing_mode &&
      script == o.script &&
      edge_group == o.edge_group &&
      campaign_status == o.campaign_status &&
      phone_columns == o.phone_columns &&
      abandon_rate == o.abandon_rate &&
      dnc_lists == o.dnc_lists &&
      callable_time_set == o.callable_time_set &&
      call_analysis_response_set == o.call_analysis_response_set &&
      errors == o.errors &&
      caller_name == o.caller_name &&
      caller_address == o.caller_address &&
      outbound_line_count == o.outbound_line_count &&
      rule_sets == o.rule_sets &&
      skip_preview_disabled == o.skip_preview_disabled &&
      preview_time_out_seconds == o.preview_time_out_seconds &&
      contact_sort == o.contact_sort &&
      no_answer_timeout == o.no_answer_timeout &&
      call_analysis_language == o.call_analysis_language &&
      priority == o.priority &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/campaign.rb, line 404
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/purecloud/models/campaign.rb, line 464
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/purecloud/models/campaign.rb, line 385
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
dialing_mode=(dialing_mode) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/campaign.rb, line 332
def dialing_mode=(dialing_mode)
  allowed_values = ["agentless", "preview", "power", "predictive", "progressive"]
  if dialing_mode && !allowed_values.include?(dialing_mode)
    fail "invalid value for 'dialing_mode', must be one of #{allowed_values}"
  end
  @dialing_mode = dialing_mode
end
eql?(o) click to toggle source

@see the `==` method

# File lib/purecloud/models/campaign.rb, line 375
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/campaign.rb, line 380
def hash
  [id, name, date_created, date_modified, version, contact_list, queue, dialing_mode, script, edge_group, campaign_status, phone_columns, abandon_rate, dnc_lists, callable_time_set, call_analysis_response_set, errors, caller_name, caller_address, outbound_line_count, rule_sets, skip_preview_disabled, preview_time_out_seconds, contact_sort, no_answer_timeout, call_analysis_language, priority, self_uri].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/campaign.rb, line 447
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/campaign.rb, line 452
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/purecloud/models/campaign.rb, line 442
def to_s
  to_hash.to_s
end