featurebase-node 0.0.2

package/resources/conversations/conversations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversations.mjs","sourceRoot":"","sources":["../../src/resources/conversations/conversations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,eAAe;OACpB,EAAiD,YAAY,EAAE;OAC/D,KAAK,oBAAoB;OACzB,EAKL,IAAI,GACL;OAEM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QACE,SAAI,GAA8B,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9E,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0uB9F,CAAC;IAxuBC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiIG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC5C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuGG;IACH,QAAQ,CACN,EAAU,EACV,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+HG;IACH,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE;YACvD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC3C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE;YACxD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4EG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8GG;IACH,KAAK,CAAC,EAAU,EAAE,MAA+B,EAAE,OAAwB;QACzE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,QAAQ,EAAE;YAC5D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC/F,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAu3DD,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;AAC1B,aAAa,CAAC,YAAY,GAAG,YAAY,CAAC"}

package/resources/conversations/index.d.mts

@@ -0,0 +1,4 @@
+export { Conversations, type Conversation, type ConversationPart, type ConversationPartAuthor, type ConversationParticipant, type ConversationTagApplication, type CsatEmailDelivery, type CsatRatedAgent, type CsatWorkflowLink, type EmailRecipients, type ConversationListResponse, type ConversationDeleteResponse, type ConversationCreateParams, type ConversationRetrieveParams, type ConversationUpdateParams, type ConversationListParams, type ConversationDeleteParams, type ConversationRedactParams, type ConversationReplyParams, } from "./conversations.mjs";
+export { Participants, type ParticipantAddParams, type ParticipantRemoveParams } from "./participants.mjs";
+export { Tags, type AttachedConversationTag, type ConversationTagMutationActor, type TagAttachParams, type TagDetachParams, } from "./tags.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/conversations/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/conversations/index.ts"],"names":[],"mappings":"OAEO,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC7B;OACM,EAAE,YAAY,EAAE,KAAK,oBAAoB,EAAE,KAAK,uBAAuB,EAAE;OACzE,EACL,IAAI,EACJ,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,eAAe,EACpB,KAAK,eAAe,GACrB"}

package/resources/conversations/index.d.ts

@@ -0,0 +1,4 @@
+export { Conversations, type Conversation, type ConversationPart, type ConversationPartAuthor, type ConversationParticipant, type ConversationTagApplication, type CsatEmailDelivery, type CsatRatedAgent, type CsatWorkflowLink, type EmailRecipients, type ConversationListResponse, type ConversationDeleteResponse, type ConversationCreateParams, type ConversationRetrieveParams, type ConversationUpdateParams, type ConversationListParams, type ConversationDeleteParams, type ConversationRedactParams, type ConversationReplyParams, } from "./conversations.js";
+export { Participants, type ParticipantAddParams, type ParticipantRemoveParams } from "./participants.js";
+export { Tags, type AttachedConversationTag, type ConversationTagMutationActor, type TagAttachParams, type TagDetachParams, } from "./tags.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/conversations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/conversations/index.ts"],"names":[],"mappings":"OAEO,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC7B;OACM,EAAE,YAAY,EAAE,KAAK,oBAAoB,EAAE,KAAK,uBAAuB,EAAE;OACzE,EACL,IAAI,EACJ,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,eAAe,EACpB,KAAK,eAAe,GACrB"}

package/resources/conversations/index.js

@@ -0,0 +1,11 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tags = exports.Participants = exports.Conversations = void 0;
+var conversations_1 = require("./conversations.js");
+Object.defineProperty(exports, "Conversations", { enumerable: true, get: function () { return conversations_1.Conversations; } });
+var participants_1 = require("./participants.js");
+Object.defineProperty(exports, "Participants", { enumerable: true, get: function () { return participants_1.Participants; } });
+var tags_1 = require("./tags.js");
+Object.defineProperty(exports, "Tags", { enumerable: true, get: function () { return tags_1.Tags; } });
+//# sourceMappingURL=index.js.map

package/resources/conversations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/conversations/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oDAoByB;AAnBvB,8GAAA,aAAa,OAAA;AAoBf,kDAAuG;AAA9F,4GAAA,YAAY,OAAA;AACrB,kCAMgB;AALd,4FAAA,IAAI,OAAA"}

