featurebase-node 0.0.2

package/resources/help-center/redirect-rules.js

@@ -0,0 +1,297 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedirectRules = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
+ */
+class RedirectRules extends resource_1.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, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.post('/v2/help_center/redirect_rules', {
+            body,
+            ...options,
+            headers: (0, headers_1.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, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/help_center/redirect_rules/${id}`, {
+            ...options,
+            headers: (0, headers_1.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, params, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+        return this._client.patch((0, path_1.path) `/v2/help_center/redirect_rules/${id}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.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 = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get('/v2/help_center/redirect_rules', {
+            query,
+            ...options,
+            headers: (0, headers_1.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, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.delete((0, path_1.path) `/v2/help_center/redirect_rules/${id}`, {
+            ...options,
+            headers: (0, headers_1.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, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params;
+        return this._client.get('/v2/help_center/redirect_rules/by-url', {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.RedirectRules = RedirectRules;
+//# sourceMappingURL=redirect-rules.js.map

package/resources/help-center/redirect-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect-rules.js","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE;YACxD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kCAAkC,EAAE,EAAE,EAAE;YACrE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAuC,EAAE,OAAwB;QAC7E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAC/D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA5SD,sCA4SC"}

package/resources/help-center/redirect-rules.mjs

@@ -0,0 +1,293 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * 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, options) {
+        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, params = {}, options) {
+        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, params, options) {
+        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 = {}, options) {
+        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, params = {}, options) {
+        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, options) {
+        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,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=redirect-rules.mjs.map

package/resources/help-center/redirect-rules.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect-rules.mjs","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACzD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kCAAkC,EAAE,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kCAAkC,EAAE,EAAE,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE;YACxD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kCAAkC,EAAE,EAAE,EAAE;YACrE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,aAAa,CAAC,MAAuC,EAAE,OAAwB;QAC7E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAC/D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/help-center.d.mts

@@ -0,0 +1,2 @@
+export * from "./help-center/index.mjs";
+//# sourceMappingURL=help-center.d.mts.map

package/resources/help-center.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-center.d.mts","sourceRoot":"","sources":["../src/resources/help-center.ts"],"names":[],"mappings":""}

package/resources/help-center.d.ts

@@ -0,0 +1,2 @@
+export * from "./help-center/index.js";
+//# sourceMappingURL=help-center.d.ts.map

package/resources/help-center.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-center.d.ts","sourceRoot":"","sources":["../src/resources/help-center.ts"],"names":[],"mappings":""}

package/resources/help-center.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./help-center/index.js"), exports);
+//# sourceMappingURL=help-center.js.map

package/resources/help-center.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-center.js","sourceRoot":"","sources":["../src/resources/help-center.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,iEAAoC"}

package/resources/help-center.mjs

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

package/resources/help-center.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-center.mjs","sourceRoot":"","sources":["../src/resources/help-center.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/index.d.mts

@@ -0,0 +1,18 @@
+export { Admins, type Admin, type AdminListResponse, type AdminListRolesResponse, type AdminRetrieveParams, type AdminListParams, type AdminListRolesParams, } from "./admins.mjs";
+export { Boards, type Board, type BoardListResponse, type BoardRetrieveParams, type BoardListParams, } from "./boards.mjs";
+export { Brands, type Brand, type BrandListResponse, type BrandRetrieveParams, type BrandListParams, } from "./brands.mjs";
+export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogListResponse, type ChangelogDeleteResponse, type ChangelogCreateParams, type ChangelogRetrieveParams, type ChangelogUpdateParams, type ChangelogListParams, type ChangelogDeleteParams, type ChangelogPublishParams, type ChangelogUnpublishParams, } from "./changelogs/changelogs.mjs";
+export { Comments, type Comment, type CommentListResponse, type CommentDelete0Response, type CommentDelete1Response, type CommentCreateParams, type CommentRetrieveParams, type CommentUpdateParams, type CommentListParams, type CommentDelete0Params, type CommentDelete1Params, } from "./comments.mjs";
+export { Companies, type Company, type DeletedCompany, type CompanyListResponse, type CompanyRetrieveParams, type CompanyListParams, type CompanyDeleteParams, type CompanyCreateOrUpdateParams, type CompanyDeleteByCompanyIDParams, } from "./companies/companies.mjs";
+export { Contacts, type Contact, type ContactList, type DeletedContact, type ContactRetrieveResponse, type ContactBlockResponse, type ContactCreateOrUpdateResponse, type ContactUnblockResponse, type ContactRetrieveParams, type ContactListParams, type ContactDeleteParams, type ContactBlockParams, type ContactCreateOrUpdateParams, type ContactUnblockParams, } from "./contacts/contacts.mjs";
+export { Conversations, type Conversation, type ConversationPart, type ConversationPartAuthor, type ConversationParticipant, type ConversationTagApplication, type CsatEmailDelivery, type CsatRatedAgent, type CsatWorkflowLink, type EmailRecipients, type ConversationListResponse, type ConversationDeleteResponse, type ConversationCreateParams, type ConversationRetrieveParams, type ConversationUpdateParams, type ConversationListParams, type ConversationDeleteParams, type ConversationRedactParams, type ConversationReplyParams, } from "./conversations/conversations.mjs";
+export { CustomFields, type CustomField, type CustomFieldList, type CustomFieldRetrieveParams, type CustomFieldListParams, } from "./custom-fields.mjs";
+export { HelpCenter } from "./help-center/help-center.mjs";
+export { PostStatuses, type PostStatus, type PostStatusListResponse, type PostStatusRetrieveParams, type PostStatusListParams, } from "./post-statuses.mjs";
+export { Posts, type Post, type PostListResponse, type PostDeleteResponse, type PostCreateParams, type PostRetrieveParams, type PostUpdateParams, type PostListParams, type PostDeleteParams, } from "./posts/posts.mjs";
+export { Surveys, type Survey, type SurveyNextAction, type SurveyListResponse, type SurveyRetrieveResponsesResponse, type SurveyRetrieveParams, type SurveyListParams, type SurveyRetrieveResponsesParams, } from "./surveys.mjs";
+export { Tags, type ConversationTag, type TagListResponse, type TagDeleteResponse, type TagRetrieveParams, type TagListParams, type TagDeleteParams, type TagCreateOrRenameParams, } from "./tags.mjs";
+export { Teams, type Team, type TeamListResponse, type TeamRetrieveParams, type TeamListParams, } from "./teams.mjs";
+export { Tickets, type AuthorInput, type Ticket, type TicketListResponse, type TicketDeleteResponse, type TicketCreateParams, type TicketRetrieveParams, type TicketUpdateParams, type TicketListParams, type TicketDeleteParams, type TicketReplyParams, } from "./tickets/tickets.mjs";
+export { Webhooks, type Webhook, type WebhookRequestConfigInput, type WebhookListResponse, type WebhookDeleteResponse, type WebhookCreateParams, type WebhookRetrieveParams, type WebhookUpdateParams, type WebhookListParams, type WebhookDeleteParams, type WebhookRefreshSecretParams, } from "./webhooks.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,oBAAoB,GAC1B;OACM,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,GACrB;OACM,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,GACrB;OACM,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,GAC9B;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,GAC1B;OACM,EACL,SAAS,EACT,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,6BAA6B,EAClC,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,GAC1B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC7B;OACM,EACL,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,GAC3B;OACM,EAAE,UAAU,EAAE;OACd,EACL,YAAY,EACZ,KAAK,UAAU,EACf,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,GAC1B;OACM,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,gBAAgB,GACtB;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,EACpC,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,6BAA6B,GACnC;OACM,EACL,IAAI,EACJ,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,uBAAuB,GAC7B;OACM,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,cAAc,GACpB;OACM,EACL,OAAO,EACP,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,GACvB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,GAChC"}