featurebase-node 0.13.0 → 0.14.1

package/src/resources/feedback/posts/posts.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as PostsAPI from './posts';
 import * as PostStatusesAPI from '../post-statuses';
 import * as VotersAPI from './voters';
 import {
@@ -26,6 +27,85 @@ import { path } from '../../../internal/utils/path';
 export class Posts extends APIResource {
   voters: VotersAPI.Voters = new VotersAPI.Voters(this._client);
 
+  /**
+   * Returns all posts (feedback submissions) for the authenticated organization.
+   *
+   * Posts are user-submitted feedback items. Each post belongs to a board and can
+   * have:
+   *
+   * - Status (in progress, complete, etc.)
+   * - Tags for categorization
+   * - Upvotes from users
+   * - Comments (if enabled)
+   * - Custom field values
+   *
+   * ### Pagination
+   *
+   * This endpoint uses **cursor-based pagination**:
+   *
+   * - `limit` - Number of posts 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/posts?limit=10`
+   * 2. If `nextCursor` is not null, use it for the next page
+   * 3. Next request: `GET /v2/posts?limit=10&cursor={nextCursor}`
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of post objects
+   * - `nextCursor` - Cursor for the next page (null if no more results)
+   *
+   * ### Filtering
+   *
+   * Filter posts using query parameters:
+   *
+   * - `boardId` - Filter by board (category) ID
+   * - `statusId` - Filter by status ID
+   * - `tags` - Filter by tag names (can be comma-separated or repeated)
+   * - `q` - Search query for title/content
+   * - `inReview` - Include posts pending moderation
+   *
+   * ### Sorting
+   *
+   * Use `sortBy` to sort results:
+   *
+   * - `createdAt` - Sort by creation date (default)
+   * - `upvotes` - Sort by vote count
+   * - `trending` - Sort by trending score
+   * - `recent` - Sort by most recently updated
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const post of client.feedback.posts.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: PostListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PostsCursorPage, Post> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/posts', CursorPage<Post>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Creates a new post (feedback submission) in the specified board.
    *
@@ -185,85 +265,6 @@ export class Posts extends APIResource {
     });
   }
 
-  /**
-   * Returns all posts (feedback submissions) for the authenticated organization.
-   *
-   * Posts are user-submitted feedback items. Each post belongs to a board and can
-   * have:
-   *
-   * - Status (in progress, complete, etc.)
-   * - Tags for categorization
-   * - Upvotes from users
-   * - Comments (if enabled)
-   * - Custom field values
-   *
-   * ### Pagination
-   *
-   * This endpoint uses **cursor-based pagination**:
-   *
-   * - `limit` - Number of posts 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/posts?limit=10`
-   * 2. If `nextCursor` is not null, use it for the next page
-   * 3. Next request: `GET /v2/posts?limit=10&cursor={nextCursor}`
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
-   *
-   * - `object` - Always "list"
-   * - `data` - Array of post objects
-   * - `nextCursor` - Cursor for the next page (null if no more results)
-   *
-   * ### Filtering
-   *
-   * Filter posts using query parameters:
-   *
-   * - `boardId` - Filter by board (category) ID
-   * - `statusId` - Filter by status ID
-   * - `tags` - Filter by tag names (can be comma-separated or repeated)
-   * - `q` - Search query for title/content
-   * - `inReview` - Include posts pending moderation
-   *
-   * ### Sorting
-   *
-   * Use `sortBy` to sort results:
-   *
-   * - `createdAt` - Sort by creation date (default)
-   * - `upvotes` - Sort by vote count
-   * - `trending` - Sort by trending score
-   * - `recent` - Sort by most recently updated
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const post of client.feedback.posts.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: PostListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PostsCursorPage, Post> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/posts', CursorPage<Post>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Permanently deletes a post. This action cannot be undone.
    *
@@ -505,14 +506,14 @@ export interface Post {
    */
   id: string;
 
-  access: Post.Access;
+  access: PostAccess;
 
   /**
    * ID of the admin assigned to this post, null if unassigned
    */
   assigneeId: string | null;
 
-  author: Post.Author | null;
+  author: PostAuthor | null;
 
   /**
    * Board (category) ID this post belongs to
@@ -544,7 +545,7 @@ export interface Post {
    */
   eta: string | null;
 
-  features: Post.Features;
+  features: PostFeatures;
 
   /**
    * Whether the post is pending moderation review
@@ -586,7 +587,7 @@ export interface Post {
   /**
    * Tags attached to this post
    */
-  tags: Array<Post.Tag>;
+  tags: Array<PostTag>;
 
   /**
    * Post title
@@ -605,56 +606,6 @@ export interface Post {
 }
 
 export namespace Post {
-  export interface Access {
-    /**
-     * External company IDs explicitly granted access to this post. Empty array means
-     * no company-level restrictions. Non-empty means only users belonging to these
-     * companies can see the post.
-     */
-    companyExternalIds: Array<string>;
-
-    /**
-     * User IDs explicitly granted access to this post. Empty array means no user-level
-     * restrictions (post uses board/org visibility). Non-empty means only these users
-     * (plus admins) can see the post.
-     */
-    userIds: Array<string>;
-  }
-
-  export interface Author {
-    /**
-     * Author unique identifier
-     */
-    id: string | null;
-
-    /**
-     * Author email (if available)
-     */
-    email: string | null;
-
-    /**
-     * Author display name
-     */
-    name: string;
-
-    /**
-     * Author profile picture URL
-     */
-    profilePicture: string | null;
-
-    /**
-     * Type of user who authored the post
-     */
-    type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
-  }
-
-  export interface Features {
-    /**
-     * Whether comments are allowed on this post
-     */
-    commentsEnabled: boolean;
-  }
-
   /**
    * Third-party integration links associated with this post
    */
@@ -819,23 +770,102 @@ export namespace Post {
       objectType: 'Opportunity' | 'Case';
     }
   }
