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



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 134

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?(:'registrants')
    self.registrants = attributes[:'registrants']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attendees ⇒ Object

The number of HubSpot contacts that attended this marketing event.



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

def attendees
  @attendees
end

#cancellations ⇒ Object

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



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

def cancellations
  @cancellations
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

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.



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

def custom_properties
  @custom_properties
end

#end_date_time ⇒ Object

The end date and time of the marketing event.



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

def end_date_time
  @end_date_time
end

#event_cancelled ⇒ Object

Indicates if the marketing event has been cancelled.



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

def event_cancelled
  @event_cancelled
end

#event_completed ⇒ Object

Returns the value of attribute event_completed.



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

def event_completed
  @event_completed
end

#event_description ⇒ Object

The description of the marketing event.



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

def event_description
  @event_description
end

#event_name ⇒ Object

The name of the marketing event.



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

def event_name
  @event_name
end

#event_organizer ⇒ Object

The name of the organizer of the marketing event.



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

def event_organizer
  @event_organizer
end

#event_type ⇒ Object

The type of the marketing event.



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

def event_type
  @event_type
end

#event_url ⇒ Object

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



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

def event_url
  @event_url
end

#external_event_id ⇒ Object

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



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

def external_event_id
  @external_event_id
end

#id ⇒ Object

Returns the value of attribute id.



68
69
70
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 68

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.



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

def no_shows
  @no_shows
end

#registrants ⇒ Object

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



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

def registrants
  @registrants
end

#start_date_time ⇒ Object

The start date and time of the marketing event.



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

def start_date_time
  @start_date_time
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



71
72
73
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 71

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 74

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



325
326
327
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 325

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 103

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 287

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 356

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Hubspot::Marketing::Events.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 427

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 332

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


312
313
314
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 312

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



318
319
320
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 318

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



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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 224

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

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

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

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

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

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at 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 @event_name.nil?
    invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
  end

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

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



403
404
405
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 403

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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 409

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



397
398
399
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 397

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb', line 271

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