@trycourier/courier 7.11.0 → 7.19.2

package/resources/users/preferences.d.mts

@@ -14,6 +14,97 @@ export declare class Preferences extends APIResource {
      * ```
      */
     retrieve(userID: string, query?: PreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferenceRetrieveResponse>;
+    /**
+     * 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: string, params: PreferenceBulkReplaceParams, options?: RequestOptions): APIPromise<PreferenceBulkReplaceResponse>;
+    /**
+     * 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: string, params: PreferenceBulkUpdateParams, options?: RequestOptions): APIPromise<PreferenceBulkUpdateResponse>;
+    /**
+     * 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: string, params: PreferenceDeleteTopicParams, options?: RequestOptions): APIPromise<void>;
     /**
      * Fetch user preferences for a specific subscription topic.
      *
@@ -47,6 +138,19 @@ export declare class Preferences extends APIResource {
      */
     updateOrCreateTopic(topicID: string, params: PreferenceUpdateOrCreateTopicParams, options?: RequestOptions): APIPromise<PreferenceUpdateOrCreateTopicResponse>;
 }
+/**
+ * A single topic override echoed in a bulk preference response.
+ */
+export interface BulkPreferenceTopic {
+    custom_routing: Array<Shared.ChannelClassification>;
+    has_custom_routing: boolean;
+    /**
+     * The applied subscription status. Echoes the requested value, so it is always
+     * OPTED_IN or OPTED_OUT.
+     */
+    status: 'OPTED_IN' | 'OPTED_OUT';
+    topic_id: string;
+}
 export interface TopicPreference {
     default_status: Shared.PreferenceStatus;
     status: Shared.PreferenceStatus;
@@ -68,6 +172,38 @@ export interface PreferenceRetrieveResponse {
      */
     paging: Shared.Paging;
 }
+export interface PreferenceBulkReplaceResponse {
+    /**
+     * The ids of the overrides that were reset to their topic default.
+     */
+    deleted: Array<string>;
+    /**
+     * The complete resulting set of topic overrides for the user.
+     */
+    items: Array<BulkPreferenceTopic>;
+}
+export interface PreferenceBulkUpdateResponse {
+    /**
+     * The topics that could not be applied, each with a reason.
+     */
+    errors: Array<PreferenceBulkUpdateResponse.Error>;
+    /**
+     * The topics that were successfully created or updated.
+     */
+    items: Array<BulkPreferenceTopic>;
+}
+export declare namespace PreferenceBulkUpdateResponse {
+    /**
+     * A single topic that could not be applied in a bulk preference request.
+     */
+    interface Error {
+        /**
+         * A human-readable explanation of why the topic could not be applied.
+         */
+        reason: string;
+        topic_id: string;
+    }
+}
 export interface PreferenceRetrieveTopicResponse {
     topic: TopicPreference;
 }
@@ -80,6 +216,80 @@ export interface PreferenceRetrieveParams {
      */
     tenant_id?: string | null;
 }
+export interface PreferenceBulkReplaceParams {
+    /**
+     * Body param: The complete set of topic overrides for the user. Up to 50 topics
+     * may be provided. Any existing override not listed here is reset to its topic
+     * default; an empty array resets every existing override.
+     */
+    topics: Array<PreferenceBulkReplaceParams.Topic>;
+    /**
+     * Query param: Replace the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export declare namespace PreferenceBulkReplaceParams {
+    interface Topic {
+        /**
+         * The subscription status to apply for this topic.
+         */
+        status: 'OPTED_IN' | 'OPTED_OUT';
+        /**
+         * A unique identifier associated with a subscription topic.
+         */
+        topic_id: string;
+        /**
+         * The channels a user has chosen to receive notifications through for this topic.
+         */
+        custom_routing?: Array<Shared.ChannelClassification>;
+        /**
+         * Whether the recipient has chosen specific delivery channels for this topic.
+         */
+        has_custom_routing?: boolean;
+    }
+}
+export interface PreferenceBulkUpdateParams {
+    /**
+     * Body param: The topics to create or update. Between 1 and 50 topics may be
+     * provided in a single request.
+     */
+    topics: Array<PreferenceBulkUpdateParams.Topic>;
+    /**
+     * Query param: Update the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export declare namespace PreferenceBulkUpdateParams {
+    interface Topic {
+        /**
+         * The subscription status to apply for this topic.
+         */
+        status: 'OPTED_IN' | 'OPTED_OUT';
+        /**
+         * A unique identifier associated with a subscription topic.
+         */
+        topic_id: string;
+        /**
+         * The channels a user has chosen to receive notifications through for this topic.
+         */
+        custom_routing?: Array<Shared.ChannelClassification>;
+        /**
+         * Whether the recipient has chosen specific delivery channels for this topic.
+         */
+        has_custom_routing?: boolean;
+    }
+}
+export interface PreferenceDeleteTopicParams {
+    /**
+     * Path param: A unique identifier associated with the user whose preferences you
+     * wish to delete.
+     */
+    user_id: string;
+    /**
+     * Query param: Delete the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
 export interface PreferenceRetrieveTopicParams {
     /**
      * Path param: A unique identifier associated with the user whose preferences you
@@ -117,6 +327,6 @@ export declare namespace PreferenceUpdateOrCreateTopicParams {
     }
 }
 export declare namespace Preferences {
-    export { 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 { 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, };
 }
 //# sourceMappingURL=preferences.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;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;;;;;;;;;;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,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,+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,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,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;CACH"}
+{"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;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"}

package/resources/users/preferences.d.ts

@@ -14,6 +14,97 @@ export declare class Preferences extends APIResource {
      * ```
      */
     retrieve(userID: string, query?: PreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferenceRetrieveResponse>;
+    /**
+     * 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: string, params: PreferenceBulkReplaceParams, options?: RequestOptions): APIPromise<PreferenceBulkReplaceResponse>;
+    /**
+     * 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: string, params: PreferenceBulkUpdateParams, options?: RequestOptions): APIPromise<PreferenceBulkUpdateResponse>;
+    /**
+     * 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: string, params: PreferenceDeleteTopicParams, options?: RequestOptions): APIPromise<void>;
     /**
      * Fetch user preferences for a specific subscription topic.
      *
@@ -47,6 +138,19 @@ export declare class Preferences extends APIResource {
      */
     updateOrCreateTopic(topicID: string, params: PreferenceUpdateOrCreateTopicParams, options?: RequestOptions): APIPromise<PreferenceUpdateOrCreateTopicResponse>;
 }
+/**
+ * A single topic override echoed in a bulk preference response.
+ */
+export interface BulkPreferenceTopic {
+    custom_routing: Array<Shared.ChannelClassification>;
+    has_custom_routing: boolean;
+    /**
+     * The applied subscription status. Echoes the requested value, so it is always
+     * OPTED_IN or OPTED_OUT.
+     */
+    status: 'OPTED_IN' | 'OPTED_OUT';
+    topic_id: string;
+}
 export interface TopicPreference {
     default_status: Shared.PreferenceStatus;
     status: Shared.PreferenceStatus;
@@ -68,6 +172,38 @@ export interface PreferenceRetrieveResponse {
      */
     paging: Shared.Paging;
 }
+export interface PreferenceBulkReplaceResponse {
+    /**
+     * The ids of the overrides that were reset to their topic default.
+     */
+    deleted: Array<string>;
+    /**
+     * The complete resulting set of topic overrides for the user.
+     */
+    items: Array<BulkPreferenceTopic>;
+}
+export interface PreferenceBulkUpdateResponse {
+    /**
+     * The topics that could not be applied, each with a reason.
+     */
+    errors: Array<PreferenceBulkUpdateResponse.Error>;
+    /**
+     * The topics that were successfully created or updated.
+     */
+    items: Array<BulkPreferenceTopic>;
+}
+export declare namespace PreferenceBulkUpdateResponse {
+    /**
+     * A single topic that could not be applied in a bulk preference request.
+     */
+    interface Error {
+        /**
+         * A human-readable explanation of why the topic could not be applied.
+         */
+        reason: string;
+        topic_id: string;
+    }
+}
 export interface PreferenceRetrieveTopicResponse {
     topic: TopicPreference;
 }
@@ -80,6 +216,80 @@ export interface PreferenceRetrieveParams {
      */
     tenant_id?: string | null;
 }
+export interface PreferenceBulkReplaceParams {
+    /**
+     * Body param: The complete set of topic overrides for the user. Up to 50 topics
+     * may be provided. Any existing override not listed here is reset to its topic
+     * default; an empty array resets every existing override.
+     */
+    topics: Array<PreferenceBulkReplaceParams.Topic>;
+    /**
+     * Query param: Replace the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export declare namespace PreferenceBulkReplaceParams {
+    interface Topic {
+        /**
+         * The subscription status to apply for this topic.
+         */
+        status: 'OPTED_IN' | 'OPTED_OUT';
+        /**
+         * A unique identifier associated with a subscription topic.
+         */
+        topic_id: string;
+        /**
+         * The channels a user has chosen to receive notifications through for this topic.
+         */
+        custom_routing?: Array<Shared.ChannelClassification>;
+        /**
+         * Whether the recipient has chosen specific delivery channels for this topic.
+         */
+        has_custom_routing?: boolean;
+    }
+}
+export interface PreferenceBulkUpdateParams {
+    /**
+     * Body param: The topics to create or update. Between 1 and 50 topics may be
+     * provided in a single request.
+     */
+    topics: Array<PreferenceBulkUpdateParams.Topic>;
+    /**
+     * Query param: Update the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
+export declare namespace PreferenceBulkUpdateParams {
+    interface Topic {
+        /**
+         * The subscription status to apply for this topic.
+         */
+        status: 'OPTED_IN' | 'OPTED_OUT';
+        /**
+         * A unique identifier associated with a subscription topic.
+         */
+        topic_id: string;
+        /**
+         * The channels a user has chosen to receive notifications through for this topic.
+         */
+        custom_routing?: Array<Shared.ChannelClassification>;
+        /**
+         * Whether the recipient has chosen specific delivery channels for this topic.
+         */
+        has_custom_routing?: boolean;
+    }
+}
+export interface PreferenceDeleteTopicParams {
+    /**
+     * Path param: A unique identifier associated with the user whose preferences you
+     * wish to delete.
+     */
+    user_id: string;
+    /**
+     * Query param: Delete the preferences of a user for this specific tenant context.
+     */
+    tenant_id?: string | null;
+}
 export interface PreferenceRetrieveTopicParams {
     /**
      * Path param: A unique identifier associated with the user whose preferences you
@@ -117,6 +327,6 @@ export declare namespace PreferenceUpdateOrCreateTopicParams {
     }
 }
 export declare namespace Preferences {
-    export { 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 { 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, };
 }
 //# sourceMappingURL=preferences.d.ts.map

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;AACpD,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;;;;;;;;;;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,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,+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,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,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;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,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"}

package/resources/users/preferences.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
 class Preferences extends resource_1.APIResource {
     /**
@@ -18,6 +19,110 @@ class Preferences extends resource_1.APIResource {
     retrieve(userID, query = {}, options) {
         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.
+     *
+     * @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((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.
+     *
+     * @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((0, path_1.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((0, path_1.path) `/users/${user_id}/preferences/${topicID}`, {
+            query: { tenant_id },
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
     /**
      * Fetch user preferences for a specific subscription topic.
      *

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;AAIlD,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;;;;;;;;;;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;AAtED,kCAsEC"}
+{"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"}