trycourier 6.5.0 → 6.7.0

data/lib/courier/models/topic_digest_schedule_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class TopicDigestScheduleResponse < Courier::Internal::Type::BaseModel
+      # @!attribute schedule_id
+      #   The schedule's identifier, assigned by the server. This is the value the
+      #   `/digests/schedules/{schedule_id}` endpoints are keyed by.
+      #
+      #   Two formats are in circulation and only one is safe to drop into a URL.
+      #   Schedules created through the API are `sch_01m26xfcn3endt3nxy4e2kx2rh` and need
+      #   no encoding. Schedules created in the Preferences Editor before that format are
+      #   `sch/{uuid}` and contain a literal `/`, so they must be URL-encoded as
+      #   `sch%2F{uuid}` — unencoded, the path does not match the route and the response
+      #   is a bare `404` that reads like a broken endpoint. Existing ids are never
+      #   migrated.
+      #
+      #   @return [String]
+      required :schedule_id, String
+
+      # @!attribute created
+      #   ISO-8601 timestamp of when the schedule was created.
+      #
+      #   @return [String, nil]
+      optional :created, String
+
+      # @!attribute day_of_month
+      #   Day of the month, 1-31.
+      #
+      #   @return [Integer, nil]
+      optional :day_of_month, Integer
+
+      # @!attribute day_of_week
+      #   A day of the week. Accepted case-insensitively, returned lowercase.
+      #
+      #   @return [Symbol, Courier::Models::DigestDayOfWeek, nil]
+      optional :day_of_week, enum: -> { Courier::DigestDayOfWeek }
+
+      # @!attribute days_of_week
+      #
+      #   @return [Array<Symbol, Courier::Models::DigestDayOfWeek>, nil]
+      optional :days_of_week, -> { Courier::Internal::Type::ArrayOf[enum: Courier::DigestDayOfWeek] }
+
+      # @!attribute disabled
+      #   Whether the schedule is disabled.
+      #
+      #   @return [Boolean, nil]
+      optional :disabled, Courier::Internal::Type::Boolean
+
+      # @!attribute frequency
+      #   Omitted for a stored schedule this enum cannot express. Those schedules never
+      #   fire, but their `schedule_id` is still returned so the `/digests/*` endpoints
+      #   remain reachable for them.
+      #
+      #   @return [Symbol, Courier::Models::DigestFrequency, nil]
+      optional :frequency, enum: -> { Courier::DigestFrequency }
+
+      # @!attribute is_default
+      #   Whether this is the schedule recipients are placed on by default.
+      #
+      #   @return [Boolean, nil]
+      optional :is_default, Courier::Internal::Type::Boolean
+
+      # @!attribute time
+      #   24-hour local delivery time, `HH:MM`.
+      #
+      #   @return [String, nil]
+      optional :time, String
+
+      # @!attribute timezone
+      #   IANA timezone the schedule is expressed in. Absent means UTC.
+      #
+      #   @return [String, nil]
+      optional :timezone, String
+
+      # @!attribute updated
+      #   ISO-8601 timestamp of the last update.
+      #
+      #   @return [String, nil]
+      optional :updated, String
+
+      # @!method initialize(schedule_id:, created: nil, day_of_month: nil, day_of_week: nil, days_of_week: nil, disabled: nil, frequency: nil, is_default: nil, time: nil, timezone: nil, updated: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::TopicDigestScheduleResponse} for more details.
+      #
+      #   A delivery cadence for a topic's digest, with its assigned id.
+      #
+      #   @param schedule_id [String] The schedule's identifier, assigned by the server. This is the value the `/diges
+      #
+      #   @param created [String] ISO-8601 timestamp of when the schedule was created.
+      #
+      #   @param day_of_month [Integer] Day of the month, 1-31.
+      #
+      #   @param day_of_week [Symbol, Courier::Models::DigestDayOfWeek] A day of the week. Accepted case-insensitively, returned lowercase.
+      #
+      #   @param days_of_week [Array<Symbol, Courier::Models::DigestDayOfWeek>]
+      #
+      #   @param disabled [Boolean] Whether the schedule is disabled.
+      #
+      #   @param frequency [Symbol, Courier::Models::DigestFrequency] Omitted for a stored schedule this enum cannot express. Those schedules never fi
+      #
+      #   @param is_default [Boolean] Whether this is the schedule recipients are placed on by default.
+      #
+      #   @param time [String] 24-hour local delivery time, `HH:MM`.
+      #
+      #   @param timezone [String] IANA timezone the schedule is expressed in. Absent means UTC.
+      #
+      #   @param updated [String] ISO-8601 timestamp of the last update.
+    end
+  end
+end

data/lib/courier/models/users/preference_update_or_create_topic_params.rb

