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


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

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

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

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

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

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

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

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

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

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


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

def display_order
  @display_order
end

#field_typeObject

Controls how the property appears in HubSpot.


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

def field_type
  @field_type
end

#group_nameObject

The name of the group this property belongs to.


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

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.


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

def has_unique_value
  @has_unique_value
end

#hiddenObject

Returns the value of attribute hidden


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

def hidden
  @hidden
end

#labelObject

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


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

def label
  @label
end

#nameObject

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


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

def name
  @name
end

#optionsObject

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


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

def options
  @options
end

#typeObject

The data type of the property.


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

def type
  @type
end

Class Method Details

.attribute_mapObject

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


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 71

def self.attribute_map
  {
    :'name' => :'name',
    :'label' => :'label',
    :'group_name' => :'groupName',
    :'description' => :'description',
    :'options' => :'options',
    :'display_order' => :'displayOrder',
    :'has_unique_value' => :'hasUniqueValue',
    :'hidden' => :'hidden',
    :'type' => :'type',
    :'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


243
244
245
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 243

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

.openapi_nullableObject

List of attributes with nullable: true


103
104
105
106
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 103

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

.openapi_typesObject

Attribute type mapping.


87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 87

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      label == o.label &&
      group_name == o.group_name &&
      description == o.description &&
      options == o.options &&
      display_order == o.display_order &&
      has_unique_value == o.has_unique_value &&
      hidden == o.hidden &&
      type == o.type &&
      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


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

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 340

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


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 250

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

230
231
232
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 230

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


236
237
238
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 236

def hash
  [name, label, group_name, description, options, display_order, has_unique_value, hidden, type, 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


168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 168

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

  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 @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


316
317
318
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 316

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


322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 322

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


310
311
312
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 310

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


191
192
193
194
195
196
197
198
199
# File 'lib/hubspot/codegen/crm/schemas/models/object_type_property_create.rb', line 191

def valid?
  return false if @name.nil?
  return false if @label.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration"])
  return false unless type_validator.valid?(@type)
  return false if @field_type.nil?
  true
end