@trycourier/courier 9.5.0 → 9.7.0

package/resources/workspace-preferences/workspace-preferences.d.mts

@@ -1,7 +1,9 @@
 import { APIResource } from "../../core/resource.mjs";
+import * as WorkspacePreferencesAPI from "./workspace-preferences.mjs";
 import * as Shared from "../shared.mjs";
+import * as DigestsAPI from "../digests/digests.mjs";
 import * as TopicsAPI from "./topics.mjs";
-import { TopicArchiveParams, TopicCreateParams, TopicReplaceParams, TopicRetrieveParams, Topics } from "./topics.mjs";
+import { TopicArchiveParams, TopicCreateParams, TopicDeleteDigestParams, TopicReleaseDigestParams, TopicReplaceParams, TopicRetrieveParams, Topics } from "./topics.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
@@ -130,6 +132,189 @@ export interface PublishPreferencesResponse {
      */
     published_by?: string | null;
 }
+/**
+ * How events collected under a category key are retained when a digest holds more
+ * than it will render.
+ */
+export interface TopicDigestCategory {
+    /**
+     * The key that identifies the category within the digest.
+     */
+    category_key: string;
+    /**
+     * 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?: number;
+    /**
+     * 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?: 'FIRST' | 'LAST' | 'HIGHEST' | 'LOWEST' | 'NONE';
+    /**
+     * The data key used to rank events. Required when `retain` is `HIGHEST` or
+     * `LOWEST`.
+     */
+    sort_key?: string;
+}
+/**
+ * Which recipient's held digest to release.
+ */
+export interface TopicDigestReleaseRequest {
+    /**
+     * 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: string;
+    /**
+     * The recipient's tenant, when they were sent to as part of one -- the same value
+     * returned as `tenant_id` on a digest instance and sent as
+     * `message.context.tenant_id`. It is part of the held digest's key, so a tenanted
+     * recipient cannot be found without it. Omit for an ordinary recipient.
+     */
+    tenant_id?: string;
+}
+/**
+ * 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.
+ */
+export interface TopicDigestRequest {
+    /**
+     * The notification template that renders the digest. A digest with no template
+     * collects nothing, so this is required.
+     */
+    template_id: string;
+    /**
+     * Optional audience the digest is scoped to.
+     */
+    audience_id?: string;
+    /**
+     * Retention rules per category key. Defaults to a single `digest` category
+     * retaining `FIRST`.
+     */
+    categories?: Array<TopicDigestCategory>;
+    /**
+     * 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.
+     */
+    schedules?: Array<TopicDigestScheduleRequest>;
+    /**
+     * Whether to deliver the digest even when nothing was collected.
+     */
+    trigger_empty?: boolean;
+}
+/**
+ * A topic's digest configuration.
+ */
+export interface TopicDigestResponse {
+    /**
+     * Retention rules per category key.
+     */
+    categories: Array<TopicDigestCategory>;
+    /**
+     * The digest's delivery cadences, each with its server-assigned `schedule_id`.
+     */
+    schedules: Array<DigestsAPI.TopicDigestScheduleResponse>;
+    /**
+     * The notification template that renders the digest.
+     */
+    template_id: string;
+    /**
+     * The audience the digest is scoped to, when set.
+     */
+    audience_id?: string;
+    /**
+     * ISO-8601 timestamp of when the digest was configured.
+     */
+    created?: string;
+    /**
+     * Whether the digest is delivered even when nothing was collected.
+     */
+    trigger_empty?: boolean;
+    /**
+     * ISO-8601 timestamp of the last update.
+     */
+    updated?: string;
+}
+/**
+ * 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.
+ */
+export interface TopicDigestScheduleRequest {
+    /**
+     * How often a digest is delivered. `instant` delivers immediately without
+     * batching, and is the one value that takes no `time`.
+     */
+    frequency: DigestsAPI.DigestFrequency;
+    /**
+     * Required when `frequency` is `monthly`.
+     */
+    day_of_month?: number;
+    /**
+     * Required when `frequency` is `weekly`.
+     */
+    day_of_week?: DigestsAPI.DigestDayOfWeek;
+    /**
+     * Required when `frequency` is `custom_days`.
+     */
+    days_of_week?: Array<DigestsAPI.DigestDayOfWeek>;
+    /**
+     * Whether the schedule is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * The schedule recipients are placed on when they have not chosen one. Set this
+     * explicitly rather than relying on array position.
+     */
+    is_default?: boolean;
+    /**
+     * Identifier of an existing schedule to update. Omit when creating a new one.
+     */
+    schedule_id?: string;
+    /**
+     * 24-hour local delivery time, `HH:MM`. Required for every frequency except
+     * `instant`.
+     */
+    time?: string;
+    /**
+     * 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.
+     */
+    timezone?: string;
+}
 /**
  * Request body for creating a workspace preference.
  */
