featurebase-node 0.12.0 → 0.14.0

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

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as PostsAPI from '../../feedback/posts/posts';
 import * as ContactsAPI from './contacts';
 import {
   ContactAttachParams,
@@ -22,86 +23,6 @@ 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.
    *
@@ -194,61 +115,6 @@ 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.
    *
@@ -340,6 +206,141 @@ 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).
@@ -426,10 +427,10 @@ export class Companies extends APIResource {
    *     "operator": "AND",
    *     "value": [
    *       { "field": "plan", "operator": "IN", "value": ["enterprise", "pro"] },
-   *       { "field": "monthly_spend", "operator": ">", "value": 1000 }
+   *       { "field": "monthlySpend", "operator": ">", "value": 1000 }
    *     ]
    *   },
-   *   "sort": "monthly_spend:desc",
+   *   "sort": "monthlySpend:desc",
    *   "limit": 20
    * }
    * ```
@@ -438,18 +439,24 @@ export class Companies extends APIResource {
    *
    * ### Supported fields and operators
    *
-   * | Field           | Type                                | Operators                   |
-   * | --------------- | ----------------------------------- | --------------------------- |
-   * | `external_id`   | string (caller-provided company id) | `=`, `!=`, `IN`, `NIN`      |
-   * | `name`          | string                              | `=`, `!=`, `IN`, `NIN`, `~` |
-   * | `monthly_spend` | number                              | `=`, `!=`, `>`, `<`         |
-   * | `plan`          | string                              | `=`, `!=`, `IN`, `NIN`      |
-   * | `industry`      | string                              | `=`, `!=`, `IN`, `NIN`      |
-   * | `website`       | string                              | `=`, `!=`, `IN`, `NIN`      |
-   * | `company_size`  | number                              | `=`, `!=`, `>`, `<`         |
-   * | `linked_users`  | number                              | `=`, `!=`, `>`, `<`         |
-   * | `last_activity` | unix seconds                        | `=`, `!=`, `>`, `<`         |
-   * | `created_at`    | unix seconds                        | `=`, `!=`, `>`, `<`         |
+   * Field names are camelCase, matching the rest of the v2 public API. Snake_case
+   * names that this endpoint originally shipped with (`external_id`,
+   * `monthly_spend`, `company_size`, `linked_users`, `last_activity`, `created_at`)
+   * are still accepted for back-compat but are deprecated — please migrate to
+   * camelCase in new code.
+   *
+   * | Field          | Type                                | Operators                   |
+   * | -------------- | ----------------------------------- | --------------------------- |
+   * | `externalId`   | string (caller-provided company id) | `=`, `!=`, `IN`, `NIN`      |
+   * | `name`         | string                              | `=`, `!=`, `IN`, `NIN`, `~` |
+   * | `monthlySpend` | number                              | `=`, `!=`, `>`, `<`         |
+   * | `plan`         | string                              | `=`, `!=`, `IN`, `NIN`      |
+   * | `industry`     | string                              | `=`, `!=`, `IN`, `NIN`      |
+   * | `website`      | string                              | `=`, `!=`, `IN`, `NIN`      |
+   * | `companySize`  | number                              | `=`, `!=`, `>`, `<`         |
+   * | `linkedUsers`  | number                              | `=`, `!=`, `>`, `<`         |
+   * | `lastActivity` | unix seconds                        | `=`, `!=`, `>`, `<`         |
+   * | `createdAt`    | unix seconds                        | `=`, `!=`, `>`, `<`         |
    *
    * The `name ~ "..."` operator runs a word-aware substring search via the
    * underlying text index. Other string operators (`!~`, `^`, `$`) are reserved for
@@ -463,9 +470,14 @@ export class Companies extends APIResource {
    *
    * Allowed values:
    *
-   * - `created_at:desc` (default), `created_at:asc`
-   * - `monthly_spend:desc`, `monthly_spend:asc`
-   * - `last_activity:desc`, `last_activity:asc`
+   * - `createdAt:desc` (default), `createdAt:asc`
+   * - `monthlySpend:desc`, `monthlySpend:asc`
+   * - `lastActivity:desc`, `lastActivity:asc`
+   *
+   * Snake_case sort axes (`created_at:desc`, `monthly_spend:asc`,
+   * `last_activity:desc`) are accepted for back-compat — the cursor encodes the
+   * canonical camelCase identity, so a caller can switch naming conventions
+   * mid-pagination without restarting.
    *
    * The chosen sort axis is encoded in the cursor; switching `sort` mid-pagination
    * returns `400 invalid_cursor`. Restart pagination without a cursor when changing
@@ -703,14 +715,6 @@ 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-01-01.nova' | '2025-12-12.clover';
-}
-
 export interface CompanyListParams extends CursorPageParams {
   /**
    * Header param: API version for this request. Defaults to your organization's
@@ -719,14 +723,6 @@ export interface CompanyListParams extends CursorPageParams {
   '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';
-}
-
 export interface CompanyCreateOrUpdateParams {
   /**
    * Body param: External company ID from your system. Used as the unique identifier
@@ -796,6 +792,22 @@ export namespace CompanyCreateOrUpdateParams {
   }
 }
 
+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';
+}
+
 export interface CompanyDeleteByCompanyIDParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -820,14 +832,22 @@ export interface CompanySearchParams {
    * Body param: Structured filter AST. Either a single filter clause or one
    * top-level AND group (max 15 clauses). Top-level OR groups are not yet supported.
    */
-  query?: CompanySearchParams.SearchFilter | CompanySearchParams.SearchFilterGroup;
+  query?: PostsAPI.SearchFilter | PostsAPI.SearchFilterGroup;
 
   /**
-   * Body param: Sort field + direction. Defaults to `created_at:desc`. The chosen
+   * Body param: Sort field + direction. Defaults to `createdAt:desc`. The chosen
    * sort axis is encoded in the cursor; switching `sort` mid-pagination returns
-   * `400 invalid_cursor`.
+   * `400 invalid_cursor`. Snake_case names (`created_at:desc`, `monthly_spend:asc`,
+   * `last_activity:desc`) are accepted for back-compat — prefer camelCase in new
+   * code.
    */
   sort?:
+    | 'createdAt:desc'
+    | 'createdAt:asc'
+    | 'monthlySpend:desc'
+    | 'monthlySpend:asc'
+    | 'lastActivity:desc'
+    | 'lastActivity:asc'
     | 'created_at:desc'
     | 'created_at:asc'
     | 'monthly_spend:desc'
@@ -842,56 +862,6 @@ export interface CompanySearchParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export namespace CompanySearchParams {
-  export interface SearchFilter {
-    /**
-     * Field name to filter on (e.g. `state`, `tag_ids`, `created_at`)
-     */
-    field: string;
-
-    /**
-     * Comparison operator
-     */
-    operator: '=' | '!=' | 'IN' | 'NIN' | '>' | '<' | '>=' | '<=' | '~' | '!~' | '^' | '$';
-
-    /**
-     * Value to compare against (primitive or array of primitives)
-     */
-    value: string | number | boolean | Array<string | number> | null;
-  }
-
-  export interface SearchFilterGroup {
-    /**
-     * Group operator: AND (all match) or OR (any match)
-     */
-    operator: 'AND' | 'OR';
-
-    /**
-     * Array of filter clauses (1-15 entries)
-     */
-    value: Array<SearchFilterGroup.Value>;
-  }
-
-  export namespace SearchFilterGroup {
-    export interface Value {
-      /**
-       * Field name to filter on (e.g. `state`, `tag_ids`, `created_at`)
-       */
-      field: string;
-
-      /**
-       * Comparison operator
-       */
-      operator: '=' | '!=' | 'IN' | 'NIN' | '>' | '<' | '>=' | '<=' | '~' | '!~' | '^' | '$';
-
-      /**
-       * Value to compare against (primitive or array of primitives)
-       */
-      value: string | number | boolean | Array<string | number> | null;
-    }
-  }
-}
-
 Companies.Contacts = Contacts;
 
 export declare namespace Companies {
@@ -900,10 +870,10 @@ export declare namespace Companies {
     type DeletedCompany as DeletedCompany,
     type CompanySearchResponse as CompanySearchResponse,
     type CompaniesCursorPage as CompaniesCursorPage,
-    type CompanyRetrieveParams as CompanyRetrieveParams,
     type CompanyListParams as CompanyListParams,
-    type CompanyDeleteParams as CompanyDeleteParams,
     type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams,
+    type CompanyRetrieveParams as CompanyRetrieveParams,
+    type CompanyDeleteParams as CompanyDeleteParams,
     type CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams,
     type CompanySearchParams as CompanySearchParams,
   };

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

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