Class: Hubspot::Crm::Schemas::Property

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/schemas/models/property.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Property

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
304
305
306
307
308
309
310
311
312
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 192

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

Whether or not the property is archived.



41
42
43
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 41

def archived
  @archived
end

#archived_at ⇒ Object

When the property was archived.



74
75
76
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 74

def archived_at
  @archived_at
end

#calculated ⇒ Object

For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.



50
51
52
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 50

def calculated
  @calculated
end

#calculation_formula ⇒ Object

Returns the value of attribute calculation_formula.



85
86
87
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 85

def calculation_formula
  @calculation_formula
end

#created_at ⇒ Object

When the property was created



38
39
40
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 38

def created_at
  @created_at
end

#created_user_id ⇒ Object

The internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.



59
60
61
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 59

def created_user_id
  @created_user_id
end

#data_sensitivity ⇒ Object

Returns the value of attribute data_sensitivity.



71
72
73
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 71

def data_sensitivity
  @data_sensitivity
end

#description ⇒ Object

A description of the property that will be shown as help text in HubSpot.



26
27
28
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 26

def description
  @description
end

#display_order ⇒ Object

The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed after any positive values.



23
24
25
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 23

def display_order
  @display_order
end

#external_options ⇒ Object

For default properties, true indicates that the options are stored externally to the property settings.



53
54
55
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 53

def external_options
  @external_options
end

#field_type ⇒ Object

Controls how the property appears in HubSpot.



88
89
90
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 88

def field_type
  @field_type
end

#form_field ⇒ Object

Whether or not the property can be used in a HubSpot form.



69
70
71
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 69

def form_field
  @form_field
end

#group_name ⇒ Object

The name of the property group the property belongs to.



77
78
79
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 77

def group_name
  @group_name
end

#has_unique_value ⇒ Object

Whether or not the property’s value must be unique. Once set, this can’t be changed.



47
48
49
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 47

def has_unique_value
  @has_unique_value
end

#hidden ⇒ Object

Returns the value of attribute hidden.



20
21
22
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 20

def hidden
  @hidden
end

#hubspot_defined ⇒ Object

This will be true for default object properties built into HubSpot.



35
36
37
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 35

def hubspot_defined
  @hubspot_defined
end

#label ⇒ Object

A human-readable property label that will be shown in HubSpot.



66
67
68
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 66

def label
  @label
end

#modification_metadata ⇒ Object

Returns the value of attribute modification_metadata.



61
62
63
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 61

def modification_metadata
  @modification_metadata
end

#name ⇒ Object

The internal property name, which must be used when referencing the property via the API.



83
84
85
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 83

def name
  @name
end

#options ⇒ Object

A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.



44
45
46
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 44

def options
  @options
end

#referenced_object_type ⇒ Object

If this property is related to other object(s), they’ll be listed here.



80
81
82
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 80

def referenced_object_type
  @referenced_object_type
end

#sensitive_data_categories ⇒ Object

Returns the value of attribute sensitive_data_categories.



63
64
65
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 63

def sensitive_data_categories
  @sensitive_data_categories
end

#show_currency_symbol ⇒ Object

Whether the property will display the currency symbol set in the account settings.



29
30
31
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 29

def show_currency_symbol
  @show_currency_symbol
end

#type ⇒ Object

The property data type.



32
33
34
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 32

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



56
57
58
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 56

def updated_at
  @updated_at
end

#updated_user_id ⇒ Object

The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.



91
92
93
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 91

def updated_user_id
  @updated_user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



148
149
150
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 148

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 116

