featurebase-node 0.15.2 → 0.15.3

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

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as TrainingDataAPI from './training-data';
 import * as FilesAPI from './files';
 import {
   FileCreateParams,
@@ -119,13 +120,77 @@ export class TrainingData extends APIResource {
   }
 }
 
+export interface KnowledgeMatchCandidate {
+  /**
+   * ID of the existing item
+   */
+  id: string;
+
+  /**
+   * The item's source identity, for training files and Q&A
+   */
+  externalId: string | null;
+
+  /**
+   * What kind of knowledge item matched: a Q&A entry, a training file / crawled
+   * page, or a live help-center article.
+   */
+  kind: 'qna' | 'training_file' | 'help_center_article';
+
+  /**
+   * Question variants, for Q&A entries
+   */
+  questions: Array<string> | null;
+
+  /**
+   * Q&A revision compared by the judge; null for other kinds. Use with PATCH
+   * expectedRevision.
+   */
+  revision: number | null;
+
+  /**
+   * Heading breadcrumb of the matching section, for training files
+   */
+  section: string | null;
+
+  /**
+   * Cosine similarity between the query and item. Calibrate any threshold using
+   * representative examples; it is not a correctness or contradiction score. `null`
+   * when the item was found by keywords only. Arrays are already ordered closest
+   * first.
+   */
+  similarity: number | null;
+
+  /**
+   * The item's `source` label, for Q&A entries and training files
+   */
+  source: string | null;
+
+  /**
+   * Excerpt of the existing content the judge compared against (Q&A answer, matching
+   * document section, or article body), up to 1200 characters plus an ellipsis when
+   * cut.
+   */
+  text: string;
+
+  /**
+   * Title of the existing item
+   */
+  title: string;
+
+  /**
+   * Public URL of the item when it has one
+   */
+  url: string | null;
+}
+
 export interface KnowledgeSearch {
   /**
    * Existing items closest to the query, best first, at most `topK`. `text` is an
    * excerpt focused on the query; `section` is the heading path inside a file when
    * known.
    */
-  candidates: Array<KnowledgeSearch.Candidate>;
+  candidates: Array<KnowledgeMatchCandidate>;
 
   /**
    * Object type identifier
@@ -144,70 +209,6 @@ export interface KnowledgeSearch {
 }
 
 export namespace KnowledgeSearch {
-  export interface Candidate {
-    /**
-     * ID of the existing item
-     */
-    id: string;
-
-    /**
-     * The item's source identity, for training files and Q&A
-     */
-    externalId: string | null;
-
-    /**
-     * What kind of knowledge item matched: a Q&A entry, a training file / crawled
-     * page, or a live help-center article.
-     */
-    kind: 'qna' | 'training_file' | 'help_center_article';
-
-    /**
-     * Question variants, for Q&A entries
-     */
-    questions: Array<string> | null;
-
-    /**
-     * Q&A revision compared by the judge; null for other kinds. Use with PATCH
-     * expectedRevision.
-     */
-    revision: number | null;
-
-    /**
-     * Heading breadcrumb of the matching section, for training files
-     */
-    section: string | null;
-
-    /**
-     * Cosine similarity between the query and item. Calibrate any threshold using
-     * representative examples; it is not a correctness or contradiction score. `null`
-     * when the item was found by keywords only. Arrays are already ordered closest
-     * first.
-     */
-    similarity: number | null;
-
-    /**
-     * The item's `source` label, for Q&A entries and training files
-     */
-    source: string | null;
-
-    /**
-     * Excerpt of the existing content the judge compared against (Q&A answer, matching
-     * document section, or article body), up to 1200 characters plus an ellipsis when
-     * cut.
-     */
-    text: string;
-
-    /**
-     * Title of the existing item
-     */
-    title: string;
-
-    /**
-     * Public URL of the item when it has one
-     */
-    url: string | null;
-  }
-
   /**
    * Where the time went
    */
