featurebase-node 0.0.2

package/resources/companies/companies.mjs

@@ -0,0 +1,363 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as ContactsAPI from "./contacts.mjs";
+import { Contacts, } from "./contacts.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
+ */
+export class Companies extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.contacts = new ContactsAPI.Contacts(this._client);
+    }
+    /**
+     * Retrieves a single company by its Featurebase ID.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
+     *
+     * ### Response
+     *
+     * Returns a company object with:
+     *
+     * - `id` - Featurebase internal ID
+     * - `companyId` - External company ID from your system
+     * - `name` - Company name
+     * - `monthlySpend` - Monthly spend/revenue
+     * - `industry` - Industry
+     * - `website` - Company website URL
+     * - `plan` - Plan/tier name
+     * - `linkedUsers` - Number of users linked to this company
+     * - `companySize` - Employee headcount
+     * - `lastActivity` - Last activity timestamp
+     * - `customFields` - Custom field values
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "company",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "companyId": "comp_12345",
+     *   "name": "Acme Inc",
+     *   "monthlySpend": 5000,
+     *   "industry": "Technology",
+     *   "website": "https://acme.com",
+     *   "plan": "enterprise",
+     *   "linkedUsers": 15,
+     *   "companySize": 250,
+     *   "lastActivity": "2025-01-15T00:00:00.000Z",
+     *   "customFields": { "location": "Europe" },
+     *   "createdAt": "2025-01-01T12:00:00.000Z",
+     *   "updatedAt": "2025-01-10T15:30:00.000Z"
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Company with the specified ID does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const company = await client.companies.retrieve(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/companies/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all companies in your organization with cursor-based pagination.
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of companies to return (1-100, default: 10)
+     * - `cursor` - Opaque cursor from a previous response for pagination
+     *
+     * ### Response Structure
+     *
+     * The response includes:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of company objects
+     * - `nextCursor` - Cursor for the next page (null if no more results)
+     *
+     * ### Company Object
+     *
+     * Each company includes:
+     *
+     * - `id` - Featurebase internal ID (MongoDB ObjectId)
+     * - `companyId` - External company ID from your system
+     * - `name` - Company name
+     * - `monthlySpend` - Monthly spend/revenue
+     * - `industry` - Industry
+     * - `website` - Company website URL
+     * - `plan` - Plan/tier name
+     * - `linkedUsers` - Number of users linked to this company
+     * - `companySize` - Employee headcount
+     * - `lastActivity` - Last activity timestamp
+     * - `customFields` - Custom field values
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "company",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "companyId": "comp_12345",
+     *       "name": "Acme Inc",
+     *       "monthlySpend": 5000,
+     *       "industry": "Technology",
+     *       "website": "https://acme.com",
+     *       "plan": "enterprise",
+     *       "linkedUsers": 15,
+     *       "companySize": 250,
+     *       "lastActivity": "2025-01-15T00:00:00.000Z",
+     *       "customFields": { "location": "Europe" },
+     *       "createdAt": "2025-01-01T12:00:00.000Z",
+     *       "updatedAt": "2025-01-10T15:30:00.000Z"
+     *     }
+     *   ],
+     *   "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const companies = await client.companies.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get('/v2/companies', {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Deletes a company by its Featurebase ID.
+     *
+     * This will also remove the company from all linked users' associations.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
+     *
+     * ```json
+     * {
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "object": "company",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Company with the specified ID does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const deletedCompany = await client.companies.delete(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    delete(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.delete(path `/v2/companies/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Creates a new company or updates an existing one.
+     *
+     * Uses the external `companyId` as the unique identifier for upsert matching. If a
+     * company with the given `companyId` already exists, it will be updated.
+     * Otherwise, a new company will be created.
+     *
+     * ### Request Body
+     *
+     * | Field          | Type   | Required | Description                                              |
+     * | -------------- | ------ | -------- | -------------------------------------------------------- |
+     * | `companyId`    | string | Yes      | External company ID from your system (unique identifier) |
+     * | `name`         | string | Yes      | Company name                                             |
+     * | `monthlySpend` | number | No       | Monthly spend/revenue from this company                  |
+     * | `industry`     | string | No       | Industry the company operates in                         |
+     * | `website`      | string | No       | Company website URL                                      |
+     * | `plan`         | string | No       | Current plan/subscription name                           |
+     * | `companySize`  | number | No       | Number of employees                                      |
+     * | `createdAt`    | string | No       | When the company was created (ISO 8601)                  |
+     * | `customFields` | object | No       | Custom field values                                      |
+     *
+     * ### Example Request
+     *
+     * ```json
+     * {
+     *   "companyId": "comp_12345",
+     *   "name": "Acme Inc",
+     *   "monthlySpend": 5000,
+     *   "industry": "Technology",
+     *   "website": "https://acme.com",
+     *   "plan": "enterprise",
+     *   "companySize": 250,
+     *   "customFields": {
+     *     "region": "EMEA",
+     *     "tier": "gold"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "company",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "companyId": "comp_12345",
+     *   "name": "Acme Inc",
+     *   "monthlySpend": 5000,
+     *   "industry": "Technology",
+     *   "website": "https://acme.com",
+     *   "plan": "enterprise",
+     *   "linkedUsers": 1,
+     *   "companySize": 250,
+     *   "lastActivity": "2025-01-15T00:00:00.000Z",
+     *   "customFields": { "region": "EMEA", "tier": "gold" },
+     *   "createdAt": "2025-01-01T12:00:00.000Z",
+     *   "updatedAt": "2025-01-15T10:30:00.000Z"
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **400 Bad Request** - Invalid company data
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const company = await client.companies.createOrUpdate({
+     *   companyId: 'comp_12345',
+     *   name: 'Acme Inc',
+     * });
+     * ```
+     */
+    createOrUpdate(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/companies', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Permanently deletes a company by its external company ID (the `companyId` from
+     * your system).
+     *
+     * This will also remove the company from all linked users' associations.
+     *
+     * ### Path Parameters
+     *
+     * - `companyId` - The external company ID from your system
+     *
+     * ### Deletion Behavior
+     *
+     * When a company is deleted:
+     *
+     * - The company record is permanently removed
+     * - The company is removed from all linked users' `companyIds` and `companies`
+     *   arrays
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
+     *
+     * - `id` - The Featurebase internal ID of the deleted company
+     * - `object` - Always "company"
+     * - `deleted` - Always `true`
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "object": "company",
+     *   "deleted": true
+     * }
+     * ```
+     *
+     * ### Use Case
+     *
+     * Use this endpoint when you need to delete a company using your own system's
+     * company identifier, such as when a company is removed from your application.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const deletedCompany =
+     *   await client.companies.deleteByCompanyID('comp_12345');
+     * ```
+     */
+    deleteByCompanyID(companyID, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.delete(path `/v2/companies/by-company-id/${companyID}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+Companies.Contacts = Contacts;
+//# sourceMappingURL=companies.mjs.map

package/resources/companies/companies.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../../src/resources/companies/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAML,QAAQ,GACT;OAEM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+W1E,CAAC;IA7WC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,QAAQ,CACN,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,EAAE,EAAE,EAAE;YACjD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,IAAI,CACF,SAA+C,EAAE,EACjD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE;YACvC,KAAK;YACL,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,EAAE,EAAE,EAAE;YACpD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2EG;IACH,cAAc,CAAC,MAAmC,EAAE,OAAwB;QAC1E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE;YACxC,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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,iBAAiB,CACf,SAAiB,EACjB,SAA4D,EAAE,EAC9D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,+BAA+B,SAAS,EAAE,EAAE;YACzE,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;AA6ND,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC"}

package/resources/companies/contacts.d.mts

@@ -0,0 +1,236 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+import * as ContactsAPI_ from "../contacts/contacts.mjs";
+/**
+ * Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
+ */
+export declare class Contacts extends APIResource {
+    /**
+     * Returns all contacts (customers) attached to a specific company.
+     *
+     * Only returns contacts with type "customer" that have the company in their
+     * `companyIds` array. Uses cursor-based pagination.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
+     *
+     * ### Query Parameters
+     *
+     * - `limit` - Number of contacts to return (1-100, default: 10)
+     * - `cursor` - Opaque cursor from a previous response for pagination
+     *
+     * ### Response Structure
+     *
+     * The response includes:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of contact objects
+     * - `nextCursor` - Cursor for the next page (null if no more results)
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "contact",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "userId": "usr_12345",
+     *       "email": "john@acme.com",
+     *       "name": "John Doe",
+     *       "type": "customer",
+     *       "companies": [...],
+     *       "createdAt": "2025-01-01T12:00:00.000Z"
+     *     }
+     *   ],
+     *   "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Company with the specified ID does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const contactList = await client.companies.contacts.list(
+     *   '507f1f77bcf86cd799439011',
+     * );
+     * ```
+     */
+    list(id: string, params?: ContactListParams | null | undefined, options?: RequestOptions): APIPromise<ContactsAPI_.ContactList>;
+    /**
+     * Attaches a contact (customer) to a company.
+     *
+     * Adds the company to the contact's `companyIds` array and embedded `companies`
+     * array. This operation is **additive** - existing company associations are
+     * preserved. Also increments the `linkedUsers` count on the company.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
+     *
+     * ### Request Body
+     *
+     * | Field       | Type   | Required | Description                                                             |
+     * | ----------- | ------ | -------- | ----------------------------------------------------------------------- |
+     * | `contactId` | string | Yes      | The Featurebase internal ID of the contact to attach (MongoDB ObjectId) |
+     *
+     * ### Example Request
+     *
+     * ```json
+     * {
+     *   "contactId": "507f1f77bcf86cd799439012"
+     * }
+     * ```
+     *
+     * ### Response
+     *
+     * Returns the updated contact object with the new company association.
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "contact",
+     *   "id": "507f1f77bcf86cd799439012",
+     *   "userId": "usr_12345",
+     *   "email": "john@acme.com",
+     *   "name": "John Doe",
+     *   "type": "customer",
+     *   "companies": [
+     *     {
+     *       "object": "company",
+     *       "id": "507f1f77bcf86cd799439011",
+     *       "companyId": "comp_12345",
+     *       "name": "Acme Inc"
+     *     }
+     *   ]
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **404 Not Found** - Company or contact does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const response = await client.companies.contacts.attach(
+     *   '507f1f77bcf86cd799439011',
+     *   { contactId: '507f1f77bcf86cd799439012' },
+     * );
+     * ```
+     */
+    attach(id: string, params: ContactAttachParams, options?: RequestOptions): APIPromise<ContactAttachResponse>;
+    /**
+     * Removes a contact (customer) from a company.
+     *
+     * Removes the company from the contact's `companyIds` array and embedded
+     * `companies` array. Also decrements the `linkedUsers` count on the company.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The Featurebase internal ID of the company (MongoDB ObjectId)
+     * - `contactId` - The Featurebase internal ID of the contact to remove (MongoDB
+     *   ObjectId)
+     *
+     * ### Response
+     *
+     * Returns the updated contact object with the company removed.
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "contact",
+     *   "id": "507f1f77bcf86cd799439012",
+     *   "userId": "usr_12345",
+     *   "email": "john@acme.com",
+     *   "name": "John Doe",
+     *   "type": "customer",
+     *   "companies": []
+     * }
+     * ```
+     *
+     * ### Error Responses
+     *
+     * - **400 Bad Request** - Contact is not attached to this company
+     * - **404 Not Found** - Company or contact does not exist
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.companies.contacts.remove(
+     *   '507f1f77bcf86cd799439012',
+     *   { id: '507f1f77bcf86cd799439011' },
+     * );
+     * ```
+     */
+    remove(contactID: string, params: ContactRemoveParams, options?: RequestOptions): APIPromise<ContactRemoveResponse>;
+}
+/**
+ * User who submitted the response
+ */
+export type ContactAttachResponse = ContactsAPI_.Contact | (null & {});
+/**
+ * User who submitted the response
+ */
+export type ContactRemoveResponse = ContactsAPI_.Contact | (null & {});
+export interface ContactListParams {
+    /**
+     * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+     * previous response to fetch the next page of results.
+     */
+    cursor?: string;
+    /**
+     * Query param: A limit on the number of contacts to be returned, between 1
+     * and 100.
+     */
+    limit?: number;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface ContactAttachParams {
+    /**
+     * Body param: The Featurebase internal ID of the contact to attach (MongoDB
+     * ObjectId)
+     */
+    contactId: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface ContactRemoveParams {
+    /**
+     * Path param: The Featurebase internal ID of the company (MongoDB ObjectId)
+     */
+    id: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Contacts {
+    export { type ContactAttachResponse as ContactAttachResponse, type ContactRemoveResponse as ContactRemoveResponse, type ContactListParams as ContactListParams, type ContactAttachParams as ContactAttachParams, type ContactRemoveParams as ContactRemoveParams, };
+}
+//# sourceMappingURL=contacts.d.mts.map

package/resources/companies/contacts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.d.mts","sourceRoot":"","sources":["../../src/resources/companies/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;OAElB,KAAK,YAAY;AAExB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC;IAYvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAYpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAUrC;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;AAEvE,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}