Class: Hubspot::Marketing::Forms::PhoneField
- Inherits:
-
Object
- Object
- Hubspot::Marketing::Forms::PhoneField
- Defined in:
- lib/hubspot/codegen/marketing/forms/models/phone_field.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#default_value ⇒ Object
The value filled in by default.
-
#dependent_fields ⇒ Object
A list of other fields to make visible based on the value filled in for this field.
-
#description ⇒ Object
Additional text helping the customer to complete the field.
-
#field_type ⇒ Object
Determines how the field will be displayed and validated.
-
#hidden ⇒ Object
Whether a field should be hidden or not.
-
#label ⇒ Object
The main label for the form field.
-
#name ⇒ Object
The identifier of the field.
-
#object_type_id ⇒ Object
A unique ID for this field’s CRM object type.
-
#placeholder ⇒ Object
The prompt text showing when the field isn’t filled in.
-
#required ⇒ Object
Whether a value for this field is required when submitting the form.
-
#use_country_code_select ⇒ Object
Whether to display a country code drop down next to the phone field.
-
#validation ⇒ Object
Returns the value of attribute validation.
Class Method Summary collapse
-
.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 = {}) ⇒ PhoneField
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 = {}) ⇒ PhoneField
Initializes the object
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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 120 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Marketing::Forms::PhoneField` 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::Marketing::Forms::PhoneField`. 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?(:'field_type') self.field_type = attributes[:'field_type'] else self.field_type = 'phone' end if attributes.key?(:'object_type_id') self.object_type_id = attributes[:'object_type_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'label') self.label = attributes[:'label'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'required') self.required = attributes[:'required'] end if attributes.key?(:'hidden') self.hidden = attributes[:'hidden'] end if attributes.key?(:'dependent_fields') if (value = attributes[:'dependent_fields']).is_a?(Array) self.dependent_fields = value end end if attributes.key?(:'placeholder') self.placeholder = attributes[:'placeholder'] end if attributes.key?(:'default_value') self.default_value = attributes[:'default_value'] end if attributes.key?(:'use_country_code_select') self.use_country_code_select = attributes[:'use_country_code_select'] end if attributes.key?(:'validation') self.validation = attributes[:'validation'] end end |
Instance Attribute Details
#default_value ⇒ Object
The value filled in by default. This value will be submitted unless the customer modifies it.
47 48 49 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 47 def default_value @default_value end |
#dependent_fields ⇒ Object
A list of other fields to make visible based on the value filled in for this field.
41 42 43 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 41 def dependent_fields @dependent_fields end |
#description ⇒ Object
Additional text helping the customer to complete the field.
32 33 34 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 32 def description @description end |
#field_type ⇒ Object
Determines how the field will be displayed and validated.
20 21 22 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 20 def field_type @field_type end |
#hidden ⇒ Object
Whether a field should be hidden or not. Hidden fields won’t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in.
38 39 40 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 38 def hidden @hidden end |
#label ⇒ Object
The main label for the form field.
29 30 31 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 29 def label @label end |
#name ⇒ Object
The identifier of the field. In combination with the object type ID, it must be unique.
26 27 28 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 26 def name @name end |
#object_type_id ⇒ Object
A unique ID for this field’s CRM object type. For example a CONTACT field will have the object type ID 0-1.
23 24 25 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 23 def object_type_id @object_type_id end |
#placeholder ⇒ Object
The prompt text showing when the field isn’t filled in.
44 45 46 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 44 def placeholder @placeholder end |
#required ⇒ Object
Whether a value for this field is required when submitting the form.
35 36 37 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 35 def required @required end |
#use_country_code_select ⇒ Object
Whether to display a country code drop down next to the phone field.
50 51 52 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 50 def use_country_code_select @use_country_code_select end |
#validation ⇒ Object
Returns the value of attribute validation.
52 53 54 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 52 def validation @validation end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 77 def self.attribute_map { :'field_type' => :'fieldType', :'object_type_id' => :'objectTypeId', :'name' => :'name', :'label' => :'label', :'description' => :'description', :'required' => :'required', :'hidden' => :'hidden', :'dependent_fields' => :'dependentFields', :'placeholder' => :'placeholder', :'default_value' => :'defaultValue', :'use_country_code_select' => :'useCountryCodeSelect', :'validation' => :'validation' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
250 251 252 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 250 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
113 114 115 116 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 113 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 95 def self.openapi_types { :'field_type' => :'String', :'object_type_id' => :'String', :'name' => :'String', :'label' => :'String', :'description' => :'String', :'required' => :'Boolean', :'hidden' => :'Boolean', :'dependent_fields' => :'Array<DependentField>', :'placeholder' => :'String', :'default_value' => :'String', :'use_country_code_select' => :'Boolean', :'validation' => :'PhoneFieldValidation' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 218 def ==(o) return true if self.equal?(o) self.class == o.class && field_type == o.field_type && object_type_id == o.object_type_id && name == o.name && label == o.label && description == o.description && required == o.required && hidden == o.hidden && dependent_fields == o.dependent_fields && placeholder == o.placeholder && default_value == o.default_value && use_country_code_select == o.use_country_code_select && validation == o.validation end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 278 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::Marketing::Forms.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
347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 347 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
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 257 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
237 238 239 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 237 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
243 244 245 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 243 def hash [field_type, object_type_id, name, label, description, required, hidden, dependent_fields, placeholder, default_value, use_country_code_select, validation].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
188 189 190 191 192 193 194 195 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 188 def list_invalid_properties invalid_properties = Array.new if @field_type.nil? invalid_properties.push('invalid value for "field_type", field_type cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
323 324 325 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 323 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 329 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
317 318 319 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 317 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
199 200 201 202 203 204 |
# File 'lib/hubspot/codegen/marketing/forms/models/phone_field.rb', line 199 def valid? return false if @field_type.nil? field_type_validator = EnumAttributeValidator.new('String', ["phone"]) return false unless field_type_validator.valid?(@field_type) true end |