trycourier 6.5.0 → 6.6.0

data/lib/courier/models/workspace_preference_topic_create_request.rb

@@ -32,6 +32,18 @@ module Courier
       #   @return [String, nil]
       optional :description, String, nil?: true
 
+      # @!attribute digest
+      #   A topic's digest configuration: the template that renders it, the cadences it
+      #   delivers on, and how collected events are retained.
+      #
+      #   Send `null` for the whole object to turn a digest off, which unlinks the
+      #   template and removes its schedules. There is no `enabled` flag, and
+      #   `schedules: []` is rejected, because both states are un-deliverable rather than
+      #   merely off.
+      #
+      #   @return [Courier::Models::TopicDigestRequest, nil]
+      optional :digest, -> { Courier::TopicDigestRequest }, nil?: true
+
       # @!attribute include_unsubscribe_header
       #   Whether to include a list-unsubscribe header on emails for this topic.
       #
@@ -52,7 +64,7 @@ module Courier
       #   @return [Hash{Symbol=>Object}, nil]
       optional :topic_data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
 
-      # @!method initialize(default_status:, name:, allowed_preferences: nil, description: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
+      # @!method initialize(default_status:, name:, allowed_preferences: nil, description: nil, digest: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::WorkspacePreferenceTopicCreateRequest} for more details.
       #
@@ -66,6 +78,8 @@ module Courier
       #
       #   @param description [String, nil] Optional description shown under the topic on the hosted preferences page.
       #
+      #   @param digest [Courier::Models::TopicDigestRequest, nil] A topic's digest configuration: the template that renders it, the cadences it de
+      #
       #   @param include_unsubscribe_header [Boolean, nil] Whether to include a list-unsubscribe header on emails for this topic.
       #
       #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels delivered for this topic. Defaults to empty if omitted.

data/lib/courier/models/workspace_preference_topic_get_response.rb

@@ -70,13 +70,19 @@ module Courier
       #   @return [String, nil]
       optional :description, String, nil?: true
 
+      # @!attribute digest
+      #   A topic's digest configuration.
+      #
+      #   @return [Courier::Models::TopicDigestResponse, nil]
+      optional :digest, -> { Courier::TopicDigestResponse }, nil?: true
+
       # @!attribute updater
       #   Id of the last updater.
       #
       #   @return [String, nil]
       optional :updater, String, nil?: true
 
-      # @!method initialize(id:, allowed_preferences:, created:, default_status:, include_unsubscribe_header:, name:, routing_options:, topic_data:, updated:, creator: nil, description: nil, updater: nil)
+      # @!method initialize(id:, allowed_preferences:, created:, default_status:, include_unsubscribe_header:, name:, routing_options:, topic_data:, updated:, creator: nil, description: nil, digest: nil, updater: nil)
       #   A subscription preference topic in your workspace.
       #
       #   @param id [String] The preference topic id.
@@ -101,6 +107,8 @@ module Courier
       #
       #   @param description [String, nil] Optional description shown under the topic on the hosted preferences page.
       #
+      #   @param digest [Courier::Models::TopicDigestResponse, nil] A topic's digest configuration.
+      #
       #   @param updater [String, nil] Id of the last updater.
 
       # A preference control a recipient may customize for a topic.

data/lib/courier/models/workspace_preference_topic_replace_request.rb

@@ -32,6 +32,18 @@ module Courier
       #   @return [String, nil]
       optional :description, String, nil?: true
 
+      # @!attribute digest
+      #   A topic's digest configuration: the template that renders it, the cadences it
+      #   delivers on, and how collected events are retained.
+      #
+      #   Send `null` for the whole object to turn a digest off, which unlinks the
+      #   template and removes its schedules. There is no `enabled` flag, and
+      #   `schedules: []` is rejected, because both states are un-deliverable rather than
+      #   merely off.
+      #
+      #   @return [Courier::Models::TopicDigestRequest, nil]
+      optional :digest, -> { Courier::TopicDigestRequest }, nil?: true
+
       # @!attribute include_unsubscribe_header
       #   Whether to include a list-unsubscribe header on emails for this topic.
       #
@@ -52,7 +64,7 @@ module Courier
       #   @return [Hash{Symbol=>Object}, nil]
       optional :topic_data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
 
