featurebase-node 0.0.2

package/resources/help-center/help-centers.js

@@ -0,0 +1,111 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HelpCenters = 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 HelpCenters extends resource_1.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, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/help_center/help_centers/${id}`, {
+            ...options,
+            headers: (0, headers_1.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 = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+        return this._client.get('/v2/help_center/help_centers', {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.HelpCenters = HelpCenters;
+//# sourceMappingURL=help-centers.js.map

package/resources/help-center/help-centers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-centers.js","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE;YACtD,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;AA1GD,kCA0GC"}

package/resources/help-center/help-centers.mjs

@@ -0,0 +1,107 @@
+// 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 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, params = {}, options) {
+        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 = {}, options) {
+        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,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=help-centers.mjs.map

package/resources/help-center/help-centers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-centers.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE;YACtD,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/index.d.mts

@@ -0,0 +1,6 @@
+export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type ArticleListResponse, type ArticleDeleteResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, } from "./articles.mjs";
+export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionListResponse, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, } from "./collections.mjs";
+export { HelpCenter } from "./help-center.mjs";
+export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterListResponse, type HelpCenterRetrieveParams, type HelpCenterListParams, } from "./help-centers.mjs";
+export { RedirectRules, type RedirectRule, type RedirectRuleListResponse, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, } from "./redirect-rules.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,GACzB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,GAC5B;OACM,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,GAC1B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,GACrC"}

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

@@ -0,0 +1,6 @@
+export { Articles, type Article, type ArticleAuthor, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type ArticleListResponse, type ArticleDeleteResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, } from "./articles.js";
+export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionListResponse, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, } from "./collections.js";
+export { HelpCenter } from "./help-center.js";
+export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterListResponse, type HelpCenterRetrieveParams, type HelpCenterListParams, } from "./help-centers.js";
+export { RedirectRules, type RedirectRule, type RedirectRuleListResponse, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, } from "./redirect-rules.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,GACzB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,GAC5B;OACM,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,GAC1B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,GACrC"}

package/resources/help-center/index.js

@@ -0,0 +1,15 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedirectRules = exports.HelpCenters = exports.HelpCenter = exports.Collections = exports.Articles = void 0;
+var articles_1 = require("./articles.js");
+Object.defineProperty(exports, "Articles", { enumerable: true, get: function () { return articles_1.Articles; } });
+var collections_1 = require("./collections.js");
+Object.defineProperty(exports, "Collections", { enumerable: true, get: function () { return collections_1.Collections; } });
+var help_center_1 = require("./help-center.js");
+Object.defineProperty(exports, "HelpCenter", { enumerable: true, get: function () { return help_center_1.HelpCenter; } });
+var help_centers_1 = require("./help-centers.js");
+Object.defineProperty(exports, "HelpCenters", { enumerable: true, get: function () { return help_centers_1.HelpCenters; } });
+var redirect_rules_1 = require("./redirect-rules.js");
+Object.defineProperty(exports, "RedirectRules", { enumerable: true, get: function () { return redirect_rules_1.RedirectRules; } });
+//# sourceMappingURL=index.js.map

package/resources/help-center/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,0CAcoB;AAblB,oGAAA,QAAQ,OAAA;AAcV,gDAauB;AAZrB,0GAAA,WAAW,OAAA;AAab,gDAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,kDAOwB;AANtB,2GAAA,WAAW,OAAA;AAOb,sDAW0B;AAVxB,+GAAA,aAAa,OAAA"}

package/resources/help-center/index.mjs

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Articles, } from "./articles.mjs";
+export { Collections, } from "./collections.mjs";
+export { HelpCenter } from "./help-center.mjs";
+export { HelpCenters, } from "./help-centers.mjs";
+export { RedirectRules, } from "./redirect-rules.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/help-center/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,QAAQ,GAaT;OACM,EACL,WAAW,GAYZ;OACM,EAAE,UAAU,EAAE;OACd,EACL,WAAW,GAMZ;OACM,EACL,aAAa,GAUd"}