Class: Hubspot::Crm::Timeline::TimelineEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/timeline/models/timeline_event.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimelineEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 88

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?(:'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

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

Instance Attribute Details

#domain ⇒ Object

The event domain (often paired with utk).



32
33
34
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 32

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`).



23
24
25
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 23

def email
  @email
end

#event_template_id ⇒ Object

The event template ID.



20
21
22
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 20

def event_template_id
  @event_template_id
end

#extra_data ⇒ Object

Additional event-specific data that can be interpreted by the template’s markdown.



41
42
43
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 41

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.



46
47
48
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 46

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).



26
27
28
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 26

def object_id
  @object_id
end

#timeline_i_frame ⇒ Object

Returns the value of attribute timeline_i_frame.



43
44
45
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 43

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.



35
36
37
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 35

def timestamp
  @timestamp
end

#tokens ⇒ Object

A collection of token keys and values associated with the template tokens.



38
39
40
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 38

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.



29
30
31
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 29

def utk
  @utk
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 49

def self.attribute_map
  {
    :'event_template_id' => :'eventTemplateId',
    :'email' => :'email',
    :'object_id' => :'objectId',
    :'utk' => :'utk',
    :'domain' => :'domain',
    :'timestamp' => :'timestamp',
    :'tokens' => :'tokens',
    :'extra_data' => :'extraData',
    :'timeline_i_frame' => :'timelineIFrame',
    :'id' => :'id'
  }
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



204
205
206
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 204

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 65

def self.openapi_types
  {
    :'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',
    :'id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      id == o.id
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



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
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 232

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 301

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 211

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


191
192
193
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



197
198
199
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 197

def hash
  [event_template_id, email, object_id, utk, domain, timestamp, tokens, extra_data, timeline_i_frame, id].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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  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

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  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



277
278
279
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 277

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 283

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



271
272
273
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 271

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



165
166
167
168
169
170
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event.rb', line 165

def valid?
  return false if @event_template_id.nil?
  return false if @tokens.nil?
  return false if @id.nil?
  true
end