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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/recipient_reference.rb,
sig/knockapi/models/recipient_reference.rbs

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

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.

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



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

Instance Attribute Details

#collection ⇒ String?

The collection the recipient object belongs to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :collection, String

#id ⇒ String?

An identifier for the recipient object.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :id, String

Instance Method Details

#to_hash ⇒ { id: String, collection: String }

Returns:

  • ({ id: String, collection: String }) 


22
 
# File 'sig/knockapi/models/recipient_reference.rbs', line 22

def to_hash: -> { id: String, collection: String }