Class: PureCloud::Campaign

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Campaign

Returns a new instance of Campaign.



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

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']
  else
    self.skip_preview_disabled = false
  end
  
  if attributes[:'previewTimeOutSeconds']
    self.preview_time_out_seconds = attributes[:'previewTimeOutSeconds']
  end
  
  if attributes[:'singleNumberPreview']
    self.single_number_preview = attributes[:'singleNumberPreview']
  else
    self.single_number_preview = false
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#abandon_rate ⇒ Object

Returns the value of attribute abandon_rate.



32
33
34
 
# File 'lib/purecloud/models/campaign.rb', line 32

def abandon_rate
  @abandon_rate
end

#call_analysis_response_set ⇒ Object

Returns the value of attribute call_analysis_response_set.



38
39
40
 
# File 'lib/purecloud/models/campaign.rb', line 38

def call_analysis_response_set
  @call_analysis_response_set
end

#callable_time_set ⇒ Object

Returns the value of attribute callable_time_set.



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

def callable_time_set
  @callable_time_set
end

#caller_address ⇒ Object

Returns the value of attribute caller_address.



44
45
46
 
# File 'lib/purecloud/models/campaign.rb', line 44

def caller_address
  @caller_address
end

#caller_name ⇒ Object

Returns the value of attribute caller_name.



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

def caller_name
  @caller_name
end

#campaign_status ⇒ Object

Returns the value of attribute campaign_status.



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

def campaign_status
  @campaign_status
end

#contact_list ⇒ Object

Returns the value of attribute contact_list.



18
19
20
 
# File 'lib/purecloud/models/campaign.rb', line 18

def contact_list
  @contact_list
end

#date_created ⇒ Object

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



11
12
13
 
# File 'lib/purecloud/models/campaign.rb', line 11

def date_created
  @date_created
end

#date_modified ⇒ Object

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



14
15
16
 
# File 'lib/purecloud/models/campaign.rb', line 14

def date_modified
  @date_modified
end

#dialing_mode ⇒ Object

Returns the value of attribute dialing_mode.



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

def dialing_mode
  @dialing_mode
end

#dnc_lists ⇒ Object

Returns the value of attribute dnc_lists.



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

def dnc_lists
  @dnc_lists
end

#edge_group ⇒ Object

Returns the value of attribute edge_group.



26
27
28
 
# File 'lib/purecloud/models/campaign.rb', line 26

def edge_group
  @edge_group
end

#errors ⇒ Object

Returns the value of attribute errors.



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

def errors
  @errors
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/campaign.rb', line 6

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/campaign.rb', line 8

def name
  @name
end

#outbound_line_count ⇒ Object

Returns the value of attribute outbound_line_count.



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

def outbound_line_count
  @outbound_line_count
end

#phone_columns ⇒ Object

Returns the value of attribute phone_columns.



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

def phone_columns
  @phone_columns
end

#preview_time_out_seconds ⇒ Object

Returns the value of attribute preview_time_out_seconds.



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

def preview_time_out_seconds
  @preview_time_out_seconds
end

#queue ⇒ Object

Returns the value of attribute queue.



20
21
22
 
# File 'lib/purecloud/models/campaign.rb', line 20

def queue
  @queue
end

#rule_sets ⇒ Object

Returns the value of attribute rule_sets.



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

def rule_sets
  @rule_sets
end

#script ⇒ Object

Returns the value of attribute script.



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

def script
  @script
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#single_number_preview ⇒ Object

Returns the value of attribute single_number_preview.



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

def single_number_preview
  @single_number_preview
end

#skip_preview_disabled ⇒ Object

Returns the value of attribute skip_preview_disabled.



50
51
52
 
# File 'lib/purecloud/models/campaign.rb', line 50

def skip_preview_disabled
  @skip_preview_disabled
end

#version ⇒ Object

Returns the value of attribute version.



16
17
18
 
# File 'lib/purecloud/models/campaign.rb', line 16

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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
 
# File 'lib/purecloud/models/campaign.rb', line 60

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',
    
    :'single_number_preview' => :'singleNumberPreview',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



117
118
119
120
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
 
# File 'lib/purecloud/models/campaign.rb', line 117

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',
    :'single_number_preview' => :'BOOLEAN',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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 &&
      single_number_preview == o.single_number_preview &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/purecloud/models/campaign.rb', line 387

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/purecloud/models/campaign.rb', line 311

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

Returns:

  • (Boolean)

See Also:

  • `==` method


301
302
303
 
# File 'lib/purecloud/models/campaign.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



306
307
308
 
# File 'lib/purecloud/models/campaign.rb', line 306

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, single_number_preview, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



370
371
372
 
# File 'lib/purecloud/models/campaign.rb', line 370

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



375
376
377
378
379
380
381
382
383
 
# File 'lib/purecloud/models/campaign.rb', line 375

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 



365
366
367
 
# File 'lib/purecloud/models/campaign.rb', line 365

def to_s
  to_hash.to_s
end