featurebase-node 0.0.2

package/resources/companies/index.d.ts

@@ -0,0 +1,3 @@
+export { Companies, type Company, type DeletedCompany, type CompanyListResponse, type CompanyRetrieveParams, type CompanyListParams, type CompanyDeleteParams, type CompanyCreateOrUpdateParams, type CompanyDeleteByCompanyIDParams, } from "./companies.js";
+export { Contacts, type ContactAttachResponse, type ContactRemoveResponse, type ContactListParams, type ContactAttachParams, type ContactRemoveParams, } from "./contacts.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/companies/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/companies/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC;OACM,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB"}

package/resources/companies/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.Contacts = exports.Companies = void 0;
+var companies_1 = require("./companies.js");
+Object.defineProperty(exports, "Companies", { enumerable: true, get: function () { return companies_1.Companies; } });
+var contacts_1 = require("./contacts.js");
+Object.defineProperty(exports, "Contacts", { enumerable: true, get: function () { return contacts_1.Contacts; } });
+//# sourceMappingURL=index.js.map

package/resources/companies/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/companies/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CAUqB;AATnB,sGAAA,SAAS,OAAA;AAUX,0CAOoB;AANlB,oGAAA,QAAQ,OAAA"}

package/resources/companies/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Companies, } from "./companies.mjs";
+export { Contacts, } from "./contacts.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/companies/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/companies/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GASV;OACM,EACL,QAAQ,GAMT"}

package/resources/companies.d.mts

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

package/resources/companies.d.mts.map

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

package/resources/companies.d.ts

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

package/resources/companies.d.ts.map

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

package/resources/companies.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("./companies/index.js"), exports);
+//# sourceMappingURL=companies.js.map

package/resources/companies.js.map

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

package/resources/companies.mjs

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

package/resources/companies.mjs.map

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

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

