Class: PureCloud::CampaignNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'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?(:'errors')
    if (value = attributes[:'errors']).is_a?(Array)
      self.errors = value
    end
  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?(:'singleNumberPreview')
    self.single_number_preview = attributes[:'singleNumberPreview']
  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?(:'additionalProperties')
    self.additional_properties = attributes[:'additionalProperties']
  end

end

Instance Attribute Details

#abandon_rate ⇒ Object

Returns the value of attribute abandon_rate.



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

def abandon_rate
  @abandon_rate
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#call_analysis_language ⇒ Object

Returns the value of attribute call_analysis_language.



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

def call_analysis_language
  @call_analysis_language
end

#call_analysis_response_set ⇒ Object

Returns the value of attribute call_analysis_response_set.



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

def call_analysis_response_set
  @call_analysis_response_set
end

#callable_time_set ⇒ Object

Returns the value of attribute callable_time_set.



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

def callable_time_set
  @callable_time_set
end

#caller_address ⇒ Object

Returns the value of attribute caller_address.



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

def caller_address
  @caller_address
end

#caller_name ⇒ Object

Returns the value of attribute caller_name.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 53

def caller_name
  @caller_name
end

#campaign_status ⇒ Object

Returns the value of attribute campaign_status.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 41

def campaign_status
  @campaign_status
end

#contact_list ⇒ Object

Returns the value of attribute contact_list.



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

def contact_list
  @contact_list
end

#contact_list_filters ⇒ Object

Returns the value of attribute contact_list_filters.



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

def contact_list_filters
  @contact_list_filters
end

#contact_sort ⇒ Object

Returns the value of attribute contact_sort.



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

def contact_sort
  @contact_sort
end

#contact_sorts ⇒ Object

Returns the value of attribute contact_sorts.



71
72
73
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 71

def contact_sorts
  @contact_sorts
end

#date_created ⇒ Object

Returns the value of attribute date_created.



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

def date_created
  @date_created
end

#date_modified ⇒ Object

Returns the value of attribute date_modified.



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

def date_modified
  @date_modified
end

#dialing_mode ⇒ Object

Returns the value of attribute dialing_mode.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 35

def dialing_mode
  @dialing_mode
end

#dnc_lists ⇒ Object

Returns the value of attribute dnc_lists.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 47

def dnc_lists
  @dnc_lists
end

#edge_group ⇒ Object

Returns the value of attribute edge_group.



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

def edge_group
  @edge_group
end

#errors ⇒ Object

Returns the value of attribute errors.



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 59

def errors
  @errors
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 21

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 23

def name
  @name
end

#no_answer_timeout ⇒ Object

Returns the value of attribute no_answer_timeout.



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

def no_answer_timeout
  @no_answer_timeout
end

#outbound_line_count ⇒ Object

Returns the value of attribute outbound_line_count.



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

def outbound_line_count
  @outbound_line_count
end

#phone_columns ⇒ Object

Returns the value of attribute phone_columns.



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

def phone_columns
  @phone_columns
end

#preview_time_out_seconds ⇒ Object

Returns the value of attribute preview_time_out_seconds.



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 65

def preview_time_out_seconds
  @preview_time_out_seconds
end

#priority ⇒ Object

Returns the value of attribute priority.



77
78
79
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 77

def priority
  @priority
end

#queue ⇒ Object

Returns the value of attribute queue.



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

def queue
  @queue
end

#rule_sets ⇒ Object

Returns the value of attribute rule_sets.



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

def rule_sets
  @rule_sets
end

#script ⇒ Object

Returns the value of attribute script.



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

def script
  @script
end

#single_number_preview ⇒ Object

Returns the value of attribute single_number_preview.



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

def single_number_preview
  @single_number_preview
end

#skip_preview_disabled ⇒ Object

Returns the value of attribute skip_preview_disabled.



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

def skip_preview_disabled
  @skip_preview_disabled
end

