featurebase-node 0.14.3 → 0.15.1

package/src/resources/conversation-attributes.ts

@@ -11,23 +11,19 @@ import { path } from '../internal/utils/path';
  */
 export class ConversationAttributes extends APIResource {
   /**
-   * Returns conversation custom attribute definitions configured in your
-   * organization.
-   *
-   * Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
-   * Use this endpoint to map those IDs to display names, identifiers, data types,
-   * field subtypes, and select options.
+   * Retrieves a single conversation custom attribute definition by its stable ID.
    *
-   * By default, archived definitions are excluded. Set `includeArchived=true` to
-   * include archived definitions.
+   * Use this when a conversation response contains a `customAttributes` key and you
+   * need the corresponding display name, identifier, data type, field subtype, or
+   * options.
    */
-  list(
-    params: ConversationAttributeListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: ConversationAttributeRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ConversationAttributeListResponse> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/conversation_attributes', {
-      query,
+  ): APIPromise<ConversationAttribute> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/conversation_attributes/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -41,19 +37,23 @@ export class ConversationAttributes extends APIResource {
   }
 
   /**
-   * Retrieves a single conversation custom attribute definition by its stable ID.
+   * Returns conversation custom attribute definitions configured in your
+   * organization.
    *
-   * Use this when a conversation response contains a `customAttributes` key and you
-   * need the corresponding display name, identifier, data type, field subtype, or
-   * options.
+   * Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
+   * Use this endpoint to map those IDs to display names, identifiers, data types,
+   * field subtypes, and select options.
+   *
+   * By default, archived definitions are excluded. Set `includeArchived=true` to
+   * include archived definitions.
    */
-  retrieve(
-    id: string,
-    params: ConversationAttributeRetrieveParams | null | undefined = {},
+  list(
+    params: ConversationAttributeListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ConversationAttribute> {
-    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/conversation_attributes/${id}`, {
+  ): APIPromise<ConversationAttributeListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.get('/v2/conversation_attributes', {
+      query,
       ...options,
       headers: buildHeaders([
         {
@@ -113,6 +113,12 @@ export interface ConversationAttribute {
    */
   options?: Array<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;
+
   /**
    * ISO timestamp when the attribute was last updated.
    */
@@ -149,6 +155,14 @@ export interface ConversationAttributeListResponse {
   object: 'list';
 }
 
+export interface ConversationAttributeRetrieveParams {
+  /**
+   * 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 ConversationAttributeListParams {
   /**
    * Query param: Include archived conversation custom attributes in the response.
@@ -159,15 +173,7 @@ export interface ConversationAttributeListParams {
    * 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 ConversationAttributeRetrieveParams {
-  /**
-   * 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 ConversationAttributes {
@@ -175,7 +181,7 @@ export declare namespace ConversationAttributes {
     type ConversationAttribute as ConversationAttribute,
     type ConversationAttributeOption as ConversationAttributeOption,
     type ConversationAttributeListResponse as ConversationAttributeListResponse,
-    type ConversationAttributeListParams as ConversationAttributeListParams,
     type ConversationAttributeRetrieveParams as ConversationAttributeRetrieveParams,
+    type ConversationAttributeListParams as ConversationAttributeListParams,
   };
 }

package/src/resources/feedback/boards.ts

@@ -11,28 +11,25 @@ import { path } from '../../internal/utils/path';
  */
 export class Boards extends APIResource {
   /**
-   * Returns all boards (post categories) for the authenticated organization.
-   *
-   * Boards are containers for posts/feedback. Each board can have different:
-   *
-   * - Access controls (public, private, segment-restricted)
-   * - Feature toggles (comments, posting enabled)
-   * - Custom fields
+   * Retrieves a single board by its unique identifier.
    *
-   * This endpoint returns all boards without pagination. Organizations typically
-   * have a small number of boards.
+   * Returns the full board object including all access controls, feature toggles,
+   * and localization settings.
    *
    * @example
    * ```ts
-   * const boards = await client.feedback.boards.list();
+   * const board = await client.feedback.boards.retrieve(
+   *   '507f1f77bcf86cd799439011',
+   * );
    * ```
    */
-  list(
-    params: BoardListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: BoardRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<BoardListResponse> {
+  ): APIPromise<Board> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get('/v2/boards', {
+    return this._client.get(path`/v2/boards/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -46,25 +43,28 @@ export class Boards extends APIResource {
   }
 
   /**
-   * Retrieves a single board by its unique identifier.
+   * Returns all boards (post categories) for the authenticated organization.
    *
-   * Returns the full board object including all access controls, feature toggles,
-   * and localization settings.
+   * Boards are containers for posts/feedback. Each board can have different:
+   *
+   * - Access controls (public, private, segment-restricted)
+   * - Feature toggles (comments, posting enabled)
+   * - Custom fields
+   *
+   * This endpoint returns all boards without pagination. Organizations typically
+   * have a small number of boards.
    *
    * @example
    * ```ts
-   * const board = await client.feedback.boards.retrieve(
-   *   '507f1f77bcf86cd799439011',
-   * );
+   * const boards = await client.feedback.boards.list();
    * ```
    */
-  retrieve(
-    id: string,
-    params: BoardRetrieveParams | null | undefined = {},
+  list(
+    params: BoardListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Board> {
+  ): APIPromise<BoardListResponse> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/boards/${id}`, {
+    return this._client.get('/v2/boards', {
       ...options,
       headers: buildHeaders([
         {
@@ -253,27 +253,27 @@ export namespace Board {
 
 export type BoardListResponse = Array<Board>;
 
-export interface BoardListParams {
+export interface BoardRetrieveParams {
   /**
    * 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 BoardRetrieveParams {
+export interface BoardListParams {
   /**
    * 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 Boards {
   export {
     type Board as Board,
     type BoardListResponse as BoardListResponse,
-    type BoardListParams as BoardListParams,
     type BoardRetrieveParams as BoardRetrieveParams,
+    type BoardListParams as BoardListParams,
   };
 }

package/src/resources/feedback/comments.ts

@@ -14,103 +14,6 @@ import { path } from '../../internal/utils/path';
  * Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.
  */
 export class Comments extends APIResource {
-  /**
-   * Returns comments for your organization.
-   *
-   * Comments are threaded discussions. Each comment can have:
-   *
-   * - Author information
-   * - Voting (upvotes/downvotes)
-   * - Privacy settings (public/private)
-   * - Moderation status
-   * - Parent comment reference for threading
-   *
-   * ### Filtering
-   *
-   * Optionally filter by:
-   *
-   * - `postId` - Get comments for a specific post
-   * - `changelogId` - Get comments for a specific changelog
-   *
-   * If no filter is provided, returns all comments across the organization.
-   *
-   * ### Pagination
-   *
-   * This endpoint uses **cursor-based pagination**:
-   *
-   * - `limit` - Number of comments to return (1-100, default 10)
-   * - `cursor` - Opaque cursor from a previous response's `nextCursor` field
-   *
-   * **Example:** To paginate through results:
-   *
-   * 1. First request: `GET /v2/comments?postId={id}&limit=10`
-   * 2. If `nextCursor` is not null, use it for the next page
-   * 3. Next request: `GET /v2/comments?postId={id}&limit=10&cursor={nextCursor}`
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
-   *
-   * - `object` - Always "list"
-   * - `data` - Array of comment objects (flat structure with `parentCommentId` for
-   *   threading)
-   * - `nextCursor` - Cursor for the next page (null if no more results)
-   *
-   * ### Comment Structure
-   *
-   * Each comment includes:
-   *
-   * - `id` - Unique comment identifier
-   * - `postId` / `changelogId` - Reference to the parent content
-   * - `parentCommentId` - Reference to parent comment (null for root comments)
-   * - `content` - Comment content in HTML format
-   * - `author` - Author information (id, name, profilePicture, type)
-   * - `upvotes` / `downvotes` / `score` - Voting metrics
-   * - `isPrivate` - Whether comment is only visible to admins
-   * - `inReview` - Whether comment is pending moderation
-   * - `created` / `updated` - Unix timestamps
-   *
-   * ### Additional Filters
-   *
-   * - `privacy` - Filter by privacy: "public", "private", or "all"
-   * - `inReview` - Filter by moderation status (true/false)
-   *
-   * ### Sorting
-   *
-   * Use `sortBy` to sort results:
-   *
-   * - `best` - Sort by confidence score (default, like Reddit)
-   * - `top` - Sort by net score (upvotes - downvotes)
-   * - `new` - Sort by creation date, newest first
-   * - `old` - Sort by creation date, oldest first
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const comment of client.feedback.comments.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: CommentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<CommentsCursorPage, Comment> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/comments', CursorPage<Comment>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Creates a new comment or reply to an existing comment.
    *
@@ -298,6 +201,103 @@ export class Comments extends APIResource {
     });
   }
 
+  /**
+   * Returns comments for your organization.
+   *
+   * Comments are threaded discussions. Each comment can have:
+   *
+   * - Author information
+   * - Voting (upvotes/downvotes)
+   * - Privacy settings (public/private)
+   * - Moderation status
+   * - Parent comment reference for threading
+   *
+   * ### Filtering
+   *
+   * Optionally filter by:
+   *
+   * - `postId` - Get comments for a specific post
+   * - `changelogId` - Get comments for a specific changelog
+   *
+   * If no filter is provided, returns all comments across the organization.
+   *
+   * ### Pagination
+   *
+   * This endpoint uses **cursor-based pagination**:
+   *
+   * - `limit` - Number of comments to return (1-100, default 10)
+   * - `cursor` - Opaque cursor from a previous response's `nextCursor` field
+   *
+   * **Example:** To paginate through results:
+   *
+   * 1. First request: `GET /v2/comments?postId={id}&limit=10`
+   * 2. If `nextCursor` is not null, use it for the next page
+   * 3. Next request: `GET /v2/comments?postId={id}&limit=10&cursor={nextCursor}`
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of comment objects (flat structure with `parentCommentId` for
+   *   threading)
+   * - `nextCursor` - Cursor for the next page (null if no more results)
+   *
+   * ### Comment Structure
+   *
+   * Each comment includes:
+   *
+   * - `id` - Unique comment identifier
+   * - `postId` / `changelogId` - Reference to the parent content
+   * - `parentCommentId` - Reference to parent comment (null for root comments)
+   * - `content` - Comment content in HTML format
+   * - `author` - Author information (id, name, profilePicture, type)
+   * - `upvotes` / `downvotes` / `score` - Voting metrics
+   * - `isPrivate` - Whether comment is only visible to admins
+   * - `inReview` - Whether comment is pending moderation
+   * - `created` / `updated` - Unix timestamps
+   *
+   * ### Additional Filters
+   *
+   * - `privacy` - Filter by privacy: "public", "private", or "all"
+   * - `inReview` - Filter by moderation status (true/false)
+   *
+   * ### Sorting
+   *
+   * Use `sortBy` to sort results:
+   *
+   * - `best` - Sort by confidence score (default, like Reddit)
+   * - `top` - Sort by net score (upvotes - downvotes)
+   * - `new` - Sort by creation date, newest first
+   * - `old` - Sort by creation date, oldest first
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const comment of client.feedback.comments.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: CommentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CommentsCursorPage, Comment> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/comments', CursorPage<Comment>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Deletes a comment by its unique identifier.
    *
@@ -848,39 +848,6 @@ export namespace CommentSearchResponse {
   }
 }
 
-export interface CommentListParams extends CursorPageParams {
-  /**
-   * Query param: Filter comments by changelog ID
-   */
-  changelogId?: string;
-
-  /**
-   * Query param: Filter by review status
-   */
-  inReview?: boolean | null;
-
-  /**
-   * Query param: Filter comments by post ID
-   */
-  postId?: string;
-
-  /**
-   * Query param: Filter comments by privacy
-   */
-  privacy?: 'public' | 'private' | 'all';
-
-  /**
-   * Query param: Sort order for comments
-   */
-  sortBy?: 'best' | 'top' | 'new' | 'old';
-
-  /**
-   * 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 CommentCreateParams {
   /**
    * Body param: Comment content in HTML format
@@ -941,7 +908,7 @@ export interface CommentCreateParams {
    * 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 CommentRetrieveParams {
@@ -949,7 +916,7 @@ export interface CommentRetrieveParams {
    * 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 CommentUpdateParams {
@@ -994,7 +961,40 @@ export interface CommentUpdateParams {
    * 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 CommentListParams extends CursorPageParams {
+  /**
+   * Query param: Filter comments by changelog ID
+   */
+  changelogId?: string;
+
+  /**
+   * Query param: Filter by review status
+   */
+  inReview?: boolean | null;
+
+  /**
+   * Query param: Filter comments by post ID
+   */
+  postId?: string;
+
+  /**
+   * Query param: Filter comments by privacy
+   */
+  privacy?: 'public' | 'private' | 'all';
+
+  /**
+   * Query param: Sort order for comments
+   */
+  sortBy?: 'best' | 'top' | 'new' | 'old';
+
+  /**
+   * 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 CommentDelete0Params {
@@ -1002,7 +1002,7 @@ export interface CommentDelete0Params {
    * 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 CommentDelete1Params {
@@ -1015,7 +1015,7 @@ export interface CommentDelete1Params {
    * 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 CommentSearchParams {
@@ -1058,7 +1058,7 @@ export interface CommentSearchParams {
    * 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 Comments {
@@ -1069,10 +1069,10 @@ export declare namespace Comments {
     type CommentDelete1Response as CommentDelete1Response,
     type CommentSearchResponse as CommentSearchResponse,
     type CommentsCursorPage as CommentsCursorPage,
-    type CommentListParams as CommentListParams,
     type CommentCreateParams as CommentCreateParams,
     type CommentRetrieveParams as CommentRetrieveParams,
     type CommentUpdateParams as CommentUpdateParams,
+    type CommentListParams as CommentListParams,
     type CommentDelete0Params as CommentDelete0Params,
     type CommentDelete1Params as CommentDelete1Params,
     type CommentSearchParams as CommentSearchParams,