class Hubspot::Crm::Schemas::ObjectSchemaEgg

Attributes

associated_objects[RW]

Associations defined for this object type.

labels[RW]
name[RW]

A unique name for this object. For internal use only.

primary_display_property[RW]

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

properties[RW]

Properties defined for this object type.

required_properties[RW]

The names of properties that should be required when creating an object of this type.

searchable_properties[RW]

Names of properties that will be indexed for this object type in by HubSpot's product search.

secondary_display_properties[RW]

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

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/object_schema_egg.rb, line 43
def self.attribute_map
  {
    :'labels' => :'labels',
    :'required_properties' => :'requiredProperties',
    :'searchable_properties' => :'searchableProperties',
    :'primary_display_property' => :'primaryDisplayProperty',
    :'secondary_display_properties' => :'secondaryDisplayProperties',
    :'properties' => :'properties',
    :'associated_objects' => :'associatedObjects',
    :'name' => :'name'
  }
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/object_schema_egg.rb, line 212
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/object_schema_egg.rb, line 78
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Schemas::ObjectSchemaEgg` 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::ObjectSchemaEgg`. 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?(:'labels')
    self.labels = attributes[:'labels']
  end

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/hubspot/codegen/crm/schemas/models/object_schema_egg.rb, line 57
def self.openapi_types
  {
    :'labels' => :'ObjectTypeDefinitionLabels',
    :'required_properties' => :'Array<String>',
    :'searchable_properties' => :'Array<String>',
    :'primary_display_property' => :'String',
    :'secondary_display_properties' => :'Array<String>',
    :'properties' => :'Array<ObjectTypePropertyCreate>',
    :'associated_objects' => :'Array<String>',
    :'name' => :'String'
  }
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/object_schema_egg.rb, line 184
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      labels == o.labels &&
      required_properties == o.required_properties &&
      searchable_properties == o.searchable_properties &&
      primary_display_property == o.primary_display_property &&
      secondary_display_properties == o.secondary_display_properties &&
      properties == o.properties &&
      associated_objects == o.associated_objects &&
      name == o.name
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/object_schema_egg.rb, line 240
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/object_schema_egg.rb, line 309
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/object_schema_egg.rb, line 219
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/object_schema_egg.rb, line 199
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/object_schema_egg.rb, line 205
def hash
  [labels, required_properties, searchable_properties, primary_display_property, secondary_display_properties, properties, associated_objects, name].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/object_schema_egg.rb, line 136
def list_invalid_properties
  invalid_properties = Array.new
  if @labels.nil?
    invalid_properties.push('invalid value for "labels", labels cannot be nil.')
  end

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

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

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

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

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

  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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/object_schema_egg.rb, line 285
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/object_schema_egg.rb, line 291
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/object_schema_egg.rb, line 279
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/object_schema_egg.rb, line 171
def valid?
  return false if @labels.nil?
  return false if @required_properties.nil?
  return false if @searchable_properties.nil?
  return false if @secondary_display_properties.nil?
  return false if @properties.nil?
  return false if @associated_objects.nil?
  return false if @name.nil?
  true
end