featurebase-node 0.14.3 → 0.15.0

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

@@ -12,75 +12,6 @@ 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.
    *
@@ -270,6 +201,75 @@ 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.
    *
@@ -327,6 +327,35 @@ export interface Collection {
    * Available locales
    */
   availableLocales: Array<
+    | 'ar'
+    | 'am'
+    | 'fa'
+    | 'ht'
+    | 'lo'
+    | 'my'
+    | 'pa'
+    | 'ps'
+    | 'so'
+    | 'tl'
+    | 'ur'
+    | 'he'
+    | 'ta'
+    | 'te'
+    | 'mr'
+    | 'gu'
+    | 'kn'
+    | 'ml'
+    | 'ha'
+    | 'jv'
+    | 'yo'
+    | 'ig'
+    | 'uz'
+    | 'ne'
+    | 'sd'
+    | 'az'
+    | 'si'
+    | 'km'
+    | 'kk'
     | 'bn'
     | 'bs'
     | 'pt-BR'
@@ -385,6 +414,35 @@ export interface Collection {
    * Current locale
    */
   locale:
+    | 'ar'
+    | 'am'
+    | 'fa'
+    | 'ht'
+    | 'lo'
+    | 'my'
+    | 'pa'
+    | 'ps'
+    | 'so'
+    | 'tl'
+    | 'ur'
+    | 'he'
+    | 'ta'
+    | 'te'
+    | 'mr'
+    | 'gu'
+    | 'kn'
+    | 'ml'
+    | 'ha'
+    | 'jv'
+    | 'yo'
+    | 'ig'
+    | 'uz'
+    | 'ne'
+    | 'sd'
+    | 'az'
+    | 'si'
+    | 'km'
+    | 'kk'
     | 'bn'
     | 'bs'
     | 'pt-BR'
@@ -467,6 +525,35 @@ export interface Collection {
    * Default locale
    */
   defaultLocale?:
+    | 'ar'
+    | 'am'
+    | 'fa'
+    | 'ht'
+    | 'lo'
+    | 'my'
+    | 'pa'
+    | 'ps'
+    | 'so'
+    | 'tl'
+    | 'ur'
+    | 'he'
+    | 'ta'
+    | 'te'
+    | 'mr'
+    | 'gu'
+    | 'kn'
+    | 'ml'
+    | 'ha'
+    | 'jv'
+    | 'yo'
+    | 'ig'
+    | 'uz'
+    | 'ne'
+    | 'sd'
+    | 'az'
+    | 'si'
+    | 'km'
+    | 'kk'
     | 'bn'
     | 'bs'
     | 'pt-BR'
@@ -578,6 +665,12 @@ export namespace Collection {
   export interface Translations {
     id?: CollectionsAPI.CollectionTranslation;
 
+    am?: CollectionsAPI.CollectionTranslation;
+
+    ar?: CollectionsAPI.CollectionTranslation;
+
+    az?: CollectionsAPI.CollectionTranslation;
+
     bg?: CollectionsAPI.CollectionTranslation;
 
     bn?: CollectionsAPI.CollectionTranslation;
@@ -600,36 +693,70 @@ export namespace Collection {
 
     et?: CollectionsAPI.CollectionTranslation;
 
+    fa?: CollectionsAPI.CollectionTranslation;
+
     fi?: CollectionsAPI.CollectionTranslation;
 
     fr?: CollectionsAPI.CollectionTranslation;
 
+    gu?: CollectionsAPI.CollectionTranslation;
+
+    ha?: CollectionsAPI.CollectionTranslation;
+
+    he?: CollectionsAPI.CollectionTranslation;
+
     hi?: CollectionsAPI.CollectionTranslation;
 
     hr?: CollectionsAPI.CollectionTranslation;
 
+    ht?: CollectionsAPI.CollectionTranslation;
+
     hu?: CollectionsAPI.CollectionTranslation;
 
+    ig?: CollectionsAPI.CollectionTranslation;
+
     it?: CollectionsAPI.CollectionTranslation;
 
     ja?: CollectionsAPI.CollectionTranslation;
 
+    jv?: CollectionsAPI.CollectionTranslation;
+
+    kk?: CollectionsAPI.CollectionTranslation;
+
+    km?: CollectionsAPI.CollectionTranslation;
+
+    kn?: CollectionsAPI.CollectionTranslation;
+
     ko?: CollectionsAPI.CollectionTranslation;
 
+    lo?: CollectionsAPI.CollectionTranslation;
+
     lt?: CollectionsAPI.CollectionTranslation;
 
     lv?: CollectionsAPI.CollectionTranslation;
 
+    ml?: CollectionsAPI.CollectionTranslation;
+
     mn?: CollectionsAPI.CollectionTranslation;
 
+    mr?: CollectionsAPI.CollectionTranslation;
+
     ms?: CollectionsAPI.CollectionTranslation;
 
+    my?: CollectionsAPI.CollectionTranslation;
+
     nb?: CollectionsAPI.CollectionTranslation;
 
+    ne?: CollectionsAPI.CollectionTranslation;
+
     nl?: CollectionsAPI.CollectionTranslation;
 
+    pa?: CollectionsAPI.CollectionTranslation;
+
     pl?: CollectionsAPI.CollectionTranslation;
 
+    ps?: CollectionsAPI.CollectionTranslation;
+
     pt?: CollectionsAPI.CollectionTranslation;
 
     'pt-BR'?: CollectionsAPI.CollectionTranslation;
@@ -638,24 +765,42 @@ export namespace Collection {
 
     ru?: CollectionsAPI.CollectionTranslation;
 
+    sd?: CollectionsAPI.CollectionTranslation;
+
+    si?: CollectionsAPI.CollectionTranslation;
+
     sk?: CollectionsAPI.CollectionTranslation;
 
     sl?: CollectionsAPI.CollectionTranslation;
 
+    so?: CollectionsAPI.CollectionTranslation;
+
     sr?: CollectionsAPI.CollectionTranslation;
 
     sv?: CollectionsAPI.CollectionTranslation;
 
     sw?: CollectionsAPI.CollectionTranslation;
 
+    ta?: CollectionsAPI.CollectionTranslation;
+
+    te?: CollectionsAPI.CollectionTranslation;
+
     th?: CollectionsAPI.CollectionTranslation;
 
+    tl?: CollectionsAPI.CollectionTranslation;
+
     tr?: CollectionsAPI.CollectionTranslation;
 
     uk?: CollectionsAPI.CollectionTranslation;
 
+    ur?: CollectionsAPI.CollectionTranslation;
+
+    uz?: CollectionsAPI.CollectionTranslation;
+
     vi?: CollectionsAPI.CollectionTranslation;
 
+    yo?: CollectionsAPI.CollectionTranslation;
+
     'zh-CN'?: CollectionsAPI.CollectionTranslation;
 
     'zh-TW'?: CollectionsAPI.CollectionTranslation;
@@ -767,20 +912,6 @@ 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
@@ -811,7 +942,7 @@ export interface CollectionCreateParams {
    * 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';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export namespace CollectionCreateParams {
@@ -821,6 +952,12 @@ export namespace CollectionCreateParams {
   export interface Translations {
     id?: CollectionsAPI.CollectionTranslationInputNova;
 
+    am?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ar?: CollectionsAPI.CollectionTranslationInputNova;
+
+    az?: CollectionsAPI.CollectionTranslationInputNova;
+
     bg?: CollectionsAPI.CollectionTranslationInputNova;
 
     bn?: CollectionsAPI.CollectionTranslationInputNova;
@@ -843,36 +980,70 @@ export namespace CollectionCreateParams {
 
     et?: CollectionsAPI.CollectionTranslationInputNova;
 
+    fa?: CollectionsAPI.CollectionTranslationInputNova;
+
     fi?: CollectionsAPI.CollectionTranslationInputNova;
 
     fr?: CollectionsAPI.CollectionTranslationInputNova;
 
+    gu?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ha?: CollectionsAPI.CollectionTranslationInputNova;
+
+    he?: CollectionsAPI.CollectionTranslationInputNova;
+
     hi?: CollectionsAPI.CollectionTranslationInputNova;
 
     hr?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ht?: CollectionsAPI.CollectionTranslationInputNova;
+
     hu?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ig?: CollectionsAPI.CollectionTranslationInputNova;
+
     it?: CollectionsAPI.CollectionTranslationInputNova;
 
     ja?: CollectionsAPI.CollectionTranslationInputNova;
 
+    jv?: CollectionsAPI.CollectionTranslationInputNova;
+
+    kk?: CollectionsAPI.CollectionTranslationInputNova;
+
+    km?: CollectionsAPI.CollectionTranslationInputNova;
+
+    kn?: CollectionsAPI.CollectionTranslationInputNova;
+
     ko?: CollectionsAPI.CollectionTranslationInputNova;
 
+    lo?: CollectionsAPI.CollectionTranslationInputNova;
+
     lt?: CollectionsAPI.CollectionTranslationInputNova;
 
     lv?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ml?: CollectionsAPI.CollectionTranslationInputNova;
+
     mn?: CollectionsAPI.CollectionTranslationInputNova;
 
+    mr?: CollectionsAPI.CollectionTranslationInputNova;
+
     ms?: CollectionsAPI.CollectionTranslationInputNova;
 
+    my?: CollectionsAPI.CollectionTranslationInputNova;
+
     nb?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ne?: CollectionsAPI.CollectionTranslationInputNova;
+
     nl?: CollectionsAPI.CollectionTranslationInputNova;
 
+    pa?: CollectionsAPI.CollectionTranslationInputNova;
+
     pl?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ps?: CollectionsAPI.CollectionTranslationInputNova;
+
     pt?: CollectionsAPI.CollectionTranslationInputNova;
 
     'pt-BR'?: CollectionsAPI.CollectionTranslationInputNova;
@@ -881,24 +1052,42 @@ export namespace CollectionCreateParams {
 
     ru?: CollectionsAPI.CollectionTranslationInputNova;
 
+    sd?: CollectionsAPI.CollectionTranslationInputNova;
+
+    si?: CollectionsAPI.CollectionTranslationInputNova;
+
     sk?: CollectionsAPI.CollectionTranslationInputNova;
 
     sl?: CollectionsAPI.CollectionTranslationInputNova;
 
+    so?: CollectionsAPI.CollectionTranslationInputNova;
+
     sr?: CollectionsAPI.CollectionTranslationInputNova;
 
     sv?: CollectionsAPI.CollectionTranslationInputNova;
 
     sw?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ta?: CollectionsAPI.CollectionTranslationInputNova;
+
+    te?: CollectionsAPI.CollectionTranslationInputNova;
+
     th?: CollectionsAPI.CollectionTranslationInputNova;
 
+    tl?: CollectionsAPI.CollectionTranslationInputNova;
+
     tr?: CollectionsAPI.CollectionTranslationInputNova;
 
     uk?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ur?: CollectionsAPI.CollectionTranslationInputNova;
+
+    uz?: CollectionsAPI.CollectionTranslationInputNova;
+
     vi?: CollectionsAPI.CollectionTranslationInputNova;
 
+    yo?: CollectionsAPI.CollectionTranslationInputNova;
+
     'zh-CN'?: CollectionsAPI.CollectionTranslationInputNova;
 
     'zh-TW'?: CollectionsAPI.CollectionTranslationInputNova;
@@ -910,7 +1099,7 @@ export interface CollectionRetrieveParams {
    * 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';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export interface CollectionUpdateParams {
@@ -943,7 +1132,7 @@ export interface CollectionUpdateParams {
    * 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';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export namespace CollectionUpdateParams {
@@ -953,6 +1142,12 @@ export namespace CollectionUpdateParams {
   export interface Translations {
     id?: CollectionsAPI.CollectionTranslationInputNova;
 
+    am?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ar?: CollectionsAPI.CollectionTranslationInputNova;
+
+    az?: CollectionsAPI.CollectionTranslationInputNova;
+
     bg?: CollectionsAPI.CollectionTranslationInputNova;
 
     bn?: CollectionsAPI.CollectionTranslationInputNova;
@@ -975,36 +1170,70 @@ export namespace CollectionUpdateParams {
 
     et?: CollectionsAPI.CollectionTranslationInputNova;
 
+    fa?: CollectionsAPI.CollectionTranslationInputNova;
+
     fi?: CollectionsAPI.CollectionTranslationInputNova;
 
     fr?: CollectionsAPI.CollectionTranslationInputNova;
 
+    gu?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ha?: CollectionsAPI.CollectionTranslationInputNova;
+
+    he?: CollectionsAPI.CollectionTranslationInputNova;
+
     hi?: CollectionsAPI.CollectionTranslationInputNova;
 
     hr?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ht?: CollectionsAPI.CollectionTranslationInputNova;
+
     hu?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ig?: CollectionsAPI.CollectionTranslationInputNova;
+
     it?: CollectionsAPI.CollectionTranslationInputNova;
 
     ja?: CollectionsAPI.CollectionTranslationInputNova;
 
+    jv?: CollectionsAPI.CollectionTranslationInputNova;
+
+    kk?: CollectionsAPI.CollectionTranslationInputNova;
+
+    km?: CollectionsAPI.CollectionTranslationInputNova;
+
+    kn?: CollectionsAPI.CollectionTranslationInputNova;
+
     ko?: CollectionsAPI.CollectionTranslationInputNova;
 
+    lo?: CollectionsAPI.CollectionTranslationInputNova;
+
     lt?: CollectionsAPI.CollectionTranslationInputNova;
 
     lv?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ml?: CollectionsAPI.CollectionTranslationInputNova;
+
     mn?: CollectionsAPI.CollectionTranslationInputNova;
 
+    mr?: CollectionsAPI.CollectionTranslationInputNova;
+
     ms?: CollectionsAPI.CollectionTranslationInputNova;
 
+    my?: CollectionsAPI.CollectionTranslationInputNova;
+
     nb?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ne?: CollectionsAPI.CollectionTranslationInputNova;
+
     nl?: CollectionsAPI.CollectionTranslationInputNova;
 
+    pa?: CollectionsAPI.CollectionTranslationInputNova;
+
     pl?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ps?: CollectionsAPI.CollectionTranslationInputNova;
+
     pt?: CollectionsAPI.CollectionTranslationInputNova;
 
     'pt-BR'?: CollectionsAPI.CollectionTranslationInputNova;
@@ -1013,36 +1242,68 @@ export namespace CollectionUpdateParams {
 
     ru?: CollectionsAPI.CollectionTranslationInputNova;
 
+    sd?: CollectionsAPI.CollectionTranslationInputNova;
+
+    si?: CollectionsAPI.CollectionTranslationInputNova;
+
     sk?: CollectionsAPI.CollectionTranslationInputNova;
 
     sl?: CollectionsAPI.CollectionTranslationInputNova;
 
+    so?: CollectionsAPI.CollectionTranslationInputNova;
+
     sr?: CollectionsAPI.CollectionTranslationInputNova;
 
     sv?: CollectionsAPI.CollectionTranslationInputNova;
 
     sw?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ta?: CollectionsAPI.CollectionTranslationInputNova;
+
+    te?: CollectionsAPI.CollectionTranslationInputNova;
+
     th?: CollectionsAPI.CollectionTranslationInputNova;
 
+    tl?: CollectionsAPI.CollectionTranslationInputNova;
+
     tr?: CollectionsAPI.CollectionTranslationInputNova;
 
     uk?: CollectionsAPI.CollectionTranslationInputNova;
 
+    ur?: CollectionsAPI.CollectionTranslationInputNova;
+
+    uz?: CollectionsAPI.CollectionTranslationInputNova;
+
     vi?: CollectionsAPI.CollectionTranslationInputNova;
 
+    yo?: CollectionsAPI.CollectionTranslationInputNova;
+
     'zh-CN'?: CollectionsAPI.CollectionTranslationInputNova;
 
     'zh-TW'?: CollectionsAPI.CollectionTranslationInputNova;
   }
 }
 
+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-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+
 export interface CollectionDeleteParams {
   /**
    * 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';
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
 export declare namespace Collections {
@@ -1053,10 +1314,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,
   };
 }