Class: Hubspot::Crm::Properties::PropertyUpdate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PropertyUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 101

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

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

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

Instance Attribute Details

#descriptionObject

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



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

def description
  @description
end

#display_orderObject

Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.



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

def display_order
  @display_order
end

#field_typeObject

Controls how the property appears in HubSpot.



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

def field_type
  @field_type
end

#group_nameObject

The name of the property group the property belongs to.



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

def group_name
  @group_name
end

#hiddenObject

If true, the property won’t be visible and can’t be used in HubSpot.



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

def hidden
  @hidden
end

#labelObject

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



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

def label
  @label
end

#optionsObject

A list of valid options for the property.



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

def options
  @options
end

#typeObject

The data type of the property.



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

def type
  @type
end

Class Method Details

.attribute_mapObject

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



66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 66

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



216
217
218
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 216

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

.openapi_nullableObject

List of attributes with nullable: true



94
95
96
97
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 94

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

.openapi_typesObject

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 80

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 188

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



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
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 244

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::Properties.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



313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 313

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 223

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


203
204
205
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 203

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



209
210
211
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 209

def hash
  [label, type, field_type, group_name, description, options, display_order, hidden].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



151
152
153
154
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 151

def list_invalid_properties
  invalid_properties = Array.new
  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



289
290
291
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 295

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



283
284
285
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 283

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



158
159
160
161
162
163
164
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 158

def valid?
  type_validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration"])
  return false unless type_validator.valid?(@type)
  field_type_validator = EnumAttributeValidator.new('String', ["textarea", "text", "date", "file", "number", "select", "radio", "checkbox", "booleancheckbox"])
  return false unless field_type_validator.valid?(@field_type)
  true
end