@@ -246,6 +431,21 @@ export interface WorkspacePreferenceTopicCreateRequest {
      * Optional description shown under the topic on the hosted preferences page.
      */
     description?: string | null;
+    /**
+     * 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.
+     */
+    digest?: WorkspacePreferenceTopicCreateRequest.Digest | null;
     /**
      * Whether to include a list-unsubscribe header on emails for this topic.
      */
@@ -261,6 +461,60 @@ export interface WorkspacePreferenceTopicCreateRequest {
         [key: string]: unknown;
     } | null;
 }
+export declare namespace WorkspacePreferenceTopicCreateRequest {
+    /**
+     * 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.
+     */
+    interface Digest {
+        /**
+         * 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.
+         */
+        schedules: Array<WorkspacePreferencesAPI.TopicDigestScheduleRequest>;
+        /**
+         * The notification template that renders the digest. A digest with no template
+         * collects nothing, so this is required.
+         */
+        template_id: string;
+        /**
+         * Optional audience the digest is scoped to.
+         */
+        audience_id?: string;
+        /**
+         * Retention rules per category key. Defaults to a single `digest` category
+         * retaining `FIRST`.
+         */
+        categories?: Array<WorkspacePreferencesAPI.TopicDigestCategory>;
+        /**
+         * Whether to deliver the digest even when nothing was collected.
+         */
+        trigger_empty?: boolean;
+    }
+}
 /**
  * A subscription preference topic in your workspace.
  */
