featurebase-node 0.0.2

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

@@ -0,0 +1,711 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+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 RedirectRules extends APIResource {
+  /**
+   * Creates a new redirect rule in your organization.
+   *
+   * The `fromUrl` is normalized on creation: query parameters and hash fragments are
+   * stripped, the hostname is lowercased, and trailing slashes are removed. The
+   * `fromUrl` hostname must match the Help Center's configured custom domain.
+   *
+   * The target article or collection must exist and have a resolvable URL (i.e., a
+   * published translation with a slug).
+   *
+   * ### Request Body
+   *
+   * Required attributes:
+   *
+   * - `helpCenterId` - The ID of the help center this rule belongs to
+   * - `locale` - Locale code used to resolve the target translation
+   * - `fromUrl` - The full absolute URL to redirect from (must match the help
+   *   center's custom domain)
+   * - `targetType` - "article" or "collection"
+   * - `targetId` - The ID of the target article or collection
+   *
+   * ### Response
+   *
+   * Returns the created redirect rule object.
+   *
+   * ### Errors
+   *
+   * - `400` - Invalid request data, fromUrl does not match custom domain, or target
+   *   not found
+   *
+   * @example
+   * ```ts
+   * const redirectRule =
+   *   await client.helpCenter.redirectRules.create({
+   *     fromUrl:
+   *       'https://help.example.com/en/old/getting-started',
+   *     helpCenterId: 'ox6qrqprmsuqaunj',
+   *     locale: 'en',
+   *     targetId: '10021362',
+   *     targetType: 'article',
+   *   });
+   * ```
+   */
+  create(params: RedirectRuleCreateParams, options?: RequestOptions): APIPromise<RedirectRule> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.post('/v2/help_center/redirect_rules', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Retrieves a specific redirect rule by its unique identifier.
+   *
+   * Returns the redirect rule object if found in your organization.
+   *
+   * ### 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
+   *
+   * - `404` - Redirect rule not found in your organization
+   *
+   * @example
+   * ```ts
+   * const redirectRule =
+   *   await client.helpCenter.redirectRules.retrieve(
+   *     '507f1f77bcf86cd799439011',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: RedirectRuleRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RedirectRule> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/help_center/redirect_rules/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Updates an existing redirect rule. Only include the fields you wish to update.
+   *
+   * If `fromUrl` is provided, it will be re-normalized and validated against the
+   * Help Center's custom domain. If `targetType` or `targetId` is changed, the new
+   * target must exist and have a resolvable URL.
+   *
+   * ### Path Parameters
+   *
+   * - `id` - The unique identifier of the redirect rule to update
+   *
+   * ### Request Body
+   *
+   * All fields are optional. Only provided fields will be updated:
+   *
+   * - `helpCenterId` - The help center ID
+   * - `locale` - Locale code
+   * - `fromUrl` - Updated source URL (will be re-normalized)
+   * - `targetType` - "article" or "collection"
+   * - `targetId` - ID of the new target article or collection
+   *
+   * ### Response
+   *
+   * Returns the updated redirect rule object.
+   *
+   * ### Errors
+   *
+   * - `404` - Redirect rule not found
+   * - `400` - Invalid data, domain mismatch, duplicate fromUrl, or target not found
+   *
+   * @example
+   * ```ts
+   * const redirectRule =
+   *   await client.helpCenter.redirectRules.update(
+   *     '507f1f77bcf86cd799439011',
+   *   );
+   * ```
+   */
+  update(id: string, params: RedirectRuleUpdateParams, options?: RequestOptions): APIPromise<RedirectRule> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.patch(path`/v2/help_center/redirect_rules/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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
+   * const redirectRules =
+   *   await client.helpCenter.redirectRules.list();
+   * ```
+   */
+  list(
+    params: RedirectRuleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RedirectRuleListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.get('/v2/help_center/redirect_rules', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Deletes an existing redirect rule. The associated Redis cache entry is also
+   * invalidated.
+   *
+   * ### Path Parameters
+   *
+   * - `id` - The unique identifier of the redirect rule to delete
+   *
+   * ### Response
+   *
+   * Returns a deletion confirmation object:
+   *
+   * - `id` - The ID of the deleted redirect rule
+   * - `object` - Always "redirect_rule"
+   * - `deleted` - Always true
+   *
+   * ### Errors
+   *
+   * - `404` - Redirect rule not found in your organization
+   *
+   * @example
+   * ```ts
+   * const redirectRule =
+   *   await client.helpCenter.redirectRules.delete(
+   *     '507f1f77bcf86cd799439011',
+   *   );
+   * ```
+   */
+  delete(
+    id: string,
+    params: RedirectRuleDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RedirectRuleDeleteResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.delete(path`/v2/help_center/redirect_rules/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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 != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface RedirectRule {
+  /**
+   * Redirect rule unique identifier
+   */
+  id: string;
+
+  /**
+   * ISO 8601 timestamp when created
+   */
+  createdAt: string;
+
+  /**
+   * Canonical source URL being redirected from (query and hash stripped)
+   */
+  fromUrl: string;
+
+  /**
+   * Help center identifier
+   */
+  helpCenterId: string;
+
+  /**
+   * Locale code for the redirect rule
+   */
+  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: 'redirect_rule';
+
+  /**
+   * Target article or collection ID
+   */
+  targetId: string;
+
+  /**
+   * Type of content the redirect points to
+   */
+  targetType: 'article' | 'collection';
+
+  /**
+   * ISO 8601 timestamp when last updated
+   */
+  updatedAt: string;
+}
+
+export interface RedirectRuleListResponse {
+  /**
+   * Array of redirect rules
+   */
+  data: Array<RedirectRule>;
+
+  /**
+   * Cursor for fetching the next page. Null if there are no more results.
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+}
+
+export interface RedirectRuleDeleteResponse {
+  /**
+   * Unique identifier of the deleted redirect rule
+   */
+  id: string;
+
+  /**
+   * Indicates the resource was deleted
+   */
+  deleted: true;
+
+  /**
+   * Object type identifier
+   */
+  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;
+
+  /**
+   * Body param: Help center identifier this redirect rule belongs to
+   */
+  helpCenterId: string;
+
+  /**
+   * Body param: Locale code for the redirect rule. Used to resolve the target
+   * article/collection translation.
+   */
+  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';
+
+  /**
+   * Body param: ID of the target article or collection
+   */
+  targetId: string;
+
+  /**
+   * Body param: Type of content the redirect points to
+   */
+  targetType: 'article' | 'collection';
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface RedirectRuleRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+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;
+
+  /**
+   * Body param: Locale code for the redirect rule
+   */
+  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';
+
+  /**
+   * Body param: ID of the target article or collection
+   */
+  targetId?: string;
+
+  /**
+   * Body param: Type of content the redirect points to
+   */
+  targetType?: 'article' | 'collection';
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface RedirectRuleListParams {
+  /**
+   * 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 redirect rules by help center ID
+   */
+  helpCenterId?: string;
+
+  /**
+   * Query param: A limit on the number of objects to be returned, between 1 and 100.
+   */
+  limit?: number;
+
+  /**
+   * Query param: Filter redirect rules by 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';
+
+  /**
+   * Query param: Filter redirect rules by target type
+   */
+  targetType?: 'article' | 'collection';
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface RedirectRuleDeleteParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+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'?: string;
+}
+
+export declare namespace RedirectRules {
+  export {
+    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.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './help-center/index';