Class: Moonbase::Models::Item

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

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(id:, collection:, values:, type: :item) ⇒ Object

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

An Item represents a single record or row within a Collection. It holds a set of ‘values` corresponding to the Collection’s ‘fields`.

Parameters:



# File 'lib/moonbase/models/item.rb', line 32

Instance Attribute Details

#collectionMoonbase::Models::CollectionPointer

A lightweight reference to a ‘Collection`, containing the minimal information needed to identify it.



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

required :collection, -> { Moonbase::CollectionPointer }

#idString

Unique identifier for the object.

Returns:

  • (String)


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

required :id, String

#typeSymbol, :item

String representing the object’s type. Always ‘item` for this object.

Returns:

  • (Symbol, :item)


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

required :type, const: :item

#valuesHash{Symbol=>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::DatetimeValue, Moonbase::Models::ChoiceValue, Moonbase::Models::FunnelStepValue, Moonbase::Models::RelationValue, 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::DatetimeValue, Moonbase::Models::ChoiceValue, Moonbase::Models::FunnelStepValue, Moonbase::Models::RelationValue>}

A hash where keys are the ‘ref` of a `Field` and values are the data stored for that field.



30
# File 'lib/moonbase/models/item.rb', line 30

required :values, -> { Moonbase::Internal::Type::HashOf[union: Moonbase::FieldValue] }