package/resources/conversations/index.mjs

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Conversations, } from "./conversations.mjs";
+export { Participants } from "./participants.mjs";
+export { Tags, } from "./tags.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/conversations/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/conversations/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,aAAa,GAmBd;OACM,EAAE,YAAY,EAA2D;OACzE,EACL,IAAI,GAKL"}

package/resources/conversations/participants.d.mts

@@ -0,0 +1,217 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as ConversationsAPI from "./conversations.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.
+ */
+export declare class Participants extends APIResource {
+    /**
+     * Adds a contact (customer or lead) as a participant to an existing conversation.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The conversation ID (short ID)
+     *
+     * ### Request Body
+     *
+     * | Field                | Type   | Required | Description                                                           |
+     * | -------------------- | ------ | -------- | --------------------------------------------------------------------- |
+     * | `participant`        | object | Yes      | The contact to add (see below)                                        |
+     * | `participant.id`     | string | No\*     | The Featurebase ID (24-character ObjectId) - matches customer or lead |
+     * | `participant.userId` | string | No\*     | External user ID from your system - matches customer only             |
+     * | `participant.email`  | string | No\*     | Email address - matches customer only                                 |
+     * | `actingAdminId`      | string | No       | Admin ID performing the action (for attribution)                      |
+     *
+     * \*At least one of `id`, `userId`, or `email` is required in the participant
+     * object.
+     *
+     * ### Lookup Priority
+     *
+     * 1. If `id` is provided, looks up by Featurebase ID (matches both customer and
+     *    lead types)
+     * 2. If `userId` is provided, looks up by external user ID (matches customer type
+     *    only)
+     * 3. If `email` is provided, looks up by email address (matches customer type
+     *    only)
+     *
+     * ### Response
+     *
+     * Returns the updated conversation object.
+     *
+     * ### Example Request (by Featurebase ID)
+     *
+     * ```json
+     * {
+     *   "participant": {
+     *     "id": "676f0f6765bdaa7d7d760f88"
+     *   },
+     *   "actingAdminId": "507f1f77bcf86cd799439011"
+     * }
+     * ```
+     *
+     * ### Example Request (by external userId)
+     *
+     * ```json
+     * {
+     *   "participant": {
+     *     "userId": "user_123"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Request (by email)
+     *
+     * ```json
+     * {
+     *   "participant": {
+     *     "email": "john@example.com"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "conversation",
+     *   "id": "12345",
+     *   "participants": [
+     *     { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" },
+     *     { "type": "customer", "id": "676f0f6765bdaa7d7d760f89" }
+     *   ],
+     *   ...
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const conversation =
+     *   await client.conversations.participants.add('12345', {
+     *     participant: {},
+     *   });
+     * ```
+     */
+    add(id: string, params: ParticipantAddParams, options?: RequestOptions): APIPromise<ConversationsAPI.Conversation>;
+    /**
+     * Removes a contact (customer or lead) from an existing conversation.
+     *
+     * **Note:** You cannot remove the last participant from a conversation.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The conversation ID (short ID)
+     *
+     * ### Request Body
+     *
+     * | Field           | Type   | Required | Description                                                         |
+     * | --------------- | ------ | -------- | ------------------------------------------------------------------- |
+     * | `id`            | string | Yes      | The Featurebase ID of the contact to remove (24-character ObjectId) |
+     * | `actingAdminId` | string | No       | Admin ID performing the action (for attribution)                    |
+     *
+     * ### Response
+     *
+     * Returns the updated conversation object.
+     *
+     * ### Example Request
+     *
+     * ```json
+     * {
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "actingAdminId": "507f1f77bcf86cd799439011"
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "conversation",
+     *   "id": "12345",
+     *   "participants": [
+     *     { "type": "customer", "id": "676f0f6765bdaa7d7d760f89" }
+     *   ],
+     *   ...
+     * }
+     * ```
+     *
+     * ### Error Cases
+     *
+     * - **400 Bad Request** - Cannot remove the last participant from a conversation
+     * - **404 Not Found** - Conversation or contact not found in participants
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const conversation =
+     *   await client.conversations.participants.remove('12345', {
+     *     id: '676f0f6765bdaa7d7d760f88',
+     *   });
+     * ```
+     */
+    remove(id: string, params: ParticipantRemoveParams, options?: RequestOptions): APIPromise<ConversationsAPI.Conversation>;
+}
+export interface ParticipantAddParams {
+    /**
+     * Body param: The contact to add as a participant. At least one of id, userId, or
+     * email is required.
+     */
+    participant: ParticipantAddParams.Participant;
+    /**
+     * Body param: The admin ID performing this action. If not provided, changes are
+     * attributed to the system bot user.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace ParticipantAddParams {
+    /**
+     * The contact to add as a participant. At least one of id, userId, or email is
+     * required.
+     */
+    interface Participant {
+        /**
+         * The Featurebase ID of the contact (customer or lead)
+         */
+        id?: string;
+        /**
+         * The email address of the contact (matches customer type only)
+         */
+        email?: string;
+        /**
+         * The external user ID from your system (matches customer type only)
+         */
+        userId?: string;
+    }
+}
+export interface ParticipantRemoveParams {
+    /**
+     * Body param: The Featurebase ID of the contact (customer or lead) to remove
+     */
+    id: string;
+    /**
+     * Body param: The admin ID performing this action. If not provided, changes are
+     * attributed to the system bot user.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Participants {
+    export { type ParticipantAddParams as ParticipantAddParams, type ParticipantRemoveParams as ParticipantRemoveParams, };
+}
+//# sourceMappingURL=participants.d.mts.map

package/resources/conversations/participants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"participants.d.mts","sourceRoot":"","sources":["../../src/resources/conversations/participants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyFG;IACH,GAAG,CACD,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAY5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;CAW7C;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,WAAW,EAAE,oBAAoB,CAAC,WAAW,CAAC;IAE9C;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/conversations/participants.d.ts

@@ -0,0 +1,217 @@
+import { APIResource } from "../../core/resource.js";
+import * as ConversationsAPI from "./conversations.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.
+ */
+export declare class Participants extends APIResource {
+    /**
+     * Adds a contact (customer or lead) as a participant to an existing conversation.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The conversation ID (short ID)
+     *
+     * ### Request Body
+     *
+     * | Field                | Type   | Required | Description                                                           |
+     * | -------------------- | ------ | -------- | --------------------------------------------------------------------- |
+     * | `participant`        | object | Yes      | The contact to add (see below)                                        |
+     * | `participant.id`     | string | No\*     | The Featurebase ID (24-character ObjectId) - matches customer or lead |
+     * | `participant.userId` | string | No\*     | External user ID from your system - matches customer only             |
+     * | `participant.email`  | string | No\*     | Email address - matches customer only                                 |
+     * | `actingAdminId`      | string | No       | Admin ID performing the action (for attribution)                      |
+     *
+     * \*At least one of `id`, `userId`, or `email` is required in the participant
+     * object.
+     *
+     * ### Lookup Priority
+     *
+     * 1. If `id` is provided, looks up by Featurebase ID (matches both customer and
+     *    lead types)
+     * 2. If `userId` is provided, looks up by external user ID (matches customer type
+     *    only)
+     * 3. If `email` is provided, looks up by email address (matches customer type
+     *    only)
+     *
+     * ### Response
+     *
+     * Returns the updated conversation object.
+     *
+     * ### Example Request (by Featurebase ID)
+     *
+     * ```json
+     * {
+     *   "participant": {
+     *     "id": "676f0f6765bdaa7d7d760f88"
+     *   },
+     *   "actingAdminId": "507f1f77bcf86cd799439011"
+     * }
+     * ```
+     *
+     * ### Example Request (by external userId)
+     *
+     * ```json
+     * {
+     *   "participant": {
+     *     "userId": "user_123"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Request (by email)
+     *
+     * ```json
+     * {
+     *   "participant": {
+     *     "email": "john@example.com"
+     *   }
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "conversation",
+     *   "id": "12345",
+     *   "participants": [
+     *     { "type": "customer", "id": "676f0f6765bdaa7d7d760f88" },
+     *     { "type": "customer", "id": "676f0f6765bdaa7d7d760f89" }
+     *   ],
+     *   ...
+     * }
+     * ```
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const conversation =
+     *   await client.conversations.participants.add('12345', {
+     *     participant: {},
+     *   });
+     * ```
+     */
+    add(id: string, params: ParticipantAddParams, options?: RequestOptions): APIPromise<ConversationsAPI.Conversation>;
+    /**
+     * Removes a contact (customer or lead) from an existing conversation.
+     *
+     * **Note:** You cannot remove the last participant from a conversation.
+     *
+     * ### Path Parameters
+     *
+     * - `id` - The conversation ID (short ID)
+     *
+     * ### Request Body
+     *
+     * | Field           | Type   | Required | Description                                                         |
+     * | --------------- | ------ | -------- | ------------------------------------------------------------------- |
+     * | `id`            | string | Yes      | The Featurebase ID of the contact to remove (24-character ObjectId) |
+     * | `actingAdminId` | string | No       | Admin ID performing the action (for attribution)                    |
+     *
+     * ### Response
+     *
+     * Returns the updated conversation object.
+     *
+     * ### Example Request
+     *
+     * ```json
+     * {
+     *   "id": "676f0f6765bdaa7d7d760f88",
+     *   "actingAdminId": "507f1f77bcf86cd799439011"
+     * }
+     * ```
+     *
+     * ### Example Response
+     *
+     * ```json
+     * {
+     *   "object": "conversation",
+     *   "id": "12345",
+     *   "participants": [
+     *     { "type": "customer", "id": "676f0f6765bdaa7d7d760f89" }
+     *   ],
+     *   ...
+     * }
+     * ```
+     *
+     * ### Error Cases
+     *
+     * - **400 Bad Request** - Cannot remove the last participant from a conversation
+     * - **404 Not Found** - Conversation or contact not found in participants
+     *
+     * ### Version Availability
+     *
+     * This endpoint is only available in API version 2026-01-01.nova and newer.
+     *
+     * @example
+     * ```ts
+     * const conversation =
+     *   await client.conversations.participants.remove('12345', {
+     *     id: '676f0f6765bdaa7d7d760f88',
+     *   });
+     * ```
+     */
+    remove(id: string, params: ParticipantRemoveParams, options?: RequestOptions): APIPromise<ConversationsAPI.Conversation>;
+}
+export interface ParticipantAddParams {
+    /**
+     * Body param: The contact to add as a participant. At least one of id, userId, or
+     * email is required.
+     */
+    participant: ParticipantAddParams.Participant;
+    /**
+     * Body param: The admin ID performing this action. If not provided, changes are
+     * attributed to the system bot user.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace ParticipantAddParams {
+    /**
+     * The contact to add as a participant. At least one of id, userId, or email is
+     * required.
+     */
+    interface Participant {
+        /**
+         * The Featurebase ID of the contact (customer or lead)
+         */
+        id?: string;
+        /**
+         * The email address of the contact (matches customer type only)
+         */
+        email?: string;
+        /**
+         * The external user ID from your system (matches customer type only)
+         */
+        userId?: string;
+    }
+}
+export interface ParticipantRemoveParams {
+    /**
+     * Body param: The Featurebase ID of the contact (customer or lead) to remove
+     */
+    id: string;
+    /**
+     * Body param: The admin ID performing this action. If not provided, changes are
+     * attributed to the system bot user.
+     */
+    actingAdminId?: string;
+    /**
+     * Header param: API version for this request. Defaults to your organization's
+     * configured API version if not specified.
+     */
+    'Featurebase-Version'?: string;
+}
+export declare namespace Participants {
+    export { type ParticipantAddParams as ParticipantAddParams, type ParticipantRemoveParams as ParticipantRemoveParams, };
+}
+//# sourceMappingURL=participants.d.ts.map

package/resources/conversations/participants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"participants.d.ts","sourceRoot":"","sources":["../../src/resources/conversations/participants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyFG;IACH,GAAG,CACD,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAY5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC;CAW7C;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,WAAW,EAAE,oBAAoB,CAAC,WAAW,CAAC;IAE9C;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}