Class: PureCloud::FlowHistoryItem

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

Overview

Information about one flow history item

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowHistoryItem

Returns a new instance of FlowHistoryItem.



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/purecloud/models/flow_history_item.rb', line 68

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[:'historyEventTime']
    self.history_event_time = attributes[:'historyEventTime']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'workItem']
    self.work_item = attributes[:'workItem']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
  if attributes[:'historyEventData']
    if (value = attributes[:'historyEventData']).is_a?(Array)
      self.history_event_data = value
    end
  end
  
  if attributes[:'historyEventType']
    self.history_event_type = attributes[:'historyEventType']
  end
  
  if attributes[:'success']
    self.success = attributes[:'success']
  else
    self.success = false
  end
  
end

Instance Attribute Details

#history_event_data ⇒ Object

Data elements associated with this history event.



22
23
24
 
# File 'lib/purecloud/models/flow_history_item.rb', line 22

def history_event_data
  @history_event_data
end

#history_event_time ⇒ Object

The time when the history item occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



7
8
9
 
# File 'lib/purecloud/models/flow_history_item.rb', line 7

def history_event_time
  @history_event_time
end

#history_event_type ⇒ Object

The type of the history event being reported.



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

def history_event_type
  @history_event_type
end

#queue ⇒ Object

The queue associated with this history event, if applicable.



19
20
21
 
# File 'lib/purecloud/models/flow_history_item.rb', line 19

def queue
  @queue
end

#state ⇒ Object

The State sequence that applies to the history event, if applicable.



10
11
12
 
# File 'lib/purecloud/models/flow_history_item.rb', line 10

def state
  @state
end

#success ⇒ Object

Whether or not the flow item was successful (if a ‘notification’ event this will default to true)



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

def success
  @success
end

#user ⇒ Object

The user associated with this history event, if applicable.



16
17
18
 
# File 'lib/purecloud/models/flow_history_item.rb', line 16

def user
  @user
end

#work_item ⇒ Object

Information about the work item associated with the history event, if applicable.



13
14
15
 
# File 'lib/purecloud/models/flow_history_item.rb', line 13

def work_item
  @work_item
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/purecloud/models/flow_history_item.rb', line 31

def self.attribute_map
  {
    
    :'history_event_time' => :'historyEventTime',
    
    :'state' => :'state',
    
    :'work_item' => :'workItem',
    
    :'user' => :'user',
    
    :'queue' => :'queue',
    
    :'history_event_data' => :'historyEventData',
    
    :'history_event_type' => :'historyEventType',
    
    :'success' => :'success'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloud/models/flow_history_item.rb', line 54

def self.swagger_types
  {
    :'history_event_time' => :'DateTime',
    :'state' => :'FlowState',
    :'work_item' => :'WorkItem',
    :'user' => :'User',
    :'queue' => :'Queue',
    :'history_event_data' => :'Array<DataItem>',
    :'history_event_type' => :'String',
    :'success' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/purecloud/models/flow_history_item.rb', line 123

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      history_event_time == o.history_event_time &&
      state == o.state &&
      work_item == o.work_item &&
      user == o.user &&
      queue == o.queue &&
      history_event_data == o.history_event_data &&
      history_event_type == o.history_event_type &&
      success == o.success
end

#_deserialize(type, value) ⇒ Object 



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/purecloud/models/flow_history_item.rb', line 223

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/purecloud/models/flow_history_item.rb', line 147

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


137
138
139
 
# File 'lib/purecloud/models/flow_history_item.rb', line 137

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



142
143
144
 
# File 'lib/purecloud/models/flow_history_item.rb', line 142

def hash
  [history_event_time, state, work_item, user, queue, history_event_data, history_event_type, success].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



206
207
208
 
# File 'lib/purecloud/models/flow_history_item.rb', line 206

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



211
212
213
214
215
216
217
218
219
 
# File 'lib/purecloud/models/flow_history_item.rb', line 211

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 



201
202
203
 
# File 'lib/purecloud/models/flow_history_item.rb', line 201

def to_s
  to_hash.to_s
end