Class: Hubspot::Crm::Properties::PropertyUpdate
- Inherits:
-
Object
- Object
- Hubspot::Crm::Properties::PropertyUpdate
- Defined in:
- lib/hubspot/codegen/crm/properties/models/property_update.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#description ⇒ Object
A description of the property that will be shown as help text in HubSpot.
-
#display_order ⇒ Object
Properties are displayed in order starting with the lowest positive integer value.
-
#field_type ⇒ Object
Controls how the property appears in HubSpot.
-
#form_field ⇒ Object
Whether or not the property can be used in a HubSpot form.
-
#group_name ⇒ Object
The name of the property group the property belongs to.
-
#hidden ⇒ Object
If true, the property won’t be visible and can’t be used in HubSpot.
-
#label ⇒ Object
A human-readable property label that will be shown in HubSpot.
-
#options ⇒ Object
A list of valid options for the property.
-
#type ⇒ Object
The data type of the property.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PropertyUpdate
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PropertyUpdate
Initializes the object
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 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 112 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. = 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 |
Instance Attribute Details
#description ⇒ Object
A description of the property that will be shown as help text in HubSpot.
33 34 35 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 33 def description @description end |
#display_order ⇒ Object
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.
39 40 41 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 39 def display_order @display_order end |
#field_type ⇒ Object
Controls how the property appears in HubSpot.
27 28 29 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 27 def field_type @field_type end |
#form_field ⇒ Object
Whether or not the property can be used in a HubSpot form.
45 46 47 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 45 def form_field @form_field end |
#group_name ⇒ Object
The name of the property group the property belongs to.
30 31 32 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 30 def group_name @group_name end |
#hidden ⇒ Object
If true, the property won’t be visible and can’t be used in HubSpot.
42 43 44 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 42 def hidden @hidden end |
#label ⇒ Object
A human-readable property label that will be shown in HubSpot.
21 22 23 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 21 def label @label end |
#options ⇒ Object
A list of valid options for the property.
36 37 38 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 36 def @options end |
#type ⇒ Object
The data type of the property.
24 25 26 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 24 def type @type end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
85 86 87 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 85 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 70 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 |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
232 233 234 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 232 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
105 106 107 108 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 105 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 90 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 203 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 && == o. && display_order == o.display_order && hidden == o.hidden && form_field == o.form_field end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
263 264 265 266 267 268 269 270 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 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 263 def _deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Hubspot::Crm::Properties.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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
334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 334 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
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 239 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif 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 end self end |
#eql?(o) ⇒ Boolean
219 220 221 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 219 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
225 226 227 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 225 def hash [label, type, field_type, group_name, description, , display_order, hidden, form_field].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
166 167 168 169 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 166 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
310 311 312 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 310 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 316 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 ⇒ String
Returns the string representation of the object
304 305 306 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 304 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
173 174 175 176 177 178 179 |
# File 'lib/hubspot/codegen/crm/properties/models/property_update.rb', line 173 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 |