-      # @!method initialize(default_status:, name:, allowed_preferences: nil, description: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
+      # @!method initialize(default_status:, name:, allowed_preferences: nil, description: nil, digest: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::WorkspacePreferenceTopicReplaceRequest} for more details.
       #
@@ -67,6 +79,8 @@ module Courier
       #
       #   @param description [String, nil] Optional description shown under the topic on the hosted preferences page. Omit
       #
+      #   @param digest [Courier::Models::TopicDigestRequest, nil] A topic's digest configuration: the template that renders it, the cadences it de
+      #
       #   @param include_unsubscribe_header [Boolean, nil] Whether to include a list-unsubscribe header on emails for this topic.
       #
       #   @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Default channels delivered for this topic. Omit to clear.

data/lib/courier/models/workspace_preferences/topic_delete_digest_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module WorkspacePreferences
+      # @see Courier::Resources::WorkspacePreferences::Topics#delete_digest
+      class TopicDeleteDigestParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute section_id
+        #
+        #   @return [String]
+        required :section_id, String
+
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(section_id:, topic_id:, request_options: {})
+        #   @param section_id [String]
+        #   @param topic_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/workspace_preferences/topic_release_digest_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module WorkspacePreferences
+      # @see Courier::Resources::WorkspacePreferences::Topics#release_digest
+      class TopicReleaseDigestParams < Courier::Models::TopicDigestReleaseRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute section_id
+        #
+        #   @return [String]
+        required :section_id, String
+
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!method initialize(section_id:, topic_id:, request_options: {})
+        #   @param section_id [String]
+        #   @param topic_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models.rb

@@ -187,6 +187,10 @@ module Courier
 
   DigestCategory = Courier::Models::DigestCategory
 
+  DigestDayOfWeek = Courier::Models::DigestDayOfWeek
+
+  DigestFrequency = Courier::Models::DigestFrequency
+
   DigestInstance = Courier::Models::DigestInstance
 
   DigestInstanceListResponse = Courier::Models::DigestInstanceListResponse
@@ -643,6 +647,18 @@ module Courier
 
   Token = Courier::Models::Token
 
+  TopicDigestCategory = Courier::Models::TopicDigestCategory
+
+  TopicDigestReleaseRequest = Courier::Models::TopicDigestReleaseRequest
+
+  TopicDigestRequest = Courier::Models::TopicDigestRequest
+
+  TopicDigestResponse = Courier::Models::TopicDigestResponse
+
+  TopicDigestScheduleRequest = Courier::Models::TopicDigestScheduleRequest
+
+  TopicDigestScheduleResponse = Courier::Models::TopicDigestScheduleResponse
+
   TranslationRetrieveParams = Courier::Models::TranslationRetrieveParams
 
   TranslationUpdateParams = Courier::Models::TranslationUpdateParams

data/lib/courier/resources/digests/schedules.rb

@@ -45,7 +45,7 @@ module Courier
         #
         # @overload release(schedule_id, request_options: {})
         #
-        # @param schedule_id [String] The ID of the digest schedule to release, in the form `sch/{uuid}`. The value mu
+        # @param schedule_id [String] The ID of the digest schedule to release. Newer schedules are `sch_01m26xfcn3end
         #
         # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/courier/resources/workspace_preferences/topics.rb

@@ -3,8 +3,6 @@
 module Courier
   module Resources
     class WorkspacePreferences
-      # Manage the workspace catalog of subscription topics, the sections that group
-      # them, and publishing the preference page.
       class Topics
         # Some parameter documentations has been truncated, see
         # {Courier::Models::WorkspacePreferences::TopicCreateParams} for more details.
@@ -12,7 +10,7 @@ module Courier
         # Creates a subscription topic inside a workspace preference. The default status
         # sets whether users start opted in, opted out, or required.
         #
-        # @overload create(section_id, default_status:, name:, allowed_preferences: nil, description: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
+        # @overload create(section_id, default_status:, name:, allowed_preferences: nil, description: nil, digest: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #
         # @param section_id [String] Path param: Id of the workspace preference to create the topic in.
         #
@@ -24,6 +22,8 @@ module Courier
         #
         # @param description [String, nil] Body param: Optional description shown under the topic on the hosted preferences
         #
+        # @param digest [Courier::Models::TopicDigestRequest, nil] Body param: A topic's digest configuration: the template that renders it, the ca
+        #
         # @param include_unsubscribe_header [Boolean, nil] Body param: Whether to include a list-unsubscribe header on emails for this topi
         #
         # @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Body param: Default channels delivered for this topic. Defaults to empty if omit
