trycourier 6.5.0 → 6.6.0

data/rbi/courier/models/workspace_preference_topic_replace_request.rbi

@@ -40,6 +40,21 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
+      # 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.
+      sig { returns(T.nilable(Courier::TopicDigestRequest)) }
+      attr_reader :digest
+
+      sig do
+        params(digest: T.nilable(Courier::TopicDigestRequest::OrHash)).void
+      end
+      attr_writer :digest
+
       # Whether to include a list-unsubscribe header on emails for this topic.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :include_unsubscribe_header
@@ -68,6 +83,7 @@ module Courier
               ]
             ),
           description: T.nilable(String),
+          digest: T.nilable(Courier::TopicDigestRequest::OrHash),
           include_unsubscribe_header: T.nilable(T::Boolean),
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -84,6 +100,14 @@ module Courier
         # Optional description shown under the topic on the hosted preferences page. Omit
         # to clear.
         description: nil,
+        # 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.
+        digest: nil,
         # Whether to include a list-unsubscribe header on emails for this topic.
         include_unsubscribe_header: nil,
         # Default channels delivered for this topic. Omit to clear.
@@ -106,6 +130,7 @@ module Courier
                 ]
               ),
             description: T.nilable(String),
+            digest: T.nilable(Courier::TopicDigestRequest),
             include_unsubscribe_header: T.nilable(T::Boolean),
             routing_options:
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),

