featurebase-node 0.2.0 → 0.4.0

package/src/resources/changelogs/changelogs.ts

@@ -10,6 +10,7 @@ import {
   Subscribers,
 } from './subscribers';
 import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -231,15 +232,18 @@ export class Changelogs extends APIResource {
    *
    * @example
    * ```ts
-   * const changelogs = await client.changelogs.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const changelog of client.changelogs.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: ChangelogListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ChangelogListResponse> {
+  ): PagePromise<ChangelogsCursorPage, Changelog> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/changelogs', {
+    return this._client.getAPIList('/v2/changelogs', CursorPage<Changelog>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -431,6 +435,8 @@ export class Changelogs extends APIResource {
   }
 }
 
+export type ChangelogsCursorPage = CursorPage<Changelog>;
+
 export interface Changelog {
   /**
    * Unique identifier
@@ -648,55 +654,6 @@ export interface PublishUnpublishSuccess {
   state?: 'published' | 'scheduled' | 'unpublished';
 }
 
-export interface ChangelogListResponse {
-  /**
-   * Array of changelogs
-   */
-  data: Array<Changelog>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-
-  /**
-   * Pagination metadata for page-based requests
-   */
-  pagination?: ChangelogListResponse.Pagination;
-}
-
-export namespace ChangelogListResponse {
-  /**
-   * Pagination metadata for page-based requests
-   */
-  export interface Pagination {
-    /**
-     * Items per page
-     */
-    limit: number;
-
-    /**
-     * Current page number
-     */
-    page: number;
-
-    /**
-     * Total number of items
-     */
-    total: number;
-
-    /**
-     * Total number of pages
-     */
-    totalPages: number;
-  }
-}
-
 export interface ChangelogDeleteResponse {
   /**
    * Unique identifier of the deleted changelog
@@ -871,7 +828,7 @@ export interface ChangelogUpdateParams {
   'Featurebase-Version'?: string;
 }
 
-export interface ChangelogListParams {
+export interface ChangelogListParams extends CursorPageParams {
   /**
    * Query param: Find changelog by its id (also accepts slug)
    */
@@ -882,21 +839,11 @@ export interface ChangelogListParams {
    */
   categories?: string | Array<string>;
 
-  /**
-   * Query param: Cursor for pagination. Use nextCursor from previous response.
-   */
-  cursor?: string;
-
   /**
    * Query param: Include Changelogs dated on or before the specified end date
    */
   endDate?: string | null;
 
-  /**
-   * Query param: Maximum number of changelogs to return
-   */
-  limit?: number;
-
   /**
    * Query param: The locale of the changelogs. Defaults to the organization default
    * locale.
@@ -1118,8 +1065,8 @@ export declare namespace Changelogs {
   export {
     type Changelog as Changelog,
     type PublishUnpublishSuccess as PublishUnpublishSuccess,
-    type ChangelogListResponse as ChangelogListResponse,
     type ChangelogDeleteResponse as ChangelogDeleteResponse,
+    type ChangelogsCursorPage as ChangelogsCursorPage,
     type ChangelogCreateParams as ChangelogCreateParams,
     type ChangelogRetrieveParams as ChangelogRetrieveParams,
     type ChangelogUpdateParams as ChangelogUpdateParams,

package/src/resources/changelogs/index.ts

@@ -4,7 +4,6 @@ export {
   Changelogs,
   type Changelog,
   type PublishUnpublishSuccess,
-  type ChangelogListResponse,
   type ChangelogDeleteResponse,
   type ChangelogCreateParams,
   type ChangelogRetrieveParams,
@@ -13,6 +12,7 @@ export {
   type ChangelogDeleteParams,
   type ChangelogPublishParams,
   type ChangelogUnpublishParams,
+  type ChangelogsCursorPage,
 } from './changelogs';
 export {
   Subscribers,

package/src/resources/feedback/comments.ts

@@ -1,8 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as TicketsAPI from '../products/tickets/tickets';
+import * as TicketsAPI from '../support/tickets/tickets';
 import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -258,15 +259,18 @@ export class Comments extends APIResource {
    *
    * @example
    * ```ts
-   * const comments = await client.feedback.comments.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const comment of client.feedback.comments.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: CommentListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CommentListResponse> {
+  ): PagePromise<CommentsCursorPage, Comment> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/comments', {
+    return this._client.getAPIList('/v2/comments', CursorPage<Comment>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -412,6 +416,8 @@ export class Comments extends APIResource {
   }
 }
 
+export type CommentsCursorPage = CursorPage<Comment>;
+
 export interface Comment {
   /**
    * Unique identifier
@@ -520,55 +526,6 @@ export namespace Comment {
   }
 }
 
-export interface CommentListResponse {
-  /**
-   * Array of comments
-   */
-  data: Array<Comment>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-
-  /**
-   * Pagination metadata for page-based requests
-   */
-  pagination?: CommentListResponse.Pagination;
-}
-
-export namespace CommentListResponse {
-  /**
-   * Pagination metadata for page-based requests
-   */
-  export interface Pagination {
-    /**
-     * Items per page
-     */
-    limit: number;
-
-    /**
-     * Current page number
-     */
-    page: number;
-
-    /**
-     * Total number of items
-     */
-    total: number;
-
-    /**
-     * Total number of pages
-     */
-    totalPages: number;
-  }
-}
-
 export interface CommentDelete0Response {
   /**
    * Unique identifier of the deleted comment
@@ -706,27 +663,17 @@ export interface CommentUpdateParams {
   'Featurebase-Version'?: string;
 }
 
-export interface CommentListParams {
+export interface CommentListParams extends CursorPageParams {
   /**
    * Query param: Filter comments by changelog ID
    */
   changelogId?: string;
 
-  /**
-   * Query param: Cursor for pagination. Use nextCursor from previous response.
-   */
-  cursor?: string;
-
   /**
    * Query param: Filter by review status
    */
   inReview?: boolean | null;
 
-  /**
-   * Query param: Maximum number of comments to return
-   */
-  limit?: number;
-
   /**
    * Query param: Filter comments by post ID
    */
@@ -773,9 +720,9 @@ export interface CommentDelete1Params {
 export declare namespace Comments {
   export {
     type Comment as Comment,
-    type CommentListResponse as CommentListResponse,
     type CommentDelete0Response as CommentDelete0Response,
     type CommentDelete1Response as CommentDelete1Response,
+    type CommentsCursorPage as CommentsCursorPage,
     type CommentCreateParams as CommentCreateParams,
     type CommentRetrieveParams as CommentRetrieveParams,
     type CommentUpdateParams as CommentUpdateParams,

package/src/resources/feedback/feedback.ts

@@ -12,10 +12,10 @@ import {
   CommentDelete1Params,
   CommentDelete1Response,
   CommentListParams,
-  CommentListResponse,
   CommentRetrieveParams,
   CommentUpdateParams,
   Comments,
+  CommentsCursorPage,
 } from './comments';
 import * as CustomFieldsAPI from './custom-fields';
 import {
@@ -40,10 +40,10 @@ import {
   PostDeleteParams,
   PostDeleteResponse,
   PostListParams,
-  PostListResponse,
   PostRetrieveParams,
   PostUpdateParams,
   Posts,
+  PostsCursorPage,
 } from './posts/posts';
 
 export class Feedback extends APIResource {
@@ -72,8 +72,8 @@ export declare namespace Feedback {
   export {
     Posts as Posts,
     type Post as Post,
-    type PostListResponse as PostListResponse,
     type PostDeleteResponse as PostDeleteResponse,
+    type PostsCursorPage as PostsCursorPage,
     type PostCreateParams as PostCreateParams,
     type PostRetrieveParams as PostRetrieveParams,
     type PostUpdateParams as PostUpdateParams,
@@ -92,9 +92,9 @@ export declare namespace Feedback {
   export {
     Comments as Comments,
     type Comment as Comment,
-    type CommentListResponse as CommentListResponse,
     type CommentDelete0Response as CommentDelete0Response,
     type CommentDelete1Response as CommentDelete1Response,
+    type CommentsCursorPage as CommentsCursorPage,
     type CommentCreateParams as CommentCreateParams,
     type CommentRetrieveParams as CommentRetrieveParams,
     type CommentUpdateParams as CommentUpdateParams,

package/src/resources/feedback/index.ts

@@ -10,7 +10,6 @@ export {
 export {
   Comments,
   type Comment,
-  type CommentListResponse,
   type CommentDelete0Response,
   type CommentDelete1Response,
   type CommentCreateParams,
@@ -19,6 +18,7 @@ export {
   type CommentListParams,
   type CommentDelete0Params,
   type CommentDelete1Params,
+  type CommentsCursorPage,
 } from './comments';
 export {
   CustomFields,
@@ -38,11 +38,11 @@ export {
 export {
   Posts,
   type Post,
-  type PostListResponse,
   type PostDeleteResponse,
   type PostCreateParams,
   type PostRetrieveParams,
   type PostUpdateParams,
   type PostListParams,
   type PostDeleteParams,
+  type PostsCursorPage,
 } from './posts/index';

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

@@ -3,13 +3,13 @@
 export {
   Posts,
   type Post,
-  type PostListResponse,
   type PostDeleteResponse,
   type PostCreateParams,
   type PostRetrieveParams,
   type PostUpdateParams,
   type PostListParams,
   type PostDeleteParams,
+  type PostsCursorPage,
 } from './posts';
 export {
   Voters,
@@ -19,4 +19,5 @@ export {
   type VoterListParams,
   type VoterAddParams,
   type VoterRemoveParams,
+  type VoterListResponsesCursorPage,
 } from './voters';

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

@@ -8,12 +8,14 @@ import {
   VoterAddResponse,
   VoterListParams,
   VoterListResponse,
+  VoterListResponsesCursorPage,
   VoterRemoveParams,
   VoterRemoveResponse,
   Voters,
 } from './voters';
-import * as TicketsAPI from '../../products/tickets/tickets';
+import * as TicketsAPI from '../../support/tickets/tickets';
 import { APIPromise } from '../../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
@@ -225,15 +227,18 @@ export class Posts extends APIResource {
    *
    * @example
    * ```ts
-   * const posts = await client.feedback.posts.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const post of client.feedback.posts.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: PostListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<PostListResponse> {
+  ): PagePromise<PostsCursorPage, Post> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/posts', {
+    return this._client.getAPIList('/v2/posts', CursorPage<Post>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -290,6 +295,8 @@ export class Posts extends APIResource {
   }
 }
 
+export type PostsCursorPage = CursorPage<Post>;
+
 export interface Post {
   /**
    * Unique identifier
@@ -629,55 +636,6 @@ export namespace Post {
   }
 }
 
-export interface PostListResponse {
-  /**
-   * Array of posts
-   */
-  data: Array<Post>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-
-  /**
-   * Pagination metadata for page-based requests
-   */
-  pagination?: PostListResponse.Pagination;
-}
-
-export namespace PostListResponse {
-  /**
-   * Pagination metadata for page-based requests
-   */
-  export interface Pagination {
-    /**
-     * Items per page
-     */
-    limit: number;
-
-    /**
-     * Current page number
-     */
-    page: number;
-
-    /**
-     * Total number of items
-     */
-    total: number;
-
-    /**
-     * Total number of pages
-     */
-    totalPages: number;
-  }
-}
-
 export interface PostDeleteResponse {
   /**
    * Unique identifier of the deleted post
@@ -931,28 +889,17 @@ export interface PostUpdateParams {
   'Featurebase-Version'?: string;
 }
 
-export interface PostListParams {
+export interface PostListParams extends CursorPageParams {
   /**
    * Query param: Filter by board (category) ID(s)
    */
   boardId?: string | Array<string>;
 
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page of results.
-   */
-  cursor?: string;
-
   /**
    * Query param: Include posts that are in review
    */
   inReview?: boolean | null;
 
-  /**
-   * Query param: A limit on the number of posts to be returned, between 1 and 100.
-   */
-  limit?: number;
-
   /**
    * Query param: Search query to filter posts by title/content
    */
@@ -998,8 +945,8 @@ Posts.Voters = Voters;
 export declare namespace Posts {
   export {
     type Post as Post,
-    type PostListResponse as PostListResponse,
     type PostDeleteResponse as PostDeleteResponse,
+    type PostsCursorPage as PostsCursorPage,
     type PostCreateParams as PostCreateParams,
     type PostRetrieveParams as PostRetrieveParams,
     type PostUpdateParams as PostUpdateParams,
@@ -1012,6 +959,7 @@ export declare namespace Posts {
     type VoterListResponse as VoterListResponse,
     type VoterAddResponse as VoterAddResponse,
     type VoterRemoveResponse as VoterRemoveResponse,
+    type VoterListResponsesCursorPage as VoterListResponsesCursorPage,
     type VoterListParams as VoterListParams,
     type VoterAddParams as VoterAddParams,
     type VoterRemoveParams as VoterRemoveParams,