Class: PureCloud::ActionMap

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ActionMap

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#action ⇒ Object

The action that will be executed if this action map is triggered.



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

def action
  @action
end

#activation ⇒ Object

Type of activation.



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

def activation
  @activation
end

#created_date ⇒ Object

Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def created_date
  @created_date
end

#display_name ⇒ Object

Display name of the action map.



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

def display_name
  @display_name
end

#end_date ⇒ Object

Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



72
73
74
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 72

def end_date
  @end_date
end

#estimated_wait_time_limit ⇒ Object

The estimated wait time limit above which actions will not be offered.



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

def estimated_wait_time_limit
  @estimated_wait_time_limit
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#is_active ⇒ Object

Whether the action map is active.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 30

def is_active
  @is_active
end

#modified_date ⇒ Object

Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def modified_date
  @modified_date
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#page_url_conditions ⇒ Object

URL conditions that a page must match for web actions to be displayable.



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

def page_url_conditions
  @page_url_conditions
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#start_date ⇒ Object

Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_date
  @start_date
end

#trigger_with_event_conditions ⇒ Object

List of event conditions that must be satisfied to trigger the action map.



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

def trigger_with_event_conditions
  @trigger_with_event_conditions
end

#trigger_with_outcome_probability_conditions ⇒ Object

Probability conditions for outcomes that must be satisfied to trigger the action map.



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

def trigger_with_outcome_probability_conditions
  @trigger_with_outcome_probability_conditions
end

#trigger_with_segments ⇒ Object

Trigger action map if any segment in the list is assigned to a given customer.



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

def trigger_with_segments
  @trigger_with_segments
end

#version ⇒ Object

The version of the action map.



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

def version
  @version
end

#weight ⇒ Object

Weight of the action map with higher number denoting higher weight.



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

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



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
115
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 75

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'version' => :'version',
    
    :'is_active' => :'isActive',
    
    :'display_name' => :'displayName',
    
    :'trigger_with_segments' => :'triggerWithSegments',
    
    :'trigger_with_event_conditions' => :'triggerWithEventConditions',
    
    :'trigger_with_outcome_probability_conditions' => :'triggerWithOutcomeProbabilityConditions',
    
    :'page_url_conditions' => :'pageUrlConditions',
    
    :'activation' => :'activation',
    
    :'weight' => :'weight',
    
    :'action' => :'action',
    
    :'estimated_wait_time_limit' => :'estimatedWaitTimeLimit',
    
    :'self_uri' => :'selfUri',
    
    :'created_date' => :'createdDate',
    
    :'modified_date' => :'modifiedDate',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'version' => :'Integer',
    
    :'is_active' => :'BOOLEAN',
    
    :'display_name' => :'String',
    
    :'trigger_with_segments' => :'Array<String>',
    
    :'trigger_with_event_conditions' => :'Array<EventCondition>',
    
    :'trigger_with_outcome_probability_conditions' => :'Array<OutcomeProbabilityCondition>',
    
    :'page_url_conditions' => :'Array<UrlCondition>',
    
    :'activation' => :'Activation',
    
    :'weight' => :'Integer',
    
    :'action' => :'ActionMapAction',
    
    :'estimated_wait_time_limit' => :'Integer',
    
    :'self_uri' => :'String',
    
    :'created_date' => :'DateTime',
    
    :'modified_date' => :'DateTime',
    
    :'start_date' => :'DateTime',
    
    :'end_date' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 536

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      version == o.version &&
      is_active == o.is_active &&
      display_name == o.display_name &&
      trigger_with_segments == o.trigger_with_segments &&
      trigger_with_event_conditions == o.trigger_with_event_conditions &&
      trigger_with_outcome_probability_conditions == o.trigger_with_outcome_probability_conditions &&
      page_url_conditions == o.page_url_conditions &&
      activation == o.activation &&
      weight == o.weight &&
      action == o.action &&
      estimated_wait_time_limit == o.estimated_wait_time_limit &&
      self_uri == o.self_uri &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      start_date == o.start_date &&
      end_date == o.end_date
end

#_deserialize(type, value) ⇒ Object 



591
592
593
594
595
596
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
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 591

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



651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 651

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



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 572

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


561
562
563
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 561

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



567
568
569
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 567

def hash
  [id, name, version, is_active, display_name, trigger_with_segments, trigger_with_event_conditions, trigger_with_outcome_probability_conditions, page_url_conditions, activation, weight, action, estimated_wait_time_limit, self_uri, created_date, modified_date, start_date, end_date].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



343
344
345
346
347
348
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 343

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



634
635
636
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 634

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



639
640
641
642
643
644
645
646
647
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 639

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 



629
630
631
 
# File 'lib/purecloudplatformclientv2/models/action_map.rb', line 629

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



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

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

  
  
  
  
  
  if @trigger_with_segments.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @page_url_conditions.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end