Class: Moonbase::Models::Collections::FieldCreateParams::Field::FieldEmail

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moonbase/models/collections/field_create_params.rb

Defined Under Namespace

Modules: Cardinality

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(name:, cardinality: nil, default_values: nil, description: nil, required: nil, unique: nil, type: :"field/email") ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::Collections::FieldCreateParams::Field::FieldEmail for more details.

Parameters for creating an email field.

Parameters:

  • name (String) —

    The human-readable name for the field.

  • cardinality (Symbol, Moonbase::Models::Collections::FieldCreateParams::Field::FieldEmail::Cardinality) (defaults to: nil) —

    Whether the field holds a single value (‘one`) or multiple values (`many`). Defa

  • default_values (Array<Moonbase::Models::EmailValue>) (defaults to: nil)
  • description (String) (defaults to: nil) —

    An optional description of the field’s purpose.

  • required (Boolean) (defaults to: nil) —

    If ‘true`, items must have a value for this field. Defaults to `false`.

  • unique (Boolean) (defaults to: nil) —

    If ‘true`, values must be unique across all items. Defaults to `false`.

  • type (Symbol, :"field/email") (defaults to: :"field/email") —

    The field type. Must be ‘field/email`.




# File 'lib/moonbase/models/collections/field_create_params.rb', line 773

Instance Attribute Details

#cardinality ⇒ Symbol, ...

Whether the field holds a single value (‘one`) or multiple values (`many`). Defaults to `one`.

Returns:



747
748
 
# File 'lib/moonbase/models/collections/field_create_params.rb', line 747

optional :cardinality,
enum: -> { Moonbase::Collections::FieldCreateParams::Field::FieldEmail::Cardinality }

#default_values ⇒ Array<Moonbase::Models::EmailValue>?

Returns:



753
 
# File 'lib/moonbase/models/collections/field_create_params.rb', line 753

optional :default_values, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::EmailValue] }

#description ⇒ String?

An optional description of the field’s purpose.

Returns:

  • (String, nil) 


759
 
# File 'lib/moonbase/models/collections/field_create_params.rb', line 759

optional :description, String

#name ⇒ String

The human-readable name for the field.

Returns:

  • (String) 


734
 
# File 'lib/moonbase/models/collections/field_create_params.rb', line 734

required :name, String

#required ⇒ Boolean?

If ‘true`, items must have a value for this field. Defaults to `false`.

Returns:

  • (Boolean, nil) 


765
 
# File 'lib/moonbase/models/collections/field_create_params.rb', line 765

optional :required, Moonbase::Internal::Type::Boolean

#type ⇒ Symbol, :"field/email"

The field type. Must be ‘field/email`.

Returns:

  • (Symbol, :"field/email") 


740
 
# File 'lib/moonbase/models/collections/field_create_params.rb', line 740

required :type, const: :"field/email"

#unique ⇒ Boolean?

If ‘true`, values must be unique across all items. Defaults to `false`.

Returns:

  • (Boolean, nil) 


771
 
# File 'lib/moonbase/models/collections/field_create_params.rb', line 771

optional :unique, Moonbase::Internal::Type::Boolean