Class: Knockapi::Models::RecipientReference::ObjectReference

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::RecipientReference::ObjectReference

Defined in:

lib/knockapi/models/recipient_reference.rb

Instance Attribute Summary

• #collection ⇒ String^?

  The collection the recipient object belongs to.

• #id ⇒ String^?

  An identifier for the recipient object.

Instance Method Summary

• #initialize(id: nil, collection: nil) ⇒ Object constructor

  A reference to a recipient object.

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: nil, collection: nil) ⇒ Object

A reference to a recipient object.

Parameters:

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

  An identifier for the recipient object.

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

  The collection the recipient object belongs to.

# File 'lib/knockapi/models/recipient_reference.rb', line 29

Instance Attribute Details

#collection ⇒ String^?

The collection the recipient object belongs to.

Returns:

• (String, nil)

# File 'lib/knockapi/models/recipient_reference.rb', line 27

optional :collection, String

#id ⇒ String^?

An identifier for the recipient object.

Returns:

• (String, nil)

# File 'lib/knockapi/models/recipient_reference.rb', line 21

optional :id, String