#version ⇒ Object

Returns the value of attribute version.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 29

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 84

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',
    :'caller_name' => :'callerName',
    :'caller_address' => :'callerAddress',
    :'outbound_line_count' => :'outboundLineCount',
    :'errors' => :'errors',
    :'rule_sets' => :'ruleSets',
    :'skip_preview_disabled' => :'skipPreviewDisabled',
    :'preview_time_out_seconds' => :'previewTimeOutSeconds',
    :'single_number_preview' => :'singleNumberPreview',
    :'contact_sort' => :'contactSort',
    :'contact_sorts' => :'contactSorts',
    :'no_answer_timeout' => :'noAnswerTimeout',
    :'call_analysis_language' => :'callAnalysisLanguage',
    :'priority' => :'priority',
    :'contact_list_filters' => :'contactListFilters',
    :'additional_properties' => :'additionalProperties'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'version' => :'Integer',
    :'contact_list' => :'DocumentDataV2NotificationCreatedBy',
    :'queue' => :'CampaignNotificationUriReference',
    :'dialing_mode' => :'String',
    :'script' => :'CampaignNotificationUriReference',
    :'edge_group' => :'CampaignNotificationUriReference',
    :'campaign_status' => :'String',
    :'phone_columns' => :'Array<CampaignNotificationPhoneColumns>',
    :'abandon_rate' => :'Float',
    :'dnc_lists' => :'Array<CampaignNotificationUriReference>',
    :'callable_time_set' => :'CampaignNotificationUriReference',
    :'call_analysis_response_set' => :'CampaignNotificationUriReference',
    :'caller_name' => :'String',
    :'caller_address' => :'String',
    :'outbound_line_count' => :'Integer',
    :'errors' => :'Array<CampaignNotificationErrors>',
    :'rule_sets' => :'Array<CampaignNotificationUriReference>',
    :'skip_preview_disabled' => :'BOOLEAN',
    :'preview_time_out_seconds' => :'Integer',
    :'single_number_preview' => :'BOOLEAN',
    :'contact_sort' => :'CampaignNotificationContactSort',
    :'contact_sorts' => :'Array<CampaignNotificationContactSort>',
    :'no_answer_timeout' => :'Integer',
    :'call_analysis_language' => :'String',
    :'priority' => :'Integer',
    :'contact_list_filters' => :'Array<CampaignNotificationUriReference>',
    :'additional_properties' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      caller_name == o.caller_name &&
      caller_address == o.caller_address &&
      outbound_line_count == o.outbound_line_count &&
      errors == o.errors &&
      rule_sets == o.rule_sets &&
      skip_preview_disabled == o.skip_preview_disabled &&
      preview_time_out_seconds == o.preview_time_out_seconds &&
      single_number_preview == o.single_number_preview &&
      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 &&
      additional_properties == o.additional_properties
end

#_deserialize(type, value) ⇒ Object 



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

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



473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 473

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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 394

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


383
384
385
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 383

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



389
390
391
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 389

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, caller_name, caller_address, outbound_line_count, errors, rule_sets, skip_preview_disabled, preview_time_out_seconds, single_number_preview, contact_sort, contact_sorts, no_answer_timeout, call_analysis_language, priority, contact_list_filters, additional_properties].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



305
306
307
308
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 305

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



456
457
458
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 456

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



461
462
463
464
465
466
467
468
469
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 461

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 



451
452
453
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 451

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



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/purecloudplatformclientv2/models/campaign_notification.rb', line 312

def valid?
  allowed_values = ["AGENTLESS", "PREVIEW", "POWER", "PREDICTIVE", "PROGRESSIVE"]
  if @dialing_mode && !allowed_values.include?(@dialing_mode)
    return false
  end
  allowed_values = ["ON", "OFF", "COMPLETE", "STOPPING", "INVALID"]
  if @campaign_status && !allowed_values.include?(@campaign_status)
    return false
  end
end