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



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
312
313
314
315
316
317
318
319
320
321
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
360
361
362
363
364
365
366
367
368
369
370
371
372
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 268

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?(:'site')
    
    
    self.site = attributes[:'site']
    
  
  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?(:'alwaysRunning')
    
    
    self.always_running = attributes[:'alwaysRunning']
    
  
  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?(:'contactListFilters')
    
    if (value = attributes[:'contactListFilters']).is_a?(Array)
      self.contact_list_filters = value
    end
    
    
  
  end

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

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

  
end

Instance Attribute Details

#abandon_rate ⇒ Object

The targeted abandon rate percentage. Required for progressive, power, and predictive campaigns.



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

def abandon_rate
  @abandon_rate
end

#always_running ⇒ Object

Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually.



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

def always_running
  @always_running
end

#call_analysis_language ⇒ Object

The language the edge will use to analyze the call.



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

def call_analysis_language
  @call_analysis_language
end

#call_analysis_response_set ⇒ Object

The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview.



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

def call_analysis_response_set
  @call_analysis_response_set
end

#callable_time_set ⇒ Object

The callable time set for this campaign to check before placing a call.



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

def callable_time_set
  @callable_time_set
end

#caller_address ⇒ Object

The caller id phone number to be displayed on the outbound call.



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

def caller_address
  @caller_address
end

#caller_name ⇒ Object

The caller id name to be displayed on the outbound call.



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

def caller_name
  @caller_name
end

#campaign_status ⇒ Object

The current status of the Campaign. A Campaign may be turned ‘on’ or ‘off’. Required for updates.



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

def campaign_status
  @campaign_status
end

#contact_list ⇒ Object

The ContactList for this Campaign to dial.



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

def contact_list
  @contact_list
end

#contact_list_filters ⇒ Object

Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.



112
113
114
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 112

def contact_list_filters
  @contact_list_filters
end

#contact_sort ⇒ Object

The order in which to sort contacts for dialing, based on a column.



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

def contact_sort
  @contact_sort
end

#contact_sorts ⇒ Object

The order in which to sort contacts for dialing, based on up to four columns.



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

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



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

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



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

def date_modified
  @date_modified
end

#dialing_mode ⇒ Object

The strategy this Campaign will use for dialing.



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

def dialing_mode
  @dialing_mode
end

#division ⇒ Object

The division this campaign belongs to.



115
116
117
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 115

def division
  @division
end

#dnc_lists ⇒ Object

DncLists for this Campaign to check before placing a call.



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

def dnc_lists
  @dnc_lists
end

#edge_group ⇒ Object

The EdgeGroup that will place the calls. Required for all dialing modes except preview.



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

def edge_group
  @edge_group
end

#errors ⇒ Object

A list of current error conditions associated with the campaign.



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

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

The name of the Campaign.



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

def name
  @name
end

#no_answer_timeout ⇒ Object

How long to wait before dispositioning a call as ‘no-answer’. Default 30 seconds. Only applicable to non-preview campaigns.



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

def no_answer_timeout
  @no_answer_timeout
end

#outbound_line_count ⇒ Object

The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless.



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

def outbound_line_count
  @outbound_line_count
end

#phone_columns ⇒ Object

The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.



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

def phone_columns
  @phone_columns
end

#preview_time_out_seconds ⇒ Object

The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns.



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

def preview_time_out_seconds
  @preview_time_out_seconds
end

#priority ⇒ Object

The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest.



109
110
111
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 109

def priority
  @priority
end

#queue ⇒ Object

The Queue for this Campaign to route calls to. Required for all dialing modes except agentless.



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

def queue
  @queue
end

#rule_sets ⇒ Object

Rule sets to be applied while this campaign is dialing.



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

def rule_sets
  @rule_sets
end

#script ⇒ Object

The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless.



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

def script
  @script
end

#self_uri ⇒ Object

The URI for this object



118
119
120
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 118

def self_uri
  @self_uri
end

#site ⇒ Object

The identifier of the site to be used for dialing; can be set in place of an edge group.



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

def site
  @site
end

#skip_preview_disabled ⇒ Object

Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns.



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

def skip_preview_disabled
  @skip_preview_disabled
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 121

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',
    
    :'site' => :'site',
    
    :'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',
    
    :'always_running' => :'alwaysRunning',
    
    :'contact_sort' => :'contactSort',
    
    :'contact_sorts' => :'contactSorts',
    
    :'no_answer_timeout' => :'noAnswerTimeout',
    
    :'call_analysis_language' => :'callAnalysisLanguage',
    
    :'priority' => :'priority',
    
    :'contact_list_filters' => :'contactListFilters',
    
    :'division' => :'division',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 194

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'version' => :'Integer',
    
    :'contact_list' => :'DomainEntityRef',
    
    :'queue' => :'DomainEntityRef',
    
    :'dialing_mode' => :'String',
    
    :'script' => :'DomainEntityRef',
    
    :'edge_group' => :'DomainEntityRef',
    
    :'site' => :'DomainEntityRef',
    
    :'campaign_status' => :'String',
    
    :'phone_columns' => :'Array<PhoneColumn>',
    
    :'abandon_rate' => :'Float',
    
    :'dnc_lists' => :'Array<DomainEntityRef>',
    
    :'callable_time_set' => :'DomainEntityRef',
    
    :'call_analysis_response_set' => :'DomainEntityRef',
    
    :'errors' => :'Array<RestErrorDetail>',
    
    :'caller_name' => :'String',
    
    :'caller_address' => :'String',
    
    :'outbound_line_count' => :'Integer',
    
    :'rule_sets' => :'Array<DomainEntityRef>',
    
    :'skip_preview_disabled' => :'BOOLEAN',
    
    :'preview_time_out_seconds' => :'Integer',
    
    :'always_running' => :'BOOLEAN',
    
    :'contact_sort' => :'ContactSort',
    
    :'contact_sorts' => :'Array<ContactSort>',
    
    :'no_answer_timeout' => :'Integer',
    
    :'call_analysis_language' => :'String',
    
    :'priority' => :'Integer',
    
    :'contact_list_filters' => :'Array<DomainEntityRef>',
    
    :'division' => :'DomainEntityRef',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 959

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 &&
      site == o.site &&
      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 &&
      always_running == o.always_running &&
      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 &&
      contact_list_filters == o.contact_list_filters &&
      division == o.division &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 1029

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



1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 1089

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



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 1010

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


999
1000
1001
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 999

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1005
1006
1007
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 1005

def hash
  [id, name, date_created, date_modified, version, contact_list, queue, dialing_mode, script, edge_group, site, 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, always_running, contact_sort, contact_sorts, no_answer_timeout, call_analysis_language, priority, contact_list_filters, division, 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



588
589
590
591
592
593
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 588

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



1072
1073
1074
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 1072

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 1077

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 



1067
1068
1069
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 1067

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



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/purecloudplatformclientv2/models/campaign.rb', line 597

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @contact_list.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @dialing_mode.nil?
    return false
  end

  
  
  allowed_values = ["agentless", "preview", "power", "predictive", "progressive", "external"]
  if @dialing_mode && !allowed_values.include?(@dialing_mode)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["on", "stopping", "off", "complete", "invalid", "forced_off", "forced_stopping"]
  if @campaign_status && !allowed_values.include?(@campaign_status)
    return false
  end
  
  
  
  
  if @phone_columns.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @caller_name.nil?
    return false
  end

  
  
  
  
  
  if @caller_address.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end