Class: Moonbase::Models::Collections::FieldUpdateParams::Field::FieldNumberMonetary

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

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

Parameters for updating a monetary field.

Parameters:

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

    Updated cardinality: ‘one` or `many`.

  • default_unit (String) (defaults to: nil) —

    The default currency for the field, as a 3-letter ISO 4217 code (e.g., ‘USD`, `E

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

    An updated description, or ‘null` to clear it.

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

    The new name for the field.

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

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

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

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

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

    The field type. Must be ‘field/number/monetary`.




# File 'lib/moonbase/models/collections/field_update_params.rb', line 533

Instance Attribute Details

#cardinality ⇒ Symbol, ...

Updated cardinality: ‘one` or `many`.

Returns:



490
491
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 490

optional :cardinality,
enum: -> { Moonbase::Collections::FieldUpdateParams::Field::FieldNumberMonetary::Cardinality }

#default_unit ⇒ String?

The default currency for the field, as a 3-letter ISO 4217 code (e.g., ‘USD`, `EUR`, `GBP`).

Returns:

  • (String, nil) 


498
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 498

optional :default_unit, String

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

Returns:



503
504
505
506
507
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 503

optional :default_values,
-> {
  Moonbase::Internal::Type::ArrayOf[Moonbase::MonetaryValue]
},
nil?: true

#description ⇒ String?

An updated description, or ‘null` to clear it.

Returns:

  • (String, nil) 


513
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 513

optional :description, String, nil?: true

#name ⇒ String?

The new name for the field.

Returns:

  • (String, nil) 


519
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 519

optional :name, String

#required ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


525
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 525

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

#type ⇒ Symbol, :"field/number/monetary"

The field type. Must be ‘field/number/monetary`.

Returns:

  • (Symbol, :"field/number/monetary") 


484
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 484

required :type, const: :"field/number/monetary"

#unique ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


531
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 531

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