data/rbi/courier/models/workspace_preferences/topic_delete_digest_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Courier
+  module Models
+    module WorkspacePreferences
+      class TopicDeleteDigestParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::WorkspacePreferences::TopicDeleteDigestParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :section_id
+
+        sig { returns(String) }
+        attr_accessor :topic_id
+
+        sig do
+          params(
+            section_id: String,
+            topic_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(section_id:, topic_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              section_id: String,
+              topic_id: String,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/workspace_preferences/topic_release_digest_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Courier
+  module Models
+    module WorkspacePreferences
+      class TopicReleaseDigestParams < Courier::Models::TopicDigestReleaseRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::WorkspacePreferences::TopicReleaseDigestParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :section_id
+
+        sig { returns(String) }
+        attr_accessor :topic_id
+
+        sig do
+          params(
+            section_id: String,
+            topic_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(section_id:, topic_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              section_id: String,
+              topic_id: String,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models.rbi

@@ -152,6 +152,10 @@ module Courier
 
   DigestCategory = Courier::Models::DigestCategory
 
+  DigestDayOfWeek = Courier::Models::DigestDayOfWeek
+
+  DigestFrequency = Courier::Models::DigestFrequency
+
   DigestInstance = Courier::Models::DigestInstance
 
   DigestInstanceListResponse = Courier::Models::DigestInstanceListResponse
@@ -622,6 +626,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/rbi/courier/resources/digests/schedules.rbi

@@ -38,8 +38,11 @@ module Courier
           ).void
         end
         def release(
-          # The ID of the digest schedule to release, in the form `sch/{uuid}`. The value
-          # must be URL-encoded (e.g. `sch%2F00000000-0000-0000-0000-000000000000`).
+          # The ID of the digest schedule to release. Newer schedules are
+          # `sch_01m26xfcn3endt3nxy4e2kx2rh` and need no encoding. Schedules created before
+          # that format are `sch/{uuid}` and contain a literal `/`, so those must be
+          # URL-encoded (e.g. `sch%2F00000000-0000-0000-0000-000000000000`). Both forms
+          # remain valid; existing ids are never migrated.
           schedule_id,
           request_options: {}
         )

data/rbi/courier/resources/workspace_preferences/topics.rbi

@@ -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
         # Creates a subscription topic inside a workspace preference. The default status
         # sets whether users start opted in, opted out, or required.
@@ -21,6 +19,7 @@ module Courier
                 ]
               ),
             description: T.nilable(String),
+            digest: T.nilable(Courier::TopicDigestRequest::OrHash),
             include_unsubscribe_header: T.nilable(T::Boolean),
             routing_options:
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -44,6 +43,14 @@ module Courier
           # Body param: Optional description shown under the topic on the hosted preferences
           # page.
           description: nil,
+          # Body param: 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.
+          digest: nil,
           # Body param: Whether to include a list-unsubscribe header on emails for this
           # topic.
           include_unsubscribe_header: nil,
@@ -119,6 +126,60 @@ 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.
+        sig do
+          params(
+            topic_id: String,
+            section_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def delete_digest(
+          # The preference topic whose digest to turn off.
+          topic_id,
+          # The preference section containing the topic.
+          section_id:,
+          request_options: {}
+        )
+        end
+
+        # 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`.
+        sig do
+          params(
+            topic_id: String,
+            section_id: String,
+            user_id: String,
+            tenant_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def release_digest(
+          # Path param: The preference topic whose digest to release.
+          topic_id,
+          # Path param: The preference section containing the topic.
+          section_id:,
+          # Body param: 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:,
+          # Body param: 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,
+          request_options: {}
+        )
+        end
+
         # Replace a topic within a workspace preference. Full document replacement;
         # missing optional fields are cleared. Same 404 rules as GET.
         sig do
@@ -135,6 +196,7 @@ module Courier
                 ]
               ),
             description: T.nilable(String),
+            digest: T.nilable(Courier::TopicDigestRequest::OrHash),
             include_unsubscribe_header: T.nilable(T::Boolean),
             routing_options:
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -157,6 +219,14 @@ module Courier
           # Body param: Optional description shown under the topic on the hosted preferences
           # page. Omit to clear.
           description: nil,
+          # Body param: 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.
+          digest: nil,
           # Body param: Whether to include a list-unsubscribe header on emails for this
           # topic.
           include_unsubscribe_header: nil,

data/rbi/courier/resources/workspace_preferences.rbi

@@ -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.
       sig { returns(Courier::Resources::WorkspacePreferences::Topics) }
       attr_reader :topics
 

data/sig/courier/models/digest_day_of_week.rbs

@@ -0,0 +1,26 @@
+module Courier
+  module Models
+    type digest_day_of_week =
+      :sunday
+      | :monday
+      | :tuesday
+      | :wednesday
+      | :thursday
+      | :friday
+      | :saturday
+
+    module DigestDayOfWeek
+      extend Courier::Internal::Type::Enum
+
+      SUNDAY: :sunday
+      MONDAY: :monday
+      TUESDAY: :tuesday
+      WEDNESDAY: :wednesday
+      THURSDAY: :thursday
+      FRIDAY: :friday
+      SATURDAY: :saturday
+
+      def self?.values: -> ::Array[Courier::Models::digest_day_of_week]
+    end
+  end
+end

data/sig/courier/models/digest_frequency.rbs

@@ -0,0 +1,19 @@
+module Courier
+  module Models
+    type digest_frequency =
+      :instant | :daily | :weekdays | :weekly | :custom_days | :monthly
+
+    module DigestFrequency
+      extend Courier::Internal::Type::Enum
+
+      INSTANT: :instant
+      DAILY: :daily
+      WEEKDAYS: :weekdays
+      WEEKLY: :weekly
+      CUSTOM_DAYS: :custom_days
+      MONTHLY: :monthly
+
+      def self?.values: -> ::Array[Courier::Models::digest_frequency]
+    end
+  end
+end

data/sig/courier/models/topic_digest_category.rbs

@@ -0,0 +1,57 @@
+module Courier
+  module Models
+    type topic_digest_category =
+      {
+        category_key: String,
+        limit: Integer,
+        retain: Courier::Models::TopicDigestCategory::retain,
+        sort_key: String
+      }
+
+    class TopicDigestCategory < Courier::Internal::Type::BaseModel
+      attr_accessor category_key: String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_reader retain: Courier::Models::TopicDigestCategory::retain?
+
+      def retain=: (
+        Courier::Models::TopicDigestCategory::retain
+      ) -> Courier::Models::TopicDigestCategory::retain
+
+      attr_reader sort_key: String?
+
+      def sort_key=: (String) -> String
+
+      def initialize: (
+        category_key: String,
+        ?limit: Integer,
+        ?retain: Courier::Models::TopicDigestCategory::retain,
+        ?sort_key: String
+      ) -> void
+
+      def to_hash: -> {
+        category_key: String,
+        limit: Integer,
+        retain: Courier::Models::TopicDigestCategory::retain,
+        sort_key: String
+      }
+
+      type retain = :FIRST | :LAST | :HIGHEST | :LOWEST | :NONE
+
+      module Retain
+        extend Courier::Internal::Type::Enum
+
+        FIRST: :FIRST
+        LAST: :LAST
+        HIGHEST: :HIGHEST
+        LOWEST: :LOWEST
+        NONE: :NONE
+
+        def self?.values: -> ::Array[Courier::Models::TopicDigestCategory::retain]
+      end
+    end
+  end
+end

data/sig/courier/models/topic_digest_release_request.rbs

@@ -0,0 +1,17 @@
+module Courier
+  module Models
+    type topic_digest_release_request = { user_id: String, tenant_id: String }
+
+    class TopicDigestReleaseRequest < Courier::Internal::Type::BaseModel
+      attr_accessor user_id: String
+
+      attr_reader tenant_id: String?
+
+      def tenant_id=: (String) -> String
+
+      def initialize: (user_id: String, ?tenant_id: String) -> void
+
+      def to_hash: -> { user_id: String, tenant_id: String }
+    end
+  end
+end

data/sig/courier/models/topic_digest_request.rbs

@@ -0,0 +1,48 @@
+module Courier
+  module Models
+    type topic_digest_request =
+      {
+        schedules: ::Array[Courier::TopicDigestScheduleRequest],
+        template_id: String,
+        audience_id: String,
+        categories: ::Array[Courier::TopicDigestCategory],
+        trigger_empty: bool
+      }
+
+    class TopicDigestRequest < Courier::Internal::Type::BaseModel
+      attr_accessor schedules: ::Array[Courier::TopicDigestScheduleRequest]
+
+      attr_accessor template_id: String
+
+      attr_reader audience_id: String?
+
+      def audience_id=: (String) -> String
+
+      attr_reader categories: ::Array[Courier::TopicDigestCategory]?
+
+      def categories=: (
+        ::Array[Courier::TopicDigestCategory]
+      ) -> ::Array[Courier::TopicDigestCategory]
+
+      attr_reader trigger_empty: bool?
+
+      def trigger_empty=: (bool) -> bool
+
+      def initialize: (
+        schedules: ::Array[Courier::TopicDigestScheduleRequest],
+        template_id: String,
+        ?audience_id: String,
+        ?categories: ::Array[Courier::TopicDigestCategory],
+        ?trigger_empty: bool
+      ) -> void
+
+      def to_hash: -> {
+        schedules: ::Array[Courier::TopicDigestScheduleRequest],
+        template_id: String,
+        audience_id: String,
+        categories: ::Array[Courier::TopicDigestCategory],
+        trigger_empty: bool
+      }
+    end
+  end
+end

data/sig/courier/models/topic_digest_response.rbs

@@ -0,0 +1,58 @@
+module Courier
+  module Models
+    type topic_digest_response =
+      {
+        categories: ::Array[Courier::TopicDigestCategory],
+        schedules: ::Array[Courier::TopicDigestScheduleResponse],
+        template_id: String,
+        audience_id: String,
+        created: String,
+        trigger_empty: bool,
+        updated: String
+      }
+
+    class TopicDigestResponse < Courier::Internal::Type::BaseModel
+      attr_accessor categories: ::Array[Courier::TopicDigestCategory]
+
+      attr_accessor schedules: ::Array[Courier::TopicDigestScheduleResponse]
+
+      attr_accessor template_id: String
+
+      attr_reader audience_id: String?
+
+      def audience_id=: (String) -> String
+
+      attr_reader created: String?
+
+      def created=: (String) -> String
+
+      attr_reader trigger_empty: bool?
+
+      def trigger_empty=: (bool) -> bool
+
+      attr_reader updated: String?
+
+      def updated=: (String) -> String
+
+      def initialize: (
+        categories: ::Array[Courier::TopicDigestCategory],
+        schedules: ::Array[Courier::TopicDigestScheduleResponse],
+        template_id: String,
+        ?audience_id: String,
+        ?created: String,
+        ?trigger_empty: bool,
+        ?updated: String
+      ) -> void
+
+      def to_hash: -> {
+        categories: ::Array[Courier::TopicDigestCategory],
+        schedules: ::Array[Courier::TopicDigestScheduleResponse],
+        template_id: String,
+        audience_id: String,
+        created: String,
+        trigger_empty: bool,
+        updated: String
+      }
+    end
+  end
+end

data/sig/courier/models/topic_digest_schedule_request.rbs

@@ -0,0 +1,80 @@
+module Courier
+  module Models
+    type topic_digest_schedule_request =
+      {
+        frequency: Courier::Models::digest_frequency,
+        day_of_month: Integer,
+        day_of_week: Courier::Models::digest_day_of_week,
+        days_of_week: ::Array[Courier::Models::digest_day_of_week],
+        disabled: bool,
+        is_default: bool,
+        schedule_id: String,
+        time: String,
+        timezone: String
+      }
+
+    class TopicDigestScheduleRequest < Courier::Internal::Type::BaseModel
+      attr_accessor frequency: Courier::Models::digest_frequency
+
+      attr_reader day_of_month: Integer?
+
+      def day_of_month=: (Integer) -> Integer
+
+      attr_reader day_of_week: Courier::Models::digest_day_of_week?
+
+      def day_of_week=: (
+        Courier::Models::digest_day_of_week
+      ) -> Courier::Models::digest_day_of_week
+
+      attr_reader days_of_week: ::Array[Courier::Models::digest_day_of_week]?
+
+      def days_of_week=: (
+        ::Array[Courier::Models::digest_day_of_week]
+      ) -> ::Array[Courier::Models::digest_day_of_week]
+
+      attr_reader disabled: bool?
+
+      def disabled=: (bool) -> bool
+
+      attr_reader is_default: bool?
+
+      def is_default=: (bool) -> bool
+
+      attr_reader schedule_id: String?
+
+      def schedule_id=: (String) -> String
+
+      attr_reader time: String?
+
+      def time=: (String) -> String
+
+      attr_reader timezone: String?
+
+      def timezone=: (String) -> String
+
+      def initialize: (
+        frequency: Courier::Models::digest_frequency,
+        ?day_of_month: Integer,
+        ?day_of_week: Courier::Models::digest_day_of_week,
+        ?days_of_week: ::Array[Courier::Models::digest_day_of_week],
+        ?disabled: bool,
+        ?is_default: bool,
+        ?schedule_id: String,
+        ?time: String,
+        ?timezone: String
+      ) -> void
+
+      def to_hash: -> {
+        frequency: Courier::Models::digest_frequency,
+        day_of_month: Integer,
+        day_of_week: Courier::Models::digest_day_of_week,
+        days_of_week: ::Array[Courier::Models::digest_day_of_week],
+        disabled: bool,
+        is_default: bool,
+        schedule_id: String,
+        time: String,
+        timezone: String
+      }
+    end
+  end
+end