@trycourier/courier 7.11.0 → 7.19.2

package/resources/users/preferences.mjs

@@ -1,5 +1,6 @@
 // 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 Preferences extends APIResource {
     /**
@@ -15,6 +16,110 @@ export class Preferences extends APIResource {
     retrieve(userID, query = {}, options) {
         return this._client.get(path `/users/${userID}/preferences`, { query, ...options });
     }
+    /**
+     * Replace a user's complete set of preference overrides in a single request. The
+     * topics in the request body become the recipient's entire set of overrides:
+     * listed topics are created or updated, and every existing override that is not
+     * included in the body is reset to its topic default. Submitting an empty `topics`
+     * array is a valid clear-all that resets every existing override.
+     *
+     * This operation is validation-atomic (all-or-nothing): structural validation
+     * fails fast with a single `400`, and if any topic is semantically invalid (an
+     * unknown topic, a `REQUIRED` topic that cannot be opted out, or a custom routing
+     * request that is not available on the workspace's plan) the request returns a
+     * single `400` aggregating every failure in `errors` and writes nothing. On
+     * success it returns `200` with `items` (the complete resulting override set) and
+     * `deleted` (the ids of the overrides that were reset to default).
+     *
+     * Every `topic_id` in the response — in `items`, `deleted`, and any `errors` — is
+     * returned in Courier's canonical topic id form, regardless of the form supplied
+     * in the request.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.preferences.bulkReplace(
+     *   'user_id',
+     *   {
+     *     topics: [
+     *       {
+     *         topic_id: 'pt_01kx4h2jdafq8bk996nn92357r',
+     *         status: 'OPTED_IN',
+     *         has_custom_routing: true,
+     *         custom_routing: ['inbox', 'email'],
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    bulkReplace(userID, params, options) {
+        const { tenant_id, ...body } = params;
+        return this._client.put(path `/users/${userID}/preferences`, { query: { tenant_id }, body, ...options });
+    }
+    /**
+     * Additively create or update a user's preferences for one or more subscription
+     * topics in a single request. Only the topics included in the request body are
+     * created or updated; any existing overrides for topics not listed are left
+     * untouched.
+     *
+     * Structural validation of the request body fails fast with a single `400`. Beyond
+     * that, each topic is processed independently (partial-success, not
+     * all-or-nothing): valid topics are written and returned in `items`, while topics
+     * that cannot be applied are collected in `errors` with a per-topic `reason` (for
+     * example an unknown topic, a `REQUIRED` topic that cannot be opted out, a custom
+     * routing request that is not available on the workspace's plan, or a write
+     * failure). The request therefore returns `200` with both lists whenever the body
+     * is structurally valid.
+     *
+     * Every `topic_id` in the response — in both `items` and `errors` — is returned in
+     * Courier's canonical topic id form, regardless of the form supplied in the
+     * request.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.preferences.bulkUpdate(
+     *   'user_id',
+     *   {
+     *     topics: [
+     *       {
+     *         topic_id: 'pt_01kx4h2jdafq8bk996nn92357r',
+     *         status: 'OPTED_IN',
+     *         has_custom_routing: true,
+     *         custom_routing: ['inbox', 'email'],
+     *       },
+     *       {
+     *         topic_id: 'pt_01kx4h2jdafq8bk99eyt3dx43x',
+     *         status: 'OPTED_OUT',
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    bulkUpdate(userID, params, options) {
+        const { tenant_id, ...body } = params;
+        return this._client.post(path `/users/${userID}/preferences`, { query: { tenant_id }, body, ...options });
+    }
+    /**
+     * Remove a user's preferences for a specific subscription topic, resetting the
+     * topic to its effective default. This operation is idempotent: deleting a
+     * preference that does not exist succeeds with no error.
+     *
+     * @example
+     * ```ts
+     * await client.users.preferences.deleteTopic('topic_id', {
+     *   user_id: 'user_id',
+     * });
+     * ```
+     */
+    deleteTopic(topicID, params, options) {
+        const { user_id, tenant_id } = params;
+        return this._client.delete(path `/users/${user_id}/preferences/${topicID}`, {
+            query: { tenant_id },
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
     /**
      * Fetch user preferences for a specific subscription topic.
      *

package/resources/users/preferences.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"preferences.mjs","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAc,EACd,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,OAAe,EACf,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CACjB,OAAe,EACf,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACtE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"preferences.mjs","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAc,EACd,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CACT,MAAc,EACd,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,UAAU,CACR,MAAc,EACd,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,OAAe,EACf,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACzE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,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,aAAa,CACX,OAAe,EACf,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CACjB,OAAe,EACf,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACtE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/users/users.d.mts

@@ -1,6 +1,6 @@
 import { APIResource } from "../../core/resource.mjs";
 import * as PreferencesAPI from "./preferences.mjs";
-import { PreferenceRetrieveParams, PreferenceRetrieveResponse, PreferenceRetrieveTopicParams, PreferenceRetrieveTopicResponse, PreferenceUpdateOrCreateTopicParams, PreferenceUpdateOrCreateTopicResponse, Preferences, TopicPreference } from "./preferences.mjs";
+import { BulkPreferenceTopic, PreferenceBulkReplaceParams, PreferenceBulkReplaceResponse, PreferenceBulkUpdateParams, PreferenceBulkUpdateResponse, PreferenceDeleteTopicParams, PreferenceRetrieveParams, PreferenceRetrieveResponse, PreferenceRetrieveTopicParams, PreferenceRetrieveTopicResponse, PreferenceUpdateOrCreateTopicParams, PreferenceUpdateOrCreateTopicResponse, Preferences, TopicPreference } from "./preferences.mjs";
 import * as TenantsAPI from "./tenants.mjs";
 import { TenantAddMultipleParams, TenantAddSingleParams, TenantListParams, TenantListResponse, TenantRemoveSingleParams, Tenants } from "./tenants.mjs";
 import * as TokensAPI from "./tokens.mjs";
@@ -11,7 +11,7 @@ export declare class Users extends APIResource {
     tokens: TokensAPI.Tokens;
 }
 export declare namespace Users {
-    export { Preferences as Preferences, type TopicPreference as TopicPreference, type PreferenceRetrieveResponse as PreferenceRetrieveResponse, type PreferenceRetrieveTopicResponse as PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse as PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams as PreferenceRetrieveParams, type PreferenceRetrieveTopicParams as PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams as PreferenceUpdateOrCreateTopicParams, };
+    export { Preferences as Preferences, type BulkPreferenceTopic as BulkPreferenceTopic, type TopicPreference as TopicPreference, type PreferenceRetrieveResponse as PreferenceRetrieveResponse, type PreferenceBulkReplaceResponse as PreferenceBulkReplaceResponse, type PreferenceBulkUpdateResponse as PreferenceBulkUpdateResponse, type PreferenceRetrieveTopicResponse as PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse as PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams as PreferenceRetrieveParams, type PreferenceBulkReplaceParams as PreferenceBulkReplaceParams, type PreferenceBulkUpdateParams as PreferenceBulkUpdateParams, type PreferenceDeleteTopicParams as PreferenceDeleteTopicParams, type PreferenceRetrieveTopicParams as PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams as PreferenceUpdateOrCreateTopicParams, };
     export { Tenants as Tenants, type TenantListResponse as TenantListResponse, type TenantListParams as TenantListParams, type TenantAddMultipleParams as TenantAddMultipleParams, type TenantAddSingleParams as TenantAddSingleParams, type TenantRemoveSingleParams as TenantRemoveSingleParams, };
     export { Tokens as Tokens, type UserToken as UserToken, type TokenRetrieveResponse as TokenRetrieveResponse, type TokenListResponse as TokenListResponse, type TokenRetrieveParams as TokenRetrieveParams, type TokenUpdateParams as TokenUpdateParams, type TokenDeleteParams as TokenDeleteParams, type TokenAddSingleParams as TokenAddSingleParams, };
 }

package/resources/users/users.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EACL,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAC7B,+BAA+B,EAC/B,mCAAmC,EACnC,qCAAqC,EACrC,WAAW,EACX,eAAe,EAChB,0BAAsB;AACvB,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,OAAO,EACR,sBAAkB;AACnB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,EACN,SAAS,EACV,qBAAiB;AAElB,qBAAa,KAAM,SAAQ,WAAW;IACpC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;CAC/D;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EACL,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAC7B,+BAA+B,EAC/B,mCAAmC,EACnC,qCAAqC,EACrC,WAAW,EACX,eAAe,EAChB,0BAAsB;AACvB,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,OAAO,EACR,sBAAkB;AACnB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,EACN,SAAS,EACV,qBAAiB;AAElB,qBAAa,KAAM,SAAQ,WAAW;IACpC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;CAC/D;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/users/users.d.ts

@@ -1,6 +1,6 @@
 import { APIResource } from "../../core/resource.js";
 import * as PreferencesAPI from "./preferences.js";
-import { PreferenceRetrieveParams, PreferenceRetrieveResponse, PreferenceRetrieveTopicParams, PreferenceRetrieveTopicResponse, PreferenceUpdateOrCreateTopicParams, PreferenceUpdateOrCreateTopicResponse, Preferences, TopicPreference } from "./preferences.js";
+import { BulkPreferenceTopic, PreferenceBulkReplaceParams, PreferenceBulkReplaceResponse, PreferenceBulkUpdateParams, PreferenceBulkUpdateResponse, PreferenceDeleteTopicParams, PreferenceRetrieveParams, PreferenceRetrieveResponse, PreferenceRetrieveTopicParams, PreferenceRetrieveTopicResponse, PreferenceUpdateOrCreateTopicParams, PreferenceUpdateOrCreateTopicResponse, Preferences, TopicPreference } from "./preferences.js";
 import * as TenantsAPI from "./tenants.js";
 import { TenantAddMultipleParams, TenantAddSingleParams, TenantListParams, TenantListResponse, TenantRemoveSingleParams, Tenants } from "./tenants.js";
 import * as TokensAPI from "./tokens.js";
@@ -11,7 +11,7 @@ export declare class Users extends APIResource {
     tokens: TokensAPI.Tokens;
 }
 export declare namespace Users {
-    export { Preferences as Preferences, type TopicPreference as TopicPreference, type PreferenceRetrieveResponse as PreferenceRetrieveResponse, type PreferenceRetrieveTopicResponse as PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse as PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams as PreferenceRetrieveParams, type PreferenceRetrieveTopicParams as PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams as PreferenceUpdateOrCreateTopicParams, };
+    export { Preferences as Preferences, type BulkPreferenceTopic as BulkPreferenceTopic, type TopicPreference as TopicPreference, type PreferenceRetrieveResponse as PreferenceRetrieveResponse, type PreferenceBulkReplaceResponse as PreferenceBulkReplaceResponse, type PreferenceBulkUpdateResponse as PreferenceBulkUpdateResponse, type PreferenceRetrieveTopicResponse as PreferenceRetrieveTopicResponse, type PreferenceUpdateOrCreateTopicResponse as PreferenceUpdateOrCreateTopicResponse, type PreferenceRetrieveParams as PreferenceRetrieveParams, type PreferenceBulkReplaceParams as PreferenceBulkReplaceParams, type PreferenceBulkUpdateParams as PreferenceBulkUpdateParams, type PreferenceDeleteTopicParams as PreferenceDeleteTopicParams, type PreferenceRetrieveTopicParams as PreferenceRetrieveTopicParams, type PreferenceUpdateOrCreateTopicParams as PreferenceUpdateOrCreateTopicParams, };
     export { Tenants as Tenants, type TenantListResponse as TenantListResponse, type TenantListParams as TenantListParams, type TenantAddMultipleParams as TenantAddMultipleParams, type TenantAddSingleParams as TenantAddSingleParams, type TenantRemoveSingleParams as TenantRemoveSingleParams, };
     export { Tokens as Tokens, type UserToken as UserToken, type TokenRetrieveResponse as TokenRetrieveResponse, type TokenListResponse as TokenListResponse, type TokenRetrieveParams as TokenRetrieveParams, type TokenUpdateParams as TokenUpdateParams, type TokenDeleteParams as TokenDeleteParams, type TokenAddSingleParams as TokenAddSingleParams, };
 }

package/resources/users/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,cAAc,yBAAsB;AAChD,OAAO,EACL,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAC7B,+BAA+B,EAC/B,mCAAmC,EACnC,qCAAqC,EACrC,WAAW,EACX,eAAe,EAChB,yBAAsB;AACvB,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,OAAO,EACR,qBAAkB;AACnB,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,EACN,SAAS,EACV,oBAAiB;AAElB,qBAAa,KAAM,SAAQ,WAAW;IACpC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;CAC/D;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,cAAc,yBAAsB;AAChD,OAAO,EACL,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAC7B,+BAA+B,EAC/B,mCAAmC,EACnC,qCAAqC,EACrC,WAAW,EACX,eAAe,EAChB,yBAAsB;AACvB,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,OAAO,EACR,qBAAkB;AACnB,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,EACN,SAAS,EACV,oBAAiB;AAElB,qBAAa,KAAM,SAAQ,WAAW;IACpC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;CAC/D;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/users/users.js.map

@@ -1 +1 @@
-{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,yEAAgD;AAChD,kDASuB;AACvB,iEAAwC;AACxC,0CAOmB;AACnB,+DAAsC;AACtC,wCASkB;AAElB,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CAAA;AAJD,sBAIC;AAED,KAAK,CAAC,WAAW,GAAG,yBAAW,CAAC;AAChC,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC;AACxB,KAAK,CAAC,MAAM,GAAG,eAAM,CAAC"}
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,yEAAgD;AAChD,kDAeuB;AACvB,iEAAwC;AACxC,0CAOmB;AACnB,+DAAsC;AACtC,wCASkB;AAElB,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CAAA;AAJD,sBAIC;AAED,KAAK,CAAC,WAAW,GAAG,yBAAW,CAAC;AAChC,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC;AACxB,KAAK,CAAC,MAAM,GAAG,eAAM,CAAC"}

package/resources/users/users.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAOL,WAAW,GAEZ,0BAAsB;AACvB,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAML,OAAO,GACR,sBAAkB;AACnB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAOL,MAAM,GAEP,qBAAiB;AAElB,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CAAA;AAED,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;AAChC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;AACxB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAaL,WAAW,GAEZ,0BAAsB;AACvB,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAML,OAAO,GACR,sBAAkB;AACnB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAOL,MAAM,GAEP,qBAAiB;AAElB,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CAAA;AAED,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;AAChC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;AACxB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC"}

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

@@ -0,0 +1,3 @@
+export { Topics, type TopicCreateParams, type TopicRetrieveParams, type TopicArchiveParams, type TopicReplaceParams, } from "./topics.mjs";
+export { WorkspacePreferences, type PublishPreferencesRequest, type PublishPreferencesResponse, type WorkspacePreferenceCreateRequest, type WorkspacePreferenceGetResponse, type WorkspacePreferenceListResponse, type WorkspacePreferenceReplaceRequest, type WorkspacePreferenceTopicCreateRequest, type WorkspacePreferenceTopicGetResponse, type WorkspacePreferenceTopicListResponse, type WorkspacePreferenceTopicReplaceRequest, type WorkspacePreferenceCreateParams, type WorkspacePreferencePublishParams, type WorkspacePreferenceReplaceParams, } from "./workspace-preferences.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,MAAM,EACN,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,qBAAiB;AAClB,OAAO,EACL,oBAAoB,EACpB,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACnC,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACtC,KAAK,qCAAqC,EAC1C,KAAK,mCAAmC,EACxC,KAAK,oCAAoC,EACzC,KAAK,sCAAsC,EAC3C,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,gCAAgC,GACtC,oCAAgC"}

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

@@ -0,0 +1,3 @@
+export { Topics, type TopicCreateParams, type TopicRetrieveParams, type TopicArchiveParams, type TopicReplaceParams, } from "./topics.js";
+export { WorkspacePreferences, type PublishPreferencesRequest, type PublishPreferencesResponse, type WorkspacePreferenceCreateRequest, type WorkspacePreferenceGetResponse, type WorkspacePreferenceListResponse, type WorkspacePreferenceReplaceRequest, type WorkspacePreferenceTopicCreateRequest, type WorkspacePreferenceTopicGetResponse, type WorkspacePreferenceTopicListResponse, type WorkspacePreferenceTopicReplaceRequest, type WorkspacePreferenceCreateParams, type WorkspacePreferencePublishParams, type WorkspacePreferenceReplaceParams, } from "./workspace-preferences.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,MAAM,EACN,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,oBAAiB;AAClB,OAAO,EACL,oBAAoB,EACpB,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACnC,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACtC,KAAK,qCAAqC,EAC1C,KAAK,mCAAmC,EACxC,KAAK,oCAAoC,EACzC,KAAK,sCAAsC,EAC3C,KAAK,+BAA+B,EACpC,KAAK,gCAAgC,EACrC,KAAK,gCAAgC,GACtC,mCAAgC"}

package/resources/workspace-preferences/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspacePreferences = exports.Topics = void 0;
+var topics_1 = require("./topics.js");
+Object.defineProperty(exports, "Topics", { enumerable: true, get: function () { return topics_1.Topics; } });
+var workspace_preferences_1 = require("./workspace-preferences.js");
+Object.defineProperty(exports, "WorkspacePreferences", { enumerable: true, get: function () { return workspace_preferences_1.WorkspacePreferences; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAMkB;AALhB,gGAAA,MAAM,OAAA;AAMR,oEAeiC;AAd/B,6HAAA,oBAAoB,OAAA"}

package/resources/workspace-preferences/index.mjs

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,MAAM,GAKP,qBAAiB;AAClB,OAAO,EACL,oBAAoB,GAcrB,oCAAgC"}

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"}