Class: WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::InstantFormConfig::Question

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

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(privacy_policy_url:, questions:, button_text: nil, greeting: nil, name: nil) ⇒ Object

Instant form configuration for lead generation campaigns.

Parameters:

  • privacy_policy_url (String) —

    URL to your privacy policy.

  • questions (Array<WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::InstantFormConfig::Question>) —

    Form questions (at least one required).

  • button_text (String, nil) (defaults to: nil) —

    Submit button text.

  • greeting (String, nil) (defaults to: nil) —

    Greeting text shown at the top of the form.

  • name (String, nil) (defaults to: nil) —

    Form name. Auto-generated if omitted.



2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2999

class Question < WhopSDK::Internal::Type::BaseModel
  # @!attribute field_type
  #   Question type (EMAIL, PHONE_NUMBER, NAME, CUSTOM).
  #
  #   @return [String]
  required :field_type, String

  # @!attribute label
  #   Custom label for the question.
  #
  #   @return [String, nil]
  optional :label, String, nil?: true

  # @!method initialize(field_type:, label: nil)
  #   A question for a TikTok instant form.
  #
  #   @param field_type [String] Question type (EMAIL, PHONE_NUMBER, NAME, CUSTOM).
  #
  #   @param label [String, nil] Custom label for the question.
end

Instance Attribute Details

#field_type ⇒ String

Question type (EMAIL, PHONE_NUMBER, NAME, CUSTOM).

Returns:

  • (String) 


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

required :field_type, String

#label ⇒ String?

Custom label for the question.

Returns:

  • (String, nil) 


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

optional :label, String, nil?: true