featurebase-node 0.15.0 → 0.15.2

package/src/resources/index.ts

@@ -10,6 +10,7 @@ export {
   Changelogs,
   type Changelog,
   type PublishUnpublishSuccess,
+  type ChangelogRetrieveResponse,
   type ChangelogDeleteResponse,
   type ChangelogCreateParams,
   type ChangelogRetrieveParams,
@@ -63,6 +64,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
    */

package/src/resources/support/tickets/tickets.ts

@@ -368,9 +368,11 @@ export class Tickets extends APIResource {
 export type TicketsCursorPage = CursorPage<Ticket>;
 
 /**
- * Author to attribute the post to. If not provided, uses the authenticated user.
- * Supports multiple identification methods: id (Featurebase ID), userId (external
- * SSO ID), or email.
+ * Author to attribute the post to. If not provided, uses the authenticated user —
+ * unless `source` is given, in which case a guest author is synthesised from
+ * `source.label` (or the channel name), because a relayed request belongs to the
+ * customer who said it. Supports multiple identification methods: id (Featurebase
+ * ID), userId (external SSO ID), or email.
  */
 export interface AuthorInput {
   /**
@@ -713,8 +715,10 @@ export interface TicketDeleteResponse {
 export interface TicketCreateParams {
   /**
    * Body param: Author to attribute the post to. If not provided, uses the
-   * authenticated user. Supports multiple identification methods: id (Featurebase
-   * ID), userId (external SSO ID), or email.
+   * authenticated user — unless `source` is given, in which case a guest author is
+   * synthesised from `source.label` (or the channel name), because a relayed request
+   * belongs to the customer who said it. Supports multiple identification methods:
+   * id (Featurebase ID), userId (external SSO ID), or email.
    */
   author: AuthorInput;