Class: Hubspot::Marketing::Events::MarketingEventCreateRequestParams

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MarketingEventCreateRequestParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 104

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

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

Instance Attribute Details

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



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

def custom_properties
  @custom_properties
end

#end_date_time ⇒ Object

The end date and time of the marketing event.



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

def end_date_time
  @end_date_time
end

#event_cancelled ⇒ Object

Indicates if the marketing event has been cancelled. Defaults to ‘false`



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

def event_cancelled
  @event_cancelled
end

#event_completed ⇒ Object

Returns the value of attribute event_completed.



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

def event_completed
  @event_completed
end

#event_description ⇒ Object

The description of the marketing event.



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

def event_description
  @event_description
end

#event_name ⇒ Object

The name of the marketing event.



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

def event_name
  @event_name
end

#event_organizer ⇒ Object

The name of the organizer of the marketing event.



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

def event_organizer
  @event_organizer
end

#event_type ⇒ Object

Describes what type of event this is. For example: ‘WEBINAR`, `CONFERENCE`, `WORKSHOP`



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

def event_type
  @event_type
end

#event_url ⇒ Object

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



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

def event_url
  @event_url
end

#external_account_id ⇒ Object

The accountId that is associated with this marketing event in the external event application.



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

def 
  @external_account_id
end

#external_event_id ⇒ Object

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



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

def external_event_id
  @external_event_id
end

#start_date_time ⇒ Object

The start date and time of the marketing event.



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

def start_date_time
  @start_date_time
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 56

def self.attribute_map
  {
    :'start_date_time' => :'startDateTime',
    :'custom_properties' => :'customProperties',
    :'external_account_id' => :'externalAccountId',
    :'event_cancelled' => :'eventCancelled',
    :'event_organizer' => :'eventOrganizer',
    :'event_url' => :'eventUrl',
    :'external_event_id' => :'externalEventId',
    :'event_description' => :'eventDescription',
    :'event_name' => :'eventName',
    :'event_type' => :'eventType',
    :'event_completed' => :'eventCompleted',
    :'end_date_time' => :'endDateTime'
  }
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



235
236
237
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 235

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 79

def self.openapi_types
  {
    :'start_date_time' => :'Time',
    :'custom_properties' => :'Array<PropertyValue>',
    :'external_account_id' => :'String',
    :'event_cancelled' => :'Boolean',
    :'event_organizer' => :'String',
    :'event_url' => :'String',
    :'external_event_id' => :'String',
    :'event_description' => :'String',
    :'event_name' => :'String',
    :'event_type' => :'String',
    :'event_completed' => :'Boolean',
    :'end_date_time' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 203

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 266

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 337

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 242

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


222
223
224
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



228
229
230
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 228

def hash
  [start_date_time, custom_properties, , event_cancelled, event_organizer, event_url, external_event_id, event_description, event_name, event_type, event_completed, end_date_time].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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  if @external_account_id.nil?
    invalid_properties.push('invalid value for "external_account_id", external_account_id 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 @event_name.nil?
    invalid_properties.push('invalid value for "event_name", event_name 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



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

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 319

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



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

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



193
194
195
196
197
198
199
 
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 193

def valid?
  return false if @external_account_id.nil?
  return false if @event_organizer.nil?
  return false if @external_event_id.nil?
  return false if @event_name.nil?
  true
end