class Hubspot::Crm::Timeline::TimelineEvent
The state of the timeline event.
Attributes
The event domain (often paired with utk).
The email address used for contact-specific events. This can be used to identify existing contacts, create new ones, or change the email for an existing contact (if paired with the `objectId`).
The event template ID.
Additional event-specific data that can be interpreted by the template's markdown.
Identifier for the event. This is optional, and we recommend you do not pass this in. We will create one for you if you omit this. You can also use `{{uuid}}` anywhere in the ID to generate a unique string, guaranteeing uniqueness.
The CRM object identifier. This is required for every event other than contacts (where utk or email can be used).
The time the event occurred. If not passed in, the curren time will be assumed. This is used to determine where an event is shown on a CRM object's timeline.
A collection of token keys and values associated with the template tokens.
Use the `utk` parameter to associate an event with a contact by `usertoken`. This is recommended if you don't know a user's email, but have an identifying user token in your cookie.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 50 def self.attribute_map { :'id' => :'id', :'event_template_id' => :'eventTemplateId', :'email' => :'email', :'object_id' => :'objectId', :'utk' => :'utk', :'domain' => :'domain', :'timestamp' => :'timestamp', :'tokens' => :'tokens', :'extra_data' => :'extraData', :'timeline_i_frame' => :'timelineIFrame' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 205 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/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 89 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Timeline::TimelineEvent` 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 `Hubspot::Crm::Timeline::TimelineEvent`. 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?(:'event_template_id') self.event_template_id = attributes[:'event_template_id'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'object_id') self.object_id = attributes[:'object_id'] end if attributes.key?(:'utk') self.utk = attributes[:'utk'] end if attributes.key?(:'domain') self.domain = attributes[:'domain'] end if attributes.key?(:'timestamp') self.timestamp = attributes[:'timestamp'] end if attributes.key?(:'tokens') if (value = attributes[:'tokens']).is_a?(Hash) self.tokens = value end end if attributes.key?(:'extra_data') self.extra_data = attributes[:'extra_data'] end if attributes.key?(:'timeline_i_frame') self.timeline_i_frame = attributes[:'timeline_i_frame'] end end
List of attributes with nullable: true
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 82 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 66 def self.openapi_types { :'id' => :'String', :'event_template_id' => :'String', :'email' => :'String', :'object_id' => :'String', :'utk' => :'String', :'domain' => :'String', :'timestamp' => :'DateTime', :'tokens' => :'Hash<String, String>', :'extra_data' => :'Object', :'timeline_i_frame' => :'TimelineEventIFrame' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 175 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && event_template_id == o.event_template_id && email == o.email && object_id == o.object_id && utk == o.utk && domain == o.domain && timestamp == o.timestamp && tokens == o.tokens && extra_data == o.extra_data && timeline_i_frame == o.timeline_i_frame 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/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 233 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 Hubspot::Crm::Timeline.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/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 302 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/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 212 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/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 192 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 198 def hash [id, event_template_id, email, object_id, utk, domain, timestamp, tokens, extra_data, timeline_i_frame].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 147 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @event_template_id.nil? invalid_properties.push('invalid value for "event_template_id", event_template_id cannot be nil.') end if @tokens.nil? invalid_properties.push('invalid value for "tokens", tokens cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 284 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/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 272 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/hubspot/codegen/crm/timeline/models/timeline_event.rb, line 166 def valid? return false if @id.nil? return false if @event_template_id.nil? return false if @tokens.nil? true end