@@ -130,13 +130,84 @@ module Courier
           )
         end
 
+        # Turn off a topic's digest, leaving the topic itself in place. The template is
+        # unlinked and the digest's schedules are removed along with their delivery rules.
+        # Equivalent to sending `digest: null` on a topic replace.
+        #
+        # @overload delete_digest(topic_id, section_id:, request_options: {})
+        #
+        # @param topic_id [String] The preference topic whose digest to turn off.
+        #
+        # @param section_id [String] The preference section containing the topic.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Courier::Models::WorkspacePreferences::TopicDeleteDigestParams
+        def delete_digest(topic_id, params)
+          parsed, options = Courier::WorkspacePreferences::TopicDeleteDigestParams.dump_request(params)
+          section_id =
+            parsed.delete(:section_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["preferences/sections/%1$s/topics/%2$s/digest", section_id, topic_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::WorkspacePreferences::TopicReleaseDigestParams} for more
+        # details.
+        #
+        # Send one recipient's held digest now, instead of waiting for its schedule. Use
+        # it to preview what a digest will look like, or to let someone flush their own.
+        #
+        # Keyed on the topic because that is how a held digest is stored: one per
+        # recipient per topic, with the schedule recorded on it rather than part of its
+        # identity. To flush every recipient on a schedule instead, use
+        # `POST /digests/schedules/{schedule_id}/trigger`.
+        #
+        # @overload release_digest(topic_id, section_id:, user_id:, tenant_id: nil, request_options: {})
+        #
+        # @param topic_id [String] Path param: The preference topic whose digest to release.
+        #
+        # @param section_id [String] Path param: The preference section containing the topic.
+        #
+        # @param user_id [String] Body param: The recipient whose digest to release. Required: there is no "releas
+        #
+        # @param tenant_id [String] Body param: The recipient's tenant, when they were sent to as part of one -- the
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Courier::Models::WorkspacePreferences::TopicReleaseDigestParams
+        def release_digest(topic_id, params)
+          parsed, options = Courier::WorkspacePreferences::TopicReleaseDigestParams.dump_request(params)
+          section_id =
+            parsed.delete(:section_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["preferences/sections/%1$s/topics/%2$s/digest/release", section_id, topic_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {Courier::Models::WorkspacePreferences::TopicReplaceParams} for more details.
         #
         # Replace a topic within a workspace preference. Full document replacement;
         # missing optional fields are cleared. Same 404 rules as GET.
         #
-        # @overload replace(topic_id, section_id:, default_status:, name:, allowed_preferences: nil, description: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil, request_options: {})
+        # @overload replace(topic_id, section_id:, default_status:, name:, allowed_preferences: nil, description: nil, digest: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil, request_options: {})
         #
         # @param topic_id [String] Path param: Id of the subscription preference topic.
         #
@@ -150,6 +221,8 @@ module Courier
         #
         # @param description [String, nil] Body param: Optional description shown under the topic on the hosted preferences
         #
+        # @param digest [Courier::Models::TopicDigestRequest, nil] Body param: A topic's digest configuration: the template that renders it, the ca
+        #
         # @param include_unsubscribe_header [Boolean, nil] Body param: Whether to include a list-unsubscribe header on emails for this topi
         #
         # @param routing_options [Array<Symbol, Courier::Models::ChannelClassification>, nil] Body param: Default channels delivered for this topic. Omit to clear.

data/lib/courier/resources/workspace_preferences.rb

@@ -5,8 +5,6 @@ module Courier
     # Manage the workspace catalog of subscription topics, the sections that group
     # them, and publishing the preference page.
     class WorkspacePreferences
-      # Manage the workspace catalog of subscription topics, the sections that group
-      # them, and publishing the preference page.
       # @return [Courier::Resources::WorkspacePreferences::Topics]
       attr_reader :topics
 

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "6.5.0"
+  VERSION = "6.6.0"
 end

data/lib/courier.rb

@@ -94,6 +94,7 @@ require_relative "courier/models/workspace_preference_create_request"
 require_relative "courier/models/publish_preferences_request"
 require_relative "courier/models/workspace_preference_replace_request"
 require_relative "courier/models/workspace_preference_topic_create_request"
+require_relative "courier/models/topic_digest_release_request"
 require_relative "courier/models/workspace_preference_topic_replace_request"
 require_relative "courier/models/airship_profile"
 require_relative "courier/models/airship_profile_audience"
@@ -175,6 +176,8 @@ require_relative "courier/models/check"
 require_relative "courier/models/default_preferences"
 require_relative "courier/models/device_type"
 require_relative "courier/models/digest_category"
+require_relative "courier/models/digest_day_of_week"
+require_relative "courier/models/digest_frequency"
 require_relative "courier/models/digest_instance"
 require_relative "courier/models/digest_instance_list_response"
 require_relative "courier/models/digests/schedule_list_instances_params"
@@ -421,6 +424,11 @@ require_relative "courier/models/tenant_update_params"
 require_relative "courier/models/text_style"
 require_relative "courier/models/timeouts"
 require_relative "courier/models/token"
+require_relative "courier/models/topic_digest_category"
+require_relative "courier/models/topic_digest_request"
+require_relative "courier/models/topic_digest_response"
+require_relative "courier/models/topic_digest_schedule_request"
+require_relative "courier/models/topic_digest_schedule_response"
 require_relative "courier/models/translation_retrieve_params"
 require_relative "courier/models/translation_retrieve_response"
 require_relative "courier/models/translation_update_params"
@@ -473,7 +481,9 @@ require_relative "courier/models/workspace_preference_replace_params"
 require_relative "courier/models/workspace_preference_retrieve_params"
 require_relative "courier/models/workspace_preferences/topic_archive_params"
 require_relative "courier/models/workspace_preferences/topic_create_params"
+require_relative "courier/models/workspace_preferences/topic_delete_digest_params"
 require_relative "courier/models/workspace_preferences/topic_list_params"
+require_relative "courier/models/workspace_preferences/topic_release_digest_params"
 require_relative "courier/models/workspace_preferences/topic_replace_params"
 require_relative "courier/models/workspace_preferences/topic_retrieve_params"
 require_relative "courier/models/workspace_preference_topic_get_response"

data/rbi/courier/models/digest_day_of_week.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Courier
+  module Models
+    # A day of the week. Accepted case-insensitively, returned lowercase.
+    module DigestDayOfWeek
+      extend Courier::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Courier::DigestDayOfWeek) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      SUNDAY = T.let(:sunday, Courier::DigestDayOfWeek::TaggedSymbol)
+      MONDAY = T.let(:monday, Courier::DigestDayOfWeek::TaggedSymbol)
+      TUESDAY = T.let(:tuesday, Courier::DigestDayOfWeek::TaggedSymbol)
+      WEDNESDAY = T.let(:wednesday, Courier::DigestDayOfWeek::TaggedSymbol)
+      THURSDAY = T.let(:thursday, Courier::DigestDayOfWeek::TaggedSymbol)
+      FRIDAY = T.let(:friday, Courier::DigestDayOfWeek::TaggedSymbol)
+      SATURDAY = T.let(:saturday, Courier::DigestDayOfWeek::TaggedSymbol)
+
+      sig { override.returns(T::Array[Courier::DigestDayOfWeek::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/courier/models/digest_frequency.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Courier
+  module Models
+    # How often a digest is delivered. `instant` delivers immediately without
+    # batching, and is the one value that takes no `time`.
+    module DigestFrequency
+      extend Courier::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Courier::DigestFrequency) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      INSTANT = T.let(:instant, Courier::DigestFrequency::TaggedSymbol)
+      DAILY = T.let(:daily, Courier::DigestFrequency::TaggedSymbol)
+      WEEKDAYS = T.let(:weekdays, Courier::DigestFrequency::TaggedSymbol)
+      WEEKLY = T.let(:weekly, Courier::DigestFrequency::TaggedSymbol)
+      CUSTOM_DAYS = T.let(:custom_days, Courier::DigestFrequency::TaggedSymbol)
+      MONTHLY = T.let(:monthly, Courier::DigestFrequency::TaggedSymbol)
+
+      sig { override.returns(T::Array[Courier::DigestFrequency::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_node.rbi

@@ -398,7 +398,18 @@ module Courier
 
         # Add the current event to a digest keyed by the given subscription topic. The
         # digest accumulates events and releases them on the schedule configured for the
-        # topic.
+        # topic, using the notification template configured on that topic. This node's
+        # `type` value is `add-to-digest`.
+        #
+        # **The topic must have a template configured.** If the topic has no template when
+        # the first event reaches this node, the journey run fails immediately: the run is
+        # marked `ERROR`, no digest instance is created, and the journey does not continue
+        # past this node. Configure the topic's template before using the topic in a
+        # journey.
+        #
+        # If the journey run is scoped to a tenant, digests are kept separate per tenant:
+        # two runs for the same user under different tenants accumulate and release as
+        # separate digests, even on the same topic.
         sig do
           params(
             subscription_topic_id: String,

data/rbi/courier/models/topic_digest_category.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Courier
+  module Models
+    class TopicDigestCategory < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::TopicDigestCategory, Courier::Internal::AnyHash)
+        end
+
+      # The key that identifies the category within the digest.
+      sig { returns(String) }
+      attr_accessor :category_key
+
+      # How many collected events are carried into the rendered digest. Defaults to 10.
+      #
+      # Events beyond the limit are discarded, not held back for the next digest: the
+      # release consumes everything collected so far and only `limit` of them appear.
+      # `retain` decides which ones those are.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Which collected events survive the `limit`. `FIRST` and `LOWEST` keep the
+      # earliest or smallest; `LAST` and `HIGHEST` keep the latest or largest. Accepted
+      # case-insensitively, returned uppercase.
+      sig { returns(T.nilable(Courier::TopicDigestCategory::Retain::OrSymbol)) }
+      attr_reader :retain
+
+      sig do
+        params(retain: Courier::TopicDigestCategory::Retain::OrSymbol).void
+      end
+      attr_writer :retain
+
+      # The data key used to rank events. Required when `retain` is `HIGHEST` or
+      # `LOWEST`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sort_key
+
+      sig { params(sort_key: String).void }
+      attr_writer :sort_key
+
+      # How events collected under a category key are retained when a digest holds more
+      # than it will render.
+      sig do
+        params(
+          category_key: String,
+          limit: Integer,
+          retain: Courier::TopicDigestCategory::Retain::OrSymbol,
+          sort_key: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The key that identifies the category within the digest.
+        category_key:,
+        # How many collected events are carried into the rendered digest. Defaults to 10.
+        #
+        # Events beyond the limit are discarded, not held back for the next digest: the
+        # release consumes everything collected so far and only `limit` of them appear.
+        # `retain` decides which ones those are.
+        limit: nil,
+        # Which collected events survive the `limit`. `FIRST` and `LOWEST` keep the
+        # earliest or smallest; `LAST` and `HIGHEST` keep the latest or largest. Accepted
+        # case-insensitively, returned uppercase.
+        retain: nil,
+        # The data key used to rank events. Required when `retain` is `HIGHEST` or
+        # `LOWEST`.
+        sort_key: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            category_key: String,
+            limit: Integer,
+            retain: Courier::TopicDigestCategory::Retain::OrSymbol,
+            sort_key: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Which collected events survive the `limit`. `FIRST` and `LOWEST` keep the
+      # earliest or smallest; `LAST` and `HIGHEST` keep the latest or largest. Accepted
+      # case-insensitively, returned uppercase.
+      module Retain
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::TopicDigestCategory::Retain) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FIRST =
+          T.let(:FIRST, Courier::TopicDigestCategory::Retain::TaggedSymbol)
+        LAST = T.let(:LAST, Courier::TopicDigestCategory::Retain::TaggedSymbol)
+        HIGHEST =
+          T.let(:HIGHEST, Courier::TopicDigestCategory::Retain::TaggedSymbol)
+        LOWEST =
+          T.let(:LOWEST, Courier::TopicDigestCategory::Retain::TaggedSymbol)
+        NONE = T.let(:NONE, Courier::TopicDigestCategory::Retain::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::TopicDigestCategory::Retain::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/topic_digest_release_request.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Courier
+  module Models
+    class TopicDigestReleaseRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::TopicDigestReleaseRequest, Courier::Internal::AnyHash)
+        end
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :user_id
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      # Which recipient's held digest to release.
+      sig do
+        params(user_id: String, tenant_id: String).returns(T.attached_class)
+      end
+      def self.new(
+        # 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.
+        user_id:,
+        # 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.
+        tenant_id: nil
+      )
+      end
+
+      sig { override.returns({ user_id: String, tenant_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end