@trycourier/courier 7.11.0 → 7.19.1

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

@@ -0,0 +1,168 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import * as WorkspacePreferencesAPI from "./workspace-preferences.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Topics extends APIResource {
+    /**
+     * Create a subscription preference topic inside a workspace preference. Fails with
+     * 404 if the workspace preference does not exist. The topic id is generated and
+     * returned.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.create(
+     *     'section_id',
+     *     { default_status: 'OPTED_OUT', name: 'Marketing' },
+     *   );
+     * ```
+     */
+    create(sectionID: string, body: TopicCreateParams, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicGetResponse>;
+    /**
+     * Retrieve a topic within a workspace preference. Returns 404 if the workspace
+     * preference does not exist, the topic does not exist, or the topic belongs to a
+     * different workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.retrieve(
+     *     'topic_id',
+     *     { section_id: 'section_id' },
+     *   );
+     * ```
+     */
+    retrieve(topicID: string, params: TopicRetrieveParams, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicGetResponse>;
+    /**
+     * List the topics in a workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicListResponse =
+     *   await client.workspacePreferences.topics.list(
+     *     'section_id',
+     *   );
+     * ```
+     */
+    list(sectionID: string, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicListResponse>;
+    /**
+     * Archive a topic and remove it from its workspace preference. Same 404 rules as
+     * GET.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.archive(
+     *   'topic_id',
+     *   { section_id: 'section_id' },
+     * );
+     * ```
+     */
+    archive(topicID: string, params: TopicArchiveParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Replace a topic within a workspace preference. Full document replacement;
+     * missing optional fields are cleared. Same 404 rules as GET.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.replace(
+     *     'topic_id',
+     *     {
+     *       section_id: 'section_id',
+     *       default_status: 'OPTED_OUT',
+     *       name: 'name',
+     *     },
+     *   );
+     * ```
+     */
+    replace(topicID: string, params: TopicReplaceParams, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicGetResponse>;
+}
+export interface TopicCreateParams {
+    /**
+     * The default subscription status applied when a recipient has not set their own.
+     */
+    default_status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
+    /**
+     * Human-readable name for the preference topic.
+     */
+    name: string;
+    /**
+     * Preference controls a recipient may customize for this topic. Defaults to empty
+     * if omitted.
+     */
+    allowed_preferences?: Array<'snooze' | 'channel_preferences'> | null;
+    /**
+     * Optional description shown under the topic on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * Whether to include a list-unsubscribe header on emails for this topic.
+     */
+    include_unsubscribe_header?: boolean | null;
+    /**
+     * Default channels delivered for this topic. Defaults to empty if omitted.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+    /**
+     * Arbitrary metadata associated with the topic.
+     */
+    topic_data?: {
+        [key: string]: unknown;
+    } | null;
+}
+export interface TopicRetrieveParams {
+    /**
+     * Id of the workspace preference.
+     */
+    section_id: string;
+}
+export interface TopicArchiveParams {
+    /**
+     * Id of the workspace preference.
+     */
+    section_id: string;
+}
+export interface TopicReplaceParams {
+    /**
+     * Path param: Id of the workspace preference.
+     */
+    section_id: string;
+    /**
+     * Body param: The default subscription status applied when a recipient has not set
+     * their own.
+     */
+    default_status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
+    /**
+     * Body param: Human-readable name for the preference topic.
+     */
+    name: string;
+    /**
+     * Body param: Preference controls a recipient may customize. Omit to clear.
+     */
+    allowed_preferences?: Array<'snooze' | 'channel_preferences'> | null;
+    /**
+     * Body param: Optional description shown under the topic on the hosted preferences
+     * page. Omit to clear.
+     */
+    description?: string | null;
+    /**
+     * Body param: Whether to include a list-unsubscribe header on emails for this
+     * topic.
+     */
+    include_unsubscribe_header?: boolean | null;
+    /**
+     * Body param: Default channels delivered for this topic. Omit to clear.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+    /**
+     * Body param: Arbitrary metadata associated with the topic. Omit to clear.
+     */
+    topic_data?: {
+        [key: string]: unknown;
+    } | null;
+}
+export declare namespace Topics {
+    export { type TopicCreateParams as TopicCreateParams, type TopicRetrieveParams as TopicRetrieveParams, type TopicArchiveParams as TopicArchiveParams, type TopicReplaceParams as TopicReplaceParams, };
+}
+//# sourceMappingURL=topics.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"topics.d.mts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/topics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,uBAAuB,oCAAgC;AACnE,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAI1E;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAK1E;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;OAgBG;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;;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,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"}

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

@@ -0,0 +1,168 @@
+import { APIResource } from "../../core/resource.js";
+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";
+export declare class Topics extends APIResource {
+    /**
+     * Create a subscription preference topic inside a workspace preference. Fails with
+     * 404 if the workspace preference does not exist. The topic id is generated and
+     * returned.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.create(
+     *     'section_id',
+     *     { default_status: 'OPTED_OUT', name: 'Marketing' },
+     *   );
+     * ```
+     */
+    create(sectionID: string, body: TopicCreateParams, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicGetResponse>;
+    /**
+     * Retrieve a topic within a workspace preference. Returns 404 if the workspace
+     * preference does not exist, the topic does not exist, or the topic belongs to a
+     * different workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.retrieve(
+     *     'topic_id',
+     *     { section_id: 'section_id' },
+     *   );
+     * ```
+     */
+    retrieve(topicID: string, params: TopicRetrieveParams, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicGetResponse>;
+    /**
+     * List the topics in a workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicListResponse =
+     *   await client.workspacePreferences.topics.list(
+     *     'section_id',
+     *   );
+     * ```
+     */
+    list(sectionID: string, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicListResponse>;
+    /**
+     * Archive a topic and remove it from its workspace preference. Same 404 rules as
+     * GET.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.archive(
+     *   'topic_id',
+     *   { section_id: 'section_id' },
+     * );
+     * ```
+     */
+    archive(topicID: string, params: TopicArchiveParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Replace a topic within a workspace preference. Full document replacement;
+     * missing optional fields are cleared. Same 404 rules as GET.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.replace(
+     *     'topic_id',
+     *     {
+     *       section_id: 'section_id',
+     *       default_status: 'OPTED_OUT',
+     *       name: 'name',
+     *     },
+     *   );
+     * ```
+     */
+    replace(topicID: string, params: TopicReplaceParams, options?: RequestOptions): APIPromise<WorkspacePreferencesAPI.WorkspacePreferenceTopicGetResponse>;
+}
+export interface TopicCreateParams {
+    /**
+     * The default subscription status applied when a recipient has not set their own.
+     */
+    default_status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
+    /**
+     * Human-readable name for the preference topic.
+     */
+    name: string;
+    /**
+     * Preference controls a recipient may customize for this topic. Defaults to empty
+     * if omitted.
+     */
+    allowed_preferences?: Array<'snooze' | 'channel_preferences'> | null;
+    /**
+     * Optional description shown under the topic on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * Whether to include a list-unsubscribe header on emails for this topic.
+     */
+    include_unsubscribe_header?: boolean | null;
+    /**
+     * Default channels delivered for this topic. Defaults to empty if omitted.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+    /**
+     * Arbitrary metadata associated with the topic.
+     */
+    topic_data?: {
+        [key: string]: unknown;
+    } | null;
+}
+export interface TopicRetrieveParams {
+    /**
+     * Id of the workspace preference.
+     */
+    section_id: string;
+}
+export interface TopicArchiveParams {
+    /**
+     * Id of the workspace preference.
+     */
+    section_id: string;
+}
+export interface TopicReplaceParams {
+    /**
+     * Path param: Id of the workspace preference.
+     */
+    section_id: string;
+    /**
+     * Body param: The default subscription status applied when a recipient has not set
+     * their own.
+     */
+    default_status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
+    /**
+     * Body param: Human-readable name for the preference topic.
+     */
+    name: string;
+    /**
+     * Body param: Preference controls a recipient may customize. Omit to clear.
+     */
+    allowed_preferences?: Array<'snooze' | 'channel_preferences'> | null;
+    /**
+     * Body param: Optional description shown under the topic on the hosted preferences
+     * page. Omit to clear.
+     */
+    description?: string | null;
+    /**
+     * Body param: Whether to include a list-unsubscribe header on emails for this
+     * topic.
+     */
+    include_unsubscribe_header?: boolean | null;
+    /**
+     * Body param: Default channels delivered for this topic. Omit to clear.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+    /**
+     * Body param: Arbitrary metadata associated with the topic. Omit to clear.
+     */
+    topic_data?: {
+        [key: string]: unknown;
+    } | null;
+}
+export declare namespace Topics {
+    export { type TopicCreateParams as TopicCreateParams, type TopicRetrieveParams as TopicRetrieveParams, type TopicArchiveParams as TopicArchiveParams, type TopicReplaceParams as TopicReplaceParams, };
+}
+//# sourceMappingURL=topics.d.ts.map

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

@@ -0,0 +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,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAI1E;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC,mCAAmC,CAAC;IAK1E;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;OAgBG;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;;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,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"}

package/resources/workspace-preferences/topics.js

@@ -0,0 +1,103 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+class Topics extends resource_1.APIResource {
+    /**
+     * Create a subscription preference topic inside a workspace preference. Fails with
+     * 404 if the workspace preference does not exist. The topic id is generated and
+     * returned.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.create(
+     *     'section_id',
+     *     { default_status: 'OPTED_OUT', name: 'Marketing' },
+     *   );
+     * ```
+     */
+    create(sectionID, body, options) {
+        return this._client.post((0, path_1.path) `/preferences/sections/${sectionID}/topics`, { body, ...options });
+    }
+    /**
+     * Retrieve a topic within a workspace preference. Returns 404 if the workspace
+     * preference does not exist, the topic does not exist, or the topic belongs to a
+     * different workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.retrieve(
+     *     'topic_id',
+     *     { section_id: 'section_id' },
+     *   );
+     * ```
+     */
+    retrieve(topicID, params, options) {
+        const { section_id } = params;
+        return this._client.get((0, path_1.path) `/preferences/sections/${section_id}/topics/${topicID}`, options);
+    }
+    /**
+     * List the topics in a workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicListResponse =
+     *   await client.workspacePreferences.topics.list(
+     *     'section_id',
+     *   );
+     * ```
+     */
+    list(sectionID, options) {
+        return this._client.get((0, path_1.path) `/preferences/sections/${sectionID}/topics`, options);
+    }
+    /**
+     * Archive a topic and remove it from its workspace preference. Same 404 rules as
+     * GET.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.archive(
+     *   'topic_id',
+     *   { section_id: 'section_id' },
+     * );
+     * ```
+     */
+    archive(topicID, params, options) {
+        const { section_id } = params;
+        return this._client.delete((0, path_1.path) `/preferences/sections/${section_id}/topics/${topicID}`, {
+            ...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.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.replace(
+     *     'topic_id',
+     *     {
+     *       section_id: 'section_id',
+     *       default_status: 'OPTED_OUT',
+     *       name: 'name',
+     *     },
+     *   );
+     * ```
+     */
+    replace(topicID, params, options) {
+        const { section_id, ...body } = params;
+        return this._client.put((0, path_1.path) `/preferences/sections/${section_id}/topics/${topicID}`, {
+            body,
+            ...options,
+        });
+    }
+}
+exports.Topics = Topics;
+//# sourceMappingURL=topics.js.map

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

@@ -0,0 +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,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;OAaG;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;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;OAgBG;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;AAhHD,wBAgHC"}

package/resources/workspace-preferences/topics.mjs

@@ -0,0 +1,99 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Topics extends APIResource {
+    /**
+     * Create a subscription preference topic inside a workspace preference. Fails with
+     * 404 if the workspace preference does not exist. The topic id is generated and
+     * returned.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.create(
+     *     'section_id',
+     *     { default_status: 'OPTED_OUT', name: 'Marketing' },
+     *   );
+     * ```
+     */
+    create(sectionID, body, options) {
+        return this._client.post(path `/preferences/sections/${sectionID}/topics`, { body, ...options });
+    }
+    /**
+     * Retrieve a topic within a workspace preference. Returns 404 if the workspace
+     * preference does not exist, the topic does not exist, or the topic belongs to a
+     * different workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.retrieve(
+     *     'topic_id',
+     *     { section_id: 'section_id' },
+     *   );
+     * ```
+     */
+    retrieve(topicID, params, options) {
+        const { section_id } = params;
+        return this._client.get(path `/preferences/sections/${section_id}/topics/${topicID}`, options);
+    }
+    /**
+     * List the topics in a workspace preference.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicListResponse =
+     *   await client.workspacePreferences.topics.list(
+     *     'section_id',
+     *   );
+     * ```
+     */
+    list(sectionID, options) {
+        return this._client.get(path `/preferences/sections/${sectionID}/topics`, options);
+    }
+    /**
+     * Archive a topic and remove it from its workspace preference. Same 404 rules as
+     * GET.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.topics.archive(
+     *   'topic_id',
+     *   { section_id: 'section_id' },
+     * );
+     * ```
+     */
+    archive(topicID, params, options) {
+        const { section_id } = params;
+        return this._client.delete(path `/preferences/sections/${section_id}/topics/${topicID}`, {
+            ...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.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceTopicGetResponse =
+     *   await client.workspacePreferences.topics.replace(
+     *     'topic_id',
+     *     {
+     *       section_id: 'section_id',
+     *       default_status: 'OPTED_OUT',
+     *       name: 'name',
+     *     },
+     *   );
+     * ```
+     */
+    replace(topicID, params, options) {
+        const { section_id, ...body } = params;
+        return this._client.put(path `/preferences/sections/${section_id}/topics/${topicID}`, {
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=topics.mjs.map

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

@@ -0,0 +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,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,SAAS,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;OAaG;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;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;OAgBG;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"}