Class: Hubspot::Marketing::Forms::FileField
- Inherits:
-
Object
- Object
- Hubspot::Marketing::Forms::FileField
- Defined in:
- lib/hubspot/codegen/marketing/forms/models/file_field.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#allow_multiple_files ⇒ Object
Whether to allow the upload of multiple files.
-
#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.
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 = {}) ⇒ FileField
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 = {}) ⇒ FileField
Initializes the object
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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 116 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Marketing::Forms::FileField` 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::FileField`. 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 = 'file' 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?(:'allow_multiple_files') self.allow_multiple_files = attributes[:'allow_multiple_files'] end end |
Instance Attribute Details
#allow_multiple_files ⇒ Object
Whether to allow the upload of multiple files.
50 51 52 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 50 def allow_multiple_files @allow_multiple_files end |
#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/file_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/file_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/file_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/file_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/file_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/file_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/file_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/file_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/file_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/file_field.rb', line 35 def required @required end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 75 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', :'allow_multiple_files' => :'allowMultipleFiles' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
241 242 243 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 241 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
109 110 111 112 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 109 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 92 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', :'allow_multiple_files' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 210 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 && allow_multiple_files == o.allow_multiple_files end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 301 302 303 304 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 269 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
338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 338 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
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 248 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
228 229 230 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 228 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
234 235 236 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 234 def hash [field_type, object_type_id, name, label, description, required, hidden, dependent_fields, placeholder, default_value, allow_multiple_files].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
180 181 182 183 184 185 186 187 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 180 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)
314 315 316 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 314 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 320 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
308 309 310 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 308 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
191 192 193 194 195 196 |
# File 'lib/hubspot/codegen/marketing/forms/models/file_field.rb', line 191 def valid? return false if @field_type.nil? field_type_validator = EnumAttributeValidator.new('String', ["file"]) return false unless field_type_validator.valid?(@field_type) true end |