@@ -58,6 +58,16 @@ module Courier
                    -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
                    nil?: true
 
+          # @!attribute digest_schedule_id
+          #   Put this recipient on one of the topic's digest schedules. Send `null` to clear
+          #   the choice and return them to the topic's default. Omit to leave an existing
+          #   choice alone, unlike the routing fields, which this endpoint replaces. An id
+          #   that is not an active schedule on the topic is rejected with a `400` before
+          #   anything is written.
+          #
+          #   @return [String, nil]
+          optional :digest_schedule_id, String, nil?: true
+
           # @!attribute has_custom_routing
           #   Set to true to route this topic to the channels in custom_routing instead of the
           #   topic's default routing.
@@ -65,7 +75,7 @@ module Courier
           #   @return [Boolean, nil]
           optional :has_custom_routing, Courier::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(status:, custom_routing: nil, has_custom_routing: nil)
+          # @!method initialize(status:, custom_routing: nil, digest_schedule_id: nil, has_custom_routing: nil)
           #   Some parameter documentations has been truncated, see
           #   {Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic} for more
           #   details.
@@ -74,6 +84,8 @@ module Courier
           #
           #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>, nil] The channels to deliver this topic on when has_custom_routing is true. One or mo
           #
+          #   @param digest_schedule_id [String, nil] Put this recipient on one of the topic's digest schedules. Send `null` to clear
+          #
           #   @param has_custom_routing [Boolean, nil] Set to true to route this topic to the channels in custom_routing instead of the
         end
       end

data/lib/courier/models/users/topic_preference.rb

@@ -41,6 +41,20 @@ module Courier
                  -> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
                  nil?: true
 
+        # @!attribute digest_schedule_id
+        #   The digest schedule this recipient is on for the topic. Omitted rather than null
+        #   when they have not chosen one, in which case the topic's default schedule
+        #   applies. Ids come from the topic's digest configuration, returned on any read of
+        #   the topic.
+        #
+        #   Also omitted when the schedule they chose has since been deleted or disabled:
+        #   the recipient is on the topic's default from that point on, which is how a send
+        #   already resolves it, so the field reports what would actually be used rather
+        #   than a dead id.
+        #
+        #   @return [String, nil]
+        optional :digest_schedule_id, String
+
         # @!attribute has_custom_routing
         #   Whether the user has chosen specific delivery channels for this topic (listed in
         #   custom_routing) rather than the topic's default routing.
@@ -64,7 +78,7 @@ module Courier
         #   @return [String, nil]
         optional :section_name, String
 
-        # @!method initialize(default_status:, status:, topic_id:, topic_name:, custom_routing: nil, has_custom_routing: nil, section_id: nil, section_name: nil)
+        # @!method initialize(default_status:, status:, topic_id:, topic_name:, custom_routing: nil, digest_schedule_id: nil, has_custom_routing: nil, section_id: nil, section_name: nil)
         #   Some parameter documentations has been truncated, see
         #   {Courier::Models::Users::TopicPreference} for more details.
         #
@@ -78,6 +92,8 @@ module Courier
         #
         #   @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>, nil] The channels the user has chosen to receive this topic on, present only when has
         #
+        #   @param digest_schedule_id [String] The digest schedule this recipient is on for the topic. Omitted rather than null
+        #
         #   @param has_custom_routing [Boolean, nil] Whether the user has chosen specific delivery channels for this topic (listed in
         #
         #   @param section_id [String] The unique identifier of the section this topic belongs to. Always present when

data/lib/courier/models/workspace_preference_topic_create_request.rb

@@ -32,6 +32,23 @@ module Courier
       #   @return [String, nil]
       optional :description, String, nil?: true
 
+      # @!attribute digest
+      #   A topic's digest, as supplied when the topic itself is created: the template
+      #   that renders it, the cadences it delivers on, and how collected events are
+      #   retained.
+      #
+      #   Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
+      #   is required — a topic being created has no stored schedules for an absent key to
+      #   leave alone.
+      #
+      #   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::WorkspacePreferenceTopicCreateRequest::Digest, nil]
+      optional :digest, -> { Courier::WorkspacePreferenceTopicCreateRequest::Digest }, nil?: true
+
       # @!attribute include_unsubscribe_header
       #   Whether to include a list-unsubscribe header on emails for this topic.
       #
@@ -52,7 +69,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 +83,8 @@ module Courier
       #
       #   @param description [String, nil] Optional description shown under the topic on the hosted preferences page.
       #
+      #   @param digest [Courier::Models::WorkspacePreferenceTopicCreateRequest::Digest, nil] A topic's digest, as supplied when the topic itself is created: the template tha
+      #
       #   @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.
