Class: PureCloud::EmailMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/email_message.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailMessage

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 120

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

  
  if attributes.has_key?(:'to')
    
    if (value = attributes[:'to']).is_a?(Array)
      self.to = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'cc')
    
    if (value = attributes[:'cc']).is_a?(Array)
      self.cc = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'bcc')
    
    if (value = attributes[:'bcc']).is_a?(Array)
      self.bcc = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'from')
    
    
    self.from = attributes[:'from']
    
  
  end

  
  if attributes.has_key?(:'subject')
    
    
    self.subject = attributes[:'subject']
    
  
  end

  
  if attributes.has_key?(:'attachments')
    
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'textBody')
    
    
    self.text_body = attributes[:'textBody']
    
  
  end

  
  if attributes.has_key?(:'htmlBody')
    
    
    self.html_body = attributes[:'htmlBody']
    
  
  end

  
  if attributes.has_key?(:'time')
    
    
    self.time = attributes[:'time']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end

Instance Attribute Details

#attachments ⇒ Object

The attachments of the email message.



42
43
44
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 42

def attachments
  @attachments
end

#bcc ⇒ Object

The recipients that were blind copied on the email message.



33
34
35
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 33

def bcc
  @bcc
end

#cc ⇒ Object

The recipients that were copied on the email message.



30
31
32
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 30

def cc
  @cc
end

#from ⇒ Object

The sender of the email message.



36
37
38
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 36

def from
  @from
end

#html_body ⇒ Object

The html body of the email message.



48
49
50
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 48

def html_body
  @html_body
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 22

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



54
55
56
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 54

def self_uri
  @self_uri
end

#subject ⇒ Object

The subject of the email message.



39
40
41
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 39

def subject
  @subject
end

#text_body ⇒ Object

The text body of the email message.



45
46
47
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 45

def text_body
  @text_body
end

#time ⇒ Object

The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



51
52
53
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 51

def time
  @time
end

#to ⇒ Object

The recipients of the email message.



27
28
29
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 27

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 57

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'to' => :'to',
    
    :'cc' => :'cc',
    
    :'bcc' => :'bcc',
    
    :'from' => :'from',
    
    :'subject' => :'subject',
    
    :'attachments' => :'attachments',
    
    :'text_body' => :'textBody',
    
    :'html_body' => :'htmlBody',
    
    :'time' => :'time',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 88

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'to' => :'Array<EmailAddress>',
    
    :'cc' => :'Array<EmailAddress>',
    
    :'bcc' => :'Array<EmailAddress>',
    
    :'from' => :'EmailAddress',
    
    :'subject' => :'String',
    
    :'attachments' => :'Array<Attachment>',
    
    :'text_body' => :'String',
    
    :'html_body' => :'String',
    
    :'time' => :'DateTime',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 386

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      to == o.to &&
      cc == o.cc &&
      bcc == o.bcc &&
      from == o.from &&
      subject == o.subject &&
      attachments == o.attachments &&
      text_body == o.text_body &&
      html_body == o.html_body &&
      time == o.time &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 435

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



495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 495

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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 416

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


405
406
407
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 405

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



411
412
413
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 411

def hash
  [id, name, to, cc, bcc, from, subject, attachments, text_body, html_body, time, self_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



247
248
249
250
251
252
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 247

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



478
479
480
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 478

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



483
484
485
486
487
488
489
490
491
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 483

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 



473
474
475
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 473

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



256
257
258
259
260
261
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/purecloudclient_v2a/models/email_message.rb', line 256

def valid?
  
  
  
  
  
  
  
  
  
  
  if @to.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @from.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @text_body.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end