trycourier 6.5.0 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aec72cc2e6e742c57ffd2f2c5f8fde487e6597a34d0351cf4613abc3f369ab07
-  data.tar.gz: 037cfdab670141377df8fa5a5443c24b8d66e98b6ccc56b68c5db6176139bbb9
+  metadata.gz: c665c6475e9af26f67197651f5599bac614c384d86086dd974ed410005ab407d
+  data.tar.gz: 4e037944cf9a6cd6346aa647a5f097e3cd04a5be4676b1b0bc392bed497be990
 SHA512:
-  metadata.gz: f9355b12ee2ed402c0f2e13d1f20b23cf5e3ee63e23e627894f66f517cf0522f866626b28485d3a5c98cfd021869f3fea6aeb3112a3e2208d65abc2733b0b10a
-  data.tar.gz: 45f4b13f45dbb29cdc1ed14845e7ff243fa90f215f45a6c4fcc324a3c725ed750d907da8571e4eb2ccf7b894aa7b9884bba71892454bc0f36f9d0f8036668695
+  metadata.gz: 244553b3412e7041264a0ceb8e355e89fcf67b8f00098cfab876e00408c39089e4e6bf0031693e7ab49749e43e74ac4fbf6b7ca16f8e91c00f63bc061157725e
+  data.tar.gz: 60ce9fc7ae0c32289b97208cad86e4c97c0ca4b44f6d7f0d10967e72ea4922bc19104a95a46c6c7ee146372a57ba9a255b773a26f9d2bad505f3e905c84d66e9

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [6.7.0](https://github.com/trycourier/courier-ruby/compare/v6.6.0...v6.7.0) (2026-09-22)
+
+
+### Features
+
+* **api:** add cancelation_token to journey create, replace, and get ([#158](https://github.com/trycourier/courier-ruby/issues/158)) ([ec47880](https://github.com/trycourier/courier-ruby/commit/ec47880a79aaefde00dedcbdc84527ff234a99f2))
+
+
+### Documentation
+
+* **api:** correct the digest schedule contract, and make `schedules` optional ([#156](https://github.com/trycourier/courier-ruby/issues/156)) ([8578d77](https://github.com/trycourier/courier-ruby/commit/8578d77848275105865c1b29b799f2cc6621987e))
+
+## [6.6.0](https://github.com/trycourier/courier-ruby/compare/v6.5.0...v6.6.0) (2026-09-15)
+
+
+### Features
+
+* **api:** digest configuration, per-recipient schedules, and release ([#154](https://github.com/trycourier/courier-ruby/issues/154)) ([abaf9f2](https://github.com/trycourier/courier-ruby/commit/abaf9f215ae6c9e6aaeb36e7313c9300da23b39b))
+
+
+### Documentation
+
+* **api:** group the topic digest endpoints under Digests, and match the docs voice ([#155](https://github.com/trycourier/courier-ruby/issues/155)) ([cb00e91](https://github.com/trycourier/courier-ruby/commit/cb00e91773b41f312db5c627ee500080da48b051))
+* **api:** stop teaching an aud_ prefix that Courier does not issue ([#152](https://github.com/trycourier/courier-ruby/issues/152)) ([1bd0f05](https://github.com/trycourier/courier-ruby/commit/1bd0f05a5e3db1e593c04046a7b20e9bdd1f64bf))
+
 ## [6.5.0](https://github.com/trycourier/courier-ruby/compare/v6.4.4...v6.5.0) (2026-09-04)
 
 

data/README.md

@@ -9,7 +9,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 6.5.0"
+gem "trycourier", "~> 6.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/courier/models/create_journey_request.rb

@@ -13,6 +13,16 @@ module Courier
       #   @return [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>]
       required :nodes, -> { Courier::Internal::Type::ArrayOf[union: Courier::JourneyNode] }
 
+      # @!attribute cancelation_token
+      #   Cancelation token stored on the journey definition. It tags every run the
+      #   journey creates so that `POST /journeys/cancel` can later cancel those runs by
+      #   token. Accepts a templated string such as `order-{{data.order_id}}`, which is
+      #   resolved per run when the journey is invoked. On a replace, omitting this field
+      #   preserves any existing token and sending a value replaces it.
+      #
+      #   @return [String, nil]
+      optional :cancelation_token, String
+
       # @!attribute enabled
       #
       #   @return [Boolean, nil]
@@ -24,13 +34,18 @@ module Courier
       #   @return [Symbol, Courier::Models::JourneyState, nil]
       optional :state, enum: -> { Courier::JourneyState }
 
-      # @!method initialize(name:, nodes:, enabled: nil, state: nil)
+      # @!method initialize(name:, nodes:, cancelation_token: nil, enabled: nil, state: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::CreateJourneyRequest} for more details.
+      #
       #   Request body for creating a journey.
       #
       #   @param name [String]
       #
       #   @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/models/digest_day_of_week.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # A day of the week. Accepted case-insensitively, returned lowercase.
+    module DigestDayOfWeek
+      extend Courier::Internal::Type::Enum
+
+      SUNDAY = :sunday
+      MONDAY = :monday
+      TUESDAY = :tuesday
+      WEDNESDAY = :wednesday
+      THURSDAY = :thursday
+      FRIDAY = :friday
+      SATURDAY = :saturday
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/courier/models/digest_frequency.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+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
+
+      INSTANT = :instant
+      DAILY = :daily
+      WEEKDAYS = :weekdays
+      WEEKLY = :weekly
+      CUSTOM_DAYS = :custom_days
+      MONTHLY = :monthly
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/courier/models/journey_conditions_field.rb

@@ -12,10 +12,20 @@ module Courier
       # - Binary form (3 elements): `[path, operator, value]` where `operator`
       #   is one of `is equal`, `is not equal`, `contains`, `does not contain`,
       #   `starts with`, `ends with`, `greater than`, `greater than or equal`,
-      #   `less than`, `less than or equal`.
+      #   `less than`, `less than or equal`, `was`, `was not`.
       #
       #   Example: `["user.tier", "is equal", "gold"]`.
       #
+      #   `was` / `was not` compare a `send_status.<nodeId>` path (referencing
+      #   an earlier send node's node id) against one of `SENT`, `DELIVERED`,
+      #   `OPENED`, `CLICKED`, `UNDELIVERABLE`. The first four are cumulative
+      #   and ordered `SENT < DELIVERED < OPENED < CLICKED`, so `was DELIVERED`
+      #   is true once the message has reached DELIVERED, OPENED, or CLICKED.
+      #   `UNDELIVERABLE` is an exact match only and is never part of that
+      #   ordering, in either direction.
+      #   Example:
+      #   `["send_status.P9Z3VCRJG647M7QNJZR3548HW741", "was", "DELIVERED"]`.
+      #
       # - Unary form (2 elements): `[path, operator]` where `operator` is
       #   one of `exists`, `does not exist`.
       #

data/lib/courier/models/journey_node.rb

@@ -47,7 +47,11 @@ module Courier
       # Collect events arriving at the node into a single batch and fire one downstream step with the aggregated payload. The first event into a batch owns the run; later contributing events terminate at the batch step. The batch releases when any of `max_items` is reached, a quiet window of `wait_period` elapses, or the `max_wait_period` ceiling hits.
       variant -> { Courier::JourneyNode::JourneyBatchNode }
 
-      # 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.
+      # 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, 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.
       variant -> { Courier::JourneyNode::JourneyAddToDigestNode }
 
       # Terminate the journey run.
@@ -240,7 +244,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.
         #
         #   @param subscription_topic_id [String] The subscription topic that owns the digest the event is added to.
         #

data/lib/courier/models/journey_response.rb

@@ -9,6 +9,14 @@ module Courier
       #   @return [String]
       required :id, String
 
+      # @!attribute cancelation_token
+      #   The journey cancelation token, or null when none is set. A token authored in the
+      #   dashboard is returned in its raw templated form, such as
+      #   `order-{{data.order_id}}`, so it can be read back and asserted.
+      #
+      #   @return [String, nil]
+      required :cancelation_token, String, nil?: true
+
       # @!attribute created
       #
       #   @return [Integer, nil]
@@ -55,11 +63,16 @@ module Courier
       #   @return [String, nil]
       required :updater, String, nil?: true
 
-      # @!method initialize(id:, created:, creator:, enabled:, name:, nodes:, published:, state:, updated:, updater:)
+      # @!method initialize(id:, cancelation_token:, created:, creator:, enabled:, name:, nodes:, published:, state:, updated:, updater:)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyResponse} for more details.
+      #
       #   A journey, with its current draft or published nodes and metadata.
       #
       #   @param id [String]
       #
+      #   @param cancelation_token [String, nil] The journey cancelation token, or null when none is set. A token authored in the
+      #
       #   @param created [Integer, nil]
       #
       #   @param creator [String, nil]

data/lib/courier/models/topic_digest_category.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class TopicDigestCategory < Courier::Internal::Type::BaseModel
+      # @!attribute category_key
+      #   The key that identifies the category within the digest.
+      #
+      #   @return [String]
+      required :category_key, String
+
+      # @!attribute limit
+      #   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.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute retain
+      #   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.
+      #
+      #   @return [Symbol, Courier::Models::TopicDigestCategory::Retain, nil]
+      optional :retain, enum: -> { Courier::TopicDigestCategory::Retain }
+
+      # @!attribute sort_key
+      #   The data key used to rank events. Required when `retain` is `HIGHEST` or
+      #   `LOWEST`.
+      #
+      #   @return [String, nil]
+      optional :sort_key, String
+
+      # @!method initialize(category_key:, limit: nil, retain: nil, sort_key: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::TopicDigestCategory} for more details.
+      #
+      #   How events collected under a category key are retained when a digest holds more
+      #   than it will render.
+      #
+      #   @param category_key [String] The key that identifies the category within the digest.
+      #
+      #   @param limit [Integer] How many collected events are carried into the rendered digest. Defaults to 10.
+      #
+      #   @param retain [Symbol, Courier::Models::TopicDigestCategory::Retain] Which collected events survive the `limit`. `FIRST` and `LOWEST` keep the earlie
+      #
+      #   @param sort_key [String] The data key used to rank events. Required when `retain` is `HIGHEST` or `LOWEST
+
+      # 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.
+      #
+      # @see Courier::Models::TopicDigestCategory#retain
+      module Retain
+        extend Courier::Internal::Type::Enum
+
+        FIRST = :FIRST
+        LAST = :LAST
+        HIGHEST = :HIGHEST
+        LOWEST = :LOWEST
+        NONE = :NONE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/topic_digest_release_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class TopicDigestReleaseRequest < Courier::Internal::Type::BaseModel
+      # @!attribute user_id
+      #   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.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute tenant_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.
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String
+
+      # @!method initialize(user_id:, tenant_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::TopicDigestReleaseRequest} for more details.
+      #
+      #   Which recipient's held digest to release.
+      #
+      #   @param user_id [String] The recipient whose digest to release. Required: there is no "release everyone o
+      #
+      #   @param tenant_id [String] The recipient's tenant, when they were sent to as part of one -- the same value
+    end
+  end
+end

data/lib/courier/models/topic_digest_request.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class TopicDigestRequest < Courier::Internal::Type::BaseModel
+      # @!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 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>, nil]
+      optional :schedules, -> { Courier::Internal::Type::ArrayOf[Courier::TopicDigestScheduleRequest] }
+
+      # @!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(template_id:, audience_id: nil, categories: nil, schedules: nil, trigger_empty: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::TopicDigestRequest} for more details.
+      #
+      #   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.
+      #
+      #   @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 schedules [Array<Courier::Models::TopicDigestScheduleRequest>] The cadences this digest delivers on.
+      #
+      #   @param trigger_empty [Boolean] Whether to deliver the digest even when nothing was collected.
+    end
+  end
+end

data/lib/courier/models/topic_digest_response.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class TopicDigestResponse < Courier::Internal::Type::BaseModel
+      # @!attribute categories
+      #   Retention rules per category key.
+      #
+      #   @return [Array<Courier::Models::TopicDigestCategory>]
+      required :categories, -> { Courier::Internal::Type::ArrayOf[Courier::TopicDigestCategory] }
+
+      # @!attribute schedules
+      #   The digest's delivery cadences, each with its server-assigned `schedule_id`.
+      #
+      #   @return [Array<Courier::Models::TopicDigestScheduleResponse>]
+      required :schedules, -> { Courier::Internal::Type::ArrayOf[Courier::TopicDigestScheduleResponse] }
+
+      # @!attribute template_id
+      #   The notification template that renders the digest.
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute audience_id
+      #   The audience the digest is scoped to, when set.
+      #
+      #   @return [String, nil]
+      optional :audience_id, String
+
+      # @!attribute created
+      #   ISO-8601 timestamp of when the digest was configured.
+      #
+      #   @return [String, nil]
+      optional :created, String
+
+      # @!attribute trigger_empty
+      #   Whether the digest is delivered even when nothing was collected.
+      #
+      #   @return [Boolean, nil]
+      optional :trigger_empty, Courier::Internal::Type::Boolean
+
+      # @!attribute updated
+      #   ISO-8601 timestamp of the last update.
+      #
+      #   @return [String, nil]
+      optional :updated, String
+
+      # @!method initialize(categories:, schedules:, template_id:, audience_id: nil, created: nil, trigger_empty: nil, updated: nil)
+      #   A topic's digest configuration.
+      #
+      #   @param categories [Array<Courier::Models::TopicDigestCategory>] Retention rules per category key.
+      #
+      #   @param schedules [Array<Courier::Models::TopicDigestScheduleResponse>] The digest's delivery cadences, each with its server-assigned `schedule_id`.
+      #
+      #   @param template_id [String] The notification template that renders the digest.
+      #
+      #   @param audience_id [String] The audience the digest is scoped to, when set.
+      #
+      #   @param created [String] ISO-8601 timestamp of when the digest was configured.
+      #
+      #   @param trigger_empty [Boolean] Whether the digest is delivered even when nothing was collected.
+      #
+      #   @param updated [String] ISO-8601 timestamp of the last update.
+    end
+  end
+end

data/lib/courier/models/topic_digest_schedule_request.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class TopicDigestScheduleRequest < Courier::Internal::Type::BaseModel
+      # @!attribute frequency
+      #   How often a digest is delivered. `instant` delivers immediately without
+      #   batching, and is the one value that takes no `time`.
+      #
+      #   @return [Symbol, Courier::Models::DigestFrequency]
+      required :frequency, enum: -> { Courier::DigestFrequency }
+
+      # @!attribute day_of_month
+      #   Required when `frequency` is `monthly`.
+      #
+      #   @return [Integer, nil]
+      optional :day_of_month, Integer
+
+      # @!attribute day_of_week
+      #   Required when `frequency` is `weekly`.
+      #
+      #   @return [Symbol, Courier::Models::DigestDayOfWeek, nil]
+      optional :day_of_week, enum: -> { Courier::DigestDayOfWeek }
+
+      # @!attribute days_of_week
+      #   Required when `frequency` is `custom_days`.
+      #
+      #   @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 is_default
+      #   The schedule recipients are placed on when they have not chosen one. Set this
+      #   explicitly rather than relying on array position.
+      #
+      #   @return [Boolean, nil]
+      optional :is_default, Courier::Internal::Type::Boolean
+
+      # @!attribute schedule_id
+      #   Identifier of an existing schedule to update. Omit when creating a new one.
+      #
+      #   @return [String, nil]
+      optional :schedule_id, String
+
+      # @!attribute time
+      #   24-hour local delivery time, `HH:MM`. Required for every frequency except
+      #   `instant`.
+      #
+      #   @return [String, nil]
+      optional :time, String
+
+      # @!attribute timezone
+      #   IANA timezone the `time` and day fields are expressed in, e.g.
+      #   `America/New_York`. Absent means UTC. Delivery follows the same local wall-clock
+      #   across daylight-saving changes.
+      #
+      #   @return [String, nil]
+      optional :timezone, String
+
+      # @!method initialize(frequency:, day_of_month: nil, day_of_week: nil, days_of_week: nil, disabled: nil, is_default: nil, schedule_id: nil, time: nil, timezone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::TopicDigestScheduleRequest} for more details.
+      #
+      #   One delivery cadence for a topic's digest. Supply `schedule_id` to update an
+      #   existing schedule in place; omit it and one is assigned and returned. The
+      #   `schedules` array is a full replacement, so a stored schedule absent from it is
+      #   deleted along with its delivery rule.
+      #
+      #   Updating by `schedule_id` replaces that schedule rather than merging into it:
+      #   any field you leave out is cleared. Two of those change delivery silently — an
+      #   omitted `timezone` reverts the schedule to UTC, and an omitted `is_default` can
+      #   leave the topic with no default schedule, which is what recipients who have not
+      #   chosen one fall back to. Restate every field you want to keep.
+      #
+      #   @param frequency [Symbol, Courier::Models::DigestFrequency] How often a digest is delivered. `instant` delivers immediately without batching
+      #
+      #   @param day_of_month [Integer] Required when `frequency` is `monthly`.
+      #
+      #   @param day_of_week [Symbol, Courier::Models::DigestDayOfWeek] Required when `frequency` is `weekly`.
+      #
+      #   @param days_of_week [Array<Symbol, Courier::Models::DigestDayOfWeek>] Required when `frequency` is `custom_days`.
+      #
+      #   @param disabled [Boolean] Whether the schedule is disabled.
+      #
+      #   @param is_default [Boolean] The schedule recipients are placed on when they have not chosen one. Set this ex
+      #
+      #   @param schedule_id [String] Identifier of an existing schedule to update. Omit when creating a new one.
+      #
+      #   @param time [String] 24-hour local delivery time, `HH:MM`. Required for every frequency except `insta
+      #
+      #   @param timezone [String] IANA timezone the `time` and day fields are expressed in, e.g. `America/New_York
+    end
+  end
+end