featurebase-node 0.12.0 → 0.14.0

package/src/resources/help-center/articles.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as ArticlesAPI from './articles';
+import * as PostsAPI from '../feedback/posts/posts';
 import { APIPromise } from '../../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
@@ -12,6 +13,83 @@ import { path } from '../../internal/utils/path';
  * Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
  */
 export class Articles extends APIResource {
+  /**
+   * Returns a paginated list of articles within your organization's help center.
+   *
+   * Articles are the main content pieces that contain documentation, guides, and
+   * FAQs.
+   *
+   * ### Query Parameters
+   *
+   * - `limit` - Number of items to return (1-100, default 10)
+   * - `cursor` - Cursor for pagination
+   * - `state` - Filter by article state: "live", "draft", or "all" (default "live")
+   * - `parentId` - Filter by parent collection ID
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of article objects
+   * - `nextCursor` - Cursor for next page (null if no more results)
+   *
+   * ### Article Object
+   *
+   * Each article includes:
+   *
+   * - `id` - Unique identifier
+   * - `title` - Article title
+   * - `description` - Article description
+   * - `body` - Article content (HTML)
+   * - `slug` - URL slug
+   * - `icon` - Article icon (emoji or custom)
+   * - `parentId` - Parent collection ID
+   * - `helpCenterId` - ID of the help center this article belongs to
+   * - `organization` - Organization ID
+   * - `state` - Article state (live or draft)
+   * - `defaultLocale` - Default locale for content
+   * - `locale` - Current locale
+   * - `availableLocales` - Array of available locales
+   * - `publishedLocales` - Array of locales where article is published
+   * - `featurebaseUrl` - Featurebase URL for the article
+   * - `externalUrl` - External URL if custom domain is configured
+   * - `author` - Author information (name, authorId, avatarUrl)
+   * - `order` - Display order
+   * - `isPublished` - Whether the article is published
+   * - `isDraftDiffersFromLive` - Whether draft differs from live version
+   * - `translations` - Translations for different locales
+   * - `createdAt` - ISO 8601 timestamp when created
+   * - `updatedAt` - ISO 8601 timestamp when last updated
+   * - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const article of client.helpCenter.articles.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: ArticleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ArticlesCursorPage, Article> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/help_center/articles', CursorPage<Article>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Creates a new article in your organization's help center.
    *
@@ -221,83 +299,6 @@ export class Articles extends APIResource {
     });
   }
 
-  /**
-   * Returns a paginated list of articles within your organization's help center.
-   *
-   * Articles are the main content pieces that contain documentation, guides, and
-   * FAQs.
-   *
-   * ### Query Parameters
-   *
-   * - `limit` - Number of items to return (1-100, default 10)
-   * - `cursor` - Cursor for pagination
-   * - `state` - Filter by article state: "live", "draft", or "all" (default "live")
-   * - `parentId` - Filter by parent collection ID
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
-   *
-   * - `object` - Always "list"
-   * - `data` - Array of article objects
-   * - `nextCursor` - Cursor for next page (null if no more results)
-   *
-   * ### Article Object
-   *
-   * Each article includes:
-   *
-   * - `id` - Unique identifier
-   * - `title` - Article title
-   * - `description` - Article description
-   * - `body` - Article content (HTML)
-   * - `slug` - URL slug
-   * - `icon` - Article icon (emoji or custom)
-   * - `parentId` - Parent collection ID
-   * - `helpCenterId` - ID of the help center this article belongs to
-   * - `organization` - Organization ID
-   * - `state` - Article state (live or draft)
-   * - `defaultLocale` - Default locale for content
-   * - `locale` - Current locale
-   * - `availableLocales` - Array of available locales
-   * - `publishedLocales` - Array of locales where article is published
-   * - `featurebaseUrl` - Featurebase URL for the article
-   * - `externalUrl` - External URL if custom domain is configured
-   * - `author` - Author information (name, authorId, avatarUrl)
-   * - `order` - Display order
-   * - `isPublished` - Whether the article is published
-   * - `isDraftDiffersFromLive` - Whether draft differs from live version
-   * - `translations` - Translations for different locales
-   * - `createdAt` - ISO 8601 timestamp when created
-   * - `updatedAt` - ISO 8601 timestamp when last updated
-   * - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const article of client.helpCenter.articles.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: ArticleListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ArticlesCursorPage, Article> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/help_center/articles', CursorPage<Article>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Deletes an existing article.
    *
@@ -683,7 +684,7 @@ export interface Article {
   /**
    * Article icon
    */
-  icon?: Article.Icon | null;
+  icon?: ArticleIcon | null;
 
   /**
    * Whether draft differs from live
@@ -800,21 +801,6 @@ export interface Article {
 }
 
 export namespace Article {
-  /**
-   * Article icon
-   */
-  export interface Icon {
-    /**
-     * Icon type
-     */
-    type: 'emoji' | 'custom';
-
-    /**
-     * Icon value (emoji or URL)
-     */
-    value: string;
-  }
-
   /**
    * Translations by locale code
    */
@@ -925,6 +911,21 @@ export interface ArticleAuthor {
   avatarUrl?: string | null;
 }
 
+/**
+ * Article icon
+ */
+export interface ArticleIcon {
+  /**
+   * Icon type
+   */
+  type: 'emoji' | 'custom';
+
+  /**
+   * Icon value (emoji or URL)
+   */
+  value: string;
+}
+
 /**
  * Icon object for the article
  */
@@ -1260,7 +1261,7 @@ export namespace ArticleSearchResponse {
     /**
      * Article icon
      */
-    icon?: Data.Icon | null;
+    icon?: ArticlesAPI.ArticleIcon | null;
 
     /**
      * Whether draft differs from live
@@ -1377,21 +1378,6 @@ export namespace ArticleSearchResponse {
   }
 
   export namespace Data {
-    /**
-     * Article icon
-     */
-    export interface Icon {
-      /**
-       * Icon type
-       */
-      type: 'emoji' | 'custom';
-
-      /**
-       * Icon value (emoji or URL)
-       */
-      value: string;
-    }
-
     /**
      * Translations by locale code
      */
@@ -1483,6 +1469,31 @@ export namespace ArticleSearchResponse {
   }
 }
 
+export interface ArticleListParams extends CursorPageParams {
+  /**
+   * Query param: Filter articles by help center ID. If omitted, returns articles
+   * across all help centers.
+   */
+  helpCenterId?: string;
+
+  /**
+   * Query param: Filter articles by parent collection ID
+   */
+  parentId?: string;
+
+  /**
+   * Query param: Filter articles by state. Use "all" to get both draft and live
+   * articles.
+   */
+  state?: 'live' | 'draft' | 'all';
+
+  /**
+   * 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 ArticleCreateParams {
   /**
    * Body param: The title of the article
@@ -1796,31 +1807,6 @@ export namespace ArticleUpdateParams {
   }
 }
 
-export interface ArticleListParams extends CursorPageParams {
-  /**
-   * Query param: Filter articles by help center ID. If omitted, returns articles
-   * across all help centers.
-   */
-  helpCenterId?: string;
-
-  /**
-   * Query param: Filter articles by parent collection ID
-   */
-  parentId?: string;
-
-  /**
-   * Query param: Filter articles by state. Use "all" to get both draft and live
-   * articles.
-   */
-  state?: 'live' | 'draft' | 'all';
-
-  /**
-   * 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 ArticleDeleteParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -1847,7 +1833,7 @@ export interface ArticleSearchParams {
    * Body param: Structured filter AST. Either a single filter clause or one
    * top-level AND group (max 15 clauses). Top-level OR groups are not yet supported.
    */
-  query?: ArticleSearchParams.SearchFilter | ArticleSearchParams.SearchFilterGroup;
+  query?: PostsAPI.SearchFilter | PostsAPI.SearchFilterGroup;
 
   /**
    * Body param: Plain-text full-text search across article title, description, and
@@ -1872,70 +1858,21 @@ export interface ArticleSearchParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export namespace ArticleSearchParams {
-  export interface SearchFilter {
-    /**
-     * Field name to filter on (e.g. `state`, `tag_ids`, `created_at`)
-     */
-    field: string;
-
-    /**
-     * Comparison operator
-     */
-    operator: '=' | '!=' | 'IN' | 'NIN' | '>' | '<' | '>=' | '<=' | '~' | '!~' | '^' | '$';
-
-    /**
-     * Value to compare against (primitive or array of primitives)
-     */
-    value: string | number | boolean | Array<string | number> | null;
-  }
-
-  export interface SearchFilterGroup {
-    /**
-     * Group operator: AND (all match) or OR (any match)
-     */
-    operator: 'AND' | 'OR';
-
-    /**
-     * Array of filter clauses (1-15 entries)
-     */
-    value: Array<SearchFilterGroup.Value>;
-  }
-
-  export namespace SearchFilterGroup {
-    export interface Value {
-      /**
-       * Field name to filter on (e.g. `state`, `tag_ids`, `created_at`)
-       */
-      field: string;
-
-      /**
-       * Comparison operator
-       */
-      operator: '=' | '!=' | 'IN' | 'NIN' | '>' | '<' | '>=' | '<=' | '~' | '!~' | '^' | '$';
-
-      /**
-       * Value to compare against (primitive or array of primitives)
-       */
-      value: string | number | boolean | Array<string | number> | null;
-    }
-  }
-}
-
 export declare namespace Articles {
   export {
     type Article as Article,
     type ArticleAuthor as ArticleAuthor,
+    type ArticleIcon as ArticleIcon,
     type ArticleIconInputNova as ArticleIconInputNova,
     type ArticleTranslation as ArticleTranslation,
     type ArticleTranslationInputNova as ArticleTranslationInputNova,
     type ArticleDeleteResponse as ArticleDeleteResponse,
     type ArticleSearchResponse as ArticleSearchResponse,
     type ArticlesCursorPage as ArticlesCursorPage,
+    type ArticleListParams as ArticleListParams,
     type ArticleCreateParams as ArticleCreateParams,
     type ArticleRetrieveParams as ArticleRetrieveParams,
     type ArticleUpdateParams as ArticleUpdateParams,
-    type ArticleListParams as ArticleListParams,
     type ArticleDeleteParams as ArticleDeleteParams,
     type ArticleSearchParams as ArticleSearchParams,
   };

package/src/resources/help-center/collections.ts

@@ -12,6 +12,75 @@ import { path } from '../../internal/utils/path';
  * Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
  */
 export class Collections extends APIResource {
+  /**
+   * Returns a paginated list of collections within your organization's help center.
+   *
+   * Collections are used to organize articles into logical groups.
+   *
+   * ### Query Parameters
+   *
+   * - `limit` - Number of items to return (1-100, default 10)
+   * - `cursor` - Cursor for pagination
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of collection objects
+   * - `nextCursor` - Cursor for next page (null if no more results)
+   *
+   * ### Collection Object
+   *
+   * Each collection includes:
+   *
+   * - `id` - Unique identifier
+   * - `name` - Collection name
+   * - `description` - Collection description
+   * - `slug` - URL slug
+   * - `icon` - Collection icon (emoji or custom)
+   * - `parentId` - Parent collection ID (null for root collections)
+   * - `helpCenterId` - ID of the help center this collection belongs to
+   * - `organization` - Organization ID
+   * - `defaultLocale` - Default locale for content
+   * - `locale` - Current locale
+   * - `availableLocales` - Array of available locales
+   * - `featurebaseUrl` - Featurebase URL for the collection
+   * - `externalUrl` - External URL if custom domain is configured
+   * - `articleCount` - Number of articles in this collection
+   * - `authorCount` - Number of authors who contributed
+   * - `order` - Display order
+   * - `translations` - Translations for different locales
+   * - `createdAt` - ISO 8601 timestamp when created
+   * - `updatedAt` - ISO 8601 timestamp when last updated
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const collection of client.helpCenter.collections.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: CollectionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CollectionsCursorPage, Collection> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/help_center/collections', CursorPage<Collection>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Creates a new collection in your organization's help center.
    *
@@ -201,75 +270,6 @@ export class Collections extends APIResource {
     });
   }
 
-  /**
-   * Returns a paginated list of collections within your organization's help center.
-   *
-   * Collections are used to organize articles into logical groups.
-   *
-   * ### Query Parameters
-   *
-   * - `limit` - Number of items to return (1-100, default 10)
-   * - `cursor` - Cursor for pagination
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
-   *
-   * - `object` - Always "list"
-   * - `data` - Array of collection objects
-   * - `nextCursor` - Cursor for next page (null if no more results)
-   *
-   * ### Collection Object
-   *
-   * Each collection includes:
-   *
-   * - `id` - Unique identifier
-   * - `name` - Collection name
-   * - `description` - Collection description
-   * - `slug` - URL slug
-   * - `icon` - Collection icon (emoji or custom)
-   * - `parentId` - Parent collection ID (null for root collections)
-   * - `helpCenterId` - ID of the help center this collection belongs to
-   * - `organization` - Organization ID
-   * - `defaultLocale` - Default locale for content
-   * - `locale` - Current locale
-   * - `availableLocales` - Array of available locales
-   * - `featurebaseUrl` - Featurebase URL for the collection
-   * - `externalUrl` - External URL if custom domain is configured
-   * - `articleCount` - Number of articles in this collection
-   * - `authorCount` - Number of authors who contributed
-   * - `order` - Display order
-   * - `translations` - Translations for different locales
-   * - `createdAt` - ISO 8601 timestamp when created
-   * - `updatedAt` - ISO 8601 timestamp when last updated
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const collection of client.helpCenter.collections.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: CollectionListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<CollectionsCursorPage, Collection> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/help_center/collections', CursorPage<Collection>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Deletes an existing collection.
    *
@@ -767,6 +767,20 @@ export interface CollectionDeleteResponse {
   object: 'collection';
 }
 
+export interface CollectionListParams extends CursorPageParams {
+  /**
+   * Query param: Filter collections by help center ID. If omitted, returns
+   * collections across all help centers.
+   */
+  helpCenterId?: 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 CollectionCreateParams {
   /**
    * Body param: The name of the collection
@@ -1023,20 +1037,6 @@ export namespace CollectionUpdateParams {
   }
 }
 
-export interface CollectionListParams extends CursorPageParams {
-  /**
-   * Query param: Filter collections by help center ID. If omitted, returns
-   * collections across all help centers.
-   */
-  helpCenterId?: 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 CollectionDeleteParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -1053,10 +1053,10 @@ export declare namespace Collections {
     type CollectionTranslationInputNova as CollectionTranslationInputNova,
     type CollectionDeleteResponse as CollectionDeleteResponse,
     type CollectionsCursorPage as CollectionsCursorPage,
+    type CollectionListParams as CollectionListParams,
     type CollectionCreateParams as CollectionCreateParams,
     type CollectionRetrieveParams as CollectionRetrieveParams,
     type CollectionUpdateParams as CollectionUpdateParams,
-    type CollectionListParams as CollectionListParams,
     type CollectionDeleteParams as CollectionDeleteParams,
   };
 }

package/src/resources/help-center/help-center.ts

@@ -8,6 +8,7 @@ import {
   ArticleCreateParams,
   ArticleDeleteParams,
   ArticleDeleteResponse,
+  ArticleIcon,
   ArticleIconInputNova,
   ArticleListParams,
   ArticleRetrieveParams,
@@ -77,8 +78,8 @@ export declare namespace HelpCenter {
     type HelpCenterNavItem as HelpCenterNavItem,
     type HelpCenterTranslation as HelpCenterTranslation,
     type HelpCentersCursorPage as HelpCentersCursorPage,
-    type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
     type HelpCenterListParams as HelpCenterListParams,
+    type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
   };
 
   export {
@@ -89,10 +90,10 @@ export declare namespace HelpCenter {
     type CollectionTranslationInputNova as CollectionTranslationInputNova,
     type CollectionDeleteResponse as CollectionDeleteResponse,
     type CollectionsCursorPage as CollectionsCursorPage,
+    type CollectionListParams as CollectionListParams,
     type CollectionCreateParams as CollectionCreateParams,
     type CollectionRetrieveParams as CollectionRetrieveParams,
     type CollectionUpdateParams as CollectionUpdateParams,
-    type CollectionListParams as CollectionListParams,
     type CollectionDeleteParams as CollectionDeleteParams,
   };
 
@@ -100,16 +101,17 @@ export declare namespace HelpCenter {
     Articles as Articles,
     type Article as Article,
     type ArticleAuthor as ArticleAuthor,
+    type ArticleIcon as ArticleIcon,
     type ArticleIconInputNova as ArticleIconInputNova,
     type ArticleTranslation as ArticleTranslation,
     type ArticleTranslationInputNova as ArticleTranslationInputNova,
     type ArticleDeleteResponse as ArticleDeleteResponse,
     type ArticleSearchResponse as ArticleSearchResponse,
     type ArticlesCursorPage as ArticlesCursorPage,
+    type ArticleListParams as ArticleListParams,
     type ArticleCreateParams as ArticleCreateParams,
     type ArticleRetrieveParams as ArticleRetrieveParams,
     type ArticleUpdateParams as ArticleUpdateParams,
-    type ArticleListParams as ArticleListParams,
     type ArticleDeleteParams as ArticleDeleteParams,
     type ArticleSearchParams as ArticleSearchParams,
   };
@@ -119,11 +121,11 @@ export declare namespace HelpCenter {
     type RedirectRule as RedirectRule,
     type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse,
     type RedirectRulesCursorPage as RedirectRulesCursorPage,
+    type RedirectRuleListParams as RedirectRuleListParams,
     type RedirectRuleCreateParams as RedirectRuleCreateParams,
+    type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams,
     type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams,
     type RedirectRuleUpdateParams as RedirectRuleUpdateParams,
-    type RedirectRuleListParams as RedirectRuleListParams,
     type RedirectRuleDeleteParams as RedirectRuleDeleteParams,
-    type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams,
   };
 }