featurebase-node 0.0.2

package/resources/admins.mjs

@@ -0,0 +1,153 @@
+// 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";
+/**
+ * Team members who manage your Featurebase organization. Admins have roles that define their permissions.
+ */
+export class Admins extends APIResource {
+    /**
+     * Retrieves a single admin by their unique identifier.
+     *
+     * Returns the admin object if found and they belong to your organization.
+     *
+     * ### Response
+     *
+     * Returns an admin object with:
+     *
+     * - `id` - Unique admin identifier
+     * - `name` - Admin's display name
+     * - `email` - Admin's email address
+     * - `picture` - Profile picture URL
+     * - `roleId` - ID of the role assigned to this admin
+     *
+     * ### Errors
+     *
+     * - `404` - Admin not found or doesn't belong to your organization
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/admins/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all admins for your organization.
+     *
+     * This endpoint returns all admins at once (typically a small list). No pagination
+     * is supported.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of admin objects
+     * - `nextCursor` - Always null
+     *
+     * ### Admin Object
+     *
+     * Each admin includes:
+     *
+     * - `id` - Unique admin identifier
+     * - `name` - Admin's display name
+     * - `email` - Admin's email address
+     * - `picture` - Profile picture URL
+     * - `roleId` - ID of the role assigned to this admin
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/admins', {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all available admin roles and their permissions.
+     *
+     * This endpoint returns all roles at once (typically a small list). No pagination
+     * is supported.
+     *
+     * ### Response Format
+     *
+     * Returns a list object with:
+     *
+     * - `object` - Always "list"
+     * - `data` - Array of admin role objects
+     * - `nextCursor` - Always null
+     *
+     * ### Admin Role Object
+     *
+     * Each role includes:
+     *
+     * - `id` - Unique role identifier
+     * - `name` - Role name (e.g., "Admin", "Viewer")
+     * - `permissions` - Object containing permission flags
+     *
+     * ### Permissions
+     *
+     * The permissions object contains boolean flags for each permission:
+     *
+     * - `view_comments_private` - Can view private comments
+     * - `manage_comments` - Can manage comments
+     * - `manage_comments_private` - Can manage private comments
+     * - `set_comment_pinned` - Can pin comments
+     * - `moderate_comments` - Can moderate comments
+     * - `set_post_category` - Can change post categories
+     * - `set_post_pinned` - Can pin posts
+     * - `set_post_eta` - Can set post ETA
+     * - `set_post_tags` - Can manage post tags
+     * - `set_post_author` - Can change post author
+     * - `set_post_status` - Can change post status
+     * - `set_post_assignee` - Can assign posts
+     * - `set_post_custom_fields` - Can edit custom fields
+     * - `post_vote_on_behalf` - Can vote on behalf of users
+     * - `post_merge` - Can merge posts
+     * - `post_import` - Can import posts
+     * - `post_export` - Can export posts
+     * - `moderate_posts` - Can moderate posts
+     * - `view_users` - Can view users
+     * - `manage_users` - Can manage users
+     * - `view_posts_private` - Can view private posts
+     * - `view_private_post_tags` - Can view private tags
+     * - `manage_changelogs` - Can manage changelogs
+     * - `manage_surveys` - Can manage surveys
+     * - `manage_branding` - Can manage branding
+     * - `manage_billing` - Can manage billing
+     * - `manage_team_members` - Can manage team members
+     * - `manage_sso` - Can manage SSO settings
+     * - `manage_api` - Can manage API settings
+     * - `manage_statuses` - Can manage statuses
+     * - `manage_boards` - Can manage boards
+     * - `manage_post_tags` - Can manage post tags
+     * - `manage_custom_fields` - Can manage custom fields
+     * - `manage_moderation_settings` - Can manage moderation
+     * - `manage_roadmap` - Can manage roadmap
+     * - `manage_user_roles` - Can manage user roles
+     * - `manage_prioritization` - Can manage prioritization
+     * - `manage_notifications` - Can manage notifications
+     * - `manage_custom_domain` - Can manage custom domain
+     * - `manage_integrations` - Can manage integrations
+     * - `use_integrations` - Can use integrations
+     * - `manage_help_center` - Can manage help center
+     * - `auto_approve_posts` - Posts auto-approved
+     */
+    listRoles(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/admins/roles', {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=admins.mjs.map

package/resources/admins.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"admins.mjs","sourceRoot":"","sources":["../src/resources/admins.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE;YAC9C,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;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;YACpC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,SAAS,CACP,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAC1C,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/boards.d.mts

@@ -0,0 +1,202 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Boards (post categories) organize feedback into distinct containers with their own settings.
+ */
+export declare class Boards extends APIResource {
+    /**
+     * Retrieves a single board by its unique identifier.
+     *
+     * Returns the full board object including all access controls, feature toggles,
+     * and localization settings.
+     */
+    retrieve(id: string, params?: BoardRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Board>;
+    /**
+     * Returns all boards (post categories) for the authenticated organization.
+     *
+     * Boards are containers for posts/feedback. Each board can have different:
+     *
+     * - Access controls (public, private, segment-restricted)
+     * - Feature toggles (comments, posting enabled)
+     * - Custom fields
+     *
+     * This endpoint returns all boards without pagination. Organizations typically
+     * have a small number of boards.
+     */
+    list(params?: BoardListParams | null | undefined, options?: RequestOptions): APIPromise<BoardListResponse>;
+}
+export interface Board {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    access: Board.Access;
+    /**
+     * ISO 8601 timestamp when created
+     */
+    createdAt: string;
+    /**
+     * Custom field IDs attached to this board
+     */
+    customFields: Array<string>;
+    features: Board.Features;
+    /**
+     * The board's icon. Can be one of three types:
+     *
+     * - **emoji**: A single emoji character (e.g., 💡, 🚀, ⭐)
+     * - **icon**: A predefined icon from the built-in library (e.g., lightbulb, bug,
+     *   star)
+     * - **url**: A custom image URL (HTTPS required)
+     *
+     * Can be `null` if no icon is set.
+     */
+    icon: Board.EmojiIcon | Board.PredefinedIcon | Board.URLIcon | null;
+    localization: Board.Localization;
+    /**
+     * Display name in organization's default locale
+     */
+    name: string;
+    /**
+     * Object type identifier
+     */
+    object: 'board';
+    postDefaults: Board.PostDefaults;
+}
+export declare namespace Board {
+    interface Access {
+        /**
+         * If true, only admins can see this board
+         */
+        adminOnly: boolean;
+        /**
+         * Role IDs allowed access (empty = all)
+         */
+        allowedRoles: Array<string>;
+        /**
+         * Role IDs explicitly denied access
+         */
+        deniedRoles: Array<string>;
+        /**
+         * Segment IDs that can access (empty = all)
+         */
+        segments: Array<string>;
+    }
+    interface Features {
+        /**
+         * Whether users can comment on posts
+         */
+        commentsEnabled: boolean;
+        /**
+         * Whether creation dates are visible on posts
+         */
+        createdDatesVisible: boolean;
+        /**
+         * Whether users can create new posts
+         */
+        postingEnabled: boolean;
+    }
+    /**
+     * An emoji character as the board icon
+     */
+    interface EmojiIcon {
+        /**
+         * Emoji icon type
+         */
+        type: 'emoji';
+        /**
+         * A single emoji character
+         */
+        value: string;
+    }
+    /**
+     * A predefined icon from the built-in icon library
+     */
+    interface PredefinedIcon {
+        /**
+         * Predefined icon type
+         */
+        type: 'icon';
+        /**
+         * Icon name from the predefined icon set (e.g., lightbulb, bug, star, rocket,
+         * flag, heart, check, question, megaphone, gift)
+         */
+        value: string;
+    }
+    /**
+     * A custom icon loaded from an external URL
+     */
+    interface URLIcon {
+        /**
+         * External URL icon type
+         */
+        type: 'url';
+        /**
+         * HTTPS URL to a custom icon image (PNG, SVG, or WebP recommended)
+         */
+        value: string;
+    }
+    interface Localization {
+        /**
+         * Localized description
+         */
+        description: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Placeholder text in the post creation form
+         */
+        formPlaceholder: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Hero description/subtitle
+         */
+        heroDescription: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Hero title shown on the board page
+         */
+        heroTitle: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Localized board name (language code → text)
+         */
+        name: {
+            [key: string]: string;
+        };
+        /**
+         * Submit button text
+         */
+        submitButtonText: {
+            [key: string]: string;
+        } | null;
+    }
+    interface PostDefaults {
+        /**
+         * Default visibility for new posts
+         */
+        visibility: 'public' | 'authorOnly' | 'companyOnly';
+    }
+}
+export type BoardListResponse = Array<Board>;
+export interface BoardRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface BoardListParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Boards {
+    export { type Board as Board, type BoardListResponse as BoardListResponse, type BoardRetrieveParams as BoardRetrieveParams, type BoardListParams as BoardListParams, };
+}
+//# sourceMappingURL=boards.d.mts.map

package/resources/boards.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boards.d.mts","sourceRoot":"","sources":["../src/resources/boards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAWpB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAUjC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;IAEzB;;;;;;;;;OASG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpE,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;CAClC;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,MAAM;QACrB;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3B;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,mBAAmB,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;QAEZ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,WAAW,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,eAAe,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,eAAe,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,IAAI,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEhC;;WAEG;QACH,gBAAgB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;KACpD;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,UAAU,EAAE,QAAQ,GAAG,YAAY,GAAG,aAAa,CAAC;KACrD;CACF;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;AAE7C,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/boards.d.ts

@@ -0,0 +1,202 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Boards (post categories) organize feedback into distinct containers with their own settings.
+ */
+export declare class Boards extends APIResource {
+    /**
+     * Retrieves a single board by its unique identifier.
+     *
+     * Returns the full board object including all access controls, feature toggles,
+     * and localization settings.
+     */
+    retrieve(id: string, params?: BoardRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Board>;
+    /**
+     * Returns all boards (post categories) for the authenticated organization.
+     *
+     * Boards are containers for posts/feedback. Each board can have different:
+     *
+     * - Access controls (public, private, segment-restricted)
+     * - Feature toggles (comments, posting enabled)
+     * - Custom fields
+     *
+     * This endpoint returns all boards without pagination. Organizations typically
+     * have a small number of boards.
+     */
+    list(params?: BoardListParams | null | undefined, options?: RequestOptions): APIPromise<BoardListResponse>;
+}
+export interface Board {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    access: Board.Access;
+    /**
+     * ISO 8601 timestamp when created
+     */
+    createdAt: string;
+    /**
+     * Custom field IDs attached to this board
+     */
+    customFields: Array<string>;
+    features: Board.Features;
+    /**
+     * The board's icon. Can be one of three types:
+     *
+     * - **emoji**: A single emoji character (e.g., 💡, 🚀, ⭐)
+     * - **icon**: A predefined icon from the built-in library (e.g., lightbulb, bug,
+     *   star)
+     * - **url**: A custom image URL (HTTPS required)
+     *
+     * Can be `null` if no icon is set.
+     */
+    icon: Board.EmojiIcon | Board.PredefinedIcon | Board.URLIcon | null;
+    localization: Board.Localization;
+    /**
+     * Display name in organization's default locale
+     */
+    name: string;
+    /**
+     * Object type identifier
+     */
+    object: 'board';
+    postDefaults: Board.PostDefaults;
+}
+export declare namespace Board {
+    interface Access {
+        /**
+         * If true, only admins can see this board
+         */
+        adminOnly: boolean;
+        /**
+         * Role IDs allowed access (empty = all)
+         */
+        allowedRoles: Array<string>;
+        /**
+         * Role IDs explicitly denied access
+         */
+        deniedRoles: Array<string>;
+        /**
+         * Segment IDs that can access (empty = all)
+         */
+        segments: Array<string>;
+    }
+    interface Features {
+        /**
+         * Whether users can comment on posts
+         */
+        commentsEnabled: boolean;
+        /**
+         * Whether creation dates are visible on posts
+         */
+        createdDatesVisible: boolean;
+        /**
+         * Whether users can create new posts
+         */
+        postingEnabled: boolean;
+    }
+    /**
+     * An emoji character as the board icon
+     */
+    interface EmojiIcon {
+        /**
+         * Emoji icon type
+         */
+        type: 'emoji';
+        /**
+         * A single emoji character
+         */
+        value: string;
+    }
+    /**
+     * A predefined icon from the built-in icon library
+     */
+    interface PredefinedIcon {
+        /**
+         * Predefined icon type
+         */
+        type: 'icon';
+        /**
+         * Icon name from the predefined icon set (e.g., lightbulb, bug, star, rocket,
+         * flag, heart, check, question, megaphone, gift)
+         */
+        value: string;
+    }
+    /**
+     * A custom icon loaded from an external URL
+     */
+    interface URLIcon {
+        /**
+         * External URL icon type
+         */
+        type: 'url';
+        /**
+         * HTTPS URL to a custom icon image (PNG, SVG, or WebP recommended)
+         */
+        value: string;
+    }
+    interface Localization {
+        /**
+         * Localized description
+         */
+        description: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Placeholder text in the post creation form
+         */
+        formPlaceholder: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Hero description/subtitle
+         */
+        heroDescription: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Hero title shown on the board page
+         */
+        heroTitle: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Localized board name (language code → text)
+         */
+        name: {
+            [key: string]: string;
+        };
+        /**
+         * Submit button text
+         */
+        submitButtonText: {
+            [key: string]: string;
+        } | null;
+    }
+    interface PostDefaults {
+        /**
+         * Default visibility for new posts
+         */
+        visibility: 'public' | 'authorOnly' | 'companyOnly';
+    }
+}
+export type BoardListResponse = Array<Board>;
+export interface BoardRetrieveParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export interface BoardListParams {
+    /**
+     * API version for this request. Defaults to your organization's configured API
+     * version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Boards {
+    export { type Board as Board, type BoardListResponse as BoardListResponse, type BoardRetrieveParams as BoardRetrieveParams, type BoardListParams as BoardListParams, };
+}
+//# sourceMappingURL=boards.d.ts.map

package/resources/boards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boards.d.ts","sourceRoot":"","sources":["../src/resources/boards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAWpB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAUjC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;IAEzB;;;;;;;;;OASG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpE,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;CAClC;AAED,yBAAiB,KAAK,CAAC;IACrB,UAAiB,MAAM;QACrB;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3B;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,mBAAmB,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;QAEZ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,WAAW,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,eAAe,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,eAAe,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,IAAI,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEhC;;WAEG;QACH,gBAAgB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;KACpD;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,UAAU,EAAE,QAAQ,GAAG,YAAY,GAAG,aAAa,CAAC;KACrD;CACF;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;AAE7C,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/boards.js

@@ -0,0 +1,52 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Boards = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Boards (post categories) organize feedback into distinct containers with their own settings.
+ */
+class Boards extends resource_1.APIResource {
+    /**
+     * Retrieves a single board by its unique identifier.
+     *
+     * Returns the full board object including all access controls, feature toggles,
+     * and localization settings.
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get((0, path_1.path) `/v2/boards/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all boards (post categories) for the authenticated organization.
+     *
+     * Boards are containers for posts/feedback. Each board can have different:
+     *
+     * - Access controls (public, private, segment-restricted)
+     * - Feature toggles (comments, posting enabled)
+     * - Custom fields
+     *
+     * This endpoint returns all boards without pagination. Organizations typically
+     * have a small number of boards.
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/boards', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Boards = Boards;
+//# sourceMappingURL=boards.js.map

package/resources/boards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boards.js","sourceRoot":"","sources":["../src/resources/boards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;OAKG;IACH,QAAQ,CACN,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE;YAC9C,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;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;YACpC,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;AA/CD,wBA+CC"}

package/resources/boards.mjs

@@ -0,0 +1,48 @@
+// 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";
+/**
+ * Boards (post categories) organize feedback into distinct containers with their own settings.
+ */
+export class Boards extends APIResource {
+    /**
+     * Retrieves a single board by its unique identifier.
+     *
+     * Returns the full board object including all access controls, feature toggles,
+     * and localization settings.
+     */
+    retrieve(id, params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get(path `/v2/boards/${id}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Returns all boards (post categories) for the authenticated organization.
+     *
+     * Boards are containers for posts/feedback. Each board can have different:
+     *
+     * - Access controls (public, private, segment-restricted)
+     * - Feature toggles (comments, posting enabled)
+     * - Custom fields
+     *
+     * This endpoint returns all boards without pagination. Organizations typically
+     * have a small number of boards.
+     */
+    list(params = {}, options) {
+        const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+        return this._client.get('/v2/boards', {
+            ...options,
+            headers: buildHeaders([
+                { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=boards.mjs.map

package/resources/boards.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"boards.mjs","sourceRoot":"","sources":["../src/resources/boards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CACN,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE;YAC9C,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;;;;;;;;;;;OAWG;IACH,IAAI,CACF,SAA6C,EAAE,EAC/C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;YACpC,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"}