Class: PureCloud::CampaignSequenceNotification

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/campaign_sequence_notification.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignSequenceNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
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
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 103

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

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

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

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

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

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

  
end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



41
42
43
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 41

def additional_properties
  @additional_properties
end

#campaigns ⇒ Object

Returns the value of attribute campaigns.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 31

def campaigns
  @campaigns
end

#current_campaign ⇒ Object

Returns the value of attribute current_campaign.



33
34
35
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 33

def current_campaign
  @current_campaign
end

#date_created ⇒ Object

Returns the value of attribute date_created.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_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/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 27

def date_modified
  @date_modified
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 21

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 23

def name
  @name
end

#repeat ⇒ Object

Returns the value of attribute repeat.



39
40
41
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 39

def repeat
  @repeat
end

#status ⇒ Object

Returns the value of attribute status.



35
36
37
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 35

def status
  @status
end

#stop_message ⇒ Object

Returns the value of attribute stop_message.



37
38
39
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 37

def stop_message
  @stop_message
end

#version ⇒ Object

Returns the value of attribute version.



29
30
31
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 29

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 44

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'version' => :'version',
    
    :'campaigns' => :'campaigns',
    
    :'current_campaign' => :'currentCampaign',
    
    :'status' => :'status',
    
    :'stop_message' => :'stopMessage',
    
    :'repeat' => :'repeat',
    
    :'additional_properties' => :'additionalProperties'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 73

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'version' => :'Integer',
    
    :'campaigns' => :'Array<DocumentDataV2NotificationCreatedBy>',
    
    :'current_campaign' => :'Integer',
    
    :'status' => :'String',
    
    :'stop_message' => :'String',
    
    :'repeat' => :'BOOLEAN',
    
    :'additional_properties' => :'Object'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 344

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 &&
      campaigns == o.campaigns &&
      current_campaign == o.current_campaign &&
      status == o.status &&
      stop_message == o.stop_message &&
      repeat == o.repeat &&
      additional_properties == o.additional_properties
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 392

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



452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 452

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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 373

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


362
363
364
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 362

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



368
369
370
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 368

def hash
  [id, name, date_created, date_modified, version, campaigns, current_campaign, status, stop_message, repeat, 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



215
216
217
218
219
220
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 215

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



435
436
437
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 435

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



440
441
442
443
444
445
446
447
448
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 440

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 



430
431
432
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 430

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



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
 
# File 'lib/purecloudclient_v2a/models/campaign_sequence_notification.rb', line 224

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ON", "OFF", "COMPLETE"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end