featurebase-node 0.9.0 → 0.11.0

package/resources/users/companies/companies.d.mts

@@ -312,6 +312,86 @@ export declare class Companies extends APIResource {
      * ```
      */
     deleteByCompanyID(companyID: string, params?: CompanyDeleteByCompanyIDParams | null | undefined, options?: RequestOptions): APIPromise<DeletedCompany>;
+    /**
+     * Search companies with a structured filter AST, sorting, and cursor pagination.
+     *
+     * ### Structured query AST
+     *
+     * Each clause has the shape `{ field, operator, value }`. You can pass a single
+     * clause or wrap up to 15 in a top-level `AND` group:
+     *
+     * ```json
+     * {
+     *   "query": {
+     *     "operator": "AND",
+     *     "value": [
+     *       { "field": "plan", "operator": "IN", "value": ["enterprise", "pro"] },
+     *       { "field": "monthly_spend", "operator": ">", "value": 1000 }
+     *     ]
+     *   },
+     *   "sort": "monthly_spend:desc",
+     *   "limit": 20
+     * }
+     * ```
+     *
+     * Top-level `OR` groups and nested groups are not supported in this version.
+     *
+     * ### 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                        | `=`, `!=`, `>`, `<`         |
+     *
+     * The `name ~ "..."` operator runs a word-aware substring search via the
+     * underlying text index. Other string operators (`!~`, `^`, `$`) are reserved for
+     * future use and currently return `400`.
+     *
+     * A query consisting only of `!=` or `NIN` clauses is rejected with
+     * `query_too_broad` to prevent full-org scans. Combine the negation with at least
+     * one positive clause (`=`, `IN`, `>`, `<`) instead.
+     *
+     * ### Sort
+     *
+     * Allowed values:
+     *
+     * - `created_at:desc` (default), `created_at:asc`
+     * - `monthly_spend:desc`, `monthly_spend:asc`
+     * - `last_activity:desc`, `last_activity:asc`
+     *
+     * The chosen sort axis is encoded in the cursor; switching `sort` mid-pagination
+     * returns `400 invalid_cursor`. Restart pagination without a cursor when changing
+     * sort.
+     *
+     * ### Pagination
+     *
+     * Cursor-based, `limit` between 1 and 100 (default 10). `totalCount` is
+     * approximate and capped at 5000; `totalCountCapped` is `true` when the real count
+     * may be higher.
+     *
+     * ### Response
+     *
+     * Returns a standard list envelope with company rows identical to
+     * `GET /v2/companies/{id}`.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.companies.search();
+     * ```
+     */
+    search(params: CompanySearchParams, options?: RequestOptions): APIPromise<CompanySearchResponse>;
 }
 export type CompaniesCursorPage = CursorPage<Company>;
 export interface Company {
@@ -388,6 +468,93 @@ export interface DeletedCompany {
      */
     object: 'company';
 }
+export interface CompanySearchResponse {
+    /**
+     * Array of search results
+     */
+    data: Array<CompanySearchResponse.Data>;
+    /**
+     * Cursor for fetching the next page (null if no more results)
+     */
+    nextCursor: string | null;
+    /**
+     * Object type identifier
+     */
+    object: 'list';
+    /**
+     * Total number of companies matching the query, capped at 5000. When the actual
+     * total is at or above the cap, `totalCountCapped` is true and the value is
+     * exactly the cap.
+     */
+    totalCount?: number;
+    /**
+     * True when `totalCount` is exactly the cap and the real count may be higher. UI
+     * can render as e.g. "5000+".
+     */
+    totalCountCapped?: boolean;
+}
+export declare namespace CompanySearchResponse {
+    interface Data {
+        /**
+         * Featurebase internal ID
+         */
+        id: string;
+        /**
+         * External company ID from your system
+         */
+        companyId: string;
+        /**
+         * Company employee headcount
+         */
+        companySize: number | null;
+        /**
+         * ISO date when company was created
+         */
+        createdAt: string | null;
+        /**
+         * Industry
+         */
+        industry: string | null;
+        /**
+         * ISO date of last activity
+         */
+        lastActivity: string | null;
+        /**
+         * Number of users linked to this company
+         */
+        linkedUsers: number | null;
+        /**
+         * Monthly spend
+         */
+        monthlySpend: number | null;
+        /**
+         * Company name
+         */
+        name: string;
+        /**
+         * Object type identifier
+         */
+        object: 'company';
+        /**
+         * Plan or tier name
+         */
+        plan: string | null;
+        /**
+         * ISO date when company was last updated
+         */
+        updatedAt: string | null;
+        /**
+         * Company website URL
+         */
+        website: string | null;
+        /**
+         * Custom field values
+         */
+        customFields?: {
+            [key: string]: unknown;
+        };
+    }
+}
 export interface CompanyRetrieveParams {
     /**
      * API version for this request. Defaults to your organization's configured API
@@ -472,8 +639,77 @@ export interface CompanyDeleteByCompanyIDParams {
      */
     'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
+export interface CompanySearchParams {
+    /**
+     * Body param: An opaque cursor for pagination. Use the `nextCursor` value from a
+     * previous response to fetch the next page of results.
+     */
+    cursor?: string;
+    /**
+     * Body param: A limit on the number of objects to be returned, between 1 and 100.
+     */
+    limit?: number;
+    /**
+     * 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;
+    /**
+     * Body param: Sort field + direction. Defaults to `created_at:desc`. The chosen
+     * sort axis is encoded in the cursor; switching `sort` mid-pagination returns
+     * `400 invalid_cursor`.
+     */
+    sort?: 'created_at:desc' | 'created_at:asc' | 'monthly_spend:desc' | 'monthly_spend:asc' | 'last_activity:desc' | 'last_activity:asc';
+    /**
+     * 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 declare namespace CompanySearchParams {
+    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;
+    }
+    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>;
+    }
+    namespace SearchFilterGroup {
+        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;
+        }
+    }
+}
 export declare namespace Companies {
-    export { type Company as Company, type DeletedCompany as DeletedCompany, type CompaniesCursorPage as CompaniesCursorPage, type CompanyRetrieveParams as CompanyRetrieveParams, type CompanyListParams as CompanyListParams, type CompanyDeleteParams as CompanyDeleteParams, type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams, type CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams, };
+    export { type Company as Company, 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 CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams, type CompanySearchParams as CompanySearchParams, };
     export { Contacts as Contacts, type ContactAttachResponse as ContactAttachResponse, type ContactRemoveResponse as ContactRemoveResponse, type ContactListParams as ContactListParams, type ContactAttachParams as ContactAttachParams, type ContactRemoveParams as ContactRemoveParams, };
 }
 //# sourceMappingURL=companies.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../../../src/resources/users/companies/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAetB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAgB5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAe7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACH,cAAc,CAAC,MAAM,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAgBlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;CAc9B;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAEtD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,2BAA2B,CAAC,YAAY,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;OAGG;IACH,UAAiB,YAAY;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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"}
+{"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../../../src/resources/users/companies/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAetB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAgB5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAe7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACH,cAAc,CAAC,MAAM,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAgBlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAe7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8EG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAejG;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAEtD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,SAAS,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC3C;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,2BAA2B,CAAC,YAAY,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;OAGG;IACH,UAAiB,YAAY;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC,YAAY,GAAG,mBAAmB,CAAC,iBAAiB,CAAC;IAEjF;;;;OAIG;IACH,IAAI,CAAC,EACD,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,CAAC;IAExB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,YAAY;QAC3B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,CAAC;QAEvF;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;KAClE;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;KACvC;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,KAAK;YACpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,CAAC;YAEvF;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;SAClE;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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"}

package/resources/users/companies/companies.d.ts

@@ -312,6 +312,86 @@ export declare class Companies extends APIResource {
      * ```
      */
     deleteByCompanyID(companyID: string, params?: CompanyDeleteByCompanyIDParams | null | undefined, options?: RequestOptions): APIPromise<DeletedCompany>;
+    /**
+     * Search companies with a structured filter AST, sorting, and cursor pagination.
+     *
+     * ### Structured query AST
+     *
+     * Each clause has the shape `{ field, operator, value }`. You can pass a single
+     * clause or wrap up to 15 in a top-level `AND` group:
+     *
+     * ```json
+     * {
+     *   "query": {
+     *     "operator": "AND",
+     *     "value": [
+     *       { "field": "plan", "operator": "IN", "value": ["enterprise", "pro"] },
+     *       { "field": "monthly_spend", "operator": ">", "value": 1000 }
+     *     ]
+     *   },
+     *   "sort": "monthly_spend:desc",
+     *   "limit": 20
+     * }
+     * ```
+     *
+     * Top-level `OR` groups and nested groups are not supported in this version.
+     *
+     * ### 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                        | `=`, `!=`, `>`, `<`         |
+     *
+     * The `name ~ "..."` operator runs a word-aware substring search via the
+     * underlying text index. Other string operators (`!~`, `^`, `$`) are reserved for
+     * future use and currently return `400`.
+     *
+     * A query consisting only of `!=` or `NIN` clauses is rejected with
+     * `query_too_broad` to prevent full-org scans. Combine the negation with at least
+     * one positive clause (`=`, `IN`, `>`, `<`) instead.
+     *
+     * ### Sort
+     *
+     * Allowed values:
+     *
+     * - `created_at:desc` (default), `created_at:asc`
+     * - `monthly_spend:desc`, `monthly_spend:asc`
+     * - `last_activity:desc`, `last_activity:asc`
+     *
+     * The chosen sort axis is encoded in the cursor; switching `sort` mid-pagination
+     * returns `400 invalid_cursor`. Restart pagination without a cursor when changing
+     * sort.
+     *
+     * ### Pagination
+     *
+     * Cursor-based, `limit` between 1 and 100 (default 10). `totalCount` is
+     * approximate and capped at 5000; `totalCountCapped` is `true` when the real count
+     * may be higher.
+     *
+     * ### Response
+     *
+     * Returns a standard list envelope with company rows identical to
+     * `GET /v2/companies/{id}`.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.companies.search();
+     * ```
+     */
+    search(params: CompanySearchParams, options?: RequestOptions): APIPromise<CompanySearchResponse>;
 }
 export type CompaniesCursorPage = CursorPage<Company>;
 export interface Company {
@@ -388,6 +468,93 @@ export interface DeletedCompany {
      */
     object: 'company';
 }
+export interface CompanySearchResponse {
+    /**
+     * Array of search results
+     */
+    data: Array<CompanySearchResponse.Data>;
+    /**
+     * Cursor for fetching the next page (null if no more results)
+     */
+    nextCursor: string | null;
+    /**
+     * Object type identifier
+     */
+    object: 'list';
+    /**
+     * Total number of companies matching the query, capped at 5000. When the actual
+     * total is at or above the cap, `totalCountCapped` is true and the value is
+     * exactly the cap.
+     */
+    totalCount?: number;
+    /**
+     * True when `totalCount` is exactly the cap and the real count may be higher. UI
+     * can render as e.g. "5000+".
+     */
+    totalCountCapped?: boolean;
+}
+export declare namespace CompanySearchResponse {
+    interface Data {
+        /**
+         * Featurebase internal ID
+         */
+        id: string;
+        /**
+         * External company ID from your system
+         */
+        companyId: string;
+        /**
+         * Company employee headcount
+         */
+        companySize: number | null;
+        /**
+         * ISO date when company was created
+         */
+        createdAt: string | null;
+        /**
+         * Industry
+         */
+        industry: string | null;
+        /**
+         * ISO date of last activity
+         */
+        lastActivity: string | null;
+        /**
+         * Number of users linked to this company
+         */
+        linkedUsers: number | null;
+        /**
+         * Monthly spend
+         */
+        monthlySpend: number | null;
+        /**
+         * Company name
+         */
+        name: string;
+        /**
+         * Object type identifier
+         */
+        object: 'company';
+        /**
+         * Plan or tier name
+         */
+        plan: string | null;
+        /**
+         * ISO date when company was last updated
+         */
+        updatedAt: string | null;
+        /**
+         * Company website URL
+         */
+        website: string | null;
+        /**
+         * Custom field values
+         */
+        customFields?: {
+            [key: string]: unknown;
+        };
+    }
+}
 export interface CompanyRetrieveParams {
     /**
      * API version for this request. Defaults to your organization's configured API
@@ -472,8 +639,77 @@ export interface CompanyDeleteByCompanyIDParams {
      */
     'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
+export interface CompanySearchParams {
+    /**
+     * Body param: An opaque cursor for pagination. Use the `nextCursor` value from a
+     * previous response to fetch the next page of results.
+     */
+    cursor?: string;
+    /**
+     * Body param: A limit on the number of objects to be returned, between 1 and 100.
+     */
+    limit?: number;
+    /**
+     * 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;
+    /**
+     * Body param: Sort field + direction. Defaults to `created_at:desc`. The chosen
+     * sort axis is encoded in the cursor; switching `sort` mid-pagination returns
+     * `400 invalid_cursor`.
+     */
+    sort?: 'created_at:desc' | 'created_at:asc' | 'monthly_spend:desc' | 'monthly_spend:asc' | 'last_activity:desc' | 'last_activity:asc';
+    /**
+     * 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 declare namespace CompanySearchParams {
+    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;
+    }
+    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>;
+    }
+    namespace SearchFilterGroup {
+        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;
+        }
+    }
+}
 export declare namespace Companies {
-    export { type Company as Company, type DeletedCompany as DeletedCompany, type CompaniesCursorPage as CompaniesCursorPage, type CompanyRetrieveParams as CompanyRetrieveParams, type CompanyListParams as CompanyListParams, type CompanyDeleteParams as CompanyDeleteParams, type CompanyCreateOrUpdateParams as CompanyCreateOrUpdateParams, type CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams, };
+    export { type Company as Company, 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 CompanyDeleteByCompanyIDParams as CompanyDeleteByCompanyIDParams, type CompanySearchParams as CompanySearchParams, };
     export { Contacts as Contacts, type ContactAttachResponse as ContactAttachResponse, type ContactRemoveResponse as ContactRemoveResponse, type ContactListParams as ContactListParams, type ContactAttachParams as ContactAttachParams, type ContactRemoveParams as ContactRemoveParams, };
 }
 //# sourceMappingURL=companies.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../../../src/resources/users/companies/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAetB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAgB5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAe7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACH,cAAc,CAAC,MAAM,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAgBlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;CAc9B;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAEtD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,2BAA2B,CAAC,YAAY,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;OAGG;IACH,UAAiB,YAAY;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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"}
+{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../../../src/resources/users/companies/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAetB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,OAAO,CAAC;IAgB5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAe7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACH,cAAc,CAAC,MAAM,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAgBlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAe7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8EG;IACH,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAejG;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAEtD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,SAAS,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC3C;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,2BAA2B,CAAC,YAAY,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;;OAGG;IACH,UAAiB,YAAY;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC,YAAY,GAAG,mBAAmB,CAAC,iBAAiB,CAAC;IAEjF;;;;OAIG;IACH,IAAI,CAAC,EACD,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,CAAC;IAExB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;CACjE;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,YAAY;QAC3B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,CAAC;QAEvF;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;KAClE;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;KACvC;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,KAAK;YACpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,CAAC;YAEvF;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;SAClE;KACF;CACF;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,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"}

package/resources/users/companies/companies.js

@@ -387,6 +387,100 @@ class Companies extends resource_1.APIResource {
             ]),
         });
     }
+    /**
+     * Search companies with a structured filter AST, sorting, and cursor pagination.
+     *
+     * ### Structured query AST
+     *
+     * Each clause has the shape `{ field, operator, value }`. You can pass a single
+     * clause or wrap up to 15 in a top-level `AND` group:
+     *
+     * ```json
+     * {
+     *   "query": {
+     *     "operator": "AND",
+     *     "value": [
+     *       { "field": "plan", "operator": "IN", "value": ["enterprise", "pro"] },
+     *       { "field": "monthly_spend", "operator": ">", "value": 1000 }
+     *     ]
+     *   },
+     *   "sort": "monthly_spend:desc",
+     *   "limit": 20
+     * }
+     * ```
+     *
+     * Top-level `OR` groups and nested groups are not supported in this version.
+     *
+     * ### 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                        | `=`, `!=`, `>`, `<`         |
+     *
+     * The `name ~ "..."` operator runs a word-aware substring search via the
+     * underlying text index. Other string operators (`!~`, `^`, `$`) are reserved for
+     * future use and currently return `400`.
+     *
+     * A query consisting only of `!=` or `NIN` clauses is rejected with
+     * `query_too_broad` to prevent full-org scans. Combine the negation with at least
+     * one positive clause (`=`, `IN`, `>`, `<`) instead.
+     *
+     * ### Sort
+     *
+     * Allowed values:
+     *
+     * - `created_at:desc` (default), `created_at:asc`
+     * - `monthly_spend:desc`, `monthly_spend:asc`
+     * - `last_activity:desc`, `last_activity:asc`
+     *
+     * The chosen sort axis is encoded in the cursor; switching `sort` mid-pagination
+     * returns `400 invalid_cursor`. Restart pagination without a cursor when changing
+     * sort.
+     *
+     * ### Pagination
+     *
+     * Cursor-based, `limit` between 1 and 100 (default 10). `totalCount` is
+     * approximate and capped at 5000; `totalCountCapped` is `true` when the real count
+     * may be higher.
+     *
+     * ### Response
+     *
+     * Returns a standard list envelope with company rows identical to
+     * `GET /v2/companies/{id}`.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.companies.search();
+     * ```
+     */
+    search(params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/companies/search', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(featurebaseVersion?.toString() != null ?
+                        { 'Featurebase-Version': featurebaseVersion?.toString() }
+                        : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
 }
 exports.Companies = Companies;
 Companies.Contacts = contacts_1.Contacts;