@trycourier/courier 9.5.0 → 9.7.0

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

@@ -3,9 +3,6 @@ import * as Shared from "../shared.js";
 import * as WorkspacePreferencesAPI from "./workspace-preferences.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
-/**
- * Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
- */
 export declare class Topics extends APIResource {
     /**
      * Creates a subscription topic inside a workspace preference. The default status
@@ -61,6 +58,41 @@ export declare class Topics extends APIResource {
      * ```
      */
     archive(topicID: string, params: TopicArchiveParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * 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.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.deleteDigest(
+     *   'topic_id',
+     *   { section_id: 'section_id' },
+     * );
+     * ```
+     */
+    deleteDigest(topicID: string, params: TopicDeleteDigestParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * 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`.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.releaseDigest(
+     *   'topic_id',
+     *   {
+     *     section_id: 'section_id',
+     *     user_id: 'user_01h1p2c3d4e5f6g7h8',
+     *   },
+     * );
+     * ```
+     */
+    releaseDigest(topicID: string, params: TopicReleaseDigestParams, options?: RequestOptions): APIPromise<void>;
     /**
      * Replace a topic within a workspace preference. Full document replacement;
      * missing optional fields are cleared. Same 404 rules as GET.
@@ -103,6 +135,21 @@ export interface TopicCreateParams {
      * page.
      */
     description?: string | null;
+    /**
+     * Body param: 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?: TopicCreateParams.Digest | null;
     /**
      * Body param: Whether to include a list-unsubscribe header on emails for this
      * topic.
@@ -136,6 +183,60 @@ export interface TopicCreateParams {
      */
     'x-idempotency-expiration'?: string;
 }
+export declare namespace TopicCreateParams {
+    /**
+     * 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;
+    }
+}
 export interface TopicRetrieveParams {
     /**
      * Id of the workspace preference.
@@ -148,6 +249,32 @@ export interface TopicArchiveParams {
      */
     section_id: string;
 }
+export interface TopicDeleteDigestParams {
+    /**
+     * The preference section containing the topic.
+     */
+    section_id: string;
+}
+export interface TopicReleaseDigestParams {
+    /**
+     * Path param: The preference section containing the topic.
+     */
+    section_id: string;
+    /**
+     * Body param: The recipient whose digest to release. Required: there is no
+     * "release everyone on this topic" form, because a whole-schedule flush already
+     * has its own endpoint and a body-shaped difference between one recipient and all
+     * of them is too easy to get wrong.
+     */
+    user_id: string;
+    /**
+     * Body param: The recipient's tenant, when they were sent to as part of one -- the
+     * same value returned as `tenant_id` on a digest instance and sent as
+     * `message.context.tenant_id`. It is part of the held digest's key, so a tenanted
+     * recipient cannot be found without it. Omit for an ordinary recipient.
+     */
+    tenant_id?: string;
+}
 export interface TopicReplaceParams {
     /**
      * Path param: Id of the workspace preference.
@@ -171,6 +298,16 @@ export interface TopicReplaceParams {
      * page. Omit to clear.
      */
     description?: string | null;
+    /**
+     * Body param: A topic's digest configuration: the template that renders it, the
+     * cadences it delivers on, and how collected events are retained.
+     *
+     * Send `null` for the whole object to turn a digest off, which unlinks the
+     * template and removes its schedules. There is no `enabled` flag, and
+     * `schedules: []` is rejected, because both states are un-deliverable rather than
+     * merely off.
+     */
+    digest?: WorkspacePreferencesAPI.TopicDigestRequest | null;
     /**
      * Body param: Whether to include a list-unsubscribe header on emails for this
      * topic.
@@ -188,6 +325,6 @@ export interface TopicReplaceParams {
     } | null;
 }
 export declare namespace Topics {
-    export { type TopicCreateParams as TopicCreateParams, type TopicRetrieveParams as TopicRetrieveParams, type TopicArchiveParams as TopicArchiveParams, type TopicReplaceParams as TopicReplaceParams, };
+    export { 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=topics.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"topics.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,uBAAuB,mCAAgC;AACnE,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAqB1E;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAK1E;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,oCAAoC,CAAC;IAI3E;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQhG;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;CAO3E;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;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;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;;OAGG;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;IAE/C;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;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;;;OAGG;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,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,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":"topics.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,uBAAuB,mCAAgC;AACnE,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAqB1E;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAK1E;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,oCAAoC,CAAC;IAI3E;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQhG;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ1G;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;CAO3E;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;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;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;;OAGG;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;IAE/C;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;;;;;;;;;;;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,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;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,uBAAuB,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAE3D;;;OAGG;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,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,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/topics.js

@@ -5,9 +5,6 @@ exports.Topics = void 0;
 const resource_1 = require("../../core/resource.js");
 const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
-/**
- * Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
- */
 class Topics extends resource_1.APIResource {
     /**
      * Creates a subscription topic inside a workspace preference. The default status
@@ -89,6 +86,54 @@ class Topics extends resource_1.APIResource {
             headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * 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.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.deleteDigest(
+     *   'topic_id',
+     *   { section_id: 'section_id' },
+     * );
+     * ```
+     */
+    deleteDigest(topicID, params, options) {
+        const { section_id } = params;
+        return this._client.delete((0, path_1.path) `/preferences/sections/${section_id}/topics/${topicID}/digest`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * 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`.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.releaseDigest(
+     *   'topic_id',
+     *   {
+     *     section_id: 'section_id',
+     *     user_id: 'user_01h1p2c3d4e5f6g7h8',
+     *   },
+     * );
+     * ```
+     */
+    releaseDigest(topicID, params, options) {
+        const { section_id, ...body } = params;
+        return this._client.post((0, path_1.path) `/preferences/sections/${section_id}/topics/${topicID}/digest/release`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
     /**
      * Replace a topic within a workspace preference. Full document replacement;
      * missing optional fields are cleared. Same 404 rules as GET.

package/resources/workspace-preferences/topics.js.map

@@ -1 +1 @@
-{"version":3,"file":"topics.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAyB,EACzB,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,SAAS,EAAE;YACxE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,SAAS,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAe,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACtF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,OAAe,EACf,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAnID,wBAmIC"}
+{"version":3,"file":"topics.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAyB,EACzB,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,SAAS,EAAE;YACxE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,SAAS,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAe,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACtF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAe,EAAE,MAA+B,EAAE,OAAwB;QACrF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,SAAS,EAAE;YAC7F,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CACX,OAAe,EACf,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,iBAAiB,EAAE;YACnG,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,OAAe,EACf,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAzLD,wBAyLC"}

package/resources/workspace-preferences/topics.mjs

@@ -2,9 +2,6 @@
 import { APIResource } from "../../core/resource.mjs";
 import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
-/**
- * Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page.
- */
 export class Topics extends APIResource {
     /**
      * Creates a subscription topic inside a workspace preference. The default status
@@ -86,6 +83,54 @@ export class Topics extends APIResource {
             headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * 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.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.deleteDigest(
+     *   'topic_id',
+     *   { section_id: 'section_id' },
+     * );
+     * ```
+     */
+    deleteDigest(topicID, params, options) {
+        const { section_id } = params;
+        return this._client.delete(path `/preferences/sections/${section_id}/topics/${topicID}/digest`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * 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`.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.releaseDigest(
+     *   'topic_id',
+     *   {
+     *     section_id: 'section_id',
+     *     user_id: 'user_01h1p2c3d4e5f6g7h8',
+     *   },
+     * );
+     * ```
+     */
+    releaseDigest(topicID, params, options) {
+        const { section_id, ...body } = params;
+        return this._client.post(path `/preferences/sections/${section_id}/topics/${topicID}/digest/release`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
     /**
      * Replace a topic within a workspace preference. Full document replacement;
      * missing optional fields are cleared. Same 404 rules as GET.

package/resources/workspace-preferences/topics.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"topics.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAyB,EACzB,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,SAAS,SAAS,EAAE;YACxE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,SAAS,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAe,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACtF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,OAAe,EACf,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"topics.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAyB,EACzB,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,SAAS,SAAS,EAAE;YACxE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAe,EACf,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,SAAS,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAe,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACtF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAe,EAAE,MAA+B,EAAE,OAAwB;QACrF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,SAAS,EAAE;YAC7F,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CACX,OAAe,EACf,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,iBAAiB,EAAE;YACnG,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,OAAe,EACf,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,UAAU,WAAW,OAAO,EAAE,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}