featurebase-node 0.14.2 → 0.15.0

package/resources/support/conversations/conversations.d.ts

@@ -13,77 +13,6 @@ import { RequestOptions } from "../../../internal/request-options.js";
  */
 export declare class Conversations extends APIResource {
     participants: ParticipantsAPI.Participants;
-    /**
-     * Returns a list of conversations in your organization using cursor-based
-     * pagination.
-     *
-     * ### Query Parameters
-     *
-     * - `limit` - Number of conversations to return (1-100, default 10)
-     * - `cursor` - Cursor from previous response for pagination
-     * - `tagIds` - Optional tag filter as a comma-separated list of tag IDs. Matches
-     *   conversations that contain all of the provided tags.
-     *
-     * ### Response Format
-     *
-     * Returns a list object with:
-     *
-     * - `object` - Always "list"
-     * - `data` - Array of conversation objects
-     * - `nextCursor` - Cursor for the next page, or null if no more results
-     *
-     * ### Conversation Object
-     *
-     * Each conversation includes:
-     *
-     * - `id` - Unique conversation identifier (short ID)
-     * - `title` - Conversation title
-     * - `state` - Current state ("open", "closed", or "snoozed")
-     * - `priority` - Whether the conversation is marked as priority
-     * - `adminAssigneeId` - ID of assigned admin (if any)
-     * - `teamAssigneeId` - ID of assigned team (if any)
-     * - `tags` - Current tags applied anywhere in the conversation
-     * - `participants` - Array of participants
-     * - `source` - Information about the first message
-     * - `createdAt` - Creation timestamp
-     * - `updatedAt` - Last update timestamp
-     *
-     * ### Example
-     *
-     * ```json
-     * {
-     *   "object": "list",
-     *   "data": [
-     *     {
-     *       "object": "conversation",
-     *       "id": "12345",
-     *       "title": "Question about pricing",
-     *       "state": "open",
-     *       "priority": false,
-     *       "adminAssigneeId": null,
-     *       "participants": [
-     *         { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" }
-     *       ],
-     *       ...
-     *     }
-     *   ],
-     *   "nextCursor": "eyJpZCI6IjEyMzQ1In0="
-     * }
-     * ```
-     *
-     * ### Version Availability
-     *
-     * This endpoint is only available in API version 2026-01-01.nova and newer.
-     *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const conversation of client.support.conversations.list()) {
-     *   // ...
-     * }
-     * ```
-     */
-    list(params?: ConversationListParams | null | undefined, options?: RequestOptions): PagePromise<ConversationsCursorPage, Conversation>;
     /**
      * Creates a new conversation. Supports both contact-initiated (customer/lead) and
      * admin-initiated (outreach) conversations.
@@ -323,41 +252,6 @@ export declare class Conversations extends APIResource {
      * ```
      */
     retrieve(id: string, params?: ConversationRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Conversation>;
-    /**
-     * Permanently deletes a conversation by its short ID.
-     *
-     * ### Path Parameters
-     *
-     * - `id` - The conversation short ID (numeric)
-     *
-     * ### Response
-     *
-     * Returns a deletion confirmation object:
-     *
-     * ```json
-     * {
-     *   "id": "12345",
-     *   "object": "conversation",
-     *   "deleted": true
-     * }
-     * ```
-     *
-     * ### Caution
-     *
-     * This operation is **irreversible**. The conversation and all its messages will
-     * be permanently deleted.
-     *
-     * ### Version Availability
-     *
-     * This endpoint is only available in API version 2026-01-01.nova and newer.
-     *
-     * @example
-     * ```ts
-     * const conversation =
-     *   await client.support.conversations.delete('12345');
-     * ```
-     */
-    delete(id: string, params?: ConversationDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationDeleteResponse>;
     /**
      * Updates a conversation's properties. Supports partial updates - only provided
      * fields will be updated.
@@ -487,97 +381,195 @@ export declare class Conversations extends APIResource {
      */
     update(id: string, params: ConversationUpdateParams, options?: RequestOptions): APIPromise<Conversation>;
     /**
-     * Adds a reply to an existing conversation. Supports both contact (customer/lead)
-     * and admin replies.
+     * Returns a list of conversations in your organization using cursor-based
+     * pagination.
      *
-     * ### Path Parameters
+     * ### Query Parameters
      *
-     * - `id` - The conversation ID (short ID)
+     * - `limit` - Number of conversations to return (1-100, default 10)
+     * - `cursor` - Cursor from previous response for pagination
+     * - `tagIds` - Optional tag filter as a comma-separated list of tag IDs. Matches
+     *   conversations that contain all of the provided tags.
      *
-     * ### Request Body
+     * ### Response Format
      *
-     * The request body varies based on who is sending the reply:
+     * Returns a list object with:
      *
-     * #### Contact Reply (customer/lead)
+     * - `object` - Always "list"
+     * - `data` - Array of conversation objects
+     * - `nextCursor` - Cursor for the next page, or null if no more results
      *
-     * | Field               | Type    | Required | Description                                                                                                                        |
-     * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
-     * | `type`              | string  | Yes      | Must be "contact"                                                                                                                  |
-     * | `userId`            | string  | No\*     | External user ID from your system                                                                                                  |
-     * | `id`                | string  | No\*     | Featurebase contact ID (24-character ObjectId)                                                                                     |
-     * | `bodyMarkdown`      | string  | Yes      | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
-     * | `messageType`       | string  | Yes      | Must be "reply"                                                                                                                    |
-     * | `skipNotifications` | boolean | No       | Skip sending notifications (default: false). Useful for bulk imports.                                                              |
+     * ### Conversation Object
      *
-     * \*At least one of `userId` or `id` is required.
+     * Each conversation includes:
      *
-     * #### Admin Reply
+     * - `id` - Unique conversation identifier (short ID)
+     * - `title` - Conversation title
+     * - `state` - Current state ("open", "closed", or "snoozed")
+     * - `priority` - Whether the conversation is marked as priority
+     * - `adminAssigneeId` - ID of assigned admin (if any)
+     * - `teamAssigneeId` - ID of assigned team (if any)
+     * - `tags` - Current tags applied anywhere in the conversation
+     * - `participants` - Array of participants
+     * - `source` - Information about the first message
+     * - `createdAt` - Creation timestamp
+     * - `updatedAt` - Last update timestamp
      *
-     * | Field               | Type    | Required | Description                                                                                                                        |
-     * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
-     * | `type`              | string  | Yes      | Must be "admin"                                                                                                                    |
-     * | `id`                | string  | Yes      | Featurebase admin ID (24-character ObjectId)                                                                                       |
-     * | `bodyMarkdown`      | string  | Yes      | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
-     * | `messageType`       | string  | Yes      | "reply" for customer-visible reply, "note" for internal note                                                                       |
-     * | `skipNotifications` | boolean | No       | Skip sending notifications (default: false). Useful for bulk imports.                                                              |
+     * ### Example
      *
-     * ### Response
+     * ```json
+     * {
+     *   "object": "list",
+     *   "data": [
+     *     {
+     *       "object": "conversation",
+     *       "id": "12345",
+     *       "title": "Question about pricing",
+     *       "state": "open",
+     *       "priority": false,
+     *       "adminAssigneeId": null,
+     *       "participants": [
+     *         { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" }
+     *       ],
+     *       ...
+     *     }
+     *   ],
+     *   "nextCursor": "eyJpZCI6IjEyMzQ1In0="
+     * }
+     * ```
      *
-     * Returns the created conversation part object with a **201 Created** status. The
-     * response includes both `bodyHtml` (with signed image URLs) and `bodyMarkdown`
-     * fields.
+     * ### Version Availability
      *
-     * ### Example Contact Reply
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
      *
-     * ```json
-     * {
-     *   "type": "contact",
-     *   "userId": "user_123",
-     *   "bodyMarkdown": "Thank you for your help!",
-     *   "messageType": "reply"
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const conversation of client.support.conversations.list()) {
+     *   // ...
      * }
      * ```
+     */
+    list(params?: ConversationListParams | null | undefined, options?: RequestOptions): PagePromise<ConversationsCursorPage, Conversation>;
+    /**
+     * Permanently deletes a conversation by its short ID.
      *
-     * ### Example Admin Reply
+     * ### Path Parameters
+     *
+     * - `id` - The conversation short ID (numeric)
+     *
+     * ### Response
+     *
+     * Returns a deletion confirmation object:
      *
      * ```json
      * {
-     *   "type": "admin",
-     *   "id": "507f1f77bcf86cd799439011",
-     *   "bodyMarkdown": "I'm happy to help! Here's what you need to do...",
-     *   "messageType": "reply"
+     *   "id": "12345",
+     *   "object": "conversation",
+     *   "deleted": true
      * }
      * ```
      *
-     * ### Example Admin Note (Internal)
+     * ### Caution
+     *
+     * This operation is **irreversible**. The conversation and all its messages will
+     * be permanently deleted.
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const conversation =
+     *   await client.support.conversations.delete('12345');
+     * ```
+     */
+    delete(id: string, params?: ConversationDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationDeleteResponse>;
+    /**
+     * Attaches a workspace tag to a conversation.
+     *
+     * This endpoint requires both the tag ID to attach and the `actingAdminId` of the
+     * admin on whose behalf the mutation is recorded.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The conversation ID (short ID)
+     *
+     * ### Request Body
+     *
+     * | Field           | Type   | Required | Description                                                              |
+     * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
+     * | `tagId`         | string | Yes      | The Featurebase tag ID to attach                                         |
+     * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
+     *
+     * ### Behavior
+     *
+     * Featurebase resolves the latest taggable reply/message in the conversation and
+     * records the tag attachment against that part so audit metadata remains
+     * deterministic.
+     *
+     * ### Response
+     *
+     * Returns the affected tag plus attachment metadata such as `targetPartId`,
+     * `appliedAt`, and `appliedBy`.
+     *
+     * ### Example Request
      *
      * ```json
      * {
-     *   "type": "admin",
-     *   "id": "507f1f77bcf86cd799439011",
-     *   "bodyMarkdown": "Customer seems frustrated, escalating to tier 2.",
-     *   "messageType": "note"
+     *   "tagId": "67ec1234abcd5678ef901234",
+     *   "actingAdminId": "507f1f77bcf86cd799439011"
      * }
      * ```
      *
-     * ### Example Response
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const attachedConversationTag =
+     *   await client.support.conversations.attachTag('12345', {
+     *     actingAdminId: '507f1f77bcf86cd799439011',
+     *     tagId: '67ec1234abcd5678ef901234',
+     *   });
+     * ```
+     */
+    attachTag(id: string, params: ConversationAttachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
+    /**
+     * Removes a workspace tag from a conversation.
+     *
+     * This endpoint requires the `actingAdminId` of the admin on whose behalf the
+     * mutation is recorded.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The conversation ID (short ID)
+     * - `tagId` - The Featurebase tag ID to remove
+     *
+     * ### Request Body
+     *
+     * | Field           | Type   | Required | Description                                                              |
+     * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
+     * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
+     *
+     * ### Behavior
+     *
+     * Featurebase resolves the latest taggable reply/message in the conversation and
+     * records the tag removal against that part so audit metadata remains
+     * deterministic.
+     *
+     * ### Response
+     *
+     * Returns the affected tag payload with the most relevant attachment metadata
+     * available for that relationship.
+     *
+     * ### Example Request
      *
      * ```json
      * {
-     *   "object": "conversation_part",
-     *   "id": "3",
-     *   "partType": "user_msg",
-     *   "bodyHtml": "<p>Thank you for your help!</p>",
-     *   "bodyMarkdown": "Thank you for your help!",
-     *   "author": {
-     *     "type": "customer",
-     *     "id": "676f0f6765bdaa7d7d760f88",
-     *     "name": "John Doe",
-     *     "email": "john@example.com"
-     *   },
-     *   "channel": "desktop",
-     *   "createdAt": "2025-01-15T10:40:00.000Z",
-     *   "updatedAt": "2025-01-15T10:40:00.000Z"
+     *   "actingAdminId": "507f1f77bcf86cd799439011"
      * }
      * ```
      *
@@ -587,15 +579,17 @@ export declare class Conversations extends APIResource {
      *
      * @example
      * ```ts
-     * const conversationPart =
-     *   await client.support.conversations.reply('12345', {
-     *     bodyMarkdown: 'Thank you for your help!',
-     *     messageType: 'reply',
-     *     type: 'contact',
-     *   });
+     * const attachedConversationTag =
+     *   await client.support.conversations.detachTag(
+     *     '67ec1234abcd5678ef901234',
+     *     {
+     *       id: '12345',
+     *       actingAdminId: '507f1f77bcf86cd799439011',
+     *     },
+     *   );
      * ```
      */
-    reply(id: string, params: ConversationReplyParams, options?: RequestOptions): APIPromise<ConversationPart>;
+    detachTag(tagID: string, params: ConversationDetachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
     /**
      * Redacts a conversation part (message) from a conversation. Redaction permanently
      * removes the message content while preserving the conversation structure.
@@ -676,10 +670,8 @@ export declare class Conversations extends APIResource {
      */
     redact(params: ConversationRedactParams, options?: RequestOptions): APIPromise<Conversation>;
     /**
-     * Attaches a workspace tag to a conversation.
-     *
-     * This endpoint requires both the tag ID to attach and the `actingAdminId` of the
-     * admin on whose behalf the mutation is recorded.
+     * Adds a reply to an existing conversation. Supports both contact (customer/lead)
+     * and admin replies.
      *
      * ### Path Parameters
      *
@@ -687,78 +679,88 @@ export declare class Conversations extends APIResource {
      *
      * ### Request Body
      *
-     * | Field           | Type   | Required | Description                                                              |
-     * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
-     * | `tagId`         | string | Yes      | The Featurebase tag ID to attach                                         |
-     * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
-     *
-     * ### Behavior
-     *
-     * Featurebase resolves the latest taggable reply/message in the conversation and
-     * records the tag attachment against that part so audit metadata remains
-     * deterministic.
-     *
-     * ### Response
-     *
-     * Returns the affected tag plus attachment metadata such as `targetPartId`,
-     * `appliedAt`, and `appliedBy`.
-     *
-     * ### Example Request
-     *
-     * ```json
-     * {
-     *   "tagId": "67ec1234abcd5678ef901234",
-     *   "actingAdminId": "507f1f77bcf86cd799439011"
-     * }
-     * ```
-     *
-     * ### Version Availability
+     * The request body varies based on who is sending the reply:
      *
-     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     * #### Contact Reply (customer/lead)
      *
-     * @example
-     * ```ts
-     * const attachedConversationTag =
-     *   await client.support.conversations.attachTag('12345', {
-     *     actingAdminId: '507f1f77bcf86cd799439011',
-     *     tagId: '67ec1234abcd5678ef901234',
-     *   });
-     * ```
-     */
-    attachTag(id: string, params: ConversationAttachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
-    /**
-     * Removes a workspace tag from a conversation.
+     * | Field               | Type    | Required | Description                                                                                                                        |
+     * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+     * | `type`              | string  | Yes      | Must be "contact"                                                                                                                  |
+     * | `userId`            | string  | No\*     | External user ID from your system                                                                                                  |
+     * | `id`                | string  | No\*     | Featurebase contact ID (24-character ObjectId)                                                                                     |
+     * | `bodyMarkdown`      | string  | Yes      | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
+     * | `messageType`       | string  | Yes      | Must be "reply"                                                                                                                    |
+     * | `skipNotifications` | boolean | No       | Skip sending notifications (default: false). Useful for bulk imports.                                                              |
      *
-     * This endpoint requires the `actingAdminId` of the admin on whose behalf the
-     * mutation is recorded.
+     * \*At least one of `userId` or `id` is required.
      *
-     * ### Path Parameters
+     * #### Admin Reply
      *
-     * - `id` - The conversation ID (short ID)
-     * - `tagId` - The Featurebase tag ID to remove
+     * | Field               | Type    | Required | Description                                                                                                                        |
+     * | ------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+     * | `type`              | string  | Yes      | Must be "admin"                                                                                                                    |
+     * | `id`                | string  | Yes      | Featurebase admin ID (24-character ObjectId)                                                                                       |
+     * | `bodyMarkdown`      | string  | Yes      | The message content in markdown format. Images referenced by URL or as base64 data URIs will be automatically uploaded and stored. |
+     * | `messageType`       | string  | Yes      | "reply" for customer-visible reply, "note" for internal note                                                                       |
+     * | `skipNotifications` | boolean | No       | Skip sending notifications (default: false). Useful for bulk imports.                                                              |
      *
-     * ### Request Body
+     * ### Response
      *
-     * | Field           | Type   | Required | Description                                                              |
-     * | --------------- | ------ | -------- | ------------------------------------------------------------------------ |
-     * | `actingAdminId` | string | Yes      | The admin performing the mutation. Must be a member of the organization. |
+     * Returns the created conversation part object with a **201 Created** status. The
+     * response includes both `bodyHtml` (with signed image URLs) and `bodyMarkdown`
+     * fields.
      *
-     * ### Behavior
+     * ### Example Contact Reply
      *
-     * Featurebase resolves the latest taggable reply/message in the conversation and
-     * records the tag removal against that part so audit metadata remains
-     * deterministic.
+     * ```json
+     * {
+     *   "type": "contact",
+     *   "userId": "user_123",
+     *   "bodyMarkdown": "Thank you for your help!",
+     *   "messageType": "reply"
+     * }
+     * ```
      *
-     * ### Response
+     * ### Example Admin Reply
      *
-     * Returns the affected tag payload with the most relevant attachment metadata
-     * available for that relationship.
+     * ```json
+     * {
+     *   "type": "admin",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "bodyMarkdown": "I'm happy to help! Here's what you need to do...",
+     *   "messageType": "reply"
+     * }
+     * ```
      *
-     * ### Example Request
+     * ### Example Admin Note (Internal)
      *
      * ```json
      * {
-     *   "actingAdminId": "507f1f77bcf86cd799439011"
+     *   "type": "admin",
+     *   "id": "507f1f77bcf86cd799439011",
+     *   "bodyMarkdown": "Customer seems frustrated, escalating to tier 2.",
+     *   "messageType": "note"
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "conversation_part",
+     *   "id": "3",
+     *   "partType": "user_msg",
+     *   "bodyHtml": "<p>Thank you for your help!</p>",
+     *   "bodyMarkdown": "Thank you for your help!",
+     *   "author": {
+     *     "type": "customer",
+     *     "id": "676f0f6765bdaa7d7d760f88",
+     *     "name": "John Doe",
+     *     "email": "john@example.com"
+     *   },
+     *   "channel": "desktop",
+     *   "createdAt": "2025-01-15T10:40:00.000Z",
+     *   "updatedAt": "2025-01-15T10:40:00.000Z"
      * }
      * ```
      *
@@ -768,17 +770,15 @@ export declare class Conversations extends APIResource {
      *
      * @example
      * ```ts
-     * const attachedConversationTag =
-     *   await client.support.conversations.detachTag(
-     *     '67ec1234abcd5678ef901234',
-     *     {
-     *       id: '12345',
-     *       actingAdminId: '507f1f77bcf86cd799439011',
-     *     },
-     *   );
+     * const conversationPart =
+     *   await client.support.conversations.reply('12345', {
+     *     bodyMarkdown: 'Thank you for your help!',
+     *     messageType: 'reply',
+     *     type: 'contact',
+     *   });
      * ```
      */
-    detachTag(tagID: string, params: ConversationDetachTagParams, options?: RequestOptions): APIPromise<AttachedConversationTag>;
+    reply(id: string, params: ConversationReplyParams, options?: RequestOptions): APIPromise<ConversationPart>;
     /**
      * Search conversations with a structured filter AST and an optional full-text
      * query.
@@ -825,18 +825,53 @@ export declare class Conversations extends APIResource {
      * `participant_id`, `company_id`, `created_at`) are still accepted for back-compat
      * but are deprecated — please migrate to camelCase in new code.
      *
-     * | Field                      | Type                                                                        | Operators              |
-     * | -------------------------- | --------------------------------------------------------------------------- | ---------------------- |
-     * | `state`                    | enum (`open` / `closed` / `snoozed`)                                        | `=`, `!=`, `IN`, `NIN` |
-     * | `priority`                 | boolean                                                                     | `=`, `!=`              |
-     * | `adminAssigneeId`          | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN` |
-     * | `teamAssigneeId`           | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN` |
-     * | `brandId`                  | id or null                                                                  | `=`, `!=`, `IN`, `NIN` |
-     * | `tagIds`                   | id (matches any conversation containing this tag)                           | `=`, `!=`, `IN`, `NIN` |
-     * | `userId` / `participantId` | id of a conversation participant                                            | `=`, `!=`, `IN`, `NIN` |
-     * | `companyId`                | company id (matches conversations whose participants belong to the company) | `=`, `!=`, `IN`, `NIN` |
-     * | `mentionedAdminIds`        | admin id                                                                    | `=`, `!=`, `IN`, `NIN` |
-     * | `createdAt`                | unix seconds                                                                | `=`, `>`, `<`          |
+     * | Field                            | Type                                                                        | Operators                                                               |
+     * | -------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+     * | `state`                          | enum (`open` / `closed` / `snoozed`)                                        | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `priority`                       | boolean                                                                     | `=`, `!=`                                                               |
+     * | `adminAssigneeId`                | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `teamAssigneeId`                 | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `brandId`                        | id or null                                                                  | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `tagIds`                         | id (matches any conversation containing this tag)                           | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `userId` / `participantId`       | id of a conversation participant                                            | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `companyId`                      | company id (matches conversations whose participants belong to the company) | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `mentionedAdminIds`              | admin id                                                                    | `=`, `!=`, `IN`, `NIN`                                                  |
+     * | `createdAt`                      | unix seconds                                                                | `=`, `>`, `<`                                                           |
+     * | `customAttributes.<attributeId>` | conversation custom attribute (see below)                                   | `=`, `!=`, `IN`, `NIN`; plus `>`, `<`, `>=`, `<=` for `number` / `date` |
+     *
+     * ### Filtering by custom attributes
+     *
+     * Any non-archived conversation custom attribute can be used as a filter field via
+     * `customAttributes.<attributeId>`, where `<attributeId>` is the attribute's `id`
+     * from `GET /v2/conversation_attributes`. The accepted value shape follows the
+     * attribute's `fieldSubType`:
+     *
+     * - `select` / `multi-select` — pass an option **label** (e.g.
+     *   `"Product question"`) or an option **id**; both are matched interchangeably,
+     *   and id-based filters keep working after options are renamed
+     * - `text` — string
+     * - `number` — number; range operators (`>`, `<`, `>=`, `<=`) are supported
+     * - `date` — ISO 8601 string or unix seconds; range operators are supported
+     * - `checkbox` — boolean
+     *
+     * Example — all conversations where the "Issue type" select attribute is "Product
+     * question":
+     *
+     * ```json
+     * {
+     *   "query": {
+     *     "field": "customAttributes.6863d3fca1234b0d5e15c86c",
+     *     "operator": "=",
+     *     "value": "Product question"
+     *   },
+     *   "include": ["customAttributeDefinitions"]
+     * }
+     * ```
+     *
+     * Referencing an attribute id that does not exist (or has been archived) returns a
+     * `field_unknown` error. Set `include` to `["customAttributeDefinitions"]` to get
+     * each returned conversation's attribute values resolved with names and types
+     * alongside the ID-keyed `customAttributes` map.
      *
      * For unbounded fields a query consisting only of `!=` or `NIN` clauses is
      * rejected with `query_too_broad` to prevent full-org scans. Combine the negation
@@ -844,6 +879,16 @@ export declare class Conversations extends APIResource {
      * fields (`state`, `priority`) are exempt because their negation is naturally
      * bounded.
      *
+     * ### Inbox visibility
+     *
+     * An open-state filter uses the same visibility rule as the Featurebase dashboard
+     * inbox. Workflow and outbound-message shells are excluded until a customer or
+     * lead interacts with them. As a result, `state = "open"` (or an `IN`/`NIN` filter
+     * that resolves exclusively to open) returns the conversations shown in the
+     * dashboard's open inbox rather than unreplied campaign or automation shells.
+     * Searches without an open-only state filter keep their existing organization-wide
+     * semantics.
+     *
      * ### Pagination
      *
      * Cursor-based, `limit` between 1 and 100 (default 10). Pagination cursors are
@@ -1106,9 +1151,11 @@ export declare namespace Conversation {
          */
         requestId: string;
         /**
-         * Source that created the CSAT request
+         * Source that created the CSAT request. `workflow` = Ask For Conversation Rating
+         * workflow action, `fibi_auto` = automatic Fibi AI Agent survey on
+         * resolve/handoff.
          */
-        requestSource: 'workflow';
+        requestSource: 'workflow' | 'fibi_auto';
         /**
          * Lifecycle status for this historical CSAT request
          */
@@ -1191,7 +1238,7 @@ export declare namespace Conversation {
         /**
          * Source of the latest CSAT request when known
          */
-        requestSource?: 'workflow';
+        requestSource?: 'workflow' | 'fibi_auto';
         /**
          * CSAT score from 1 to 5 when rated
          */
@@ -1636,9 +1683,11 @@ export declare namespace ConversationPart {
              */
             requestId: string;
             /**
-             * Source that created the CSAT request
+             * Source that created the CSAT request. `workflow` = Ask For Conversation Rating
+             * workflow action, `fibi_auto` = automatic Fibi AI Agent survey on
+             * resolve/handoff.
              */
-            requestSource: 'workflow';
+            requestSource: 'workflow' | 'fibi_auto';
             /**
              * Status of the CSAT request represented by this part
              */
@@ -1707,9 +1756,11 @@ export declare namespace ConversationPart {
              */
             requestId: string;
             /**
-             * Source that created the CSAT request
+             * Source that created the CSAT request. `workflow` = Ask For Conversation Rating
+             * workflow action, `fibi_auto` = automatic Fibi AI Agent survey on
+             * resolve/handoff.
              */
-            requestSource: 'workflow';
+            requestSource: 'workflow' | 'fibi_auto';
             /**
              * CSAT score from 1 to 5
              */
@@ -2561,24 +2612,6 @@ export declare namespace ConversationSearchResponse {
         }
     }
 }
-export interface ConversationListParams extends CursorPageParams {
-    /**
-     * Query param: Comma-separated optional expansions. Use
-     * `customAttributeDefinitions` to return `customAttributeValues` with names and
-     * types alongside ID-keyed `customAttributes`.
-     */
-    include?: string | Array<string>;
-    /**
-     * Query param: Filter conversations by one or more tag IDs using a comma-separated
-     * list. Conversations must contain all provided tags.
-     */
-    tagIds?: string | Array<string>;
-    /**
-     * 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 interface ConversationCreateParams {
     /**
      * Body param: The content of the initial message in markdown format. Images
@@ -2616,7 +2649,7 @@ export interface ConversationCreateParams {
      * 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 ConversationCreateParams {
     /**
@@ -2675,14 +2708,7 @@ export interface ConversationRetrieveParams {
      * 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 interface ConversationDeleteParams {
-    /**
-     * 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 ConversationUpdateParams {
     /**
@@ -2729,7 +2755,7 @@ export interface ConversationUpdateParams {
      * 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 ConversationUpdateParams {
     /**
@@ -2757,6 +2783,88 @@ export declare namespace ConversationUpdateParams {
         contactIds?: Array<string>;
     }
 }
+export interface ConversationListParams extends CursorPageParams {
+    /**
+     * Query param: Comma-separated optional expansions. Use
+     * `customAttributeDefinitions` to return `customAttributeValues` with names and
+     * types alongside ID-keyed `customAttributes`.
+     */
+    include?: string | Array<string>;
+    /**
+     * Query param: Filter conversations by one or more tag IDs using a comma-separated
+     * list. Conversations must contain all provided tags.
+     */
+    tagIds?: string | Array<string>;
+    /**
+     * Header param: 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 ConversationDeleteParams {
+    /**
+     * 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 ConversationAttachTagParams {
+    /**
+     * Body param: Required admin ID performing this tag attachment. Must be a member
+     * of the organization so the mutation can be attributed to a real admin actor.
+     */
+    actingAdminId: string;
+    /**
+     * Body param: The Featurebase tag ID to attach to the conversation.
+     */
+    tagId: string;
+    /**
+     * Header param: 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 ConversationDetachTagParams {
+    /**
+     * Path param: Conversation ID (short ID)
+     */
+    id: string;
+    /**
+     * Body param: Required admin ID performing this tag removal. Must be a member of
+     * the organization so the mutation can be attributed to a real admin actor.
+     */
+    actingAdminId: string;
+    /**
+     * Header param: 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 ConversationRedactParams {
+    /**
+     * Body param: The conversation short ID that contains the part to redact
+     */
+    conversationId: string;
+    /**
+     * Body param: The conversation part short ID to redact
+     */
+    conversationPartId: string;
+    /**
+     * Body param: The type of item to redact. Currently only "conversation_part" is
+     * supported.
+     */
+    type: 'conversation_part';
+    /**
+     * Body param: The admin ID performing this action. If not provided, changes are
+     * attributed to the system bot user.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: 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 type ConversationReplyParams = ConversationReplyParams.ContactReplyBody | ConversationReplyParams.AdminReplyBody;
 export declare namespace ConversationReplyParams {
     interface ContactReplyBody {
@@ -2791,7 +2899,7 @@ export declare namespace ConversationReplyParams {
          * 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';
     }
     interface AdminReplyBody {
         /**
@@ -2822,66 +2930,9 @@ export declare namespace ConversationReplyParams {
          * 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 ConversationRedactParams {
-    /**
-     * Body param: The conversation short ID that contains the part to redact
-     */
-    conversationId: string;
-    /**
-     * Body param: The conversation part short ID to redact
-     */
-    conversationPartId: string;
-    /**
-     * Body param: The type of item to redact. Currently only "conversation_part" is
-     * supported.
-     */
-    type: 'conversation_part';
-    /**
-     * Body param: The admin ID performing this action. If not provided, changes are
-     * attributed to the system bot user.
-     */
-    actingAdminId?: string;
-    /**
-     * 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 interface ConversationAttachTagParams {
-    /**
-     * Body param: Required admin ID performing this tag attachment. Must be a member
-     * of the organization so the mutation can be attributed to a real admin actor.
-     */
-    actingAdminId: string;
-    /**
-     * Body param: The Featurebase tag ID to attach to the conversation.
-     */
-    tagId: string;
-    /**
-     * 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 interface ConversationDetachTagParams {
-    /**
-     * Path param: Conversation ID (short ID)
-     */
-    id: string;
-    /**
-     * Body param: Required admin ID performing this tag removal. Must be a member of
-     * the organization so the mutation can be attributed to a real admin actor.
-     */
-    actingAdminId: string;
-    /**
-     * 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 interface ConversationSearchParams {
     /**
      * Body param: An opaque cursor for pagination. Use the nextCursor value from a
@@ -2923,10 +2974,10 @@ export interface ConversationSearchParams {
      * 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 Conversations {
-    export { type AttachedConversationTag as AttachedConversationTag, type Conversation as Conversation, type ConversationAttributeValue as ConversationAttributeValue, type ConversationPart as ConversationPart, type ConversationPartAuthor as ConversationPartAuthor, type ConversationParticipant as ConversationParticipant, type ConversationTagApplication as ConversationTagApplication, type ConversationTagMutationActor as ConversationTagMutationActor, type CsatEmailDelivery as CsatEmailDelivery, type CsatRatedAgent as CsatRatedAgent, type CsatSlackDelivery as CsatSlackDelivery, type CsatWorkflowLink as CsatWorkflowLink, type EmailRecipients as EmailRecipients, type MessageSource as MessageSource, type SearchMatchingPartAuthor as SearchMatchingPartAuthor, type SlackMessageDetails as SlackMessageDetails, type ConversationDeleteResponse as ConversationDeleteResponse, type ConversationSearchResponse as ConversationSearchResponse, type ConversationsCursorPage as ConversationsCursorPage, type ConversationListParams as ConversationListParams, type ConversationCreateParams as ConversationCreateParams, type ConversationRetrieveParams as ConversationRetrieveParams, type ConversationDeleteParams as ConversationDeleteParams, type ConversationUpdateParams as ConversationUpdateParams, type ConversationReplyParams as ConversationReplyParams, type ConversationRedactParams as ConversationRedactParams, type ConversationAttachTagParams as ConversationAttachTagParams, type ConversationDetachTagParams as ConversationDetachTagParams, type ConversationSearchParams as ConversationSearchParams, };
+    export { type AttachedConversationTag as AttachedConversationTag, type Conversation as Conversation, type ConversationAttributeValue as ConversationAttributeValue, type ConversationPart as ConversationPart, type ConversationPartAuthor as ConversationPartAuthor, type ConversationParticipant as ConversationParticipant, type ConversationTagApplication as ConversationTagApplication, type ConversationTagMutationActor as ConversationTagMutationActor, type CsatEmailDelivery as CsatEmailDelivery, type CsatRatedAgent as CsatRatedAgent, type CsatSlackDelivery as CsatSlackDelivery, type CsatWorkflowLink as CsatWorkflowLink, type EmailRecipients as EmailRecipients, type MessageSource as MessageSource, type SearchMatchingPartAuthor as SearchMatchingPartAuthor, type SlackMessageDetails as SlackMessageDetails, type ConversationDeleteResponse as ConversationDeleteResponse, type ConversationSearchResponse as ConversationSearchResponse, type ConversationsCursorPage as ConversationsCursorPage, type ConversationCreateParams as ConversationCreateParams, type ConversationRetrieveParams as ConversationRetrieveParams, type ConversationUpdateParams as ConversationUpdateParams, type ConversationListParams as ConversationListParams, type ConversationDeleteParams as ConversationDeleteParams, type ConversationAttachTagParams as ConversationAttachTagParams, type ConversationDetachTagParams as ConversationDetachTagParams, type ConversationRedactParams as ConversationRedactParams, type ConversationReplyParams as ConversationReplyParams, type ConversationSearchParams as ConversationSearchParams, };
     export { Participants as Participants, type ParticipantAddParams as ParticipantAddParams, type ParticipantRemoveParams as ParticipantRemoveParams, };
 }
 //# sourceMappingURL=conversations.d.ts.map