def self.attribute_map
  {
    :'hidden' => :'hidden',
    :'display_order' => :'displayOrder',
    :'description' => :'description',
    :'show_currency_symbol' => :'showCurrencySymbol',
    :'type' => :'type',
    :'hubspot_defined' => :'hubspotDefined',
    :'created_at' => :'createdAt',
    :'archived' => :'archived',
    :'options' => :'options',
    :'has_unique_value' => :'hasUniqueValue',
    :'calculated' => :'calculated',
    :'external_options' => :'externalOptions',
    :'updated_at' => :'updatedAt',
    :'created_user_id' => :'createdUserId',
    :'modification_metadata' => :'modificationMetadata',
    :'sensitive_data_categories' => :'sensitiveDataCategories',
    :'label' => :'label',
    :'form_field' => :'formField',
    :'data_sensitivity' => :'dataSensitivity',
    :'archived_at' => :'archivedAt',
    :'group_name' => :'groupName',
    :'referenced_object_type' => :'referencedObjectType',
    :'name' => :'name',
    :'calculation_formula' => :'calculationFormula',
    :'field_type' => :'fieldType',
    :'updated_user_id' => :'updatedUserId'
  }
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



422
423
424
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 422

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



185
186
187
188
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 185

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 153

def self.openapi_types
  {
    :'hidden' => :'Boolean',
    :'display_order' => :'Integer',
    :'description' => :'String',
    :'show_currency_symbol' => :'Boolean',
    :'type' => :'String',
    :'hubspot_defined' => :'Boolean',
    :'created_at' => :'Time',
    :'archived' => :'Boolean',
    :'options' => :'Array<Option>',
    :'has_unique_value' => :'Boolean',
    :'calculated' => :'Boolean',
    :'external_options' => :'Boolean',
    :'updated_at' => :'Time',
    :'created_user_id' => :'String',
    :'modification_metadata' => :'PropertyModificationMetadata',
    :'sensitive_data_categories' => :'Array<String>',
    :'label' => :'String',
    :'form_field' => :'Boolean',
    :'data_sensitivity' => :'String',
    :'archived_at' => :'Time',
    :'group_name' => :'String',
    :'referenced_object_type' => :'String',
    :'name' => :'String',
    :'calculation_formula' => :'String',
    :'field_type' => :'String',
    :'updated_user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 376

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      hidden == o.hidden &&
      display_order == o.display_order &&
      description == o.description &&
      show_currency_symbol == o.show_currency_symbol &&
      type == o.type &&
      hubspot_defined == o.hubspot_defined &&
      created_at == o.created_at &&
      archived == o.archived &&
      options == o.options &&
      has_unique_value == o.has_unique_value &&
      calculated == o.calculated &&
      external_options == o.external_options &&
      updated_at == o.updated_at &&
      created_user_id == o.created_user_id &&
      modification_metadata == o.modification_metadata &&
      sensitive_data_categories == o.sensitive_data_categories &&
      label == o.label &&
      form_field == o.form_field &&
      data_sensitivity == o.data_sensitivity &&
      archived_at == o.archived_at &&
      group_name == o.group_name &&
      referenced_object_type == o.referenced_object_type &&
      name == o.name &&
      calculation_formula == o.calculation_formula &&
      field_type == o.field_type &&
      updated_user_id == o.updated_user_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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 453

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::Crm::Schemas.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



524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 524

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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 429

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


409
410
411
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 409

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



415
416
417
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 415

def hash
  [hidden, display_order, description, show_currency_symbol, type, hubspot_defined, created_at, archived, options, has_unique_value, calculated, external_options, updated_at, created_user_id, modification_metadata, sensitive_data_categories, label, form_field, data_sensitivity, archived_at, group_name, referenced_object_type, name, calculation_formula, field_type, updated_user_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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 316

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

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

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

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

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

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

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



500
501
502
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 500

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



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 506

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



494
495
496
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 494

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



351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/hubspot/codegen/crm/schemas/models/property.rb', line 351

def valid?
  return false if @description.nil?
  return false if @type.nil?
  return false if @options.nil?
  return false if @label.nil?
  data_sensitivity_validator = EnumAttributeValidator.new('String', ["non_sensitive", "sensitive", "highly_sensitive"])
  return false unless data_sensitivity_validator.valid?(@data_sensitivity)
  return false if @group_name.nil?
  return false if @name.nil?
  return false if @field_type.nil?
  true
end