Class: Pipedrive::MailMessageData

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/models/mail_message_data.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MailMessageData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
244
245
246
247
248
249
250
251
252
253
254
255
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 205

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::MailMessageData` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Pipedrive::MailMessageData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

  if attributes.key?(:'body_url')
    self.body_url = attributes[:'body_url']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

  if attributes.key?(:'mail_thread_id')
    self.mail_thread_id = attributes[:'mail_thread_id']
  end

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

  if attributes.key?(:'snippet')
    self.snippet = attributes[:'snippet']
  end

  if attributes.key?(:'mail_tracking_status')
    self.mail_tracking_status = attributes[:'mail_tracking_status']
  end

  if attributes.key?(:'mail_link_tracking_enabled_flag')
    self.mail_link_tracking_enabled_flag = attributes[:'mail_link_tracking_enabled_flag']
  end

  if attributes.key?(:'read_flag')
    self.read_flag = attributes[:'read_flag']
  end

  if attributes.key?(:'draft')
    self.draft = attributes[:'draft']
  end

  if attributes.key?(:'draft_flag')
    self.draft_flag = attributes[:'draft_flag']
  end

  if attributes.key?(:'synced_flag')
    self.synced_flag = attributes[:'synced_flag']
  end

  if attributes.key?(:'deleted_flag')
    self.deleted_flag = attributes[:'deleted_flag']
  end

  if attributes.key?(:'has_body_flag')
    self.has_body_flag = attributes[:'has_body_flag']
  end

  if attributes.key?(:'sent_flag')
    self.sent_flag = attributes[:'sent_flag']
  end

  if attributes.key?(:'sent_from_pipedrive_flag')
    self.sent_from_pipedrive_flag = attributes[:'sent_from_pipedrive_flag']
  end

  if attributes.key?(:'smart_bcc_flag')
    self.smart_bcc_flag = attributes[:'smart_bcc_flag']
  end

  if attributes.key?(:'message_time')
    self.message_time = attributes[:'message_time']
  end

  if attributes.key?(:'add_time')
    self.add_time = attributes[:'add_time']
  end

  if attributes.key?(:'update_time')
    self.update_time = attributes[:'update_time']
  end

  if attributes.key?(:'has_attachments_flag')
    self.has_attachments_flag = attributes[:'has_attachments_flag']
  end

  if attributes.key?(:'has_inline_attachments_flag')
    self.has_inline_attachments_flag = attributes[:'has_inline_attachments_flag']
  end

  if attributes.key?(:'has_real_attachments_flag')
    self.has_real_attachments_flag = attributes[:'has_real_attachments_flag']
  end

  if attributes.key?(:'write_flag')
    self.write_flag = attributes[:'write_flag']
  end
end

Instance Attribute Details

#account_id ⇒ Object

The connection account ID



36
37
38
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 36

def 
  @account_id
end

#add_time ⇒ Object

The insertion into the database time of the mail message



87
88
89
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 87

def add_time
  @add_time
end

#bcc ⇒ Object

The array of mail message blind copies (object)



30
31
32
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 30

def bcc
  @bcc
end

#body_url ⇒ Object

The mail message body URL



33
34
35
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 33

def body_url
  @body_url
end

#cc ⇒ Object

The array of mail message copies (object)



27
28
29
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 27

def cc
  @cc
end

#deleted_flag ⇒ Object

Whether the mail message is deleted or not



69
70
71
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 69

def deleted_flag
  @deleted_flag
end

#draft ⇒ Object

If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise null.



60
61
62
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 60

def draft
  @draft
end

#draft_flag ⇒ Object

Whether the mail message is a draft or not



63
64
65
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 63

def draft_flag
  @draft_flag
end

#from ⇒ Object

The array of mail message sender (object)



21
22
23
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 21

def from
  @from
end

#has_attachments_flag ⇒ Object

Whether the mail message has an attachment or not



93
94
95
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 93

def has_attachments_flag
  @has_attachments_flag
end

#has_body_flag ⇒ Object

Whether the mail message has a body or not



72
73
74
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 72

def has_body_flag
  @has_body_flag
end

#has_inline_attachments_flag ⇒ Object

Whether the mail message has an inline attachment or not



96
97
98
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 96

def has_inline_attachments_flag
  @has_inline_attachments_flag
end

#has_real_attachments_flag ⇒ Object

Whether the mail message has an attachment (which is not inline) or not



99
100
101
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 99

def has_real_attachments_flag
  @has_real_attachments_flag
end

#id ⇒ Object

ID of the mail message.



18
19
20
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 18

def id
  @id
end

#mail_link_tracking_enabled_flag ⇒ Object

Whether the link tracking in mail message body is enabled.



54
55
56
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 54

def mail_link_tracking_enabled_flag
  @mail_link_tracking_enabled_flag
end

#mail_thread_id ⇒ Object

ID of the mail message thread



42
43
44
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 42

def mail_thread_id
  @mail_thread_id
end

#mail_tracking_status ⇒ Object

The status of tracking mail message. Value is null if tracking is not enabled.



51
52
53
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 51

def mail_tracking_status
  @mail_tracking_status
end

#message_time ⇒ Object

Creation or receival time of the mail message



84
85
86
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 84

def message_time
  @message_time
end

#read_flag ⇒ Object

Whether the mail message is read or not by the user



57
58
59
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 57

def read_flag
  @read_flag
end

#sent_flag ⇒ Object

Whether the mail message has been sent or not



75
76
77
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 75

def sent_flag
  @sent_flag
end

#sent_from_pipedrive_flag ⇒ Object

Whether the mail message has been sent from Pipedrive app or not



78
79
80
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 78

def sent_from_pipedrive_flag
  @sent_from_pipedrive_flag
end

#smart_bcc_flag ⇒ Object

Whether the mail message has been created by Smart Email BCC feature or not



81
82
83
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 81

def smart_bcc_flag
  @smart_bcc_flag
end

#snippet ⇒ Object

The snippet of mail message. Snippet length is up to 225 characters.



48
49
50
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 48

def snippet
  @snippet
end

#subject ⇒ Object

The subject of mail message



45
46
47
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 45

def subject
  @subject
end

#synced_flag ⇒ Object

Whether the mail message is synced with the provider or not



66
67
68
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 66

def synced_flag
  @synced_flag
end

#to ⇒ Object

The array of mail message receiver (object)



24
25
26
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 24

def to
  @to
end

#update_time ⇒ Object

The updating time in the database of the mail message



90
91
92
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 90

def update_time
  @update_time
end

#user_id ⇒ Object

ID of the user whom mail message will be assigned to



39
40
41
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 39

def user_id
  @user_id
end

#write_flag ⇒ Object

We strongly advise you to avoid the use of this property. We will soon deprecate this property.



102
103
104
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 102

def write_flag
  @write_flag
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 127

def self.attribute_map
  {
    :'id' => :'id',
    :'from' => :'from',
    :'to' => :'to',
    :'cc' => :'cc',
    :'bcc' => :'bcc',
    :'body_url' => :'body_url',
    :'account_id' => :'account_id',
    :'user_id' => :'user_id',
    :'mail_thread_id' => :'mail_thread_id',
    :'subject' => :'subject',
    :'snippet' => :'snippet',
    :'mail_tracking_status' => :'mail_tracking_status',
    :'mail_link_tracking_enabled_flag' => :'mail_link_tracking_enabled_flag',
    :'read_flag' => :'read_flag',
    :'draft' => :'draft',
    :'draft_flag' => :'draft_flag',
    :'synced_flag' => :'synced_flag',
    :'deleted_flag' => :'deleted_flag',
    :'has_body_flag' => :'has_body_flag',
    :'sent_flag' => :'sent_flag',
    :'sent_from_pipedrive_flag' => :'sent_from_pipedrive_flag',
    :'smart_bcc_flag' => :'smart_bcc_flag',
    :'message_time' => :'message_time',
    :'add_time' => :'add_time',
    :'update_time' => :'update_time',
    :'has_attachments_flag' => :'has_attachments_flag',
    :'has_inline_attachments_flag' => :'has_inline_attachments_flag',
    :'has_real_attachments_flag' => :'has_real_attachments_flag',
    :'write_flag' => :'write_flag'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



419
420
421
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 419

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



197
198
199
200
201
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 197

def self.openapi_nullable
  Set.new([
    :'mail_tracking_status',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 162

def self.openapi_types
  {
    :'id' => :'Integer',
    :'from' => :'Array<MailParticipant>',
    :'to' => :'Array<MailParticipant>',
    :'cc' => :'Array<MailParticipant>',
    :'bcc' => :'Array<MailParticipant>',
    :'body_url' => :'String',
    :'account_id' => :'String',
    :'user_id' => :'Integer',
    :'mail_thread_id' => :'Integer',
    :'subject' => :'String',
    :'snippet' => :'String',
    :'mail_tracking_status' => :'String',
    :'mail_link_tracking_enabled_flag' => :'NumberBooleanDefault0',
    :'read_flag' => :'NumberBooleanDefault0',
    :'draft' => :'String',
    :'draft_flag' => :'NumberBooleanDefault0',
    :'synced_flag' => :'NumberBooleanDefault0',
    :'deleted_flag' => :'NumberBooleanDefault0',
    :'has_body_flag' => :'NumberBooleanDefault0',
    :'sent_flag' => :'NumberBooleanDefault0',
    :'sent_from_pipedrive_flag' => :'NumberBooleanDefault0',
    :'smart_bcc_flag' => :'NumberBooleanDefault0',
    :'message_time' => :'Date',
    :'add_time' => :'Date',
    :'update_time' => :'Date',
    :'has_attachments_flag' => :'NumberBooleanDefault0',
    :'has_inline_attachments_flag' => :'NumberBooleanDefault0',
    :'has_real_attachments_flag' => :'NumberBooleanDefault0',
    :'write_flag' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 370

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      from == o.from &&
      to == o.to &&
      cc == o.cc &&
      bcc == o.bcc &&
      body_url == o.body_url &&
       == o. &&
      user_id == o.user_id &&
      mail_thread_id == o.mail_thread_id &&
      subject == o.subject &&
      snippet == o.snippet &&
      mail_tracking_status == o.mail_tracking_status &&
      mail_link_tracking_enabled_flag == o.mail_link_tracking_enabled_flag &&
      read_flag == o.read_flag &&
      draft == o.draft &&
      draft_flag == o.draft_flag &&
      synced_flag == o.synced_flag &&
      deleted_flag == o.deleted_flag &&
      has_body_flag == o.has_body_flag &&
      sent_flag == o.sent_flag &&
      sent_from_pipedrive_flag == o.sent_from_pipedrive_flag &&
      smart_bcc_flag == o.smart_bcc_flag &&
      message_time == o.message_time &&
      add_time == o.add_time &&
      update_time == o.update_time &&
      has_attachments_flag == o.has_attachments_flag &&
      has_inline_attachments_flag == o.has_inline_attachments_flag &&
      has_real_attachments_flag == o.has_real_attachments_flag &&
      write_flag == o.write_flag
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 447

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 =~ /\A(true|t|yes|y|1)\z/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
    Pipedrive.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 516

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 426

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


406
407
408
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 406

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



412
413
414
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 412

def hash
  [id, from, to, cc, bcc, body_url, , user_id, mail_thread_id, subject, snippet, mail_tracking_status, mail_link_tracking_enabled_flag, read_flag, draft, draft_flag, synced_flag, deleted_flag, has_body_flag, sent_flag, sent_from_pipedrive_flag, smart_bcc_flag, message_time, add_time, update_time, has_attachments_flag, has_inline_attachments_flag, has_real_attachments_flag, write_flag].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



345
346
347
348
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 345

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



492
493
494
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 492

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 498

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



486
487
488
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 486

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



352
353
354
355
356
 
# File 'lib/pipedrive-openapi-client/models/mail_message_data.rb', line 352

def valid?
  mail_tracking_status_validator = EnumAttributeValidator.new('String', ["opened", "not opened"])
  return false unless mail_tracking_status_validator.valid?(@mail_tracking_status)
  true
end