featurebase-node 0.14.2 → 0.15.0

package/src/resources/users/companies/companies.ts

@@ -23,6 +23,86 @@ import { path } from '../../../internal/utils/path';
 export class Companies extends APIResource {
   contacts: ContactsAPI.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.users.companies.retrieve(
+   *   '507f1f77bcf86cd799439011',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: CompanyRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Company> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/companies/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Returns all companies in your organization with cursor-based pagination.
    *
@@ -115,6 +195,61 @@ export class Companies extends APIResource {
     });
   }
 
+  /**
+   * 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.users.companies.delete(
+   *   '507f1f77bcf86cd799439011',
+   * );
+   * ```
+   */
+  delete(
+    id: string,
+    params: CompanyDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DeletedCompany> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.delete(path`/v2/companies/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Creates a new company or updates an existing one.
    *
@@ -206,141 +341,6 @@ export class Companies extends APIResource {
     });
   }
 
-  /**
-   * 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.users.companies.retrieve(
-   *   '507f1f77bcf86cd799439011',
-   * );
-   * ```
-   */
-  retrieve(
-    id: string,
-    params: CompanyRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<Company> {
-    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/companies/${id}`, {
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : 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.users.companies.delete(
-   *   '507f1f77bcf86cd799439011',
-   * );
-   * ```
-   */
-  delete(
-    id: string,
-    params: CompanyDeleteParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<DeletedCompany> {
-    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.delete(path`/v2/companies/${id}`, {
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Permanently deletes a company by its external company ID (the `companyId` from
    * your system).
@@ -715,12 +715,28 @@ export namespace CompanySearchResponse {
   }
 }
 
+export interface CompanyRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+
 export interface CompanyListParams extends CursorPageParams {
   /**
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+
+export interface CompanyDeleteParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface CompanyCreateOrUpdateParams {
@@ -749,7 +765,7 @@ export interface CompanyCreateOrUpdateParams {
    * Body param: Custom field values on the company. Values can be string, number,
    * boolean, null, or array of primitives.
    */
-  customFields?: CompanyCreateOrUpdateParams.CustomFields;
+  customFields?: { [key: string]: string | number | boolean | Array<string | number | boolean> | null };
 
   /**
    * Body param: Industry the company operates in
@@ -775,37 +791,7 @@ export interface CompanyCreateOrUpdateParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
-}
-
-export namespace CompanyCreateOrUpdateParams {
-  /**
-   * Custom field values on the company. Values can be string, number, boolean, null,
-   * or array of primitives.
-   */
-  export interface CustomFields {
-    priority?: string;
-
-    region?: string;
-
-    tier?: string;
-  }
-}
-
-export interface CompanyRetrieveParams {
-  /**
-   * API version for this request. Defaults to your organization's configured API
-   * version if not specified.
-   */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
-}
-
-export interface CompanyDeleteParams {
-  /**
-   * API version for this request. Defaults to your organization's configured API
-   * version if not specified.
-   */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface CompanyDeleteByCompanyIDParams {
@@ -813,7 +799,7 @@ export interface CompanyDeleteByCompanyIDParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface CompanySearchParams {
@@ -859,7 +845,7 @@ export interface CompanySearchParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 Companies.Contacts = Contacts;
@@ -870,10 +856,10 @@ export declare namespace Companies {
     type DeletedCompany as DeletedCompany,
     type CompanySearchResponse as CompanySearchResponse,
     type CompaniesCursorPage as CompaniesCursorPage,
-    type CompanyListParams as CompanyListParams,
-    type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams,
     type CompanyRetrieveParams as CompanyRetrieveParams,
+    type CompanyListParams as CompanyListParams,
     type CompanyDeleteParams as CompanyDeleteParams,
+    type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams,
     type CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams,
     type CompanySearchParams as CompanySearchParams,
   };

package/src/resources/users/companies/contacts.ts

@@ -269,7 +269,7 @@ export interface ContactListParams extends CursorPageParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface ContactAttachParams {
@@ -283,7 +283,7 @@ export interface ContactAttachParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface ContactRemoveParams {
@@ -296,7 +296,7 @@ export interface ContactRemoveParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export declare namespace Contacts {

package/src/resources/users/companies/index.ts

@@ -5,10 +5,10 @@ export {
   type Company,
   type DeletedCompany,
   type CompanySearchResponse,
-  type CompanyListParams,
-  type CompanyCreateOrUpdateParams,
   type CompanyRetrieveParams,
+  type CompanyListParams,
   type CompanyDeleteParams,
+  type CompanyCreateOrUpdateParams,
   type CompanyDeleteByCompanyIDParams,
   type CompanySearchParams,
   type CompaniesCursorPage,

package/src/resources/users/contacts/by-user-id/by-user-id.ts

@@ -181,7 +181,7 @@ export interface ByUserIDRetrieveParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface ByUserIDDeleteParams {
@@ -189,7 +189,7 @@ export interface ByUserIDDeleteParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 ByUserID.EmailPreferences = EmailPreferences;

package/src/resources/users/contacts/by-user-id/email-preferences.ts

@@ -197,7 +197,7 @@ export interface EmailPreferenceRetrieveParams {
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface EmailPreferenceUpdateParams {
@@ -210,7 +210,7 @@ export interface EmailPreferenceUpdateParams {
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export namespace EmailPreferenceUpdateParams {