Class: Hubspot::Marketing::Events::PropertyValue

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PropertyValue

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#data_sensitivity ⇒ Object

Returns the value of attribute data_sensitivity.



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

def data_sensitivity
  @data_sensitivity
end

#is_encrypted ⇒ Object

Returns the value of attribute is_encrypted.



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

def is_encrypted
  @is_encrypted
end

#is_large_value ⇒ Object

Returns the value of attribute is_large_value.



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

def is_large_value
  @is_large_value
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#persistence_timestamp ⇒ Object

Returns the value of attribute persistence_timestamp.



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

def persistence_timestamp
  @persistence_timestamp
end

#request_id ⇒ Object

Returns the value of attribute request_id.



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

def request_id
  @request_id
end

#selected_by_user ⇒ Object

Returns the value of attribute selected_by_user.



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

def selected_by_user
  @selected_by_user
end

#selected_by_user_timestamp ⇒ Object

Returns the value of attribute selected_by_user_timestamp.



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

def selected_by_user_timestamp
  @selected_by_user_timestamp
end

#source ⇒ Object

Returns the value of attribute source.



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

def source
  @source
end

#source_id ⇒ Object

Returns the value of attribute source_id.



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

def source_id
  @source_id
end

#source_label ⇒ Object

Returns the value of attribute source_label.



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

def source_label
  @source_label
end

#source_metadata ⇒ Object

