Class: PureCloud::Campaign

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/campaign.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Campaign

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 179

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?(:'dateCreated')
    self.date_created = attributes[:'dateCreated']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#abandon_rate ⇒ Object

the targeted abandon rate percentage



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 57

def abandon_rate
  @abandon_rate
end

#call_analysis_language ⇒ Object

The language the edge will use to analyse the call



99
100
101
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 99

def call_analysis_language
  @call_analysis_language
end

#call_analysis_response_set ⇒ Object

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



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 66

def call_analysis_response_set
  @call_analysis_response_set
end

#callable_time_set ⇒ Object

the identifier of the callable time set



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 63

def callable_time_set
  @callable_time_set
end

#caller_address ⇒ Object

caller id phone number to be displayed on the outbound call



75
76
77
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 75

def caller_address
  @caller_address
end

#caller_name ⇒ Object

caller id name to be displayed on the outbound call



72
73
74
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 72

def caller_name
  @caller_name
end

#campaign_status ⇒ Object

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



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 51

def campaign_status
  @campaign_status
end

#contact_list ⇒ Object

identifier of the contact list for the campaign



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 36

def contact_list
  @contact_list
end

#contact_sort ⇒ Object

information determining the order in which the contacts will be dialed



90
91
92
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 90

def contact_sort
  @contact_sort
end

#contact_sorts ⇒ Object

column prioritized information determining the order in which the contacts will be dialed



93
94
95
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 93

def contact_sorts
  @contact_sorts
end

#date_created ⇒ Object

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



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 27

def date_created
  @date_created
end

#date_modified ⇒ Object

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



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 30

def date_modified
  @date_modified
end

#dialing_mode ⇒ Object

dialing mode of the campaign



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 42

def dialing_mode
  @dialing_mode
end

#dnc_lists ⇒ Object

identifiers of the do not call lists



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 60

def dnc_lists
  @dnc_lists
end

#edge_group ⇒ Object

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



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 48

def edge_group
  @edge_group
end

#errors ⇒ Object

a list of current error conditions associated with the campaign



69
70
71
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 69

def errors
  @errors
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 22

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 24

def name
  @name
end

#no_answer_timeout ⇒ Object

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



96
97
98
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 96

def no_answer_timeout
  @no_answer_timeout
end

#outbound_line_count ⇒ Object

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



78
79
80
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 78

def outbound_line_count
  @outbound_line_count
end

#phone_columns ⇒ Object

the contact list phone columns to be called for the campaign



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 54

def phone_columns
  @phone_columns
end

#preview_time_out_seconds ⇒ Object

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



87
88
89
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 87

def preview_time_out_seconds
  @preview_time_out_seconds
end

#priority ⇒ Object

The priority of this campaign relative to other campaigns



102
103
104
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 102

def priority
  @priority
end

#queue ⇒ Object

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



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 39

def queue
  @queue
end

#rule_sets ⇒ Object

identifiers of the rule sets



81
82
83
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 81

def rule_sets
  @rule_sets
end

#script ⇒ Object

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



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 45

def script
  @script
end

#self_uri ⇒ Object

The URI for this object



105
106
107
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 105

def self_uri
  @self_uri
end

#skip_preview_disabled ⇒ Object

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



84
85
86
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 84

def skip_preview_disabled
  @skip_preview_disabled
end

#version ⇒ Object

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



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 33

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 108

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',
    :'contact_sorts' => :'contactSorts',
    :'no_answer_timeout' => :'noAnswerTimeout',
    :'call_analysis_language' => :'callAnalysisLanguage',
    :'priority' => :'priority',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 143

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',
    :'contact_sorts' => :'Array<ContactSort>',
    :'no_answer_timeout' => :'Integer',
    :'call_analysis_language' => :'String',
    :'priority' => :'Integer',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 373

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 &&
      contact_sorts == o.contact_sorts &&
      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) ⇒ Object 



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 439

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) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 499

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) ⇒ Object

build the object from hash



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 420

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


409
410
411
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 409

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



415
416
417
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 415

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, contact_sorts, no_answer_timeout, call_analysis_language, priority, self_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



315
316
317
318
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 315

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



482
483
484
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 482

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



487
488
489
490
491
492
493
494
495
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 487

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 ⇒ Object 



477
478
479
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 477

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 322

def valid?
  if @contact_list.nil?
    return false
  end

  if @queue.nil?
    return false
  end

  if @dialing_mode.nil?
    return false
  end

  allowed_values = ["agentless", "preview", "power", "predictive", "progressive"]
  if @dialing_mode && !allowed_values.include?(@dialing_mode)
    return false
  end
  if @script.nil?
    return false
  end

  if @edge_group.nil?
    return false
  end

  if @campaign_status.nil?
    return false
  end

  if @phone_columns.nil?
    return false
  end

  if @call_analysis_response_set.nil?
    return false
  end

end