featurebase-node 0.0.2

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

@@ -0,0 +1,1065 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CollectionsAPI from './collections';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+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 {
+  /**
+   * Creates a new collection in your organization's help center.
+   *
+   * ### Request Body
+   *
+   * Required attributes:
+   *
+   * - `name` - The name of the collection
+   *
+   * Optional attributes:
+   *
+   * - `description` - A description of the collection
+   * - `icon` - An icon object representing the collection icon (with type and value)
+   * - `parentId` - The ID of the parent collection, if any
+   * - `translations` - A dictionary of translations keyed by locale
+   *
+   * ### Response
+   *
+   * Returns the created collection object with:
+   *
+   * - `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
+   * const collection =
+   *   await client.helpCenter.collections.create({
+   *     name: 'English Collection',
+   *   });
+   * ```
+   */
+  create(params: CollectionCreateParams, options?: RequestOptions): APIPromise<Collection> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.post('/v2/help_center/collections', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Retrieves a specific collection by its unique identifier.
+   *
+   * Returns the collection object if found in your organization's help center.
+   *
+   * ### Response
+   *
+   * Returns a collection object with:
+   *
+   * - `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
+   *
+   * ### Errors
+   *
+   * - `404` - Collection not found in your organization's help center
+   *
+   * @example
+   * ```ts
+   * const collection =
+   *   await client.helpCenter.collections.retrieve('6474684');
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: CollectionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Collection> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/help_center/collections/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Updates an existing collection. Only include the fields you wish to update.
+   *
+   * ### Path Parameters
+   *
+   * - `id` - The unique identifier of the collection to update
+   *
+   * ### Request Body
+   *
+   * All fields are optional. Only provided fields will be updated:
+   *
+   * - `name` - The new name of the collection
+   * - `description` - The new description of the collection
+   * - `icon` - An updated icon object for the collection (with type and value)
+   * - `parentId` - The new parent collection ID, if applicable (null for root level)
+   * - `translations` - A dictionary of updated translations keyed by locale code
+   *
+   * ### Response
+   *
+   * Returns the updated collection object with:
+   *
+   * - `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
+   *
+   * ### Errors
+   *
+   * - `404` - Collection not found in your organization's help center
+   *
+   * @example
+   * ```ts
+   * const collection =
+   *   await client.helpCenter.collections.update('3416135');
+   * ```
+   */
+  update(id: string, params: CollectionUpdateParams, options?: RequestOptions): APIPromise<Collection> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.patch(path`/v2/help_center/collections/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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
+   * const collections =
+   *   await client.helpCenter.collections.list();
+   * ```
+   */
+  list(
+    params: CollectionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CollectionListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.get('/v2/help_center/collections', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Deletes an existing collection.
+   *
+   * ### Path Parameters
+   *
+   * - `id` - The unique identifier of the collection to delete
+   *
+   * ### Response
+   *
+   * Returns a deletion confirmation object:
+   *
+   * - `id` - The ID of the deleted collection
+   * - `object` - Always "collection"
+   * - `deleted` - Always true
+   *
+   * ### Errors
+   *
+   * - `404` - Collection not found in your organization's help center
+   *
+   * @example
+   * ```ts
+   * const collection =
+   *   await client.helpCenter.collections.delete('3416135');
+   * ```
+   */
+  delete(
+    id: string,
+    params: CollectionDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CollectionDeleteResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.delete(path`/v2/help_center/collections/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface Collection {
+  /**
+   * Collection unique identifier
+   */
+  id: string;
+
+  /**
+   * Available locales
+   */
+  availableLocales: Array<
+    | 'bn'
+    | 'bs'
+    | 'pt-BR'
+    | 'bg'
+    | 'ca'
+    | 'hr'
+    | 'cs'
+    | 'da'
+    | 'nl'
+    | 'en'
+    | 'et'
+    | 'fi'
+    | 'fr'
+    | 'de'
+    | 'el'
+    | 'hi'
+    | 'hu'
+    | 'id'
+    | 'it'
+    | 'ja'
+    | 'ko'
+    | 'lv'
+    | 'lt'
+    | 'ms'
+    | 'mn'
+    | 'nb'
+    | 'pl'
+    | 'pt'
+    | 'ro'
+    | 'ru'
+    | 'sr'
+    | 'zh-CN'
+    | 'sk'
+    | 'sl'
+    | 'es'
+    | 'sw'
+    | 'sv'
+    | 'th'
+    | 'zh-TW'
+    | 'tr'
+    | 'uk'
+    | 'vi'
+  >;
+
+  /**
+   * ISO 8601 timestamp when created
+   */
+  createdAt: string;
+
+  /**
+   * Help center ID
+   */
+  helpCenterId: string;
+
+  /**
+   * Current locale
+   */
+  locale:
+    | 'bn'
+    | 'bs'
+    | 'pt-BR'
+    | 'bg'
+    | 'ca'
+    | 'hr'
+    | 'cs'
+    | 'da'
+    | 'nl'
+    | 'en'
+    | 'et'
+    | 'fi'
+    | 'fr'
+    | 'de'
+    | 'el'
+    | 'hi'
+    | 'hu'
+    | 'id'
+    | 'it'
+    | 'ja'
+    | 'ko'
+    | 'lv'
+    | 'lt'
+    | 'ms'
+    | 'mn'
+    | 'nb'
+    | 'pl'
+    | 'pt'
+    | 'ro'
+    | 'ru'
+    | 'sr'
+    | 'zh-CN'
+    | 'sk'
+    | 'sl'
+    | 'es'
+    | 'sw'
+    | 'sv'
+    | 'th'
+    | 'zh-TW'
+    | 'tr'
+    | 'uk'
+    | 'vi';
+
+  /**
+   * Object type identifier
+   */
+  object: 'collection';
+
+  /**
+   * Organization ID
+   */
+  organization: string;
+
+  /**
+   * Parent collection ID
+   */
+  parentId: string | null;
+
+  /**
+   * ISO 8601 timestamp when last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Number of articles
+   */
+  articleCount?: number;
+
+  /**
+   * Number of authors
+   */
+  authorCount?: number;
+
+  /**
+   * Whether to collapse sidebar
+   */
+  collapseSidebar?: boolean;
+
+  /**
+   * Default locale
+   */
+  defaultLocale?:
+    | 'bn'
+    | 'bs'
+    | 'pt-BR'
+    | 'bg'
+    | 'ca'
+    | 'hr'
+    | 'cs'
+    | 'da'
+    | 'nl'
+    | 'en'
+    | 'et'
+    | 'fi'
+    | 'fr'
+    | 'de'
+    | 'el'
+    | 'hi'
+    | 'hu'
+    | 'id'
+    | 'it'
+    | 'ja'
+    | 'ko'
+    | 'lv'
+    | 'lt'
+    | 'ms'
+    | 'mn'
+    | 'nb'
+    | 'pl'
+    | 'pt'
+    | 'ro'
+    | 'ru'
+    | 'sr'
+    | 'zh-CN'
+    | 'sk'
+    | 'sl'
+    | 'es'
+    | 'sw'
+    | 'sv'
+    | 'th'
+    | 'zh-TW'
+    | 'tr'
+    | 'uk'
+    | 'vi';
+
+  /**
+   * Collection description
+   */
+  description?: string;
+
+  /**
+   * External URL
+   */
+  externalUrl?: string;
+
+  /**
+   * Featurebase URL
+   */
+  featurebaseUrl?: string;
+
+  /**
+   * Collection icon
+   */
+  icon?: Collection.Icon | null;
+
+  /**
+   * Collection name
+   */
+  name?: string;
+
+  /**
+   * Display order
+   */
+  order?: number | null;
+
+  /**
+   * Collection path
+   */
+  path?: string;
+
+  /**
+   * URL slug
+   */
+  slug?: string;
+
+  /**
+   * Translations by locale code
+   */
+  translations?: Collection.Translations;
+}
+
+export namespace Collection {
+  /**
+   * Collection icon
+   */
+  export interface Icon {
+    /**
+     * Icon type
+     */
+    type: string;
+
+    /**
+     * Icon value
+     */
+    value: string;
+  }
+
+  /**
+   * Translations by locale code
+   */
+  export interface Translations {
+    id?: CollectionsAPI.CollectionTranslation;
+
+    bg?: CollectionsAPI.CollectionTranslation;
+
+    bn?: CollectionsAPI.CollectionTranslation;
+
+    bs?: CollectionsAPI.CollectionTranslation;
+
+    ca?: CollectionsAPI.CollectionTranslation;
+
+    cs?: CollectionsAPI.CollectionTranslation;
+
+    da?: CollectionsAPI.CollectionTranslation;
+
+    de?: CollectionsAPI.CollectionTranslation;
+
+    el?: CollectionsAPI.CollectionTranslation;
+
+    en?: CollectionsAPI.CollectionTranslation;
+
+    es?: CollectionsAPI.CollectionTranslation;
+
+    et?: CollectionsAPI.CollectionTranslation;
+
+    fi?: CollectionsAPI.CollectionTranslation;
+
+    fr?: CollectionsAPI.CollectionTranslation;
+
+    hi?: CollectionsAPI.CollectionTranslation;
+
+    hr?: CollectionsAPI.CollectionTranslation;
+
+    hu?: CollectionsAPI.CollectionTranslation;
+
+    it?: CollectionsAPI.CollectionTranslation;
+
+    ja?: CollectionsAPI.CollectionTranslation;
+
+    ko?: CollectionsAPI.CollectionTranslation;
+
+    lt?: CollectionsAPI.CollectionTranslation;
+
+    lv?: CollectionsAPI.CollectionTranslation;
+
+    mn?: CollectionsAPI.CollectionTranslation;
+
+    ms?: CollectionsAPI.CollectionTranslation;
+
+    nb?: CollectionsAPI.CollectionTranslation;
+
+    nl?: CollectionsAPI.CollectionTranslation;
+
+    pl?: CollectionsAPI.CollectionTranslation;
+
+    pt?: CollectionsAPI.CollectionTranslation;
+
+    'pt-BR'?: CollectionsAPI.CollectionTranslation;
+
+    ro?: CollectionsAPI.CollectionTranslation;
+
+    ru?: CollectionsAPI.CollectionTranslation;
+
+    sk?: CollectionsAPI.CollectionTranslation;
+
+    sl?: CollectionsAPI.CollectionTranslation;
+
+    sr?: CollectionsAPI.CollectionTranslation;
+
+    sv?: CollectionsAPI.CollectionTranslation;
+
+    sw?: CollectionsAPI.CollectionTranslation;
+
+    th?: CollectionsAPI.CollectionTranslation;
+
+    tr?: CollectionsAPI.CollectionTranslation;
+
+    uk?: CollectionsAPI.CollectionTranslation;
+
+    vi?: CollectionsAPI.CollectionTranslation;
+
+    'zh-CN'?: CollectionsAPI.CollectionTranslation;
+
+    'zh-TW'?: CollectionsAPI.CollectionTranslation;
+  }
+}
+
+/**
+ * An updated icon object for the collection
+ */
+export interface CollectionIconNova {
+  /**
+   * Icon type (e.g., "emoji")
+   */
+  type: 'emoji' | 'predefined';
+
+  /**
+   * Icon value
+   */
+  value: string;
+}
+
+export interface CollectionTranslation {
+  /**
+   * Number of articles
+   */
+  articleCount?: number;
+
+  /**
+   * Number of authors
+   */
+  authorCount?: number;
+
+  /**
+   * List of authors
+   */
+  authors?: Array<CollectionTranslation.Author>;
+
+  /**
+   * Collection description
+   */
+  description?: string;
+
+  /**
+   * External URL
+   */
+  externalUrl?: string;
+
+  /**
+   * Featurebase URL
+   */
+  featurebaseUrl?: string;
+
+  /**
+   * Collection name
+   */
+  name?: string;
+
+  /**
+   * URL slug
+   */
+  slug?: string;
+}
+
+export namespace CollectionTranslation {
+  export interface Author {
+    /**
+     * Author ID
+     */
+    authorId?: string;
+
+    /**
+     * Author avatar URL
+     */
+    avatarUrl?: string | null;
+
+    /**
+     * Author name
+     */
+    name?: string;
+  }
+}
+
+export interface CollectionTranslationInputNova {
+  /**
+   * Collection description in this locale
+   */
+  description?: string;
+
+  /**
+   * Collection name in this locale
+   */
+  name?: string;
+}
+
+export interface CollectionListResponse {
+  /**
+   * Array of collections
+   */
+  data: Array<Collection>;
+
+  /**
+   * Cursor for fetching the next page (cursor-based pagination)
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+}
+
+export interface CollectionDeleteResponse {
+  /**
+   * Unique identifier of the deleted collection
+   */
+  id: string;
+
+  /**
+   * Indicates the resource was deleted
+   */
+  deleted: true;
+
+  /**
+   * Object type identifier
+   */
+  object: 'collection';
+}
+
+export interface CollectionCreateParams {
+  /**
+   * Body param: The name of the collection
+   */
+  name: string;
+
+  /**
+   * Body param: A description of the collection
+   */
+  description?: string;
+
+  /**
+   * Body param: An updated icon object for the collection
+   */
+  icon?: CollectionIconNova | null;
+
+  /**
+   * Body param: The ID of the parent collection, if any
+   */
+  parentId?: string | null;
+
+  /**
+   * Body param: A dictionary of translations keyed by locale
+   */
+  translations?: CollectionCreateParams.Translations;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export namespace CollectionCreateParams {
+  /**
+   * A dictionary of translations keyed by locale
+   */
+  export interface Translations {
+    id?: CollectionsAPI.CollectionTranslationInputNova;
+
+    bg?: CollectionsAPI.CollectionTranslationInputNova;
+
+    bn?: CollectionsAPI.CollectionTranslationInputNova;
+
+    bs?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ca?: CollectionsAPI.CollectionTranslationInputNova;
+
+    cs?: CollectionsAPI.CollectionTranslationInputNova;
+
+    da?: CollectionsAPI.CollectionTranslationInputNova;
+
+    de?: CollectionsAPI.CollectionTranslationInputNova;
+
+    el?: CollectionsAPI.CollectionTranslationInputNova;
+
+    en?: CollectionsAPI.CollectionTranslationInputNova;
+
+    es?: CollectionsAPI.CollectionTranslationInputNova;
+
+    et?: CollectionsAPI.CollectionTranslationInputNova;
+
+    fi?: CollectionsAPI.CollectionTranslationInputNova;
+
+    fr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    hi?: CollectionsAPI.CollectionTranslationInputNova;
+
+    hr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    hu?: CollectionsAPI.CollectionTranslationInputNova;
+
+    it?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ja?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ko?: CollectionsAPI.CollectionTranslationInputNova;
+
+    lt?: CollectionsAPI.CollectionTranslationInputNova;
+
+    lv?: CollectionsAPI.CollectionTranslationInputNova;
+
+    mn?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ms?: CollectionsAPI.CollectionTranslationInputNova;
+
+    nb?: CollectionsAPI.CollectionTranslationInputNova;
+
+    nl?: CollectionsAPI.CollectionTranslationInputNova;
+
+    pl?: CollectionsAPI.CollectionTranslationInputNova;
+
+    pt?: CollectionsAPI.CollectionTranslationInputNova;
+
+    'pt-BR'?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ro?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ru?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sk?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sl?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sv?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sw?: CollectionsAPI.CollectionTranslationInputNova;
+
+    th?: CollectionsAPI.CollectionTranslationInputNova;
+
+    tr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    uk?: CollectionsAPI.CollectionTranslationInputNova;
+
+    vi?: CollectionsAPI.CollectionTranslationInputNova;
+
+    'zh-CN'?: CollectionsAPI.CollectionTranslationInputNova;
+
+    'zh-TW'?: CollectionsAPI.CollectionTranslationInputNova;
+  }
+}
+
+export interface CollectionRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface CollectionUpdateParams {
+  /**
+   * Body param: The new description of the collection
+   */
+  description?: string;
+
+  /**
+   * Body param: An updated icon object for the collection
+   */
+  icon?: CollectionIconNova | null;
+
+  /**
+   * Body param: The new name of the collection
+   */
+  name?: string;
+
+  /**
+   * Body param: The new parent collection ID, if applicable
+   */
+  parentId?: string | null;
+
+  /**
+   * Body param: A dictionary of updated translations keyed by locale
+   */
+  translations?: CollectionUpdateParams.Translations;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export namespace CollectionUpdateParams {
+  /**
+   * A dictionary of updated translations keyed by locale
+   */
+  export interface Translations {
+    id?: CollectionsAPI.CollectionTranslationInputNova;
+
+    bg?: CollectionsAPI.CollectionTranslationInputNova;
+
+    bn?: CollectionsAPI.CollectionTranslationInputNova;
+
+    bs?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ca?: CollectionsAPI.CollectionTranslationInputNova;
+
+    cs?: CollectionsAPI.CollectionTranslationInputNova;
+
+    da?: CollectionsAPI.CollectionTranslationInputNova;
+
+    de?: CollectionsAPI.CollectionTranslationInputNova;
+
+    el?: CollectionsAPI.CollectionTranslationInputNova;
+
+    en?: CollectionsAPI.CollectionTranslationInputNova;
+
+    es?: CollectionsAPI.CollectionTranslationInputNova;
+
+    et?: CollectionsAPI.CollectionTranslationInputNova;
+
+    fi?: CollectionsAPI.CollectionTranslationInputNova;
+
+    fr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    hi?: CollectionsAPI.CollectionTranslationInputNova;
+
+    hr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    hu?: CollectionsAPI.CollectionTranslationInputNova;
+
+    it?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ja?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ko?: CollectionsAPI.CollectionTranslationInputNova;
+
+    lt?: CollectionsAPI.CollectionTranslationInputNova;
+
+    lv?: CollectionsAPI.CollectionTranslationInputNova;
+
+    mn?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ms?: CollectionsAPI.CollectionTranslationInputNova;
+
+    nb?: CollectionsAPI.CollectionTranslationInputNova;
+
+    nl?: CollectionsAPI.CollectionTranslationInputNova;
+
+    pl?: CollectionsAPI.CollectionTranslationInputNova;
+
+    pt?: CollectionsAPI.CollectionTranslationInputNova;
+
+    'pt-BR'?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ro?: CollectionsAPI.CollectionTranslationInputNova;
+
+    ru?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sk?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sl?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sv?: CollectionsAPI.CollectionTranslationInputNova;
+
+    sw?: CollectionsAPI.CollectionTranslationInputNova;
+
+    th?: CollectionsAPI.CollectionTranslationInputNova;
+
+    tr?: CollectionsAPI.CollectionTranslationInputNova;
+
+    uk?: CollectionsAPI.CollectionTranslationInputNova;
+
+    vi?: CollectionsAPI.CollectionTranslationInputNova;
+
+    'zh-CN'?: CollectionsAPI.CollectionTranslationInputNova;
+
+    'zh-TW'?: CollectionsAPI.CollectionTranslationInputNova;
+  }
+}
+
+export interface CollectionListParams {
+  /**
+   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+   * previous response to fetch the next page.
+   */
+  cursor?: string;
+
+  /**
+   * Query param: Filter collections by help center ID. If omitted, returns
+   * collections across all help centers.
+   */
+  helpCenterId?: string;
+
+  /**
+   * Query param: A limit on the number of objects to be returned, between 1 and 100.
+   */
+  limit?: number;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface CollectionDeleteParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export declare namespace Collections {
+  export {
+    type Collection as Collection,
+    type CollectionIconNova as CollectionIconNova,
+    type CollectionTranslation as CollectionTranslation,
+    type CollectionTranslationInputNova as CollectionTranslationInputNova,
+    type CollectionListResponse as CollectionListResponse,
+    type CollectionDeleteResponse as CollectionDeleteResponse,
+    type CollectionCreateParams as CollectionCreateParams,
+    type CollectionRetrieveParams as CollectionRetrieveParams,
+    type CollectionUpdateParams as CollectionUpdateParams,
+    type CollectionListParams as CollectionListParams,
+    type CollectionDeleteParams as CollectionDeleteParams,
+  };
+}