featurebase-node 0.13.0 → 0.14.1

package/src/resources/index.ts

@@ -1,30 +1,64 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  AuditLogs,
+  type AuditLogListResponse,
+  type AuditLogListParams,
+  type AuditLogListResponsesCursorPage,
+} from './audit-logs';
 export {
   Changelogs,
   type Changelog,
   type PublishUnpublishSuccess,
   type ChangelogDeleteResponse,
+  type ChangelogListParams,
   type ChangelogCreateParams,
   type ChangelogRetrieveParams,
   type ChangelogUpdateParams,
-  type ChangelogListParams,
   type ChangelogDeleteParams,
   type ChangelogPublishParams,
   type ChangelogUnpublishParams,
   type ChangelogsCursorPage,
 } from './changelogs/changelogs';
+export {
+  ConversationAttributes,
+  type ConversationAttribute,
+  type ConversationAttributeOption,
+  type ConversationAttributeListResponse,
+  type ConversationAttributeListParams,
+  type ConversationAttributeRetrieveParams,
+} from './conversation-attributes';
 export { Feedback } from './feedback/feedback';
 export { HelpCenter } from './help-center/help-center';
 export { Organization } from './organization/organization';
+export {
+  Reports,
+  type ReportAttribute,
+  type ReportAttributeOption,
+  type ReportDataset,
+  type ReportFilterExpression,
+  type ReportFilterRule,
+  type ReportGroupedDatum,
+  type ReportMetric,
+  type ReportSegmentDatum,
+  type ReportTimeSeriesDatum,
+  type ReportDrillInResponse,
+  type ReportListDatasetsResponse,
+  type ReportLookupFilterValuesResponse,
+  type ReportQueryResponse,
+  type ReportListDatasetsParams,
+  type ReportQueryParams,
+  type ReportLookupFilterValuesParams,
+  type ReportDrillInParams,
+} from './reports';
 export { Support } from './support/support';
 export {
   Surveys,
   type Survey,
   type SurveyNextAction,
   type SurveyListResponsesResponse,
-  type SurveyRetrieveParams,
   type SurveyListParams,
+  type SurveyRetrieveParams,
   type SurveyListResponsesParams,
   type SurveysCursorPage,
   type SurveyListResponsesResponsesCursorPage,
@@ -35,10 +69,10 @@ export {
   type Webhook,
   type WebhookRequestConfigInput,
   type WebhookDeleteResponse,
+  type WebhookListParams,
   type WebhookCreateParams,
   type WebhookRetrieveParams,
   type WebhookUpdateParams,
-  type WebhookListParams,
   type WebhookDeleteParams,
   type WebhookRefreshSecretParams,
   type WebhooksCursorPage,

package/src/resources/organization/admins.ts

@@ -11,31 +11,35 @@ import { path } from '../../internal/utils/path';
  */
 export class Admins extends APIResource {
   /**
-   * Retrieves a single admin by their unique identifier.
+   * Returns all admins for your organization.
    *
-   * Returns the admin object if found and they belong to your organization.
+   * This endpoint returns all admins at once (typically a small list). No pagination
+   * is supported.
    *
-   * ### Response
+   * ### Response Format
    *
-   * Returns an admin object with:
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of admin objects
+   * - `nextCursor` - Always null
+   *
+   * ### Admin Object
+   *
+   * Each admin includes:
    *
    * - `id` - Unique admin identifier
    * - `name` - Admin's display name
    * - `email` - Admin's email address
    * - `picture` - Profile picture URL
    * - `roleId` - ID of the role assigned to this admin
-   *
-   * ### Errors
-   *
-   * - `404` - Admin not found or doesn't belong to your organization
    */
-  retrieve(
-    id: string,
-    params: AdminRetrieveParams | null | undefined = {},
+  list(
+    params: AdminListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Admin> {
+  ): APIPromise<AdminListResponse> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/admins/${id}`, {
+    return this._client.get('/v2/admins', {
       ...options,
       headers: buildHeaders([
         {
@@ -49,35 +53,31 @@ export class Admins extends APIResource {
   }
 
   /**
-   * Returns all admins for your organization.
-   *
-   * This endpoint returns all admins at once (typically a small list). No pagination
-   * is supported.
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
+   * Retrieves a single admin by their unique identifier.
    *
-   * - `object` - Always "list"
-   * - `data` - Array of admin objects
-   * - `nextCursor` - Always null
+   * Returns the admin object if found and they belong to your organization.
    *
-   * ### Admin Object
+   * ### Response
    *
-   * Each admin includes:
+   * Returns an admin object with:
    *
    * - `id` - Unique admin identifier
    * - `name` - Admin's display name
    * - `email` - Admin's email address
    * - `picture` - Profile picture URL
    * - `roleId` - ID of the role assigned to this admin
+   *
+   * ### Errors
+   *
+   * - `404` - Admin not found or doesn't belong to your organization
    */
-  list(
-    params: AdminListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: AdminRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<AdminListResponse> {
+  ): APIPromise<Admin> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get('/v2/admins', {
+    return this._client.get(path`/v2/admins/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -158,6 +158,8 @@ export class Admins extends APIResource {
    * - `manage_integrations` - Can manage integrations
    * - `use_integrations` - Can use integrations
    * - `manage_help_center` - Can manage help center
+   * - `manage_outbound` - Can manage outbound messages
+   * - `manage_outbound_state` - Can manage outbound message state
    * - `auto_approve_posts` - Posts auto-approved
    */
   listRoles(
@@ -380,6 +382,16 @@ export namespace AdminListRolesResponse {
        */
       manage_notifications?: boolean;
 
+      /**
+       * Manage outbound messages
+       */
+      manage_outbound?: boolean;
+
+      /**
+       * Manage outbound message state
+       */
+      manage_outbound_state?: boolean;
+
       /**
        * Manage post tags
        */
@@ -533,7 +545,7 @@ export namespace AdminListRolesResponse {
   }
 }
 
-export interface AdminRetrieveParams {
+export interface AdminListParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -541,7 +553,7 @@ export interface AdminRetrieveParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface AdminListParams {
+export interface AdminRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -562,8 +574,8 @@ export declare namespace Admins {
     type Admin as Admin,
     type AdminListResponse as AdminListResponse,
     type AdminListRolesResponse as AdminListRolesResponse,
-    type AdminRetrieveParams as AdminRetrieveParams,
     type AdminListParams as AdminListParams,
+    type AdminRetrieveParams as AdminRetrieveParams,
     type AdminListRolesParams as AdminListRolesParams,
   };
 }

package/src/resources/organization/brands.ts

@@ -12,17 +12,26 @@ import { path } from '../../internal/utils/path';
  */
 export class Brands extends APIResource {
   /**
-   * Retrieves a single brand by its Featurebase ID.
+   * Returns all brands in your organization with cursor-based pagination.
    *
-   * ### Path Parameters
+   * ### Query Parameters
    *
-   * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
+   * - `limit` - Number of brands to return (1-100, default: 10)
+   * - `cursor` - Opaque cursor from a previous response for pagination
    *
-   * ### Response
+   * ### Response Structure
    *
-   * Returns a brand object with:
+   * The response includes:
    *
-   * - `id` - Featurebase internal ID
+   * - `object` - Always "list"
+   * - `data` - Array of brand objects
+   * - `nextCursor` - Cursor for the next page (null if no more results)
+   *
+   * ### Brand Object
+   *
+   * Each brand includes:
+   *
+   * - `id` - Featurebase internal ID (MongoDB ObjectId)
    * - `name` - Brand display name
    * - `isDefault` - Whether this is the default brand
    * - `createdAt` - Creation timestamp
@@ -34,32 +43,34 @@ export class Brands extends APIResource {
    *
    * ```json
    * {
-   *   "object": "brand",
-   *   "id": "507f1f77bcf86cd799439011",
-   *   "name": "Default Brand",
-   *   "isDefault": true,
-   *   "createdAt": "2025-01-01T12:00:00.000Z",
-   *   "updatedAt": "2025-01-10T15:30:00.000Z",
-   *   "helpCenterId": "11",
-   *   "senderEmailAddressId": "507f1f77bcf86cd799439012"
+   *   "object": "list",
+   *   "data": [
+   *     {
+   *       "object": "brand",
+   *       "id": "507f1f77bcf86cd799439011",
+   *       "name": "Default Brand",
+   *       "isDefault": true,
+   *       "createdAt": "2025-01-01T12:00:00.000Z",
+   *       "updatedAt": "2025-01-10T15:30:00.000Z",
+   *       "helpCenterId": "11",
+   *       "senderEmailAddressId": "507f1f77bcf86cd799439012"
+   *     }
+   *   ],
+   *   "nextCursor": null
    * }
    * ```
    *
-   * ### Error Responses
-   *
-   * - **404 Not Found** - Brand with the specified ID does not exist
-   *
    * ### Version Availability
    *
    * This endpoint is only available in API version 2026-01-01.nova and newer.
    */
-  retrieve(
-    id: string,
-    params: BrandRetrieveParams | null | undefined = {},
+  list(
+    params: BrandListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Brand> {
-    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/brands/${id}`, {
+  ): PagePromise<BrandsCursorPage, Brand> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/brands', CursorPage<Brand>, {
+      query,
       ...options,
       headers: buildHeaders([
         {
@@ -73,26 +84,17 @@ export class Brands extends APIResource {
   }
 
   /**
-   * Returns all brands in your organization with cursor-based pagination.
-   *
-   * ### Query Parameters
-   *
-   * - `limit` - Number of brands to return (1-100, default: 10)
-   * - `cursor` - Opaque cursor from a previous response for pagination
-   *
-   * ### Response Structure
+   * Retrieves a single brand by its Featurebase ID.
    *
-   * The response includes:
+   * ### Path Parameters
    *
-   * - `object` - Always "list"
-   * - `data` - Array of brand objects
-   * - `nextCursor` - Cursor for the next page (null if no more results)
+   * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
    *
-   * ### Brand Object
+   * ### Response
    *
-   * Each brand includes:
+   * Returns a brand object with:
    *
-   * - `id` - Featurebase internal ID (MongoDB ObjectId)
+   * - `id` - Featurebase internal ID
    * - `name` - Brand display name
    * - `isDefault` - Whether this is the default brand
    * - `createdAt` - Creation timestamp
@@ -104,34 +106,32 @@ export class Brands extends APIResource {
    *
    * ```json
    * {
-   *   "object": "list",
-   *   "data": [
-   *     {
-   *       "object": "brand",
-   *       "id": "507f1f77bcf86cd799439011",
-   *       "name": "Default Brand",
-   *       "isDefault": true,
-   *       "createdAt": "2025-01-01T12:00:00.000Z",
-   *       "updatedAt": "2025-01-10T15:30:00.000Z",
-   *       "helpCenterId": "11",
-   *       "senderEmailAddressId": "507f1f77bcf86cd799439012"
-   *     }
-   *   ],
-   *   "nextCursor": null
+   *   "object": "brand",
+   *   "id": "507f1f77bcf86cd799439011",
+   *   "name": "Default Brand",
+   *   "isDefault": true,
+   *   "createdAt": "2025-01-01T12:00:00.000Z",
+   *   "updatedAt": "2025-01-10T15:30:00.000Z",
+   *   "helpCenterId": "11",
+   *   "senderEmailAddressId": "507f1f77bcf86cd799439012"
    * }
    * ```
    *
+   * ### Error Responses
+   *
+   * - **404 Not Found** - Brand with the specified ID does not exist
+   *
    * ### Version Availability
    *
    * This endpoint is only available in API version 2026-01-01.nova and newer.
    */
-  list(
-    params: BrandListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: BrandRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<BrandsCursorPage, Brand> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/brands', CursorPage<Brand>, {
-      query,
+  ): APIPromise<Brand> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/brands/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -189,18 +189,18 @@ export interface Brand {
   updatedAt: string | null;
 }
 
-export interface BrandRetrieveParams {
+export interface BrandListParams extends CursorPageParams {
   /**
-   * API version for this request. Defaults to your organization's configured API
-   * version if not specified.
+   * 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 BrandListParams extends CursorPageParams {
+export interface BrandRetrieveParams {
   /**
-   * Header param: API version for this request. Defaults to your organization's
-   * configured API version if not specified.
+   * 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';
 }
@@ -209,7 +209,7 @@ export declare namespace Brands {
   export {
     type Brand as Brand,
     type BrandsCursorPage as BrandsCursorPage,
-    type BrandRetrieveParams as BrandRetrieveParams,
     type BrandListParams as BrandListParams,
+    type BrandRetrieveParams as BrandRetrieveParams,
   };
 }

package/src/resources/organization/index.ts

@@ -5,15 +5,15 @@ export {
   type Admin,
   type AdminListResponse,
   type AdminListRolesResponse,
-  type AdminRetrieveParams,
   type AdminListParams,
+  type AdminRetrieveParams,
   type AdminListRolesParams,
 } from './admins';
 export {
   Brands,
   type Brand,
-  type BrandRetrieveParams,
   type BrandListParams,
+  type BrandRetrieveParams,
   type BrandsCursorPage,
 } from './brands';
 export { Organization } from './organization';
@@ -21,6 +21,6 @@ export {
   Teams,
   type Team,
   type TeamListResponse,
-  type TeamRetrieveParams,
   type TeamListParams,
+  type TeamRetrieveParams,
 } from './teams';

package/src/resources/organization/organization.ts

@@ -32,8 +32,8 @@ export declare namespace Organization {
     type Admin as Admin,
     type AdminListResponse as AdminListResponse,
     type AdminListRolesResponse as AdminListRolesResponse,
-    type AdminRetrieveParams as AdminRetrieveParams,
     type AdminListParams as AdminListParams,
+    type AdminRetrieveParams as AdminRetrieveParams,
     type AdminListRolesParams as AdminListRolesParams,
   };
 
@@ -41,15 +41,15 @@ export declare namespace Organization {
     Teams as Teams,
     type Team as Team,
     type TeamListResponse as TeamListResponse,
-    type TeamRetrieveParams as TeamRetrieveParams,
     type TeamListParams as TeamListParams,
+    type TeamRetrieveParams as TeamRetrieveParams,
   };
 
   export {
     Brands as Brands,
     type Brand as Brand,
     type BrandsCursorPage as BrandsCursorPage,
-    type BrandRetrieveParams as BrandRetrieveParams,
     type BrandListParams as BrandListParams,
+    type BrandRetrieveParams as BrandRetrieveParams,
   };
 }

package/src/resources/organization/teams.ts

@@ -11,15 +11,18 @@ import { path } from '../../internal/utils/path';
  */
 export class Teams extends APIResource {
   /**
-   * Retrieves a single team by its Featurebase ID.
+   * Returns all teams in your organization.
    *
-   * ### Path Parameters
+   * ### Response Structure
    *
-   * - `id` - The Featurebase internal ID of the team (MongoDB ObjectId)
+   * The response includes:
    *
-   * ### Response
+   * - `object` - Always "list"
+   * - `data` - Array of team objects
    *
-   * Returns a team object with:
+   * ### Team Object
+   *
+   * Each team includes:
    *
    * - `id` - Unique team identifier
    * - `name` - Team display name
@@ -31,33 +34,33 @@ export class Teams extends APIResource {
    *
    * ```json
    * {
-   *   "object": "team",
-   *   "id": "507f1f77bcf86cd799439011",
-   *   "name": "Support Team",
-   *   "color": "#3B82F6",
-   *   "icon": {
-   *     "value": "👥",
-   *     "type": "emoji"
-   *   },
-   *   "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
+   *   "object": "list",
+   *   "data": [
+   *     {
+   *       "object": "team",
+   *       "id": "507f1f77bcf86cd799439011",
+   *       "name": "Support Team",
+   *       "color": "#3B82F6",
+   *       "icon": {
+   *         "value": "👥",
+   *         "type": "emoji"
+   *       },
+   *       "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
+   *     }
+   *   ]
    * }
    * ```
    *
-   * ### Error Responses
-   *
-   * - **404 Not Found** - Team with the specified ID does not exist
-   *
    * ### Version Availability
    *
    * This endpoint is only available in API version 2026-01-01.nova and newer.
    */
-  retrieve(
-    id: string,
-    params: TeamRetrieveParams | null | undefined = {},
+  list(
+    params: TeamListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Team> {
+  ): APIPromise<TeamListResponse> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/teams/${id}`, {
+    return this._client.get('/v2/teams', {
       ...options,
       headers: buildHeaders([
         {
@@ -71,18 +74,15 @@ export class Teams extends APIResource {
   }
 
   /**
-   * Returns all teams in your organization.
-   *
-   * ### Response Structure
+   * Retrieves a single team by its Featurebase ID.
    *
-   * The response includes:
+   * ### Path Parameters
    *
-   * - `object` - Always "list"
-   * - `data` - Array of team objects
+   * - `id` - The Featurebase internal ID of the team (MongoDB ObjectId)
    *
-   * ### Team Object
+   * ### Response
    *
-   * Each team includes:
+   * Returns a team object with:
    *
    * - `id` - Unique team identifier
    * - `name` - Team display name
@@ -94,33 +94,33 @@ export class Teams extends APIResource {
    *
    * ```json
    * {
-   *   "object": "list",
-   *   "data": [
-   *     {
-   *       "object": "team",
-   *       "id": "507f1f77bcf86cd799439011",
-   *       "name": "Support Team",
-   *       "color": "#3B82F6",
-   *       "icon": {
-   *         "value": "👥",
-   *         "type": "emoji"
-   *       },
-   *       "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
-   *     }
-   *   ]
+   *   "object": "team",
+   *   "id": "507f1f77bcf86cd799439011",
+   *   "name": "Support Team",
+   *   "color": "#3B82F6",
+   *   "icon": {
+   *     "value": "👥",
+   *     "type": "emoji"
+   *   },
+   *   "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
    * }
    * ```
    *
+   * ### Error Responses
+   *
+   * - **404 Not Found** - Team with the specified ID does not exist
+   *
    * ### Version Availability
    *
    * This endpoint is only available in API version 2026-01-01.nova and newer.
    */
-  list(
-    params: TeamListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: TeamRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<TeamListResponse> {
+  ): APIPromise<Team> {
     const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get('/v2/teams', {
+    return this._client.get(path`/v2/teams/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -195,7 +195,7 @@ export interface TeamListResponse {
   object: 'list';
 }
 
-export interface TeamRetrieveParams {
+export interface TeamListParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -203,7 +203,7 @@ export interface TeamRetrieveParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface TeamListParams {
+export interface TeamRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
    * version if not specified.
@@ -215,7 +215,7 @@ export declare namespace Teams {
   export {
     type Team as Team,
     type TeamListResponse as TeamListResponse,
-    type TeamRetrieveParams as TeamRetrieveParams,
     type TeamListParams as TeamListParams,
+    type TeamRetrieveParams as TeamRetrieveParams,
   };
 }