Class: WhopSDK::Models::AdCreateParams::LeadForm

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::AdCreateParams::LeadForm

Defined in:

lib/whop_sdk/models/ad_create_params.rb,
sig/whop_sdk/models/ad_create_params.rbs

Defined Under Namespace

Modules: FormType Classes: Completion, Disclaimer, Intro, PrivacyPolicy, Question

Instance Attribute Summary

• #completion ⇒ WhopSDK::Models::AdCreateParams::LeadForm::Completion^?

  Optional completion screen shown after submission; url sets the follow-up website button.

• #disclaimer ⇒ WhopSDK::Models::AdCreateParams::LeadForm::Disclaimer^?

  Optional custom consent disclaimer with checkboxes.

• #form_type ⇒ Symbol, ...

  more_volume (default) is quickest to submit; higher_intent adds a confirmation step.

• #intro ⇒ WhopSDK::Models::AdCreateParams::LeadForm::Intro^?

  Optional intro screen shown before the questions.

• #name ⇒ String^?

  Internal name for the form.

• #phone_verification ⇒ Boolean^?

  Require SMS verification of the phone number (higher_intent forms).

• #privacy_policy ⇒ WhopSDK::Models::AdCreateParams::LeadForm::PrivacyPolicy^?

  Your privacy policy.

• #questions ⇒ Array<WhopSDK::Models::AdCreateParams::LeadForm::Question>^?

  The questions on the form.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(link_text: nil, url: nil) ⇒ Object constructor

  Your privacy policy.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(link_text: nil, url: nil) ⇒ Object

Your privacy policy. url is required by Meta.

Parameters:

• link_text (String) (defaults to: nil)
• url (String) (defaults to: nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 322

Instance Attribute Details

#completion ⇒ WhopSDK::Models::AdCreateParams::LeadForm::Completion^?

Optional completion screen shown after submission; url sets the follow-up website button.

Returns:

• (WhopSDK::Models::AdCreateParams::LeadForm::Completion, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 275

optional :completion, -> { WhopSDK::AdCreateParams::LeadForm::Completion }

#disclaimer ⇒ WhopSDK::Models::AdCreateParams::LeadForm::Disclaimer^?

Optional custom consent disclaimer with checkboxes.

Returns:

• (WhopSDK::Models::AdCreateParams::LeadForm::Disclaimer, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 281

optional :disclaimer, -> { WhopSDK::AdCreateParams::LeadForm::Disclaimer }

#form_type ⇒ Symbol, ...

more_volume (default) is quickest to submit; higher_intent adds a confirmation step.

Returns:

• (Symbol, WhopSDK::Models::AdCreateParams::LeadForm::FormType, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 288

optional :form_type, enum: -> { WhopSDK::AdCreateParams::LeadForm::FormType }

#intro ⇒ WhopSDK::Models::AdCreateParams::LeadForm::Intro^?

Optional intro screen shown before the questions.

Returns:

• (WhopSDK::Models::AdCreateParams::LeadForm::Intro, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 294

optional :intro, -> { WhopSDK::AdCreateParams::LeadForm::Intro }

#name ⇒ String^?

Internal name for the form. Auto-generated if omitted.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 300

optional :name, String

#phone_verification ⇒ Boolean^?

Require SMS verification of the phone number (higher_intent forms).

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 306

optional :phone_verification, WhopSDK::Internal::Type::Boolean

#privacy_policy ⇒ WhopSDK::Models::AdCreateParams::LeadForm::PrivacyPolicy^?

Your privacy policy. url is required by Meta.

Returns:

• (WhopSDK::Models::AdCreateParams::LeadForm::PrivacyPolicy, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 312

optional :privacy_policy, -> { WhopSDK::AdCreateParams::LeadForm::PrivacyPolicy }

#questions ⇒ Array<WhopSDK::Models::AdCreateParams::LeadForm::Question>^?

The questions on the form. Standard prefill types need only a type; a custom question needs a label and a format (plus options for multiple_choice). Options carry an optional key and answer-routing logic.

Returns:

• (Array<WhopSDK::Models::AdCreateParams::LeadForm::Question>, nil)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 320

optional :questions, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdCreateParams::LeadForm::Question] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/whop_sdk/models/ad_create_params.rb', line 443

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/ad_create_params.rbs', line 350

def to_hash: -> {