featurebase-node 0.2.0 → 0.4.0

package/src/resources/{products → support}/tickets/categories.ts

@@ -20,7 +20,7 @@ export class Categories extends APIResource {
    * @example
    * ```ts
    * const board =
-   *   await client.products.tickets.categories.retrieve(
+   *   await client.support.tickets.categories.retrieve(
    *     '507f1f77bcf86cd799439011',
    *   );
    * ```
@@ -58,7 +58,7 @@ export class Categories extends APIResource {
    * @example
    * ```ts
    * const boards =
-   *   await client.products.tickets.categories.list();
+   *   await client.support.tickets.categories.list();
    * ```
    */
   list(

package/src/resources/{products → support}/tickets/custom-fields.ts

@@ -31,7 +31,7 @@ export class CustomFields extends APIResource {
    * @example
    * ```ts
    * const customField =
-   *   await client.products.tickets.customFields.retrieve(
+   *   await client.support.tickets.customFields.retrieve(
    *     '65d26304b2e65b1e1278170c',
    *   );
    * ```
@@ -74,7 +74,7 @@ export class CustomFields extends APIResource {
    * @example
    * ```ts
    * const customFieldList =
-   *   await client.products.tickets.customFields.list();
+   *   await client.support.tickets.customFields.list();
    * ```
    */
   list(

package/src/resources/{products → support}/tickets/index.ts

@@ -17,7 +17,6 @@ export {
   Tickets,
   type AuthorInput,
   type Ticket,
-  type TicketListResponse,
   type TicketDeleteResponse,
   type TicketCreateParams,
   type TicketRetrieveParams,
@@ -25,4 +24,5 @@ export {
   type TicketListParams,
   type TicketDeleteParams,
   type TicketReplyParams,
+  type TicketsCursorPage,
 } from './tickets';

package/src/resources/{products → support}/tickets/statuses.ts

@@ -19,7 +19,7 @@ export class Statuses extends APIResource {
    * @example
    * ```ts
    * const postStatus =
-   *   await client.products.tickets.statuses.retrieve(
+   *   await client.support.tickets.statuses.retrieve(
    *     '507f1f77bcf86cd799439011',
    *   );
    * ```
@@ -54,7 +54,7 @@ export class Statuses extends APIResource {
    * @example
    * ```ts
    * const postStatuses =
-   *   await client.products.tickets.statuses.list();
+   *   await client.support.tickets.statuses.list();
    * ```
    */
   list(

package/src/resources/{products → 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';
@@ -78,7 +79,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.create({
+   * const ticket = await client.support.tickets.create({
    *   author: {},
    *   ticketCategoryId: '507f1f77bcf86cd799439011',
    *   title: 'Cannot login to dashboard',
@@ -111,7 +112,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.retrieve(1);
+   * const ticket = await client.support.tickets.retrieve(1);
    * ```
    */
   retrieve(
@@ -172,7 +173,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.update(1);
+   * const ticket = await client.support.tickets.update(1);
    * ```
    */
   update(id: number, params: TicketUpdateParams, options?: RequestOptions): APIPromise<Ticket> {
@@ -210,15 +211,18 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const tickets = await client.products.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([
@@ -259,7 +263,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.delete(1);
+   * const ticket = await client.support.tickets.delete(1);
    * ```
    */
   delete(
@@ -318,7 +322,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.products.tickets.reply(1, {
+   * const ticket = await client.support.tickets.reply(1, {
    *   body: '<p>Thank you for your help!</p>',
    *   type: 'contact',
    * });
@@ -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,16 +823,6 @@ export interface TicketListParams {
    */
   categoryType?: 'customer' | 'tracker' | 'back-office';
 
-  /**
-   * Query param
-   */
-  cursor?: string;
-
-  /**
-   * Query param
-   */
-  limit?: number;
-
   /**
    * Query param
    */
@@ -987,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/{products.ts → support.ts}

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './products/index';
+export * from './support/index';

package/src/resources/{products/surveys.ts → surveys.ts}

@@ -1,12 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
+import { APIResource } from '../core/resource';
 import * as SurveysAPI from './surveys';
-import * as ContactsAPI from '../users/contacts/contacts';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
+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';
 
 /**
  * Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.
@@ -44,13 +45,6 @@ export class Surveys extends APIResource {
    * ### Errors
    *
    * - `404` - Survey not found in your organization
-   *
-   * @example
-   * ```ts
-   * const survey = await client.products.surveys.retrieve(
-   *   '6743752ca81ae59d25cf834b',
-   * );
-   * ```
    */
   retrieve(
     id: string,
@@ -98,18 +92,13 @@ export class Surveys extends APIResource {
    * - `pages` - Array of survey pages/questions
    * - `createdAt` - ISO 8601 timestamp when created
    * - `updatedAt` - ISO 8601 timestamp when last updated
-   *
-   * @example
-   * ```ts
-   * const surveys = await client.products.surveys.list();
-   * ```
    */
   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([
@@ -156,32 +145,32 @@ export class Surveys extends APIResource {
    * ### Errors
    *
    * - `404` - Survey not found in your organization
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.products.surveys.retrieveResponses(
-   *     '6743752ca81ae59d25cf834b',
-   *   );
-   * ```
    */
-  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
@@ -425,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;
-  }
+    createdAt?: string;
 
-  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;
-
-      /**
-       * ISO 8601 timestamp when updated
-       */
-      updatedAt?: string;
-    }
+    /**
+     * ISO 8601 timestamp when updated
+     */
+    updatedAt?: string;
   }
 }
 
@@ -530,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
    */
@@ -559,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
    */
@@ -587,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 };