featurebase-node 0.3.0 → 0.4.0

package/src/resources/support/tickets/tickets.ts

@@ -10,6 +10,7 @@ import { CustomFieldListParams, CustomFieldRetrieveParams, CustomFields } from '
 import * as StatusesAPI from './statuses';
 import { StatusListParams, StatusListResponse, StatusRetrieveParams, Statuses } from './statuses';
 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';
@@ -210,15 +211,18 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const tickets = await client.support.tickets.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const ticket of client.support.tickets.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: TicketListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<TicketListResponse> {
+  ): PagePromise<TicketsCursorPage, Ticket> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/tickets', {
+    return this._client.getAPIList('/v2/tickets', CursorPage<Ticket>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -337,6 +341,8 @@ export class Tickets extends APIResource {
   }
 }
 
+export type TicketsCursorPage = CursorPage<Ticket>;
+
 /**
  * Author to attribute the post to. If not provided, uses the authenticated user.
  * Supports multiple identification methods: id (Featurebase ID), userId (external
@@ -663,23 +669,6 @@ export namespace Ticket {
   }
 }
 
-export interface TicketListResponse {
-  /**
-   * Array of tickets
-   */
-  data: Array<Ticket>;
-
-  /**
-   * Cursor for fetching the next page
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface TicketDeleteResponse {
   /**
    * Unique identifier of the deleted ticket
@@ -823,7 +812,7 @@ export interface TicketUpdateParams {
   'Featurebase-Version'?: string;
 }
 
-export interface TicketListParams {
+export interface TicketListParams extends CursorPageParams {
   /**
    * Query param
    */
