@trycourier/courier 7.11.0 → 7.19.1

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

@@ -0,0 +1,410 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import * as TopicsAPI from "./topics.js";
+import { TopicArchiveParams, TopicCreateParams, TopicReplaceParams, TopicRetrieveParams, Topics } from "./topics.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class WorkspacePreferences extends APIResource {
+    topics: TopicsAPI.Topics;
+    /**
+     * Create a workspace preference. The workspace preference id is generated and
+     * returned. Topics are created inside a workspace preference via POST
+     * /preferences/sections/{section_id}/topics.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.create({
+     *     name: 'Account Notifications',
+     *   });
+     * ```
+     */
+    create(body: WorkspacePreferenceCreateParams, options?: RequestOptions): APIPromise<WorkspacePreferenceGetResponse>;
+    /**
+     * Retrieve a workspace preference by id, including its topics.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.retrieve('section_id');
+     * ```
+     */
+    retrieve(sectionID: string, options?: RequestOptions): APIPromise<WorkspacePreferenceGetResponse>;
+    /**
+     * List the workspace's preferences. Each workspace preference embeds its topics.
+     * Scoped to the workspace of the API key.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceListResponse =
+     *   await client.workspacePreferences.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<WorkspacePreferenceListResponse>;
+    /**
+     * Archive a workspace preference. The workspace preference must be empty: delete
+     * its topics first, otherwise the request fails with 409.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.archive('section_id');
+     * ```
+     */
+    archive(sectionID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Publish the workspace's preferences page. Takes a snapshot of every workspace
+     * preference with its topics under a new published version, making the current
+     * state visible on the hosted preferences page (non-draft).
+     *
+     * @example
+     * ```ts
+     * const publishPreferencesResponse =
+     *   await client.workspacePreferences.publish();
+     * ```
+     */
+    publish(body?: WorkspacePreferencePublishParams | null | undefined, options?: RequestOptions): APIPromise<PublishPreferencesResponse>;
+    /**
+     * Replace a workspace preference. Full document replacement; missing optional
+     * fields are cleared. Topics attached to the workspace preference are unaffected.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.replace('section_id', {
+     *     name: 'name',
+     *   });
+     * ```
+     */
+    replace(sectionID: string, body: WorkspacePreferenceReplaceParams, options?: RequestOptions): APIPromise<WorkspacePreferenceGetResponse>;
+}
+/**
+ * Optional page metadata to apply when publishing the workspace's preferences
+ * page. All fields are optional; omitted fields fall back to the page defaults
+ * (and the workspace default brand).
+ */
+export interface PublishPreferencesRequest {
+    /**
+     * Brand for the hosted page - "default" (workspace default brand), "none" (no
+     * brand), or a specific brand id. Defaults to "default".
+     */
+    brand_id?: string | null;
+    /**
+     * Description shown under the heading on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * Heading shown at the top of the hosted preferences page.
+     */
+    heading?: string | null;
+}
+/**
+ * Result of publishing the workspace's preferences page.
+ */
+export interface PublishPreferencesResponse {
+    /**
+     * Id of the published page snapshot.
+     */
+    page_id: string;
+    /**
+     * ISO-8601 timestamp of the publish.
+     */
+    published_at: string;
+    /**
+     * Monotonic published version (epoch milliseconds).
+     */
+    published_version: number;
+    /**
+     * Draft-mode hosted preferences page URL for previewing.
+     */
+    preview_url?: string | null;
+    /**
+     * Id of the publisher.
+     */
+    published_by?: string | null;
+}
+/**
+ * Request body for creating a workspace preference.
+ */
+export interface WorkspacePreferenceCreateRequest {
+    /**
+     * Human-readable name for the workspace preference.
+     */
+    name: string;
+    /**
+     * Optional description shown under the section on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * Whether the workspace preference defines custom routing for its topics.
+     */
+    has_custom_routing?: boolean | null;
+    /**
+     * Default channels for the workspace preference. Defaults to empty if omitted.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+}
+/**
+ * A workspace preference in your workspace, including its topics.
+ */
+export interface WorkspacePreferenceGetResponse {
+    /**
+     * The workspace preference id.
+     */
+    id: string;
+    /**
+     * ISO-8601 timestamp of when the workspace preference was created.
+     */
+    created: string;
+    /**
+     * Whether the workspace preference defines custom routing for its topics.
+     */
+    has_custom_routing: boolean;
+    /**
+     * Human-readable name.
+     */
+    name: string;
+    /**
+     * Default channels for the workspace preference. May be empty.
+     */
+    routing_options: Array<Shared.ChannelClassification>;
+    /**
+     * The topics contained in this workspace preference.
+     */
+    topics: Array<WorkspacePreferenceTopicGetResponse>;
+    /**
+     * Id of the creator.
+     */
+    creator?: string | null;
+    /**
+     * Optional description shown under the section on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * ISO-8601 timestamp of the last update.
+     */
+    updated?: string | null;
+    /**
+     * Id of the last updater.
+     */
+    updater?: string | null;
+}
+/**
+ * The workspace's preferences, each with its topics.
+ */
+export interface WorkspacePreferenceListResponse {
+    results: Array<WorkspacePreferenceGetResponse>;
+}
+/**
+ * Request body for replacing a workspace preference. Full document replacement;
+ * missing optional fields are cleared.
+ */
+export interface WorkspacePreferenceReplaceRequest {
+    /**
+     * Human-readable name for the workspace preference.
+     */
+    name: string;
+    /**
+     * Optional description shown under the section on the hosted preferences page.
+     * Omit to clear.
+     */
+    description?: string | null;
+    /**
+     * Whether the workspace preference defines custom routing for its topics.
+     */
+    has_custom_routing?: boolean | null;
+    /**
+     * Default channels for the workspace preference. Omit to clear.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+}
+/**
+ * Request body for creating a preference topic.
+ */
+export interface WorkspacePreferenceTopicCreateRequest {
+    /**
+     * 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;
+}
+/**
+ * A subscription preference topic in your workspace.
+ */
+export interface WorkspacePreferenceTopicGetResponse {
+    /**
+     * The preference topic id.
+     */
+    id: string;
+    /**
+     * Preference controls a recipient may customize. May be empty.
+     */
+    allowed_preferences: Array<'snooze' | 'channel_preferences'>;
+    /**
+     * ISO-8601 timestamp of when the topic was created.
+     */
+    created: string;
+    /**
+     * The default subscription status applied when a recipient has not set their own.
+     */
+    default_status: 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED';
+    /**
+     * Whether a list-unsubscribe header is included on emails for this topic.
+     */
+    include_unsubscribe_header: boolean;
+    /**
+     * Human-readable name.
+     */
+    name: string;
+    /**
+     * Default channels delivered for this topic. May be empty.
+     */
+    routing_options: Array<Shared.ChannelClassification>;
+    /**
+     * Arbitrary metadata associated with the topic.
+     */
+    topic_data: {
+        [key: string]: unknown;
+    };
+    /**
+     * ISO-8601 timestamp of the last update.
+     */
+    updated: string;
+    /**
+     * Id of the creator.
+     */
+    creator?: string | null;
+    /**
+     * Optional description shown under the topic on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * Id of the last updater.
+     */
+    updater?: string | null;
+}
+/**
+ * Topics contained in a workspace preference.
+ */
+export interface WorkspacePreferenceTopicListResponse {
+    results: Array<WorkspacePreferenceTopicGetResponse>;
+}
+/**
+ * Request body for replacing a preference topic. Full document replacement;
+ * missing optional fields are cleared.
+ */
+export interface WorkspacePreferenceTopicReplaceRequest {
+    /**
+     * 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. Omit to clear.
+     */
+    allowed_preferences?: Array<'snooze' | 'channel_preferences'> | null;
+    /**
+     * Optional description shown under the topic on the hosted preferences page. Omit
+     * to clear.
+     */
+    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. Omit to clear.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+    /**
+     * Arbitrary metadata associated with the topic. Omit to clear.
+     */
+    topic_data?: {
+        [key: string]: unknown;
+    } | null;
+}
+export interface WorkspacePreferenceCreateParams {
+    /**
+     * Human-readable name for the workspace preference.
+     */
+    name: string;
+    /**
+     * Optional description shown under the section on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * Whether the workspace preference defines custom routing for its topics.
+     */
+    has_custom_routing?: boolean | null;
+    /**
+     * Default channels for the workspace preference. Defaults to empty if omitted.
+     */
+    routing_options?: Array<Shared.ChannelClassification> | null;
+}
+export interface WorkspacePreferencePublishParams {
+    /**
+     * Brand for the hosted page - "default" (workspace default brand), "none" (no
+     * brand), or a specific brand id. Defaults to "default".
+     */
+    brand_id?: string | null;
+    /**
+     * Description shown under the heading on the hosted preferences page.
+     */
+    description?: string | null;
+    /**
+     * Heading shown at the top of the hosted preferences page.
+     */
+    heading?: string | null;
+}
+export interface WorkspacePreferenceReplaceParams {
+    /**
+     * Human-readable name for the workspace preference.
+     */
+    name: string;
+    /**
+     * Optional description shown under the section on the hosted preferences page.
+     * Omit to clear.
+     */
+    description?: string | null;
+    /**
+     * Whether the workspace preference defines custom routing for its topics.
+     */
+    has_custom_routing?: boolean | null;
+    /**
+     * Default channels for the workspace preference. Omit to clear.
+     */
+    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, };
+}
+//# sourceMappingURL=workspace-preferences.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;OAQG;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;;;;;;;;;;OAUG;IACH,OAAO,CACL,IAAI,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;OAWG;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;;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,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;CACzB;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"}

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

@@ -0,0 +1,104 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspacePreferences = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const TopicsAPI = tslib_1.__importStar(require("./topics.js"));
+const topics_1 = require("./topics.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class WorkspacePreferences extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.topics = new TopicsAPI.Topics(this._client);
+    }
+    /**
+     * Create a workspace preference. The workspace preference id is generated and
+     * returned. Topics are created inside a workspace preference via POST
+     * /preferences/sections/{section_id}/topics.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.create({
+     *     name: 'Account Notifications',
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/preferences/sections', { body, ...options });
+    }
+    /**
+     * Retrieve a workspace preference by id, including its topics.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.retrieve('section_id');
+     * ```
+     */
+    retrieve(sectionID, options) {
+        return this._client.get((0, path_1.path) `/preferences/sections/${sectionID}`, options);
+    }
+    /**
+     * List the workspace's preferences. Each workspace preference embeds its topics.
+     * Scoped to the workspace of the API key.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceListResponse =
+     *   await client.workspacePreferences.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/preferences/sections', options);
+    }
+    /**
+     * Archive a workspace preference. The workspace preference must be empty: delete
+     * its topics first, otherwise the request fails with 409.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.archive('section_id');
+     * ```
+     */
+    archive(sectionID, options) {
+        return this._client.delete((0, path_1.path) `/preferences/sections/${sectionID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Publish the workspace's preferences page. Takes a snapshot of every workspace
+     * preference with its topics under a new published version, making the current
+     * state visible on the hosted preferences page (non-draft).
+     *
+     * @example
+     * ```ts
+     * const publishPreferencesResponse =
+     *   await client.workspacePreferences.publish();
+     * ```
+     */
+    publish(body = {}, options) {
+        return this._client.post('/preferences/publish', { body, ...options });
+    }
+    /**
+     * Replace a workspace preference. Full document replacement; missing optional
+     * fields are cleared. Topics attached to the workspace preference are unaffected.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.replace('section_id', {
+     *     name: 'name',
+     *   });
+     * ```
+     */
+    replace(sectionID, body, options) {
+        return this._client.put((0, path_1.path) `/preferences/sections/${sectionID}`, { body, ...options });
+    }
+}
+exports.WorkspacePreferences = WorkspacePreferences;
+WorkspacePreferences.Topics = topics_1.Topics;
+//# sourceMappingURL=workspace-preferences.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,+DAAsC;AACtC,wCAMkB;AAElB,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,oBAAqB,SAAQ,sBAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsGhE,CAAC;IApGC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,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;;;;;;;;;;OAUG;IACH,OAAO,CACL,OAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAvGD,oDAuGC;AAmYD,oBAAoB,CAAC,MAAM,GAAG,eAAM,CAAC"}

package/resources/workspace-preferences/workspace-preferences.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 * as TopicsAPI from "./topics.mjs";
+import { Topics, } from "./topics.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class WorkspacePreferences extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.topics = new TopicsAPI.Topics(this._client);
+    }
+    /**
+     * Create a workspace preference. The workspace preference id is generated and
+     * returned. Topics are created inside a workspace preference via POST
+     * /preferences/sections/{section_id}/topics.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.create({
+     *     name: 'Account Notifications',
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/preferences/sections', { body, ...options });
+    }
+    /**
+     * Retrieve a workspace preference by id, including its topics.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.retrieve('section_id');
+     * ```
+     */
+    retrieve(sectionID, options) {
+        return this._client.get(path `/preferences/sections/${sectionID}`, options);
+    }
+    /**
+     * List the workspace's preferences. Each workspace preference embeds its topics.
+     * Scoped to the workspace of the API key.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceListResponse =
+     *   await client.workspacePreferences.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/preferences/sections', options);
+    }
+    /**
+     * Archive a workspace preference. The workspace preference must be empty: delete
+     * its topics first, otherwise the request fails with 409.
+     *
+     * @example
+     * ```ts
+     * await client.workspacePreferences.archive('section_id');
+     * ```
+     */
+    archive(sectionID, options) {
+        return this._client.delete(path `/preferences/sections/${sectionID}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Publish the workspace's preferences page. Takes a snapshot of every workspace
+     * preference with its topics under a new published version, making the current
+     * state visible on the hosted preferences page (non-draft).
+     *
+     * @example
+     * ```ts
+     * const publishPreferencesResponse =
+     *   await client.workspacePreferences.publish();
+     * ```
+     */
+    publish(body = {}, options) {
+        return this._client.post('/preferences/publish', { body, ...options });
+    }
+    /**
+     * Replace a workspace preference. Full document replacement; missing optional
+     * fields are cleared. Topics attached to the workspace preference are unaffected.
+     *
+     * @example
+     * ```ts
+     * const workspacePreferenceGetResponse =
+     *   await client.workspacePreferences.replace('section_id', {
+     *     name: 'name',
+     *   });
+     * ```
+     */
+    replace(sectionID, body, options) {
+        return this._client.put(path `/preferences/sections/${sectionID}`, { body, ...options });
+    }
+}
+WorkspacePreferences.Topics = Topics;
+//# sourceMappingURL=workspace-preferences.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-preferences.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAKL,MAAM,GACP,qBAAiB;AAElB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsGhE,CAAC;IApGC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,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;;;;;;;;;;OAUG;IACH,OAAO,CACL,OAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAmYD,oBAAoB,CAAC,MAAM,GAAG,MAAM,CAAC"}

package/resources/workspace-preferences.d.mts

@@ -0,0 +1,2 @@
+export * from "./workspace-preferences/index.mjs";
+//# sourceMappingURL=workspace-preferences.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-preferences.d.mts","sourceRoot":"","sources":["../src/resources/workspace-preferences.ts"],"names":[],"mappings":"AAEA,kDAA8C"}

package/resources/workspace-preferences.d.ts

@@ -0,0 +1,2 @@
+export * from "./workspace-preferences/index.js";
+//# sourceMappingURL=workspace-preferences.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../src/resources/workspace-preferences.ts"],"names":[],"mappings":"AAEA,iDAA8C"}

package/resources/workspace-preferences.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./workspace-preferences/index.js"), exports);
+//# sourceMappingURL=workspace-preferences.js.map

package/resources/workspace-preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../src/resources/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2EAA8C"}

package/resources/workspace-preferences.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./workspace-preferences/index.mjs";
+//# sourceMappingURL=workspace-preferences.mjs.map

package/resources/workspace-preferences.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-preferences.mjs","sourceRoot":"","sources":["../src/resources/workspace-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,kDAA8C"}