Class: PureCloud::Email

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Email

Returns a new instance of Email.



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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/purecloud/models/email.rb', line 118

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[:'held']
    self.held = attributes[:'held']
  end
  
  if attributes[:'subject']
    self.subject = attributes[:'subject']
  end
  
  if attributes[:'messagesSent']
    self.messages_sent = attributes[:'messagesSent']
  end
  
  if attributes[:'segments']
    if (value = attributes[:'segments']).is_a?(Array)
      self.segments = value
    end
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'recordingId']
    self.recording_id = attributes[:'recordingId']
  end
  
  if attributes[:'errorInfo']
    self.error_info = attributes[:'errorInfo']
  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
  
  if attributes[:'disconnectedTime']
    self.disconnected_time = attributes[:'disconnectedTime']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
end

Instance Attribute Details

#connected_time ⇒ Object

The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def connected_time
  @connected_time
end

#direction ⇒ Object

The direction of the email



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

def direction
  @direction
end

#disconnect_type ⇒ Object

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.



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

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def disconnected_time
  @disconnected_time
end

#error_info ⇒ Object

Returns the value of attribute error_info.



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

def error_info
  @error_info
end

#held ⇒ Object

True if this call is held and the person on this side hears silence.



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

def held
  @held
end

#id ⇒ Object

A globally unique identifier for this communication.



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

def id
  @id
end

#messages_sent ⇒ Object

The number of email messages sent by this participant.



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

def messages_sent
  @messages_sent
end

#provider ⇒ Object

The source provider for the email.



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

def provider
  @provider
end

#recording_id ⇒ Object

A globally unique identifier for the recording associated with this call.



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

def recording_id
  @recording_id
end

#segments ⇒ Object

The time line of the participant’s email, divided into activity segments.



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

def segments
  @segments
end

#start_hold_time ⇒ Object

The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

The connection state of this communication.



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

def state
  @state
end

#subject ⇒ Object

The subject for the initial email that started this conversation.



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

def subject
  @subject
end

Class Method Details

.attribute_map ⇒ Object

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



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
88
89
90
91
92
93
94
95
 
# File 'lib/purecloud/models/email.rb', line 63

def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'id' => :'id',
    
    :'held' => :'held',
    
    :'subject' => :'subject',
    
    :'messages_sent' => :'messagesSent',
    
    :'segments' => :'segments',
    
    :'direction' => :'direction',
    
    :'recording_id' => :'recordingId',
    
    :'error_info' => :'errorInfo',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'provider' => :'provider'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/purecloud/models/email.rb', line 98

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'held' => :'BOOLEAN',
    :'subject' => :'String',
    :'messages_sent' => :'Integer',
    :'segments' => :'Array<Segment>',
    :'direction' => :'String',
    :'recording_id' => :'String',
    :'error_info' => :'ErrorBody',
    :'disconnect_type' => :'String',
    :'start_hold_time' => :'DateTime',
    :'connected_time' => :'DateTime',
    :'disconnected_time' => :'DateTime',
    :'provider' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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

#_deserialize(type, value) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/purecloud/models/email.rb', line 262

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/purecloud/models/email.rb', line 322

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/purecloud/models/email.rb', line 243

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


233
234
235
 
# File 'lib/purecloud/models/email.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



238
239
240
 
# File 'lib/purecloud/models/email.rb', line 238

def hash
  [state, id, held, subject, messages_sent, segments, direction, recording_id, error_info, disconnect_type, start_hold_time, connected_time, disconnected_time, provider].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



305
306
307
 
# File 'lib/purecloud/models/email.rb', line 305

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



310
311
312
313
314
315
316
317
318
 
# File 'lib/purecloud/models/email.rb', line 310

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 



300
301
302
 
# File 'lib/purecloud/models/email.rb', line 300

def to_s
  to_hash.to_s
end