featurebase-node 0.0.2

package/resources/contacts/email-preferences.d.mts

@@ -0,0 +1,334 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as EmailPreferencesAPI from "./email-preferences.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
+ */
+export declare class EmailPreferences extends APIResource {
+    /**
+     * Retrieves the email preference state for a customer contact by their Featurebase
+     * ID.
+     *
+     * **Important:** This endpoint only supports customer contacts. Leads do not have
+     * a customer email preference surface in the public API.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase contact ID (24-character ObjectId)
+     *
+     * ### Response Format
+     *
+     * Returns a contact email preferences object with:
+     *
+     * - `object` - Always "contact_email_preferences"
+     * - `contactId` - Featurebase contact ID
+     * - `userId` - External user ID, if available
+     * - `email` - Contact email address, if available
+     * - `preferences` - Current email preference state
+     *
+     * ### Preference Semantics
+     *
+     * Each preference includes:
+     *
+     * - `status` - The stored preference state for that category
+     * - `effectiveStatus` - The final state after applying the global `all` preference
+     *   override
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "contact_email_preferences",
+     *   "contactId": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "preferences": {
+     *     "all": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "postUpdates": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "postComments": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "commentReplies": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "changelog": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferencesOutput =
+     *   await client.contacts.emailPreferences.retrieve(
+     *     '507f1f77bcf86cd799439011',
+     *   );
+     * ```
+     */
+    retrieve(id: string, params?: EmailPreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferencesOutput>;
+    /**
+     * Updates one or more email preferences for a customer contact by their
+     * Featurebase ID.
+     *
+     * **Important:** This endpoint only supports customer contacts. Leads do not have
+     * a customer email preference surface in the public API.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase contact ID (24-character ObjectId)
+     *
+     * ### Request Body
+     *
+     * - `preferences` - A partial map of preference keys to their desired stored
+     *   status. Only the preferences included in the request are updated; any
+     *   preferences omitted are left unchanged. At least one preference must be
+     *   provided.
+     *
+     * ### Supported Preference Keys
+     *
+     * - `all` - Master delivery gate. When `unsubscribed`, the contact will not
+     *   receive any emails regardless of the per-category values. Per-category values
+     *   are still persisted, so flipping `all` back to `subscribed` restores the
+     *   contact's previous granular preferences.
+     * - `postUpdates` - Status changes and updates on posts the contact interacts
+     *   with.
+     * - `postComments` - New comments on posts the contact follows.
+     * - `commentReplies` - Replies to the contact's own comments.
+     * - `changelog` - New changelog releases.
+     *
+     * ### Per-key Values
+     *
+     * - `subscribed` - The contact will receive this email category (subject to the
+     *   `all` gate).
+     * - `unsubscribed` - The contact will not receive this email category.
+     *
+     * ### Combining `all` with per-category keys
+     *
+     * You can send `all` together with any per-category keys in the same request. The
+     * full map is applied atomically as the contact's new stored state — there is no
+     * implicit reset of the other keys. This makes the endpoint safe for
+     * preference-center UIs that POST the entire form state on submit.
+     *
+     * The computed per-category result (after applying the `all` gate) is surfaced as
+     * `effectiveStatus` in the response, while `status` reflects the value actually
+     * stored for that key.
+     *
+     * ### Example Request (partial update)
+     *
+     * ```json
+     * {
+     *   "preferences": {
+     *     "postUpdates": "unsubscribed",
+     *     "changelog": "subscribed"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Request (full preference-center submit)
+     *
+     * ```json
+     * {
+     *   "preferences": {
+     *     "all": "subscribed",
+     *     "postUpdates": "subscribed",
+     *     "postComments": "unsubscribed",
+     *     "commentReplies": "unsubscribed",
+     *     "changelog": "unsubscribed"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "contact_email_preferences",
+     *   "contactId": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "preferences": {
+     *     "all": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "subscribed"
+     *     },
+     *     "postUpdates": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "subscribed"
+     *     },
+     *     "postComments": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "commentReplies": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "changelog": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferencesOutput =
+     *   await client.contacts.emailPreferences.update(
+     *     '507f1f77bcf86cd799439011',
+     *     { preferences: {} },
+     *   );
+     * ```
+     */
+    update(id: string, params: EmailPreferenceUpdateParams, options?: RequestOptions): APIPromise<PreferencesOutput>;
+}
+/**
+ * Global email preference state for all email notifications.
+ */
+export interface PreferenceState {
+    /**
+     * Final effective status after applying global preference overrides
+     */
+    effectiveStatus: 'subscribed' | 'unsubscribed';
+    /**
+     * Stored preference status for this category
+     */
+    status: 'subscribed' | 'unsubscribed';
+}
+export interface PreferencesOutput {
+    /**
+     * Featurebase contact ID
+     */
+    contactId: string;
+    /**
+     * Object type identifier
+     */
+    object: 'contact_email_preferences';
+    /**
+     * Email preference state for this contact, including both stored status and final
+     * effective status.
+     */
+    preferences: PreferencesOutput.Preferences;
+    /**
+     * Contact email address, if available
+     */
+    email?: string | null;
+    /**
+     * External user ID from your system, if available
+     */
+    userId?: string | null;
+}
+export declare namespace PreferencesOutput {
+    /**
+     * Email preference state for this contact, including both stored status and final
+     * effective status.
+     */
+    interface Preferences {
+        /**
+         * Global email preference state for all email notifications.
+         */
+        all: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        changelog: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        commentReplies: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        postComments: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        postUpdates: EmailPreferencesAPI.PreferenceState;
+    }
+}
+export interface UpdatePreferenceBody {
+    preferences: UpdatePreferenceBody.Preferences;
+}
+export declare namespace UpdatePreferenceBody {
+    interface Preferences {
+        /**
+         * Master delivery gate. When `unsubscribed`, the contact receives no emails
+         * regardless of the per-category values. Per-category values are preserved.
+         */
+        all?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new changelog release notifications.
+         */
+        changelog?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for replies to the contact’s own comments.
+         */
+        commentReplies?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new comments on posts the contact follows.
+         */
+        postComments?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for post status changes and updates on posts the contact follows.
+         */
+        postUpdates?: 'subscribed' | 'unsubscribed';
+    }
+}
+export interface EmailPreferenceRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface EmailPreferenceUpdateParams {
+    /**
+     * Body param
+     */
+    preferences: EmailPreferenceUpdateParams.Preferences;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace EmailPreferenceUpdateParams {
+    interface Preferences {
+        /**
+         * Master delivery gate. When `unsubscribed`, the contact receives no emails
+         * regardless of the per-category values. Per-category values are preserved.
+         */
+        all?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new changelog release notifications.
+         */
+        changelog?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for replies to the contact’s own comments.
+         */
+        commentReplies?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new comments on posts the contact follows.
+         */
+        postComments?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for post status changes and updates on posts the contact follows.
+         */
+        postUpdates?: 'subscribed' | 'unsubscribed';
+    }
+}
+export declare namespace EmailPreferences {
+    export { type PreferenceState as PreferenceState, type PreferencesOutput as PreferencesOutput, type UpdatePreferenceBody as UpdatePreferenceBody, type EmailPreferenceRetrieveParams as EmailPreferenceRetrieveParams, type EmailPreferenceUpdateParams as EmailPreferenceUpdateParams, };
+}
+//# sourceMappingURL=email-preferences.d.mts.map

package/resources/contacts/email-preferences.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-preferences.d.mts","sourceRoot":"","sources":["../../src/resources/contacts/email-preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAWhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiHG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAWjC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,YAAY,GAAG,cAAc,CAAC;IAE/C;;OAEG;IACH,MAAM,EAAE,YAAY,GAAG,cAAc,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IAEpC;;;OAGG;IACH,WAAW,EAAE,iBAAiB,CAAC,WAAW,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,GAAG,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAEzC;;WAEG;QACH,SAAS,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAE/C;;WAEG;QACH,cAAc,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAEpD;;WAEG;QACH,YAAY,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAElD;;WAEG;QACH,WAAW,EAAE,mBAAmB,CAAC,eAAe,CAAC;KAClD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,oBAAoB,CAAC,WAAW,CAAC;CAC/C;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,WAAW;QAC1B;;;WAGG;QACH,GAAG,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAEpC;;WAEG;QACH,SAAS,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE1C;;WAEG;QACH,cAAc,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE/C;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE7C;;WAEG;QACH,WAAW,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,2BAA2B,CAAC,WAAW,CAAC;IAErD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,WAAW;QAC1B;;;WAGG;QACH,GAAG,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAEpC;;WAEG;QACH,SAAS,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE1C;;WAEG;QACH,cAAc,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE/C;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE7C;;WAEG;QACH,WAAW,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;KAC7C;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/contacts/email-preferences.d.ts

@@ -0,0 +1,334 @@
+import { APIResource } from "../../core/resource.js";
+import * as EmailPreferencesAPI from "./email-preferences.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
+ */
+export declare class EmailPreferences extends APIResource {
+    /**
+     * Retrieves the email preference state for a customer contact by their Featurebase
+     * ID.
+     *
+     * **Important:** This endpoint only supports customer contacts. Leads do not have
+     * a customer email preference surface in the public API.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase contact ID (24-character ObjectId)
+     *
+     * ### Response Format
+     *
+     * Returns a contact email preferences object with:
+     *
+     * - `object` - Always "contact_email_preferences"
+     * - `contactId` - Featurebase contact ID
+     * - `userId` - External user ID, if available
+     * - `email` - Contact email address, if available
+     * - `preferences` - Current email preference state
+     *
+     * ### Preference Semantics
+     *
+     * Each preference includes:
+     *
+     * - `status` - The stored preference state for that category
+     * - `effectiveStatus` - The final state after applying the global `all` preference
+     *   override
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "contact_email_preferences",
+     *   "contactId": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "preferences": {
+     *     "all": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "postUpdates": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "postComments": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "commentReplies": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "changelog": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferencesOutput =
+     *   await client.contacts.emailPreferences.retrieve(
+     *     '507f1f77bcf86cd799439011',
+     *   );
+     * ```
+     */
+    retrieve(id: string, params?: EmailPreferenceRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<PreferencesOutput>;
+    /**
+     * Updates one or more email preferences for a customer contact by their
+     * Featurebase ID.
+     *
+     * **Important:** This endpoint only supports customer contacts. Leads do not have
+     * a customer email preference surface in the public API.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase contact ID (24-character ObjectId)
+     *
+     * ### Request Body
+     *
+     * - `preferences` - A partial map of preference keys to their desired stored
+     *   status. Only the preferences included in the request are updated; any
+     *   preferences omitted are left unchanged. At least one preference must be
+     *   provided.
+     *
+     * ### Supported Preference Keys
+     *
+     * - `all` - Master delivery gate. When `unsubscribed`, the contact will not
+     *   receive any emails regardless of the per-category values. Per-category values
+     *   are still persisted, so flipping `all` back to `subscribed` restores the
+     *   contact's previous granular preferences.
+     * - `postUpdates` - Status changes and updates on posts the contact interacts
+     *   with.
+     * - `postComments` - New comments on posts the contact follows.
+     * - `commentReplies` - Replies to the contact's own comments.
+     * - `changelog` - New changelog releases.
+     *
+     * ### Per-key Values
+     *
+     * - `subscribed` - The contact will receive this email category (subject to the
+     *   `all` gate).
+     * - `unsubscribed` - The contact will not receive this email category.
+     *
+     * ### Combining `all` with per-category keys
+     *
+     * You can send `all` together with any per-category keys in the same request. The
+     * full map is applied atomically as the contact's new stored state — there is no
+     * implicit reset of the other keys. This makes the endpoint safe for
+     * preference-center UIs that POST the entire form state on submit.
+     *
+     * The computed per-category result (after applying the `all` gate) is surfaced as
+     * `effectiveStatus` in the response, while `status` reflects the value actually
+     * stored for that key.
+     *
+     * ### Example Request (partial update)
+     *
+     * ```json
+     * {
+     *   "preferences": {
+     *     "postUpdates": "unsubscribed",
+     *     "changelog": "subscribed"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Request (full preference-center submit)
+     *
+     * ```json
+     * {
+     *   "preferences": {
+     *     "all": "subscribed",
+     *     "postUpdates": "subscribed",
+     *     "postComments": "unsubscribed",
+     *     "commentReplies": "unsubscribed",
+     *     "changelog": "unsubscribed"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "contact_email_preferences",
+     *   "contactId": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "preferences": {
+     *     "all": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "subscribed"
+     *     },
+     *     "postUpdates": {
+     *       "status": "subscribed",
+     *       "effectiveStatus": "subscribed"
+     *     },
+     *     "postComments": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "commentReplies": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     },
+     *     "changelog": {
+     *       "status": "unsubscribed",
+     *       "effectiveStatus": "unsubscribed"
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferencesOutput =
+     *   await client.contacts.emailPreferences.update(
+     *     '507f1f77bcf86cd799439011',
+     *     { preferences: {} },
+     *   );
+     * ```
+     */
+    update(id: string, params: EmailPreferenceUpdateParams, options?: RequestOptions): APIPromise<PreferencesOutput>;
+}
+/**
+ * Global email preference state for all email notifications.
+ */
+export interface PreferenceState {
+    /**
+     * Final effective status after applying global preference overrides
+     */
+    effectiveStatus: 'subscribed' | 'unsubscribed';
+    /**
+     * Stored preference status for this category
+     */
+    status: 'subscribed' | 'unsubscribed';
+}
+export interface PreferencesOutput {
+    /**
+     * Featurebase contact ID
+     */
+    contactId: string;
+    /**
+     * Object type identifier
+     */
+    object: 'contact_email_preferences';
+    /**
+     * Email preference state for this contact, including both stored status and final
+     * effective status.
+     */
+    preferences: PreferencesOutput.Preferences;
+    /**
+     * Contact email address, if available
+     */
+    email?: string | null;
+    /**
+     * External user ID from your system, if available
+     */
+    userId?: string | null;
+}
+export declare namespace PreferencesOutput {
+    /**
+     * Email preference state for this contact, including both stored status and final
+     * effective status.
+     */
+    interface Preferences {
+        /**
+         * Global email preference state for all email notifications.
+         */
+        all: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        changelog: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        commentReplies: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        postComments: EmailPreferencesAPI.PreferenceState;
+        /**
+         * Global email preference state for all email notifications.
+         */
+        postUpdates: EmailPreferencesAPI.PreferenceState;
+    }
+}
+export interface UpdatePreferenceBody {
+    preferences: UpdatePreferenceBody.Preferences;
+}
+export declare namespace UpdatePreferenceBody {
+    interface Preferences {
+        /**
+         * Master delivery gate. When `unsubscribed`, the contact receives no emails
+         * regardless of the per-category values. Per-category values are preserved.
+         */
+        all?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new changelog release notifications.
+         */
+        changelog?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for replies to the contact’s own comments.
+         */
+        commentReplies?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new comments on posts the contact follows.
+         */
+        postComments?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for post status changes and updates on posts the contact follows.
+         */
+        postUpdates?: 'subscribed' | 'unsubscribed';
+    }
+}
+export interface EmailPreferenceRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface EmailPreferenceUpdateParams {
+    /**
+     * Body param
+     */
+    preferences: EmailPreferenceUpdateParams.Preferences;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace EmailPreferenceUpdateParams {
+    interface Preferences {
+        /**
+         * Master delivery gate. When `unsubscribed`, the contact receives no emails
+         * regardless of the per-category values. Per-category values are preserved.
+         */
+        all?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new changelog release notifications.
+         */
+        changelog?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for replies to the contact’s own comments.
+         */
+        commentReplies?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for new comments on posts the contact follows.
+         */
+        postComments?: 'subscribed' | 'unsubscribed';
+        /**
+         * Stored status for post status changes and updates on posts the contact follows.
+         */
+        postUpdates?: 'subscribed' | 'unsubscribed';
+    }
+}
+export declare namespace EmailPreferences {
+    export { type PreferenceState as PreferenceState, type PreferencesOutput as PreferencesOutput, type UpdatePreferenceBody as UpdatePreferenceBody, type EmailPreferenceRetrieveParams as EmailPreferenceRetrieveParams, type EmailPreferenceUpdateParams as EmailPreferenceUpdateParams, };
+}
+//# sourceMappingURL=email-preferences.d.ts.map

package/resources/contacts/email-preferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/contacts/email-preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAWhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiHG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAWjC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,YAAY,GAAG,cAAc,CAAC;IAE/C;;OAEG;IACH,MAAM,EAAE,YAAY,GAAG,cAAc,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IAEpC;;;OAGG;IACH,WAAW,EAAE,iBAAiB,CAAC,WAAW,CAAC;IAE3C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,GAAG,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAEzC;;WAEG;QACH,SAAS,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAE/C;;WAEG;QACH,cAAc,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAEpD;;WAEG;QACH,YAAY,EAAE,mBAAmB,CAAC,eAAe,CAAC;QAElD;;WAEG;QACH,WAAW,EAAE,mBAAmB,CAAC,eAAe,CAAC;KAClD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,oBAAoB,CAAC,WAAW,CAAC;CAC/C;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,WAAW;QAC1B;;;WAGG;QACH,GAAG,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAEpC;;WAEG;QACH,SAAS,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE1C;;WAEG;QACH,cAAc,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE/C;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE7C;;WAEG;QACH,WAAW,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,2BAA2B,CAAC,WAAW,CAAC;IAErD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,WAAW;QAC1B;;;WAGG;QACH,GAAG,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAEpC;;WAEG;QACH,SAAS,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE1C;;WAEG;QACH,cAAc,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE/C;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;QAE7C;;WAEG;QACH,WAAW,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;KAC7C;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}