featurebase-node 0.12.0 → 0.14.0

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

@@ -23,6 +23,54 @@ export class Tickets extends APIResource {
   categories: CategoriesAPI.Categories = new CategoriesAPI.Categories(this._client);
   statuses: StatusesAPI.Statuses = new StatusesAPI.Statuses(this._client);
 
+  /**
+   * Returns a list of tickets in your organization using cursor-based pagination.
+   *
+   * ### Query Parameters
+   *
+   * | Parameter           | Type     | Description                                                      |
+   * | ------------------- | -------- | ---------------------------------------------------------------- |
+   * | `limit`             | number   | Number of tickets to return (1-100, default 10)                  |
+   * | `cursor`            | string   | Cursor from previous response for pagination                     |
+   * | `ticketCategoryIds` | string[] | Filter by ticket category IDs                                    |
+   * | `statusIds`         | string[] | Filter by status IDs                                             |
+   * | `q`                 | string   | Search query                                                     |
+   * | `assigneeId`        | string   | Filter by assignee ID                                            |
+   * | `categoryType`      | string   | Filter by category type: "customer", "tracker", or "back-office" |
+   * | `sortBy`            | string   | Sort field: "date" (default), "recent", or "ticketNumber"        |
+   * | `sortOrder`         | string   | Sort direction: "asc" or "desc" (default)                        |
+   *
+   * ### Response
+   *
+   * Returns a list object with `data` (array of ticket objects) and `nextCursor`.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const ticket of client.support.tickets.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: TicketListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TicketsCursorPage, Ticket> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/tickets', CursorPage<Ticket>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Creates a new ticket.
    *
@@ -200,54 +248,6 @@ export class Tickets extends APIResource {
     });
   }
 
-  /**
-   * Returns a list of tickets in your organization using cursor-based pagination.
-   *
-   * ### Query Parameters
-   *
-   * | Parameter           | Type     | Description                                                      |
-   * | ------------------- | -------- | ---------------------------------------------------------------- |
-   * | `limit`             | number   | Number of tickets to return (1-100, default 10)                  |
-   * | `cursor`            | string   | Cursor from previous response for pagination                     |
-   * | `ticketCategoryIds` | string[] | Filter by ticket category IDs                                    |
-   * | `statusIds`         | string[] | Filter by status IDs                                             |
-   * | `q`                 | string   | Search query                                                     |
-   * | `assigneeId`        | string   | Filter by assignee ID                                            |
-   * | `categoryType`      | string   | Filter by category type: "customer", "tracker", or "back-office" |
-   * | `sortBy`            | string   | Sort field: "date" (default), "recent", or "ticketNumber"        |
-   * | `sortOrder`         | string   | Sort direction: "asc" or "desc" (default)                        |
-   *
-   * ### Response
-   *
-   * Returns a list object with `data` (array of ticket objects) and `nextCursor`.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const ticket of client.support.tickets.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: TicketListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<TicketsCursorPage, Ticket> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/tickets', CursorPage<Ticket>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Permanently deletes a ticket by its ticket number.
    *
@@ -710,6 +710,49 @@ export interface TicketDeleteResponse {
   object: 'ticket';
 }
 
+export interface TicketListParams extends CursorPageParams {
+  /**
+   * Query param
+   */
+  assigneeId?: string;
+
+  /**
+   * Query param
+   */
+  categoryType?: 'customer' | 'tracker' | 'back-office';
+
+  /**
+   * Query param
+   */
+  q?: string;
+
+  /**
+   * Query param
+   */
+  sortBy?: 'date' | 'recent' | 'ticketNumber';
+
+  /**
+   * Query param
+   */
+  sortOrder?: 'asc' | 'desc';
+
+  /**
+   * Query param
+   */
+  statusIds?: Array<string>;
+
+  /**
+   * Query param
+   */
+  ticketCategoryIds?: 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 TicketCreateParams {
   /**
    * Body param: Author to attribute the post to. If not provided, uses the
@@ -836,49 +879,6 @@ export interface TicketUpdateParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface TicketListParams extends CursorPageParams {
-  /**
-   * Query param
-   */
-  assigneeId?: string;
-
-  /**
-   * Query param
-   */
-  categoryType?: 'customer' | 'tracker' | 'back-office';
-
-  /**
-   * Query param
-   */
-  q?: string;
-
-  /**
-   * Query param
-   */
-  sortBy?: 'date' | 'recent' | 'ticketNumber';
-
-  /**
-   * Query param
-   */
-  sortOrder?: 'asc' | 'desc';
-
-  /**
-   * Query param
-   */
-  statusIds?: Array<string>;
-
-  /**
-   * Query param
-   */
-  ticketCategoryIds?: 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 TicketDeleteParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -992,31 +992,31 @@ export declare namespace Tickets {
     type Ticket as Ticket,
     type TicketDeleteResponse as TicketDeleteResponse,
     type TicketsCursorPage as TicketsCursorPage,
+    type TicketListParams as TicketListParams,
     type TicketCreateParams as TicketCreateParams,
     type TicketRetrieveParams as TicketRetrieveParams,
     type TicketUpdateParams as TicketUpdateParams,
-    type TicketListParams as TicketListParams,
     type TicketDeleteParams as TicketDeleteParams,
     type TicketReplyParams as TicketReplyParams,
   };
 
   export {
     CustomFields as CustomFields,
-    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
     type CustomFieldListParams as CustomFieldListParams,
+    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
   };
 
   export {
     Categories as Categories,
     type CategoryListResponse as CategoryListResponse,
-    type CategoryRetrieveParams as CategoryRetrieveParams,
     type CategoryListParams as CategoryListParams,
+    type CategoryRetrieveParams as CategoryRetrieveParams,
   };
 
   export {
     Statuses as Statuses,
     type StatusListResponse as StatusListResponse,
-    type StatusRetrieveParams as StatusRetrieveParams,
     type StatusListParams as StatusListParams,
+    type StatusRetrieveParams as StatusRetrieveParams,
   };
 }

package/src/resources/surveys.ts

@@ -14,45 +14,44 @@ import { path } from '../internal/utils/path';
  */
 export class Surveys extends APIResource {
   /**
-   * Retrieves a single survey by its unique identifier.
+   * Returns all surveys configured in your Featurebase organization.
    *
-   * Returns the survey object if found in your organization.
+   * ### Query Parameters
    *
-   * ### Response
+   * - `limit` - Number of items to return (1-100, default 10)
+   * - `cursor` - Cursor for pagination
+   * - `type` - Filter by survey page type (text, link, rating, multiple-choice)
+   * - `isActive` - Filter by active status
    *
-   * Returns a survey object with:
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of survey objects
+   * - `nextCursor` - Cursor for next page (null if no more results)
+   *
+   * ### Survey Object
+   *
+   * Each survey includes:
    *
    * - `id` - Unique identifier
    * - `title` - Survey title
    * - `description` - Survey description
    * - `isActive` - Whether the survey is active
    * - `responseCount` - Number of responses received
-   * - `targeting` - Targeting configuration
+   * - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
    * - `pages` - Array of survey pages/questions
    * - `createdAt` - ISO 8601 timestamp when created
    * - `updatedAt` - ISO 8601 timestamp when last updated
-   *
-   * ### Survey Pages
-   *
-   * Each page represents a question or screen in the survey:
-   *
-   * - `type` - Page type (text, link, rating, multiple-choice)
-   * - `title` - Question title
-   * - `description` - Optional description
-   * - `logic` - Conditional logic rules
-   * - `defaultAction` - Default action when no logic matches
-   *
-   * ### Errors
-   *
-   * - `404` - Survey not found in your organization
    */
-  retrieve(
-    id: string,
-    params: SurveyRetrieveParams | null | undefined = {},
+  list(
+    params: SurveyListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Survey> {
-    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/surveys/${id}`, {
+  ): PagePromise<SurveysCursorPage, Survey> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/surveys', CursorPage<Survey>, {
+      query,
       ...options,
       headers: buildHeaders([
         {
@@ -66,44 +65,45 @@ export class Surveys extends APIResource {
   }
 
   /**
-   * Returns all surveys configured in your Featurebase organization.
-   *
-   * ### Query Parameters
-   *
-   * - `limit` - Number of items to return (1-100, default 10)
-   * - `cursor` - Cursor for pagination
-   * - `type` - Filter by survey page type (text, link, rating, multiple-choice)
-   * - `isActive` - Filter by active status
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
+   * Retrieves a single survey by its unique identifier.
    *
-   * - `object` - Always "list"
-   * - `data` - Array of survey objects
-   * - `nextCursor` - Cursor for next page (null if no more results)
+   * Returns the survey object if found in your organization.
    *
-   * ### Survey Object
+   * ### Response
    *
-   * Each survey includes:
+   * Returns a survey object with:
    *
    * - `id` - Unique identifier
    * - `title` - Survey title
    * - `description` - Survey description
    * - `isActive` - Whether the survey is active
    * - `responseCount` - Number of responses received
-   * - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
+   * - `targeting` - Targeting configuration
    * - `pages` - Array of survey pages/questions
    * - `createdAt` - ISO 8601 timestamp when created
    * - `updatedAt` - ISO 8601 timestamp when last updated
+   *
+   * ### Survey Pages
+   *
+   * Each page represents a question or screen in the survey:
+   *
+   * - `type` - Page type (text, link, rating, multiple-choice)
+   * - `title` - Question title
+   * - `description` - Optional description
+   * - `logic` - Conditional logic rules
+   * - `defaultAction` - Default action when no logic matches
+   *
+   * ### Errors
+   *
+   * - `404` - Survey not found in your organization
    */
-  list(
-    params: SurveyListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: SurveyRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<SurveysCursorPage, Survey> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/surveys', CursorPage<Survey>, {
-      query,
+  ): APIPromise<Survey> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/surveys/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -487,14 +487,6 @@ export namespace SurveyListResponsesResponse {
   }
 }
 
-export interface SurveyRetrieveParams {
-  /**
-   * 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 SurveyListParams extends CursorPageParams {
   /**
    * Query param: Filter by active status
@@ -513,6 +505,14 @@ export interface SurveyListParams extends CursorPageParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
+export interface SurveyRetrieveParams {
+  /**
+   * 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 SurveyListResponsesParams extends CursorPageParams {
   /**
    * Query param: Filter by survey page ID
@@ -533,8 +533,8 @@ export declare namespace Surveys {
     type SurveyListResponsesResponse as SurveyListResponsesResponse,
     type SurveysCursorPage as SurveysCursorPage,
     type SurveyListResponsesResponsesCursorPage as SurveyListResponsesResponsesCursorPage,
-    type SurveyRetrieveParams as SurveyRetrieveParams,
     type SurveyListParams as SurveyListParams,
+    type SurveyRetrieveParams as SurveyRetrieveParams,
     type SurveyListResponsesParams as SurveyListResponsesParams,
   };
 }