Class: PureCloud::MessagingCampaign

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessagingCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#always_running ⇒ Object

Whether this messaging campaign is always running



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

def always_running
  @always_running
end

#callable_time_set ⇒ Object

The callable time set for this messaging campaign.



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

def callable_time_set
  @callable_time_set
end

#campaign_status ⇒ Object

The current status of the messaging campaign. A messaging campaign may be turned ‘on’ or ‘off’.



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

def campaign_status
  @campaign_status
end

#contact_list ⇒ Object

The contact list that this messaging campaign will send messages for.



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

def contact_list
  @contact_list
end

#contact_sorts ⇒ Object

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



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

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/messaging_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/messaging_campaign.rb', line 30

def date_modified
  @date_modified
end

#division ⇒ Object

The division this entity belongs to.



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

def division
  @division
end

#dnc_lists ⇒ Object

The dnc lists to check before sending a message for this messaging campaign.



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

def dnc_lists
  @dnc_lists
end

#errors ⇒ Object

A list of current error conditions associated with this messaging campaign.



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

def errors
  @errors
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#messages_per_minute ⇒ Object

How many messages this messaging campaign will send per minute.



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

def messages_per_minute
  @messages_per_minute
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#sms_config ⇒ Object

Configuration for this messaging campaign to send SMS messages.



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

def sms_config
  @sms_config
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'version' => :'version',
    
    :'division' => :'division',
    
    :'campaign_status' => :'campaignStatus',
    
    :'callable_time_set' => :'callableTimeSet',
    
    :'contact_list' => :'contactList',
    
    :'dnc_lists' => :'dncLists',
    
    :'always_running' => :'alwaysRunning',
    
    :'contact_sorts' => :'contactSorts',
    
    :'messages_per_minute' => :'messagesPerMinute',
    
    :'errors' => :'errors',
    
    :'sms_config' => :'smsConfig',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
141
142
143
144
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 108

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'version' => :'Integer',
    
    :'division' => :'DomainEntityRef',
    
    :'campaign_status' => :'String',
    
    :'callable_time_set' => :'DomainEntityRef',
    
    :'contact_list' => :'DomainEntityRef',
    
    :'dnc_lists' => :'Array<DomainEntityRef>',
    
    :'always_running' => :'BOOLEAN',
    
    :'contact_sorts' => :'Array<ContactSort>',
    
    :'messages_per_minute' => :'Integer',
    
    :'errors' => :'Array<RestErrorDetail>',
    
    :'sms_config' => :'SmsConfig',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 493

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 &&
      division == o.division &&
      campaign_status == o.campaign_status &&
      callable_time_set == o.callable_time_set &&
      contact_list == o.contact_list &&
      dnc_lists == o.dnc_lists &&
      always_running == o.always_running &&
      contact_sorts == o.contact_sorts &&
      messages_per_minute == o.messages_per_minute &&
      errors == o.errors &&
      sms_config == o.sms_config &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 606

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



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 527

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


516
517
518
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 516

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



522
523
524
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 522

def hash
  [id, name, date_created, date_modified, version, division, campaign_status, callable_time_set, contact_list, dnc_lists, always_running, contact_sorts, messages_per_minute, errors, sms_config, 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



309
310
311
312
313
314
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 309

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



589
590
591
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 589

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



594
595
596
597
598
599
600
601
602
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 594

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 



584
585
586
 
# File 'lib/purecloudplatformclientv2/models/messaging_campaign.rb', line 584

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["on", "stopping", "off", "complete", "invalid"]
  if @campaign_status && !allowed_values.include?(@campaign_status)
    return false
  end
  
  
  
  
  
  
  
  
  if @contact_list.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @messages_per_minute.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end