+}
 
-  export interface Tag {
-    /**
-     * Tag unique identifier
-     */
-    id: string;
+export interface PostAccess {
+  /**
+   * External company IDs explicitly granted access to this post. Empty array means
+   * no company-level restrictions. Non-empty means only users belonging to these
+   * companies can see the post.
+   */
+  companyExternalIds: Array<string>;
 
-    /**
-     * Tag color hex code
-     */
-    color: string | null;
+  /**
+   * User IDs explicitly granted access to this post. Empty array means no user-level
+   * restrictions (post uses board/org visibility). Non-empty means only these users
+   * (plus admins) can see the post.
+   */
+  userIds: Array<string>;
+}
 
-    /**
-     * Tag name
-     */
-    name: string;
-  }
+export interface PostAuthor {
+  /**
+   * Author unique identifier
+   */
+  id: string | null;
+
+  /**
+   * Author email (if available)
+   */
+  email: string | null;
+
+  /**
+   * Author display name
+   */
+  name: string;
+
+  /**
+   * Author profile picture URL
+   */
+  profilePicture: string | null;
+
+  /**
+   * Type of user who authored the post
+   */
+  type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
+}
+
+export interface PostFeatures {
+  /**
+   * Whether comments are allowed on this post
+   */
+  commentsEnabled: boolean;
+}
+
+export interface PostTag {
+  /**
+   * Tag unique identifier
+   */
+  id: string;
+
+  /**
+   * Tag color hex code
+   */
+  color: string | null;
+
+  /**
+   * Tag name
+   */
+  name: string;
+}
+
+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<SearchFilter>;
 }
 
 export interface PostDeleteResponse {
@@ -892,14 +922,14 @@ export namespace PostSearchResponse {
      */
     id: string;
 
-    access: Data.Access;
+    access: PostsAPI.PostAccess;
 
     /**
      * ID of the admin assigned to this post, null if unassigned
      */
     assigneeId: string | null;
 
-    author: Data.Author | null;
+    author: PostsAPI.PostAuthor | null;
 
     /**
      * Board (category) ID this post belongs to
@@ -931,7 +961,7 @@ export namespace PostSearchResponse {
      */
     eta: string | null;
 
-    features: Data.Features;
+    features: PostsAPI.PostFeatures;
 
     /**
      * Whether the post is pending moderation review
@@ -973,7 +1003,7 @@ export namespace PostSearchResponse {
     /**
      * Tags attached to this post
      */
-    tags: Array<Data.Tag>;
+    tags: Array<PostsAPI.PostTag>;
 
     /**
      * Post title
@@ -992,56 +1022,6 @@ export namespace PostSearchResponse {
   }
 
   export namespace Data {
-    export interface Access {
-      /**
-       * External company IDs explicitly granted access to this post. Empty array means
-       * no company-level restrictions. Non-empty means only users belonging to these
-       * companies can see the post.
-       */
-      companyExternalIds: Array<string>;
-
-      /**
-       * User IDs explicitly granted access to this post. Empty array means no user-level
-       * restrictions (post uses board/org visibility). Non-empty means only these users
-       * (plus admins) can see the post.
-       */
-      userIds: Array<string>;
-    }
-
-    export interface Author {
-      /**
-       * Author unique identifier
-       */
-      id: string | null;
-
-      /**
-       * Author email (if available)
-       */
-      email: string | null;
-
-      /**
-       * Author display name
-       */
-      name: string;
-
-      /**
-       * Author profile picture URL
-       */
-      profilePicture: string | null;
-
-      /**
-       * Type of user who authored the post
-       */
-      type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
-    }
-
-    export interface Features {
-      /**
-       * Whether comments are allowed on this post
-       */
-      commentsEnabled: boolean;
-    }
-
     /**
      * Third-party integration links associated with this post
      */
@@ -1206,24 +1186,50 @@ export namespace PostSearchResponse {
         objectType: 'Opportunity' | 'Case';
       }
     }
