Class: PureCloud::ConversationChat

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationChat

Returns a new instance of ConversationChat.



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
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/purecloud/models/conversation_chat.rb', line 71

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[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'roomId']
    self.room_id = attributes[:'roomId']
  end
  
  if attributes[:'recordingId']
    self.recording_id = attributes[:'recordingId']
  end
  
  if attributes[:'segments']
    if (value = attributes[:'segments']).is_a?(Array)
      self.segments = value
    end
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  else
    self.held = false
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
end

Instance Attribute Details

#connected_timeObject

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



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

def connected_time
  @connected_time
end

#directionObject

Returns the value of attribute direction.



17
18
19
# File 'lib/purecloud/models/conversation_chat.rb', line 17

def direction
  @direction
end

#disconnect_typeObject

Returns the value of attribute disconnect_type.



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

def disconnect_type
  @disconnect_type
end

#heldObject

Returns the value of attribute held.



15
16
17
# File 'lib/purecloud/models/conversation_chat.rb', line 15

def held
  @held
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#recording_idObject

Returns the value of attribute recording_id.



11
12
13
# File 'lib/purecloud/models/conversation_chat.rb', line 11

def recording_id
  @recording_id
end

#room_idObject

Returns the value of attribute room_id.



9
10
11
# File 'lib/purecloud/models/conversation_chat.rb', line 9

def room_id
  @room_id
end

#segmentsObject

Returns the value of attribute segments.



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

def segments
  @segments
end

#start_hold_timeObject

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



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

def start_hold_time
  @start_hold_time
end

#stateObject

Returns the value of attribute state.



5
6
7
# File 'lib/purecloud/models/conversation_chat.rb', line 5

def state
  @state
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'id' => :'id',
    
    :'room_id' => :'roomId',
    
    :'recording_id' => :'recordingId',
    
    :'segments' => :'segments',
    
    :'held' => :'held',
    
    :'direction' => :'direction',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'connected_time' => :'connectedTime'
    
  }
end

.swagger_typesObject

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/purecloud/models/conversation_chat.rb', line 55

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'room_id' => :'String',
    :'recording_id' => :'String',
    :'segments' => :'Array<Segment>',
    :'held' => :'BOOLEAN',
    :'direction' => :'String',
    :'disconnect_type' => :'String',
    :'start_hold_time' => :'DateTime',
    :'connected_time' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/purecloud/models/conversation_chat.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      room_id == o.room_id &&
      recording_id == o.recording_id &&
      segments == o.segments &&
      held == o.held &&
      direction == o.direction &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      connected_time == o.connected_time
end

#_deserialize(type, value) ⇒ Object



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

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



254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/purecloud/models/conversation_chat.rb', line 254

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



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

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


168
169
170
# File 'lib/purecloud/models/conversation_chat.rb', line 168

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



173
174
175
# File 'lib/purecloud/models/conversation_chat.rb', line 173

def hash
  [state, id, room_id, recording_id, segments, held, direction, disconnect_type, start_hold_time, connected_time].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



237
238
239
# File 'lib/purecloud/models/conversation_chat.rb', line 237

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



242
243
244
245
246
247
248
249
250
# File 'lib/purecloud/models/conversation_chat.rb', line 242

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_sObject



232
233
234
# File 'lib/purecloud/models/conversation_chat.rb', line 232

def to_s
  to_hash.to_s
end