@@ -96,6 +115,83 @@ module Courier
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # @see Courier::Models::WorkspacePreferenceTopicCreateRequest#digest
+      class Digest < Courier::Internal::Type::BaseModel
+        # @!attribute schedules
+        #   The cadences this digest delivers on.
+        #
+        #   The array replaces the stored schedules wholesale, so a schedule you leave out
+        #   of it is deleted along with its delivery rule. Omit the key entirely to leave
+        #   the stored schedules untouched — useful for changing `template_id` or
+        #   `categories` without restating every schedule.
+        #
+        #   A digest must end up with at least one schedule, because one with none collects
+        #   events into an instance that can never fire. So sending `[]` is always a `400`,
+        #   and so is omitting the key on a topic that has no schedules stored yet.
+        #
+        #   On **create** the key is required outright: a topic being created has nothing
+        #   stored to leave alone, and the topic row is written before its digest, so
+        #   rejecting it any later would leave the topic behind and let a retry duplicate
+        #   it.
+        #
+        #   @return [Array<Courier::Models::TopicDigestScheduleRequest>]
+        required :schedules, -> { Courier::Internal::Type::ArrayOf[Courier::TopicDigestScheduleRequest] }
+
+        # @!attribute template_id
+        #   The notification template that renders the digest. A digest with no template
+        #   collects nothing, so this is required.
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!attribute audience_id
+        #   Optional audience the digest is scoped to.
+        #
+        #   @return [String, nil]
+        optional :audience_id, String
+
+        # @!attribute categories
+        #   Retention rules per category key. Defaults to a single `digest` category
+        #   retaining `FIRST`.
+        #
+        #   @return [Array<Courier::Models::TopicDigestCategory>, nil]
+        optional :categories, -> { Courier::Internal::Type::ArrayOf[Courier::TopicDigestCategory] }
+
+        # @!attribute trigger_empty
+        #   Whether to deliver the digest even when nothing was collected.
+        #
+        #   @return [Boolean, nil]
+        optional :trigger_empty, Courier::Internal::Type::Boolean
+
+        # @!method initialize(schedules:, template_id:, audience_id: nil, categories: nil, trigger_empty: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::WorkspacePreferenceTopicCreateRequest::Digest} for more
+        #   details.
+        #
+        #   A topic's digest, as supplied when the topic itself is created: the template
+        #   that renders it, the cadences it delivers on, and how collected events are
+        #   retained.
+        #
+        #   Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
+        #   is required — a topic being created has no stored schedules for an absent key to
+        #   leave alone.
+        #
+        #   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.
+        #
+        #   @param schedules [Array<Courier::Models::TopicDigestScheduleRequest>] The cadences this digest delivers on.
+        #
+        #   @param template_id [String] The notification template that renders the digest. A digest with no template col
+        #
+        #   @param audience_id [String] Optional audience the digest is scoped to.
+        #
+        #   @param categories [Array<Courier::Models::TopicDigestCategory>] Retention rules per category key. Defaults to a single `digest` category retaini
+        #
+        #   @param trigger_empty [Boolean] Whether to deliver the digest even when nothing was collected.
+      end
     end
   end
 end

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/journeys.rb

@@ -21,12 +21,14 @@ module Courier
       # Creates a journey from a set of nodes, in draft state unless you pass a
       # published state. Send nodes cannot be included until their templates exist.
       #
-      # @overload create(name:, nodes:, enabled: nil, state: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
+      # @overload create(name:, nodes:, cancelation_token: nil, enabled: nil, state: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #
       # @param name [String] Body param
       #
       # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>] Body param
       #
+      # @param cancelation_token [String] Body param: Cancelation token stored on the journey definition. It tags every ru
+      #
       # @param enabled [Boolean] Body param
       #
       # @param state [Symbol, Courier::Models::JourneyState] Body param: Lifecycle state of a journey.
@@ -259,10 +261,13 @@ module Courier
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::JourneyReplaceParams} for more details.
+      #
       # Replaces a journey's working draft, leaving the published version live until you
       # publish. Reach for this when editing a journey already running.
       #
-      # @overload replace(template_id, name:, nodes:, enabled: nil, state: nil, request_options: {})
+      # @overload replace(template_id, name:, nodes:, cancelation_token: nil, enabled: nil, state: nil, request_options: {})
       #
       # @param template_id [String] Journey id
       #
@@ -270,6 +275,8 @@ module Courier
       #
       # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
+      # @param cancelation_token [String] Cancelation token stored on the journey definition. It tags every run the journe
+      #
       # @param enabled [Boolean]
       #
       # @param state [Symbol, Courier::Models::JourneyState] Lifecycle state of a journey.

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::WorkspacePreferenceTopicCreateRequest::Digest, nil] Body param: A topic's digest, as supplied when the topic itself is created: the
+        #
         # @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.7.0"
 end