Class: Hubspot::Crm::Schemas::ObjectTypePropertyCreate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectTypePropertyCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#descriptionObject

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



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

def description
  @description
end

#display_orderObject

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.



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

def display_order
  @display_order
end

#field_typeObject

Controls how the property appears in HubSpot.



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

def field_type
  @field_type
end

#form_fieldObject

Whether the property can be used in a HubSpot form.



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

def form_field
  @form_field
end

#group_nameObject

The name of the group this property belongs to.



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

def group_name
  @group_name
end

#has_unique_valueObject

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



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

def has_unique_value
  @has_unique_value
end

#hiddenObject

Returns the value of attribute hidden.



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

def hidden
  @hidden
end

#labelObject

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



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

def label
  @label
end

#nameObject

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



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

def name
  @name
end

#number_display_hintObject

Controls how numeric properties are formatted in the HubSpot UI



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

def number_display_hint
  @number_display_hint
end

#option_sort_strategyObject

Controls how the property options will be sorted in the HubSpot UI.



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

def option_sort_strategy
  @option_sort_strategy
end

#optionsObject

A list of available options for the property. This field is only required for enumerated properties.



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

def options
  @options
end

#referenced_object_typeObject

Defines the options this property will return, e.g. OWNER would return name of users on the portal.



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

def referenced_object_type
  @referenced_object_type
end

#searchable_in_global_searchObject

Allow users to search for information entered to this field (limited to 3 properties)



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

def searchable_in_global_search
  @searchable_in_global_search
end

#show_currency_symbolObject

Whether the property will display the currency symbol in the HubSpot UI.



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

def show_currency_symbol
  @show_currency_symbol
end

#text_display_hintObject

Controls how text properties are formatted in the HubSpot UI



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

def text_display_hint
  @text_display_hint
end

#typeObject

The data type of the property.



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

def type
  @type
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



116
117
118
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 93

def self.attribute_map
  {
    :'hidden' => :'hidden',
    :'option_sort_strategy' => :'optionSortStrategy',
    :'display_order' => :'displayOrder',
    :'description' => :'description',
    :'show_currency_symbol' => :'showCurrencySymbol',
    :'label' => :'label',
    :'type' => :'type',
    :'form_field' => :'formField',
    :'group_name' => :'groupName',
    :'referenced_object_type' => :'referencedObjectType',
    :'text_display_hint' => :'textDisplayHint',
    :'name' => :'name',
    :'options' => :'options',
    :'searchable_in_global_search' => :'searchableInGlobalSearch',
    :'number_display_hint' => :'numberDisplayHint',
    :'has_unique_value' => :'hasUniqueValue',
    :'field_type' => :'fieldType'
  }
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



355
356
357
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 355

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

.openapi_nullableObject

List of attributes with nullable: true



144
145
146
147
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 144

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

.openapi_typesObject

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 121

def self.openapi_types
  {
    :'hidden' => :'Boolean',
    :'option_sort_strategy' => :'String',
    :'display_order' => :'Integer',
    :'description' => :'String',
    :'show_currency_symbol' => :'Boolean',
    :'label' => :'String',
    :'type' => :'String',
    :'form_field' => :'Boolean',
    :'group_name' => :'String',
    :'referenced_object_type' => :'String',
    :'text_display_hint' => :'String',
    :'name' => :'String',
    :'options' => :'Array<OptionInput>',
    :'searchable_in_global_search' => :'Boolean',
    :'number_display_hint' => :'String',
    :'has_unique_value' => :'Boolean',
    :'field_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 318

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      hidden == o.hidden &&
      option_sort_strategy == o.option_sort_strategy &&
      display_order == o.display_order &&
      description == o.description &&
      show_currency_symbol == o.show_currency_symbol &&
      label == o.label &&
      type == o.type &&
      form_field == o.form_field &&
      group_name == o.group_name &&
      referenced_object_type == o.referenced_object_type &&
      text_display_hint == o.text_display_hint &&
      name == o.name &&
      options == o.options &&
      searchable_in_global_search == o.searchable_in_global_search &&
      number_display_hint == o.number_display_hint &&
      has_unique_value == o.has_unique_value &&
      field_type == o.field_type
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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 386

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



457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 457

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 362

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


342
343
344
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 342

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



348
349
350
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 348

def hash
  [hidden, option_sort_strategy, display_order, description, show_currency_symbol, label, type, form_field, group_name, referenced_object_type, text_display_hint, name, options, searchable_in_global_search, number_display_hint, has_unique_value, field_type].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 237

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

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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



433
434
435
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 433

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 439

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



427
428
429
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 427

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 260

def valid?
  option_sort_strategy_validator = EnumAttributeValidator.new('String', ["DISPLAY_ORDER", "ALPHABETICAL"])
  return false unless option_sort_strategy_validator.valid?(@option_sort_strategy)
  return false if @label.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration", "bool"])
  return false unless type_validator.valid?(@type)
  text_display_hint_validator = EnumAttributeValidator.new('String', ["unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address", "postal_code"])
  return false unless text_display_hint_validator.valid?(@text_display_hint)
  return false if @name.nil?
  number_display_hint_validator = EnumAttributeValidator.new('String', ["unformatted", "formatted", "currency", "percentage", "duration", "probability"])
  return false unless number_display_hint_validator.valid?(@number_display_hint)
  return false if @field_type.nil?
  true
end