featurebase-node 0.0.2

package/src/resources/tags.ts

@@ -0,0 +1,226 @@
+// 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';
+
+/**
+ * Conversation tags let you organize, filter, and automate around inbox conversations. Use these endpoints to list, look up, create, rename, and delete workspace conversation tags.
+ */
+export class Tags extends APIResource {
+  /**
+   * Returns a single conversation tag by its Featurebase tag ID. Archived tags can
+   * still be retrieved directly by ID, while permanently deleted tags return `404`.
+   *
+   * @example
+   * ```ts
+   * const conversationTag = await client.tags.retrieve(
+   *   '67ec1234abcd5678ef901234',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: TagRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConversationTag> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/tags/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns the live conversation tags available in the workspace tag catalog. These
+   * are the canonical tags that power conversation payloads, filters, and tag
+   * mutation endpoints.
+   *
+   * @example
+   * ```ts
+   * const tags = await client.tags.list();
+   * ```
+   */
+  list(params: TagListParams | null | undefined = {}, options?: RequestOptions): APIPromise<TagListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/tags', {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Deletes a conversation tag from the workspace catalog and removes it from
+   * aggregate conversation tag state. Archived and historical part applications
+   * remain part of the audit trail where applicable.
+   *
+   * @example
+   * ```ts
+   * const tag = await client.tags.delete(
+   *   '67ec1234abcd5678ef901234',
+   * );
+   * ```
+   */
+  delete(
+    id: string,
+    params: TagDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TagDeleteResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params ?? {};
+    return this._client.delete(path`/v2/tags/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Creates a new workspace conversation tag when only `name` is provided. If `id`
+   * is also provided, the existing tag is renamed instead.
+   *
+   * @example
+   * ```ts
+   * const conversationTag = await client.tags.createOrRename({
+   *   name: 'Churn',
+   * });
+   * ```
+   */
+  createOrRename(params: TagCreateOrRenameParams, options?: RequestOptions): APIPromise<ConversationTag> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.post('/v2/tags', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface ConversationTag {
+  /**
+   * Unique tag identifier
+   */
+  id: string;
+
+  /**
+   * Current tag name
+   */
+  name: string;
+
+  /**
+   * Object type identifier for a tag
+   */
+  type: 'tag';
+}
+
+export interface TagListResponse {
+  /**
+   * Array containing the actual response elements
+   */
+  data: Array<ConversationTag>;
+
+  /**
+   * Cursor to use for fetching the next page. Null if there are no more results.
+   */
+  nextCursor: string | null;
+
+  /**
+   * String representing the object type
+   */
+  object: 'list';
+}
+
+export interface TagDeleteResponse {
+  /**
+   * Unique tag identifier
+   */
+  id: string;
+
+  /**
+   * Whether the tag has been deleted
+   */
+  deleted: true;
+
+  /**
+   * Object type identifier
+   */
+  object: 'tag';
+}
+
+export interface TagRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface TagListParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface TagDeleteParams {
+  /**
+   * Body param: Optional admin ID for actor attribution and permission checks.
+   */
+  actingAdminId?: string;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface TagCreateOrRenameParams {
+  /**
+   * Body param: Tag name
+   */
+  name: string;
+
+  /**
+   * Body param: Optional existing tag ID. Provide this to rename an existing tag
+   * instead of creating a new one.
+   */
+  id?: string;
+
+  /**
+   * Body param: Optional admin ID for actor attribution and permission checks.
+   */
+  actingAdminId?: string;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export declare namespace Tags {
+  export {
+    type ConversationTag as ConversationTag,
+    type TagListResponse as TagListResponse,
+    type TagDeleteResponse as TagDeleteResponse,
+    type TagRetrieveParams as TagRetrieveParams,
+    type TagListParams as TagListParams,
+    type TagDeleteParams as TagDeleteParams,
+    type TagCreateOrRenameParams as TagCreateOrRenameParams,
+  };
+}

package/src/resources/teams.ts

@@ -0,0 +1,213 @@
+// 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';
+
+/**
+ * Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.
+ */
+export class Teams extends APIResource {
+  /**
+   * Retrieves a single team by its Featurebase ID.
+   *
+   * ### Path Parameters
+   *
+   * - `id` - The Featurebase internal ID of the team (MongoDB ObjectId)
+   *
+   * ### Response
+   *
+   * Returns a team object with:
+   *
+   * - `id` - Unique team identifier
+   * - `name` - Team display name
+   * - `color` - Team color in hex format
+   * - `icon` - Team icon (emoji, predefined, or external URL)
+   * - `members` - Array of admin IDs who are members of this team
+   *
+   * ### Example Response
+   *
+   * ```json
+   * {
+   *   "object": "team",
+   *   "id": "507f1f77bcf86cd799439011",
+   *   "name": "Support Team",
+   *   "color": "#3B82F6",
+   *   "icon": {
+   *     "value": "👥",
+   *     "type": "emoji"
+   *   },
+   *   "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
+   * }
+   * ```
+   *
+   * ### Error Responses
+   *
+   * - **404 Not Found** - Team 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: TeamRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Team> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/teams/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns all teams in your organization.
+   *
+   * ### Response Structure
+   *
+   * The response includes:
+   *
+   * - `object` - Always "list"
+   * - `data` - Array of team objects
+   *
+   * ### Team Object
+   *
+   * Each team includes:
+   *
+   * - `id` - Unique team identifier
+   * - `name` - Team display name
+   * - `color` - Team color in hex format
+   * - `icon` - Team icon (emoji, predefined, or external URL)
+   * - `members` - Array of admin IDs who are members of this team
+   *
+   * ### Example Response
+   *
+   * ```json
+   * {
+   *   "object": "list",
+   *   "data": [
+   *     {
+   *       "object": "team",
+   *       "id": "507f1f77bcf86cd799439011",
+   *       "name": "Support Team",
+   *       "color": "#3B82F6",
+   *       "icon": {
+   *         "value": "👥",
+   *         "type": "emoji"
+   *       },
+   *       "members": ["5fef50c5e9458a0012f82456", "5fef50c5e9458a0012f82457"]
+   *     }
+   *   ]
+   * }
+   * ```
+   *
+   * ### Version Availability
+   *
+   * This endpoint is only available in API version 2026-01-01.nova and newer.
+   */
+  list(
+    params: TeamListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TeamListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/teams', {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface Team {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Team color in hex format
+   */
+  color: string;
+
+  /**
+   * Team icon
+   */
+  icon: Team.Icon | null;
+
+  /**
+   * Array of admin IDs who are members of this team
+   */
+  members: Array<string>;
+
+  /**
+   * Team name
+   */
+  name: string;
+
+  /**
+   * Object type identifier
+   */
+  object: 'team';
+}
+
+export namespace Team {
+  /**
+   * Team icon
+   */
+  export interface Icon {
+    /**
+     * Type of icon
+     */
+    type: 'emoji' | 'predefined' | 'external';
+
+    /**
+     * Icon value
+     */
+    value: string;
+  }
+}
+
+export interface TeamListResponse {
+  /**
+   * Array of teams
+   */
+  data: Array<Team>;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+}
+
+export interface TeamRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface TeamListParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export declare namespace Teams {
+  export {
+    type Team as Team,
+    type TeamListResponse as TeamListResponse,
+    type TeamRetrieveParams as TeamRetrieveParams,
+    type TeamListParams as TeamListParams,
+  };
+}

package/src/resources/tickets/categories.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BoardsAPI from '../boards';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
+ */
+export class Categories extends APIResource {
+  /**
+   * Retrieves a single ticket category by its unique identifier.
+   *
+   * Returns the full category object including access controls, feature toggles, and
+   * localization settings.
+   *
+   * @example
+   * ```ts
+   * const board = await client.tickets.categories.retrieve(
+   *   '507f1f77bcf86cd799439011',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: CategoryRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BoardsAPI.Board> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/tickets/categories/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns all ticket categories for the authenticated organization.
+   *
+   * Ticket categories organize tickets into distinct containers. Each category can
+   * have different:
+   *
+   * - Access controls (public, private, segment-restricted)
+   * - Feature toggles (comments, posting enabled)
+   * - Custom fields
+   *
+   * Use the `supportBoard` and `supportBoardType` fields to identify ticket
+   * categories.
+   *
+   * This endpoint returns all categories without pagination.
+   *
+   * @example
+   * ```ts
+   * const boards = await client.tickets.categories.list();
+   * ```
+   */
+  list(
+    params: CategoryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CategoryListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/tickets/categories', {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type CategoryListResponse = Array<BoardsAPI.Board>;
+
+export interface CategoryRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface CategoryListParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export declare namespace Categories {
+  export {
+    type CategoryListResponse as CategoryListResponse,
+    type CategoryRetrieveParams as CategoryRetrieveParams,
+    type CategoryListParams as CategoryListParams,
+  };
+}

package/src/resources/tickets/custom-fields.ts

@@ -0,0 +1,116 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CustomFieldsAPI from '../custom-fields';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
+ */
+export class CustomFields extends APIResource {
+  /**
+   * Retrieves a single custom field by its unique identifier.
+   *
+   * ### Response
+   *
+   * Returns a custom field object with:
+   *
+   * - `id` - Unique field identifier
+   * - `label` - Field label displayed to users
+   * - `type` - Field type (text, number, select, multi-select, checkbox, date, file)
+   * - `required` - Whether the field is required
+   * - `placeholder` - Placeholder text (for text/number fields)
+   * - `public` - Whether the field value is publicly visible
+   * - `internal` - Whether the field is for internal use only
+   * - `options` - Array of options (for select/multi-select fields)
+   * - `allowMultiple` - Whether multiple files can be uploaded (file fields only)
+   *
+   * @example
+   * ```ts
+   * const customField =
+   *   await client.tickets.customFields.retrieve(
+   *     '65d26304b2e65b1e1278170c',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: CustomFieldRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomFieldsAPI.CustomField> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/tickets/custom_fields/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns all custom fields configured in your organization that can be used on
+   * tickets.
+   *
+   * This endpoint returns all custom fields at once. No pagination is supported.
+   *
+   * ### Custom Field Object
+   *
+   * Each custom field includes:
+   *
+   * - `id` - Unique field identifier
+   * - `label` - Field label displayed to users
+   * - `type` - Field type (text, number, select, multi-select, checkbox, date, file)
+   * - `required` - Whether the field is required
+   * - `placeholder` - Placeholder text (for text/number fields)
+   * - `public` - Whether the field value is publicly visible
+   * - `internal` - Whether the field is for internal use only
+   * - `options` - Array of options (for select/multi-select fields)
+   * - `allowMultiple` - Whether multiple files can be uploaded (file fields only)
+   *
+   * @example
+   * ```ts
+   * const customFieldList =
+   *   await client.tickets.customFields.list();
+   * ```
+   */
+  list(
+    params: CustomFieldListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomFieldsAPI.CustomFieldList> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/tickets/custom_fields', {
+      ...options,
+      headers: buildHeaders([
+        { ...(featurebaseVersion != null ? { 'Featurebase-Version': featurebaseVersion } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface CustomFieldRetrieveParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export interface CustomFieldListParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: string;
+}
+
+export declare namespace CustomFields {
+  export {
+    type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
+    type CustomFieldListParams as CustomFieldListParams,
+  };
+}

package/src/resources/tickets/index.ts

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Categories,
+  type CategoryListResponse,
+  type CategoryRetrieveParams,
+  type CategoryListParams,
+} from './categories';
+export { CustomFields, type CustomFieldRetrieveParams, type CustomFieldListParams } from './custom-fields';
+export {
+  Statuses,
+  type StatusListResponse,
+  type StatusRetrieveParams,
+  type StatusListParams,
+} from './statuses';
+export {
+  Tickets,
+  type AuthorInput,
+  type Ticket,
+  type TicketListResponse,
+  type TicketDeleteResponse,
+  type TicketCreateParams,
+  type TicketRetrieveParams,
+  type TicketUpdateParams,
+  type TicketListParams,
+  type TicketDeleteParams,
+  type TicketReplyParams,
+} from './tickets';