featurebase-node 0.15.0 → 0.15.1

package/resources/training-data.d.ts

@@ -0,0 +1,2 @@
+export * from "./training-data/index.js";
+//# sourceMappingURL=training-data.d.ts.map

package/resources/training-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"training-data.d.ts","sourceRoot":"","sources":["../src/resources/training-data.ts"],"names":[],"mappings":"AAEA,yCAAsC"}

package/resources/training-data.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./training-data/index.js"), exports);
+//# sourceMappingURL=training-data.js.map

package/resources/training-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"training-data.js","sourceRoot":"","sources":["../src/resources/training-data.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mEAAsC"}

package/resources/training-data.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./training-data/index.mjs";
+//# sourceMappingURL=training-data.mjs.map

package/resources/training-data.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"training-data.mjs","sourceRoot":"","sources":["../src/resources/training-data.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,0CAAsC"}

package/src/client.ts

@@ -101,6 +101,13 @@ import { Feedback } from './resources/feedback/feedback';
 import { HelpCenter } from './resources/help-center/help-center';
 import { Organization } from './resources/organization/organization';
 import { Support } from './resources/support/support';
+import {
+  KnowledgeSearch,
+  Oracle,
+  TrainingData,
+  TrainingDataOracleParams,
+  TrainingDataSearchParams,
+} from './resources/training-data/training-data';
 import { Users } from './resources/users/users';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
@@ -872,6 +879,10 @@ export class Featurebase {
    * Query your workspace analytics: conversation volume, response times, CSAT, SLA compliance, teammate performance, AI agent resolutions and more. Start with the datasets catalog to discover metrics and attributes, then run queries with filters, grouping and period comparison.
    */
   reports: API.Reports = new API.Reports(this);
+  /**
+   * Training data teaches the AI agent about your product beyond your public Help Center: training files (documents, policies, internal notes) and Q&A entries (question variants with the exact answer to give). Use these endpoints to keep that knowledge in sync from your own systems — for example, pushing resolved support conversations, internal runbooks, or SOP documents automatically.
+   */
+  trainingData: API.TrainingData = new API.TrainingData(this);
 }
 
 Featurebase.Support = Support;
@@ -885,6 +896,7 @@ Featurebase.Webhooks = Webhooks;
 Featurebase.ConversationAttributes = ConversationAttributes;
 Featurebase.AuditLogs = AuditLogs;
 Featurebase.Reports = Reports;
+Featurebase.TrainingData = TrainingData;
 
 export declare namespace Featurebase {
   export type RequestOptions = Opts.RequestOptions;
@@ -985,4 +997,12 @@ export declare namespace Featurebase {
     type ReportLookupFilterValuesParams as ReportLookupFilterValuesParams,
     type ReportQueryParams as ReportQueryParams,
   };
+
+  export {
+    TrainingData as TrainingData,
+    type KnowledgeSearch as KnowledgeSearch,
+    type Oracle as Oracle,
+    type TrainingDataOracleParams as TrainingDataOracleParams,
+    type TrainingDataSearchParams as TrainingDataSearchParams,
+  };
 }

package/src/resources/audit-logs.ts

