Class: Hubspot::Marketing::Forms::FieldGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/marketing/forms/models/field_group.rb

Overview

A collection of up to three form fields usually displayed in a row.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FieldGroup

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Marketing::Forms::FieldGroup` 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::FieldGroup`. 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?(:'group_type')
    self.group_type = attributes[:'group_type']
  end

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

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

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

Instance Attribute Details

#fields ⇒ Object

The form fields included in the group



31
32
33
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 31

def fields
  @fields
end

#group_type ⇒ Object

Returns the value of attribute group_type.



22
23
24
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 22

def group_type
  @group_type
end

#rich_text ⇒ Object

A block of rich text or an image. Those can be used to add extra information for the customers filling in the form. If the field group includes fields, the rich text will be displayed before the fields.



28
29
30
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 28

def rich_text
  @rich_text
end

#rich_text_type ⇒ Object

The type of rich text included. The default value is text.



25
26
27
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 25

def rich_text_type
  @rich_text_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



56
57
58
59
60
61
62
63
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 56

def self.attribute_map
  {
    :'group_type' => :'groupType',
    :'rich_text_type' => :'richTextType',
    :'rich_text' => :'richText',
    :'fields' => :'fields'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



198
199
200
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 198

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 71

def self.openapi_types
  {
    :'group_type' => :'String',
    :'rich_text_type' => :'String',
    :'rich_text' => :'String',
    :'fields' => :'Array<DependentFieldDependentField>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      group_type == o.group_type &&
      rich_text_type == o.rich_text_type &&
      rich_text == o.rich_text &&
      fields == o.fields
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 229

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::Marketing::Forms.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 300

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 205

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 191

def hash
  [group_type, rich_text_type, rich_text, fields].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 122

def list_invalid_properties
  invalid_properties = Array.new
  if @group_type.nil?
    invalid_properties.push('invalid value for "group_type", group_type cannot be nil.')
  end

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 276

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 282

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

Returns:

  • (String) —

    String presentation of the object



270
271
272
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 270

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/hubspot/codegen/marketing/forms/models/field_group.rb', line 141

def valid?
  return false if @group_type.nil?
  group_type_validator = EnumAttributeValidator.new('String', ["default_group", "progressive", "queued"])
  return false unless group_type_validator.valid?(@group_type)
  return false if @rich_text_type.nil?
  rich_text_type_validator = EnumAttributeValidator.new('String', ["text", "image"])
  return false unless rich_text_type_validator.valid?(@rich_text_type)
  return false if @fields.nil?
  true
end