Class: Moonbase::Models::IdentifierField

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

Defined Under Namespace

Modules: Cardinality, Kind

Instance Attribute Summary collapse

Class Method 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(id:, cardinality:, created_at:, default_values:, kind:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/identifier") ⇒ Object

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

A field that stores opaque external identifiers verbatim.

Parameters:




# File 'lib/moonbase/models/identifier_field.rb', line 86

Instance Attribute Details

#cardinality ⇒ Symbol, Moonbase::Models::IdentifierField::Cardinality

Specifies whether the field can hold a single value (‘one`) or multiple values (`many`).

Returns:



17
 
# File 'lib/moonbase/models/identifier_field.rb', line 17

required :cardinality, enum: -> { Moonbase::IdentifierField::Cardinality }

#created_at ⇒ Time

Time at which the object was created, as an ISO 8601 timestamp in UTC.

Returns:

  • (Time) 


23
 
# File 'lib/moonbase/models/identifier_field.rb', line 23

required :created_at, Time

#default_values ⇒ Array<Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IdentifierValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::CurrentDate, Moonbase::Models::DatetimeValue, Moonbase::Models::CurrentDatetime, Moonbase::Models::ChoiceValue, Moonbase::Models::FunnelStepValue, Moonbase::Models::RelationValue, Moonbase::Models::CurrentMember>

Returns:



28
 
# File 'lib/moonbase/models/identifier_field.rb', line 28

required :default_values, -> { Moonbase::Internal::Type::ArrayOf[union: Moonbase::FieldDefaultValue] }

#description ⇒ String?

An optional, longer-form description of the field’s purpose.

Returns:

  • (String, nil) 


84
 
# File 'lib/moonbase/models/identifier_field.rb', line 84

optional :description, String

#id ⇒ String

Unique identifier for the object.

Returns:

  • (String) 


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

required :id, String

#kind ⇒ Symbol, Moonbase::Models::IdentifierField::Kind

Returns:



33
 
# File 'lib/moonbase/models/identifier_field.rb', line 33

required :kind, enum: -> { Moonbase::IdentifierField::Kind }

#name ⇒ String

The human-readable name of the field (e.g., “Stripe Id”).

Returns:

  • (String) 


39
 
# File 'lib/moonbase/models/identifier_field.rb', line 39

required :name, String

#readonly ⇒ Boolean

If ‘true`, the value of this field is system-managed and cannot be updated via the API.

Returns:

  • (Boolean) 


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

required :readonly, Moonbase::Internal::Type::Boolean

#ref ⇒ String

A unique, stable, machine-readable identifier for the field within its collection (e.g., ‘stripe_id`).

Returns:

  • (String) 


53
 
# File 'lib/moonbase/models/identifier_field.rb', line 53

required :ref, String

#required ⇒ Boolean

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

Returns:

  • (Boolean) 


59
 
# File 'lib/moonbase/models/identifier_field.rb', line 59

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

#type ⇒ Symbol, :"field/identifier"

The data type of the field. Always ‘field/identifier` for this field.

Returns:

  • (Symbol, :"field/identifier") 


65
 
# File 'lib/moonbase/models/identifier_field.rb', line 65

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

#unique ⇒ Boolean

If ‘true`, values for this field must be unique across all items in the collection.

Returns:

  • (Boolean) 


72
 
# File 'lib/moonbase/models/identifier_field.rb', line 72

required :unique, Moonbase::Internal::Type::Boolean

#updated_at ⇒ Time

Time at which the object was last updated, as an ISO 8601 timestamp in UTC.

Returns:

  • (Time) 


78
 
# File 'lib/moonbase/models/identifier_field.rb', line 78

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/moonbase/models/identifier_field.rb', line 128