@@ -311,6 +565,10 @@ export interface WorkspacePreferenceTopicGetResponse {
      * Optional description shown under the topic on the hosted preferences page.
      */
     description?: string | null;
+    /**
+     * A topic's digest configuration.
+     */
+    digest?: TopicDigestResponse | null;
     /**
      * Id of the last updater.
      */
@@ -344,6 +602,16 @@ export interface WorkspacePreferenceTopicReplaceRequest {
      * to clear.
      */
     description?: string | null;
+    /**
+     * 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?: TopicDigestRequest | null;
     /**
      * Whether to include a list-unsubscribe header on emails for this topic.
      */
@@ -447,7 +715,7 @@ export interface WorkspacePreferenceReplaceParams {
     routing_options?: Array<Shared.ChannelClassification> | null;
 }
 export declare namespace WorkspacePreferences {
-    export { type PublishPreferencesRequest as PublishPreferencesRequest, type PublishPreferencesResponse as PublishPreferencesResponse, type WorkspacePreferenceCreateRequest as WorkspacePreferenceCreateRequest, type WorkspacePreferenceGetResponse as WorkspacePreferenceGetResponse, type WorkspacePreferenceListResponse as WorkspacePreferenceListResponse, type WorkspacePreferenceReplaceRequest as WorkspacePreferenceReplaceRequest, type WorkspacePreferenceTopicCreateRequest as WorkspacePreferenceTopicCreateRequest, type WorkspacePreferenceTopicGetResponse as WorkspacePreferenceTopicGetResponse, type WorkspacePreferenceTopicListResponse as WorkspacePreferenceTopicListResponse, type WorkspacePreferenceTopicReplaceRequest as WorkspacePreferenceTopicReplaceRequest, type WorkspacePreferenceCreateParams as WorkspacePreferenceCreateParams, type WorkspacePreferencePublishParams as WorkspacePreferencePublishParams, type WorkspacePreferenceReplaceParams as WorkspacePreferenceReplaceParams, };
-    export { Topics as Topics, type TopicCreateParams as TopicCreateParams, type TopicRetrieveParams as TopicRetrieveParams, type TopicArchiveParams as TopicArchiveParams, type TopicReplaceParams as TopicReplaceParams, };
+    export { type PublishPreferencesRequest as PublishPreferencesRequest, type PublishPreferencesResponse as PublishPreferencesResponse, type TopicDigestCategory as TopicDigestCategory, type TopicDigestReleaseRequest as TopicDigestReleaseRequest, type TopicDigestRequest as TopicDigestRequest, type TopicDigestResponse as TopicDigestResponse, type TopicDigestScheduleRequest as TopicDigestScheduleRequest, type WorkspacePreferenceCreateRequest as WorkspacePreferenceCreateRequest, type WorkspacePreferenceGetResponse as WorkspacePreferenceGetResponse, type WorkspacePreferenceListResponse as WorkspacePreferenceListResponse, type WorkspacePreferenceReplaceRequest as WorkspacePreferenceReplaceRequest, type WorkspacePreferenceTopicCreateRequest as WorkspacePreferenceTopicCreateRequest, type WorkspacePreferenceTopicGetResponse as WorkspacePreferenceTopicGetResponse, type WorkspacePreferenceTopicListResponse as WorkspacePreferenceTopicListResponse, type WorkspacePreferenceTopicReplaceRequest as WorkspacePreferenceTopicReplaceRequest, type WorkspacePreferenceCreateParams as WorkspacePreferenceCreateParams, type WorkspacePreferencePublishParams as WorkspacePreferencePublishParams, type WorkspacePreferenceReplaceParams as WorkspacePreferenceReplaceParams, };
+    export { Topics as Topics, type TopicCreateParams as TopicCreateParams, type TopicRetrieveParams as TopicRetrieveParams, type TopicArchiveParams as TopicArchiveParams, type TopicDeleteDigestParams as TopicDeleteDigestParams, type TopicReleaseDigestParams as TopicReleaseDigestParams, type TopicReplaceParams as TopicReplaceParams, };
 }
 //# sourceMappingURL=workspace-preferences.d.mts.map

package/resources/workspace-preferences/workspace-preferences.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"workspace-preferences.d.mts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,qBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAC;IAE7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,OAAO,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"workspace-preferences.d.mts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,uBAAuB,oCAAgC;AACnE,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,UAAU,+BAA2B;AACjD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,qBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE1D;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAE9C;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEvC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;IAEzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,SAAS,EAAE,UAAU,CAAC,eAAe,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,qCAAqC,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;;;;;;;;;;;;OAaG;IACH,UAAiB,MAAM;QACrB;;;;;;;;;;;;;;;;WAgBG;QACH,SAAS,EAAE,KAAK,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;QAErE;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;QAEhE;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAC;IAE7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,OAAO,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/workspace-preferences/workspace-preferences.d.ts

@@ -1,7 +1,9 @@
 import { APIResource } from "../../core/resource.js";
+import * as WorkspacePreferencesAPI from "./workspace-preferences.js";
 import * as Shared from "../shared.js";
+import * as DigestsAPI from "../digests/digests.js";
 import * as TopicsAPI from "./topics.js";
-import { TopicArchiveParams, TopicCreateParams, TopicReplaceParams, TopicRetrieveParams, Topics } from "./topics.js";
+import { TopicArchiveParams, TopicCreateParams, TopicDeleteDigestParams, TopicReleaseDigestParams, TopicReplaceParams, TopicRetrieveParams, Topics } from "./topics.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 /**
@@ -130,6 +132,189 @@ export interface PublishPreferencesResponse {
      */
     published_by?: string | null;
 }
+/**
+ * How events collected under a category key are retained when a digest holds more
+ * than it will render.
+ */
+export interface TopicDigestCategory {
+    /**
+     * The key that identifies the category within the digest.
+     */
+    category_key: string;
+    /**
+     * 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?: number;
+    /**
+     * 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?: 'FIRST' | 'LAST' | 'HIGHEST' | 'LOWEST' | 'NONE';
+    /**
+     * The data key used to rank events. Required when `retain` is `HIGHEST` or
+     * `LOWEST`.
+     */
+    sort_key?: string;
+}
+/**
+ * Which recipient's held digest to release.
+ */
+export interface TopicDigestReleaseRequest {
+    /**
+     * 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: string;
+    /**
+     * The recipient's tenant, when they were sent to as part of one -- the same value
+     * returned as `tenant_id` on a digest instance and sent as
+     * `message.context.tenant_id`. It is part of the held digest's key, so a tenanted
+     * recipient cannot be found without it. Omit for an ordinary recipient.
+     */
+    tenant_id?: string;
+}
+/**
+ * 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.
+ */
+export interface TopicDigestRequest {
+    /**
+     * The notification template that renders the digest. A digest with no template
+     * collects nothing, so this is required.
+     */
+    template_id: string;
+    /**
+     * Optional audience the digest is scoped to.
+     */
+    audience_id?: string;
+    /**
+     * Retention rules per category key. Defaults to a single `digest` category
+     * retaining `FIRST`.
+     */
+    categories?: Array<TopicDigestCategory>;
+    /**
+     * 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.
+     */
+    schedules?: Array<TopicDigestScheduleRequest>;
+    /**
+     * Whether to deliver the digest even when nothing was collected.
+     */
+    trigger_empty?: boolean;
+}
+/**
+ * A topic's digest configuration.
+ */
+export interface TopicDigestResponse {
+    /**
+     * Retention rules per category key.
+     */
+    categories: Array<TopicDigestCategory>;
+    /**
+     * The digest's delivery cadences, each with its server-assigned `schedule_id`.
+     */
+    schedules: Array<DigestsAPI.TopicDigestScheduleResponse>;
+    /**
+     * The notification template that renders the digest.
+     */
+    template_id: string;
+    /**
+     * The audience the digest is scoped to, when set.
+     */
+    audience_id?: string;
+    /**
+     * ISO-8601 timestamp of when the digest was configured.
+     */
+    created?: string;
+    /**
+     * Whether the digest is delivered even when nothing was collected.
+     */
+    trigger_empty?: boolean;
+    /**
+     * ISO-8601 timestamp of the last update.
+     */
+    updated?: string;
+}
+/**
+ * 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.
+ */
+export interface TopicDigestScheduleRequest {
+    /**
+     * How often a digest is delivered. `instant` delivers immediately without
+     * batching, and is the one value that takes no `time`.
+     */
+    frequency: DigestsAPI.DigestFrequency;
+    /**
+     * Required when `frequency` is `monthly`.
+     */
+    day_of_month?: number;
+    /**
+     * Required when `frequency` is `weekly`.
+     */
+    day_of_week?: DigestsAPI.DigestDayOfWeek;
+    /**
+     * Required when `frequency` is `custom_days`.
+     */
+    days_of_week?: Array<DigestsAPI.DigestDayOfWeek>;
+    /**
+     * Whether the schedule is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * The schedule recipients are placed on when they have not chosen one. Set this
+     * explicitly rather than relying on array position.
+     */
+    is_default?: boolean;
+    /**
+     * Identifier of an existing schedule to update. Omit when creating a new one.
+     */
+    schedule_id?: string;
+    /**
+     * 24-hour local delivery time, `HH:MM`. Required for every frequency except
+     * `instant`.
+     */
+    time?: string;
+    /**
+     * 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.
+     */
+    timezone?: string;
+}
 /**
  * Request body for creating a workspace preference.
  */
@@ -246,6 +431,21 @@ export interface WorkspacePreferenceTopicCreateRequest {
      * Optional description shown under the topic on the hosted preferences page.
      */
     description?: string | null;
+    /**
+     * 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.
+     */
+    digest?: WorkspacePreferenceTopicCreateRequest.Digest | null;
     /**
      * Whether to include a list-unsubscribe header on emails for this topic.
      */
@@ -261,6 +461,60 @@ export interface WorkspacePreferenceTopicCreateRequest {
         [key: string]: unknown;
     } | null;
 }
+export declare namespace WorkspacePreferenceTopicCreateRequest {
+    /**
+     * 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.
+     */
+    interface Digest {
+        /**
+         * 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.
+         */
+        schedules: Array<WorkspacePreferencesAPI.TopicDigestScheduleRequest>;
+        /**
+         * The notification template that renders the digest. A digest with no template
+         * collects nothing, so this is required.
+         */
+        template_id: string;
+        /**
+         * Optional audience the digest is scoped to.
+         */
+        audience_id?: string;
+        /**
+         * Retention rules per category key. Defaults to a single `digest` category
+         * retaining `FIRST`.
+         */
+        categories?: Array<WorkspacePreferencesAPI.TopicDigestCategory>;
+        /**
+         * Whether to deliver the digest even when nothing was collected.
+         */
+        trigger_empty?: boolean;
+    }
+}
 /**
  * A subscription preference topic in your workspace.
  */
@@ -311,6 +565,10 @@ export interface WorkspacePreferenceTopicGetResponse {
      * Optional description shown under the topic on the hosted preferences page.
      */
     description?: string | null;
+    /**
+     * A topic's digest configuration.
+     */
+    digest?: TopicDigestResponse | null;
     /**
      * Id of the last updater.
      */
@@ -344,6 +602,16 @@ export interface WorkspacePreferenceTopicReplaceRequest {
      * to clear.
      */
     description?: string | null;
+    /**
+     * 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?: TopicDigestRequest | null;
     /**
      * Whether to include a list-unsubscribe header on emails for this topic.
      */
@@ -447,7 +715,7 @@ export interface WorkspacePreferenceReplaceParams {
     routing_options?: Array<Shared.ChannelClassification> | null;
 }
 export declare namespace WorkspacePreferences {
-    export { type PublishPreferencesRequest as PublishPreferencesRequest, type PublishPreferencesResponse as PublishPreferencesResponse, type WorkspacePreferenceCreateRequest as WorkspacePreferenceCreateRequest, type WorkspacePreferenceGetResponse as WorkspacePreferenceGetResponse, type WorkspacePreferenceListResponse as WorkspacePreferenceListResponse, type WorkspacePreferenceReplaceRequest as WorkspacePreferenceReplaceRequest, type WorkspacePreferenceTopicCreateRequest as WorkspacePreferenceTopicCreateRequest, type WorkspacePreferenceTopicGetResponse as WorkspacePreferenceTopicGetResponse, type WorkspacePreferenceTopicListResponse as WorkspacePreferenceTopicListResponse, type WorkspacePreferenceTopicReplaceRequest as WorkspacePreferenceTopicReplaceRequest, type WorkspacePreferenceCreateParams as WorkspacePreferenceCreateParams, type WorkspacePreferencePublishParams as WorkspacePreferencePublishParams, type WorkspacePreferenceReplaceParams as WorkspacePreferenceReplaceParams, };
-    export { Topics as Topics, type TopicCreateParams as TopicCreateParams, type TopicRetrieveParams as TopicRetrieveParams, type TopicArchiveParams as TopicArchiveParams, type TopicReplaceParams as TopicReplaceParams, };
+    export { type PublishPreferencesRequest as PublishPreferencesRequest, type PublishPreferencesResponse as PublishPreferencesResponse, type TopicDigestCategory as TopicDigestCategory, type TopicDigestReleaseRequest as TopicDigestReleaseRequest, type TopicDigestRequest as TopicDigestRequest, type TopicDigestResponse as TopicDigestResponse, type TopicDigestScheduleRequest as TopicDigestScheduleRequest, type WorkspacePreferenceCreateRequest as WorkspacePreferenceCreateRequest, type WorkspacePreferenceGetResponse as WorkspacePreferenceGetResponse, type WorkspacePreferenceListResponse as WorkspacePreferenceListResponse, type WorkspacePreferenceReplaceRequest as WorkspacePreferenceReplaceRequest, type WorkspacePreferenceTopicCreateRequest as WorkspacePreferenceTopicCreateRequest, type WorkspacePreferenceTopicGetResponse as WorkspacePreferenceTopicGetResponse, type WorkspacePreferenceTopicListResponse as WorkspacePreferenceTopicListResponse, type WorkspacePreferenceTopicReplaceRequest as WorkspacePreferenceTopicReplaceRequest, type WorkspacePreferenceCreateParams as WorkspacePreferenceCreateParams, type WorkspacePreferencePublishParams as WorkspacePreferencePublishParams, type WorkspacePreferenceReplaceParams as WorkspacePreferenceReplaceParams, };
+    export { Topics as Topics, type TopicCreateParams as TopicCreateParams, type TopicRetrieveParams as TopicRetrieveParams, type TopicArchiveParams as TopicArchiveParams, type TopicDeleteDigestParams as TopicDeleteDigestParams, type TopicReleaseDigestParams as TopicReleaseDigestParams, type TopicReplaceParams as TopicReplaceParams, };
 }
 //# sourceMappingURL=workspace-preferences.d.ts.map