class Hubspot::Crm::Properties::PropertyUpdate
Attributes
A description of the property that will be shown as help text in HubSpot.
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.
Controls how the property appears in HubSpot.
Whether or not the property can be used in a HubSpot form.
The name of the property group the property belongs to.
A human-readable property label that will be shown in HubSpot.
A list of valid options for the property.
The data type of the property.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 69 def self.attribute_map { :'label' => :'label', :'type' => :'type', :'field_type' => :'fieldType', :'group_name' => :'groupName', :'description' => :'description', :'options' => :'options', :'display_order' => :'displayOrder', :'hidden' => :'hidden', :'form_field' => :'formField' } end
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/properties/models/property_update.rb, line 226 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 106 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 if attributes.key?(:'form_field') self.form_field = attributes[:'form_field'] end end
List of attributes with nullable: true
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 99 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 84 def self.openapi_types { :'label' => :'String', :'type' => :'String', :'field_type' => :'String', :'group_name' => :'String', :'description' => :'String', :'options' => :'Array<OptionInput>', :'display_order' => :'Integer', :'hidden' => :'Boolean', :'form_field' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 197 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 && form_field == o.form_field end
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/properties/models/property_update.rb, line 254 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
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/properties/models/property_update.rb, line 323 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
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/properties/models/property_update.rb, line 233 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
@see the `==` method @param [Object] Object to be compared
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 213 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] field_type
Object to be assigned
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 187 def field_type=(field_type) validator = EnumAttributeValidator.new('String', ["textarea", "text", "date", "file", "number", "select", "radio", "checkbox", "booleancheckbox"]) unless validator.valid?(field_type) fail ArgumentError, "invalid value for \"field_type\", must be one of #{validator.allowable_values}." end @field_type = field_type end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 219 def hash [label, type, field_type, group_name, description, options, display_order, hidden, form_field].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 160 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 305 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 293 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/hubspot/codegen/crm/properties/models/property_update.rb, line 177 def type=(type) validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end
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/properties/models/property_update.rb, line 167 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