Class: Moonbase::Models::StageFieldCreateParams

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moonbase/models/stage_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(funnel:, name:, cardinality: nil, default_values: nil, description: nil, required: nil, unique: nil, type: :"field/stage") ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::StageFieldCreateParams for more details.

Parameters for creating a stage field.

Parameters:

  • funnel (Moonbase::Models::FunnelPointerParam) —

    The funnel that defines the available stages for this field.

  • name (String) —

    The human-readable name for the field.

  • cardinality (Symbol, Moonbase::Models::StageFieldCreateParams::Cardinality) (defaults to: nil) —

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

  • default_values (Array<Moonbase::Models::FunnelStepValueParam>) (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/stage") (defaults to: :"field/stage") —

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




# File 'lib/moonbase/models/stage_field_create_params.rb', line 54

Instance Attribute Details

#cardinality ⇒ Symbol, ...

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

Returns:



29
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 29

optional :cardinality, enum: -> { Moonbase::StageFieldCreateParams::Cardinality }

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

Returns:



34
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 34

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

#description ⇒ String?

An optional description of the field’s purpose.

Returns:

  • (String, nil) 


40
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 40

optional :description, String

#funnel ⇒ Moonbase::Models::FunnelPointerParam

The funnel that defines the available stages for this field.

Returns:



10
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 10

required :funnel, -> { Moonbase::FunnelPointerParam }

#name ⇒ String

The human-readable name for the field.

Returns:

  • (String) 


16
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 16

required :name, String

#required ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


46
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 46

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

#type ⇒ Symbol, :"field/stage"

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

Returns:

  • (Symbol, :"field/stage") 


22
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 22

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

#unique ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


52
 
# File 'lib/moonbase/models/stage_field_create_params.rb', line 52

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