Class: PureCloud::FlowReportResultItem

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

Overview

Report for one active (running) process found in result to a report request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowReportResultItem 



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

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[:'flowExecId']
    self.flow_exec_id = attributes[:'flowExecId']
  end
  
  if attributes[:'flowConfigId']
    self.flow_config_id = attributes[:'flowConfigId']
  end
  
  if attributes[:'flowInstanceName']
    self.flow_instance_name = attributes[:'flowInstanceName']
  end
  
  if attributes[:'associatedDocument']
    self.associated_document = attributes[:'associatedDocument']
  end
  
  if attributes[:'flowStatus']
    self.flow_status = attributes[:'flowStatus']
  end
  
  if attributes[:'currentState']
    self.current_state = attributes[:'currentState']
  end
  
  if attributes[:'startDateTime']
    self.start_date_time = attributes[:'startDateTime']
  end
  
  if attributes[:'endDateTime']
    self.end_date_time = attributes[:'endDateTime']
  end
  
  if attributes[:'workItemUserAssignees']
    if (value = attributes[:'workItemUserAssignees']).is_a?(Array)
      self.work_item_user_assignees = value
    end
  end
  
  if attributes[:'completedUser']
    self.completed_user = attributes[:'completedUser']
  end
  
  if attributes[:'completionReason']
    self.completion_reason = attributes[:'completionReason']
  end
  
  if attributes[:'flowErrorInfo']
    self.flow_error_info = attributes[:'flowErrorInfo']
  end
  
end

Instance Attribute Details

#associated_document ⇒ Object

the document for this flow (if this flow was launched via a document)



32
33
34
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 32

def associated_document
  @associated_document
end

#completed_user ⇒ Object

User that completed the flow



50
51
52
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 50

def completed_user
  @completed_user
end

#completion_reason ⇒ Object

Reason for completion



53
54
55
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 53

def completion_reason
  @completion_reason
end

#current_state ⇒ Object

The current state of the flow (EG what action is being processed)



38
39
40
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 38

def current_state
  @current_state
end

#end_date_time ⇒ Object

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



44
45
46
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 44

def end_date_time
  @end_date_time
end

#flow_config_id ⇒ Object

The flow config ID that this workitem was created from.



26
27
28
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 26

def flow_config_id
  @flow_config_id
end

#flow_error_info ⇒ Object

Additional information if the flow is in error



56
57
58
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 56

def flow_error_info
  @flow_error_info
end

#flow_exec_id ⇒ Object

The flow instance ID for this process



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

def flow_exec_id
  @flow_exec_id
end

#flow_instance_name ⇒ Object

The instance name for this flow in relation to its primary document. If the flow is not a document-centric type, this value will be empty.



29
30
31
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 29

def flow_instance_name
  @flow_instance_name
end

#flow_status ⇒ Object

The flow’s running status, which indicates whether the flow is running normally or in error, etc;



35
36
37
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 35

def flow_status
  @flow_status
end

#start_date_time ⇒ Object

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



41
42
43
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 41

def start_date_time
  @start_date_time
end

#work_item_user_assignees ⇒ Object

List of users currently assigned to a workItem



47
48
49
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 47

def work_item_user_assignees
  @work_item_user_assignees
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'flow_exec_id' => :'flowExecId',
    
    :'flow_config_id' => :'flowConfigId',
    
    :'flow_instance_name' => :'flowInstanceName',
    
    :'associated_document' => :'associatedDocument',
    
    :'flow_status' => :'flowStatus',
    
    :'current_state' => :'currentState',
    
    :'start_date_time' => :'startDateTime',
    
    :'end_date_time' => :'endDateTime',
    
    :'work_item_user_assignees' => :'workItemUserAssignees',
    
    :'completed_user' => :'completedUser',
    
    :'completion_reason' => :'completionReason',
    
    :'flow_error_info' => :'flowErrorInfo'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'flow_exec_id' => :'FlowExecId',
    :'flow_config_id' => :'FlowConfigId',
    :'flow_instance_name' => :'String',
    :'associated_document' => :'AssociatedDocument',
    :'flow_status' => :'String',
    :'current_state' => :'String',
    :'start_date_time' => :'DateTime',
    :'end_date_time' => :'DateTime',
    :'work_item_user_assignees' => :'Array<User>',
    :'completed_user' => :'User',
    :'completion_reason' => :'String',
    :'flow_error_info' => :'ErrorBody'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flow_exec_id == o.flow_exec_id &&
      flow_config_id == o.flow_config_id &&
      flow_instance_name == o.flow_instance_name &&
      associated_document == o.associated_document &&
      flow_status == o.flow_status &&
      current_state == o.current_state &&
      start_date_time == o.start_date_time &&
      end_date_time == o.end_date_time &&
      work_item_user_assignees == o.work_item_user_assignees &&
      completed_user == o.completed_user &&
      completion_reason == o.completion_reason &&
      flow_error_info == o.flow_error_info
end

#_deserialize(type, value) ⇒ Object 



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

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 284

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 205

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

See Also:

  • `==` method


195
196
197
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



200
201
202
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 200

def hash
  [flow_exec_id, flow_config_id, flow_instance_name, associated_document, flow_status, current_state, start_date_time, end_date_time, work_item_user_assignees, completed_user, completion_reason, flow_error_info].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



267
268
269
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 267

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



272
273
274
275
276
277
278
279
280
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 272

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 



262
263
264
 
# File 'lib/purecloud/models/flow_report_result_item.rb', line 262

def to_s
  to_hash.to_s
end