featurebase-node 0.13.0 → 0.14.1

package/src/resources/feedback/boards.ts

@@ -11,25 +11,28 @@ import { path } from '../../internal/utils/path';
  */
 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([
         {
@@ -43,28 +46,25 @@ 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([
         {
@@ -253,7 +253,7 @@ export namespace Board {
 
 export type BoardListResponse = Array<Board>;
 
-export interface BoardRetrieveParams {
+export interface BoardListParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -261,7 +261,7 @@ export interface BoardRetrieveParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface BoardListParams {
+export interface BoardRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -273,7 +273,7 @@ export declare namespace Boards {
   export {
     type Board as Board,
     type BoardListResponse as BoardListResponse,
-    type BoardRetrieveParams as BoardRetrieveParams,
     type BoardListParams as BoardListParams,
+    type BoardRetrieveParams as BoardRetrieveParams,
   };
 }

package/src/resources/feedback/comments.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as CommentsAPI from './comments';
+import * as PostsAPI from './posts/posts';
 import * as TicketsAPI from '../support/tickets/tickets';
 import { APIPromise } from '../../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
@@ -12,6 +14,103 @@ 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.
    *
@@ -199,103 +298,6 @@ 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.
    *
@@ -609,7 +611,7 @@ export interface Comment {
    */
   id: string;
 
-  author: Comment.Author | null;
+  author: CommentAuthor | null;
 
   /**
    * Changelog ID this comment belongs to
@@ -687,28 +689,26 @@ export interface Comment {
   upvotes: number;
 }
 
-export namespace Comment {
-  export interface Author {
-    /**
-     * Author unique identifier
-     */
-    id: string | null;
+export interface CommentAuthor {
+  /**
+   * Author unique identifier
+   */
+  id: string | null;
 
-    /**
-     * Author display name
-     */
-    name: string;
+  /**
+   * Author display name
+   */
+  name: string;
 
-    /**
-     * Author profile picture URL
-     */
-    profilePicture: string | null;
+  /**
+   * Author profile picture URL
+   */
+  profilePicture: string | null;
 
-    /**
-     * Type of user who authored the comment
-     */
-    type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
-  }
+  /**
+   * Type of user who authored the comment
+   */
+  type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
 }
 
 export interface CommentDelete0Response {
@@ -769,7 +769,7 @@ export namespace CommentSearchResponse {
      */
     id: string;
 
-    author: Data.Author | null;
+    author: CommentsAPI.CommentAuthor | null;
 
     /**
      * Changelog ID this comment belongs to
@@ -846,30 +846,39 @@ export namespace CommentSearchResponse {
      */
     upvotes: number;
   }
+}
 
-  export namespace Data {
-    export interface Author {
-      /**
-       * Author unique identifier
-       */
-      id: string | null;
-
-      /**
-       * Author display name
-       */
-      name: string;
-
-      /**
-       * Author profile picture URL
-       */
-      profilePicture: string | null;
-
-      /**
-       * Type of user who authored the comment
-       */
-      type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
-    }
-  }
+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 {
@@ -988,39 +997,6 @@ export interface CommentUpdateParams {
   'Featurebase-Version'?: '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-01-01.nova' | '2025-12-12.clover';
-}
-
 export interface CommentDelete0Params {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -1058,7 +1034,7 @@ export interface CommentSearchParams {
    * Body param: Structured filter AST. Either a single filter clause or one
    * top-level AND group (max 15 clauses). Top-level OR groups are not yet supported.
    */
-  query?: CommentSearchParams.SearchFilter | CommentSearchParams.SearchFilterGroup;
+  query?: PostsAPI.SearchFilter | PostsAPI.SearchFilterGroup;
 
   /**
    * Body param: Plain-text full-text search across comment `content`. Server-managed
@@ -1085,67 +1061,18 @@ export interface CommentSearchParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export namespace CommentSearchParams {
-  export interface SearchFilter {
-    /**
-     * Field name to filter on (e.g. `state`, `tag_ids`, `created_at`)
-     */
-    field: string;
-
-    /**
-     * Comparison operator
-     */
-    operator: '=' | '!=' | 'IN' | 'NIN' | '>' | '<' | '>=' | '<=' | '~' | '!~' | '^' | '$';
-
-    /**
-     * Value to compare against (primitive or array of primitives)
-     */
-    value: string | number | boolean | Array<string | number> | null;
-  }
-
-  export interface SearchFilterGroup {
-    /**
-     * Group operator: AND (all match) or OR (any match)
-     */
-    operator: 'AND' | 'OR';
-
-    /**
-     * Array of filter clauses (1-15 entries)
-     */
-    value: Array<SearchFilterGroup.Value>;
-  }
-
-  export namespace SearchFilterGroup {
-    export interface Value {
-      /**
-       * Field name to filter on (e.g. `state`, `tag_ids`, `created_at`)
-       */
-      field: string;
-
-      /**
-       * Comparison operator
-       */
-      operator: '=' | '!=' | 'IN' | 'NIN' | '>' | '<' | '>=' | '<=' | '~' | '!~' | '^' | '$';
-
-      /**
-       * Value to compare against (primitive or array of primitives)
-       */
-      value: string | number | boolean | Array<string | number> | null;
-    }
-  }
-}
-
 export declare namespace Comments {
   export {
     type Comment as Comment,
+    type CommentAuthor as CommentAuthor,
     type CommentDelete0Response as CommentDelete0Response,
     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,