@trycourier/courier 7.21.0 → 7.23.0

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

@@ -1 +1 @@
-{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAK5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAK3C;;;;;;;;;;;OAWG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;;;;OAUG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAK9C;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAQrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAEpD,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;IAEjC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAExC,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEhC,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE5D,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;IAElD;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,qCAAqC;IACpD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,mCAAmC,CAAC,KAAK,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mCAAmC,CAAC;IACnD,UAAiB,KAAK;QACpB,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAEhC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;QAE5D,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,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;CACH"}
+{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAK5C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAuB3C;;;;;;;;;;OAUG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;;;;;OAWG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAK9C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAQrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAEpD,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;IAEjC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAExC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;IAElD;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,qCAAqC;IACpD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAErD;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,mCAAmC,CAAC,KAAK,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mCAAmC,CAAC;IACnD,UAAiB,KAAK;QACpB;;;;WAIG;QACH,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAEhC;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;QAE5D;;;WAGG;QACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,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;CACH"}

package/resources/users/preferences.js

@@ -5,9 +5,13 @@ exports.Preferences = void 0;
 const resource_1 = require("../../core/resource.js");
 const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
+/**
+ * Read and write a single user's notification preferences, per topic and per channel.
+ */
 class Preferences extends resource_1.APIResource {
     /**
-     * Fetch all user preferences.
+     * Returns a user's preference overrides with paging, one entry per subscription
+     * topic they have set a choice for.
      *
      * @example
      * ```ts
@@ -20,23 +24,8 @@ class Preferences extends resource_1.APIResource {
         return this._client.get((0, path_1.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.
+     * Replaces a user's entire set of preference overrides. Any topic you leave out is
+     * reset to its default, so send the full set rather than a subset.
      *
      * @example
      * ```ts
@@ -60,23 +49,8 @@ class Preferences extends resource_1.APIResource {
         return this._client.put((0, path_1.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.
+     * Adds or updates a user's preferences for several subscription topics at once.
+     * Topics you leave out keep whatever they were set to before.
      *
      * @example
      * ```ts
@@ -100,13 +74,25 @@ class Preferences extends resource_1.APIResource {
      * ```
      */
     bulkUpdate(userID, params, options) {
-        const { tenant_id, ...body } = params;
-        return this._client.post((0, path_1.path) `/users/${userID}/preferences`, { query: { tenant_id }, body, ...options });
+        const { tenant_id, 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
+        return this._client.post((0, path_1.path) `/users/${userID}/preferences`, {
+            query: { tenant_id },
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xIdempotencyExpiration != null ?
+                        { 'x-idempotency-expiration': xIdempotencyExpiration }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * 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.
+     * Removes a user's override for one subscription topic, resetting it to the
+     * effective default from the tenant or workspace.
      *
      * @example
      * ```ts
@@ -124,7 +110,8 @@ class Preferences extends resource_1.APIResource {
         });
     }
     /**
-     * Fetch user preferences for a specific subscription topic.
+     * Returns a user's opt-in status and channel choices for one subscription topic,
+     * or the effective default if they have set no override.
      *
      * @example
      * ```ts
@@ -139,7 +126,8 @@ class Preferences extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/users/${user_id}/preferences/${topicID}`, { query, ...options });
     }
     /**
-     * Update or Create user preferences for a specific subscription topic.
+     * Sets a user's opt-in status and channel choices for one subscription topic,
+     * overriding the tenant default for that topic only.
      *
      * @example
      * ```ts

package/resources/users/preferences.js.map

@@ -1 +1 @@
-{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAc,EACd,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,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,IAAA,WAAI,EAAA,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,IAAA,WAAI,EAAA,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,IAAA,WAAI,EAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACzE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,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,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,IAAA,WAAI,EAAA,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,IAAA,WAAI,EAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACtE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA7LD,kCA6LC"}
+{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAc,EACd,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;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,IAAA,WAAI,EAAA,UAAU,MAAM,cAAc,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,UAAU,CACR,MAAc,EACd,MAAkC,EAClC,OAAwB;QAExB,MAAM,EACJ,SAAS,EACT,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,cAAc,EAAE;YAC3D,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;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,IAAA,WAAI,EAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACzE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,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;;;;;;;;;;;OAWG;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,IAAA,WAAI,EAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;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,IAAA,WAAI,EAAA,UAAU,OAAO,gBAAgB,OAAO,EAAE,EAAE;YACtE,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAnLD,kCAmLC"}

package/resources/users/preferences.mjs

@@ -2,9 +2,13 @@
 import { APIResource } from "../../core/resource.mjs";
 import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
+/**
+ * Read and write a single user's notification preferences, per topic and per channel.
+ */
 export class Preferences extends APIResource {
     /**
-     * Fetch all user preferences.
+     * Returns a user's preference overrides with paging, one entry per subscription
+     * topic they have set a choice for.
      *
      * @example
      * ```ts
@@ -17,23 +21,8 @@ export class Preferences extends APIResource {
         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.
+     * Replaces a user's entire set of preference overrides. Any topic you leave out is
+     * reset to its default, so send the full set rather than a subset.
      *
      * @example
      * ```ts
@@ -57,23 +46,8 @@ export class Preferences extends APIResource {
         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.
+     * Adds or updates a user's preferences for several subscription topics at once.
+     * Topics you leave out keep whatever they were set to before.
      *
      * @example
      * ```ts
@@ -97,13 +71,25 @@ export class Preferences extends APIResource {
      * ```
      */
     bulkUpdate(userID, params, options) {
-        const { tenant_id, ...body } = params;
-        return this._client.post(path `/users/${userID}/preferences`, { query: { tenant_id }, body, ...options });
+        const { tenant_id, 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
+        return this._client.post(path `/users/${userID}/preferences`, {
+            query: { tenant_id },
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xIdempotencyExpiration != null ?
+                        { 'x-idempotency-expiration': xIdempotencyExpiration }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
     }
     /**
-     * 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.
+     * Removes a user's override for one subscription topic, resetting it to the
+     * effective default from the tenant or workspace.
      *
      * @example
      * ```ts
@@ -121,7 +107,8 @@ export class Preferences extends APIResource {
         });
     }
     /**
-     * Fetch user preferences for a specific subscription topic.
+     * Returns a user's opt-in status and channel choices for one subscription topic,
+     * or the effective default if they have set no override.
      *
      * @example
      * ```ts
@@ -136,7 +123,8 @@ export class Preferences extends APIResource {
         return this._client.get(path `/users/${user_id}/preferences/${topicID}`, { query, ...options });
     }
     /**
-     * Update or Create user preferences for a specific subscription topic.
+     * Sets a user's opt-in status and channel choices for one subscription topic,
+     * overriding the tenant default for that topic only.
      *
      * @example
      * ```ts

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;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"}
+{"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;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;;;;;OAoBG;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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,UAAU,CACR,MAAc,EACd,MAAkC,EAClC,OAAwB;QAExB,MAAM,EACJ,SAAS,EACT,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE;YAC3D,KAAK,EAAE,EAAE,SAAS,EAAE;YACpB,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;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;;;;;;;;;;;OAWG;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;;;;;;;;;;;;;;;;;;;OAmBG;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/tenants.d.mts

@@ -2,9 +2,13 @@ import { APIResource } from "../../core/resource.mjs";
 import * as TenantsAPI from "../tenants/tenants.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Associate a user with one or more tenants, and read or remove those associations.
+ */
 export declare class Tenants extends APIResource {
     /**
-     * Returns a paginated list of user tenant associations.
+     * Returns the tenants a user belongs to, with cursor paging. A user can belong to
+     * many tenants, each with its own profile and preferences.
      *
      * @example
      * ```ts
@@ -13,9 +17,8 @@ export declare class Tenants extends APIResource {
      */
     list(userID: string, query?: TenantListParams | null | undefined, options?: RequestOptions): APIPromise<TenantListResponse>;
     /**
-     * This endpoint is used to add a user to multiple tenants in one call. A custom
-     * profile can also be supplied for each tenant. This profile will be merged with
-     * the user's main profile when sending to the user with that tenant.
+     * Adds a user to several tenants in one call, each optionally with a per-tenant
+     * profile that overrides their workspace profile.
      *
      * @example
      * ```ts
@@ -26,10 +29,8 @@ export declare class Tenants extends APIResource {
      */
     addMultiple(userID: string, body: TenantAddMultipleParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * This endpoint is used to add a single tenant.
-     *
-     * A custom profile can also be supplied with the tenant. This profile will be
-     * merged with the user's main profile when sending to the user with that tenant.
+     * Adds a user to one tenant, optionally with a tenant-specific profile that
+     * overrides their workspace profile for sends in that tenant.
      *
      * @example
      * ```ts
@@ -40,7 +41,8 @@ export declare class Tenants extends APIResource {
      */
     addSingle(tenantID: string, params: TenantAddSingleParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Removes a user from any tenants they may have been associated with.
+     * Removes a user from every tenant they belong to in one call. Their
+     * workspace-level profile is a separate resource.
      *
      * @example
      * ```ts
@@ -49,7 +51,8 @@ export declare class Tenants extends APIResource {
      */
     removeAll(userID: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * Removes a user from the supplied tenant.
+     * Removes a user from one tenant. Their other tenant memberships and workspace
+     * profile are managed through separate endpoints.
      *
      * @example
      * ```ts

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

@@ -1 +1 @@
-{"version":3,"file":"tenants.d.mts","sourceRoot":"","sources":["../../src/resources/users/tenants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,UAAU,+BAA2B;AACjD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQtG;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAStG;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrE;;;;;;;;;OASG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,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;CACH"}
+{"version":3,"file":"tenants.d.mts","sourceRoot":"","sources":["../../src/resources/users/tenants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,UAAU,+BAA2B;AACjD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQtG;;;;;;;;;;OAUG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAStG;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrE;;;;;;;;;;OAUG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,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;CACH"}

package/resources/users/tenants.d.ts

@@ -2,9 +2,13 @@ import { APIResource } from "../../core/resource.js";
 import * as TenantsAPI from "../tenants/tenants.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Associate a user with one or more tenants, and read or remove those associations.
+ */
 export declare class Tenants extends APIResource {
     /**
-     * Returns a paginated list of user tenant associations.
+     * Returns the tenants a user belongs to, with cursor paging. A user can belong to
+     * many tenants, each with its own profile and preferences.
      *
      * @example
      * ```ts
@@ -13,9 +17,8 @@ export declare class Tenants extends APIResource {
      */
     list(userID: string, query?: TenantListParams | null | undefined, options?: RequestOptions): APIPromise<TenantListResponse>;
     /**
-     * This endpoint is used to add a user to multiple tenants in one call. A custom
-     * profile can also be supplied for each tenant. This profile will be merged with
-     * the user's main profile when sending to the user with that tenant.
+     * Adds a user to several tenants in one call, each optionally with a per-tenant
+     * profile that overrides their workspace profile.
      *
      * @example
      * ```ts
@@ -26,10 +29,8 @@ export declare class Tenants extends APIResource {
      */
     addMultiple(userID: string, body: TenantAddMultipleParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * This endpoint is used to add a single tenant.
-     *
-     * A custom profile can also be supplied with the tenant. This profile will be
-     * merged with the user's main profile when sending to the user with that tenant.
+     * Adds a user to one tenant, optionally with a tenant-specific profile that
+     * overrides their workspace profile for sends in that tenant.
      *
      * @example
      * ```ts
@@ -40,7 +41,8 @@ export declare class Tenants extends APIResource {
      */
     addSingle(tenantID: string, params: TenantAddSingleParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Removes a user from any tenants they may have been associated with.
+     * Removes a user from every tenant they belong to in one call. Their
+     * workspace-level profile is a separate resource.
      *
      * @example
      * ```ts
@@ -49,7 +51,8 @@ export declare class Tenants extends APIResource {
      */
     removeAll(userID: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * Removes a user from the supplied tenant.
+     * Removes a user from one tenant. Their other tenant memberships and workspace
+     * profile are managed through separate endpoints.
      *
      * @example
      * ```ts

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

@@ -1 +1 @@
-{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../../src/resources/users/tenants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,8BAA2B;AACjD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQtG;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAStG;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrE;;;;;;;;;OASG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,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;CACH"}
+{"version":3,"file":"tenants.d.ts","sourceRoot":"","sources":["../../src/resources/users/tenants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,8BAA2B;AACjD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQtG;;;;;;;;;;OAUG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAStG;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrE;;;;;;;;;;OAUG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,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;CACH"}

package/resources/users/tenants.js

@@ -5,9 +5,13 @@ exports.Tenants = void 0;
 const resource_1 = require("../../core/resource.js");
 const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
+/**
+ * Associate a user with one or more tenants, and read or remove those associations.
+ */
 class Tenants extends resource_1.APIResource {
     /**
-     * Returns a paginated list of user tenant associations.
+     * Returns the tenants a user belongs to, with cursor paging. A user can belong to
+     * many tenants, each with its own profile and preferences.
      *
      * @example
      * ```ts
@@ -18,9 +22,8 @@ class Tenants extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/users/${userID}/tenants`, { query, ...options });
     }
     /**
-     * This endpoint is used to add a user to multiple tenants in one call. A custom
-     * profile can also be supplied for each tenant. This profile will be merged with
-     * the user's main profile when sending to the user with that tenant.
+     * Adds a user to several tenants in one call, each optionally with a per-tenant
+     * profile that overrides their workspace profile.
      *
      * @example
      * ```ts
@@ -37,10 +40,8 @@ class Tenants extends resource_1.APIResource {
         });
     }
     /**
-     * This endpoint is used to add a single tenant.
-     *
-     * A custom profile can also be supplied with the tenant. This profile will be
-     * merged with the user's main profile when sending to the user with that tenant.
+     * Adds a user to one tenant, optionally with a tenant-specific profile that
+     * overrides their workspace profile for sends in that tenant.
      *
      * @example
      * ```ts
@@ -58,7 +59,8 @@ class Tenants extends resource_1.APIResource {
         });
     }
     /**
-     * Removes a user from any tenants they may have been associated with.
+     * Removes a user from every tenant they belong to in one call. Their
+     * workspace-level profile is a separate resource.
      *
      * @example
      * ```ts
@@ -72,7 +74,8 @@ class Tenants extends resource_1.APIResource {
         });
     }
     /**
-     * Removes a user from the supplied tenant.
+     * Removes a user from one tenant. Their other tenant memberships and workspace
+     * profile are managed through separate endpoints.
      *
      * @example
      * ```ts

package/resources/users/tenants.js.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/users/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CACF,MAAc,EACd,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAAc,EAAE,IAA6B,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,UAAU,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,QAAgB,EAAE,MAA6B,EAAE,OAAwB;QACjF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACnE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,MAAc,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,UAAU,EAAE;YACzD,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;;;;;;;;;OASG;IACH,YAAY,CACV,QAAgB,EAChB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACtE,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;CACF;AA/FD,0BA+FC"}
+{"version":3,"file":"tenants.js","sourceRoot":"","sources":["../../src/resources/users/tenants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,MAAc,EACd,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAc,EAAE,IAA6B,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,UAAU,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,QAAgB,EAAE,MAA6B,EAAE,OAAwB;QACjF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACnE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAc,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,UAAU,EAAE;YACzD,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,YAAY,CACV,QAAgB,EAChB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACtE,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;CACF;AA/FD,0BA+FC"}

package/resources/users/tenants.mjs

@@ -2,9 +2,13 @@
 import { APIResource } from "../../core/resource.mjs";
 import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
+/**
+ * Associate a user with one or more tenants, and read or remove those associations.
+ */
 export class Tenants extends APIResource {
     /**
-     * Returns a paginated list of user tenant associations.
+     * Returns the tenants a user belongs to, with cursor paging. A user can belong to
+     * many tenants, each with its own profile and preferences.
      *
      * @example
      * ```ts
@@ -15,9 +19,8 @@ export class Tenants extends APIResource {
         return this._client.get(path `/users/${userID}/tenants`, { query, ...options });
     }
     /**
-     * This endpoint is used to add a user to multiple tenants in one call. A custom
-     * profile can also be supplied for each tenant. This profile will be merged with
-     * the user's main profile when sending to the user with that tenant.
+     * Adds a user to several tenants in one call, each optionally with a per-tenant
+     * profile that overrides their workspace profile.
      *
      * @example
      * ```ts
@@ -34,10 +37,8 @@ export class Tenants extends APIResource {
         });
     }
     /**
-     * This endpoint is used to add a single tenant.
-     *
-     * A custom profile can also be supplied with the tenant. This profile will be
-     * merged with the user's main profile when sending to the user with that tenant.
+     * Adds a user to one tenant, optionally with a tenant-specific profile that
+     * overrides their workspace profile for sends in that tenant.
      *
      * @example
      * ```ts
@@ -55,7 +56,8 @@ export class Tenants extends APIResource {
         });
     }
     /**
-     * Removes a user from any tenants they may have been associated with.
+     * Removes a user from every tenant they belong to in one call. Their
+     * workspace-level profile is a separate resource.
      *
      * @example
      * ```ts
@@ -69,7 +71,8 @@ export class Tenants extends APIResource {
         });
     }
     /**
-     * Removes a user from the supplied tenant.
+     * Removes a user from one tenant. Their other tenant memberships and workspace
+     * profile are managed through separate endpoints.
      *
      * @example
      * ```ts

package/resources/users/tenants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/users/tenants.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,IAAI,CACF,MAAc,EACd,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAAc,EAAE,IAA6B,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,UAAU,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,QAAgB,EAAE,MAA6B,EAAE,OAAwB;QACjF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACnE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,MAAc,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,MAAM,UAAU,EAAE;YACzD,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;;;;;;;;;OASG;IACH,YAAY,CACV,QAAgB,EAChB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACtE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"tenants.mjs","sourceRoot":"","sources":["../../src/resources/users/tenants.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;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,IAAI,CACF,MAAc,EACd,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAc,EAAE,IAA6B,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,UAAU,EAAE;YACtD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,QAAgB,EAAE,MAA6B,EAAE,OAAwB;QACjF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACnE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAc,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,MAAM,UAAU,EAAE;YACzD,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,YAAY,CACV,QAAgB,EAChB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,OAAO,YAAY,QAAQ,EAAE,EAAE;YACtE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/users/tokens.d.mts

@@ -1,9 +1,13 @@
 import { APIResource } from "../../core/resource.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Register and manage the APNS and FCM device tokens Courier delivers push notifications to.
+ */
 export declare class Tokens extends APIResource {
     /**
-     * Get single token available for a `:token`
+     * Returns one device token with its provider key, status and status reason, expiry
+     * date, and any properties stored alongside it.
      *
      * @example
      * ```ts
@@ -14,7 +18,8 @@ export declare class Tokens extends APIResource {
      */
     retrieve(token: string, params: TokenRetrieveParams, options?: RequestOptions): APIPromise<TokenRetrieveResponse>;
     /**
-     * Apply a JSON Patch (RFC 6902) to the specified token.
+     * Applies a JSON Patch to a device token, changing its status, expiry, or
+     * properties without re-registering it.
      *
      * @example
      * ```ts
@@ -26,7 +31,8 @@ export declare class Tokens extends APIResource {
      */
     update(token: string, params: TokenUpdateParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Gets all tokens available for a :user_id
+     * Returns every device token registered for a user, each with its provider key,
+     * status, and expiry date.
      *
      * @example
      * ```ts
@@ -35,7 +41,8 @@ export declare class Tokens extends APIResource {
      */
     list(userID: string, options?: RequestOptions): APIPromise<TokenListResponse>;
     /**
-     * Delete User Token
+     * Deletes one device token for a user, addressed by the token value, so push sends
+     * no longer target that device.
      *
      * @example
      * ```ts
@@ -46,7 +53,8 @@ export declare class Tokens extends APIResource {
      */
     delete(token: string, params: TokenDeleteParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Adds multiple tokens to a user and overwrites matching existing tokens.
+     * Registers several device tokens for a user in one call, overwriting any stored
+     * token with a matching value.
      *
      * @example
      * ```ts
@@ -55,7 +63,8 @@ export declare class Tokens extends APIResource {
      */
     addMultiple(userID: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * Adds a single token to a user and overwrites a matching existing token.
+     * Registers one device token for a user against a provider key, overwriting the
+     * token if it already exists. Push sends resolve tokens per user.
      *
      * @example
      * ```ts