featurebase-node 0.0.2

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

@@ -0,0 +1,125 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ArticlesAPI from './articles';
+import {
+  Article,
+  ArticleAuthor,
+  ArticleCreateParams,
+  ArticleDeleteParams,
+  ArticleDeleteResponse,
+  ArticleIconInputNova,
+  ArticleListParams,
+  ArticleListResponse,
+  ArticleRetrieveParams,
+  ArticleTranslation,
+  ArticleTranslationInputNova,
+  ArticleUpdateParams,
+  Articles,
+} from './articles';
+import * as CollectionsAPI from './collections';
+import {
+  Collection,
+  CollectionCreateParams,
+  CollectionDeleteParams,
+  CollectionDeleteResponse,
+  CollectionIconNova,
+  CollectionListParams,
+  CollectionListResponse,
+  CollectionRetrieveParams,
+  CollectionTranslation,
+  CollectionTranslationInputNova,
+  CollectionUpdateParams,
+  Collections,
+} from './collections';
+import * as HelpCentersAPI from './help-centers';
+import {
+  HelpCenter as HelpCentersAPIHelpCenter,
+  HelpCenterListParams,
+  HelpCenterListResponse,
+  HelpCenterNavItem,
+  HelpCenterRetrieveParams,
+  HelpCenterTranslation,
+  HelpCenters,
+} from './help-centers';
+import * as RedirectRulesAPI from './redirect-rules';
+import {
+  RedirectRule,
+  RedirectRuleCreateParams,
+  RedirectRuleDeleteParams,
+  RedirectRuleDeleteResponse,
+  RedirectRuleListParams,
+  RedirectRuleListResponse,
+  RedirectRuleRetrieveByURLParams,
+  RedirectRuleRetrieveParams,
+  RedirectRuleUpdateParams,
+  RedirectRules,
+} from './redirect-rules';
+
+export class HelpCenter extends APIResource {
+  helpCenters: HelpCentersAPI.HelpCenters = new HelpCentersAPI.HelpCenters(this._client);
+  collections: CollectionsAPI.Collections = new CollectionsAPI.Collections(this._client);
+  articles: ArticlesAPI.Articles = new ArticlesAPI.Articles(this._client);
+  redirectRules: RedirectRulesAPI.RedirectRules = new RedirectRulesAPI.RedirectRules(this._client);
+}
+
+HelpCenter.HelpCenters = HelpCenters;
+HelpCenter.Collections = Collections;
+HelpCenter.Articles = Articles;
+HelpCenter.RedirectRules = RedirectRules;
+
+export declare namespace HelpCenter {
+  export {
+    HelpCenters as HelpCenters,
+    type HelpCentersAPIHelpCenter as HelpCenter,
+    type HelpCenterNavItem as HelpCenterNavItem,
+    type HelpCenterTranslation as HelpCenterTranslation,
+    type HelpCenterListResponse as HelpCenterListResponse,
+    type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
+    type HelpCenterListParams as HelpCenterListParams,
+  };
+
+  export {
+    Collections as Collections,
+    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,
+  };
+
+  export {
+    Articles as Articles,
+    type Article as Article,
+    type ArticleAuthor as ArticleAuthor,
+    type ArticleIconInputNova as ArticleIconInputNova,
+    type ArticleTranslation as ArticleTranslation,
+    type ArticleTranslationInputNova as ArticleTranslationInputNova,
+    type ArticleListResponse as ArticleListResponse,
+    type ArticleDeleteResponse as ArticleDeleteResponse,
+    type ArticleCreateParams as ArticleCreateParams,
+    type ArticleRetrieveParams as ArticleRetrieveParams,
+    type ArticleUpdateParams as ArticleUpdateParams,
+    type ArticleListParams as ArticleListParams,
+    type ArticleDeleteParams as ArticleDeleteParams,
+  };
+
+  export {
+    RedirectRules as RedirectRules,
+    type RedirectRule as RedirectRule,
+    type RedirectRuleListResponse as RedirectRuleListResponse,
+    type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse,
+    type RedirectRuleCreateParams as RedirectRuleCreateParams,
+    type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams,
+    type RedirectRuleUpdateParams as RedirectRuleUpdateParams,
+    type RedirectRuleListParams as RedirectRuleListParams,
+    type RedirectRuleDeleteParams as RedirectRuleDeleteParams,
+    type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams,
+  };
+}

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

