featurebase-node 0.13.0 → 0.14.1

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

@@ -13,47 +13,55 @@ import { path } from '../../internal/utils/path';
  */
 export class HelpCenters extends APIResource {
   /**
-   * Retrieves a single help center by its unique identifier.
+   * Returns all help centers configured in your Featurebase organization.
    *
-   * Returns the help center object if found in your organization.
+   * Currently, Featurebase only supports one help center per organization, but we
+   * plan on supporting multiple help centers in the future.
    *
-   * ### Response
+   * ### Query Parameters
    *
-   * Returns a help center object with:
+   * - `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 help center objects
+   * - `nextCursor` - Cursor for next page (null if no more results)
+   *
+   * ### Help Center Object
+   *
+   * Each help center includes:
    *
    * - `id` - Unique identifier
    * - `displayName` - Help center display name
    * - `title` - Help center title
    * - `description` - Help center description
-   * - `searchPlaceholder` - Search input placeholder text
    * - `isPublic` - Whether the help center is publicly accessible
    * - `defaultLocale` - Default locale for content
-   * - `locale` - Current locale
    * - `availableLocales` - Array of available locales
    * - `navItems` - Navigation items configuration
    * - `urls` - URL configuration (subpath, custom domain)
    * - `createdAt` - ISO 8601 timestamp when created
    * - `updatedAt` - ISO 8601 timestamp when last updated
    *
-   * ### Errors
-   *
-   * - `404` - Help center not found in your organization
-   *
    * @example
    * ```ts
-   * const helpCenter =
-   *   await client.helpCenter.helpCenters.retrieve(
-   *     '2tgy0ig982j54qfl',
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const helpCenter of client.helpCenter.helpCenters.list()) {
+   *   // ...
+   * }
    * ```
    */
-  retrieve(
-    id: string,
-    params: HelpCenterRetrieveParams | null | undefined = {},
+  list(
+    params: HelpCenterListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<HelpCenter> {
-    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
-    return this._client.get(path`/v2/help_center/help_centers/${id}`, {
+  ): PagePromise<HelpCentersCursorPage, HelpCenter> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/help_center/help_centers', CursorPage<HelpCenter>, {
+      query,
       ...options,
       headers: buildHeaders([
         {
@@ -67,55 +75,47 @@ export class HelpCenters extends APIResource {
   }
 
   /**
-   * Returns all help centers configured in your Featurebase organization.
-   *
-   * Currently, Featurebase only supports one help center per organization, but we
-   * plan on supporting multiple help centers in the future.
-   *
-   * ### Query Parameters
-   *
-   * - `limit` - Number of items to return (1-100, default 10)
-   * - `cursor` - Cursor for pagination
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
+   * Retrieves a single help center by its unique identifier.
    *
-   * - `object` - Always "list"
-   * - `data` - Array of help center objects
-   * - `nextCursor` - Cursor for next page (null if no more results)
+   * Returns the help center object if found in your organization.
    *
-   * ### Help Center Object
+   * ### Response
    *
-   * Each help center includes:
+   * Returns a help center object with:
    *
    * - `id` - Unique identifier
    * - `displayName` - Help center display name
    * - `title` - Help center title
    * - `description` - Help center description
+   * - `searchPlaceholder` - Search input placeholder text
    * - `isPublic` - Whether the help center is publicly accessible
    * - `defaultLocale` - Default locale for content
+   * - `locale` - Current locale
    * - `availableLocales` - Array of available locales
    * - `navItems` - Navigation items configuration
    * - `urls` - URL configuration (subpath, custom domain)
    * - `createdAt` - ISO 8601 timestamp when created
    * - `updatedAt` - ISO 8601 timestamp when last updated
    *
+   * ### Errors
+   *
+   * - `404` - Help center not found in your organization
+   *
    * @example
    * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const helpCenter of client.helpCenter.helpCenters.list()) {
-   *   // ...
-   * }
+   * const helpCenter =
+   *   await client.helpCenter.helpCenters.retrieve(
+   *     '2tgy0ig982j54qfl',
+   *   );
    * ```
    */
-  list(
-    params: HelpCenterListParams | null | undefined = {},
+  retrieve(
+    id: string,
+    params: HelpCenterRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<HelpCentersCursorPage, HelpCenter> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/help_center/help_centers', CursorPage<HelpCenter>, {
-      query,
+  ): APIPromise<HelpCenter> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/help_center/help_centers/${id}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -515,18 +515,18 @@ export interface HelpCenterTranslation {
   title?: string;
 }
 
-export interface HelpCenterRetrieveParams {
+export interface HelpCenterListParams 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 HelpCenterListParams extends CursorPageParams {
+export interface HelpCenterRetrieveParams {
   /**
-   * 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';
 }
@@ -537,7 +537,7 @@ export declare namespace HelpCenters {
     type HelpCenterNavItem as HelpCenterNavItem,
     type HelpCenterTranslation as HelpCenterTranslation,
     type HelpCentersCursorPage as HelpCentersCursorPage,
-    type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
     type HelpCenterListParams as HelpCenterListParams,
+    type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
   };
 }

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

@@ -4,15 +4,16 @@ export {
   Articles,
   type Article,
   type ArticleAuthor,
+  type ArticleIcon,
   type ArticleIconInputNova,
   type ArticleTranslation,
   type ArticleTranslationInputNova,
   type ArticleDeleteResponse,
   type ArticleSearchResponse,
+  type ArticleListParams,
   type ArticleCreateParams,
   type ArticleRetrieveParams,
   type ArticleUpdateParams,
-  type ArticleListParams,
   type ArticleDeleteParams,
   type ArticleSearchParams,
   type ArticlesCursorPage,
@@ -24,10 +25,10 @@ export {
   type CollectionTranslation,
   type CollectionTranslationInputNova,
   type CollectionDeleteResponse,
+  type CollectionListParams,
   type CollectionCreateParams,
   type CollectionRetrieveParams,
   type CollectionUpdateParams,
-  type CollectionListParams,
   type CollectionDeleteParams,
   type CollectionsCursorPage,
 } from './collections';
@@ -36,19 +37,19 @@ export {
   HelpCenters,
   type HelpCenterNavItem,
   type HelpCenterTranslation,
-  type HelpCenterRetrieveParams,
   type HelpCenterListParams,
+  type HelpCenterRetrieveParams,
   type HelpCentersCursorPage,
 } from './help-centers';
 export {
   RedirectRules,
   type RedirectRule,
   type RedirectRuleDeleteResponse,
+  type RedirectRuleListParams,
   type RedirectRuleCreateParams,
+  type RedirectRuleRetrieveByURLParams,
   type RedirectRuleRetrieveParams,
   type RedirectRuleUpdateParams,
-  type RedirectRuleListParams,
   type RedirectRuleDeleteParams,
-  type RedirectRuleRetrieveByURLParams,
   type RedirectRulesCursorPage,
 } from './redirect-rules';

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

@@ -11,6 +11,69 @@ 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 RedirectRules extends APIResource {
+  /**
+   * Returns a paginated list of redirect rules within your organization.
+   *
+   * Redirect rules map old Help Center URLs to new article or collection
+   * destinations, enabling seamless migration from legacy help center systems. Only
+   * Help Centers with a custom domain configured support redirect rules.
+   *
+   * ### Query Parameters
+   *
+   * - `limit` - Number of items to return (1-100, default 10)
+   * - `cursor` - Cursor for pagination
+   * - `helpCenterId` - Filter by help center ID
+   * - `locale` - Filter by locale code
+   * - `targetType` - Filter by target type ("article" or "collection")
+   *
+   * ### Response Format
+   *
+   * Returns a list object with:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of redirect rule objects
+   * - `nextCursor` - Cursor for next page (null if no more results)
+   *
+   * ### Redirect Rule Object
+   *
+   * Each redirect rule includes:
+   *
+   * - `id` - Unique identifier (MongoDB ObjectId)
+   * - `helpCenterId` - Help center this rule belongs to
+   * - `locale` - Locale code used to resolve the target translation
+   * - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
+   * - `targetType` - "article" or "collection"
+   * - `targetId` - ID of the target article or collection
+   * - `createdAt` - ISO 8601 timestamp when created
+   * - `updatedAt` - ISO 8601 timestamp when last updated
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const redirectRule of client.helpCenter.redirectRules.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: RedirectRuleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RedirectRulesCursorPage, RedirectRule> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.getAPIList('/v2/help_center/redirect_rules', CursorPage<RedirectRule>, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Creates a new redirect rule in your organization.
    *
@@ -70,6 +133,60 @@ export class RedirectRules extends APIResource {
     });
   }
 
+  /**
+   * Retrieves a specific redirect rule by its source URL.
+   *
+   * The `url` query parameter is normalized before matching: query parameters and
+   * hash fragments are stripped, the hostname is lowercased, and trailing slashes
+   * are removed. This is the same normalization applied when creating a redirect
+   * rule.
+   *
+   * ### Query Parameters
+   *
+   * - `url` (required) - Full absolute URL to look up (http or https)
+   *
+   * ### Response
+   *
+   * Returns a redirect rule object with:
+   *
+   * - `id` - Unique identifier (MongoDB ObjectId)
+   * - `helpCenterId` - Help center this rule belongs to
+   * - `locale` - Locale code
+   * - `fromUrl` - Canonical source URL being redirected from
+   * - `targetType` - "article" or "collection"
+   * - `targetId` - ID of the target article or collection
+   * - `createdAt` - ISO 8601 timestamp when created
+   * - `updatedAt` - ISO 8601 timestamp when last updated
+   *
+   * ### Errors
+   *
+   * - `400` - Invalid URL format
+   * - `404` - No redirect rule exists for the given URL
+   *
+   * @example
+   * ```ts
+   * const redirectRule =
+   *   await client.helpCenter.redirectRules.retrieveByURL({
+   *     url: 'https://help.example.com/en/old/getting-started',
+   *   });
+   * ```
+   */
+  retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params;
+    return this._client.get('/v2/help_center/redirect_rules/by-url', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Retrieves a specific redirect rule by its unique identifier.
    *
@@ -173,69 +290,6 @@ export class RedirectRules extends APIResource {
     });
   }
 
-  /**
-   * Returns a paginated list of redirect rules within your organization.
-   *
-   * Redirect rules map old Help Center URLs to new article or collection
-   * destinations, enabling seamless migration from legacy help center systems. Only
-   * Help Centers with a custom domain configured support redirect rules.
-   *
-   * ### Query Parameters
-   *
-   * - `limit` - Number of items to return (1-100, default 10)
-   * - `cursor` - Cursor for pagination
-   * - `helpCenterId` - Filter by help center ID
-   * - `locale` - Filter by locale code
-   * - `targetType` - Filter by target type ("article" or "collection")
-   *
-   * ### Response Format
-   *
-   * Returns a list object with:
-   *
-   * - `object` - Always "list"
-   * - `data` - Array of redirect rule objects
-   * - `nextCursor` - Cursor for next page (null if no more results)
-   *
-   * ### Redirect Rule Object
-   *
-   * Each redirect rule includes:
-   *
-   * - `id` - Unique identifier (MongoDB ObjectId)
-   * - `helpCenterId` - Help center this rule belongs to
-   * - `locale` - Locale code used to resolve the target translation
-   * - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
-   * - `targetType` - "article" or "collection"
-   * - `targetId` - ID of the target article or collection
-   * - `createdAt` - ISO 8601 timestamp when created
-   * - `updatedAt` - ISO 8601 timestamp when last updated
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const redirectRule of client.helpCenter.redirectRules.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: RedirectRuleListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<RedirectRulesCursorPage, RedirectRule> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
-    return this._client.getAPIList('/v2/help_center/redirect_rules', CursorPage<RedirectRule>, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
-
   /**
    * Deletes an existing redirect rule. The associated Redis cache entry is also
    * invalidated.
@@ -282,60 +336,6 @@ export class RedirectRules extends APIResource {
       ]),
     });
   }
-
-  /**
-   * Retrieves a specific redirect rule by its source URL.
-   *
-   * The `url` query parameter is normalized before matching: query parameters and
-   * hash fragments are stripped, the hostname is lowercased, and trailing slashes
-   * are removed. This is the same normalization applied when creating a redirect
-   * rule.
-   *
-   * ### Query Parameters
-   *
-   * - `url` (required) - Full absolute URL to look up (http or https)
-   *
-   * ### Response
-   *
-   * Returns a redirect rule object with:
-   *
-   * - `id` - Unique identifier (MongoDB ObjectId)
-   * - `helpCenterId` - Help center this rule belongs to
-   * - `locale` - Locale code
-   * - `fromUrl` - Canonical source URL being redirected from
-   * - `targetType` - "article" or "collection"
-   * - `targetId` - ID of the target article or collection
-   * - `createdAt` - ISO 8601 timestamp when created
-   * - `updatedAt` - ISO 8601 timestamp when last updated
-   *
-   * ### Errors
-   *
-   * - `400` - Invalid URL format
-   * - `404` - No redirect rule exists for the given URL
-   *
-   * @example
-   * ```ts
-   * const redirectRule =
-   *   await client.helpCenter.redirectRules.retrieveByURL({
-   *     url: 'https://help.example.com/en/old/getting-started',
-   *   });
-   * ```
-   */
-  retrieveByURL(params: RedirectRuleRetrieveByURLParams, options?: RequestOptions): APIPromise<RedirectRule> {
-    const { 'Featurebase-Version': featurebaseVersion, ...query } = params;
-    return this._client.get('/v2/help_center/redirect_rules/by-url', {
-      query,
-      ...options,
-      headers: buildHeaders([
-        {
-          ...(featurebaseVersion?.toString() != null ?
-            { 'Featurebase-Version': featurebaseVersion?.toString() }
-          : undefined),
-        },
-        options?.headers,
-      ]),
-    });
-  }
 }
 
 export type RedirectRulesCursorPage = CursorPage<RedirectRule>;
@@ -446,24 +446,16 @@ export interface RedirectRuleDeleteResponse {
   object: 'redirect_rule';
 }
 
-export interface RedirectRuleCreateParams {
-  /**
-   * Body param: Full absolute URL to redirect from. Must use http or https protocol.
-   * Query parameters and hash fragments are stripped during normalization. The
-   * hostname must match the Help Center custom domain.
-   */
-  fromUrl: string;
-
+export interface RedirectRuleListParams extends CursorPageParams {
   /**
-   * Body param: Help center identifier this redirect rule belongs to
+   * Query param: Filter redirect rules by help center ID
    */
-  helpCenterId: string;
+  helpCenterId?: string;
 
   /**
-   * Body param: Locale code for the redirect rule. Used to resolve the target
-   * article/collection translation.
+   * Query param: Filter redirect rules by locale
    */
-  locale:
+  locale?:
     | 'bn'
     | 'bs'
     | 'pt-BR'
@@ -508,14 +500,9 @@ export interface RedirectRuleCreateParams {
     | 'vi';
 
   /**
-   * Body param: ID of the target article or collection
-   */
-  targetId: string;
-
-  /**
-   * Body param: Type of content the redirect points to
+   * Query param: Filter redirect rules by target type
    */
-  targetType: 'article' | 'collection';
+  targetType?: 'article' | 'collection';
 
   /**
    * Header param: API version for this request. Defaults to your organization's
@@ -524,31 +511,24 @@ export interface RedirectRuleCreateParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface RedirectRuleRetrieveParams {
-  /**
-   * 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 RedirectRuleUpdateParams {
+export interface RedirectRuleCreateParams {
   /**
    * Body param: Full absolute URL to redirect from. Must use http or https protocol.
    * Query parameters and hash fragments are stripped during normalization. The
    * hostname must match the Help Center custom domain.
    */
-  fromUrl?: string;
+  fromUrl: string;
 
   /**
-   * Body param: Help center identifier
+   * Body param: Help center identifier this redirect rule belongs to
    */
-  helpCenterId?: string;
+  helpCenterId: string;
 
   /**
-   * Body param: Locale code for the redirect rule
+   * Body param: Locale code for the redirect rule. Used to resolve the target
+   * article/collection translation.
    */
-  locale?:
+  locale:
     | 'bn'
     | 'bs'
     | 'pt-BR'
@@ -595,12 +575,12 @@ export interface RedirectRuleUpdateParams {
   /**
    * Body param: ID of the target article or collection
    */
-  targetId?: string;
+  targetId: string;
 
   /**
    * Body param: Type of content the redirect points to
    */
-  targetType?: 'article' | 'collection';
+  targetType: 'article' | 'collection';
 
   /**
    * Header param: API version for this request. Defaults to your organization's
@@ -609,14 +589,44 @@ export interface RedirectRuleUpdateParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface RedirectRuleListParams extends CursorPageParams {
+export interface RedirectRuleRetrieveByURLParams {
   /**
-   * Query param: Filter redirect rules by help center ID
+   * Query param: Full absolute URL to look up. The URL is normalized before
+   * matching: query parameters and hash fragments are stripped, the hostname is
+   * lowercased, and trailing slashes are removed.
+   */
+  url: 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 RedirectRuleRetrieveParams {
+  /**
+   * 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 RedirectRuleUpdateParams {
+  /**
+   * Body param: Full absolute URL to redirect from. Must use http or https protocol.
+   * Query parameters and hash fragments are stripped during normalization. The
+   * hostname must match the Help Center custom domain.
+   */
+  fromUrl?: string;
+
+  /**
+   * Body param: Help center identifier
    */
   helpCenterId?: string;
 
   /**
-   * Query param: Filter redirect rules by locale
+   * Body param: Locale code for the redirect rule
    */
   locale?:
     | 'bn'
@@ -663,7 +673,12 @@ export interface RedirectRuleListParams extends CursorPageParams {
     | 'vi';
 
   /**
-   * Query param: Filter redirect rules by target type
+   * Body param: ID of the target article or collection
+   */
+  targetId?: string;
+
+  /**
+   * Body param: Type of content the redirect points to
    */
   targetType?: 'article' | 'collection';
 
@@ -682,31 +697,16 @@ export interface RedirectRuleDeleteParams {
   'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
 }
 
-export interface RedirectRuleRetrieveByURLParams {
-  /**
-   * Query param: Full absolute URL to look up. The URL is normalized before
-   * matching: query parameters and hash fragments are stripped, the hostname is
-   * lowercased, and trailing slashes are removed.
-   */
-  url: 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 declare namespace RedirectRules {
   export {
     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,
   };
 }