featurebase-node 0.15.2 → 0.15.3

package/src/client.ts

@@ -31,6 +31,11 @@ import {
   AuditLogListResponsesCursorPage,
   AuditLogs,
 } from './resources/audit-logs';
+import {
+  AwayReasonRetrieveAwayReasonsParams,
+  AwayReasonRetrieveAwayReasonsResponse,
+  AwayReasons,
+} from './resources/away-reasons';
 import {
   ConversationAttribute,
   ConversationAttributeListParams,
@@ -45,6 +50,8 @@ import {
   ReportDataset,
   ReportDrillInParams,
   ReportDrillInResponse,
+  ReportFilterCapabilitiesParams,
+  ReportFilterCapabilitiesResponse,
   ReportFilterExpression,
   ReportFilterRule,
   ReportGroupedDatum,
@@ -83,6 +90,7 @@ import {
   Webhooks,
   WebhooksCursorPage,
 } from './resources/webhooks';
+import { Workload, WorkloadListParams, WorkloadListResponse } from './resources/workload';
 import {
   Changelog,
   ChangelogCreateParams,
@@ -103,6 +111,7 @@ import { HelpCenter } from './resources/help-center/help-center';
 import { Organization } from './resources/organization/organization';
 import { Support } from './resources/support/support';
 import {
+  KnowledgeMatchCandidate,
   KnowledgeSearch,
   Oracle,
   TrainingData,
@@ -884,6 +893,14 @@ export class Featurebase {
    * 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);
+  /**
+   * Live conversation workload, teammate availability, capacity limits, and managed away reasons for large support teams.
+   */
+  workload: API.Workload = new API.Workload(this);
+  /**
+   * Live conversation workload, teammate availability, capacity limits, and managed away reasons for large support teams.
+   */
+  awayReasons: API.AwayReasons = new API.AwayReasons(this);
 }
 
 Featurebase.Support = Support;
@@ -898,6 +915,8 @@ Featurebase.ConversationAttributes = ConversationAttributes;
 Featurebase.AuditLogs = AuditLogs;
 Featurebase.Reports = Reports;
 Featurebase.TrainingData = TrainingData;
+Featurebase.Workload = Workload;
+Featurebase.AwayReasons = AwayReasons;
 
 export declare namespace Featurebase {
   export type RequestOptions = Opts.RequestOptions;
@@ -991,10 +1010,12 @@ export declare namespace Featurebase {
     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,
@@ -1002,9 +1023,22 @@ export declare namespace Featurebase {
 
   export {
     TrainingData as TrainingData,
+    type KnowledgeMatchCandidate as KnowledgeMatchCandidate,
     type KnowledgeSearch as KnowledgeSearch,
     type Oracle as Oracle,
     type TrainingDataOracleParams as TrainingDataOracleParams,
     type TrainingDataSearchParams as TrainingDataSearchParams,
   };
+
+  export {
+    Workload as Workload,
+    type WorkloadListResponse as WorkloadListResponse,
+    type WorkloadListParams as WorkloadListParams,
+  };
+
+  export {
+    AwayReasons as AwayReasons,
+    type AwayReasonRetrieveAwayReasonsResponse as AwayReasonRetrieveAwayReasonsResponse,
+    type AwayReasonRetrieveAwayReasonsParams as AwayReasonRetrieveAwayReasonsParams,
+  };
 }

package/src/resources/away-reasons.ts

@@ -0,0 +1,68 @@
+// 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';
+
+/**
+ * Live conversation workload, teammate availability, capacity limits, and managed away reasons for large support teams.
+ */
+export class AwayReasons extends APIResource {
+  /**
+   * Returns active managed away reasons. Set includeArchived=true to include
+   * historical reasons.
+   */
+  retrieveAwayReasons(
+    params: AwayReasonRetrieveAwayReasonsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AwayReasonRetrieveAwayReasonsResponse> {
+    const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
+    return this._client.get('/v2/away-reasons', {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(featurebaseVersion?.toString() != null ?
+            { 'Featurebase-Version': featurebaseVersion?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface AwayReasonRetrieveAwayReasonsResponse {
+  data: Array<AwayReasonRetrieveAwayReasonsResponse.Data>;
+
+  nextCursor: null;
+
+  object: 'list';
+}
+
+export namespace AwayReasonRetrieveAwayReasonsResponse {
+  export interface Data {
+    id: string;
+
+    archived: boolean;
+
+    label: string;
+
+    object: 'away_reason';
+  }
+}
+
+export interface AwayReasonRetrieveAwayReasonsParams {
+  /**
+   * 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 AwayReasons {
+  export {
+    type AwayReasonRetrieveAwayReasonsResponse as AwayReasonRetrieveAwayReasonsResponse,
+    type AwayReasonRetrieveAwayReasonsParams as AwayReasonRetrieveAwayReasonsParams,
+  };
+}

package/src/resources/feedback/feedback.ts

@@ -45,8 +45,10 @@ import {
   PostDeleteParams,
   PostDeleteResponse,
   PostFeatures,
+  PostList,
   PostListParams,
   PostMergeParams,
+  PostProcessing,
   PostRetrieveParams,
   PostSearchParams,
   PostSearchResponse,
@@ -88,6 +90,8 @@ export declare namespace Feedback {
     type PostAccess as PostAccess,
     type PostAuthor as PostAuthor,
     type PostFeatures as PostFeatures,
+    type PostList as PostList,
+    type PostProcessing as PostProcessing,
     type PostTag as PostTag,
     type SearchFilter as SearchFilter,
     type SearchFilterGroup as SearchFilterGroup,

package/src/resources/feedback/index.ts

@@ -44,6 +44,8 @@ export {
   type PostAccess,
   type PostAuthor,
   type PostFeatures,
+  type PostList,
+  type PostProcessing,
   type PostTag,
   type SearchFilter,
   type SearchFilterGroup,

package/src/resources/feedback/posts/index.ts

@@ -13,6 +13,8 @@ export {
   type PostAccess,
   type PostAuthor,
   type PostFeatures,
+  type PostList,
+  type PostProcessing,
   type PostTag,
   type SearchFilter,
   type SearchFilterGroup,

package/src/resources/feedback/posts/posts.ts

@@ -945,7 +945,7 @@ export interface Post {
    * the create returned), with `results` listing what was made of the submission
    * once the run has finished.
    */
-  processing?: Post.Processing;
+  processing?: PostProcessing;
 }
 
 export namespace Post {
@@ -1157,107 +1157,6 @@ export namespace Post {
       objectType: 'Opportunity' | 'Case';
     }
   }
-
-  /**
-   * On POST /v2/posts — `queued`: a processing run (claim extraction or the Organize
-   * rewrite) was enqueued and its result lands asynchronously on the post.
-   * `skipped`: nothing was enqueued; `reason` says which gate decided
-   * ('request_mode' for every intakeMode: 'request' create). `existing`: the create
-   * was an idempotent replay and the post was not processed again. On GET
-   * /v2/posts/{id} this field is present only for posts created with
-   * `intakeMode: 'feedback'` and reports how far that processing has got ('queued',
-   * 'processing', 'complete', 'needs_review', or 'skipped' with the same `reason`
-   * the create returned), with `results` listing what was made of the submission
-   * once the run has finished.
-   */
-  export interface Processing {
-    /**
-     * 'queued' = an AI run was enqueued and has not landed yet; 'processing' = the run
-     * is working on the submission; 'complete' = it finished and `results` lists what
-     * it produced; 'needs_review' = it finished and a teammate still has to decide
-     * something; 'skipped' = nothing was enqueued (see `reason`); 'existing' =
-     * idempotent replay, not processed again.
-     */
-    status: 'queued' | 'processing' | 'complete' | 'needs_review' | 'skipped' | 'existing';
-
-    /**
-     * Why processing was skipped. 'request_mode' = intakeMode was 'request' (the
-     * default); 'autopilot_off' = the workspace's Autopilot dial is off or its plan
-     * does not include it; 'pipeline_paused' = the platform paused AI processing (it
-     * resumes automatically); 'support_board' / 'spam_held' / 'staff_authored' /
-     * 'no_content' = the post did not qualify; 'source_too_long' = the text was over
-     * the length limit when the run read it (a create that long is normally refused
-     * with a 400 first); 'extraction_failed' = the AI could not read the text after
-     * repeated attempts; nothing was written, and opening the post in Triage runs the
-     * analysis again.
-     */
-    reason?:
-      | 'request_mode'
-      | 'autopilot_off'
-      | 'insights_disabled'
-      | 'pipeline_paused'
-      | 'support_board'
-      | 'spam_held'
-      | 'staff_authored'
-      | 'not_a_post'
-      | 'no_board'
-      | 'no_id'
-      | 'no_content'
-      | 'source_too_long'
-      | 'extraction_failed'
-      | 'hook_error';
-
-    /**
-     * What the workspace's "Organize submissions" lane made of this submission, one
-     * entry per ask it found, in the order they appear in the text. Present on GET
-     * /v2/posts/{id} for posts created with `intakeMode: 'feedback'` once the run has
-     * finished. Absent while the run is still working, and absent for workspaces that
-     * do not organize submissions — there the post itself is the request.
-     */
-    results?: Array<Processing.Result>;
-  }
-
-  export namespace Processing {
-    export interface Result {
-      /**
-       * 'request' = the ask became a request of its own; 'attached' = it was added as
-       * evidence to a request that already existed; 'held' = it became a request that is
-       * waiting for a teammate to publish it; 'question' = it asked something and no
-       * request was created, so a teammate answers it.
-       */
-      outcome: 'attached' | 'request' | 'question' | 'held';
-
-      /**
-       * The ask, as it was written up.
-       */
-      title: string;
-
-      /**
-       * The request this ask became, or was attached to. Absent for a question, and
-       * absent when the request is not readable through this API (for example a ticket
-       * board).
-       */
-      postId?: string;
-
-      /**
-       * Title of `postId`.
-       */
-      postTitle?: string;
-
-      /**
-       * Why a 'held' result is waiting for a teammate. Only on a 'held' result, and only
-       * one of these codes: 'too_many_topics' = the submission held more separate asks
-       * than one submission can become requests, so this one request lists the asks that
-       * did not fit, one line each in the customer's words; 'uncertain' = the ask was
-       * too vague to file without a person; 'custom_fields' = the board requires custom
-       * fields this submission did not carry; 'processing_failed' = the AI could not
-       * rewrite the text (the request then holds the original words) or could not check
-       * this ask against existing requests, so a teammate confirms it is not a
-       * duplicate.
-       */
-      reason?: 'too_many_topics' | 'uncertain' | 'custom_fields' | 'processing_failed';
-    }
-  }
 }
 
 export interface PostAccess {
@@ -1310,6 +1209,156 @@ export interface PostFeatures {
   commentsEnabled: boolean;
 }
 
+export interface PostList {
+  /**
+   * Array of posts
+   */
+  data: Array<Post>;
+
+  /**
+   * Cursor for fetching the next page (cursor-based pagination)
+   */
+  nextCursor: string | null;
+
+  /**
+   * Object type identifier
+   */
+  object: 'list';
+
+  /**
+   * Pagination metadata for page-based requests
+   */
+  pagination?: PostList.Pagination;
+}
+
+export namespace PostList {
+  /**
+   * Pagination metadata for page-based requests
+   */
+  export interface Pagination {
+    /**
+     * Items per page
+     */
+    limit: number;
+
+    /**
+     * Current page number
+     */
+    page: number;
+
+    /**
+     * Total number of items
+     */
+    total: number;
+
+    /**
+     * Total number of pages
+     */
+    totalPages: number;
+  }
+}
+
+/**
+ * On POST /v2/posts — `queued`: a processing run (claim extraction or the Organize
+ * rewrite) was enqueued and its result lands asynchronously on the post.
+ * `skipped`: nothing was enqueued; `reason` says which gate decided
+ * ('request_mode' for every intakeMode: 'request' create). `existing`: the create
+ * was an idempotent replay and the post was not processed again. On GET
+ * /v2/posts/{id} this field is present only for posts created with
+ * `intakeMode: 'feedback'` and reports how far that processing has got ('queued',
+ * 'processing', 'complete', 'needs_review', or 'skipped' with the same `reason`
+ * the create returned), with `results` listing what was made of the submission
+ * once the run has finished.
+ */
+export interface PostProcessing {
+  /**
+   * 'queued' = an AI run was enqueued and has not landed yet; 'processing' = the run
+   * is working on the submission; 'complete' = it finished and `results` lists what
+   * it produced; 'needs_review' = it finished and a teammate still has to decide
+   * something; 'skipped' = nothing was enqueued (see `reason`); 'existing' =
+   * idempotent replay, not processed again.
+   */
+  status: 'queued' | 'processing' | 'complete' | 'needs_review' | 'skipped' | 'existing';
+
+  /**
+   * Why processing was skipped. 'request_mode' = intakeMode was 'request' (the
+   * default); 'autopilot_off' = the workspace's Autopilot dial is off or its plan
+   * does not include it; 'pipeline_paused' = the platform paused AI processing (it
+   * resumes automatically); 'support_board' / 'spam_held' / 'staff_authored' /
+   * 'no_content' = the post did not qualify; 'source_too_long' = the text was over
+   * the length limit when the run read it (a create that long is normally refused
+   * with a 400 first); 'extraction_failed' = the AI could not read the text after
+   * repeated attempts; nothing was written, and opening the post in Triage runs the
+   * analysis again.
+   */
+  reason?:
+    | 'request_mode'
+    | 'autopilot_off'
+    | 'insights_disabled'
+    | 'pipeline_paused'
+    | 'support_board'
+    | 'spam_held'
+    | 'staff_authored'
+    | 'not_a_post'
+    | 'no_board'
+    | 'no_id'
+    | 'no_content'
+    | 'source_too_long'
+    | 'extraction_failed'
+    | 'hook_error';
+
+  /**
+   * What the workspace's "Organize submissions" lane made of this submission, one
+   * entry per ask it found, in the order they appear in the text. Present on GET
+   * /v2/posts/{id} for posts created with `intakeMode: 'feedback'` once the run has
+   * finished. Absent while the run is still working, and absent for workspaces that
+   * do not organize submissions — there the post itself is the request.
+   */
+  results?: Array<PostProcessing.Result>;
+}
+
+export namespace PostProcessing {
+  export interface Result {
+    /**
+     * 'request' = the ask became a request of its own; 'attached' = it was added as
+     * evidence to a request that already existed; 'held' = it became a request that is
+     * waiting for a teammate to publish it; 'question' = it asked something and no
+     * request was created, so a teammate answers it.
+     */
+    outcome: 'attached' | 'request' | 'question' | 'held';
+
+    /**
+     * The ask, as it was written up.
+     */
+    title: string;
+
+    /**
+     * The request this ask became, or was attached to. Absent for a question, and
+     * absent when the request is not readable through this API (for example a ticket
+     * board).
+     */
+    postId?: string;
+
+    /**
+     * Title of `postId`.
+     */
+    postTitle?: string;
+
+    /**
+     * Why a 'held' result is waiting for a teammate. Only on a 'held' result, and only
+     * one of these codes: 'too_many_topics' = the submission held more separate asks
+     * than one submission can become requests, so this one request lists the asks that
+     * did not fit, one line each in the customer's words; 'uncertain' = the ask was
+     * too vague to file without a person; 'custom_fields' = the board requires custom
+     * fields this submission did not carry; 'processing_failed' = the AI could not
+     * rewrite the text (the request then holds the original words) or could not check
+     * this ask against existing requests, so a teammate confirms it is not a
+     * duplicate.
+     */
+    reason?: 'too_many_topics' | 'uncertain' | 'custom_fields' | 'processing_failed';
+  }
+}
+
 export interface PostTag {
   /**
    * Tag unique identifier
@@ -1581,7 +1630,7 @@ export namespace PostSearchResponse {
      * the create returned), with `results` listing what was made of the submission
      * once the run has finished.
      */
-    processing?: Data.Processing;
+    processing?: PostsAPI.PostProcessing;
   }
 
   export namespace Data {
@@ -1793,107 +1842,6 @@ export namespace PostSearchResponse {
         objectType: 'Opportunity' | 'Case';
       }
     }
-
-    /**
-     * On POST /v2/posts — `queued`: a processing run (claim extraction or the Organize
-     * rewrite) was enqueued and its result lands asynchronously on the post.
-     * `skipped`: nothing was enqueued; `reason` says which gate decided
-     * ('request_mode' for every intakeMode: 'request' create). `existing`: the create
-     * was an idempotent replay and the post was not processed again. On GET
-     * /v2/posts/{id} this field is present only for posts created with
-     * `intakeMode: 'feedback'` and reports how far that processing has got ('queued',
-     * 'processing', 'complete', 'needs_review', or 'skipped' with the same `reason`
-     * the create returned), with `results` listing what was made of the submission
-     * once the run has finished.
-     */
-    export interface Processing {
-      /**
-       * 'queued' = an AI run was enqueued and has not landed yet; 'processing' = the run
-       * is working on the submission; 'complete' = it finished and `results` lists what
-       * it produced; 'needs_review' = it finished and a teammate still has to decide
-       * something; 'skipped' = nothing was enqueued (see `reason`); 'existing' =
-       * idempotent replay, not processed again.
-       */
-      status: 'queued' | 'processing' | 'complete' | 'needs_review' | 'skipped' | 'existing';
-
-      /**
-       * Why processing was skipped. 'request_mode' = intakeMode was 'request' (the
-       * default); 'autopilot_off' = the workspace's Autopilot dial is off or its plan
-       * does not include it; 'pipeline_paused' = the platform paused AI processing (it
-       * resumes automatically); 'support_board' / 'spam_held' / 'staff_authored' /
-       * 'no_content' = the post did not qualify; 'source_too_long' = the text was over
-       * the length limit when the run read it (a create that long is normally refused
-       * with a 400 first); 'extraction_failed' = the AI could not read the text after
-       * repeated attempts; nothing was written, and opening the post in Triage runs the
-       * analysis again.
-       */
-      reason?:
-        | 'request_mode'
-        | 'autopilot_off'
-        | 'insights_disabled'
-        | 'pipeline_paused'
-        | 'support_board'
-        | 'spam_held'
-        | 'staff_authored'
-        | 'not_a_post'
-        | 'no_board'
-        | 'no_id'
-        | 'no_content'
-        | 'source_too_long'
-        | 'extraction_failed'
-        | 'hook_error';
-
-      /**
-       * What the workspace's "Organize submissions" lane made of this submission, one
-       * entry per ask it found, in the order they appear in the text. Present on GET
-       * /v2/posts/{id} for posts created with `intakeMode: 'feedback'` once the run has
-       * finished. Absent while the run is still working, and absent for workspaces that
-       * do not organize submissions — there the post itself is the request.
-       */
-      results?: Array<Processing.Result>;
-    }
-
-    export namespace Processing {
-      export interface Result {
-        /**
-         * 'request' = the ask became a request of its own; 'attached' = it was added as
-         * evidence to a request that already existed; 'held' = it became a request that is
-         * waiting for a teammate to publish it; 'question' = it asked something and no
-         * request was created, so a teammate answers it.
-         */
-        outcome: 'attached' | 'request' | 'question' | 'held';
-
-        /**
-         * The ask, as it was written up.
-         */
-        title: string;
-
-        /**
-         * The request this ask became, or was attached to. Absent for a question, and
-         * absent when the request is not readable through this API (for example a ticket
-         * board).
-         */
-        postId?: string;
-
-        /**
-         * Title of `postId`.
-         */
-        postTitle?: string;
-
-        /**
-         * Why a 'held' result is waiting for a teammate. Only on a 'held' result, and only
-         * one of these codes: 'too_many_topics' = the submission held more separate asks
-         * than one submission can become requests, so this one request lists the asks that
-         * did not fit, one line each in the customer's words; 'uncertain' = the ask was
-         * too vague to file without a person; 'custom_fields' = the board requires custom
-         * fields this submission did not carry; 'processing_failed' = the AI could not
-         * rewrite the text (the request then holds the original words) or could not check
-         * this ask against existing requests, so a teammate confirms it is not a
-         * duplicate.
-         */
-        reason?: 'too_many_topics' | 'uncertain' | 'custom_fields' | 'processing_failed';
-      }
-    }
   }
 }
 
@@ -2388,6 +2336,8 @@ export declare namespace Posts {
     type PostAccess as PostAccess,
     type PostAuthor as PostAuthor,
     type PostFeatures as PostFeatures,
+    type PostList as PostList,
+    type PostProcessing as PostProcessing,
     type PostTag as PostTag,
     type SearchFilter as SearchFilter,
     type SearchFilterGroup as SearchFilterGroup,

package/src/resources/index.ts

@@ -6,6 +6,11 @@ export {
   type AuditLogListParams,
   type AuditLogListResponsesCursorPage,
 } from './audit-logs';
+export {
+  AwayReasons,
+  type AwayReasonRetrieveAwayReasonsResponse,
+  type AwayReasonRetrieveAwayReasonsParams,
+} from './away-reasons';
 export {
   Changelogs,
   type Changelog,
@@ -44,10 +49,12 @@ export {
   type ReportSegmentDatum,
   type ReportTimeSeriesDatum,
   type ReportDrillInResponse,
+  type ReportFilterCapabilitiesResponse,
   type ReportListDatasetsResponse,
   type ReportLookupFilterValuesResponse,
   type ReportQueryResponse,
   type ReportDrillInParams,
+  type ReportFilterCapabilitiesParams,
   type ReportListDatasetsParams,
   type ReportLookupFilterValuesParams,
   type ReportQueryParams,
@@ -66,6 +73,7 @@ export {
 } from './surveys';
 export {
   TrainingData,
+  type KnowledgeMatchCandidate,
   type KnowledgeSearch,
   type Oracle,
   type TrainingDataOracleParams,
@@ -85,3 +93,4 @@ export {
   type WebhookRefreshSecretParams,
   type WebhooksCursorPage,
 } from './webhooks';
+export { Workload, type WorkloadListResponse, type WorkloadListParams } from './workload';