Class: PureCloud::WorkItemDetails

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

Overview

Details about a WorkItem

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkItemDetails

Returns a new instance of WorkItemDetails.



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

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[:'workItemDefinition']
    self.work_item_definition = attributes[:'workItemDefinition']
  end
  
  if attributes[:'flowExecId']
    self.flow_exec_id = attributes[:'flowExecId']
  end
  
  if attributes[:'flowConfigId']
    self.flow_config_id = attributes[:'flowConfigId']
  end
  
  if attributes[:'flowCreateTime']
    self.flow_create_time = attributes[:'flowCreateTime']
  end
  
  if attributes[:'createTime']
    self.create_time = attributes[:'createTime']
  end
  
  if attributes[:'owner']
    self.owner = attributes[:'owner']
  end
  
  if attributes[:'offeredToUsers']
    if (value = attributes[:'offeredToUsers']).is_a?(Array)
      self.offered_to_users = value
    end
  end
  
  if attributes[:'offeredToQueues']
    if (value = attributes[:'offeredToQueues']).is_a?(Array)
      self.offered_to_queues = value
    end
  end
  
  if attributes[:'title']
    self.title = attributes[:'title']
  end
  
  if attributes[:'subtitle']
    self.subtitle = attributes[:'subtitle']
  end
  
  if attributes[:'associatedDocuments']
    if (value = attributes[:'associatedDocuments']).is_a?(Array)
      self.associated_documents = value
    end
  end
  
  if attributes[:'availableActions']
    self.available_actions = attributes[:'availableActions']
  end
  
  if attributes[:'dataValueInfo']
    self.data_value_info = attributes[:'dataValueInfo']
  end
  
  if attributes[:'workItemCache']
    self.work_item_cache = attributes[:'workItemCache']
  end
  
  if attributes[:'lastOfferedTime']
    self.last_offered_time = attributes[:'lastOfferedTime']
  end
  
  if attributes[:'lastOwnershipUpdateTime']
    self.last_ownership_update_time = attributes[:'lastOwnershipUpdateTime']
  end
  
  if attributes[:'currentTaskStartTime']
    self.current_task_start_time = attributes[:'currentTaskStartTime']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#associated_documents ⇒ Object

The documents associated with this workitem



57
58
59
 
# File 'lib/purecloud/models/work_item_details.rb', line 57

def associated_documents
  @associated_documents
end

#available_actions ⇒ Object

The actions that the user can take on this workitem (submit, transfer, etc).



60
61
62
 
# File 'lib/purecloud/models/work_item_details.rb', line 60

def available_actions
  @available_actions
end

#create_time ⇒ Object

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



39
40
41
 
# File 'lib/purecloud/models/work_item_details.rb', line 39

def create_time
  @create_time
end

#current_task_start_time ⇒ Object

This is the time when the current task that started the work item was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



75
76
77
 
# File 'lib/purecloud/models/work_item_details.rb', line 75

def current_task_start_time
  @current_task_start_time
end

#data_value_info ⇒ Object

The data items that provide values for any work item form elements, if applicable.



63
64
65
 
# File 'lib/purecloud/models/work_item_details.rb', line 63

def data_value_info
  @data_value_info
end

#flow_config_id ⇒ Object

The flow config ID that this workitem was created from.



33
34
35
 
# File 'lib/purecloud/models/work_item_details.rb', line 33

def flow_config_id
  @flow_config_id
end

#flow_create_time ⇒ Object

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



36
37
38
 
# File 'lib/purecloud/models/work_item_details.rb', line 36

def flow_create_time
  @flow_create_time
end

#flow_exec_id ⇒ Object

The flow instance ID that created this WorkItem



30
31
32
 
# File 'lib/purecloud/models/work_item_details.rb', line 30

def flow_exec_id
  @flow_exec_id
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#last_offered_time ⇒ Object

The time this work item was last offered to a user or queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



69
70
71
 
# File 'lib/purecloud/models/work_item_details.rb', line 69

def last_offered_time
  @last_offered_time
end

#last_ownership_update_time ⇒ Object

The most recent time a user assumed ownership of a work item. This may be blank if the work item has no owner. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



72
73
74
 
# File 'lib/purecloud/models/work_item_details.rb', line 72

def last_ownership_update_time
  @last_ownership_update_time
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#offered_to_queues ⇒ Object

List of queues that this workItem is offered to. May be null if only offered to users.



48
49
50
 
# File 'lib/purecloud/models/work_item_details.rb', line 48

def offered_to_queues
  @offered_to_queues
end

#offered_to_users ⇒ Object

List of users that this workItem is offered to. May be null if only offered to queues.



45
46
47
 
# File 'lib/purecloud/models/work_item_details.rb', line 45

def offered_to_users
  @offered_to_users
end

