Class: PureCloud::AnalyticsFlow

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsFlow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#ending_language ⇒ Object

Flow ending language, e.g. en-us



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 58

def ending_language
  @ending_language
end

#entry_reason ⇒ Object

The particular entry reason for this flow, e.g. an address, userId, or flowId



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

def entry_reason
  @entry_reason
end

#entry_type ⇒ Object

The entry type for this flow



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 40

def entry_type
  @entry_type
end

#exit_reason ⇒ Object

The exit reason for this flow, e.g. DISCONNECT



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 34

def exit_reason
  @exit_reason
end

#flow_id ⇒ Object

The unique identifier of this flow



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

def flow_id
  @flow_id
end

#flow_name ⇒ Object

The name of this flow



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

def flow_name
  @flow_name
end

#flow_type ⇒ Object

The type of this flow



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

def flow_type
  @flow_type
end

#flow_version ⇒ Object

The version of this flow



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 28

def flow_version
  @flow_version
end

#issued_callback ⇒ Object

Flag indicating whether the flow issued a callback



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 52

def issued_callback
  @issued_callback
end

#outcomes ⇒ Object

Flow outcomes



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

def outcomes
  @outcomes
end

#starting_language ⇒ Object

Flow starting language, e.g. en-us



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

def starting_language
  @starting_language
end

#transfer_target_address ⇒ Object

The address of a transfer target



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

def transfer_target_address
  @transfer_target_address
end

#transfer_target_name ⇒ Object

The name of a transfer target



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 46

def transfer_target_name
  @transfer_target_name
end

#transfer_type ⇒ Object

The type of transfer for flows that ended with a transfer



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

def transfer_type
  @transfer_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'flow_id' => :'flowId',
    
    :'flow_name' => :'flowName',
    
    :'flow_version' => :'flowVersion',
    
    :'flow_type' => :'flowType',
    
    :'exit_reason' => :'exitReason',
    
    :'entry_reason' => :'entryReason',
    
    :'entry_type' => :'entryType',
    
    :'transfer_type' => :'transferType',
    
    :'transfer_target_name' => :'transferTargetName',
    
    :'transfer_target_address' => :'transferTargetAddress',
    
    :'issued_callback' => :'issuedCallback',
    
    :'starting_language' => :'startingLanguage',
    
    :'ending_language' => :'endingLanguage',
    
    :'outcomes' => :'outcomes'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
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
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 99

def self.swagger_types
  {
    
    :'flow_id' => :'String',
    
    :'flow_name' => :'String',
    
    :'flow_version' => :'String',
    
    :'flow_type' => :'String',
    
    :'exit_reason' => :'String',
    
    :'entry_reason' => :'String',
    
    :'entry_type' => :'String',
    
    :'transfer_type' => :'String',
    
    :'transfer_target_name' => :'String',
    
    :'transfer_target_address' => :'String',
    
    :'issued_callback' => :'BOOLEAN',
    
    :'starting_language' => :'String',
    
    :'ending_language' => :'String',
    
    :'outcomes' => :'Array<AnalyticsFlowOutcome>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 444

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flow_id == o.flow_id &&
      flow_name == o.flow_name &&
      flow_version == o.flow_version &&
      flow_type == o.flow_type &&
      exit_reason == o.exit_reason &&
      entry_reason == o.entry_reason &&
      entry_type == o.entry_type &&
      transfer_type == o.transfer_type &&
      transfer_target_name == o.transfer_target_name &&
      transfer_target_address == o.transfer_target_address &&
      issued_callback == o.issued_callback &&
      starting_language == o.starting_language &&
      ending_language == o.ending_language &&
      outcomes == o.outcomes
end

#_deserialize(type, value) ⇒ Object 



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 495

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



555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 555

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



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 476

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


465
466
467
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 465

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



471
472
473
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 471

def hash
  [flow_id, flow_name, flow_version, flow_type, exit_reason, entry_reason, entry_type, transfer_type, transfer_target_name, transfer_target_address, issued_callback, starting_language, ending_language, outcomes].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



274
275
276
277
278
279
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 274

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



538
539
540
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 538

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



543
544
545
546
547
548
549
550
551
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 543

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 



533
534
535
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 533

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



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
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/purecloudplatformclientv2/models/analytics_flow.rb', line 283

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["BOT", "COMMONMODULE", "INBOUNDCALL", "INBOUNDCHAT", "INBOUNDEMAIL", "INBOUNDSHORTMESSAGE", "INQUEUECALL", "OUTBOUNDCALL", "SECURECALL", "SPEECH", "SURVEYINVITE", "WORKFLOW"]
  if @flow_type && !allowed_values.include?(@flow_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["dnis", "direct", "flow", "agent", "outbound"]
  if @entry_type && !allowed_values.include?(@entry_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end