Class: Hubspot::Crm::Timeline::TimelineEvent
- Inherits:
-
Object
- Object
- Hubspot::Crm::Timeline::TimelineEvent
- Defined in:
- lib/hubspot/codegen/crm/timeline/models/timeline_event.rb
Overview
The state of the timeline event.
Instance Attribute Summary collapse
-
#domain ⇒ Object
The event domain (often paired with utk).
-
#email ⇒ Object
The email address used for contact-specific events.
-
#event_template_id ⇒ Object
The event template ID.
-
#extra_data ⇒ Object
Additional event-specific data that can be interpreted by the template’s markdown.
-
#id ⇒ Object
Identifier for the event.
-
#object_id ⇒ Object
The CRM object identifier.
-
#timeline_i_frame ⇒ Object
Returns the value of attribute timeline_i_frame.
-
#timestamp ⇒ Object
The time the event occurred.
-
#tokens ⇒ Object
A collection of token keys and values associated with the template tokens.
-
#utk ⇒ Object
Use the ‘utk` parameter to associate an event with a contact by `usertoken`.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TimelineEvent
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ TimelineEvent
Initializes the object
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 141 142 143 |
# 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. = 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 |
Instance Attribute Details
#domain ⇒ Object
The event domain (often paired with utk).
36 37 38 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 36 def domain @domain end |
#email ⇒ Object
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`).
27 28 29 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 27 def email @email end |
#event_template_id ⇒ Object
The event template ID.
24 25 26 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 24 def event_template_id @event_template_id end |
#extra_data ⇒ Object
Additional event-specific data that can be interpreted by the template’s markdown.
45 46 47 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 45 def extra_data @extra_data end |
#id ⇒ Object
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.
21 22 23 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 21 def id @id end |
#object_id ⇒ Object
The CRM object identifier. This is required for every event other than contacts (where utk or email can be used).
30 31 32 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 30 def object_id @object_id end |
#timeline_i_frame ⇒ Object
Returns the value of attribute timeline_i_frame.
47 48 49 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 47 def timeline_i_frame @timeline_i_frame end |
#timestamp ⇒ Object
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.
39 40 41 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 39 def @timestamp end |
#tokens ⇒ Object
A collection of token keys and values associated with the template tokens.
42 43 44 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 42 def tokens @tokens end |
#utk ⇒ Object
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.
33 34 35 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 33 def utk @utk end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# 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 |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
205 206 207 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 205 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
82 83 84 85 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 82 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# 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 && == o. && tokens == o.tokens && extra_data == o.extra_data && timeline_i_frame == o.timeline_i_frame end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
302 303 304 305 306 307 308 309 310 311 312 313 314 |
# 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# 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 |
#eql?(o) ⇒ Boolean
192 193 194 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 192 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
198 199 200 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 198 def hash [id, event_template_id, email, object_id, utk, domain, , tokens, extra_data, timeline_i_frame].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# 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 |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
278 279 280 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 278 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
284 285 286 287 288 289 290 291 292 293 294 295 296 |
# 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 |
#to_s ⇒ String
Returns the string representation of the object
272 273 274 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 272 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
166 167 168 169 170 171 |
# 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 |