Class: Moonbase::Models::Constituent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Moonbase::Models::Constituent

Defined in:

lib/moonbase/models/constituent.rb

Defined Under Namespace

Modules: Relation

Instance Attribute Summary

• #entity ⇒ Moonbase::Models::CallPointer, ...

  A lightweight reference to the entity of ‘Constituent`, containing information about what type of entity it is as well as the entity’s id.

• #relation ⇒ Symbol, Moonbase::Models::Constituent::Relation
• #type ⇒ Symbol, :constituent

Instance Method Summary

• #initialize(entity:, relation:, type: :constituent) ⇒ Object constructor

  Some parameter documentations has been truncated, see Constituent for more details.

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(entity:, relation:, type: :constituent) ⇒ Object

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

The Constituent object represents information about something that was involved in a particular activity.

Parameters:

• entity (Moonbase::Models::CallPointer, Moonbase::Models::CollectionPointer, Moonbase::Models::ItemPointer, Moonbase::Models::FilePointer, Moonbase::Models::MeetingPointer, Moonbase::Models::EmailMessagePointer, Moonbase::Models::NotePointer, Moonbase::Models::ProgramPointer, Moonbase::Models::ProgramMessagePointer, Moonbase::Models::ProgramTemplatePointer, Moonbase::Models::UnsubscribePointer) —

  A lightweight reference to the entity of ‘Constituent`, containing information a

• relation (Symbol, Moonbase::Models::Constituent::Relation)
• type (Symbol, :constituent) (defaults to: :constituent)

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

Instance Attribute Details

#entity ⇒ Moonbase::Models::CallPointer, ...

A lightweight reference to the entity of ‘Constituent`, containing information about what type of entity it is as well as the entity’s id.

Returns:

• (Moonbase::Models::CallPointer, Moonbase::Models::CollectionPointer, Moonbase::Models::ItemPointer, Moonbase::Models::FilePointer, Moonbase::Models::MeetingPointer, Moonbase::Models::EmailMessagePointer, Moonbase::Models::NotePointer, Moonbase::Models::ProgramPointer, Moonbase::Models::ProgramMessagePointer, Moonbase::Models::ProgramTemplatePointer, Moonbase::Models::UnsubscribePointer)

# File 'lib/moonbase/models/constituent.rb', line 11

required :entity, union: -> { Moonbase::ConstituentEntityPointer }

#relation ⇒ Symbol, Moonbase::Models::Constituent::Relation

Returns:

• (Symbol, Moonbase::Models::Constituent::Relation)

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

required :relation, enum: -> { Moonbase::Constituent::Relation }

#type ⇒ Symbol, :constituent

Returns:

• (Symbol, :constituent)

# File 'lib/moonbase/models/constituent.rb', line 21

required :type, const: :constituent