class Pipedrive::MailMessageData
Attributes
The connection account ID
The insertion into the database time of the mail message
The array of mail message blind copies (object)
The mail message body URL
The array of mail message copies (object)
Whether the mail message is deleted or not
If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise null.
Whether the mail message is a draft or not
The array of mail message sender (object)
Whether the mail message has an attachment or not
Whether the mail message has a body or not
Whether the mail message has an inline attachment or not
Whether the mail message has an attachment (which is not inline) or not
ID of the mail message.
Whether the link tracking in mail message body is enabled.
ID of the mail message thread
The status of tracking mail message. Value is null if tracking is not enabled.
Creation or receival time of the mail message
Whether the mail message is read or not by the user
Whether the mail message has been sent or not
Whether the mail message has been sent from Pipedrive
app or not
Whether the mail message has been created by Smart Email BCC feature or not
The snippet of mail message. Snippet length is up to 225 characters.
The subject of mail message
Whether the mail message is synced with the provider or not
The array of mail message receiver (object)
The updating time in the database of the mail message
ID of the user whom mail message will be assigned to
We strongly advise you to avoid the use of this property. We will soon deprecate this property.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/pipedrive-openapi-client/models/mail_message_data.rb, line 419 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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.account_id = 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
List of attributes with nullable: true
# File lib/pipedrive-openapi-client/models/mail_message_data.rb, line 197 def self.openapi_nullable Set.new([ :'mail_tracking_status', ]) end
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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 && account_id == o.account_id && 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/pipedrive-openapi-client/models/mail_message_data.rb, line 406 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/pipedrive-openapi-client/models/mail_message_data.rb, line 412 def hash [id, from, to, cc, bcc, body_url, account_id, 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/pipedrive-openapi-client/models/mail_message_data.rb, line 345 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] mail_tracking_status
Object to be assigned
# File lib/pipedrive-openapi-client/models/mail_message_data.rb, line 360 def mail_tracking_status=(mail_tracking_status) validator = EnumAttributeValidator.new('String', ["opened", "not opened"]) unless validator.valid?(mail_tracking_status) fail ArgumentError, "invalid value for \"mail_tracking_status\", must be one of #{validator.allowable_values}." end @mail_tracking_status = mail_tracking_status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/pipedrive-openapi-client/models/mail_message_data.rb, line 486 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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