Class: Hubspot::Marketing::Events::MarketingEventCreateRequestParams
- Inherits:
-
Object
- Object
- Hubspot::Marketing::Events::MarketingEventCreateRequestParams
- Defined in:
- lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb
Instance Attribute Summary collapse
-
#custom_properties ⇒ Object
A list of PropertyValues.
-
#end_date_time ⇒ Object
The end date and time of the marketing event.
-
#event_cancelled ⇒ Object
Indicates if the marketing event has been cancelled.
-
#event_description ⇒ Object
The description of the marketing event.
-
#event_name ⇒ Object
The name of the marketing event.
-
#event_organizer ⇒ Object
The name of the organizer of the marketing event.
-
#event_type ⇒ Object
Describes what type of event this is.
-
#event_url ⇒ Object
A URL in the external event application where the marketing event can be managed.
-
#external_account_id ⇒ Object
The accountId that is associated with this marketing event in the external event application.
-
#external_event_id ⇒ Object
The id of the marketing event in the external event application.
-
#start_date_time ⇒ Object
The start date and time of the marketing event.
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 = {}) ⇒ MarketingEventCreateRequestParams
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 = {}) ⇒ MarketingEventCreateRequestParams
Initializes the object
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 144 145 146 147 148 149 150 151 152 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 94 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?(:'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_account_id') self.external_account_id = attributes[:'external_account_id'] end if attributes.key?(:'external_event_id') self.external_event_id = attributes[:'external_event_id'] 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.
44 45 46 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.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_create_request_params.rb', line 29 def end_date_time @end_date_time end |
#event_cancelled ⇒ Object
Indicates if the marketing event has been cancelled. Defaults to ‘false`
41 42 43 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.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_create_request_params.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_create_request_params.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_create_request_params.rb', line 32 def event_organizer @event_organizer end |
#event_type ⇒ Object
Describes what type of event this is. For example: ‘WEBINAR`, `CONFERENCE`, `WORKSHOP`
23 24 25 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.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_create_request_params.rb', line 38 def event_url @event_url end |
#external_account_id ⇒ Object
The accountId that is associated with this marketing event in the external event application.
47 48 49 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 47 def external_account_id @external_account_id end |
#external_event_id ⇒ Object
The id of the marketing event in the external event application.
50 51 52 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 50 def external_event_id @external_event_id 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_create_request_params.rb', line 26 def start_date_time @start_date_time end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 53 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_account_id' => :'externalAccountId', :'external_event_id' => :'externalEventId' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
220 221 222 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 220 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
87 88 89 90 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 87 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 70 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_account_id' => :'String', :'external_event_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 189 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_account_id == o.external_account_id && external_event_id == o.external_event_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 248 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
317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 317 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
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 227 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
207 208 209 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 207 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
213 214 215 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 213 def hash [event_name, event_type, start_date_time, end_date_time, event_organizer, event_description, event_url, event_cancelled, custom_properties, external_account_id, external_event_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 156 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_account_id.nil? invalid_properties.push('invalid value for "external_account_id", external_account_id 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 invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
293 294 295 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 293 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 299 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
287 288 289 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 287 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
179 180 181 182 183 184 185 |
# File 'lib/hubspot/codegen/marketing/events/models/marketing_event_create_request_params.rb', line 179 def valid? return false if @event_name.nil? return false if @event_organizer.nil? return false if @external_account_id.nil? return false if @external_event_id.nil? true end |