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



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
185
186
187
188
189
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 125

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?(:'create_new_contact_for_new_email')
    self.create_new_contact_for_new_email = attributes[:'create_new_contact_for_new_email']
  end

  if attributes.key?(:'editable')
    self.editable = attributes[:'editable']
  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

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

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

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

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

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

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

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

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

  if attributes.key?(:'notify_recipients')
    if (value = attributes[:'notify_recipients']).is_a?(Array)
      self.notify_recipients = value
    end
  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.



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

def allow_link_to_reset_known_values
  @allow_link_to_reset_known_values
end

#archivable ⇒ Object

Whether the form can be archived.



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

def archivable
  @archivable
end

#cloneable ⇒ Object

Whether the form can be cloned.



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

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.



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

def create_new_contact_for_new_email
  @create_new_contact_for_new_email
end

#editable ⇒ Object

Whether the form can be edited.



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

def editable
  @editable
end

#language ⇒ Object

The language of the form.



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

def language
  @language
end

#lifecycle_stages ⇒ Object

Returns the value of attribute lifecycle_stages.



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

def lifecycle_stages
  @lifecycle_stages
end

#notify_contact_owner ⇒ Object

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



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

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.



52
53
54
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 52

def notify_recipients
  @notify_recipients
end

#post_submit_action ⇒ Object

Returns the value of attribute post_submit_action.



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

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.



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

def pre_populate_known_values
  @pre_populate_known_values
end

#recaptcha_enabled ⇒ Object

Whether CAPTCHA (spam prevention) is enabled.



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

def recaptcha_enabled
  @recaptcha_enabled
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.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/hub_spot_form_configuration.rb', line 77

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



305
306
307
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 305

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 100

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 273

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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 336

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 407

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 312

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


292
293
294
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 298

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



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 193

def list_invalid_properties
  invalid_properties = Array.new
  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 @editable.nil?
    invalid_properties.push('invalid value for "editable", editable 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

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

  if @language.nil?
    invalid_properties.push('invalid value for "language", language 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 @cloneable.nil?
    invalid_properties.push('invalid value for "cloneable", cloneable 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 @recaptcha_enabled.nil?
    invalid_properties.push('invalid value for "recaptcha_enabled", recaptcha_enabled cannot be nil.')
  end

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

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



383
384
385
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 389

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



377
378
379
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 377

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/hubspot/codegen/marketing/forms/models/hub_spot_form_configuration.rb', line 244

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