featurebase-node 0.15.2 → 0.15.3

package/src/resources/organization/admins.ts

@@ -1,14 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as AdminsAPI from './admins';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
-/**
- * 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.
@@ -179,6 +177,75 @@ export class Admins extends APIResource {
       ]),
     });
   }
+
+  /**
+   * Updates the admin capacity mode or paused state. mode can be inherit, custom, or
+   * unlimited. custom requires limit. Omitted fields keep their current value.
+   */
+  updateAssignmentLimit(
+    id: string,
+    params: AdminUpdateAssignmentLimitParams,
+    options?: RequestOptions,
+  ): APIPromise<AssignmentLimit> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.patch(path`/v2/admins/${id}/assignment-limit`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Updates an admin away state. awayReasonId uses a stable managed-reason ID. Omit
+   * it to preserve the current reason, or send null to clear the reason.
+   */
+  updateAway(
+    id: string,
+    params: AdminUpdateAwayParams,
+    options?: RequestOptions,
+  ): APIPromise<AdminAvailability> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.patch(path`/v2/admins/${id}/away`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Atomically updates away state or assignment limits for up to 50 admins. One
+   * request performs one operation type. Assignment-limit operations require an
+   * explicit paused value.
+   */
+  updateBulk(params: AdminUpdateBulkParams, options?: RequestOptions): APIPromise<AdminUpdateBulkResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.patch('/v2/admins/bulk', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
 }
 
 export interface Admin {
@@ -213,6 +280,46 @@ export interface Admin {
   roleId?: string;
 }
 
+export interface AdminAvailability {
+  adminId: string;
+
+  automatic: boolean;
+
+  away: boolean;
+
+  changedAt: string | null;
+
+  lastActiveAt: string | null;
+
+  object: 'admin_availability';
+
+  reason: AdminAvailability.Reason | null;
+
+  reassignReplies: boolean;
+}
+
+export namespace AdminAvailability {
+  export interface Reason {
+    id: string | null;
+
+    label: string;
+  }
+}
+
+export interface AssignmentLimit {
+  adminId: string;
+
+  effectiveLimit: number | null;
+
+  limit: number | null;
+
+  mode: 'inherit' | 'custom' | 'unlimited';
+
+  object: 'assignment_limit';
+
+  paused: boolean;
+}
+
 export interface AdminListResponse {
   /**
    * Array of admins
@@ -545,6 +652,28 @@ export namespace AdminListRolesResponse {
   }
 }
 
+export interface AdminUpdateBulkResponse {
+  data: Array<AdminUpdateBulkResponse.Data>;
+
+  object: 'bulk_result';
+
+  operation: 'away' | 'assignment_limit';
+
+  updatedCount: number;
+}
+
+export namespace AdminUpdateBulkResponse {
+  export interface Data {
+    adminId: string;
+
+    assignmentLimit: AdminsAPI.AssignmentLimit;
+
+    availability: AdminsAPI.AdminAvailability;
+
+    object: 'admin_workload_state';
+  }
+}
+
 export interface AdminRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -569,13 +698,135 @@ export interface AdminListRolesParams {
   'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
+export interface AdminUpdateAssignmentLimitParams {
+  /**
+   * Body param
+   */
+  limit?: number;
+
+  /**
+   * Body param
+   */
+  mode?: 'inherit' | 'custom' | 'unlimited';
+
+  /**
+   * Body param
+   */
+  paused?: boolean;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+
+export interface AdminUpdateAwayParams {
+  /**
+   * Body param
+   */
+  enabled: boolean;
+
+  /**
+   * Body param
+   */
+  awayReasonId?: string | null;
+
+  /**
+   * Body param
+   */
+  reassignReplies?: boolean;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+
+export type AdminUpdateBulkParams = AdminUpdateBulkParams.Variant0 | AdminUpdateBulkParams.Variant1;
+
+export declare namespace AdminUpdateBulkParams {
+  export interface Variant0 {
+    /**
+     * Body param
+     */
+    adminIds: Array<string>;
+
+    /**
+     * Body param
+     */
+    enabled: boolean;
+
+    /**
+     * Body param
+     */
+    operation: 'away';
+
+    /**
+     * Body param
+     */
+    awayReasonId?: string | null;
+
+    /**
+     * Body param
+     */
+    reassignReplies?: boolean;
+
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+  }
+
+  export interface Variant1 {
+    /**
+     * Body param
+     */
+    adminIds: Array<string>;
+
+    /**
+     * Body param
+     */
+    operation: 'assignment_limit';
+
+    /**
+     * Body param
+     */
+    paused: boolean;
+
+    /**
+     * Body param
+     */
+    limit?: number;
+
+    /**
+     * Body param
+     */
+    mode?: 'inherit' | 'custom' | 'unlimited';
+
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+  }
+}
+
 export declare namespace Admins {
   export {
     type Admin as Admin,
+    type AdminAvailability as AdminAvailability,
+    type AssignmentLimit as AssignmentLimit,
     type AdminListResponse as AdminListResponse,
     type AdminListRolesResponse as AdminListRolesResponse,
+    type AdminUpdateBulkResponse as AdminUpdateBulkResponse,
     type AdminRetrieveParams as AdminRetrieveParams,
     type AdminListParams as AdminListParams,
     type AdminListRolesParams as AdminListRolesParams,
+    type AdminUpdateAssignmentLimitParams as AdminUpdateAssignmentLimitParams,
+    type AdminUpdateAwayParams as AdminUpdateAwayParams,
+    type AdminUpdateBulkParams as AdminUpdateBulkParams,
   };
 }

package/src/resources/organization/index.ts

@@ -3,11 +3,17 @@
 export {
   Admins,
   type Admin,
+  type AdminAvailability,
+  type AssignmentLimit,
   type AdminListResponse,
   type AdminListRolesResponse,
+  type AdminUpdateBulkResponse,
   type AdminRetrieveParams,
   type AdminListParams,
   type AdminListRolesParams,
+  type AdminUpdateAssignmentLimitParams,
+  type AdminUpdateAwayParams,
+  type AdminUpdateBulkParams,
 } from './admins';
 export {
   Brands,
@@ -21,6 +27,8 @@ export {
   Teams,
   type Team,
   type TeamListResponse,
+  type TeamRetrieveMetricsResponse,
   type TeamRetrieveParams,
   type TeamListParams,
+  type TeamRetrieveMetricsParams,
 } from './teams';

package/src/resources/organization/organization.ts

@@ -4,17 +4,31 @@ import { APIResource } from '../../core/resource';
 import * as AdminsAPI from './admins';
 import {
   Admin,
+  AdminAvailability,
   AdminListParams,
   AdminListResponse,
   AdminListRolesParams,
   AdminListRolesResponse,
   AdminRetrieveParams,
+  AdminUpdateAssignmentLimitParams,
+  AdminUpdateAwayParams,
+  AdminUpdateBulkParams,
+  AdminUpdateBulkResponse,
   Admins,
+  AssignmentLimit,
 } from './admins';
 import * as BrandsAPI from './brands';
 import { Brand, BrandListParams, BrandRetrieveParams, Brands, BrandsCursorPage } from './brands';
 import * as TeamsAPI from './teams';
-import { Team, TeamListParams, TeamListResponse, TeamRetrieveParams, Teams } from './teams';
+import {
+  Team,
+  TeamListParams,
+  TeamListResponse,
+  TeamRetrieveMetricsParams,
+  TeamRetrieveMetricsResponse,
+  TeamRetrieveParams,
+  Teams,
+} from './teams';
 
 export class Organization extends APIResource {
   admins: AdminsAPI.Admins = new AdminsAPI.Admins(this._client);
@@ -30,19 +44,27 @@ export declare namespace Organization {
   export {
     Admins as Admins,
     type Admin as Admin,
+    type AdminAvailability as AdminAvailability,
+    type AssignmentLimit as AssignmentLimit,
     type AdminListResponse as AdminListResponse,
     type AdminListRolesResponse as AdminListRolesResponse,
+    type AdminUpdateBulkResponse as AdminUpdateBulkResponse,
     type AdminRetrieveParams as AdminRetrieveParams,
     type AdminListParams as AdminListParams,
     type AdminListRolesParams as AdminListRolesParams,
+    type AdminUpdateAssignmentLimitParams as AdminUpdateAssignmentLimitParams,
+    type AdminUpdateAwayParams as AdminUpdateAwayParams,
+    type AdminUpdateBulkParams as AdminUpdateBulkParams,
   };
 
   export {
     Teams as Teams,
     type Team as Team,
     type TeamListResponse as TeamListResponse,
+    type TeamRetrieveMetricsResponse as TeamRetrieveMetricsResponse,
     type TeamRetrieveParams as TeamRetrieveParams,
     type TeamListParams as TeamListParams,
+    type TeamRetrieveMetricsParams as TeamRetrieveMetricsParams,
   };
 
   export {

package/src/resources/organization/teams.ts

@@ -6,9 +6,6 @@ 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.
@@ -132,6 +129,29 @@ export class Teams extends APIResource {
       ]),
     });
   }
+
+  /**
+   * Returns Intercom-style per-admin team metrics with open, snoozed, waiting, idle,
+   * capacity limit, pause, and away state. Results use cursor pagination.
+   */
+  retrieveMetrics(
+    id: string,
+    params: TeamRetrieveMetricsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TeamRetrieveMetricsResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get(path`/v2/teams/${id}/metrics`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
 }
 
 export interface Team {
@@ -195,6 +215,42 @@ export interface TeamListResponse {
   object: 'list';
 }
 
+export interface TeamRetrieveMetricsResponse {
+  data: Array<TeamRetrieveMetricsResponse.Data>;
+
+  generatedAt: string;
+
+  nextCursor: string | null;
+
+  object: 'team_metrics';
+
+  teamId: string;
+}
+
+export namespace TeamRetrieveMetricsResponse {
+  export interface Data {
+    adminId: string;
+
+    assignmentLimit: number | null;
+
+    atCapacity: boolean;
+
+    away: boolean;
+
+    idleCount: number;
+
+    object: 'team_admin_metrics';
+
+    openCount: number;
+
+    paused: boolean;
+
+    snoozedCount: number;
+
+    waitingCount: number;
+  }
+}
+
 export interface TeamRetrieveParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -211,11 +267,21 @@ export interface TeamListParams {
   'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
 }
 
+export interface TeamRetrieveMetricsParams {
+  /**
+   * API version for this request. Defaults to your organization's configured API
+   * version if not specified.
+   */
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+
 export declare namespace Teams {
   export {
     type Team as Team,
     type TeamListResponse as TeamListResponse,
+    type TeamRetrieveMetricsResponse as TeamRetrieveMetricsResponse,
     type TeamRetrieveParams as TeamRetrieveParams,
     type TeamListParams as TeamListParams,
+    type TeamRetrieveMetricsParams as TeamRetrieveMetricsParams,
   };
 }

package/src/resources/reports.ts

@@ -64,6 +64,45 @@ export class Reports extends APIResource {
     });
   }
 
+  /**
+   * Returns the filter attribute IDs supported by the selected metric and optional
+   * grouping route.
+   *
+   * Use this operation before constructing metric-level filters. It applies the same
+   * routing rules as the dashboard and prevents clients from offering filters that
+   * the selected metric, group, or segment path cannot execute.
+   *
+   * ### Version Availability
+   *
+   * This endpoint is only available in API version 2026-01-01.nova and newer, and
+   * only for workspaces with the Reports product enabled (404 otherwise).
+   *
+   * @example
+   * ```ts
+   * const response = await client.reports.filterCapabilities({
+   *   metricId: 'x',
+   * });
+   * ```
+   */
+  filterCapabilities(
+    params: ReportFilterCapabilitiesParams,
+    options?: RequestOptions,
+  ): APIPromise<ReportFilterCapabilitiesResponse> {
+    const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
+    return this._client.post('/v2/reports/filter-capabilities', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
   /**
    * Returns the reporting catalog: every dataset available to your workspace with
    * its metrics and attributes.
@@ -753,6 +792,12 @@ export namespace ReportDrillInResponse {
   }
 }
 
+export interface ReportFilterCapabilitiesResponse {
+  object: 'report_metric_filter_capabilities';
+
+  supportedFilterAttributeIds: Array<string>;
+}
+
 export interface ReportListDatasetsResponse {
   data: Array<ReportDataset>;
 
@@ -1165,6 +1210,29 @@ export namespace ReportDrillInParams {
   }
 }
 
+export interface ReportFilterCapabilitiesParams {
+  /**
+   * Body param
+   */
+  metricId: string;
+
+  /**
+   * Body param
+   */
+  groupBy?: string;
+
+  /**
+   * Body param
+   */
+  segmentBy?: string;
+
+  /**
+   * Header param: API version for this request. Defaults to your organization's
+   * configured API version if not specified.
+   */
+  'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
+}
+
 export interface ReportListDatasetsParams {
   /**
    * API version for this request. Defaults to your organization's configured API
@@ -1377,10 +1445,12 @@ export declare namespace Reports {
     type ReportSegmentDatum as ReportSegmentDatum,
     type ReportTimeSeriesDatum as ReportTimeSeriesDatum,
     type ReportDrillInResponse as ReportDrillInResponse,
+    type ReportFilterCapabilitiesResponse as ReportFilterCapabilitiesResponse,
     type ReportListDatasetsResponse as ReportListDatasetsResponse,
     type ReportLookupFilterValuesResponse as ReportLookupFilterValuesResponse,
     type ReportQueryResponse as ReportQueryResponse,
     type ReportDrillInParams as ReportDrillInParams,
+    type ReportFilterCapabilitiesParams as ReportFilterCapabilitiesParams,
     type ReportListDatasetsParams as ReportListDatasetsParams,
     type ReportLookupFilterValuesParams as ReportLookupFilterValuesParams,
     type ReportQueryParams as ReportQueryParams,

package/src/resources/training-data/index.ts

@@ -24,6 +24,7 @@ export {
 } from './qna';
 export {
   TrainingData,
+  type KnowledgeMatchCandidate,
   type KnowledgeSearch,
   type Oracle,
   type TrainingDataOracleParams,