featurebase-node 0.14.3 → 0.15.1

package/src/resources/support/conversations/conversations.ts

@@ -19,95 +19,6 @@ import { path } from '../../../internal/utils/path';
 export class Conversations extends APIResource {
   participants: ParticipantsAPI.Participants = new ParticipantsAPI.Participants(this._client);
 
-  /**
-   * 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> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/conversations', CursorPage<Conversation>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Creates a new conversation. Supports both contact-initiated (customer/lead) and
    * admin-initiated (outreach) conversations.
@@ -381,59 +292,6 @@ export class Conversations extends APIResource {
     });
   }
 
-  /**
-   * 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> {
-    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.delete(path`/v2/conversations/${id}`, {
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Updates a conversation's properties. Supports partial updates - only provided
    * fields will be updated.
@@ -578,118 +436,82 @@ export class Conversations extends APIResource {
   }
 
   /**
-   * Adds a reply to an existing conversation. Supports both contact (customer/lead)
-   * and admin replies.
-   *
-   * ### Path Parameters
-   *
-   * - `id` - The conversation ID (short ID)
-   *
-   * ### Request Body
+   * Returns a list of conversations in your organization using cursor-based
+   * pagination.
    *
-   * The request body varies based on who is sending the reply:
+   * ### Query Parameters
    *
-   * #### Contact Reply (customer/lead)
+   * - `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.
    *
-   * | 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.                                                              |
+   * ### Response Format
    *
-   * \*At least one of `userId` or `id` is required.
+   * Returns a list object with:
    *
-   * #### Admin Reply
+   * - `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 "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.                                                              |
+   * ### Conversation Object
    *
-   * ### Response
+   * Each conversation includes:
    *
-   * Returns the created conversation part object with a **201 Created** status. The
-   * response includes both `bodyHtml` (with signed image URLs) and `bodyMarkdown`
-   * fields.
+   * - `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 Contact Reply
+   * ### Example
    *
    * ```json
    * {
-   *   "type": "contact",
-   *   "userId": "user_123",
-   *   "bodyMarkdown": "Thank you for your help!",
-   *   "messageType": "reply"
+   *   "object": "list",
+   *   "data": [
+   *     {
+   *       "object": "conversation",
+   *       "id": "12345",
+   *       "title": "Question about pricing",
+   *       "state": "open",
+   *       "priority": false,
+   *       "adminAssigneeId": null,
+   *       "participants": [
+   *         { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" }
+   *       ],
+   *       ...
+   *     }
+   *   ],
+   *   "nextCursor": "eyJpZCI6IjEyMzQ1In0="
    * }
    * ```
    *
-   * ### Example Admin Reply
-   *
-   * ```json
-   * {
-   *   "type": "admin",
-   *   "id": "507f1f77bcf86cd799439011",
-   *   "bodyMarkdown": "I'm happy to help! Here's what you need to do...",
-   *   "messageType": "reply"
-   * }
-   * ```
+   * ### Version Availability
    *
-   * ### Example Admin Note (Internal)
+   * This endpoint is only available in API version 2026-01-01.nova and newer.
    *
-   * ```json
-   * {
-   *   "type": "admin",
-   *   "id": "507f1f77bcf86cd799439011",
-   *   "bodyMarkdown": "Customer seems frustrated, escalating to tier 2.",
-   *   "messageType": "note"
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const conversation of client.support.conversations.list()) {
+   *   // ...
    * }
    * ```
-   *
-   * ### 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"
-   * }
-   * ```
-   *
-   * ### Version Availability
-   *
-   * This endpoint is only available in API version 2026-01-01.nova and newer.
-   *
-   * @example
-   * ```ts
-   * const conversationPart =
-   *   await client.support.conversations.reply('12345', {
-   *     bodyMarkdown: 'Thank you for your help!',
-   *     messageType: 'reply',
-   *     type: 'contact',
-   *   });
-   * ```
    */
-  reply(id: string, params: ConversationReplyParams, options?: RequestOptions): APIPromise<ConversationPart> {
-    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
-    return this._client.post(path`/v2/conversations/${id}/reply`, {
-      body,
+  list(
+    params: ConversationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ConversationsCursorPage, Conversation> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/conversations', CursorPage<Conversation>, {
+      query,
       ...options,
       headers: buildHeaders([
         {
@@ -703,68 +525,28 @@ export class Conversations extends APIResource {
   }
 
   /**
-   * Redacts a conversation part (message) from a conversation. Redaction permanently
-   * removes the message content while preserving the conversation structure.
-   *
-   * Only human message types can be redacted:
-   *
-   * - `user_msg` - Messages from customers/leads
-   * - `admin_msg` - Messages from admins
-   * - `email_msg` - Email messages
-   * - `bot_msg` - Bot messages
-   *
-   * System-generated conversation parts (assignments, status changes, etc.) cannot
-   * be redacted.
+   * Permanently deletes a conversation by its short ID.
    *
-   * ### Request Body
+   * ### Path Parameters
    *
-   * | Field                | Type   | Required | Description                                                                    |
-   * | -------------------- | ------ | -------- | ------------------------------------------------------------------------------ |
-   * | `type`               | string | Yes      | The type of item to redact. Currently only `"conversation_part"` is supported. |
-   * | `conversationId`     | string | Yes      | The conversation short ID containing the part to redact                        |
-   * | `conversationPartId` | string | Yes      | The conversation part short ID to redact                                       |
-   * | `actingAdminId`      | string | No       | Admin ID performing the action (for attribution)                               |
+   * - `id` - The conversation short ID (numeric)
    *
    * ### Response
    *
-   * Returns the updated conversation object.
-   *
-   * ### Example Request
-   *
-   * ```json
-   * {
-   *   "type": "conversation_part",
-   *   "conversationId": "12345",
-   *   "conversationPartId": "67890",
-   *   "actingAdminId": "507f1f77bcf86cd799439011"
-   * }
-   * ```
-   *
-   * ### Example Response
+   * Returns a deletion confirmation object:
    *
    * ```json
    * {
-   *   "object": "conversation",
    *   "id": "12345",
-   *   "conversationParts": [
-   *     {
-   *       "object": "conversation_part",
-   *       "id": "67890",
-   *       "partType": "user_msg",
-   *       "bodyHtml": "",
-   *       "bodyMarkdown": "",
-   *       "redacted": true,
-   *       ...
-   *     }
-   *   ],
-   *   ...
+   *   "object": "conversation",
+   *   "deleted": true
    * }
    * ```
    *
-   * ### Error Cases
+   * ### Caution
    *
-   * - **400 Bad Request** - Only human messages can be redacted
-   * - **404 Not Found** - Conversation or conversation part not found
+   * This operation is **irreversible**. The conversation and all its messages will
+   * be permanently deleted.
    *
    * ### Version Availability
    *
@@ -773,17 +555,16 @@ export class Conversations extends APIResource {
    * @example
    * ```ts
    * const conversation =
-   *   await client.support.conversations.redact({
-   *     conversationId: '12345',
-   *     conversationPartId: '67890',
-   *     type: 'conversation_part',
-   *   });
+   *   await client.support.conversations.delete('12345');
    * ```
    */
-  redact(params: ConversationRedactParams, options?: RequestOptions): APIPromise<Conversation> {
-    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
-    return this._client.post('/v2/conversations/redact', {
-      body,
+  delete(
+    id: string,
+    params: ConversationDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConversationDeleteResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.delete(path`/v2/conversations/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -894,11 +675,236 @@ export class Conversations extends APIResource {
    * Returns the affected tag payload with the most relevant attachment metadata
    * available for that relationship.
    *
-   * ### Example Request
+   * ### Example Request
+   *
+   * ```json
+   * {
+   *   "actingAdminId": "507f1f77bcf86cd799439011"
+   * }
+   * ```
+   *
+   * ### Version Availability
+   *
+   * This endpoint is only available in API version 2026-01-01.nova and newer.
+   *
+   * @example
+   * ```ts
+   * const attachedConversationTag =
+   *   await client.support.conversations.detachTag(
+   *     '67ec1234abcd5678ef901234',
+   *     {
+   *       id: '12345',
+   *       actingAdminId: '507f1f77bcf86cd799439011',
+   *     },
+   *   );
+   * ```
+   */
+  detachTag(
+    tagID: string,
+    params: ConversationDetachTagParams,
+    options?: RequestOptions,
+  ): APIPromise<AttachedConversationTag> {
+    const { id, 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.delete(path`/v2/conversations/${id}/tags/${tagID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Redacts a conversation part (message) from a conversation. Redaction permanently
+   * removes the message content while preserving the conversation structure.
+   *
+   * Only human message types can be redacted:
+   *
+   * - `user_msg` - Messages from customers/leads
+   * - `admin_msg` - Messages from admins
+   * - `email_msg` - Email messages
+   * - `bot_msg` - Bot messages
+   *
+   * System-generated conversation parts (assignments, status changes, etc.) cannot
+   * be redacted.
+   *
+   * ### Request Body
+   *
+   * | Field                | Type   | Required | Description                                                                    |
+   * | -------------------- | ------ | -------- | ------------------------------------------------------------------------------ |
+   * | `type`               | string | Yes      | The type of item to redact. Currently only `"conversation_part"` is supported. |
+   * | `conversationId`     | string | Yes      | The conversation short ID containing the part to redact                        |
+   * | `conversationPartId` | string | Yes      | The conversation part short ID to redact                                       |
+   * | `actingAdminId`      | string | No       | Admin ID performing the action (for attribution)                               |
+   *
+   * ### Response
+   *
+   * Returns the updated conversation object.
+   *
+   * ### Example Request
+   *
+   * ```json
+   * {
+   *   "type": "conversation_part",
+   *   "conversationId": "12345",
+   *   "conversationPartId": "67890",
+   *   "actingAdminId": "507f1f77bcf86cd799439011"
+   * }
+   * ```
+   *
+   * ### Example Response
+   *
+   * ```json
+   * {
+   *   "object": "conversation",
+   *   "id": "12345",
+   *   "conversationParts": [
+   *     {
+   *       "object": "conversation_part",
+   *       "id": "67890",
+   *       "partType": "user_msg",
+   *       "bodyHtml": "",
+   *       "bodyMarkdown": "",
+   *       "redacted": true,
+   *       ...
+   *     }
+   *   ],
+   *   ...
+   * }
+   * ```
+   *
+   * ### Error Cases
+   *
+   * - **400 Bad Request** - Only human messages can be redacted
+   * - **404 Not Found** - Conversation or conversation part not found
+   *
+   * ### Version Availability
+   *
+   * This endpoint is only available in API version 2026-01-01.nova and newer.
+   *
+   * @example
+   * ```ts
+   * const conversation =
+   *   await client.support.conversations.redact({
+   *     conversationId: '12345',
+   *     conversationPartId: '67890',
+   *     type: 'conversation_part',
+   *   });
+   * ```
+   */
+  redact(params: ConversationRedactParams, options?: RequestOptions): APIPromise<Conversation> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.post('/v2/conversations/redact', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Adds a reply to an existing conversation. Supports both contact (customer/lead)
+   * and admin replies.
+   *
+   * ### Path Parameters
+   *
+   * - `id` - The conversation ID (short ID)
+   *
+   * ### Request Body
+   *
+   * The request body varies based on who is sending the reply:
+   *
+   * #### Contact Reply (customer/lead)
+   *
+   * | 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.                                                              |
+   *
+   * \*At least one of `userId` or `id` is required.
+   *
+   * #### Admin Reply
+   *
+   * | 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.                                                              |
+   *
+   * ### Response
+   *
+   * Returns the created conversation part object with a **201 Created** status. The
+   * response includes both `bodyHtml` (with signed image URLs) and `bodyMarkdown`
+   * fields.
+   *
+   * ### Example Contact Reply
+   *
+   * ```json
+   * {
+   *   "type": "contact",
+   *   "userId": "user_123",
+   *   "bodyMarkdown": "Thank you for your help!",
+   *   "messageType": "reply"
+   * }
+   * ```
+   *
+   * ### Example Admin Reply
+   *
+   * ```json
+   * {
+   *   "type": "admin",
+   *   "id": "507f1f77bcf86cd799439011",
+   *   "bodyMarkdown": "I'm happy to help! Here's what you need to do...",
+   *   "messageType": "reply"
+   * }
+   * ```
+   *
+   * ### Example Admin Note (Internal)
+   *
+   * ```json
+   * {
+   *   "type": "admin",
+   *   "id": "507f1f77bcf86cd799439011",
+   *   "bodyMarkdown": "Customer seems frustrated, escalating to tier 2.",
+   *   "messageType": "note"
+   * }
+   * ```
+   *
+   * ### Example Response
    *
    * ```json
    * {
-   *   "actingAdminId": "507f1f77bcf86cd799439011"
+   *   "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"
    * }
    * ```
    *
@@ -908,23 +914,17 @@ export 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> {
-    const { id, 'Featurebase-Version': featurebaseVersion, ...body } = params;
-    return this._client.delete(path`/v2/conversations/${id}/tags/${tagID}`, {
+  reply(id: string, params: ConversationReplyParams, options?: RequestOptions): APIPromise<ConversationPart> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.post(path`/v2/conversations/${id}/reply`, {
       body,
       ...options,
       headers: buildHeaders([
@@ -1038,6 +1038,16 @@ export 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
@@ -1536,6 +1546,12 @@ export interface ConversationAttributeValue {
    */
   options?: Array<ConversationAttributesAPI.ConversationAttributeOption>;
 
+  /**
+   * Whether teammates must set a value before closing a conversation from the Inbox.
+   * Closes via the API, workflows, and Fibi are not blocked.
+   */
+  required?: boolean;
+
   /**
    * The conversation-specific custom attribute value.
    */
@@ -2673,7 +2689,17 @@ export interface CsatEmailDelivery {
   /**
    * Email delivery status for the CSAT request when applicable
    */
-  status: 'pending' | 'sent' | 'failed';
+  status: 'pending' | 'sending' | 'ambiguous' | 'retry_wait' | 'sent' | 'failed';
+
+  /**
+   * Number of delivery attempts made for this CSAT email
+   */
+  attempts?: number;
+
+  /**
+   * ISO timestamp when the current delivery attempt was durably claimed
+   */
+  claimedAt?: string;
 
   /**
    * ISO timestamp when the CSAT email failed
@@ -2685,11 +2711,21 @@ export interface CsatEmailDelivery {
    */
   failureReason?: string;
 
+  /**
+   * Stable provider-correlation key for this CSAT delivery
+   */
+  idempotencyKey?: string;
+
   /**
    * Email message ID associated with delivery
    */
   messageId?: string;
 
+  /**
+   * ISO timestamp when a retry-waiting CSAT email may be attempted again
+   */
+  nextAttemptAt?: string;
+
   /**
    * ISO timestamp when the CSAT email was sent
    */
@@ -3159,27 +3195,6 @@ export 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
@@ -3223,7 +3238,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 namespace ConversationCreateParams {
@@ -3291,15 +3306,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 {
@@ -3353,7 +3360,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 namespace ConversationUpdateParams {
@@ -3386,6 +3393,103 @@ export namespace ConversationUpdateParams {
   }
 }
 
+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;
@@ -3429,7 +3533,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';
   }
 
   export interface AdminReplyBody {
@@ -3466,78 +3570,10 @@ 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
@@ -3585,7 +3621,7 @@ 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';
 }
 
 Conversations.Participants = Participants;
@@ -3611,15 +3647,15 @@ export declare namespace Conversations {
     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 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,
   };