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.



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloud/models/email.rb', line 81

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']
  else
    self.held = false
  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
  
end

Instance Attribute Details

#connected_time ⇒ Object

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



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

def connected_time
  @connected_time
end

#direction ⇒ Object

Returns the value of attribute direction.



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

def direction
  @direction
end

#disconnect_type ⇒ Object

Returns the value of attribute disconnect_type.



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

def disconnect_type
  @disconnect_type
end

#error_info ⇒ Object

Returns the value of attribute error_info.



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

def error_info
  @error_info
end

#held ⇒ Object

Returns the value of attribute held.



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

def held
  @held
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#messages_sent ⇒ Object

Returns the value of attribute messages_sent.



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

def messages_sent
  @messages_sent
end

#recording_id ⇒ Object

Returns the value of attribute recording_id.



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

def recording_id
  @recording_id
end

#segments ⇒ Object

Returns the value of attribute segments.



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

def segments
  @segments
end

#start_hold_time ⇒ Object

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



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

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#subject ⇒ Object

Returns the value of attribute subject.



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

def subject
  @subject
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloud/models/email.rb', line 32

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'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/purecloud/models/email.rb', line 63

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'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/purecloud/models/email.rb', line 170

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
end

#_deserialize(type, value) ⇒ Object 



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
248
249
250
 
# File 'lib/purecloud/models/email.rb', line 217

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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/purecloud/models/email.rb', line 274

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloud/models/email.rb', line 198

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


188
189
190
 
# File 'lib/purecloud/models/email.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



193
194
195
 
# File 'lib/purecloud/models/email.rb', line 193

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



257
258
259
 
# File 'lib/purecloud/models/email.rb', line 257

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



262
263
264
265
266
267
268
269
270
 
# File 'lib/purecloud/models/email.rb', line 262

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 



252
253
254
 
# File 'lib/purecloud/models/email.rb', line 252

def to_s
  to_hash.to_s
end