Class: WhopSDK::Models::Plan::CustomField

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#field_type ⇒ Symbol, :text

What type of input field to use.

Returns:

  • (Symbol, :text) 


242
 
# File 'lib/whop_sdk/models/plan.rb', line 242

required :field_type, const: :text

#id ⇒ String

The internal ID of the given custom field

Returns:

  • (String) 


236
 
# File 'lib/whop_sdk/models/plan.rb', line 236

required :id, String

#name ⇒ String

The title/header of the custom field.

Returns:

  • (String) 


248
 
# File 'lib/whop_sdk/models/plan.rb', line 248

required :name, String

#order ⇒ Integer?

How the custom field should be ordered when rendered on the checkout page.

Returns:

  • (Integer, nil) 


254
 
# File 'lib/whop_sdk/models/plan.rb', line 254

required :order, Integer, nil?: true

#placeholder ⇒ String?

An example response displayed in the input field.

Returns:

  • (String, nil) 


260
 
# File 'lib/whop_sdk/models/plan.rb', line 260

required :placeholder, String, nil?: true

#required ⇒ Boolean

Whether or not the custom field is required.

Returns:

  • (Boolean) 


266
 
# File 'lib/whop_sdk/models/plan.rb', line 266

required :required, WhopSDK::Internal::Type::Boolean