Class: Hubspot::Marketing::Forms::HubSpotFormConfiguration

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HubSpotFormConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 115

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

Whether to add a reset link to the form. This removes any pre-populated content on the form and creates a new contact on submission.



49
50
51
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 49

def allow_link_to_reset_known_values
  @allow_link_to_reset_known_values
end

#archivable ⇒ Object

Whether the form can be archived.



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

def archivable
  @archivable
end

#cloneable ⇒ Object

Whether the form can be cloned.



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

def cloneable
  @cloneable
end

#create_new_contact_for_new_email ⇒ Object

Whether to create a new contact when a form is submitted with an email address that doesn’t match any in your existing contacts records.



43
44
45
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 43

def create_new_contact_for_new_email
  @create_new_contact_for_new_email
end

#editable ⇒ Object

Whether the form can be edited.



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

def editable
  @editable
end

#language ⇒ Object

The language of the form.



20
21
22
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 20

def language
  @language
end

#notify_contact_owner ⇒ Object

Whether to send a notification email to the contact owner when a submission is received.



37
38
39
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 37

def notify_contact_owner
  @notify_contact_owner
end

#notify_recipients ⇒ Object

The list of user IDs to receive a notification email when a submission is received.



40
41
42
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 40

def notify_recipients
  @notify_recipients
end

#post_submit_action ⇒ Object

Returns the value of attribute post_submit_action.



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

def post_submit_action
  @post_submit_action
end

#pre_populate_known_values ⇒ Object

Whether contact fields should pre-populate with known information when a contact returns to your site.



46
47
48
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 46

def pre_populate_known_values
  @pre_populate_known_values
end

#recaptcha_enabled ⇒ Object

Whether CAPTCHA (spam prevention) is enabled.



34
35
36
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 34

def recaptcha_enabled
  @recaptcha_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 74

def self.attribute_map
  {
    :'language' => :'language',
    :'cloneable' => :'cloneable',
    :'post_submit_action' => :'postSubmitAction',
    :'editable' => :'editable',
    :'archivable' => :'archivable',
    :'recaptcha_enabled' => :'recaptchaEnabled',
    :'notify_contact_owner' => :'notifyContactOwner',
    :'notify_recipients' => :'notifyRecipients',
    :'create_new_contact_for_new_email' => :'createNewContactForNewEmail',
    :'pre_populate_known_values' => :'prePopulateKnownValues',
    :'allow_link_to_reset_known_values' => :'allowLinkToResetKnownValues'
  }
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



288
289
290
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 288

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 91

def self.openapi_types
  {
    :'language' => :'String',
    :'cloneable' => :'Boolean',
    :'post_submit_action' => :'FormPostSubmitAction',
    :'editable' => :'Boolean',
    :'archivable' => :'Boolean',
    :'recaptcha_enabled' => :'Boolean',
    :'notify_contact_owner' => :'Boolean',
    :'notify_recipients' => :'Array<String>',
    :'create_new_contact_for_new_email' => :'Boolean',
    :'pre_populate_known_values' => :'Boolean',
    :'allow_link_to_reset_known_values' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      language == o.language &&
      cloneable == o.cloneable &&
      post_submit_action == o.post_submit_action &&
      editable == o.editable &&
      archivable == o.archivable &&
      recaptcha_enabled == o.recaptcha_enabled &&
      notify_contact_owner == o.notify_contact_owner &&
      notify_recipients == o.notify_recipients &&
      create_new_contact_for_new_email == o.create_new_contact_for_new_email &&
      pre_populate_known_values == o.pre_populate_known_values &&
      allow_link_to_reset_known_values == o.allow_link_to_reset_known_values
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 316

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 385

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 295

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 281

def hash
  [language, cloneable, post_submit_action, editable, archivable, recaptcha_enabled, notify_contact_owner, notify_recipients, create_new_contact_for_new_email, pre_populate_known_values, allow_link_to_reset_known_values].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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 177

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

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

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

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

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

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

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

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

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

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

  if @allow_link_to_reset_known_values.nil?
    invalid_properties.push('invalid value for "allow_link_to_reset_known_values", allow_link_to_reset_known_values 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



361
362
363
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 367

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



355
356
357
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 355

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 228

def valid?
  return false if @language.nil?
  language_validator = EnumAttributeValidator.new('String', ["af", "ar-eg", "bn", "bg", "ca-es", "cs", "da", "de", "el", "en", "es", "es-mx", "fi", "fr", "hr", "hu", "id", "it", "ja", "ko", "nl", "no-no", "pl", "pt", "pt-br", "ro", "ru", "sl", "sv", "th", "tr", "uk", "vi", "zh-cn", "zh-hk"])
  return false unless language_validator.valid?(@language)
  return false if @cloneable.nil?
  return false if @post_submit_action.nil?
  return false if @editable.nil?
  return false if @archivable.nil?
  return false if @recaptcha_enabled.nil?
  return false if @notify_contact_owner.nil?
  return false if @notify_recipients.nil?
  return false if @create_new_contact_for_new_email.nil?
  return false if @pre_populate_known_values.nil?
  return false if @allow_link_to_reset_known_values.nil?
  true
end