Class: WhopSDK::Models::PlanCreateParams::CustomField

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/plan_create_params.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_typeSymbol, :text

The type of the custom field.

Returns:

  • (Symbol, :text)


249
# File 'lib/whop_sdk/models/plan_create_params.rb', line 249

required :field_type, const: :text

#idString?

The ID of the custom field (if being updated)

Returns:

  • (String, nil)


261
# File 'lib/whop_sdk/models/plan_create_params.rb', line 261

optional :id, String, nil?: true

#nameString

The name of the custom field.

Returns:

  • (String)


255
# File 'lib/whop_sdk/models/plan_create_params.rb', line 255

required :name, String

#orderInteger?

The order of the field.

Returns:

  • (Integer, nil)


267
# File 'lib/whop_sdk/models/plan_create_params.rb', line 267

optional :order, Integer, nil?: true

#placeholderString?

The placeholder value of the field.

Returns:

  • (String, nil)


273
# File 'lib/whop_sdk/models/plan_create_params.rb', line 273

optional :placeholder, String, nil?: true

#requiredBoolean?

Whether or not the field is required.

Returns:

  • (Boolean, nil)


279
# File 'lib/whop_sdk/models/plan_create_params.rb', line 279

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