@@ -276,6 +276,12 @@ export interface AuditLogListResponse {
     | 'ai_agent.guidance_changed'
     | 'ai_agent.multilingual_changed'
     | 'ai_agent.data_context_changed'
+    | 'ai_agent.training_file_created'
+    | 'ai_agent.training_file_updated'
+    | 'ai_agent.training_file_deleted'
+    | 'ai_agent.qna_created'
+    | 'ai_agent.qna_updated'
+    | 'ai_agent.qna_deleted'
     | 'email.sending_address_created'
     | 'email.sending_address_updated'
     | 'email.sending_address_deleted'
@@ -560,6 +566,12 @@ export interface AuditLogListParams extends CursorPageParams {
     | 'ai_agent.guidance_changed'
     | 'ai_agent.multilingual_changed'
     | 'ai_agent.data_context_changed'
+    | 'ai_agent.training_file_created'
+    | 'ai_agent.training_file_updated'
+    | 'ai_agent.training_file_deleted'
+    | 'ai_agent.qna_created'
+    | 'ai_agent.qna_updated'
+    | 'ai_agent.qna_deleted'
     | 'email.sending_address_created'
     | 'email.sending_address_updated'
     | 'email.sending_address_deleted'

package/src/resources/conversation-attributes.ts

@@ -113,6 +113,12 @@ export interface ConversationAttribute {
    */
   options?: Array<ConversationAttributeOption>;
 
+  /**
+   * Whether teammates must set a value before closing a conversation from the Inbox.
+   * Closes via the API, workflows, and Fibi are not blocked.
+   */
+  required?: boolean;
+
   /**
    * ISO timestamp when the attribute was last updated.
    */

package/src/resources/index.ts

@@ -63,6 +63,13 @@ export {
   type SurveysCursorPage,
   type SurveyListResponsesResponsesCursorPage,
 } from './surveys';
+export {
+  TrainingData,
+  type KnowledgeSearch,
+  type Oracle,
+  type TrainingDataOracleParams,
+  type TrainingDataSearchParams,
+} from './training-data/training-data';
 export { Users } from './users/users';
 export {
   Webhooks,

package/src/resources/reports.ts

@@ -20,6 +20,8 @@ export class Reports extends APIResource {
    * `dataPointFilters` selecting the data point:
    *
    * - `timeBucket` — a `date` from the time series
+   * - `timeSegmentValue` + `timeSegmentGranularity` — the selected bucket from a
+   *   Segment-by-Time series
    * - `groupValue` / `segmentValue` — a `group` / `segment` value from grouped data
    * - `dayOfWeek` + `hourOfDay` — a heatmap cell (`hourly_heatmap` view)
    * - `flowPathId` or `sourceNodeId` + `targetNodeId` — a flow edge (`sankey` view)
@@ -187,14 +189,19 @@ export class Reports extends APIResource {
    * For high-cardinality breakdowns, cap the number of returned series:
    *
    * - `topValuesLimit` keeps only the top **N** `groupBy` values;
-   *   `segmentTopValuesLimit` does the same for `segmentBy`. Allowed values: **5, 7,
-   *   10, 15, 20**. `topValuesLimit` requires `groupBy`; `segmentTopValuesLimit`
-   *   requires `segmentBy`.
-   * - Members are ranked by the selected metric/aggregation over the **full filtered
-   *   primary range**, so the ranked set is **stable across every time bucket** (a
-   *   value that spikes in one bucket but is small overall does not enter the set).
-   *   A comparison period reuses the **primary period's** ranked set — it is never
-   *   re-ranked, so the legend stays identical period-over-period.
+   *   `segmentTopValuesLimit` does the same for `segmentBy`. Both accept integers
+   *   from **1 to 100**; the editor offers common presets plus a Custom value.
+   *   `topValuesLimit` requires `groupBy`; `segmentTopValuesLimit` requires
+   *   `segmentBy`.
+   * - For time-series segment breakdowns, members are ranked **inside each time
+   *   bucket**. The response keeps the union of those bucket winners in its series
+   *   catalog, while a member outside a bucket's Top N has a zero value in that
+   *   bucket. This matches the chart's per-period ranking semantics. A comparison
+   *   period is folded into the primary period's union of visible members so current
+   *   and previous series keep the same identities.
+   * - For non-time-series grouped results, members are ranked over the full filtered
+   *   primary range. A comparison period reuses the primary period's ranked set
+   *   rather than independently changing the legend.
    * - `showOther` / `segmentShowOther` append a single synthetic bucket with id
    *   `__other__` and label `Other` that sums every value outside the top set.
    *   Because the values are summed, Show Other is only supported for **additive
@@ -339,6 +346,38 @@ export interface ReportAttributeOption {
   label: string;
 
   value: string;
+
+  presentation?: ReportAttributeOption.Presentation;
+}
+
+export namespace ReportAttributeOption {
+  export interface Presentation {
+    kind:
+      | 'brand'
+      | 'company'
+      | 'country'
+      | 'knowledge_source'
+      | 'plain'
+      | 'sla'
+      | 'tag'
+      | 'team'
+      | 'teammate'
+      | 'ticket_category'
+      | 'ticket_state'
+      | 'ticket_type'
+      | 'user'
+      | 'workflow';
+
+    color?: string;
+
+    icon?: unknown;
+
+    iconSvg?: string;
+
+    imageUrl?: string;
+
+    secondaryLabel?: string;
+  }
 }
 
 export interface ReportDataset {
@@ -428,11 +467,29 @@ export interface ReportGroupedDatum {
 
   groupLabel?: string;
 
+  identity?: ReportGroupedDatum.Identity;
+
   previousValue?: number;
 
   segments?: Array<ReportSegmentDatum>;
 }
 
+export namespace ReportGroupedDatum {
+  export interface Identity {
+    id: string;
+
+    kind: 'teammate' | 'team' | 'user' | 'company' | 'fibi';
+
+    label: string;
+
+    avatarUrl?: string;
+
+    color?: string;
+
+    website?: string;
+  }
+}
+
 export interface ReportMetric {
   /**
    * Metric ID — use as `metric` in query requests.
@@ -445,6 +502,8 @@ export interface ReportMetric {
     'count' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'range' | 'percentile' | 'value'
   >;
 
+  definitionVersion: number;
+
   description: string;
 
   executionKind: 'pipe_aggregate' | 'pipe_computed_ratio';
@@ -528,11 +587,29 @@ export interface ReportSegmentDatum {
 
   value: number;
 
+  identity?: ReportSegmentDatum.Identity;
+
   previousValue?: number;
 
   segmentLabel?: string;
 }
 
+export namespace ReportSegmentDatum {
+  export interface Identity {
+    id: string;
+
+    kind: 'teammate' | 'team' | 'user' | 'company' | 'fibi';
+
+    label: string;
+
+    avatarUrl?: string;
+
+    color?: string;
+
+    website?: string;
+  }
+}
+
 export interface ReportTimeSeriesDatum {
   /**
    * Time bucket start (ISO 8601).
@@ -687,8 +764,12 @@ export interface ReportLookupFilterValuesResponse {
 
   object: 'list';
 
+  lookupContextKey?: string;
+
   nextCursor?: string;
 
+  truncated?: boolean;
+
   unavailableSelectedValues?: Array<string>;
 }
 
@@ -820,16 +901,38 @@ export namespace ReportQueryResponse {
       export interface Cells {
         display: string;
 
+        deltaPercent?: number;
+
         denominator?: number;
 
+        identity?: Cells.Identity;
+
         numerator?: number;
 
+        previousValue?: number;
+
         raw?: unknown;
 
         sortValue?: string | number | null;
 
         value?: unknown;
       }
+
+      export namespace Cells {
+        export interface Identity {
+          id: string;
+
+          kind: 'teammate' | 'team' | 'user' | 'company' | 'fibi';
+
+          label: string;
+
+          avatarUrl?: string;
+
+          color?: string;
+
+          website?: string;
+        }
+      }
     }
 
     export interface Sort {
@@ -848,16 +951,38 @@ export namespace ReportQueryResponse {
       export interface Cells {
         display: string;
 
+        deltaPercent?: number;
+
         denominator?: number;
 
+        identity?: Cells.Identity;
+
         numerator?: number;
 
+        previousValue?: number;
+
         raw?: unknown;
 
         sortValue?: string | number | null;
 
         value?: unknown;
       }
+
+      export namespace Cells {
+        export interface Identity {
+          id: string;
+
+          kind: 'teammate' | 'team' | 'user' | 'company' | 'fibi';
+
+          label: string;
+
+          avatarUrl?: string;
+
+          color?: string;
+
+          website?: string;
+        }
+      }
     }
   }
 }
@@ -1018,6 +1143,16 @@ export namespace ReportDrillInParams {
      * Time bucket to drill into (a `date` value from the query time series).
      */
     timeBucket?: string;
+
+    /**
+     * Granularity of `timeSegmentValue`; both fields must be sent together.
+     */
+    timeSegmentGranularity?: 'hour' | 'day' | 'week' | 'month';
+
+    /**
+     * Time-segment bucket selected from a Segment-by-Time series.
+     */
+    timeSegmentValue?: string;
   }
 
   export interface Sort {
@@ -1065,6 +1200,12 @@ export interface ReportLookupFilterValuesParams {
    */
   limit?: number;
 
+  /**
+   * Body param: Opaque client context echoed by the response so stale lookup results
+   * can be discarded safely.
+   */
+  lookupContextKey?: string;
+
   /**
    * Body param
    */
@@ -1177,13 +1318,14 @@ export interface ReportQueryParams {
   segmentShowOther?: boolean;
 
   /**
-   * Body param: Keep only the top N `segmentBy` values per series, ranked by the
-   * selected metric over the full filtered primary range. Under a time View-by the
-   * ranked segment set is identical across every bucket; under a dimension View-by
-   * the ranking is applied within each retained parent group. Allowed values: `5`,
-   * `7`, `10`, `15`, `20`. Requires `segmentBy`.
+   * Body param: Keep only the top N `segmentBy` values per series. Under a time
+   * View-by, segments are ranked independently inside each time bucket and the
+   * response series catalog contains the union of bucket winners. Under a dimension
+   * View-by, ranking is applied within each retained parent group. Allowed range:
+   * `1` to `100`; the editor offers common presets plus a Custom value. Requires
+   * `segmentBy`.
    */
-  segmentTopValuesLimit?: 5 | 7 | 10 | 15 | 20;
+  segmentTopValuesLimit?: number;
 
   /**
    * Body param: When `true`, append a single synthetic group with id `__other__` and
@@ -1202,12 +1344,11 @@ export interface ReportQueryParams {
 
   /**
    * Body param: Keep only the top N `groupBy` (View-by) values, ranked by the
-   * selected metric/aggregation over the full filtered primary range. Allowed
-   * values: `5`, `7`, `10`, `15`, `20`. The ranked set is stable across every time
-   * bucket, and a comparison period reuses the primary period's ranked set (never
-   * re-ranked). Requires `groupBy`.
+   * selected metric/aggregation over the full filtered primary range. Allowed range:
+   * `1` to `100`; the editor offers common presets plus a Custom value. A comparison
+   * period reuses the primary period's ranked set. Requires `groupBy`.
    */
-  topValuesLimit?: 5 | 7 | 10 | 15 | 20;
+  topValuesLimit?: number;
 
   /**
    * Body param: Result shape. `standard` returns a time series (plus grouped/segment

package/src/resources/support/conversations/conversations.ts

@@ -1546,6 +1546,12 @@ export interface ConversationAttributeValue {
    */
   options?: Array<ConversationAttributesAPI.ConversationAttributeOption>;
 
+  /**
+   * Whether teammates must set a value before closing a conversation from the Inbox.
+   * Closes via the API, workflows, and Fibi are not blocked.
+   */
+  required?: boolean;
+
   /**
    * The conversation-specific custom attribute value.
    */
@@ -2683,7 +2689,17 @@ export interface CsatEmailDelivery {
   /**
    * Email delivery status for the CSAT request when applicable
    */
-  status: 'pending' | 'sent' | 'failed';
+  status: 'pending' | 'sending' | 'ambiguous' | 'retry_wait' | 'sent' | 'failed';
+
+  /**
+   * Number of delivery attempts made for this CSAT email
+   */
+  attempts?: number;
+
+  /**
+   * ISO timestamp when the current delivery attempt was durably claimed
+   */
+  claimedAt?: string;
 
   /**
    * ISO timestamp when the CSAT email failed
@@ -2695,11 +2711,21 @@ export interface CsatEmailDelivery {
    */
   failureReason?: string;
 
+  /**
+   * Stable provider-correlation key for this CSAT delivery
+   */
+  idempotencyKey?: string;
+
   /**
    * Email message ID associated with delivery
    */
   messageId?: string;
 
+  /**
+   * ISO timestamp when a retry-waiting CSAT email may be attempted again
+   */
+  nextAttemptAt?: string;
+
   /**
    * ISO timestamp when the CSAT email was sent
    */