Class: PureCloud::FlowDetails

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

Overview

Details about the current state of a Flow Instance

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowDetails

Returns a new instance of FlowDetails.



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

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[:'flowConfigId']
    self.flow_config_id = attributes[:'flowConfigId']
  end
  
  if attributes[:'launchTime']
    self.launch_time = attributes[:'launchTime']
  end
  
  if attributes[:'launchType']
    self.launch_type = attributes[:'launchType']
  end
  
  if attributes[:'launchedBy']
    self.launched_by = attributes[:'launchedBy']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'associatedDocuments']
    if (value = attributes[:'associatedDocuments']).is_a?(Array)
      self.associated_documents = value
    end
  end
  
  if attributes[:'flowCompletionTime']
    self.flow_completion_time = attributes[:'flowCompletionTime']
  end
  
  if attributes[:'flowCompletionReason']
    self.flow_completion_reason = attributes[:'flowCompletionReason']
  end
  
  if attributes[:'flowErrorInfo']
    self.flow_error_info = attributes[:'flowErrorInfo']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#associated_documents ⇒ Object

The documents associated with this flow.



43
44
45
 
# File 'lib/purecloud/models/flow_details.rb', line 43

def associated_documents
  @associated_documents
end

#flow_completion_reason ⇒ Object

The completion reason set at the flow completion time, if applicable.



49
50
51
 
# File 'lib/purecloud/models/flow_details.rb', line 49

def flow_completion_reason
  @flow_completion_reason
end

#flow_completion_time ⇒ Object

The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def flow_completion_time
  @flow_completion_time
end

#flow_config_id ⇒ Object

The FlowConfigId that was used to launch this flow.



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

def flow_config_id
  @flow_config_id
end

#flow_error_info ⇒ Object

Additional information if the flow is in error



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

def flow_error_info
  @flow_error_info
end

#id ⇒ Object

The globally unique identifier for the object.



23
24
25
 
# File 'lib/purecloud/models/flow_details.rb', line 23

def id
  @id
end

#launch_time ⇒ Object

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



31
32
33
 
# File 'lib/purecloud/models/flow_details.rb', line 31

def launch_time
  @launch_time
end

#launch_type ⇒ Object

The launch mode for this flow instance.



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

def launch_type
  @launch_type
end

#launched_by ⇒ Object

The user who launched the flow, if the flow was launched as the result of that user’s action.



37
38
39
 
# File 'lib/purecloud/models/flow_details.rb', line 37

def launched_by
  @launched_by
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/purecloud/models/flow_details.rb', line 25

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



55
56
57
 
# File 'lib/purecloud/models/flow_details.rb', line 55

def self_uri
  @self_uri
end

#status ⇒ Object

The flow’s running status, which indicates whether the flow is running normally or completed, etc.



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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
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
 
# File 'lib/purecloud/models/flow_details.rb', line 58

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'flow_config_id' => :'flowConfigId',
    
    :'launch_time' => :'launchTime',
    
    :'launch_type' => :'launchType',
    
    :'launched_by' => :'launchedBy',
    
    :'status' => :'status',
    
    :'associated_documents' => :'associatedDocuments',
    
    :'flow_completion_time' => :'flowCompletionTime',
    
    :'flow_completion_reason' => :'flowCompletionReason',
    
    :'flow_error_info' => :'flowErrorInfo',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/purecloud/models/flow_details.rb', line 89

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'flow_config_id' => :'FlowConfigId',
    :'launch_time' => :'DateTime',
    :'launch_type' => :'String',
    :'launched_by' => :'User',
    :'status' => :'String',
    :'associated_documents' => :'Array<AssociatedDocument>',
    :'flow_completion_time' => :'DateTime',
    :'flow_completion_reason' => :'String',
    :'flow_error_info' => :'ErrorBody',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloud/models/flow_details.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      flow_config_id == o.flow_config_id &&
      launch_time == o.launch_time &&
      launch_type == o.launch_type &&
      launched_by == o.launched_by &&
      status == o.status &&
      associated_documents == o.associated_documents &&
      flow_completion_time == o.flow_completion_time &&
      flow_completion_reason == o.flow_completion_reason &&
      flow_error_info == o.flow_error_info &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/purecloud/models/flow_details.rb', line 292

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/purecloud/models/flow_details.rb', line 213

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


203
204
205
 
# File 'lib/purecloud/models/flow_details.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



208
209
210
 
# File 'lib/purecloud/models/flow_details.rb', line 208

def hash
  [id, name, flow_config_id, launch_time, launch_type, launched_by, status, associated_documents, flow_completion_time, flow_completion_reason, flow_error_info, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



275
276
277
 
# File 'lib/purecloud/models/flow_details.rb', line 275

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



280
281
282
283
284
285
286
287
288
 
# File 'lib/purecloud/models/flow_details.rb', line 280

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 



270
271
272
 
# File 'lib/purecloud/models/flow_details.rb', line 270

def to_s
  to_hash.to_s
end