Class: Hubspot::Marketing::Events::MarketingEventPublicReadResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MarketingEventPublicReadResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



121
122
123
124
125
126
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
160
161
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
195
196
197
198
199
200
201
202
203
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 121

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Marketing::Events::MarketingEventPublicReadResponse` 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::Marketing::Events::MarketingEventPublicReadResponse`. 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_name')
    self.event_name = attributes[:'event_name']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attendees ⇒ Object

The number of HubSpot contacts that attended this marketing event.



53
54
55
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 53

def attendees
  @attendees
end

#cancellations ⇒ Object

The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration.



56
57
58
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 56

def cancellations
  @cancellations
end

#created_at ⇒ Object

Returns the value of attribute created_at.



61
62
63
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 61

def created_at
  @created_at
end

#custom_properties ⇒ Object

A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account’s definition of the MarketingEvent Object. If they don’t they will be filtered out and not set. In order to do this you’ll need to create a new PropertyGroup on the HubSpot account’s MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.



44
45
46
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 44

def custom_properties
  @custom_properties
end

#end_date_time ⇒ Object

The end date and time of the marketing event.



29
30
31
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 29

def end_date_time
  @end_date_time
end

#event_cancelled ⇒ Object

Indicates if the marketing event has been cancelled.



41
42
43
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 41

def event_cancelled
  @event_cancelled
end

#event_description ⇒ Object

The description of the marketing event.



35
36
37
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 35

def event_description
  @event_description
end

#event_name ⇒ Object

The name of the marketing event.



20
21
22
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 20

def event_name
  @event_name
end

#event_organizer ⇒ Object

The name of the organizer of the marketing event.



32
33
34
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 32

def event_organizer
  @event_organizer
end

#event_type ⇒ Object

The type of the marketing event.



23
24
25
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 23

def event_type
  @event_type
end

#event_url ⇒ Object

A URL in the external event application where the marketing event can be managed.



38
39
40
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 38

def event_url
  @event_url
end

#external_event_id ⇒ Object

The id of the marketing event in the external event application.



47
48
49
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 47

def external_event_id
  @external_event_id
end

#id ⇒ Object

Returns the value of attribute id.



65
66
67
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 65

def id
  @id
end

#no_shows ⇒ Object

The number of HubSpot contacts that registered for this marketing event, but did not attend. This field only had a value when the event is over.



59
60
61
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 59

def no_shows
  @no_shows
end

#registrants ⇒ Object

The number of HubSpot contacts that registered for this marketing event.



50
51
52
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 50

def registrants
  @registrants
end

#start_date_time ⇒ Object

The start date and time of the marketing event.



26
27
28
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 26

def start_date_time
  @start_date_time
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



63
64
65
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 63

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 68

def self.attribute_map
  {
    :'event_name' => :'eventName',
    :'event_type' => :'eventType',
    :'start_date_time' => :'startDateTime',
    :'end_date_time' => :'endDateTime',
    :'event_organizer' => :'eventOrganizer',
    :'event_description' => :'eventDescription',
    :'event_url' => :'eventUrl',
    :'event_cancelled' => :'eventCancelled',
    :'custom_properties' => :'customProperties',
    :'external_event_id' => :'externalEventId',
    :'registrants' => :'registrants',
    :'attendees' => :'attendees',
    :'cancellations' => :'cancellations',
    :'no_shows' => :'noShows',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'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



307
308
309
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 307

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 91

def self.openapi_types
  {
    :'event_name' => :'String',
    :'event_type' => :'String',
    :'start_date_time' => :'DateTime',
    :'end_date_time' => :'DateTime',
    :'event_organizer' => :'String',
    :'event_description' => :'String',
    :'event_url' => :'String',
    :'event_cancelled' => :'Boolean',
    :'custom_properties' => :'Array<PropertyValue>',
    :'external_event_id' => :'String',
    :'registrants' => :'Integer',
    :'attendees' => :'Integer',
    :'cancellations' => :'Integer',
    :'no_shows' => :'Integer',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_name == o.event_name &&
      event_type == o.event_type &&
      start_date_time == o.start_date_time &&
      end_date_time == o.end_date_time &&
      event_organizer == o.event_organizer &&
      event_description == o.event_description &&
      event_url == o.event_url &&
      event_cancelled == o.event_cancelled &&
      custom_properties == o.custom_properties &&
      external_event_id == o.external_event_id &&
      registrants == o.registrants &&
      attendees == o.attendees &&
      cancellations == o.cancellations &&
      no_shows == o.no_shows &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 335

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::Marketing::Events.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



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 404

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 314

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


294
295
296
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



300
301
302
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 300

def hash
  [event_name, event_type, start_date_time, end_date_time, event_organizer, event_description, event_url, event_cancelled, custom_properties, external_event_id, registrants, attendees, cancellations, no_shows, created_at, updated_at, 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



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
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 207

def list_invalid_properties
  invalid_properties = Array.new
  if @event_name.nil?
    invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
  end

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

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

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

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

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

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

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

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at 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



380
381
382
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 380

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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 386

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



374
375
376
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 374

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 254

def valid?
  return false if @event_name.nil?
  return false if @event_organizer.nil?
  return false if @external_event_id.nil?
  return false if @registrants.nil?
  return false if @attendees.nil?
  return false if @cancellations.nil?
  return false if @no_shows.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @id.nil?
  true
end