featurebase-node 0.14.2 → 0.14.3

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

@@ -984,18 +984,53 @@ export class Conversations extends APIResource {
    * `participant_id`, `company_id`, `created_at`) are still accepted for back-compat
    * but are deprecated — please migrate to camelCase in new code.
    *
-   * | Field                      | Type                                                                        | Operators              |
-   * | -------------------------- | --------------------------------------------------------------------------- | ---------------------- |
-   * | `state`                    | enum (`open` / `closed` / `snoozed`)                                        | `=`, `!=`, `IN`, `NIN` |
-   * | `priority`                 | boolean                                                                     | `=`, `!=`              |
-   * | `adminAssigneeId`          | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN` |
-   * | `teamAssigneeId`           | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN` |
-   * | `brandId`                  | id or null                                                                  | `=`, `!=`, `IN`, `NIN` |
-   * | `tagIds`                   | id (matches any conversation containing this tag)                           | `=`, `!=`, `IN`, `NIN` |
-   * | `userId` / `participantId` | id of a conversation participant                                            | `=`, `!=`, `IN`, `NIN` |
-   * | `companyId`                | company id (matches conversations whose participants belong to the company) | `=`, `!=`, `IN`, `NIN` |
-   * | `mentionedAdminIds`        | admin id                                                                    | `=`, `!=`, `IN`, `NIN` |
-   * | `createdAt`                | unix seconds                                                                | `=`, `>`, `<`          |
+   * | Field                            | Type                                                                        | Operators                                                               |
+   * | -------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+   * | `state`                          | enum (`open` / `closed` / `snoozed`)                                        | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `priority`                       | boolean                                                                     | `=`, `!=`                                                               |
+   * | `adminAssigneeId`                | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `teamAssigneeId`                 | id or null (unassigned)                                                     | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `brandId`                        | id or null                                                                  | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `tagIds`                         | id (matches any conversation containing this tag)                           | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `userId` / `participantId`       | id of a conversation participant                                            | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `companyId`                      | company id (matches conversations whose participants belong to the company) | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `mentionedAdminIds`              | admin id                                                                    | `=`, `!=`, `IN`, `NIN`                                                  |
+   * | `createdAt`                      | unix seconds                                                                | `=`, `>`, `<`                                                           |
+   * | `customAttributes.<attributeId>` | conversation custom attribute (see below)                                   | `=`, `!=`, `IN`, `NIN`; plus `>`, `<`, `>=`, `<=` for `number` / `date` |
+   *
+   * ### Filtering by custom attributes
+   *
+   * Any non-archived conversation custom attribute can be used as a filter field via
+   * `customAttributes.<attributeId>`, where `<attributeId>` is the attribute's `id`
+   * from `GET /v2/conversation_attributes`. The accepted value shape follows the
+   * attribute's `fieldSubType`:
+   *
+   * - `select` / `multi-select` — pass an option **label** (e.g.
+   *   `"Product question"`) or an option **id**; both are matched interchangeably,
+   *   and id-based filters keep working after options are renamed
+   * - `text` — string
+   * - `number` — number; range operators (`>`, `<`, `>=`, `<=`) are supported
+   * - `date` — ISO 8601 string or unix seconds; range operators are supported
+   * - `checkbox` — boolean
+   *
+   * Example — all conversations where the "Issue type" select attribute is "Product
+   * question":
+   *
+   * ```json
+   * {
+   *   "query": {
+   *     "field": "customAttributes.6863d3fca1234b0d5e15c86c",
+   *     "operator": "=",
+   *     "value": "Product question"
+   *   },
+   *   "include": ["customAttributeDefinitions"]
+   * }
+   * ```
+   *
+   * Referencing an attribute id that does not exist (or has been archived) returns a
+   * `field_unknown` error. Set `include` to `["customAttributeDefinitions"]` to get
+   * each returned conversation's attribute values resolved with names and types
+   * alongside the ID-keyed `customAttributes` map.
    *
    * For unbounded fields a query consisting only of `!=` or `NIN` clauses is
    * rejected with `query_too_broad` to prevent full-org scans. Combine the negation
@@ -1329,9 +1364,11 @@ export namespace Conversation {
     requestId: string;
 
     /**
-     * Source that created the CSAT request
+     * Source that created the CSAT request. `workflow` = Ask For Conversation Rating
+     * workflow action, `fibi_auto` = automatic Fibi AI Agent survey on
+     * resolve/handoff.
      */
-    requestSource: 'workflow';
+    requestSource: 'workflow' | 'fibi_auto';
 
     /**
      * Lifecycle status for this historical CSAT request
@@ -1437,7 +1474,7 @@ export namespace Conversation {
     /**
      * Source of the latest CSAT request when known
      */
-    requestSource?: 'workflow';
+    requestSource?: 'workflow' | 'fibi_auto';
 
     /**
      * CSAT score from 1 to 5 when rated
@@ -2001,9 +2038,11 @@ export namespace ConversationPart {
       requestId: string;
 
       /**
-       * Source that created the CSAT request
+       * Source that created the CSAT request. `workflow` = Ask For Conversation Rating
+       * workflow action, `fibi_auto` = automatic Fibi AI Agent survey on
+       * resolve/handoff.
        */
-      requestSource: 'workflow';
+      requestSource: 'workflow' | 'fibi_auto';
 
       /**
        * Status of the CSAT request represented by this part
@@ -2088,9 +2127,11 @@ export namespace ConversationPart {
       requestId: string;
 
       /**
-       * Source that created the CSAT request
+       * Source that created the CSAT request. `workflow` = Ask For Conversation Rating
+       * workflow action, `fibi_auto` = automatic Fibi AI Agent survey on
+       * resolve/handoff.
        */
-      requestSource: 'workflow';
+      requestSource: 'workflow' | 'fibi_auto';
 
       /**
        * CSAT score from 1 to 5

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.14.2'; // x-release-please-version
+export const VERSION = '0.14.3'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.14.2";
+export declare const VERSION = "0.14.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.14.2'; // x-release-please-version
+exports.VERSION = '0.14.3'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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