#owner ⇒ Object

The user currently working on/has responsibility for this WorkItem. May be null if no owner.



42
43
44
 
# File 'lib/purecloud/models/work_item_details.rb', line 42

def owner
  @owner
end

#self_uri ⇒ Object

The URI for this object



78
79
80
 
# File 'lib/purecloud/models/work_item_details.rb', line 78

def self_uri
  @self_uri
end

#subtitle ⇒ Object

The work item’s subtitle - 2nd line/description



54
55
56
 
# File 'lib/purecloud/models/work_item_details.rb', line 54

def subtitle
  @subtitle
end

#title ⇒ Object

The work item title



51
52
53
 
# File 'lib/purecloud/models/work_item_details.rb', line 51

def title
  @title
end

#work_item_cache ⇒ Object

The data items in the current work item cache, if one exists.



66
67
68
 
# File 'lib/purecloud/models/work_item_details.rb', line 66

def work_item_cache
  @work_item_cache
end

#work_item_definition ⇒ Object

Returns the value of attribute work_item_definition.



27
28
29
 
# File 'lib/purecloud/models/work_item_details.rb', line 27

def work_item_definition
  @work_item_definition
end

Class Method Details

.attribute_map ⇒ Object

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



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
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloud/models/work_item_details.rb', line 81

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'work_item_definition' => :'workItemDefinition',
    
    :'flow_exec_id' => :'flowExecId',
    
    :'flow_config_id' => :'flowConfigId',
    
    :'flow_create_time' => :'flowCreateTime',
    
    :'create_time' => :'createTime',
    
    :'owner' => :'owner',
    
    :'offered_to_users' => :'offeredToUsers',
    
    :'offered_to_queues' => :'offeredToQueues',
    
    :'title' => :'title',
    
    :'subtitle' => :'subtitle',
    
    :'associated_documents' => :'associatedDocuments',
    
    :'available_actions' => :'availableActions',
    
    :'data_value_info' => :'dataValueInfo',
    
    :'work_item_cache' => :'workItemCache',
    
    :'last_offered_time' => :'lastOfferedTime',
    
    :'last_ownership_update_time' => :'lastOwnershipUpdateTime',
    
    :'current_task_start_time' => :'currentTaskStartTime',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'work_item_definition' => :'WorkItemDefinition',
    :'flow_exec_id' => :'FlowExecId',
    :'flow_config_id' => :'FlowConfigId',
    :'flow_create_time' => :'DateTime',
    :'create_time' => :'DateTime',
    :'owner' => :'User',
    :'offered_to_users' => :'Array<User>',
    :'offered_to_queues' => :'Array<Queue>',
    :'title' => :'String',
    :'subtitle' => :'String',
    :'associated_documents' => :'Array<AssociatedDocument>',
    :'available_actions' => :'WorkItemActions',
    :'data_value_info' => :'DataValueInfo',
    :'work_item_cache' => :'WorkItemCache',
    :'last_offered_time' => :'DateTime',
    :'last_ownership_update_time' => :'DateTime',
    :'current_task_start_time' => :'DateTime',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/purecloud/models/work_item_details.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      work_item_definition == o.work_item_definition &&
      flow_exec_id == o.flow_exec_id &&
      flow_config_id == o.flow_config_id &&
      flow_create_time == o.flow_create_time &&
      create_time == o.create_time &&
      owner == o.owner &&
      offered_to_users == o.offered_to_users &&
      offered_to_queues == o.offered_to_queues &&
      title == o.title &&
      subtitle == o.subtitle &&
      associated_documents == o.associated_documents &&
      available_actions == o.available_actions &&
      data_value_info == o.data_value_info &&
      work_item_cache == o.work_item_cache &&
      last_offered_time == o.last_offered_time &&
      last_ownership_update_time == o.last_ownership_update_time &&
      current_task_start_time == o.current_task_start_time &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/purecloud/models/work_item_details.rb', line 365

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/purecloud/models/work_item_details.rb', line 286

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


276
277
278
 
# File 'lib/purecloud/models/work_item_details.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



281
282
283
 
# File 'lib/purecloud/models/work_item_details.rb', line 281

def hash
  [id, name, work_item_definition, flow_exec_id, flow_config_id, flow_create_time, create_time, owner, offered_to_users, offered_to_queues, title, subtitle, associated_documents, available_actions, data_value_info, work_item_cache, last_offered_time, last_ownership_update_time, current_task_start_time, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



348
349
350
 
# File 'lib/purecloud/models/work_item_details.rb', line 348

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



353
354
355
356
357
358
359
360
361
 
# File 'lib/purecloud/models/work_item_details.rb', line 353

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 



343
344
345
 
# File 'lib/purecloud/models/work_item_details.rb', line 343

def to_s
  to_hash.to_s
end