Source metadata encoded as a base64 string. For example: ‘ZXhhbXBsZSBzdHJpbmc=`



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

def source_metadata
  @source_metadata
end

#source_vid ⇒ Object

Returns the value of attribute source_vid.



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

def source_vid
  @source_vid
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



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

def timestamp
  @timestamp
end

#unit ⇒ Object

Returns the value of attribute unit.



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

def unit
  @unit
end

#updated_by_user_id ⇒ Object

Returns the value of attribute updated_by_user_id.



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

def updated_by_user_id
  @updated_by_user_id
end

#use_timestamp_as_persistence_timestamp ⇒ Object

Returns the value of attribute use_timestamp_as_persistence_timestamp.



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

def use_timestamp_as_persistence_timestamp
  @use_timestamp_as_persistence_timestamp
end

#value ⇒ Object

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
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/property_value.rb', line 90

def self.attribute_map
  {
    :'source_id' => :'sourceId',
    :'selected_by_user' => :'selectedByUser',
    :'source_label' => :'sourceLabel',
    :'source' => :'source',
    :'updated_by_user_id' => :'updatedByUserId',
    :'persistence_timestamp' => :'persistenceTimestamp',
    :'source_metadata' => :'sourceMetadata',
    :'data_sensitivity' => :'dataSensitivity',
    :'source_vid' => :'sourceVid',
    :'unit' => :'unit',
    :'request_id' => :'requestId',
    :'is_encrypted' => :'isEncrypted',
    :'name' => :'name',
    :'use_timestamp_as_persistence_timestamp' => :'useTimestampAsPersistenceTimestamp',
    :'value' => :'value',
    :'selected_by_user_timestamp' => :'selectedByUserTimestamp',
    :'timestamp' => :'timestamp',
    :'is_large_value' => :'isLargeValue'
  }
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



385
386
387
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 385

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 143

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

.openapi_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 119

def self.openapi_types
  {
    :'source_id' => :'String',
    :'selected_by_user' => :'Boolean',
    :'source_label' => :'String',
    :'source' => :'String',
    :'updated_by_user_id' => :'Integer',
    :'persistence_timestamp' => :'Integer',
    :'source_metadata' => :'String',
    :'data_sensitivity' => :'String',
    :'source_vid' => :'Array<Integer>',
    :'unit' => :'String',
    :'request_id' => :'String',
    :'is_encrypted' => :'Boolean',
    :'name' => :'String',
    :'use_timestamp_as_persistence_timestamp' => :'Boolean',
    :'value' => :'String',
    :'selected_by_user_timestamp' => :'Integer',
    :'timestamp' => :'Integer',
    :'is_large_value' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 347

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source_id == o.source_id &&
      selected_by_user == o.selected_by_user &&
      source_label == o.source_label &&
      source == o.source &&
      updated_by_user_id == o.updated_by_user_id &&
      persistence_timestamp == o.persistence_timestamp &&
      source_metadata == o.source_metadata &&
      data_sensitivity == o.data_sensitivity &&
      source_vid == o.source_vid &&
      unit == o.unit &&
      request_id == o.request_id &&
      is_encrypted == o.is_encrypted &&
      name == o.name &&
      use_timestamp_as_persistence_timestamp == o.use_timestamp_as_persistence_timestamp &&
      value == o.value &&
      selected_by_user_timestamp == o.selected_by_user_timestamp &&
      timestamp == o.timestamp &&
      is_large_value == o.is_large_value
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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 416

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



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 487

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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 392

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


372
373
374
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 372

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



378
379
380
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 378

def hash
  [source_id, selected_by_user, source_label, source, updated_by_user_id, persistence_timestamp, source_metadata, data_sensitivity, source_vid, unit, request_id, is_encrypted, name, use_timestamp_as_persistence_timestamp, value, selected_by_user_timestamp, timestamp, is_large_value].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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



463
464
465
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 463

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



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 469

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



457
458
459
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 457

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/hubspot/codegen/marketing/events/models/property_value.rb', line 303

def valid?
  return false if @source_id.nil?
  return false if @selected_by_user.nil?
  return false if @source_label.nil?
  return false if @source.nil?
  source_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "IMPORT", "API", "FORM", "ANALYTICS", "MIGRATION", "SALESFORCE", "INTEGRATION", "CONTACTS_WEB", "WAL_INCREMENTAL", "TASK", "EMAIL", "WORKFLOWS", "CALCULATED", "SOCIAL", "BATCH_UPDATE", "SIGNALS", "BIDEN", "DEFAULT", "COMPANIES", "DEALS", "ASSISTS", "PRESENTATIONS", "TALLY", "SIDEKICK", "CRM_UI", "MERGE_CONTACTS", "PORTAL_USER_ASSOCIATOR", "INTEGRATIONS_PLATFORM", "BCC_TO_CRM", "FORWARD_TO_CRM", "ENGAGEMENTS", "SALES", "HEISENBERG", "LEADIN", "GMAIL_INTEGRATION", "ACADEMY", "SALES_MESSAGES", "AVATARS_SERVICE", "MERGE_COMPANIES", "SEQUENCES", "COMPANY_FAMILIES", "MOBILE_IOS", "MOBILE_ANDROID", "CONTACTS", "ASSOCIATIONS", "EXTENSION", "SUCCESS", "BOT", "INTEGRATIONS_SYNC", "AUTOMATION_PLATFORM", "CONVERSATIONS", "EMAIL_INTEGRATION", "CONTENT_MEMBERSHIP", "QUOTES", "BET_ASSIGNMENT", "QUOTAS", "BET_CRM_CONNECTOR", "MEETINGS", "MERGE_OBJECTS", "RECYCLING_BIN", "ADS", "AI_GROUP", "COMMUNICATOR", "SETTINGS", "PROPERTY_SETTINGS", "PIPELINE_SETTINGS", "COMPANY_INSIGHTS", "BEHAVIORAL_EVENTS", "PAYMENTS", "GOALS", "PORTAL_OBJECT_SYNC", "APPROVALS", "FILE_MANAGER", "MARKETPLACE", "INTERNAL_PROCESSING", "FORECASTING", "SLACK_INTEGRATION", "CRM_UI_BULK_ACTION", "WORKFLOW_CONTACT_DELETE_ACTION", "ACCEPTANCE_TEST", "PLAYBOOKS", "CHATSPOT", "FLYWHEEL_PRODUCT_DATA_SYNC", "HELP_DESK", "BILLING", "DATA_ENRICHMENT", "AUTOMATION_JOURNEY", "MICROAPPS", "INTENT", "PROSPECTING_AGENT"])
  return false unless source_validator.valid?(@source)
  return false if @source_metadata.nil?
  return false if @data_sensitivity.nil?
  data_sensitivity_validator = EnumAttributeValidator.new('String', ["none", "standard", "high"])
  return false unless data_sensitivity_validator.valid?(@data_sensitivity)
  return false if @source_vid.nil?
  return false if @unit.nil?
  return false if @request_id.nil?
  return false if @is_encrypted.nil?
  return false if @name.nil?
  return false if @value.nil?
  return false if @selected_by_user_timestamp.nil?
  return false if @timestamp.nil?
  true
end