@@ -834,17 +823,6 @@ export interface TicketListParams {
    */
   categoryType?: 'customer' | 'tracker' | 'back-office';
 
-  /**
-   * 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
-   */
-  limit?: number;
-
   /**
    * Query param
    */
@@ -988,8 +966,8 @@ export declare namespace Tickets {
   export {
     type AuthorInput as AuthorInput,
     type Ticket as Ticket,
-    type TicketListResponse as TicketListResponse,
     type TicketDeleteResponse as TicketDeleteResponse,
+    type TicketsCursorPage as TicketsCursorPage,
     type TicketCreateParams as TicketCreateParams,
     type TicketRetrieveParams as TicketRetrieveParams,
     type TicketUpdateParams as TicketUpdateParams,

package/src/resources/surveys.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../core/resource';
 import * as SurveysAPI from './surveys';
 import * as ContactsAPI from './users/contacts/contacts';
 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';
@@ -95,9 +96,9 @@ export class Surveys extends APIResource {
   list(
     params: SurveyListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<SurveyListResponse> {
+  ): PagePromise<SurveysCursorPage, Survey> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/surveys', {
+    return this._client.getAPIList('/v2/surveys', CursorPage<Survey>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -145,23 +146,31 @@ export class Surveys extends APIResource {
    *
    * - `404` - Survey not found in your organization
    */
-  retrieveResponses(
+  listResponses(
     id: string,
-    params: SurveyRetrieveResponsesParams | null | undefined = {},
+    params: SurveyListResponsesParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<SurveyRetrieveResponsesResponse> {
+  ): PagePromise<SurveyListResponsesResponsesCursorPage, SurveyListResponsesResponse> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get(path`/v2/surveys/${id}/responses`, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
-        options?.headers,
-      ]),
-    });
+    return this._client.getAPIList(
+      path`/v2/surveys/${id}/responses`,
+      CursorPage<SurveyListResponsesResponse>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+          options?.headers,
+        ]),
+      },
+    );
   }
 }
 
+export type SurveysCursorPage = CursorPage<Survey>;
+
+export type SurveyListResponsesResponsesCursorPage = CursorPage<SurveyListResponsesResponse>;
+
 export interface Survey {
   /**
    * Unique identifier
@@ -405,100 +414,64 @@ export interface SurveyNextAction {
   pageId?: string;
 }
 
-export interface SurveyListResponse {
+export interface SurveyListResponsesResponse {
   /**
-   * Array of surveys
+   * Unique identifier
    */
-  data: Array<Survey>;
+  id: string;
 
   /**
-   * Cursor for fetching the next page (cursor-based pagination)
+   * ISO 8601 timestamp when created
    */
-  nextCursor: string | null;
+  createdAt: string;
 
   /**
    * Object type identifier
    */
-  object: 'list';
-}
-
-export interface SurveyRetrieveResponsesResponse {
-  /**
-   * Array of survey responses
-   */
-  data: Array<SurveyRetrieveResponsesResponse.Data>;
+  object: 'survey_response';
 
   /**
-   * Cursor for fetching the next page (cursor-based pagination)
+   * Individual responses to questions
    */
-  nextCursor: string | null;
+  responses: Array<SurveyListResponsesResponse.Response>;
 
   /**
-   * Object type identifier
+   * User who submitted the response
    */
-  object: 'list';
+  user: ContactsAPI.Contact | null;
 }
 
-export namespace SurveyRetrieveResponsesResponse {
-  export interface Data {
+export namespace SurveyListResponsesResponse {
+  export interface Response {
     /**
-     * Unique identifier
+     * Page ID this response is for
      */
-    id: string;
+    pageId: string;
 
     /**
-     * ISO 8601 timestamp when created
+     * Response type
      */
-    createdAt: string;
+    type: 'text' | 'link' | 'rating' | 'multiple-choice';
 
     /**
-     * Object type identifier
+     * Response value
      */
-    object: 'survey_response';
+    value: string | number | boolean | Array<string>;
 
     /**
-     * Individual responses to questions
+     * Response ID
      */
-    responses: Array<Data.Response>;
+    id?: string;
 
     /**
-     * User who submitted the response
+     * ISO 8601 timestamp when created
      */
-    user: ContactsAPI.Contact | null;
-  }
-
-  export namespace Data {
-    export interface Response {
-      /**
-       * Page ID this response is for
-       */
-      pageId: string;
-
-      /**
-       * Response type
-       */
-      type: 'text' | 'link' | 'rating' | 'multiple-choice';
-
-      /**
-       * Response value
-       */
-      value: string | number | boolean | Array<string>;
-
-      /**
-       * Response ID
-       */
-      id?: string;
-
-      /**
-       * ISO 8601 timestamp when created
-       */
-      createdAt?: string;
+    createdAt?: string;
 
-      /**
-       * ISO 8601 timestamp when updated
-       */
-      updatedAt?: string;
-    }
+    /**
+     * ISO 8601 timestamp when updated
+     */
+    updatedAt?: string;
   }
 }
 
@@ -510,23 +483,12 @@ export interface SurveyRetrieveParams {
   'Featurebase-Version'?: string;
 }
 
-export interface SurveyListParams {
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page.
-   */
-  cursor?: string;
-
+export interface SurveyListParams extends CursorPageParams {
   /**
    * Query param: Filter by active status
    */
   isActive?: boolean | null;
 
-  /**
-   * Query param: A limit on the number of objects to be returned, between 1 and 100.
-   */
-  limit?: number;
-
   /**
    * Query param: Filter by survey page type
    */
@@ -539,18 +501,7 @@ export interface SurveyListParams {
   'Featurebase-Version'?: string;
 }
 
-export interface SurveyRetrieveResponsesParams {
-  /**
-   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
-   * previous response to fetch the next page.
-   */
-  cursor?: string;
-
-  /**
-   * Query param: A limit on the number of objects to be returned, between 1 and 100.
-   */
-  limit?: number;
-
+export interface SurveyListResponsesParams extends CursorPageParams {
   /**
    * Query param: Filter by survey page ID
    */
@@ -567,10 +518,11 @@ export declare namespace Surveys {
   export {
     type Survey as Survey,
     type SurveyNextAction as SurveyNextAction,
-    type SurveyListResponse as SurveyListResponse,
-    type SurveyRetrieveResponsesResponse as SurveyRetrieveResponsesResponse,
+    type SurveyListResponsesResponse as SurveyListResponsesResponse,
+    type SurveysCursorPage as SurveysCursorPage,
+    type SurveyListResponsesResponsesCursorPage as SurveyListResponsesResponsesCursorPage,
     type SurveyRetrieveParams as SurveyRetrieveParams,
     type SurveyListParams as SurveyListParams,
-    type SurveyRetrieveResponsesParams as SurveyRetrieveResponsesParams,
+    type SurveyListResponsesParams as SurveyListResponsesParams,
   };
 }

package/src/resources/users/companies/companies.ts

@@ -11,6 +11,7 @@ import {
   Contacts,
 } from './contacts';
 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';
@@ -164,15 +165,18 @@ export class Companies extends APIResource {
    *
    * @example
    * ```ts
-   * const companies = await client.users.companies.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const company of client.users.companies.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     params: CompanyListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CompanyListResponse> {
+  ): PagePromise<CompaniesCursorPage, Company> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/companies', {
+    return this._client.getAPIList('/v2/companies', CursorPage<Company>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -389,6 +393,8 @@ export class Companies extends APIResource {
   }
 }
 
+export type CompaniesCursorPage = CursorPage<Company>;
+
 export interface Company {
   /**
    * Featurebase internal ID
@@ -478,23 +484,6 @@ export interface DeletedCompany {
   object: 'company';
 }
 
-export interface CompanyListResponse {
-  /**
-   * Array of companies
-   */
-  data: Array<Company>;
-
-  /**
-   * Cursor for fetching the next page (cursor-based pagination)
-   */
-  nextCursor: string | null;
-
-  /**
-   * Object type identifier
-   */
-  object: 'list';
-}
-
 export interface CompanyRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -503,19 +492,7 @@ export interface CompanyRetrieveParams {
   'Featurebase-Version'?: string;
 }
 
-export interface CompanyListParams {
-  /**
-   * 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 companies to be returned, between 1
-   * and 100.
-   */
-  limit?: number;
-
+export interface CompanyListParams extends CursorPageParams {
   /**
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
@@ -614,7 +591,7 @@ export declare namespace Companies {
   export {
     type Company as Company,
     type DeletedCompany as DeletedCompany,
-    type CompanyListResponse as CompanyListResponse,
+    type CompaniesCursorPage as CompaniesCursorPage,
     type CompanyRetrieveParams as CompanyRetrieveParams,
     type CompanyListParams as CompanyListParams,
     type CompanyDeleteParams as CompanyDeleteParams,

package/src/resources/users/companies/contacts.ts

@@ -2,7 +2,9 @@
 
 import { APIResource } from '../../../core/resource';
 import * as UsersContactsAPI from '../contacts/contacts';
+import { ContactListDataCursorPage } from '../contacts/contacts';
 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';
@@ -65,26 +67,32 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contactList =
-   *   await client.users.companies.contacts.list(
-   *     '507f1f77bcf86cd799439011',
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const contact of client.users.companies.contacts.list(
+   *   '507f1f77bcf86cd799439011',
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     id: string,
     params: ContactListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<UsersContactsAPI.ContactList> {
+  ): PagePromise<ContactListDataCursorPage, UsersContactsAPI.ContactList.Data> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get(path`/v2/companies/${id}/contacts`, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
-        options?.headers,
-      ]),
-    });
+    return this._client.getAPIList(
+      path`/v2/companies/${id}/contacts`,
+      CursorPage<UsersContactsAPI.ContactList.Data>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+          options?.headers,
+        ]),
+      },
+    );
   }
 
   /**
@@ -244,19 +252,7 @@ export type ContactAttachResponse = UsersContactsAPI.Contact | (null & {});
  */
 export type ContactRemoveResponse = UsersContactsAPI.Contact | (null & {});
 
-export interface ContactListParams {
-  /**
-   * 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 contacts to be returned, between 1
-   * and 100.
-   */
-  limit?: number;
-
+export interface ContactListParams extends CursorPageParams {
   /**
    * Header param: API version for this request. Defaults to your organization's
    * configured API version if not specified.
@@ -300,3 +296,5 @@ export declare namespace Contacts {
     type ContactRemoveParams as ContactRemoveParams,
   };
 }
+
+export { type ContactListDataCursorPage };

package/src/resources/users/companies/index.ts

@@ -4,12 +4,12 @@ export {
   Companies,
   type Company,
   type DeletedCompany,
-  type CompanyListResponse,
   type CompanyRetrieveParams,
   type CompanyListParams,
   type CompanyDeleteParams,
   type CompanyCreateOrUpdateParams,
   type CompanyDeleteByCompanyIDParams,
+  type CompaniesCursorPage,
 } from './companies';
 export {
   Contacts,

package/src/resources/users/contacts/contacts.ts

@@ -20,6 +20,7 @@ import {
   ByUserIDRetrieveResponse,
 } from './by-user-id/by-user-id';
 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';
@@ -157,12 +158,18 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contactList = await client.users.contacts.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const contact of client.users.contacts.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(params: ContactListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ContactList> {
+  list(
+    params: ContactListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ContactListDataCursorPage, ContactList.Data> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.get('/v2/contacts', {
+    return this._client.getAPIList('/v2/contacts', CursorPage<ContactList.Data>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -478,6 +485,8 @@ export class Contacts extends APIResource {
   }
 }
 
+export type ContactListDataCursorPage = CursorPage<ContactList.Data>;
+
 /**
  * User who submitted the response
  */
@@ -671,23 +680,12 @@ export interface ContactRetrieveParams {
   'Featurebase-Version'?: string;
 }
 
-export interface ContactListParams {
+export interface ContactListParams extends CursorPageParams {
   /**
    * Query param: Filter contacts by type. Defaults to "customer".
    */
   contactType?: 'customer' | 'lead' | 'all';
 
-  /**
-   * 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 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.
@@ -883,6 +881,7 @@ export declare namespace Contacts {
     type ContactBlockResponse as ContactBlockResponse,
     type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse,
     type ContactUnblockResponse as ContactUnblockResponse,
+    type ContactListDataCursorPage as ContactListDataCursorPage,
     type ContactRetrieveParams as ContactRetrieveParams,
     type ContactListParams as ContactListParams,
     type ContactDeleteParams as ContactDeleteParams,

package/src/resources/users/contacts/index.ts

@@ -21,6 +21,7 @@ export {
   type ContactBlockParams,
   type ContactCreateOrUpdateParams,
   type ContactUnblockParams,
+  type ContactListDataCursorPage,
 } from './contacts';
 export {
   EmailPreferences,

package/src/resources/users/index.ts

@@ -4,12 +4,12 @@ export {
   Companies,
   type Company,
   type DeletedCompany,
-  type CompanyListResponse,
   type CompanyRetrieveParams,
   type CompanyListParams,
   type CompanyDeleteParams,
   type CompanyCreateOrUpdateParams,
   type CompanyDeleteByCompanyIDParams,
+  type CompaniesCursorPage,
 } from './companies/index';
 export {
   Contacts,
@@ -26,5 +26,6 @@ export {
   type ContactBlockParams,
   type ContactCreateOrUpdateParams,
   type ContactUnblockParams,
+  type ContactListDataCursorPage,
 } from './contacts/index';
 export { Users } from './users';

package/src/resources/users/users.ts

@@ -4,12 +4,12 @@ import { APIResource } from '../../core/resource';
 import * as CompaniesAPI from './companies/companies';
 import {
   Companies,
+  CompaniesCursorPage,
   Company,
   CompanyCreateOrUpdateParams,
   CompanyDeleteByCompanyIDParams,
   CompanyDeleteParams,
   CompanyListParams,
-  CompanyListResponse,
   CompanyRetrieveParams,
   DeletedCompany,
 } from './companies/companies';
@@ -22,6 +22,7 @@ import {
   ContactCreateOrUpdateResponse,
   ContactDeleteParams,
   ContactList,
+  ContactListDataCursorPage,
   ContactListParams,
   ContactRetrieveParams,
   ContactRetrieveResponse,
@@ -49,6 +50,7 @@ export declare namespace Users {
     type ContactBlockResponse as ContactBlockResponse,
     type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse,
     type ContactUnblockResponse as ContactUnblockResponse,
+    type ContactListDataCursorPage as ContactListDataCursorPage,
     type ContactRetrieveParams as ContactRetrieveParams,
     type ContactListParams as ContactListParams,
     type ContactDeleteParams as ContactDeleteParams,
@@ -61,7 +63,7 @@ export declare namespace Users {
     Companies as Companies,
     type Company as Company,
     type DeletedCompany as DeletedCompany,
-    type CompanyListResponse as CompanyListResponse,
+    type CompaniesCursorPage as CompaniesCursorPage,
     type CompanyRetrieveParams as CompanyRetrieveParams,
     type CompanyListParams as CompanyListParams,
     type CompanyDeleteParams as CompanyDeleteParams,