featurebase-node 0.0.2

package/resources/companies/companies.js

@@ -0,0 +1,368 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Companies = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const ContactsAPI = tslib_1.__importStar(require("./contacts.js"));
+const contacts_1 = require("./contacts.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
+ */
+class Companies extends resource_1.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((0, path_1.path) `/v2/companies/${id}`, {
+            ...options,
+            headers: (0, headers_1.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: (0, headers_1.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((0, path_1.path) `/v2/companies/${id}`, {
+            ...options,
+            headers: (0, headers_1.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: (0, headers_1.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((0, path_1.path) `/v2/companies/by-company-id/${companyID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Companies = Companies;
+Companies.Contacts = contacts_1.Contacts;
+//# sourceMappingURL=companies.js.map

package/resources/companies/companies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"companies.js","sourceRoot":"","sources":["../../src/resources/companies/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CAOoB;AAEpB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;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,IAAA,WAAI,EAAA,iBAAiB,EAAE,EAAE,EAAE;YACjD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,IAAA,WAAI,EAAA,iBAAiB,EAAE,EAAE,EAAE;YACpD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,IAAA,WAAI,EAAA,+BAA+B,SAAS,EAAE,EAAE;YACzE,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;AAhXD,8BAgXC;AA6ND,SAAS,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}