class Hubspot::Crm::Schemas::Property

Attributes

archived[RW]

Whether or not the property is archived.

archived_at[RW]

When the property was archived.

calculated[RW]

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

created_at[RW]

When the property was created

created_user_id[RW]

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.

description[RW]

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

display_order[RW]

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.

external_options[RW]

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

field_type[RW]

Controls how the property appears in HubSpot.

form_field[RW]

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

group_name[RW]

The name of the property group the property belongs to.

has_unique_value[RW]

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

hidden[RW]
hubspot_defined[RW]

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

label[RW]

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

modification_metadata[RW]
name[RW]

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

options[RW]

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

referenced_object_type[RW]

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

show_currency_symbol[RW]

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

type[RW]

The property data type.

updated_at[RW]
updated_user_id[RW]

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.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 86
def self.attribute_map
  {
    :'updated_at' => :'updatedAt',
    :'created_at' => :'createdAt',
    :'archived_at' => :'archivedAt',
    :'name' => :'name',
    :'label' => :'label',
    :'type' => :'type',
    :'field_type' => :'fieldType',
    :'description' => :'description',
    :'group_name' => :'groupName',
    :'options' => :'options',
    :'created_user_id' => :'createdUserId',
    :'updated_user_id' => :'updatedUserId',
    :'referenced_object_type' => :'referencedObjectType',
    :'display_order' => :'displayOrder',
    :'calculated' => :'calculated',
    :'external_options' => :'externalOptions',
    :'archived' => :'archived',
    :'has_unique_value' => :'hasUniqueValue',
    :'hidden' => :'hidden',
    :'hubspot_defined' => :'hubspotDefined',
    :'show_currency_symbol' => :'showCurrencySymbol',
    :'modification_metadata' => :'modificationMetadata',
    :'form_field' => :'formField'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 352
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/hubspot/codegen/crm/schemas/models/property.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::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?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'form_field')
    self.form_field = attributes[:'form_field']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 144
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 115
def self.openapi_types
  {
    :'updated_at' => :'DateTime',
    :'created_at' => :'DateTime',
    :'archived_at' => :'DateTime',
    :'name' => :'String',
    :'label' => :'String',
    :'type' => :'String',
    :'field_type' => :'String',
    :'description' => :'String',
    :'group_name' => :'String',
    :'options' => :'Array<Option>',
    :'created_user_id' => :'String',
    :'updated_user_id' => :'String',
    :'referenced_object_type' => :'String',
    :'display_order' => :'Integer',
    :'calculated' => :'Boolean',
    :'external_options' => :'Boolean',
    :'archived' => :'Boolean',
    :'has_unique_value' => :'Boolean',
    :'hidden' => :'Boolean',
    :'hubspot_defined' => :'Boolean',
    :'show_currency_symbol' => :'Boolean',
    :'modification_metadata' => :'PropertyModificationMetadata',
    :'form_field' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 309
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      updated_at == o.updated_at &&
      created_at == o.created_at &&
      archived_at == o.archived_at &&
      name == o.name &&
      label == o.label &&
      type == o.type &&
      field_type == o.field_type &&
      description == o.description &&
      group_name == o.group_name &&
      options == o.options &&
      created_user_id == o.created_user_id &&
      updated_user_id == o.updated_user_id &&
      referenced_object_type == o.referenced_object_type &&
      display_order == o.display_order &&
      calculated == o.calculated &&
      external_options == o.external_options &&
      archived == o.archived &&
      has_unique_value == o.has_unique_value &&
      hidden == o.hidden &&
      hubspot_defined == o.hubspot_defined &&
      show_currency_symbol == o.show_currency_symbol &&
      modification_metadata == o.modification_metadata &&
      form_field == o.form_field
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 380
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 449
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 359
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 339
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 345
def hash
  [updated_at, created_at, archived_at, name, label, type, field_type, description, group_name, options, created_user_id, updated_user_id, referenced_object_type, display_order, calculated, external_options, archived, has_unique_value, hidden, hubspot_defined, show_currency_symbol, modification_metadata, form_field].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

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

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

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

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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 425
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 431
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 419
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/hubspot/codegen/crm/schemas/models/property.rb, line 296
def valid?
  return false if @name.nil?
  return false if @label.nil?
  return false if @type.nil?
  return false if @field_type.nil?
  return false if @description.nil?
  return false if @group_name.nil?
  return false if @options.nil?
  true
end