@@ -0,0 +1,147 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as ContactsAPI from "../contacts.mjs";
+import * as EmailPreferencesAPI from "./email-preferences.mjs";
+import { EmailPreferenceRetrieveParams, EmailPreferenceUpdateParams, EmailPreferences } 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 ByUserID extends APIResource {
+    emailPreferences: EmailPreferencesAPI.EmailPreferences;
+    /**
+     * Retrieves a single contact by their external user ID (from your system via SSO).
+     *
+     * **Important:** This endpoint only returns customers (type: "customer"). Leads
+     * are not returned.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system (matched via SSO integration)
+     *
+     * ### Response Format
+     *
+     * Returns a single contact object with:
+     *
+     * - `object` - Always "contact"
+     * - `id` - Unique contact identifier
+     * - `userId` - External user ID from SSO
+     * - `email` - Contact email address
+     * - `name` - Contact display name
+     * - `profilePicture` - Profile picture URL
+     * - `type` - Always "customer" for this endpoint
+     * - `companies` - Array of companies the contact belongs to
+     * - `customFields` - Custom field values
+     * - `postsCreated` - Number of posts created
+     * - `commentsCreated` - Number of comments created
+     * - `lastActivity` - Last activity timestamp
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "object": "contact",
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "name": "John Doe",
+     *   "type": "customer",
+     *   ...
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * This endpoint is useful when you need to look up a contact using your own
+     * system's user identifier, such as when displaying Featurebase data alongside
+     * your user's information in your own application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const byUserID = await client.contacts.byUserID.retrieve(
+     *   'usr_12345',
+     * );
+     * ```
+     */
+    retrieve(userID: string, params?: ByUserIDRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ByUserIDRetrieveResponse>;
+    /**
+     * Permanently deletes a contact by their external user ID.
+     *
+     * **Important:** This endpoint only deletes customers (type: "customer"). Leads
+     * cannot be deleted using this endpoint.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system
+     *
+     * ### Deletion Behavior
+     *
+     * When a contact is deleted:
+     *
+     * - The contact record is permanently removed
+     * - Associated data cleanup is triggered asynchronously
+     * - Comments and posts created by the contact are handled according to retention
+     *   policies
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
+     *
+     * - `id` - The ID of the deleted contact
+     * - `object` - Always "contact"
+     * - `deleted` - Always `true`
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "object": "contact",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * Use this endpoint when you need to delete a contact using your own system's user
+     * identifier, such as when a user deletes their account in your application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const deletedContact =
+     *   await client.contacts.byUserID.delete('usr_12345');
+     * ```
+     */
+    delete(userID: string, params?: ByUserIDDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ContactsAPI.DeletedContact>;
+}
+/**
+ * User who submitted the response
+ */
+export type ByUserIDRetrieveResponse = ContactsAPI.Contact | (null & {});
+export interface ByUserIDRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface ByUserIDDeleteParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace ByUserID {
+    export { type ByUserIDRetrieveResponse as ByUserIDRetrieveResponse, type ByUserIDRetrieveParams as ByUserIDRetrieveParams, type ByUserIDDeleteParams as ByUserIDDeleteParams, };
+    export { EmailPreferences as EmailPreferences, type EmailPreferenceRetrieveParams as EmailPreferenceRetrieveParams, type EmailPreferenceUpdateParams as EmailPreferenceUpdateParams, };
+}
+//# sourceMappingURL=by-user-id.d.mts.map

package/resources/contacts/by-user-id/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/by-user-id.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,mBAAmB;OACxB,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,gBAAgB,EACjB;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAWvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,cAAc,CAAC;CAU1C;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;AAEzE,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

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

@@ -0,0 +1,147 @@
+import { APIResource } from "../../../core/resource.js";
+import * as ContactsAPI from "../contacts.js";
+import * as EmailPreferencesAPI from "./email-preferences.js";
+import { EmailPreferenceRetrieveParams, EmailPreferenceUpdateParams, EmailPreferences } 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 ByUserID extends APIResource {
+    emailPreferences: EmailPreferencesAPI.EmailPreferences;
+    /**
+     * Retrieves a single contact by their external user ID (from your system via SSO).
+     *
+     * **Important:** This endpoint only returns customers (type: "customer"). Leads
+     * are not returned.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system (matched via SSO integration)
+     *
+     * ### Response Format
+     *
+     * Returns a single contact object with:
+     *
+     * - `object` - Always "contact"
+     * - `id` - Unique contact identifier
+     * - `userId` - External user ID from SSO
+     * - `email` - Contact email address
+     * - `name` - Contact display name
+     * - `profilePicture` - Profile picture URL
+     * - `type` - Always "customer" for this endpoint
+     * - `companies` - Array of companies the contact belongs to
+     * - `customFields` - Custom field values
+     * - `postsCreated` - Number of posts created
+     * - `commentsCreated` - Number of comments created
+     * - `lastActivity` - Last activity timestamp
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "object": "contact",
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "name": "John Doe",
+     *   "type": "customer",
+     *   ...
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * This endpoint is useful when you need to look up a contact using your own
+     * system's user identifier, such as when displaying Featurebase data alongside
+     * your user's information in your own application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const byUserID = await client.contacts.byUserID.retrieve(
+     *   'usr_12345',
+     * );
+     * ```
+     */
+    retrieve(userID: string, params?: ByUserIDRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ByUserIDRetrieveResponse>;
+    /**
+     * Permanently deletes a contact by their external user ID.
+     *
+     * **Important:** This endpoint only deletes customers (type: "customer"). Leads
+     * cannot be deleted using this endpoint.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system
+     *
+     * ### Deletion Behavior
+     *
+     * When a contact is deleted:
+     *
+     * - The contact record is permanently removed
+     * - Associated data cleanup is triggered asynchronously
+     * - Comments and posts created by the contact are handled according to retention
+     *   policies
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
+     *
+     * - `id` - The ID of the deleted contact
+     * - `object` - Always "contact"
+     * - `deleted` - Always `true`
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "object": "contact",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * Use this endpoint when you need to delete a contact using your own system's user
+     * identifier, such as when a user deletes their account in your application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const deletedContact =
+     *   await client.contacts.byUserID.delete('usr_12345');
+     * ```
+     */
+    delete(userID: string, params?: ByUserIDDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ContactsAPI.DeletedContact>;
+}
+/**
+ * User who submitted the response
+ */
+export type ByUserIDRetrieveResponse = ContactsAPI.Contact | (null & {});
+export interface ByUserIDRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface ByUserIDDeleteParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace ByUserID {
+    export { type ByUserIDRetrieveResponse as ByUserIDRetrieveResponse, type ByUserIDRetrieveParams as ByUserIDRetrieveParams, type ByUserIDDeleteParams as ByUserIDDeleteParams, };
+    export { EmailPreferences as EmailPreferences, type EmailPreferenceRetrieveParams as EmailPreferenceRetrieveParams, type EmailPreferenceUpdateParams as EmailPreferenceUpdateParams, };
+}
+//# sourceMappingURL=by-user-id.d.ts.map

package/resources/contacts/by-user-id/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/by-user-id.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,mBAAmB;OACxB,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,gBAAgB,EACjB;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAWvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC,cAAc,CAAC;CAU1C;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;AAEzE,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

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

@@ -0,0 +1,152 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ByUserID = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
+const EmailPreferencesAPI = tslib_1.__importStar(require("./email-preferences.js"));
+const email_preferences_1 = require("./email-preferences.js");
+const headers_1 = require("../../../internal/headers.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
+ */
+class ByUserID extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.emailPreferences = new EmailPreferencesAPI.EmailPreferences(this._client);
+    }
+    /**
+     * Retrieves a single contact by their external user ID (from your system via SSO).
+     *
+     * **Important:** This endpoint only returns customers (type: "customer"). Leads
+     * are not returned.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system (matched via SSO integration)
+     *
+     * ### Response Format
+     *
+     * Returns a single contact object with:
+     *
+     * - `object` - Always "contact"
+     * - `id` - Unique contact identifier
+     * - `userId` - External user ID from SSO
+     * - `email` - Contact email address
+     * - `name` - Contact display name
+     * - `profilePicture` - Profile picture URL
+     * - `type` - Always "customer" for this endpoint
+     * - `companies` - Array of companies the contact belongs to
+     * - `customFields` - Custom field values
+     * - `postsCreated` - Number of posts created
+     * - `commentsCreated` - Number of comments created
+     * - `lastActivity` - Last activity timestamp
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "object": "contact",
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "name": "John Doe",
+     *   "type": "customer",
+     *   ...
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * This endpoint is useful when you need to look up a contact using your own
+     * system's user identifier, such as when displaying Featurebase data alongside
+     * your user's information in your own application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const byUserID = await client.contacts.byUserID.retrieve(
+     *   'usr_12345',
+     * );
+     * ```
+     */
+    retrieve(userID, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/contacts/by-user-id/${userID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Permanently deletes a contact by their external user ID.
+     *
+     * **Important:** This endpoint only deletes customers (type: "customer"). Leads
+     * cannot be deleted using this endpoint.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system
+     *
+     * ### Deletion Behavior
+     *
+     * When a contact is deleted:
+     *
+     * - The contact record is permanently removed
+     * - Associated data cleanup is triggered asynchronously
+     * - Comments and posts created by the contact are handled according to retention
+     *   policies
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
+     *
+     * - `id` - The ID of the deleted contact
+     * - `object` - Always "contact"
+     * - `deleted` - Always `true`
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "object": "contact",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * Use this endpoint when you need to delete a contact using your own system's user
+     * identifier, such as when a user deletes their account in your application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const deletedContact =
+     *   await client.contacts.byUserID.delete('usr_12345');
+     * ```
+     */
+    delete(userID, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.delete((0, path_1.path) `/v2/contacts/by-user-id/${userID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.ByUserID = ByUserID;
+ByUserID.EmailPreferences = email_preferences_1.EmailPreferences;
+//# sourceMappingURL=by-user-id.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"by-user-id.js","sourceRoot":"","sources":["../../../src/resources/contacts/by-user-id/by-user-id.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAErD,oFAA2D;AAC3D,8DAI6B;AAE7B,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IA6IJ,CAAC;IA3IC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,QAAQ,CACN,MAAc,EACd,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,MAAM,EAAE,EAAE;YAC/D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,MAAM,CACJ,MAAc,EACd,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,2BAA2B,MAAM,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;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;AAhJD,4BAgJC;AAuBD,QAAQ,CAAC,gBAAgB,GAAG,oCAAgB,CAAC"}

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

@@ -0,0 +1,147 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import * as EmailPreferencesAPI from "./email-preferences.mjs";
+import { EmailPreferences, } from "./email-preferences.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 ByUserID extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.emailPreferences = new EmailPreferencesAPI.EmailPreferences(this._client);
+    }
+    /**
+     * Retrieves a single contact by their external user ID (from your system via SSO).
+     *
+     * **Important:** This endpoint only returns customers (type: "customer"). Leads
+     * are not returned.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system (matched via SSO integration)
+     *
+     * ### Response Format
+     *
+     * Returns a single contact object with:
+     *
+     * - `object` - Always "contact"
+     * - `id` - Unique contact identifier
+     * - `userId` - External user ID from SSO
+     * - `email` - Contact email address
+     * - `name` - Contact display name
+     * - `profilePicture` - Profile picture URL
+     * - `type` - Always "customer" for this endpoint
+     * - `companies` - Array of companies the contact belongs to
+     * - `customFields` - Custom field values
+     * - `postsCreated` - Number of posts created
+     * - `commentsCreated` - Number of comments created
+     * - `lastActivity` - Last activity timestamp
+     *
+     * ### Example
+     *
+     * ```json
+     * {
+     *   "object": "contact",
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "userId": "usr_12345",
+     *   "email": "john@example.com",
+     *   "name": "John Doe",
+     *   "type": "customer",
+     *   ...
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * This endpoint is useful when you need to look up a contact using your own
+     * system's user identifier, such as when displaying Featurebase data alongside
+     * your user's information in your own application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const byUserID = await client.contacts.byUserID.retrieve(
+     *   'usr_12345',
+     * );
+     * ```
+     */
+    retrieve(userID, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/contacts/by-user-id/${userID}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Permanently deletes a contact by their external user ID.
+     *
+     * **Important:** This endpoint only deletes customers (type: "customer"). Leads
+     * cannot be deleted using this endpoint.
+     *
+     * ### Path Parameters
+     *
+     * - `userId` - The external user ID from your system
+     *
+     * ### Deletion Behavior
+     *
+     * When a contact is deleted:
+     *
+     * - The contact record is permanently removed
+     * - Associated data cleanup is triggered asynchronously
+     * - Comments and posts created by the contact are handled according to retention
+     *   policies
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
+     *
+     * - `id` - The ID of the deleted contact
+     * - `object` - Always "contact"
+     * - `deleted` - Always `true`
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "object": "contact",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * Use this endpoint when you need to delete a contact using your own system's user
+     * identifier, such as when a user deletes their account in your application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const deletedContact =
+     *   await client.contacts.byUserID.delete('usr_12345');
+     * ```
+     */
+    delete(userID, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.delete(path `/v2/contacts/by-user-id/${userID}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+ByUserID.EmailPreferences = EmailPreferences;
+//# sourceMappingURL=by-user-id.mjs.map