@@ -246,7 +247,7 @@ export interface Oracle {
    * Retrieved items and the addressed entry (first when present), at most 10.
    * Excerpts are partial evidence.
    */
-  candidates: Array<Oracle.Candidate>;
+  candidates: Array<KnowledgeMatchCandidate>;
 
   /**
    * A candidate or text budget limited verification (including clipped proposed
@@ -279,6 +280,10 @@ export interface Oracle {
    */
   reason: string;
 
+  /**
+   * The existing item the action refers to, with its excerpt; `null` for `create` /
+   * `update_target`. For a `different` verdict the closest miss is `candidates[0]`.
+   */
   target: Oracle.Target;
 
   /**
@@ -297,70 +302,6 @@ export interface Oracle {
 }
 
 export namespace Oracle {
-  export interface Candidate {
-    /**
-     * ID of the existing item
-     */
-    id: string;
-
-    /**
-     * The item's source identity, for training files and Q&A
-     */
-    externalId: string | null;
-
-    /**
-     * What kind of knowledge item matched: a Q&A entry, a training file / crawled
-     * page, or a live help-center article.
-     */
-    kind: 'qna' | 'training_file' | 'help_center_article';
-
-    /**
-     * Question variants, for Q&A entries
-     */
-    questions: Array<string> | null;
-
-    /**
-     * Q&A revision compared by the judge; null for other kinds. Use with PATCH
-     * expectedRevision.
-     */
-    revision: number | null;
-
-    /**
-     * Heading breadcrumb of the matching section, for training files
-     */
-    section: string | null;
-
-    /**
-     * Cosine similarity between the query and item. Calibrate any threshold using
-     * representative examples; it is not a correctness or contradiction score. `null`
-     * when the item was found by keywords only. Arrays are already ordered closest
-     * first.
-     */
-    similarity: number | null;
-
-    /**
-     * The item's `source` label, for Q&A entries and training files
-     */
-    source: string | null;
-
-    /**
-     * Excerpt of the existing content the judge compared against (Q&A answer, matching
-     * document section, or article body), up to 1200 characters plus an ellipsis when
-     * cut.
-     */
-    text: string;
-
-    /**
-     * Title of the existing item
-     */
-    title: string;
-
-    /**
-     * Public URL of the item when it has one
-     */
-    url: string | null;
-  }
-
   /**
    * The Q&A entry addressed by externalId or a normalized question, including its
    * checked revision, or null
@@ -406,69 +347,11 @@ export namespace Oracle {
     verdict: 'same_topic' | 'contradicts' | 'different' | 'unclear';
   }
 
-  export interface Target {
-    /**
-     * ID of the existing item
-     */
-    id: string;
-
-    /**
-     * The item's source identity, for training files and Q&A
-     */
-    externalId: string | null;
-
-    /**
-     * What kind of knowledge item matched: a Q&A entry, a training file / crawled
-     * page, or a live help-center article.
-     */
-    kind: 'qna' | 'training_file' | 'help_center_article';
-
-    /**
-     * Question variants, for Q&A entries
-     */
-    questions: Array<string> | null;
-
-    /**
-     * Q&A revision compared by the judge; null for other kinds. Use with PATCH
-     * expectedRevision.
-     */
-    revision: number | null;
-
-    /**
-     * Heading breadcrumb of the matching section, for training files
-     */
-    section: string | null;
-
-    /**
-     * Cosine similarity between the query and item. Calibrate any threshold using
-     * representative examples; it is not a correctness or contradiction score. `null`
-     * when the item was found by keywords only. Arrays are already ordered closest
-     * first.
-     */
-    similarity: number | null;
-
-    /**
-     * The item's `source` label, for Q&A entries and training files
-     */
-    source: string | null;
-
-    /**
-     * Excerpt of the existing content the judge compared against (Q&A answer, matching
-     * document section, or article body), up to 1200 characters plus an ellipsis when
-     * cut.
-     */
-    text: string;
-
-    /**
-     * Title of the existing item
-     */
-    title: string;
-
-    /**
-     * Public URL of the item when it has one
-     */
-    url: string | null;
-  }
+  /**
+   * The existing item the action refers to, with its excerpt; `null` for `create` /
+   * `update_target`. For a `different` verdict the closest miss is `candidates[0]`.
+   */
+  export interface Target extends TrainingDataAPI.KnowledgeMatchCandidate {}
 
   /**
    * Where the time went
@@ -571,6 +454,7 @@ TrainingData.QnaResource = QnaResource;
 
 export declare namespace TrainingData {
   export {
+    type KnowledgeMatchCandidate as KnowledgeMatchCandidate,
     type KnowledgeSearch as KnowledgeSearch,
     type Oracle as Oracle,
     type TrainingDataOracleParams as TrainingDataOracleParams,

package/src/resources/workload.ts

@@ -0,0 +1,179 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as AdminsAPI from './organization/admins';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Live conversation workload, teammate availability, capacity limits, and managed away reasons for large support teams.
+ */
+export class Workload extends APIResource {
+  /**
+   * Returns live workspace, team, and admin workload. Admin rows use cursor
+   * pagination. teamId and adminId filter admin and team rows. The summary stays
+   * workspace-wide. The snapshot is cached for five seconds.
+   */
+  list(
+    params: WorkloadListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WorkloadListResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/workload', {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface WorkloadListResponse {
+  admins: WorkloadListResponse.Admins;
+
+  generatedAt: string;
+
+  object: 'workload';
+
+  summary: WorkloadListResponse.Summary;
+
+  teams: Array<WorkloadListResponse.Team>;
+}
+
+export namespace WorkloadListResponse {
+  export interface Admins {
+    data: Array<Admins.Data>;
+
+    nextCursor: string | null;
+
+    object: 'list';
+  }
+
+  export namespace Admins {
+    export interface Data {
+      adminId: string;
+
+      assignmentLimit: AdminsAPI.AssignmentLimit;
+
+      atCapacity: boolean;
+
+      availability: AdminsAPI.AdminAvailability;
+
+      idleCount: number;
+
+      inboxes: Array<Data.Inbox>;
+
+      object: 'workload_admin';
+
+      openCount: number;
+
+      snoozedCount: number;
+
+      waitingCount: number;
+    }
+
+    export namespace Data {
+      export interface Inbox {
+        assignmentLimit: number | null;
+
+        atCapacity: boolean;
+
+        idleCount: number;
+
+        openCount: number;
+
+        snoozedCount: number;
+
+        teamId: string;
+
+        waitingCount: number;
+      }
+    }
+  }
+
+  export interface Summary {
+    avgWaitMs: number | null;
+
+    awayReasonBreakdown: Array<Summary.AwayReasonBreakdown>;
+
+    closedToday: number;
+
+    idleConversations: number;
+
+    idleThresholdMinutes: number;
+
+    longestWaitingMs: number | null;
+
+    openConversations: number;
+
+    snoozedConversations: number;
+
+    unassignedConversations: number;
+
+    waitingConversations: number;
+
+    waitingFirstReplyConversations: number;
+  }
+
+  export namespace Summary {
+    export interface AwayReasonBreakdown {
+      count: number;
+
+      reason: string;
+    }
+  }
+
+  export interface Team {
+    assignedCount: number;
+
+    assignmentLimit: number | null;
+
+    atCapacityCount: number;
+
+    avgWaitMs: number | null;
+
+    awayCount: number;
+
+    closedToday: number;
+
+    idleCount: number;
+
+    longestWaitingMs: number | null;
+
+    memberCount: number;
+
+    name: string;
+
+    object: 'workload_team';
+
+    openCount: number;
+
+    queuedCount: number;
+
+    snoozedCount: number;
+
+    teamId: string;
+
+    waitingCount: number;
+
+    waitingFirstReplyCount: number;
+  }
+}
+
+export interface WorkloadListParams {
+  /**
+   * 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 Workload {
+  export { type WorkloadListResponse as WorkloadListResponse, type WorkloadListParams as WorkloadListParams };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.15.2'; // x-release-please-version
+export const VERSION = '0.15.3'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.15.2";
+export declare const VERSION = "0.15.3";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.15.2";
+export declare const VERSION = "0.15.3";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.15.2'; // x-release-please-version
+exports.VERSION = '0.15.3'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.15.2'; // x-release-please-version
+export const VERSION = '0.15.3'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map