Class: WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/ad_group_update_params.rb

Overview

See Also:

Defined Under Namespace

Classes: CustomDisclaimerCheckbox, Question, ThankYouPage

Instance Attribute Summary collapse

Instance Method Summary collapse

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(key:, text:, is_checked_by_default: nil, is_required: nil) ⇒ Object

A consent checkbox for the custom disclaimer section.

Parameters:

  • key (String) —

    Unique key for this checkbox.

  • text (String) —

    Label text for the checkbox.

  • is_checked_by_default (Boolean, nil) (defaults to: nil) —

    Whether the checkbox is checked by default.

  • is_required (Boolean, nil) (defaults to: nil) —

    Whether the checkbox must be checked to submit.




# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1833

Instance Attribute Details

#background_image_source ⇒ String?

Background image source: from_ad or custom.

Returns:

  • (String, nil) 


1426
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1426

optional :background_image_source, String, nil?: true

#background_image_url ⇒ String?

URL of custom background image.

Returns:

  • (String, nil) 


1432
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1432

optional :background_image_url, String, nil?: true

#conditional_logic_enabled ⇒ Boolean?

Whether conditional logic is enabled for questions.

Returns:

  • (Boolean, nil) 


1438
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1438

optional :conditional_logic_enabled, WhopSDK::Internal::Type::Boolean, nil?: true

#context_card_button_text ⇒ String?

CTA button text on the greeting card.

Returns:

  • (String, nil) 


1444
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1444

optional :context_card_button_text, String, nil?: true

#context_card_content ⇒ Array<String>?

Optional greeting card bullet points.

Returns:

  • (Array<String>, nil) 


1450
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1450

optional :context_card_content, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#context_card_style ⇒ String?

Greeting layout: PARAGRAPH_STYLE or LIST_STYLE.

Returns:

  • (String, nil) 


1456
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1456

optional :context_card_style, String, nil?: true

#context_card_title ⇒ String?

Optional greeting card title.

Returns:

  • (String, nil) 


1462
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1462

optional :context_card_title, String, nil?: true

#custom_disclaimer_body ⇒ String?

Custom disclaimer body text.

Returns:

  • (String, nil) 


1468
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1468

optional :custom_disclaimer_body, String, nil?: true

#custom_disclaimer_checkboxes ⇒ Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig::CustomDisclaimerCheckbox>?

Consent checkboxes for the custom disclaimer.

Returns:



1474
1475
1476
1477
1478
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1474

optional :custom_disclaimer_checkboxes,
-> {
  WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig::CustomDisclaimerCheckbox]
},
nil?: true

#custom_disclaimer_title ⇒ String?

Custom disclaimer section title.

Returns:

  • (String, nil) 


1484
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1484

optional :custom_disclaimer_title, String, nil?: true

#form_type ⇒ String?

Form type: more_volume, higher_intent, or rich_creative.

Returns:

  • (String, nil) 


1490
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1490

optional :form_type, String, nil?: true

#messenger_enabled ⇒ Boolean?

Enable Messenger follow-up after form submission.

Returns:

  • (Boolean, nil) 


1496
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1496

optional :messenger_enabled, WhopSDK::Internal::Type::Boolean, nil?: true

#name ⇒ String

Name of the lead form.

Returns:

  • (String) 


1407
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1407

required :name, String

#phone_verification_enabled ⇒ Boolean?

Require phone number verification via OTP (higher_intent only).

Returns:

  • (Boolean, nil) 


1502
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1502

optional :phone_verification_enabled, WhopSDK::Internal::Type::Boolean, nil?: true

#privacy_policy_link_text ⇒ String?

Custom link text for privacy policy (max 70 chars).

Returns:

  • (String, nil) 


1508
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1508

optional :privacy_policy_link_text, String, nil?: true

#privacy_policy_url ⇒ String

URL to your privacy policy. Required by Meta.

Returns:

  • (String) 


1413
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1413

required :privacy_policy_url, String

#question_page_custom_headline ⇒ String?

Custom headline for the questions page.

Returns:

  • (String, nil) 


1514
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1514

optional :question_page_custom_headline, String, nil?: true

#questions ⇒ Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig::Question>

Questions to ask on the form.

Returns:



1419
1420
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1419

required :questions,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig::Question] }

#rich_creative_headline ⇒ String?

Headline for rich creative form intro.

Returns:

  • (String, nil) 


1520
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1520

optional :rich_creative_headline, String, nil?: true

#rich_creative_overview ⇒ String?

Overview description for rich creative form intro.

Returns:

  • (String, nil) 


1526
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1526

optional :rich_creative_overview, String, nil?: true

#rich_creative_url ⇒ String?

Uploaded image URL for rich creative form type.

Returns:

  • (String, nil) 


1532
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1532

optional :rich_creative_url, String, nil?: true

#thank_you_pages ⇒ Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig::ThankYouPage>?

Thank you / ending pages (supports multiple for conditional routing).

Returns:



1538
1539
1540
1541
1542
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 1538

optional :thank_you_pages,
-> {
  WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroupUpdateParams::PlatformConfig::Meta::LeadFormConfig::ThankYouPage]
},
nil?: true