featurebase-node 0.3.0 → 0.4.0

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 '../../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,

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

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../core/resource';
 import * as CompaniesAPI from '../../users/companies/companies';
 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';
@@ -50,18 +51,21 @@ export class Voters extends APIResource {
    *
    * @example
    * ```ts
-   * const voters = await client.feedback.posts.voters.list(
+   * // Automatically fetches more pages as needed.
+   * for await (const voterListResponse of client.feedback.posts.voters.list(
    *   '507f1f77bcf86cd799439011',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     id: string,
     params: VoterListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<VoterListResponse> {
+  ): PagePromise<VoterListResponsesCursorPage, VoterListResponse> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get(path`/v2/posts/${id}/voters`, {
+    return this._client.getAPIList(path`/v2/posts/${id}/voters`, CursorPage<VoterListResponse>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -176,150 +180,103 @@ export class Voters extends APIResource {
   }
 }
 
+export type VoterListResponsesCursorPage = CursorPage<VoterListResponse>;
+
 export interface VoterListResponse {
   /**
-   * Array of users
+   * Unique identifier
    */
-  data: Array<VoterListResponse.Data>;
+  id: string;
 
   /**
-   * Cursor for fetching the next page (cursor-based pagination)
+   * User display name
    */
-  nextCursor: string | null;
+  name: string;
 
   /**
    * Object type identifier
    */
-  object: 'list';
+  object: 'contact';
 
   /**
-   * Pagination metadata for page-based requests
+   * Type of user
    */
-  pagination?: VoterListResponse.Pagination;
-}
+  type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
 
-export namespace VoterListResponse {
-  export interface Data {
-    /**
-     * Unique identifier
-     */
-    id: string;
-
-    /**
-     * User display name
-     */
-    name: string;
-
-    /**
-     * Object type identifier
-     */
-    object: 'contact';
-
-    /**
-     * Type of user
-     */
-    type: 'admin' | 'customer' | 'guest' | 'integration' | 'bot' | 'lead';
-
-    /**
-     * Number of comments created
-     */
-    commentsCreated?: number;
-
-    /**
-     * Companies the user belongs to
-     */
-    companies?: Array<CompaniesAPI.Company>;
-
-    /**
-     * Custom field values on the user
-     */
-    customFields?: { [key: string]: unknown };
-
-    /**
-     * User description/bio
-     */
-    description?: string;
-
-    /**
-     * User email
-     */
-    email?: string | null;
-
-    /**
-     * Last activity ISO timestamp
-     */
-    lastActivity?: string;
-
-    /**
-     * User locale
-     */
-    locale?: string;
-
-    /**
-     * Whether manually opted out from changelog
-     */
-    manuallyOptedOutFromChangelog?: boolean;
-
-    /**
-     * Organization ID the user belongs to
-     */
-    organizationId?: string;
-
-    /**
-     * Number of posts created
-     */
-    postsCreated?: number;
-
-    /**
-     * Profile picture URL
-     */
-    profilePicture?: string | null;
-
-    /**
-     * User roles
-     */
-    roles?: Array<string>;
-
-    /**
-     * Whether subscribed to changelog
-     */
-    subscribedToChangelog?: boolean;
-
-    /**
-     * External user ID from SSO
-     */
-    userId?: string;
-
-    /**
-     * Whether email is verified
-     */
-    verified?: boolean;
-  }
+  /**
+   * Number of comments created
+   */
+  commentsCreated?: number;
 
   /**
-   * Pagination metadata for page-based requests
+   * Companies the user belongs to
    */
-  export interface Pagination {
-    /**
-     * Items per page
-     */
-    limit: number;
+  companies?: Array<CompaniesAPI.Company>;
 
-    /**
-     * Current page number
-     */
-    page: number;
+  /**
+   * Custom field values on the user
+   */
+  customFields?: { [key: string]: unknown };
 
-    /**
-     * Total number of items
-     */
-    total: number;
+  /**
+   * User description/bio
+   */
+  description?: string;
 
-    /**
-     * Total number of pages
-     */
-    totalPages: number;
-  }
+  /**
+   * User email
+   */
+  email?: string | null;
+
+  /**
+   * Last activity ISO timestamp
+   */
+  lastActivity?: string;
+
+  /**
+   * User locale
+   */
+  locale?: string;
+
+  /**
+   * Whether manually opted out from changelog
+   */
+  manuallyOptedOutFromChangelog?: boolean;
+
+  /**
+   * Organization ID the user belongs to
+   */
+  organizationId?: string;
+
+  /**
+   * Number of posts created
+   */
+  postsCreated?: number;
+
+  /**
+   * Profile picture URL
+   */
+  profilePicture?: string | null;
+
+  /**
+   * User roles
+   */
+  roles?: Array<string>;
+
+  /**
+   * Whether subscribed to changelog
+   */
+  subscribedToChangelog?: boolean;
+
+  /**
+   * External user ID from SSO
+   */
+  userId?: string;
+
+  /**
+   * Whether email is verified
+   */
+  verified?: boolean;
 }
 
 export interface VoterAddResponse {
@@ -366,18 +323,7 @@ export interface VoterRemoveResponse {
   removed: true;
 }
 
-export interface VoterListParams {
-  /**
-   * 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: A limit on the number of voters to be returned, between 1 and 100.
-   */
-  limit?: number;
-
+export interface VoterListParams extends CursorPageParams {
   /**
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
@@ -446,6 +392,7 @@ export declare namespace Voters {
     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,

package/src/resources/help-center/articles.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as ArticlesAPI from './articles';
 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';
@@ -250,15 +251,18 @@ export class Articles extends APIResource {
    *
    * @example
    * ```ts
-   * const articles = await client.helpCenter.articles.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const article of client.helpCenter.articles.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: ArticleListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ArticleListResponse> {
+  ): PagePromise<ArticlesCursorPage, Article> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/help_center/articles', {
+    return this._client.getAPIList('/v2/help_center/articles', CursorPage<Article>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -310,6 +314,8 @@ export class Articles extends APIResource {
   }
 }
 
+export type ArticlesCursorPage = CursorPage<Article>;
+
 export interface Article {
   /**
    * Article unique identifier
@@ -837,23 +843,6 @@ export interface ArticleTranslationInputNova {
   title?: string;
 }
 
-export interface ArticleListResponse {
-  /**
-   * Array of article objects
-   */
-  data: Array<Article>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface ArticleDeleteResponse {
   /**
    * Unique identifier of the deleted article
@@ -1169,24 +1158,13 @@ export namespace ArticleUpdateParams {
   }
 }
 
-export interface ArticleListParams {
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page of results.
-   */
-  cursor?: string;
-
+export interface ArticleListParams extends CursorPageParams {
   /**
    * Query param: Filter articles by help center ID. If omitted, returns articles
    * across all help centers.
    */
   helpCenterId?: string;
 
-  /**
-   * Query param: A limit on the number of objects to be returned, between 1 and 100.
-   */
-  limit?: number;
-
   /**
    * Query param: Filter articles by parent collection ID
    */
@@ -1220,8 +1198,8 @@ export declare namespace Articles {
     type ArticleIconInputNova as ArticleIconInputNova,
     type ArticleTranslation as ArticleTranslation,
     type ArticleTranslationInputNova as ArticleTranslationInputNova,
-    type ArticleListResponse as ArticleListResponse,
     type ArticleDeleteResponse as ArticleDeleteResponse,
+    type ArticlesCursorPage as ArticlesCursorPage,
     type ArticleCreateParams as ArticleCreateParams,
     type ArticleRetrieveParams as ArticleRetrieveParams,
     type ArticleUpdateParams as ArticleUpdateParams,

package/src/resources/help-center/collections.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as CollectionsAPI from './collections';
 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';
@@ -232,16 +233,18 @@ export class Collections extends APIResource {
    *
    * @example
    * ```ts
-   * const collections =
-   *   await client.helpCenter.collections.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const collection of client.helpCenter.collections.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: CollectionListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CollectionListResponse> {
+  ): PagePromise<CollectionsCursorPage, Collection> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/help_center/collections', {
+    return this._client.getAPIList('/v2/help_center/collections', CursorPage<Collection>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -292,6 +295,8 @@ export class Collections extends APIResource {
   }
 }
 
+export type CollectionsCursorPage = CursorPage<Collection>;
+
 export interface Collection {
   /**
    * Collection unique identifier
@@ -725,23 +730,6 @@ export interface CollectionTranslationInputNova {
   name?: string;
 }
 
-export interface CollectionListResponse {
-  /**
-   * Array of collections
-   */
-  data: Array<Collection>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface CollectionDeleteResponse {
   /**
    * Unique identifier of the deleted collection
@@ -1015,24 +1003,13 @@ export namespace CollectionUpdateParams {
   }
 }
 
-export interface CollectionListParams {
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page.
-   */
-  cursor?: string;
-
+export interface CollectionListParams extends CursorPageParams {
   /**
    * Query param: Filter collections by help center ID. If omitted, returns
    * collections across all help centers.
    */
   helpCenterId?: string;
 
-  /**
-   * Query param: A limit on the number of objects to be returned, between 1 and 100.
-   */
-  limit?: number;
-
   /**
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
@@ -1054,8 +1031,8 @@ export declare namespace Collections {
     type CollectionIconNova as CollectionIconNova,
     type CollectionTranslation as CollectionTranslation,
     type CollectionTranslationInputNova as CollectionTranslationInputNova,
-    type CollectionListResponse as CollectionListResponse,
     type CollectionDeleteResponse as CollectionDeleteResponse,
+    type CollectionsCursorPage as CollectionsCursorPage,
     type CollectionCreateParams as CollectionCreateParams,
     type CollectionRetrieveParams as CollectionRetrieveParams,
     type CollectionUpdateParams as CollectionUpdateParams,