Class: Courier::Models::TopicDigestReleaseRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/topic_digest_release_request.rb,
sig/courier/models/topic_digest_release_request.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(user_id:, tenant_id: nil) ⇒ TopicDigestReleaseRequest

Some parameter documentations has been truncated, see Courier::Models::TopicDigestReleaseRequest for more details.

Which recipient's held digest to release.

Parameters:

  • user_id (String) —

    The recipient whose digest to release. Required: there is no "release everyone o

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

    The recipient's tenant, when they were sent to as part of one -- the same value

  • user_id: (String)
  • tenant_id: (String) (defaults to: nil) 



# File 'lib/courier/models/topic_digest_release_request.rb', line 24

Instance Attribute Details

#tenant_id ⇒ String?

The recipient's tenant, when they were sent to as part of one -- the same value returned as tenant_id on a digest instance and sent as message.context.tenant_id. It is part of the held digest's key, so a tenanted recipient cannot be found without it. Omit for an ordinary recipient.

Parameters:

  • (String)

Returns:

  • (String, nil) 


22
 
# File 'lib/courier/models/topic_digest_release_request.rb', line 22

optional :tenant_id, String

#user_id ⇒ String

The recipient whose digest to release. Required: there is no "release everyone on this topic" form, because a whole-schedule flush already has its own endpoint and a body-shaped difference between one recipient and all of them is too easy to get wrong.

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/courier/models/topic_digest_release_request.rb', line 13

required :user_id, String

Instance Method Details

#to_hash ⇒ { user_id: String, tenant_id: String }

Returns:

  • ({ user_id: String, tenant_id: String }) 


14
 
# File 'sig/courier/models/topic_digest_release_request.rbs', line 14

def to_hash: -> { user_id: String, tenant_id: String }