featurebase-node 0.0.2

package/src/resources/boards.ts

@@ -0,0 +1,259 @@
+// 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';
+
+/**
+ * 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: string,
+    params: BoardRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Board> {
+    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: BoardListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BoardListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/boards', {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+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 namespace Board {
+  export 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>;
+  }
+
+  export 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
+   */
+  export interface EmojiIcon {
+    /**
+     * Emoji icon type
+     */
+    type: 'emoji';
+
+    /**
+     * A single emoji character
+     */
+    value: string;
+  }
+
+  /**
+   * A predefined icon from the built-in icon library
+   */
+  export 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
+   */
+  export interface URLIcon {
+    /**
+     * External URL icon type
+     */
+    type: 'url';
+
+    /**
+     * HTTPS URL to a custom icon image (PNG, SVG, or WebP recommended)
+     */
+    value: string;
+  }
+
+  export 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;
+  }
+
+  export 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,
+  };
+}

package/src/resources/brands.ts

@@ -0,0 +1,232 @@
+// 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';
+
+/**
+ * Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.
+ */
+export class Brands extends APIResource {
+  /**
+   * Retrieves a single brand by its Featurebase ID.
+   *
+   * ### Path Parameters
+   *
+   * - `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)
+   *
+   * ### Response
+   *
+   * Returns a brand object with:
+   *
+   * - `id` - Featurebase internal ID
+   * - `name` - Brand display name
+   * - `isDefault` - Whether this is the default brand
+   * - `createdAt` - Creation timestamp
+   * - `updatedAt` - Last update timestamp
+   * - `helpCenterId` - Associated help center ID
+   * - `senderEmailAddressId` - Default sender email address ID
+   *
+   * ### Example Response
+   *
+   * ```json
+   * {
+   *   "object": "brand",
+   *   "id": "507f1f77bcf86cd799439011",
+   *   "name": "Default Brand",
+   *   "isDefault": true,
+   *   "createdAt": "2025-01-01T12:00:00.000Z",
+   *   "updatedAt": "2025-01-10T15:30:00.000Z",
+   *   "helpCenterId": "11",
+   *   "senderEmailAddressId": "507f1f77bcf86cd799439012"
+   * }
+   * ```
+   *
+   * ### Error Responses
+   *
+   * - **404 Not Found** - Brand with the specified ID does not exist
+   *
+   * ### Version Availability
+   *
+   * This endpoint is only available in API version 2026-01-01.nova and newer.
+   */
+  retrieve(
+    id: string,
+    params: BrandRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Brand> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/brands/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns all brands in your organization with cursor-based pagination.
+   *
+   * ### Query Parameters
+   *
+   * - `limit` - Number of brands to return (1-100, default: 10)
+   * - `cursor` - Opaque cursor from a previous response for pagination
+   *
+   * ### Response Structure
+   *
+   * The response includes:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of brand objects
+   * - `nextCursor` - Cursor for the next page (null if no more results)
+   *
+   * ### Brand Object
+   *
+   * Each brand includes:
+   *
+   * - `id` - Featurebase internal ID (MongoDB ObjectId)
+   * - `name` - Brand display name
+   * - `isDefault` - Whether this is the default brand
+   * - `createdAt` - Creation timestamp
+   * - `updatedAt` - Last update timestamp
+   * - `helpCenterId` - Associated help center ID
+   * - `senderEmailAddressId` - Default sender email address ID
+   *
+   * ### Example Response
+   *
+   * ```json
+   * {
+   *   "object": "list",
+   *   "data": [
+   *     {
+   *       "object": "brand",
+   *       "id": "507f1f77bcf86cd799439011",
+   *       "name": "Default Brand",
+   *       "isDefault": true,
+   *       "createdAt": "2025-01-01T12:00:00.000Z",
+   *       "updatedAt": "2025-01-10T15:30:00.000Z",
+   *       "helpCenterId": "11",
+   *       "senderEmailAddressId": "507f1f77bcf86cd799439012"
+   *     }
+   *   ],
+   *   "nextCursor": null
+   * }
+   * ```
+   *
+   * ### Version Availability
+   *
+   * This endpoint is only available in API version 2026-01-01.nova and newer.
+   */
+  list(
+    params: BrandListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BrandListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
+    return this._client.get('/v2/brands', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface Brand {
+  /**
+   * Featurebase internal ID
+   */
+  id: string;
+
+  /**
+   * ISO date when brand was created
+   */
+  createdAt: string | null;
+
+  /**
+   * The ID of the help center associated with this brand
+   */
+  helpCenterId: string | null;
+
+  /**
+   * Whether this is the default brand
+   */
+  isDefault: boolean;
+
+  /**
+   * Brand display name
+   */
+  name: string;
+
+  /**
+   * Object type identifier
+   */
+  object: 'brand';
+
+  /**
+   * The ID of the default sending email address for this brand
+   */
+  senderEmailAddressId: string | null;
+
+  /**
+   * ISO date when brand was last updated
+   */
+  updatedAt: string | null;
+}
+
+export interface BrandListResponse {
+  /**
+   * Array of brands
+   */
+  data: Array<Brand>;
+
+  /**
+   * Cursor for fetching the next page (cursor-based pagination)
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+}
+
+export interface BrandRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface BrandListParams {
+  /**
+   * Query param: An opaque cursor for pagination. Use the nextCursor value from a
+   * previous response to fetch the next page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Query param: A limit on the number of brands to be returned, between 1 and 100.
+   */
+  limit?: number;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export declare namespace Brands {
+  export {
+    type Brand as Brand,
+    type BrandListResponse as BrandListResponse,
+    type BrandRetrieveParams as BrandRetrieveParams,
+    type BrandListParams as BrandListParams,
+  };
+}