+  }
+}
 
-    export interface Tag {
-      /**
-       * Tag unique identifier
-       */
-      id: string;
+export interface PostListParams extends CursorPageParams {
+  /**
+   * Query param: Filter by board (category) ID(s)
+   */
+  boardId?: string | Array<string>;
 
-      /**
-       * Tag color hex code
-       */
-      color: string | null;
+  /**
+   * Query param: Include posts that are in review
+   */
+  inReview?: boolean | null;
 
-      /**
-       * Tag name
-       */
-      name: string;
-    }
-  }
+  /**
+   * Query param: Search query to filter posts by title/content
+   */
+  q?: string;
+
+  /**
+   * Query param: Sort order for posts
+   */
+  sortBy?: 'createdAt' | 'upvotes' | 'trending' | 'recent';
+
+  /**
+   * Query param: Sort direction
+   */
+  sortOrder?: 'asc' | 'desc';
+
+  /**
+   * Query param: Filter by status ID(s)
+   */
+  statusId?: string | Array<string>;
+
+  /**
+   * Query param: Filter by tag names
+   */
+  tags?: 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 PostCreateParams {
@@ -1462,49 +1468,6 @@ export interface PostUpdateParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface PostListParams extends CursorPageParams {
-  /**
-   * Query param: Filter by board (category) ID(s)
-   */
-  boardId?: string | Array<string>;
-
-  /**
-   * Query param: Include posts that are in review
-   */
-  inReview?: boolean | null;
-
-  /**
-   * Query param: Search query to filter posts by title/content
-   */
-  q?: string;
-
-  /**
-   * Query param: Sort order for posts
-   */
-  sortBy?: 'createdAt' | 'upvotes' | 'trending' | 'recent';
-
-  /**
-   * Query param: Sort direction
-   */
-  sortOrder?: 'asc' | 'desc';
-
-  /**
-   * Query param: Filter by status ID(s)
-   */
-  statusId?: string | Array<string>;
-
-  /**
-   * Query param: Filter by tag names
-   */
-  tags?: 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 PostDeleteParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -1529,7 +1492,7 @@ export interface PostSearchParams {
    * 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?: PostSearchParams.SearchFilter | PostSearchParams.SearchFilterGroup;
+  query?: SearchFilter | SearchFilterGroup;
 
   /**
    * Body param: Plain-text full-text search across post `title` and `content`.
@@ -1579,68 +1542,24 @@ export interface PostSearchParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export namespace PostSearchParams {
-  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;
-    }
-  }
-}
-
 Posts.Voters = Voters;
 
 export declare namespace Posts {
   export {
     type Post as Post,
+    type PostAccess as PostAccess,
+    type PostAuthor as PostAuthor,
+    type PostFeatures as PostFeatures,
+    type PostTag as PostTag,
+    type SearchFilter as SearchFilter,
+    type SearchFilterGroup as SearchFilterGroup,
     type PostDeleteResponse as PostDeleteResponse,
     type PostSearchResponse as PostSearchResponse,
     type PostsCursorPage as PostsCursorPage,
+    type PostListParams as PostListParams,
     type PostCreateParams as PostCreateParams,
     type PostRetrieveParams as PostRetrieveParams,
     type PostUpdateParams as PostUpdateParams,
-    type PostListParams as PostListParams,
     type PostDeleteParams as PostDeleteParams,
     type PostSearchParams as PostSearchParams,
   };