featurebase-node 0.0.2

package/resources/contacts/by-user-id/email-preferences.mjs

@@ -0,0 +1,172 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { buildHeaders } from "../../../internal/headers.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
+ */
+export class EmailPreferences extends APIResource {
+    /**
+     * Retrieves the email preference state for a customer contact by their external
+     * user ID.
+     *
+     * This endpoint only supports customer contacts and mirrors the existing
+     * `by-user-id` lookup pattern used across the contact API.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system
+     *
+     * ### 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.byUserID.emailPreferences.retrieve(
+     *     'usr_12345',
+     *   );
+     * ```
+     */
+    retrieve(userID, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/contacts/by-user-id/${userID}/email-preferences`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Updates one or more email preferences for a customer contact by their external
+     * user ID.
+     *
+     * This endpoint only supports customer contacts and mirrors the existing
+     * `by-user-id` lookup pattern used across the contact API.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system
+     *
+     * ### 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.
+     *
+     * See `PATCH /v2/contacts/{id}/email-preferences` for the full list of supported
+     * preference keys and per-key values, the `all` delivery-gate semantics, and
+     * details on combining `all` with per-category keys in a single request.
+     *
+     * ### 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.byUserID.emailPreferences.update(
+     *     'usr_12345',
+     *     { preferences: {} },
+     *   );
+     * ```
+     */
+    update(userID, params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.patch(path `/v2/contacts/by-user-id/${userID}/email-preferences`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=email-preferences.mjs.map

package/resources/contacts/by-user-id/email-preferences.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-preferences.mjs","sourceRoot":"","sources":["../../../src/resources/contacts/by-user-id/email-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,QAAQ,CACN,MAAc,EACd,SAA2D,EAAE,EAC7D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,MAAM,oBAAoB,EAAE;YACjF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwFG;IACH,MAAM,CACJ,MAAc,EACd,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,2BAA2B,MAAM,oBAAoB,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/contacts/by-user-id/index.d.mts

@@ -0,0 +1,3 @@
+export { ByUserID, type ByUserIDRetrieveResponse, type ByUserIDRetrieveParams, type ByUserIDDeleteParams, } from "./by-user-id.mjs";
+export { EmailPreferences, type EmailPreferenceRetrieveParams, type EmailPreferenceUpdateParams, } from "./email-preferences.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/contacts/by-user-id/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/contacts/by-user-id/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B;OACM,EACL,gBAAgB,EAChB,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,GACjC"}

package/resources/contacts/by-user-id/index.d.ts

@@ -0,0 +1,3 @@
+export { ByUserID, type ByUserIDRetrieveResponse, type ByUserIDRetrieveParams, type ByUserIDDeleteParams, } from "./by-user-id.js";
+export { EmailPreferences, type EmailPreferenceRetrieveParams, type EmailPreferenceUpdateParams, } from "./email-preferences.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/contacts/by-user-id/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/contacts/by-user-id/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B;OACM,EACL,gBAAgB,EAChB,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,GACjC"}

package/resources/contacts/by-user-id/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailPreferences = exports.ByUserID = void 0;
+var by_user_id_1 = require("./by-user-id.js");
+Object.defineProperty(exports, "ByUserID", { enumerable: true, get: function () { return by_user_id_1.ByUserID; } });
+var email_preferences_1 = require("./email-preferences.js");
+Object.defineProperty(exports, "EmailPreferences", { enumerable: true, get: function () { return email_preferences_1.EmailPreferences; } });
+//# sourceMappingURL=index.js.map

package/resources/contacts/by-user-id/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/contacts/by-user-id/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAKsB;AAJpB,sGAAA,QAAQ,OAAA;AAKV,4DAI6B;AAH3B,qHAAA,gBAAgB,OAAA"}

package/resources/contacts/by-user-id/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { ByUserID, } from "./by-user-id.mjs";
+export { EmailPreferences, } from "./email-preferences.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/contacts/by-user-id/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/contacts/by-user-id/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,QAAQ,GAIT;OACM,EACL,gBAAgB,GAGjB"}

package/resources/contacts/by-user-id.d.mts

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

package/resources/contacts/by-user-id.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"by-user-id.d.mts","sourceRoot":"","sources":["../../src/resources/contacts/by-user-id.ts"],"names":[],"mappings":""}

package/resources/contacts/by-user-id.d.ts

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

package/resources/contacts/by-user-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"by-user-id.d.ts","sourceRoot":"","sources":["../../src/resources/contacts/by-user-id.ts"],"names":[],"mappings":""}

package/resources/contacts/by-user-id.js

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

package/resources/contacts/by-user-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"by-user-id.js","sourceRoot":"","sources":["../../src/resources/contacts/by-user-id.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gEAAmC"}

package/resources/contacts/by-user-id.mjs

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

package/resources/contacts/by-user-id.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"by-user-id.mjs","sourceRoot":"","sources":["../../src/resources/contacts/by-user-id.ts"],"names":[],"mappings":"AAAA,sFAAsF"}