@@ -0,0 +1,558 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as HelpCentersAPI from './help-centers';
+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 HelpCenters extends APIResource {
+  /**
+   * Retrieves a single help center by its unique identifier.
+   *
+   * Returns the help center object if found in your organization.
+   *
+   * ### Response
+   *
+   * 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
+   * const helpCenter =
+   *   await client.helpCenter.helpCenters.retrieve(
+   *     '2tgy0ig982j54qfl',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: HelpCenterRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<HelpCenter> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/help_center/help_centers/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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:
+   *
+   * - `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
+   * - `isPublic` - Whether the help center is publicly accessible
+   * - `defaultLocale` - Default locale for content
+   * - `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
+   *
+   * @example
+   * ```ts
+   * const helpCenters =
+   *   await client.helpCenter.helpCenters.list();
+   * ```
+   */
+  list(
+    params: HelpCenterListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<HelpCenterListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.get('/v2/help_center/help_centers', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface HelpCenter {
+  /**
+   * Help center 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;
+
+  /**
+   * Default locale for the help center
+   */
+  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';
+
+  /**
+   * Whether the help center is public
+   */
+  isPublic: boolean;
+
+  /**
+   * 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: 'help_center';
+
+  /**
+   * Organization ID
+   */
+  organization: string;
+
+  /**
+   * ISO 8601 timestamp when last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Help center description
+   */
+  description?: string;
+
+  /**
+   * Help center display name
+   */
+  displayName?: string;
+
+  /**
+   * Whether external links in articles open in a new tab
+   */
+  externalLinksOpenInNewTab?: boolean;
+
+  /**
+   * Whether to hide author info on articles
+   */
+  hideAuthorInfo?: boolean;
+
+  /**
+   * Whether to hide date info on articles
+   */
+  hideDateInfo?: boolean;
+
+  /**
+   * Whether internal links in articles open in a new tab
+   */
+  internalLinksOpenInNewTab?: boolean;
+
+  /**
+   * Navigation items
+   */
+  navItems?: Array<HelpCenterNavItem>;
+
+  /**
+   * Search input placeholder
+   */
+  searchPlaceholder?: string;
+
+  /**
+   * Help center title
+   */
+  title?: string;
+
+  /**
+   * Translations for different locales
+   */
+  translations?: HelpCenter.Translations;
+
+  /**
+   * URLs configuration
+   */
+  urls?: HelpCenter.URLs;
+}
+
+export namespace HelpCenter {
+  /**
+   * Translations for different locales
+   */
+  export interface Translations {
+    id?: HelpCentersAPI.HelpCenterTranslation;
+
+    bg?: HelpCentersAPI.HelpCenterTranslation;
+
+    bn?: HelpCentersAPI.HelpCenterTranslation;
+
+    bs?: HelpCentersAPI.HelpCenterTranslation;
+
+    ca?: HelpCentersAPI.HelpCenterTranslation;
+
+    cs?: HelpCentersAPI.HelpCenterTranslation;
+
+    da?: HelpCentersAPI.HelpCenterTranslation;
+
+    de?: HelpCentersAPI.HelpCenterTranslation;
+
+    el?: HelpCentersAPI.HelpCenterTranslation;
+
+    en?: HelpCentersAPI.HelpCenterTranslation;
+
+    es?: HelpCentersAPI.HelpCenterTranslation;
+
+    et?: HelpCentersAPI.HelpCenterTranslation;
+
+    fi?: HelpCentersAPI.HelpCenterTranslation;
+
+    fr?: HelpCentersAPI.HelpCenterTranslation;
+
+    hi?: HelpCentersAPI.HelpCenterTranslation;
+
+    hr?: HelpCentersAPI.HelpCenterTranslation;
+
+    hu?: HelpCentersAPI.HelpCenterTranslation;
+
+    it?: HelpCentersAPI.HelpCenterTranslation;
+
+    ja?: HelpCentersAPI.HelpCenterTranslation;
+
+    ko?: HelpCentersAPI.HelpCenterTranslation;
+
+    lt?: HelpCentersAPI.HelpCenterTranslation;
+
+    lv?: HelpCentersAPI.HelpCenterTranslation;
+
+    mn?: HelpCentersAPI.HelpCenterTranslation;
+
+    ms?: HelpCentersAPI.HelpCenterTranslation;
+
+    nb?: HelpCentersAPI.HelpCenterTranslation;
+
+    nl?: HelpCentersAPI.HelpCenterTranslation;
+
+    pl?: HelpCentersAPI.HelpCenterTranslation;
+
+    pt?: HelpCentersAPI.HelpCenterTranslation;
+
+    'pt-BR'?: HelpCentersAPI.HelpCenterTranslation;
+
+    ro?: HelpCentersAPI.HelpCenterTranslation;
+
+    ru?: HelpCentersAPI.HelpCenterTranslation;
+
+    sk?: HelpCentersAPI.HelpCenterTranslation;
+
+    sl?: HelpCentersAPI.HelpCenterTranslation;
+
+    sr?: HelpCentersAPI.HelpCenterTranslation;
+
+    sv?: HelpCentersAPI.HelpCenterTranslation;
+
+    sw?: HelpCentersAPI.HelpCenterTranslation;
+
+    th?: HelpCentersAPI.HelpCenterTranslation;
+
+    tr?: HelpCentersAPI.HelpCenterTranslation;
+
+    uk?: HelpCentersAPI.HelpCenterTranslation;
+
+    vi?: HelpCentersAPI.HelpCenterTranslation;
+
+    'zh-CN'?: HelpCentersAPI.HelpCenterTranslation;
+
+    'zh-TW'?: HelpCentersAPI.HelpCenterTranslation;
+  }
+
+  /**
+   * URLs configuration
+   */
+  export interface URLs {
+    /**
+     * External custom domain
+     */
+    externalDomain?: string;
+
+    /**
+     * Featurebase subpath
+     */
+    featurebaseSubpath?: string;
+  }
+}
+
+export interface HelpCenterNavItem {
+  /**
+   * Navigation item title
+   */
+  title: string;
+
+  /**
+   * Navigation item type
+   */
+  type: 'link' | 'button';
+
+  /**
+   * Navigation item URL
+   */
+  url: string;
+
+  /**
+   * Navigation item icon
+   */
+  icon?: string | null;
+}
+
+export interface HelpCenterTranslation {
+  /**
+   * Description for this locale
+   */
+  description?: string;
+
+  /**
+   * Display name for this locale
+   */
+  displayName?: string;
+
+  /**
+   * Navigation items for this locale
+   */
+  navItems?: Array<HelpCenterNavItem>;
+
+  /**
+   * Search placeholder for this locale
+   */
+  searchPlaceholder?: string;
+
+  /**
+   * Title for this locale
+   */
+  title?: string;
+}
+
+export interface HelpCenterListResponse {
+  /**
+   * Array of help centers
+   */
+  data: Array<HelpCenter>;
+
+  /**
+   * Cursor for fetching the next page (cursor-based pagination)
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+}
+
+export interface HelpCenterRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface HelpCenterListParams {
+  /**
+   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+   * previous response to fetch the next page.
+   */
+  cursor?: 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 declare namespace HelpCenters {
+  export {
+    type HelpCenter as HelpCenter,
+    type HelpCenterNavItem as HelpCenterNavItem,
+    type HelpCenterTranslation as HelpCenterTranslation,
+    type HelpCenterListResponse as HelpCenterListResponse,
+    type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
+    type HelpCenterListParams as HelpCenterListParams,
+  };
+}