featurebase-node 0.13.0 → 0.14.0

package/src/resources/changelogs/changelogs.ts

@@ -21,6 +21,84 @@ import { path } from '../../internal/utils/path';
 export class Changelogs extends APIResource {
   subscribers: SubscribersAPI.Subscribers = new SubscribersAPI.Subscribers(this._client);
 
+  /**
+   * Returns all changelogs for the authenticated organization.
+   *
+   * Changelogs are release notes and updates that keep users informed about new
+   * features, improvements, and bug fixes. Each changelog can have:
+   *
+   * - Multiple translations (locales)
+   * - Categories for organization
+   * - Featured images
+   * - Scheduled publishing
+   *
+   * ### Pagination
+   *
+   * This endpoint uses **cursor-based pagination**:
+   *
+   * - `limit` - Number of changelogs to return (1-100, default 10)
+   * - `cursor` - Opaque cursor from a previous response's `nextCursor` field
+   *
+   * **Example:** To paginate through results:
+   *
+   * 1. First request: `GET /v2/changelogs?limit=10`
+   * 2. If `nextCursor` is not null, use it for the next page
+   * 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of changelog objects
+   * - `nextCursor` - Cursor for the next page (null if no more results)
+   *
+   * ### Filtering
+   *
+   * Filter changelogs using query parameters:
+   *
+   * - `id` - Find a specific changelog by ID or slug
+   * - `q` - Search query for title/content
+   * - `categories` - Filter by category names
+   * - `locale` - Get changelogs in a specific locale (defaults to org default)
+   * - `state` - Filter by state: `live`, `draft`, or `all`
+   * - `startDate` - Include changelogs dated on or after this date
+   * - `endDate` - Include changelogs dated on or before this date
+   *
+   * ### Sorting
+   *
+   * Results are sorted by date (descending by default):
+   *
+   * - `sortBy` - Field to sort by (currently only `date`)
+   * - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const changelog of client.changelogs.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: ChangelogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ChangelogsCursorPage, Changelog> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/changelogs', CursorPage<Changelog>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Creates a new changelog for the authenticated organization.
    *
@@ -191,84 +269,6 @@ export class Changelogs extends APIResource {
     });
   }
 
-  /**
-   * Returns all changelogs for the authenticated organization.
-   *
-   * Changelogs are release notes and updates that keep users informed about new
-   * features, improvements, and bug fixes. Each changelog can have:
-   *
-   * - Multiple translations (locales)
-   * - Categories for organization
-   * - Featured images
-   * - Scheduled publishing
-   *
-   * ### Pagination
-   *
-   * This endpoint uses **cursor-based pagination**:
-   *
-   * - `limit` - Number of changelogs to return (1-100, default 10)
-   * - `cursor` - Opaque cursor from a previous response's `nextCursor` field
-   *
-   * **Example:** To paginate through results:
-   *
-   * 1. First request: `GET /v2/changelogs?limit=10`
-   * 2. If `nextCursor` is not null, use it for the next page
-   * 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
-   *
-   * - `object` - Always "list"
-   * - `data` - Array of changelog objects
-   * - `nextCursor` - Cursor for the next page (null if no more results)
-   *
-   * ### Filtering
-   *
-   * Filter changelogs using query parameters:
-   *
-   * - `id` - Find a specific changelog by ID or slug
-   * - `q` - Search query for title/content
-   * - `categories` - Filter by category names
-   * - `locale` - Get changelogs in a specific locale (defaults to org default)
-   * - `state` - Filter by state: `live`, `draft`, or `all`
-   * - `startDate` - Include changelogs dated on or after this date
-   * - `endDate` - Include changelogs dated on or before this date
-   *
-   * ### Sorting
-   *
-   * Results are sorted by date (descending by default):
-   *
-   * - `sortBy` - Field to sort by (currently only `date`)
-   * - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const changelog of client.changelogs.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: ChangelogListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ChangelogsCursorPage, Changelog> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/changelogs', CursorPage<Changelog>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Deletes a changelog by its unique identifier.
    *
@@ -699,45 +699,25 @@ export interface ChangelogDeleteResponse {
   object: 'changelog';
 }
 
-export interface ChangelogCreateParams {
-  /**
-   * Body param: The title of the changelog
-   */
-  title: string;
-
-  /**
-   * Body param: An array of segment IDs that are allowed to view the changelog
-   */
-  allowedSegmentIds?: Array<string>;
-
-  /**
-   * Body param: An array of category names to which the changelog belongs
-   */
-  categories?: Array<string>;
-
+export interface ChangelogListParams extends CursorPageParams {
   /**
-   * Body param: The date of the changelog
+   * Query param: Find changelog by its id (also accepts slug)
    */
-  date?: string | null;
+  id?: string;
 
   /**
-   * Body param: The URL of the featured image for the changelog. External URLs will
-   * be uploaded to our storage.
+   * Query param: Filter changelogs by category names (single value or array)
    */
-  featuredImage?: string;
+  categories?: string | Array<string>;
 
   /**
-   * Body param: HTML content of the changelog. Provide either htmlContent or
-   * markdownContent. Supports Featurebase custom blocks (callouts, multi-code,
-   * accordions, columns, file/image/video, iframes) — see the **Content Components**
-   * guide. External image URLs and base64 data URIs are uploaded to our storage
-   * automatically.
+   * Query param: Include Changelogs dated on or before the specified end date
    */
-  htmlContent?: string;
+  endDate?: string | null;
 
   /**
-   * Body param: The locale of the changelog, defaulting to the organization default
-   * locale
+   * Query param: The locale of the changelogs. Defaults to the organization default
+   * locale.
    */
   locale?:
     | 'bn'
@@ -784,17 +764,30 @@ export interface ChangelogCreateParams {
     | 'vi';
 
   /**
-   * Body param: Markdown content of the changelog (CommonMark + GFM). Provide either
-   * htmlContent or markdownContent. Markdown is converted to plain HTML — to use
-   * Featurebase custom blocks (callouts, multi-code, accordions, columns) send
-   * htmlContent instead. See the **Content Components** guide.
+   * Query param: Search for changelogs by title or content
    */
-  markdownContent?: string;
+  q?: string;
 
   /**
-   * Body param: The state of the changelog (draft or live)
+   * Query param: Field to sort by
    */
-  state?: 'draft' | 'live';
+  sortBy?: 'date';
+
+  /**
+   * Query param: Sort direction
+   */
+  sortOrder?: 'asc' | 'desc';
+
+  /**
+   * Query param: Include Changelogs dated on or after the specified start date
+   */
+  startDate?: string | null;
+
+  /**
+   * Query param: The state of the changelog. Use "all" to get both draft and live
+   * changelogs.
+   */
+  state?: 'draft' | 'live' | 'all';
 
   /**
    * Header param: API version for this request. Defaults to your organization's
@@ -803,15 +796,12 @@ export interface ChangelogCreateParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface ChangelogRetrieveParams {
+export interface ChangelogCreateParams {
   /**
-   * API version for this request. Defaults to your organization's configured API
-   * version if not specified.
+   * Body param: The title of the changelog
    */
-  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
-}
+  title: string;
 
-export interface ChangelogUpdateParams {
   /**
    * Body param: An array of segment IDs that are allowed to view the changelog
    */
@@ -843,44 +833,8 @@ export interface ChangelogUpdateParams {
   htmlContent?: string;
 
   /**
-   * Body param: Markdown content of the changelog (CommonMark + GFM). Provide either
-   * htmlContent or markdownContent. Markdown is converted to plain HTML — to use
-   * Featurebase custom blocks (callouts, multi-code, accordions, columns) send
-   * htmlContent instead. See the **Content Components** guide.
-   */
-  markdownContent?: string;
-
-  /**
-   * Body param: The title of the changelog
-   */
-  title?: 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 ChangelogListParams extends CursorPageParams {
-  /**
-   * Query param: Find changelog by its id (also accepts slug)
-   */
-  id?: string;
-
-  /**
-   * Query param: Filter changelogs by category names (single value or array)
-   */
-  categories?: string | Array<string>;
-
-  /**
-   * Query param: Include Changelogs dated on or before the specified end date
-   */
-  endDate?: string | null;
-
-  /**
-   * Query param: The locale of the changelogs. Defaults to the organization default
-   * locale.
+   * Body param: The locale of the changelog, defaulting to the organization default
+   * locale
    */
   locale?:
     | 'bn'
@@ -927,30 +881,76 @@ export interface ChangelogListParams extends CursorPageParams {
     | 'vi';
 
   /**
-   * Query param: Search for changelogs by title or content
+   * Body param: Markdown content of the changelog (CommonMark + GFM). Provide either
+   * htmlContent or markdownContent. Markdown is converted to plain HTML — to use
+   * Featurebase custom blocks (callouts, multi-code, accordions, columns) send
+   * htmlContent instead. See the **Content Components** guide.
    */
-  q?: string;
+  markdownContent?: string;
 
   /**
-   * Query param: Field to sort by
+   * Body param: The state of the changelog (draft or live)
    */
-  sortBy?: 'date';
+  state?: 'draft' | 'live';
 
   /**
-   * Query param: Sort direction
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
    */
-  sortOrder?: 'asc' | 'desc';
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+}
 
+export interface ChangelogRetrieveParams {
   /**
-   * Query param: Include Changelogs dated on or after the specified start date
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
    */
-  startDate?: string | null;
+  'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
+}
 
+export interface ChangelogUpdateParams {
   /**
-   * Query param: The state of the changelog. Use "all" to get both draft and live
-   * changelogs.
+   * Body param: An array of segment IDs that are allowed to view the changelog
    */
-  state?: 'draft' | 'live' | 'all';
+  allowedSegmentIds?: Array<string>;
+
+  /**
+   * Body param: An array of category names to which the changelog belongs
+   */
+  categories?: Array<string>;
+
+  /**
+   * Body param: The date of the changelog
+   */
+  date?: string | null;
+
+  /**
+   * Body param: The URL of the featured image for the changelog. External URLs will
+   * be uploaded to our storage.
+   */
+  featuredImage?: string;
+
+  /**
+   * Body param: HTML content of the changelog. Provide either htmlContent or
+   * markdownContent. Supports Featurebase custom blocks (callouts, multi-code,
+   * accordions, columns, file/image/video, iframes) — see the **Content Components**
+   * guide. External image URLs and base64 data URIs are uploaded to our storage
+   * automatically.
+   */
+  htmlContent?: string;
+
+  /**
+   * Body param: Markdown content of the changelog (CommonMark + GFM). Provide either
+   * htmlContent or markdownContent. Markdown is converted to plain HTML — to use
+   * Featurebase custom blocks (callouts, multi-code, accordions, columns) send
+   * htmlContent instead. See the **Content Components** guide.
+   */
+  markdownContent?: string;
+
+  /**
+   * Body param: The title of the changelog
+   */
+  title?: string;
 
   /**
    * Header param: API version for this request. Defaults to your organization's
@@ -1101,10 +1101,10 @@ export declare namespace Changelogs {
     type PublishUnpublishSuccess as PublishUnpublishSuccess,
     type ChangelogDeleteResponse as ChangelogDeleteResponse,
     type ChangelogsCursorPage as ChangelogsCursorPage,
+    type ChangelogListParams as ChangelogListParams,
     type ChangelogCreateParams as ChangelogCreateParams,
     type ChangelogRetrieveParams as ChangelogRetrieveParams,
     type ChangelogUpdateParams as ChangelogUpdateParams,
-    type ChangelogListParams as ChangelogListParams,
     type ChangelogDeleteParams as ChangelogDeleteParams,
     type ChangelogPublishParams as ChangelogPublishParams,
     type ChangelogUnpublishParams as ChangelogUnpublishParams,

package/src/resources/changelogs/index.ts

@@ -5,10 +5,10 @@ export {
   type Changelog,
   type PublishUnpublishSuccess,
   type ChangelogDeleteResponse,
+  type ChangelogListParams,
   type ChangelogCreateParams,
   type ChangelogRetrieveParams,
   type ChangelogUpdateParams,
-  type ChangelogListParams,
   type ChangelogDeleteParams,
   type ChangelogPublishParams,
   type ChangelogUnpublishParams,

package/src/resources/conversation-attributes.ts

@@ -0,0 +1,181 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Conversation custom attribute definitions configured in your Featurebase organization. Use these definitions to map ID-keyed conversation custom attributes to human-readable names and value types.
+ */
+export class ConversationAttributes extends APIResource {
+  /**
+   * Returns conversation custom attribute definitions configured in your
+   * organization.
+   *
+   * Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
+   * Use this endpoint to map those IDs to display names, identifiers, data types,
+   * field subtypes, and select options.
+   *
+   * By default, archived definitions are excluded. Set `includeArchived=true` to
+   * include archived definitions.
+   */
+  list(
+    params: ConversationAttributeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConversationAttributeListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.get('/v2/conversation_attributes', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Retrieves a single conversation custom attribute definition by its stable ID.
+   *
+   * Use this when a conversation response contains a `customAttributes` key and you
+   * need the corresponding display name, identifier, data type, field subtype, or
+   * options.
+   */
+  retrieve(
+    id: string,
+    params: ConversationAttributeRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConversationAttribute> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/conversation_attributes/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface ConversationAttribute {
+  /**
+   * Stable machine identifier used as the key in conversation.customAttributes.
+   */
+  id: string;
+
+  /**
+   * Whether this definition has been archived.
+   */
+  archived: boolean;
+
+  /**
+   * Storage-level data type used for validation and search.
+   */
+  dataType: 'string' | 'number' | 'boolean' | 'date' | 'array' | 'object';
+
+  /**
+   * Conversation field subtype that controls the expected value shape.
+   */
+  fieldSubType: 'text' | 'number' | 'select' | 'multi-select' | 'checkbox' | 'date';
+
+  /**
+   * Stable internal identifier for the attribute definition.
+   */
+  identifier: string;
+
+  /**
+   * Human-readable attribute name shown in Featurebase.
+   */
+  name: string;
+
+  /**
+   * Object type identifier
+   */
+  object: 'conversation_attribute';
+
+  /**
+   * ISO timestamp when the attribute was created.
+   */
+  createdAt?: string;
+
+  /**
+   * Allowed values for select and multi-select attributes.
+   */
+  options?: Array<ConversationAttributeOption>;
+
+  /**
+   * ISO timestamp when the attribute was last updated.
+   */
+  updatedAt?: string;
+}
+
+export interface ConversationAttributeOption {
+  /**
+   * Option display label
+   */
+  label: string;
+
+  /**
+   * Option unique identifier when stored for this option.
+   */
+  id?: string;
+}
+
+export interface ConversationAttributeListResponse {
+  /**
+   * Array of conversation custom attribute definitions.
+   */
+  data: Array<ConversationAttribute>;
+
+  /**
+   * Cursor for fetching the next page. Always null; all definitions are returned at
+   * once.
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+}
+
+export interface ConversationAttributeListParams {
+  /**
+   * Query param: Include archived conversation custom attributes in the response.
+   */
+  includeArchived?: boolean | 'true' | 'false';
+
+  /**
+   * 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 ConversationAttributeRetrieveParams {
+  /**
+   * 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 declare namespace ConversationAttributes {
+  export {
+    type ConversationAttribute as ConversationAttribute,
+    type ConversationAttributeOption as ConversationAttributeOption,
+    type ConversationAttributeListResponse as ConversationAttributeListResponse,
+    type ConversationAttributeListParams as ConversationAttributeListParams,
+    type ConversationAttributeRetrieveParams as ConversationAttributeRetrieveParams,
+  };
+}